-
| {{ _("Date") }} | @@ -64,10 +64,10 @@{{ frappe.format(row.account, {fieldtype: "Link"}) or " " }} | - {{ row.account and frappe.utils.fmt_money(row.debit, currency=filters.presentation_currency) }} + {{ row.get('account', '') and frappe.utils.fmt_money(row.debit, currency=filters.presentation_currency) }} | - {{ row.account and frappe.utils.fmt_money(row.credit, currency=filters.presentation_currency) }} + {{ row.get('account', '') and frappe.utils.fmt_money(row.credit, currency=filters.presentation_currency) }} | {% endif %}
diff --git a/erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.js b/erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.js
index 088c190f451..29f2e98e779 100644
--- a/erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.js
+++ b/erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.js
@@ -51,6 +51,13 @@ frappe.ui.form.on('Process Statement Of Accounts', {
}
}
});
+ frm.set_query("account", function() {
+ return {
+ filters: {
+ 'company': frm.doc.company
+ }
+ };
+ });
if(frm.doc.__islocal){
frm.set_value('from_date', frappe.datetime.add_months(frappe.datetime.get_today(), -1));
frm.set_value('to_date', frappe.datetime.get_today());
diff --git a/erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.py b/erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.py
index 09aa72352e4..01f716daa21 100644
--- a/erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.py
+++ b/erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.py
@@ -23,130 +23,166 @@ from erpnext.accounts.report.general_ledger.general_ledger import execute as get
class ProcessStatementOfAccounts(Document):
def validate(self):
if not self.subject:
- self.subject = 'Statement Of Accounts for {{ customer.name }}'
+ self.subject = "Statement Of Accounts for {{ customer.name }}"
if not self.body:
- self.body = 'Hello {{ customer.name }}, PFA your Statement Of Accounts from {{ doc.from_date }} to {{ doc.to_date }}.' + self.body = "Hello {{ customer.name }}, PFA your Statement Of Accounts from {{ doc.from_date }} to {{ doc.to_date }}." validate_template(self.subject) validate_template(self.body) if not self.customers: - frappe.throw(_('Customers not selected.')) + frappe.throw(_("Customers not selected.")) if self.enable_auto_email: - self.to_date = self.start_date - self.from_date = add_months(self.to_date, -1 * self.filter_duration) + if self.start_date and getdate(self.start_date) >= getdate(today()): + self.to_date = self.start_date + self.from_date = add_months(self.to_date, -1 * self.filter_duration) def get_report_pdf(doc, consolidated=True): statement_dict = {} - ageing = '' + ageing = "" base_template_path = "frappe/www/printview.html" - template_path = "erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.html" + template_path = ( + "erpnext/accounts/doctype/process_statement_of_accounts/process_statement_of_accounts.html" + ) for entry in doc.customers: if doc.include_ageing: - ageing_filters = frappe._dict({ - 'company': doc.company, - 'report_date': doc.to_date, - 'ageing_based_on': doc.ageing_based_on, - 'range1': 30, - 'range2': 60, - 'range3': 90, - 'range4': 120, - 'customer': entry.customer - }) + ageing_filters = frappe._dict( + { + "company": doc.company, + "report_date": doc.to_date, + "ageing_based_on": doc.ageing_based_on, + "range1": 30, + "range2": 60, + "range3": 90, + "range4": 120, + "customer": entry.customer, + } + ) col1, ageing = get_ageing(ageing_filters) if ageing: - ageing[0]['ageing_based_on'] = doc.ageing_based_on + ageing[0]["ageing_based_on"] = doc.ageing_based_on - tax_id = frappe.get_doc('Customer', entry.customer).tax_id - presentation_currency = get_party_account_currency('Customer', entry.customer, doc.company) \ - or doc.currency or get_company_currency(doc.company) + tax_id = frappe.get_doc("Customer", entry.customer).tax_id + presentation_currency = ( + get_party_account_currency("Customer", entry.customer, doc.company) + or doc.currency + or get_company_currency(doc.company) + ) if doc.letter_head: from frappe.www.printview import get_letter_head + letter_head = get_letter_head(doc, 0) - filters= frappe._dict({ - 'from_date': doc.from_date, - 'to_date': doc.to_date, - 'company': doc.company, - 'finance_book': doc.finance_book if doc.finance_book else None, - 'account': doc.account if doc.account else None, - 'party_type': 'Customer', - 'party': [entry.customer], - 'presentation_currency': presentation_currency, - 'group_by': doc.group_by, - 'currency': doc.currency, - 'cost_center': [cc.cost_center_name for cc in doc.cost_center], - 'project': [p.project_name for p in doc.project], - 'show_opening_entries': 0, - 'include_default_book_entries': 0, - 'tax_id': tax_id if tax_id else None - }) + filters = frappe._dict( + { + "from_date": doc.from_date, + "to_date": doc.to_date, + "company": doc.company, + "finance_book": doc.finance_book if doc.finance_book else None, + "account": [doc.account] if doc.account else None, + "party_type": "Customer", + "party": [entry.customer], + "presentation_currency": presentation_currency, + "group_by": doc.group_by, + "currency": doc.currency, + "cost_center": [cc.cost_center_name for cc in doc.cost_center], + "project": [p.project_name for p in doc.project], + "show_opening_entries": 0, + "include_default_book_entries": 0, + "tax_id": tax_id if tax_id else None, + } + ) col, res = get_soa(filters) for x in [0, -2, -1]: - res[x]['account'] = res[x]['account'].replace("'","") + res[x]["account"] = res[x]["account"].replace("'", "") if len(res) == 3: continue - html = frappe.render_template(template_path, \ - {"filters": filters, "data": res, "ageing": ageing[0] if (doc.include_ageing and ageing) else None, + html = frappe.render_template( + template_path, + { + "filters": filters, + "data": res, + "ageing": ageing[0] if (doc.include_ageing and ageing) else None, "letter_head": letter_head if doc.letter_head else None, - "terms_and_conditions": frappe.db.get_value('Terms and Conditions', doc.terms_and_conditions, 'terms') - if doc.terms_and_conditions else None}) + "terms_and_conditions": frappe.db.get_value( + "Terms and Conditions", doc.terms_and_conditions, "terms" + ) + if doc.terms_and_conditions + else None, + }, + ) - html = frappe.render_template(base_template_path, {"body": html, \ - "css": get_print_style(), "title": "Statement For " + entry.customer}) + html = frappe.render_template( + base_template_path, + {"body": html, "css": get_print_style(), "title": "Statement For " + entry.customer}, + ) statement_dict[entry.customer] = html if not bool(statement_dict): return False elif consolidated: - result = ''.join(list(statement_dict.values())) - return get_pdf(result, {'orientation': doc.orientation}) + result = "".join(list(statement_dict.values())) + return get_pdf(result, {"orientation": doc.orientation}) else: for customer, statement_html in statement_dict.items(): - statement_dict[customer]=get_pdf(statement_html, {'orientation': doc.orientation}) + statement_dict[customer] = get_pdf(statement_html, {"orientation": doc.orientation}) return statement_dict + def get_customers_based_on_territory_or_customer_group(customer_collection, collection_name): fields_dict = { - 'Customer Group': 'customer_group', - 'Territory': 'territory', + "Customer Group": "customer_group", + "Territory": "territory", } collection = frappe.get_doc(customer_collection, collection_name) - selected = [customer.name for customer in frappe.get_list(customer_collection, filters=[ - ['lft', '>=', collection.lft], - ['rgt', '<=', collection.rgt] - ], - fields=['name'], - order_by='lft asc, rgt desc' - )] - return frappe.get_list('Customer', fields=['name', 'email_id'], \ - filters=[[fields_dict[customer_collection], 'IN', selected]]) + selected = [ + customer.name + for customer in frappe.get_list( + customer_collection, + filters=[["lft", ">=", collection.lft], ["rgt", "<=", collection.rgt]], + fields=["name"], + order_by="lft asc, rgt desc", + ) + ] + return frappe.get_list( + "Customer", + fields=["name", "email_id"], + filters=[[fields_dict[customer_collection], "IN", selected]], + ) + def get_customers_based_on_sales_person(sales_person): - lft, rgt = frappe.db.get_value("Sales Person", - sales_person, ["lft", "rgt"]) - records = frappe.db.sql(""" + lft, rgt = frappe.db.get_value("Sales Person", sales_person, ["lft", "rgt"]) + records = frappe.db.sql( + """ select distinct parent, parenttype from `tabSales Team` steam where parenttype = 'Customer' and exists(select name from `tabSales Person` where lft >= %s and rgt <= %s and name = steam.sales_person) - """, (lft, rgt), as_dict=1) + """, + (lft, rgt), + as_dict=1, + ) sales_person_records = frappe._dict() for d in records: sales_person_records.setdefault(d.parenttype, set()).add(d.parent) - if sales_person_records.get('Customer'): - return frappe.get_list('Customer', fields=['name', 'email_id'], \ - filters=[['name', 'in', list(sales_person_records['Customer'])]]) + if sales_person_records.get("Customer"): + return frappe.get_list( + "Customer", + fields=["name", "email_id"], + filters=[["name", "in", list(sales_person_records["Customer"])]], + ) else: return [] + def get_recipients_and_cc(customer, doc): recipients = [] for clist in doc.customers: @@ -155,65 +191,72 @@ def get_recipients_and_cc(customer, doc): if doc.primary_mandatory and clist.primary_email: recipients.append(clist.primary_email) cc = [] - if doc.cc_to != '': + if doc.cc_to != "": try: - cc=[frappe.get_value('User', doc.cc_to, 'email')] + cc = [frappe.get_value("User", doc.cc_to, "email")] except Exception: pass return recipients, cc + def get_context(customer, doc): template_doc = copy.deepcopy(doc) del template_doc.customers template_doc.from_date = format_date(template_doc.from_date) template_doc.to_date = format_date(template_doc.to_date) return { - 'doc': template_doc, - 'customer': frappe.get_doc('Customer', customer), - 'frappe': frappe.utils + "doc": template_doc, + "customer": frappe.get_doc("Customer", customer), + "frappe": frappe.utils, } + @frappe.whitelist() def fetch_customers(customer_collection, collection_name, primary_mandatory): customer_list = [] customers = [] - if customer_collection == 'Sales Person': + if customer_collection == "Sales Person": customers = get_customers_based_on_sales_person(collection_name) if not bool(customers): - frappe.throw(_('No Customers found with selected options.')) + frappe.throw(_("No Customers found with selected options.")) else: - if customer_collection == 'Sales Partner': - customers = frappe.get_list('Customer', fields=['name', 'email_id'], \ - filters=[['default_sales_partner', '=', collection_name]]) + if customer_collection == "Sales Partner": + customers = frappe.get_list( + "Customer", + fields=["name", "email_id"], + filters=[["default_sales_partner", "=", collection_name]], + ) else: - customers = get_customers_based_on_territory_or_customer_group(customer_collection, collection_name) + customers = get_customers_based_on_territory_or_customer_group( + customer_collection, collection_name + ) for customer in customers: - primary_email = customer.get('email_id') or '' + primary_email = customer.get("email_id") or "" billing_email = get_customer_emails(customer.name, 1, billing_and_primary=False) if int(primary_mandatory): - if (primary_email == ''): + if primary_email == "": continue - elif (billing_email == '') and (primary_email == ''): + elif (billing_email == "") and (primary_email == ""): continue - customer_list.append({ - 'name': customer.name, - 'primary_email': primary_email, - 'billing_email': billing_email - }) + customer_list.append( + {"name": customer.name, "primary_email": primary_email, "billing_email": billing_email} + ) return customer_list + @frappe.whitelist() def get_customer_emails(customer_name, primary_mandatory, billing_and_primary=True): - """ Returns first email from Contact Email table as a Billing email - when Is Billing Contact checked - and Primary email- email with Is Primary checked """ + """Returns first email from Contact Email table as a Billing email + when Is Billing Contact checked + and Primary email- email with Is Primary checked""" - billing_email = frappe.db.sql(""" + billing_email = frappe.db.sql( + """ SELECT email.email_id FROM @@ -231,42 +274,43 @@ def get_customer_emails(customer_name, primary_mandatory, billing_and_primary=Tr and link.link_name=%s and contact.is_billing_contact=1 ORDER BY - contact.creation desc""", customer_name) + contact.creation desc""", + customer_name, + ) if len(billing_email) == 0 or (billing_email[0][0] is None): if billing_and_primary: frappe.throw(_("No billing email found for customer: {0}").format(customer_name)) else: - return '' + return "" if billing_and_primary: - primary_email = frappe.get_value('Customer', customer_name, 'email_id') + primary_email = frappe.get_value("Customer", customer_name, "email_id") if primary_email is None and int(primary_mandatory): frappe.throw(_("No primary email found for customer: {0}").format(customer_name)) - return [primary_email or '', billing_email[0][0]] + return [primary_email or "", billing_email[0][0]] else: - return billing_email[0][0] or '' + return billing_email[0][0] or "" + @frappe.whitelist() def download_statements(document_name): - doc = frappe.get_doc('Process Statement Of Accounts', document_name) + doc = frappe.get_doc("Process Statement Of Accounts", document_name) report = get_report_pdf(doc) if report: - frappe.local.response.filename = doc.name + '.pdf' + frappe.local.response.filename = doc.name + ".pdf" frappe.local.response.filecontent = report frappe.local.response.type = "download" + @frappe.whitelist() def send_emails(document_name, from_scheduler=False): - doc = frappe.get_doc('Process Statement Of Accounts', document_name) + doc = frappe.get_doc("Process Statement Of Accounts", document_name) report = get_report_pdf(doc, consolidated=False) if report: for customer, report_pdf in report.items(): - attachments = [{ - 'fname': customer + '.pdf', - 'fcontent': report_pdf - }] + attachments = [{"fname": customer + ".pdf", "fcontent": report_pdf}] recipients, cc = get_recipients_and_cc(customer, doc) context = get_context(customer, doc) @@ -274,7 +318,7 @@ def send_emails(document_name, from_scheduler=False): message = frappe.render_template(doc.body, context) frappe.enqueue( - queue='short', + queue="short", method=frappe.sendmail, recipients=recipients, sender=frappe.session.user, @@ -282,28 +326,34 @@ def send_emails(document_name, from_scheduler=False): subject=subject, message=message, now=True, - reference_doctype='Process Statement Of Accounts', + reference_doctype="Process Statement Of Accounts", reference_name=document_name, - attachments=attachments + attachments=attachments, ) if doc.enable_auto_email and from_scheduler: new_to_date = getdate(today()) - if doc.frequency == 'Weekly': + if doc.frequency == "Weekly": new_to_date = add_days(new_to_date, 7) else: - new_to_date = add_months(new_to_date, 1 if doc.frequency == 'Monthly' else 3) + new_to_date = add_months(new_to_date, 1 if doc.frequency == "Monthly" else 3) new_from_date = add_months(new_to_date, -1 * doc.filter_duration) - doc.add_comment('Comment', 'Emails sent on: ' + frappe.utils.format_datetime(frappe.utils.now())) - doc.db_set('to_date', new_to_date, commit=True) - doc.db_set('from_date', new_from_date, commit=True) + doc.add_comment( + "Comment", "Emails sent on: " + frappe.utils.format_datetime(frappe.utils.now()) + ) + doc.db_set("to_date", new_to_date, commit=True) + doc.db_set("from_date", new_from_date, commit=True) return True else: return False + @frappe.whitelist() def send_auto_email(): - selected = frappe.get_list('Process Statement Of Accounts', filters={'to_date': format_date(today()), 'enable_auto_email': 1}) + selected = frappe.get_list( + "Process Statement Of Accounts", + filters={"to_date": format_date(today()), "enable_auto_email": 1}, + ) for entry in selected: send_emails(entry.name, from_scheduler=True) return True diff --git a/erpnext/accounts/doctype/promotional_scheme/promotional_scheme.py b/erpnext/accounts/doctype/promotional_scheme/promotional_scheme.py index 5fbe93ee68d..fac9be7bdb1 100644 --- a/erpnext/accounts/doctype/promotional_scheme/promotional_scheme.py +++ b/erpnext/accounts/doctype/promotional_scheme/promotional_scheme.py @@ -6,29 +6,73 @@ import frappe from frappe import _ from frappe.model.document import Document -pricing_rule_fields = ['apply_on', 'mixed_conditions', 'is_cumulative', 'other_item_code', 'other_item_group', - 'apply_rule_on_other', 'other_brand', 'selling', 'buying', 'applicable_for', 'valid_from', - 'valid_upto', 'customer', 'customer_group', 'territory', 'sales_partner', 'campaign', 'supplier', - 'supplier_group', 'company', 'currency', 'apply_multiple_pricing_rules'] +pricing_rule_fields = [ + "apply_on", + "mixed_conditions", + "is_cumulative", + "other_item_code", + "other_item_group", + "apply_rule_on_other", + "other_brand", + "selling", + "buying", + "applicable_for", + "valid_from", + "valid_upto", + "customer", + "customer_group", + "territory", + "sales_partner", + "campaign", + "supplier", + "supplier_group", + "company", + "currency", + "apply_multiple_pricing_rules", +] -other_fields = ['min_qty', 'max_qty', 'min_amt', - 'max_amt', 'priority','warehouse', 'threshold_percentage', 'rule_description'] +other_fields = [ + "min_qty", + "max_qty", + "min_amt", + "max_amt", + "priority", + "warehouse", + "threshold_percentage", + "rule_description", +] -price_discount_fields = ['rate_or_discount', 'apply_discount_on', 'apply_discount_on_rate', - 'rate', 'discount_amount', 'discount_percentage', 'validate_applied_rule', 'apply_multiple_pricing_rules'] +price_discount_fields = [ + "rate_or_discount", + "apply_discount_on", + "apply_discount_on_rate", + "rate", + "discount_amount", + "discount_percentage", + "validate_applied_rule", + "apply_multiple_pricing_rules", +] + +product_discount_fields = [ + "free_item", + "free_qty", + "free_item_uom", + "free_item_rate", + "same_item", + "is_recursive", + "apply_multiple_pricing_rules", +] -product_discount_fields = ['free_item', 'free_qty', 'free_item_uom', - 'free_item_rate', 'same_item', 'is_recursive', 'apply_multiple_pricing_rules'] class TransactionExists(frappe.ValidationError): pass + class PromotionalScheme(Document): def validate(self): if not self.selling and not self.buying: frappe.throw(_("Either 'Selling' or 'Buying' must be selected"), title=_("Mandatory")) - if not (self.price_discount_slabs - or self.product_discount_slabs): + if not (self.price_discount_slabs or self.product_discount_slabs): frappe.throw(_("Price or product discount slabs are required")) self.validate_applicable_for() @@ -39,7 +83,7 @@ class PromotionalScheme(Document): applicable_for = frappe.scrub(self.applicable_for) if not self.get(applicable_for): - msg = (f'The field {frappe.bold(self.applicable_for)} is required') + msg = f"The field {frappe.bold(self.applicable_for)} is required" frappe.throw(_(msg)) def validate_pricing_rules(self): @@ -53,28 +97,28 @@ class PromotionalScheme(Document): if self._doc_before_save.applicable_for == self.applicable_for: return - docnames = frappe.get_all('Pricing Rule', - filters= {'promotional_scheme': self.name}) + docnames = frappe.get_all("Pricing Rule", filters={"promotional_scheme": self.name}) for docname in docnames: - if frappe.db.exists('Pricing Rule Detail', - {'pricing_rule': docname.name, 'docstatus': ('<', 2)}): + if frappe.db.exists( + "Pricing Rule Detail", {"pricing_rule": docname.name, "docstatus": ("<", 2)} + ): raise_for_transaction_exists(self.name) if docnames and not transaction_exists: for docname in docnames: - frappe.delete_doc('Pricing Rule', docname.name) + frappe.delete_doc("Pricing Rule", docname.name) def on_update(self): - pricing_rules = frappe.get_all( - 'Pricing Rule', - fields = ["promotional_scheme_id", "name", "creation"], - filters = { - 'promotional_scheme': self.name, - 'applicable_for': self.applicable_for - }, - order_by = 'creation asc', - ) or {} + pricing_rules = ( + frappe.get_all( + "Pricing Rule", + fields=["promotional_scheme_id", "name", "creation"], + filters={"promotional_scheme": self.name, "applicable_for": self.applicable_for}, + order_by="creation asc", + ) + or {} + ) self.update_pricing_rules(pricing_rules) def update_pricing_rules(self, pricing_rules): @@ -83,7 +127,7 @@ class PromotionalScheme(Document): names = [] for rule in pricing_rules: names.append(rule.name) - rules[rule.get('promotional_scheme_id')] = names + rules[rule.get("promotional_scheme_id")] = names docs = get_pricing_rules(self, rules) @@ -100,34 +144,38 @@ class PromotionalScheme(Document): frappe.msgprint(_("New {0} pricing rules are created").format(count)) def on_trash(self): - for rule in frappe.get_all('Pricing Rule', - {'promotional_scheme': self.name}): - frappe.delete_doc('Pricing Rule', rule.name) + for rule in frappe.get_all("Pricing Rule", {"promotional_scheme": self.name}): + frappe.delete_doc("Pricing Rule", rule.name) + def raise_for_transaction_exists(name): - msg = (f"""You can't change the {frappe.bold(_('Applicable For'))} - because transactions are present against the Promotional Scheme {frappe.bold(name)}. """) - msg += 'Kindly disable this Promotional Scheme and create new for new Applicable For.' + msg = f"""You can't change the {frappe.bold(_('Applicable For'))} + because transactions are present against the Promotional Scheme {frappe.bold(name)}. """ + msg += "Kindly disable this Promotional Scheme and create new for new Applicable For." frappe.throw(_(msg), TransactionExists) + def get_pricing_rules(doc, rules=None): if rules is None: rules = {} new_doc = [] - for child_doc, fields in {'price_discount_slabs': price_discount_fields, - 'product_discount_slabs': product_discount_fields}.items(): + for child_doc, fields in { + "price_discount_slabs": price_discount_fields, + "product_discount_slabs": product_discount_fields, + }.items(): if doc.get(child_doc): new_doc.extend(_get_pricing_rules(doc, child_doc, fields, rules)) return new_doc + def _get_pricing_rules(doc, child_doc, discount_fields, rules=None): if rules is None: rules = {} new_doc = [] args = get_args_for_pricing_rule(doc) - applicable_for = frappe.scrub(doc.get('applicable_for')) + applicable_for = frappe.scrub(doc.get("applicable_for")) for idx, d in enumerate(doc.get(child_doc)): if d.name in rules: @@ -138,15 +186,23 @@ def _get_pricing_rules(doc, child_doc, discount_fields, rules=None): else: for applicable_for_value in args.get(applicable_for): docname = get_pricing_rule_docname(d, applicable_for, applicable_for_value) - pr = prepare_pricing_rule(args, doc, child_doc, discount_fields, - d, docname, applicable_for, applicable_for_value) + pr = prepare_pricing_rule( + args, doc, child_doc, discount_fields, d, docname, applicable_for, applicable_for_value + ) new_doc.append(pr) elif args.get(applicable_for): applicable_for_values = args.get(applicable_for) or [] for applicable_for_value in applicable_for_values: - pr = prepare_pricing_rule(args, doc, child_doc, discount_fields, - d, applicable_for=applicable_for, value= applicable_for_value) + pr = prepare_pricing_rule( + args, + doc, + child_doc, + discount_fields, + d, + applicable_for=applicable_for, + value=applicable_for_value, + ) new_doc.append(pr) else: @@ -155,20 +211,24 @@ def _get_pricing_rules(doc, child_doc, discount_fields, rules=None): return new_doc -def get_pricing_rule_docname(row: dict, applicable_for: str = None, applicable_for_value: str = None) -> str: - fields = ['promotional_scheme_id', 'name'] - filters = { - 'promotional_scheme_id': row.name - } + +def get_pricing_rule_docname( + row: dict, applicable_for: str = None, applicable_for_value: str = None +) -> str: + fields = ["promotional_scheme_id", "name"] + filters = {"promotional_scheme_id": row.name} if applicable_for: fields.append(applicable_for) filters[applicable_for] = applicable_for_value - docname = frappe.get_all('Pricing Rule', fields = fields, filters = filters) - return docname[0].name if docname else '' + docname = frappe.get_all("Pricing Rule", fields=fields, filters=filters) + return docname[0].name if docname else "" -def prepare_pricing_rule(args, doc, child_doc, discount_fields, d, docname=None, applicable_for=None, value=None): + +def prepare_pricing_rule( + args, doc, child_doc, discount_fields, d, docname=None, applicable_for=None, value=None +): if docname: pr = frappe.get_doc("Pricing Rule", docname) else: @@ -182,33 +242,31 @@ def prepare_pricing_rule(args, doc, child_doc, discount_fields, d, docname=None, return set_args(temp_args, pr, doc, child_doc, discount_fields, d) + def set_args(args, pr, doc, child_doc, discount_fields, child_doc_fields): pr.update(args) - for field in (other_fields + discount_fields): + for field in other_fields + discount_fields: pr.set(field, child_doc_fields.get(field)) pr.promotional_scheme_id = child_doc_fields.name pr.promotional_scheme = doc.name pr.disable = child_doc_fields.disable if child_doc_fields.disable else doc.disable - pr.price_or_product_discount = ('Price' - if child_doc == 'price_discount_slabs' else 'Product') + pr.price_or_product_discount = "Price" if child_doc == "price_discount_slabs" else "Product" - for field in ['items', 'item_groups', 'brands']: + for field in ["items", "item_groups", "brands"]: if doc.get(field): pr.set(field, []) - apply_on = frappe.scrub(doc.get('apply_on')) + apply_on = frappe.scrub(doc.get("apply_on")) for d in doc.get(field): - pr.append(field, { - apply_on: d.get(apply_on), - 'uom': d.uom - }) + pr.append(field, {apply_on: d.get(apply_on), "uom": d.uom}) return pr + def get_args_for_pricing_rule(doc): - args = { 'promotional_scheme': doc.name } - applicable_for = frappe.scrub(doc.get('applicable_for')) + args = {"promotional_scheme": doc.name} + applicable_for = frappe.scrub(doc.get("applicable_for")) for d in pricing_rule_fields: if d == applicable_for: diff --git a/erpnext/accounts/doctype/promotional_scheme/promotional_scheme_dashboard.py b/erpnext/accounts/doctype/promotional_scheme/promotional_scheme_dashboard.py index 6d079242682..70e87404a35 100644 --- a/erpnext/accounts/doctype/promotional_scheme/promotional_scheme_dashboard.py +++ b/erpnext/accounts/doctype/promotional_scheme/promotional_scheme_dashboard.py @@ -3,11 +3,6 @@ from frappe import _ def get_data(): return { - 'fieldname': 'promotional_scheme', - 'transactions': [ - { - 'label': _('Reference'), - 'items': ['Pricing Rule'] - } - ] + "fieldname": "promotional_scheme", + "transactions": [{"label": _("Reference"), "items": ["Pricing Rule"]}], } diff --git a/erpnext/accounts/doctype/promotional_scheme/test_promotional_scheme.py b/erpnext/accounts/doctype/promotional_scheme/test_promotional_scheme.py index 49192a45f87..b3b9d7b2086 100644 --- a/erpnext/accounts/doctype/promotional_scheme/test_promotional_scheme.py +++ b/erpnext/accounts/doctype/promotional_scheme/test_promotional_scheme.py @@ -11,96 +11,111 @@ from erpnext.selling.doctype.sales_order.test_sales_order import make_sales_orde class TestPromotionalScheme(unittest.TestCase): def setUp(self): - if frappe.db.exists('Promotional Scheme', '_Test Scheme'): - frappe.delete_doc('Promotional Scheme', '_Test Scheme') + if frappe.db.exists("Promotional Scheme", "_Test Scheme"): + frappe.delete_doc("Promotional Scheme", "_Test Scheme") def test_promotional_scheme(self): - ps = make_promotional_scheme(applicable_for='Customer', customer='_Test Customer') - price_rules = frappe.get_all('Pricing Rule', fields = ["promotional_scheme_id", "name", "creation"], - filters = {'promotional_scheme': ps.name}) - self.assertTrue(len(price_rules),1) - price_doc_details = frappe.db.get_value('Pricing Rule', price_rules[0].name, ['customer', 'min_qty', 'discount_percentage'], as_dict = 1) - self.assertTrue(price_doc_details.customer, '_Test Customer') + ps = make_promotional_scheme(applicable_for="Customer", customer="_Test Customer") + price_rules = frappe.get_all( + "Pricing Rule", + fields=["promotional_scheme_id", "name", "creation"], + filters={"promotional_scheme": ps.name}, + ) + self.assertTrue(len(price_rules), 1) + price_doc_details = frappe.db.get_value( + "Pricing Rule", price_rules[0].name, ["customer", "min_qty", "discount_percentage"], as_dict=1 + ) + self.assertTrue(price_doc_details.customer, "_Test Customer") self.assertTrue(price_doc_details.min_qty, 4) self.assertTrue(price_doc_details.discount_percentage, 20) ps.price_discount_slabs[0].min_qty = 6 - ps.append('customer', { - 'customer': "_Test Customer 2"}) + ps.append("customer", {"customer": "_Test Customer 2"}) ps.save() - price_rules = frappe.get_all('Pricing Rule', fields = ["promotional_scheme_id", "name"], - filters = {'promotional_scheme': ps.name}) + price_rules = frappe.get_all( + "Pricing Rule", + fields=["promotional_scheme_id", "name"], + filters={"promotional_scheme": ps.name}, + ) self.assertTrue(len(price_rules), 2) - price_doc_details = frappe.db.get_value('Pricing Rule', price_rules[1].name, ['customer', 'min_qty', 'discount_percentage'], as_dict = 1) - self.assertTrue(price_doc_details.customer, '_Test Customer 2') + price_doc_details = frappe.db.get_value( + "Pricing Rule", price_rules[1].name, ["customer", "min_qty", "discount_percentage"], as_dict=1 + ) + self.assertTrue(price_doc_details.customer, "_Test Customer 2") self.assertTrue(price_doc_details.min_qty, 6) self.assertTrue(price_doc_details.discount_percentage, 20) - price_doc_details = frappe.db.get_value('Pricing Rule', price_rules[0].name, ['customer', 'min_qty', 'discount_percentage'], as_dict = 1) - self.assertTrue(price_doc_details.customer, '_Test Customer') + price_doc_details = frappe.db.get_value( + "Pricing Rule", price_rules[0].name, ["customer", "min_qty", "discount_percentage"], as_dict=1 + ) + self.assertTrue(price_doc_details.customer, "_Test Customer") self.assertTrue(price_doc_details.min_qty, 6) - frappe.delete_doc('Promotional Scheme', ps.name) - price_rules = frappe.get_all('Pricing Rule', fields = ["promotional_scheme_id", "name"], - filters = {'promotional_scheme': ps.name}) + frappe.delete_doc("Promotional Scheme", ps.name) + price_rules = frappe.get_all( + "Pricing Rule", + fields=["promotional_scheme_id", "name"], + filters={"promotional_scheme": ps.name}, + ) self.assertEqual(price_rules, []) def test_promotional_scheme_without_applicable_for(self): ps = make_promotional_scheme() - price_rules = frappe.get_all('Pricing Rule', filters = {'promotional_scheme': ps.name}) + price_rules = frappe.get_all("Pricing Rule", filters={"promotional_scheme": ps.name}) self.assertTrue(len(price_rules), 1) - frappe.delete_doc('Promotional Scheme', ps.name) + frappe.delete_doc("Promotional Scheme", ps.name) - price_rules = frappe.get_all('Pricing Rule', filters = {'promotional_scheme': ps.name}) + price_rules = frappe.get_all("Pricing Rule", filters={"promotional_scheme": ps.name}) self.assertEqual(price_rules, []) def test_change_applicable_for_in_promotional_scheme(self): ps = make_promotional_scheme() - price_rules = frappe.get_all('Pricing Rule', filters = {'promotional_scheme': ps.name}) + price_rules = frappe.get_all("Pricing Rule", filters={"promotional_scheme": ps.name}) self.assertTrue(len(price_rules), 1) - so = make_sales_order(qty=5, currency='USD', do_not_save=True) + so = make_sales_order(qty=5, currency="USD", do_not_save=True) so.set_missing_values() so.save() self.assertEqual(price_rules[0].name, so.pricing_rules[0].pricing_rule) - ps.applicable_for = 'Customer' - ps.append('customer', { - 'customer': '_Test Customer' - }) + ps.applicable_for = "Customer" + ps.append("customer", {"customer": "_Test Customer"}) self.assertRaises(TransactionExists, ps.save) - frappe.delete_doc('Sales Order', so.name) - frappe.delete_doc('Promotional Scheme', ps.name) - price_rules = frappe.get_all('Pricing Rule', filters = {'promotional_scheme': ps.name}) + frappe.delete_doc("Sales Order", so.name) + frappe.delete_doc("Promotional Scheme", ps.name) + price_rules = frappe.get_all("Pricing Rule", filters={"promotional_scheme": ps.name}) self.assertEqual(price_rules, []) + def make_promotional_scheme(**args): args = frappe._dict(args) - ps = frappe.new_doc('Promotional Scheme') - ps.name = '_Test Scheme' - ps.append('items',{ - 'item_code': '_Test Item' - }) + ps = frappe.new_doc("Promotional Scheme") + ps.name = "_Test Scheme" + ps.append("items", {"item_code": "_Test Item"}) ps.selling = 1 - ps.append('price_discount_slabs',{ - 'min_qty': 4, - 'validate_applied_rule': 0, - 'discount_percentage': 20, - 'rule_description': 'Test' - }) + ps.append( + "price_discount_slabs", + { + "min_qty": 4, + "validate_applied_rule": 0, + "discount_percentage": 20, + "rule_description": "Test", + }, + ) - ps.company = '_Test Company' + ps.company = "_Test Company" if args.applicable_for: ps.applicable_for = args.applicable_for - ps.append(frappe.scrub(args.applicable_for), { - frappe.scrub(args.applicable_for): args.get(frappe.scrub(args.applicable_for)) - }) + ps.append( + frappe.scrub(args.applicable_for), + {frappe.scrub(args.applicable_for): args.get(frappe.scrub(args.applicable_for))}, + ) ps.save() diff --git a/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.js b/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.js index 19c0d8aaf3d..aed8cb56d1b 100644 --- a/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.js +++ b/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.js @@ -30,6 +30,9 @@ erpnext.accounts.PurchaseInvoice = erpnext.buying.BuyingController.extend({ onload: function() { this._super(); + // Ignore linked advances + this.frm.ignore_doctypes_on_cancel_all = ['Journal Entry', 'Payment Entry']; + if(!this.frm.doc.__islocal) { // show credit_to in print format if(!this.frm.doc.supplier && this.frm.doc.credit_to) { @@ -42,8 +45,6 @@ erpnext.accounts.PurchaseInvoice = erpnext.buying.BuyingController.extend({ if (this.frm.doc.supplier && this.frm.doc.__islocal) { this.frm.trigger('supplier'); } - - erpnext.accounts.dimensions.setup_dimension_filters(this.frm, this.frm.doctype); }, refresh: function(doc) { @@ -276,6 +277,8 @@ erpnext.accounts.PurchaseInvoice = erpnext.buying.BuyingController.extend({ if(this.frm.updating_party_details || this.frm.doc.inter_company_invoice_reference) return; + if (this.frm.doc.__onload && this.frm.doc.__onload.load_after_mapping) return; + erpnext.utils.get_party_details(this.frm, "erpnext.accounts.party.get_party_details", { posting_date: this.frm.doc.posting_date, @@ -536,7 +539,7 @@ frappe.ui.form.on("Purchase Invoice", { }, add_custom_buttons: function(frm) { - if (frm.doc.per_received < 100) { + if (frm.doc.docstatus == 1 && frm.doc.per_received < 100) { frm.add_custom_button(__('Purchase Receipt'), () => { frm.events.make_purchase_receipt(frm); }, __('Create')); diff --git a/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.json b/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.json index bd0116443ff..ff3d5950808 100644 --- a/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.json +++ b/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.json @@ -83,6 +83,8 @@ "section_break_51", "taxes_and_charges", "taxes", + "tax_withheld_vouchers_section", + "tax_withheld_vouchers", "sec_tax_breakup", "other_charges_calculation", "totals", @@ -511,7 +513,6 @@ "fieldname": "ignore_pricing_rule", "fieldtype": "Check", "label": "Ignore Pricing Rule", - "no_copy": 1, "permlevel": 1, "print_hide": 1 }, @@ -1417,13 +1418,25 @@ "label": "Advance Tax", "options": "Advance Tax", "read_only": 1 + }, + { + "fieldname": "tax_withheld_vouchers_section", + "fieldtype": "Section Break", + "label": "Tax Withheld Vouchers" + }, + { + "fieldname": "tax_withheld_vouchers", + "fieldtype": "Table", + "label": "Tax Withheld Vouchers", + "options": "Tax Withheld Vouchers", + "read_only": 1 } ], "icon": "fa fa-file-text", "idx": 204, "is_submittable": 1, "links": [], - "modified": "2021-11-25 13:31:02.716727", + "modified": "2022-09-13 23:39:54.525037", "modified_by": "Administrator", "module": "Accounts", "name": "Purchase Invoice", @@ -1483,6 +1496,7 @@ "show_name_in_global_search": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "timeline_field": "supplier", "title_field": "title", "track_changes": 1 diff --git a/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.py b/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.py index 33fbd748c7b..6476845de78 100644 --- a/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.py +++ b/erpnext/accounts/doctype/purchase_invoice/purchase_invoice.py @@ -33,6 +33,7 @@ from erpnext.accounts.utils import get_account_currency, get_fiscal_year from erpnext.assets.doctype.asset.asset import get_asset_account, is_cwip_accounting_enabled from erpnext.assets.doctype.asset_category.asset_category import get_asset_category_account from erpnext.buying.utils import check_on_hold_or_closed_status +from erpnext.controllers.accounts_controller import validate_account_head from erpnext.controllers.buying_controller import BuyingController from erpnext.stock import get_warehouse_account_map from erpnext.stock.doctype.purchase_receipt.purchase_receipt import ( @@ -40,25 +41,26 @@ from erpnext.stock.doctype.purchase_receipt.purchase_receipt import ( update_billed_amount_based_on_po, ) -form_grid_templates = { - "items": "templates/form_grid/item_grid.html" -} +form_grid_templates = {"items": "templates/form_grid/item_grid.html"} + class PurchaseInvoice(BuyingController): def __init__(self, *args, **kwargs): super(PurchaseInvoice, self).__init__(*args, **kwargs) - self.status_updater = [{ - 'source_dt': 'Purchase Invoice Item', - 'target_dt': 'Purchase Order Item', - 'join_field': 'po_detail', - 'target_field': 'billed_amt', - 'target_parent_dt': 'Purchase Order', - 'target_parent_field': 'per_billed', - 'target_ref_field': 'amount', - 'source_field': 'amount', - 'percent_join_field': 'purchase_order', - 'overflow_type': 'billing' - }] + self.status_updater = [ + { + "source_dt": "Purchase Invoice Item", + "target_dt": "Purchase Order Item", + "join_field": "po_detail", + "target_field": "billed_amt", + "target_parent_dt": "Purchase Order", + "target_parent_field": "per_billed", + "target_ref_field": "amount", + "source_field": "amount", + "percent_join_field": "purchase_order", + "overflow_type": "billing", + } + ] def onload(self): super(PurchaseInvoice, self).onload() @@ -67,15 +69,14 @@ class PurchaseInvoice(BuyingController): def before_save(self): if not self.on_hold: - self.release_date = '' - + self.release_date = "" def invoice_is_blocked(self): return self.on_hold and (not self.release_date or self.release_date > getdate(nowdate())) def validate(self): if not self.is_opening: - self.is_opening = 'No' + self.is_opening = "No" self.validate_posting_time() @@ -87,14 +88,14 @@ class PurchaseInvoice(BuyingController): self.validate_supplier_invoice() # validate cash purchase - if (self.is_paid == 1): + if self.is_paid == 1: self.validate_cash() # validate service stop date to lie in between start and end date validate_service_stop_date(self) - if self._action=="submit" and self.update_stock: - self.make_batches('warehouse') + if self._action == "submit" and self.update_stock: + self.make_batches("warehouse") self.validate_release_date() self.check_conversion_rate() @@ -105,79 +106,86 @@ class PurchaseInvoice(BuyingController): self.validate_uom_is_integer("uom", "qty") self.validate_uom_is_integer("stock_uom", "stock_qty") self.set_expense_account(for_validate=True) + self.validate_expense_account() self.set_against_expense_account() self.validate_write_off_account() self.validate_multiple_billing("Purchase Receipt", "pr_detail", "amount", "items") self.create_remarks() self.set_status() self.validate_purchase_receipt_if_update_stock() - validate_inter_company_party(self.doctype, self.supplier, self.company, self.inter_company_invoice_reference) + validate_inter_company_party( + self.doctype, self.supplier, self.company, self.inter_company_invoice_reference + ) self.reset_default_field_value("set_warehouse", "items", "warehouse") self.reset_default_field_value("rejected_warehouse", "items", "rejected_warehouse") self.reset_default_field_value("set_from_warehouse", "items", "from_warehouse") def validate_release_date(self): if self.release_date and getdate(nowdate()) >= getdate(self.release_date): - frappe.throw(_('Release date must be in the future')) + frappe.throw(_("Release date must be in the future")) def validate_cash(self): if not self.cash_bank_account and flt(self.paid_amount): frappe.throw(_("Cash or Bank Account is mandatory for making payment entry")) - if (flt(self.paid_amount) + flt(self.write_off_amount) - - flt(self.get("rounded_total") or self.grand_total) - > 1/(10**(self.precision("base_grand_total") + 1))): + if flt(self.paid_amount) + flt(self.write_off_amount) - flt( + self.get("rounded_total") or self.grand_total + ) > 1 / (10 ** (self.precision("base_grand_total") + 1)): frappe.throw(_("""Paid amount + Write Off Amount can not be greater than Grand Total""")) def create_remarks(self): if not self.remarks: if self.bill_no and self.bill_date: - self.remarks = _("Against Supplier Invoice {0} dated {1}").format(self.bill_no, - formatdate(self.bill_date)) + self.remarks = _("Against Supplier Invoice {0} dated {1}").format( + self.bill_no, formatdate(self.bill_date) + ) else: self.remarks = _("No Remarks") def set_missing_values(self, for_validate=False): if not self.credit_to: self.credit_to = get_party_account("Supplier", self.supplier, self.company) - self.party_account_currency = frappe.db.get_value("Account", self.credit_to, "account_currency", cache=True) + self.party_account_currency = frappe.db.get_value( + "Account", self.credit_to, "account_currency", cache=True + ) if not self.due_date: - self.due_date = get_due_date(self.posting_date, "Supplier", self.supplier, self.company, self.bill_date) + self.due_date = get_due_date( + self.posting_date, "Supplier", self.supplier, self.company, self.bill_date + ) tds_category = frappe.db.get_value("Supplier", self.supplier, "tax_withholding_category") if tds_category and not for_validate: self.apply_tds = 1 self.tax_withholding_category = tds_category + self.set_onload("supplier_tds", tds_category) super(PurchaseInvoice, self).set_missing_values(for_validate) - def check_conversion_rate(self): - default_currency = erpnext.get_company_currency(self.company) - if not default_currency: - throw(_('Please enter default currency in Company Master')) - if (self.currency == default_currency and flt(self.conversion_rate) != 1.00) or not self.conversion_rate or (self.currency != default_currency and flt(self.conversion_rate) == 1.00): - throw(_("Conversion rate cannot be 0 or 1")) - def validate_credit_to_acc(self): if not self.credit_to: self.credit_to = get_party_account("Supplier", self.supplier, self.company) if not self.credit_to: self.raise_missing_debit_credit_account_error("Supplier", self.supplier) - account = frappe.db.get_value("Account", self.credit_to, - ["account_type", "report_type", "account_currency"], as_dict=True) + account = frappe.db.get_value( + "Account", self.credit_to, ["account_type", "report_type", "account_currency"], as_dict=True + ) if account.report_type != "Balance Sheet": frappe.throw( - _("Please ensure {} account is a Balance Sheet account. You can change the parent account to a Balance Sheet account or select a different account.") - .format(frappe.bold("Credit To")), title=_("Invalid Account") + _( + "Please ensure {} account is a Balance Sheet account. You can change the parent account to a Balance Sheet account or select a different account." + ).format(frappe.bold("Credit To")), + title=_("Invalid Account"), ) if self.supplier and account.account_type != "Payable": frappe.throw( - _("Please ensure {} account is a Payable account. Change the account type to Payable or select a different account.") - .format(frappe.bold("Credit To")), title=_("Invalid Account") + _( + "Please ensure {} account {} is a Payable account. Change the account type to Payable or select a different account." + ).format(frappe.bold("Credit To"), frappe.bold(self.credit_to)), + title=_("Invalid Account"), ) self.party_account_currency = account.account_currency @@ -185,51 +193,61 @@ class PurchaseInvoice(BuyingController): def check_on_hold_or_closed_status(self): check_list = [] - for d in self.get('items'): + for d in self.get("items"): if d.purchase_order and not d.purchase_order in check_list and not d.purchase_receipt: check_list.append(d.purchase_order) - check_on_hold_or_closed_status('Purchase Order', d.purchase_order) + check_on_hold_or_closed_status("Purchase Order", d.purchase_order) def validate_with_previous_doc(self): - super(PurchaseInvoice, self).validate_with_previous_doc({ - "Purchase Order": { - "ref_dn_field": "purchase_order", - "compare_fields": [["supplier", "="], ["company", "="], ["currency", "="]], - }, - "Purchase Order Item": { - "ref_dn_field": "po_detail", - "compare_fields": [["project", "="], ["item_code", "="], ["uom", "="]], - "is_child_table": True, - "allow_duplicate_prev_row_id": True - }, - "Purchase Receipt": { - "ref_dn_field": "purchase_receipt", - "compare_fields": [["supplier", "="], ["company", "="], ["currency", "="]], - }, - "Purchase Receipt Item": { - "ref_dn_field": "pr_detail", - "compare_fields": [["project", "="], ["item_code", "="], ["uom", "="]], - "is_child_table": True + super(PurchaseInvoice, self).validate_with_previous_doc( + { + "Purchase Order": { + "ref_dn_field": "purchase_order", + "compare_fields": [["supplier", "="], ["company", "="], ["currency", "="]], + }, + "Purchase Order Item": { + "ref_dn_field": "po_detail", + "compare_fields": [["project", "="], ["item_code", "="], ["uom", "="]], + "is_child_table": True, + "allow_duplicate_prev_row_id": True, + }, + "Purchase Receipt": { + "ref_dn_field": "purchase_receipt", + "compare_fields": [["supplier", "="], ["company", "="], ["currency", "="]], + }, + "Purchase Receipt Item": { + "ref_dn_field": "pr_detail", + "compare_fields": [["project", "="], ["item_code", "="], ["uom", "="]], + "is_child_table": True, + }, } - }) + ) - if cint(frappe.db.get_single_value('Buying Settings', 'maintain_same_rate')) and not self.is_return: - self.validate_rate_with_reference_doc([ - ["Purchase Order", "purchase_order", "po_detail"], - ["Purchase Receipt", "purchase_receipt", "pr_detail"] - ]) + if ( + cint(frappe.db.get_single_value("Buying Settings", "maintain_same_rate")) and not self.is_return + ): + self.validate_rate_with_reference_doc( + [ + ["Purchase Order", "purchase_order", "po_detail"], + ["Purchase Receipt", "purchase_receipt", "pr_detail"], + ] + ) def validate_warehouse(self, for_validate=True): if self.update_stock and for_validate: - for d in self.get('items'): - if not d.warehouse: - frappe.throw(_("Warehouse required at Row No {0}, please set default warehouse for the item {1} for the company {2}"). - format(d.idx, d.item_code, self.company)) + stock_items = self.get_stock_items() + for d in self.get("items"): + if not d.warehouse and d.item_code in stock_items: + frappe.throw( + _( + "Warehouse required at Row No {0}, please set default warehouse for the item {1} for the company {2}" + ).format(d.idx, d.item_code, self.company) + ) super(PurchaseInvoice, self).validate_warehouse() def validate_item_code(self): - for d in self.get('items'): + for d in self.get("items"): if not d.item_code: frappe.msgprint(_("Item Code required at Row No {0}").format(d.idx), raise_exception=True) @@ -257,51 +275,82 @@ class PurchaseInvoice(BuyingController): if item.item_code: asset_category = frappe.get_cached_value("Item", item.item_code, "asset_category") - if auto_accounting_for_stock and item.item_code in stock_items \ - and self.is_opening == 'No' and not item.is_fixed_asset \ - and (not item.po_detail or - not frappe.db.get_value("Purchase Order Item", item.po_detail, "delivered_by_supplier")): + if ( + auto_accounting_for_stock + and item.item_code in stock_items + and self.is_opening == "No" + and not item.is_fixed_asset + and ( + not item.po_detail + or not frappe.db.get_value("Purchase Order Item", item.po_detail, "delivered_by_supplier") + ) + ): if self.update_stock and (not item.from_warehouse): - if for_validate and item.expense_account and item.expense_account != warehouse_account[item.warehouse]["account"]: - msg = _("Row {0}: Expense Head changed to {1} because account {2} is not linked to warehouse {3} or it is not the default inventory account").format( - item.idx, frappe.bold(warehouse_account[item.warehouse]["account"]), frappe.bold(item.expense_account), frappe.bold(item.warehouse)) + if ( + for_validate + and item.expense_account + and item.expense_account != warehouse_account[item.warehouse]["account"] + ): + msg = _( + "Row {0}: Expense Head changed to {1} because account {2} is not linked to warehouse {3} or it is not the default inventory account" + ).format( + item.idx, + frappe.bold(warehouse_account[item.warehouse]["account"]), + frappe.bold(item.expense_account), + frappe.bold(item.warehouse), + ) frappe.msgprint(msg, title=_("Expense Head Changed")) item.expense_account = warehouse_account[item.warehouse]["account"] else: # check if 'Stock Received But Not Billed' account is credited in Purchase receipt or not if item.purchase_receipt: - negative_expense_booked_in_pr = frappe.db.sql("""select name from `tabGL Entry` + negative_expense_booked_in_pr = frappe.db.sql( + """select name from `tabGL Entry` where voucher_type='Purchase Receipt' and voucher_no=%s and account = %s""", - (item.purchase_receipt, stock_not_billed_account)) + (item.purchase_receipt, stock_not_billed_account), + ) if negative_expense_booked_in_pr: - if for_validate and item.expense_account and item.expense_account != stock_not_billed_account: - msg = _("Row {0}: Expense Head changed to {1} because expense is booked against this account in Purchase Receipt {2}").format( - item.idx, frappe.bold(stock_not_billed_account), frappe.bold(item.purchase_receipt)) + if ( + for_validate and item.expense_account and item.expense_account != stock_not_billed_account + ): + msg = _( + "Row {0}: Expense Head changed to {1} because expense is booked against this account in Purchase Receipt {2}" + ).format( + item.idx, frappe.bold(stock_not_billed_account), frappe.bold(item.purchase_receipt) + ) frappe.msgprint(msg, title=_("Expense Head Changed")) item.expense_account = stock_not_billed_account else: # If no purchase receipt present then book expense in 'Stock Received But Not Billed' # This is done in cases when Purchase Invoice is created before Purchase Receipt - if for_validate and item.expense_account and item.expense_account != stock_not_billed_account: - msg = _("Row {0}: Expense Head changed to {1} as no Purchase Receipt is created against Item {2}.").format( - item.idx, frappe.bold(stock_not_billed_account), frappe.bold(item.item_code)) + if ( + for_validate and item.expense_account and item.expense_account != stock_not_billed_account + ): + msg = _( + "Row {0}: Expense Head changed to {1} as no Purchase Receipt is created against Item {2}." + ).format( + item.idx, frappe.bold(stock_not_billed_account), frappe.bold(item.item_code) + ) msg += " " - msg += _("This is done to handle accounting for cases when Purchase Receipt is created after Purchase Invoice") + msg += _( + "This is done to handle accounting for cases when Purchase Receipt is created after Purchase Invoice" + ) frappe.msgprint(msg, title=_("Expense Head Changed")) item.expense_account = stock_not_billed_account elif item.is_fixed_asset and not is_cwip_accounting_enabled(asset_category): - asset_category_account = get_asset_category_account('fixed_asset_account', item=item.item_code, - company = self.company) + asset_category_account = get_asset_category_account( + "fixed_asset_account", item=item.item_code, company=self.company + ) if not asset_category_account: - form_link = get_link_to_form('Asset Category', asset_category) + form_link = get_link_to_form("Asset Category", asset_category) throw( _("Please set Fixed Asset Account in {} against {}.").format(form_link, self.company), - title=_("Missing Account") + title=_("Missing Account"), ) item.expense_account = asset_category_account elif item.is_fixed_asset and item.pr_detail: @@ -309,6 +358,10 @@ class PurchaseInvoice(BuyingController): elif not item.expense_account and for_validate: throw(_("Expense account is mandatory for item {0}").format(item.item_code or item.item_name)) + def validate_expense_account(self): + for item in self.get("items"): + validate_account_head(item.idx, item.expense_account, self.company, "Expense") + def set_against_expense_account(self): against_accounts = [] for item in self.get("items"): @@ -318,32 +371,44 @@ class PurchaseInvoice(BuyingController): self.against_expense_account = ",".join(against_accounts) def po_required(self): - if frappe.db.get_value("Buying Settings", None, "po_required") == 'Yes': + if frappe.db.get_value("Buying Settings", None, "po_required") == "Yes": - if frappe.get_value('Supplier', self.supplier, 'allow_purchase_invoice_creation_without_purchase_order'): + if frappe.get_value( + "Supplier", self.supplier, "allow_purchase_invoice_creation_without_purchase_order" + ): return - for d in self.get('items'): + for d in self.get("items"): if not d.purchase_order: msg = _("Purchase Order Required for item {}").format(frappe.bold(d.item_code)) msg += " " msg += _("To submit the invoice without purchase order please set {0} as {1} in {2}").format( - frappe.bold(_('Purchase Order Required')), frappe.bold('No'), get_link_to_form('Buying Settings', 'Buying Settings', 'Buying Settings')) + frappe.bold(_("Purchase Order Required")), + frappe.bold("No"), + get_link_to_form("Buying Settings", "Buying Settings", "Buying Settings"), + ) throw(msg, title=_("Mandatory Purchase Order")) def pr_required(self): stock_items = self.get_stock_items() - if frappe.db.get_value("Buying Settings", None, "pr_required") == 'Yes': + if frappe.db.get_value("Buying Settings", None, "pr_required") == "Yes": - if frappe.get_value('Supplier', self.supplier, 'allow_purchase_invoice_creation_without_purchase_receipt'): + if frappe.get_value( + "Supplier", self.supplier, "allow_purchase_invoice_creation_without_purchase_receipt" + ): return - for d in self.get('items'): + for d in self.get("items"): if not d.purchase_receipt and d.item_code in stock_items: msg = _("Purchase Receipt Required for item {}").format(frappe.bold(d.item_code)) msg += " " - msg += _("To submit the invoice without purchase receipt please set {0} as {1} in {2}").format( - frappe.bold(_('Purchase Receipt Required')), frappe.bold('No'), get_link_to_form('Buying Settings', 'Buying Settings', 'Buying Settings')) + msg += _( + "To submit the invoice without purchase receipt please set {0} as {1} in {2}" + ).format( + frappe.bold(_("Purchase Receipt Required")), + frappe.bold("No"), + get_link_to_form("Buying Settings", "Buying Settings", "Buying Settings"), + ) throw(msg, title=_("Mandatory Purchase Receipt")) def validate_write_off_account(self): @@ -351,56 +416,65 @@ class PurchaseInvoice(BuyingController): throw(_("Please enter Write Off Account")) def check_prev_docstatus(self): - for d in self.get('items'): + for d in self.get("items"): if d.purchase_order: - submitted = frappe.db.sql("select name from `tabPurchase Order` where docstatus = 1 and name = %s", d.purchase_order) + submitted = frappe.db.sql( + "select name from `tabPurchase Order` where docstatus = 1 and name = %s", d.purchase_order + ) if not submitted: frappe.throw(_("Purchase Order {0} is not submitted").format(d.purchase_order)) if d.purchase_receipt: - submitted = frappe.db.sql("select name from `tabPurchase Receipt` where docstatus = 1 and name = %s", d.purchase_receipt) + submitted = frappe.db.sql( + "select name from `tabPurchase Receipt` where docstatus = 1 and name = %s", d.purchase_receipt + ) if not submitted: frappe.throw(_("Purchase Receipt {0} is not submitted").format(d.purchase_receipt)) def update_status_updater_args(self): if cint(self.update_stock): - self.status_updater.append({ - 'source_dt': 'Purchase Invoice Item', - 'target_dt': 'Purchase Order Item', - 'join_field': 'po_detail', - 'target_field': 'received_qty', - 'target_parent_dt': 'Purchase Order', - 'target_parent_field': 'per_received', - 'target_ref_field': 'qty', - 'source_field': 'received_qty', - 'second_source_dt': 'Purchase Receipt Item', - 'second_source_field': 'received_qty', - 'second_join_field': 'purchase_order_item', - 'percent_join_field':'purchase_order', - 'overflow_type': 'receipt', - 'extra_cond': """ and exists(select name from `tabPurchase Invoice` - where name=`tabPurchase Invoice Item`.parent and update_stock = 1)""" - }) + self.status_updater.append( + { + "source_dt": "Purchase Invoice Item", + "target_dt": "Purchase Order Item", + "join_field": "po_detail", + "target_field": "received_qty", + "target_parent_dt": "Purchase Order", + "target_parent_field": "per_received", + "target_ref_field": "qty", + "source_field": "received_qty", + "second_source_dt": "Purchase Receipt Item", + "second_source_field": "received_qty", + "second_join_field": "purchase_order_item", + "percent_join_field": "purchase_order", + "overflow_type": "receipt", + "extra_cond": """ and exists(select name from `tabPurchase Invoice` + where name=`tabPurchase Invoice Item`.parent and update_stock = 1)""", + } + ) if cint(self.is_return): - self.status_updater.append({ - 'source_dt': 'Purchase Invoice Item', - 'target_dt': 'Purchase Order Item', - 'join_field': 'po_detail', - 'target_field': 'returned_qty', - 'source_field': '-1 * qty', - 'second_source_dt': 'Purchase Receipt Item', - 'second_source_field': '-1 * qty', - 'second_join_field': 'purchase_order_item', - 'overflow_type': 'receipt', - 'extra_cond': """ and exists (select name from `tabPurchase Invoice` - where name=`tabPurchase Invoice Item`.parent and update_stock=1 and is_return=1)""" - }) + self.status_updater.append( + { + "source_dt": "Purchase Invoice Item", + "target_dt": "Purchase Order Item", + "join_field": "po_detail", + "target_field": "returned_qty", + "source_field": "-1 * qty", + "second_source_dt": "Purchase Receipt Item", + "second_source_field": "-1 * qty", + "second_join_field": "purchase_order_item", + "overflow_type": "receipt", + "extra_cond": """ and exists (select name from `tabPurchase Invoice` + where name=`tabPurchase Invoice Item`.parent and update_stock=1 and is_return=1)""", + } + ) def validate_purchase_receipt_if_update_stock(self): if self.update_stock: for item in self.get("items"): if item.purchase_receipt: - frappe.throw(_("Stock cannot be updated against Purchase Receipt {0}") - .format(item.purchase_receipt)) + frappe.throw( + _("Stock cannot be updated against Purchase Receipt {0}").format(item.purchase_receipt) + ) def on_submit(self): super(PurchaseInvoice, self).on_submit() @@ -409,8 +483,9 @@ class PurchaseInvoice(BuyingController): self.update_status_updater_args() self.update_prevdoc_status() - frappe.get_doc('Authorization Control').validate_approving_authority(self.doctype, - self.company, self.base_grand_total) + frappe.get_doc("Authorization Control").validate_approving_authority( + self.doctype, self.company, self.base_grand_total + ) if not self.is_return: self.update_against_document_in_jv() @@ -425,6 +500,7 @@ class PurchaseInvoice(BuyingController): self.update_stock_ledger() self.set_consumed_qty_in_po() from erpnext.stock.doctype.serial_no.serial_no import update_serial_nos_after_submit + update_serial_nos_after_submit(self, "items") # this sequence because outstanding may get -negative @@ -447,13 +523,32 @@ class PurchaseInvoice(BuyingController): update_outstanding = "No" if (cint(self.is_paid) or self.write_off_account) else "Yes" if self.docstatus == 1: - make_gl_entries(gl_entries, update_outstanding=update_outstanding, merge_entries=False, from_repost=from_repost) + make_gl_entries( + gl_entries, + update_outstanding=update_outstanding, + merge_entries=False, + from_repost=from_repost, + ) elif self.docstatus == 2: + provisional_entries = [a for a in gl_entries if a.voucher_type == "Purchase Receipt"] make_reverse_gl_entries(voucher_type=self.doctype, voucher_no=self.name) + if provisional_entries: + for entry in provisional_entries: + frappe.db.set_value( + "GL Entry", + {"voucher_type": "Purchase Receipt", "voucher_detail_no": entry.voucher_detail_no}, + "is_cancelled", + 1, + ) if update_outstanding == "No": - update_outstanding_amt(self.credit_to, "Supplier", self.supplier, - self.doctype, self.return_against if cint(self.is_return) and self.return_against else self.name) + update_outstanding_amt( + self.credit_to, + "Supplier", + self.supplier, + self.doctype, + self.return_against if cint(self.is_return) and self.return_against else self.name, + ) elif self.docstatus == 2 and cint(self.update_stock) and self.auto_accounting_for_stock: make_reverse_gl_entries(voucher_type=self.doctype, voucher_no=self.name) @@ -472,7 +567,6 @@ class PurchaseInvoice(BuyingController): self.make_supplier_gl_entry(gl_entries) self.make_item_gl_entries(gl_entries) - self.make_discount_gl_entries(gl_entries) if self.check_asset_cwip_enabled(): self.get_asset_gl_entry(gl_entries) @@ -502,28 +596,41 @@ class PurchaseInvoice(BuyingController): def make_supplier_gl_entry(self, gl_entries): # Checked both rounding_adjustment and rounded_total # because rounded_total had value even before introcution of posting GLE based on rounded total - grand_total = self.rounded_total if (self.rounding_adjustment and self.rounded_total) else self.grand_total + grand_total = ( + self.rounded_total if (self.rounding_adjustment and self.rounded_total) else self.grand_total + ) + base_grand_total = flt( + self.base_rounded_total + if (self.base_rounding_adjustment and self.base_rounded_total) + else self.base_grand_total, + self.precision("base_grand_total"), + ) if grand_total and not self.is_internal_transfer(): - # Did not use base_grand_total to book rounding loss gle - grand_total_in_company_currency = flt(grand_total * self.conversion_rate, - self.precision("grand_total")) - gl_entries.append( - self.get_gl_dict({ + # Did not use base_grand_total to book rounding loss gle + gl_entries.append( + self.get_gl_dict( + { "account": self.credit_to, "party_type": "Supplier", "party": self.supplier, "due_date": self.due_date, "against": self.against_expense_account, - "credit": grand_total_in_company_currency, - "credit_in_account_currency": grand_total_in_company_currency \ - if self.party_account_currency==self.company_currency else grand_total, - "against_voucher": self.return_against if cint(self.is_return) and self.return_against else self.name, + "credit": base_grand_total, + "credit_in_account_currency": base_grand_total + if self.party_account_currency == self.company_currency + else grand_total, + "against_voucher": self.return_against + if cint(self.is_return) and self.return_against + else self.name, "against_voucher_type": self.doctype, "project": self.project, - "cost_center": self.cost_center - }, self.party_account_currency, item=self) + "cost_center": self.cost_center, + }, + self.party_account_currency, + item=self, ) + ) def make_item_gl_entries(self, gl_entries): # item gl entries @@ -535,13 +642,30 @@ class PurchaseInvoice(BuyingController): voucher_wise_stock_value = {} if self.update_stock: - for d in frappe.get_all('Stock Ledger Entry', - fields = ["voucher_detail_no", "stock_value_difference", "warehouse"], filters={'voucher_no': self.name}): - voucher_wise_stock_value.setdefault((d.voucher_detail_no, d.warehouse), d.stock_value_difference) + stock_ledger_entries = frappe.get_all( + "Stock Ledger Entry", + fields=["voucher_detail_no", "stock_value_difference", "warehouse"], + filters={"voucher_no": self.name, "voucher_type": self.doctype, "is_cancelled": 0}, + ) + for d in stock_ledger_entries: + voucher_wise_stock_value.setdefault( + (d.voucher_detail_no, d.warehouse), d.stock_value_difference + ) - valuation_tax_accounts = [d.account_head for d in self.get("taxes") - if d.category in ('Valuation', 'Total and Valuation') - and flt(d.base_tax_amount_after_discount_amount)] + valuation_tax_accounts = [ + d.account_head + for d in self.get("taxes") + if d.category in ("Valuation", "Total and Valuation") + and flt(d.base_tax_amount_after_discount_amount) + ] + + provisional_accounting_for_non_stock_items = cint( + frappe.db.get_value( + "Company", self.company, "enable_provisional_accounting_for_non_stock_items" + ) + ) + + purchase_receipt_doc_map = {} for item in self.get("items"): if flt(item.base_net_amount): @@ -551,167 +675,249 @@ class PurchaseInvoice(BuyingController): if self.update_stock and self.auto_accounting_for_stock and item.item_code in stock_items: # warehouse account - warehouse_debit_amount = self.make_stock_adjustment_entry(gl_entries, - item, voucher_wise_stock_value, account_currency) + warehouse_debit_amount = self.make_stock_adjustment_entry( + gl_entries, item, voucher_wise_stock_value, account_currency + ) if item.from_warehouse: - gl_entries.append(self.get_gl_dict({ - "account": warehouse_account[item.warehouse]['account'], - "against": warehouse_account[item.from_warehouse]["account"], - "cost_center": item.cost_center, - "project": item.project or self.project, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "debit": warehouse_debit_amount, - }, warehouse_account[item.warehouse]["account_currency"], item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": warehouse_account[item.warehouse]["account"], + "against": warehouse_account[item.from_warehouse]["account"], + "cost_center": item.cost_center, + "project": item.project or self.project, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "debit": warehouse_debit_amount, + }, + warehouse_account[item.warehouse]["account_currency"], + item=item, + ) + ) # Intentionally passed negative debit amount to avoid incorrect GL Entry validation - gl_entries.append(self.get_gl_dict({ - "account": warehouse_account[item.from_warehouse]['account'], - "against": warehouse_account[item.warehouse]["account"], - "cost_center": item.cost_center, - "project": item.project or self.project, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "debit": -1 * flt(item.base_net_amount, item.precision("base_net_amount")), - }, warehouse_account[item.from_warehouse]["account_currency"], item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": warehouse_account[item.from_warehouse]["account"], + "against": warehouse_account[item.warehouse]["account"], + "cost_center": item.cost_center, + "project": item.project or self.project, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "debit": -1 * flt(item.base_net_amount, item.precision("base_net_amount")), + }, + warehouse_account[item.from_warehouse]["account_currency"], + item=item, + ) + ) # Do not book expense for transfer within same company transfer if not self.is_internal_transfer(): gl_entries.append( - self.get_gl_dict({ - "account": item.expense_account, - "against": self.supplier, - "debit": flt(item.base_net_amount, item.precision("base_net_amount")), - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "cost_center": item.cost_center, - "project": item.project - }, account_currency, item=item) + self.get_gl_dict( + { + "account": item.expense_account, + "against": self.supplier, + "debit": flt(item.base_net_amount, item.precision("base_net_amount")), + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "cost_center": item.cost_center, + "project": item.project, + }, + account_currency, + item=item, + ) ) else: if not self.is_internal_transfer(): gl_entries.append( - self.get_gl_dict({ - "account": item.expense_account, - "against": self.supplier, - "debit": warehouse_debit_amount, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "cost_center": item.cost_center, - "project": item.project or self.project - }, account_currency, item=item) + self.get_gl_dict( + { + "account": item.expense_account, + "against": self.supplier, + "debit": warehouse_debit_amount, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "cost_center": item.cost_center, + "project": item.project or self.project, + }, + account_currency, + item=item, + ) ) # Amount added through landed-cost-voucher if landed_cost_entries: for account, amount in iteritems(landed_cost_entries[(item.item_code, item.name)]): - gl_entries.append(self.get_gl_dict({ - "account": account, - "against": item.expense_account, - "cost_center": item.cost_center, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "credit": flt(amount["base_amount"]), - "credit_in_account_currency": flt(amount["amount"]), - "project": item.project or self.project - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": account, + "against": item.expense_account, + "cost_center": item.cost_center, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "credit": flt(amount["base_amount"]), + "credit_in_account_currency": flt(amount["amount"]), + "project": item.project or self.project, + }, + item=item, + ) + ) # sub-contracting warehouse if flt(item.rm_supp_cost): supplier_warehouse_account = warehouse_account[self.supplier_warehouse]["account"] if not supplier_warehouse_account: - frappe.throw(_("Please set account in Warehouse {0}") - .format(self.supplier_warehouse)) - gl_entries.append(self.get_gl_dict({ - "account": supplier_warehouse_account, - "against": item.expense_account, - "cost_center": item.cost_center, - "project": item.project or self.project, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "credit": flt(item.rm_supp_cost) - }, warehouse_account[self.supplier_warehouse]["account_currency"], item=item)) + frappe.throw(_("Please set account in Warehouse {0}").format(self.supplier_warehouse)) + gl_entries.append( + self.get_gl_dict( + { + "account": supplier_warehouse_account, + "against": item.expense_account, + "cost_center": item.cost_center, + "project": item.project or self.project, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "credit": flt(item.rm_supp_cost), + }, + warehouse_account[self.supplier_warehouse]["account_currency"], + item=item, + ) + ) - elif not item.is_fixed_asset or (item.is_fixed_asset and not is_cwip_accounting_enabled(asset_category)): - expense_account = (item.expense_account - if (not item.enable_deferred_expense or self.is_return) else item.deferred_expense_account) + elif not item.is_fixed_asset or ( + item.is_fixed_asset and not is_cwip_accounting_enabled(asset_category) + ): + expense_account = ( + item.expense_account + if (not item.enable_deferred_expense or self.is_return) + else item.deferred_expense_account + ) if not item.is_fixed_asset: - dummy, amount = self.get_amount_and_base_amount(item, self.enable_discount_accounting) + dummy, amount = self.get_amount_and_base_amount(item, None) else: amount = flt(item.base_net_amount + item.item_tax_amount, item.precision("base_net_amount")) - auto_accounting_for_non_stock_items = cint(frappe.db.get_value('Company', self.company, 'enable_perpetual_inventory_for_non_stock_items')) - - if auto_accounting_for_non_stock_items: - service_received_but_not_billed_account = self.get_company_default("service_received_but_not_billed") - + if provisional_accounting_for_non_stock_items: if item.purchase_receipt: + provisional_account = frappe.db.get_value( + "Purchase Receipt Item", item.pr_detail, "provisional_expense_account" + ) or self.get_company_default("default_provisional_account") + purchase_receipt_doc = purchase_receipt_doc_map.get(item.purchase_receipt) + + if not purchase_receipt_doc: + purchase_receipt_doc = frappe.get_doc("Purchase Receipt", item.purchase_receipt) + purchase_receipt_doc_map[item.purchase_receipt] = purchase_receipt_doc + # Post reverse entry for Stock-Received-But-Not-Billed if it is booked in Purchase Receipt - expense_booked_in_pr = frappe.db.get_value('GL Entry', {'is_cancelled': 0, - 'voucher_type': 'Purchase Receipt', 'voucher_no': item.purchase_receipt, 'voucher_detail_no': item.pr_detail, - 'account':service_received_but_not_billed_account}, ['name']) + expense_booked_in_pr = frappe.db.get_value( + "GL Entry", + { + "is_cancelled": 0, + "voucher_type": "Purchase Receipt", + "voucher_no": item.purchase_receipt, + "voucher_detail_no": item.pr_detail, + "account": provisional_account, + }, + ["name"], + ) if expense_booked_in_pr: - expense_account = service_received_but_not_billed_account + # Intentionally passing purchase invoice item to handle partial billing + purchase_receipt_doc.add_provisional_gl_entry( + item, gl_entries, self.posting_date, provisional_account, reverse=1 + ) if not self.is_internal_transfer(): - gl_entries.append(self.get_gl_dict({ - "account": expense_account, - "against": self.supplier, - "debit": amount, - "cost_center": item.cost_center, - "project": item.project or self.project - }, account_currency, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": expense_account, + "against": self.supplier, + "debit": amount, + "cost_center": item.cost_center, + "project": item.project or self.project, + }, + account_currency, + item=item, + ) + ) # If asset is bought through this document and not linked to PR if self.update_stock and item.landed_cost_voucher_amount: - expenses_included_in_asset_valuation = self.get_company_default("expenses_included_in_asset_valuation") + expenses_included_in_asset_valuation = self.get_company_default( + "expenses_included_in_asset_valuation" + ) # Amount added through landed-cost-voucher - gl_entries.append(self.get_gl_dict({ - "account": expenses_included_in_asset_valuation, - "against": expense_account, - "cost_center": item.cost_center, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "credit": flt(item.landed_cost_voucher_amount), - "project": item.project or self.project - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": expenses_included_in_asset_valuation, + "against": expense_account, + "cost_center": item.cost_center, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "credit": flt(item.landed_cost_voucher_amount), + "project": item.project or self.project, + }, + item=item, + ) + ) - gl_entries.append(self.get_gl_dict({ - "account": expense_account, - "against": expenses_included_in_asset_valuation, - "cost_center": item.cost_center, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "debit": flt(item.landed_cost_voucher_amount), - "project": item.project or self.project - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": expense_account, + "against": expenses_included_in_asset_valuation, + "cost_center": item.cost_center, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "debit": flt(item.landed_cost_voucher_amount), + "project": item.project or self.project, + }, + item=item, + ) + ) # update gross amount of asset bought through this document - assets = frappe.db.get_all('Asset', - filters={ 'purchase_invoice': self.name, 'item_code': item.item_code } + assets = frappe.db.get_all( + "Asset", filters={"purchase_invoice": self.name, "item_code": item.item_code} ) for asset in assets: frappe.db.set_value("Asset", asset.name, "gross_purchase_amount", flt(item.valuation_rate)) - frappe.db.set_value("Asset", asset.name, "purchase_receipt_amount", flt(item.valuation_rate)) + frappe.db.set_value( + "Asset", asset.name, "purchase_receipt_amount", flt(item.valuation_rate) + ) - if self.auto_accounting_for_stock and self.is_opening == "No" and \ - item.item_code in stock_items and item.item_tax_amount: - # Post reverse entry for Stock-Received-But-Not-Billed if it is booked in Purchase Receipt - if item.purchase_receipt and valuation_tax_accounts: - negative_expense_booked_in_pr = frappe.db.sql("""select name from `tabGL Entry` + if ( + self.auto_accounting_for_stock + and self.is_opening == "No" + and item.item_code in stock_items + and item.item_tax_amount + ): + # Post reverse entry for Stock-Received-But-Not-Billed if it is booked in Purchase Receipt + if item.purchase_receipt and valuation_tax_accounts: + negative_expense_booked_in_pr = frappe.db.sql( + """select name from `tabGL Entry` where voucher_type='Purchase Receipt' and voucher_no=%s and account in %s""", - (item.purchase_receipt, valuation_tax_accounts)) + (item.purchase_receipt, valuation_tax_accounts), + ) - if not negative_expense_booked_in_pr: - gl_entries.append( - self.get_gl_dict({ + if not negative_expense_booked_in_pr: + gl_entries.append( + self.get_gl_dict( + { "account": self.stock_received_but_not_billed, "against": self.supplier, "debit": flt(item.item_tax_amount, item.precision("item_tax_amount")), "remarks": self.remarks or _("Accounting Entry for Stock"), "cost_center": self.cost_center, - "project": item.project or self.project - }, item=item) + "project": item.project or self.project, + }, + item=item, ) + ) - self.negative_expense_to_be_booked += flt(item.item_tax_amount, \ - item.precision("item_tax_amount")) + self.negative_expense_to_be_booked += flt( + item.item_tax_amount, item.precision("item_tax_amount") + ) def get_asset_gl_entry(self, gl_entries): arbnb_account = self.get_company_default("asset_received_but_not_billed") @@ -719,125 +925,179 @@ class PurchaseInvoice(BuyingController): for item in self.get("items"): if item.is_fixed_asset: - asset_amount = flt(item.net_amount) + flt(item.item_tax_amount/self.conversion_rate) + asset_amount = flt(item.net_amount) + flt(item.item_tax_amount / self.conversion_rate) base_asset_amount = flt(item.base_net_amount + item.item_tax_amount) - item_exp_acc_type = frappe.db.get_value('Account', item.expense_account, 'account_type') - if (not item.expense_account or item_exp_acc_type not in ['Asset Received But Not Billed', 'Fixed Asset']): + item_exp_acc_type = frappe.db.get_value("Account", item.expense_account, "account_type") + if not item.expense_account or item_exp_acc_type not in [ + "Asset Received But Not Billed", + "Fixed Asset", + ]: item.expense_account = arbnb_account if not self.update_stock: arbnb_currency = get_account_currency(item.expense_account) - gl_entries.append(self.get_gl_dict({ - "account": item.expense_account, - "against": self.supplier, - "remarks": self.get("remarks") or _("Accounting Entry for Asset"), - "debit": base_asset_amount, - "debit_in_account_currency": (base_asset_amount - if arbnb_currency == self.company_currency else asset_amount), - "cost_center": item.cost_center, - "project": item.project or self.project - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": item.expense_account, + "against": self.supplier, + "remarks": self.get("remarks") or _("Accounting Entry for Asset"), + "debit": base_asset_amount, + "debit_in_account_currency": ( + base_asset_amount if arbnb_currency == self.company_currency else asset_amount + ), + "cost_center": item.cost_center, + "project": item.project or self.project, + }, + item=item, + ) + ) if item.item_tax_amount: asset_eiiav_currency = get_account_currency(eiiav_account) - gl_entries.append(self.get_gl_dict({ - "account": eiiav_account, - "against": self.supplier, - "remarks": self.get("remarks") or _("Accounting Entry for Asset"), - "cost_center": item.cost_center, - "project": item.project or self.project, - "credit": item.item_tax_amount, - "credit_in_account_currency": (item.item_tax_amount - if asset_eiiav_currency == self.company_currency else - item.item_tax_amount / self.conversion_rate) - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": eiiav_account, + "against": self.supplier, + "remarks": self.get("remarks") or _("Accounting Entry for Asset"), + "cost_center": item.cost_center, + "project": item.project or self.project, + "credit": item.item_tax_amount, + "credit_in_account_currency": ( + item.item_tax_amount + if asset_eiiav_currency == self.company_currency + else item.item_tax_amount / self.conversion_rate + ), + }, + item=item, + ) + ) else: - cwip_account = get_asset_account("capital_work_in_progress_account", - asset_category=item.asset_category,company=self.company) + cwip_account = get_asset_account( + "capital_work_in_progress_account", asset_category=item.asset_category, company=self.company + ) cwip_account_currency = get_account_currency(cwip_account) - gl_entries.append(self.get_gl_dict({ - "account": cwip_account, - "against": self.supplier, - "remarks": self.get("remarks") or _("Accounting Entry for Asset"), - "debit": base_asset_amount, - "debit_in_account_currency": (base_asset_amount - if cwip_account_currency == self.company_currency else asset_amount), - "cost_center": self.cost_center, - "project": item.project or self.project - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": cwip_account, + "against": self.supplier, + "remarks": self.get("remarks") or _("Accounting Entry for Asset"), + "debit": base_asset_amount, + "debit_in_account_currency": ( + base_asset_amount if cwip_account_currency == self.company_currency else asset_amount + ), + "cost_center": self.cost_center, + "project": item.project or self.project, + }, + item=item, + ) + ) if item.item_tax_amount and not cint(erpnext.is_perpetual_inventory_enabled(self.company)): asset_eiiav_currency = get_account_currency(eiiav_account) - gl_entries.append(self.get_gl_dict({ - "account": eiiav_account, - "against": self.supplier, - "remarks": self.get("remarks") or _("Accounting Entry for Asset"), - "cost_center": item.cost_center, - "credit": item.item_tax_amount, - "project": item.project or self.project, - "credit_in_account_currency": (item.item_tax_amount - if asset_eiiav_currency == self.company_currency else - item.item_tax_amount / self.conversion_rate) - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": eiiav_account, + "against": self.supplier, + "remarks": self.get("remarks") or _("Accounting Entry for Asset"), + "cost_center": item.cost_center, + "credit": item.item_tax_amount, + "project": item.project or self.project, + "credit_in_account_currency": ( + item.item_tax_amount + if asset_eiiav_currency == self.company_currency + else item.item_tax_amount / self.conversion_rate + ), + }, + item=item, + ) + ) # When update stock is checked # Assets are bought through this document then it will be linked to this document if self.update_stock: if flt(item.landed_cost_voucher_amount): - gl_entries.append(self.get_gl_dict({ - "account": eiiav_account, - "against": cwip_account, - "cost_center": item.cost_center, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "credit": flt(item.landed_cost_voucher_amount), - "project": item.project or self.project - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": eiiav_account, + "against": cwip_account, + "cost_center": item.cost_center, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "credit": flt(item.landed_cost_voucher_amount), + "project": item.project or self.project, + }, + item=item, + ) + ) - gl_entries.append(self.get_gl_dict({ - "account": cwip_account, - "against": eiiav_account, - "cost_center": item.cost_center, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "debit": flt(item.landed_cost_voucher_amount), - "project": item.project or self.project - }, item=item)) + gl_entries.append( + self.get_gl_dict( + { + "account": cwip_account, + "against": eiiav_account, + "cost_center": item.cost_center, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "debit": flt(item.landed_cost_voucher_amount), + "project": item.project or self.project, + }, + item=item, + ) + ) # update gross amount of assets bought through this document - assets = frappe.db.get_all('Asset', - filters={ 'purchase_invoice': self.name, 'item_code': item.item_code } + assets = frappe.db.get_all( + "Asset", filters={"purchase_invoice": self.name, "item_code": item.item_code} ) for asset in assets: frappe.db.set_value("Asset", asset.name, "gross_purchase_amount", flt(item.valuation_rate)) - frappe.db.set_value("Asset", asset.name, "purchase_receipt_amount", flt(item.valuation_rate)) + frappe.db.set_value( + "Asset", asset.name, "purchase_receipt_amount", flt(item.valuation_rate) + ) return gl_entries - def make_stock_adjustment_entry(self, gl_entries, item, voucher_wise_stock_value, account_currency): + def make_stock_adjustment_entry( + self, gl_entries, item, voucher_wise_stock_value, account_currency + ): net_amt_precision = item.precision("base_net_amount") val_rate_db_precision = 6 if cint(item.precision("valuation_rate")) <= 6 else 9 - warehouse_debit_amount = flt(flt(item.valuation_rate, val_rate_db_precision) - * flt(item.qty) * flt(item.conversion_factor), net_amt_precision) + warehouse_debit_amount = flt( + flt(item.valuation_rate, val_rate_db_precision) * flt(item.qty) * flt(item.conversion_factor), + net_amt_precision, + ) # Stock ledger value is not matching with the warehouse amount - if (self.update_stock and voucher_wise_stock_value.get(item.name) and - warehouse_debit_amount != flt(voucher_wise_stock_value.get((item.name, item.warehouse)), net_amt_precision)): + if ( + self.update_stock + and voucher_wise_stock_value.get((item.name, item.warehouse)) + and warehouse_debit_amount + != flt(voucher_wise_stock_value.get((item.name, item.warehouse)), net_amt_precision) + ): cost_of_goods_sold_account = self.get_company_default("default_expense_account") stock_amount = flt(voucher_wise_stock_value.get((item.name, item.warehouse)), net_amt_precision) stock_adjustment_amt = warehouse_debit_amount - stock_amount gl_entries.append( - self.get_gl_dict({ - "account": cost_of_goods_sold_account, - "against": item.expense_account, - "debit": stock_adjustment_amt, - "remarks": self.get("remarks") or _("Stock Adjustment"), - "cost_center": item.cost_center, - "project": item.project or self.project - }, account_currency, item=item) + self.get_gl_dict( + { + "account": cost_of_goods_sold_account, + "against": item.expense_account, + "debit": stock_adjustment_amt, + "remarks": self.get("remarks") or _("Stock Adjustment"), + "cost_center": item.cost_center, + "project": item.project or self.project, + }, + account_currency, + item=item, + ) ) warehouse_debit_amount = stock_amount @@ -849,31 +1109,42 @@ class PurchaseInvoice(BuyingController): valuation_tax = {} for tax in self.get("taxes"): - amount, base_amount = self.get_tax_amounts(tax, self.enable_discount_accounting) + amount, base_amount = self.get_tax_amounts(tax, None) if tax.category in ("Total", "Valuation and Total") and flt(base_amount): account_currency = get_account_currency(tax.account_head) dr_or_cr = "debit" if tax.add_deduct_tax == "Add" else "credit" gl_entries.append( - self.get_gl_dict({ - "account": tax.account_head, - "against": self.supplier, - dr_or_cr: base_amount, - dr_or_cr + "_in_account_currency": base_amount - if account_currency==self.company_currency + self.get_gl_dict( + { + "account": tax.account_head, + "against": self.supplier, + dr_or_cr: base_amount, + dr_or_cr + "_in_account_currency": base_amount + if account_currency == self.company_currency else amount, - "cost_center": tax.cost_center - }, account_currency, item=tax) + "cost_center": tax.cost_center, + }, + account_currency, + item=tax, + ) ) # accumulate valuation tax - if self.is_opening == "No" and tax.category in ("Valuation", "Valuation and Total") and flt(base_amount) \ - and not self.is_internal_transfer(): + if ( + self.is_opening == "No" + and tax.category in ("Valuation", "Valuation and Total") + and flt(base_amount) + and not self.is_internal_transfer() + ): if self.auto_accounting_for_stock and not tax.cost_center: - frappe.throw(_("Cost Center is required in row {0} in Taxes table for type {1}").format(tax.idx, _(tax.category))) + frappe.throw( + _("Cost Center is required in row {0} in Taxes table for type {1}").format( + tax.idx, _(tax.category) + ) + ) valuation_tax.setdefault(tax.name, 0) - valuation_tax[tax.name] += \ - (tax.add_deduct_tax == "Add" and 1 or -1) * flt(base_amount) + valuation_tax[tax.name] += (tax.add_deduct_tax == "Add" and 1 or -1) * flt(base_amount) if self.is_opening == "No" and self.negative_expense_to_be_booked and valuation_tax: # credit valuation tax amount in "Expenses Included In Valuation" @@ -887,17 +1158,22 @@ class PurchaseInvoice(BuyingController): if i == len(valuation_tax): applicable_amount = amount_including_divisional_loss else: - applicable_amount = self.negative_expense_to_be_booked * (valuation_tax[tax.name] / total_valuation_amount) + applicable_amount = self.negative_expense_to_be_booked * ( + valuation_tax[tax.name] / total_valuation_amount + ) amount_including_divisional_loss -= applicable_amount gl_entries.append( - self.get_gl_dict({ - "account": tax.account_head, - "cost_center": tax.cost_center, - "against": self.supplier, - "credit": applicable_amount, - "remarks": self.remarks or _("Accounting Entry for Stock"), - }, item=tax) + self.get_gl_dict( + { + "account": tax.account_head, + "cost_center": tax.cost_center, + "against": self.supplier, + "credit": applicable_amount, + "remarks": self.remarks or _("Accounting Entry for Stock"), + }, + item=tax, + ) ) i += 1 @@ -906,18 +1182,24 @@ class PurchaseInvoice(BuyingController): for tax in self.get("taxes"): if valuation_tax.get(tax.name): gl_entries.append( - self.get_gl_dict({ - "account": tax.account_head, - "cost_center": tax.cost_center, - "against": self.supplier, - "credit": valuation_tax[tax.name], - "remarks": self.remarks or _("Accounting Entry for Stock") - }, item=tax)) + self.get_gl_dict( + { + "account": tax.account_head, + "cost_center": tax.cost_center, + "against": self.supplier, + "credit": valuation_tax[tax.name], + "remarks": self.remarks or _("Accounting Entry for Stock"), + }, + item=tax, + ) + ) @property def enable_discount_accounting(self): if not hasattr(self, "_enable_discount_accounting"): - self._enable_discount_accounting = cint(frappe.db.get_single_value('Accounts Settings', 'enable_discount_accounting')) + self._enable_discount_accounting = cint( + frappe.db.get_single_value("Accounts Settings", "enable_discount_accounting") + ) return self._enable_discount_accounting @@ -925,13 +1207,18 @@ class PurchaseInvoice(BuyingController): if self.is_internal_transfer() and flt(self.base_total_taxes_and_charges): account_currency = get_account_currency(self.unrealized_profit_loss_account) gl_entries.append( - self.get_gl_dict({ - "account": self.unrealized_profit_loss_account, - "against": self.supplier, - "credit": flt(self.total_taxes_and_charges), - "credit_in_account_currency": flt(self.base_total_taxes_and_charges), - "cost_center": self.cost_center - }, account_currency, item=self)) + self.get_gl_dict( + { + "account": self.unrealized_profit_loss_account, + "against": self.supplier, + "credit": flt(self.total_taxes_and_charges), + "credit_in_account_currency": flt(self.base_total_taxes_and_charges), + "cost_center": self.cost_center, + }, + account_currency, + item=self, + ) + ) def make_payment_gl_entries(self, gl_entries): # Make Cash GL Entries @@ -939,30 +1226,42 @@ class PurchaseInvoice(BuyingController): bank_account_currency = get_account_currency(self.cash_bank_account) # CASH, make payment entries gl_entries.append( - self.get_gl_dict({ - "account": self.credit_to, - "party_type": "Supplier", - "party": self.supplier, - "against": self.cash_bank_account, - "debit": self.base_paid_amount, - "debit_in_account_currency": self.base_paid_amount \ - if self.party_account_currency==self.company_currency else self.paid_amount, - "against_voucher": self.return_against if cint(self.is_return) and self.return_against else self.name, - "against_voucher_type": self.doctype, - "cost_center": self.cost_center, - "project": self.project - }, self.party_account_currency, item=self) + self.get_gl_dict( + { + "account": self.credit_to, + "party_type": "Supplier", + "party": self.supplier, + "against": self.cash_bank_account, + "debit": self.base_paid_amount, + "debit_in_account_currency": self.base_paid_amount + if self.party_account_currency == self.company_currency + else self.paid_amount, + "against_voucher": self.return_against + if cint(self.is_return) and self.return_against + else self.name, + "against_voucher_type": self.doctype, + "cost_center": self.cost_center, + "project": self.project, + }, + self.party_account_currency, + item=self, + ) ) gl_entries.append( - self.get_gl_dict({ - "account": self.cash_bank_account, - "against": self.supplier, - "credit": self.base_paid_amount, - "credit_in_account_currency": self.base_paid_amount \ - if bank_account_currency==self.company_currency else self.paid_amount, - "cost_center": self.cost_center - }, bank_account_currency, item=self) + self.get_gl_dict( + { + "account": self.cash_bank_account, + "against": self.supplier, + "credit": self.base_paid_amount, + "credit_in_account_currency": self.base_paid_amount + if bank_account_currency == self.company_currency + else self.paid_amount, + "cost_center": self.cost_center, + }, + bank_account_currency, + item=self, + ) ) def make_write_off_gl_entry(self, gl_entries): @@ -972,48 +1271,66 @@ class PurchaseInvoice(BuyingController): write_off_account_currency = get_account_currency(self.write_off_account) gl_entries.append( - self.get_gl_dict({ - "account": self.credit_to, - "party_type": "Supplier", - "party": self.supplier, - "against": self.write_off_account, - "debit": self.base_write_off_amount, - "debit_in_account_currency": self.base_write_off_amount \ - if self.party_account_currency==self.company_currency else self.write_off_amount, - "against_voucher": self.return_against if cint(self.is_return) and self.return_against else self.name, - "against_voucher_type": self.doctype, - "cost_center": self.cost_center, - "project": self.project - }, self.party_account_currency, item=self) + self.get_gl_dict( + { + "account": self.credit_to, + "party_type": "Supplier", + "party": self.supplier, + "against": self.write_off_account, + "debit": self.base_write_off_amount, + "debit_in_account_currency": self.base_write_off_amount + if self.party_account_currency == self.company_currency + else self.write_off_amount, + "against_voucher": self.return_against + if cint(self.is_return) and self.return_against + else self.name, + "against_voucher_type": self.doctype, + "cost_center": self.cost_center, + "project": self.project, + }, + self.party_account_currency, + item=self, + ) ) gl_entries.append( - self.get_gl_dict({ - "account": self.write_off_account, - "against": self.supplier, - "credit": flt(self.base_write_off_amount), - "credit_in_account_currency": self.base_write_off_amount \ - if write_off_account_currency==self.company_currency else self.write_off_amount, - "cost_center": self.cost_center or self.write_off_cost_center - }, item=self) + self.get_gl_dict( + { + "account": self.write_off_account, + "against": self.supplier, + "credit": flt(self.base_write_off_amount), + "credit_in_account_currency": self.base_write_off_amount + if write_off_account_currency == self.company_currency + else self.write_off_amount, + "cost_center": self.cost_center or self.write_off_cost_center, + }, + item=self, + ) ) def make_gle_for_rounding_adjustment(self, gl_entries): # if rounding adjustment in small and conversion rate is also small then # base_rounding_adjustment may become zero due to small precision # eg: rounding_adjustment = 0.01 and exchange rate = 0.05 and precision of base_rounding_adjustment is 2 - # then base_rounding_adjustment becomes zero and error is thrown in GL Entry - if not self.is_internal_transfer() and self.rounding_adjustment and self.base_rounding_adjustment: - round_off_account, round_off_cost_center = \ - get_round_off_account_and_cost_center(self.company) + # then base_rounding_adjustment becomes zero and error is thrown in GL Entry + if ( + not self.is_internal_transfer() and self.rounding_adjustment and self.base_rounding_adjustment + ): + round_off_account, round_off_cost_center = get_round_off_account_and_cost_center( + self.company, "Purchase Invoice", self.name + ) gl_entries.append( - self.get_gl_dict({ - "account": round_off_account, - "against": self.supplier, - "debit_in_account_currency": self.rounding_adjustment, - "debit": self.base_rounding_adjustment, - "cost_center": self.cost_center or round_off_cost_center, - }, item=self)) + self.get_gl_dict( + { + "account": round_off_account, + "against": self.supplier, + "debit_in_account_currency": self.rounding_adjustment, + "debit": self.base_rounding_adjustment, + "cost_center": self.cost_center or round_off_cost_center, + }, + item=self, + ) + ) def on_cancel(self): check_if_return_invoice_linked_with_payment_entry(self) @@ -1044,10 +1361,10 @@ class PurchaseInvoice(BuyingController): self.repost_future_sle_and_gle() self.update_project() - frappe.db.set(self, 'status', 'Cancelled') + frappe.db.set(self, "status", "Cancelled") unlink_inter_company_doc(self.doctype, self.name, self.inter_company_invoice_reference) - self.ignore_linked_doctypes = ('GL Entry', 'Stock Ledger Entry', 'Repost Item Valuation') + self.ignore_linked_doctypes = ("GL Entry", "Stock Ledger Entry", "Repost Item Valuation") self.update_advance_tax_references(cancel=1) def update_project(self): @@ -1068,19 +1385,22 @@ class PurchaseInvoice(BuyingController): if cint(frappe.db.get_single_value("Accounts Settings", "check_supplier_invoice_uniqueness")): fiscal_year = get_fiscal_year(self.posting_date, company=self.company, as_dict=True) - pi = frappe.db.sql('''select name from `tabPurchase Invoice` + pi = frappe.db.sql( + """select name from `tabPurchase Invoice` where bill_no = %(bill_no)s and supplier = %(supplier)s and name != %(name)s and docstatus < 2 - and posting_date between %(year_start_date)s and %(year_end_date)s''', { - "bill_no": self.bill_no, - "supplier": self.supplier, - "name": self.name, - "year_start_date": fiscal_year.year_start_date, - "year_end_date": fiscal_year.year_end_date - }) + and posting_date between %(year_start_date)s and %(year_end_date)s""", + { + "bill_no": self.bill_no, + "supplier": self.supplier, + "name": self.name, + "year_start_date": fiscal_year.year_start_date, + "year_end_date": fiscal_year.year_end_date, + }, + ) if pi: pi = pi[0][0] @@ -1090,16 +1410,26 @@ class PurchaseInvoice(BuyingController): updated_pr = [] for d in self.get("items"): if d.pr_detail: - billed_amt = frappe.db.sql("""select sum(amount) from `tabPurchase Invoice Item` - where pr_detail=%s and docstatus=1""", d.pr_detail) + billed_amt = frappe.db.sql( + """select sum(amount) from `tabPurchase Invoice Item` + where pr_detail=%s and docstatus=1""", + d.pr_detail, + ) billed_amt = billed_amt and billed_amt[0][0] or 0 - frappe.db.set_value("Purchase Receipt Item", d.pr_detail, "billed_amt", billed_amt, update_modified=update_modified) + frappe.db.set_value( + "Purchase Receipt Item", + d.pr_detail, + "billed_amt", + billed_amt, + update_modified=update_modified, + ) updated_pr.append(d.purchase_receipt) elif d.po_detail: updated_pr += update_billed_amount_based_on_po(d.po_detail, update_modified) for pr in set(updated_pr): from erpnext.stock.doctype.purchase_receipt.purchase_receipt import update_billing_percentage + pr_doc = frappe.get_doc("Purchase Receipt", pr) update_billing_percentage(pr_doc, update_modified=update_modified) @@ -1107,25 +1437,29 @@ class PurchaseInvoice(BuyingController): self.due_date = None def block_invoice(self, hold_comment=None, release_date=None): - self.db_set('on_hold', 1) - self.db_set('hold_comment', cstr(hold_comment)) - self.db_set('release_date', release_date) + self.db_set("on_hold", 1) + self.db_set("hold_comment", cstr(hold_comment)) + self.db_set("release_date", release_date) def unblock_invoice(self): - self.db_set('on_hold', 0) - self.db_set('release_date', None) + self.db_set("on_hold", 0) + self.db_set("release_date", None) def set_tax_withholding(self): if not self.apply_tds: return - if self.apply_tds and not self.get('tax_withholding_category'): - self.tax_withholding_category = frappe.db.get_value('Supplier', self.supplier, 'tax_withholding_category') + if self.apply_tds and not self.get("tax_withholding_category"): + self.tax_withholding_category = frappe.db.get_value( + "Supplier", self.supplier, "tax_withholding_category" + ) if not self.tax_withholding_category: return - tax_withholding_details, advance_taxes = get_party_tax_withholding_details(self, self.tax_withholding_category) + tax_withholding_details, advance_taxes, voucher_wise_amount = get_party_tax_withholding_details( + self, self.tax_withholding_category + ) # Adjust TDS paid on advances self.allocate_advance_tds(tax_withholding_details, advance_taxes) @@ -1143,37 +1477,59 @@ class PurchaseInvoice(BuyingController): if not accounts or tax_withholding_details.get("account_head") not in accounts: self.append("taxes", tax_withholding_details) - to_remove = [d for d in self.taxes - if not d.tax_amount and d.account_head == tax_withholding_details.get("account_head")] + to_remove = [ + d + for d in self.taxes + if not d.tax_amount and d.account_head == tax_withholding_details.get("account_head") + ] for d in to_remove: self.remove(d) + ## Add pending vouchers on which tax was withheld + self.set("tax_withheld_vouchers", []) + + for voucher_no, voucher_details in voucher_wise_amount.items(): + self.append( + "tax_withheld_vouchers", + { + "voucher_name": voucher_no, + "voucher_type": voucher_details.get("voucher_type"), + "taxable_amount": voucher_details.get("amount"), + }, + ) + # calculate totals again after applying TDS self.calculate_taxes_and_totals() def allocate_advance_tds(self, tax_withholding_details, advance_taxes): - self.set('advance_tax', []) + self.set("advance_tax", []) for tax in advance_taxes: allocated_amount = 0 pending_amount = flt(tax.tax_amount - tax.allocated_amount) - if flt(tax_withholding_details.get('tax_amount')) >= pending_amount: - tax_withholding_details['tax_amount'] -= pending_amount + if flt(tax_withholding_details.get("tax_amount")) >= pending_amount: + tax_withholding_details["tax_amount"] -= pending_amount allocated_amount = pending_amount - elif flt(tax_withholding_details.get('tax_amount')) and flt(tax_withholding_details.get('tax_amount')) < pending_amount: - allocated_amount = tax_withholding_details['tax_amount'] - tax_withholding_details['tax_amount'] = 0 + elif ( + flt(tax_withholding_details.get("tax_amount")) + and flt(tax_withholding_details.get("tax_amount")) < pending_amount + ): + allocated_amount = tax_withholding_details["tax_amount"] + tax_withholding_details["tax_amount"] = 0 - self.append('advance_tax', { - 'reference_type': 'Payment Entry', - 'reference_name': tax.parent, - 'reference_detail': tax.name, - 'account_head': tax.account_head, - 'allocated_amount': allocated_amount - }) + self.append( + "advance_tax", + { + "reference_type": "Payment Entry", + "reference_name": tax.parent, + "reference_detail": tax.name, + "account_head": tax.account_head, + "allocated_amount": allocated_amount, + }, + ) def update_advance_tax_references(self, cancel=0): - for tax in self.get('advance_tax'): + for tax in self.get("advance_tax"): at = frappe.qb.DocType("Advance Taxes and Charges").as_("at") if cancel: @@ -1187,8 +1543,8 @@ class PurchaseInvoice(BuyingController): def set_status(self, update=False, status=None, update_modified=True): if self.is_new(): - if self.get('amended_from'): - self.status = 'Draft' + if self.get("amended_from"): + self.status = "Draft" return outstanding_amount = flt(self.outstanding_amount, self.precision("outstanding_amount")) @@ -1199,19 +1555,25 @@ class PurchaseInvoice(BuyingController): status = "Cancelled" elif self.docstatus == 1: if self.is_internal_transfer(): - self.status = 'Internal Transfer' + self.status = "Internal Transfer" elif is_overdue(self, total): self.status = "Overdue" elif 0 < outstanding_amount < total: self.status = "Partly Paid" elif outstanding_amount > 0 and getdate(self.due_date) >= getdate(): self.status = "Unpaid" - #Check if outstanding amount is 0 due to debit note issued against invoice - elif outstanding_amount <= 0 and self.is_return == 0 and frappe.db.get_value('Purchase Invoice', {'is_return': 1, 'return_against': self.name, 'docstatus': 1}): + # Check if outstanding amount is 0 due to debit note issued against invoice + elif ( + outstanding_amount <= 0 + and self.is_return == 0 + and frappe.db.get_value( + "Purchase Invoice", {"is_return": 1, "return_against": self.name, "docstatus": 1} + ) + ): self.status = "Debit Note Issued" elif self.is_return == 1: self.status = "Return" - elif outstanding_amount<=0: + elif outstanding_amount <= 0: self.status = "Paid" else: self.status = "Submitted" @@ -1219,76 +1581,86 @@ class PurchaseInvoice(BuyingController): self.status = "Draft" if update: - self.db_set('status', self.status, update_modified = update_modified) + self.db_set("status", self.status, update_modified=update_modified) + def get_list_context(context=None): from erpnext.controllers.website_list_for_contact import get_list_context + list_context = get_list_context(context) - list_context.update({ - 'show_sidebar': True, - 'show_search': True, - 'no_breadcrumbs': True, - 'title': _('Purchase Invoices'), - }) + list_context.update( + { + "show_sidebar": True, + "show_search": True, + "no_breadcrumbs": True, + "title": _("Purchase Invoices"), + } + ) return list_context + @erpnext.allow_regional def make_regional_gl_entries(gl_entries, doc): return gl_entries + @frappe.whitelist() def make_debit_note(source_name, target_doc=None): from erpnext.controllers.sales_and_purchase_return import make_return_doc + return make_return_doc("Purchase Invoice", source_name, target_doc) + @frappe.whitelist() def make_stock_entry(source_name, target_doc=None): - doc = get_mapped_doc("Purchase Invoice", source_name, { - "Purchase Invoice": { - "doctype": "Stock Entry", - "validation": { - "docstatus": ["=", 1] - } - }, - "Purchase Invoice Item": { - "doctype": "Stock Entry Detail", - "field_map": { - "stock_qty": "transfer_qty", - "batch_no": "batch_no" + doc = get_mapped_doc( + "Purchase Invoice", + source_name, + { + "Purchase Invoice": {"doctype": "Stock Entry", "validation": {"docstatus": ["=", 1]}}, + "Purchase Invoice Item": { + "doctype": "Stock Entry Detail", + "field_map": {"stock_qty": "transfer_qty", "batch_no": "batch_no"}, }, - } - }, target_doc) + }, + target_doc, + ) return doc + @frappe.whitelist() def change_release_date(name, release_date=None): - if frappe.db.exists('Purchase Invoice', name): - pi = frappe.get_doc('Purchase Invoice', name) - pi.db_set('release_date', release_date) + if frappe.db.exists("Purchase Invoice", name): + pi = frappe.get_doc("Purchase Invoice", name) + pi.db_set("release_date", release_date) @frappe.whitelist() def unblock_invoice(name): - if frappe.db.exists('Purchase Invoice', name): - pi = frappe.get_doc('Purchase Invoice', name) + if frappe.db.exists("Purchase Invoice", name): + pi = frappe.get_doc("Purchase Invoice", name) pi.unblock_invoice() @frappe.whitelist() def block_invoice(name, release_date, hold_comment=None): - if frappe.db.exists('Purchase Invoice', name): - pi = frappe.get_doc('Purchase Invoice', name) + if frappe.db.exists("Purchase Invoice", name): + pi = frappe.get_doc("Purchase Invoice", name) pi.block_invoice(hold_comment, release_date) + @frappe.whitelist() def make_inter_company_sales_invoice(source_name, target_doc=None): from erpnext.accounts.doctype.sales_invoice.sales_invoice import make_inter_company_transaction + return make_inter_company_transaction("Purchase Invoice", source_name, target_doc) + def on_doctype_update(): frappe.db.add_index("Purchase Invoice", ["supplier", "is_return", "return_against"]) + @frappe.whitelist() def make_purchase_receipt(source_name, target_doc=None): def update_item(obj, target, source_parent): @@ -1296,33 +1668,39 @@ def make_purchase_receipt(source_name, target_doc=None): target.received_qty = flt(obj.qty) - flt(obj.received_qty) target.stock_qty = (flt(obj.qty) - flt(obj.received_qty)) * flt(obj.conversion_factor) target.amount = (flt(obj.qty) - flt(obj.received_qty)) * flt(obj.rate) - target.base_amount = (flt(obj.qty) - flt(obj.received_qty)) * \ - flt(obj.rate) * flt(source_parent.conversion_rate) + target.base_amount = ( + (flt(obj.qty) - flt(obj.received_qty)) * flt(obj.rate) * flt(source_parent.conversion_rate) + ) - doc = get_mapped_doc("Purchase Invoice", source_name, { - "Purchase Invoice": { - "doctype": "Purchase Receipt", - "validation": { - "docstatus": ["=", 1], - } - }, - "Purchase Invoice Item": { - "doctype": "Purchase Receipt Item", - "field_map": { - "name": "purchase_invoice_item", - "parent": "purchase_invoice", - "bom": "bom", - "purchase_order": "purchase_order", - "po_detail": "purchase_order_item", - "material_request": "material_request", - "material_request_item": "material_request_item" + doc = get_mapped_doc( + "Purchase Invoice", + source_name, + { + "Purchase Invoice": { + "doctype": "Purchase Receipt", + "validation": { + "docstatus": ["=", 1], + }, }, - "postprocess": update_item, - "condition": lambda doc: abs(doc.received_qty) < abs(doc.qty) + "Purchase Invoice Item": { + "doctype": "Purchase Receipt Item", + "field_map": { + "name": "purchase_invoice_item", + "parent": "purchase_invoice", + "bom": "bom", + "purchase_order": "purchase_order", + "po_detail": "purchase_order_item", + "material_request": "material_request", + "material_request_item": "material_request_item", + }, + "postprocess": update_item, + "condition": lambda doc: abs(doc.received_qty) < abs(doc.qty), + }, + "Purchase Taxes and Charges": {"doctype": "Purchase Taxes and Charges"}, }, - "Purchase Taxes and Charges": { - "doctype": "Purchase Taxes and Charges" - } - }, target_doc) + target_doc, + ) + + doc.set_onload("ignore_price_list", True) return doc diff --git a/erpnext/accounts/doctype/purchase_invoice/purchase_invoice_dashboard.py b/erpnext/accounts/doctype/purchase_invoice/purchase_invoice_dashboard.py index f1878b480ed..10dd0ef6e25 100644 --- a/erpnext/accounts/doctype/purchase_invoice/purchase_invoice_dashboard.py +++ b/erpnext/accounts/doctype/purchase_invoice/purchase_invoice_dashboard.py @@ -1,38 +1,28 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'purchase_invoice', - 'non_standard_fieldnames': { - 'Journal Entry': 'reference_name', - 'Payment Entry': 'reference_name', - 'Payment Request': 'reference_name', - 'Landed Cost Voucher': 'receipt_document', - 'Purchase Invoice': 'return_against', - 'Auto Repeat': 'reference_document' + "fieldname": "purchase_invoice", + "non_standard_fieldnames": { + "Journal Entry": "reference_name", + "Payment Entry": "reference_name", + "Payment Request": "reference_name", + "Landed Cost Voucher": "receipt_document", + "Purchase Invoice": "return_against", + "Auto Repeat": "reference_document", }, - 'internal_links': { - 'Purchase Order': ['items', 'purchase_order'], - 'Purchase Receipt': ['items', 'purchase_receipt'], + "internal_links": { + "Purchase Order": ["items", "purchase_order"], + "Purchase Receipt": ["items", "purchase_receipt"], }, - 'transactions': [ + "transactions": [ + {"label": _("Payment"), "items": ["Payment Entry", "Payment Request", "Journal Entry"]}, { - 'label': _('Payment'), - 'items': ['Payment Entry', 'Payment Request', 'Journal Entry'] + "label": _("Reference"), + "items": ["Purchase Order", "Purchase Receipt", "Asset", "Landed Cost Voucher"], }, - { - 'label': _('Reference'), - 'items': ['Purchase Order', 'Purchase Receipt', 'Asset', 'Landed Cost Voucher'] - }, - { - 'label': _('Returns'), - 'items': ['Purchase Invoice'] - }, - { - 'label': _('Subscription'), - 'items': ['Auto Repeat'] - }, - ] + {"label": _("Returns"), "items": ["Purchase Invoice"]}, + {"label": _("Subscription"), "items": ["Auto Repeat"]}, + ], } diff --git a/erpnext/accounts/doctype/purchase_invoice/test_purchase_invoice.py b/erpnext/accounts/doctype/purchase_invoice/test_purchase_invoice.py index 52c3d52046a..60611b0edbb 100644 --- a/erpnext/accounts/doctype/purchase_invoice/test_purchase_invoice.py +++ b/erpnext/accounts/doctype/purchase_invoice/test_purchase_invoice.py @@ -2,7 +2,6 @@ # License: GNU General Public License v3. See license.txt - import unittest import frappe @@ -11,22 +10,29 @@ from frappe.utils import add_days, cint, flt, getdate, nowdate, today import erpnext from erpnext.accounts.doctype.account.test_account import create_account, get_inventory_account from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry +from erpnext.buying.doctype.purchase_order.purchase_order import get_mapped_purchase_invoice +from erpnext.buying.doctype.purchase_order.test_purchase_order import create_purchase_order from erpnext.buying.doctype.supplier.test_supplier import create_supplier from erpnext.controllers.accounts_controller import get_payment_terms from erpnext.controllers.buying_controller import QtyMismatchError from erpnext.exceptions import InvalidCurrency from erpnext.projects.doctype.project.test_project import make_project from erpnext.stock.doctype.item.test_item import create_item +from erpnext.stock.doctype.purchase_receipt.purchase_receipt import ( + make_purchase_invoice as create_purchase_invoice_from_receipt, +) from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import ( get_taxes, make_purchase_receipt, ) from erpnext.stock.doctype.stock_entry.test_stock_entry import get_qty_after_transaction +from erpnext.stock.tests.test_utils import StockTestMixin test_dependencies = ["Item", "Cost Center", "Payment Term", "Payment Terms Template"] test_ignore = ["Serial No"] -class TestPurchaseInvoice(unittest.TestCase): + +class TestPurchaseInvoice(unittest.TestCase, StockTestMixin): @classmethod def setUpClass(self): unlink_payment_on_cancel_of_invoice() @@ -38,16 +44,18 @@ class TestPurchaseInvoice(unittest.TestCase): def test_purchase_invoice_received_qty(self): """ - 1. Test if received qty is validated against accepted + rejected - 2. Test if received qty is auto set on save + 1. Test if received qty is validated against accepted + rejected + 2. Test if received qty is auto set on save """ pi = make_purchase_invoice( qty=1, rejected_qty=1, received_qty=3, item_code="_Test Item Home Desktop 200", - rejected_warehouse = "_Test Rejected Warehouse - _TC", - update_stock=True, do_not_save=True) + rejected_warehouse="_Test Rejected Warehouse - _TC", + update_stock=True, + do_not_save=True, + ) self.assertRaises(QtyMismatchError, pi.save) pi.items[0].received_qty = 0 @@ -74,18 +82,26 @@ class TestPurchaseInvoice(unittest.TestCase): "_Test Account CST - _TC": [29.88, 0], "_Test Account VAT - _TC": [156.25, 0], "_Test Account Discount - _TC": [0, 168.03], - "Round Off - _TC": [0, 0.3] + "Round Off - _TC": [0, 0.3], } - gl_entries = frappe.db.sql("""select account, debit, credit from `tabGL Entry` - where voucher_type = 'Purchase Invoice' and voucher_no = %s""", pi.name, as_dict=1) + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` + where voucher_type = 'Purchase Invoice' and voucher_no = %s""", + pi.name, + as_dict=1, + ) for d in gl_entries: self.assertEqual([d.debit, d.credit], expected_gl_entries.get(d.account)) def test_gl_entries_with_perpetual_inventory(self): - pi = make_purchase_invoice(company="_Test Company with perpetual inventory", - warehouse= "Stores - TCP1", cost_center = "Main - TCP1", - expense_account ="_Test Account Cost for Goods Sold - TCP1", - get_taxes_and_charges=True, qty=10) + pi = make_purchase_invoice( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + expense_account="_Test Account Cost for Goods Sold - TCP1", + get_taxes_and_charges=True, + qty=10, + ) self.assertTrue(cint(erpnext.is_perpetual_inventory_enabled(pi.company)), 1) @@ -99,6 +115,7 @@ class TestPurchaseInvoice(unittest.TestCase): def test_payment_entry_unlink_against_purchase_invoice(self): from erpnext.accounts.doctype.payment_entry.test_payment_entry import get_payment_entry + unlink_payment_on_cancel_of_invoice(0) pi_doc = make_purchase_invoice() @@ -114,7 +131,7 @@ class TestPurchaseInvoice(unittest.TestCase): pe.save(ignore_permissions=True) pe.submit() - pi_doc = frappe.get_doc('Purchase Invoice', pi_doc.name) + pi_doc = frappe.get_doc("Purchase Invoice", pi_doc.name) pi_doc.load_from_db() self.assertTrue(pi_doc.status, "Paid") @@ -122,7 +139,7 @@ class TestPurchaseInvoice(unittest.TestCase): unlink_payment_on_cancel_of_invoice() def test_purchase_invoice_for_blocked_supplier(self): - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 supplier.save() @@ -132,9 +149,9 @@ class TestPurchaseInvoice(unittest.TestCase): supplier.save() def test_purchase_invoice_for_blocked_supplier_invoice(self): - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 - supplier.hold_type = 'Invoices' + supplier.hold_type = "Invoices" supplier.save() self.assertRaises(frappe.ValidationError, make_purchase_invoice) @@ -143,31 +160,40 @@ class TestPurchaseInvoice(unittest.TestCase): supplier.save() def test_purchase_invoice_for_blocked_supplier_payment(self): - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 - supplier.hold_type = 'Payments' + supplier.hold_type = "Payments" supplier.save() pi = make_purchase_invoice() self.assertRaises( - frappe.ValidationError, get_payment_entry, dt='Purchase Invoice', dn=pi.name, bank_account="_Test Bank - _TC") + frappe.ValidationError, + get_payment_entry, + dt="Purchase Invoice", + dn=pi.name, + bank_account="_Test Bank - _TC", + ) supplier.on_hold = 0 supplier.save() def test_purchase_invoice_for_blocked_supplier_payment_today_date(self): - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 - supplier.hold_type = 'Payments' + supplier.hold_type = "Payments" supplier.release_date = nowdate() supplier.save() pi = make_purchase_invoice() self.assertRaises( - frappe.ValidationError, get_payment_entry, dt='Purchase Invoice', dn=pi.name, - bank_account="_Test Bank - _TC") + frappe.ValidationError, + get_payment_entry, + dt="Purchase Invoice", + dn=pi.name, + bank_account="_Test Bank - _TC", + ) supplier.on_hold = 0 supplier.save() @@ -176,15 +202,15 @@ class TestPurchaseInvoice(unittest.TestCase): # this test is meant to fail only if something fails in the try block with self.assertRaises(Exception): try: - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 - supplier.hold_type = 'Payments' - supplier.release_date = '2018-03-01' + supplier.hold_type = "Payments" + supplier.release_date = "2018-03-01" supplier.save() pi = make_purchase_invoice() - get_payment_entry('Purchase Invoice', dn=pi.name, bank_account="_Test Bank - _TC") + get_payment_entry("Purchase Invoice", dn=pi.name, bank_account="_Test Bank - _TC") supplier.on_hold = 0 supplier.save() @@ -198,7 +224,7 @@ class TestPurchaseInvoice(unittest.TestCase): pi.release_date = nowdate() self.assertRaises(frappe.ValidationError, pi.save) - pi.release_date = '' + pi.release_date = "" pi.save() def test_purchase_invoice_temporary_blocked(self): @@ -207,7 +233,7 @@ class TestPurchaseInvoice(unittest.TestCase): pi.save() pi.submit() - pe = get_payment_entry('Purchase Invoice', dn=pi.name, bank_account="_Test Bank - _TC") + pe = get_payment_entry("Purchase Invoice", dn=pi.name, bank_account="_Test Bank - _TC") self.assertRaises(frappe.ValidationError, pe.save) @@ -223,9 +249,24 @@ class TestPurchaseInvoice(unittest.TestCase): def test_gl_entries_with_perpetual_inventory_against_pr(self): - pr = make_purchase_receipt(company="_Test Company with perpetual inventory", supplier_warehouse="Work In Progress - TCP1", warehouse= "Stores - TCP1", cost_center = "Main - TCP1", get_taxes_and_charges=True,) + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + supplier_warehouse="Work In Progress - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + get_taxes_and_charges=True, + ) - pi = make_purchase_invoice(company="_Test Company with perpetual inventory", supplier_warehouse="Work In Progress - TCP1", warehouse= "Stores - TCP1", cost_center = "Main - TCP1", expense_account ="_Test Account Cost for Goods Sold - TCP1", get_taxes_and_charges=True, qty=10,do_not_save= "True") + pi = make_purchase_invoice( + company="_Test Company with perpetual inventory", + supplier_warehouse="Work In Progress - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + expense_account="_Test Account Cost for Goods Sold - TCP1", + get_taxes_and_charges=True, + qty=10, + do_not_save="True", + ) for d in pi.items: d.purchase_receipt = pr.name @@ -238,72 +279,35 @@ class TestPurchaseInvoice(unittest.TestCase): self.check_gle_for_pi(pi.name) def check_gle_for_pi(self, pi): - gl_entries = frappe.db.sql("""select account, sum(debit) as debit, sum(credit) as credit + gl_entries = frappe.db.sql( + """select account, sum(debit) as debit, sum(credit) as credit from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s - group by account""", pi, as_dict=1) + group by account""", + pi, + as_dict=1, + ) self.assertTrue(gl_entries) - expected_values = dict((d[0], d) for d in [ - ["Creditors - TCP1", 0, 720], - ["Stock Received But Not Billed - TCP1", 500.0, 0], - ["_Test Account Shipping Charges - TCP1", 100.0, 0.0], - ["_Test Account VAT - TCP1", 120.0, 0] - ]) + expected_values = dict( + (d[0], d) + for d in [ + ["Creditors - TCP1", 0, 720], + ["Stock Received But Not Billed - TCP1", 500.0, 0], + ["_Test Account Shipping Charges - TCP1", 100.0, 0.0], + ["_Test Account VAT - TCP1", 120.0, 0], + ] + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_values[gle.account][0], gle.account) self.assertEqual(expected_values[gle.account][1], gle.debit) self.assertEqual(expected_values[gle.account][2], gle.credit) - def test_purchase_invoice_with_discount_accounting_enabled(self): - enable_discount_accounting() - - discount_account = create_account(account_name="Discount Account", - parent_account="Indirect Expenses - _TC", company="_Test Company") - pi = make_purchase_invoice(discount_account=discount_account, rate=45) - - expected_gle = [ - ["_Test Account Cost for Goods Sold - _TC", 250.0, 0.0, nowdate()], - ["Creditors - _TC", 0.0, 225.0, nowdate()], - ["Discount Account - _TC", 0.0, 25.0, nowdate()] - ] - - check_gl_entries(self, pi.name, expected_gle, nowdate()) - enable_discount_accounting(enable=0) - - def test_additional_discount_for_purchase_invoice_with_discount_accounting_enabled(self): - enable_discount_accounting() - additional_discount_account = create_account(account_name="Discount Account", - parent_account="Indirect Expenses - _TC", company="_Test Company") - - pi = make_purchase_invoice(do_not_save=1, parent_cost_center="Main - _TC") - pi.apply_discount_on = "Grand Total" - pi.additional_discount_account = additional_discount_account - pi.additional_discount_percentage = 10 - pi.disable_rounded_total = 1 - pi.append("taxes", { - "charge_type": "On Net Total", - "account_head": "_Test Account VAT - _TC", - "cost_center": "Main - _TC", - "description": "Test", - "rate": 10 - }) - pi.submit() - - expected_gle = [ - ["_Test Account Cost for Goods Sold - _TC", 250.0, 0.0, nowdate()], - ["_Test Account VAT - _TC", 25.0, 0.0, nowdate()], - ["Creditors - _TC", 0.0, 247.5, nowdate()], - ["Discount Account - _TC", 0.0, 27.5, nowdate()] - ] - - check_gl_entries(self, pi.name, expected_gle, nowdate()) - def test_purchase_invoice_change_naming_series(self): pi = frappe.copy_doc(test_records[1]) pi.insert() - pi.naming_series = 'TEST-' + pi.naming_series = "TEST-" self.assertRaises(frappe.CannotChangeConstantError, pi.save) @@ -312,25 +316,33 @@ class TestPurchaseInvoice(unittest.TestCase): pi.load_from_db() self.assertTrue(pi.status, "Draft") - pi.naming_series = 'TEST-' + pi.naming_series = "TEST-" self.assertRaises(frappe.CannotChangeConstantError, pi.save) def test_gl_entries_for_non_stock_items_with_perpetual_inventory(self): - pi = make_purchase_invoice(item_code = "_Test Non Stock Item", - company = "_Test Company with perpetual inventory", warehouse= "Stores - TCP1", - cost_center = "Main - TCP1", expense_account ="_Test Account Cost for Goods Sold - TCP1") + pi = make_purchase_invoice( + item_code="_Test Non Stock Item", + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + expense_account="_Test Account Cost for Goods Sold - TCP1", + ) self.assertTrue(pi.status, "Unpaid") - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s - order by account asc""", pi.name, as_dict=1) + order by account asc""", + pi.name, + as_dict=1, + ) self.assertTrue(gl_entries) expected_values = [ ["_Test Account Cost for Goods Sold - TCP1", 250.0, 0], - ["Creditors - TCP1", 0, 250] + ["Creditors - TCP1", 0, 250], ] for i, gle in enumerate(gl_entries): @@ -345,7 +357,7 @@ class TestPurchaseInvoice(unittest.TestCase): expected_values = [ ["_Test Item Home Desktop 100", 90, 59], - ["_Test Item Home Desktop 200", 135, 177] + ["_Test Item Home Desktop 200", 135, 177], ] for i, item in enumerate(pi.get("items")): self.assertEqual(item.item_code, expected_values[i][0]) @@ -377,10 +389,7 @@ class TestPurchaseInvoice(unittest.TestCase): wrapper.insert() wrapper.load_from_db() - expected_values = [ - ["_Test FG Item", 90, 59], - ["_Test Item Home Desktop 200", 135, 177] - ] + expected_values = [["_Test FG Item", 90, 59], ["_Test Item Home Desktop 200", 135, 177]] for i, item in enumerate(wrapper.get("items")): self.assertEqual(item.item_code, expected_values[i][0]) self.assertEqual(item.item_tax_amount, expected_values[i][1]) @@ -417,14 +426,17 @@ class TestPurchaseInvoice(unittest.TestCase): pi = frappe.copy_doc(test_records[0]) pi.disable_rounded_total = 1 pi.allocate_advances_automatically = 0 - pi.append("advances", { - "reference_type": "Journal Entry", - "reference_name": jv.name, - "reference_row": jv.get("accounts")[0].name, - "advance_amount": 400, - "allocated_amount": 300, - "remarks": jv.remark - }) + pi.append( + "advances", + { + "reference_type": "Journal Entry", + "reference_name": jv.name, + "reference_row": jv.get("accounts")[0].name, + "advance_amount": 400, + "allocated_amount": 300, + "remarks": jv.remark, + }, + ) pi.insert() self.assertEqual(pi.outstanding_amount, 1212.30) @@ -437,14 +449,24 @@ class TestPurchaseInvoice(unittest.TestCase): pi.submit() pi.load_from_db() - self.assertTrue(frappe.db.sql("""select name from `tabJournal Entry Account` + self.assertTrue( + frappe.db.sql( + """select name from `tabJournal Entry Account` where reference_type='Purchase Invoice' - and reference_name=%s and debit_in_account_currency=300""", pi.name)) + and reference_name=%s and debit_in_account_currency=300""", + pi.name, + ) + ) pi.cancel() - self.assertFalse(frappe.db.sql("""select name from `tabJournal Entry Account` - where reference_type='Purchase Invoice' and reference_name=%s""", pi.name)) + self.assertFalse( + frappe.db.sql( + """select name from `tabJournal Entry Account` + where reference_type='Purchase Invoice' and reference_name=%s""", + pi.name, + ) + ) def test_invoice_with_advance_and_multi_payment_terms(self): from erpnext.accounts.doctype.journal_entry.test_journal_entry import ( @@ -458,20 +480,26 @@ class TestPurchaseInvoice(unittest.TestCase): pi = frappe.copy_doc(test_records[0]) pi.disable_rounded_total = 1 pi.allocate_advances_automatically = 0 - pi.append("advances", { - "reference_type": "Journal Entry", - "reference_name": jv.name, - "reference_row": jv.get("accounts")[0].name, - "advance_amount": 400, - "allocated_amount": 300, - "remarks": jv.remark - }) + pi.append( + "advances", + { + "reference_type": "Journal Entry", + "reference_name": jv.name, + "reference_row": jv.get("accounts")[0].name, + "advance_amount": 400, + "allocated_amount": 300, + "remarks": jv.remark, + }, + ) pi.insert() - pi.update({ - "payment_schedule": get_payment_terms("_Test Payment Term Template", - pi.posting_date, pi.grand_total, pi.base_grand_total) - }) + pi.update( + { + "payment_schedule": get_payment_terms( + "_Test Payment Term Template", pi.posting_date, pi.grand_total, pi.base_grand_total + ) + } + ) pi.save() pi.submit() @@ -485,7 +513,9 @@ class TestPurchaseInvoice(unittest.TestCase): self.assertTrue( frappe.db.sql( "select name from `tabJournal Entry Account` where reference_type='Purchase Invoice' and " - "reference_name=%s and debit_in_account_currency=300", pi.name) + "reference_name=%s and debit_in_account_currency=300", + pi.name, + ) ) self.assertEqual(pi.outstanding_amount, 1212.30) @@ -495,49 +525,76 @@ class TestPurchaseInvoice(unittest.TestCase): self.assertFalse( frappe.db.sql( "select name from `tabJournal Entry Account` where reference_type='Purchase Invoice' and " - "reference_name=%s", pi.name) + "reference_name=%s", + pi.name, + ) ) def test_total_purchase_cost_for_project(self): if not frappe.db.exists("Project", {"project_name": "_Test Project for Purchase"}): - project = make_project({'project_name':'_Test Project for Purchase'}) + project = make_project({"project_name": "_Test Project for Purchase"}) else: project = frappe.get_doc("Project", {"project_name": "_Test Project for Purchase"}) - existing_purchase_cost = frappe.db.sql("""select sum(base_net_amount) + existing_purchase_cost = frappe.db.sql( + """select sum(base_net_amount) from `tabPurchase Invoice Item` where project = '{0}' - and docstatus=1""".format(project.name)) + and docstatus=1""".format( + project.name + ) + ) existing_purchase_cost = existing_purchase_cost and existing_purchase_cost[0][0] or 0 pi = make_purchase_invoice(currency="USD", conversion_rate=60, project=project.name) - self.assertEqual(frappe.db.get_value("Project", project.name, "total_purchase_cost"), - existing_purchase_cost + 15000) + self.assertEqual( + frappe.db.get_value("Project", project.name, "total_purchase_cost"), + existing_purchase_cost + 15000, + ) pi1 = make_purchase_invoice(qty=10, project=project.name) - self.assertEqual(frappe.db.get_value("Project", project.name, "total_purchase_cost"), - existing_purchase_cost + 15500) + self.assertEqual( + frappe.db.get_value("Project", project.name, "total_purchase_cost"), + existing_purchase_cost + 15500, + ) pi1.cancel() - self.assertEqual(frappe.db.get_value("Project", project.name, "total_purchase_cost"), - existing_purchase_cost + 15000) + self.assertEqual( + frappe.db.get_value("Project", project.name, "total_purchase_cost"), + existing_purchase_cost + 15000, + ) pi.cancel() - self.assertEqual(frappe.db.get_value("Project", project.name, "total_purchase_cost"), existing_purchase_cost) + self.assertEqual( + frappe.db.get_value("Project", project.name, "total_purchase_cost"), existing_purchase_cost + ) def test_return_purchase_invoice_with_perpetual_inventory(self): - pi = make_purchase_invoice(company = "_Test Company with perpetual inventory", warehouse= "Stores - TCP1", - cost_center = "Main - TCP1", expense_account ="_Test Account Cost for Goods Sold - TCP1") - - return_pi = make_purchase_invoice(is_return=1, return_against=pi.name, qty=-2, - company = "_Test Company with perpetual inventory", warehouse= "Stores - TCP1", - cost_center = "Main - TCP1", expense_account ="_Test Account Cost for Goods Sold - TCP1") + pi = make_purchase_invoice( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + expense_account="_Test Account Cost for Goods Sold - TCP1", + ) + return_pi = make_purchase_invoice( + is_return=1, + return_against=pi.name, + qty=-2, + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + expense_account="_Test Account Cost for Goods Sold - TCP1", + ) # check gl entries for return - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type=%s and voucher_no=%s - order by account desc""", ("Purchase Invoice", return_pi.name), as_dict=1) + order by account desc""", + ("Purchase Invoice", return_pi.name), + as_dict=1, + ) self.assertTrue(gl_entries) @@ -550,14 +607,96 @@ class TestPurchaseInvoice(unittest.TestCase): self.assertEqual(expected_values[gle.account][0], gle.debit) self.assertEqual(expected_values[gle.account][1], gle.credit) - def test_multi_currency_gle(self): - pi = make_purchase_invoice(supplier="_Test Supplier USD", credit_to="_Test Payable USD - _TC", - currency="USD", conversion_rate=50) + def test_standalone_return_using_pi(self): + from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry - gl_entries = frappe.db.sql("""select account, account_currency, debit, credit, + item = self.make_item().name + company = "_Test Company with perpetual inventory" + warehouse = "Stores - TCP1" + + make_stock_entry(item_code=item, target=warehouse, qty=50, rate=120) + + return_pi = make_purchase_invoice( + is_return=1, + item=item, + qty=-10, + update_stock=1, + rate=100, + company=company, + warehouse=warehouse, + cost_center="Main - TCP1", + ) + + # assert that stock consumption is with actual rate + self.assertGLEs( + return_pi, + [{"credit": 1200, "debit": 0}], + gle_filters={"account": "Stock In Hand - TCP1"}, + ) + + # assert loss booked in COGS + self.assertGLEs( + return_pi, + [{"credit": 0, "debit": 200}], + gle_filters={"account": "Cost of Goods Sold - TCP1"}, + ) + + def test_return_with_lcv(self): + from erpnext.controllers.sales_and_purchase_return import make_return_doc + from erpnext.stock.doctype.landed_cost_voucher.test_landed_cost_voucher import ( + create_landed_cost_voucher, + ) + + item = self.make_item().name + company = "_Test Company with perpetual inventory" + warehouse = "Stores - TCP1" + cost_center = "Main - TCP1" + + pi = make_purchase_invoice( + item=item, + company=company, + warehouse=warehouse, + cost_center=cost_center, + update_stock=1, + qty=10, + rate=100, + ) + + # Create landed cost voucher - will increase valuation of received item by 10 + create_landed_cost_voucher("Purchase Invoice", pi.name, pi.company, charges=100) + return_pi = make_return_doc(pi.doctype, pi.name) + return_pi.save().submit() + + # assert that stock consumption is with actual in rate + self.assertGLEs( + return_pi, + [{"credit": 1100, "debit": 0}], + gle_filters={"account": "Stock In Hand - TCP1"}, + ) + + # assert loss booked in COGS + self.assertGLEs( + return_pi, + [{"credit": 0, "debit": 100}], + gle_filters={"account": "Cost of Goods Sold - TCP1"}, + ) + + def test_multi_currency_gle(self): + pi = make_purchase_invoice( + supplier="_Test Supplier USD", + credit_to="_Test Payable USD - _TC", + currency="USD", + conversion_rate=50, + ) + + gl_entries = frappe.db.sql( + """select account, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s - order by account asc""", pi.name, as_dict=1) + order by account asc""", + pi.name, + as_dict=1, + ) self.assertTrue(gl_entries) @@ -567,53 +706,74 @@ class TestPurchaseInvoice(unittest.TestCase): "debit": 0, "debit_in_account_currency": 0, "credit": 12500, - "credit_in_account_currency": 250 + "credit_in_account_currency": 250, }, "_Test Account Cost for Goods Sold - _TC": { "account_currency": "INR", "debit": 12500, "debit_in_account_currency": 12500, "credit": 0, - "credit_in_account_currency": 0 - } + "credit_in_account_currency": 0, + }, } - for field in ("account_currency", "debit", "debit_in_account_currency", "credit", "credit_in_account_currency"): + for field in ( + "account_currency", + "debit", + "debit_in_account_currency", + "credit", + "credit_in_account_currency", + ): for i, gle in enumerate(gl_entries): self.assertEqual(expected_values[gle.account][field], gle[field]) - # Check for valid currency - pi1 = make_purchase_invoice(supplier="_Test Supplier USD", credit_to="_Test Payable USD - _TC", - do_not_save=True) + pi1 = make_purchase_invoice( + supplier="_Test Supplier USD", credit_to="_Test Payable USD - _TC", do_not_save=True + ) self.assertRaises(InvalidCurrency, pi1.save) # cancel pi.cancel() - gle = frappe.db.sql("""select name from `tabGL Entry` - where voucher_type='Sales Invoice' and voucher_no=%s""", pi.name) + gle = frappe.db.sql( + """select name from `tabGL Entry` + where voucher_type='Sales Invoice' and voucher_no=%s""", + pi.name, + ) self.assertFalse(gle) def test_purchase_invoice_update_stock_gl_entry_with_perpetual_inventory(self): - pi = make_purchase_invoice(update_stock=1, posting_date=frappe.utils.nowdate(), - posting_time=frappe.utils.nowtime(), cash_bank_account="Cash - TCP1", company="_Test Company with perpetual inventory", supplier_warehouse="Work In Progress - TCP1", warehouse= "Stores - TCP1", cost_center = "Main - TCP1", expense_account ="_Test Account Cost for Goods Sold - TCP1") + pi = make_purchase_invoice( + update_stock=1, + posting_date=frappe.utils.nowdate(), + posting_time=frappe.utils.nowtime(), + cash_bank_account="Cash - TCP1", + company="_Test Company with perpetual inventory", + supplier_warehouse="Work In Progress - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + expense_account="_Test Account Cost for Goods Sold - TCP1", + ) - gl_entries = frappe.db.sql("""select account, account_currency, debit, credit, + gl_entries = frappe.db.sql( + """select account, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s - order by account asc""", pi.name, as_dict=1) + order by account asc""", + pi.name, + as_dict=1, + ) self.assertTrue(gl_entries) stock_in_hand_account = get_inventory_account(pi.company, pi.get("items")[0].warehouse) - expected_gl_entries = dict((d[0], d) for d in [ - [pi.credit_to, 0.0, 250.0], - [stock_in_hand_account, 250.0, 0.0] - ]) + expected_gl_entries = dict( + (d[0], d) for d in [[pi.credit_to, 0.0, 250.0], [stock_in_hand_account, 250.0, 0.0]] + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_gl_entries[gle.account][0], gle.account) @@ -622,22 +782,39 @@ class TestPurchaseInvoice(unittest.TestCase): def test_purchase_invoice_for_is_paid_and_update_stock_gl_entry_with_perpetual_inventory(self): - pi = make_purchase_invoice(update_stock=1, posting_date=frappe.utils.nowdate(), - posting_time=frappe.utils.nowtime(), cash_bank_account="Cash - TCP1", is_paid=1, company="_Test Company with perpetual inventory", supplier_warehouse="Work In Progress - TCP1", warehouse= "Stores - TCP1", cost_center = "Main - TCP1", expense_account ="_Test Account Cost for Goods Sold - TCP1") + pi = make_purchase_invoice( + update_stock=1, + posting_date=frappe.utils.nowdate(), + posting_time=frappe.utils.nowtime(), + cash_bank_account="Cash - TCP1", + is_paid=1, + company="_Test Company with perpetual inventory", + supplier_warehouse="Work In Progress - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + expense_account="_Test Account Cost for Goods Sold - TCP1", + ) - gl_entries = frappe.db.sql("""select account, account_currency, sum(debit) as debit, + gl_entries = frappe.db.sql( + """select account, account_currency, sum(debit) as debit, sum(credit) as credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s - group by account, voucher_no order by account asc;""", pi.name, as_dict=1) + group by account, voucher_no order by account asc;""", + pi.name, + as_dict=1, + ) stock_in_hand_account = get_inventory_account(pi.company, pi.get("items")[0].warehouse) self.assertTrue(gl_entries) - expected_gl_entries = dict((d[0], d) for d in [ - [pi.credit_to, 250.0, 250.0], - [stock_in_hand_account, 250.0, 0.0], - ["Cash - TCP1", 0.0, 250.0] - ]) + expected_gl_entries = dict( + (d[0], d) + for d in [ + [pi.credit_to, 250.0, 250.0], + [stock_in_hand_account, 250.0, 0.0], + ["Cash - TCP1", 0.0, 250.0], + ] + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_gl_entries[gle.account][0], gle.account) @@ -645,31 +822,36 @@ class TestPurchaseInvoice(unittest.TestCase): self.assertEqual(expected_gl_entries[gle.account][2], gle.credit) def test_auto_batch(self): - item_code = frappe.db.get_value('Item', - {'has_batch_no': 1, 'create_new_batch':1}, 'name') + item_code = frappe.db.get_value("Item", {"has_batch_no": 1, "create_new_batch": 1}, "name") if not item_code: - doc = frappe.get_doc({ - 'doctype': 'Item', - 'is_stock_item': 1, - 'item_code': 'test batch item', - 'item_group': 'Products', - 'has_batch_no': 1, - 'create_new_batch': 1 - }).insert(ignore_permissions=True) + doc = frappe.get_doc( + { + "doctype": "Item", + "is_stock_item": 1, + "item_code": "test batch item", + "item_group": "Products", + "has_batch_no": 1, + "create_new_batch": 1, + } + ).insert(ignore_permissions=True) item_code = doc.name - pi = make_purchase_invoice(update_stock=1, posting_date=frappe.utils.nowdate(), - posting_time=frappe.utils.nowtime(), item_code=item_code) + pi = make_purchase_invoice( + update_stock=1, + posting_date=frappe.utils.nowdate(), + posting_time=frappe.utils.nowtime(), + item_code=item_code, + ) - self.assertTrue(frappe.db.get_value('Batch', - {'item': item_code, 'reference_name': pi.name})) + self.assertTrue(frappe.db.get_value("Batch", {"item": item_code, "reference_name": pi.name})) def test_update_stock_and_purchase_return(self): actual_qty_0 = get_qty_after_transaction() - pi = make_purchase_invoice(update_stock=1, posting_date=frappe.utils.nowdate(), - posting_time=frappe.utils.nowtime()) + pi = make_purchase_invoice( + update_stock=1, posting_date=frappe.utils.nowdate(), posting_time=frappe.utils.nowtime() + ) actual_qty_1 = get_qty_after_transaction() self.assertEqual(actual_qty_0 + 5, actual_qty_1) @@ -696,13 +878,20 @@ class TestPurchaseInvoice(unittest.TestCase): from erpnext.buying.doctype.purchase_order.test_purchase_order import update_backflush_based_on from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry - update_backflush_based_on('BOM') - make_stock_entry(item_code="_Test Item", target="_Test Warehouse 1 - _TC", qty=100, basic_rate=100) - make_stock_entry(item_code="_Test Item Home Desktop 100", target="_Test Warehouse 1 - _TC", - qty=100, basic_rate=100) + update_backflush_based_on("BOM") + make_stock_entry( + item_code="_Test Item", target="_Test Warehouse 1 - _TC", qty=100, basic_rate=100 + ) + make_stock_entry( + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse 1 - _TC", + qty=100, + basic_rate=100, + ) - pi = make_purchase_invoice(item_code="_Test FG Item", qty=10, rate=500, - update_stock=1, is_subcontracted="Yes") + pi = make_purchase_invoice( + item_code="_Test FG Item", qty=10, rate=500, update_stock=1, is_subcontracted="Yes" + ) self.assertEqual(len(pi.get("supplied_items")), 2) @@ -710,15 +899,26 @@ class TestPurchaseInvoice(unittest.TestCase): self.assertEqual(flt(pi.get("items")[0].rm_supp_cost, 2), flt(rm_supp_cost, 2)) def test_rejected_serial_no(self): - pi = make_purchase_invoice(item_code="_Test Serialized Item With Series", received_qty=2, qty=1, - rejected_qty=1, rate=500, update_stock=1, rejected_warehouse = "_Test Rejected Warehouse - _TC", - allow_zero_valuation_rate=1) + pi = make_purchase_invoice( + item_code="_Test Serialized Item With Series", + received_qty=2, + qty=1, + rejected_qty=1, + rate=500, + update_stock=1, + rejected_warehouse="_Test Rejected Warehouse - _TC", + allow_zero_valuation_rate=1, + ) - self.assertEqual(frappe.db.get_value("Serial No", pi.get("items")[0].serial_no, "warehouse"), - pi.get("items")[0].warehouse) + self.assertEqual( + frappe.db.get_value("Serial No", pi.get("items")[0].serial_no, "warehouse"), + pi.get("items")[0].warehouse, + ) - self.assertEqual(frappe.db.get_value("Serial No", pi.get("items")[0].rejected_serial_no, - "warehouse"), pi.get("items")[0].rejected_warehouse) + self.assertEqual( + frappe.db.get_value("Serial No", pi.get("items")[0].rejected_serial_no, "warehouse"), + pi.get("items")[0].rejected_warehouse, + ) def test_outstanding_amount_after_advance_jv_cancelation(self): from erpnext.accounts.doctype.journal_entry.test_journal_entry import ( @@ -726,85 +926,95 @@ class TestPurchaseInvoice(unittest.TestCase): ) jv = frappe.copy_doc(jv_test_records[1]) - jv.accounts[0].is_advance = 'Yes' + jv.accounts[0].is_advance = "Yes" jv.insert() jv.submit() pi = frappe.copy_doc(test_records[0]) - pi.append("advances", { - "reference_type": "Journal Entry", - "reference_name": jv.name, - "reference_row": jv.get("accounts")[0].name, - "advance_amount": 400, - "allocated_amount": 300, - "remarks": jv.remark - }) + pi.append( + "advances", + { + "reference_type": "Journal Entry", + "reference_name": jv.name, + "reference_row": jv.get("accounts")[0].name, + "advance_amount": 400, + "allocated_amount": 300, + "remarks": jv.remark, + }, + ) pi.insert() pi.submit() pi.load_from_db() - #check outstanding after advance allocation + # check outstanding after advance allocation self.assertEqual(flt(pi.outstanding_amount), flt(pi.rounded_total - pi.total_advance)) - #added to avoid Document has been modified exception + # added to avoid Document has been modified exception jv = frappe.get_doc("Journal Entry", jv.name) jv.cancel() pi.load_from_db() - #check outstanding after advance cancellation + # check outstanding after advance cancellation self.assertEqual(flt(pi.outstanding_amount), flt(pi.rounded_total + pi.total_advance)) def test_outstanding_amount_after_advance_payment_entry_cancelation(self): - pe = frappe.get_doc({ - "doctype": "Payment Entry", - "payment_type": "Pay", - "party_type": "Supplier", - "party": "_Test Supplier", - "company": "_Test Company", - "paid_from_account_currency": "INR", - "paid_to_account_currency": "INR", - "source_exchange_rate": 1, - "target_exchange_rate": 1, - "reference_no": "1", - "reference_date": nowdate(), - "received_amount": 300, - "paid_amount": 300, - "paid_from": "_Test Cash - _TC", - "paid_to": "_Test Payable - _TC" - }) + pe = frappe.get_doc( + { + "doctype": "Payment Entry", + "payment_type": "Pay", + "party_type": "Supplier", + "party": "_Test Supplier", + "company": "_Test Company", + "paid_from_account_currency": "INR", + "paid_to_account_currency": "INR", + "source_exchange_rate": 1, + "target_exchange_rate": 1, + "reference_no": "1", + "reference_date": nowdate(), + "received_amount": 300, + "paid_amount": 300, + "paid_from": "_Test Cash - _TC", + "paid_to": "_Test Payable - _TC", + } + ) pe.insert() pe.submit() pi = frappe.copy_doc(test_records[0]) pi.is_pos = 0 - pi.append("advances", { - "doctype": "Purchase Invoice Advance", - "reference_type": "Payment Entry", - "reference_name": pe.name, - "advance_amount": 300, - "allocated_amount": 300, - "remarks": pe.remarks - }) + pi.append( + "advances", + { + "doctype": "Purchase Invoice Advance", + "reference_type": "Payment Entry", + "reference_name": pe.name, + "advance_amount": 300, + "allocated_amount": 300, + "remarks": pe.remarks, + }, + ) pi.insert() pi.submit() pi.load_from_db() - #check outstanding after advance allocation + # check outstanding after advance allocation self.assertEqual(flt(pi.outstanding_amount), flt(pi.rounded_total - pi.total_advance)) - #added to avoid Document has been modified exception + # added to avoid Document has been modified exception pe = frappe.get_doc("Payment Entry", pe.name) pe.cancel() pi.load_from_db() - #check outstanding after advance cancellation + # check outstanding after advance cancellation self.assertEqual(flt(pi.outstanding_amount), flt(pi.rounded_total + pi.total_advance)) def test_purchase_invoice_with_shipping_rule(self): from erpnext.accounts.doctype.shipping_rule.test_shipping_rule import create_shipping_rule - shipping_rule = create_shipping_rule(shipping_rule_type = "Buying", shipping_rule_name = "Shipping Rule - Purchase Invoice Test") + shipping_rule = create_shipping_rule( + shipping_rule_type="Buying", shipping_rule_name="Shipping Rule - Purchase Invoice Test" + ) pi = frappe.copy_doc(test_records[0]) @@ -820,16 +1030,20 @@ class TestPurchaseInvoice(unittest.TestCase): def test_make_pi_without_terms(self): pi = make_purchase_invoice(do_not_save=1) - self.assertFalse(pi.get('payment_schedule')) + self.assertFalse(pi.get("payment_schedule")) pi.insert() - self.assertTrue(pi.get('payment_schedule')) + self.assertTrue(pi.get("payment_schedule")) def test_duplicate_due_date_in_terms(self): pi = make_purchase_invoice(do_not_save=1) - pi.append('payment_schedule', dict(due_date='2017-01-01', invoice_portion=50.00, payment_amount=50)) - pi.append('payment_schedule', dict(due_date='2017-01-01', invoice_portion=50.00, payment_amount=50)) + pi.append( + "payment_schedule", dict(due_date="2017-01-01", invoice_portion=50.00, payment_amount=50) + ) + pi.append( + "payment_schedule", dict(due_date="2017-01-01", invoice_portion=50.00, payment_amount=50) + ) self.assertRaises(frappe.ValidationError, pi.insert) @@ -837,12 +1051,13 @@ class TestPurchaseInvoice(unittest.TestCase): from erpnext.accounts.doctype.payment_entry.test_payment_entry import get_payment_entry from erpnext.accounts.doctype.sales_invoice.test_sales_invoice import get_outstanding_amount - pi = make_purchase_invoice(item_code = "_Test Item", qty = (5 * -1), rate=500, is_return = 1) + pi = make_purchase_invoice(item_code="_Test Item", qty=(5 * -1), rate=500, is_return=1) pi.load_from_db() self.assertTrue(pi.status, "Return") - outstanding_amount = get_outstanding_amount(pi.doctype, - pi.name, "Creditors - _TC", pi.supplier, "Supplier") + outstanding_amount = get_outstanding_amount( + pi.doctype, pi.name, "Creditors - _TC", pi.supplier, "Supplier" + ) self.assertEqual(pi.outstanding_amount, outstanding_amount) @@ -857,30 +1072,33 @@ class TestPurchaseInvoice(unittest.TestCase): pe.insert() pe.submit() - pi_doc = frappe.get_doc('Purchase Invoice', pi.name) + pi_doc = frappe.get_doc("Purchase Invoice", pi.name) self.assertEqual(pi_doc.outstanding_amount, 0) def test_purchase_invoice_with_cost_center(self): from erpnext.accounts.doctype.cost_center.test_cost_center import create_cost_center + cost_center = "_Test Cost Center for BS Account - _TC" create_cost_center(cost_center_name="_Test Cost Center for BS Account", company="_Test Company") - pi = make_purchase_invoice_against_cost_center(cost_center=cost_center, credit_to="Creditors - _TC") + pi = make_purchase_invoice_against_cost_center( + cost_center=cost_center, credit_to="Creditors - _TC" + ) self.assertEqual(pi.cost_center, cost_center) expected_values = { - "Creditors - _TC": { - "cost_center": cost_center - }, - "_Test Account Cost for Goods Sold - _TC": { - "cost_center": cost_center - } + "Creditors - _TC": {"cost_center": cost_center}, + "_Test Account Cost for Goods Sold - _TC": {"cost_center": cost_center}, } - gl_entries = frappe.db.sql("""select account, cost_center, account_currency, debit, credit, + gl_entries = frappe.db.sql( + """select account, cost_center, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s - order by account asc""", pi.name, as_dict=1) + order by account asc""", + pi.name, + as_dict=1, + ) self.assertTrue(gl_entries) @@ -889,21 +1107,21 @@ class TestPurchaseInvoice(unittest.TestCase): def test_purchase_invoice_without_cost_center(self): cost_center = "_Test Cost Center - _TC" - pi = make_purchase_invoice(credit_to="Creditors - _TC") + pi = make_purchase_invoice(credit_to="Creditors - _TC") expected_values = { - "Creditors - _TC": { - "cost_center": None - }, - "_Test Account Cost for Goods Sold - _TC": { - "cost_center": cost_center - } + "Creditors - _TC": {"cost_center": None}, + "_Test Account Cost for Goods Sold - _TC": {"cost_center": cost_center}, } - gl_entries = frappe.db.sql("""select account, cost_center, account_currency, debit, credit, + gl_entries = frappe.db.sql( + """select account, cost_center, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s - order by account asc""", pi.name, as_dict=1) + order by account asc""", + pi.name, + as_dict=1, + ) self.assertTrue(gl_entries) @@ -911,36 +1129,40 @@ class TestPurchaseInvoice(unittest.TestCase): self.assertEqual(expected_values[gle.account]["cost_center"], gle.cost_center) def test_purchase_invoice_with_project_link(self): - project = make_project({ - 'project_name': 'Purchase Invoice Project', - 'project_template_name': 'Test Project Template', - 'start_date': '2020-01-01' - }) - item_project = make_project({ - 'project_name': 'Purchase Invoice Item Project', - 'project_template_name': 'Test Project Template', - 'start_date': '2019-06-01' - }) + project = make_project( + { + "project_name": "Purchase Invoice Project", + "project_template_name": "Test Project Template", + "start_date": "2020-01-01", + } + ) + item_project = make_project( + { + "project_name": "Purchase Invoice Item Project", + "project_template_name": "Test Project Template", + "start_date": "2019-06-01", + } + ) - pi = make_purchase_invoice(credit_to="Creditors - _TC" ,do_not_save=1) + pi = make_purchase_invoice(credit_to="Creditors - _TC", do_not_save=1) pi.items[0].project = item_project.name pi.project = project.name pi.submit() expected_values = { - "Creditors - _TC": { - "project": project.name - }, - "_Test Account Cost for Goods Sold - _TC": { - "project": item_project.name - } + "Creditors - _TC": {"project": project.name}, + "_Test Account Cost for Goods Sold - _TC": {"project": item_project.name}, } - gl_entries = frappe.db.sql("""select account, cost_center, project, account_currency, debit, credit, + gl_entries = frappe.db.sql( + """select account, cost_center, project, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s - order by account asc""", pi.name, as_dict=1) + order by account asc""", + pi.name, + as_dict=1, + ) self.assertTrue(gl_entries) @@ -948,10 +1170,11 @@ class TestPurchaseInvoice(unittest.TestCase): self.assertEqual(expected_values[gle.account]["project"], gle.project) def test_deferred_expense_via_journal_entry(self): - deferred_account = create_account(account_name="Deferred Expense", - parent_account="Current Assets - _TC", company="_Test Company") + deferred_account = create_account( + account_name="Deferred Expense", parent_account="Current Assets - _TC", company="_Test Company" + ) - acc_settings = frappe.get_doc('Accounts Settings', 'Accounts Settings') + acc_settings = frappe.get_doc("Accounts Settings", "Accounts Settings") acc_settings.book_deferred_entries_via_journal_entry = 1 acc_settings.submit_journal_entries = 1 acc_settings.save() @@ -963,7 +1186,7 @@ class TestPurchaseInvoice(unittest.TestCase): pi = make_purchase_invoice(item=item.name, qty=1, rate=100, do_not_save=True) pi.set_posting_time = 1 - pi.posting_date = '2019-03-15' + pi.posting_date = "2019-01-10" pi.items[0].enable_deferred_expense = 1 pi.items[0].service_start_date = "2019-01-10" pi.items[0].service_end_date = "2019-03-15" @@ -971,14 +1194,16 @@ class TestPurchaseInvoice(unittest.TestCase): pi.save() pi.submit() - pda1 = frappe.get_doc(dict( - doctype='Process Deferred Accounting', - posting_date=nowdate(), - start_date="2019-01-01", - end_date="2019-03-31", - type="Expense", - company="_Test Company" - )) + pda1 = frappe.get_doc( + dict( + doctype="Process Deferred Accounting", + posting_date=nowdate(), + start_date="2019-01-01", + end_date="2019-03-31", + type="Expense", + company="_Test Company", + ) + ) pda1.insert() pda1.submit() @@ -989,13 +1214,17 @@ class TestPurchaseInvoice(unittest.TestCase): ["_Test Account Cost for Goods Sold - _TC", 0.0, 43.08, "2019-02-28"], [deferred_account, 43.08, 0.0, "2019-02-28"], ["_Test Account Cost for Goods Sold - _TC", 0.0, 23.07, "2019-03-15"], - [deferred_account, 23.07, 0.0, "2019-03-15"] + [deferred_account, 23.07, 0.0, "2019-03-15"], ] - gl_entries = gl_entries = frappe.db.sql("""select account, debit, credit, posting_date + gl_entries = gl_entries = frappe.db.sql( + """select account, debit, credit, posting_date from `tabGL Entry` where voucher_type='Journal Entry' and voucher_detail_no=%s and posting_date <= %s - order by posting_date asc, account asc""", (pi.items[0].name, pi.posting_date), as_dict=1) + order by posting_date asc, account asc""", + (pi.items[0].name, pi.posting_date), + as_dict=1, + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_gle[i][0], gle.account) @@ -1003,108 +1232,139 @@ class TestPurchaseInvoice(unittest.TestCase): self.assertEqual(expected_gle[i][2], gle.debit) self.assertEqual(getdate(expected_gle[i][3]), gle.posting_date) - acc_settings = frappe.get_doc('Accounts Settings', 'Accounts Settings') + acc_settings = frappe.get_doc("Accounts Settings", "Accounts Settings") acc_settings.book_deferred_entries_via_journal_entry = 0 acc_settings.submit_journal_entriessubmit_journal_entries = 0 acc_settings.save() def test_gain_loss_with_advance_entry(self): unlink_enabled = frappe.db.get_value( - "Accounts Settings", "Accounts Settings", - "unlink_payment_on_cancel_of_invoice") + "Accounts Settings", "Accounts Settings", "unlink_payment_on_cancel_of_invoice" + ) frappe.db.set_value( - "Accounts Settings", "Accounts Settings", - "unlink_payment_on_cancel_of_invoice", 1) + "Accounts Settings", "Accounts Settings", "unlink_payment_on_cancel_of_invoice", 1 + ) original_account = frappe.db.get_value("Company", "_Test Company", "exchange_gain_loss_account") - frappe.db.set_value("Company", "_Test Company", "exchange_gain_loss_account", "Exchange Gain/Loss - _TC") + frappe.db.set_value( + "Company", "_Test Company", "exchange_gain_loss_account", "Exchange Gain/Loss - _TC" + ) - pay = frappe.get_doc({ - 'doctype': 'Payment Entry', - 'company': '_Test Company', - 'payment_type': 'Pay', - 'party_type': 'Supplier', - 'party': '_Test Supplier USD', - 'paid_to': '_Test Payable USD - _TC', - 'paid_from': 'Cash - _TC', - 'paid_amount': 70000, - 'target_exchange_rate': 70, - 'received_amount': 1000, - }) + pay = frappe.get_doc( + { + "doctype": "Payment Entry", + "company": "_Test Company", + "payment_type": "Pay", + "party_type": "Supplier", + "party": "_Test Supplier USD", + "paid_to": "_Test Payable USD - _TC", + "paid_from": "Cash - _TC", + "paid_amount": 70000, + "target_exchange_rate": 70, + "received_amount": 1000, + } + ) pay.insert() pay.submit() - pi = make_purchase_invoice(supplier='_Test Supplier USD', currency="USD", - conversion_rate=75, rate=500, do_not_save=1, qty=1) + pi = make_purchase_invoice( + supplier="_Test Supplier USD", + currency="USD", + conversion_rate=75, + rate=500, + do_not_save=1, + qty=1, + ) pi.cost_center = "_Test Cost Center - _TC" pi.advances = [] - pi.append("advances", { - "reference_type": "Payment Entry", - "reference_name": pay.name, - "advance_amount": 1000, - "remarks": pay.remarks, - "allocated_amount": 500, - "ref_exchange_rate": 70 - }) + pi.append( + "advances", + { + "reference_type": "Payment Entry", + "reference_name": pay.name, + "advance_amount": 1000, + "remarks": pay.remarks, + "allocated_amount": 500, + "ref_exchange_rate": 70, + }, + ) pi.save() pi.submit() expected_gle = [ ["_Test Account Cost for Goods Sold - _TC", 37500.0], ["_Test Payable USD - _TC", -35000.0], - ["Exchange Gain/Loss - _TC", -2500.0] + ["Exchange Gain/Loss - _TC", -2500.0], ] - gl_entries = frappe.db.sql(""" + gl_entries = frappe.db.sql( + """ select account, sum(debit - credit) as balance from `tabGL Entry` where voucher_no=%s group by account - order by account asc""", (pi.name), as_dict=1) + order by account asc""", + (pi.name), + as_dict=1, + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_gle[i][0], gle.account) self.assertEqual(expected_gle[i][1], gle.balance) - pi_2 = make_purchase_invoice(supplier='_Test Supplier USD', currency="USD", - conversion_rate=73, rate=500, do_not_save=1, qty=1) + pi_2 = make_purchase_invoice( + supplier="_Test Supplier USD", + currency="USD", + conversion_rate=73, + rate=500, + do_not_save=1, + qty=1, + ) pi_2.cost_center = "_Test Cost Center - _TC" pi_2.advances = [] - pi_2.append("advances", { - "reference_type": "Payment Entry", - "reference_name": pay.name, - "advance_amount": 500, - "remarks": pay.remarks, - "allocated_amount": 500, - "ref_exchange_rate": 70 - }) + pi_2.append( + "advances", + { + "reference_type": "Payment Entry", + "reference_name": pay.name, + "advance_amount": 500, + "remarks": pay.remarks, + "allocated_amount": 500, + "ref_exchange_rate": 70, + }, + ) pi_2.save() pi_2.submit() expected_gle = [ ["_Test Account Cost for Goods Sold - _TC", 36500.0], ["_Test Payable USD - _TC", -35000.0], - ["Exchange Gain/Loss - _TC", -1500.0] + ["Exchange Gain/Loss - _TC", -1500.0], ] - gl_entries = frappe.db.sql(""" + gl_entries = frappe.db.sql( + """ select account, sum(debit - credit) as balance from `tabGL Entry` where voucher_no=%s - group by account order by account asc""", (pi_2.name), as_dict=1) + group by account order by account asc""", + (pi_2.name), + as_dict=1, + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_gle[i][0], gle.account) self.assertEqual(expected_gle[i][1], gle.balance) - expected_gle = [ - ["_Test Payable USD - _TC", 70000.0], - ["Cash - _TC", -70000.0] - ] + expected_gle = [["_Test Payable USD - _TC", 70000.0], ["Cash - _TC", -70000.0]] - gl_entries = frappe.db.sql(""" + gl_entries = frappe.db.sql( + """ select account, sum(debit - credit) as balance from `tabGL Entry` where voucher_no=%s and is_cancelled=0 - group by account order by account asc""", (pay.name), as_dict=1) + group by account order by account asc""", + (pay.name), + as_dict=1, + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_gle[i][0], gle.account) @@ -1119,46 +1379,57 @@ class TestPurchaseInvoice(unittest.TestCase): pay.reload() pay.cancel() - frappe.db.set_value("Accounts Settings", "Accounts Settings", "unlink_payment_on_cancel_of_invoice", unlink_enabled) + frappe.db.set_value( + "Accounts Settings", "Accounts Settings", "unlink_payment_on_cancel_of_invoice", unlink_enabled + ) frappe.db.set_value("Company", "_Test Company", "exchange_gain_loss_account", original_account) def test_purchase_invoice_advance_taxes(self): from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry - from erpnext.buying.doctype.purchase_order.purchase_order import get_mapped_purchase_invoice - from erpnext.buying.doctype.purchase_order.test_purchase_order import create_purchase_order # create a new supplier to test - supplier = create_supplier(supplier_name = '_Test TDS Advance Supplier', - tax_withholding_category = 'TDS - 194 - Dividends - Individual') + supplier = create_supplier( + supplier_name="_Test TDS Advance Supplier", + tax_withholding_category="TDS - 194 - Dividends - Individual", + ) # Update tax withholding category with current fiscal year and rate details - update_tax_witholding_category('_Test Company', 'TDS Payable - _TC') + update_tax_witholding_category("_Test Company", "TDS Payable - _TC") # Create Purchase Order with TDS applied - po = create_purchase_order(do_not_save=1, supplier=supplier.name, rate=3000, item='_Test Non Stock Item', - posting_date='2021-09-15') + po = create_purchase_order( + do_not_save=1, + supplier=supplier.name, + rate=3000, + item="_Test Non Stock Item", + posting_date="2021-09-15", + ) po.save() po.submit() # Create Payment Entry Against the order - payment_entry = get_payment_entry(dt='Purchase Order', dn=po.name) - payment_entry.paid_from = 'Cash - _TC' + payment_entry = get_payment_entry(dt="Purchase Order", dn=po.name) + payment_entry.paid_from = "Cash - _TC" payment_entry.apply_tax_withholding_amount = 1 - payment_entry.tax_withholding_category = 'TDS - 194 - Dividends - Individual' + payment_entry.tax_withholding_category = "TDS - 194 - Dividends - Individual" payment_entry.save() payment_entry.submit() # Check GLE for Payment Entry expected_gle = [ - ['Cash - _TC', 0, 27000], - ['Creditors - _TC', 30000, 0], - ['TDS Payable - _TC', 0, 3000], + ["Cash - _TC", 0, 27000], + ["Creditors - _TC", 30000, 0], + ["TDS Payable - _TC", 0, 3000], ] - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Payment Entry' and voucher_no=%s - order by account asc""", (payment_entry.name), as_dict=1) + order by account asc""", + (payment_entry.name), + as_dict=1, + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_gle[i][0], gle.account) @@ -1168,23 +1439,24 @@ class TestPurchaseInvoice(unittest.TestCase): # Create Purchase Invoice against Purchase Order purchase_invoice = get_mapped_purchase_invoice(po.name) purchase_invoice.allocate_advances_automatically = 1 - purchase_invoice.items[0].item_code = '_Test Non Stock Item' - purchase_invoice.items[0].expense_account = '_Test Account Cost for Goods Sold - _TC' + purchase_invoice.items[0].item_code = "_Test Non Stock Item" + purchase_invoice.items[0].expense_account = "_Test Account Cost for Goods Sold - _TC" purchase_invoice.save() purchase_invoice.submit() # Check GLE for Purchase Invoice # Zero net effect on final TDS Payable on invoice - expected_gle = [ - ['_Test Account Cost for Goods Sold - _TC', 30000], - ['Creditors - _TC', -30000] - ] + expected_gle = [["_Test Account Cost for Goods Sold - _TC", 30000], ["Creditors - _TC", -30000]] - gl_entries = frappe.db.sql("""select account, sum(debit - credit) as amount + gl_entries = frappe.db.sql( + """select account, sum(debit - credit) as amount from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s group by account - order by account asc""", (purchase_invoice.name), as_dict=1) + order by account asc""", + (purchase_invoice.name), + as_dict=1, + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_gle[i][0], gle.account) @@ -1198,11 +1470,126 @@ class TestPurchaseInvoice(unittest.TestCase): payment_entry.load_from_db() self.assertEqual(payment_entry.taxes[0].allocated_amount, 0) + def test_provisional_accounting_entry(self): + create_item("_Test Non Stock Item", is_stock_item=0) + + provisional_account = create_account( + account_name="Provision Account", + parent_account="Current Liabilities - _TC", + company="_Test Company", + ) + + company = frappe.get_doc("Company", "_Test Company") + company.enable_provisional_accounting_for_non_stock_items = 1 + company.default_provisional_account = provisional_account + company.save() + + pr = make_purchase_receipt( + item_code="_Test Non Stock Item", posting_date=add_days(nowdate(), -2) + ) + + pi = create_purchase_invoice_from_receipt(pr.name) + pi.set_posting_time = 1 + pi.posting_date = add_days(pr.posting_date, -1) + pi.items[0].expense_account = "Cost of Goods Sold - _TC" + pi.save() + pi.submit() + + self.assertEquals(pr.items[0].provisional_expense_account, "Provision Account - _TC") + + # Check GLE for Purchase Invoice + expected_gle = [ + ["Cost of Goods Sold - _TC", 250, 0, add_days(pr.posting_date, -1)], + ["Creditors - _TC", 0, 250, add_days(pr.posting_date, -1)], + ] + + check_gl_entries(self, pi.name, expected_gle, pi.posting_date) + + expected_gle_for_purchase_receipt = [ + ["Provision Account - _TC", 250, 0, pr.posting_date], + ["_Test Account Cost for Goods Sold - _TC", 0, 250, pr.posting_date], + ["Provision Account - _TC", 0, 250, pi.posting_date], + ["_Test Account Cost for Goods Sold - _TC", 250, 0, pi.posting_date], + ] + + check_gl_entries(self, pr.name, expected_gle_for_purchase_receipt, pr.posting_date) + + # Cancel purchase invoice to check reverse provisional entry cancellation + pi.cancel() + + expected_gle_for_purchase_receipt_post_pi_cancel = [ + ["Provision Account - _TC", 0, 250, pi.posting_date], + ["_Test Account Cost for Goods Sold - _TC", 250, 0, pi.posting_date], + ] + + check_gl_entries( + self, pr.name, expected_gle_for_purchase_receipt_post_pi_cancel, pr.posting_date + ) + + company.enable_provisional_accounting_for_non_stock_items = 0 + company.save() + + def test_item_less_defaults(self): + + pi = frappe.new_doc("Purchase Invoice") + pi.supplier = "_Test Supplier" + pi.company = "_Test Company" + pi.append( + "items", + { + "item_name": "Opening item", + "qty": 1, + "uom": "Tonne", + "stock_uom": "Kg", + "rate": 1000, + "expense_account": "Stock Received But Not Billed - _TC", + }, + ) + + pi.save() + self.assertEqual(pi.items[0].conversion_factor, 1000) + + def test_batch_expiry_for_purchase_invoice(self): + from erpnext.controllers.sales_and_purchase_return import make_return_doc + + item = self.make_item( + "_Test Batch Item For Return Check", + { + "is_purchase_item": 1, + "is_stock_item": 1, + "has_batch_no": 1, + "create_new_batch": 1, + "batch_number_series": "TBIRC.#####", + }, + ) + + pi = make_purchase_invoice( + qty=1, + item_code=item.name, + update_stock=True, + ) + + pi.load_from_db() + batch_no = pi.items[0].batch_no + self.assertTrue(batch_no) + + frappe.db.set_value("Batch", batch_no, "expiry_date", add_days(nowdate(), -1)) + + return_pi = make_return_doc(pi.doctype, pi.name) + return_pi.save().submit() + + self.assertTrue(return_pi.docstatus == 1) + + def check_gl_entries(doc, voucher_no, expected_gle, posting_date): - gl_entries = frappe.db.sql("""select account, debit, credit, posting_date + gl_entries = frappe.db.sql( + """select account, debit, credit, posting_date from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no=%s and posting_date >= %s - order by posting_date asc, account asc""", (voucher_no, posting_date), as_dict=1) + order by posting_date asc, account asc""", + (voucher_no, posting_date), + as_dict=1, + ) for i, gle in enumerate(gl_entries): doc.assertEqual(expected_gle[i][0], gle.account) @@ -1210,45 +1597,55 @@ def check_gl_entries(doc, voucher_no, expected_gle, posting_date): doc.assertEqual(expected_gle[i][2], gle.credit) doc.assertEqual(getdate(expected_gle[i][3]), gle.posting_date) + def update_tax_witholding_category(company, account): from erpnext.accounts.utils import get_fiscal_year - fiscal_year = get_fiscal_year(fiscal_year='_Test Fiscal Year 2021') + fiscal_year = get_fiscal_year(date=nowdate()) - if not frappe.db.get_value('Tax Withholding Rate', - {'parent': 'TDS - 194 - Dividends - Individual', 'from_date': ('>=', fiscal_year[1]), - 'to_date': ('<=', fiscal_year[2])}): - tds_category = frappe.get_doc('Tax Withholding Category', 'TDS - 194 - Dividends - Individual') - tds_category.set('rates', []) + if not frappe.db.get_value( + "Tax Withholding Rate", + { + "parent": "TDS - 194 - Dividends - Individual", + "from_date": (">=", fiscal_year[1]), + "to_date": ("<=", fiscal_year[2]), + }, + ): + tds_category = frappe.get_doc("Tax Withholding Category", "TDS - 194 - Dividends - Individual") + tds_category.set("rates", []) - tds_category.append('rates', { - 'from_date': fiscal_year[1], - 'to_date': fiscal_year[2], - 'tax_withholding_rate': 10, - 'single_threshold': 2500, - 'cumulative_threshold': 0 - }) + tds_category.append( + "rates", + { + "from_date": fiscal_year[1], + "to_date": fiscal_year[2], + "tax_withholding_rate": 10, + "single_threshold": 2500, + "cumulative_threshold": 0, + }, + ) tds_category.save() - if not frappe.db.get_value('Tax Withholding Account', - {'parent': 'TDS - 194 - Dividends - Individual', 'account': account}): - tds_category = frappe.get_doc('Tax Withholding Category', 'TDS - 194 - Dividends - Individual') - tds_category.append('accounts', { - 'company': company, - 'account': account - }) + if not frappe.db.get_value( + "Tax Withholding Account", {"parent": "TDS - 194 - Dividends - Individual", "account": account} + ): + tds_category = frappe.get_doc("Tax Withholding Category", "TDS - 194 - Dividends - Individual") + tds_category.append("accounts", {"company": company, "account": account}) tds_category.save() + def unlink_payment_on_cancel_of_invoice(enable=1): accounts_settings = frappe.get_doc("Accounts Settings") accounts_settings.unlink_payment_on_cancellation_of_invoice = enable accounts_settings.save() + def enable_discount_accounting(enable=1): accounts_settings = frappe.get_doc("Accounts Settings") accounts_settings.enable_discount_accounting = enable accounts_settings.save() + def make_purchase_invoice(**args): pi = frappe.new_doc("Purchase Invoice") args = frappe._dict(args) @@ -1261,7 +1658,7 @@ def make_purchase_invoice(**args): pi.is_paid = 1 if args.cash_bank_account: - pi.cash_bank_account=args.cash_bank_account + pi.cash_bank_account = args.cash_bank_account pi.company = args.company or "_Test Company" pi.supplier = args.supplier or "_Test Supplier" @@ -1273,27 +1670,30 @@ def make_purchase_invoice(**args): pi.supplier_warehouse = args.supplier_warehouse or "_Test Warehouse 1 - _TC" pi.cost_center = args.parent_cost_center - pi.append("items", { - "item_code": args.item or args.item_code or "_Test Item", - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "qty": args.qty or 5, - "received_qty": args.received_qty or 0, - "rejected_qty": args.rejected_qty or 0, - "rate": args.rate or 50, - "price_list_rate": args.price_list_rate or 50, - "expense_account": args.expense_account or '_Test Account Cost for Goods Sold - _TC', - "discount_account": args.discount_account or None, - "discount_amount": args.discount_amount or 0, - "conversion_factor": 1.0, - "serial_no": args.serial_no, - "stock_uom": args.uom or "_Test UOM", - "cost_center": args.cost_center or "_Test Cost Center - _TC", - "project": args.project, - "rejected_warehouse": args.rejected_warehouse or "", - "rejected_serial_no": args.rejected_serial_no or "", - "asset_location": args.location or "", - "allow_zero_valuation_rate": args.get("allow_zero_valuation_rate") or 0 - }) + pi.append( + "items", + { + "item_code": args.item or args.item_code or "_Test Item", + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "qty": args.qty or 5, + "received_qty": args.received_qty or 0, + "rejected_qty": args.rejected_qty or 0, + "rate": args.rate or 50, + "price_list_rate": args.price_list_rate or 50, + "expense_account": args.expense_account or "_Test Account Cost for Goods Sold - _TC", + "discount_account": args.discount_account or None, + "discount_amount": args.discount_amount or 0, + "conversion_factor": 1.0, + "serial_no": args.serial_no, + "stock_uom": args.uom or "_Test UOM", + "cost_center": args.cost_center or "_Test Cost Center - _TC", + "project": args.project, + "rejected_warehouse": args.rejected_warehouse or "", + "rejected_serial_no": args.rejected_serial_no or "", + "asset_location": args.location or "", + "allow_zero_valuation_rate": args.get("allow_zero_valuation_rate") or 0, + }, + ) if args.get_taxes_and_charges: taxes = get_taxes() @@ -1306,6 +1706,7 @@ def make_purchase_invoice(**args): pi.submit() return pi + def make_purchase_invoice_against_cost_center(**args): pi = frappe.new_doc("Purchase Invoice") args = frappe._dict(args) @@ -1318,7 +1719,7 @@ def make_purchase_invoice_against_cost_center(**args): pi.is_paid = 1 if args.cash_bank_account: - pi.cash_bank_account=args.cash_bank_account + pi.cash_bank_account = args.cash_bank_account pi.company = args.company or "_Test Company" pi.cost_center = args.cost_center or "_Test Cost Center - _TC" @@ -1332,25 +1733,29 @@ def make_purchase_invoice_against_cost_center(**args): if args.supplier_warehouse: pi.supplier_warehouse = "_Test Warehouse 1 - _TC" - pi.append("items", { - "item_code": args.item or args.item_code or "_Test Item", - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "qty": args.qty or 5, - "received_qty": args.received_qty or 0, - "rejected_qty": args.rejected_qty or 0, - "rate": args.rate or 50, - "conversion_factor": 1.0, - "serial_no": args.serial_no, - "stock_uom": "_Test UOM", - "cost_center": args.cost_center or "_Test Cost Center - _TC", - "project": args.project, - "rejected_warehouse": args.rejected_warehouse or "", - "rejected_serial_no": args.rejected_serial_no or "" - }) + pi.append( + "items", + { + "item_code": args.item or args.item_code or "_Test Item", + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "qty": args.qty or 5, + "received_qty": args.received_qty or 0, + "rejected_qty": args.rejected_qty or 0, + "rate": args.rate or 50, + "conversion_factor": 1.0, + "serial_no": args.serial_no, + "stock_uom": "_Test UOM", + "cost_center": args.cost_center or "_Test Cost Center - _TC", + "project": args.project, + "rejected_warehouse": args.rejected_warehouse or "", + "rejected_serial_no": args.rejected_serial_no or "", + }, + ) if not args.do_not_save: pi.insert() if not args.do_not_submit: pi.submit() return pi -test_records = frappe.get_test_records('Purchase Invoice') + +test_records = frappe.get_test_records("Purchase Invoice") diff --git a/erpnext/accounts/doctype/purchase_taxes_and_charges_template/purchase_taxes_and_charges_template.py b/erpnext/accounts/doctype/purchase_taxes_and_charges_template/purchase_taxes_and_charges_template.py index f5eb404d0a4..70d29bfda25 100644 --- a/erpnext/accounts/doctype/purchase_taxes_and_charges_template/purchase_taxes_and_charges_template.py +++ b/erpnext/accounts/doctype/purchase_taxes_and_charges_template/purchase_taxes_and_charges_template.py @@ -16,5 +16,5 @@ class PurchaseTaxesandChargesTemplate(Document): def autoname(self): if self.company and self.title: - abbr = frappe.get_cached_value('Company', self.company, 'abbr') - self.name = '{0} - {1}'.format(self.title, abbr) + abbr = frappe.get_cached_value("Company", self.company, "abbr") + self.name = "{0} - {1}".format(self.title, abbr) diff --git a/erpnext/accounts/doctype/purchase_taxes_and_charges_template/purchase_taxes_and_charges_template_dashboard.py b/erpnext/accounts/doctype/purchase_taxes_and_charges_template/purchase_taxes_and_charges_template_dashboard.py index 95a7a1c889b..1f0ea211f20 100644 --- a/erpnext/accounts/doctype/purchase_taxes_and_charges_template/purchase_taxes_and_charges_template_dashboard.py +++ b/erpnext/accounts/doctype/purchase_taxes_and_charges_template/purchase_taxes_and_charges_template_dashboard.py @@ -1,21 +1,17 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'taxes_and_charges', - 'non_standard_fieldnames': { - 'Tax Rule': 'purchase_tax_template', + "fieldname": "taxes_and_charges", + "non_standard_fieldnames": { + "Tax Rule": "purchase_tax_template", }, - 'transactions': [ + "transactions": [ { - 'label': _('Transactions'), - 'items': ['Purchase Invoice', 'Purchase Order', 'Purchase Receipt'] + "label": _("Transactions"), + "items": ["Purchase Invoice", "Purchase Order", "Purchase Receipt"], }, - { - 'label': _('References'), - 'items': ['Supplier Quotation', 'Tax Rule'] - } - ] + {"label": _("References"), "items": ["Supplier Quotation", "Tax Rule"]}, + ], } diff --git a/erpnext/accounts/doctype/purchase_taxes_and_charges_template/test_purchase_taxes_and_charges_template.py b/erpnext/accounts/doctype/purchase_taxes_and_charges_template/test_purchase_taxes_and_charges_template.py index b5b4a67d759..1d02f055048 100644 --- a/erpnext/accounts/doctype/purchase_taxes_and_charges_template/test_purchase_taxes_and_charges_template.py +++ b/erpnext/accounts/doctype/purchase_taxes_and_charges_template/test_purchase_taxes_and_charges_template.py @@ -5,5 +5,6 @@ import unittest # test_records = frappe.get_test_records('Purchase Taxes and Charges Template') + class TestPurchaseTaxesandChargesTemplate(unittest.TestCase): pass diff --git a/erpnext/accounts/doctype/sales_invoice/sales_invoice.js b/erpnext/accounts/doctype/sales_invoice/sales_invoice.js index 8a6d3cd5935..c765e4f07ff 100644 --- a/erpnext/accounts/doctype/sales_invoice/sales_invoice.js +++ b/erpnext/accounts/doctype/sales_invoice/sales_invoice.js @@ -34,7 +34,9 @@ erpnext.accounts.SalesInvoiceController = erpnext.selling.SellingController.exte var me = this; this._super(); - this.frm.ignore_doctypes_on_cancel_all = ['POS Invoice', 'Timesheet', 'POS Invoice Merge Log', 'POS Closing Entry']; + this.frm.ignore_doctypes_on_cancel_all = ['POS Invoice', 'Timesheet', 'POS Invoice Merge Log', + 'POS Closing Entry', 'Journal Entry', 'Payment Entry']; + if(!this.frm.doc.__islocal && !this.frm.doc.customer && this.frm.doc.debit_to) { // show debit_to in print format this.frm.set_df_property("debit_to", "print_hide", 0); @@ -51,7 +53,6 @@ erpnext.accounts.SalesInvoiceController = erpnext.selling.SellingController.exte me.frm.refresh_fields(); } erpnext.queries.setup_warehouse_query(this.frm); - erpnext.accounts.dimensions.setup_dimension_filters(this.frm, this.frm.doctype); }, refresh: function(doc, dt, dn) { @@ -281,6 +282,9 @@ erpnext.accounts.SalesInvoiceController = erpnext.selling.SellingController.exte } var me = this; if(this.frm.updating_party_details) return; + + if (this.frm.doc.__onload && this.frm.doc.__onload.load_after_mapping) return; + erpnext.utils.get_party_details(this.frm, "erpnext.accounts.party.get_party_details", { posting_date: this.frm.doc.posting_date, @@ -470,9 +474,21 @@ erpnext.accounts.SalesInvoiceController = erpnext.selling.SellingController.exte let row = frappe.get_doc(d.doctype, d.name) set_timesheet_detail_rate(row.doctype, row.name, me.frm.doc.currency, row.timesheet_detail) }); - frm.trigger("calculate_timesheet_totals"); + this.frm.trigger("calculate_timesheet_totals"); } + }, + + is_cash_or_non_trade_discount() { + this.frm.set_df_property("additional_discount_account", "hidden", 1 - this.frm.doc.is_cash_or_non_trade_discount); + this.frm.set_df_property("additional_discount_account", "reqd", this.frm.doc.is_cash_or_non_trade_discount); + + if (!this.frm.doc.is_cash_or_non_trade_discount) { + this.frm.set_value("additional_discount_account", ""); + } + + this.calculate_taxes_and_totals(); } + }); // for backward compatibility: combine new and previous states @@ -880,27 +896,44 @@ frappe.ui.form.on('Sales Invoice', { set_timesheet_data: function(frm, timesheets) { frm.clear_table("timesheets") - timesheets.forEach(timesheet => { + timesheets.forEach(async (timesheet) => { if (frm.doc.currency != timesheet.currency) { - frappe.call({ - method: "erpnext.setup.utils.get_exchange_rate", - args: { - from_currency: timesheet.currency, - to_currency: frm.doc.currency - }, - callback: function(r) { - if (r.message) { - exchange_rate = r.message; - frm.events.append_time_log(frm, timesheet, exchange_rate); - } - } - }); + const exchange_rate = await frm.events.get_exchange_rate( + frm, timesheet.currency, frm.doc.currency + ) + frm.events.append_time_log(frm, timesheet, exchange_rate) } else { frm.events.append_time_log(frm, timesheet, 1.0); } }); }, + async get_exchange_rate(frm, from_currency, to_currency) { + if ( + frm.exchange_rates + && frm.exchange_rates[from_currency] + && frm.exchange_rates[from_currency][to_currency] + ) { + return frm.exchange_rates[from_currency][to_currency]; + } + + return frappe.call({ + method: "erpnext.setup.utils.get_exchange_rate", + args: { + from_currency, + to_currency + }, + callback: function(r) { + if (r.message) { + // cache exchange rates + frm.exchange_rates = frm.exchange_rates || {}; + frm.exchange_rates[from_currency] = frm.exchange_rates[from_currency] || {}; + frm.exchange_rates[from_currency][to_currency] = r.message; + } + } + }); + }, + append_time_log: function(frm, time_log, exchange_rate) { const row = frm.add_child("timesheets"); row.activity_type = time_log.activity_type; @@ -911,7 +944,7 @@ frappe.ui.form.on('Sales Invoice', { row.billing_hours = time_log.billing_hours; row.billing_amount = flt(time_log.billing_amount) * flt(exchange_rate); row.timesheet_detail = time_log.name; - row.project_name = time_log.project_name; + row.project_name = time_log.project_name; frm.refresh_field("timesheets"); frm.trigger("calculate_timesheet_totals"); diff --git a/erpnext/accounts/doctype/sales_invoice/sales_invoice.json b/erpnext/accounts/doctype/sales_invoice/sales_invoice.json index 545abf77e6b..cd3434a7756 100644 --- a/erpnext/accounts/doctype/sales_invoice/sales_invoice.json +++ b/erpnext/accounts/doctype/sales_invoice/sales_invoice.json @@ -2,7 +2,7 @@ "actions": [], "allow_import": 1, "autoname": "naming_series:", - "creation": "2013-05-24 19:29:05", + "creation": "2022-01-25 10:29:57.771398", "doctype": "DocType", "engine": "InnoDB", "field_order": [ @@ -106,6 +106,7 @@ "loyalty_redemption_cost_center", "section_break_49", "apply_discount_on", + "is_cash_or_non_trade_discount", "base_discount_amount", "additional_discount_account", "column_break_51", @@ -413,7 +414,7 @@ }, { "default": "0", - "depends_on": "eval: doc.is_return && doc.return_against", + "depends_on": "eval: doc.is_return", "fieldname": "update_billed_amount_in_sales_order", "fieldtype": "Check", "hide_days": 1, @@ -650,8 +651,6 @@ "hide_days": 1, "hide_seconds": 1, "label": "Ignore Pricing Rule", - "no_copy": 1, - "permlevel": 1, "print_hide": 1 }, { @@ -1974,9 +1973,10 @@ }, { "default": "0", + "description": "Issue a debit note with 0 qty against an existing Sales Invoice", "fieldname": "is_debit_note", "fieldtype": "Check", - "label": "Is Debit Note" + "label": "Is Rate Adjustment Entry (Debit Note)" }, { "default": "0", @@ -1988,7 +1988,7 @@ { "fieldname": "additional_discount_account", "fieldtype": "Link", - "label": "Additional Discount Account", + "label": "Discount Account", "options": "Account" }, { @@ -2026,6 +2026,13 @@ "fieldtype": "Currency", "label": "Amount Eligible for Commission", "read_only": 1 + }, + { + "default": "0", + "depends_on": "eval: doc.apply_discount_on == \"Grand Total\"", + "fieldname": "is_cash_or_non_trade_discount", + "fieldtype": "Check", + "label": "Is Cash or Non Trade Discount" } ], "icon": "fa fa-file-text", @@ -2038,7 +2045,7 @@ "link_fieldname": "consolidated_invoice" } ], - "modified": "2021-10-21 20:19:38.667508", + "modified": "2022-09-16 17:44:22.227332", "modified_by": "Administrator", "module": "Accounts", "name": "Sales Invoice", @@ -2089,8 +2096,9 @@ "show_name_in_global_search": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "timeline_field": "customer", "title_field": "title", "track_changes": 1, "track_seen": 1 -} +} \ No newline at end of file diff --git a/erpnext/accounts/doctype/sales_invoice/sales_invoice.py b/erpnext/accounts/doctype/sales_invoice/sales_invoice.py index 176d47897d6..1badb809341 100644 --- a/erpnext/accounts/doctype/sales_invoice/sales_invoice.py +++ b/erpnext/accounts/doctype/sales_invoice/sales_invoice.py @@ -38,35 +38,41 @@ from erpnext.assets.doctype.asset.depreciation import ( get_gl_entries_on_asset_regain, make_depreciation_entry, ) +from erpnext.controllers.accounts_controller import validate_account_head from erpnext.controllers.selling_controller import SellingController from erpnext.healthcare.utils import manage_invoice_submit_cancel from erpnext.projects.doctype.timesheet.timesheet import get_projectwise_timesheet_data from erpnext.setup.doctype.company.company import update_company_current_month_sales from erpnext.stock.doctype.batch.batch import set_batch_nos from erpnext.stock.doctype.delivery_note.delivery_note import update_billed_amount_based_on_so -from erpnext.stock.doctype.serial_no.serial_no import get_delivery_note_serial_no, get_serial_nos +from erpnext.stock.doctype.serial_no.serial_no import ( + get_delivery_note_serial_no, + get_serial_nos, + update_serial_nos_after_submit, +) + +form_grid_templates = {"items": "templates/form_grid/item_grid.html"} -form_grid_templates = { - "items": "templates/form_grid/item_grid.html" -} class SalesInvoice(SellingController): def __init__(self, *args, **kwargs): super(SalesInvoice, self).__init__(*args, **kwargs) - self.status_updater = [{ - 'source_dt': 'Sales Invoice Item', - 'target_field': 'billed_amt', - 'target_ref_field': 'amount', - 'target_dt': 'Sales Order Item', - 'join_field': 'so_detail', - 'target_parent_dt': 'Sales Order', - 'target_parent_field': 'per_billed', - 'source_field': 'amount', - 'percent_join_field': 'sales_order', - 'status_field': 'billing_status', - 'keyword': 'Billed', - 'overflow_type': 'billing' - }] + self.status_updater = [ + { + "source_dt": "Sales Invoice Item", + "target_field": "billed_amt", + "target_ref_field": "amount", + "target_dt": "Sales Order Item", + "join_field": "so_detail", + "target_parent_dt": "Sales Order", + "target_parent_field": "per_billed", + "source_field": "amount", + "percent_join_field": "sales_order", + "status_field": "billing_status", + "keyword": "Billed", + "overflow_type": "billing", + } + ] def set_indicator(self): """Set indicator for portal""" @@ -109,7 +115,12 @@ class SalesInvoice(SellingController): self.validate_fixed_asset() self.set_income_account_for_fixed_assets() self.validate_item_cost_centers() - validate_inter_company_party(self.doctype, self.customer, self.company, self.inter_company_invoice_reference) + self.validate_income_account() + self.check_conversion_rate() + + validate_inter_company_party( + self.doctype, self.customer, self.company, self.inter_company_invoice_reference + ) if cint(self.is_pos): self.validate_pos() @@ -125,15 +136,21 @@ class SalesInvoice(SellingController): validate_service_stop_date(self) if not self.is_opening: - self.is_opening = 'No' + self.is_opening = "No" - if self._action != 'submit' and self.update_stock and not self.is_return: - set_batch_nos(self, 'warehouse', True) + if self._action != "submit" and self.update_stock and not self.is_return: + set_batch_nos(self, "warehouse", True) if self.redeem_loyalty_points: - lp = frappe.get_doc('Loyalty Program', self.loyalty_program) - self.loyalty_redemption_account = lp.expense_account if not self.loyalty_redemption_account else self.loyalty_redemption_account - self.loyalty_redemption_cost_center = lp.cost_center if not self.loyalty_redemption_cost_center else self.loyalty_redemption_cost_center + lp = frappe.get_doc("Loyalty Program", self.loyalty_program) + self.loyalty_redemption_account = ( + lp.expense_account if not self.loyalty_redemption_account else self.loyalty_redemption_account + ) + self.loyalty_redemption_cost_center = ( + lp.cost_center + if not self.loyalty_redemption_cost_center + else self.loyalty_redemption_cost_center + ) self.set_against_income_account() self.validate_c_form() @@ -150,11 +167,16 @@ class SalesInvoice(SellingController): if self.is_pos and not self.is_return: self.verify_payment_amount_is_positive() - #validate amount in mode of payments for returned invoices for pos must be negative + # validate amount in mode of payments for returned invoices for pos must be negative if self.is_pos and self.is_return: self.verify_payment_amount_is_negative() - if self.redeem_loyalty_points and self.loyalty_program and self.loyalty_points and not self.is_consolidated: + if ( + self.redeem_loyalty_points + and self.loyalty_program + and self.loyalty_points + and not self.is_consolidated + ): validate_loyalty_points(self, self.loyalty_points) self.reset_default_field_value("set_warehouse", "items", "warehouse") @@ -167,14 +189,28 @@ class SalesInvoice(SellingController): if self.update_stock: frappe.throw(_("'Update Stock' cannot be checked for fixed asset sale")) - elif asset.status in ("Scrapped", "Cancelled") or (asset.status == "Sold" and not self.is_return): - frappe.throw(_("Row #{0}: Asset {1} cannot be submitted, it is already {2}").format(d.idx, d.asset, asset.status)) + elif asset.status in ("Scrapped", "Cancelled") or ( + asset.status == "Sold" and not self.is_return + ): + frappe.throw( + _("Row #{0}: Asset {1} cannot be submitted, it is already {2}").format( + d.idx, d.asset, asset.status + ) + ) def validate_item_cost_centers(self): for item in self.items: cost_center_company = frappe.get_cached_value("Cost Center", item.cost_center, "company") if cost_center_company != self.company: - frappe.throw(_("Row #{0}: Cost Center {1} does not belong to company {2}").format(frappe.bold(item.idx), frappe.bold(item.cost_center), frappe.bold(self.company))) + frappe.throw( + _("Row #{0}: Cost Center {1} does not belong to company {2}").format( + frappe.bold(item.idx), frappe.bold(item.cost_center), frappe.bold(self.company) + ) + ) + + def validate_income_account(self): + for item in self.get("items"): + validate_account_head(item.idx, item.income_account, self.company, "Income") def set_tax_withholding(self): tax_withholding_details = get_party_tax_withholding_details(self) @@ -193,8 +229,11 @@ class SalesInvoice(SellingController): if not accounts or tax_withholding_account not in accounts: self.append("taxes", tax_withholding_details) - to_remove = [d for d in self.taxes - if not d.tax_amount and d.charge_type == "Actual" and d.account_head == tax_withholding_account] + to_remove = [ + d + for d in self.taxes + if not d.tax_amount and d.charge_type == "Actual" and d.account_head == tax_withholding_account + ] for d in to_remove: self.remove(d) @@ -209,8 +248,9 @@ class SalesInvoice(SellingController): self.validate_pos_paid_amount() if not self.auto_repeat: - frappe.get_doc('Authorization Control').validate_approving_authority(self.doctype, - self.company, self.base_grand_total, self) + frappe.get_doc("Authorization Control").validate_approving_authority( + self.doctype, self.company, self.base_grand_total, self + ) self.check_prev_docstatus() @@ -227,6 +267,8 @@ class SalesInvoice(SellingController): # because updating reserved qty in bin depends upon updated delivered qty in SO if self.update_stock == 1: self.update_stock_ledger() + if self.is_return and self.update_stock: + update_serial_nos_after_submit(self, "items") # this sequence because outstanding may get -ve self.make_gl_entries() @@ -246,7 +288,9 @@ class SalesInvoice(SellingController): self.update_time_sheet(self.name) - if frappe.db.get_single_value('Selling Settings', 'sales_update_frequency') == "Each Transaction": + if ( + frappe.db.get_single_value("Selling Settings", "sales_update_frequency") == "Each Transaction" + ): update_company_current_month_sales(self.company) self.update_project() update_linked_doc(self.doctype, self.name, self.inter_company_invoice_reference) @@ -254,7 +298,9 @@ class SalesInvoice(SellingController): # create the loyalty point ledger entry if the customer is enrolled in any loyalty program if not self.is_return and not self.is_consolidated and self.loyalty_program: self.make_loyalty_point_entry() - elif self.is_return and self.return_against and not self.is_consolidated and self.loyalty_program: + elif ( + self.is_return and self.return_against and not self.is_consolidated and self.loyalty_program + ): against_si_doc = frappe.get_doc("Sales Invoice", self.return_against) against_si_doc.delete_loyalty_point_entry() against_si_doc.make_loyalty_point_entry() @@ -262,7 +308,7 @@ class SalesInvoice(SellingController): self.apply_loyalty_points() # Healthcare Service Invoice. - domain_settings = frappe.get_doc('Domain Settings') + domain_settings = frappe.get_doc("Domain Settings") active_domains = [d.domain for d in domain_settings.active_domains] if "Healthcare" in active_domains: @@ -271,6 +317,9 @@ class SalesInvoice(SellingController): self.process_common_party_accounting() def validate_pos_return(self): + if self.is_consolidated: + # pos return is already validated in pos invoice + return if self.is_pos and self.is_return: total_amount_in_payments = 0 @@ -287,16 +336,16 @@ class SalesInvoice(SellingController): def check_if_consolidated_invoice(self): # since POS Invoice extends Sales Invoice, we explicitly check if doctype is Sales Invoice if self.doctype == "Sales Invoice" and self.is_consolidated: - invoice_or_credit_note = "consolidated_credit_note" if self.is_return else "consolidated_invoice" - pos_closing_entry = frappe.get_all( - "POS Invoice Merge Log", - filters={ invoice_or_credit_note: self.name }, - pluck="pos_closing_entry" + invoice_or_credit_note = ( + "consolidated_credit_note" if self.is_return else "consolidated_invoice" ) - if pos_closing_entry: + pos_closing_entry = frappe.get_all( + "POS Invoice Merge Log", filters={invoice_or_credit_note: self.name}, pluck="pos_closing_entry" + ) + if pos_closing_entry and pos_closing_entry[0]: msg = _("To cancel a {} you need to cancel the POS Closing Entry {}.").format( frappe.bold("Consolidated Sales Invoice"), - get_link_to_form("POS Closing Entry", pos_closing_entry[0]) + get_link_to_form("POS Closing Entry", pos_closing_entry[0]), ) frappe.throw(msg, title=_("Not Allowed")) @@ -338,14 +387,18 @@ class SalesInvoice(SellingController): if self.update_stock == 1: self.repost_future_sle_and_gle() - frappe.db.set(self, 'status', 'Cancelled') + frappe.db.set(self, "status", "Cancelled") - if frappe.db.get_single_value('Selling Settings', 'sales_update_frequency') == "Each Transaction": + if ( + frappe.db.get_single_value("Selling Settings", "sales_update_frequency") == "Each Transaction" + ): update_company_current_month_sales(self.company) self.update_project() if not self.is_return and not self.is_consolidated and self.loyalty_program: self.delete_loyalty_point_entry() - elif self.is_return and self.return_against and not self.is_consolidated and self.loyalty_program: + elif ( + self.is_return and self.return_against and not self.is_consolidated and self.loyalty_program + ): against_si_doc = frappe.get_doc("Sales Invoice", self.return_against) against_si_doc.delete_loyalty_point_entry() against_si_doc.make_loyalty_point_entry() @@ -353,56 +406,62 @@ class SalesInvoice(SellingController): unlink_inter_company_doc(self.doctype, self.name, self.inter_company_invoice_reference) # Healthcare Service Invoice. - domain_settings = frappe.get_doc('Domain Settings') + domain_settings = frappe.get_doc("Domain Settings") active_domains = [d.domain for d in domain_settings.active_domains] if "Healthcare" in active_domains: manage_invoice_submit_cancel(self, "on_cancel") self.unlink_sales_invoice_from_timesheets() - self.ignore_linked_doctypes = ('GL Entry', 'Stock Ledger Entry', 'Repost Item Valuation') + self.ignore_linked_doctypes = ("GL Entry", "Stock Ledger Entry", "Repost Item Valuation") def update_status_updater_args(self): if cint(self.update_stock): - self.status_updater.append({ - 'source_dt':'Sales Invoice Item', - 'target_dt':'Sales Order Item', - 'target_parent_dt':'Sales Order', - 'target_parent_field':'per_delivered', - 'target_field':'delivered_qty', - 'target_ref_field':'qty', - 'source_field':'qty', - 'join_field':'so_detail', - 'percent_join_field':'sales_order', - 'status_field':'delivery_status', - 'keyword':'Delivered', - 'second_source_dt': 'Delivery Note Item', - 'second_source_field': 'qty', - 'second_join_field': 'so_detail', - 'overflow_type': 'delivery', - 'extra_cond': """ and exists(select name from `tabSales Invoice` - where name=`tabSales Invoice Item`.parent and update_stock = 1)""" - }) + self.status_updater.append( + { + "source_dt": "Sales Invoice Item", + "target_dt": "Sales Order Item", + "target_parent_dt": "Sales Order", + "target_parent_field": "per_delivered", + "target_field": "delivered_qty", + "target_ref_field": "qty", + "source_field": "qty", + "join_field": "so_detail", + "percent_join_field": "sales_order", + "status_field": "delivery_status", + "keyword": "Delivered", + "second_source_dt": "Delivery Note Item", + "second_source_field": "qty", + "second_join_field": "so_detail", + "overflow_type": "delivery", + "extra_cond": """ and exists(select name from `tabSales Invoice` + where name=`tabSales Invoice Item`.parent and update_stock = 1)""", + } + ) if cint(self.is_return): - self.status_updater.append({ - 'source_dt': 'Sales Invoice Item', - 'target_dt': 'Sales Order Item', - 'join_field': 'so_detail', - 'target_field': 'returned_qty', - 'target_parent_dt': 'Sales Order', - 'source_field': '-1 * qty', - 'second_source_dt': 'Delivery Note Item', - 'second_source_field': '-1 * qty', - 'second_join_field': 'so_detail', - 'extra_cond': """ and exists (select name from `tabSales Invoice` where name=`tabSales Invoice Item`.parent and update_stock=1 and is_return=1)""" - }) + self.status_updater.append( + { + "source_dt": "Sales Invoice Item", + "target_dt": "Sales Order Item", + "join_field": "so_detail", + "target_field": "returned_qty", + "target_parent_dt": "Sales Order", + "source_field": "-1 * qty", + "second_source_dt": "Delivery Note Item", + "second_source_field": "-1 * qty", + "second_join_field": "so_detail", + "extra_cond": """ and exists (select name from `tabSales Invoice` where name=`tabSales Invoice Item`.parent and update_stock=1 and is_return=1)""", + } + ) def check_credit_limit(self): from erpnext.selling.doctype.customer.customer import check_credit_limit validate_against_credit_limit = False - bypass_credit_limit_check_at_sales_order = frappe.db.get_value("Customer Credit Limit", - filters={'parent': self.customer, 'parenttype': 'Customer', 'company': self.company}, - fieldname=["bypass_credit_limit_check"]) + bypass_credit_limit_check_at_sales_order = frappe.db.get_value( + "Customer Credit Limit", + filters={"parent": self.customer, "parenttype": "Customer", "company": self.company}, + fieldname=["bypass_credit_limit_check"], + ) if bypass_credit_limit_check_at_sales_order: validate_against_credit_limit = True @@ -416,7 +475,7 @@ class SalesInvoice(SellingController): def unlink_sales_invoice_from_timesheets(self): for row in self.timesheets: - timesheet = frappe.get_doc('Timesheet', row.time_sheet) + timesheet = frappe.get_doc("Timesheet", row.time_sheet) for time_log in timesheet.time_logs: if time_log.sales_invoice == self.name: time_log.sales_invoice = None @@ -432,15 +491,17 @@ class SalesInvoice(SellingController): if not self.debit_to: self.debit_to = get_party_account("Customer", self.customer, self.company) - self.party_account_currency = frappe.db.get_value("Account", self.debit_to, "account_currency", cache=True) + self.party_account_currency = frappe.db.get_value( + "Account", self.debit_to, "account_currency", cache=True + ) if not self.due_date and self.customer: self.due_date = get_due_date(self.posting_date, "Customer", self.customer, self.company) super(SalesInvoice, self).set_missing_values(for_validate) print_format = pos.get("print_format") if pos else None - if not print_format and not cint(frappe.db.get_value('Print Format', 'POS Invoice', 'disabled')): - print_format = 'POS Invoice' + if not print_format and not cint(frappe.db.get_value("Print Format", "POS Invoice", "disabled")): + print_format = "POS Invoice" if pos: return { @@ -448,7 +509,7 @@ class SalesInvoice(SellingController): "allow_edit_rate": pos.get("allow_user_to_edit_rate"), "allow_edit_discount": pos.get("allow_user_to_edit_discount"), "campaign": pos.get("campaign"), - "allow_print_before_pay": pos.get("allow_print_before_pay") + "allow_print_before_pay": pos.get("allow_print_before_pay"), } def update_time_sheet(self, sales_invoice): @@ -464,9 +525,11 @@ class SalesInvoice(SellingController): def update_time_sheet_detail(self, timesheet, args, sales_invoice): for data in timesheet.time_logs: - if (self.project and args.timesheet_detail == data.name) or \ - (not self.project and not data.sales_invoice) or \ - (not sales_invoice and data.sales_invoice == self.name): + if ( + (self.project and args.timesheet_detail == data.name) + or (not self.project and not data.sales_invoice) + or (not sales_invoice and data.sales_invoice == self.name) + ): data.sales_invoice = sales_invoice def on_update(self): @@ -476,7 +539,7 @@ class SalesInvoice(SellingController): paid_amount = 0.0 base_paid_amount = 0.0 for data in self.payments: - data.base_amount = flt(data.amount*self.conversion_rate, self.precision("base_paid_amount")) + data.base_amount = flt(data.amount * self.conversion_rate, self.precision("base_paid_amount")) paid_amount += data.amount base_paid_amount += data.base_amount @@ -487,7 +550,7 @@ class SalesInvoice(SellingController): for data in self.timesheets: if data.time_sheet: status = frappe.db.get_value("Timesheet", data.time_sheet, "status") - if status not in ['Submitted', 'Payslip']: + if status not in ["Submitted", "Payslip"]: frappe.throw(_("Timesheet {0} is already completed or cancelled").format(data.time_sheet)) def set_pos_fields(self, for_validate=False): @@ -496,20 +559,23 @@ class SalesInvoice(SellingController): return if not self.account_for_change_amount: - self.account_for_change_amount = frappe.get_cached_value('Company', self.company, 'default_cash_account') + self.account_for_change_amount = frappe.get_cached_value( + "Company", self.company, "default_cash_account" + ) from erpnext.stock.get_item_details import get_pos_profile, get_pos_profile_item_details + if not self.pos_profile and not self.flags.ignore_pos_profile: pos_profile = get_pos_profile(self.company) or {} if not pos_profile: return - self.pos_profile = pos_profile.get('name') + self.pos_profile = pos_profile.get("name") pos = {} if self.pos_profile: - pos = frappe.get_doc('POS Profile', self.pos_profile) + pos = frappe.get_doc("POS Profile", self.pos_profile) - if not self.get('payments') and not for_validate: + if not self.get("payments") and not for_validate: update_multi_mode_option(self, pos) if pos: @@ -522,35 +588,52 @@ class SalesInvoice(SellingController): if not for_validate: self.ignore_pricing_rule = pos.ignore_pricing_rule - if pos.get('account_for_change_amount'): - self.account_for_change_amount = pos.get('account_for_change_amount') + if pos.get("account_for_change_amount"): + self.account_for_change_amount = pos.get("account_for_change_amount") - for fieldname in ('currency', 'letter_head', 'tc_name', - 'company', 'select_print_heading', 'write_off_account', 'taxes_and_charges', - 'write_off_cost_center', 'apply_discount_on', 'cost_center'): - if (not for_validate) or (for_validate and not self.get(fieldname)): - self.set(fieldname, pos.get(fieldname)) + for fieldname in ( + "currency", + "letter_head", + "tc_name", + "company", + "select_print_heading", + "write_off_account", + "taxes_and_charges", + "write_off_cost_center", + "apply_discount_on", + "cost_center", + ): + if (not for_validate) or (for_validate and not self.get(fieldname)): + self.set(fieldname, pos.get(fieldname)) if pos.get("company_address"): self.company_address = pos.get("company_address") if self.customer: - customer_price_list, customer_group = frappe.get_value("Customer", self.customer, ['default_price_list', 'customer_group']) - customer_group_price_list = frappe.get_value("Customer Group", customer_group, 'default_price_list') - selling_price_list = customer_price_list or customer_group_price_list or pos.get('selling_price_list') + customer_price_list, customer_group = frappe.get_value( + "Customer", self.customer, ["default_price_list", "customer_group"] + ) + customer_group_price_list = frappe.get_value( + "Customer Group", customer_group, "default_price_list" + ) + selling_price_list = ( + customer_price_list or customer_group_price_list or pos.get("selling_price_list") + ) else: - selling_price_list = pos.get('selling_price_list') + selling_price_list = pos.get("selling_price_list") if selling_price_list: - self.set('selling_price_list', selling_price_list) + self.set("selling_price_list", selling_price_list) if not for_validate: self.update_stock = cint(pos.get("update_stock")) # set pos values in items for item in self.get("items"): - if item.get('item_code'): - profile_details = get_pos_profile_item_details(pos, frappe._dict(item.as_dict()), pos, update_data=True) + if item.get("item_code"): + profile_details = get_pos_profile_item_details( + pos, frappe._dict(item.as_dict()), pos, update_data=True + ) for fname, val in iteritems(profile_details): if (not for_validate) or (for_validate and not item.get(fname)): item.set(fname, val) @@ -574,19 +657,29 @@ class SalesInvoice(SellingController): if not self.debit_to: self.raise_missing_debit_credit_account_error("Customer", self.customer) - account = frappe.get_cached_value("Account", self.debit_to, - ["account_type", "report_type", "account_currency"], as_dict=True) + account = frappe.get_cached_value( + "Account", self.debit_to, ["account_type", "report_type", "account_currency"], as_dict=True + ) if not account: frappe.throw(_("Debit To is required"), title=_("Account Missing")) if account.report_type != "Balance Sheet": - msg = _("Please ensure {} account is a Balance Sheet account.").format(frappe.bold("Debit To")) + " " - msg += _("You can change the parent account to a Balance Sheet account or select a different account.") + msg = ( + _("Please ensure {} account is a Balance Sheet account.").format(frappe.bold("Debit To")) + " " + ) + msg += _( + "You can change the parent account to a Balance Sheet account or select a different account." + ) frappe.throw(msg, title=_("Invalid Account")) if self.customer and account.account_type != "Receivable": - msg = _("Please ensure {} account is a Receivable account.").format(frappe.bold("Debit To")) + " " + msg = ( + _("Please ensure {} account {} is a Receivable account.").format( + frappe.bold("Debit To"), frappe.bold(self.debit_to) + ) + + " " + ) msg += _("Change the account type to Receivable or select a different account.") frappe.throw(msg, title=_("Invalid Account")) @@ -595,52 +688,60 @@ class SalesInvoice(SellingController): def clear_unallocated_mode_of_payments(self): self.set("payments", self.get("payments", {"amount": ["not in", [0, None, ""]]})) - frappe.db.sql("""delete from `tabSales Invoice Payment` where parent = %s - and amount = 0""", self.name) + frappe.db.sql( + """delete from `tabSales Invoice Payment` where parent = %s + and amount = 0""", + self.name, + ) def validate_with_previous_doc(self): - super(SalesInvoice, self).validate_with_previous_doc({ - "Sales Order": { - "ref_dn_field": "sales_order", - "compare_fields": [["customer", "="], ["company", "="], ["project", "="], ["currency", "="]] - }, - "Sales Order Item": { - "ref_dn_field": "so_detail", - "compare_fields": [["item_code", "="], ["uom", "="], ["conversion_factor", "="]], - "is_child_table": True, - "allow_duplicate_prev_row_id": True - }, - "Delivery Note": { - "ref_dn_field": "delivery_note", - "compare_fields": [["customer", "="], ["company", "="], ["project", "="], ["currency", "="]] - }, - "Delivery Note Item": { - "ref_dn_field": "dn_detail", - "compare_fields": [["item_code", "="], ["uom", "="], ["conversion_factor", "="]], - "is_child_table": True, - "allow_duplicate_prev_row_id": True - }, - }) + super(SalesInvoice, self).validate_with_previous_doc( + { + "Sales Order": { + "ref_dn_field": "sales_order", + "compare_fields": [["customer", "="], ["company", "="], ["project", "="], ["currency", "="]], + }, + "Sales Order Item": { + "ref_dn_field": "so_detail", + "compare_fields": [["item_code", "="], ["uom", "="], ["conversion_factor", "="]], + "is_child_table": True, + "allow_duplicate_prev_row_id": True, + }, + "Delivery Note": { + "ref_dn_field": "delivery_note", + "compare_fields": [["customer", "="], ["company", "="], ["project", "="], ["currency", "="]], + }, + "Delivery Note Item": { + "ref_dn_field": "dn_detail", + "compare_fields": [["item_code", "="], ["uom", "="], ["conversion_factor", "="]], + "is_child_table": True, + "allow_duplicate_prev_row_id": True, + }, + } + ) - if cint(frappe.db.get_single_value('Selling Settings', 'maintain_same_sales_rate')) and not self.is_return: - self.validate_rate_with_reference_doc([ - ["Sales Order", "sales_order", "so_detail"], - ["Delivery Note", "delivery_note", "dn_detail"] - ]) + if ( + cint(frappe.db.get_single_value("Selling Settings", "maintain_same_sales_rate")) + and not self.is_return + ): + self.validate_rate_with_reference_doc( + [["Sales Order", "sales_order", "so_detail"], ["Delivery Note", "delivery_note", "dn_detail"]] + ) def set_against_income_account(self): """Set against account for debit to account""" against_acc = [] - for d in self.get('items'): + for d in self.get("items"): if d.income_account and d.income_account not in against_acc: against_acc.append(d.income_account) - self.against_income_account = ','.join(against_acc) + self.against_income_account = ",".join(against_acc) def add_remarks(self): if not self.remarks: if self.po_no and self.po_date: - self.remarks = _("Against Customer Order {0} dated {1}").format(self.po_no, - formatdate(self.po_date)) + self.remarks = _("Against Customer Order {0} dated {1}").format( + self.po_no, formatdate(self.po_date) + ) else: self.remarks = _("No Remarks") @@ -656,36 +757,41 @@ class SalesInvoice(SellingController): if self.is_return: return - prev_doc_field_map = {'Sales Order': ['so_required', 'is_pos'],'Delivery Note': ['dn_required', 'update_stock']} + prev_doc_field_map = { + "Sales Order": ["so_required", "is_pos"], + "Delivery Note": ["dn_required", "update_stock"], + } for key, value in iteritems(prev_doc_field_map): - if frappe.db.get_single_value('Selling Settings', value[0]) == 'Yes': + if frappe.db.get_single_value("Selling Settings", value[0]) == "Yes": - if frappe.get_value('Customer', self.customer, value[0]): + if frappe.get_value("Customer", self.customer, value[0]): continue - for d in self.get('items'): - if (d.item_code and not d.get(key.lower().replace(' ', '_')) and not self.get(value[1])): + for d in self.get("items"): + if d.item_code and not d.get(key.lower().replace(" ", "_")) and not self.get(value[1]): msgprint(_("{0} is mandatory for Item {1}").format(key, d.item_code), raise_exception=1) - def validate_proj_cust(self): """check for does customer belong to same project as entered..""" if self.project and self.customer: - res = frappe.db.sql("""select name from `tabProject` + res = frappe.db.sql( + """select name from `tabProject` where name = %s and (customer = %s or customer is null or customer = '')""", - (self.project, self.customer)) + (self.project, self.customer), + ) if not res: - throw(_("Customer {0} does not belong to project {1}").format(self.customer,self.project)) + throw(_("Customer {0} does not belong to project {1}").format(self.customer, self.project)) def validate_pos(self): if self.is_return: invoice_total = self.rounded_total or self.grand_total - if flt(self.paid_amount) + flt(self.write_off_amount) - flt(invoice_total) > \ - 1.0/(10.0**(self.precision("grand_total") + 1.0)): - frappe.throw(_("Paid amount + Write Off Amount can not be greater than Grand Total")) + if flt(self.paid_amount) + flt(self.write_off_amount) - flt(invoice_total) > 1.0 / ( + 10.0 ** (self.precision("grand_total") + 1.0) + ): + frappe.throw(_("Paid amount + Write Off Amount can not be greater than Grand Total")) def validate_item_code(self): - for d in self.get('items'): + for d in self.get("items"): if not d.item_code and self.is_opening == "No": msgprint(_("Item Code required at Row No {0}").format(d.idx), raise_exception=True) @@ -693,17 +799,24 @@ class SalesInvoice(SellingController): super(SalesInvoice, self).validate_warehouse() for d in self.get_item_list(): - if not d.warehouse and d.item_code and frappe.get_cached_value("Item", d.item_code, "is_stock_item"): + if ( + not d.warehouse + and d.item_code + and frappe.get_cached_value("Item", d.item_code, "is_stock_item") + ): frappe.throw(_("Warehouse required for stock Item {0}").format(d.item_code)) def validate_delivery_note(self): for d in self.get("items"): if d.delivery_note: - msgprint(_("Stock cannot be updated against Delivery Note {0}").format(d.delivery_note), raise_exception=1) + msgprint( + _("Stock cannot be updated against Delivery Note {0}").format(d.delivery_note), + raise_exception=1, + ) def validate_write_off_account(self): if flt(self.write_off_amount) and not self.write_off_account: - self.write_off_account = frappe.get_cached_value('Company', self.company, 'write_off_account') + self.write_off_account = frappe.get_cached_value("Company", self.company, "write_off_account") if flt(self.write_off_amount) and not self.write_off_account: msgprint(_("Please enter Write Off Account"), raise_exception=1) @@ -713,18 +826,23 @@ class SalesInvoice(SellingController): msgprint(_("Please enter Account for Change Amount"), raise_exception=1) def validate_c_form(self): - """ Blank C-form no if C-form applicable marked as 'No'""" - if self.amended_from and self.c_form_applicable == 'No' and self.c_form_no: - frappe.db.sql("""delete from `tabC-Form Invoice Detail` where invoice_no = %s - and parent = %s""", (self.amended_from, self.c_form_no)) + """Blank C-form no if C-form applicable marked as 'No'""" + if self.amended_from and self.c_form_applicable == "No" and self.c_form_no: + frappe.db.sql( + """delete from `tabC-Form Invoice Detail` where invoice_no = %s + and parent = %s""", + (self.amended_from, self.c_form_no), + ) - frappe.db.set(self, 'c_form_no', '') + frappe.db.set(self, "c_form_no", "") def validate_c_form_on_cancel(self): - """ Display message if C-Form no exists on cancellation of Sales Invoice""" - if self.c_form_applicable == 'Yes' and self.c_form_no: - msgprint(_("Please remove this Invoice {0} from C-Form {1}") - .format(self.name, self.c_form_no), raise_exception = 1) + """Display message if C-Form no exists on cancellation of Sales Invoice""" + if self.c_form_applicable == "Yes" and self.c_form_no: + msgprint( + _("Please remove this Invoice {0} from C-Form {1}").format(self.name, self.c_form_no), + raise_exception=1, + ) def validate_dropship_item(self): for item in self.items: @@ -733,27 +851,36 @@ class SalesInvoice(SellingController): frappe.throw(_("Could not update stock, invoice contains drop shipping item.")) def update_current_stock(self): - for d in self.get('items'): + for d in self.get("items"): if d.item_code and d.warehouse: - bin = frappe.db.sql("select actual_qty from `tabBin` where item_code = %s and warehouse = %s", (d.item_code, d.warehouse), as_dict = 1) - d.actual_qty = bin and flt(bin[0]['actual_qty']) or 0 + bin = frappe.db.sql( + "select actual_qty from `tabBin` where item_code = %s and warehouse = %s", + (d.item_code, d.warehouse), + as_dict=1, + ) + d.actual_qty = bin and flt(bin[0]["actual_qty"]) or 0 - for d in self.get('packed_items'): - bin = frappe.db.sql("select actual_qty, projected_qty from `tabBin` where item_code = %s and warehouse = %s", (d.item_code, d.warehouse), as_dict = 1) - d.actual_qty = bin and flt(bin[0]['actual_qty']) or 0 - d.projected_qty = bin and flt(bin[0]['projected_qty']) or 0 + for d in self.get("packed_items"): + bin = frappe.db.sql( + "select actual_qty, projected_qty from `tabBin` where item_code = %s and warehouse = %s", + (d.item_code, d.warehouse), + as_dict=1, + ) + d.actual_qty = bin and flt(bin[0]["actual_qty"]) or 0 + d.projected_qty = bin and flt(bin[0]["projected_qty"]) or 0 def update_packing_list(self): if cint(self.update_stock) == 1: from erpnext.stock.doctype.packed_item.packed_item import make_packing_list + make_packing_list(self) else: - self.set('packed_items', []) + self.set("packed_items", []) def set_billing_hours_and_amount(self): if not self.project: for timesheet in self.timesheets: - ts_doc = frappe.get_doc('Timesheet', timesheet.time_sheet) + ts_doc = frappe.get_doc("Timesheet", timesheet.time_sheet) if not timesheet.billing_hours and ts_doc.total_billable_hours: timesheet.billing_hours = ts_doc.total_billable_hours @@ -768,17 +895,20 @@ class SalesInvoice(SellingController): @frappe.whitelist() def add_timesheet_data(self): - self.set('timesheets', []) + self.set("timesheets", []) if self.project: for data in get_projectwise_timesheet_data(self.project): - self.append('timesheets', { - 'time_sheet': data.time_sheet, - 'billing_hours': data.billing_hours, - 'billing_amount': data.billing_amount, - 'timesheet_detail': data.name, - 'activity_type': data.activity_type, - 'description': data.description - }) + self.append( + "timesheets", + { + "time_sheet": data.time_sheet, + "billing_hours": data.billing_hours, + "billing_amount": data.billing_amount, + "timesheet_detail": data.name, + "activity_type": data.activity_type, + "description": data.description, + }, + ) self.calculate_billing_amount_for_timesheet() @@ -790,13 +920,19 @@ class SalesInvoice(SellingController): self.total_billing_hours = timesheet_sum("billing_hours") def get_warehouse(self): - user_pos_profile = frappe.db.sql("""select name, warehouse from `tabPOS Profile` - where ifnull(user,'') = %s and company = %s""", (frappe.session['user'], self.company)) + user_pos_profile = frappe.db.sql( + """select name, warehouse from `tabPOS Profile` + where ifnull(user,'') = %s and company = %s""", + (frappe.session["user"], self.company), + ) warehouse = user_pos_profile[0][1] if user_pos_profile else None if not warehouse: - global_pos_profile = frappe.db.sql("""select name, warehouse from `tabPOS Profile` - where (user is null or user = '') and company = %s""", self.company) + global_pos_profile = frappe.db.sql( + """select name, warehouse from `tabPOS Profile` + where (user is null or user = '') and company = %s""", + self.company, + ) if global_pos_profile: warehouse = global_pos_profile[0][1] @@ -810,14 +946,16 @@ class SalesInvoice(SellingController): for d in self.get("items"): if d.is_fixed_asset: if not disposal_account: - disposal_account, depreciation_cost_center = get_disposal_account_and_cost_center(self.company) + disposal_account, depreciation_cost_center = get_disposal_account_and_cost_center( + self.company + ) d.income_account = disposal_account if not d.cost_center: d.cost_center = depreciation_cost_center def check_prev_docstatus(self): - for d in self.get('items'): + for d in self.get("items"): if d.sales_order and frappe.db.get_value("Sales Order", d.sales_order, "docstatus") != 1: frappe.throw(_("Sales Order {0} is not submitted").format(d.sales_order)) @@ -833,22 +971,35 @@ class SalesInvoice(SellingController): if gl_entries: # if POS and amount is written off, updating outstanding amt after posting all gl entries - update_outstanding = "No" if (cint(self.is_pos) or self.write_off_account or - cint(self.redeem_loyalty_points)) else "Yes" + update_outstanding = ( + "No" + if (cint(self.is_pos) or self.write_off_account or cint(self.redeem_loyalty_points)) + else "Yes" + ) if self.docstatus == 1: - make_gl_entries(gl_entries, update_outstanding=update_outstanding, merge_entries=False, from_repost=from_repost) + make_gl_entries( + gl_entries, + update_outstanding=update_outstanding, + merge_entries=False, + from_repost=from_repost, + ) elif self.docstatus == 2: make_reverse_gl_entries(voucher_type=self.doctype, voucher_no=self.name) if update_outstanding == "No": from erpnext.accounts.doctype.gl_entry.gl_entry import update_outstanding_amt - update_outstanding_amt(self.debit_to, "Customer", self.customer, - self.doctype, self.return_against if cint(self.is_return) and self.return_against else self.name) - elif self.docstatus == 2 and cint(self.update_stock) \ - and cint(auto_accounting_for_stock): - make_reverse_gl_entries(voucher_type=self.doctype, voucher_no=self.name) + update_outstanding_amt( + self.debit_to, + "Customer", + self.customer, + self.doctype, + self.return_against if cint(self.is_return) and self.return_against else self.name, + ) + + elif self.docstatus == 2 and cint(self.update_stock) and cint(auto_accounting_for_stock): + make_reverse_gl_entries(voucher_type=self.doctype, voucher_no=self.name) def get_gl_entries(self, warehouse_account=None): from erpnext.accounts.general_ledger import merge_similar_entries @@ -878,27 +1029,40 @@ class SalesInvoice(SellingController): def make_customer_gl_entry(self, gl_entries): # Checked both rounding_adjustment and rounded_total # because rounded_total had value even before introcution of posting GLE based on rounded total - grand_total = self.rounded_total if (self.rounding_adjustment and self.rounded_total) else self.grand_total - if grand_total and not self.is_internal_transfer(): - # Didnot use base_grand_total to book rounding loss gle - grand_total_in_company_currency = flt(grand_total * self.conversion_rate, - self.precision("grand_total")) + grand_total = ( + self.rounded_total if (self.rounding_adjustment and self.rounded_total) else self.grand_total + ) + base_grand_total = flt( + self.base_rounded_total + if (self.base_rounding_adjustment and self.base_rounded_total) + else self.base_grand_total, + self.precision("base_grand_total"), + ) + if grand_total and not self.is_internal_transfer(): + # Did not use base_grand_total to book rounding loss gle gl_entries.append( - self.get_gl_dict({ - "account": self.debit_to, - "party_type": "Customer", - "party": self.customer, - "due_date": self.due_date, - "against": self.against_income_account, - "debit": grand_total_in_company_currency, - "debit_in_account_currency": grand_total_in_company_currency \ - if self.party_account_currency==self.company_currency else grand_total, - "against_voucher": self.return_against if cint(self.is_return) and self.return_against else self.name, - "against_voucher_type": self.doctype, - "cost_center": self.cost_center, - "project": self.project - }, self.party_account_currency, item=self) + self.get_gl_dict( + { + "account": self.debit_to, + "party_type": "Customer", + "party": self.customer, + "due_date": self.due_date, + "against": self.against_income_account, + "debit": base_grand_total, + "debit_in_account_currency": base_grand_total + if self.party_account_currency == self.company_currency + else grand_total, + "against_voucher": self.return_against + if cint(self.is_return) and self.return_against + else self.name, + "against_voucher_type": self.doctype, + "cost_center": self.cost_center, + "project": self.project, + }, + self.party_account_currency, + item=self, + ) ) def make_tax_gl_entries(self, gl_entries): @@ -908,29 +1072,39 @@ class SalesInvoice(SellingController): if flt(tax.base_tax_amount_after_discount_amount): account_currency = get_account_currency(tax.account_head) gl_entries.append( - self.get_gl_dict({ - "account": tax.account_head, - "against": self.customer, - "credit": flt(base_amount, - tax.precision("tax_amount_after_discount_amount")), - "credit_in_account_currency": (flt(base_amount, - tax.precision("base_tax_amount_after_discount_amount")) if account_currency==self.company_currency else - flt(amount, tax.precision("tax_amount_after_discount_amount"))), - "cost_center": tax.cost_center - }, account_currency, item=tax) + self.get_gl_dict( + { + "account": tax.account_head, + "against": self.customer, + "credit": flt(base_amount, tax.precision("tax_amount_after_discount_amount")), + "credit_in_account_currency": ( + flt(base_amount, tax.precision("base_tax_amount_after_discount_amount")) + if account_currency == self.company_currency + else flt(amount, tax.precision("tax_amount_after_discount_amount")) + ), + "cost_center": tax.cost_center, + }, + account_currency, + item=tax, + ) ) def make_internal_transfer_gl_entries(self, gl_entries): if self.is_internal_transfer() and flt(self.base_total_taxes_and_charges): account_currency = get_account_currency(self.unrealized_profit_loss_account) gl_entries.append( - self.get_gl_dict({ - "account": self.unrealized_profit_loss_account, - "against": self.customer, - "debit": flt(self.total_taxes_and_charges), - "debit_in_account_currency": flt(self.base_total_taxes_and_charges), - "cost_center": self.cost_center - }, account_currency, item=self)) + self.get_gl_dict( + { + "account": self.unrealized_profit_loss_account, + "against": self.customer, + "debit": flt(self.total_taxes_and_charges), + "debit_in_account_currency": flt(self.base_total_taxes_and_charges), + "cost_center": self.cost_center, + }, + account_currency, + item=self, + ) + ) def make_item_gl_entries(self, gl_entries): # income account gl entries @@ -940,22 +1114,24 @@ class SalesInvoice(SellingController): asset = self.get_asset(item) if self.is_return: - fixed_asset_gl_entries = get_gl_entries_on_asset_regain(asset, - item.base_net_amount, item.finance_book) - asset.db_set("disposal_date", None) - if asset.calculate_depreciation: self.reverse_depreciation_entry_made_after_sale(asset) self.reset_depreciation_schedule(asset) - else: - fixed_asset_gl_entries = get_gl_entries_on_asset_disposal(asset, - item.base_net_amount, item.finance_book) - asset.db_set("disposal_date", self.posting_date) + fixed_asset_gl_entries = get_gl_entries_on_asset_regain( + asset, item.base_net_amount, item.finance_book + ) + asset.db_set("disposal_date", None) + else: if asset.calculate_depreciation: self.depreciate_asset(asset) + fixed_asset_gl_entries = get_gl_entries_on_asset_disposal( + asset, item.base_net_amount, item.finance_book + ) + asset.db_set("disposal_date", self.posting_date) + for gle in fixed_asset_gl_entries: gle["against"] = self.customer gl_entries.append(self.get_gl_dict(gle, item=item)) @@ -965,47 +1141,57 @@ class SalesInvoice(SellingController): else: # Do not book income for transfer within same company if not self.is_internal_transfer(): - income_account = (item.income_account - if (not item.enable_deferred_revenue or self.is_return) else item.deferred_revenue_account) + income_account = ( + item.income_account + if (not item.enable_deferred_revenue or self.is_return) + else item.deferred_revenue_account + ) amount, base_amount = self.get_amount_and_base_amount(item, self.enable_discount_accounting) account_currency = get_account_currency(income_account) gl_entries.append( - self.get_gl_dict({ - "account": income_account, - "against": self.customer, - "credit": flt(base_amount, item.precision("base_net_amount")), - "credit_in_account_currency": (flt(base_amount, item.precision("base_net_amount")) - if account_currency==self.company_currency - else flt(amount, item.precision("net_amount"))), - "cost_center": item.cost_center, - "project": item.project or self.project - }, account_currency, item=item) + self.get_gl_dict( + { + "account": income_account, + "against": self.customer, + "credit": flt(base_amount, item.precision("base_net_amount")), + "credit_in_account_currency": ( + flt(base_amount, item.precision("base_net_amount")) + if account_currency == self.company_currency + else flt(amount, item.precision("net_amount")) + ), + "cost_center": item.cost_center, + "project": item.project or self.project, + }, + account_currency, + item=item, + ) ) # expense account gl entries - if cint(self.update_stock) and \ - erpnext.is_perpetual_inventory_enabled(self.company): + if cint(self.update_stock) and erpnext.is_perpetual_inventory_enabled(self.company): gl_entries += super(SalesInvoice, self).get_gl_entries() def get_asset(self, item): - if item.get('asset'): + if item.get("asset"): asset = frappe.get_doc("Asset", item.asset) else: - frappe.throw(_( - "Row #{0}: You must select an Asset for Item {1}.").format(item.idx, item.item_name), - title=_("Missing Asset") + frappe.throw( + _("Row #{0}: You must select an Asset for Item {1}.").format(item.idx, item.item_name), + title=_("Missing Asset"), ) self.check_finance_books(item, asset) return asset def check_finance_books(self, item, asset): - if (len(asset.finance_books) > 1 and not item.finance_book - and asset.finance_books[0].finance_book): - frappe.throw(_("Select finance book for the item {0} at row {1}") - .format(item.item_code, item.idx)) + if ( + len(asset.finance_books) > 1 and not item.finance_book and asset.finance_books[0].finance_book + ): + frappe.throw( + _("Select finance book for the item {0} at row {1}").format(item.item_code, item.idx) + ) def depreciate_asset(self, asset): asset.flags.ignore_validate_update_after_submit = True @@ -1013,6 +1199,7 @@ class SalesInvoice(SellingController): asset.save() make_depreciation_entry(asset.name, self.posting_date) + asset.load_from_db() def reset_depreciation_schedule(self, asset): asset.flags.ignore_validate_update_after_submit = True @@ -1022,17 +1209,16 @@ class SalesInvoice(SellingController): self.modify_depreciation_schedule_for_asset_repairs(asset) asset.save() + asset.load_from_db() def modify_depreciation_schedule_for_asset_repairs(self, asset): asset_repairs = frappe.get_all( - 'Asset Repair', - filters = {'asset': asset.name}, - fields = ['name', 'increase_in_asset_life'] + "Asset Repair", filters={"asset": asset.name}, fields=["name", "increase_in_asset_life"] ) for repair in asset_repairs: if repair.increase_in_asset_life: - asset_repair = frappe.get_doc('Asset Repair', repair.name) + asset_repair = frappe.get_doc("Asset Repair", repair.name) asset_repair.modify_depreciation_schedule() asset.prepare_depreciation_data() @@ -1042,8 +1228,8 @@ class SalesInvoice(SellingController): posting_date_of_original_invoice = self.get_posting_date_of_sales_invoice() row = -1 - finance_book = asset.get('schedules')[0].get('finance_book') - for schedule in asset.get('schedules'): + finance_book = asset.get("schedules")[0].get("finance_book") + for schedule in asset.get("schedules"): if schedule.finance_book != finance_book: row = 0 finance_book = schedule.finance_book @@ -1051,8 +1237,9 @@ class SalesInvoice(SellingController): row += 1 if schedule.schedule_date == posting_date_of_original_invoice: - if not self.sale_was_made_on_original_schedule_date(asset, schedule, row, posting_date_of_original_invoice) \ - or self.sale_happens_in_the_future(posting_date_of_original_invoice): + if not self.sale_was_made_on_original_schedule_date( + asset, schedule, row, posting_date_of_original_invoice + ) or self.sale_happens_in_the_future(posting_date_of_original_invoice): reverse_journal_entry = make_reverse_journal_entry(schedule.journal_entry) reverse_journal_entry.posting_date = nowdate() @@ -1067,14 +1254,17 @@ class SalesInvoice(SellingController): asset.save() def get_posting_date_of_sales_invoice(self): - return frappe.db.get_value('Sales Invoice', self.return_against, 'posting_date') + return frappe.db.get_value("Sales Invoice", self.return_against, "posting_date") # if the invoice had been posted on the date the depreciation was initially supposed to happen, the depreciation shouldn't be undone - def sale_was_made_on_original_schedule_date(self, asset, schedule, row, posting_date_of_original_invoice): - for finance_book in asset.get('finance_books'): + def sale_was_made_on_original_schedule_date( + self, asset, schedule, row, posting_date_of_original_invoice + ): + for finance_book in asset.get("finance_books"): if schedule.finance_book == finance_book.finance_book: - orginal_schedule_date = add_months(finance_book.depreciation_start_date, - row * cint(finance_book.frequency_of_depreciation)) + orginal_schedule_date = add_months( + finance_book.depreciation_start_date, row * cint(finance_book.frequency_of_depreciation) + ) if orginal_schedule_date == posting_date_of_original_invoice: return True @@ -1095,7 +1285,9 @@ class SalesInvoice(SellingController): @property def enable_discount_accounting(self): if not hasattr(self, "_enable_discount_accounting"): - self._enable_discount_accounting = cint(frappe.db.get_single_value('Accounts Settings', 'enable_discount_accounting')) + self._enable_discount_accounting = cint( + frappe.db.get_single_value("Accounts Settings", "enable_discount_accounting") + ) return self._enable_discount_accounting @@ -1103,36 +1295,46 @@ class SalesInvoice(SellingController): if self.is_return: asset.set_status() else: - asset.set_status("Sold" if self.docstatus==1 else None) + asset.set_status("Sold" if self.docstatus == 1 else None) def make_loyalty_point_redemption_gle(self, gl_entries): if cint(self.redeem_loyalty_points): gl_entries.append( - self.get_gl_dict({ - "account": self.debit_to, - "party_type": "Customer", - "party": self.customer, - "against": "Expense account - " + cstr(self.loyalty_redemption_account) + " for the Loyalty Program", - "credit": self.loyalty_amount, - "against_voucher": self.return_against if cint(self.is_return) else self.name, - "against_voucher_type": self.doctype, - "cost_center": self.cost_center - }, item=self) + self.get_gl_dict( + { + "account": self.debit_to, + "party_type": "Customer", + "party": self.customer, + "against": "Expense account - " + + cstr(self.loyalty_redemption_account) + + " for the Loyalty Program", + "credit": self.loyalty_amount, + "against_voucher": self.return_against if cint(self.is_return) else self.name, + "against_voucher_type": self.doctype, + "cost_center": self.cost_center, + }, + item=self, + ) ) gl_entries.append( - self.get_gl_dict({ - "account": self.loyalty_redemption_account, - "cost_center": self.cost_center or self.loyalty_redemption_cost_center, - "against": self.customer, - "debit": self.loyalty_amount, - "remark": "Loyalty Points redeemed by the customer" - }, item=self) + self.get_gl_dict( + { + "account": self.loyalty_redemption_account, + "cost_center": self.cost_center or self.loyalty_redemption_cost_center, + "against": self.customer, + "debit": self.loyalty_amount, + "remark": "Loyalty Points redeemed by the customer", + }, + item=self, + ) ) def make_pos_gl_entries(self, gl_entries): if cint(self.is_pos): - skip_change_gl_entries = not cint(frappe.db.get_single_value('Accounts Settings', 'post_change_gl_entries')) + skip_change_gl_entries = not cint( + frappe.db.get_single_value("Accounts Settings", "post_change_gl_entries") + ) for payment_mode in self.payments: if skip_change_gl_entries and payment_mode.account == self.account_for_change_amount: @@ -1141,32 +1343,42 @@ class SalesInvoice(SellingController): if payment_mode.amount: # POS, make payment entries gl_entries.append( - self.get_gl_dict({ - "account": self.debit_to, - "party_type": "Customer", - "party": self.customer, - "against": payment_mode.account, - "credit": payment_mode.base_amount, - "credit_in_account_currency": payment_mode.base_amount \ - if self.party_account_currency==self.company_currency \ + self.get_gl_dict( + { + "account": self.debit_to, + "party_type": "Customer", + "party": self.customer, + "against": payment_mode.account, + "credit": payment_mode.base_amount, + "credit_in_account_currency": payment_mode.base_amount + if self.party_account_currency == self.company_currency else payment_mode.amount, - "against_voucher": self.return_against if cint(self.is_return) and self.return_against else self.name, - "against_voucher_type": self.doctype, - "cost_center": self.cost_center - }, self.party_account_currency, item=self) + "against_voucher": self.return_against + if cint(self.is_return) and self.return_against + else self.name, + "against_voucher_type": self.doctype, + "cost_center": self.cost_center, + }, + self.party_account_currency, + item=self, + ) ) payment_mode_account_currency = get_account_currency(payment_mode.account) gl_entries.append( - self.get_gl_dict({ - "account": payment_mode.account, - "against": self.customer, - "debit": payment_mode.base_amount, - "debit_in_account_currency": payment_mode.base_amount \ - if payment_mode_account_currency==self.company_currency \ + self.get_gl_dict( + { + "account": payment_mode.account, + "against": self.customer, + "debit": payment_mode.base_amount, + "debit_in_account_currency": payment_mode.base_amount + if payment_mode_account_currency == self.company_currency else payment_mode.amount, - "cost_center": self.cost_center - }, payment_mode_account_currency, item=self) + "cost_center": self.cost_center, + }, + payment_mode_account_currency, + item=self, + ) ) if not skip_change_gl_entries: @@ -1176,28 +1388,38 @@ class SalesInvoice(SellingController): if self.change_amount: if self.account_for_change_amount: gl_entries.append( - self.get_gl_dict({ - "account": self.debit_to, - "party_type": "Customer", - "party": self.customer, - "against": self.account_for_change_amount, - "debit": flt(self.base_change_amount), - "debit_in_account_currency": flt(self.base_change_amount) \ - if self.party_account_currency==self.company_currency else flt(self.change_amount), - "against_voucher": self.return_against if cint(self.is_return) and self.return_against else self.name, - "against_voucher_type": self.doctype, - "cost_center": self.cost_center, - "project": self.project - }, self.party_account_currency, item=self) + self.get_gl_dict( + { + "account": self.debit_to, + "party_type": "Customer", + "party": self.customer, + "against": self.account_for_change_amount, + "debit": flt(self.base_change_amount), + "debit_in_account_currency": flt(self.base_change_amount) + if self.party_account_currency == self.company_currency + else flt(self.change_amount), + "against_voucher": self.return_against + if cint(self.is_return) and self.return_against + else self.name, + "against_voucher_type": self.doctype, + "cost_center": self.cost_center, + "project": self.project, + }, + self.party_account_currency, + item=self, + ) ) gl_entries.append( - self.get_gl_dict({ - "account": self.account_for_change_amount, - "against": self.customer, - "credit": self.base_change_amount, - "cost_center": self.cost_center - }, item=self) + self.get_gl_dict( + { + "account": self.account_for_change_amount, + "against": self.customer, + "credit": self.base_change_amount, + "cost_center": self.cost_center, + }, + item=self, + ) ) else: frappe.throw(_("Select change amount account"), title="Mandatory Field") @@ -1206,61 +1428,86 @@ class SalesInvoice(SellingController): # write off entries, applicable if only pos if self.write_off_account and flt(self.write_off_amount, self.precision("write_off_amount")): write_off_account_currency = get_account_currency(self.write_off_account) - default_cost_center = frappe.get_cached_value('Company', self.company, 'cost_center') + default_cost_center = frappe.get_cached_value("Company", self.company, "cost_center") gl_entries.append( - self.get_gl_dict({ - "account": self.debit_to, - "party_type": "Customer", - "party": self.customer, - "against": self.write_off_account, - "credit": flt(self.base_write_off_amount, self.precision("base_write_off_amount")), - "credit_in_account_currency": (flt(self.base_write_off_amount, - self.precision("base_write_off_amount")) if self.party_account_currency==self.company_currency - else flt(self.write_off_amount, self.precision("write_off_amount"))), - "against_voucher": self.return_against if cint(self.is_return) else self.name, - "against_voucher_type": self.doctype, - "cost_center": self.cost_center, - "project": self.project - }, self.party_account_currency, item=self) + self.get_gl_dict( + { + "account": self.debit_to, + "party_type": "Customer", + "party": self.customer, + "against": self.write_off_account, + "credit": flt(self.base_write_off_amount, self.precision("base_write_off_amount")), + "credit_in_account_currency": ( + flt(self.base_write_off_amount, self.precision("base_write_off_amount")) + if self.party_account_currency == self.company_currency + else flt(self.write_off_amount, self.precision("write_off_amount")) + ), + "against_voucher": self.return_against if cint(self.is_return) else self.name, + "against_voucher_type": self.doctype, + "cost_center": self.cost_center, + "project": self.project, + }, + self.party_account_currency, + item=self, + ) ) gl_entries.append( - self.get_gl_dict({ - "account": self.write_off_account, - "against": self.customer, - "debit": flt(self.base_write_off_amount, self.precision("base_write_off_amount")), - "debit_in_account_currency": (flt(self.base_write_off_amount, - self.precision("base_write_off_amount")) if write_off_account_currency==self.company_currency - else flt(self.write_off_amount, self.precision("write_off_amount"))), - "cost_center": self.cost_center or self.write_off_cost_center or default_cost_center - }, write_off_account_currency, item=self) + self.get_gl_dict( + { + "account": self.write_off_account, + "against": self.customer, + "debit": flt(self.base_write_off_amount, self.precision("base_write_off_amount")), + "debit_in_account_currency": ( + flt(self.base_write_off_amount, self.precision("base_write_off_amount")) + if write_off_account_currency == self.company_currency + else flt(self.write_off_amount, self.precision("write_off_amount")) + ), + "cost_center": self.cost_center or self.write_off_cost_center or default_cost_center, + }, + write_off_account_currency, + item=self, + ) ) def make_gle_for_rounding_adjustment(self, gl_entries): - if flt(self.rounding_adjustment, self.precision("rounding_adjustment")) and self.base_rounding_adjustment \ - and not self.is_internal_transfer(): - round_off_account, round_off_cost_center = \ - get_round_off_account_and_cost_center(self.company) + if ( + flt(self.rounding_adjustment, self.precision("rounding_adjustment")) + and self.base_rounding_adjustment + and not self.is_internal_transfer() + ): + round_off_account, round_off_cost_center = get_round_off_account_and_cost_center( + self.company, "Sales Invoice", self.name + ) gl_entries.append( - self.get_gl_dict({ - "account": round_off_account, - "against": self.customer, - "credit_in_account_currency": flt(self.rounding_adjustment, - self.precision("rounding_adjustment")), - "credit": flt(self.base_rounding_adjustment, - self.precision("base_rounding_adjustment")), - "cost_center": self.cost_center or round_off_cost_center, - }, item=self)) + self.get_gl_dict( + { + "account": round_off_account, + "against": self.customer, + "credit_in_account_currency": flt( + self.rounding_adjustment, self.precision("rounding_adjustment") + ), + "credit": flt(self.base_rounding_adjustment, self.precision("base_rounding_adjustment")), + "cost_center": self.cost_center or round_off_cost_center, + }, + item=self, + ) + ) def update_billing_status_in_dn(self, update_modified=True): updated_delivery_notes = [] for d in self.get("items"): if d.dn_detail: - billed_amt = frappe.db.sql("""select sum(amount) from `tabSales Invoice Item` - where dn_detail=%s and docstatus=1""", d.dn_detail) + billed_amt = frappe.db.sql( + """select sum(amount) from `tabSales Invoice Item` + where dn_detail=%s and docstatus=1""", + d.dn_detail, + ) billed_amt = billed_amt and billed_amt[0][0] or 0 - frappe.db.set_value("Delivery Note Item", d.dn_detail, "billed_amt", billed_amt, update_modified=update_modified) + frappe.db.set_value( + "Delivery Note Item", d.dn_detail, "billed_amt", billed_amt, update_modified=update_modified + ) updated_delivery_notes.append(d.delivery_note) elif d.so_detail: updated_delivery_notes += update_billed_amount_based_on_so(d.so_detail, update_modified) @@ -1275,7 +1522,7 @@ class SalesInvoice(SellingController): self.due_date = None def update_serial_no(self, in_cancel=False): - """ update Sales Invoice refrence in Serial No """ + """update Sales Invoice refrence in Serial No""" invoice = None if (in_cancel or self.is_return) else self.name if in_cancel and self.is_return: invoice = self.return_against @@ -1285,26 +1532,25 @@ class SalesInvoice(SellingController): continue for serial_no in get_serial_nos(item.serial_no): - if serial_no and frappe.db.get_value('Serial No', serial_no, 'item_code') == item.item_code: - frappe.db.set_value('Serial No', serial_no, 'sales_invoice', invoice) + if serial_no and frappe.db.get_value("Serial No", serial_no, "item_code") == item.item_code: + frappe.db.set_value("Serial No", serial_no, "sales_invoice", invoice) def validate_serial_numbers(self): """ - validate serial number agains Delivery Note and Sales Invoice + validate serial number agains Delivery Note and Sales Invoice """ self.set_serial_no_against_delivery_note() self.validate_serial_against_delivery_note() def set_serial_no_against_delivery_note(self): for item in self.items: - if item.serial_no and item.delivery_note and \ - item.qty != len(get_serial_nos(item.serial_no)): + if item.serial_no and item.delivery_note and item.qty != len(get_serial_nos(item.serial_no)): item.serial_no = get_delivery_note_serial_no(item.item_code, item.qty, item.delivery_note) def validate_serial_against_delivery_note(self): """ - validate if the serial numbers in Sales Invoice Items are same as in - Delivery Note Item + validate if the serial numbers in Sales Invoice Items are same as in + Delivery Note Item """ for item in self.items: @@ -1323,14 +1569,18 @@ class SalesInvoice(SellingController): serial_no_msg = ", ".join(frappe.bold(d) for d in serial_no_diff) msg = _("Row #{0}: The following Serial Nos are not present in Delivery Note {1}:").format( - item.idx, dn_link) + item.idx, dn_link + ) msg += " " + serial_no_msg frappe.throw(msg=msg, title=_("Serial Nos Mismatch")) if item.serial_no and cint(item.qty) != len(si_serial_nos): - frappe.throw(_("Row #{0}: {1} Serial numbers required for Item {2}. You have provided {3}.").format( - item.idx, item.qty, item.item_code, len(si_serial_nos))) + frappe.throw( + _("Row #{0}: {1} Serial numbers required for Item {2}. You have provided {3}.").format( + item.idx, item.qty, item.item_code, len(si_serial_nos) + ) + ) def update_project(self): if self.project: @@ -1338,7 +1588,6 @@ class SalesInvoice(SellingController): project.update_billed_amount() project.db_update() - def verify_payment_amount_is_positive(self): for entry in self.payments: if entry.amount < 0: @@ -1354,63 +1603,90 @@ class SalesInvoice(SellingController): returned_amount = self.get_returned_amount() current_amount = flt(self.grand_total) - cint(self.loyalty_amount) eligible_amount = current_amount - returned_amount - lp_details = get_loyalty_program_details_with_points(self.customer, company=self.company, - current_transaction_amount=current_amount, loyalty_program=self.loyalty_program, - expiry_date=self.posting_date, include_expired_entry=True) - if lp_details and getdate(lp_details.from_date) <= getdate(self.posting_date) and \ - (not lp_details.to_date or getdate(lp_details.to_date) >= getdate(self.posting_date)): + lp_details = get_loyalty_program_details_with_points( + self.customer, + company=self.company, + current_transaction_amount=current_amount, + loyalty_program=self.loyalty_program, + expiry_date=self.posting_date, + include_expired_entry=True, + ) + if ( + lp_details + and getdate(lp_details.from_date) <= getdate(self.posting_date) + and (not lp_details.to_date or getdate(lp_details.to_date) >= getdate(self.posting_date)) + ): collection_factor = lp_details.collection_factor if lp_details.collection_factor else 1.0 - points_earned = cint(eligible_amount/collection_factor) + points_earned = cint(eligible_amount / collection_factor) - doc = frappe.get_doc({ - "doctype": "Loyalty Point Entry", - "company": self.company, - "loyalty_program": lp_details.loyalty_program, - "loyalty_program_tier": lp_details.tier_name, - "customer": self.customer, - "invoice_type": self.doctype, - "invoice": self.name, - "loyalty_points": points_earned, - "purchase_amount": eligible_amount, - "expiry_date": add_days(self.posting_date, lp_details.expiry_duration), - "posting_date": self.posting_date - }) + doc = frappe.get_doc( + { + "doctype": "Loyalty Point Entry", + "company": self.company, + "loyalty_program": lp_details.loyalty_program, + "loyalty_program_tier": lp_details.tier_name, + "customer": self.customer, + "invoice_type": self.doctype, + "invoice": self.name, + "loyalty_points": points_earned, + "purchase_amount": eligible_amount, + "expiry_date": add_days(self.posting_date, lp_details.expiry_duration), + "posting_date": self.posting_date, + } + ) doc.flags.ignore_permissions = 1 doc.save() self.set_loyalty_program_tier() # valdite the redemption and then delete the loyalty points earned on cancel of the invoice def delete_loyalty_point_entry(self): - lp_entry = frappe.db.sql("select name from `tabLoyalty Point Entry` where invoice=%s", - (self.name), as_dict=1) + lp_entry = frappe.db.sql( + "select name from `tabLoyalty Point Entry` where invoice=%s", (self.name), as_dict=1 + ) - if not lp_entry: return - against_lp_entry = frappe.db.sql('''select name, invoice from `tabLoyalty Point Entry` - where redeem_against=%s''', (lp_entry[0].name), as_dict=1) + if not lp_entry: + return + against_lp_entry = frappe.db.sql( + """select name, invoice from `tabLoyalty Point Entry` + where redeem_against=%s""", + (lp_entry[0].name), + as_dict=1, + ) if against_lp_entry: invoice_list = ", ".join([d.invoice for d in against_lp_entry]) frappe.throw( - _('''{} can't be cancelled since the Loyalty Points earned has been redeemed. First cancel the {} No {}''') - .format(self.doctype, self.doctype, invoice_list) + _( + """{} can't be cancelled since the Loyalty Points earned has been redeemed. First cancel the {} No {}""" + ).format(self.doctype, self.doctype, invoice_list) ) else: - frappe.db.sql('''delete from `tabLoyalty Point Entry` where invoice=%s''', (self.name)) + frappe.db.sql("""delete from `tabLoyalty Point Entry` where invoice=%s""", (self.name)) # Set loyalty program self.set_loyalty_program_tier() def set_loyalty_program_tier(self): - lp_details = get_loyalty_program_details_with_points(self.customer, company=self.company, - loyalty_program=self.loyalty_program, include_expired_entry=True) + lp_details = get_loyalty_program_details_with_points( + self.customer, + company=self.company, + loyalty_program=self.loyalty_program, + include_expired_entry=True, + ) frappe.db.set_value("Customer", self.customer, "loyalty_program_tier", lp_details.tier_name) def get_returned_amount(self): - returned_amount = frappe.db.sql(""" - select sum(grand_total) - from `tabSales Invoice` - where docstatus=1 and is_return=1 and ifnull(return_against, '')=%s - """, self.name) - return abs(flt(returned_amount[0][0])) if returned_amount else 0 + from frappe.query_builder.functions import Coalesce, Sum + + doc = frappe.qb.DocType(self.doctype) + returned_amount = ( + frappe.qb.from_(doc) + .select(Sum(doc.grand_total)) + .where( + (doc.docstatus == 1) & (doc.is_return == 1) & (Coalesce(doc.return_against, "") == self.name) + ) + ).run() + + return abs(returned_amount[0][0]) if returned_amount[0][0] else 0 # redeem the loyalty points. def apply_loyalty_points(self): @@ -1418,7 +1694,10 @@ class SalesInvoice(SellingController): get_loyalty_point_entries, get_redemption_details, ) - loyalty_point_entries = get_loyalty_point_entries(self.customer, self.loyalty_program, self.company, self.posting_date) + + loyalty_point_entries = get_loyalty_point_entries( + self.customer, self.loyalty_program, self.company, self.posting_date + ) redemption_details = get_redemption_details(self.customer, self.loyalty_program, self.company) points_to_redeem = self.loyalty_points @@ -1432,24 +1711,26 @@ class SalesInvoice(SellingController): redeemed_points = points_to_redeem else: redeemed_points = available_points - doc = frappe.get_doc({ - "doctype": "Loyalty Point Entry", - "company": self.company, - "loyalty_program": self.loyalty_program, - "loyalty_program_tier": lp_entry.loyalty_program_tier, - "customer": self.customer, - "invoice_type": self.doctype, - "invoice": self.name, - "redeem_against": lp_entry.name, - "loyalty_points": -1*redeemed_points, - "purchase_amount": self.grand_total, - "expiry_date": lp_entry.expiry_date, - "posting_date": self.posting_date - }) + doc = frappe.get_doc( + { + "doctype": "Loyalty Point Entry", + "company": self.company, + "loyalty_program": self.loyalty_program, + "loyalty_program_tier": lp_entry.loyalty_program_tier, + "customer": self.customer, + "invoice_type": self.doctype, + "invoice": self.name, + "redeem_against": lp_entry.name, + "loyalty_points": -1 * redeemed_points, + "purchase_amount": self.grand_total, + "expiry_date": lp_entry.expiry_date, + "posting_date": self.posting_date, + } + ) doc.flags.ignore_permissions = 1 doc.save() points_to_redeem -= redeemed_points - if points_to_redeem < 1: # since points_to_redeem is integer + if points_to_redeem < 1: # since points_to_redeem is integer break # Healthcare @@ -1457,44 +1738,47 @@ class SalesInvoice(SellingController): def set_healthcare_services(self, checked_values): self.set("items", []) from erpnext.stock.get_item_details import get_item_details + for checked_item in checked_values: item_line = self.append("items", {}) - price_list, price_list_currency = frappe.db.get_values("Price List", {"selling": 1}, ['name', 'currency'])[0] + price_list, price_list_currency = frappe.db.get_values( + "Price List", {"selling": 1}, ["name", "currency"] + )[0] args = { - 'doctype': "Sales Invoice", - 'item_code': checked_item['item'], - 'company': self.company, - 'customer': frappe.db.get_value("Patient", self.patient, "customer"), - 'selling_price_list': price_list, - 'price_list_currency': price_list_currency, - 'plc_conversion_rate': 1.0, - 'conversion_rate': 1.0 + "doctype": "Sales Invoice", + "item_code": checked_item["item"], + "company": self.company, + "customer": frappe.db.get_value("Patient", self.patient, "customer"), + "selling_price_list": price_list, + "price_list_currency": price_list_currency, + "plc_conversion_rate": 1.0, + "conversion_rate": 1.0, } item_details = get_item_details(args) - item_line.item_code = checked_item['item'] + item_line.item_code = checked_item["item"] item_line.qty = 1 - if checked_item['qty']: - item_line.qty = checked_item['qty'] - if checked_item['rate']: - item_line.rate = checked_item['rate'] + if checked_item["qty"]: + item_line.qty = checked_item["qty"] + if checked_item["rate"]: + item_line.rate = checked_item["rate"] else: item_line.rate = item_details.price_list_rate item_line.amount = float(item_line.rate) * float(item_line.qty) - if checked_item['income_account']: - item_line.income_account = checked_item['income_account'] - if checked_item['dt']: - item_line.reference_dt = checked_item['dt'] - if checked_item['dn']: - item_line.reference_dn = checked_item['dn'] - if checked_item['description']: - item_line.description = checked_item['description'] + if checked_item["income_account"]: + item_line.income_account = checked_item["income_account"] + if checked_item["dt"]: + item_line.reference_dt = checked_item["dt"] + if checked_item["dn"]: + item_line.reference_dn = checked_item["dn"] + if checked_item["description"]: + item_line.description = checked_item["description"] - self.set_missing_values(for_validate = True) + self.set_missing_values(for_validate=True) def set_status(self, update=False, status=None, update_modified=True): if self.is_new(): - if self.get('amended_from'): - self.status = 'Draft' + if self.get("amended_from"): + self.status = "Draft" return outstanding_amount = flt(self.outstanding_amount, self.precision("outstanding_amount")) @@ -1505,7 +1789,7 @@ class SalesInvoice(SellingController): status = "Cancelled" elif self.docstatus == 1: if self.is_internal_transfer(): - self.status = 'Internal Transfer' + self.status = "Internal Transfer" elif is_overdue(self, total): self.status = "Overdue" elif 0 < outstanding_amount < total: @@ -1513,11 +1797,17 @@ class SalesInvoice(SellingController): elif outstanding_amount > 0 and getdate(self.due_date) >= getdate(): self.status = "Unpaid" # Check if outstanding amount is 0 due to credit note issued against invoice - elif outstanding_amount <= 0 and self.is_return == 0 and frappe.db.get_value('Sales Invoice', {'is_return': 1, 'return_against': self.name, 'docstatus': 1}): + elif ( + outstanding_amount <= 0 + and self.is_return == 0 + and frappe.db.get_value( + "Sales Invoice", {"is_return": 1, "return_against": self.name, "docstatus": 1} + ) + ): self.status = "Credit Note Issued" elif self.is_return == 1: self.status = "Return" - elif outstanding_amount<=0: + elif outstanding_amount <= 0: self.status = "Paid" else: self.status = "Submitted" @@ -1533,34 +1823,29 @@ class SalesInvoice(SellingController): self.status = "Draft" if update: - self.db_set('status', self.status, update_modified = update_modified) + self.db_set("status", self.status, update_modified=update_modified) def get_total_in_party_account_currency(doc): - total_fieldname = ( - "grand_total" - if doc.disable_rounded_total - else "rounded_total" - ) + total_fieldname = "grand_total" if doc.disable_rounded_total else "rounded_total" if doc.party_account_currency != doc.currency: total_fieldname = "base_" + total_fieldname return flt(doc.get(total_fieldname), doc.precision(total_fieldname)) + def is_overdue(doc, total): outstanding_amount = flt(doc.outstanding_amount, doc.precision("outstanding_amount")) if outstanding_amount <= 0: return today = getdate() - if doc.get('is_pos') or not doc.get('payment_schedule'): + if doc.get("is_pos") or not doc.get("payment_schedule"): return getdate(doc.due_date) < today # calculate payable amount till date payment_amount_field = ( - "base_payment_amount" - if doc.party_account_currency != doc.currency - else "payment_amount" + "base_payment_amount" if doc.party_account_currency != doc.currency else "payment_amount" ) payable_amount = sum( @@ -1575,7 +1860,8 @@ def is_overdue(doc, total): def get_discounting_status(sales_invoice): status = None - invoice_discounting_list = frappe.db.sql(""" + invoice_discounting_list = frappe.db.sql( + """ select status from `tabInvoice Discounting` id, `tabDiscounted Invoice` d where @@ -1583,7 +1869,9 @@ def get_discounting_status(sales_invoice): and d.sales_invoice=%s and id.docstatus=1 and status in ('Disbursed', 'Settled') - """, sales_invoice) + """, + sales_invoice, + ) for d in invoice_discounting_list: status = d[0] @@ -1592,6 +1880,7 @@ def get_discounting_status(sales_invoice): return status + def validate_inter_company_party(doctype, party, company, inter_company_reference): if not party: return @@ -1620,10 +1909,19 @@ def validate_inter_company_party(doctype, party, company, inter_company_referenc frappe.throw(_("Invalid Company for Inter Company Transaction.")) elif frappe.db.get_value(partytype, {"name": party, internal: 1}, "name") == party: - companies = frappe.get_all("Allowed To Transact With", fields=["company"], filters={"parenttype": partytype, "parent": party}) + companies = frappe.get_all( + "Allowed To Transact With", + fields=["company"], + filters={"parenttype": partytype, "parent": party}, + ) companies = [d.company for d in companies] if not company in companies: - frappe.throw(_("{0} not allowed to transact with {1}. Please change the Company.").format(partytype, company)) + frappe.throw( + _("{0} not allowed to transact with {1}. Please change the Company.").format( + partytype, company + ) + ) + def update_linked_doc(doctype, name, inter_company_reference): @@ -1633,8 +1931,8 @@ def update_linked_doc(doctype, name, inter_company_reference): ref_field = "inter_company_order_reference" if inter_company_reference: - frappe.db.set_value(doctype, inter_company_reference,\ - ref_field, name) + frappe.db.set_value(doctype, inter_company_reference, ref_field, name) + def unlink_inter_company_doc(doctype, name, inter_company_reference): @@ -1649,48 +1947,57 @@ def unlink_inter_company_doc(doctype, name, inter_company_reference): frappe.db.set_value(doctype, name, ref_field, "") frappe.db.set_value(ref_doc, inter_company_reference, ref_field, "") + def get_list_context(context=None): from erpnext.controllers.website_list_for_contact import get_list_context + list_context = get_list_context(context) - list_context.update({ - 'show_sidebar': True, - 'show_search': True, - 'no_breadcrumbs': True, - 'title': _('Invoices'), - }) + list_context.update( + { + "show_sidebar": True, + "show_search": True, + "no_breadcrumbs": True, + "title": _("Invoices"), + } + ) return list_context + @frappe.whitelist() def get_bank_cash_account(mode_of_payment, company): - account = frappe.db.get_value("Mode of Payment Account", - {"parent": mode_of_payment, "company": company}, "default_account") + account = frappe.db.get_value( + "Mode of Payment Account", {"parent": mode_of_payment, "company": company}, "default_account" + ) if not account: - frappe.throw(_("Please set default Cash or Bank account in Mode of Payment {0}") - .format(get_link_to_form("Mode of Payment", mode_of_payment)), title=_("Missing Account")) - return { - "account": account - } + frappe.throw( + _("Please set default Cash or Bank account in Mode of Payment {0}").format( + get_link_to_form("Mode of Payment", mode_of_payment) + ), + title=_("Missing Account"), + ) + return {"account": account} + @frappe.whitelist() def make_maintenance_schedule(source_name, target_doc=None): - doclist = get_mapped_doc("Sales Invoice", source_name, { - "Sales Invoice": { - "doctype": "Maintenance Schedule", - "validation": { - "docstatus": ["=", 1] - } + doclist = get_mapped_doc( + "Sales Invoice", + source_name, + { + "Sales Invoice": {"doctype": "Maintenance Schedule", "validation": {"docstatus": ["=", 1]}}, + "Sales Invoice Item": { + "doctype": "Maintenance Schedule Item", + }, }, - "Sales Invoice Item": { - "doctype": "Maintenance Schedule Item", - }, - }, target_doc) + target_doc, + ) return doclist + @frappe.whitelist() def make_delivery_note(source_name, target_doc=None): def set_missing_values(source, target): - target.ignore_pricing_rule = 1 target.run_method("set_missing_values") target.run_method("set_po_nos") target.run_method("calculate_taxes_and_totals") @@ -1702,82 +2009,104 @@ def make_delivery_note(source_name, target_doc=None): target_doc.base_amount = target_doc.qty * flt(source_doc.base_rate) target_doc.amount = target_doc.qty * flt(source_doc.rate) - doclist = get_mapped_doc("Sales Invoice", source_name, { - "Sales Invoice": { - "doctype": "Delivery Note", - "validation": { - "docstatus": ["=", 1] - } - }, - "Sales Invoice Item": { - "doctype": "Delivery Note Item", - "field_map": { - "name": "si_detail", - "parent": "against_sales_invoice", - "serial_no": "serial_no", - "sales_order": "against_sales_order", - "so_detail": "so_detail", - "cost_center": "cost_center" + doclist = get_mapped_doc( + "Sales Invoice", + source_name, + { + "Sales Invoice": {"doctype": "Delivery Note", "validation": {"docstatus": ["=", 1]}}, + "Sales Invoice Item": { + "doctype": "Delivery Note Item", + "field_map": { + "name": "si_detail", + "parent": "against_sales_invoice", + "serial_no": "serial_no", + "sales_order": "against_sales_order", + "so_detail": "so_detail", + "cost_center": "cost_center", + }, + "postprocess": update_item, + "condition": lambda doc: doc.delivered_by_supplier != 1, }, - "postprocess": update_item, - "condition": lambda doc: doc.delivered_by_supplier!=1 - }, - "Sales Taxes and Charges": { - "doctype": "Sales Taxes and Charges", - "add_if_empty": True - }, - "Sales Team": { - "doctype": "Sales Team", - "field_map": { - "incentives": "incentives" + "Sales Taxes and Charges": {"doctype": "Sales Taxes and Charges", "add_if_empty": True}, + "Sales Team": { + "doctype": "Sales Team", + "field_map": {"incentives": "incentives"}, + "add_if_empty": True, }, - "add_if_empty": True - } - }, target_doc, set_missing_values) + }, + target_doc, + set_missing_values, + ) + doclist.set_onload("ignore_price_list", True) return doclist + @frappe.whitelist() def make_sales_return(source_name, target_doc=None): from erpnext.controllers.sales_and_purchase_return import make_return_doc + return make_return_doc("Sales Invoice", source_name, target_doc) + def set_account_for_mode_of_payment(self): for data in self.payments: if not data.account: data.account = get_bank_cash_account(data.mode_of_payment, self.company).get("account") + def get_inter_company_details(doc, doctype): if doctype in ["Sales Invoice", "Sales Order", "Delivery Note"]: - parties = frappe.db.get_all("Supplier", fields=["name"], filters={"disabled": 0, "is_internal_supplier": 1, "represents_company": doc.company}) + parties = frappe.db.get_all( + "Supplier", + fields=["name"], + filters={"disabled": 0, "is_internal_supplier": 1, "represents_company": doc.company}, + ) company = frappe.get_cached_value("Customer", doc.customer, "represents_company") if not parties: - frappe.throw(_('No Supplier found for Inter Company Transactions which represents company {0}').format(frappe.bold(doc.company))) + frappe.throw( + _("No Supplier found for Inter Company Transactions which represents company {0}").format( + frappe.bold(doc.company) + ) + ) party = get_internal_party(parties, "Supplier", doc) else: - parties = frappe.db.get_all("Customer", fields=["name"], filters={"disabled": 0, "is_internal_customer": 1, "represents_company": doc.company}) + parties = frappe.db.get_all( + "Customer", + fields=["name"], + filters={"disabled": 0, "is_internal_customer": 1, "represents_company": doc.company}, + ) company = frappe.get_cached_value("Supplier", doc.supplier, "represents_company") if not parties: - frappe.throw(_('No Customer found for Inter Company Transactions which represents company {0}').format(frappe.bold(doc.company))) + frappe.throw( + _("No Customer found for Inter Company Transactions which represents company {0}").format( + frappe.bold(doc.company) + ) + ) party = get_internal_party(parties, "Customer", doc) - return { - "party": party, - "company": company - } + return {"party": party, "company": company} + def get_internal_party(parties, link_doctype, doc): if len(parties) == 1: - party = parties[0].name + party = parties[0].name else: # If more than one Internal Supplier/Customer, get supplier/customer on basis of address - if doc.get('company_address') or doc.get('shipping_address'): - party = frappe.db.get_value("Dynamic Link", {"parent": doc.get('company_address') or doc.get('shipping_address'), - "parenttype": "Address", "link_doctype": link_doctype}, "link_name") + if doc.get("company_address") or doc.get("shipping_address"): + party = frappe.db.get_value( + "Dynamic Link", + { + "parent": doc.get("company_address") or doc.get("shipping_address"), + "parenttype": "Address", + "link_doctype": link_doctype, + }, + "link_name", + ) if not party: party = parties[0].name @@ -1786,11 +2115,18 @@ def get_internal_party(parties, link_doctype, doc): return party + def validate_inter_company_transaction(doc, doctype): details = get_inter_company_details(doc, doctype) - price_list = doc.selling_price_list if doctype in ["Sales Invoice", "Sales Order", "Delivery Note"] else doc.buying_price_list - valid_price_list = frappe.db.get_value("Price List", {"name": price_list, "buying": 1, "selling": 1}) + price_list = ( + doc.selling_price_list + if doctype in ["Sales Invoice", "Sales Order", "Delivery Note"] + else doc.buying_price_list + ) + valid_price_list = frappe.db.get_value( + "Price List", {"name": price_list, "buying": 1, "selling": 1} + ) if not valid_price_list and not doc.is_internal_transfer(): frappe.throw(_("Selected Price List should have buying and selling fields checked.")) @@ -1800,28 +2136,34 @@ def validate_inter_company_transaction(doc, doctype): frappe.throw(_("No {0} found for Inter Company Transactions.").format(partytype)) company = details.get("company") - default_currency = frappe.get_cached_value('Company', company, "default_currency") + default_currency = frappe.get_cached_value("Company", company, "default_currency") if default_currency != doc.currency: - frappe.throw(_("Company currencies of both the companies should match for Inter Company Transactions.")) + frappe.throw( + _("Company currencies of both the companies should match for Inter Company Transactions.") + ) return + @frappe.whitelist() def make_inter_company_purchase_invoice(source_name, target_doc=None): return make_inter_company_transaction("Sales Invoice", source_name, target_doc) + def make_inter_company_transaction(doctype, source_name, target_doc=None): if doctype in ["Sales Invoice", "Sales Order"]: source_doc = frappe.get_doc(doctype, source_name) target_doctype = "Purchase Invoice" if doctype == "Sales Invoice" else "Purchase Order" target_detail_field = "sales_invoice_item" if doctype == "Sales Invoice" else "sales_order_item" - source_document_warehouse_field = 'target_warehouse' - target_document_warehouse_field = 'from_warehouse' + source_document_warehouse_field = "target_warehouse" + target_document_warehouse_field = "from_warehouse" + received_items = get_received_items(source_name, target_doctype, target_detail_field) else: source_doc = frappe.get_doc(doctype, source_name) target_doctype = "Sales Invoice" if doctype == "Purchase Invoice" else "Sales Order" - source_document_warehouse_field = 'from_warehouse' - target_document_warehouse_field = 'target_warehouse' + source_document_warehouse_field = "from_warehouse" + target_document_warehouse_field = "target_warehouse" + received_items = {} validate_inter_company_transaction(source_doc, doctype) details = get_inter_company_details(source_doc, doctype) @@ -1833,7 +2175,7 @@ def make_inter_company_transaction(doctype, source_name, target_doc=None): def update_details(source_doc, target_doc, source_parent): target_doc.inter_company_invoice_reference = source_doc.name if target_doc.doctype in ["Purchase Invoice", "Purchase Order"]: - currency = frappe.db.get_value('Supplier', details.get('party'), 'default_currency') + currency = frappe.db.get_value("Supplier", details.get("party"), "default_currency") target_doc.company = details.get("company") target_doc.supplier = details.get("party") target_doc.is_internal_supplier = 1 @@ -1841,130 +2183,203 @@ def make_inter_company_transaction(doctype, source_name, target_doc=None): target_doc.buying_price_list = source_doc.selling_price_list # Invert Addresses - update_address(target_doc, 'supplier_address', 'address_display', source_doc.company_address) - update_address(target_doc, 'shipping_address', 'shipping_address_display', source_doc.customer_address) + update_address(target_doc, "supplier_address", "address_display", source_doc.company_address) + update_address( + target_doc, "shipping_address", "shipping_address_display", source_doc.customer_address + ) if currency: target_doc.currency = currency - update_taxes(target_doc, party=target_doc.supplier, party_type='Supplier', company=target_doc.company, - doctype=target_doc.doctype, party_address=target_doc.supplier_address, - company_address=target_doc.shipping_address) + update_taxes( + target_doc, + party=target_doc.supplier, + party_type="Supplier", + company=target_doc.company, + doctype=target_doc.doctype, + party_address=target_doc.supplier_address, + company_address=target_doc.shipping_address, + ) else: - currency = frappe.db.get_value('Customer', details.get('party'), 'default_currency') + currency = frappe.db.get_value("Customer", details.get("party"), "default_currency") target_doc.company = details.get("company") target_doc.customer = details.get("party") target_doc.selling_price_list = source_doc.buying_price_list - update_address(target_doc, 'company_address', 'company_address_display', source_doc.supplier_address) - update_address(target_doc, 'shipping_address_name', 'shipping_address', source_doc.shipping_address) - update_address(target_doc, 'customer_address', 'address_display', source_doc.shipping_address) + update_address( + target_doc, "company_address", "company_address_display", source_doc.supplier_address + ) + update_address( + target_doc, "shipping_address_name", "shipping_address", source_doc.shipping_address + ) + update_address(target_doc, "customer_address", "address_display", source_doc.shipping_address) if currency: target_doc.currency = currency - update_taxes(target_doc, party=target_doc.customer, party_type='Customer', company=target_doc.company, - doctype=target_doc.doctype, party_address=target_doc.customer_address, - company_address=target_doc.company_address, shipping_address_name=target_doc.shipping_address_name) + update_taxes( + target_doc, + party=target_doc.customer, + party_type="Customer", + company=target_doc.company, + doctype=target_doc.doctype, + party_address=target_doc.customer_address, + company_address=target_doc.company_address, + shipping_address_name=target_doc.shipping_address_name, + ) + + def update_item(source, target, source_parent): + target.qty = flt(source.qty) - received_items.get(source.name, 0.0) item_field_map = { "doctype": target_doctype + " Item", - "field_no_map": [ - "income_account", - "expense_account", - "cost_center", - "warehouse" - ], + "field_no_map": ["income_account", "expense_account", "cost_center", "warehouse"], "field_map": { - 'rate': 'rate', - } + "rate": "rate", + }, + "postprocess": update_item, + "condition": lambda doc: doc.qty > 0, } if doctype in ["Sales Invoice", "Sales Order"]: - item_field_map["field_map"].update({ - "name": target_detail_field, - }) + item_field_map["field_map"].update( + { + "name": target_detail_field, + } + ) - if source_doc.get('update_stock'): - item_field_map["field_map"].update({ - source_document_warehouse_field: target_document_warehouse_field, - 'batch_no': 'batch_no', - 'serial_no': 'serial_no' - }) + if source_doc.get("update_stock"): + item_field_map["field_map"].update( + { + source_document_warehouse_field: target_document_warehouse_field, + "batch_no": "batch_no", + "serial_no": "serial_no", + } + ) - doclist = get_mapped_doc(doctype, source_name, { - doctype: { - "doctype": target_doctype, - "postprocess": update_details, - "set_target_warehouse": "set_from_warehouse", - "field_no_map": [ - "taxes_and_charges", - "set_warehouse", - "shipping_address" - ] + doclist = get_mapped_doc( + doctype, + source_name, + { + doctype: { + "doctype": target_doctype, + "postprocess": update_details, + "set_target_warehouse": "set_from_warehouse", + "field_no_map": ["taxes_and_charges", "set_warehouse", "shipping_address"], + }, + doctype + " Item": item_field_map, }, - doctype +" Item": item_field_map - - }, target_doc, set_missing_values) + target_doc, + set_missing_values, + ) return doclist + +def get_received_items(reference_name, doctype, reference_fieldname): + target_doctypes = frappe.get_all( + doctype, + filters={"inter_company_invoice_reference": reference_name, "docstatus": 1}, + as_list=True, + ) + + if target_doctypes: + target_doctypes = list(target_doctypes[0]) + + received_items_map = frappe._dict( + frappe.get_all( + doctype + " Item", + filters={"parent": ("in", target_doctypes)}, + fields=[reference_fieldname, "qty"], + as_list=1, + ) + ) + + return received_items_map + + def set_purchase_references(doc): # add internal PO or PR links if any if doc.is_internal_transfer(): - if doc.doctype == 'Purchase Receipt': + if doc.doctype == "Purchase Receipt": so_item_map = get_delivery_note_details(doc.inter_company_invoice_reference) if so_item_map: - pd_item_map, parent_child_map, warehouse_map = \ - get_pd_details('Purchase Order Item', so_item_map, 'sales_order_item') + pd_item_map, parent_child_map, warehouse_map = get_pd_details( + "Purchase Order Item", so_item_map, "sales_order_item" + ) update_pr_items(doc, so_item_map, pd_item_map, parent_child_map, warehouse_map) - elif doc.doctype == 'Purchase Invoice': + elif doc.doctype == "Purchase Invoice": dn_item_map, so_item_map = get_sales_invoice_details(doc.inter_company_invoice_reference) # First check for Purchase receipt if list(dn_item_map.values()): - pd_item_map, parent_child_map, warehouse_map = \ - get_pd_details('Purchase Receipt Item', dn_item_map, 'delivery_note_item') + pd_item_map, parent_child_map, warehouse_map = get_pd_details( + "Purchase Receipt Item", dn_item_map, "delivery_note_item" + ) - update_pi_items(doc, 'pr_detail', 'purchase_receipt', - dn_item_map, pd_item_map, parent_child_map, warehouse_map) + update_pi_items( + doc, + "pr_detail", + "purchase_receipt", + dn_item_map, + pd_item_map, + parent_child_map, + warehouse_map, + ) if list(so_item_map.values()): - pd_item_map, parent_child_map, warehouse_map = \ - get_pd_details('Purchase Order Item', so_item_map, 'sales_order_item') + pd_item_map, parent_child_map, warehouse_map = get_pd_details( + "Purchase Order Item", so_item_map, "sales_order_item" + ) - update_pi_items(doc, 'po_detail', 'purchase_order', - so_item_map, pd_item_map, parent_child_map, warehouse_map) + update_pi_items( + doc, "po_detail", "purchase_order", so_item_map, pd_item_map, parent_child_map, warehouse_map + ) -def update_pi_items(doc, detail_field, parent_field, sales_item_map, - purchase_item_map, parent_child_map, warehouse_map): - for item in doc.get('items'): + +def update_pi_items( + doc, + detail_field, + parent_field, + sales_item_map, + purchase_item_map, + parent_child_map, + warehouse_map, +): + for item in doc.get("items"): item.set(detail_field, purchase_item_map.get(sales_item_map.get(item.sales_invoice_item))) item.set(parent_field, parent_child_map.get(sales_item_map.get(item.sales_invoice_item))) if doc.update_stock: item.warehouse = warehouse_map.get(sales_item_map.get(item.sales_invoice_item)) + def update_pr_items(doc, sales_item_map, purchase_item_map, parent_child_map, warehouse_map): - for item in doc.get('items'): + for item in doc.get("items"): item.purchase_order_item = purchase_item_map.get(sales_item_map.get(item.delivery_note_item)) item.warehouse = warehouse_map.get(sales_item_map.get(item.delivery_note_item)) item.purchase_order = parent_child_map.get(sales_item_map.get(item.delivery_note_item)) + def get_delivery_note_details(internal_reference): - si_item_details = frappe.get_all('Delivery Note Item', fields=['name', 'so_detail'], - filters={'parent': internal_reference}) + si_item_details = frappe.get_all( + "Delivery Note Item", fields=["name", "so_detail"], filters={"parent": internal_reference} + ) return {d.name: d.so_detail for d in si_item_details if d.so_detail} + def get_sales_invoice_details(internal_reference): dn_item_map = {} so_item_map = {} - si_item_details = frappe.get_all('Sales Invoice Item', fields=['name', 'so_detail', - 'dn_detail'], filters={'parent': internal_reference}) + si_item_details = frappe.get_all( + "Sales Invoice Item", + fields=["name", "so_detail", "dn_detail"], + filters={"parent": internal_reference}, + ) for d in si_item_details: if d.dn_detail: @@ -1974,13 +2389,17 @@ def get_sales_invoice_details(internal_reference): return dn_item_map, so_item_map + def get_pd_details(doctype, sd_detail_map, sd_detail_field): pd_item_map = {} accepted_warehouse_map = {} parent_child_map = {} - pd_item_details = frappe.get_all(doctype, - fields=[sd_detail_field, 'name', 'warehouse', 'parent'], filters={sd_detail_field: ('in', list(sd_detail_map.values()))}) + pd_item_details = frappe.get_all( + doctype, + fields=[sd_detail_field, "name", "warehouse", "parent"], + filters={sd_detail_field: ("in", list(sd_detail_map.values()))}, + ) for d in pd_item_details: pd_item_map.setdefault(d.get(sd_detail_field), d.name) @@ -1989,16 +2408,33 @@ def get_pd_details(doctype, sd_detail_map, sd_detail_field): return pd_item_map, parent_child_map, accepted_warehouse_map -def update_taxes(doc, party=None, party_type=None, company=None, doctype=None, party_address=None, - company_address=None, shipping_address_name=None, master_doctype=None): + +def update_taxes( + doc, + party=None, + party_type=None, + company=None, + doctype=None, + party_address=None, + company_address=None, + shipping_address_name=None, + master_doctype=None, +): # Update Party Details - party_details = get_party_details(party=party, party_type=party_type, company=company, - doctype=doctype, party_address=party_address, company_address=company_address, - shipping_address=shipping_address_name) + party_details = get_party_details( + party=party, + party_type=party_type, + company=company, + doctype=doctype, + party_address=party_address, + company_address=company_address, + shipping_address=shipping_address_name, + ) # Update taxes and charges if any - doc.taxes_and_charges = party_details.get('taxes_and_charges') - doc.set('taxes', party_details.get('taxes')) + doc.taxes_and_charges = party_details.get("taxes_and_charges") + doc.set("taxes", party_details.get("taxes")) + def update_address(doc, address_field, address_display_field, address_name): doc.set(address_field, address_name) @@ -2009,53 +2445,61 @@ def update_address(doc, address_field, address_display_field, address_name): doc.set(address_display_field, get_address_display(doc.get(address_field))) + @frappe.whitelist() def get_loyalty_programs(customer): - ''' sets applicable loyalty program to the customer or returns a list of applicable programs ''' + """sets applicable loyalty program to the customer or returns a list of applicable programs""" from erpnext.selling.doctype.customer.customer import get_loyalty_programs - customer = frappe.get_doc('Customer', customer) - if customer.loyalty_program: return [customer.loyalty_program] + customer = frappe.get_doc("Customer", customer) + if customer.loyalty_program: + return [customer.loyalty_program] lp_details = get_loyalty_programs(customer) if len(lp_details) == 1: - frappe.db.set(customer, 'loyalty_program', lp_details[0]) + frappe.db.set(customer, "loyalty_program", lp_details[0]) return lp_details else: return lp_details + def on_doctype_update(): frappe.db.add_index("Sales Invoice", ["customer", "is_return", "return_against"]) + @frappe.whitelist() def create_invoice_discounting(source_name, target_doc=None): invoice = frappe.get_doc("Sales Invoice", source_name) invoice_discounting = frappe.new_doc("Invoice Discounting") invoice_discounting.company = invoice.company - invoice_discounting.append("invoices", { - "sales_invoice": source_name, - "customer": invoice.customer, - "posting_date": invoice.posting_date, - "outstanding_amount": invoice.outstanding_amount - }) + invoice_discounting.append( + "invoices", + { + "sales_invoice": source_name, + "customer": invoice.customer, + "posting_date": invoice.posting_date, + "outstanding_amount": invoice.outstanding_amount, + }, + ) return invoice_discounting + def update_multi_mode_option(doc, pos_profile): def append_payment(payment_mode): - payment = doc.append('payments', {}) + payment = doc.append("payments", {}) payment.default = payment_mode.default payment.mode_of_payment = payment_mode.mop payment.account = payment_mode.default_account payment.type = payment_mode.type - doc.set('payments', []) + doc.set("payments", []) invalid_modes = [] - mode_of_payments = [d.mode_of_payment for d in pos_profile.get('payments')] + mode_of_payments = [d.mode_of_payment for d in pos_profile.get("payments")] mode_of_payments_info = get_mode_of_payments_info(mode_of_payments, doc.company) - for row in pos_profile.get('payments'): + for row in pos_profile.get("payments"): payment_mode = mode_of_payments_info.get(row.mode_of_payment) if not payment_mode: invalid_modes.append(get_link_to_form("Mode of Payment", row.mode_of_payment)) @@ -2071,12 +2515,17 @@ def update_multi_mode_option(doc, pos_profile): msg = _("Please set default Cash or Bank account in Mode of Payments {}") frappe.throw(msg.format(", ".join(invalid_modes)), title=_("Missing Account")) + def get_all_mode_of_payments(doc): - return frappe.db.sql(""" + return frappe.db.sql( + """ select mpa.default_account, mpa.parent, mp.type as type from `tabMode of Payment Account` mpa,`tabMode of Payment` mp where mpa.parent = mp.name and mpa.company = %(company)s and mp.enabled = 1""", - {'company': doc.company}, as_dict=1) + {"company": doc.company}, + as_dict=1, + ) + def get_mode_of_payments_info(mode_of_payments, company): data = frappe.db.sql( @@ -2092,16 +2541,24 @@ def get_mode_of_payments_info(mode_of_payments, company): mp.name in %s group by mp.name - """, (company, mode_of_payments), as_dict=1) + """, + (company, mode_of_payments), + as_dict=1, + ) + + return {row.get("mop"): row for row in data} - return {row.get('mop'): row for row in data} def get_mode_of_payment_info(mode_of_payment, company): - return frappe.db.sql(""" + return frappe.db.sql( + """ select mpa.default_account, mpa.parent, mp.type as type from `tabMode of Payment Account` mpa,`tabMode of Payment` mp where mpa.parent = mp.name and mpa.company = %s and mp.enabled = 1 and mp.name = %s""", - (company, mode_of_payment), as_dict=1) + (company, mode_of_payment), + as_dict=1, + ) + @frappe.whitelist() def create_dunning(source_name, target_doc=None): @@ -2111,41 +2568,58 @@ def create_dunning(source_name, target_doc=None): calculate_interest_and_amount, get_dunning_letter_text, ) + def set_missing_values(source, target): target.sales_invoice = source_name target.outstanding_amount = source.outstanding_amount overdue_days = (getdate(target.posting_date) - getdate(source.due_date)).days target.overdue_days = overdue_days - if frappe.db.exists('Dunning Type', {'start_day': [ - '<', overdue_days], 'end_day': ['>=', overdue_days]}): - dunning_type = frappe.get_doc('Dunning Type', {'start_day': [ - '<', overdue_days], 'end_day': ['>=', overdue_days]}) + if frappe.db.exists( + "Dunning Type", {"start_day": ["<", overdue_days], "end_day": [">=", overdue_days]} + ): + dunning_type = frappe.get_doc( + "Dunning Type", {"start_day": ["<", overdue_days], "end_day": [">=", overdue_days]} + ) target.dunning_type = dunning_type.name target.rate_of_interest = dunning_type.rate_of_interest target.dunning_fee = dunning_type.dunning_fee - letter_text = get_dunning_letter_text(dunning_type = dunning_type.name, doc = target.as_dict()) + letter_text = get_dunning_letter_text(dunning_type=dunning_type.name, doc=target.as_dict()) if letter_text: - target.body_text = letter_text.get('body_text') - target.closing_text = letter_text.get('closing_text') - target.language = letter_text.get('language') - amounts = calculate_interest_and_amount(target.posting_date, target.outstanding_amount, - target.rate_of_interest, target.dunning_fee, target.overdue_days) - target.interest_amount = amounts.get('interest_amount') - target.dunning_amount = amounts.get('dunning_amount') - target.grand_total = amounts.get('grand_total') + target.body_text = letter_text.get("body_text") + target.closing_text = letter_text.get("closing_text") + target.language = letter_text.get("language") + amounts = calculate_interest_and_amount( + target.posting_date, + target.outstanding_amount, + target.rate_of_interest, + target.dunning_fee, + target.overdue_days, + ) + target.interest_amount = amounts.get("interest_amount") + target.dunning_amount = amounts.get("dunning_amount") + target.grand_total = amounts.get("grand_total") - doclist = get_mapped_doc("Sales Invoice", source_name, { - "Sales Invoice": { - "doctype": "Dunning", - } - }, target_doc, set_missing_values) + doclist = get_mapped_doc( + "Sales Invoice", + source_name, + { + "Sales Invoice": { + "doctype": "Dunning", + } + }, + target_doc, + set_missing_values, + ) return doclist + def check_if_return_invoice_linked_with_payment_entry(self): # If a Return invoice is linked with payment entry along with other invoices, # the cancellation of the Return causes allocated amount to be greater than paid - if not frappe.db.get_single_value('Accounts Settings', 'unlink_payment_on_cancellation_of_invoice'): + if not frappe.db.get_single_value( + "Accounts Settings", "unlink_payment_on_cancellation_of_invoice" + ): return payment_entries = [] @@ -2154,7 +2628,8 @@ def check_if_return_invoice_linked_with_payment_entry(self): else: invoice = self.name - payment_entries = frappe.db.sql_list(""" + payment_entries = frappe.db.sql_list( + """ SELECT t1.name FROM @@ -2164,7 +2639,9 @@ def check_if_return_invoice_linked_with_payment_entry(self): and t1.docstatus = 1 and t2.reference_name = %s and t2.allocated_amount < 0 - """, invoice) + """, + invoice, + ) links_to_pe = [] if payment_entries: @@ -2173,7 +2650,9 @@ def check_if_return_invoice_linked_with_payment_entry(self): if len(payment_entry.references) > 1: links_to_pe.append(payment_entry.name) if links_to_pe: - payment_entries_link = [get_link_to_form('Payment Entry', name, label=name) for name in links_to_pe] + payment_entries_link = [ + get_link_to_form("Payment Entry", name, label=name) for name in links_to_pe + ] message = _("Please cancel and amend the Payment Entry") message += " " + ", ".join(payment_entries_link) + " " message += _("to unallocate the amount of this Return Invoice before cancelling it.") diff --git a/erpnext/accounts/doctype/sales_invoice/sales_invoice_dashboard.py b/erpnext/accounts/doctype/sales_invoice/sales_invoice_dashboard.py index 104d4f9b8aa..0a765f3f46f 100644 --- a/erpnext/accounts/doctype/sales_invoice/sales_invoice_dashboard.py +++ b/erpnext/accounts/doctype/sales_invoice/sales_invoice_dashboard.py @@ -1,37 +1,36 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'sales_invoice', - 'non_standard_fieldnames': { - 'Delivery Note': 'against_sales_invoice', - 'Journal Entry': 'reference_name', - 'Payment Entry': 'reference_name', - 'Payment Request': 'reference_name', - 'Sales Invoice': 'return_against', - 'Auto Repeat': 'reference_document', + "fieldname": "sales_invoice", + "non_standard_fieldnames": { + "Delivery Note": "against_sales_invoice", + "Journal Entry": "reference_name", + "Payment Entry": "reference_name", + "Payment Request": "reference_name", + "Sales Invoice": "return_against", + "Auto Repeat": "reference_document", + "Purchase Invoice": "inter_company_invoice_reference", }, - 'internal_links': { - 'Sales Order': ['items', 'sales_order'] + "internal_links": { + "Sales Order": ["items", "sales_order"], + "Timesheet": ["timesheets", "time_sheet"], }, - 'transactions': [ + "transactions": [ { - 'label': _('Payment'), - 'items': ['Payment Entry', 'Payment Request', 'Journal Entry', 'Invoice Discounting', 'Dunning'] + "label": _("Payment"), + "items": [ + "Payment Entry", + "Payment Request", + "Journal Entry", + "Invoice Discounting", + "Dunning", + ], }, - { - 'label': _('Reference'), - 'items': ['Timesheet', 'Delivery Note', 'Sales Order'] - }, - { - 'label': _('Returns'), - 'items': ['Sales Invoice'] - }, - { - 'label': _('Subscription'), - 'items': ['Auto Repeat'] - }, - ] + {"label": _("Reference"), "items": ["Timesheet", "Delivery Note", "Sales Order"]}, + {"label": _("Returns"), "items": ["Sales Invoice"]}, + {"label": _("Subscription"), "items": ["Auto Repeat"]}, + {"label": _("Internal Transfers"), "items": ["Purchase Invoice"]}, + ], } diff --git a/erpnext/accounts/doctype/sales_invoice/test_sales_invoice.py b/erpnext/accounts/doctype/sales_invoice/test_sales_invoice.py index ebe2a969b46..2df095a41a0 100644 --- a/erpnext/accounts/doctype/sales_invoice/test_sales_invoice.py +++ b/erpnext/accounts/doctype/sales_invoice/test_sales_invoice.py @@ -19,6 +19,7 @@ from erpnext.accounts.doctype.sales_invoice.sales_invoice import make_inter_comp from erpnext.accounts.utils import PaymentEntryUnlinkError from erpnext.assets.doctype.asset.depreciation import post_depreciation_entries from erpnext.assets.doctype.asset.test_asset import create_asset, create_asset_data +from erpnext.controllers.accounts_controller import update_invoice_status from erpnext.controllers.taxes_and_totals import get_itemised_tax_breakup_data from erpnext.exceptions import InvalidAccountCurrency, InvalidCurrency from erpnext.regional.india.utils import get_ewb_data @@ -57,23 +58,25 @@ class TestSalesInvoice(unittest.TestCase): w2 = frappe.get_doc(w.doctype, w.name) import time + time.sleep(1) w.save() import time + time.sleep(1) self.assertRaises(frappe.TimestampMismatchError, w2.save) def test_sales_invoice_change_naming_series(self): si = frappe.copy_doc(test_records[2]) si.insert() - si.naming_series = 'TEST-' + si.naming_series = "TEST-" self.assertRaises(frappe.CannotChangeConstantError, si.save) si = frappe.copy_doc(test_records[1]) si.insert() - si.naming_series = 'TEST-' + si.naming_series = "TEST-" self.assertRaises(frappe.CannotChangeConstantError, si.save) @@ -89,15 +92,21 @@ class TestSalesInvoice(unittest.TestCase): si.insert() expected_values = { - "keys": ["price_list_rate", "discount_percentage", "rate", "amount", - "base_price_list_rate", "base_rate", "base_amount"], + "keys": [ + "price_list_rate", + "discount_percentage", + "rate", + "amount", + "base_price_list_rate", + "base_rate", + "base_amount", + ], "_Test Item Home Desktop 100": [50, 0, 50, 500, 50, 50, 500], "_Test Item Home Desktop 200": [150, 0, 150, 750, 150, 150, 750], } # check if children are saved - self.assertEqual(len(si.get("items")), - len(expected_values)-1) + self.assertEqual(len(si.get("items")), len(expected_values) - 1) # check if item values are calculated for d in si.get("items"): @@ -118,7 +127,7 @@ class TestSalesInvoice(unittest.TestCase): "_Test Account S&H Education Cess - _TC": [1.4, 1619.2], "_Test Account CST - _TC": [32.38, 1651.58], "_Test Account VAT - _TC": [156.25, 1807.83], - "_Test Account Discount - _TC": [-180.78, 1627.05] + "_Test Account Discount - _TC": [-180.78, 1627.05], } for d in si.get("taxes"): @@ -148,7 +157,7 @@ class TestSalesInvoice(unittest.TestCase): pe.submit() unlink_payment_on_cancel_of_invoice(0) - si = frappe.get_doc('Sales Invoice', si.name) + si = frappe.get_doc("Sales Invoice", si.name) self.assertRaises(frappe.LinkExistsError, si.cancel) unlink_payment_on_cancel_of_invoice() @@ -159,25 +168,30 @@ class TestSalesInvoice(unittest.TestCase): si2 = create_sales_invoice(rate=300) si3 = create_sales_invoice(qty=-1, rate=300, is_return=1) - pe = get_payment_entry("Sales Invoice", si1.name, bank_account="_Test Bank - _TC") - pe.append('references', { - 'reference_doctype': 'Sales Invoice', - 'reference_name': si2.name, - 'total_amount': si2.grand_total, - 'outstanding_amount': si2.outstanding_amount, - 'allocated_amount': si2.outstanding_amount - }) + pe.append( + "references", + { + "reference_doctype": "Sales Invoice", + "reference_name": si2.name, + "total_amount": si2.grand_total, + "outstanding_amount": si2.outstanding_amount, + "allocated_amount": si2.outstanding_amount, + }, + ) - pe.append('references', { - 'reference_doctype': 'Sales Invoice', - 'reference_name': si3.name, - 'total_amount': si3.grand_total, - 'outstanding_amount': si3.outstanding_amount, - 'allocated_amount': si3.outstanding_amount - }) + pe.append( + "references", + { + "reference_doctype": "Sales Invoice", + "reference_name": si3.name, + "total_amount": si3.grand_total, + "outstanding_amount": si3.outstanding_amount, + "allocated_amount": si3.outstanding_amount, + }, + ) - pe.reference_no = 'Test001' + pe.reference_no = "Test001" pe.reference_date = nowdate() pe.save() pe.submit() @@ -188,7 +202,6 @@ class TestSalesInvoice(unittest.TestCase): si1.load_from_db() self.assertRaises(PaymentEntryUnlinkError, si1.cancel) - def test_sales_invoice_calculation_export_currency(self): si = frappe.copy_doc(test_records[2]) si.currency = "USD" @@ -203,14 +216,21 @@ class TestSalesInvoice(unittest.TestCase): si.insert() expected_values = { - "keys": ["price_list_rate", "discount_percentage", "rate", "amount", - "base_price_list_rate", "base_rate", "base_amount"], + "keys": [ + "price_list_rate", + "discount_percentage", + "rate", + "amount", + "base_price_list_rate", + "base_rate", + "base_amount", + ], "_Test Item Home Desktop 100": [1, 0, 1, 10, 50, 50, 500], "_Test Item Home Desktop 200": [3, 0, 3, 15, 150, 150, 750], } # check if children are saved - self.assertEqual(len(si.get("items")), len(expected_values)-1) + self.assertEqual(len(si.get("items")), len(expected_values) - 1) # check if item values are calculated for d in si.get("items"): @@ -233,7 +253,7 @@ class TestSalesInvoice(unittest.TestCase): "_Test Account S&H Education Cess - _TC": [1.5, 1619.5, 0.03, 32.39], "_Test Account CST - _TC": [32.5, 1652, 0.65, 33.04], "_Test Account VAT - _TC": [156.5, 1808.5, 3.13, 36.17], - "_Test Account Discount - _TC": [-181.0, 1627.5, -3.62, 32.55] + "_Test Account Discount - _TC": [-181.0, 1627.5, -3.62, 32.55], } for d in si.get("taxes"): @@ -245,22 +265,28 @@ class TestSalesInvoice(unittest.TestCase): def test_sales_invoice_with_discount_and_inclusive_tax(self): si = create_sales_invoice(qty=100, rate=50, do_not_save=True) - si.append("taxes", { - "charge_type": "On Net Total", - "account_head": "_Test Account Service Tax - _TC", - "cost_center": "_Test Cost Center - _TC", - "description": "Service Tax", - "rate": 14, - 'included_in_print_rate': 1 - }) - si.append("taxes", { - "charge_type": "On Item Quantity", - "account_head": "_Test Account Education Cess - _TC", - "cost_center": "_Test Cost Center - _TC", - "description": "CESS", - "rate": 5, - 'included_in_print_rate': 1 - }) + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": "_Test Account Service Tax - _TC", + "cost_center": "_Test Cost Center - _TC", + "description": "Service Tax", + "rate": 14, + "included_in_print_rate": 1, + }, + ) + si.append( + "taxes", + { + "charge_type": "On Item Quantity", + "account_head": "_Test Account Education Cess - _TC", + "cost_center": "_Test Cost Center - _TC", + "description": "CESS", + "rate": 5, + "included_in_print_rate": 1, + }, + ) si.insert() # with inclusive tax @@ -272,7 +298,7 @@ class TestSalesInvoice(unittest.TestCase): # additional discount si.discount_amount = 100 - si.apply_discount_on = 'Net Total' + si.apply_discount_on = "Net Total" si.payment_schedule = [] si.save() @@ -285,7 +311,7 @@ class TestSalesInvoice(unittest.TestCase): # additional discount on grand total si.discount_amount = 100 - si.apply_discount_on = 'Grand Total' + si.apply_discount_on = "Grand Total" si.payment_schedule = [] si.save() @@ -297,14 +323,17 @@ class TestSalesInvoice(unittest.TestCase): def test_sales_invoice_discount_amount(self): si = frappe.copy_doc(test_records[3]) si.discount_amount = 104.94 - si.append("taxes", { - "charge_type": "On Previous Row Amount", - "account_head": "_Test Account Service Tax - _TC", - "cost_center": "_Test Cost Center - _TC", - "description": "Service Tax", - "rate": 10, - "row_id": 8, - }) + si.append( + "taxes", + { + "charge_type": "On Previous Row Amount", + "account_head": "_Test Account Service Tax - _TC", + "cost_center": "_Test Cost Center - _TC", + "description": "Service Tax", + "rate": 10, + "row_id": 8, + }, + ) si.insert() expected_values = [ @@ -320,7 +349,7 @@ class TestSalesInvoice(unittest.TestCase): "net_rate": 46.54, "net_amount": 465.37, "base_net_rate": 46.54, - "base_net_amount": 465.37 + "base_net_amount": 465.37, }, { "item_code": "_Test Item Home Desktop 200", @@ -334,12 +363,12 @@ class TestSalesInvoice(unittest.TestCase): "net_rate": 139.62, "net_amount": 698.08, "base_net_rate": 139.62, - "base_net_amount": 698.08 - } + "base_net_amount": 698.08, + }, ] # check if children are saved - self.assertEqual(len(si.get("items")), len(expected_values)) + self.assertEqual(len(si.get("items")), len(expected_values)) # check if item values are calculated for i, d in enumerate(si.get("items")): @@ -361,7 +390,7 @@ class TestSalesInvoice(unittest.TestCase): "_Test Account Customs Duty - _TC": [125, 116.35, 1585.40], "_Test Account Shipping Charges - _TC": [100, 100, 1685.40], "_Test Account Discount - _TC": [-180.33, -168.54, 1516.86], - "_Test Account Service Tax - _TC": [-18.03, -16.85, 1500.01] + "_Test Account Service Tax - _TC": [-18.03, -16.85, 1500.01], } for d in si.get("taxes"): @@ -376,38 +405,48 @@ class TestSalesInvoice(unittest.TestCase): frappe.db.set_value("Company", "_Test Company", "round_off_account", "Round Off - _TC") si = frappe.copy_doc(test_records[3]) si.discount_amount = 104.94 - si.append("taxes", { - "doctype": "Sales Taxes and Charges", - "charge_type": "On Previous Row Amount", - "account_head": "_Test Account Service Tax - _TC", - "cost_center": "_Test Cost Center - _TC", - "description": "Service Tax", - "rate": 10, - "row_id": 8 - }) + si.append( + "taxes", + { + "doctype": "Sales Taxes and Charges", + "charge_type": "On Previous Row Amount", + "account_head": "_Test Account Service Tax - _TC", + "cost_center": "_Test Cost Center - _TC", + "description": "Service Tax", + "rate": 10, + "row_id": 8, + }, + ) si.insert() si.submit() - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) self.assertTrue(gl_entries) - expected_values = dict((d[0], d) for d in [ - [si.debit_to, 1500, 0.0], - [test_records[3]["items"][0]["income_account"], 0.0, 1163.45], - [test_records[3]["taxes"][0]["account_head"], 0.0, 130.31], - [test_records[3]["taxes"][1]["account_head"], 0.0, 2.61], - [test_records[3]["taxes"][2]["account_head"], 0.0, 1.30], - [test_records[3]["taxes"][3]["account_head"], 0.0, 25.95], - [test_records[3]["taxes"][4]["account_head"], 0.0, 145.43], - [test_records[3]["taxes"][5]["account_head"], 0.0, 116.35], - [test_records[3]["taxes"][6]["account_head"], 0.0, 100], - [test_records[3]["taxes"][7]["account_head"], 168.54, 0.0], - ["_Test Account Service Tax - _TC", 16.85, 0.0], - ["Round Off - _TC", 0.01, 0.0] - ]) + expected_values = dict( + (d[0], d) + for d in [ + [si.debit_to, 1500, 0.0], + [test_records[3]["items"][0]["income_account"], 0.0, 1163.45], + [test_records[3]["taxes"][0]["account_head"], 0.0, 130.31], + [test_records[3]["taxes"][1]["account_head"], 0.0, 2.61], + [test_records[3]["taxes"][2]["account_head"], 0.0, 1.30], + [test_records[3]["taxes"][3]["account_head"], 0.0, 25.95], + [test_records[3]["taxes"][4]["account_head"], 0.0, 145.43], + [test_records[3]["taxes"][5]["account_head"], 0.0, 116.35], + [test_records[3]["taxes"][6]["account_head"], 0.0, 100], + [test_records[3]["taxes"][7]["account_head"], 168.54, 0.0], + ["_Test Account Service Tax - _TC", 16.85, 0.0], + ["Round Off - _TC", 0.01, 0.0], + ] + ) for gle in gl_entries: self.assertEqual(expected_values[gle.account][0], gle.account) @@ -417,8 +456,11 @@ class TestSalesInvoice(unittest.TestCase): # cancel si.cancel() - gle = frappe.db.sql("""select * from `tabGL Entry` - where voucher_type='Sales Invoice' and voucher_no=%s""", si.name) + gle = frappe.db.sql( + """select * from `tabGL Entry` + where voucher_type='Sales Invoice' and voucher_no=%s""", + si.name, + ) self.assertTrue(gle) @@ -430,14 +472,17 @@ class TestSalesInvoice(unittest.TestCase): item_row_copy.qty = qty si.append("items", item_row_copy) - si.append("taxes", { - "account_head": "_Test Account VAT - _TC", - "charge_type": "On Net Total", - "cost_center": "_Test Cost Center - _TC", - "description": "VAT", - "doctype": "Sales Taxes and Charges", - "rate": 19 - }) + si.append( + "taxes", + { + "account_head": "_Test Account VAT - _TC", + "charge_type": "On Net Total", + "cost_center": "_Test Cost Center - _TC", + "description": "VAT", + "doctype": "Sales Taxes and Charges", + "rate": 19, + }, + ) si.insert() self.assertEqual(si.net_total, 4600) @@ -452,10 +497,10 @@ class TestSalesInvoice(unittest.TestCase): item_row = si.get("items")[0] add_items = [ - (54, '_Test Account Excise Duty @ 12 - _TC'), - (288, '_Test Account Excise Duty @ 15 - _TC'), - (144, '_Test Account Excise Duty @ 20 - _TC'), - (430, '_Test Item Tax Template 1 - _TC') + (54, "_Test Account Excise Duty @ 12 - _TC"), + (288, "_Test Account Excise Duty @ 15 - _TC"), + (144, "_Test Account Excise Duty @ 20 - _TC"), + (430, "_Test Item Tax Template 1 - _TC"), ] for qty, item_tax_template in add_items: item_row_copy = copy.deepcopy(item_row) @@ -463,30 +508,39 @@ class TestSalesInvoice(unittest.TestCase): item_row_copy.item_tax_template = item_tax_template si.append("items", item_row_copy) - si.append("taxes", { - "account_head": "_Test Account Excise Duty - _TC", - "charge_type": "On Net Total", - "cost_center": "_Test Cost Center - _TC", - "description": "Excise Duty", - "doctype": "Sales Taxes and Charges", - "rate": 11 - }) - si.append("taxes", { - "account_head": "_Test Account Education Cess - _TC", - "charge_type": "On Net Total", - "cost_center": "_Test Cost Center - _TC", - "description": "Education Cess", - "doctype": "Sales Taxes and Charges", - "rate": 0 - }) - si.append("taxes", { - "account_head": "_Test Account S&H Education Cess - _TC", - "charge_type": "On Net Total", - "cost_center": "_Test Cost Center - _TC", - "description": "S&H Education Cess", - "doctype": "Sales Taxes and Charges", - "rate": 3 - }) + si.append( + "taxes", + { + "account_head": "_Test Account Excise Duty - _TC", + "charge_type": "On Net Total", + "cost_center": "_Test Cost Center - _TC", + "description": "Excise Duty", + "doctype": "Sales Taxes and Charges", + "rate": 11, + }, + ) + si.append( + "taxes", + { + "account_head": "_Test Account Education Cess - _TC", + "charge_type": "On Net Total", + "cost_center": "_Test Cost Center - _TC", + "description": "Education Cess", + "doctype": "Sales Taxes and Charges", + "rate": 0, + }, + ) + si.append( + "taxes", + { + "account_head": "_Test Account S&H Education Cess - _TC", + "charge_type": "On Net Total", + "cost_center": "_Test Cost Center - _TC", + "description": "S&H Education Cess", + "doctype": "Sales Taxes and Charges", + "rate": 3, + }, + ) si.insert() self.assertEqual(si.net_total, 4600) @@ -516,14 +570,17 @@ class TestSalesInvoice(unittest.TestCase): si.apply_discount_on = "Net Total" si.discount_amount = 75.0 - si.append("taxes", { - "account_head": "_Test Account VAT - _TC", - "charge_type": "On Net Total", - "cost_center": "_Test Cost Center - _TC", - "description": "VAT", - "doctype": "Sales Taxes and Charges", - "rate": 24 - }) + si.append( + "taxes", + { + "account_head": "_Test Account VAT - _TC", + "charge_type": "On Net Total", + "cost_center": "_Test Cost Center - _TC", + "description": "VAT", + "doctype": "Sales Taxes and Charges", + "rate": 24, + }, + ) si.insert() self.assertEqual(si.total, 975) @@ -537,7 +594,7 @@ class TestSalesInvoice(unittest.TestCase): def test_inclusive_rate_validations(self): si = frappe.copy_doc(test_records[2]) for i, tax in enumerate(si.get("taxes")): - tax.idx = i+1 + tax.idx = i + 1 si.get("items")[0].price_list_rate = 62.5 si.get("items")[0].price_list_rate = 191 @@ -557,14 +614,43 @@ class TestSalesInvoice(unittest.TestCase): si.insert() expected_values = { - "keys": ["price_list_rate", "discount_percentage", "rate", "amount", - "base_price_list_rate", "base_rate", "base_amount", "net_rate", "net_amount"], - "_Test Item Home Desktop 100": [62.5, 0, 62.5, 625.0, 62.5, 62.5, 625.0, 50, 499.97600115194473], - "_Test Item Home Desktop 200": [190.66, 0, 190.66, 953.3, 190.66, 190.66, 953.3, 150, 749.9968530500239], + "keys": [ + "price_list_rate", + "discount_percentage", + "rate", + "amount", + "base_price_list_rate", + "base_rate", + "base_amount", + "net_rate", + "net_amount", + ], + "_Test Item Home Desktop 100": [ + 62.5, + 0, + 62.5, + 625.0, + 62.5, + 62.5, + 625.0, + 50, + 499.97600115194473, + ], + "_Test Item Home Desktop 200": [ + 190.66, + 0, + 190.66, + 953.3, + 190.66, + 190.66, + 953.3, + 150, + 749.9968530500239, + ], } # check if children are saved - self.assertEqual(len(si.get("items")), len(expected_values)-1) + self.assertEqual(len(si.get("items")), len(expected_values) - 1) # check if item values are calculated for d in si.get("items"): @@ -585,7 +671,7 @@ class TestSalesInvoice(unittest.TestCase): "_Test Account VAT - _TC": [156.25, 1578.30], "_Test Account Customs Duty - _TC": [125, 1703.30], "_Test Account Shipping Charges - _TC": [100, 1803.30], - "_Test Account Discount - _TC": [-180.33, 1622.97] + "_Test Account Discount - _TC": [-180.33, 1622.97], } for d in si.get("taxes"): @@ -623,7 +709,7 @@ class TestSalesInvoice(unittest.TestCase): "net_rate": 40, "net_amount": 399.9808009215558, "base_net_rate": 2000, - "base_net_amount": 19999 + "base_net_amount": 19999, }, { "item_code": "_Test Item Home Desktop 200", @@ -637,8 +723,8 @@ class TestSalesInvoice(unittest.TestCase): "net_rate": 118.01, "net_amount": 590.0531205155963, "base_net_rate": 5900.5, - "base_net_amount": 29502.5 - } + "base_net_amount": 29502.5, + }, ] # check if children are saved @@ -663,8 +749,8 @@ class TestSalesInvoice(unittest.TestCase): "_Test Account CST - _TC": [1104, 56312.0, 22.08, 1126.24], "_Test Account VAT - _TC": [6187.5, 62499.5, 123.75, 1249.99], "_Test Account Customs Duty - _TC": [4950.0, 67449.5, 99.0, 1348.99], - "_Test Account Shipping Charges - _TC": [ 100, 67549.5, 2, 1350.99], - "_Test Account Discount - _TC": [ -6755, 60794.5, -135.10, 1215.89] + "_Test Account Shipping Charges - _TC": [100, 67549.5, 2, 1350.99], + "_Test Account Discount - _TC": [-6755, 60794.5, -135.10, 1215.89], } for d in si.get("taxes"): @@ -676,7 +762,6 @@ class TestSalesInvoice(unittest.TestCase): self.assertEqual(si.rounding_adjustment, 0.01) self.assertEqual(si.base_rounding_adjustment, 0.50) - def test_outstanding(self): w = self.make() self.assertEqual(w.outstanding_amount, w.base_rounded_total) @@ -696,11 +781,11 @@ class TestSalesInvoice(unittest.TestCase): self.assertEqual(frappe.db.get_value("Sales Invoice", w.name, "outstanding_amount"), 162.0) - link_data = get_dynamic_link_map().get('Sales Invoice', []) + link_data = get_dynamic_link_map().get("Sales Invoice", []) link_doctypes = [d.parent for d in link_data] # test case for dynamic link order - self.assertTrue(link_doctypes.index('GL Entry') > link_doctypes.index('Journal Entry Account')) + self.assertTrue(link_doctypes.index("GL Entry") > link_doctypes.index("Journal Entry Account")) jv.cancel() self.assertEqual(frappe.db.get_value("Sales Invoice", w.name, "outstanding_amount"), 562.0) @@ -710,18 +795,25 @@ class TestSalesInvoice(unittest.TestCase): si.insert() si.submit() - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) self.assertTrue(gl_entries) - expected_values = dict((d[0], d) for d in [ - [si.debit_to, 630.0, 0.0], - [test_records[1]["items"][0]["income_account"], 0.0, 500.0], - [test_records[1]["taxes"][0]["account_head"], 0.0, 80.0], - [test_records[1]["taxes"][1]["account_head"], 0.0, 50.0], - ]) + expected_values = dict( + (d[0], d) + for d in [ + [si.debit_to, 630.0, 0.0], + [test_records[1]["items"][0]["income_account"], 0.0, 500.0], + [test_records[1]["taxes"][0]["account_head"], 0.0, 80.0], + [test_records[1]["taxes"][1]["account_head"], 0.0, 50.0], + ] + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_values[gle.account][0], gle.account) @@ -731,25 +823,49 @@ class TestSalesInvoice(unittest.TestCase): # cancel si.cancel() - gle = frappe.db.sql("""select * from `tabGL Entry` - where voucher_type='Sales Invoice' and voucher_no=%s""", si.name) + gle = frappe.db.sql( + """select * from `tabGL Entry` + where voucher_type='Sales Invoice' and voucher_no=%s""", + si.name, + ) self.assertTrue(gle) def test_pos_gl_entry_with_perpetual_inventory(self): - make_pos_profile(company="_Test Company with perpetual inventory", income_account = "Sales - TCP1", - expense_account = "Cost of Goods Sold - TCP1", warehouse="Stores - TCP1", cost_center = "Main - TCP1", write_off_account="_Test Write Off - TCP1") + make_pos_profile( + company="_Test Company with perpetual inventory", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + write_off_account="_Test Write Off - TCP1", + ) - pr = make_purchase_receipt(company= "_Test Company with perpetual inventory", item_code= "_Test FG Item",warehouse= "Stores - TCP1",cost_center= "Main - TCP1") + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + item_code="_Test FG Item", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + ) - pos = create_sales_invoice(company= "_Test Company with perpetual inventory", debit_to="Debtors - TCP1", item_code= "_Test FG Item", warehouse="Stores - TCP1", - income_account = "Sales - TCP1", expense_account = "Cost of Goods Sold - TCP1", cost_center = "Main - TCP1", do_not_save=True) + pos = create_sales_invoice( + company="_Test Company with perpetual inventory", + debit_to="Debtors - TCP1", + item_code="_Test FG Item", + warehouse="Stores - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + do_not_save=True, + ) pos.is_pos = 1 pos.update_stock = 1 - pos.append("payments", {'mode_of_payment': 'Bank Draft', 'account': '_Test Bank - TCP1', 'amount': 50}) - pos.append("payments", {'mode_of_payment': 'Cash', 'account': 'Cash - TCP1', 'amount': 50}) + pos.append( + "payments", {"mode_of_payment": "Bank Draft", "account": "_Test Bank - TCP1", "amount": 50} + ) + pos.append("payments", {"mode_of_payment": "Cash", "account": "Cash - TCP1", "amount": 50}) taxes = get_taxes_and_charges() pos.taxes = [] @@ -769,20 +885,19 @@ class TestSalesInvoice(unittest.TestCase): pos_profile = make_pos_profile() pos_profile.payments = [] - pos_profile.append('payments', { - 'default': 1, - 'mode_of_payment': 'Cash' - }) + pos_profile.append("payments", {"default": 1, "mode_of_payment": "Cash"}) pos_profile.save() - pos = create_sales_invoice(qty = 10, do_not_save=True) + pos = create_sales_invoice(qty=10, do_not_save=True) pos.is_pos = 1 pos.pos_profile = pos_profile.name - pos.append("payments", {'mode_of_payment': 'Bank Draft', 'account': '_Test Bank - _TC', 'amount': 500}) - pos.append("payments", {'mode_of_payment': 'Cash', 'account': 'Cash - _TC', 'amount': 500}) + pos.append( + "payments", {"mode_of_payment": "Bank Draft", "account": "_Test Bank - _TC", "amount": 500} + ) + pos.append("payments", {"mode_of_payment": "Cash", "account": "Cash - _TC", "amount": 500}) pos.insert() pos.submit() @@ -791,46 +906,123 @@ class TestSalesInvoice(unittest.TestCase): pos_return.insert() pos_return.submit() - self.assertEqual(pos_return.get('payments')[0].amount, -1000) + self.assertEqual(pos_return.get("payments")[0].amount, -1000) def test_pos_change_amount(self): - make_pos_profile(company="_Test Company with perpetual inventory", income_account = "Sales - TCP1", - expense_account = "Cost of Goods Sold - TCP1", warehouse="Stores - TCP1", cost_center = "Main - TCP1", write_off_account="_Test Write Off - TCP1") + make_pos_profile( + company="_Test Company with perpetual inventory", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + write_off_account="_Test Write Off - TCP1", + ) - make_purchase_receipt(company= "_Test Company with perpetual inventory", - item_code= "_Test FG Item",warehouse= "Stores - TCP1", cost_center= "Main - TCP1") + make_purchase_receipt( + company="_Test Company with perpetual inventory", + item_code="_Test FG Item", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + ) - pos = create_sales_invoice(company= "_Test Company with perpetual inventory", - debit_to="Debtors - TCP1", item_code= "_Test FG Item", warehouse="Stores - TCP1", - income_account = "Sales - TCP1", expense_account = "Cost of Goods Sold - TCP1", - cost_center = "Main - TCP1", do_not_save=True) + pos = create_sales_invoice( + company="_Test Company with perpetual inventory", + debit_to="Debtors - TCP1", + item_code="_Test FG Item", + warehouse="Stores - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + do_not_save=True, + ) pos.is_pos = 1 pos.update_stock = 1 - pos.append("payments", {'mode_of_payment': 'Bank Draft', 'account': '_Test Bank - TCP1', 'amount': 50}) - pos.append("payments", {'mode_of_payment': 'Cash', 'account': 'Cash - TCP1', 'amount': 60}) + pos.append( + "payments", {"mode_of_payment": "Bank Draft", "account": "_Test Bank - TCP1", "amount": 50} + ) + pos.append("payments", {"mode_of_payment": "Cash", "account": "Cash - TCP1", "amount": 60}) - pos.change_amount = 5.0 + pos.write_off_outstanding_amount_automatically = 1 pos.insert() pos.submit() self.assertEqual(pos.grand_total, 100.0) - self.assertEqual(pos.write_off_amount, -5) + self.assertEqual(pos.write_off_amount, 0) + + def test_auto_write_off_amount(self): + make_pos_profile( + company="_Test Company with perpetual inventory", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + write_off_account="_Test Write Off - TCP1", + ) + + make_purchase_receipt( + company="_Test Company with perpetual inventory", + item_code="_Test FG Item", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + ) + + pos = create_sales_invoice( + company="_Test Company with perpetual inventory", + debit_to="Debtors - TCP1", + item_code="_Test FG Item", + warehouse="Stores - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + do_not_save=True, + ) + + pos.is_pos = 1 + pos.update_stock = 1 + + pos.append( + "payments", {"mode_of_payment": "Bank Draft", "account": "_Test Bank - TCP1", "amount": 50} + ) + pos.append("payments", {"mode_of_payment": "Cash", "account": "Cash - TCP1", "amount": 40}) + + pos.write_off_outstanding_amount_automatically = 1 + pos.insert() + pos.submit() + + self.assertEqual(pos.grand_total, 100.0) + self.assertEqual(pos.write_off_amount, 10) def test_pos_with_no_gl_entry_for_change_amount(self): - frappe.db.set_value('Accounts Settings', None, 'post_change_gl_entries', 0) + frappe.db.set_value("Accounts Settings", None, "post_change_gl_entries", 0) - make_pos_profile(company="_Test Company with perpetual inventory", income_account = "Sales - TCP1", - expense_account = "Cost of Goods Sold - TCP1", warehouse="Stores - TCP1", cost_center = "Main - TCP1", write_off_account="_Test Write Off - TCP1") + make_pos_profile( + company="_Test Company with perpetual inventory", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + write_off_account="_Test Write Off - TCP1", + ) - make_purchase_receipt(company= "_Test Company with perpetual inventory", - item_code= "_Test FG Item",warehouse= "Stores - TCP1", cost_center= "Main - TCP1") + make_purchase_receipt( + company="_Test Company with perpetual inventory", + item_code="_Test FG Item", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + ) - pos = create_sales_invoice(company= "_Test Company with perpetual inventory", - debit_to="Debtors - TCP1", item_code= "_Test FG Item", warehouse="Stores - TCP1", - income_account = "Sales - TCP1", expense_account = "Cost of Goods Sold - TCP1", - cost_center = "Main - TCP1", do_not_save=True) + pos = create_sales_invoice( + company="_Test Company with perpetual inventory", + debit_to="Debtors - TCP1", + item_code="_Test FG Item", + warehouse="Stores - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + do_not_save=True, + ) pos.is_pos = 1 pos.update_stock = 1 @@ -840,8 +1032,10 @@ class TestSalesInvoice(unittest.TestCase): for tax in taxes: pos.append("taxes", tax) - pos.append("payments", {'mode_of_payment': 'Bank Draft', 'account': '_Test Bank - TCP1', 'amount': 50}) - pos.append("payments", {'mode_of_payment': 'Cash', 'account': 'Cash - TCP1', 'amount': 60}) + pos.append( + "payments", {"mode_of_payment": "Bank Draft", "account": "_Test Bank - TCP1", "amount": 50} + ) + pos.append("payments", {"mode_of_payment": "Cash", "account": "Cash - TCP1", "amount": 60}) pos.insert() pos.submit() @@ -851,40 +1045,50 @@ class TestSalesInvoice(unittest.TestCase): self.validate_pos_gl_entry(pos, pos, 60, validate_without_change_gle=True) - frappe.db.set_value('Accounts Settings', None, 'post_change_gl_entries', 1) + frappe.db.set_value("Accounts Settings", None, "post_change_gl_entries", 1) def validate_pos_gl_entry(self, si, pos, cash_amount, validate_without_change_gle=False): if validate_without_change_gle: cash_amount -= pos.change_amount # check stock ledger entries - sle = frappe.db.sql("""select * from `tabStock Ledger Entry` + sle = frappe.db.sql( + """select * from `tabStock Ledger Entry` where voucher_type = 'Sales Invoice' and voucher_no = %s""", - si.name, as_dict=1)[0] + si.name, + as_dict=1, + )[0] self.assertTrue(sle) - self.assertEqual([sle.item_code, sle.warehouse, sle.actual_qty], - ['_Test FG Item', 'Stores - TCP1', -1.0]) + self.assertEqual( + [sle.item_code, sle.warehouse, sle.actual_qty], ["_Test FG Item", "Stores - TCP1", -1.0] + ) # check gl entries - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc, debit asc, credit asc""", si.name, as_dict=1) + order by account asc, debit asc, credit asc""", + si.name, + as_dict=1, + ) self.assertTrue(gl_entries) - stock_in_hand = get_inventory_account('_Test Company with perpetual inventory') - expected_gl_entries = sorted([ - [si.debit_to, 100.0, 0.0], - [pos.items[0].income_account, 0.0, 89.09], - ['Round Off - TCP1', 0.0, 0.01], - [pos.taxes[0].account_head, 0.0, 10.69], - [pos.taxes[1].account_head, 0.0, 0.21], - [stock_in_hand, 0.0, abs(sle.stock_value_difference)], - [pos.items[0].expense_account, abs(sle.stock_value_difference), 0.0], - [si.debit_to, 0.0, 50.0], - [si.debit_to, 0.0, cash_amount], - ["_Test Bank - TCP1", 50, 0.0], - ["Cash - TCP1", cash_amount, 0.0] - ]) + stock_in_hand = get_inventory_account("_Test Company with perpetual inventory") + expected_gl_entries = sorted( + [ + [si.debit_to, 100.0, 0.0], + [pos.items[0].income_account, 0.0, 89.09], + ["Round Off - TCP1", 0.0, 0.01], + [pos.taxes[0].account_head, 0.0, 10.69], + [pos.taxes[1].account_head, 0.0, 0.21], + [stock_in_hand, 0.0, abs(sle.stock_value_difference)], + [pos.items[0].expense_account, abs(sle.stock_value_difference), 0.0], + [si.debit_to, 0.0, 50.0], + [si.debit_to, 0.0, cash_amount], + ["_Test Bank - TCP1", 50, 0.0], + ["Cash - TCP1", cash_amount, 0.0], + ] + ) for i, gle in enumerate(sorted(gl_entries, key=lambda gle: gle.account)): self.assertEqual(expected_gl_entries[i][0], gle.account) @@ -892,8 +1096,11 @@ class TestSalesInvoice(unittest.TestCase): self.assertEqual(expected_gl_entries[i][2], gle.credit) si.cancel() - gle = frappe.db.sql("""select * from `tabGL Entry` - where voucher_type='Sales Invoice' and voucher_no=%s""", si.name) + gle = frappe.db.sql( + """select * from `tabGL Entry` + where voucher_type='Sales Invoice' and voucher_no=%s""", + si.name, + ) self.assertTrue(gle) @@ -913,21 +1120,29 @@ class TestSalesInvoice(unittest.TestCase): self.assertRaises(frappe.ValidationError, si.submit) def test_sales_invoice_gl_entry_with_perpetual_inventory_no_item_code(self): - si = create_sales_invoice(company="_Test Company with perpetual inventory", debit_to = "Debtors - TCP1", - income_account="Sales - TCP1", cost_center = "Main - TCP1", do_not_save=True) + si = create_sales_invoice( + company="_Test Company with perpetual inventory", + debit_to="Debtors - TCP1", + income_account="Sales - TCP1", + cost_center="Main - TCP1", + do_not_save=True, + ) si.get("items")[0].item_code = None si.insert() si.submit() - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) self.assertTrue(gl_entries) - expected_values = dict((d[0], d) for d in [ - ["Debtors - TCP1", 100.0, 0.0], - ["Sales - TCP1", 0.0, 100.0] - ]) + expected_values = dict( + (d[0], d) for d in [["Debtors - TCP1", 100.0, 0.0], ["Sales - TCP1", 0.0, 100.0]] + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_values[gle.account][0], gle.account) self.assertEqual(expected_values[gle.account][1], gle.debit) @@ -936,25 +1151,32 @@ class TestSalesInvoice(unittest.TestCase): def test_sales_invoice_gl_entry_with_perpetual_inventory_non_stock_item(self): si = create_sales_invoice(item="_Test Non Stock Item") - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) self.assertTrue(gl_entries) - expected_values = dict((d[0], d) for d in [ - [si.debit_to, 100.0, 0.0], - [test_records[1]["items"][0]["income_account"], 0.0, 100.0] - ]) + expected_values = dict( + (d[0], d) + for d in [ + [si.debit_to, 100.0, 0.0], + [test_records[1]["items"][0]["income_account"], 0.0, 100.0], + ] + ) for i, gle in enumerate(gl_entries): self.assertEqual(expected_values[gle.account][0], gle.account) self.assertEqual(expected_values[gle.account][1], gle.debit) self.assertEqual(expected_values[gle.account][2], gle.credit) - def _insert_purchase_receipt(self): from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import ( test_records as pr_test_records, ) + pr = frappe.copy_doc(pr_test_records[0]) pr.naming_series = "_T-Purchase Receipt-" pr.insert() @@ -964,6 +1186,7 @@ class TestSalesInvoice(unittest.TestCase): from erpnext.stock.doctype.delivery_note.test_delivery_note import ( test_records as dn_test_records, ) + dn = frappe.copy_doc(dn_test_records[0]) dn.naming_series = "_T-Delivery Note-" dn.insert() @@ -981,24 +1204,37 @@ class TestSalesInvoice(unittest.TestCase): si = frappe.copy_doc(test_records[0]) si.allocate_advances_automatically = 0 - si.append("advances", { - "doctype": "Sales Invoice Advance", - "reference_type": "Journal Entry", - "reference_name": jv.name, - "reference_row": jv.get("accounts")[0].name, - "advance_amount": 400, - "allocated_amount": 300, - "remarks": jv.remark - }) + si.append( + "advances", + { + "doctype": "Sales Invoice Advance", + "reference_type": "Journal Entry", + "reference_name": jv.name, + "reference_row": jv.get("accounts")[0].name, + "advance_amount": 400, + "allocated_amount": 300, + "remarks": jv.remark, + }, + ) si.insert() si.submit() si.load_from_db() - self.assertTrue(frappe.db.sql("""select name from `tabJournal Entry Account` - where reference_name=%s""", si.name)) + self.assertTrue( + frappe.db.sql( + """select name from `tabJournal Entry Account` + where reference_name=%s""", + si.name, + ) + ) - self.assertTrue(frappe.db.sql("""select name from `tabJournal Entry Account` - where reference_name=%s and credit_in_account_currency=300""", si.name)) + self.assertTrue( + frappe.db.sql( + """select name from `tabJournal Entry Account` + where reference_name=%s and credit_in_account_currency=300""", + si.name, + ) + ) self.assertEqual(si.outstanding_amount, 262.0) @@ -1020,29 +1256,34 @@ class TestSalesInvoice(unittest.TestCase): si.submit() self.assertFalse(frappe.db.get_value("Serial No", serial_nos[0], "warehouse")) - self.assertEqual(frappe.db.get_value("Serial No", serial_nos[0], - "delivery_document_no"), si.name) + self.assertEqual( + frappe.db.get_value("Serial No", serial_nos[0], "delivery_document_no"), si.name + ) return si def test_serialized_cancel(self): from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos + si = self.test_serialized() si.cancel() serial_nos = get_serial_nos(si.get("items")[0].serial_no) - self.assertEqual(frappe.db.get_value("Serial No", serial_nos[0], "warehouse"), "_Test Warehouse - _TC") - self.assertFalse(frappe.db.get_value("Serial No", serial_nos[0], - "delivery_document_no")) + self.assertEqual( + frappe.db.get_value("Serial No", serial_nos[0], "warehouse"), "_Test Warehouse - _TC" + ) + self.assertFalse(frappe.db.get_value("Serial No", serial_nos[0], "delivery_document_no")) self.assertFalse(frappe.db.get_value("Serial No", serial_nos[0], "sales_invoice")) def test_serialize_status(self): - serial_no = frappe.get_doc({ - "doctype": "Serial No", - "item_code": "_Test Serialized Item With Series", - "serial_no": make_autoname("SR", "Serial No") - }) + serial_no = frappe.get_doc( + { + "doctype": "Serial No", + "item_code": "_Test Serialized Item With Series", + "serial_no": make_autoname("SR", "Serial No"), + } + ) serial_no.save() si = frappe.copy_doc(test_records[0]) @@ -1056,8 +1297,8 @@ class TestSalesInvoice(unittest.TestCase): def test_serial_numbers_against_delivery_note(self): """ - check if the sales invoice item serial numbers and the delivery note items - serial numbers are same + check if the sales invoice item serial numbers and the delivery note items + serial numbers are same """ from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos @@ -1077,40 +1318,84 @@ class TestSalesInvoice(unittest.TestCase): def test_return_sales_invoice(self): make_stock_entry(item_code="_Test Item", target="Stores - TCP1", qty=50, basic_rate=100) - actual_qty_0 = get_qty_after_transaction(item_code = "_Test Item", warehouse = "Stores - TCP1") + actual_qty_0 = get_qty_after_transaction(item_code="_Test Item", warehouse="Stores - TCP1") - si = create_sales_invoice(qty = 5, rate=500, update_stock=1, company= "_Test Company with perpetual inventory", debit_to="Debtors - TCP1", item_code= "_Test Item", warehouse="Stores - TCP1", income_account = "Sales - TCP1", expense_account = "Cost of Goods Sold - TCP1", cost_center = "Main - TCP1") + si = create_sales_invoice( + qty=5, + rate=500, + update_stock=1, + company="_Test Company with perpetual inventory", + debit_to="Debtors - TCP1", + item_code="_Test Item", + warehouse="Stores - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + ) - - actual_qty_1 = get_qty_after_transaction(item_code = "_Test Item", warehouse = "Stores - TCP1") + actual_qty_1 = get_qty_after_transaction(item_code="_Test Item", warehouse="Stores - TCP1") self.assertEqual(actual_qty_0 - 5, actual_qty_1) # outgoing_rate - outgoing_rate = frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Sales Invoice", - "voucher_no": si.name}, "stock_value_difference") / 5 + outgoing_rate = ( + frappe.db.get_value( + "Stock Ledger Entry", + {"voucher_type": "Sales Invoice", "voucher_no": si.name}, + "stock_value_difference", + ) + / 5 + ) # return entry - si1 = create_sales_invoice(is_return=1, return_against=si.name, qty=-2, rate=500, update_stock=1, company= "_Test Company with perpetual inventory", debit_to="Debtors - TCP1", item_code= "_Test Item", warehouse="Stores - TCP1", income_account = "Sales - TCP1", expense_account = "Cost of Goods Sold - TCP1", cost_center = "Main - TCP1") + si1 = create_sales_invoice( + is_return=1, + return_against=si.name, + qty=-2, + rate=500, + update_stock=1, + company="_Test Company with perpetual inventory", + debit_to="Debtors - TCP1", + item_code="_Test Item", + warehouse="Stores - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + ) - actual_qty_2 = get_qty_after_transaction(item_code = "_Test Item", warehouse = "Stores - TCP1") + actual_qty_2 = get_qty_after_transaction(item_code="_Test Item", warehouse="Stores - TCP1") self.assertEqual(actual_qty_1 + 2, actual_qty_2) - incoming_rate, stock_value_difference = frappe.db.get_value("Stock Ledger Entry", + incoming_rate, stock_value_difference = frappe.db.get_value( + "Stock Ledger Entry", {"voucher_type": "Sales Invoice", "voucher_no": si1.name}, - ["incoming_rate", "stock_value_difference"]) + ["incoming_rate", "stock_value_difference"], + ) self.assertEqual(flt(incoming_rate, 3), abs(flt(outgoing_rate, 3))) - stock_in_hand_account = get_inventory_account('_Test Company with perpetual inventory', si1.items[0].warehouse) + stock_in_hand_account = get_inventory_account( + "_Test Company with perpetual inventory", si1.items[0].warehouse + ) # Check gl entry - gle_warehouse_amount = frappe.db.get_value("GL Entry", {"voucher_type": "Sales Invoice", - "voucher_no": si1.name, "account": stock_in_hand_account}, "debit") + gle_warehouse_amount = frappe.db.get_value( + "GL Entry", + {"voucher_type": "Sales Invoice", "voucher_no": si1.name, "account": stock_in_hand_account}, + "debit", + ) self.assertEqual(gle_warehouse_amount, stock_value_difference) - party_credited = frappe.db.get_value("GL Entry", {"voucher_type": "Sales Invoice", - "voucher_no": si1.name, "account": "Debtors - TCP1", "party": "_Test Customer"}, "credit") + party_credited = frappe.db.get_value( + "GL Entry", + { + "voucher_type": "Sales Invoice", + "voucher_no": si1.name, + "account": "Debtors - TCP1", + "party": "_Test Customer", + }, + "credit", + ) self.assertEqual(party_credited, 1000) @@ -1121,63 +1406,87 @@ class TestSalesInvoice(unittest.TestCase): def test_gle_made_when_asset_is_returned(self): create_asset_data() - pi = frappe.new_doc('Purchase Invoice') - pi.supplier = '_Test Supplier' - pi.append('items', { - 'item_code': 'Macbook Pro', - 'qty': 1 - }) + pi = frappe.new_doc("Purchase Invoice") + pi.supplier = "_Test Supplier" + pi.append("items", {"item_code": "Macbook Pro", "qty": 1}) pi.set_missing_values() asset = create_asset(item_code="Macbook Pro") si = create_sales_invoice(item_code="Macbook Pro", asset=asset.name, qty=1, rate=90000) - return_si = create_sales_invoice(is_return=1, return_against=si.name, item_code="Macbook Pro", asset=asset.name, qty=-1, rate=90000) + return_si = create_sales_invoice( + is_return=1, + return_against=si.name, + item_code="Macbook Pro", + asset=asset.name, + qty=-1, + rate=90000, + ) disposal_account = frappe.get_cached_value("Company", "_Test Company", "disposal_account") # Asset value is 100,000 but it was sold for 90,000, so there should be a loss of 10,000 loss_for_si = frappe.get_all( "GL Entry", - filters = { - "voucher_no": si.name, - "account": disposal_account - }, - fields = ["credit", "debit"] + filters={"voucher_no": si.name, "account": disposal_account}, + fields=["credit", "debit"], )[0] loss_for_return_si = frappe.get_all( "GL Entry", - filters = { - "voucher_no": return_si.name, - "account": disposal_account - }, - fields = ["credit", "debit"] + filters={"voucher_no": return_si.name, "account": disposal_account}, + fields=["credit", "debit"], )[0] - self.assertEqual(loss_for_si['credit'], loss_for_return_si['debit']) - self.assertEqual(loss_for_si['debit'], loss_for_return_si['credit']) + self.assertEqual(loss_for_si["credit"], loss_for_return_si["debit"]) + self.assertEqual(loss_for_si["debit"], loss_for_return_si["credit"]) def test_incoming_rate_for_stand_alone_credit_note(self): - return_si = create_sales_invoice(is_return=1, update_stock=1, qty=-1, rate=90000, incoming_rate=10, - company='_Test Company with perpetual inventory', warehouse='Stores - TCP1', debit_to='Debtors - TCP1', - income_account='Sales - TCP1', expense_account='Cost of Goods Sold - TCP1', cost_center='Main - TCP1') + return_si = create_sales_invoice( + is_return=1, + update_stock=1, + qty=-1, + rate=90000, + incoming_rate=10, + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + debit_to="Debtors - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + ) - incoming_rate = frappe.db.get_value('Stock Ledger Entry', {'voucher_no': return_si.name}, 'incoming_rate') - debit_amount = frappe.db.get_value('GL Entry', - {'voucher_no': return_si.name, 'account': 'Stock In Hand - TCP1'}, 'debit') + incoming_rate = frappe.db.get_value( + "Stock Ledger Entry", {"voucher_no": return_si.name}, "incoming_rate" + ) + debit_amount = frappe.db.get_value( + "GL Entry", {"voucher_no": return_si.name, "account": "Stock In Hand - TCP1"}, "debit" + ) self.assertEqual(debit_amount, 10.0) self.assertEqual(incoming_rate, 10.0) def test_incoming_rate_for_stand_alone_credit_note(self): - return_si = create_sales_invoice(is_return=1, update_stock=1, qty=-1, rate=90000, incoming_rate=10, - company='_Test Company with perpetual inventory', warehouse='Stores - TCP1', debit_to='Debtors - TCP1', - income_account='Sales - TCP1', expense_account='Cost of Goods Sold - TCP1', cost_center='Main - TCP1') + return_si = create_sales_invoice( + is_return=1, + update_stock=1, + qty=-1, + rate=90000, + incoming_rate=10, + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + debit_to="Debtors - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + ) - incoming_rate = frappe.db.get_value('Stock Ledger Entry', {'voucher_no': return_si.name}, 'incoming_rate') - debit_amount = frappe.db.get_value('GL Entry', - {'voucher_no': return_si.name, 'account': 'Stock In Hand - TCP1'}, 'debit') + incoming_rate = frappe.db.get_value( + "Stock Ledger Entry", {"voucher_no": return_si.name}, "incoming_rate" + ) + debit_amount = frappe.db.get_value( + "GL Entry", {"voucher_no": return_si.name, "account": "Stock In Hand - TCP1"}, "debit" + ) self.assertEqual(debit_amount, 10.0) self.assertEqual(incoming_rate, 10.0) @@ -1189,16 +1498,25 @@ class TestSalesInvoice(unittest.TestCase): si.insert() expected_values = { - "keys": ["price_list_rate", "discount_percentage", "rate", "amount", - "base_price_list_rate", "base_rate", "base_amount", - "net_rate", "base_net_rate", "net_amount", "base_net_amount"], + "keys": [ + "price_list_rate", + "discount_percentage", + "rate", + "amount", + "base_price_list_rate", + "base_rate", + "base_amount", + "net_rate", + "base_net_rate", + "net_amount", + "base_net_amount", + ], "_Test Item Home Desktop 100": [50, 0, 50, 500, 50, 50, 500, 25, 25, 250, 250], "_Test Item Home Desktop 200": [150, 0, 150, 750, 150, 150, 750, 75, 75, 375, 375], } # check if children are saved - self.assertEqual(len(si.get("items")), - len(expected_values)-1) + self.assertEqual(len(si.get("items")), len(expected_values) - 1) # check if item values are calculated for d in si.get("items"): @@ -1213,16 +1531,19 @@ class TestSalesInvoice(unittest.TestCase): # check tax calculation expected_values = { - "keys": ["tax_amount", "tax_amount_after_discount_amount", - "base_tax_amount_after_discount_amount"], + "keys": [ + "tax_amount", + "tax_amount_after_discount_amount", + "base_tax_amount_after_discount_amount", + ], "_Test Account Shipping Charges - _TC": [100, 100, 100], "_Test Account Customs Duty - _TC": [62.5, 62.5, 62.5], "_Test Account Excise Duty - _TC": [70, 70, 70], "_Test Account Education Cess - _TC": [1.4, 1.4, 1.4], - "_Test Account S&H Education Cess - _TC": [.7, 0.7, 0.7], + "_Test Account S&H Education Cess - _TC": [0.7, 0.7, 0.7], "_Test Account CST - _TC": [17.19, 17.19, 17.19], "_Test Account VAT - _TC": [78.13, 78.13, 78.13], - "_Test Account Discount - _TC": [-95.49, -95.49, -95.49] + "_Test Account Discount - _TC": [-95.49, -95.49, -95.49], } for d in si.get("taxes"): @@ -1230,19 +1551,26 @@ class TestSalesInvoice(unittest.TestCase): if expected_values.get(d.account_head): self.assertEqual(d.get(k), expected_values[d.account_head][i]) - self.assertEqual(si.total_taxes_and_charges, 234.43) self.assertEqual(si.base_grand_total, 859.43) self.assertEqual(si.grand_total, 859.43) def test_multi_currency_gle(self): - si = create_sales_invoice(customer="_Test Customer USD", debit_to="_Test Receivable USD - _TC", - currency="USD", conversion_rate=50) + si = create_sales_invoice( + customer="_Test Customer USD", + debit_to="_Test Receivable USD - _TC", + currency="USD", + conversion_rate=50, + ) - gl_entries = frappe.db.sql("""select account, account_currency, debit, credit, + gl_entries = frappe.db.sql( + """select account, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) self.assertTrue(gl_entries) @@ -1252,59 +1580,99 @@ class TestSalesInvoice(unittest.TestCase): "debit": 5000, "debit_in_account_currency": 100, "credit": 0, - "credit_in_account_currency": 0 + "credit_in_account_currency": 0, }, "Sales - _TC": { "account_currency": "INR", "debit": 0, "debit_in_account_currency": 0, "credit": 5000, - "credit_in_account_currency": 5000 - } + "credit_in_account_currency": 5000, + }, } - for field in ("account_currency", "debit", "debit_in_account_currency", "credit", "credit_in_account_currency"): + for field in ( + "account_currency", + "debit", + "debit_in_account_currency", + "credit", + "credit_in_account_currency", + ): for i, gle in enumerate(gl_entries): self.assertEqual(expected_values[gle.account][field], gle[field]) # cancel si.cancel() - gle = frappe.db.sql("""select name from `tabGL Entry` - where voucher_type='Sales Invoice' and voucher_no=%s""", si.name) + gle = frappe.db.sql( + """select name from `tabGL Entry` + where voucher_type='Sales Invoice' and voucher_no=%s""", + si.name, + ) self.assertTrue(gle) + def test_invoice_exchange_rate(self): + si = create_sales_invoice( + customer="_Test Customer USD", + debit_to="_Test Receivable USD - _TC", + currency="USD", + conversion_rate=1, + do_not_save=1, + ) + + self.assertRaises(frappe.ValidationError, si.save) + def test_invalid_currency(self): # Customer currency = USD # Transaction currency cannot be INR - si1 = create_sales_invoice(customer="_Test Customer USD", debit_to="_Test Receivable USD - _TC", - do_not_save=True) + si1 = create_sales_invoice( + customer="_Test Customer USD", debit_to="_Test Receivable USD - _TC", do_not_save=True + ) self.assertRaises(InvalidCurrency, si1.save) # Transaction currency cannot be EUR - si2 = create_sales_invoice(customer="_Test Customer USD", debit_to="_Test Receivable USD - _TC", - currency="EUR", conversion_rate=80, do_not_save=True) + si2 = create_sales_invoice( + customer="_Test Customer USD", + debit_to="_Test Receivable USD - _TC", + currency="EUR", + conversion_rate=80, + do_not_save=True, + ) self.assertRaises(InvalidCurrency, si2.save) # Transaction currency only allowed in USD - si3 = create_sales_invoice(customer="_Test Customer USD", debit_to="_Test Receivable USD - _TC", - currency="USD", conversion_rate=50) + si3 = create_sales_invoice( + customer="_Test Customer USD", + debit_to="_Test Receivable USD - _TC", + currency="USD", + conversion_rate=50, + ) # Party Account currency must be in USD, as there is existing GLE with USD - si4 = create_sales_invoice(customer="_Test Customer USD", debit_to="_Test Receivable - _TC", - currency="USD", conversion_rate=50, do_not_submit=True) + si4 = create_sales_invoice( + customer="_Test Customer USD", + debit_to="_Test Receivable - _TC", + currency="USD", + conversion_rate=50, + do_not_submit=True, + ) self.assertRaises(InvalidAccountCurrency, si4.submit) # Party Account currency must be in USD, force customer currency as there is no GLE si3.cancel() - si5 = create_sales_invoice(customer="_Test Customer USD", debit_to="_Test Receivable - _TC", - currency="USD", conversion_rate=50, do_not_submit=True) + si5 = create_sales_invoice( + customer="_Test Customer USD", + debit_to="_Test Receivable - _TC", + currency="USD", + conversion_rate=50, + do_not_submit=True, + ) self.assertRaises(InvalidAccountCurrency, si5.submit) @@ -1312,12 +1680,12 @@ class TestSalesInvoice(unittest.TestCase): si = create_sales_invoice(item_code="_Test Item", qty=1, do_not_submit=True) price_list_rate = flt(100) * flt(si.plc_conversion_rate) si.items[0].price_list_rate = price_list_rate - si.items[0].margin_type = 'Percentage' + si.items[0].margin_type = "Percentage" si.items[0].margin_rate_or_amount = 25 si.items[0].discount_amount = 0.0 si.items[0].discount_percentage = 0.0 si.save() - self.assertEqual(si.get("items")[0].rate, flt((price_list_rate*25)/100 + price_list_rate)) + self.assertEqual(si.get("items")[0].rate, flt((price_list_rate * 25) / 100 + price_list_rate)) def test_outstanding_amount_after_advance_jv_cancelation(self): from erpnext.accounts.doctype.journal_entry.test_journal_entry import ( @@ -1325,89 +1693,107 @@ class TestSalesInvoice(unittest.TestCase): ) jv = frappe.copy_doc(jv_test_records[0]) - jv.accounts[0].is_advance = 'Yes' + jv.accounts[0].is_advance = "Yes" jv.insert() jv.submit() si = frappe.copy_doc(test_records[0]) - si.append("advances", { - "doctype": "Sales Invoice Advance", - "reference_type": "Journal Entry", - "reference_name": jv.name, - "reference_row": jv.get("accounts")[0].name, - "advance_amount": 400, - "allocated_amount": 300, - "remarks": jv.remark - }) + si.append( + "advances", + { + "doctype": "Sales Invoice Advance", + "reference_type": "Journal Entry", + "reference_name": jv.name, + "reference_row": jv.get("accounts")[0].name, + "advance_amount": 400, + "allocated_amount": 300, + "remarks": jv.remark, + }, + ) si.insert() si.submit() si.load_from_db() - #check outstanding after advance allocation - self.assertEqual(flt(si.outstanding_amount), - flt(si.rounded_total - si.total_advance, si.precision("outstanding_amount"))) + # check outstanding after advance allocation + self.assertEqual( + flt(si.outstanding_amount), + flt(si.rounded_total - si.total_advance, si.precision("outstanding_amount")), + ) - #added to avoid Document has been modified exception + # added to avoid Document has been modified exception jv = frappe.get_doc("Journal Entry", jv.name) jv.cancel() si.load_from_db() - #check outstanding after advance cancellation - self.assertEqual(flt(si.outstanding_amount), - flt(si.rounded_total + si.total_advance, si.precision("outstanding_amount"))) + # check outstanding after advance cancellation + self.assertEqual( + flt(si.outstanding_amount), + flt(si.rounded_total + si.total_advance, si.precision("outstanding_amount")), + ) def test_outstanding_amount_after_advance_payment_entry_cancelation(self): - pe = frappe.get_doc({ - "doctype": "Payment Entry", - "payment_type": "Receive", - "party_type": "Customer", - "party": "_Test Customer", - "company": "_Test Company", - "paid_from_account_currency": "INR", - "paid_to_account_currency": "INR", - "source_exchange_rate": 1, - "target_exchange_rate": 1, - "reference_no": "1", - "reference_date": nowdate(), - "received_amount": 300, - "paid_amount": 300, - "paid_from": "_Test Receivable - _TC", - "paid_to": "_Test Cash - _TC" - }) + pe = frappe.get_doc( + { + "doctype": "Payment Entry", + "payment_type": "Receive", + "party_type": "Customer", + "party": "_Test Customer", + "company": "_Test Company", + "paid_from_account_currency": "INR", + "paid_to_account_currency": "INR", + "source_exchange_rate": 1, + "target_exchange_rate": 1, + "reference_no": "1", + "reference_date": nowdate(), + "received_amount": 300, + "paid_amount": 300, + "paid_from": "_Test Receivable - _TC", + "paid_to": "_Test Cash - _TC", + } + ) pe.insert() pe.submit() si = frappe.copy_doc(test_records[0]) si.is_pos = 0 - si.append("advances", { - "doctype": "Sales Invoice Advance", - "reference_type": "Payment Entry", - "reference_name": pe.name, - "advance_amount": 300, - "allocated_amount": 300, - "remarks": pe.remarks - }) + si.append( + "advances", + { + "doctype": "Sales Invoice Advance", + "reference_type": "Payment Entry", + "reference_name": pe.name, + "advance_amount": 300, + "allocated_amount": 300, + "remarks": pe.remarks, + }, + ) si.insert() si.submit() si.load_from_db() - #check outstanding after advance allocation - self.assertEqual(flt(si.outstanding_amount), - flt(si.rounded_total - si.total_advance, si.precision("outstanding_amount"))) + # check outstanding after advance allocation + self.assertEqual( + flt(si.outstanding_amount), + flt(si.rounded_total - si.total_advance, si.precision("outstanding_amount")), + ) - #added to avoid Document has been modified exception + # added to avoid Document has been modified exception pe = frappe.get_doc("Payment Entry", pe.name) pe.cancel() si.load_from_db() - #check outstanding after advance cancellation - self.assertEqual(flt(si.outstanding_amount), - flt(si.rounded_total + si.total_advance, si.precision("outstanding_amount"))) + # check outstanding after advance cancellation + self.assertEqual( + flt(si.outstanding_amount), + flt(si.rounded_total + si.total_advance, si.precision("outstanding_amount")), + ) def test_multiple_uom_in_selling(self): - frappe.db.sql("""delete from `tabItem Price` - where price_list='_Test Price List' and item_code='_Test Item'""") + frappe.db.sql( + """delete from `tabItem Price` + where price_list='_Test Price List' and item_code='_Test Item'""" + ) item_price = frappe.new_doc("Item Price") item_price.price_list = "_Test Price List" item_price.item_code = "_Test Item" @@ -1421,9 +1807,18 @@ class TestSalesInvoice(unittest.TestCase): si.save() expected_values = { - "keys": ["price_list_rate", "stock_uom", "uom", "conversion_factor", "rate", "amount", - "base_price_list_rate", "base_rate", "base_amount"], - "_Test Item": [1000, "_Test UOM", "_Test UOM 1", 10.0, 1000, 1000, 1000, 1000, 1000] + "keys": [ + "price_list_rate", + "stock_uom", + "uom", + "conversion_factor", + "rate", + "amount", + "base_price_list_rate", + "base_rate", + "base_amount", + ], + "_Test Item": [1000, "_Test UOM", "_Test UOM 1", 10.0, 1000, 1000, 1000, 1000, 1000], } # check if the conversion_factor and price_list_rate is calculated according to uom @@ -1438,23 +1833,10 @@ class TestSalesInvoice(unittest.TestCase): itemised_tax, itemised_taxable_amount = get_itemised_tax_breakup_data(si) expected_itemised_tax = { - "_Test Item": { - "Service Tax": { - "tax_rate": 10.0, - "tax_amount": 1000.0 - } - }, - "_Test Item 2": { - "Service Tax": { - "tax_rate": 10.0, - "tax_amount": 500.0 - } - } - } - expected_itemised_taxable_amount = { - "_Test Item": 10000.0, - "_Test Item 2": 5000.0 + "_Test Item": {"Service Tax": {"tax_rate": 10.0, "tax_amount": 1000.0}}, + "_Test Item 2": {"Service Tax": {"tax_rate": 10.0, "tax_amount": 500.0}}, } + expected_itemised_taxable_amount = {"_Test Item": 10000.0, "_Test Item 2": 5000.0} self.assertEqual(itemised_tax, expected_itemised_tax) self.assertEqual(itemised_taxable_amount, expected_itemised_taxable_amount) @@ -1469,23 +1851,10 @@ class TestSalesInvoice(unittest.TestCase): itemised_tax, itemised_taxable_amount = get_itemised_tax_breakup_data(si) expected_itemised_tax = { - "_Test Item": { - "Service Tax": { - "tax_rate": 10.0, - "tax_amount": 1000.0 - } - }, - "_Test Item 2": { - "Service Tax": { - "tax_rate": 10.0, - "tax_amount": 500.0 - } - } - } - expected_itemised_taxable_amount = { - "_Test Item": 10000.0, - "_Test Item 2": 5000.0 + "_Test Item": {"Service Tax": {"tax_rate": 10.0, "tax_amount": 1000.0}}, + "_Test Item 2": {"Service Tax": {"tax_rate": 10.0, "tax_amount": 500.0}}, } + expected_itemised_taxable_amount = {"_Test Item": 10000.0, "_Test Item 2": 5000.0} self.assertEqual(itemised_tax, expected_itemised_tax) self.assertEqual(itemised_taxable_amount, expected_itemised_taxable_amount) @@ -1494,59 +1863,73 @@ class TestSalesInvoice(unittest.TestCase): def create_si_to_test_tax_breakup(self): si = create_sales_invoice(qty=100, rate=50, do_not_save=True) - si.append("items", { - "item_code": "_Test Item", - "gst_hsn_code": "999800", - "warehouse": "_Test Warehouse - _TC", - "qty": 100, - "rate": 50, - "income_account": "Sales - _TC", - "expense_account": "Cost of Goods Sold - _TC", - "cost_center": "_Test Cost Center - _TC" - }) - si.append("items", { - "item_code": "_Test Item 2", - "gst_hsn_code": "999800", - "warehouse": "_Test Warehouse - _TC", - "qty": 100, - "rate": 50, - "income_account": "Sales - _TC", - "expense_account": "Cost of Goods Sold - _TC", - "cost_center": "_Test Cost Center - _TC" - }) + si.append( + "items", + { + "item_code": "_Test Item", + "gst_hsn_code": "999800", + "warehouse": "_Test Warehouse - _TC", + "qty": 100, + "rate": 50, + "income_account": "Sales - _TC", + "expense_account": "Cost of Goods Sold - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ) + si.append( + "items", + { + "item_code": "_Test Item 2", + "gst_hsn_code": "999800", + "warehouse": "_Test Warehouse - _TC", + "qty": 100, + "rate": 50, + "income_account": "Sales - _TC", + "expense_account": "Cost of Goods Sold - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ) - si.append("taxes", { - "charge_type": "On Net Total", - "account_head": "_Test Account Service Tax - _TC", - "cost_center": "_Test Cost Center - _TC", - "description": "Service Tax", - "rate": 10 - }) + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": "_Test Account Service Tax - _TC", + "cost_center": "_Test Cost Center - _TC", + "description": "Service Tax", + "rate": 10, + }, + ) si.insert() return si def test_company_monthly_sales(self): - existing_current_month_sales = frappe.get_cached_value('Company', "_Test Company", "total_monthly_sales") + existing_current_month_sales = frappe.get_cached_value( + "Company", "_Test Company", "total_monthly_sales" + ) si = create_sales_invoice() - current_month_sales = frappe.get_cached_value('Company', "_Test Company", "total_monthly_sales") + current_month_sales = frappe.get_cached_value("Company", "_Test Company", "total_monthly_sales") self.assertEqual(current_month_sales, existing_current_month_sales + si.base_grand_total) si.cancel() - current_month_sales = frappe.get_cached_value('Company', "_Test Company", "total_monthly_sales") + current_month_sales = frappe.get_cached_value("Company", "_Test Company", "total_monthly_sales") self.assertEqual(current_month_sales, existing_current_month_sales) def test_rounding_adjustment(self): si = create_sales_invoice(rate=24900, do_not_save=True) for tax in ["Tax 1", "Tax2"]: - si.append("taxes", { - "charge_type": "On Net Total", - "account_head": "_Test Account Service Tax - _TC", - "description": tax, - "rate": 14, - "cost_center": "_Test Cost Center - _TC", - "included_in_print_rate": 1 - }) + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": "_Test Account Service Tax - _TC", + "description": tax, + "rate": 14, + "cost_center": "_Test Cost Center - _TC", + "included_in_print_rate": 1, + }, + ) si.save() si.submit() self.assertEqual(si.net_total, 19453.13) @@ -1554,16 +1937,23 @@ class TestSalesInvoice(unittest.TestCase): self.assertEqual(si.total_taxes_and_charges, 5446.88) self.assertEqual(si.rounding_adjustment, -0.01) - expected_values = dict((d[0], d) for d in [ - [si.debit_to, 24900, 0.0], - ["_Test Account Service Tax - _TC", 0.0, 5446.88], - ["Sales - _TC", 0.0, 19453.13], - ["Round Off - _TC", 0.01, 0.0] - ]) + expected_values = dict( + (d[0], d) + for d in [ + [si.debit_to, 24900, 0.0], + ["_Test Account Service Tax - _TC", 0.0, 5446.88], + ["Sales - _TC", 0.0, 19453.13], + ["Round Off - _TC", 0.01, 0.0], + ] + ) - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) for gle in gl_entries: self.assertEqual(expected_values[gle.account][0], gle.account) @@ -1573,24 +1963,30 @@ class TestSalesInvoice(unittest.TestCase): def test_rounding_adjustment_2(self): si = create_sales_invoice(rate=400, do_not_save=True) for rate in [400, 600, 100]: - si.append("items", { - "item_code": "_Test Item", - "gst_hsn_code": "999800", - "warehouse": "_Test Warehouse - _TC", - "qty": 1, - "rate": rate, - "income_account": "Sales - _TC", - "cost_center": "_Test Cost Center - _TC" - }) + si.append( + "items", + { + "item_code": "_Test Item", + "gst_hsn_code": "999800", + "warehouse": "_Test Warehouse - _TC", + "qty": 1, + "rate": rate, + "income_account": "Sales - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ) for tax_account in ["_Test Account VAT - _TC", "_Test Account Service Tax - _TC"]: - si.append("taxes", { - "charge_type": "On Net Total", - "account_head": tax_account, - "description": tax_account, - "rate": 9, - "cost_center": "_Test Cost Center - _TC", - "included_in_print_rate": 1 - }) + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": tax_account, + "description": tax_account, + "rate": 9, + "cost_center": "_Test Cost Center - _TC", + "included_in_print_rate": 1, + }, + ) si.save() si.submit() self.assertEqual(si.net_total, 1271.19) @@ -1598,26 +1994,121 @@ class TestSalesInvoice(unittest.TestCase): self.assertEqual(si.total_taxes_and_charges, 228.82) self.assertEqual(si.rounding_adjustment, -0.01) - expected_values = dict((d[0], d) for d in [ - [si.debit_to, 1500, 0.0], - ["_Test Account Service Tax - _TC", 0.0, 114.41], - ["_Test Account VAT - _TC", 0.0, 114.41], - ["Sales - _TC", 0.0, 1271.18] - ]) + expected_values = dict( + (d[0], d) + for d in [ + [si.debit_to, 1500, 0.0], + ["_Test Account Service Tax - _TC", 0.0, 114.41], + ["_Test Account VAT - _TC", 0.0, 114.41], + ["Sales - _TC", 0.0, 1271.18], + ] + ) - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) for gle in gl_entries: self.assertEqual(expected_values[gle.account][0], gle.account) self.assertEqual(expected_values[gle.account][1], gle.debit) self.assertEqual(expected_values[gle.account][2], gle.credit) + def test_rounding_adjustment_3(self): + from erpnext.accounts.doctype.accounting_dimension.test_accounting_dimension import ( + create_dimension, + disable_dimension, + ) + + create_dimension() + + si = create_sales_invoice(do_not_save=True) + si.items = [] + for d in [(1122, 2), (1122.01, 1), (1122.01, 1)]: + si.append( + "items", + { + "item_code": "_Test Item", + "gst_hsn_code": "999800", + "warehouse": "_Test Warehouse - _TC", + "qty": d[1], + "rate": d[0], + "income_account": "Sales - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ) + for tax_account in ["_Test Account VAT - _TC", "_Test Account Service Tax - _TC"]: + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": tax_account, + "description": tax_account, + "rate": 6, + "cost_center": "_Test Cost Center - _TC", + "included_in_print_rate": 1, + }, + ) + + si.cost_center = "_Test Cost Center 2 - _TC" + si.location = "Block 1" + + si.save() + si.submit() + self.assertEqual(si.net_total, 4007.16) + self.assertEqual(si.grand_total, 4488.02) + self.assertEqual(si.total_taxes_and_charges, 480.86) + self.assertEqual(si.rounding_adjustment, -0.02) + + expected_values = dict( + (d[0], d) + for d in [ + [si.debit_to, 4488.0, 0.0], + ["_Test Account Service Tax - _TC", 0.0, 240.43], + ["_Test Account VAT - _TC", 0.0, 240.43], + ["Sales - _TC", 0.0, 4007.15], + ["Round Off - _TC", 0.01, 0], + ] + ) + + gl_entries = frappe.db.sql( + """select account, debit, credit + from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s + order by account asc""", + si.name, + as_dict=1, + ) + + debit_credit_diff = 0 + for gle in gl_entries: + self.assertEqual(expected_values[gle.account][0], gle.account) + self.assertEqual(expected_values[gle.account][1], gle.debit) + self.assertEqual(expected_values[gle.account][2], gle.credit) + debit_credit_diff += gle.debit - gle.credit + + self.assertEqual(debit_credit_diff, 0) + + round_off_gle = frappe.db.get_value( + "GL Entry", + {"voucher_type": "Sales Invoice", "voucher_no": si.name, "account": "Round Off - _TC"}, + ["cost_center", "location"], + as_dict=1, + ) + + self.assertEqual(round_off_gle.cost_center, "_Test Cost Center 2 - _TC") + self.assertEqual(round_off_gle.location, "Block 1") + + disable_dimension() + def test_sales_invoice_with_shipping_rule(self): from erpnext.accounts.doctype.shipping_rule.test_shipping_rule import create_shipping_rule - shipping_rule = create_shipping_rule(shipping_rule_type = "Selling", shipping_rule_name = "Shipping Rule - Sales Invoice Test") + shipping_rule = create_shipping_rule( + shipping_rule_type="Selling", shipping_rule_name="Shipping Rule - Sales Invoice Test" + ) si = frappe.copy_doc(test_records[2]) @@ -1630,29 +2121,32 @@ class TestSalesInvoice(unittest.TestCase): self.assertEqual(si.total_taxes_and_charges, 468.85) self.assertEqual(si.grand_total, 1718.85) - - def test_create_invoice_without_terms(self): si = create_sales_invoice(do_not_save=1) - self.assertFalse(si.get('payment_schedule')) + self.assertFalse(si.get("payment_schedule")) si.insert() - self.assertTrue(si.get('payment_schedule')) + self.assertTrue(si.get("payment_schedule")) def test_duplicate_due_date_in_terms(self): si = create_sales_invoice(do_not_save=1) - si.append('payment_schedule', dict(due_date='2017-01-01', invoice_portion=50.00, payment_amount=50)) - si.append('payment_schedule', dict(due_date='2017-01-01', invoice_portion=50.00, payment_amount=50)) + si.append( + "payment_schedule", dict(due_date="2017-01-01", invoice_portion=50.00, payment_amount=50) + ) + si.append( + "payment_schedule", dict(due_date="2017-01-01", invoice_portion=50.00, payment_amount=50) + ) self.assertRaises(frappe.ValidationError, si.insert) def test_credit_note(self): from erpnext.accounts.doctype.payment_entry.test_payment_entry import get_payment_entry - si = create_sales_invoice(item_code = "_Test Item", qty = (5 * -1), rate=500, is_return = 1) + si = create_sales_invoice(item_code="_Test Item", qty=(5 * -1), rate=500, is_return=1) - outstanding_amount = get_outstanding_amount(si.doctype, - si.name, "Debtors - _TC", si.customer, "Customer") + outstanding_amount = get_outstanding_amount( + si.doctype, si.name, "Debtors - _TC", si.customer, "Customer" + ) self.assertEqual(si.outstanding_amount, outstanding_amount) @@ -1667,30 +2161,31 @@ class TestSalesInvoice(unittest.TestCase): pe.insert() pe.submit() - si_doc = frappe.get_doc('Sales Invoice', si.name) + si_doc = frappe.get_doc("Sales Invoice", si.name) self.assertEqual(si_doc.outstanding_amount, 0) def test_sales_invoice_with_cost_center(self): from erpnext.accounts.doctype.cost_center.test_cost_center import create_cost_center + cost_center = "_Test Cost Center for BS Account - _TC" create_cost_center(cost_center_name="_Test Cost Center for BS Account", company="_Test Company") - si = create_sales_invoice_against_cost_center(cost_center=cost_center, debit_to="Debtors - _TC") + si = create_sales_invoice_against_cost_center(cost_center=cost_center, debit_to="Debtors - _TC") self.assertEqual(si.cost_center, cost_center) expected_values = { - "Debtors - _TC": { - "cost_center": cost_center - }, - "Sales - _TC": { - "cost_center": cost_center - } + "Debtors - _TC": {"cost_center": cost_center}, + "Sales - _TC": {"cost_center": cost_center}, } - gl_entries = frappe.db.sql("""select account, cost_center, account_currency, debit, credit, + gl_entries = frappe.db.sql( + """select account, cost_center, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) self.assertTrue(gl_entries) @@ -1700,16 +2195,20 @@ class TestSalesInvoice(unittest.TestCase): def test_sales_invoice_with_project_link(self): from erpnext.projects.doctype.project.test_project import make_project - project = make_project({ - 'project_name': 'Sales Invoice Project', - 'project_template_name': 'Test Project Template', - 'start_date': '2020-01-01' - }) - item_project = make_project({ - 'project_name': 'Sales Invoice Item Project', - 'project_template_name': 'Test Project Template', - 'start_date': '2019-06-01' - }) + project = make_project( + { + "project_name": "Sales Invoice Project", + "project_template_name": "Test Project Template", + "start_date": "2020-01-01", + } + ) + item_project = make_project( + { + "project_name": "Sales Invoice Item Project", + "project_template_name": "Test Project Template", + "start_date": "2019-06-01", + } + ) sales_invoice = create_sales_invoice(do_not_save=1) sales_invoice.items[0].project = item_project.name @@ -1718,18 +2217,18 @@ class TestSalesInvoice(unittest.TestCase): sales_invoice.submit() expected_values = { - "Debtors - _TC": { - "project": project.name - }, - "Sales - _TC": { - "project": item_project.name - } + "Debtors - _TC": {"project": project.name}, + "Sales - _TC": {"project": item_project.name}, } - gl_entries = frappe.db.sql("""select account, cost_center, project, account_currency, debit, credit, + gl_entries = frappe.db.sql( + """select account, cost_center, project, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", sales_invoice.name, as_dict=1) + order by account asc""", + sales_invoice.name, + as_dict=1, + ) self.assertTrue(gl_entries) @@ -1738,21 +2237,21 @@ class TestSalesInvoice(unittest.TestCase): def test_sales_invoice_without_cost_center(self): cost_center = "_Test Cost Center - _TC" - si = create_sales_invoice(debit_to="Debtors - _TC") + si = create_sales_invoice(debit_to="Debtors - _TC") expected_values = { - "Debtors - _TC": { - "cost_center": None - }, - "Sales - _TC": { - "cost_center": cost_center - } + "Debtors - _TC": {"cost_center": None}, + "Sales - _TC": {"cost_center": cost_center}, } - gl_entries = frappe.db.sql("""select account, cost_center, account_currency, debit, credit, + gl_entries = frappe.db.sql( + """select account, cost_center, account_currency, debit, credit, debit_in_account_currency, credit_in_account_currency from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s - order by account asc""", si.name, as_dict=1) + order by account asc""", + si.name, + as_dict=1, + ) self.assertTrue(gl_entries) @@ -1760,8 +2259,11 @@ class TestSalesInvoice(unittest.TestCase): self.assertEqual(expected_values[gle.account]["cost_center"], gle.cost_center) def test_deferred_revenue(self): - deferred_account = create_account(account_name="Deferred Revenue", - parent_account="Current Liabilities - _TC", company="_Test Company") + deferred_account = create_account( + account_name="Deferred Revenue", + parent_account="Current Liabilities - _TC", + company="_Test Company", + ) item = create_item("_Test Item for Deferred Accounting") item.enable_deferred_revenue = 1 @@ -1777,14 +2279,16 @@ class TestSalesInvoice(unittest.TestCase): si.save() si.submit() - pda1 = frappe.get_doc(dict( - doctype='Process Deferred Accounting', - posting_date=nowdate(), - start_date="2019-01-01", - end_date="2019-03-31", - type="Income", - company="_Test Company" - )) + pda1 = frappe.get_doc( + dict( + doctype="Process Deferred Accounting", + posting_date=nowdate(), + start_date="2019-01-01", + end_date="2019-03-31", + type="Income", + company="_Test Company", + ) + ) pda1.insert() pda1.submit() @@ -1795,58 +2299,28 @@ class TestSalesInvoice(unittest.TestCase): [deferred_account, 43.08, 0.0, "2019-02-28"], ["Sales - _TC", 0.0, 43.08, "2019-02-28"], [deferred_account, 23.07, 0.0, "2019-03-15"], - ["Sales - _TC", 0.0, 23.07, "2019-03-15"] + ["Sales - _TC", 0.0, 23.07, "2019-03-15"], ] check_gl_entries(self, si.name, expected_gle, "2019-01-30") - def test_deferred_revenue_post_account_freeze_upto_by_admin(self): - frappe.set_user("Administrator") - - frappe.db.set_value('Accounts Settings', None, 'acc_frozen_upto', None) - frappe.db.set_value('Accounts Settings', None, 'frozen_accounts_modifier', None) - - deferred_account = create_account(account_name="Deferred Revenue", - parent_account="Current Liabilities - _TC", company="_Test Company") - - item = create_item("_Test Item for Deferred Accounting") - item.enable_deferred_revenue = 1 - item.deferred_revenue_account = deferred_account - item.no_of_months = 12 - item.save() - - si = create_sales_invoice(item=item.name, posting_date="2019-01-10", do_not_save=True) + def test_deferred_revenue_missing_account(self): + si = create_sales_invoice(posting_date="2019-01-10", do_not_submit=True) si.items[0].enable_deferred_revenue = 1 si.items[0].service_start_date = "2019-01-10" si.items[0].service_end_date = "2019-03-15" - si.items[0].deferred_revenue_account = deferred_account - si.save() - si.submit() - frappe.db.set_value('Accounts Settings', None, 'acc_frozen_upto', getdate('2019-01-31')) - frappe.db.set_value('Accounts Settings', None, 'frozen_accounts_modifier', 'System Manager') - - pda1 = frappe.get_doc(dict( - doctype='Process Deferred Accounting', - posting_date=nowdate(), - start_date="2019-01-01", - end_date="2019-03-31", - type="Income", - company="_Test Company" - )) - - pda1.insert() - self.assertRaises(frappe.ValidationError, pda1.submit) - - frappe.db.set_value('Accounts Settings', None, 'acc_frozen_upto', None) - frappe.db.set_value('Accounts Settings', None, 'frozen_accounts_modifier', None) + self.assertRaises(frappe.ValidationError, si.save) def test_fixed_deferred_revenue(self): - deferred_account = create_account(account_name="Deferred Revenue", - parent_account="Current Liabilities - _TC", company="_Test Company") + deferred_account = create_account( + account_name="Deferred Revenue", + parent_account="Current Liabilities - _TC", + company="_Test Company", + ) - acc_settings = frappe.get_doc('Accounts Settings', 'Accounts Settings') - acc_settings.book_deferred_entries_based_on = 'Months' + acc_settings = frappe.get_doc("Accounts Settings", "Accounts Settings") + acc_settings.book_deferred_entries_based_on = "Months" acc_settings.save() item = create_item("_Test Item for Deferred Accounting") @@ -1855,7 +2329,9 @@ class TestSalesInvoice(unittest.TestCase): item.no_of_months = 12 item.save() - si = create_sales_invoice(item=item.name, posting_date="2019-01-16", rate=50000, do_not_submit=True) + si = create_sales_invoice( + item=item.name, posting_date="2019-01-16", rate=50000, do_not_submit=True + ) si.items[0].enable_deferred_revenue = 1 si.items[0].service_start_date = "2019-01-16" si.items[0].service_end_date = "2019-03-31" @@ -1863,14 +2339,16 @@ class TestSalesInvoice(unittest.TestCase): si.save() si.submit() - pda1 = frappe.get_doc(dict( - doctype='Process Deferred Accounting', - posting_date='2019-03-31', - start_date="2019-01-01", - end_date="2019-03-31", - type="Income", - company="_Test Company" - )) + pda1 = frappe.get_doc( + dict( + doctype="Process Deferred Accounting", + posting_date="2019-03-31", + start_date="2019-01-01", + end_date="2019-03-31", + type="Income", + company="_Test Company", + ) + ) pda1.insert() pda1.submit() @@ -1881,13 +2359,13 @@ class TestSalesInvoice(unittest.TestCase): [deferred_account, 20000.0, 0.0, "2019-02-28"], ["Sales - _TC", 0.0, 20000.0, "2019-02-28"], [deferred_account, 20000.0, 0.0, "2019-03-31"], - ["Sales - _TC", 0.0, 20000.0, "2019-03-31"] + ["Sales - _TC", 0.0, 20000.0, "2019-03-31"], ] check_gl_entries(self, si.name, expected_gle, "2019-01-30") - acc_settings = frappe.get_doc('Accounts Settings', 'Accounts Settings') - acc_settings.book_deferred_entries_based_on = 'Days' + acc_settings = frappe.get_doc("Accounts Settings", "Accounts Settings") + acc_settings.book_deferred_entries_based_on = "Days" acc_settings.save() def test_inter_company_transaction(self): @@ -1896,45 +2374,47 @@ class TestSalesInvoice(unittest.TestCase): create_internal_customer( customer_name="_Test Internal Customer", represents_company="_Test Company 1", - allowed_to_interact_with="Wind Power LLC" + allowed_to_interact_with="Wind Power LLC", ) if not frappe.db.exists("Supplier", "_Test Internal Supplier"): - supplier = frappe.get_doc({ - "supplier_group": "_Test Supplier Group", - "supplier_name": "_Test Internal Supplier", - "doctype": "Supplier", - "is_internal_supplier": 1, - "represents_company": "Wind Power LLC" - }) + supplier = frappe.get_doc( + { + "supplier_group": "_Test Supplier Group", + "supplier_name": "_Test Internal Supplier", + "doctype": "Supplier", + "is_internal_supplier": 1, + "represents_company": "Wind Power LLC", + } + ) - supplier.append("companies", { - "company": "_Test Company 1" - }) + supplier.append("companies", {"company": "_Test Company 1"}) supplier.insert() si = create_sales_invoice( - company = "Wind Power LLC", - customer = "_Test Internal Customer", - debit_to = "Debtors - WP", - warehouse = "Stores - WP", - income_account = "Sales - WP", - expense_account = "Cost of Goods Sold - WP", - cost_center = "Main - WP", - currency = "USD", - do_not_save = 1 + company="Wind Power LLC", + customer="_Test Internal Customer", + debit_to="Debtors - WP", + warehouse="Stores - WP", + income_account="Sales - WP", + expense_account="Cost of Goods Sold - WP", + cost_center="Main - WP", + currency="USD", + do_not_save=1, ) si.selling_price_list = "_Test Price List Rest of the World" si.submit() target_doc = make_inter_company_transaction("Sales Invoice", si.name) - target_doc.items[0].update({ - "expense_account": "Cost of Goods Sold - _TC1", - "cost_center": "Main - _TC1", - "warehouse": "Stores - _TC1" - }) + target_doc.items[0].update( + { + "expense_account": "Cost of Goods Sold - _TC1", + "cost_center": "Main - _TC1", + "warehouse": "Stores - _TC1", + } + ) target_doc.submit() self.assertEqual(target_doc.company, "_Test Company 1") @@ -1944,9 +2424,9 @@ class TestSalesInvoice(unittest.TestCase): se = make_stock_entry( item_code="138-CMS Shoe", target="Finished Goods - _TC", - company = "_Test Company", + company="_Test Company", qty=1, - basic_rate=500 + basic_rate=500, ) si = frappe.copy_doc(test_records[0]) @@ -1958,8 +2438,9 @@ class TestSalesInvoice(unittest.TestCase): si.insert() si.submit() - sles = frappe.get_all("Stock Ledger Entry", filters={"voucher_no": si.name}, - fields=["name", "actual_qty"]) + sles = frappe.get_all( + "Stock Ledger Entry", filters={"voucher_no": si.name}, fields=["name", "actual_qty"] + ) # check if both SLEs are created self.assertEqual(len(sles), 2) @@ -1973,82 +2454,92 @@ class TestSalesInvoice(unittest.TestCase): ## Create internal transfer account from erpnext.selling.doctype.customer.test_customer import create_internal_customer - account = create_account(account_name="Unrealized Profit", - parent_account="Current Liabilities - TCP1", company="_Test Company with perpetual inventory") + account = create_account( + account_name="Unrealized Profit", + parent_account="Current Liabilities - TCP1", + company="_Test Company with perpetual inventory", + ) - frappe.db.set_value('Company', '_Test Company with perpetual inventory', - 'unrealized_profit_loss_account', account) + frappe.db.set_value( + "Company", "_Test Company with perpetual inventory", "unrealized_profit_loss_account", account + ) - customer = create_internal_customer("_Test Internal Customer 2", "_Test Company with perpetual inventory", - "_Test Company with perpetual inventory") + customer = create_internal_customer( + "_Test Internal Customer 2", + "_Test Company with perpetual inventory", + "_Test Company with perpetual inventory", + ) - create_internal_supplier("_Test Internal Supplier 2", "_Test Company with perpetual inventory", - "_Test Company with perpetual inventory") + create_internal_supplier( + "_Test Internal Supplier 2", + "_Test Company with perpetual inventory", + "_Test Company with perpetual inventory", + ) si = create_sales_invoice( - company = "_Test Company with perpetual inventory", - customer = customer, - debit_to = "Debtors - TCP1", - warehouse = "Stores - TCP1", - income_account = "Sales - TCP1", - expense_account = "Cost of Goods Sold - TCP1", - cost_center = "Main - TCP1", - currency = "INR", - do_not_save = 1 + company="_Test Company with perpetual inventory", + customer=customer, + debit_to="Debtors - TCP1", + warehouse="Stores - TCP1", + income_account="Sales - TCP1", + expense_account="Cost of Goods Sold - TCP1", + cost_center="Main - TCP1", + currency="INR", + do_not_save=1, ) si.selling_price_list = "_Test Price List Rest of the World" si.update_stock = 1 - si.items[0].target_warehouse = 'Work In Progress - TCP1' + si.items[0].target_warehouse = "Work In Progress - TCP1" # Add stock to stores for succesful stock transfer make_stock_entry( - target="Stores - TCP1", - company = "_Test Company with perpetual inventory", - qty=1, - basic_rate=100 + target="Stores - TCP1", company="_Test Company with perpetual inventory", qty=1, basic_rate=100 ) add_taxes(si) si.save() rate = 0.0 - for d in si.get('items'): - rate = get_incoming_rate({ - "item_code": d.item_code, - "warehouse": d.warehouse, - "posting_date": si.posting_date, - "posting_time": si.posting_time, - "qty": -1 * flt(d.get('stock_qty')), - "serial_no": d.serial_no, - "company": si.company, - "voucher_type": 'Sales Invoice', - "voucher_no": si.name, - "allow_zero_valuation": d.get("allow_zero_valuation") - }, raise_error_if_no_rate=False) + for d in si.get("items"): + rate = get_incoming_rate( + { + "item_code": d.item_code, + "warehouse": d.warehouse, + "posting_date": si.posting_date, + "posting_time": si.posting_time, + "qty": -1 * flt(d.get("stock_qty")), + "serial_no": d.serial_no, + "company": si.company, + "voucher_type": "Sales Invoice", + "voucher_no": si.name, + "allow_zero_valuation": d.get("allow_zero_valuation"), + }, + raise_error_if_no_rate=False, + ) rate = flt(rate, 2) si.submit() target_doc = make_inter_company_transaction("Sales Invoice", si.name) - target_doc.company = '_Test Company with perpetual inventory' - target_doc.items[0].warehouse = 'Finished Goods - TCP1' + target_doc.company = "_Test Company with perpetual inventory" + target_doc.items[0].warehouse = "Finished Goods - TCP1" add_taxes(target_doc) target_doc.save() target_doc.submit() - tax_amount = flt(rate * (12/100), 2) + tax_amount = flt(rate * (12 / 100), 2) si_gl_entries = [ ["_Test Account Excise Duty - TCP1", 0.0, tax_amount, nowdate()], - ["Unrealized Profit - TCP1", tax_amount, 0.0, nowdate()] + ["Unrealized Profit - TCP1", tax_amount, 0.0, nowdate()], ] check_gl_entries(self, si.name, si_gl_entries, add_days(nowdate(), -1)) pi_gl_entries = [ - ["_Test Account Excise Duty - TCP1", tax_amount , 0.0, nowdate()], - ["Unrealized Profit - TCP1", 0.0, tax_amount, nowdate()] + ["_Test Account Excise Duty - TCP1", tax_amount, 0.0, nowdate()], + ["Unrealized Profit - TCP1", 0.0, tax_amount, nowdate()], ] # Sale and Purchase both should be at valuation rate @@ -2064,44 +2555,48 @@ class TestSalesInvoice(unittest.TestCase): data = get_ewb_data("Sales Invoice", [si.name]) - self.assertEqual(data['version'], '1.0.0421') - self.assertEqual(data['billLists'][0]['fromGstin'], '27AAECE4835E1ZR') - self.assertEqual(data['billLists'][0]['fromTrdName'], '_Test Company') - self.assertEqual(data['billLists'][0]['toTrdName'], '_Test Customer') - self.assertEqual(data['billLists'][0]['vehicleType'], 'R') - self.assertEqual(data['billLists'][0]['totalValue'], 60000) - self.assertEqual(data['billLists'][0]['cgstValue'], 5400) - self.assertEqual(data['billLists'][0]['sgstValue'], 5400) - self.assertEqual(data['billLists'][0]['vehicleNo'], 'KA12KA1234') - self.assertEqual(data['billLists'][0]['itemList'][0]['taxableAmount'], 60000) - self.assertEqual(data['billLists'][0]['actualFromStateCode'],7) - self.assertEqual(data['billLists'][0]['fromStateCode'],27) + self.assertEqual(data["version"], "1.0.0421") + self.assertEqual(data["billLists"][0]["fromGstin"], "27AAECE4835E1ZR") + self.assertEqual(data["billLists"][0]["fromTrdName"], "_Test Company") + self.assertEqual(data["billLists"][0]["toTrdName"], "_Test Customer") + self.assertEqual(data["billLists"][0]["vehicleType"], "R") + self.assertEqual(data["billLists"][0]["totalValue"], 60000) + self.assertEqual(data["billLists"][0]["cgstValue"], 5400) + self.assertEqual(data["billLists"][0]["sgstValue"], 5400) + self.assertEqual(data["billLists"][0]["vehicleNo"], "KA12KA1234") + self.assertEqual(data["billLists"][0]["itemList"][0]["taxableAmount"], 60000) + self.assertEqual(data["billLists"][0]["actualFromStateCode"], 7) + self.assertEqual(data["billLists"][0]["fromStateCode"], 27) def test_einvoice_submission_without_irn(self): # init - einvoice_settings = frappe.get_doc('E Invoice Settings') + einvoice_settings = frappe.get_doc("E Invoice Settings") einvoice_settings.enable = 1 einvoice_settings.applicable_from = nowdate() - einvoice_settings.append('credentials', { - 'company': '_Test Company', - 'gstin': '27AAECE4835E1ZR', - 'username': 'test', - 'password': 'test' - }) + einvoice_settings.append( + "credentials", + { + "company": "_Test Company", + "gstin": "27AAECE4835E1ZR", + "username": "test", + "password": "test", + }, + ) einvoice_settings.save() country = frappe.flags.country - frappe.flags.country = 'India' + frappe.flags.country = "India" si = make_sales_invoice_for_ewaybill() self.assertRaises(frappe.ValidationError, si.submit) - si.irn = 'test_irn' + si.irn = "test_irn" si.submit() # reset - einvoice_settings = frappe.get_doc('E Invoice Settings') + einvoice_settings = frappe.get_doc("E Invoice Settings") einvoice_settings.enable = 0 + einvoice_settings.save() frappe.flags.country = country def test_einvoice_json(self): @@ -2112,45 +2607,265 @@ class TestSalesInvoice(unittest.TestCase): si.save() einvoice = make_einvoice(si) - self.assertTrue(einvoice['EwbDtls']) + self.assertTrue(einvoice["EwbDtls"]) validate_totals(einvoice) - si.apply_discount_on = 'Net Total' + si.apply_discount_on = "Net Total" si.save() einvoice = make_einvoice(si) validate_totals(einvoice) - [d.set('included_in_print_rate', 1) for d in si.taxes] + [d.set("included_in_print_rate", 1) for d in si.taxes] si.save() einvoice = make_einvoice(si) validate_totals(einvoice) + def test_einvoice_discounts(self): + from erpnext.regional.india.e_invoice.utils import make_einvoice, validate_totals + + frappe.db.set_single_value("E Invoice Settings", "dont_show_discounts_in_e_invoice", False) + + # Normal Itemized Discount + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "" + si.items[0].price_list_rate = 12 + si.items[0].discount_percentage = 16.6666666667 + si.items[0].rate = 10 + + si.items[1].price_list_rate = 15 + si.items[1].discount_amount = 5 + si.items[1].rate = 10 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][0]["Discount"], 4000) + self.assertEqual(einvoice["ItemList"][1]["Discount"], 2100) + self.assertEqual(einvoice["ItemList"][2]["Discount"], 222) + self.assertEqual(einvoice["ItemList"][3]["Discount"], 5555) + self.assertEqual(einvoice["ValDtls"]["Discount"], 0) + + self.assertEqual(einvoice["ItemList"][0]["UnitPrice"], 12) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 15) + self.assertEqual(einvoice["ItemList"][2]["UnitPrice"], 20) + self.assertEqual(einvoice["ItemList"][3]["UnitPrice"], 10) + + # Invoice Discount on net total + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "Net Total" + si.discount_amount = 400 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][0]["Discount"], 253.61) + self.assertEqual(einvoice["ItemList"][1]["Discount"], 66.57) + self.assertEqual(einvoice["ItemList"][2]["Discount"], 243.11) + self.assertEqual(einvoice["ItemList"][3]["Discount"], 5613.71) + self.assertEqual(einvoice["ValDtls"]["Discount"], 0) + + self.assertEqual(einvoice["ItemList"][0]["UnitPrice"], 12) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 15) + self.assertEqual(einvoice["ItemList"][2]["UnitPrice"], 20) + self.assertEqual(einvoice["ItemList"][3]["UnitPrice"], 10) + + # Invoice Discount on grand total (Itemized Discount) + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "Grand Total" + si.discount_amount = 400 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][0]["Discount"], 214.93) + self.assertEqual(einvoice["ItemList"][1]["Discount"], 56.42) + self.assertEqual(einvoice["ItemList"][2]["Discount"], 239.89) + self.assertEqual(einvoice["ItemList"][3]["Discount"], 5604.75) + self.assertEqual(einvoice["ValDtls"]["Discount"], 0) + + self.assertEqual(einvoice["ItemList"][0]["UnitPrice"], 12) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 15) + self.assertEqual(einvoice["ItemList"][2]["UnitPrice"], 20) + self.assertEqual(einvoice["ItemList"][3]["UnitPrice"], 10) + + # Invoice Discount on grand total (Cash/Non-Trade Discount) + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "Grand Total" + si.is_cash_or_non_trade_discount = 1 + si.discount_amount = 400 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][0]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][1]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][2]["Discount"], 222.0) + self.assertEqual(einvoice["ItemList"][3]["Discount"], 5555.0) + self.assertEqual(einvoice["ValDtls"]["Discount"], 400) + + self.assertEqual(einvoice["ItemList"][0]["UnitPrice"], 12) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 15) + self.assertEqual(einvoice["ItemList"][2]["UnitPrice"], 20) + self.assertEqual(einvoice["ItemList"][3]["UnitPrice"], 10) + + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "" + si.items[1].price_list_rate = 15 + si.items[1].discount_amount = -5 + si.items[1].rate = 20 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][1]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 20) + + def test_einvoice_without_discounts(self): + from erpnext.regional.india.e_invoice.utils import make_einvoice, validate_totals + + frappe.db.set_single_value("E Invoice Settings", "dont_show_discounts_in_e_invoice", True) + + # Normal Itemized Discount + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "" + si.items[0].price_list_rate = 12 + si.items[0].discount_percentage = 16.6666666667 + si.items[0].rate = 10 + + si.items[1].price_list_rate = 15 + si.items[1].discount_amount = 5 + si.items[1].rate = 10 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][0]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][1]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][2]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][3]["Discount"], 0) + self.assertEqual(einvoice["ValDtls"]["Discount"], 0) + + self.assertEqual(einvoice["ItemList"][0]["UnitPrice"], 10) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 10) + self.assertEqual(einvoice["ItemList"][2]["UnitPrice"], 18) + self.assertEqual(einvoice["ItemList"][3]["UnitPrice"], 5) + + # Invoice Discount on net total + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "Net Total" + si.discount_amount = 400 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][0]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][1]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][2]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][3]["Discount"], 0) + self.assertEqual(einvoice["ValDtls"]["Discount"], 0) + + self.assertEqual(einvoice["ItemList"][0]["UnitPrice"], 11.87) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 14.84) + self.assertEqual(einvoice["ItemList"][2]["UnitPrice"], 17.81) + self.assertEqual(einvoice["ItemList"][3]["UnitPrice"], 4.95) + + # Invoice Discount on grand total (Itemized Discount) + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "Grand Total" + si.discount_amount = 400 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][0]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][1]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][2]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][3]["Discount"], 0) + self.assertEqual(einvoice["ValDtls"]["Discount"], 0) + + self.assertEqual(einvoice["ItemList"][0]["UnitPrice"], 11.89) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 14.87) + self.assertEqual(einvoice["ItemList"][2]["UnitPrice"], 17.84) + self.assertEqual(einvoice["ItemList"][3]["UnitPrice"], 4.96) + + # Invoice Discount on grand total (Cash/Non-Trade Discount) + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "Grand Total" + si.is_cash_or_non_trade_discount = 1 + si.discount_amount = 400 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][0]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][1]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][2]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][3]["Discount"], 0) + self.assertEqual(einvoice["ValDtls"]["Discount"], 400) + + self.assertEqual(einvoice["ItemList"][0]["UnitPrice"], 12) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 15) + self.assertEqual(einvoice["ItemList"][2]["UnitPrice"], 18) + self.assertEqual(einvoice["ItemList"][3]["UnitPrice"], 5) + + si = get_sales_invoice_for_e_invoice() + si.apply_discount_on = "" + si.items[1].price_list_rate = 15 + si.items[1].discount_amount = -5 + si.items[1].rate = 20 + si.save() + + einvoice = make_einvoice(si) + validate_totals(einvoice) + + self.assertEqual(einvoice["ItemList"][1]["Discount"], 0) + self.assertEqual(einvoice["ItemList"][1]["UnitPrice"], 20) + def test_item_tax_net_range(self): item = create_item("T Shirt") - item.set('taxes', []) - item.append("taxes", { - "item_tax_template": "_Test Account Excise Duty @ 10 - _TC", - "minimum_net_rate": 0, - "maximum_net_rate": 500 - }) + item.set("taxes", []) + item.append( + "taxes", + { + "item_tax_template": "_Test Account Excise Duty @ 10 - _TC", + "minimum_net_rate": 0, + "maximum_net_rate": 500, + }, + ) - item.append("taxes", { - "item_tax_template": "_Test Account Excise Duty @ 12 - _TC", - "minimum_net_rate": 501, - "maximum_net_rate": 1000 - }) + item.append( + "taxes", + { + "item_tax_template": "_Test Account Excise Duty @ 12 - _TC", + "minimum_net_rate": 501, + "maximum_net_rate": 1000, + }, + ) item.save() - sales_invoice = create_sales_invoice(item = "T Shirt", rate=700, do_not_submit=True) - self.assertEqual(sales_invoice.items[0].item_tax_template, "_Test Account Excise Duty @ 12 - _TC") + sales_invoice = create_sales_invoice(item="T Shirt", rate=700, do_not_submit=True) + self.assertEqual( + sales_invoice.items[0].item_tax_template, "_Test Account Excise Duty @ 12 - _TC" + ) # Apply discount - sales_invoice.apply_discount_on = 'Net Total' + sales_invoice.apply_discount_on = "Net Total" sales_invoice.discount_amount = 300 sales_invoice.save() - self.assertEqual(sales_invoice.items[0].item_tax_template, "_Test Account Excise Duty @ 10 - _TC") + self.assertEqual( + sales_invoice.items[0].item_tax_template, "_Test Account Excise Duty @ 10 - _TC" + ) def test_sales_invoice_with_discount_accounting_enabled(self): from erpnext.accounts.doctype.purchase_invoice.test_purchase_invoice import ( @@ -2159,14 +2874,17 @@ class TestSalesInvoice(unittest.TestCase): enable_discount_accounting() - discount_account = create_account(account_name="Discount Account", - parent_account="Indirect Expenses - _TC", company="_Test Company") + discount_account = create_account( + account_name="Discount Account", + parent_account="Indirect Expenses - _TC", + company="_Test Company", + ) si = create_sales_invoice(discount_account=discount_account, discount_percentage=10, rate=90) expected_gle = [ ["Debtors - _TC", 90.0, 0.0, nowdate()], ["Discount Account - _TC", 10.0, 0.0, nowdate()], - ["Sales - _TC", 0.0, 100.0, nowdate()] + ["Sales - _TC", 0.0, 100.0, nowdate()], ] check_gl_entries(self, si.name, expected_gle, add_days(nowdate(), -1)) @@ -2178,27 +2896,33 @@ class TestSalesInvoice(unittest.TestCase): ) enable_discount_accounting() - additional_discount_account = create_account(account_name="Discount Account", - parent_account="Indirect Expenses - _TC", company="_Test Company") + additional_discount_account = create_account( + account_name="Discount Account", + parent_account="Indirect Expenses - _TC", + company="_Test Company", + ) - si = create_sales_invoice(parent_cost_center='Main - _TC', do_not_save=1) + si = create_sales_invoice(parent_cost_center="Main - _TC", do_not_save=1) si.apply_discount_on = "Grand Total" si.additional_discount_account = additional_discount_account si.additional_discount_percentage = 20 - si.append("taxes", { - "charge_type": "On Net Total", - "account_head": "_Test Account VAT - _TC", - "cost_center": "Main - _TC", - "description": "Test", - "rate": 10 - }) + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": "_Test Account VAT - _TC", + "cost_center": "Main - _TC", + "description": "Test", + "rate": 10, + }, + ) si.submit() expected_gle = [ ["_Test Account VAT - _TC", 0.0, 10.0, nowdate()], ["Debtors - _TC", 88, 0.0, nowdate()], ["Discount Account - _TC", 22.0, 0.0, nowdate()], - ["Sales - _TC", 0.0, 100.0, nowdate()] + ["Sales - _TC", 0.0, 100.0, nowdate()], ] check_gl_entries(self, si.name, expected_gle, add_days(nowdate(), -1)) @@ -2206,20 +2930,22 @@ class TestSalesInvoice(unittest.TestCase): def test_asset_depreciation_on_sale_with_pro_rata(self): """ - Tests if an Asset set to depreciate yearly on June 30, that gets sold on Sept 30, creates an additional depreciation entry on its date of sale. + Tests if an Asset set to depreciate yearly on June 30, that gets sold on Sept 30, creates an additional depreciation entry on its date of sale. """ create_asset_data() asset = create_asset(item_code="Macbook Pro", calculate_depreciation=1, submit=1) post_depreciation_entries(getdate("2021-09-30")) - create_sales_invoice(item_code="Macbook Pro", asset=asset.name, qty=1, rate=90000, posting_date=getdate("2021-09-30")) + create_sales_invoice( + item_code="Macbook Pro", asset=asset.name, qty=1, rate=90000, posting_date=getdate("2021-09-30") + ) asset.load_from_db() expected_values = [ - ["2020-06-30", 1311.48, 1311.48], - ["2021-06-30", 20000.0, 21311.48], - ["2021-09-30", 5041.1, 26352.58] + ["2020-06-30", 1366.12, 1366.12], + ["2021-06-30", 20000.0, 21366.12], + ["2021-09-30", 5041.1, 26407.22], ] for i, schedule in enumerate(asset.schedules): @@ -2230,23 +2956,28 @@ class TestSalesInvoice(unittest.TestCase): def test_asset_depreciation_on_sale_without_pro_rata(self): """ - Tests if an Asset set to depreciate yearly on Dec 31, that gets sold on Dec 31 after two years, created an additional depreciation entry on its date of sale. + Tests if an Asset set to depreciate yearly on Dec 31, that gets sold on Dec 31 after two years, created an additional depreciation entry on its date of sale. """ create_asset_data() - asset = create_asset(item_code="Macbook Pro", calculate_depreciation=1, - available_for_use_date=getdate("2019-12-31"), total_number_of_depreciations=3, - expected_value_after_useful_life=10000, depreciation_start_date=getdate("2020-12-31"), submit=1) + asset = create_asset( + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date=getdate("2019-12-31"), + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date=getdate("2020-12-31"), + submit=1, + ) post_depreciation_entries(getdate("2021-09-30")) - create_sales_invoice(item_code="Macbook Pro", asset=asset.name, qty=1, rate=90000, posting_date=getdate("2021-12-31")) + create_sales_invoice( + item_code="Macbook Pro", asset=asset.name, qty=1, rate=90000, posting_date=getdate("2021-12-31") + ) asset.load_from_db() - expected_values = [ - ["2020-12-31", 30000, 30000], - ["2021-12-31", 30000, 60000] - ] + expected_values = [["2020-12-31", 30000, 30000], ["2021-12-31", 30000, 60000]] for i, schedule in enumerate(asset.schedules): self.assertEqual(getdate(expected_values[i][0]), schedule.schedule_date) @@ -2261,18 +2992,20 @@ class TestSalesInvoice(unittest.TestCase): asset = create_asset(item_code="Macbook Pro", calculate_depreciation=1, submit=1) post_depreciation_entries(getdate("2021-09-30")) - si = create_sales_invoice(item_code="Macbook Pro", asset=asset.name, qty=1, rate=90000, posting_date=getdate("2021-09-30")) + si = create_sales_invoice( + item_code="Macbook Pro", asset=asset.name, qty=1, rate=90000, posting_date=getdate("2021-09-30") + ) return_si = make_return_doc("Sales Invoice", si.name) return_si.submit() asset.load_from_db() expected_values = [ - ["2020-06-30", 1311.48, 1311.48, True], - ["2021-06-30", 20000.0, 21311.48, True], - ["2022-06-30", 20000.0, 41311.48, False], - ["2023-06-30", 20000.0, 61311.48, False], - ["2024-06-30", 20000.0, 81311.48, False], - ["2025-06-06", 18688.52, 100000.0, False] + ["2020-06-30", 1366.12, 1366.12, True], + ["2021-06-30", 20000.0, 21366.12, True], + ["2022-06-30", 20000.0, 41366.12, False], + ["2023-06-30", 20000.0, 61366.12, False], + ["2024-06-30", 20000.0, 81366.12, False], + ["2025-06-06", 18633.88, 100000.0, False], ] for i, schedule in enumerate(asset.schedules): @@ -2297,30 +3030,34 @@ class TestSalesInvoice(unittest.TestCase): party_link = create_party_link("Supplier", supplier, customer) # enable common party accounting - frappe.db.set_value('Accounts Settings', None, 'enable_common_party_accounting', 1) + frappe.db.set_value("Accounts Settings", None, "enable_common_party_accounting", 1) # create a sales invoice si = create_sales_invoice(customer=customer, parent_cost_center="_Test Cost Center - _TC") # check outstanding of sales invoice si.reload() - self.assertEqual(si.status, 'Paid') + self.assertEqual(si.status, "Paid") self.assertEqual(flt(si.outstanding_amount), 0.0) # check creation of journal entry - jv = frappe.get_all('Journal Entry Account', { - 'account': si.debit_to, - 'party_type': 'Customer', - 'party': si.customer, - 'reference_type': si.doctype, - 'reference_name': si.name - }, pluck='credit_in_account_currency') + jv = frappe.get_all( + "Journal Entry Account", + { + "account": si.debit_to, + "party_type": "Customer", + "party": si.customer, + "reference_type": si.doctype, + "reference_name": si.name, + }, + pluck="credit_in_account_currency", + ) self.assertTrue(jv) self.assertEqual(jv[0], si.grand_total) party_link.delete() - frappe.db.set_value('Accounts Settings', None, 'enable_common_party_accounting', 0) + frappe.db.set_value("Accounts Settings", None, "enable_common_party_accounting", 0) def test_payment_statuses(self): from erpnext.accounts.doctype.payment_entry.test_payment_entry import get_payment_entry @@ -2330,16 +3067,14 @@ class TestSalesInvoice(unittest.TestCase): # Test Overdue si = create_sales_invoice(do_not_submit=True) si.payment_schedule = [] - si.append("payment_schedule", { - "due_date": add_days(today, -5), - "invoice_portion": 50, - "payment_amount": si.grand_total / 2 - }) - si.append("payment_schedule", { - "due_date": add_days(today, 5), - "invoice_portion": 50, - "payment_amount": si.grand_total / 2 - }) + si.append( + "payment_schedule", + {"due_date": add_days(today, -5), "invoice_portion": 50, "payment_amount": si.grand_total / 2}, + ) + si.append( + "payment_schedule", + {"due_date": add_days(today, 5), "invoice_portion": 50, "payment_amount": si.grand_total / 2}, + ) si.submit() self.assertEqual(si.status, "Overdue") @@ -2370,15 +3105,63 @@ class TestSalesInvoice(unittest.TestCase): si.reload() self.assertEqual(si.status, "Paid") + def test_update_invoice_status(self): + today = nowdate() + + # Sales Invoice without Payment Schedule + si = create_sales_invoice(posting_date=add_days(today, -5)) + + # Sales Invoice with Payment Schedule + si_with_payment_schedule = create_sales_invoice(do_not_submit=True) + si_with_payment_schedule.extend( + "payment_schedule", + [ + { + "due_date": add_days(today, -5), + "invoice_portion": 50, + "payment_amount": si_with_payment_schedule.grand_total / 2, + }, + { + "due_date": add_days(today, 5), + "invoice_portion": 50, + "payment_amount": si_with_payment_schedule.grand_total / 2, + }, + ], + ) + si_with_payment_schedule.submit() + + for invoice in (si, si_with_payment_schedule): + invoice.db_set("status", "Unpaid") + update_invoice_status() + invoice.reload() + self.assertEqual(invoice.status, "Overdue") + + invoice.db_set("status", "Unpaid and Discounted") + update_invoice_status() + invoice.reload() + self.assertEqual(invoice.status, "Overdue and Discounted") + def test_sales_commission(self): - si = frappe.copy_doc(test_records[0]) - item = copy.deepcopy(si.get('items')[0]) - item.update({ - "qty": 1, - "rate": 500, - "grant_commission": 1 - }) - si.append("items", item) + si = frappe.copy_doc(test_records[2]) + + frappe.db.set_value("Item", si.get("items")[0].item_code, "grant_commission", 1) + frappe.db.set_value("Item", si.get("items")[1].item_code, "grant_commission", 0) + + item = copy.deepcopy(si.get("items")[0]) + item.update( + { + "qty": 1, + "rate": 500, + } + ) + + item = copy.deepcopy(si.get("items")[1]) + item.update( + { + "qty": 1, + "rate": 500, + } + ) # Test valid values for commission_rate, total_commission in ((0, 0), (10, 50), (100, 500)): @@ -2394,7 +3177,7 @@ class TestSalesInvoice(unittest.TestCase): self.assertRaises(frappe.ValidationError, si.save) def test_sales_invoice_submission_post_account_freezing_date(self): - frappe.db.set_value('Accounts Settings', None, 'acc_frozen_upto', add_days(getdate(), 1)) + frappe.db.set_value("Accounts Settings", None, "acc_frozen_upto", add_days(getdate(), 1)) si = create_sales_invoice(do_not_save=True) si.posting_date = add_days(getdate(), 1) si.save() @@ -2403,17 +3186,19 @@ class TestSalesInvoice(unittest.TestCase): si.posting_date = getdate() si.submit() - frappe.db.set_value('Accounts Settings', None, 'acc_frozen_upto', None) + frappe.db.set_value("Accounts Settings", None, "acc_frozen_upto", None) def test_over_billing_case_against_delivery_note(self): - ''' - Test a case where duplicating the item with qty = 1 in the invoice - allows overbilling even if it is disabled - ''' + """ + Test a case where duplicating the item with qty = 1 in the invoice + allows overbilling even if it is disabled + """ from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note - over_billing_allowance = frappe.db.get_single_value('Accounts Settings', 'over_billing_allowance') - frappe.db.set_value('Accounts Settings', None, 'over_billing_allowance', 0) + over_billing_allowance = frappe.db.get_single_value( + "Accounts Settings", "over_billing_allowance" + ) + frappe.db.set_value("Accounts Settings", None, "over_billing_allowance", 0) dn = create_delivery_note() dn.submit() @@ -2421,7 +3206,7 @@ class TestSalesInvoice(unittest.TestCase): si = make_sales_invoice(dn.name) # make a copy of first item and add it to invoice item_copy = frappe.copy_doc(si.items[0]) - si.append('items', item_copy) + si.append("items", item_copy) si.save() with self.assertRaises(frappe.ValidationError) as err: @@ -2429,120 +3214,338 @@ class TestSalesInvoice(unittest.TestCase): self.assertTrue("cannot overbill" in str(err.exception).lower()) - frappe.db.set_value('Accounts Settings', None, 'over_billing_allowance', over_billing_allowance) + frappe.db.set_value("Accounts Settings", None, "over_billing_allowance", over_billing_allowance) + + def test_multi_currency_deferred_revenue_via_journal_entry(self): + deferred_account = create_account( + account_name="Deferred Revenue", + parent_account="Current Liabilities - _TC", + company="_Test Company", + ) + + acc_settings = frappe.get_single("Accounts Settings") + acc_settings.book_deferred_entries_via_journal_entry = 1 + acc_settings.submit_journal_entries = 1 + acc_settings.save() + + item = create_item("_Test Item for Deferred Accounting") + item.enable_deferred_expense = 1 + item.deferred_revenue_account = deferred_account + item.save() + + si = create_sales_invoice( + customer="_Test Customer USD", + currency="USD", + item=item.name, + qty=1, + rate=100, + conversion_rate=60, + do_not_save=True, + ) + + si.set_posting_time = 1 + si.posting_date = "2019-01-01" + si.debit_to = "_Test Receivable USD - _TC" + si.items[0].enable_deferred_revenue = 1 + si.items[0].service_start_date = "2019-01-01" + si.items[0].service_end_date = "2019-03-30" + si.items[0].deferred_expense_account = deferred_account + si.save() + si.submit() + + frappe.db.set_value("Accounts Settings", None, "acc_frozen_upto", getdate("2019-01-31")) + + pda1 = frappe.get_doc( + dict( + doctype="Process Deferred Accounting", + posting_date=nowdate(), + start_date="2019-01-01", + end_date="2019-03-31", + type="Income", + company="_Test Company", + ) + ) + + pda1.insert() + pda1.submit() + + expected_gle = [ + ["Sales - _TC", 0.0, 2089.89, "2019-01-28"], + [deferred_account, 2089.89, 0.0, "2019-01-28"], + ["Sales - _TC", 0.0, 1887.64, "2019-02-28"], + [deferred_account, 1887.64, 0.0, "2019-02-28"], + ["Sales - _TC", 0.0, 2022.47, "2019-03-15"], + [deferred_account, 2022.47, 0.0, "2019-03-15"], + ] + + gl_entries = gl_entries = frappe.db.sql( + """select account, debit, credit, posting_date + from `tabGL Entry` + where voucher_type='Journal Entry' and voucher_detail_no=%s and posting_date <= %s + order by posting_date asc, account asc""", + (si.items[0].name, si.posting_date), + as_dict=1, + ) + + for i, gle in enumerate(gl_entries): + self.assertEqual(expected_gle[i][0], gle.account) + self.assertEqual(expected_gle[i][1], gle.credit) + self.assertEqual(expected_gle[i][2], gle.debit) + self.assertEqual(getdate(expected_gle[i][3]), gle.posting_date) + + acc_settings = frappe.get_single("Accounts Settings") + acc_settings.book_deferred_entries_via_journal_entry = 0 + acc_settings.submit_journal_entries = 0 + acc_settings.save() + + frappe.db.set_value("Accounts Settings", None, "acc_frozen_upto", None) + + def test_standalone_serial_no_return(self): + si = create_sales_invoice( + item_code="_Test Serialized Item With Series", update_stock=True, is_return=True, qty=-1 + ) + si.reload() + self.assertTrue(si.items[0].serial_no) + + def test_sales_invoice_with_disabled_account(self): + try: + account = frappe.get_doc("Account", "VAT 5% - _TC") + account.disabled = 1 + account.save() + + si = create_sales_invoice(do_not_save=True) + si.posting_date = add_days(getdate(), 1) + si.taxes = [] + + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": "VAT 5% - _TC", + "cost_center": "Main - _TC", + "description": "VAT @ 5.0", + "rate": 9, + }, + ) + si.save() + + with self.assertRaises(frappe.ValidationError) as err: + si.submit() + + self.assertTrue( + "Cannot create accounting entries against disabled accounts" in str(err.exception) + ) + + finally: + account.disabled = 0 + account.save() + + def test_gain_loss_with_advance_entry(self): + from erpnext.accounts.doctype.journal_entry.test_journal_entry import make_journal_entry + + unlink_enabled = frappe.db.get_value( + "Accounts Settings", "Accounts Settings", "unlink_payment_on_cancel_of_invoice" + ) + + frappe.db.set_value( + "Accounts Settings", "Accounts Settings", "unlink_payment_on_cancel_of_invoice", 1 + ) + + jv = make_journal_entry("_Test Receivable USD - _TC", "_Test Bank - _TC", -7000, save=False) + + jv.accounts[0].exchange_rate = 70 + jv.accounts[0].credit_in_account_currency = 100 + jv.accounts[0].party_type = "Customer" + jv.accounts[0].party = "_Test Customer USD" + + jv.save() + jv.submit() + + si = create_sales_invoice( + customer="_Test Customer USD", + debit_to="_Test Receivable USD - _TC", + currency="USD", + conversion_rate=75, + do_not_save=1, + rate=100, + ) + + si.append( + "advances", + { + "reference_type": "Journal Entry", + "reference_name": jv.name, + "reference_row": jv.accounts[0].name, + "advance_amount": 100, + "allocated_amount": 100, + "ref_exchange_rate": 70, + }, + ) + si.save() + si.submit() + + expected_gle = [ + ["_Test Receivable USD - _TC", 7500.0, 500], + ["Exchange Gain/Loss - _TC", 500.0, 0.0], + ["Sales - _TC", 0.0, 7500.0], + ] + + check_gl_entries(self, si.name, expected_gle, nowdate()) + + frappe.db.set_value( + "Accounts Settings", "Accounts Settings", "unlink_payment_on_cancel_of_invoice", unlink_enabled + ) + def get_sales_invoice_for_e_invoice(): si = make_sales_invoice_for_ewaybill() - si.naming_series = 'INV-2020-.#####' + si.naming_series = "INV-2020-.#####" si.items = [] - si.append("items", { - "item_code": "_Test Item", - "uom": "Nos", - "warehouse": "_Test Warehouse - _TC", - "qty": 2000, - "rate": 12, - "income_account": "Sales - _TC", - "expense_account": "Cost of Goods Sold - _TC", - "cost_center": "_Test Cost Center - _TC", - }) + si.append( + "items", + { + "item_code": "_Test Item", + "uom": "Nos", + "warehouse": "_Test Warehouse - _TC", + "qty": 2000, + "rate": 12, + "income_account": "Sales - _TC", + "expense_account": "Cost of Goods Sold - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ) - si.append("items", { - "item_code": "_Test Item 2", - "uom": "Nos", - "warehouse": "_Test Warehouse - _TC", - "qty": 420, - "rate": 15, - "income_account": "Sales - _TC", - "expense_account": "Cost of Goods Sold - _TC", - "cost_center": "_Test Cost Center - _TC", - }) + si.append( + "items", + { + "item_code": "_Test Item 2", + "uom": "Nos", + "warehouse": "_Test Warehouse - _TC", + "qty": 420, + "rate": 15, + "income_account": "Sales - _TC", + "expense_account": "Cost of Goods Sold - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ) + + si.append( + "items", + { + "item_code": "_Test Item", + "uom": "Nos", + "warehouse": "_Test Warehouse - _TC", + "qty": 111, + "price_list_rate": 20, + "discount_percentage": 10, + "income_account": "Sales - _TC", + "expense_account": "Cost of Goods Sold - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ) + + si.append( + "items", + { + "item_code": "_Test Item 2", + "uom": "Nos", + "warehouse": "_Test Warehouse - _TC", + "qty": 1111, + "price_list_rate": 10, + "rate": 5, + "income_account": "Sales - _TC", + "expense_account": "Cost of Goods Sold - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ) return si def make_test_address_for_ewaybill(): - if not frappe.db.exists('Address', '_Test Address for Eway bill-Billing'): - address = frappe.get_doc({ - "address_line1": "_Test Address Line 1", - "address_title": "_Test Address for Eway bill", - "address_type": "Billing", - "city": "_Test City", - "state": "Test State", - "country": "India", - "doctype": "Address", - "is_primary_address": 1, - "phone": "+910000000000", - "gstin": "27AAECE4835E1ZR", - "gst_state": "Maharashtra", - "gst_state_number": "27", - "pincode": "401108" - }).insert() + if not frappe.db.exists("Address", "_Test Address for Eway bill-Billing"): + address = frappe.get_doc( + { + "address_line1": "_Test Address Line 1", + "address_title": "_Test Address for Eway bill", + "address_type": "Billing", + "city": "_Test City", + "state": "Test State", + "country": "India", + "doctype": "Address", + "is_primary_address": 1, + "phone": "+910000000000", + "gstin": "27AAECE4835E1ZR", + "gst_state": "Maharashtra", + "gst_state_number": "27", + "pincode": "401108", + } + ).insert() - address.append("links", { - "link_doctype": "Company", - "link_name": "_Test Company" - }) + address.append("links", {"link_doctype": "Company", "link_name": "_Test Company"}) address.save() - if not frappe.db.exists('Address', '_Test Customer-Address for Eway bill-Shipping'): - address = frappe.get_doc({ - "address_line1": "_Test Address Line 1", - "address_title": "_Test Customer-Address for Eway bill", - "address_type": "Shipping", - "city": "_Test City", - "state": "Test State", - "country": "India", - "doctype": "Address", - "is_primary_address": 1, - "phone": "+910000000000", - "gstin": "27AACCM7806M1Z3", - "gst_state": "Maharashtra", - "gst_state_number": "27", - "pincode": "410038" - }).insert() + if not frappe.db.exists("Address", "_Test Customer-Address for Eway bill-Shipping"): + address = frappe.get_doc( + { + "address_line1": "_Test Address Line 1", + "address_title": "_Test Customer-Address for Eway bill", + "address_type": "Shipping", + "city": "_Test City", + "state": "Test State", + "country": "India", + "doctype": "Address", + "is_primary_address": 1, + "phone": "+910000000000", + "gstin": "27AACCM7806M1Z3", + "gst_state": "Maharashtra", + "gst_state_number": "27", + "pincode": "410038", + } + ).insert() - address.append("links", { - "link_doctype": "Customer", - "link_name": "_Test Customer" - }) + address.append("links", {"link_doctype": "Customer", "link_name": "_Test Customer"}) address.save() - if not frappe.db.exists('Address', '_Test Dispatch-Address for Eway bill-Shipping'): - address = frappe.get_doc({ - "address_line1": "_Test Dispatch Address Line 1", - "address_title": "_Test Dispatch-Address for Eway bill", - "address_type": "Shipping", - "city": "_Test City", - "state": "Test State", - "country": "India", - "doctype": "Address", - "is_primary_address": 0, - "phone": "+910000000000", - "gstin": "07AAACC1206D1ZI", - "gst_state": "Delhi", - "gst_state_number": "07", - "pincode": "1100101" - }).insert() + if not frappe.db.exists("Address", "_Test Dispatch-Address for Eway bill-Shipping"): + address = frappe.get_doc( + { + "address_line1": "_Test Dispatch Address Line 1", + "address_title": "_Test Dispatch-Address for Eway bill", + "address_type": "Shipping", + "city": "_Test City", + "state": "Test State", + "country": "India", + "doctype": "Address", + "is_primary_address": 0, + "phone": "+910000000000", + "gstin": "07AAACC1206D1ZI", + "gst_state": "Delhi", + "gst_state_number": "07", + "pincode": "1100101", + } + ).insert() - address.append("links", { - "link_doctype": "Company", - "link_name": "_Test Company" - }) + address.append("links", {"link_doctype": "Company", "link_name": "_Test Company"}) address.save() + def make_test_transporter_for_ewaybill(): - if not frappe.db.exists('Supplier', '_Test Transporter'): - frappe.get_doc({ - "doctype": "Supplier", - "supplier_name": "_Test Transporter", - "country": "India", - "supplier_group": "_Test Supplier Group", - "supplier_type": "Company", - "is_transporter": 1 - }).insert() + if not frappe.db.exists("Supplier", "_Test Transporter"): + frappe.get_doc( + { + "doctype": "Supplier", + "supplier_name": "_Test Transporter", + "country": "India", + "supplier_group": "_Test Supplier Group", + "supplier_type": "Company", + "is_transporter": 1, + } + ).insert() + def make_sales_invoice_for_ewaybill(): make_test_address_for_ewaybill() @@ -2553,20 +3556,23 @@ def make_sales_invoice_for_ewaybill(): gst_account = frappe.get_all( "GST Account", fields=["cgst_account", "sgst_account", "igst_account"], - filters = {"company": "_Test Company"} + filters={"company": "_Test Company"}, ) if not gst_account: - gst_settings.append("gst_accounts", { - "company": "_Test Company", - "cgst_account": "Output Tax CGST - _TC", - "sgst_account": "Output Tax SGST - _TC", - "igst_account": "Output Tax IGST - _TC", - }) + gst_settings.append( + "gst_accounts", + { + "company": "_Test Company", + "cgst_account": "Output Tax CGST - _TC", + "sgst_account": "Output Tax SGST - _TC", + "igst_account": "Output Tax IGST - _TC", + }, + ) gst_settings.save() - si = create_sales_invoice(do_not_save=1, rate='60000') + si = create_sales_invoice(do_not_save=1, rate="60000") si.distance = 2000 si.company_address = "_Test Address for Eway bill-Billing" @@ -2574,32 +3580,43 @@ def make_sales_invoice_for_ewaybill(): si.dispatch_address_name = "_Test Dispatch-Address for Eway bill-Shipping" si.vehicle_no = "KA12KA1234" si.gst_category = "Registered Regular" - si.mode_of_transport = 'Road' - si.transporter = '_Test Transporter' + si.mode_of_transport = "Road" + si.transporter = "_Test Transporter" - si.append("taxes", { - "charge_type": "On Net Total", - "account_head": "Output Tax CGST - _TC", - "cost_center": "Main - _TC", - "description": "CGST @ 9.0", - "rate": 9 - }) + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": "Output Tax CGST - _TC", + "cost_center": "Main - _TC", + "description": "CGST @ 9.0", + "rate": 9, + }, + ) - si.append("taxes", { - "charge_type": "On Net Total", - "account_head": "Output Tax SGST - _TC", - "cost_center": "Main - _TC", - "description": "SGST @ 9.0", - "rate": 9 - }) + si.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": "Output Tax SGST - _TC", + "cost_center": "Main - _TC", + "description": "SGST @ 9.0", + "rate": 9, + }, + ) return si + def check_gl_entries(doc, voucher_no, expected_gle, posting_date): - gl_entries = frappe.db.sql("""select account, debit, credit, posting_date + gl_entries = frappe.db.sql( + """select account, debit, credit, posting_date from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no=%s and posting_date > %s - order by posting_date asc, account asc""", (voucher_no, posting_date), as_dict=1) + order by posting_date asc, account asc""", + (voucher_no, posting_date), + as_dict=1, + ) for i, gle in enumerate(gl_entries): doc.assertEqual(expected_gle[i][0], gle.account) @@ -2607,6 +3624,7 @@ def check_gl_entries(doc, voucher_no, expected_gle, posting_date): doc.assertEqual(expected_gle[i][2], gle.credit) doc.assertEqual(getdate(expected_gle[i][3]), gle.posting_date) + def create_sales_invoice(**args): si = frappe.new_doc("Sales Invoice") args = frappe._dict(args) @@ -2621,32 +3639,35 @@ def create_sales_invoice(**args): si.is_pos = args.is_pos si.is_return = args.is_return si.return_against = args.return_against - si.currency=args.currency or "INR" + si.currency = args.currency or "INR" si.conversion_rate = args.conversion_rate or 1 si.naming_series = args.naming_series or "T-SINV-" si.cost_center = args.parent_cost_center - si.append("items", { - "item_code": args.item or args.item_code or "_Test Item", - "item_name": args.item_name or "_Test Item", - "description": args.description or "_Test Item", - "gst_hsn_code": "999800", - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "qty": args.qty or 1, - "uom": args.uom or "Nos", - "stock_uom": args.uom or "Nos", - "rate": args.rate if args.get("rate") is not None else 100, - "price_list_rate": args.price_list_rate if args.get("price_list_rate") is not None else 100, - "income_account": args.income_account or "Sales - _TC", - "expense_account": args.expense_account or "Cost of Goods Sold - _TC", - "asset": args.asset or None, - "discount_account": args.discount_account or None, - "discount_amount": args.discount_amount or 0, - "cost_center": args.cost_center or "_Test Cost Center - _TC", - "serial_no": args.serial_no, - "conversion_factor": 1, - "incoming_rate": args.incoming_rate or 0 - }) + si.append( + "items", + { + "item_code": args.item or args.item_code or "_Test Item", + "item_name": args.item_name or "_Test Item", + "description": args.description or "_Test Item", + "gst_hsn_code": "999800", + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "qty": args.qty or 1, + "uom": args.uom or "Nos", + "stock_uom": args.uom or "Nos", + "rate": args.rate if args.get("rate") is not None else 100, + "price_list_rate": args.price_list_rate if args.get("price_list_rate") is not None else 100, + "income_account": args.income_account or "Sales - _TC", + "expense_account": args.expense_account or "Cost of Goods Sold - _TC", + "asset": args.asset or None, + "discount_account": args.discount_account or None, + "discount_amount": args.discount_amount or 0, + "cost_center": args.cost_center or "_Test Cost Center - _TC", + "serial_no": args.serial_no, + "conversion_factor": 1, + "incoming_rate": args.incoming_rate or 0, + }, + ) if not args.do_not_save: si.insert() @@ -2659,6 +3680,7 @@ def create_sales_invoice(**args): return si + def create_sales_invoice_against_cost_center(**args): si = frappe.new_doc("Sales Invoice") args = frappe._dict(args) @@ -2674,20 +3696,23 @@ def create_sales_invoice_against_cost_center(**args): si.is_pos = args.is_pos si.is_return = args.is_return si.return_against = args.return_against - si.currency=args.currency or "INR" + si.currency = args.currency or "INR" si.conversion_rate = args.conversion_rate or 1 - si.append("items", { - "item_code": args.item or args.item_code or "_Test Item", - "gst_hsn_code": "999800", - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "qty": args.qty or 1, - "rate": args.rate or 100, - "income_account": "Sales - _TC", - "expense_account": "Cost of Goods Sold - _TC", - "cost_center": args.cost_center or "_Test Cost Center - _TC", - "serial_no": args.serial_no - }) + si.append( + "items", + { + "item_code": args.item or args.item_code or "_Test Item", + "gst_hsn_code": "999800", + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "qty": args.qty or 1, + "rate": args.rate or 100, + "income_account": "Sales - _TC", + "expense_account": "Cost of Goods Sold - _TC", + "cost_center": args.cost_center or "_Test Cost Center - _TC", + "serial_no": args.serial_no, + }, + ) if not args.do_not_save: si.insert() @@ -2702,59 +3727,69 @@ def create_sales_invoice_against_cost_center(**args): test_dependencies = ["Journal Entry", "Contact", "Address"] -test_records = frappe.get_test_records('Sales Invoice') +test_records = frappe.get_test_records("Sales Invoice") + def get_outstanding_amount(against_voucher_type, against_voucher, account, party, party_type): - bal = flt(frappe.db.sql(""" + bal = flt( + frappe.db.sql( + """ select sum(debit_in_account_currency) - sum(credit_in_account_currency) from `tabGL Entry` where against_voucher_type=%s and against_voucher=%s and account = %s and party = %s and party_type = %s""", - (against_voucher_type, against_voucher, account, party, party_type))[0][0] or 0.0) + (against_voucher_type, against_voucher, account, party, party_type), + )[0][0] + or 0.0 + ) - if against_voucher_type == 'Purchase Invoice': + if against_voucher_type == "Purchase Invoice": bal = bal * -1 return bal + def get_taxes_and_charges(): - return [{ - "account_head": "_Test Account Excise Duty - TCP1", - "charge_type": "On Net Total", - "cost_center": "Main - TCP1", - "description": "Excise Duty", - "doctype": "Sales Taxes and Charges", - "idx": 1, - "included_in_print_rate": 1, - "parentfield": "taxes", - "rate": 12 - }, - { - "account_head": "_Test Account Education Cess - TCP1", - "charge_type": "On Previous Row Amount", - "cost_center": "Main - TCP1", - "description": "Education Cess", - "doctype": "Sales Taxes and Charges", - "idx": 2, - "included_in_print_rate": 1, - "parentfield": "taxes", - "rate": 2, - "row_id": 1 - }] + return [ + { + "account_head": "_Test Account Excise Duty - TCP1", + "charge_type": "On Net Total", + "cost_center": "Main - TCP1", + "description": "Excise Duty", + "doctype": "Sales Taxes and Charges", + "idx": 1, + "included_in_print_rate": 1, + "parentfield": "taxes", + "rate": 12, + }, + { + "account_head": "_Test Account Education Cess - TCP1", + "charge_type": "On Previous Row Amount", + "cost_center": "Main - TCP1", + "description": "Education Cess", + "doctype": "Sales Taxes and Charges", + "idx": 2, + "included_in_print_rate": 1, + "parentfield": "taxes", + "rate": 2, + "row_id": 1, + }, + ] + def create_internal_supplier(supplier_name, represents_company, allowed_to_interact_with): if not frappe.db.exists("Supplier", supplier_name): - supplier = frappe.get_doc({ - "supplier_group": "_Test Supplier Group", - "supplier_name": supplier_name, - "doctype": "Supplier", - "is_internal_supplier": 1, - "represents_company": represents_company - }) + supplier = frappe.get_doc( + { + "supplier_group": "_Test Supplier Group", + "supplier_name": supplier_name, + "doctype": "Supplier", + "is_internal_supplier": 1, + "represents_company": represents_company, + } + ) - supplier.append("companies", { - "company": allowed_to_interact_with - }) + supplier.append("companies", {"company": allowed_to_interact_with}) supplier.insert() supplier_name = supplier.name @@ -2763,11 +3798,15 @@ def create_internal_supplier(supplier_name, represents_company, allowed_to_inter return supplier_name + def add_taxes(doc): - doc.append('taxes', { - 'account_head': '_Test Account Excise Duty - TCP1', - "charge_type": "On Net Total", - "cost_center": "Main - TCP1", - "description": "Excise Duty", - "rate": 12 - }) + doc.append( + "taxes", + { + "account_head": "_Test Account Excise Duty - TCP1", + "charge_type": "On Net Total", + "cost_center": "Main - TCP1", + "description": "Excise Duty", + "rate": 12, + }, + ) diff --git a/erpnext/accounts/doctype/sales_invoice_item/sales_invoice_item.json b/erpnext/accounts/doctype/sales_invoice_item/sales_invoice_item.json index a9412d86396..7bb564b066a 100644 --- a/erpnext/accounts/doctype/sales_invoice_item/sales_invoice_item.json +++ b/erpnext/accounts/doctype/sales_invoice_item/sales_invoice_item.json @@ -279,7 +279,6 @@ "label": "Discount (%) on Price List Rate with Margin", "oldfieldname": "adj_rate", "oldfieldtype": "Float", - "precision": "2", "print_hide": 1 }, { @@ -832,6 +831,7 @@ }, { "default": "0", + "fetch_from": "item_code.grant_commission", "fieldname": "grant_commission", "fieldtype": "Check", "label": "Grant Commission", @@ -841,7 +841,7 @@ "idx": 1, "istable": 1, "links": [], - "modified": "2021-10-05 12:24:54.968907", + "modified": "2022-08-26 12:06:31.205417", "modified_by": "Administrator", "module": "Accounts", "name": "Sales Invoice Item", @@ -851,3 +851,4 @@ "sort_field": "modified", "sort_order": "DESC" } + diff --git a/erpnext/accounts/doctype/sales_taxes_and_charges_template/sales_taxes_and_charges_template.py b/erpnext/accounts/doctype/sales_taxes_and_charges_template/sales_taxes_and_charges_template.py index b5909447dc8..d9009bae4c0 100644 --- a/erpnext/accounts/doctype/sales_taxes_and_charges_template/sales_taxes_and_charges_template.py +++ b/erpnext/accounts/doctype/sales_taxes_and_charges_template/sales_taxes_and_charges_template.py @@ -21,13 +21,14 @@ class SalesTaxesandChargesTemplate(Document): def autoname(self): if self.company and self.title: - abbr = frappe.get_cached_value('Company', self.company, 'abbr') - self.name = '{0} - {1}'.format(self.title, abbr) + abbr = frappe.get_cached_value("Company", self.company, "abbr") + self.name = "{0} - {1}".format(self.title, abbr) def set_missing_values(self): for data in self.taxes: - if data.charge_type == 'On Net Total' and flt(data.rate) == 0.0: - data.rate = frappe.db.get_value('Account', data.account_head, 'tax_rate') + if data.charge_type == "On Net Total" and flt(data.rate) == 0.0: + data.rate = frappe.db.get_value("Account", data.account_head, "tax_rate") + def valdiate_taxes_and_charges_template(doc): # default should not be disabled @@ -35,9 +36,13 @@ def valdiate_taxes_and_charges_template(doc): # doc.is_default = 1 if doc.is_default == 1: - frappe.db.sql("""update `tab{0}` set is_default = 0 - where is_default = 1 and name != %s and company = %s""".format(doc.doctype), - (doc.name, doc.company)) + frappe.db.sql( + """update `tab{0}` set is_default = 0 + where is_default = 1 and name != %s and company = %s""".format( + doc.doctype + ), + (doc.name, doc.company), + ) validate_disabled(doc) @@ -46,14 +51,31 @@ def valdiate_taxes_and_charges_template(doc): for tax in doc.get("taxes"): validate_taxes_and_charges(tax) - validate_account_head(tax, doc) + validate_account_head(tax.idx, tax.account_head, doc.company) validate_cost_center(tax, doc) validate_inclusive_tax(tax, doc) + def validate_disabled(doc): if doc.is_default and doc.disabled: frappe.throw(_("Disabled template must not be default template")) + def validate_for_tax_category(doc): - if frappe.db.exists(doc.doctype, {"company": doc.company, "tax_category": doc.tax_category, "disabled": 0, "name": ["!=", doc.name]}): - frappe.throw(_("A template with tax category {0} already exists. Only one template is allowed with each tax category").format(frappe.bold(doc.tax_category))) + if not doc.tax_category: + return + + if frappe.db.exists( + doc.doctype, + { + "company": doc.company, + "tax_category": doc.tax_category, + "disabled": 0, + "name": ["!=", doc.name], + }, + ): + frappe.throw( + _( + "A template with tax category {0} already exists. Only one template is allowed with each tax category" + ).format(frappe.bold(doc.tax_category)) + ) diff --git a/erpnext/accounts/doctype/sales_taxes_and_charges_template/sales_taxes_and_charges_template_dashboard.py b/erpnext/accounts/doctype/sales_taxes_and_charges_template/sales_taxes_and_charges_template_dashboard.py index 5b9fbafed8d..6432acaae93 100644 --- a/erpnext/accounts/doctype/sales_taxes_and_charges_template/sales_taxes_and_charges_template_dashboard.py +++ b/erpnext/accounts/doctype/sales_taxes_and_charges_template/sales_taxes_and_charges_template_dashboard.py @@ -1,23 +1,16 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'taxes_and_charges', - 'non_standard_fieldnames': { - 'Tax Rule': 'sales_tax_template', - 'Subscription': 'sales_tax_template', - 'Restaurant': 'default_tax_template' + "fieldname": "taxes_and_charges", + "non_standard_fieldnames": { + "Tax Rule": "sales_tax_template", + "Subscription": "sales_tax_template", + "Restaurant": "default_tax_template", }, - 'transactions': [ - { - 'label': _('Transactions'), - 'items': ['Sales Invoice', 'Sales Order', 'Delivery Note'] - }, - { - 'label': _('References'), - 'items': ['POS Profile', 'Subscription', 'Restaurant', 'Tax Rule'] - } - ] + "transactions": [ + {"label": _("Transactions"), "items": ["Sales Invoice", "Sales Order", "Delivery Note"]}, + {"label": _("References"), "items": ["POS Profile", "Subscription", "Restaurant", "Tax Rule"]}, + ], } diff --git a/erpnext/accounts/doctype/sales_taxes_and_charges_template/test_sales_taxes_and_charges_template.py b/erpnext/accounts/doctype/sales_taxes_and_charges_template/test_sales_taxes_and_charges_template.py index 7b13c6c6925..972b773501a 100644 --- a/erpnext/accounts/doctype/sales_taxes_and_charges_template/test_sales_taxes_and_charges_template.py +++ b/erpnext/accounts/doctype/sales_taxes_and_charges_template/test_sales_taxes_and_charges_template.py @@ -5,7 +5,8 @@ import unittest import frappe -test_records = frappe.get_test_records('Sales Taxes and Charges Template') +test_records = frappe.get_test_records("Sales Taxes and Charges Template") + class TestSalesTaxesandChargesTemplate(unittest.TestCase): pass diff --git a/erpnext/accounts/doctype/share_transfer/share_transfer.py b/erpnext/accounts/doctype/share_transfer/share_transfer.py index b543ad8204d..4f49843c1eb 100644 --- a/erpnext/accounts/doctype/share_transfer/share_transfer.py +++ b/erpnext/accounts/doctype/share_transfer/share_transfer.py @@ -10,95 +10,115 @@ from frappe.model.naming import make_autoname from frappe.utils import nowdate -class ShareDontExists(ValidationError): pass +class ShareDontExists(ValidationError): + pass + class ShareTransfer(Document): def on_submit(self): - if self.transfer_type == 'Issue': + if self.transfer_type == "Issue": shareholder = self.get_company_shareholder() - shareholder.append('share_balance', { - 'share_type': self.share_type, - 'from_no': self.from_no, - 'to_no': self.to_no, - 'rate': self.rate, - 'amount': self.amount, - 'no_of_shares': self.no_of_shares, - 'is_company': 1, - 'current_state': 'Issued' - }) + shareholder.append( + "share_balance", + { + "share_type": self.share_type, + "from_no": self.from_no, + "to_no": self.to_no, + "rate": self.rate, + "amount": self.amount, + "no_of_shares": self.no_of_shares, + "is_company": 1, + "current_state": "Issued", + }, + ) shareholder.save() doc = self.get_shareholder_doc(self.to_shareholder) - doc.append('share_balance', { - 'share_type': self.share_type, - 'from_no': self.from_no, - 'to_no': self.to_no, - 'rate': self.rate, - 'amount': self.amount, - 'no_of_shares': self.no_of_shares - }) + doc.append( + "share_balance", + { + "share_type": self.share_type, + "from_no": self.from_no, + "to_no": self.to_no, + "rate": self.rate, + "amount": self.amount, + "no_of_shares": self.no_of_shares, + }, + ) doc.save() - elif self.transfer_type == 'Purchase': + elif self.transfer_type == "Purchase": self.remove_shares(self.from_shareholder) self.remove_shares(self.get_company_shareholder().name) - elif self.transfer_type == 'Transfer': + elif self.transfer_type == "Transfer": self.remove_shares(self.from_shareholder) doc = self.get_shareholder_doc(self.to_shareholder) - doc.append('share_balance', { - 'share_type': self.share_type, - 'from_no': self.from_no, - 'to_no': self.to_no, - 'rate': self.rate, - 'amount': self.amount, - 'no_of_shares': self.no_of_shares - }) + doc.append( + "share_balance", + { + "share_type": self.share_type, + "from_no": self.from_no, + "to_no": self.to_no, + "rate": self.rate, + "amount": self.amount, + "no_of_shares": self.no_of_shares, + }, + ) doc.save() def on_cancel(self): - if self.transfer_type == 'Issue': + if self.transfer_type == "Issue": compnay_shareholder = self.get_company_shareholder() self.remove_shares(compnay_shareholder.name) self.remove_shares(self.to_shareholder) - elif self.transfer_type == 'Purchase': + elif self.transfer_type == "Purchase": compnay_shareholder = self.get_company_shareholder() from_shareholder = self.get_shareholder_doc(self.from_shareholder) - from_shareholder.append('share_balance', { - 'share_type': self.share_type, - 'from_no': self.from_no, - 'to_no': self.to_no, - 'rate': self.rate, - 'amount': self.amount, - 'no_of_shares': self.no_of_shares - }) + from_shareholder.append( + "share_balance", + { + "share_type": self.share_type, + "from_no": self.from_no, + "to_no": self.to_no, + "rate": self.rate, + "amount": self.amount, + "no_of_shares": self.no_of_shares, + }, + ) from_shareholder.save() - compnay_shareholder.append('share_balance', { - 'share_type': self.share_type, - 'from_no': self.from_no, - 'to_no': self.to_no, - 'rate': self.rate, - 'amount': self.amount, - 'no_of_shares': self.no_of_shares - }) + compnay_shareholder.append( + "share_balance", + { + "share_type": self.share_type, + "from_no": self.from_no, + "to_no": self.to_no, + "rate": self.rate, + "amount": self.amount, + "no_of_shares": self.no_of_shares, + }, + ) compnay_shareholder.save() - elif self.transfer_type == 'Transfer': + elif self.transfer_type == "Transfer": self.remove_shares(self.to_shareholder) from_shareholder = self.get_shareholder_doc(self.from_shareholder) - from_shareholder.append('share_balance', { - 'share_type': self.share_type, - 'from_no': self.from_no, - 'to_no': self.to_no, - 'rate': self.rate, - 'amount': self.amount, - 'no_of_shares': self.no_of_shares - }) + from_shareholder.append( + "share_balance", + { + "share_type": self.share_type, + "from_no": self.from_no, + "to_no": self.to_no, + "rate": self.rate, + "amount": self.amount, + "no_of_shares": self.no_of_shares, + }, + ) from_shareholder.save() def validate(self): @@ -106,90 +126,96 @@ class ShareTransfer(Document): self.basic_validations() self.folio_no_validation() - if self.transfer_type == 'Issue': + if self.transfer_type == "Issue": # validate share doesn't exist in company ret_val = self.share_exists(self.get_company_shareholder().name) - if ret_val in ('Complete', 'Partial'): - frappe.throw(_('The shares already exist'), frappe.DuplicateEntryError) + if ret_val in ("Complete", "Partial"): + frappe.throw(_("The shares already exist"), frappe.DuplicateEntryError) else: # validate share exists with from_shareholder ret_val = self.share_exists(self.from_shareholder) - if ret_val in ('Outside', 'Partial'): - frappe.throw(_("The shares don't exist with the {0}") - .format(self.from_shareholder), ShareDontExists) + if ret_val in ("Outside", "Partial"): + frappe.throw( + _("The shares don't exist with the {0}").format(self.from_shareholder), ShareDontExists + ) def basic_validations(self): - if self.transfer_type == 'Purchase': - self.to_shareholder = '' + if self.transfer_type == "Purchase": + self.to_shareholder = "" if not self.from_shareholder: - frappe.throw(_('The field From Shareholder cannot be blank')) + frappe.throw(_("The field From Shareholder cannot be blank")) if not self.from_folio_no: self.to_folio_no = self.autoname_folio(self.to_shareholder) if not self.asset_account: - frappe.throw(_('The field Asset Account cannot be blank')) - elif (self.transfer_type == 'Issue'): - self.from_shareholder = '' + frappe.throw(_("The field Asset Account cannot be blank")) + elif self.transfer_type == "Issue": + self.from_shareholder = "" if not self.to_shareholder: - frappe.throw(_('The field To Shareholder cannot be blank')) + frappe.throw(_("The field To Shareholder cannot be blank")) if not self.to_folio_no: self.to_folio_no = self.autoname_folio(self.to_shareholder) if not self.asset_account: - frappe.throw(_('The field Asset Account cannot be blank')) + frappe.throw(_("The field Asset Account cannot be blank")) else: if not self.from_shareholder or not self.to_shareholder: - frappe.throw(_('The fields From Shareholder and To Shareholder cannot be blank')) + frappe.throw(_("The fields From Shareholder and To Shareholder cannot be blank")) if not self.to_folio_no: self.to_folio_no = self.autoname_folio(self.to_shareholder) if not self.equity_or_liability_account: - frappe.throw(_('The field Equity/Liability Account cannot be blank')) + frappe.throw(_("The field Equity/Liability Account cannot be blank")) if self.from_shareholder == self.to_shareholder: - frappe.throw(_('The seller and the buyer cannot be the same')) + frappe.throw(_("The seller and the buyer cannot be the same")) if self.no_of_shares != self.to_no - self.from_no + 1: - frappe.throw(_('The number of shares and the share numbers are inconsistent')) + frappe.throw(_("The number of shares and the share numbers are inconsistent")) if not self.amount: self.amount = self.rate * self.no_of_shares if self.amount != self.rate * self.no_of_shares: - frappe.throw(_('There are inconsistencies between the rate, no of shares and the amount calculated')) + frappe.throw( + _("There are inconsistencies between the rate, no of shares and the amount calculated") + ) def share_exists(self, shareholder): doc = self.get_shareholder_doc(shareholder) for entry in doc.share_balance: - if entry.share_type != self.share_type or \ - entry.from_no > self.to_no or \ - entry.to_no < self.from_no: - continue # since query lies outside bounds - elif entry.from_no <= self.from_no and entry.to_no >= self.to_no: #both inside - return 'Complete' # absolute truth! + if ( + entry.share_type != self.share_type or entry.from_no > self.to_no or entry.to_no < self.from_no + ): + continue # since query lies outside bounds + elif entry.from_no <= self.from_no and entry.to_no >= self.to_no: # both inside + return "Complete" # absolute truth! elif entry.from_no <= self.from_no <= self.to_no: - return 'Partial' + return "Partial" elif entry.from_no <= self.to_no <= entry.to_no: - return 'Partial' + return "Partial" - return 'Outside' + return "Outside" def folio_no_validation(self): - shareholder_fields = ['from_shareholder', 'to_shareholder'] + shareholder_fields = ["from_shareholder", "to_shareholder"] for shareholder_field in shareholder_fields: shareholder_name = self.get(shareholder_field) if not shareholder_name: continue doc = self.get_shareholder_doc(shareholder_name) if doc.company != self.company: - frappe.throw(_('The shareholder does not belong to this company')) + frappe.throw(_("The shareholder does not belong to this company")) if not doc.folio_no: - doc.folio_no = self.from_folio_no \ - if (shareholder_field == 'from_shareholder') else self.to_folio_no + doc.folio_no = ( + self.from_folio_no if (shareholder_field == "from_shareholder") else self.to_folio_no + ) doc.save() else: - if doc.folio_no and doc.folio_no != (self.from_folio_no if (shareholder_field == 'from_shareholder') else self.to_folio_no): - frappe.throw(_('The folio numbers are not matching')) + if doc.folio_no and doc.folio_no != ( + self.from_folio_no if (shareholder_field == "from_shareholder") else self.to_folio_no + ): + frappe.throw(_("The folio numbers are not matching")) def autoname_folio(self, shareholder, is_company=False): if is_company: doc = self.get_company_shareholder() else: doc = self.get_shareholder_doc(shareholder) - doc.folio_no = make_autoname('FN.#####') + doc.folio_no = make_autoname("FN.#####") doc.save() return doc.folio_no @@ -197,106 +223,120 @@ class ShareTransfer(Document): # query = {'from_no': share_starting_no, 'to_no': share_ending_no} # Shares exist for sure # Iterate over all entries and modify entry if in entry - doc = frappe.get_doc('Shareholder', shareholder) + doc = frappe.get_doc("Shareholder", shareholder) current_entries = doc.share_balance new_entries = [] for entry in current_entries: # use spaceage logic here - if entry.share_type != self.share_type or \ - entry.from_no > self.to_no or \ - entry.to_no < self.from_no: + if ( + entry.share_type != self.share_type or entry.from_no > self.to_no or entry.to_no < self.from_no + ): new_entries.append(entry) - continue # since query lies outside bounds + continue # since query lies outside bounds elif entry.from_no <= self.from_no and entry.to_no >= self.to_no: - #split + # split if entry.from_no == self.from_no: if entry.to_no == self.to_no: - pass #nothing to append + pass # nothing to append else: - new_entries.append(self.return_share_balance_entry(self.to_no+1, entry.to_no, entry.rate)) + new_entries.append(self.return_share_balance_entry(self.to_no + 1, entry.to_no, entry.rate)) else: if entry.to_no == self.to_no: - new_entries.append(self.return_share_balance_entry(entry.from_no, self.from_no-1, entry.rate)) + new_entries.append( + self.return_share_balance_entry(entry.from_no, self.from_no - 1, entry.rate) + ) else: - new_entries.append(self.return_share_balance_entry(entry.from_no, self.from_no-1, entry.rate)) - new_entries.append(self.return_share_balance_entry(self.to_no+1, entry.to_no, entry.rate)) + new_entries.append( + self.return_share_balance_entry(entry.from_no, self.from_no - 1, entry.rate) + ) + new_entries.append(self.return_share_balance_entry(self.to_no + 1, entry.to_no, entry.rate)) elif entry.from_no >= self.from_no and entry.to_no <= self.to_no: # split and check - pass #nothing to append + pass # nothing to append elif self.from_no <= entry.from_no <= self.to_no and entry.to_no >= self.to_no: - new_entries.append(self.return_share_balance_entry(self.to_no+1, entry.to_no, entry.rate)) + new_entries.append(self.return_share_balance_entry(self.to_no + 1, entry.to_no, entry.rate)) elif self.from_no <= entry.to_no <= self.to_no and entry.from_no <= self.from_no: - new_entries.append(self.return_share_balance_entry(entry.from_no, self.from_no-1, entry.rate)) + new_entries.append( + self.return_share_balance_entry(entry.from_no, self.from_no - 1, entry.rate) + ) else: new_entries.append(entry) doc.share_balance = [] for entry in new_entries: - doc.append('share_balance', entry) + doc.append("share_balance", entry) doc.save() def return_share_balance_entry(self, from_no, to_no, rate): # return an entry as a dict return { - 'share_type' : self.share_type, - 'from_no' : from_no, - 'to_no' : to_no, - 'rate' : rate, - 'amount' : self.rate * (to_no - from_no + 1), - 'no_of_shares' : to_no - from_no + 1 + "share_type": self.share_type, + "from_no": from_no, + "to_no": to_no, + "rate": rate, + "amount": self.rate * (to_no - from_no + 1), + "no_of_shares": to_no - from_no + 1, } def get_shareholder_doc(self, shareholder): # Get Shareholder doc based on the Shareholder name if shareholder: - query_filters = {'name': shareholder} + query_filters = {"name": shareholder} - name = frappe.db.get_value('Shareholder', {'name': shareholder}, 'name') + name = frappe.db.get_value("Shareholder", {"name": shareholder}, "name") - return frappe.get_doc('Shareholder', name) + return frappe.get_doc("Shareholder", name) def get_company_shareholder(self): # Get company doc or create one if not present - company_shareholder = frappe.db.get_value('Shareholder', - { - 'company': self.company, - 'is_company': 1 - }, 'name') + company_shareholder = frappe.db.get_value( + "Shareholder", {"company": self.company, "is_company": 1}, "name" + ) if company_shareholder: - return frappe.get_doc('Shareholder', company_shareholder) + return frappe.get_doc("Shareholder", company_shareholder) else: - shareholder = frappe.get_doc({ - 'doctype': 'Shareholder', - 'title': self.company, - 'company': self.company, - 'is_company': 1 - }) + shareholder = frappe.get_doc( + {"doctype": "Shareholder", "title": self.company, "company": self.company, "is_company": 1} + ) shareholder.insert() return shareholder + @frappe.whitelist() -def make_jv_entry( company, account, amount, payment_account,\ - credit_applicant_type, credit_applicant, debit_applicant_type, debit_applicant): - journal_entry = frappe.new_doc('Journal Entry') - journal_entry.voucher_type = 'Journal Entry' +def make_jv_entry( + company, + account, + amount, + payment_account, + credit_applicant_type, + credit_applicant, + debit_applicant_type, + debit_applicant, +): + journal_entry = frappe.new_doc("Journal Entry") + journal_entry.voucher_type = "Journal Entry" journal_entry.company = company journal_entry.posting_date = nowdate() account_amt_list = [] - account_amt_list.append({ - "account": account, - "debit_in_account_currency": amount, - "party_type": debit_applicant_type, - "party": debit_applicant, - }) - account_amt_list.append({ - "account": payment_account, - "credit_in_account_currency": amount, - "party_type": credit_applicant_type, - "party": credit_applicant, - }) + account_amt_list.append( + { + "account": account, + "debit_in_account_currency": amount, + "party_type": debit_applicant_type, + "party": debit_applicant, + } + ) + account_amt_list.append( + { + "account": payment_account, + "credit_in_account_currency": amount, + "party_type": credit_applicant_type, + "party": credit_applicant, + } + ) journal_entry.set("accounts", account_amt_list) return journal_entry.as_dict() diff --git a/erpnext/accounts/doctype/share_transfer/test_share_transfer.py b/erpnext/accounts/doctype/share_transfer/test_share_transfer.py index bc3a52167db..97310743605 100644 --- a/erpnext/accounts/doctype/share_transfer/test_share_transfer.py +++ b/erpnext/accounts/doctype/share_transfer/test_share_transfer.py @@ -9,6 +9,7 @@ from erpnext.accounts.doctype.share_transfer.share_transfer import ShareDontExis test_dependencies = ["Share Type", "Shareholder"] + class TestShareTransfer(unittest.TestCase): def setUp(self): frappe.db.sql("delete from `tabShare Transfer`") @@ -26,7 +27,7 @@ class TestShareTransfer(unittest.TestCase): "rate": 10, "company": "_Test Company", "asset_account": "Cash - _TC", - "equity_or_liability_account": "Creditors - _TC" + "equity_or_liability_account": "Creditors - _TC", }, { "doctype": "Share Transfer", @@ -40,7 +41,7 @@ class TestShareTransfer(unittest.TestCase): "no_of_shares": 100, "rate": 15, "company": "_Test Company", - "equity_or_liability_account": "Creditors - _TC" + "equity_or_liability_account": "Creditors - _TC", }, { "doctype": "Share Transfer", @@ -54,7 +55,7 @@ class TestShareTransfer(unittest.TestCase): "no_of_shares": 300, "rate": 20, "company": "_Test Company", - "equity_or_liability_account": "Creditors - _TC" + "equity_or_liability_account": "Creditors - _TC", }, { "doctype": "Share Transfer", @@ -68,7 +69,7 @@ class TestShareTransfer(unittest.TestCase): "no_of_shares": 200, "rate": 15, "company": "_Test Company", - "equity_or_liability_account": "Creditors - _TC" + "equity_or_liability_account": "Creditors - _TC", }, { "doctype": "Share Transfer", @@ -82,42 +83,46 @@ class TestShareTransfer(unittest.TestCase): "rate": 25, "company": "_Test Company", "asset_account": "Cash - _TC", - "equity_or_liability_account": "Creditors - _TC" - } + "equity_or_liability_account": "Creditors - _TC", + }, ] for d in share_transfers: st = frappe.get_doc(d) st.submit() def test_invalid_share_transfer(self): - doc = frappe.get_doc({ - "doctype": "Share Transfer", - "transfer_type": "Transfer", - "date": "2018-01-05", - "from_shareholder": "SH-00003", - "to_shareholder": "SH-00002", - "share_type": "Equity", - "from_no": 1, - "to_no": 100, - "no_of_shares": 100, - "rate": 15, - "company": "_Test Company", - "equity_or_liability_account": "Creditors - _TC" - }) + doc = frappe.get_doc( + { + "doctype": "Share Transfer", + "transfer_type": "Transfer", + "date": "2018-01-05", + "from_shareholder": "SH-00003", + "to_shareholder": "SH-00002", + "share_type": "Equity", + "from_no": 1, + "to_no": 100, + "no_of_shares": 100, + "rate": 15, + "company": "_Test Company", + "equity_or_liability_account": "Creditors - _TC", + } + ) self.assertRaises(ShareDontExists, doc.insert) - doc = frappe.get_doc({ - "doctype": "Share Transfer", - "transfer_type": "Purchase", - "date": "2018-01-02", - "from_shareholder": "SH-00001", - "share_type": "Equity", - "from_no": 1, - "to_no": 200, - "no_of_shares": 200, - "rate": 15, - "company": "_Test Company", - "asset_account": "Cash - _TC", - "equity_or_liability_account": "Creditors - _TC" - }) + doc = frappe.get_doc( + { + "doctype": "Share Transfer", + "transfer_type": "Purchase", + "date": "2018-01-02", + "from_shareholder": "SH-00001", + "share_type": "Equity", + "from_no": 1, + "to_no": 200, + "no_of_shares": 200, + "rate": 15, + "company": "_Test Company", + "asset_account": "Cash - _TC", + "equity_or_liability_account": "Creditors - _TC", + } + ) self.assertRaises(ShareDontExists, doc.insert) diff --git a/erpnext/accounts/doctype/share_type/share_type_dashboard.py b/erpnext/accounts/doctype/share_type/share_type_dashboard.py index fdb417ed6d0..19604b332a3 100644 --- a/erpnext/accounts/doctype/share_type/share_type_dashboard.py +++ b/erpnext/accounts/doctype/share_type/share_type_dashboard.py @@ -1,14 +1,8 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'share_type', - 'transactions': [ - { - 'label': _('References'), - 'items': ['Share Transfer', 'Shareholder'] - } - ] + "fieldname": "share_type", + "transactions": [{"label": _("References"), "items": ["Share Transfer", "Shareholder"]}], } diff --git a/erpnext/accounts/doctype/shareholder/shareholder.py b/erpnext/accounts/doctype/shareholder/shareholder.py index 8a0fa85a692..b0e2493f7a6 100644 --- a/erpnext/accounts/doctype/shareholder/shareholder.py +++ b/erpnext/accounts/doctype/shareholder/shareholder.py @@ -15,7 +15,7 @@ class Shareholder(Document): load_address_and_contact(self) def on_trash(self): - delete_contact_and_address('Shareholder', self.name) + delete_contact_and_address("Shareholder", self.name) def before_save(self): for entry in self.share_balance: diff --git a/erpnext/accounts/doctype/shareholder/shareholder_dashboard.py b/erpnext/accounts/doctype/shareholder/shareholder_dashboard.py index 44d5ec684fb..fa9d431c19e 100644 --- a/erpnext/accounts/doctype/shareholder/shareholder_dashboard.py +++ b/erpnext/accounts/doctype/shareholder/shareholder_dashboard.py @@ -1,14 +1,6 @@ - - def get_data(): return { - 'fieldname': 'shareholder', - 'non_standard_fieldnames': { - 'Share Transfer': 'to_shareholder' - }, - 'transactions': [ - { - 'items': ['Share Transfer'] - } - ] + "fieldname": "shareholder", + "non_standard_fieldnames": {"Share Transfer": "to_shareholder"}, + "transactions": [{"items": ["Share Transfer"]}], } diff --git a/erpnext/accounts/doctype/shipping_rule/shipping_rule.py b/erpnext/accounts/doctype/shipping_rule/shipping_rule.py index 7e5129911e4..1d79503a05e 100644 --- a/erpnext/accounts/doctype/shipping_rule/shipping_rule.py +++ b/erpnext/accounts/doctype/shipping_rule/shipping_rule.py @@ -12,9 +12,17 @@ from frappe.utils import flt, fmt_money import erpnext -class OverlappingConditionError(frappe.ValidationError): pass -class FromGreaterThanToError(frappe.ValidationError): pass -class ManyBlankToValuesError(frappe.ValidationError): pass +class OverlappingConditionError(frappe.ValidationError): + pass + + +class FromGreaterThanToError(frappe.ValidationError): + pass + + +class ManyBlankToValuesError(frappe.ValidationError): + pass + class ShippingRule(Document): def validate(self): @@ -35,15 +43,19 @@ class ShippingRule(Document): if not d.to_value: zero_to_values.append(d) elif d.from_value >= d.to_value: - throw(_("From value must be less than to value in row {0}").format(d.idx), FromGreaterThanToError) + throw( + _("From value must be less than to value in row {0}").format(d.idx), FromGreaterThanToError + ) # check if more than two or more rows has To Value = 0 if len(zero_to_values) >= 2: - throw(_('There can only be one Shipping Rule Condition with 0 or blank value for "To Value"'), - ManyBlankToValuesError) + throw( + _('There can only be one Shipping Rule Condition with 0 or blank value for "To Value"'), + ManyBlankToValuesError, + ) def apply(self, doc): - '''Apply shipping rule on given doc. Called from accounts controller''' + """Apply shipping rule on given doc. Called from accounts controller""" shipping_amount = 0.0 by_value = False @@ -52,15 +64,15 @@ class ShippingRule(Document): # validate country only if there is address self.validate_countries(doc) - if self.calculate_based_on == 'Net Total': + if self.calculate_based_on == "Net Total": value = doc.base_net_total by_value = True - elif self.calculate_based_on == 'Net Weight': + elif self.calculate_based_on == "Net Weight": value = doc.total_net_weight by_value = True - elif self.calculate_based_on == 'Fixed': + elif self.calculate_based_on == "Fixed": shipping_amount = self.shipping_amount # shipping amount by value, apply conditions @@ -75,7 +87,9 @@ class ShippingRule(Document): def get_shipping_amount_from_rules(self, value): for condition in self.get("conditions"): - if not condition.to_value or (flt(condition.from_value) <= flt(value) <= flt(condition.to_value)): + if not condition.to_value or ( + flt(condition.from_value) <= flt(value) <= flt(condition.to_value) + ): return condition.shipping_amount return 0.0 @@ -83,27 +97,31 @@ class ShippingRule(Document): def validate_countries(self, doc): # validate applicable countries if self.countries: - shipping_country = doc.get_shipping_address().get('country') + shipping_country = doc.get_shipping_address().get("country") if not shipping_country: - frappe.throw(_('Shipping Address does not have country, which is required for this Shipping Rule')) + frappe.throw( + _("Shipping Address does not have country, which is required for this Shipping Rule") + ) if shipping_country not in [d.country for d in self.countries]: - frappe.throw(_('Shipping rule not applicable for country {0} in Shipping Address').format(shipping_country)) + frappe.throw( + _("Shipping rule not applicable for country {0} in Shipping Address").format(shipping_country) + ) def add_shipping_rule_to_tax_table(self, doc, shipping_amount): shipping_charge = { "charge_type": "Actual", "account_head": self.account, - "cost_center": self.cost_center + "cost_center": self.cost_center, } if self.shipping_rule_type == "Selling": # check if not applied on purchase - if not doc.meta.get_field('taxes').options == 'Sales Taxes and Charges': - frappe.throw(_('Shipping rule only applicable for Selling')) + if not doc.meta.get_field("taxes").options == "Sales Taxes and Charges": + frappe.throw(_("Shipping rule only applicable for Selling")) shipping_charge["doctype"] = "Sales Taxes and Charges" else: # check if not applied on sales - if not doc.meta.get_field('taxes').options == 'Purchase Taxes and Charges': - frappe.throw(_('Shipping rule only applicable for Buying')) + if not doc.meta.get_field("taxes").options == "Purchase Taxes and Charges": + frappe.throw(_("Shipping rule only applicable for Buying")) shipping_charge["doctype"] = "Purchase Taxes and Charges" shipping_charge["category"] = "Valuation and Total" @@ -127,19 +145,19 @@ class ShippingRule(Document): def validate_overlapping_shipping_rule_conditions(self): def overlap_exists_between(num_range1, num_range2): """ - num_range1 and num_range2 are two ranges - ranges are represented as a tuple e.g. range 100 to 300 is represented as (100, 300) - if condition num_range1 = 100 to 300 - then condition num_range2 can only be like 50 to 99 or 301 to 400 - hence, non-overlapping condition = (x1 <= x2 < y1 <= y2) or (y1 <= y2 < x1 <= x2) + num_range1 and num_range2 are two ranges + ranges are represented as a tuple e.g. range 100 to 300 is represented as (100, 300) + if condition num_range1 = 100 to 300 + then condition num_range2 can only be like 50 to 99 or 301 to 400 + hence, non-overlapping condition = (x1 <= x2 < y1 <= y2) or (y1 <= y2 < x1 <= x2) """ (x1, x2), (y1, y2) = num_range1, num_range2 separate = (x1 <= x2 <= y1 <= y2) or (y1 <= y2 <= x1 <= x2) - return (not separate) + return not separate overlaps = [] for i in range(0, len(self.conditions)): - for j in range(i+1, len(self.conditions)): + for j in range(i + 1, len(self.conditions)): d1, d2 = self.conditions[i], self.conditions[j] if d1.as_dict() != d2.as_dict(): # in our case, to_value can be zero, hence pass the from_value if so @@ -153,7 +171,12 @@ class ShippingRule(Document): msgprint(_("Overlapping conditions found between:")) messages = [] for d1, d2 in overlaps: - messages.append("%s-%s = %s " % (d1.from_value, d1.to_value, fmt_money(d1.shipping_amount, currency=company_currency)) + - _("and") + " %s-%s = %s" % (d2.from_value, d2.to_value, fmt_money(d2.shipping_amount, currency=company_currency))) + messages.append( + "%s-%s = %s " + % (d1.from_value, d1.to_value, fmt_money(d1.shipping_amount, currency=company_currency)) + + _("and") + + " %s-%s = %s" + % (d2.from_value, d2.to_value, fmt_money(d2.shipping_amount, currency=company_currency)) + ) msgprint("\n".join(messages), raise_exception=OverlappingConditionError) diff --git a/erpnext/accounts/doctype/shipping_rule/shipping_rule_dashboard.py b/erpnext/accounts/doctype/shipping_rule/shipping_rule_dashboard.py index ef2a053227b..60ce120c54f 100644 --- a/erpnext/accounts/doctype/shipping_rule/shipping_rule_dashboard.py +++ b/erpnext/accounts/doctype/shipping_rule/shipping_rule_dashboard.py @@ -1,25 +1,13 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'shipping_rule', - 'non_standard_fieldnames': { - 'Payment Entry': 'party_name' - }, - 'transactions': [ - { - 'label': _('Pre Sales'), - 'items': ['Quotation', 'Supplier Quotation'] - }, - { - 'label': _('Sales'), - 'items': ['Sales Order', 'Delivery Note', 'Sales Invoice'] - }, - { - 'label': _('Purchase'), - 'items': ['Purchase Invoice', 'Purchase Order', 'Purchase Receipt'] - } - ] + "fieldname": "shipping_rule", + "non_standard_fieldnames": {"Payment Entry": "party_name"}, + "transactions": [ + {"label": _("Pre Sales"), "items": ["Quotation", "Supplier Quotation"]}, + {"label": _("Sales"), "items": ["Sales Order", "Delivery Note", "Sales Invoice"]}, + {"label": _("Purchase"), "items": ["Purchase Invoice", "Purchase Order", "Purchase Receipt"]}, + ], } diff --git a/erpnext/accounts/doctype/shipping_rule/test_shipping_rule.py b/erpnext/accounts/doctype/shipping_rule/test_shipping_rule.py index c06dae09701..a24e834c572 100644 --- a/erpnext/accounts/doctype/shipping_rule/test_shipping_rule.py +++ b/erpnext/accounts/doctype/shipping_rule/test_shipping_rule.py @@ -11,18 +11,19 @@ from erpnext.accounts.doctype.shipping_rule.shipping_rule import ( OverlappingConditionError, ) -test_records = frappe.get_test_records('Shipping Rule') +test_records = frappe.get_test_records("Shipping Rule") + class TestShippingRule(unittest.TestCase): def test_from_greater_than_to(self): shipping_rule = frappe.copy_doc(test_records[0]) - shipping_rule.name = test_records[0].get('name') + shipping_rule.name = test_records[0].get("name") shipping_rule.get("conditions")[0].from_value = 101 self.assertRaises(FromGreaterThanToError, shipping_rule.insert) def test_many_zero_to_values(self): shipping_rule = frappe.copy_doc(test_records[0]) - shipping_rule.name = test_records[0].get('name') + shipping_rule.name = test_records[0].get("name") shipping_rule.get("conditions")[0].to_value = 0 self.assertRaises(ManyBlankToValuesError, shipping_rule.insert) @@ -35,48 +36,58 @@ class TestShippingRule(unittest.TestCase): ((50, 150), (50, 150)), ]: shipping_rule = frappe.copy_doc(test_records[0]) - shipping_rule.name = test_records[0].get('name') + shipping_rule.name = test_records[0].get("name") shipping_rule.get("conditions")[0].from_value = range_a[0] shipping_rule.get("conditions")[0].to_value = range_a[1] shipping_rule.get("conditions")[1].from_value = range_b[0] shipping_rule.get("conditions")[1].to_value = range_b[1] self.assertRaises(OverlappingConditionError, shipping_rule.insert) + def create_shipping_rule(shipping_rule_type, shipping_rule_name): if frappe.db.exists("Shipping Rule", shipping_rule_name): return frappe.get_doc("Shipping Rule", shipping_rule_name) sr = frappe.new_doc("Shipping Rule") - sr.account = "_Test Account Shipping Charges - _TC" - sr.calculate_based_on = "Net Total" + sr.account = "_Test Account Shipping Charges - _TC" + sr.calculate_based_on = "Net Total" sr.company = "_Test Company" sr.cost_center = "_Test Cost Center - _TC" sr.label = shipping_rule_name sr.name = shipping_rule_name sr.shipping_rule_type = shipping_rule_type - sr.append("conditions", { + sr.append( + "conditions", + { "doctype": "Shipping Rule Condition", "from_value": 0, "parentfield": "conditions", "shipping_amount": 50.0, - "to_value": 100 - }) - sr.append("conditions", { + "to_value": 100, + }, + ) + sr.append( + "conditions", + { "doctype": "Shipping Rule Condition", "from_value": 101, "parentfield": "conditions", "shipping_amount": 100.0, - "to_value": 200 - }) - sr.append("conditions", { + "to_value": 200, + }, + ) + sr.append( + "conditions", + { "doctype": "Shipping Rule Condition", "from_value": 201, "parentfield": "conditions", "shipping_amount": 200.0, - "to_value": 2000 - }) + "to_value": 2000, + }, + ) sr.insert(ignore_permissions=True) sr.submit() return sr diff --git a/erpnext/accounts/doctype/subscription/subscription.py b/erpnext/accounts/doctype/subscription/subscription.py index 5942ce5d637..62ffc79fee8 100644 --- a/erpnext/accounts/doctype/subscription/subscription.py +++ b/erpnext/accounts/doctype/subscription/subscription.py @@ -1,4 +1,3 @@ - # Copyright (c) 2018, Frappe Technologies Pvt. Ltd. and contributors # For license information, please see license.txt @@ -24,6 +23,7 @@ from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import ( get_accounting_dimensions, ) from erpnext.accounts.doctype.subscription_plan.subscription_plan import get_plan_rate +from erpnext.accounts.party import get_party_account_currency class Subscription(Document): @@ -60,7 +60,11 @@ class Subscription(Document): """ _current_invoice_start = None - if self.is_new_subscription() and self.trial_period_end and getdate(self.trial_period_end) > getdate(self.start_date): + if ( + self.is_new_subscription() + and self.trial_period_end + and getdate(self.trial_period_end) > getdate(self.start_date) + ): _current_invoice_start = add_days(self.trial_period_end, 1) elif self.trial_period_start and self.is_trialling(): _current_invoice_start = self.trial_period_start @@ -102,7 +106,7 @@ class Subscription(Document): if self.follow_calendar_months: billing_info = self.get_billing_cycle_and_interval() - billing_interval_count = billing_info[0]['billing_interval_count'] + billing_interval_count = billing_info[0]["billing_interval_count"] calendar_months = get_calendar_months(billing_interval_count) calendar_month = 0 current_invoice_end_month = getdate(_current_invoice_end).month @@ -112,12 +116,13 @@ class Subscription(Document): if month <= current_invoice_end_month: calendar_month = month - if cint(calendar_month - billing_interval_count) <= 0 and \ - getdate(date).month != 1: + if cint(calendar_month - billing_interval_count) <= 0 and getdate(date).month != 1: calendar_month = 12 current_invoice_end_year -= 1 - _current_invoice_end = get_last_day(cstr(current_invoice_end_year) + '-' + cstr(calendar_month) + '-01') + _current_invoice_end = get_last_day( + cstr(current_invoice_end_year) + "-" + cstr(calendar_month) + "-01" + ) if self.end_date and getdate(_current_invoice_end) > getdate(self.end_date): _current_invoice_end = self.end_date @@ -131,7 +136,7 @@ class Subscription(Document): same billing interval """ if billing_cycle_data and len(billing_cycle_data) != 1: - frappe.throw(_('You can only have Plans with the same billing cycle in a Subscription')) + frappe.throw(_("You can only have Plans with the same billing cycle in a Subscription")) def get_billing_cycle_and_interval(self): """ @@ -141,10 +146,11 @@ class Subscription(Document): """ plan_names = [plan.plan for plan in self.plans] billing_info = frappe.db.sql( - 'select distinct `billing_interval`, `billing_interval_count` ' - 'from `tabSubscription Plan` ' - 'where name in %s', - (plan_names,), as_dict=1 + "select distinct `billing_interval`, `billing_interval_count` " + "from `tabSubscription Plan` " + "where name in %s", + (plan_names,), + as_dict=1, ) return billing_info @@ -161,19 +167,19 @@ class Subscription(Document): if billing_info: data = dict() - interval = billing_info[0]['billing_interval'] - interval_count = billing_info[0]['billing_interval_count'] - if interval not in ['Day', 'Week']: - data['days'] = -1 - if interval == 'Day': - data['days'] = interval_count - 1 - elif interval == 'Month': - data['months'] = interval_count - elif interval == 'Year': - data['years'] = interval_count + interval = billing_info[0]["billing_interval"] + interval_count = billing_info[0]["billing_interval_count"] + if interval not in ["Day", "Week"]: + data["days"] = -1 + if interval == "Day": + data["days"] = interval_count - 1 + elif interval == "Month": + data["months"] = interval_count + elif interval == "Year": + data["years"] = interval_count # todo: test week - elif interval == 'Week': - data['days'] = interval_count * 7 - 1 + elif interval == "Week": + data["days"] = interval_count * 7 - 1 return data @@ -184,27 +190,27 @@ class Subscription(Document): Used when the `Subscription` needs to decide what to do after the current generated invoice is past it's due date and grace period. """ - subscription_settings = frappe.get_single('Subscription Settings') - if self.status == 'Past Due Date' and self.is_past_grace_period(): - self.status = 'Cancelled' if cint(subscription_settings.cancel_after_grace) else 'Unpaid' + subscription_settings = frappe.get_single("Subscription Settings") + if self.status == "Past Due Date" and self.is_past_grace_period(): + self.status = "Cancelled" if cint(subscription_settings.cancel_after_grace) else "Unpaid" def set_subscription_status(self): """ Sets the status of the `Subscription` """ if self.is_trialling(): - self.status = 'Trialling' - elif self.status == 'Active' and self.end_date and getdate() > getdate(self.end_date): - self.status = 'Completed' + self.status = "Trialling" + elif self.status == "Active" and self.end_date and getdate() > getdate(self.end_date): + self.status = "Completed" elif self.is_past_grace_period(): - subscription_settings = frappe.get_single('Subscription Settings') - self.status = 'Cancelled' if cint(subscription_settings.cancel_after_grace) else 'Unpaid' + subscription_settings = frappe.get_single("Subscription Settings") + self.status = "Cancelled" if cint(subscription_settings.cancel_after_grace) else "Unpaid" elif self.current_invoice_is_past_due() and not self.is_past_grace_period(): - self.status = 'Past Due Date' + self.status = "Past Due Date" elif not self.has_outstanding_invoice(): - self.status = 'Active' + self.status = "Active" elif self.is_new_subscription(): - self.status = 'Active' + self.status = "Active" self.save() def is_trialling(self): @@ -231,7 +237,7 @@ class Subscription(Document): """ current_invoice = self.get_current_invoice() if self.current_invoice_is_past_due(current_invoice): - subscription_settings = frappe.get_single('Subscription Settings') + subscription_settings = frappe.get_single("Subscription Settings") grace_period = cint(subscription_settings.grace_period) return getdate() > add_days(current_invoice.due_date, grace_period) @@ -252,15 +258,15 @@ class Subscription(Document): """ Returns the most recent generated invoice. """ - doctype = 'Sales Invoice' if self.party_type == 'Customer' else 'Purchase Invoice' + doctype = "Sales Invoice" if self.party_type == "Customer" else "Purchase Invoice" if len(self.invoices): current = self.invoices[-1] - if frappe.db.exists(doctype, current.get('invoice')): - doc = frappe.get_doc(doctype, current.get('invoice')) + if frappe.db.exists(doctype, current.get("invoice")): + doc = frappe.get_doc(doctype, current.get("invoice")) return doc else: - frappe.throw(_('Invoice {0} no longer exists').format(current.get('invoice'))) + frappe.throw(_("Invoice {0} no longer exists").format(current.get("invoice"))) def is_new_subscription(self): """ @@ -273,7 +279,7 @@ class Subscription(Document): self.validate_plans_billing_cycle(self.get_billing_cycle_and_interval()) self.validate_end_date() self.validate_to_follow_calendar_months() - self.cost_center = erpnext.get_default_cost_center(self.get('company')) + self.cost_center = erpnext.get_default_cost_center(self.get("company")) def validate_trial_period(self): """ @@ -281,30 +287,34 @@ class Subscription(Document): """ if self.trial_period_start and self.trial_period_end: if getdate(self.trial_period_end) < getdate(self.trial_period_start): - frappe.throw(_('Trial Period End Date Cannot be before Trial Period Start Date')) + frappe.throw(_("Trial Period End Date Cannot be before Trial Period Start Date")) if self.trial_period_start and not self.trial_period_end: - frappe.throw(_('Both Trial Period Start Date and Trial Period End Date must be set')) + frappe.throw(_("Both Trial Period Start Date and Trial Period End Date must be set")) if self.trial_period_start and getdate(self.trial_period_start) > getdate(self.start_date): - frappe.throw(_('Trial Period Start date cannot be after Subscription Start Date')) + frappe.throw(_("Trial Period Start date cannot be after Subscription Start Date")) def validate_end_date(self): billing_cycle_info = self.get_billing_cycle_data() end_date = add_to_date(self.start_date, **billing_cycle_info) if self.end_date and getdate(self.end_date) <= getdate(end_date): - frappe.throw(_('Subscription End Date must be after {0} as per the subscription plan').format(end_date)) + frappe.throw( + _("Subscription End Date must be after {0} as per the subscription plan").format(end_date) + ) def validate_to_follow_calendar_months(self): if self.follow_calendar_months: billing_info = self.get_billing_cycle_and_interval() if not self.end_date: - frappe.throw(_('Subscription End Date is mandatory to follow calendar months')) + frappe.throw(_("Subscription End Date is mandatory to follow calendar months")) - if billing_info[0]['billing_interval'] != 'Month': - frappe.throw(_('Billing Interval in Subscription Plan must be Month to follow calendar months')) + if billing_info[0]["billing_interval"] != "Month": + frappe.throw( + _("Billing Interval in Subscription Plan must be Month to follow calendar months") + ) def after_insert(self): # todo: deal with users who collect prepayments. Maybe a new Subscription Invoice doctype? @@ -316,13 +326,10 @@ class Subscription(Document): saves the `Subscription`. """ - doctype = 'Sales Invoice' if self.party_type == 'Customer' else 'Purchase Invoice' + doctype = "Sales Invoice" if self.party_type == "Customer" else "Purchase Invoice" invoice = self.create_invoice(prorate) - self.append('invoices', { - 'document_type': doctype, - 'invoice': invoice.name - }) + self.append("invoices", {"document_type": doctype, "invoice": invoice.name}) self.save() @@ -332,52 +339,58 @@ class Subscription(Document): """ Creates a `Invoice`, submits it and returns it """ - doctype = 'Sales Invoice' if self.party_type == 'Customer' else 'Purchase Invoice' + doctype = "Sales Invoice" if self.party_type == "Customer" else "Purchase Invoice" invoice = frappe.new_doc(doctype) # For backward compatibility # Earlier subscription didn't had any company field - company = self.get('company') or get_default_company() + company = self.get("company") or get_default_company() if not company: - frappe.throw(_("Company is mandatory was generating invoice. Please set default company in Global Defaults")) + frappe.throw( + _("Company is mandatory was generating invoice. Please set default company in Global Defaults") + ) invoice.company = company invoice.set_posting_time = 1 - invoice.posting_date = self.current_invoice_start if self.generate_invoice_at_period_start \ + invoice.posting_date = ( + self.current_invoice_start + if self.generate_invoice_at_period_start else self.current_invoice_end + ) invoice.cost_center = self.cost_center - if doctype == 'Sales Invoice': + if doctype == "Sales Invoice": invoice.customer = self.party else: invoice.supplier = self.party - if frappe.db.get_value('Supplier', self.party, 'tax_withholding_category'): + if frappe.db.get_value("Supplier", self.party, "tax_withholding_category"): invoice.apply_tds = 1 - ## Add dimensions in invoice for subscription: + # Add party currency to invoice + invoice.currency = get_party_account_currency(self.party_type, self.party, self.company) + + # Add dimensions in invoice for subscription: accounting_dimensions = get_accounting_dimensions() for dimension in accounting_dimensions: if self.get(dimension): - invoice.update({ - dimension: self.get(dimension) - }) + invoice.update({dimension: self.get(dimension)}) # Subscription is better suited for service items. I won't update `update_stock` # for that reason items_list = self.get_items_from_plans(self.plans, prorate) for item in items_list: - item['cost_center'] = self.cost_center - invoice.append('items', item) + item["cost_center"] = self.cost_center + invoice.append("items", item) # Taxes - tax_template = '' + tax_template = "" - if doctype == 'Sales Invoice' and self.sales_tax_template: + if doctype == "Sales Invoice" and self.sales_tax_template: tax_template = self.sales_tax_template - if doctype == 'Purchase Invoice' and self.purchase_tax_template: + if doctype == "Purchase Invoice" and self.purchase_tax_template: tax_template = self.purchase_tax_template if tax_template: @@ -387,11 +400,11 @@ class Subscription(Document): # Due date if self.days_until_due: invoice.append( - 'payment_schedule', + "payment_schedule", { - 'due_date': add_days(invoice.posting_date, cint(self.days_until_due)), - 'invoice_portion': 100 - } + "due_date": add_days(invoice.posting_date, cint(self.days_until_due)), + "invoice_portion": 100, + }, ) # Discounts @@ -403,7 +416,7 @@ class Subscription(Document): if self.additional_discount_percentage or self.additional_discount_amount: discount_on = self.apply_additional_discount - invoice.apply_discount_on = discount_on if discount_on else 'Grand Total' + invoice.apply_discount_on = discount_on if discount_on else "Grand Total" # Subscription period invoice.from_date = self.current_invoice_start @@ -423,44 +436,62 @@ class Subscription(Document): Returns the `Item`s linked to `Subscription Plan` """ if prorate: - prorate_factor = get_prorata_factor(self.current_invoice_end, self.current_invoice_start, - self.generate_invoice_at_period_start) + prorate_factor = get_prorata_factor( + self.current_invoice_end, self.current_invoice_start, self.generate_invoice_at_period_start + ) items = [] party = self.party for plan in plans: - plan_doc = frappe.get_doc('Subscription Plan', plan.plan) + plan_doc = frappe.get_doc("Subscription Plan", plan.plan) item_code = plan_doc.item - if self.party == 'Customer': - deferred_field = 'enable_deferred_revenue' + if self.party == "Customer": + deferred_field = "enable_deferred_revenue" else: - deferred_field = 'enable_deferred_expense' + deferred_field = "enable_deferred_expense" - deferred = frappe.db.get_value('Item', item_code, deferred_field) + deferred = frappe.db.get_value("Item", item_code, deferred_field) if not prorate: - item = {'item_code': item_code, 'qty': plan.qty, 'rate': get_plan_rate(plan.plan, plan.qty, party, - self.current_invoice_start, self.current_invoice_end), 'cost_center': plan_doc.cost_center} + item = { + "item_code": item_code, + "qty": plan.qty, + "rate": get_plan_rate( + plan.plan, plan.qty, party, self.current_invoice_start, self.current_invoice_end + ), + "cost_center": plan_doc.cost_center, + } else: - item = {'item_code': item_code, 'qty': plan.qty, 'rate': get_plan_rate(plan.plan, plan.qty, party, - self.current_invoice_start, self.current_invoice_end, prorate_factor), 'cost_center': plan_doc.cost_center} + item = { + "item_code": item_code, + "qty": plan.qty, + "rate": get_plan_rate( + plan.plan, + plan.qty, + party, + self.current_invoice_start, + self.current_invoice_end, + prorate_factor, + ), + "cost_center": plan_doc.cost_center, + } if deferred: - item.update({ - deferred_field: deferred, - 'service_start_date': self.current_invoice_start, - 'service_end_date': self.current_invoice_end - }) + item.update( + { + deferred_field: deferred, + "service_start_date": self.current_invoice_start, + "service_end_date": self.current_invoice_end, + } + ) accounting_dimensions = get_accounting_dimensions() for dimension in accounting_dimensions: if plan_doc.get(dimension): - item.update({ - dimension: plan_doc.get(dimension) - }) + item.update({dimension: plan_doc.get(dimension)}) items.append(item) @@ -473,9 +504,9 @@ class Subscription(Document): 1. `process_for_active` 2. `process_for_past_due` """ - if self.status == 'Active': + if self.status == "Active": self.process_for_active() - elif self.status in ['Past Due Date', 'Unpaid']: + elif self.status in ["Past Due Date", "Unpaid"]: self.process_for_past_due_date() self.set_subscription_status() @@ -483,8 +514,10 @@ class Subscription(Document): self.save() def is_postpaid_to_invoice(self): - return getdate() > getdate(self.current_invoice_end) or \ - (getdate() >= getdate(self.current_invoice_end) and getdate(self.current_invoice_end) == getdate(self.current_invoice_start)) + return getdate() > getdate(self.current_invoice_end) or ( + getdate() >= getdate(self.current_invoice_end) + and getdate(self.current_invoice_end) == getdate(self.current_invoice_start) + ) def is_prepaid_to_invoice(self): if not self.generate_invoice_at_period_start: @@ -500,9 +533,13 @@ class Subscription(Document): invoice = self.get_current_invoice() if not (_current_start_date and _current_end_date): - _current_start_date, _current_end_date = self.update_subscription_period(date=add_days(self.current_invoice_end, 1), return_date=True) + _current_start_date, _current_end_date = self.update_subscription_period( + date=add_days(self.current_invoice_end, 1), return_date=True + ) - if invoice and getdate(_current_start_date) <= getdate(invoice.posting_date) <= getdate(_current_end_date): + if invoice and getdate(_current_start_date) <= getdate(invoice.posting_date) <= getdate( + _current_end_date + ): return True return False @@ -517,10 +554,11 @@ class Subscription(Document): 3. Change the `Subscription` status to 'Cancelled' """ - if not self.is_current_invoice_generated(self.current_invoice_start, self.current_invoice_end) \ - and (self.is_postpaid_to_invoice() or self.is_prepaid_to_invoice()): + if not self.is_current_invoice_generated( + self.current_invoice_start, self.current_invoice_end + ) and (self.is_postpaid_to_invoice() or self.is_prepaid_to_invoice()): - prorate = frappe.db.get_single_value('Subscription Settings', 'prorate') + prorate = frappe.db.get_single_value("Subscription Settings", "prorate") self.generate_invoice(prorate) if getdate() > getdate(self.current_invoice_end) and self.is_prepaid_to_invoice(): @@ -536,7 +574,7 @@ class Subscription(Document): if self.end_date and getdate() < getdate(self.end_date): return - self.status = 'Cancelled' + self.status = "Cancelled" if not self.cancelation_date: self.cancelation_date = nowdate() @@ -551,19 +589,21 @@ class Subscription(Document): """ current_invoice = self.get_current_invoice() if not current_invoice: - frappe.throw(_('Current invoice {0} is missing').format(current_invoice.invoice)) + frappe.throw(_("Current invoice {0} is missing").format(current_invoice.invoice)) else: if not self.has_outstanding_invoice(): - self.status = 'Active' + self.status = "Active" else: self.set_status_grace_period() # Generate invoices periodically even if current invoice are unpaid - if self.generate_new_invoices_past_due_date and not \ - self.is_current_invoice_generated(self.current_invoice_start, self.current_invoice_end) \ - and (self.is_postpaid_to_invoice() or self.is_prepaid_to_invoice()): + if ( + self.generate_new_invoices_past_due_date + and not self.is_current_invoice_generated(self.current_invoice_start, self.current_invoice_end) + and (self.is_postpaid_to_invoice() or self.is_prepaid_to_invoice()) + ): - prorate = frappe.db.get_single_value('Subscription Settings', 'prorate') + prorate = frappe.db.get_single_value("Subscription Settings", "prorate") self.generate_invoice(prorate) if getdate() > getdate(self.current_invoice_end): @@ -574,18 +614,19 @@ class Subscription(Document): """ Return `True` if the given invoice is paid """ - return invoice.status == 'Paid' + return invoice.status == "Paid" def has_outstanding_invoice(self): """ Returns `True` if the most recent invoice for the `Subscription` is not paid """ - doctype = 'Sales Invoice' if self.party_type == 'Customer' else 'Purchase Invoice' + doctype = "Sales Invoice" if self.party_type == "Customer" else "Purchase Invoice" current_invoice = self.get_current_invoice() invoice_list = [d.invoice for d in self.invoices] - outstanding_invoices = frappe.get_all(doctype, fields=['name'], - filters={'status': ('!=', 'Paid'), 'name': ('in', invoice_list)}) + outstanding_invoices = frappe.get_all( + doctype, fields=["name"], filters={"status": ("!=", "Paid"), "name": ("in", invoice_list)} + ) if outstanding_invoices: return True @@ -597,10 +638,12 @@ class Subscription(Document): This sets the subscription as cancelled. It will stop invoices from being generated but it will not affect already created invoices. """ - if self.status != 'Cancelled': - to_generate_invoice = True if self.status == 'Active' and not self.generate_invoice_at_period_start else False - to_prorate = frappe.db.get_single_value('Subscription Settings', 'prorate') - self.status = 'Cancelled' + if self.status != "Cancelled": + to_generate_invoice = ( + True if self.status == "Active" and not self.generate_invoice_at_period_start else False + ) + to_prorate = frappe.db.get_single_value("Subscription Settings", "prorate") + self.status = "Cancelled" self.cancelation_date = nowdate() if to_generate_invoice: self.generate_invoice(prorate=to_prorate) @@ -612,19 +655,20 @@ class Subscription(Document): subscription and the `Subscription` will lose all the history of generated invoices it has. """ - if self.status == 'Cancelled': - self.status = 'Active' - self.db_set('start_date', nowdate()) + if self.status == "Cancelled": + self.status = "Active" + self.db_set("start_date", nowdate()) self.update_subscription_period(nowdate()) self.invoices = [] self.save() else: - frappe.throw(_('You cannot restart a Subscription that is not cancelled.')) + frappe.throw(_("You cannot restart a Subscription that is not cancelled.")) def get_precision(self): invoice = self.get_current_invoice() if invoice: - return invoice.precision('grand_total') + return invoice.precision("grand_total") + def get_calendar_months(billing_interval): calendar_months = [] @@ -635,6 +679,7 @@ def get_calendar_months(billing_interval): return calendar_months + def get_prorata_factor(period_end, period_start, is_prepaid): if is_prepaid: prorate_factor = 1 @@ -659,7 +704,7 @@ def get_all_subscriptions(): """ Returns all `Subscription` documents """ - return frappe.db.get_all('Subscription', {'status': ('!=','Cancelled')}) + return frappe.db.get_all("Subscription", {"status": ("!=", "Cancelled")}) def process(data): @@ -668,7 +713,7 @@ def process(data): """ if data: try: - subscription = frappe.get_doc('Subscription', data['name']) + subscription = frappe.get_doc("Subscription", data["name"]) subscription.process() frappe.db.commit() except frappe.ValidationError: @@ -684,7 +729,7 @@ def cancel_subscription(name): Cancels a `Subscription`. This will stop the `Subscription` from further invoicing the `Subscriber` but all already outstanding invoices will not be affected. """ - subscription = frappe.get_doc('Subscription', name) + subscription = frappe.get_doc("Subscription", name) subscription.cancel_subscription() @@ -694,7 +739,7 @@ def restart_subscription(name): Restarts a cancelled `Subscription`. The `Subscription` will 'forget' the history of all invoices it has generated """ - subscription = frappe.get_doc('Subscription', name) + subscription = frappe.get_doc("Subscription", name) subscription.restart_subscription() @@ -703,5 +748,5 @@ def get_subscription_updates(name): """ Use this to get the latest state of the given `Subscription` """ - subscription = frappe.get_doc('Subscription', name) + subscription = frappe.get_doc("Subscription", name) subscription.process() diff --git a/erpnext/accounts/doctype/subscription/test_subscription.py b/erpnext/accounts/doctype/subscription/test_subscription.py index 9dd370bd472..eb17daa282f 100644 --- a/erpnext/accounts/doctype/subscription/test_subscription.py +++ b/erpnext/accounts/doctype/subscription/test_subscription.py @@ -18,81 +18,111 @@ from erpnext.accounts.doctype.subscription.subscription import get_prorata_facto test_dependencies = ("UOM", "Item Group", "Item") + def create_plan(): - if not frappe.db.exists('Subscription Plan', '_Test Plan Name'): - plan = frappe.new_doc('Subscription Plan') - plan.plan_name = '_Test Plan Name' - plan.item = '_Test Non Stock Item' + if not frappe.db.exists("Subscription Plan", "_Test Plan Name"): + plan = frappe.new_doc("Subscription Plan") + plan.plan_name = "_Test Plan Name" + plan.item = "_Test Non Stock Item" plan.price_determination = "Fixed Rate" plan.cost = 900 - plan.billing_interval = 'Month' + plan.billing_interval = "Month" plan.billing_interval_count = 1 plan.insert() - if not frappe.db.exists('Subscription Plan', '_Test Plan Name 2'): - plan = frappe.new_doc('Subscription Plan') - plan.plan_name = '_Test Plan Name 2' - plan.item = '_Test Non Stock Item' + if not frappe.db.exists("Subscription Plan", "_Test Plan Name 2"): + plan = frappe.new_doc("Subscription Plan") + plan.plan_name = "_Test Plan Name 2" + plan.item = "_Test Non Stock Item" plan.price_determination = "Fixed Rate" plan.cost = 1999 - plan.billing_interval = 'Month' + plan.billing_interval = "Month" plan.billing_interval_count = 1 plan.insert() - if not frappe.db.exists('Subscription Plan', '_Test Plan Name 3'): - plan = frappe.new_doc('Subscription Plan') - plan.plan_name = '_Test Plan Name 3' - plan.item = '_Test Non Stock Item' + if not frappe.db.exists("Subscription Plan", "_Test Plan Name 3"): + plan = frappe.new_doc("Subscription Plan") + plan.plan_name = "_Test Plan Name 3" + plan.item = "_Test Non Stock Item" plan.price_determination = "Fixed Rate" plan.cost = 1999 - plan.billing_interval = 'Day' + plan.billing_interval = "Day" plan.billing_interval_count = 14 plan.insert() # Defined a quarterly Subscription Plan - if not frappe.db.exists('Subscription Plan', '_Test Plan Name 4'): - plan = frappe.new_doc('Subscription Plan') - plan.plan_name = '_Test Plan Name 4' - plan.item = '_Test Non Stock Item' + if not frappe.db.exists("Subscription Plan", "_Test Plan Name 4"): + plan = frappe.new_doc("Subscription Plan") + plan.plan_name = "_Test Plan Name 4" + plan.item = "_Test Non Stock Item" plan.price_determination = "Monthly Rate" plan.cost = 20000 - plan.billing_interval = 'Month' + plan.billing_interval = "Month" plan.billing_interval_count = 3 plan.insert() - if not frappe.db.exists('Supplier', '_Test Supplier'): - supplier = frappe.new_doc('Supplier') - supplier.supplier_name = '_Test Supplier' - supplier.supplier_group = 'All Supplier Groups' + if not frappe.db.exists("Subscription Plan", "_Test Plan Multicurrency"): + plan = frappe.new_doc("Subscription Plan") + plan.plan_name = "_Test Plan Multicurrency" + plan.item = "_Test Non Stock Item" + plan.price_determination = "Fixed Rate" + plan.cost = 50 + plan.currency = "USD" + plan.billing_interval = "Month" + plan.billing_interval_count = 1 + plan.insert() + + +def create_parties(): + if not frappe.db.exists("Supplier", "_Test Supplier"): + supplier = frappe.new_doc("Supplier") + supplier.supplier_name = "_Test Supplier" + supplier.supplier_group = "All Supplier Groups" supplier.insert() + if not frappe.db.exists("Customer", "_Test Subscription Customer"): + customer = frappe.new_doc("Customer") + customer.customer_name = "_Test Subscription Customer" + customer.billing_currency = "USD" + customer.append( + "accounts", {"company": "_Test Company", "account": "_Test Receivable USD - _TC"} + ) + customer.insert() + + class TestSubscription(unittest.TestCase): def setUp(self): create_plan() + create_parties() def test_create_subscription_with_trial_with_correct_period(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" subscription.trial_period_start = nowdate() subscription.trial_period_end = add_months(nowdate(), 1) - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() self.assertEqual(subscription.trial_period_start, nowdate()) self.assertEqual(subscription.trial_period_end, add_months(nowdate(), 1)) - self.assertEqual(add_days(subscription.trial_period_end, 1), get_date_str(subscription.current_invoice_start)) - self.assertEqual(add_to_date(subscription.current_invoice_start, months=1, days=-1), get_date_str(subscription.current_invoice_end)) + self.assertEqual( + add_days(subscription.trial_period_end, 1), get_date_str(subscription.current_invoice_start) + ) + self.assertEqual( + add_to_date(subscription.current_invoice_start, months=1, days=-1), + get_date_str(subscription.current_invoice_end), + ) self.assertEqual(subscription.invoices, []) - self.assertEqual(subscription.status, 'Trialling') + self.assertEqual(subscription.status, "Trialling") subscription.delete() def test_create_subscription_without_trial_with_correct_period(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() self.assertEqual(subscription.trial_period_start, None) @@ -101,190 +131,190 @@ class TestSubscription(unittest.TestCase): self.assertEqual(subscription.current_invoice_end, add_to_date(nowdate(), months=1, days=-1)) # No invoice is created self.assertEqual(len(subscription.invoices), 0) - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") subscription.delete() def test_create_subscription_trial_with_wrong_dates(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" subscription.trial_period_end = nowdate() subscription.trial_period_start = add_days(nowdate(), 30) - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) self.assertRaises(frappe.ValidationError, subscription.save) subscription.delete() def test_create_subscription_multi_with_different_billing_fails(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" subscription.trial_period_end = nowdate() subscription.trial_period_start = add_days(nowdate(), 30) - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) - subscription.append('plans', {'plan': '_Test Plan Name 3', 'qty': 1}) + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) + subscription.append("plans", {"plan": "_Test Plan Name 3", "qty": 1}) self.assertRaises(frappe.ValidationError, subscription.save) subscription.delete() def test_invoice_is_generated_at_end_of_billing_period(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.start_date = '2018-01-01' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.start_date = "2018-01-01" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.insert() - self.assertEqual(subscription.status, 'Active') - self.assertEqual(subscription.current_invoice_start, '2018-01-01') - self.assertEqual(subscription.current_invoice_end, '2018-01-31') + self.assertEqual(subscription.status, "Active") + self.assertEqual(subscription.current_invoice_start, "2018-01-01") + self.assertEqual(subscription.current_invoice_end, "2018-01-31") subscription.process() self.assertEqual(len(subscription.invoices), 1) - self.assertEqual(subscription.current_invoice_start, '2018-01-01') + self.assertEqual(subscription.current_invoice_start, "2018-01-01") subscription.process() - self.assertEqual(subscription.status, 'Unpaid') + self.assertEqual(subscription.status, "Unpaid") subscription.delete() def test_status_goes_back_to_active_after_invoice_is_paid(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) - subscription.start_date = '2018-01-01' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) + subscription.start_date = "2018-01-01" subscription.insert() - subscription.process() # generate first invoice + subscription.process() # generate first invoice self.assertEqual(len(subscription.invoices), 1) # Status is unpaid as Days until Due is zero and grace period is Zero - self.assertEqual(subscription.status, 'Unpaid') + self.assertEqual(subscription.status, "Unpaid") subscription.get_current_invoice() current_invoice = subscription.get_current_invoice() self.assertIsNotNone(current_invoice) - current_invoice.db_set('outstanding_amount', 0) - current_invoice.db_set('status', 'Paid') + current_invoice.db_set("outstanding_amount", 0) + current_invoice.db_set("status", "Paid") subscription.process() - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") self.assertEqual(subscription.current_invoice_start, add_months(subscription.start_date, 1)) self.assertEqual(len(subscription.invoices), 1) subscription.delete() def test_subscription_cancel_after_grace_period(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") default_grace_period_action = settings.cancel_after_grace settings.cancel_after_grace = 1 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) - subscription.start_date = '2018-01-01' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) + subscription.start_date = "2018-01-01" subscription.insert() - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") - subscription.process() # generate first invoice + subscription.process() # generate first invoice # This should change status to Cancelled since grace period is 0 # And is backdated subscription so subscription will be cancelled after processing - self.assertEqual(subscription.status, 'Cancelled') + self.assertEqual(subscription.status, "Cancelled") settings.cancel_after_grace = default_grace_period_action settings.save() subscription.delete() def test_subscription_unpaid_after_grace_period(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") default_grace_period_action = settings.cancel_after_grace settings.cancel_after_grace = 0 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) - subscription.start_date = '2018-01-01' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) + subscription.start_date = "2018-01-01" subscription.insert() - subscription.process() # generate first invoice + subscription.process() # generate first invoice # Status is unpaid as Days until Due is zero and grace period is Zero - self.assertEqual(subscription.status, 'Unpaid') + self.assertEqual(subscription.status, "Unpaid") settings.cancel_after_grace = default_grace_period_action settings.save() subscription.delete() def test_subscription_invoice_days_until_due(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.days_until_due = 10 subscription.start_date = add_months(nowdate(), -1) subscription.insert() - subscription.process() # generate first invoice + subscription.process() # generate first invoice self.assertEqual(len(subscription.invoices), 1) - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") subscription.delete() def test_subscription_is_past_due_doesnt_change_within_grace_period(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") grace_period = settings.grace_period settings.grace_period = 1000 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.start_date = add_days(nowdate(), -1000) subscription.insert() - subscription.process() # generate first invoice + subscription.process() # generate first invoice - self.assertEqual(subscription.status, 'Past Due Date') + self.assertEqual(subscription.status, "Past Due Date") subscription.process() # Grace period is 1000 days so status should remain as Past Due Date - self.assertEqual(subscription.status, 'Past Due Date') + self.assertEqual(subscription.status, "Past Due Date") subscription.process() - self.assertEqual(subscription.status, 'Past Due Date') + self.assertEqual(subscription.status, "Past Due Date") subscription.process() - self.assertEqual(subscription.status, 'Past Due Date') + self.assertEqual(subscription.status, "Past Due Date") settings.grace_period = grace_period settings.save() subscription.delete() def test_subscription_remains_active_during_invoice_period(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() - subscription.process() # no changes expected + subscription.process() # no changes expected - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") self.assertEqual(subscription.current_invoice_start, nowdate()) self.assertEqual(subscription.current_invoice_end, add_to_date(nowdate(), months=1, days=-1)) self.assertEqual(len(subscription.invoices), 0) - subscription.process() # no changes expected still - self.assertEqual(subscription.status, 'Active') + subscription.process() # no changes expected still + self.assertEqual(subscription.status, "Active") self.assertEqual(subscription.current_invoice_start, nowdate()) self.assertEqual(subscription.current_invoice_end, add_to_date(nowdate(), months=1, days=-1)) self.assertEqual(len(subscription.invoices), 0) - subscription.process() # no changes expected yet still - self.assertEqual(subscription.status, 'Active') + subscription.process() # no changes expected yet still + self.assertEqual(subscription.status, "Active") self.assertEqual(subscription.current_invoice_start, nowdate()) self.assertEqual(subscription.current_invoice_end, add_to_date(nowdate(), months=1, days=-1)) self.assertEqual(len(subscription.invoices), 0) @@ -292,30 +322,30 @@ class TestSubscription(unittest.TestCase): subscription.delete() def test_subscription_cancelation(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() subscription.cancel_subscription() - self.assertEqual(subscription.status, 'Cancelled') + self.assertEqual(subscription.status, "Cancelled") subscription.delete() def test_subscription_cancellation_invoices(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") to_prorate = settings.prorate settings.prorate = 1 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") subscription.cancel_subscription() # Invoice must have been generated @@ -323,33 +353,39 @@ class TestSubscription(unittest.TestCase): invoice = subscription.get_current_invoice() diff = flt(date_diff(nowdate(), subscription.current_invoice_start) + 1) - plan_days = flt(date_diff(subscription.current_invoice_end, subscription.current_invoice_start) + 1) - prorate_factor = flt(diff/plan_days) + plan_days = flt( + date_diff(subscription.current_invoice_end, subscription.current_invoice_start) + 1 + ) + prorate_factor = flt(diff / plan_days) self.assertEqual( flt( - get_prorata_factor(subscription.current_invoice_end, subscription.current_invoice_start, - subscription.generate_invoice_at_period_start), - 2), - flt(prorate_factor, 2) + get_prorata_factor( + subscription.current_invoice_end, + subscription.current_invoice_start, + subscription.generate_invoice_at_period_start, + ), + 2, + ), + flt(prorate_factor, 2), ) self.assertEqual(flt(invoice.grand_total, 2), flt(prorate_factor * 900, 2)) - self.assertEqual(subscription.status, 'Cancelled') + self.assertEqual(subscription.status, "Cancelled") subscription.delete() settings.prorate = to_prorate settings.save() def test_subscription_cancellation_invoices_with_prorata_false(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") to_prorate = settings.prorate settings.prorate = 0 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() subscription.cancel_subscription() invoice = subscription.get_current_invoice() @@ -362,21 +398,23 @@ class TestSubscription(unittest.TestCase): subscription.delete() def test_subscription_cancellation_invoices_with_prorata_true(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") to_prorate = settings.prorate settings.prorate = 1 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() subscription.cancel_subscription() invoice = subscription.get_current_invoice() diff = flt(date_diff(nowdate(), subscription.current_invoice_start) + 1) - plan_days = flt(date_diff(subscription.current_invoice_end, subscription.current_invoice_start) + 1) + plan_days = flt( + date_diff(subscription.current_invoice_end, subscription.current_invoice_start) + 1 + ) prorate_factor = flt(diff / plan_days) self.assertEqual(flt(invoice.grand_total, 2), flt(prorate_factor * 900, 2)) @@ -387,30 +425,30 @@ class TestSubscription(unittest.TestCase): subscription.delete() def test_subcription_cancellation_and_process(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") default_grace_period_action = settings.cancel_after_grace settings.cancel_after_grace = 1 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) - subscription.start_date = '2018-01-01' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) + subscription.start_date = "2018-01-01" subscription.insert() - subscription.process() # generate first invoice + subscription.process() # generate first invoice invoices = len(subscription.invoices) subscription.cancel_subscription() - self.assertEqual(subscription.status, 'Cancelled') + self.assertEqual(subscription.status, "Cancelled") self.assertEqual(len(subscription.invoices), invoices) subscription.process() - self.assertEqual(subscription.status, 'Cancelled') + self.assertEqual(subscription.status, "Cancelled") self.assertEqual(len(subscription.invoices), invoices) subscription.process() - self.assertEqual(subscription.status, 'Cancelled') + self.assertEqual(subscription.status, "Cancelled") self.assertEqual(len(subscription.invoices), invoices) settings.cancel_after_grace = default_grace_period_action @@ -418,36 +456,36 @@ class TestSubscription(unittest.TestCase): subscription.delete() def test_subscription_restart_and_process(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") default_grace_period_action = settings.cancel_after_grace settings.grace_period = 0 settings.cancel_after_grace = 0 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) - subscription.start_date = '2018-01-01' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) + subscription.start_date = "2018-01-01" subscription.insert() - subscription.process() # generate first invoice + subscription.process() # generate first invoice # Status is unpaid as Days until Due is zero and grace period is Zero - self.assertEqual(subscription.status, 'Unpaid') + self.assertEqual(subscription.status, "Unpaid") subscription.cancel_subscription() - self.assertEqual(subscription.status, 'Cancelled') + self.assertEqual(subscription.status, "Cancelled") subscription.restart_subscription() - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") self.assertEqual(len(subscription.invoices), 0) subscription.process() - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") self.assertEqual(len(subscription.invoices), 0) subscription.process() - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") self.assertEqual(len(subscription.invoices), 0) settings.cancel_after_grace = default_grace_period_action @@ -455,42 +493,42 @@ class TestSubscription(unittest.TestCase): subscription.delete() def test_subscription_unpaid_back_to_active(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") default_grace_period_action = settings.cancel_after_grace settings.cancel_after_grace = 0 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) - subscription.start_date = '2018-01-01' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) + subscription.start_date = "2018-01-01" subscription.insert() - subscription.process() # generate first invoice + subscription.process() # generate first invoice # This should change status to Unpaid since grace period is 0 - self.assertEqual(subscription.status, 'Unpaid') + self.assertEqual(subscription.status, "Unpaid") invoice = subscription.get_current_invoice() - invoice.db_set('outstanding_amount', 0) - invoice.db_set('status', 'Paid') + invoice.db_set("outstanding_amount", 0) + invoice.db_set("status", "Paid") subscription.process() - self.assertEqual(subscription.status, 'Active') + self.assertEqual(subscription.status, "Active") # A new invoice is generated subscription.process() - self.assertEqual(subscription.status, 'Unpaid') + self.assertEqual(subscription.status, "Unpaid") settings.cancel_after_grace = default_grace_period_action settings.save() subscription.delete() def test_restart_active_subscription(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() self.assertRaises(frappe.ValidationError, subscription.restart_subscription) @@ -498,44 +536,44 @@ class TestSubscription(unittest.TestCase): subscription.delete() def test_subscription_invoice_discount_percentage(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" subscription.additional_discount_percentage = 10 - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() subscription.cancel_subscription() invoice = subscription.get_current_invoice() self.assertEqual(invoice.additional_discount_percentage, 10) - self.assertEqual(invoice.apply_discount_on, 'Grand Total') + self.assertEqual(invoice.apply_discount_on, "Grand Total") subscription.delete() def test_subscription_invoice_discount_amount(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" subscription.additional_discount_amount = 11 - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() subscription.cancel_subscription() invoice = subscription.get_current_invoice() self.assertEqual(invoice.discount_amount, 11) - self.assertEqual(invoice.apply_discount_on, 'Grand Total') + self.assertEqual(invoice.apply_discount_on, "Grand Total") subscription.delete() def test_prepaid_subscriptions(self): # Create a non pre-billed subscription, processing should not create # invoices. - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() subscription.process() @@ -550,16 +588,16 @@ class TestSubscription(unittest.TestCase): self.assertEqual(len(subscription.invoices), 1) def test_prepaid_subscriptions_with_prorate_true(self): - settings = frappe.get_single('Subscription Settings') + settings = frappe.get_single("Subscription Settings") to_prorate = settings.prorate settings.prorate = 1 settings.save() - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Customer' - subscription.party = '_Test Customer' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Customer" subscription.generate_invoice_at_period_start = True - subscription.append('plans', {'plan': '_Test Plan Name', 'qty': 1}) + subscription.append("plans", {"plan": "_Test Plan Name", "qty": 1}) subscription.save() subscription.process() subscription.cancel_subscription() @@ -579,38 +617,38 @@ class TestSubscription(unittest.TestCase): subscription.delete() def test_subscription_with_follow_calendar_months(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Supplier' - subscription.party = '_Test Supplier' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Supplier" + subscription.party = "_Test Supplier" subscription.generate_invoice_at_period_start = 1 subscription.follow_calendar_months = 1 # select subscription start date as '2018-01-15' - subscription.start_date = '2018-01-15' - subscription.end_date = '2018-07-15' - subscription.append('plans', {'plan': '_Test Plan Name 4', 'qty': 1}) + subscription.start_date = "2018-01-15" + subscription.end_date = "2018-07-15" + subscription.append("plans", {"plan": "_Test Plan Name 4", "qty": 1}) subscription.save() # even though subscription starts at '2018-01-15' and Billing interval is Month and count 3 # First invoice will end at '2018-03-31' instead of '2018-04-14' - self.assertEqual(get_date_str(subscription.current_invoice_end), '2018-03-31') + self.assertEqual(get_date_str(subscription.current_invoice_end), "2018-03-31") def test_subscription_generate_invoice_past_due(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Supplier' - subscription.party = '_Test Supplier' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Supplier" + subscription.party = "_Test Supplier" subscription.generate_invoice_at_period_start = 1 subscription.generate_new_invoices_past_due_date = 1 # select subscription start date as '2018-01-15' - subscription.start_date = '2018-01-01' - subscription.append('plans', {'plan': '_Test Plan Name 4', 'qty': 1}) + subscription.start_date = "2018-01-01" + subscription.append("plans", {"plan": "_Test Plan Name 4", "qty": 1}) subscription.save() # Process subscription and create first invoice # Subscription status will be unpaid since due date has already passed subscription.process() self.assertEqual(len(subscription.invoices), 1) - self.assertEqual(subscription.status, 'Unpaid') + self.assertEqual(subscription.status, "Unpaid") # Now the Subscription is unpaid # Even then new invoice should be created as we have enabled `generate_new_invoices_past_due_date` in @@ -620,20 +658,39 @@ class TestSubscription(unittest.TestCase): self.assertEqual(len(subscription.invoices), 2) def test_subscription_without_generate_invoice_past_due(self): - subscription = frappe.new_doc('Subscription') - subscription.party_type = 'Supplier' - subscription.party = '_Test Supplier' + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Supplier" + subscription.party = "_Test Supplier" subscription.generate_invoice_at_period_start = 1 # select subscription start date as '2018-01-15' - subscription.start_date = '2018-01-01' - subscription.append('plans', {'plan': '_Test Plan Name 4', 'qty': 1}) + subscription.start_date = "2018-01-01" + subscription.append("plans", {"plan": "_Test Plan Name 4", "qty": 1}) subscription.save() # Process subscription and create first invoice # Subscription status will be unpaid since due date has already passed subscription.process() self.assertEqual(len(subscription.invoices), 1) - self.assertEqual(subscription.status, 'Unpaid') + self.assertEqual(subscription.status, "Unpaid") subscription.process() self.assertEqual(len(subscription.invoices), 1) + + def test_multicurrency_subscription(self): + subscription = frappe.new_doc("Subscription") + subscription.party_type = "Customer" + subscription.party = "_Test Subscription Customer" + subscription.generate_invoice_at_period_start = 1 + subscription.company = "_Test Company" + # select subscription start date as '2018-01-15' + subscription.start_date = "2018-01-01" + subscription.append("plans", {"plan": "_Test Plan Multicurrency", "qty": 1}) + subscription.save() + + subscription.process() + self.assertEqual(len(subscription.invoices), 1) + self.assertEqual(subscription.status, "Unpaid") + + # Check the currency of the created invoice + currency = frappe.db.get_value("Sales Invoice", subscription.invoices[0].invoice, "currency") + self.assertEqual(currency, "USD") diff --git a/erpnext/accounts/doctype/subscription_plan/subscription_plan.json b/erpnext/accounts/doctype/subscription_plan/subscription_plan.json index 878ae098891..563df79eec7 100644 --- a/erpnext/accounts/doctype/subscription_plan/subscription_plan.json +++ b/erpnext/accounts/doctype/subscription_plan/subscription_plan.json @@ -75,7 +75,8 @@ "fieldname": "cost", "fieldtype": "Currency", "in_list_view": 1, - "label": "Cost" + "label": "Cost", + "options": "currency" }, { "depends_on": "eval:doc.price_determination==\"Based On Price List\"", @@ -147,7 +148,7 @@ } ], "links": [], - "modified": "2021-08-13 10:53:44.205774", + "modified": "2021-12-10 15:24:15.794477", "modified_by": "Administrator", "module": "Accounts", "name": "Subscription Plan", diff --git a/erpnext/accounts/doctype/subscription_plan/subscription_plan.py b/erpnext/accounts/doctype/subscription_plan/subscription_plan.py index 1285343d196..a95e0a9c2da 100644 --- a/erpnext/accounts/doctype/subscription_plan/subscription_plan.py +++ b/erpnext/accounts/doctype/subscription_plan/subscription_plan.py @@ -16,10 +16,13 @@ class SubscriptionPlan(Document): def validate_interval_count(self): if self.billing_interval_count < 1: - frappe.throw(_('Billing Interval Count cannot be less than 1')) + frappe.throw(_("Billing Interval Count cannot be less than 1")) + @frappe.whitelist() -def get_plan_rate(plan, quantity=1, customer=None, start_date=None, end_date=None, prorate_factor=1): +def get_plan_rate( + plan, quantity=1, customer=None, start_date=None, end_date=None, prorate_factor=1 +): plan = frappe.get_doc("Subscription Plan", plan) if plan.price_determination == "Fixed Rate": return plan.cost * prorate_factor @@ -30,13 +33,19 @@ def get_plan_rate(plan, quantity=1, customer=None, start_date=None, end_date=Non else: customer_group = None - price = get_price(item_code=plan.item, price_list=plan.price_list, customer_group=customer_group, company=None, qty=quantity) + price = get_price( + item_code=plan.item, + price_list=plan.price_list, + customer_group=customer_group, + company=None, + qty=quantity, + ) if not price: return 0 else: return price.price_list_rate * prorate_factor - elif plan.price_determination == 'Monthly Rate': + elif plan.price_determination == "Monthly Rate": start_date = getdate(start_date) end_date = getdate(end_date) @@ -44,15 +53,21 @@ def get_plan_rate(plan, quantity=1, customer=None, start_date=None, end_date=Non cost = plan.cost * no_of_months # Adjust cost if start or end date is not month start or end - prorate = frappe.db.get_single_value('Subscription Settings', 'prorate') + prorate = frappe.db.get_single_value("Subscription Settings", "prorate") if prorate: - prorate_factor = flt(date_diff(start_date, get_first_day(start_date)) / date_diff( - get_last_day(start_date), get_first_day(start_date)), 1) + prorate_factor = flt( + date_diff(start_date, get_first_day(start_date)) + / date_diff(get_last_day(start_date), get_first_day(start_date)), + 1, + ) - prorate_factor += flt(date_diff(get_last_day(end_date), end_date) / date_diff( - get_last_day(end_date), get_first_day(end_date)), 1) + prorate_factor += flt( + date_diff(get_last_day(end_date), end_date) + / date_diff(get_last_day(end_date), get_first_day(end_date)), + 1, + ) - cost -= (plan.cost * prorate_factor) + cost -= plan.cost * prorate_factor return cost diff --git a/erpnext/accounts/doctype/subscription_plan/subscription_plan_dashboard.py b/erpnext/accounts/doctype/subscription_plan/subscription_plan_dashboard.py index 15df62daa23..7df76cde80c 100644 --- a/erpnext/accounts/doctype/subscription_plan/subscription_plan_dashboard.py +++ b/erpnext/accounts/doctype/subscription_plan/subscription_plan_dashboard.py @@ -1,18 +1,9 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'subscription_plan', - 'non_standard_fieldnames': { - 'Payment Request': 'plan', - 'Subscription': 'plan' - }, - 'transactions': [ - { - 'label': _('References'), - 'items': ['Payment Request', 'Subscription'] - } - ] + "fieldname": "subscription_plan", + "non_standard_fieldnames": {"Payment Request": "plan", "Subscription": "plan"}, + "transactions": [{"label": _("References"), "items": ["Payment Request", "Subscription"]}], } diff --git a/erpnext/accounts/doctype/tax_category/tax_category.json b/erpnext/accounts/doctype/tax_category/tax_category.json index f7145af44c3..44a339f31df 100644 --- a/erpnext/accounts/doctype/tax_category/tax_category.json +++ b/erpnext/accounts/doctype/tax_category/tax_category.json @@ -2,12 +2,13 @@ "actions": [], "allow_rename": 1, "autoname": "field:title", - "creation": "2018-11-22 23:38:39.668804", + "creation": "2022-01-19 01:09:28.920486", "doctype": "DocType", "editable_grid": 1, "engine": "InnoDB", "field_order": [ - "title" + "title", + "disabled" ], "fields": [ { @@ -18,14 +19,21 @@ "label": "Title", "reqd": 1, "unique": 1 + }, + { + "default": "0", + "fieldname": "disabled", + "fieldtype": "Check", + "label": "Disabled" } ], "index_web_pages_for_search": 1, "links": [], - "modified": "2021-03-03 11:50:38.748872", + "modified": "2022-01-18 21:13:41.161017", "modified_by": "Administrator", "module": "Accounts", "name": "Tax Category", + "naming_rule": "By fieldname", "owner": "Administrator", "permissions": [ { @@ -65,5 +73,6 @@ "quick_entry": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/accounts/doctype/tax_category/tax_category_dashboard.py b/erpnext/accounts/doctype/tax_category/tax_category_dashboard.py index c9d52da78ad..17a275ebc34 100644 --- a/erpnext/accounts/doctype/tax_category/tax_category_dashboard.py +++ b/erpnext/accounts/doctype/tax_category/tax_category_dashboard.py @@ -1,30 +1,14 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'tax_category', - 'transactions': [ - { - 'label': _('Pre Sales'), - 'items': ['Quotation', 'Supplier Quotation'] - }, - { - 'label': _('Sales'), - 'items': ['Sales Invoice', 'Delivery Note', 'Sales Order'] - }, - { - 'label': _('Purchase'), - 'items': ['Purchase Invoice', 'Purchase Receipt'] - }, - { - 'label': _('Party'), - 'items': ['Customer', 'Supplier'] - }, - { - 'label': _('Taxes'), - 'items': ['Item', 'Tax Rule'] - } - ] + "fieldname": "tax_category", + "transactions": [ + {"label": _("Pre Sales"), "items": ["Quotation", "Supplier Quotation"]}, + {"label": _("Sales"), "items": ["Sales Invoice", "Delivery Note", "Sales Order"]}, + {"label": _("Purchase"), "items": ["Purchase Invoice", "Purchase Receipt"]}, + {"label": _("Party"), "items": ["Customer", "Supplier"]}, + {"label": _("Taxes"), "items": ["Item", "Tax Rule"]}, + ], } diff --git a/erpnext/accounts/doctype/tax_rule/tax_rule.py b/erpnext/accounts/doctype/tax_rule/tax_rule.py index ce64d222856..a21d48415fd 100644 --- a/erpnext/accounts/doctype/tax_rule/tax_rule.py +++ b/erpnext/accounts/doctype/tax_rule/tax_rule.py @@ -16,9 +16,17 @@ from six import iteritems from erpnext.setup.doctype.customer_group.customer_group import get_parent_customer_groups -class IncorrectCustomerGroup(frappe.ValidationError): pass -class IncorrectSupplierType(frappe.ValidationError): pass -class ConflictingTaxRule(frappe.ValidationError): pass +class IncorrectCustomerGroup(frappe.ValidationError): + pass + + +class IncorrectSupplierType(frappe.ValidationError): + pass + + +class ConflictingTaxRule(frappe.ValidationError): + pass + class TaxRule(Document): def __setup__(self): @@ -31,7 +39,7 @@ class TaxRule(Document): self.validate_use_for_shopping_cart() def validate_tax_template(self): - if self.tax_type== "Sales": + if self.tax_type == "Sales": self.purchase_tax_template = self.supplier = self.supplier_group = None if self.customer: self.customer_group = None @@ -51,28 +59,28 @@ class TaxRule(Document): def validate_filters(self): filters = { - "tax_type": self.tax_type, - "customer": self.customer, - "customer_group": self.customer_group, - "supplier": self.supplier, - "supplier_group": self.supplier_group, - "item": self.item, - "item_group": self.item_group, - "billing_city": self.billing_city, - "billing_county": self.billing_county, - "billing_state": self.billing_state, - "billing_zipcode": self.billing_zipcode, - "billing_country": self.billing_country, - "shipping_city": self.shipping_city, - "shipping_county": self.shipping_county, - "shipping_state": self.shipping_state, - "shipping_zipcode": self.shipping_zipcode, - "shipping_country": self.shipping_country, - "tax_category": self.tax_category, - "company": self.company + "tax_type": self.tax_type, + "customer": self.customer, + "customer_group": self.customer_group, + "supplier": self.supplier, + "supplier_group": self.supplier_group, + "item": self.item, + "item_group": self.item_group, + "billing_city": self.billing_city, + "billing_county": self.billing_county, + "billing_state": self.billing_state, + "billing_zipcode": self.billing_zipcode, + "billing_country": self.billing_country, + "shipping_city": self.shipping_city, + "shipping_county": self.shipping_county, + "shipping_state": self.shipping_state, + "shipping_zipcode": self.shipping_zipcode, + "shipping_country": self.shipping_country, + "tax_category": self.tax_category, + "company": self.company, } - conds="" + conds = "" for d in filters: if conds: conds += " and " @@ -82,85 +90,112 @@ class TaxRule(Document): conds += """ and ((from_date > '{from_date}' and from_date < '{to_date}') or (to_date > '{from_date}' and to_date < '{to_date}') or ('{from_date}' > from_date and '{from_date}' < to_date) or - ('{from_date}' = from_date and '{to_date}' = to_date))""".format(from_date=self.from_date, to_date=self.to_date) + ('{from_date}' = from_date and '{to_date}' = to_date))""".format( + from_date=self.from_date, to_date=self.to_date + ) elif self.from_date and not self.to_date: - conds += """ and to_date > '{from_date}'""".format(from_date = self.from_date) + conds += """ and to_date > '{from_date}'""".format(from_date=self.from_date) elif self.to_date and not self.from_date: - conds += """ and from_date < '{to_date}'""".format(to_date = self.to_date) + conds += """ and from_date < '{to_date}'""".format(to_date=self.to_date) - tax_rule = frappe.db.sql("select name, priority \ - from `tabTax Rule` where {0} and name != '{1}'".format(conds, self.name), as_dict=1) + tax_rule = frappe.db.sql( + "select name, priority \ + from `tabTax Rule` where {0} and name != '{1}'".format( + conds, self.name + ), + as_dict=1, + ) if tax_rule: if tax_rule[0].priority == self.priority: frappe.throw(_("Tax Rule Conflicts with {0}").format(tax_rule[0].name), ConflictingTaxRule) def validate_use_for_shopping_cart(self): - '''If shopping cart is enabled and no tax rule exists for shopping cart, enable this one''' - if (not self.use_for_shopping_cart - and cint(frappe.db.get_single_value('E Commerce Settings', 'enabled')) - and not frappe.db.get_value('Tax Rule', {'use_for_shopping_cart': 1, 'name': ['!=', self.name]})): + """If shopping cart is enabled and no tax rule exists for shopping cart, enable this one""" + if ( + not self.use_for_shopping_cart + and cint(frappe.db.get_single_value("E Commerce Settings", "enabled")) + and not frappe.db.get_value("Tax Rule", {"use_for_shopping_cart": 1, "name": ["!=", self.name]}) + ): self.use_for_shopping_cart = 1 - frappe.msgprint(_("Enabling 'Use for Shopping Cart', as Shopping Cart is enabled and there should be at least one Tax Rule for Shopping Cart")) + frappe.msgprint( + _( + "Enabling 'Use for Shopping Cart', as Shopping Cart is enabled and there should be at least one Tax Rule for Shopping Cart" + ) + ) + @frappe.whitelist() def get_party_details(party, party_type, args=None): out = {} billing_address, shipping_address = None, None if args: - if args.get('billing_address'): - billing_address = frappe.get_doc('Address', args.get('billing_address')) - if args.get('shipping_address'): - shipping_address = frappe.get_doc('Address', args.get('shipping_address')) + if args.get("billing_address"): + billing_address = frappe.get_doc("Address", args.get("billing_address")) + if args.get("shipping_address"): + shipping_address = frappe.get_doc("Address", args.get("shipping_address")) else: billing_address_name = get_default_address(party_type, party) - shipping_address_name = get_default_address(party_type, party, 'is_shipping_address') + shipping_address_name = get_default_address(party_type, party, "is_shipping_address") if billing_address_name: - billing_address = frappe.get_doc('Address', billing_address_name) + billing_address = frappe.get_doc("Address", billing_address_name) if shipping_address_name: - shipping_address = frappe.get_doc('Address', shipping_address_name) + shipping_address = frappe.get_doc("Address", shipping_address_name) if billing_address: - out["billing_city"]= billing_address.city - out["billing_county"]= billing_address.county - out["billing_state"]= billing_address.state - out["billing_zipcode"]= billing_address.pincode - out["billing_country"]= billing_address.country + out["billing_city"] = billing_address.city + out["billing_county"] = billing_address.county + out["billing_state"] = billing_address.state + out["billing_zipcode"] = billing_address.pincode + out["billing_country"] = billing_address.country if shipping_address: - out["shipping_city"]= shipping_address.city - out["shipping_county"]= shipping_address.county - out["shipping_state"]= shipping_address.state - out["shipping_zipcode"]= shipping_address.pincode - out["shipping_country"]= shipping_address.country + out["shipping_city"] = shipping_address.city + out["shipping_county"] = shipping_address.county + out["shipping_state"] = shipping_address.state + out["shipping_zipcode"] = shipping_address.pincode + out["shipping_country"] = shipping_address.country return out + def get_tax_template(posting_date, args): """Get matching tax rule""" args = frappe._dict(args) - conditions = ["""(from_date is null or from_date <= '{0}') - and (to_date is null or to_date >= '{0}')""".format(posting_date)] + conditions = [ + """(from_date is null or from_date <= '{0}') + and (to_date is null or to_date >= '{0}')""".format( + posting_date + ) + ] - conditions.append("ifnull(tax_category, '') = {0}".format(frappe.db.escape(cstr(args.get("tax_category"))))) - if 'tax_category' in args.keys(): - del args['tax_category'] + conditions.append( + "ifnull(tax_category, '') = {0}".format(frappe.db.escape(cstr(args.get("tax_category")))) + ) + if "tax_category" in args.keys(): + del args["tax_category"] for key, value in iteritems(args): - if key=="use_for_shopping_cart": + if key == "use_for_shopping_cart": conditions.append("use_for_shopping_cart = {0}".format(1 if value else 0)) - elif key == 'customer_group': - if not value: value = get_root_of("Customer Group") + elif key == "customer_group": + if not value: + value = get_root_of("Customer Group") customer_group_condition = get_customer_group_condition(value) conditions.append("ifnull({0}, '') in ('', {1})".format(key, customer_group_condition)) else: conditions.append("ifnull({0}, '') in ('', {1})".format(key, frappe.db.escape(cstr(value)))) - tax_rule = frappe.db.sql("""select * from `tabTax Rule` - where {0}""".format(" and ".join(conditions)), as_dict = True) + tax_rule = frappe.db.sql( + """select * from `tabTax Rule` + where {0}""".format( + " and ".join(conditions) + ), + as_dict=True, + ) if not tax_rule: return None @@ -168,24 +203,30 @@ def get_tax_template(posting_date, args): for rule in tax_rule: rule.no_of_keys_matched = 0 for key in args: - if rule.get(key): rule.no_of_keys_matched += 1 + if rule.get(key): + rule.no_of_keys_matched += 1 - rule = sorted(tax_rule, - key = functools.cmp_to_key(lambda b, a: - cmp(a.no_of_keys_matched, b.no_of_keys_matched) or - cmp(a.priority, b.priority)))[0] + rule = sorted( + tax_rule, + key=functools.cmp_to_key( + lambda b, a: cmp(a.no_of_keys_matched, b.no_of_keys_matched) or cmp(a.priority, b.priority) + ), + )[0] tax_template = rule.sales_tax_template or rule.purchase_tax_template doctype = "{0} Taxes and Charges Template".format(rule.tax_type) - if frappe.db.get_value(doctype, tax_template, 'disabled')==1: + if frappe.db.get_value(doctype, tax_template, "disabled") == 1: return None return tax_template + def get_customer_group_condition(customer_group): condition = "" - customer_groups = ["%s"%(frappe.db.escape(d.name)) for d in get_parent_customer_groups(customer_group)] + customer_groups = [ + "%s" % (frappe.db.escape(d.name)) for d in get_parent_customer_groups(customer_group) + ] if customer_groups: - condition = ",".join(['%s'] * len(customer_groups))%(tuple(customer_groups)) + condition = ",".join(["%s"] * len(customer_groups)) % (tuple(customer_groups)) return condition diff --git a/erpnext/accounts/doctype/tax_rule/test_tax_rule.py b/erpnext/accounts/doctype/tax_rule/test_tax_rule.py index 44344bb7635..2cb9564875f 100644 --- a/erpnext/accounts/doctype/tax_rule/test_tax_rule.py +++ b/erpnext/accounts/doctype/tax_rule/test_tax_rule.py @@ -9,7 +9,7 @@ from erpnext.accounts.doctype.tax_rule.tax_rule import ConflictingTaxRule, get_t from erpnext.crm.doctype.opportunity.opportunity import make_quotation from erpnext.crm.doctype.opportunity.test_opportunity import make_opportunity -test_records = frappe.get_test_records('Tax Rule') +test_records = frappe.get_test_records("Tax Rule") from six import iteritems @@ -27,40 +27,70 @@ class TestTaxRule(unittest.TestCase): frappe.db.sql("delete from `tabTax Rule`") def test_conflict(self): - tax_rule1 = make_tax_rule(customer= "_Test Customer", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", priority = 1) + tax_rule1 = make_tax_rule( + customer="_Test Customer", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + priority=1, + ) tax_rule1.save() - tax_rule2 = make_tax_rule(customer= "_Test Customer", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", priority = 1) + tax_rule2 = make_tax_rule( + customer="_Test Customer", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + priority=1, + ) self.assertRaises(ConflictingTaxRule, tax_rule2.save) def test_conflict_with_non_overlapping_dates(self): - tax_rule1 = make_tax_rule(customer= "_Test Customer", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", priority = 1, from_date = "2015-01-01") + tax_rule1 = make_tax_rule( + customer="_Test Customer", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + priority=1, + from_date="2015-01-01", + ) tax_rule1.save() - tax_rule2 = make_tax_rule(customer= "_Test Customer", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", priority = 1, to_date = "2013-01-01") + tax_rule2 = make_tax_rule( + customer="_Test Customer", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + priority=1, + to_date="2013-01-01", + ) tax_rule2.save() self.assertTrue(tax_rule2.name) def test_for_parent_customer_group(self): - tax_rule1 = make_tax_rule(customer_group= "All Customer Groups", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", priority = 1, from_date = "2015-01-01") + tax_rule1 = make_tax_rule( + customer_group="All Customer Groups", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + priority=1, + from_date="2015-01-01", + ) tax_rule1.save() - self.assertEqual(get_tax_template("2015-01-01", {"customer_group" : "Commercial", "use_for_shopping_cart":1}), - "_Test Sales Taxes and Charges Template - _TC") + self.assertEqual( + get_tax_template("2015-01-01", {"customer_group": "Commercial", "use_for_shopping_cart": 1}), + "_Test Sales Taxes and Charges Template - _TC", + ) def test_conflict_with_overlapping_dates(self): - tax_rule1 = make_tax_rule(customer= "_Test Customer", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", priority = 1, from_date = "2015-01-01", to_date = "2015-01-05") + tax_rule1 = make_tax_rule( + customer="_Test Customer", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + priority=1, + from_date="2015-01-01", + to_date="2015-01-05", + ) tax_rule1.save() - tax_rule2 = make_tax_rule(customer= "_Test Customer", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", priority = 1, from_date = "2015-01-03", to_date = "2015-01-09") + tax_rule2 = make_tax_rule( + customer="_Test Customer", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + priority=1, + from_date="2015-01-03", + to_date="2015-01-09", + ) self.assertRaises(ConflictingTaxRule, tax_rule2.save) @@ -68,93 +98,186 @@ class TestTaxRule(unittest.TestCase): tax_rule = make_tax_rule() self.assertEqual(tax_rule.purchase_tax_template, None) - def test_select_tax_rule_based_on_customer(self): - make_tax_rule(customer= "_Test Customer", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + save=1, + ) - make_tax_rule(customer= "_Test Customer 1", - sales_tax_template = "_Test Sales Taxes and Charges Template 1 - _TC", save=1) + make_tax_rule( + customer="_Test Customer 1", + sales_tax_template="_Test Sales Taxes and Charges Template 1 - _TC", + save=1, + ) - make_tax_rule(customer= "_Test Customer 2", - sales_tax_template = "_Test Sales Taxes and Charges Template 2 - _TC", save=1) + make_tax_rule( + customer="_Test Customer 2", + sales_tax_template="_Test Sales Taxes and Charges Template 2 - _TC", + save=1, + ) - self.assertEqual(get_tax_template("2015-01-01", {"customer":"_Test Customer 2"}), - "_Test Sales Taxes and Charges Template 2 - _TC") + self.assertEqual( + get_tax_template("2015-01-01", {"customer": "_Test Customer 2"}), + "_Test Sales Taxes and Charges Template 2 - _TC", + ) def test_select_tax_rule_based_on_tax_category(self): - make_tax_rule(customer="_Test Customer", tax_category="_Test Tax Category 1", - sales_tax_template="_Test Sales Taxes and Charges Template 1 - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + tax_category="_Test Tax Category 1", + sales_tax_template="_Test Sales Taxes and Charges Template 1 - _TC", + save=1, + ) - make_tax_rule(customer="_Test Customer", tax_category="_Test Tax Category 2", - sales_tax_template="_Test Sales Taxes and Charges Template 2 - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + tax_category="_Test Tax Category 2", + sales_tax_template="_Test Sales Taxes and Charges Template 2 - _TC", + save=1, + ) self.assertFalse(get_tax_template("2015-01-01", {"customer": "_Test Customer"})) - self.assertEqual(get_tax_template("2015-01-01", {"customer": "_Test Customer", "tax_category": "_Test Tax Category 1"}), - "_Test Sales Taxes and Charges Template 1 - _TC") - self.assertEqual(get_tax_template("2015-01-01", {"customer": "_Test Customer", "tax_category": "_Test Tax Category 2"}), - "_Test Sales Taxes and Charges Template 2 - _TC") + self.assertEqual( + get_tax_template( + "2015-01-01", {"customer": "_Test Customer", "tax_category": "_Test Tax Category 1"} + ), + "_Test Sales Taxes and Charges Template 1 - _TC", + ) + self.assertEqual( + get_tax_template( + "2015-01-01", {"customer": "_Test Customer", "tax_category": "_Test Tax Category 2"} + ), + "_Test Sales Taxes and Charges Template 2 - _TC", + ) - make_tax_rule(customer="_Test Customer", tax_category="", - sales_tax_template="_Test Sales Taxes and Charges Template - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + tax_category="", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + save=1, + ) - self.assertEqual(get_tax_template("2015-01-01", {"customer": "_Test Customer"}), - "_Test Sales Taxes and Charges Template - _TC") + self.assertEqual( + get_tax_template("2015-01-01", {"customer": "_Test Customer"}), + "_Test Sales Taxes and Charges Template - _TC", + ) def test_select_tax_rule_based_on_better_match(self): - make_tax_rule(customer= "_Test Customer", billing_city = "Test City", billing_state = "Test State", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + billing_city="Test City", + billing_state="Test State", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + save=1, + ) - make_tax_rule(customer= "_Test Customer", billing_city = "Test City1", billing_state = "Test State", - sales_tax_template = "_Test Sales Taxes and Charges Template 1 - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + billing_city="Test City1", + billing_state="Test State", + sales_tax_template="_Test Sales Taxes and Charges Template 1 - _TC", + save=1, + ) - self.assertEqual(get_tax_template("2015-01-01", {"customer":"_Test Customer", "billing_city": "Test City", "billing_state": "Test State"}), - "_Test Sales Taxes and Charges Template - _TC") + self.assertEqual( + get_tax_template( + "2015-01-01", + {"customer": "_Test Customer", "billing_city": "Test City", "billing_state": "Test State"}, + ), + "_Test Sales Taxes and Charges Template - _TC", + ) def test_select_tax_rule_based_on_state_match(self): - make_tax_rule(customer= "_Test Customer", shipping_state = "Test State", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + shipping_state="Test State", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + save=1, + ) - make_tax_rule(customer= "_Test Customer", shipping_state = "Test State12", - sales_tax_template = "_Test Sales Taxes and Charges Template 1 - _TC", priority=2, save=1) + make_tax_rule( + customer="_Test Customer", + shipping_state="Test State12", + sales_tax_template="_Test Sales Taxes and Charges Template 1 - _TC", + priority=2, + save=1, + ) - self.assertEqual(get_tax_template("2015-01-01", {"customer":"_Test Customer", "shipping_state": "Test State"}), - "_Test Sales Taxes and Charges Template - _TC") + self.assertEqual( + get_tax_template("2015-01-01", {"customer": "_Test Customer", "shipping_state": "Test State"}), + "_Test Sales Taxes and Charges Template - _TC", + ) def test_select_tax_rule_based_on_better_priority(self): - make_tax_rule(customer= "_Test Customer", billing_city = "Test City", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", priority=1, save=1) + make_tax_rule( + customer="_Test Customer", + billing_city="Test City", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + priority=1, + save=1, + ) - make_tax_rule(customer= "_Test Customer", billing_city = "Test City", - sales_tax_template = "_Test Sales Taxes and Charges Template 1 - _TC", priority=2, save=1) + make_tax_rule( + customer="_Test Customer", + billing_city="Test City", + sales_tax_template="_Test Sales Taxes and Charges Template 1 - _TC", + priority=2, + save=1, + ) - self.assertEqual(get_tax_template("2015-01-01", {"customer":"_Test Customer", "billing_city": "Test City"}), - "_Test Sales Taxes and Charges Template 1 - _TC") + self.assertEqual( + get_tax_template("2015-01-01", {"customer": "_Test Customer", "billing_city": "Test City"}), + "_Test Sales Taxes and Charges Template 1 - _TC", + ) def test_select_tax_rule_based_cross_matching_keys(self): - make_tax_rule(customer= "_Test Customer", billing_city = "Test City", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + billing_city="Test City", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + save=1, + ) - make_tax_rule(customer= "_Test Customer 1", billing_city = "Test City 1", - sales_tax_template = "_Test Sales Taxes and Charges Template 1 - _TC", save=1) + make_tax_rule( + customer="_Test Customer 1", + billing_city="Test City 1", + sales_tax_template="_Test Sales Taxes and Charges Template 1 - _TC", + save=1, + ) - self.assertEqual(get_tax_template("2015-01-01", {"customer":"_Test Customer", "billing_city": "Test City 1"}), - None) + self.assertEqual( + get_tax_template("2015-01-01", {"customer": "_Test Customer", "billing_city": "Test City 1"}), + None, + ) def test_select_tax_rule_based_cross_partially_keys(self): - make_tax_rule(customer= "_Test Customer", billing_city = "Test City", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + billing_city="Test City", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + save=1, + ) - make_tax_rule(billing_city = "Test City 1", - sales_tax_template = "_Test Sales Taxes and Charges Template 1 - _TC", save=1) + make_tax_rule( + billing_city="Test City 1", + sales_tax_template="_Test Sales Taxes and Charges Template 1 - _TC", + save=1, + ) - self.assertEqual(get_tax_template("2015-01-01", {"customer":"_Test Customer", "billing_city": "Test City 1"}), - "_Test Sales Taxes and Charges Template 1 - _TC") + self.assertEqual( + get_tax_template("2015-01-01", {"customer": "_Test Customer", "billing_city": "Test City 1"}), + "_Test Sales Taxes and Charges Template 1 - _TC", + ) def test_taxes_fetch_via_tax_rule(self): - make_tax_rule(customer= "_Test Customer", billing_city = "_Test City", - sales_tax_template = "_Test Sales Taxes and Charges Template - _TC", save=1) + make_tax_rule( + customer="_Test Customer", + billing_city="_Test City", + sales_tax_template="_Test Sales Taxes and Charges Template - _TC", + save=1, + ) # create opportunity for customer opportunity = make_opportunity(with_items=1) @@ -169,7 +292,6 @@ class TestTaxRule(unittest.TestCase): self.assertTrue(len(quotation.taxes) > 0) - def make_tax_rule(**args): args = frappe._dict(args) diff --git a/erpnext/accounts/print_format/gst_pos_invoice/__init__.py b/erpnext/accounts/doctype/tax_withheld_vouchers/__init__.py similarity index 100% rename from erpnext/accounts/print_format/gst_pos_invoice/__init__.py rename to erpnext/accounts/doctype/tax_withheld_vouchers/__init__.py diff --git a/erpnext/accounts/doctype/tax_withheld_vouchers/tax_withheld_vouchers.json b/erpnext/accounts/doctype/tax_withheld_vouchers/tax_withheld_vouchers.json new file mode 100644 index 00000000000..ce8c0c37086 --- /dev/null +++ b/erpnext/accounts/doctype/tax_withheld_vouchers/tax_withheld_vouchers.json @@ -0,0 +1,49 @@ +{ + "actions": [], + "autoname": "autoincrement", + "creation": "2022-09-13 16:18:59.404842", + "doctype": "DocType", + "editable_grid": 1, + "engine": "InnoDB", + "field_order": [ + "voucher_type", + "voucher_name", + "taxable_amount" + ], + "fields": [ + { + "fieldname": "voucher_type", + "fieldtype": "Link", + "in_list_view": 1, + "label": "Voucher Type", + "options": "DocType" + }, + { + "fieldname": "voucher_name", + "fieldtype": "Dynamic Link", + "in_list_view": 1, + "label": "Voucher Name", + "options": "voucher_type" + }, + { + "fieldname": "taxable_amount", + "fieldtype": "Currency", + "in_list_view": 1, + "label": "Taxable Amount", + "options": "Company:company:default_currency" + } + ], + "index_web_pages_for_search": 1, + "istable": 1, + "links": [], + "modified": "2022-09-13 23:40:41.479208", + "modified_by": "Administrator", + "module": "Accounts", + "name": "Tax Withheld Vouchers", + "naming_rule": "Autoincrement", + "owner": "Administrator", + "permissions": [], + "sort_field": "modified", + "sort_order": "DESC", + "states": [] +} \ No newline at end of file diff --git a/erpnext/accounts/doctype/tax_withheld_vouchers/tax_withheld_vouchers.py b/erpnext/accounts/doctype/tax_withheld_vouchers/tax_withheld_vouchers.py new file mode 100644 index 00000000000..ea54c5403a8 --- /dev/null +++ b/erpnext/accounts/doctype/tax_withheld_vouchers/tax_withheld_vouchers.py @@ -0,0 +1,9 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +# For license information, please see license.txt + +# import frappe +from frappe.model.document import Document + + +class TaxWithheldVouchers(Document): + pass diff --git a/erpnext/accounts/doctype/tax_withholding_category/tax_withholding_category.py b/erpnext/accounts/doctype/tax_withholding_category/tax_withholding_category.py index f33aa31e161..7f79724f3bc 100644 --- a/erpnext/accounts/doctype/tax_withholding_category/tax_withholding_category.py +++ b/erpnext/accounts/doctype/tax_withholding_category/tax_withholding_category.py @@ -15,7 +15,7 @@ class TaxWithholdingCategory(Document): def validate_dates(self): last_date = None - for d in self.get('rates'): + for d in self.get("rates"): if getdate(d.from_date) >= getdate(d.to_date): frappe.throw(_("Row #{0}: From Date cannot be before To Date").format(d.idx)) @@ -24,18 +24,25 @@ class TaxWithholdingCategory(Document): frappe.throw(_("Row #{0}: Dates overlapping with other row").format(d.idx)) def validate_thresholds(self): - for d in self.get('rates'): - if d.cumulative_threshold and d.cumulative_threshold < d.single_threshold: - frappe.throw(_("Row #{0}: Cumulative threshold cannot be less than Single Transaction threshold").format(d.idx)) + for d in self.get("rates"): + if ( + d.cumulative_threshold and d.single_threshold and d.cumulative_threshold < d.single_threshold + ): + frappe.throw( + _("Row #{0}: Cumulative threshold cannot be less than Single Transaction threshold").format( + d.idx + ) + ) + def get_party_details(inv): - party_type, party = '', '' + party_type, party = "", "" - if inv.doctype == 'Sales Invoice': - party_type = 'Customer' + if inv.doctype == "Sales Invoice": + party_type = "Customer" party = inv.customer else: - party_type = 'Supplier' + party_type = "Supplier" party = inv.supplier if not party: @@ -43,65 +50,71 @@ def get_party_details(inv): return party_type, party + def get_party_tax_withholding_details(inv, tax_withholding_category=None): - pan_no = '' + pan_no = "" parties = [] party_type, party = get_party_details(inv) has_pan_field = frappe.get_meta(party_type).has_field("pan") if not tax_withholding_category: if has_pan_field: - fields = ['tax_withholding_category', 'pan'] + fields = ["tax_withholding_category", "pan"] else: - fields = ['tax_withholding_category'] + fields = ["tax_withholding_category"] tax_withholding_details = frappe.db.get_value(party_type, party, fields, as_dict=1) - tax_withholding_category = tax_withholding_details.get('tax_withholding_category') - pan_no = tax_withholding_details.get('pan') + tax_withholding_category = tax_withholding_details.get("tax_withholding_category") + pan_no = tax_withholding_details.get("pan") if not tax_withholding_category: return # if tax_withholding_category passed as an argument but not pan_no if not pan_no and has_pan_field: - pan_no = frappe.db.get_value(party_type, party, 'pan') + pan_no = frappe.db.get_value(party_type, party, "pan") # Get others suppliers with the same PAN No if pan_no: - parties = frappe.get_all(party_type, filters={ 'pan': pan_no }, pluck='name') + parties = frappe.get_all(party_type, filters={"pan": pan_no}, pluck="name") if not parties: parties.append(party) - posting_date = inv.get('posting_date') or inv.get('transaction_date') + posting_date = inv.get("posting_date") or inv.get("transaction_date") tax_details = get_tax_withholding_details(tax_withholding_category, posting_date, inv.company) if not tax_details: - frappe.throw(_('Please set associated account in Tax Withholding Category {0} against Company {1}') - .format(tax_withholding_category, inv.company)) + frappe.throw( + _("Please set associated account in Tax Withholding Category {0} against Company {1}").format( + tax_withholding_category, inv.company + ) + ) - if party_type == 'Customer' and not tax_details.cumulative_threshold: + if party_type == "Customer" and not tax_details.cumulative_threshold: # TCS is only chargeable on sum of invoiced value - frappe.throw(_('Tax Withholding Category {} against Company {} for Customer {} should have Cumulative Threshold value.') - .format(tax_withholding_category, inv.company, party)) + frappe.throw( + _( + "Tax Withholding Category {} against Company {} for Customer {} should have Cumulative Threshold value." + ).format(tax_withholding_category, inv.company, party) + ) - tax_amount, tax_deducted, tax_deducted_on_advances = get_tax_amount( - party_type, parties, - inv, tax_details, - posting_date, pan_no + tax_amount, tax_deducted, tax_deducted_on_advances, voucher_wise_amount = get_tax_amount( + party_type, parties, inv, tax_details, posting_date, pan_no ) - if party_type == 'Supplier': + if party_type == "Supplier": tax_row = get_tax_row_for_tds(tax_details, tax_amount) else: tax_row = get_tax_row_for_tcs(inv, tax_details, tax_amount, tax_deducted) - if inv.doctype == 'Purchase Invoice': - return tax_row, tax_deducted_on_advances + if inv.doctype == "Purchase Invoice": + return tax_row, tax_deducted_on_advances, voucher_wise_amount else: return tax_row + def get_tax_withholding_details(tax_withholding_category, posting_date, company): tax_withholding = frappe.get_doc("Tax Withholding Category", tax_withholding_category) @@ -109,19 +122,24 @@ def get_tax_withholding_details(tax_withholding_category, posting_date, company) for account_detail in tax_withholding.accounts: if company == account_detail.company: - return frappe._dict({ - "tax_withholding_category": tax_withholding_category, - "account_head": account_detail.account, - "rate": tax_rate_detail.tax_withholding_rate, - "from_date": tax_rate_detail.from_date, - "to_date": tax_rate_detail.to_date, - "threshold": tax_rate_detail.single_threshold, - "cumulative_threshold": tax_rate_detail.cumulative_threshold, - "description": tax_withholding.category_name if tax_withholding.category_name else tax_withholding_category, - "consider_party_ledger_amount": tax_withholding.consider_party_ledger_amount, - "tax_on_excess_amount": tax_withholding.tax_on_excess_amount, - "round_off_tax_amount": tax_withholding.round_off_tax_amount - }) + return frappe._dict( + { + "tax_withholding_category": tax_withholding_category, + "account_head": account_detail.account, + "rate": tax_rate_detail.tax_withholding_rate, + "from_date": tax_rate_detail.from_date, + "to_date": tax_rate_detail.to_date, + "threshold": tax_rate_detail.single_threshold, + "cumulative_threshold": tax_rate_detail.cumulative_threshold, + "description": tax_withholding.category_name + if tax_withholding.category_name + else tax_withholding_category, + "consider_party_ledger_amount": tax_withholding.consider_party_ledger_amount, + "tax_on_excess_amount": tax_withholding.tax_on_excess_amount, + "round_off_tax_amount": tax_withholding.round_off_tax_amount, + } + ) + def get_tax_withholding_rates(tax_withholding, posting_date): # returns the row that matches with the fiscal year from posting date @@ -131,13 +149,14 @@ def get_tax_withholding_rates(tax_withholding, posting_date): frappe.throw(_("No Tax Withholding data found for the current posting date.")) + def get_tax_row_for_tcs(inv, tax_details, tax_amount, tax_deducted): row = { "category": "Total", "charge_type": "Actual", "tax_amount": tax_amount, "description": tax_details.description, - "account_head": tax_details.account_head + "account_head": tax_details.account_head, } if tax_deducted: @@ -147,20 +166,20 @@ def get_tax_row_for_tcs(inv, tax_details, tax_amount, tax_deducted): taxes_excluding_tcs = [d for d in inv.taxes if d.account_head != tax_details.account_head] if taxes_excluding_tcs: # chargeable amount is the total amount after other charges are applied - row.update({ - "charge_type": "On Previous Row Total", - "row_id": len(taxes_excluding_tcs), - "rate": tax_details.rate - }) + row.update( + { + "charge_type": "On Previous Row Total", + "row_id": len(taxes_excluding_tcs), + "rate": tax_details.rate, + } + ) else: # if only TCS is to be charged, then net total is chargeable amount - row.update({ - "charge_type": "On Net Total", - "rate": tax_details.rate - }) + row.update({"charge_type": "On Net Total", "rate": tax_details.rate}) return row + def get_tax_row_for_tds(tax_details, tax_amount): return { "category": "Total", @@ -168,29 +187,41 @@ def get_tax_row_for_tds(tax_details, tax_amount): "tax_amount": tax_amount, "add_deduct_tax": "Deduct", "description": tax_details.description, - "account_head": tax_details.account_head + "account_head": tax_details.account_head, } + def get_lower_deduction_certificate(tax_details, pan_no): - ldc_name = frappe.db.get_value('Lower Deduction Certificate', + ldc_name = frappe.db.get_value( + "Lower Deduction Certificate", { - 'pan_no': pan_no, - 'tax_withholding_category': tax_details.tax_withholding_category, - 'valid_from': ('>=', tax_details.from_date), - 'valid_upto': ('<=', tax_details.to_date) - }, 'name') + "pan_no": pan_no, + "tax_withholding_category": tax_details.tax_withholding_category, + "valid_from": (">=", tax_details.from_date), + "valid_upto": ("<=", tax_details.to_date), + }, + "name", + ) if ldc_name: - return frappe.get_doc('Lower Deduction Certificate', ldc_name) + return frappe.get_doc("Lower Deduction Certificate", ldc_name) + def get_tax_amount(party_type, parties, inv, tax_details, posting_date, pan_no=None): - vouchers = get_invoice_vouchers(parties, tax_details, inv.company, party_type=party_type) - advance_vouchers = get_advance_vouchers(parties, company=inv.company, from_date=tax_details.from_date, - to_date=tax_details.to_date, party_type=party_type) + vouchers, voucher_wise_amount = get_invoice_vouchers( + parties, tax_details, inv.company, party_type=party_type + ) + advance_vouchers = get_advance_vouchers( + parties, + company=inv.company, + from_date=tax_details.from_date, + to_date=tax_details.to_date, + party_type=party_type, + ) taxable_vouchers = vouchers + advance_vouchers tax_deducted_on_advances = 0 - if inv.doctype == 'Purchase Invoice': + if inv.doctype == "Purchase Invoice": tax_deducted_on_advances = get_taxes_deducted_on_advances_allocated(inv, tax_details) tax_deducted = 0 @@ -198,18 +229,21 @@ def get_tax_amount(party_type, parties, inv, tax_details, posting_date, pan_no=N tax_deducted = get_deducted_tax(taxable_vouchers, tax_details) tax_amount = 0 - if party_type == 'Supplier': + + if party_type == "Supplier": ldc = get_lower_deduction_certificate(tax_details, pan_no) if tax_deducted: net_total = inv.net_total if ldc: - tax_amount = get_tds_amount_from_ldc(ldc, parties, pan_no, tax_details, posting_date, net_total) + tax_amount = get_tds_amount_from_ldc( + ldc, parties, pan_no, tax_details, posting_date, net_total + ) else: tax_amount = net_total * tax_details.rate / 100 if net_total > 0 else 0 else: tax_amount = get_tds_amount(ldc, parties, inv, tax_details, tax_deducted, vouchers) - elif party_type == 'Customer': + elif party_type == "Customer": if tax_deducted: # if already TCS is charged, then amount will be calculated based on 'Previous Row Total' tax_amount = 0 @@ -221,83 +255,108 @@ def get_tax_amount(party_type, parties, inv, tax_details, posting_date, pan_no=N if cint(tax_details.round_off_tax_amount): tax_amount = round(tax_amount) - return tax_amount, tax_deducted, tax_deducted_on_advances + return tax_amount, tax_deducted, tax_deducted_on_advances, voucher_wise_amount -def get_invoice_vouchers(parties, tax_details, company, party_type='Supplier'): - dr_or_cr = 'credit' if party_type == 'Supplier' else 'debit' - doctype = 'Purchase Invoice' if party_type == 'Supplier' else 'Sales Invoice' + +def get_invoice_vouchers(parties, tax_details, company, party_type="Supplier"): + doctype = "Purchase Invoice" if party_type == "Supplier" else "Sales Invoice" + voucher_wise_amount = {} + vouchers = [] filters = { - 'company': company, - frappe.scrub(party_type): ['in', parties], - 'posting_date': ['between', (tax_details.from_date, tax_details.to_date)], - 'is_opening': 'No', - 'docstatus': 1 + "company": company, + frappe.scrub(party_type): ["in", parties], + "posting_date": ["between", (tax_details.from_date, tax_details.to_date)], + "is_opening": "No", + "docstatus": 1, } - if not tax_details.get('consider_party_ledger_amount') and doctype != "Sales Invoice": - filters.update({ - 'apply_tds': 1, - 'tax_withholding_category': tax_details.get('tax_withholding_category') - }) + if not tax_details.get("consider_party_ledger_amount") and doctype != "Sales Invoice": + filters.update( + {"apply_tds": 1, "tax_withholding_category": tax_details.get("tax_withholding_category")} + ) - invoices = frappe.get_all(doctype, filters=filters, pluck="name") or [""] + invoices_details = frappe.get_all(doctype, filters=filters, fields=["name", "base_net_total"]) - journal_entries = frappe.db.sql(""" - SELECT j.name + for d in invoices_details: + vouchers.append(d.name) + voucher_wise_amount.update({d.name: {"amount": d.base_net_total, "voucher_type": doctype}}) + + journal_entries_details = frappe.db.sql( + """ + SELECT j.name, ja.credit - ja.debit AS amount FROM `tabJournal Entry` j, `tabJournal Entry Account` ja WHERE - j.docstatus = 1 + j.name = ja.parent + AND j.docstatus = 1 AND j.is_opening = 'No' AND j.posting_date between %s and %s - AND ja.{dr_or_cr} > 0 AND ja.party in %s - """.format(dr_or_cr=dr_or_cr), (tax_details.from_date, tax_details.to_date, tuple(parties)), as_list=1) + AND j.apply_tds = 1 + AND j.tax_withholding_category = %s + """, + ( + tax_details.from_date, + tax_details.to_date, + tuple(parties), + tax_details.get("tax_withholding_category"), + ), + as_dict=1, + ) - if journal_entries: - journal_entries = journal_entries[0] + if journal_entries_details: + for d in journal_entries_details: + vouchers.append(d.name) + voucher_wise_amount.update({d.name: {"amount": d.amount, "voucher_type": "Journal Entry"}}) - return invoices + journal_entries + return vouchers, voucher_wise_amount -def get_advance_vouchers(parties, company=None, from_date=None, to_date=None, party_type='Supplier'): + +def get_advance_vouchers( + parties, company=None, from_date=None, to_date=None, party_type="Supplier" +): # for advance vouchers, debit and credit is reversed - dr_or_cr = 'debit' if party_type == 'Supplier' else 'credit' + dr_or_cr = "debit" if party_type == "Supplier" else "credit" filters = { - dr_or_cr: ['>', 0], - 'is_opening': 'No', - 'is_cancelled': 0, - 'party_type': party_type, - 'party': ['in', parties], - 'against_voucher': ['is', 'not set'] + dr_or_cr: [">", 0], + "is_opening": "No", + "is_cancelled": 0, + "party_type": party_type, + "party": ["in", parties], } - if company: - filters['company'] = company - if from_date and to_date: - filters['posting_date'] = ['between', (from_date, to_date)] + if party_type == "Customer": + filters.update({"against_voucher": ["is", "not set"]}) + + if company: + filters["company"] = company + if from_date and to_date: + filters["posting_date"] = ["between", (from_date, to_date)] + + return frappe.get_all("GL Entry", filters=filters, distinct=1, pluck="voucher_no") or [""] - return frappe.get_all('GL Entry', filters=filters, distinct=1, pluck='voucher_no') or [""] def get_taxes_deducted_on_advances_allocated(inv, tax_details): - advances = [d.reference_name for d in inv.get('advances')] tax_info = [] - if advances: - pe = frappe.qb.DocType("Payment Entry").as_("pe") - at = frappe.qb.DocType("Advance Taxes and Charges").as_("at") + if inv.get("advances"): + advances = [d.reference_name for d in inv.get("advances")] - tax_info = frappe.qb.from_(at).inner_join(pe).on( - pe.name == at.parent - ).select( - at.parent, at.name, at.tax_amount, at.allocated_amount - ).where( - pe.tax_withholding_category == tax_details.get('tax_withholding_category') - ).where( - at.parent.isin(advances) - ).where( - at.account_head == tax_details.account_head - ).run(as_dict=True) + if advances: + pe = frappe.qb.DocType("Payment Entry").as_("pe") + at = frappe.qb.DocType("Advance Taxes and Charges").as_("at") + + tax_info = ( + frappe.qb.from_(at) + .inner_join(pe) + .on(pe.name == at.parent) + .select(at.parent, at.name, at.tax_amount, at.allocated_amount) + .where(pe.tax_withholding_category == tax_details.get("tax_withholding_category")) + .where(at.parent.isin(advances)) + .where(at.account_head == tax_details.account_head) + .run(as_dict=True) + ) return tax_info @@ -305,59 +364,72 @@ def get_taxes_deducted_on_advances_allocated(inv, tax_details): def get_deducted_tax(taxable_vouchers, tax_details): # check if TDS / TCS account is already charged on taxable vouchers filters = { - 'is_cancelled': 0, - 'credit': ['>', 0], - 'posting_date': ['between', (tax_details.from_date, tax_details.to_date)], - 'account': tax_details.account_head, - 'voucher_no': ['in', taxable_vouchers], + "is_cancelled": 0, + "credit": [">", 0], + "posting_date": ["between", (tax_details.from_date, tax_details.to_date)], + "account": tax_details.account_head, + "voucher_no": ["in", taxable_vouchers], } field = "credit" - entries = frappe.db.get_all('GL Entry', filters, pluck=field) + entries = frappe.db.get_all("GL Entry", filters, pluck=field) return sum(entries) + def get_tds_amount(ldc, parties, inv, tax_details, tax_deducted, vouchers): tds_amount = 0 - invoice_filters = { - 'name': ('in', vouchers), - 'docstatus': 1, - 'apply_tds': 1 - } + supp_credit_amt = 0.0 + supp_jv_credit_amt = 0.0 - field = 'sum(net_total)' + invoice_filters = {"name": ("in", vouchers), "docstatus": 1, "apply_tds": 1} + + field = "sum(net_total)" if cint(tax_details.consider_party_ledger_amount): - invoice_filters.pop('apply_tds', None) - field = 'sum(grand_total)' + invoice_filters.pop("apply_tds", None) + field = "sum(grand_total)" - supp_credit_amt = frappe.db.get_value('Purchase Invoice', invoice_filters, field) or 0.0 + if vouchers: + supp_credit_amt = frappe.db.get_value("Purchase Invoice", invoice_filters, field) or 0.0 - supp_jv_credit_amt = frappe.db.get_value('Journal Entry Account', { - 'parent': ('in', vouchers), 'docstatus': 1, - 'party': ('in', parties), 'reference_type': ('!=', 'Purchase Invoice') - }, 'sum(credit_in_account_currency)') or 0.0 + supp_jv_credit_amt = ( + frappe.db.get_value( + "Journal Entry Account", + { + "parent": ("in", vouchers), + "docstatus": 1, + "party": ("in", parties), + "reference_type": ("!=", "Purchase Invoice"), + }, + "sum(credit_in_account_currency)", + ) + ) or 0.0 supp_credit_amt += supp_jv_credit_amt supp_credit_amt += inv.net_total - debit_note_amount = get_debit_note_amount(parties, tax_details.from_date, tax_details.to_date, inv.company) - supp_credit_amt -= debit_note_amount + threshold = tax_details.get("threshold", 0) + cumulative_threshold = tax_details.get("cumulative_threshold", 0) - threshold = tax_details.get('threshold', 0) - cumulative_threshold = tax_details.get('cumulative_threshold', 0) - - if ((threshold and inv.net_total >= threshold) or (cumulative_threshold and supp_credit_amt >= cumulative_threshold)): - if (cumulative_threshold and supp_credit_amt >= cumulative_threshold) and cint(tax_details.tax_on_excess_amount): + if (threshold and inv.net_total >= threshold) or ( + cumulative_threshold and supp_credit_amt >= cumulative_threshold + ): + if (cumulative_threshold and supp_credit_amt >= cumulative_threshold) and cint( + tax_details.tax_on_excess_amount + ): # Get net total again as TDS is calculated on net total # Grand is used to just check for threshold breach - net_total = frappe.db.get_value('Purchase Invoice', invoice_filters, 'sum(net_total)') or 0.0 + net_total = frappe.db.get_value("Purchase Invoice", invoice_filters, "sum(net_total)") or 0.0 net_total += inv.net_total supp_credit_amt = net_total - cumulative_threshold if ldc and is_valid_certificate( - ldc.valid_from, ldc.valid_upto, - inv.get('posting_date') or inv.get('transaction_date'), tax_deducted, - inv.net_total, ldc.certificate_limit + ldc.valid_from, + ldc.valid_upto, + inv.get("posting_date") or inv.get("transaction_date"), + tax_deducted, + inv.net_total, + ldc.certificate_limit, ): tds_amount = get_ltds_amount(supp_credit_amt, 0, ldc.certificate_limit, ldc.rate, tax_details) else: @@ -365,98 +437,115 @@ def get_tds_amount(ldc, parties, inv, tax_details, tax_deducted, vouchers): return tds_amount + def get_tcs_amount(parties, inv, tax_details, vouchers, adv_vouchers): tcs_amount = 0 + invoiced_amt = 0 + advance_amt = 0 # sum of debit entries made from sales invoices - invoiced_amt = frappe.db.get_value('GL Entry', { - 'is_cancelled': 0, - 'party': ['in', parties], - 'company': inv.company, - 'voucher_no': ['in', vouchers], - }, 'sum(debit)') or 0.0 + if vouchers: + invoiced_amt = ( + frappe.db.get_value( + "GL Entry", + { + "is_cancelled": 0, + "party": ["in", parties], + "company": inv.company, + "voucher_no": ["in", vouchers], + }, + "sum(debit)", + ) + or 0.0 + ) # sum of credit entries made from PE / JV with unset 'against voucher' - advance_amt = frappe.db.get_value('GL Entry', { - 'is_cancelled': 0, - 'party': ['in', parties], - 'company': inv.company, - 'voucher_no': ['in', adv_vouchers], - }, 'sum(credit)') or 0.0 + if advance_amt: + advance_amt = ( + frappe.db.get_value( + "GL Entry", + { + "is_cancelled": 0, + "party": ["in", parties], + "company": inv.company, + "voucher_no": ["in", adv_vouchers], + }, + "sum(credit)", + ) + or 0.0 + ) # sum of credit entries made from sales invoice - credit_note_amt = sum(frappe.db.get_all('GL Entry', { - 'is_cancelled': 0, - 'credit': ['>', 0], - 'party': ['in', parties], - 'posting_date': ['between', (tax_details.from_date, tax_details.to_date)], - 'company': inv.company, - 'voucher_type': 'Sales Invoice', - }, pluck='credit')) + credit_note_amt = sum( + frappe.db.get_all( + "GL Entry", + { + "is_cancelled": 0, + "credit": [">", 0], + "party": ["in", parties], + "posting_date": ["between", (tax_details.from_date, tax_details.to_date)], + "company": inv.company, + "voucher_type": "Sales Invoice", + }, + pluck="credit", + ) + ) - cumulative_threshold = tax_details.get('cumulative_threshold', 0) + cumulative_threshold = tax_details.get("cumulative_threshold", 0) current_invoice_total = get_invoice_total_without_tcs(inv, tax_details) total_invoiced_amt = current_invoice_total + invoiced_amt + advance_amt - credit_note_amt - if ((cumulative_threshold and total_invoiced_amt >= cumulative_threshold)): + if cumulative_threshold and total_invoiced_amt >= cumulative_threshold: chargeable_amt = total_invoiced_amt - cumulative_threshold tcs_amount = chargeable_amt * tax_details.rate / 100 if chargeable_amt > 0 else 0 return tcs_amount + def get_invoice_total_without_tcs(inv, tax_details): tcs_tax_row = [d for d in inv.taxes if d.account_head == tax_details.account_head] tcs_tax_row_amount = tcs_tax_row[0].base_tax_amount if tcs_tax_row else 0 return inv.grand_total - tcs_tax_row_amount + def get_tds_amount_from_ldc(ldc, parties, pan_no, tax_details, posting_date, net_total): tds_amount = 0 - limit_consumed = frappe.db.get_value('Purchase Invoice', { - 'supplier': ('in', parties), - 'apply_tds': 1, - 'docstatus': 1 - }, 'sum(net_total)') + limit_consumed = frappe.db.get_value( + "Purchase Invoice", + {"supplier": ("in", parties), "apply_tds": 1, "docstatus": 1}, + "sum(net_total)", + ) if is_valid_certificate( - ldc.valid_from, ldc.valid_upto, - posting_date, limit_consumed, - net_total, ldc.certificate_limit + ldc.valid_from, ldc.valid_upto, posting_date, limit_consumed, net_total, ldc.certificate_limit ): - tds_amount = get_ltds_amount(net_total, limit_consumed, ldc.certificate_limit, ldc.rate, tax_details) + tds_amount = get_ltds_amount( + net_total, limit_consumed, ldc.certificate_limit, ldc.rate, tax_details + ) return tds_amount -def get_debit_note_amount(suppliers, from_date, to_date, company=None): - - filters = { - 'supplier': ['in', suppliers], - 'is_return': 1, - 'docstatus': 1, - 'posting_date': ['between', (from_date, to_date)] - } - fields = ['abs(sum(net_total)) as net_total'] - - if company: - filters['company'] = company - - return frappe.get_all('Purchase Invoice', filters, fields)[0].get('net_total') or 0.0 def get_ltds_amount(current_amount, deducted_amount, certificate_limit, rate, tax_details): if current_amount < (certificate_limit - deducted_amount): - return current_amount * rate/100 + return current_amount * rate / 100 else: - ltds_amount = (certificate_limit - deducted_amount) + ltds_amount = certificate_limit - deducted_amount tds_amount = current_amount - ltds_amount - return ltds_amount * rate/100 + tds_amount * tax_details.rate/100 + return ltds_amount * rate / 100 + tds_amount * tax_details.rate / 100 -def is_valid_certificate(valid_from, valid_upto, posting_date, deducted_amount, current_amount, certificate_limit): + +def is_valid_certificate( + valid_from, valid_upto, posting_date, deducted_amount, current_amount, certificate_limit +): valid = False - if ((getdate(valid_from) <= getdate(posting_date) <= getdate(valid_upto)) and - certificate_limit > deducted_amount): + if ( + getdate(valid_from) <= getdate(posting_date) <= getdate(valid_upto) + ) and certificate_limit > deducted_amount: valid = True return valid diff --git a/erpnext/accounts/doctype/tax_withholding_category/tax_withholding_category_dashboard.py b/erpnext/accounts/doctype/tax_withholding_category/tax_withholding_category_dashboard.py index 46d0c2e487e..8a510ea023f 100644 --- a/erpnext/accounts/doctype/tax_withholding_category/tax_withholding_category_dashboard.py +++ b/erpnext/accounts/doctype/tax_withholding_category/tax_withholding_category_dashboard.py @@ -1,11 +1,2 @@ - - def get_data(): - return { - 'fieldname': 'tax_withholding_category', - 'transactions': [ - { - 'items': ['Supplier'] - } - ] - } + return {"fieldname": "tax_withholding_category", "transactions": [{"items": ["Supplier"]}]} diff --git a/erpnext/accounts/doctype/tax_withholding_category/test_tax_withholding_category.py b/erpnext/accounts/doctype/tax_withholding_category/test_tax_withholding_category.py index a3fcf7da7a5..e80fe11ab30 100644 --- a/erpnext/accounts/doctype/tax_withholding_category/test_tax_withholding_category.py +++ b/erpnext/accounts/doctype/tax_withholding_category/test_tax_withholding_category.py @@ -10,6 +10,7 @@ from erpnext.accounts.utils import get_fiscal_year test_dependencies = ["Supplier Group", "Customer Group"] + class TestTaxWithholdingCategory(unittest.TestCase): @classmethod def setUpClass(self): @@ -21,18 +22,20 @@ class TestTaxWithholdingCategory(unittest.TestCase): cancel_invoices() def test_cumulative_threshold_tds(self): - frappe.db.set_value("Supplier", "Test TDS Supplier", "tax_withholding_category", "Cumulative Threshold TDS") + frappe.db.set_value( + "Supplier", "Test TDS Supplier", "tax_withholding_category", "Cumulative Threshold TDS" + ) invoices = [] # create invoices for lower than single threshold tax rate for _ in range(2): - pi = create_purchase_invoice(supplier = "Test TDS Supplier") + pi = create_purchase_invoice(supplier="Test TDS Supplier") pi.submit() invoices.append(pi) # create another invoice whose total when added to previously created invoice, # surpasses cumulative threshhold - pi = create_purchase_invoice(supplier = "Test TDS Supplier") + pi = create_purchase_invoice(supplier="Test TDS Supplier") pi.submit() # assert equal tax deduction on total invoice amount uptil now @@ -41,21 +44,23 @@ class TestTaxWithholdingCategory(unittest.TestCase): invoices.append(pi) # TDS is already deducted, so from onward system will deduct the TDS on every invoice - pi = create_purchase_invoice(supplier = "Test TDS Supplier", rate=5000) + pi = create_purchase_invoice(supplier="Test TDS Supplier", rate=5000) pi.submit() # assert equal tax deduction on total invoice amount uptil now self.assertEqual(pi.taxes_and_charges_deducted, 500) invoices.append(pi) - #delete invoices to avoid clashing - for d in invoices: + # delete invoices to avoid clashing + for d in reversed(invoices): d.cancel() def test_single_threshold_tds(self): invoices = [] - frappe.db.set_value("Supplier", "Test TDS Supplier1", "tax_withholding_category", "Single Threshold TDS") - pi = create_purchase_invoice(supplier = "Test TDS Supplier1", rate = 20000) + frappe.db.set_value( + "Supplier", "Test TDS Supplier1", "tax_withholding_category", "Single Threshold TDS" + ) + pi = create_purchase_invoice(supplier="Test TDS Supplier1", rate=20000) pi.submit() invoices.append(pi) @@ -63,7 +68,7 @@ class TestTaxWithholdingCategory(unittest.TestCase): self.assertEqual(pi.grand_total, 18000) # check gl entry for the purchase invoice - gl_entries = frappe.db.get_all('GL Entry', filters={'voucher_no': pi.name}, fields=["*"]) + gl_entries = frappe.db.get_all("GL Entry", filters={"voucher_no": pi.name}, fields=["*"]) self.assertEqual(len(gl_entries), 3) for d in gl_entries: if d.account == pi.credit_to: @@ -75,7 +80,7 @@ class TestTaxWithholdingCategory(unittest.TestCase): else: raise ValueError("Account head does not match.") - pi = create_purchase_invoice(supplier = "Test TDS Supplier1") + pi = create_purchase_invoice(supplier="Test TDS Supplier1") pi.submit() invoices.append(pi) @@ -83,22 +88,24 @@ class TestTaxWithholdingCategory(unittest.TestCase): self.assertEqual(pi.taxes_and_charges_deducted, 1000) # delete invoices to avoid clashing - for d in invoices: + for d in reversed(invoices): d.cancel() def test_tax_withholding_category_checks(self): invoices = [] - frappe.db.set_value("Supplier", "Test TDS Supplier3", "tax_withholding_category", "New TDS Category") + frappe.db.set_value( + "Supplier", "Test TDS Supplier3", "tax_withholding_category", "New TDS Category" + ) # First Invoice with no tds check - pi = create_purchase_invoice(supplier = "Test TDS Supplier3", rate = 20000, do_not_save=True) + pi = create_purchase_invoice(supplier="Test TDS Supplier3", rate=20000, do_not_save=True) pi.apply_tds = 0 pi.save() pi.submit() invoices.append(pi) # Second Invoice will apply TDS checked - pi1 = create_purchase_invoice(supplier = "Test TDS Supplier3", rate = 20000) + pi1 = create_purchase_invoice(supplier="Test TDS Supplier3", rate=20000) pi1.submit() invoices.append(pi1) @@ -107,85 +114,92 @@ class TestTaxWithholdingCategory(unittest.TestCase): # TDS should be applied only on 1000 self.assertEqual(pi1.taxes[0].tax_amount, 1000) - for d in invoices: + for d in reversed(invoices): d.cancel() - def test_cumulative_threshold_tcs(self): - frappe.db.set_value("Customer", "Test TCS Customer", "tax_withholding_category", "Cumulative Threshold TCS") + frappe.db.set_value( + "Customer", "Test TCS Customer", "tax_withholding_category", "Cumulative Threshold TCS" + ) invoices = [] # create invoices for lower than single threshold tax rate for _ in range(2): - si = create_sales_invoice(customer = "Test TCS Customer") + si = create_sales_invoice(customer="Test TCS Customer") si.submit() invoices.append(si) # create another invoice whose total when added to previously created invoice, # surpasses cumulative threshhold - si = create_sales_invoice(customer = "Test TCS Customer", rate=12000) + si = create_sales_invoice(customer="Test TCS Customer", rate=12000) si.submit() # assert tax collection on total invoice amount created until now - tcs_charged = sum([d.base_tax_amount for d in si.taxes if d.account_head == 'TCS - _TC']) + tcs_charged = sum([d.base_tax_amount for d in si.taxes if d.account_head == "TCS - _TC"]) self.assertEqual(tcs_charged, 200) self.assertEqual(si.grand_total, 12200) invoices.append(si) # TCS is already collected once, so going forward system will collect TCS on every invoice - si = create_sales_invoice(customer = "Test TCS Customer", rate=5000) + si = create_sales_invoice(customer="Test TCS Customer", rate=5000) si.submit() - tcs_charged = sum(d.base_tax_amount for d in si.taxes if d.account_head == 'TCS - _TC') + tcs_charged = sum(d.base_tax_amount for d in si.taxes if d.account_head == "TCS - _TC") self.assertEqual(tcs_charged, 500) invoices.append(si) - #delete invoices to avoid clashing - for d in invoices: + # cancel invoices to avoid clashing + for d in reversed(invoices): d.cancel() def test_tds_calculation_on_net_total(self): - frappe.db.set_value("Supplier", "Test TDS Supplier4", "tax_withholding_category", "Cumulative Threshold TDS") + frappe.db.set_value( + "Supplier", "Test TDS Supplier4", "tax_withholding_category", "Cumulative Threshold TDS" + ) invoices = [] - pi = create_purchase_invoice(supplier = "Test TDS Supplier4", rate = 20000, do_not_save=True) - pi.append('taxes', { - "category": "Total", - "charge_type": "Actual", - "account_head": '_Test Account VAT - _TC', - "cost_center": 'Main - _TC', - "tax_amount": 1000, - "description": "Test", - "add_deduct_tax": "Add" - - }) + pi = create_purchase_invoice(supplier="Test TDS Supplier4", rate=20000, do_not_save=True) + pi.append( + "taxes", + { + "category": "Total", + "charge_type": "Actual", + "account_head": "_Test Account VAT - _TC", + "cost_center": "Main - _TC", + "tax_amount": 1000, + "description": "Test", + "add_deduct_tax": "Add", + }, + ) pi.save() pi.submit() invoices.append(pi) # Second Invoice will apply TDS checked - pi1 = create_purchase_invoice(supplier = "Test TDS Supplier4", rate = 20000) + pi1 = create_purchase_invoice(supplier="Test TDS Supplier4", rate=20000) pi1.submit() invoices.append(pi1) self.assertEqual(pi1.taxes[0].tax_amount, 4000) - #delete invoices to avoid clashing - for d in invoices: + # cancel invoices to avoid clashing + for d in reversed(invoices): d.cancel() def test_multi_category_single_supplier(self): - frappe.db.set_value("Supplier", "Test TDS Supplier5", "tax_withholding_category", "Test Service Category") + frappe.db.set_value( + "Supplier", "Test TDS Supplier5", "tax_withholding_category", "Test Service Category" + ) invoices = [] - pi = create_purchase_invoice(supplier = "Test TDS Supplier5", rate = 500, do_not_save=True) + pi = create_purchase_invoice(supplier="Test TDS Supplier5", rate=500, do_not_save=True) pi.tax_withholding_category = "Test Service Category" pi.save() pi.submit() invoices.append(pi) # Second Invoice will apply TDS checked - pi1 = create_purchase_invoice(supplier = "Test TDS Supplier5", rate = 2500, do_not_save=True) + pi1 = create_purchase_invoice(supplier="Test TDS Supplier5", rate=2500, do_not_save=True) pi1.tax_withholding_category = "Test Goods Category" pi1.save() pi1.submit() @@ -193,258 +207,356 @@ class TestTaxWithholdingCategory(unittest.TestCase): self.assertEqual(pi1.taxes[0].tax_amount, 250) - #delete invoices to avoid clashing - for d in invoices: + # cancel invoices to avoid clashing + for d in reversed(invoices): d.cancel() -def cancel_invoices(): - purchase_invoices = frappe.get_all("Purchase Invoice", { - 'supplier': ['in', ['Test TDS Supplier', 'Test TDS Supplier1', 'Test TDS Supplier2']], - 'docstatus': 1 - }, pluck="name") + def test_tax_withholding_category_voucher_display(self): + frappe.db.set_value( + "Supplier", "Test TDS Supplier6", "tax_withholding_category", "Test Multi Invoice Category" + ) + invoices = [] - sales_invoices = frappe.get_all("Sales Invoice", { - 'customer': 'Test TCS Customer', - 'docstatus': 1 - }, pluck="name") + pi = create_purchase_invoice(supplier="Test TDS Supplier6", rate=4000, do_not_save=True) + pi.apply_tds = 1 + pi.tax_withholding_category = "Test Multi Invoice Category" + pi.save() + pi.submit() + invoices.append(pi) + + pi1 = create_purchase_invoice(supplier="Test TDS Supplier6", rate=2000, do_not_save=True) + pi1.apply_tds = 1 + pi1.is_return = 1 + pi1.items[0].qty = -1 + pi1.tax_withholding_category = "Test Multi Invoice Category" + pi1.save() + pi1.submit() + invoices.append(pi1) + + pi2 = create_purchase_invoice(supplier="Test TDS Supplier6", rate=9000, do_not_save=True) + pi2.apply_tds = 1 + pi2.tax_withholding_category = "Test Multi Invoice Category" + pi2.save() + pi2.submit() + invoices.append(pi2) + + pi2.load_from_db() + + self.assertTrue(pi2.taxes[0].tax_amount, 1100) + + self.assertTrue(pi2.tax_withheld_vouchers[0].voucher_name == pi1.name) + self.assertTrue(pi2.tax_withheld_vouchers[0].taxable_amount == pi1.net_total) + self.assertTrue(pi2.tax_withheld_vouchers[1].voucher_name == pi.name) + self.assertTrue(pi2.tax_withheld_vouchers[1].taxable_amount == pi.net_total) + + # cancel invoices to avoid clashing + for d in reversed(invoices): + d.cancel() + + +def cancel_invoices(): + purchase_invoices = frappe.get_all( + "Purchase Invoice", + { + "supplier": ["in", ["Test TDS Supplier", "Test TDS Supplier1", "Test TDS Supplier2"]], + "docstatus": 1, + }, + pluck="name", + ) + + sales_invoices = frappe.get_all( + "Sales Invoice", {"customer": "Test TCS Customer", "docstatus": 1}, pluck="name" + ) for d in purchase_invoices: - frappe.get_doc('Purchase Invoice', d).cancel() + frappe.get_doc("Purchase Invoice", d).cancel() for d in sales_invoices: - frappe.get_doc('Sales Invoice', d).cancel() + frappe.get_doc("Sales Invoice", d).cancel() + def create_purchase_invoice(**args): # return sales invoice doc object - item = frappe.db.get_value('Item', {'item_name': 'TDS Item'}, "name") + item = frappe.db.get_value("Item", {"item_name": "TDS Item"}, "name") args = frappe._dict(args) - pi = frappe.get_doc({ - "doctype": "Purchase Invoice", - "posting_date": today(), - "apply_tds": 0 if args.do_not_apply_tds else 1, - "supplier": args.supplier, - "company": '_Test Company', - "taxes_and_charges": "", - "currency": "INR", - "credit_to": "Creditors - _TC", - "taxes": [], - "items": [{ - 'doctype': 'Purchase Invoice Item', - 'item_code': item, - 'qty': args.qty or 1, - 'rate': args.rate or 10000, - 'cost_center': 'Main - _TC', - 'expense_account': 'Stock Received But Not Billed - _TC' - }] - }) + pi = frappe.get_doc( + { + "doctype": "Purchase Invoice", + "posting_date": today(), + "apply_tds": 0 if args.do_not_apply_tds else 1, + "supplier": args.supplier, + "company": "_Test Company", + "taxes_and_charges": "", + "currency": "INR", + "credit_to": "Creditors - _TC", + "taxes": [], + "items": [ + { + "doctype": "Purchase Invoice Item", + "item_code": item, + "qty": args.qty or 1, + "rate": args.rate or 10000, + "cost_center": "Main - _TC", + "expense_account": "Stock Received But Not Billed - _TC", + } + ], + } + ) pi.save() return pi + def create_sales_invoice(**args): # return sales invoice doc object - item = frappe.db.get_value('Item', {'item_name': 'TCS Item'}, "name") + item = frappe.db.get_value("Item", {"item_name": "TCS Item"}, "name") args = frappe._dict(args) - si = frappe.get_doc({ - "doctype": "Sales Invoice", - "posting_date": today(), - "customer": args.customer, - "company": '_Test Company', - "taxes_and_charges": "", - "currency": "INR", - "debit_to": "Debtors - _TC", - "taxes": [], - "items": [{ - 'doctype': 'Sales Invoice Item', - 'item_code': item, - 'qty': args.qty or 1, - 'rate': args.rate or 10000, - 'cost_center': 'Main - _TC', - 'expense_account': 'Cost of Goods Sold - _TC', - 'warehouse': args.warehouse or '_Test Warehouse - _TC' - }] - }) + si = frappe.get_doc( + { + "doctype": "Sales Invoice", + "posting_date": today(), + "customer": args.customer, + "company": "_Test Company", + "taxes_and_charges": "", + "currency": "INR", + "debit_to": "Debtors - _TC", + "taxes": [], + "items": [ + { + "doctype": "Sales Invoice Item", + "item_code": item, + "qty": args.qty or 1, + "rate": args.rate or 10000, + "cost_center": "Main - _TC", + "expense_account": "Cost of Goods Sold - _TC", + "warehouse": args.warehouse or "_Test Warehouse - _TC", + } + ], + } + ) si.save() return si + def create_records(): # create a new suppliers - for name in ['Test TDS Supplier', 'Test TDS Supplier1', 'Test TDS Supplier2', 'Test TDS Supplier3', - 'Test TDS Supplier4', 'Test TDS Supplier5']: - if frappe.db.exists('Supplier', name): + for name in [ + "Test TDS Supplier", + "Test TDS Supplier1", + "Test TDS Supplier2", + "Test TDS Supplier3", + "Test TDS Supplier4", + "Test TDS Supplier5", + "Test TDS Supplier6", + ]: + if frappe.db.exists("Supplier", name): continue - frappe.get_doc({ - "supplier_group": "_Test Supplier Group", - "supplier_name": name, - "doctype": "Supplier", - }).insert() + frappe.get_doc( + { + "supplier_group": "_Test Supplier Group", + "supplier_name": name, + "doctype": "Supplier", + } + ).insert() - for name in ['Test TCS Customer']: - if frappe.db.exists('Customer', name): + for name in ["Test TCS Customer"]: + if frappe.db.exists("Customer", name): continue - frappe.get_doc({ - "customer_group": "_Test Customer Group", - "customer_name": name, - "doctype": "Customer" - }).insert() + frappe.get_doc( + {"customer_group": "_Test Customer Group", "customer_name": name, "doctype": "Customer"} + ).insert() # create item - if not frappe.db.exists('Item', "TDS Item"): - frappe.get_doc({ - "doctype": "Item", - "item_code": "TDS Item", - "item_name": "TDS Item", - "item_group": "All Item Groups", - "is_stock_item": 0, - }).insert() + if not frappe.db.exists("Item", "TDS Item"): + frappe.get_doc( + { + "doctype": "Item", + "item_code": "TDS Item", + "item_name": "TDS Item", + "item_group": "All Item Groups", + "is_stock_item": 0, + } + ).insert() - if not frappe.db.exists('Item', "TCS Item"): - frappe.get_doc({ - "doctype": "Item", - "item_code": "TCS Item", - "item_name": "TCS Item", - "item_group": "All Item Groups", - "is_stock_item": 1 - }).insert() + if not frappe.db.exists("Item", "TCS Item"): + frappe.get_doc( + { + "doctype": "Item", + "item_code": "TCS Item", + "item_name": "TCS Item", + "item_group": "All Item Groups", + "is_stock_item": 1, + } + ).insert() # create tds account if not frappe.db.exists("Account", "TDS - _TC"): - frappe.get_doc({ - 'doctype': 'Account', - 'company': '_Test Company', - 'account_name': 'TDS', - 'parent_account': 'Tax Assets - _TC', - 'report_type': 'Balance Sheet', - 'root_type': 'Asset' - }).insert() + frappe.get_doc( + { + "doctype": "Account", + "company": "_Test Company", + "account_name": "TDS", + "parent_account": "Tax Assets - _TC", + "report_type": "Balance Sheet", + "root_type": "Asset", + } + ).insert() # create tcs account if not frappe.db.exists("Account", "TCS - _TC"): - frappe.get_doc({ - 'doctype': 'Account', - 'company': '_Test Company', - 'account_name': 'TCS', - 'parent_account': 'Duties and Taxes - _TC', - 'report_type': 'Balance Sheet', - 'root_type': 'Liability' - }).insert() + frappe.get_doc( + { + "doctype": "Account", + "company": "_Test Company", + "account_name": "TCS", + "parent_account": "Duties and Taxes - _TC", + "report_type": "Balance Sheet", + "root_type": "Liability", + } + ).insert() + def create_tax_with_holding_category(): fiscal_year = get_fiscal_year(today(), company="_Test Company") # Cumulative threshold if not frappe.db.exists("Tax Withholding Category", "Cumulative Threshold TDS"): - frappe.get_doc({ - "doctype": "Tax Withholding Category", - "name": "Cumulative Threshold TDS", - "category_name": "10% TDS", - "rates": [{ - 'from_date': fiscal_year[1], - 'to_date': fiscal_year[2], - 'tax_withholding_rate': 10, - 'single_threshold': 0, - 'cumulative_threshold': 30000.00 - }], - "accounts": [{ - 'company': '_Test Company', - 'account': 'TDS - _TC' - }] - }).insert() + frappe.get_doc( + { + "doctype": "Tax Withholding Category", + "name": "Cumulative Threshold TDS", + "category_name": "10% TDS", + "rates": [ + { + "from_date": fiscal_year[1], + "to_date": fiscal_year[2], + "tax_withholding_rate": 10, + "single_threshold": 0, + "cumulative_threshold": 30000.00, + } + ], + "accounts": [{"company": "_Test Company", "account": "TDS - _TC"}], + } + ).insert() if not frappe.db.exists("Tax Withholding Category", "Cumulative Threshold TCS"): - frappe.get_doc({ - "doctype": "Tax Withholding Category", - "name": "Cumulative Threshold TCS", - "category_name": "10% TCS", - "rates": [{ - 'from_date': fiscal_year[1], - 'to_date': fiscal_year[2], - 'tax_withholding_rate': 10, - 'single_threshold': 0, - 'cumulative_threshold': 30000.00 - }], - "accounts": [{ - 'company': '_Test Company', - 'account': 'TCS - _TC' - }] - }).insert() + frappe.get_doc( + { + "doctype": "Tax Withholding Category", + "name": "Cumulative Threshold TCS", + "category_name": "10% TCS", + "rates": [ + { + "from_date": fiscal_year[1], + "to_date": fiscal_year[2], + "tax_withholding_rate": 10, + "single_threshold": 0, + "cumulative_threshold": 30000.00, + } + ], + "accounts": [{"company": "_Test Company", "account": "TCS - _TC"}], + } + ).insert() # Single thresold if not frappe.db.exists("Tax Withholding Category", "Single Threshold TDS"): - frappe.get_doc({ - "doctype": "Tax Withholding Category", - "name": "Single Threshold TDS", - "category_name": "10% TDS", - "rates": [{ - 'from_date': fiscal_year[1], - 'to_date': fiscal_year[2], - 'tax_withholding_rate': 10, - 'single_threshold': 20000.00, - 'cumulative_threshold': 0 - }], - "accounts": [{ - 'company': '_Test Company', - 'account': 'TDS - _TC' - }] - }).insert() + frappe.get_doc( + { + "doctype": "Tax Withholding Category", + "name": "Single Threshold TDS", + "category_name": "10% TDS", + "rates": [ + { + "from_date": fiscal_year[1], + "to_date": fiscal_year[2], + "tax_withholding_rate": 10, + "single_threshold": 20000.00, + "cumulative_threshold": 0, + } + ], + "accounts": [{"company": "_Test Company", "account": "TDS - _TC"}], + } + ).insert() if not frappe.db.exists("Tax Withholding Category", "New TDS Category"): - frappe.get_doc({ - "doctype": "Tax Withholding Category", - "name": "New TDS Category", - "category_name": "New TDS Category", - "round_off_tax_amount": 1, - "consider_party_ledger_amount": 1, - "tax_on_excess_amount": 1, - "rates": [{ - 'from_date': fiscal_year[1], - 'to_date': fiscal_year[2], - 'tax_withholding_rate': 10, - 'single_threshold': 0, - 'cumulative_threshold': 30000 - }], - "accounts": [{ - 'company': '_Test Company', - 'account': 'TDS - _TC' - }] - }).insert() + frappe.get_doc( + { + "doctype": "Tax Withholding Category", + "name": "New TDS Category", + "category_name": "New TDS Category", + "round_off_tax_amount": 1, + "consider_party_ledger_amount": 1, + "tax_on_excess_amount": 1, + "rates": [ + { + "from_date": fiscal_year[1], + "to_date": fiscal_year[2], + "tax_withholding_rate": 10, + "single_threshold": 0, + "cumulative_threshold": 30000, + } + ], + "accounts": [{"company": "_Test Company", "account": "TDS - _TC"}], + } + ).insert() if not frappe.db.exists("Tax Withholding Category", "Test Service Category"): - frappe.get_doc({ - "doctype": "Tax Withholding Category", - "name": "Test Service Category", - "category_name": "Test Service Category", - "rates": [{ - 'from_date': fiscal_year[1], - 'to_date': fiscal_year[2], - 'tax_withholding_rate': 10, - 'single_threshold': 2000, - 'cumulative_threshold': 2000 - }], - "accounts": [{ - 'company': '_Test Company', - 'account': 'TDS - _TC' - }] - }).insert() + frappe.get_doc( + { + "doctype": "Tax Withholding Category", + "name": "Test Service Category", + "category_name": "Test Service Category", + "rates": [ + { + "from_date": fiscal_year[1], + "to_date": fiscal_year[2], + "tax_withholding_rate": 10, + "single_threshold": 2000, + "cumulative_threshold": 2000, + } + ], + "accounts": [{"company": "_Test Company", "account": "TDS - _TC"}], + } + ).insert() if not frappe.db.exists("Tax Withholding Category", "Test Goods Category"): - frappe.get_doc({ - "doctype": "Tax Withholding Category", - "name": "Test Goods Category", - "category_name": "Test Goods Category", - "rates": [{ - 'from_date': fiscal_year[1], - 'to_date': fiscal_year[2], - 'tax_withholding_rate': 10, - 'single_threshold': 2000, - 'cumulative_threshold': 2000 - }], - "accounts": [{ - 'company': '_Test Company', - 'account': 'TDS - _TC' - }] - }).insert() + frappe.get_doc( + { + "doctype": "Tax Withholding Category", + "name": "Test Goods Category", + "category_name": "Test Goods Category", + "rates": [ + { + "from_date": fiscal_year[1], + "to_date": fiscal_year[2], + "tax_withholding_rate": 10, + "single_threshold": 2000, + "cumulative_threshold": 2000, + } + ], + "accounts": [{"company": "_Test Company", "account": "TDS - _TC"}], + } + ).insert() + + if not frappe.db.exists("Tax Withholding Category", "Test Multi Invoice Category"): + frappe.get_doc( + { + "doctype": "Tax Withholding Category", + "name": "Test Multi Invoice Category", + "category_name": "Test Multi Invoice Category", + "rates": [ + { + "from_date": fiscal_year[1], + "to_date": fiscal_year[2], + "tax_withholding_rate": 10, + "single_threshold": 5000, + "cumulative_threshold": 10000, + } + ], + "accounts": [{"company": "_Test Company", "account": "TDS - _TC"}], + } + ).insert() diff --git a/erpnext/accounts/doctype/tax_withholding_rate/tax_withholding_rate.json b/erpnext/accounts/doctype/tax_withholding_rate/tax_withholding_rate.json index d2c505c6300..e032bb307b0 100644 --- a/erpnext/accounts/doctype/tax_withholding_rate/tax_withholding_rate.json +++ b/erpnext/accounts/doctype/tax_withholding_rate/tax_withholding_rate.json @@ -28,14 +28,14 @@ { "columns": 2, "fieldname": "single_threshold", - "fieldtype": "Currency", + "fieldtype": "Float", "in_list_view": 1, "label": "Single Transaction Threshold" }, { "columns": 3, "fieldname": "cumulative_threshold", - "fieldtype": "Currency", + "fieldtype": "Float", "in_list_view": 1, "label": "Cumulative Transaction Threshold" }, @@ -59,7 +59,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-08-31 11:42:12.213977", + "modified": "2022-01-13 12:04:42.904263", "modified_by": "Administrator", "module": "Accounts", "name": "Tax Withholding Rate", @@ -68,5 +68,6 @@ "quick_entry": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/accounts/general_ledger.py b/erpnext/accounts/general_ledger.py index 1836db6477f..7525369d4f6 100644 --- a/erpnext/accounts/general_ledger.py +++ b/erpnext/accounts/general_ledger.py @@ -14,23 +14,59 @@ from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import ( from erpnext.accounts.doctype.budget.budget import validate_expense_against_budget -class ClosedAccountingPeriod(frappe.ValidationError): pass +class ClosedAccountingPeriod(frappe.ValidationError): + pass -def make_gl_entries(gl_map, cancel=False, adv_adj=False, merge_entries=True, update_outstanding='Yes', from_repost=False): + +def make_gl_entries( + gl_map, + cancel=False, + adv_adj=False, + merge_entries=True, + update_outstanding="Yes", + from_repost=False, +): if gl_map: if not cancel: validate_accounting_period(gl_map) + validate_disabled_accounts(gl_map) gl_map = process_gl_map(gl_map, merge_entries) if gl_map and len(gl_map) > 1: save_entries(gl_map, adv_adj, update_outstanding, from_repost) # Post GL Map proccess there may no be any GL Entries elif gl_map: - frappe.throw(_("Incorrect number of General Ledger Entries found. You might have selected a wrong Account in the transaction.")) + frappe.throw( + _( + "Incorrect number of General Ledger Entries found. You might have selected a wrong Account in the transaction." + ) + ) else: make_reverse_gl_entries(gl_map, adv_adj=adv_adj, update_outstanding=update_outstanding) + +def validate_disabled_accounts(gl_map): + accounts = [d.account for d in gl_map if d.account] + + Account = frappe.qb.DocType("Account") + + disabled_accounts = ( + frappe.qb.from_(Account) + .where(Account.name.isin(accounts) & Account.disabled == 1) + .select(Account.name, Account.disabled) + ).run(as_dict=True) + + if disabled_accounts: + account_list = " " + account_list += ", ".join([frappe.bold(d.name) for d in disabled_accounts]) + frappe.throw( + _("Cannot create accounting entries against disabled accounts: {0}").format(account_list), + title=_("Disabled Account Selected"), + ) + + def validate_accounting_period(gl_map): - accounting_periods = frappe.db.sql(""" SELECT + accounting_periods = frappe.db.sql( + """ SELECT ap.name as name FROM `tabAccounting Period` ap, `tabClosed Document` cd @@ -40,15 +76,23 @@ def validate_accounting_period(gl_map): AND cd.closed = 1 AND cd.document_type = %(voucher_type)s AND %(date)s between ap.start_date and ap.end_date - """, { - 'date': gl_map[0].posting_date, - 'company': gl_map[0].company, - 'voucher_type': gl_map[0].voucher_type - }, as_dict=1) + """, + { + "date": gl_map[0].posting_date, + "company": gl_map[0].company, + "voucher_type": gl_map[0].voucher_type, + }, + as_dict=1, + ) if accounting_periods: - frappe.throw(_("You cannot create or cancel any accounting entries with in the closed Accounting Period {0}") - .format(frappe.bold(accounting_periods[0].name)), ClosedAccountingPeriod) + frappe.throw( + _( + "You cannot create or cancel any accounting entries with in the closed Accounting Period {0}" + ).format(frappe.bold(accounting_periods[0].name)), + ClosedAccountingPeriod, + ) + def process_gl_map(gl_map, merge_entries=True, precision=None): if merge_entries: @@ -60,8 +104,9 @@ def process_gl_map(gl_map, merge_entries=True, precision=None): entry.debit = 0.0 if flt(entry.debit_in_account_currency) < 0: - entry.credit_in_account_currency = \ - flt(entry.credit_in_account_currency) - flt(entry.debit_in_account_currency) + entry.credit_in_account_currency = flt(entry.credit_in_account_currency) - flt( + entry.debit_in_account_currency + ) entry.debit_in_account_currency = 0.0 if flt(entry.credit) < 0: @@ -69,46 +114,54 @@ def process_gl_map(gl_map, merge_entries=True, precision=None): entry.credit = 0.0 if flt(entry.credit_in_account_currency) < 0: - entry.debit_in_account_currency = \ - flt(entry.debit_in_account_currency) - flt(entry.credit_in_account_currency) + entry.debit_in_account_currency = flt(entry.debit_in_account_currency) - flt( + entry.credit_in_account_currency + ) entry.credit_in_account_currency = 0.0 update_net_values(entry) return gl_map + def update_net_values(entry): # In some scenarios net value needs to be shown in the ledger # This method updates net values as debit or credit if entry.post_net_value and entry.debit and entry.credit: if entry.debit > entry.credit: entry.debit = entry.debit - entry.credit - entry.debit_in_account_currency = entry.debit_in_account_currency \ - - entry.credit_in_account_currency + entry.debit_in_account_currency = ( + entry.debit_in_account_currency - entry.credit_in_account_currency + ) entry.credit = 0 entry.credit_in_account_currency = 0 else: entry.credit = entry.credit - entry.debit - entry.credit_in_account_currency = entry.credit_in_account_currency \ - - entry.debit_in_account_currency + entry.credit_in_account_currency = ( + entry.credit_in_account_currency - entry.debit_in_account_currency + ) entry.debit = 0 entry.debit_in_account_currency = 0 + def merge_similar_entries(gl_map, precision=None): merged_gl_map = [] accounting_dimensions = get_accounting_dimensions() + for entry in gl_map: # if there is already an entry in this account then just add it # to that entry same_head = check_if_in_list(entry, merged_gl_map, accounting_dimensions) if same_head: - same_head.debit = flt(same_head.debit) + flt(entry.debit) - same_head.debit_in_account_currency = \ - flt(same_head.debit_in_account_currency) + flt(entry.debit_in_account_currency) + same_head.debit = flt(same_head.debit) + flt(entry.debit) + same_head.debit_in_account_currency = flt(same_head.debit_in_account_currency) + flt( + entry.debit_in_account_currency + ) same_head.credit = flt(same_head.credit) + flt(entry.credit) - same_head.credit_in_account_currency = \ - flt(same_head.credit_in_account_currency) + flt(entry.credit_in_account_currency) + same_head.credit_in_account_currency = flt(same_head.credit_in_account_currency) + flt( + entry.credit_in_account_currency + ) else: merged_gl_map.append(entry) @@ -119,14 +172,25 @@ def merge_similar_entries(gl_map, precision=None): precision = get_field_precision(frappe.get_meta("GL Entry").get_field("debit"), company_currency) # filter zero debit and credit entries - merged_gl_map = filter(lambda x: flt(x.debit, precision)!=0 or flt(x.credit, precision)!=0, merged_gl_map) + merged_gl_map = filter( + lambda x: flt(x.debit, precision) != 0 or flt(x.credit, precision) != 0, merged_gl_map + ) merged_gl_map = list(merged_gl_map) return merged_gl_map + def check_if_in_list(gle, gl_map, dimensions=None): - account_head_fieldnames = ['voucher_detail_no', 'party', 'against_voucher', - 'cost_center', 'against_voucher_type', 'party_type', 'project', 'finance_book'] + account_head_fieldnames = [ + "voucher_detail_no", + "party", + "against_voucher", + "cost_center", + "against_voucher_type", + "party_type", + "project", + "finance_book", + ] if dimensions: account_head_fieldnames = account_head_fieldnames + dimensions @@ -145,6 +209,7 @@ def check_if_in_list(gle, gl_map, dimensions=None): if same_head: return e + def save_entries(gl_map, adv_adj, update_outstanding, from_repost=False): if not from_repost: validate_cwip_accounts(gl_map) @@ -157,36 +222,53 @@ def save_entries(gl_map, adv_adj, update_outstanding, from_repost=False): for entry in gl_map: make_entry(entry, adv_adj, update_outstanding, from_repost) + def make_entry(args, adv_adj, update_outstanding, from_repost=False): gle = frappe.new_doc("GL Entry") gle.update(args) gle.flags.ignore_permissions = 1 gle.flags.from_repost = from_repost gle.flags.adv_adj = adv_adj - gle.flags.update_outstanding = update_outstanding or 'Yes' + gle.flags.update_outstanding = update_outstanding or "Yes" + gle.flags.notify_update = False gle.submit() - if not from_repost: + if not from_repost and gle.voucher_type != "Period Closing Voucher": validate_expense_against_budget(args) + def validate_cwip_accounts(gl_map): """Validate that CWIP account are not used in Journal Entry""" if gl_map and gl_map[0].voucher_type != "Journal Entry": return - cwip_enabled = any(cint(ac.enable_cwip_accounting) for ac in frappe.db.get_all("Asset Category", "enable_cwip_accounting")) + cwip_enabled = any( + cint(ac.enable_cwip_accounting) + for ac in frappe.db.get_all("Asset Category", "enable_cwip_accounting") + ) if cwip_enabled: - cwip_accounts = [d[0] for d in frappe.db.sql("""select name from tabAccount - where account_type = 'Capital Work in Progress' and is_group=0""")] + cwip_accounts = [ + d[0] + for d in frappe.db.sql( + """select name from tabAccount + where account_type = 'Capital Work in Progress' and is_group=0""" + ) + ] for entry in gl_map: if entry.account in cwip_accounts: frappe.throw( - _("Account: {0} is capital Work in progress and can not be updated by Journal Entry").format(entry.account)) + _( + "Account: {0} is capital Work in progress and can not be updated by Journal Entry" + ).format(entry.account) + ) + def round_off_debit_credit(gl_map): - precision = get_field_precision(frappe.get_meta("GL Entry").get_field("debit"), - currency=frappe.get_cached_value('Company', gl_map[0].company, "default_currency")) + precision = get_field_precision( + frappe.get_meta("GL Entry").get_field("debit"), + currency=frappe.get_cached_value("Company", gl_map[0].company, "default_currency"), + ) debit_credit_diff = 0.0 for entry in gl_map: @@ -199,17 +281,23 @@ def round_off_debit_credit(gl_map): if gl_map[0]["voucher_type"] in ("Journal Entry", "Payment Entry"): allowance = 5.0 / (10**precision) else: - allowance = .5 + allowance = 0.5 if abs(debit_credit_diff) > allowance: - frappe.throw(_("Debit and Credit not equal for {0} #{1}. Difference is {2}.") - .format(gl_map[0].voucher_type, gl_map[0].voucher_no, debit_credit_diff)) + frappe.throw( + _("Debit and Credit not equal for {0} #{1}. Difference is {2}.").format( + gl_map[0].voucher_type, gl_map[0].voucher_no, debit_credit_diff + ) + ) elif abs(debit_credit_diff) >= (1.0 / (10**precision)): make_round_off_gle(gl_map, debit_credit_diff, precision) + def make_round_off_gle(gl_map, debit_credit_diff, precision): - round_off_account, round_off_cost_center = get_round_off_account_and_cost_center(gl_map[0].company) + round_off_account, round_off_cost_center = get_round_off_account_and_cost_center( + gl_map[0].company, gl_map[0].voucher_type, gl_map[0].voucher_no + ) round_off_account_exists = False round_off_gle = frappe._dict() for d in gl_map: @@ -221,35 +309,67 @@ def make_round_off_gle(gl_map, debit_credit_diff, precision): debit_credit_diff += flt(d.credit) round_off_account_exists = True - if round_off_account_exists and abs(debit_credit_diff) <= (1.0 / (10**precision)): + if round_off_account_exists and abs(debit_credit_diff) < (1.0 / (10**precision)): gl_map.remove(round_off_gle) return if not round_off_gle: - for k in ["voucher_type", "voucher_no", "company", - "posting_date", "remarks"]: - round_off_gle[k] = gl_map[0][k] + for k in ["voucher_type", "voucher_no", "company", "posting_date", "remarks"]: + round_off_gle[k] = gl_map[0][k] - round_off_gle.update({ - "account": round_off_account, - "debit_in_account_currency": abs(debit_credit_diff) if debit_credit_diff < 0 else 0, - "credit_in_account_currency": debit_credit_diff if debit_credit_diff > 0 else 0, - "debit": abs(debit_credit_diff) if debit_credit_diff < 0 else 0, - "credit": debit_credit_diff if debit_credit_diff > 0 else 0, - "cost_center": round_off_cost_center, - "party_type": None, - "party": None, - "is_opening": "No", - "against_voucher_type": None, - "against_voucher": None - }) + round_off_gle.update( + { + "account": round_off_account, + "debit_in_account_currency": abs(debit_credit_diff) if debit_credit_diff < 0 else 0, + "credit_in_account_currency": debit_credit_diff if debit_credit_diff > 0 else 0, + "debit": abs(debit_credit_diff) if debit_credit_diff < 0 else 0, + "credit": debit_credit_diff if debit_credit_diff > 0 else 0, + "cost_center": round_off_cost_center, + "party_type": None, + "party": None, + "is_opening": "No", + "against_voucher_type": None, + "against_voucher": None, + } + ) + + update_accounting_dimensions(round_off_gle) if not round_off_account_exists: gl_map.append(round_off_gle) -def get_round_off_account_and_cost_center(company): - round_off_account, round_off_cost_center = frappe.get_cached_value('Company', company, - ["round_off_account", "round_off_cost_center"]) or [None, None] + +def update_accounting_dimensions(round_off_gle): + dimensions = get_accounting_dimensions() + meta = frappe.get_meta(round_off_gle["voucher_type"]) + has_all_dimensions = True + + for dimension in dimensions: + if not meta.has_field(dimension): + has_all_dimensions = False + + if dimensions and has_all_dimensions: + dimension_values = frappe.db.get_value( + round_off_gle["voucher_type"], round_off_gle["voucher_no"], dimensions, as_dict=1 + ) + + for dimension in dimensions: + round_off_gle[dimension] = dimension_values.get(dimension) + + +def get_round_off_account_and_cost_center(company, voucher_type, voucher_no): + round_off_account, round_off_cost_center = frappe.get_cached_value( + "Company", company, ["round_off_account", "round_off_cost_center"] + ) or [None, None] + + meta = frappe.get_meta(voucher_type) + + # Give first preference to parent cost center for round off GLE + if meta.has_field("cost_center"): + parent_cost_center = frappe.db.get_value(voucher_type, voucher_no, "cost_center") + if parent_cost_center: + round_off_cost_center = parent_cost_center + if not round_off_account: frappe.throw(_("Please mention Round Off Account in Company")) @@ -258,68 +378,78 @@ def get_round_off_account_and_cost_center(company): return round_off_account, round_off_cost_center -def make_reverse_gl_entries(gl_entries=None, voucher_type=None, voucher_no=None, - adv_adj=False, update_outstanding="Yes"): + +def make_reverse_gl_entries( + gl_entries=None, voucher_type=None, voucher_no=None, adv_adj=False, update_outstanding="Yes" +): """ - Get original gl entries of the voucher - and make reverse gl entries by swapping debit and credit + Get original gl entries of the voucher + and make reverse gl entries by swapping debit and credit """ if not gl_entries: - gl_entries = frappe.get_all("GL Entry", - fields = ["*"], - filters = { - "voucher_type": voucher_type, - "voucher_no": voucher_no, - "is_cancelled": 0 - }) + gl_entries = frappe.get_all( + "GL Entry", + fields=["*"], + filters={"voucher_type": voucher_type, "voucher_no": voucher_no, "is_cancelled": 0}, + ) if gl_entries: validate_accounting_period(gl_entries) check_freezing_date(gl_entries[0]["posting_date"], adv_adj) - set_as_cancel(gl_entries[0]['voucher_type'], gl_entries[0]['voucher_no']) + set_as_cancel(gl_entries[0]["voucher_type"], gl_entries[0]["voucher_no"]) for entry in gl_entries: - entry['name'] = None - debit = entry.get('debit', 0) - credit = entry.get('credit', 0) + entry["name"] = None + debit = entry.get("debit", 0) + credit = entry.get("credit", 0) - debit_in_account_currency = entry.get('debit_in_account_currency', 0) - credit_in_account_currency = entry.get('credit_in_account_currency', 0) + debit_in_account_currency = entry.get("debit_in_account_currency", 0) + credit_in_account_currency = entry.get("credit_in_account_currency", 0) - entry['debit'] = credit - entry['credit'] = debit - entry['debit_in_account_currency'] = credit_in_account_currency - entry['credit_in_account_currency'] = debit_in_account_currency + entry["debit"] = credit + entry["credit"] = debit + entry["debit_in_account_currency"] = credit_in_account_currency + entry["credit_in_account_currency"] = debit_in_account_currency - entry['remarks'] = "On cancellation of " + entry['voucher_no'] - entry['is_cancelled'] = 1 + entry["remarks"] = "On cancellation of " + entry["voucher_no"] + entry["is_cancelled"] = 1 - if entry['debit'] or entry['credit']: + if entry["debit"] or entry["credit"]: make_entry(entry, adv_adj, "Yes") def check_freezing_date(posting_date, adv_adj=False): """ - Nobody can do GL Entries where posting date is before freezing date - except authorized person + Nobody can do GL Entries where posting date is before freezing date + except authorized person - Administrator has all the roles so this check will be bypassed if any role is allowed to post - Hence stop admin to bypass if accounts are freezed + Administrator has all the roles so this check will be bypassed if any role is allowed to post + Hence stop admin to bypass if accounts are freezed """ if not adv_adj: - acc_frozen_upto = frappe.db.get_value('Accounts Settings', None, 'acc_frozen_upto') + acc_frozen_upto = frappe.db.get_value("Accounts Settings", None, "acc_frozen_upto") if acc_frozen_upto: - frozen_accounts_modifier = frappe.db.get_value( 'Accounts Settings', None,'frozen_accounts_modifier') - if getdate(posting_date) <= getdate(acc_frozen_upto) \ - and (frozen_accounts_modifier not in frappe.get_roles() or frappe.session.user == 'Administrator'): - frappe.throw(_("You are not authorized to add or update entries before {0}").format(formatdate(acc_frozen_upto))) + frozen_accounts_modifier = frappe.db.get_value( + "Accounts Settings", None, "frozen_accounts_modifier" + ) + if getdate(posting_date) <= getdate(acc_frozen_upto) and ( + frozen_accounts_modifier not in frappe.get_roles() or frappe.session.user == "Administrator" + ): + frappe.throw( + _("You are not authorized to add or update entries before {0}").format( + formatdate(acc_frozen_upto) + ) + ) + def set_as_cancel(voucher_type, voucher_no): """ - Set is_cancelled=1 in all original gl entries for the voucher + Set is_cancelled=1 in all original gl entries for the voucher """ - frappe.db.sql("""UPDATE `tabGL Entry` SET is_cancelled = 1, + frappe.db.sql( + """UPDATE `tabGL Entry` SET is_cancelled = 1, modified=%s, modified_by=%s where voucher_type=%s and voucher_no=%s and is_cancelled = 0""", - (now(), frappe.session.user, voucher_type, voucher_no)) + (now(), frappe.session.user, voucher_type, voucher_no), + ) diff --git a/erpnext/accounts/notification/notification_for_new_fiscal_year/notification_for_new_fiscal_year.py b/erpnext/accounts/notification/notification_for_new_fiscal_year/notification_for_new_fiscal_year.py index 19b550feea7..02e3e933330 100644 --- a/erpnext/accounts/notification/notification_for_new_fiscal_year/notification_for_new_fiscal_year.py +++ b/erpnext/accounts/notification/notification_for_new_fiscal_year/notification_for_new_fiscal_year.py @@ -1,5 +1,3 @@ - - def get_context(context): # do your magic here pass diff --git a/erpnext/accounts/party.py b/erpnext/accounts/party.py index a1c34a87ba8..c2ba0b43c6e 100644 --- a/erpnext/accounts/party.py +++ b/erpnext/accounts/party.py @@ -34,125 +34,255 @@ from erpnext.accounts.utils import get_fiscal_year from erpnext.exceptions import InvalidAccountCurrency, PartyDisabled, PartyFrozen -class DuplicatePartyAccountError(frappe.ValidationError): pass +class DuplicatePartyAccountError(frappe.ValidationError): + pass + @frappe.whitelist() -def get_party_details(party=None, account=None, party_type="Customer", company=None, posting_date=None, - bill_date=None, price_list=None, currency=None, doctype=None, ignore_permissions=False, fetch_payment_terms_template=True, - party_address=None, company_address=None, shipping_address=None, pos_profile=None): +def get_party_details( + party=None, + account=None, + party_type="Customer", + company=None, + posting_date=None, + bill_date=None, + price_list=None, + currency=None, + doctype=None, + ignore_permissions=False, + fetch_payment_terms_template=True, + party_address=None, + company_address=None, + shipping_address=None, + pos_profile=None, +): if not party: return {} if not frappe.db.exists(party_type, party): frappe.throw(_("{0}: {1} does not exists").format(party_type, party)) - return _get_party_details(party, account, party_type, - company, posting_date, bill_date, price_list, currency, doctype, ignore_permissions, - fetch_payment_terms_template, party_address, company_address, shipping_address, pos_profile) + return _get_party_details( + party, + account, + party_type, + company, + posting_date, + bill_date, + price_list, + currency, + doctype, + ignore_permissions, + fetch_payment_terms_template, + party_address, + company_address, + shipping_address, + pos_profile, + ) -def _get_party_details(party=None, account=None, party_type="Customer", company=None, posting_date=None, - bill_date=None, price_list=None, currency=None, doctype=None, ignore_permissions=False, - fetch_payment_terms_template=True, party_address=None, company_address=None, shipping_address=None, pos_profile=None): - party_details = frappe._dict(set_account_and_due_date(party, account, party_type, company, posting_date, bill_date, doctype)) + +def _get_party_details( + party=None, + account=None, + party_type="Customer", + company=None, + posting_date=None, + bill_date=None, + price_list=None, + currency=None, + doctype=None, + ignore_permissions=False, + fetch_payment_terms_template=True, + party_address=None, + company_address=None, + shipping_address=None, + pos_profile=None, +): + party_details = frappe._dict( + set_account_and_due_date(party, account, party_type, company, posting_date, bill_date, doctype) + ) party = party_details[party_type.lower()] - if not ignore_permissions and not (frappe.has_permission(party_type, "read", party) or frappe.has_permission(party_type, "select", party)): + if not ignore_permissions and not ( + frappe.has_permission(party_type, "read", party) + or frappe.has_permission(party_type, "select", party) + ): frappe.throw(_("Not permitted for {0}").format(party), frappe.PermissionError) party = frappe.get_doc(party_type, party) - currency = party.default_currency if party.get("default_currency") else get_company_currency(company) + currency = party.get("default_currency") or currency or get_company_currency(company) - party_address, shipping_address = set_address_details(party_details, party, party_type, doctype, company, party_address, company_address, shipping_address) + party_address, shipping_address = set_address_details( + party_details, + party, + party_type, + doctype, + company, + party_address, + company_address, + shipping_address, + ) set_contact_details(party_details, party, party_type) set_other_values(party_details, party, party_type) set_price_list(party_details, party, party_type, price_list, pos_profile) - party_details["tax_category"] = get_address_tax_category(party.get("tax_category"), - party_address, shipping_address if party_type != "Supplier" else party_address) + party_details["tax_category"] = get_address_tax_category( + party.get("tax_category"), + party_address, + shipping_address if party_type != "Supplier" else party_address, + ) - tax_template = set_taxes(party.name, party_type, posting_date, company, - customer_group=party_details.customer_group, supplier_group=party_details.supplier_group, tax_category=party_details.tax_category, - billing_address=party_address, shipping_address=shipping_address) + tax_template = set_taxes( + party.name, + party_type, + posting_date, + company, + customer_group=party_details.customer_group, + supplier_group=party_details.supplier_group, + tax_category=party_details.tax_category, + billing_address=party_address, + shipping_address=shipping_address, + ) if tax_template: - party_details['taxes_and_charges'] = tax_template + party_details["taxes_and_charges"] = tax_template if cint(fetch_payment_terms_template): - party_details["payment_terms_template"] = get_payment_terms_template(party.name, party_type, company) + party_details["payment_terms_template"] = get_payment_terms_template( + party.name, party_type, company + ) if not party_details.get("currency"): party_details["currency"] = currency # sales team - if party_type=="Customer": - party_details["sales_team"] = [{ - "sales_person": d.sales_person, - "allocated_percentage": d.allocated_percentage or None, - "commission_rate": d.commission_rate - } for d in party.get("sales_team")] + if party_type == "Customer": + party_details["sales_team"] = [ + { + "sales_person": d.sales_person, + "allocated_percentage": d.allocated_percentage or None, + "commission_rate": d.commission_rate, + } + for d in party.get("sales_team") + ] # supplier tax withholding category if party_type == "Supplier" and party: - party_details["supplier_tds"] = frappe.get_value(party_type, party.name, "tax_withholding_category") + party_details["supplier_tds"] = frappe.get_value( + party_type, party.name, "tax_withholding_category" + ) return party_details -def set_address_details(party_details, party, party_type, doctype=None, company=None, party_address=None, company_address=None, shipping_address=None): - billing_address_field = "customer_address" if party_type == "Lead" \ - else party_type.lower() + "_address" - party_details[billing_address_field] = party_address or get_default_address(party_type, party.name) + +def set_address_details( + party_details, + party, + party_type, + doctype=None, + company=None, + party_address=None, + company_address=None, + shipping_address=None, +): + billing_address_field = ( + "customer_address" if party_type == "Lead" else party_type.lower() + "_address" + ) + party_details[billing_address_field] = party_address or get_default_address( + party_type, party.name + ) if doctype: - party_details.update(get_fetch_values(doctype, billing_address_field, party_details[billing_address_field])) + party_details.update( + get_fetch_values(doctype, billing_address_field, party_details[billing_address_field]) + ) # address display party_details.address_display = get_address_display(party_details[billing_address_field]) # shipping address if party_type in ["Customer", "Lead"]: - party_details.shipping_address_name = shipping_address or get_party_shipping_address(party_type, party.name) + party_details.shipping_address_name = shipping_address or get_party_shipping_address( + party_type, party.name + ) party_details.shipping_address = get_address_display(party_details["shipping_address_name"]) if doctype: - party_details.update(get_fetch_values(doctype, 'shipping_address_name', party_details.shipping_address_name)) + party_details.update( + get_fetch_values(doctype, "shipping_address_name", party_details.shipping_address_name) + ) if company_address: - party_details.update({'company_address': company_address}) + party_details.company_address = company_address else: party_details.update(get_company_address(company)) - if doctype and doctype in ['Delivery Note', 'Sales Invoice', 'Sales Order']: + if doctype and doctype in ["Delivery Note", "Sales Invoice", "Sales Order", "Quotation"]: if party_details.company_address: - party_details.update(get_fetch_values(doctype, 'company_address', party_details.company_address)) + party_details.update( + get_fetch_values(doctype, "company_address", party_details.company_address) + ) get_regional_address_details(party_details, doctype, company) elif doctype and doctype in ["Purchase Invoice", "Purchase Order", "Purchase Receipt"]: + if shipping_address: + party_details.update( + { + "shipping_address": shipping_address, + "shipping_address_display": get_address_display(shipping_address), + **get_fetch_values(doctype, "shipping_address", shipping_address), + } + ) + if party_details.company_address: - party_details["shipping_address"] = shipping_address or party_details["company_address"] - party_details.shipping_address_display = get_address_display(party_details["shipping_address"]) - party_details.update(get_fetch_values(doctype, 'shipping_address', party_details.shipping_address)) + # billing address + party_details.update( + { + "billing_address": party_details.company_address, + "billing_address_display": ( + party_details.company_address_display or get_address_display(party_details.company_address) + ), + **get_fetch_values(doctype, "billing_address", party_details.company_address), + } + ) + + # shipping address - if not already set + if not party_details.shipping_address: + party_details.update( + { + "shipping_address": party_details.billing_address, + "shipping_address_display": party_details.billing_address_display, + **get_fetch_values(doctype, "shipping_address", party_details.billing_address), + } + ) + get_regional_address_details(party_details, doctype, company) return party_details.get(billing_address_field), party_details.shipping_address_name + @erpnext.allow_regional def get_regional_address_details(party_details, doctype, company): pass + def set_contact_details(party_details, party, party_type): party_details.contact_person = get_default_contact(party_type, party.name) if not party_details.contact_person: - party_details.update({ - "contact_person": None, - "contact_display": None, - "contact_email": None, - "contact_mobile": None, - "contact_phone": None, - "contact_designation": None, - "contact_department": None - }) + party_details.update( + { + "contact_person": None, + "contact_display": None, + "contact_email": None, + "contact_mobile": None, + "contact_phone": None, + "contact_designation": None, + "contact_department": None, + } + ) else: party_details.update(get_contact_details(party_details.contact_person)) + def set_other_values(party_details, party, party_type): # copy - if party_type=="Customer": + if party_type == "Customer": to_copy = ["customer_name", "customer_group", "territory", "language"] else: to_copy = ["supplier_name", "supplier_group", "language"] @@ -160,112 +290,121 @@ def set_other_values(party_details, party, party_type): party_details[f] = party.get(f) # fields prepended with default in Customer doctype - for f in ['currency'] \ - + (['sales_partner', 'commission_rate'] if party_type=="Customer" else []): + for f in ["currency"] + ( + ["sales_partner", "commission_rate"] if party_type == "Customer" else [] + ): if party.get("default_" + f): party_details[f] = party.get("default_" + f) + def get_default_price_list(party): """Return default price list for party (Document object)""" if party.get("default_price_list"): return party.default_price_list if party.doctype == "Customer": - price_list = frappe.get_cached_value("Customer Group", - party.customer_group, "default_price_list") - if price_list: - return price_list + return frappe.db.get_value("Customer Group", party.customer_group, "default_price_list") - return None def set_price_list(party_details, party, party_type, given_price_list, pos=None): # price list - price_list = get_permitted_documents('Price List') + price_list = get_permitted_documents("Price List") # if there is only one permitted document based on user permissions, set it if price_list and len(price_list) == 1: price_list = price_list[0] - elif pos and party_type == 'Customer': - customer_price_list = frappe.get_value('Customer', party.name, 'default_price_list') + elif pos and party_type == "Customer": + customer_price_list = frappe.get_value("Customer", party.name, "default_price_list") if customer_price_list: price_list = customer_price_list else: - pos_price_list = frappe.get_value('POS Profile', pos, 'selling_price_list') + pos_price_list = frappe.get_value("POS Profile", pos, "selling_price_list") price_list = pos_price_list or given_price_list else: price_list = get_default_price_list(party) or given_price_list if price_list: - party_details.price_list_currency = frappe.db.get_value("Price List", price_list, "currency", cache=True) + party_details.price_list_currency = frappe.db.get_value( + "Price List", price_list, "currency", cache=True + ) - party_details["selling_price_list" if party.doctype=="Customer" else "buying_price_list"] = price_list + party_details[ + "selling_price_list" if party.doctype == "Customer" else "buying_price_list" + ] = price_list -def set_account_and_due_date(party, account, party_type, company, posting_date, bill_date, doctype): +def set_account_and_due_date( + party, account, party_type, company, posting_date, bill_date, doctype +): if doctype not in ["POS Invoice", "Sales Invoice", "Purchase Invoice"]: # not an invoice - return { - party_type.lower(): party - } + return {party_type.lower(): party} if party: account = get_party_account(party_type, party, company) - account_fieldname = "debit_to" if party_type=="Customer" else "credit_to" + account_fieldname = "debit_to" if party_type == "Customer" else "credit_to" out = { party_type.lower(): party, - account_fieldname : account, - "due_date": get_due_date(posting_date, party_type, party, company, bill_date) + account_fieldname: account, + "due_date": get_due_date(posting_date, party_type, party, company, bill_date), } return out + @frappe.whitelist() def get_party_account(party_type, party=None, company=None): """Returns the account for the given `party`. - Will first search in party (Customer / Supplier) record, if not found, - will search in group (Customer Group / Supplier Group), - finally will return default.""" + Will first search in party (Customer / Supplier) record, if not found, + will search in group (Customer Group / Supplier Group), + finally will return default.""" if not company: frappe.throw(_("Please select a Company")) - if not party and party_type in ['Customer', 'Supplier']: - default_account_name = "default_receivable_account" \ - if party_type=="Customer" else "default_payable_account" + if not party and party_type in ["Customer", "Supplier"]: + default_account_name = ( + "default_receivable_account" if party_type == "Customer" else "default_payable_account" + ) - return frappe.get_cached_value('Company', company, default_account_name) + return frappe.get_cached_value("Company", company, default_account_name) - account = frappe.db.get_value("Party Account", - {"parenttype": party_type, "parent": party, "company": company}, "account") + account = frappe.db.get_value( + "Party Account", {"parenttype": party_type, "parent": party, "company": company}, "account" + ) - if not account and party_type in ['Customer', 'Supplier']: - party_group_doctype = "Customer Group" if party_type=="Customer" else "Supplier Group" + if not account and party_type in ["Customer", "Supplier"]: + party_group_doctype = "Customer Group" if party_type == "Customer" else "Supplier Group" group = frappe.get_cached_value(party_type, party, scrub(party_group_doctype)) - account = frappe.db.get_value("Party Account", - {"parenttype": party_group_doctype, "parent": group, "company": company}, "account") + account = frappe.db.get_value( + "Party Account", + {"parenttype": party_group_doctype, "parent": group, "company": company}, + "account", + ) - if not account and party_type in ['Customer', 'Supplier']: - default_account_name = "default_receivable_account" \ - if party_type=="Customer" else "default_payable_account" - account = frappe.get_cached_value('Company', company, default_account_name) + if not account and party_type in ["Customer", "Supplier"]: + default_account_name = ( + "default_receivable_account" if party_type == "Customer" else "default_payable_account" + ) + account = frappe.get_cached_value("Company", company, default_account_name) existing_gle_currency = get_party_gle_currency(party_type, party, company) if existing_gle_currency: if account: account_currency = frappe.db.get_value("Account", account, "account_currency", cache=True) if (account and account_currency != existing_gle_currency) or not account: - account = get_party_gle_account(party_type, party, company) + account = get_party_gle_account(party_type, party, company) return account + @frappe.whitelist() def get_party_bank_account(party_type, party): - return frappe.db.get_value('Bank Account', { - 'party_type': party_type, - 'party': party, - 'is_default': 1 - }) + return frappe.db.get_value( + "Bank Account", {"party_type": party_type, "party": party, "is_default": 1} + ) + def get_party_account_currency(party_type, party, company): def generator(): @@ -274,27 +413,38 @@ def get_party_account_currency(party_type, party, company): return frappe.local_cache("party_account_currency", (party_type, party, company), generator) + def get_party_gle_currency(party_type, party, company): def generator(): - existing_gle_currency = frappe.db.sql("""select account_currency from `tabGL Entry` + existing_gle_currency = frappe.db.sql( + """select account_currency from `tabGL Entry` where docstatus=1 and company=%(company)s and party_type=%(party_type)s and party=%(party)s - limit 1""", { "company": company, "party_type": party_type, "party": party }) + limit 1""", + {"company": company, "party_type": party_type, "party": party}, + ) return existing_gle_currency[0][0] if existing_gle_currency else None - return frappe.local_cache("party_gle_currency", (party_type, party, company), generator, - regenerate_if_none=True) + return frappe.local_cache( + "party_gle_currency", (party_type, party, company), generator, regenerate_if_none=True + ) + def get_party_gle_account(party_type, party, company): def generator(): - existing_gle_account = frappe.db.sql("""select account from `tabGL Entry` + existing_gle_account = frappe.db.sql( + """select account from `tabGL Entry` where docstatus=1 and company=%(company)s and party_type=%(party_type)s and party=%(party)s - limit 1""", { "company": company, "party_type": party_type, "party": party }) + limit 1""", + {"company": company, "party_type": party_type, "party": party}, + ) return existing_gle_account[0][0] if existing_gle_account else None - return frappe.local_cache("party_gle_account", (party_type, party, company), generator, - regenerate_if_none=True) + return frappe.local_cache( + "party_gle_account", (party_type, party, company), generator, regenerate_if_none=True + ) + def validate_party_gle_currency(party_type, party, company, party_account_currency=None): """Validate party account currency with existing GL Entry's currency""" @@ -304,32 +454,58 @@ def validate_party_gle_currency(party_type, party, company, party_account_curren existing_gle_currency = get_party_gle_currency(party_type, party, company) if existing_gle_currency and party_account_currency != existing_gle_currency: - frappe.throw(_("{0} {1} has accounting entries in currency {2} for company {3}. Please select a receivable or payable account with currency {2}.") - .format(frappe.bold(party_type), frappe.bold(party), frappe.bold(existing_gle_currency), frappe.bold(company)), InvalidAccountCurrency) + frappe.throw( + _( + "{0} {1} has accounting entries in currency {2} for company {3}. Please select a receivable or payable account with currency {2}." + ).format( + frappe.bold(party_type), + frappe.bold(party), + frappe.bold(existing_gle_currency), + frappe.bold(company), + ), + InvalidAccountCurrency, + ) + def validate_party_accounts(doc): + from erpnext.controllers.accounts_controller import validate_account_head companies = [] for account in doc.get("accounts"): if account.company in companies: - frappe.throw(_("There can only be 1 Account per Company in {0} {1}") - .format(doc.doctype, doc.name), DuplicatePartyAccountError) + frappe.throw( + _("There can only be 1 Account per Company in {0} {1}").format(doc.doctype, doc.name), + DuplicatePartyAccountError, + ) else: companies.append(account.company) - party_account_currency = frappe.db.get_value("Account", account.account, "account_currency", cache=True) + party_account_currency = frappe.db.get_value( + "Account", account.account, "account_currency", cache=True + ) if frappe.db.get_default("Company"): - company_default_currency = frappe.get_cached_value('Company', - frappe.db.get_default("Company"), "default_currency") + company_default_currency = frappe.get_cached_value( + "Company", frappe.db.get_default("Company"), "default_currency" + ) else: - company_default_currency = frappe.db.get_value('Company', account.company, "default_currency") + company_default_currency = frappe.db.get_value("Company", account.company, "default_currency") validate_party_gle_currency(doc.doctype, doc.name, account.company, party_account_currency) if doc.get("default_currency") and party_account_currency and company_default_currency: - if doc.default_currency != party_account_currency and doc.default_currency != company_default_currency: - frappe.throw(_("Billing currency must be equal to either default company's currency or party account currency")) + if ( + doc.default_currency != party_account_currency + and doc.default_currency != company_default_currency + ): + frappe.throw( + _( + "Billing currency must be equal to either default company's currency or party account currency" + ) + ) + + # validate if account is mapped for same company + validate_account_head(account.idx, account.account, account.company) @frappe.whitelist() @@ -341,18 +517,23 @@ def get_due_date(posting_date, party_type, party, company=None, bill_date=None): template_name = get_payment_terms_template(party, party_type, company) if template_name: - due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime("%Y-%m-%d") + due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime( + "%Y-%m-%d" + ) else: if party_type == "Supplier": supplier_group = frappe.get_cached_value(party_type, party, "supplier_group") template_name = frappe.get_cached_value("Supplier Group", supplier_group, "payment_terms") if template_name: - due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime("%Y-%m-%d") + due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime( + "%Y-%m-%d" + ) # If due date is calculated from bill_date, check this condition if getdate(due_date) < getdate(posting_date): due_date = posting_date return due_date + def get_due_date_from_template(template_name, posting_date, bill_date): """ Inspects all `Payment Term`s from the a `Payment Terms Template` and returns the due @@ -362,40 +543,55 @@ def get_due_date_from_template(template_name, posting_date, bill_date): """ due_date = getdate(bill_date or posting_date) - template = frappe.get_doc('Payment Terms Template', template_name) + template = frappe.get_doc("Payment Terms Template", template_name) for term in template.terms: - if term.due_date_based_on == 'Day(s) after invoice date': + if term.due_date_based_on == "Day(s) after invoice date": due_date = max(due_date, add_days(due_date, term.credit_days)) - elif term.due_date_based_on == 'Day(s) after the end of the invoice month': + elif term.due_date_based_on == "Day(s) after the end of the invoice month": due_date = max(due_date, add_days(get_last_day(due_date), term.credit_days)) else: due_date = max(due_date, add_months(get_last_day(due_date), term.credit_months)) return due_date -def validate_due_date(posting_date, due_date, party_type, party, company=None, bill_date=None, template_name=None): + +def validate_due_date( + posting_date, due_date, party_type, party, company=None, bill_date=None, template_name=None +): if getdate(due_date) < getdate(posting_date): frappe.throw(_("Due Date cannot be before Posting / Supplier Invoice Date")) else: - if not template_name: return + if not template_name: + return - default_due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime("%Y-%m-%d") + default_due_date = get_due_date_from_template(template_name, posting_date, bill_date).strftime( + "%Y-%m-%d" + ) if not default_due_date: return if default_due_date != posting_date and getdate(due_date) > getdate(default_due_date): - is_credit_controller = frappe.db.get_single_value("Accounts Settings", "credit_controller") in frappe.get_roles() + is_credit_controller = ( + frappe.db.get_single_value("Accounts Settings", "credit_controller") in frappe.get_roles() + ) if is_credit_controller: - msgprint(_("Note: Due / Reference Date exceeds allowed customer credit days by {0} day(s)") - .format(date_diff(due_date, default_due_date))) + msgprint( + _("Note: Due / Reference Date exceeds allowed customer credit days by {0} day(s)").format( + date_diff(due_date, default_due_date) + ) + ) else: - frappe.throw(_("Due / Reference Date cannot be after {0}") - .format(formatdate(default_due_date))) + frappe.throw( + _("Due / Reference Date cannot be after {0}").format(formatdate(default_due_date)) + ) + @frappe.whitelist() def get_address_tax_category(tax_category=None, billing_address=None, shipping_address=None): - addr_tax_category_from = frappe.db.get_single_value("Accounts Settings", "determine_address_tax_category_from") + addr_tax_category_from = frappe.db.get_single_value( + "Accounts Settings", "determine_address_tax_category_from" + ) if addr_tax_category_from == "Shipping Address": if shipping_address: tax_category = frappe.db.get_value("Address", shipping_address, "tax_category") or tax_category @@ -405,36 +601,48 @@ def get_address_tax_category(tax_category=None, billing_address=None, shipping_a return cstr(tax_category) + @frappe.whitelist() -def set_taxes(party, party_type, posting_date, company, customer_group=None, supplier_group=None, tax_category=None, - billing_address=None, shipping_address=None, use_for_shopping_cart=None): +def set_taxes( + party, + party_type, + posting_date, + company, + customer_group=None, + supplier_group=None, + tax_category=None, + billing_address=None, + shipping_address=None, + use_for_shopping_cart=None, +): from erpnext.accounts.doctype.tax_rule.tax_rule import get_party_details, get_tax_template - args = { - party_type.lower(): party, - "company": company - } + + args = {party_type.lower(): party, "company": company} if tax_category: - args['tax_category'] = tax_category + args["tax_category"] = tax_category if customer_group: - args['customer_group'] = customer_group + args["customer_group"] = customer_group if supplier_group: - args['supplier_group'] = supplier_group + args["supplier_group"] = supplier_group if billing_address or shipping_address: - args.update(get_party_details(party, party_type, {"billing_address": billing_address, \ - "shipping_address": shipping_address })) + args.update( + get_party_details( + party, party_type, {"billing_address": billing_address, "shipping_address": shipping_address} + ) + ) else: args.update(get_party_details(party, party_type)) if party_type in ("Customer", "Lead"): args.update({"tax_type": "Sales"}) - if party_type=='Lead': - args['customer'] = None - del args['lead'] + if party_type == "Lead": + args["customer"] = None + del args["lead"] else: args.update({"tax_type": "Purchase"}) @@ -449,25 +657,27 @@ def get_payment_terms_template(party_name, party_type, company=None): if party_type not in ("Customer", "Supplier"): return template = None - if party_type == 'Customer': - customer = frappe.get_cached_value("Customer", party_name, - fieldname=['payment_terms', "customer_group"], as_dict=1) + if party_type == "Customer": + customer = frappe.get_cached_value( + "Customer", party_name, fieldname=["payment_terms", "customer_group"], as_dict=1 + ) template = customer.payment_terms if not template and customer.customer_group: - template = frappe.get_cached_value("Customer Group", - customer.customer_group, 'payment_terms') + template = frappe.get_cached_value("Customer Group", customer.customer_group, "payment_terms") else: - supplier = frappe.get_cached_value("Supplier", party_name, - fieldname=['payment_terms', "supplier_group"], as_dict=1) + supplier = frappe.get_cached_value( + "Supplier", party_name, fieldname=["payment_terms", "supplier_group"], as_dict=1 + ) template = supplier.payment_terms if not template and supplier.supplier_group: - template = frappe.get_cached_value("Supplier Group", supplier.supplier_group, 'payment_terms') + template = frappe.get_cached_value("Supplier Group", supplier.supplier_group, "payment_terms") if not template and company: - template = frappe.get_cached_value('Company', company, fieldname='payment_terms') + template = frappe.get_cached_value("Company", company, fieldname="payment_terms") return template + def validate_party_frozen_disabled(party_type, party_name): if frappe.flags.ignore_party_validation: @@ -479,7 +689,9 @@ def validate_party_frozen_disabled(party_type, party_name): if party.disabled: frappe.throw(_("{0} {1} is disabled").format(party_type, party_name), PartyDisabled) elif party.get("is_frozen"): - frozen_accounts_modifier = frappe.db.get_single_value( 'Accounts Settings', 'frozen_accounts_modifier') + frozen_accounts_modifier = frappe.db.get_single_value( + "Accounts Settings", "frozen_accounts_modifier" + ) if not frozen_accounts_modifier in frappe.get_roles(): frappe.throw(_("{0} {1} is frozen").format(party_type, party_name), PartyFrozen) @@ -487,99 +699,124 @@ def validate_party_frozen_disabled(party_type, party_name): if frappe.db.get_value("Employee", party_name, "status") != "Active": frappe.msgprint(_("{0} {1} is not active").format(party_type, party_name), alert=True) + def get_timeline_data(doctype, name): - '''returns timeline data for the past one year''' + """returns timeline data for the past one year""" from frappe.desk.form.load import get_communication_data out = {} - fields = 'creation, count(*)' - after = add_years(None, -1).strftime('%Y-%m-%d') - group_by='group by Date(creation)' + fields = "creation, count(*)" + after = add_years(None, -1).strftime("%Y-%m-%d") + group_by = "group by Date(creation)" - data = get_communication_data(doctype, name, after=after, group_by='group by creation', - fields='C.creation as creation, count(C.name)',as_dict=False) + data = get_communication_data( + doctype, + name, + after=after, + group_by="group by creation", + fields="C.creation as creation, count(C.name)", + as_dict=False, + ) # fetch and append data from Activity Log - data += frappe.db.sql("""select {fields} + data += frappe.db.sql( + """select {fields} from `tabActivity Log` where (reference_doctype=%(doctype)s and reference_name=%(name)s) or (timeline_doctype in (%(doctype)s) and timeline_name=%(name)s) or (reference_doctype in ("Quotation", "Opportunity") and timeline_name=%(name)s) and status!='Success' and creation > {after} {group_by} order by creation desc - """.format(fields=fields, group_by=group_by, after=after), { - "doctype": doctype, - "name": name - }, as_dict=False) + """.format( + fields=fields, group_by=group_by, after=after + ), + {"doctype": doctype, "name": name}, + as_dict=False, + ) timeline_items = dict(data) for date, count in iteritems(timeline_items): timestamp = get_timestamp(date) - out.update({ timestamp: count }) + out.update({timestamp: count}) return out + def get_dashboard_info(party_type, party, loyalty_program=None): current_fiscal_year = get_fiscal_year(nowdate(), as_dict=True) - doctype = "Sales Invoice" if party_type=="Customer" else "Purchase Invoice" + doctype = "Sales Invoice" if party_type == "Customer" else "Purchase Invoice" - companies = frappe.get_all(doctype, filters={ - 'docstatus': 1, - party_type.lower(): party - }, distinct=1, fields=['company']) + companies = frappe.get_all( + doctype, filters={"docstatus": 1, party_type.lower(): party}, distinct=1, fields=["company"] + ) company_wise_info = [] - company_wise_grand_total = frappe.get_all(doctype, + company_wise_grand_total = frappe.get_all( + doctype, filters={ - 'docstatus': 1, + "docstatus": 1, party_type.lower(): party, - 'posting_date': ('between', [current_fiscal_year.year_start_date, current_fiscal_year.year_end_date]) - }, - group_by="company", - fields=["company", "sum(grand_total) as grand_total", "sum(base_grand_total) as base_grand_total"] - ) + "posting_date": ( + "between", + [current_fiscal_year.year_start_date, current_fiscal_year.year_end_date], + ), + }, + group_by="company", + fields=[ + "company", + "sum(grand_total) as grand_total", + "sum(base_grand_total) as base_grand_total", + ], + ) loyalty_point_details = [] if party_type == "Customer": - loyalty_point_details = frappe._dict(frappe.get_all("Loyalty Point Entry", - filters={ - 'customer': party, - 'expiry_date': ('>=', getdate()), + loyalty_point_details = frappe._dict( + frappe.get_all( + "Loyalty Point Entry", + filters={ + "customer": party, + "expiry_date": (">=", getdate()), }, group_by="company", fields=["company", "sum(loyalty_points) as loyalty_points"], - as_list =1 - )) + as_list=1, + ) + ) company_wise_billing_this_year = frappe._dict() for d in company_wise_grand_total: company_wise_billing_this_year.setdefault( - d.company,{ - "grand_total": d.grand_total, - "base_grand_total": d.base_grand_total - }) + d.company, {"grand_total": d.grand_total, "base_grand_total": d.base_grand_total} + ) - - company_wise_total_unpaid = frappe._dict(frappe.db.sql(""" + company_wise_total_unpaid = frappe._dict( + frappe.db.sql( + """ select company, sum(debit_in_account_currency) - sum(credit_in_account_currency) from `tabGL Entry` where party_type = %s and party=%s and is_cancelled = 0 - group by company""", (party_type, party))) + group by company""", + (party_type, party), + ) + ) for d in companies: - company_default_currency = frappe.db.get_value("Company", d.company, 'default_currency') + company_default_currency = frappe.db.get_value("Company", d.company, "default_currency") party_account_currency = get_party_account_currency(party_type, party, d.company) - if party_account_currency==company_default_currency: - billing_this_year = flt(company_wise_billing_this_year.get(d.company,{}).get("base_grand_total")) + if party_account_currency == company_default_currency: + billing_this_year = flt( + company_wise_billing_this_year.get(d.company, {}).get("base_grand_total") + ) else: - billing_this_year = flt(company_wise_billing_this_year.get(d.company,{}).get("grand_total")) + billing_this_year = flt(company_wise_billing_this_year.get(d.company, {}).get("grand_total")) total_unpaid = flt(company_wise_total_unpaid.get(d.company)) @@ -602,6 +839,7 @@ def get_dashboard_info(party_type, party, loyalty_program=None): return company_wise_info + def get_party_shipping_address(doctype, name): """ Returns an Address name (best guess) for the given doctype and name for which `address_type == 'Shipping'` is true. @@ -614,50 +852,59 @@ def get_party_shipping_address(doctype, name): :return: String """ out = frappe.db.sql( - 'SELECT dl.parent ' - 'from `tabDynamic Link` dl join `tabAddress` ta on dl.parent=ta.name ' - 'where ' - 'dl.link_doctype=%s ' - 'and dl.link_name=%s ' + "SELECT dl.parent " + "from `tabDynamic Link` dl join `tabAddress` ta on dl.parent=ta.name " + "where " + "dl.link_doctype=%s " + "and dl.link_name=%s " 'and dl.parenttype="Address" ' - 'and ifnull(ta.disabled, 0) = 0 and' + "and ifnull(ta.disabled, 0) = 0 and" '(ta.address_type="Shipping" or ta.is_shipping_address=1) ' - 'order by ta.is_shipping_address desc, ta.address_type desc limit 1', - (doctype, name) + "order by ta.is_shipping_address desc, ta.address_type desc limit 1", + (doctype, name), ) if out: return out[0][0] else: - return '' + return "" -def get_partywise_advanced_payment_amount(party_type, posting_date = None, future_payment=0, company=None): + +def get_partywise_advanced_payment_amount( + party_type, posting_date=None, future_payment=0, company=None +): cond = "1=1" if posting_date: if future_payment: - cond = "posting_date <= '{0}' OR DATE(creation) <= '{0}' """.format(posting_date) + cond = "posting_date <= '{0}' OR DATE(creation) <= '{0}' " "".format(posting_date) else: cond = "posting_date <= '{0}'".format(posting_date) if company: cond += "and company = {0}".format(frappe.db.escape(company)) - data = frappe.db.sql(""" SELECT party, sum({0}) as amount + data = frappe.db.sql( + """ SELECT party, sum({0}) as amount FROM `tabGL Entry` WHERE party_type = %s and against_voucher is null and is_cancelled = 0 - and {1} GROUP BY party""" - .format(("credit") if party_type == "Customer" else "debit", cond) , party_type) + and {1} GROUP BY party""".format( + ("credit") if party_type == "Customer" else "debit", cond + ), + party_type, + ) if data: return frappe._dict(data) + def get_default_contact(doctype, name): """ - Returns default contact for the given doctype and name. - Can be ordered by `contact_type` to either is_primary_contact or is_billing_contact. + Returns default contact for the given doctype and name. + Can be ordered by `contact_type` to either is_primary_contact or is_billing_contact. """ - out = frappe.db.sql(""" + out = frappe.db.sql( + """ SELECT dl.parent, c.is_primary_contact, c.is_billing_contact FROM `tabDynamic Link` dl INNER JOIN tabContact c ON c.name = dl.parent @@ -666,7 +913,9 @@ def get_default_contact(doctype, name): dl.link_name=%s AND dl.parenttype = "Contact" ORDER BY is_primary_contact DESC, is_billing_contact DESC - """, (doctype, name)) + """, + (doctype, name), + ) if out: try: return out[0][0] @@ -674,3 +923,18 @@ def get_default_contact(doctype, name): return None else: return None + + +def add_party_account(party_type, party, company, account): + doc = frappe.get_doc(party_type, party) + account_exists = False + for d in doc.get("accounts"): + if d.account == account: + account_exists = True + + if not account_exists: + accounts = {"company": company, "account": account} + + doc.append("accounts", accounts) + + doc.save() diff --git a/erpnext/accounts/print_format/gst_e_invoice/gst_e_invoice.html b/erpnext/accounts/print_format/gst_e_invoice/gst_e_invoice.html index e6580493095..605ce8383e4 100644 --- a/erpnext/accounts/print_format/gst_e_invoice/gst_e_invoice.html +++ b/erpnext/accounts/print_format/gst_e_invoice/gst_e_invoice.html @@ -1,7 +1,8 @@ {%- from "templates/print_formats/standard_macros.html" import add_header, render_field, print_value -%} -{%- set einvoice = json.loads(doc.signed_einvoice) -%}
+ {% if doc.signed_einvoice %}
+ {%- set einvoice = json.loads(doc.signed_einvoice) -%}
{% if letter_head and not no_letterhead %}
{{ letter_head }}
@@ -170,4 +171,10 @@
|
|---|
+ You must generate IRN before you can preview GST E-Invoice.
+
+ {% endif %}
+
diff --git a/erpnext/accounts/print_format/gst_pos_invoice/gst_pos_invoice.json b/erpnext/accounts/print_format/gst_pos_invoice/gst_pos_invoice.json
deleted file mode 100644
index 1aa1c02968f..00000000000
--- a/erpnext/accounts/print_format/gst_pos_invoice/gst_pos_invoice.json
+++ /dev/null
@@ -1,23 +0,0 @@
-{
- "align_labels_right": 0,
- "creation": "2017-08-08 12:33:04.773099",
- "custom_format": 1,
- "disabled": 0,
- "doc_type": "Sales Invoice",
- "docstatus": 0,
- "doctype": "Print Format",
- "font": "Default",
- "html": "\n\n{% if letter_head %}\n {{ letter_head }}\n{% endif %}\n\n\t{{ doc.company }}
\n\t{% if doc.company_address_display %}\n\t\t{% set company_address = doc.company_address_display.replace(\"\\n\", \" \").replace(\"
\", \" \") %}\n\t\t{% if \"GSTIN\" not in company_address %}\n\t\t\t{{ company_address }}\n\t\t\t{{ _(\"GSTIN\") }}:{{ doc.company_gstin }}\n\t\t{% else %}\n\t\t\t{{ company_address.replace(\"GSTIN\", \"
GSTIN\") }}\n\t\t{% endif %}\n\t{% endif %}\n\t
\n\t{% if doc.docstatus == 0 %}\n\t\t{{ doc.status + \" \"+ (doc.select_print_heading or _(\"Invoice\")) }}
\n\t{% else %}\n\t\t{{ doc.select_print_heading or _(\"Invoice\") }}
\n\t{% endif %}\n
\n\t{{ _(\"Receipt No\") }}: {{ doc.name }}
\n\t{{ _(\"Date\") }}: {{ doc.get_formatted(\"posting_date\") }}
\n\t{% if doc.grand_total > 50000 %}\n\t\t{% set customer_address = doc.address_display.replace(\"\\n\", \" \").replace(\"
\", \" \") %}\n\t\t{{ _(\"Customer\") }}:
\n\t\t{{ doc.customer_name }}
\n\t\t{{ customer_address }}\n\t{% endif %}\n
\n
| {{ _(\"Item\") }} | \n\t\t\t{{ _(\"Qty\") }} | \n\t\t\t{{ _(\"Amount\") }} | \n\t\t
|---|---|---|
| \n\t\t\t\t{{ item.item_code }}\n\t\t\t\t{%- if item.item_name != item.item_code -%}\n\t\t\t\t\t {{ item.item_name }}\n\t\t\t\t{%- endif -%}\n\t\t\t\t{%- if item.gst_hsn_code -%}\n\t\t\t\t\t {{ _(\"HSN/SAC\") }}: {{ item.gst_hsn_code }}\n\t\t\t\t{%- endif -%}\n\t\t\t\t{%- if item.serial_no -%}\n\t\t\t\t\t {{ _(\"Serial No\") }}: {{ item.serial_no }}\n\t\t\t\t{%- endif -%}\n\t\t\t | \n\t\t\t{{ item.qty }} @ {{ item.rate }} | \n\t\t\t{{ item.get_formatted(\"amount\") }} | \n\t\t
| \n\t\t\t\t\t{{ _(\"Total Excl. Tax\") }}\n\t\t\t\t | \n\t\t\t\t\n\t\t\t\t\t{{ doc.get_formatted(\"net_total\", doc) }}\n\t\t\t\t | \n\t\t\t{% else %}\n\t\t\t\t\n\t\t\t\t\t{{ _(\"Total\") }}\n\t\t\t\t | \n\t\t\t\t\n\t\t\t\t\t{{ doc.get_formatted(\"total\", doc) }}\n\t\t\t\t | \n\t\t\t{% endif %}\n\t\t
| \n\t\t\t\t\t{{ row.description }}\n\t\t\t\t | \n\t\t\t\t\n\t\t\t\t\t{{ row.get_formatted(\"tax_amount\", doc) }}\n\t\t\t\t | \n\t\t\t||
| \n\t\t\t\t{{ _(\"Discount\") }}\n\t\t\t | \n\t\t\t\n\t\t\t\t{{ doc.get_formatted(\"discount_amount\") }}\n\t\t\t | \n\t\t||
| \n\t\t\t\t{{ _(\"Grand Total\") }}\n\t\t\t | \n\t\t\t\n\t\t\t\t{{ doc.get_formatted(\"grand_total\") }}\n\t\t\t | \n\t\t||
| \n\t\t\t\t{{ _(\"Rounded Total\") }}\n\t\t\t | \n\t\t\t\n\t\t\t\t{{ doc.get_formatted(\"rounded_total\") }}\n\t\t\t | \n\t\t||
| \n\t\t\t\t{{ _(\"Paid Amount\") }}\n\t\t\t | \n\t\t\t\n\t\t\t\t{{ doc.get_formatted(\"paid_amount\") }}\n\t\t\t | \n\t\t||
| \n\t\t\t\t{{ _(\"Change Amount\") }}\n\t\t\t | \n\t\t\t\n\t\t\t\t{{ doc.get_formatted(\"change_amount\") }}\n\t\t\t | \n\t\t
{{ doc.terms or \"\" }}
\n{{ _(\"Thank you, please visit again.\") }}
", - "idx": 0, - "line_breaks": 0, - "modified": "2020-04-29 16:39:12.936215", - "modified_by": "Administrator", - "module": "Accounts", - "name": "GST POS Invoice", - "owner": "Administrator", - "print_format_builder": 0, - "print_format_type": "Jinja", - "raw_printing": 0, - "show_section_headings": 0, - "standard": "Yes" -} \ No newline at end of file diff --git a/erpnext/accounts/report/account_balance/account_balance.py b/erpnext/accounts/report/account_balance/account_balance.py index a2c70a45f99..824a965cdcf 100644 --- a/erpnext/accounts/report/account_balance/account_balance.py +++ b/erpnext/accounts/report/account_balance/account_balance.py @@ -14,6 +14,7 @@ def execute(filters=None): data = get_data(filters) return columns, data + def get_columns(filters): columns = [ { @@ -21,7 +22,7 @@ def get_columns(filters): "fieldtype": "Link", "fieldname": "account", "options": "Account", - "width": 100 + "width": 100, }, { "label": _("Currency"), @@ -29,19 +30,20 @@ def get_columns(filters): "fieldname": "currency", "options": "Currency", "hidden": 1, - "width": 50 + "width": 50, }, { "label": _("Balance"), "fieldtype": "Currency", "fieldname": "balance", "options": "currency", - "width": 100 - } + "width": 100, + }, ] return columns + def get_conditions(filters): conditions = {} @@ -57,12 +59,14 @@ def get_conditions(filters): return conditions + def get_data(filters): data = [] conditions = get_conditions(filters) - accounts = frappe.db.get_all("Account", fields=["name", "account_currency"], - filters=conditions, order_by='name') + accounts = frappe.db.get_all( + "Account", fields=["name", "account_currency"], filters=conditions, order_by="name" + ) for d in accounts: balance = get_balance_on(d.name, date=filters.report_date) diff --git a/erpnext/accounts/report/account_balance/test_account_balance.py b/erpnext/accounts/report/account_balance/test_account_balance.py index 50b1a679b6c..13fa05d4743 100644 --- a/erpnext/accounts/report/account_balance/test_account_balance.py +++ b/erpnext/accounts/report/account_balance/test_account_balance.py @@ -1,4 +1,3 @@ - import unittest import frappe @@ -14,9 +13,9 @@ class TestAccountBalance(unittest.TestCase): frappe.db.sql("delete from `tabGL Entry` where company='_Test Company 2'") filters = { - 'company': '_Test Company 2', - 'report_date': getdate(), - 'root_type': 'Income', + "company": "_Test Company 2", + "report_date": getdate(), + "root_type": "Income", } make_sales_invoice() @@ -25,42 +24,45 @@ class TestAccountBalance(unittest.TestCase): expected_data = [ { - "account": 'Direct Income - _TC2', - "currency": 'EUR', + "account": "Direct Income - _TC2", + "currency": "EUR", "balance": -100.0, }, { - "account": 'Income - _TC2', - "currency": 'EUR', + "account": "Income - _TC2", + "currency": "EUR", "balance": -100.0, }, { - "account": 'Indirect Income - _TC2', - "currency": 'EUR', + "account": "Indirect Income - _TC2", + "currency": "EUR", "balance": 0.0, }, { - "account": 'Sales - _TC2', - "currency": 'EUR', + "account": "Sales - _TC2", + "currency": "EUR", "balance": -100.0, }, { - "account": 'Service - _TC2', - "currency": 'EUR', + "account": "Service - _TC2", + "currency": "EUR", "balance": 0.0, - } + }, ] self.assertEqual(expected_data, report[1]) + def make_sales_invoice(): frappe.set_user("Administrator") - create_sales_invoice(company="_Test Company 2", - customer = '_Test Customer 2', - currency = 'EUR', - warehouse = 'Finished Goods - _TC2', - debit_to = 'Debtors - _TC2', - income_account = 'Sales - _TC2', - expense_account = 'Cost of Goods Sold - _TC2', - cost_center = 'Main - _TC2') + create_sales_invoice( + company="_Test Company 2", + customer="_Test Customer 2", + currency="EUR", + warehouse="Finished Goods - _TC2", + debit_to="Debtors - _TC2", + income_account="Sales - _TC2", + expense_account="Cost of Goods Sold - _TC2", + cost_center="Main - _TC2", + ) diff --git a/erpnext/accounts/report/accounts_payable/accounts_payable.js b/erpnext/accounts/report/accounts_payable/accounts_payable.js index 81c60bb337d..f6961eb95fa 100644 --- a/erpnext/accounts/report/accounts_payable/accounts_payable.js +++ b/erpnext/accounts/report/accounts_payable/accounts_payable.js @@ -53,6 +53,22 @@ frappe.query_reports["Accounts Payable"] = { } } }, + { + "fieldname": "party_account", + "label": __("Payable Account"), + "fieldtype": "Link", + "options": "Account", + get_query: () => { + var company = frappe.query_report.get_filter_value('company'); + return { + filters: { + 'company': company, + 'account_type': 'Payable', + 'is_group': 0 + } + }; + } + }, { "fieldname": "ageing_based_on", "label": __("Ageing Based On"), diff --git a/erpnext/accounts/report/accounts_receivable/accounts_receivable.html b/erpnext/accounts/report/accounts_receivable/accounts_receivable.html index f4fd06ba037..f2bf9424f72 100644 --- a/erpnext/accounts/report/accounts_receivable/accounts_receivable.html +++ b/erpnext/accounts/report/accounts_receivable/accounts_receivable.html @@ -42,7 +42,7 @@ {% if(filters.show_future_payments) { %} {% var balance_row = data.slice(-1).pop(); - var start = filters.based_on_payment_terms ? 13 : 11; + var start = report.columns.findIndex((elem) => (elem.fieldname == 'age')); var range1 = report.columns[start].label; var range2 = report.columns[start+1].label; var range3 = report.columns[start+2].label; diff --git a/erpnext/accounts/report/accounts_receivable/accounts_receivable.js b/erpnext/accounts/report/accounts_receivable/accounts_receivable.js index 570029851e8..748bcde4354 100644 --- a/erpnext/accounts/report/accounts_receivable/accounts_receivable.js +++ b/erpnext/accounts/report/accounts_receivable/accounts_receivable.js @@ -66,6 +66,22 @@ frappe.query_reports["Accounts Receivable"] = { } } }, + { + "fieldname": "party_account", + "label": __("Receivable Account"), + "fieldtype": "Link", + "options": "Account", + get_query: () => { + var company = frappe.query_report.get_filter_value('company'); + return { + filters: { + 'company': company, + 'account_type': 'Receivable', + 'is_group': 0 + } + }; + } + }, { "fieldname": "ageing_based_on", "label": __("Ageing Based On"), diff --git a/erpnext/accounts/report/accounts_receivable/accounts_receivable.py b/erpnext/accounts/report/accounts_receivable/accounts_receivable.py index a990f23cd6b..c9567f23a34 100755 --- a/erpnext/accounts/report/accounts_receivable/accounts_receivable.py +++ b/erpnext/accounts/report/accounts_receivable/accounts_receivable.py @@ -29,6 +29,7 @@ from erpnext.accounts.utils import get_currency_precision # 9. Report amounts are in "Party Currency" if party is selected, or company currency for multi-party # 10. This reports is based on all GL Entries that are made against account_type "Receivable" or "Payable" + def execute(filters=None): args = { "party_type": "Customer", @@ -36,18 +37,23 @@ def execute(filters=None): } return ReceivablePayableReport(filters).run(args) + class ReceivablePayableReport(object): def __init__(self, filters=None): self.filters = frappe._dict(filters or {}) self.filters.report_date = getdate(self.filters.report_date or nowdate()) - self.age_as_on = getdate(nowdate()) \ - if self.filters.report_date > getdate(nowdate()) \ + self.age_as_on = ( + getdate(nowdate()) + if self.filters.report_date > getdate(nowdate()) else self.filters.report_date + ) def run(self, args): self.filters.update(args) self.set_defaults() - self.party_naming_by = frappe.db.get_value(args.get("naming_by")[0], None, args.get("naming_by")[1]) + self.party_naming_by = frappe.db.get_value( + args.get("naming_by")[0], None, args.get("naming_by")[1] + ) self.get_columns() self.get_data() self.get_chart_data() @@ -55,8 +61,10 @@ class ReceivablePayableReport(object): def set_defaults(self): if not self.filters.get("company"): - self.filters.company = frappe.db.get_single_value('Global Defaults', 'default_company') - self.company_currency = frappe.get_cached_value('Company', self.filters.get("company"), "default_currency") + self.filters.company = frappe.db.get_single_value("Global Defaults", "default_company") + self.company_currency = frappe.get_cached_value( + "Company", self.filters.get("company"), "default_currency" + ) self.currency_precision = get_currency_precision() or 2 self.dr_or_cr = "debit" if self.filters.party_type == "Customer" else "credit" self.party_type = self.filters.party_type @@ -64,8 +72,8 @@ class ReceivablePayableReport(object): self.invoices = set() self.skip_total_row = 0 - if self.filters.get('group_by_party'): - self.previous_party='' + if self.filters.get("group_by_party"): + self.previous_party = "" self.total_row_map = {} self.skip_total_row = 1 @@ -73,7 +81,7 @@ class ReceivablePayableReport(object): self.get_gl_entries() self.get_sales_invoices_or_customers_based_on_sales_person() self.voucher_balance = OrderedDict() - self.init_voucher_balance() # invoiced, paid, credit_note, outstanding + self.init_voucher_balance() # invoiced, paid, credit_note, outstanding # Build delivery note map against all sales invoices self.build_delivery_note_map() @@ -100,64 +108,73 @@ class ReceivablePayableReport(object): key = (gle.voucher_type, gle.voucher_no, gle.party) if not key in self.voucher_balance: self.voucher_balance[key] = frappe._dict( - voucher_type = gle.voucher_type, - voucher_no = gle.voucher_no, - party = gle.party, - posting_date = gle.posting_date, - account_currency = gle.account_currency, - remarks = gle.remarks if self.filters.get("show_remarks") else None, - invoiced = 0.0, - paid = 0.0, - credit_note = 0.0, - outstanding = 0.0, - invoiced_in_account_currency = 0.0, - paid_in_account_currency = 0.0, - credit_note_in_account_currency = 0.0, - outstanding_in_account_currency = 0.0 + voucher_type=gle.voucher_type, + voucher_no=gle.voucher_no, + party=gle.party, + party_account=gle.account, + posting_date=gle.posting_date, + account_currency=gle.account_currency, + remarks=gle.remarks if self.filters.get("show_remarks") else None, + invoiced=0.0, + paid=0.0, + credit_note=0.0, + outstanding=0.0, + invoiced_in_account_currency=0.0, + paid_in_account_currency=0.0, + credit_note_in_account_currency=0.0, + outstanding_in_account_currency=0.0, ) self.get_invoices(gle) - if self.filters.get('group_by_party'): + if self.filters.get("group_by_party"): self.init_subtotal_row(gle.party) - if self.filters.get('group_by_party'): - self.init_subtotal_row('Total') + if self.filters.get("group_by_party"): + self.init_subtotal_row("Total") def get_invoices(self, gle): - if gle.voucher_type in ('Sales Invoice', 'Purchase Invoice'): + if gle.voucher_type in ("Sales Invoice", "Purchase Invoice"): if self.filters.get("sales_person"): - if gle.voucher_no in self.sales_person_records.get("Sales Invoice", []) \ - or gle.party in self.sales_person_records.get("Customer", []): - self.invoices.add(gle.voucher_no) + if gle.voucher_no in self.sales_person_records.get( + "Sales Invoice", [] + ) or gle.party in self.sales_person_records.get("Customer", []): + self.invoices.add(gle.voucher_no) else: self.invoices.add(gle.voucher_no) def init_subtotal_row(self, party): if not self.total_row_map.get(party): - self.total_row_map.setdefault(party, { - 'party': party, - 'bold': 1 - }) + self.total_row_map.setdefault(party, {"party": party, "bold": 1}) for field in self.get_currency_fields(): self.total_row_map[party][field] = 0.0 def get_currency_fields(self): - return ['invoiced', 'paid', 'credit_note', 'outstanding', 'range1', - 'range2', 'range3', 'range4', 'range5'] + return [ + "invoiced", + "paid", + "credit_note", + "outstanding", + "range1", + "range2", + "range3", + "range4", + "range5", + ] def update_voucher_balance(self, gle): # get the row where this balance needs to be updated # if its a payment, it will return the linked invoice or will be considered as advance row = self.get_voucher_balance(gle) - if not row: return + if not row: + return # gle_balance will be the total "debit - credit" for receivable type reports and # and vice-versa for payable type reports gle_balance = self.get_gle_balance(gle) gle_balance_in_account_currency = self.get_gle_balance_in_account_currency(gle) if gle_balance > 0: - if gle.voucher_type in ('Journal Entry', 'Payment Entry') and gle.against_voucher: + if gle.voucher_type in ("Journal Entry", "Payment Entry") and gle.against_voucher: # debit against sales / purchase invoice row.paid -= gle_balance row.paid_in_account_currency -= gle_balance_in_account_currency @@ -177,7 +194,7 @@ class ReceivablePayableReport(object): row.paid_in_account_currency -= gle_balance_in_account_currency if gle.cost_center: - row.cost_center = str(gle.cost_center) + row.cost_center = str(gle.cost_center) def update_sub_total_row(self, row, party): total_row = self.total_row_map.get(party) @@ -191,14 +208,16 @@ class ReceivablePayableReport(object): if sub_total_row: self.data.append(sub_total_row) self.data.append({}) - self.update_sub_total_row(sub_total_row, 'Total') + self.update_sub_total_row(sub_total_row, "Total") def get_voucher_balance(self, gle): if self.filters.get("sales_person"): against_voucher = gle.against_voucher or gle.voucher_no - if not (gle.party in self.sales_person_records.get("Customer", []) or \ - against_voucher in self.sales_person_records.get("Sales Invoice", [])): - return + if not ( + gle.party in self.sales_person_records.get("Customer", []) + or against_voucher in self.sales_person_records.get("Sales Invoice", []) + ): + return voucher_balance = None if gle.against_voucher: @@ -208,13 +227,15 @@ class ReceivablePayableReport(object): # If payment is made against credit note # and credit note is made against a Sales Invoice # then consider the payment against original sales invoice. - if gle.against_voucher_type in ('Sales Invoice', 'Purchase Invoice'): + if gle.against_voucher_type in ("Sales Invoice", "Purchase Invoice"): if gle.against_voucher in self.return_entries: return_against = self.return_entries.get(gle.against_voucher) if return_against: against_voucher = return_against - voucher_balance = self.voucher_balance.get((gle.against_voucher_type, against_voucher, gle.party)) + voucher_balance = self.voucher_balance.get( + (gle.against_voucher_type, against_voucher, gle.party) + ) if not voucher_balance: # no invoice, this is an invoice / stand-alone payment / credit note @@ -227,13 +248,18 @@ class ReceivablePayableReport(object): # as we can use this to filter out invoices without outstanding for key, row in self.voucher_balance.items(): row.outstanding = flt(row.invoiced - row.paid - row.credit_note, self.currency_precision) - row.outstanding_in_account_currency = flt(row.invoiced_in_account_currency - row.paid_in_account_currency - \ - row.credit_note_in_account_currency, self.currency_precision) + row.outstanding_in_account_currency = flt( + row.invoiced_in_account_currency + - row.paid_in_account_currency + - row.credit_note_in_account_currency, + self.currency_precision, + ) row.invoice_grand_total = row.invoiced - if (abs(row.outstanding) > 1.0/10 ** self.currency_precision) and \ - (abs(row.outstanding_in_account_currency) > 1.0/10 ** self.currency_precision): + if (abs(row.outstanding) > 1.0 / 10**self.currency_precision) and ( + abs(row.outstanding_in_account_currency) > 1.0 / 10**self.currency_precision + ): # non-zero oustanding, we must consider this row if self.is_invoice(row) and self.filters.based_on_payment_terms: @@ -254,10 +280,10 @@ class ReceivablePayableReport(object): else: self.append_row(row) - if self.filters.get('group_by_party'): + if self.filters.get("group_by_party"): self.append_subtotal_row(self.previous_party) if self.data: - self.data.append(self.total_row_map.get('Total')) + self.data.append(self.total_row_map.get("Total")) def append_row(self, row): self.allocate_future_payments(row) @@ -265,7 +291,7 @@ class ReceivablePayableReport(object): self.set_party_details(row) self.set_ageing(row) - if self.filters.get('group_by_party'): + if self.filters.get("group_by_party"): self.update_sub_total_row(row, row.party) if self.previous_party and (self.previous_party != row.party): self.append_subtotal_row(self.previous_party) @@ -279,39 +305,49 @@ class ReceivablePayableReport(object): invoice_details.pop("due_date", None) row.update(invoice_details) - if row.voucher_type == 'Sales Invoice': + if row.voucher_type == "Sales Invoice": if self.filters.show_delivery_notes: self.set_delivery_notes(row) if self.filters.show_sales_person and row.sales_team: row.sales_person = ", ".join(row.sales_team) - del row['sales_team'] + del row["sales_team"] def set_delivery_notes(self, row): delivery_notes = self.delivery_notes.get(row.voucher_no, []) if delivery_notes: - row.delivery_notes = ', '.join(delivery_notes) + row.delivery_notes = ", ".join(delivery_notes) def build_delivery_note_map(self): if self.invoices and self.filters.show_delivery_notes: self.delivery_notes = frappe._dict() # delivery note link inside sales invoice - si_against_dn = frappe.db.sql(""" + si_against_dn = frappe.db.sql( + """ select parent, delivery_note from `tabSales Invoice Item` where docstatus=1 and parent in (%s) - """ % (','.join(['%s'] * len(self.invoices))), tuple(self.invoices), as_dict=1) + """ + % (",".join(["%s"] * len(self.invoices))), + tuple(self.invoices), + as_dict=1, + ) for d in si_against_dn: if d.delivery_note: self.delivery_notes.setdefault(d.parent, set()).add(d.delivery_note) - dn_against_si = frappe.db.sql(""" + dn_against_si = frappe.db.sql( + """ select distinct parent, against_sales_invoice from `tabDelivery Note Item` where against_sales_invoice in (%s) - """ % (','.join(['%s'] * len(self.invoices))), tuple(self.invoices) , as_dict=1) + """ + % (",".join(["%s"] * len(self.invoices))), + tuple(self.invoices), + as_dict=1, + ) for d in dn_against_si: self.delivery_notes.setdefault(d.against_sales_invoice, set()).add(d.parent) @@ -319,39 +355,55 @@ class ReceivablePayableReport(object): def get_invoice_details(self): self.invoice_details = frappe._dict() if self.party_type == "Customer": - si_list = frappe.db.sql(""" + si_list = frappe.db.sql( + """ select name, due_date, po_no from `tabSales Invoice` where posting_date <= %s - """,self.filters.report_date, as_dict=1) + """, + self.filters.report_date, + as_dict=1, + ) for d in si_list: self.invoice_details.setdefault(d.name, d) # Get Sales Team if self.filters.show_sales_person: - sales_team = frappe.db.sql(""" + sales_team = frappe.db.sql( + """ select parent, sales_person from `tabSales Team` where parenttype = 'Sales Invoice' - """, as_dict=1) + """, + as_dict=1, + ) for d in sales_team: - self.invoice_details.setdefault(d.parent, {})\ - .setdefault('sales_team', []).append(d.sales_person) + self.invoice_details.setdefault(d.parent, {}).setdefault("sales_team", []).append( + d.sales_person + ) if self.party_type == "Supplier": - for pi in frappe.db.sql(""" + for pi in frappe.db.sql( + """ select name, due_date, bill_no, bill_date from `tabPurchase Invoice` where posting_date <= %s - """, self.filters.report_date, as_dict=1): + """, + self.filters.report_date, + as_dict=1, + ): self.invoice_details.setdefault(pi.name, pi) # Invoices booked via Journal Entries - journal_entries = frappe.db.sql(""" + journal_entries = frappe.db.sql( + """ select name, due_date, bill_no, bill_date from `tabJournal Entry` where posting_date <= %s - """, self.filters.report_date, as_dict=1) + """, + self.filters.report_date, + as_dict=1, + ) for je in journal_entries: if je.bill_no: @@ -372,17 +424,18 @@ class ReceivablePayableReport(object): # update "paid" and "oustanding" for this term if not term.paid: - self.allocate_closing_to_term(row, term, 'paid') + self.allocate_closing_to_term(row, term, "paid") # update "credit_note" and "oustanding" for this term if term.outstanding: - self.allocate_closing_to_term(row, term, 'credit_note') + self.allocate_closing_to_term(row, term, "credit_note") - row.payment_terms = sorted(row.payment_terms, key=lambda x: x['due_date']) + row.payment_terms = sorted(row.payment_terms, key=lambda x: x["due_date"]) def get_payment_terms(self, row): # build payment_terms for row - payment_terms_details = frappe.db.sql(""" + payment_terms_details = frappe.db.sql( + """ select si.name, si.party_account_currency, si.currency, si.conversion_rate, ps.due_date, ps.payment_term, ps.payment_amount, ps.description, ps.paid_amount, ps.discounted_amount @@ -391,8 +444,12 @@ class ReceivablePayableReport(object): si.name = ps.parent and si.name = %s order by ps.paid_amount desc, due_date - """.format(row.voucher_type), row.voucher_no, as_dict = 1) - + """.format( + row.voucher_type + ), + row.voucher_no, + as_dict=1, + ) original_row = frappe._dict(row) row.payment_terms = [] @@ -406,23 +463,29 @@ class ReceivablePayableReport(object): self.append_payment_term(row, d, term) def append_payment_term(self, row, d, term): - if (self.filters.get("customer") or self.filters.get("supplier")) and d.currency == d.party_account_currency: + if ( + self.filters.get("customer") or self.filters.get("supplier") + ) and d.currency == d.party_account_currency: invoiced = d.payment_amount else: invoiced = flt(flt(d.payment_amount) * flt(d.conversion_rate), self.currency_precision) - row.payment_terms.append(term.update({ - "due_date": d.due_date, - "invoiced": invoiced, - "invoice_grand_total": row.invoiced, - "payment_term": d.description or d.payment_term, - "paid": d.paid_amount + d.discounted_amount, - "credit_note": 0.0, - "outstanding": invoiced - d.paid_amount - d.discounted_amount - })) + row.payment_terms.append( + term.update( + { + "due_date": d.due_date, + "invoiced": invoiced, + "invoice_grand_total": row.invoiced, + "payment_term": d.description or d.payment_term, + "paid": d.paid_amount + d.discounted_amount, + "credit_note": 0.0, + "outstanding": invoiced - d.paid_amount - d.discounted_amount, + } + ) + ) if d.paid_amount: - row['paid'] -= d.paid_amount + d.discounted_amount + row["paid"] -= d.paid_amount + d.discounted_amount def allocate_closing_to_term(self, row, term, key): if row[key]: @@ -437,7 +500,7 @@ class ReceivablePayableReport(object): def allocate_extra_payments_or_credits(self, row): # allocate extra payments / credits additional_row = None - for key in ('paid', 'credit_note'): + for key in ("paid", "credit_note"): if row[key] > 0: if not additional_row: additional_row = frappe._dict(row) @@ -445,7 +508,9 @@ class ReceivablePayableReport(object): additional_row[key] = row[key] if additional_row: - additional_row.outstanding = additional_row.invoiced - additional_row.paid - additional_row.credit_note + additional_row.outstanding = ( + additional_row.invoiced - additional_row.paid - additional_row.credit_note + ) self.append_row(additional_row) def get_future_payments(self): @@ -459,7 +524,8 @@ class ReceivablePayableReport(object): self.future_payments.setdefault((d.invoice_no, d.party), []).append(d) def get_future_payments_from_payment_entry(self): - return frappe.db.sql(""" + return frappe.db.sql( + """ select ref.reference_name as invoice_no, payment_entry.party, @@ -475,16 +541,23 @@ class ReceivablePayableReport(object): payment_entry.docstatus < 2 and payment_entry.posting_date > %s and payment_entry.party_type = %s - """, (self.filters.report_date, self.party_type), as_dict=1) + """, + (self.filters.report_date, self.party_type), + as_dict=1, + ) def get_future_payments_from_journal_entry(self): - if self.filters.get('party'): - amount_field = ("jea.debit_in_account_currency - jea.credit_in_account_currency" - if self.party_type == 'Supplier' else "jea.credit_in_account_currency - jea.debit_in_account_currency") + if self.filters.get("party"): + amount_field = ( + "jea.debit_in_account_currency - jea.credit_in_account_currency" + if self.party_type == "Supplier" + else "jea.credit_in_account_currency - jea.debit_in_account_currency" + ) else: - amount_field = ("jea.debit - " if self.party_type == 'Supplier' else "jea.credit") + amount_field = "jea.debit - " if self.party_type == "Supplier" else "jea.credit" - return frappe.db.sql(""" + return frappe.db.sql( + """ select jea.reference_name as invoice_no, jea.party, @@ -503,7 +576,12 @@ class ReceivablePayableReport(object): and jea.reference_name is not null and jea.reference_name != '' group by je.name, jea.reference_name having future_amount > 0 - """.format(amount_field), (self.filters.report_date, self.party_type), as_dict=1) + """.format( + amount_field + ), + (self.filters.report_date, self.party_type), + as_dict=1, + ) def allocate_future_payments(self, row): # future payments are captured in additional columns @@ -525,22 +603,21 @@ class ReceivablePayableReport(object): future.future_amount = 0 row.remaining_balance = row.outstanding - row.future_amount - row.setdefault('future_ref', []).append(cstr(future.future_ref) + '/' + cstr(future.future_date)) + row.setdefault("future_ref", []).append( + cstr(future.future_ref) + "/" + cstr(future.future_date) + ) if row.future_ref: - row.future_ref = ', '.join(row.future_ref) + row.future_ref = ", ".join(row.future_ref) def get_return_entries(self): doctype = "Sales Invoice" if self.party_type == "Customer" else "Purchase Invoice" - filters={ - 'is_return': 1, - 'docstatus': 1 - } + filters = {"is_return": 1, "docstatus": 1} party_field = scrub(self.filters.party_type) if self.filters.get(party_field): filters.update({party_field: self.filters.get(party_field)}) self.return_entries = frappe._dict( - frappe.get_all(doctype, filters, ['name', 'return_against'], as_list=1) + frappe.get_all(doctype, filters, ["name", "return_against"], as_list=1) ) def set_ageing(self, row): @@ -571,16 +648,26 @@ class ReceivablePayableReport(object): row.age = (getdate(self.age_as_on) - getdate(entry_date)).days or 0 index = None - if not (self.filters.range1 and self.filters.range2 and self.filters.range3 and self.filters.range4): - self.filters.range1, self.filters.range2, self.filters.range3, self.filters.range4 = 30, 60, 90, 120 + if not ( + self.filters.range1 and self.filters.range2 and self.filters.range3 and self.filters.range4 + ): + self.filters.range1, self.filters.range2, self.filters.range3, self.filters.range4 = ( + 30, + 60, + 90, + 120, + ) - for i, days in enumerate([self.filters.range1, self.filters.range2, self.filters.range3, self.filters.range4]): + for i, days in enumerate( + [self.filters.range1, self.filters.range2, self.filters.range3, self.filters.range4] + ): if cint(row.age) <= cint(days): index = i break - if index is None: index = 4 - row['range' + str(index+1)] = row.outstanding + if index is None: + index = 4 + row["range" + str(index + 1)] = row.outstanding def get_gl_entries(self): # get all the GL entries filtered by the given filters @@ -605,7 +692,8 @@ class ReceivablePayableReport(object): remarks = ", remarks" if self.filters.get("show_remarks") else "" - self.gl_entries = frappe.db.sql(""" + self.gl_entries = frappe.db.sql( + """ select name, posting_date, account, party_type, party, voucher_type, voucher_no, cost_center, against_voucher_type, against_voucher, account_currency, {0}, {1} {remarks} @@ -616,20 +704,27 @@ class ReceivablePayableReport(object): and is_cancelled = 0 and party_type=%s and (party is not null and party != '') - {2} {3} {4}""" - .format(select_fields, doc_currency_fields, date_condition, conditions, order_by, remarks=remarks), values, as_dict=True) + {2} {3} {4}""".format( + select_fields, doc_currency_fields, date_condition, conditions, order_by, remarks=remarks + ), + values, + as_dict=True, + ) def get_sales_invoices_or_customers_based_on_sales_person(self): if self.filters.get("sales_person"): - lft, rgt = frappe.db.get_value("Sales Person", - self.filters.get("sales_person"), ["lft", "rgt"]) + lft, rgt = frappe.db.get_value("Sales Person", self.filters.get("sales_person"), ["lft", "rgt"]) - records = frappe.db.sql(""" + records = frappe.db.sql( + """ select distinct parent, parenttype from `tabSales Team` steam where parenttype in ('Customer', 'Sales Invoice') and exists(select name from `tabSales Person` where lft >= %s and rgt <= %s and name = steam.sales_person) - """, (lft, rgt), as_dict=1) + """, + (lft, rgt), + as_dict=1, + ) self.sales_person_records = frappe._dict() for d in records: @@ -642,10 +737,10 @@ class ReceivablePayableReport(object): self.add_common_filters(conditions, values, party_type_field) - if party_type_field=="customer": + if party_type_field == "customer": self.add_customer_filters(conditions, values) - elif party_type_field=="supplier": + elif party_type_field == "supplier": self.add_supplier_filters(conditions, values) if self.filters.cost_center: @@ -656,13 +751,16 @@ class ReceivablePayableReport(object): def get_cost_center_conditions(self, conditions): lft, rgt = frappe.db.get_value("Cost Center", self.filters.cost_center, ["lft", "rgt"]) - cost_center_list = [center.name for center in frappe.get_list("Cost Center", filters = {'lft': (">=", lft), 'rgt': ("<=", rgt)})] + cost_center_list = [ + center.name + for center in frappe.get_list("Cost Center", filters={"lft": (">=", lft), "rgt": ("<=", rgt)}) + ] cost_center_string = '", "'.join(cost_center_list) conditions.append('cost_center in ("{0}")'.format(cost_center_string)) def get_order_by_condition(self): - if self.filters.get('group_by_party'): + if self.filters.get("group_by_party"): return "order by party, posting_date" else: return "order by posting_date, party" @@ -680,21 +778,28 @@ class ReceivablePayableReport(object): conditions.append("party=%s") values.append(self.filters.get(party_type_field)) - # get GL with "receivable" or "payable" account_type - account_type = "Receivable" if self.party_type == "Customer" else "Payable" - accounts = [d.name for d in frappe.get_all("Account", - filters={"account_type": account_type, "company": self.filters.company})] - - if accounts: - conditions.append("account in (%s)" % ','.join(['%s'] *len(accounts))) - values += accounts + if self.filters.party_account: + conditions.append("account =%s") + values.append(self.filters.party_account) + else: + # get GL with "receivable" or "payable" account_type + account_type = "Receivable" if self.party_type == "Customer" else "Payable" + accounts = [ + d.name + for d in frappe.get_all( + "Account", filters={"account_type": account_type, "company": self.filters.company} + ) + ] + if accounts: + conditions.append("account in (%s)" % ",".join(["%s"] * len(accounts))) + values += accounts def add_customer_filters(self, conditions, values): if self.filters.get("customer_group"): - conditions.append(self.get_hierarchical_filters('Customer Group', 'customer_group')) + conditions.append(self.get_hierarchical_filters("Customer Group", "customer_group")) if self.filters.get("territory"): - conditions.append(self.get_hierarchical_filters('Territory', 'territory')) + conditions.append(self.get_hierarchical_filters("Territory", "territory")) if self.filters.get("payment_terms_template"): conditions.append("party in (select name from tabCustomer where payment_terms=%s)") @@ -706,8 +811,10 @@ class ReceivablePayableReport(object): def add_supplier_filters(self, conditions, values): if self.filters.get("supplier_group"): - conditions.append("""party in (select name from tabSupplier - where supplier_group=%s)""") + conditions.append( + """party in (select name from tabSupplier + where supplier_group=%s)""" + ) values.append(self.filters.get("supplier_group")) if self.filters.get("payment_terms_template"): @@ -720,7 +827,8 @@ class ReceivablePayableReport(object): return """party in (select name from tabCustomer where exists(select name from `tab{doctype}` where lft >= {lft} and rgt <= {rgt} and name=tabCustomer.{key}))""".format( - doctype=doctype, lft=lft, rgt=rgt, key=key) + doctype=doctype, lft=lft, rgt=rgt, key=key + ) def add_accounting_dimensions_filters(self, conditions, values): accounting_dimensions = get_accounting_dimensions(as_list=False) @@ -728,9 +836,10 @@ class ReceivablePayableReport(object): if accounting_dimensions: for dimension in accounting_dimensions: if self.filters.get(dimension.fieldname): - if frappe.get_cached_value('DocType', dimension.document_type, 'is_tree'): - self.filters[dimension.fieldname] = get_dimension_with_children(dimension.document_type, - self.filters.get(dimension.fieldname)) + if frappe.get_cached_value("DocType", dimension.document_type, "is_tree"): + self.filters[dimension.fieldname] = get_dimension_with_children( + dimension.document_type, self.filters.get(dimension.fieldname) + ) conditions.append("{0} in %s".format(dimension.fieldname)) values.append(tuple(self.filters.get(dimension.fieldname))) @@ -740,123 +849,176 @@ class ReceivablePayableReport(object): def get_gle_balance_in_account_currency(self, gle): # get the balance of the GL (debit - credit) or reverse balance based on report type - return gle.get(self.dr_or_cr + '_in_account_currency') - self.get_reverse_balance_in_account_currency(gle) + return gle.get( + self.dr_or_cr + "_in_account_currency" + ) - self.get_reverse_balance_in_account_currency(gle) def get_reverse_balance_in_account_currency(self, gle): - return gle.get('debit_in_account_currency' if self.dr_or_cr=='credit' else 'credit_in_account_currency') + return gle.get( + "debit_in_account_currency" if self.dr_or_cr == "credit" else "credit_in_account_currency" + ) def get_reverse_balance(self, gle): # get "credit" balance if report type is "debit" and vice versa - return gle.get('debit' if self.dr_or_cr=='credit' else 'credit') + return gle.get("debit" if self.dr_or_cr == "credit" else "credit") def is_invoice(self, gle): - if gle.voucher_type in ('Sales Invoice', 'Purchase Invoice'): + if gle.voucher_type in ("Sales Invoice", "Purchase Invoice"): return True def get_party_details(self, party): if not party in self.party_details: - if self.party_type == 'Customer': - self.party_details[party] = frappe.db.get_value('Customer', party, ['customer_name', - 'territory', 'customer_group', 'customer_primary_contact'], as_dict=True) + if self.party_type == "Customer": + self.party_details[party] = frappe.db.get_value( + "Customer", + party, + ["customer_name", "territory", "customer_group", "customer_primary_contact"], + as_dict=True, + ) else: - self.party_details[party] = frappe.db.get_value('Supplier', party, ['supplier_name', - 'supplier_group'], as_dict=True) + self.party_details[party] = frappe.db.get_value( + "Supplier", party, ["supplier_name", "supplier_group"], as_dict=True + ) return self.party_details[party] - def get_columns(self): self.columns = [] - self.add_column('Posting Date', fieldtype='Date') - self.add_column(label=_(self.party_type), fieldname='party', - fieldtype='Link', options=self.party_type, width=180) + self.add_column("Posting Date", fieldtype="Date") + self.add_column( + label=_(self.party_type), + fieldname="party", + fieldtype="Link", + options=self.party_type, + width=180, + ) + + self.add_column( + label="Receivable Account" if self.party_type == "Customer" else "Payable Account", + fieldname="party_account", + fieldtype="Link", + options="Account", + width=180, + ) if self.party_naming_by == "Naming Series": - self.add_column(_('{0} Name').format(self.party_type), - fieldname = scrub(self.party_type) + '_name', fieldtype='Data') + self.add_column( + _("{0} Name").format(self.party_type), + fieldname=scrub(self.party_type) + "_name", + fieldtype="Data", + ) - if self.party_type == 'Customer': - self.add_column(_("Customer Contact"), fieldname='customer_primary_contact', - fieldtype='Link', options='Contact') + if self.party_type == "Customer": + self.add_column( + _("Customer Contact"), + fieldname="customer_primary_contact", + fieldtype="Link", + options="Contact", + ) - self.add_column(label=_('Cost Center'), fieldname='cost_center', fieldtype='Data') - self.add_column(label=_('Voucher Type'), fieldname='voucher_type', fieldtype='Data') - self.add_column(label=_('Voucher No'), fieldname='voucher_no', fieldtype='Dynamic Link', - options='voucher_type', width=180) + self.add_column(label=_("Cost Center"), fieldname="cost_center", fieldtype="Data") + self.add_column(label=_("Voucher Type"), fieldname="voucher_type", fieldtype="Data") + self.add_column( + label=_("Voucher No"), + fieldname="voucher_no", + fieldtype="Dynamic Link", + options="voucher_type", + width=180, + ) if self.filters.show_remarks: - self.add_column(label=_('Remarks'), fieldname='remarks', fieldtype='Text', width=200), + self.add_column(label=_("Remarks"), fieldname="remarks", fieldtype="Text", width=200), - self.add_column(label='Due Date', fieldtype='Date') + self.add_column(label="Due Date", fieldtype="Date") if self.party_type == "Supplier": - self.add_column(label=_('Bill No'), fieldname='bill_no', fieldtype='Data') - self.add_column(label=_('Bill Date'), fieldname='bill_date', fieldtype='Date') + self.add_column(label=_("Bill No"), fieldname="bill_no", fieldtype="Data") + self.add_column(label=_("Bill Date"), fieldname="bill_date", fieldtype="Date") if self.filters.based_on_payment_terms: - self.add_column(label=_('Payment Term'), fieldname='payment_term', fieldtype='Data') - self.add_column(label=_('Invoice Grand Total'), fieldname='invoice_grand_total') + self.add_column(label=_("Payment Term"), fieldname="payment_term", fieldtype="Data") + self.add_column(label=_("Invoice Grand Total"), fieldname="invoice_grand_total") - self.add_column(_('Invoiced Amount'), fieldname='invoiced') - self.add_column(_('Paid Amount'), fieldname='paid') + self.add_column(_("Invoiced Amount"), fieldname="invoiced") + self.add_column(_("Paid Amount"), fieldname="paid") if self.party_type == "Customer": - self.add_column(_('Credit Note'), fieldname='credit_note') + self.add_column(_("Credit Note"), fieldname="credit_note") else: # note: fieldname is still `credit_note` - self.add_column(_('Debit Note'), fieldname='credit_note') - self.add_column(_('Outstanding Amount'), fieldname='outstanding') + self.add_column(_("Debit Note"), fieldname="credit_note") + self.add_column(_("Outstanding Amount"), fieldname="outstanding") self.setup_ageing_columns() - self.add_column(label=_('Currency'), fieldname='currency', fieldtype='Link', options='Currency', width=80) + self.add_column( + label=_("Currency"), fieldname="currency", fieldtype="Link", options="Currency", width=80 + ) if self.filters.show_future_payments: - self.add_column(label=_('Future Payment Ref'), fieldname='future_ref', fieldtype='Data') - self.add_column(label=_('Future Payment Amount'), fieldname='future_amount') - self.add_column(label=_('Remaining Balance'), fieldname='remaining_balance') + self.add_column(label=_("Future Payment Ref"), fieldname="future_ref", fieldtype="Data") + self.add_column(label=_("Future Payment Amount"), fieldname="future_amount") + self.add_column(label=_("Remaining Balance"), fieldname="remaining_balance") - if self.filters.party_type == 'Customer': - self.add_column(label=_('Customer LPO'), fieldname='po_no', fieldtype='Data') + if self.filters.party_type == "Customer": + self.add_column(label=_("Customer LPO"), fieldname="po_no", fieldtype="Data") # comma separated list of linked delivery notes if self.filters.show_delivery_notes: - self.add_column(label=_('Delivery Notes'), fieldname='delivery_notes', fieldtype='Data') - self.add_column(label=_('Territory'), fieldname='territory', fieldtype='Link', - options='Territory') - self.add_column(label=_('Customer Group'), fieldname='customer_group', fieldtype='Link', - options='Customer Group') + self.add_column(label=_("Delivery Notes"), fieldname="delivery_notes", fieldtype="Data") + self.add_column( + label=_("Territory"), fieldname="territory", fieldtype="Link", options="Territory" + ) + self.add_column( + label=_("Customer Group"), + fieldname="customer_group", + fieldtype="Link", + options="Customer Group", + ) if self.filters.show_sales_person: - self.add_column(label=_('Sales Person'), fieldname='sales_person', fieldtype='Data') + self.add_column(label=_("Sales Person"), fieldname="sales_person", fieldtype="Data") if self.filters.party_type == "Supplier": - self.add_column(label=_('Supplier Group'), fieldname='supplier_group', fieldtype='Link', - options='Supplier Group') + self.add_column( + label=_("Supplier Group"), + fieldname="supplier_group", + fieldtype="Link", + options="Supplier Group", + ) - def add_column(self, label, fieldname=None, fieldtype='Currency', options=None, width=120): - if not fieldname: fieldname = scrub(label) - if fieldtype=='Currency': options='currency' - if fieldtype=='Date': width = 90 + def add_column(self, label, fieldname=None, fieldtype="Currency", options=None, width=120): + if not fieldname: + fieldname = scrub(label) + if fieldtype == "Currency": + options = "currency" + if fieldtype == "Date": + width = 90 - self.columns.append(dict( - label=label, - fieldname=fieldname, - fieldtype=fieldtype, - options=options, - width=width - )) + self.columns.append( + dict(label=label, fieldname=fieldname, fieldtype=fieldtype, options=options, width=width) + ) def setup_ageing_columns(self): # for charts self.ageing_column_labels = [] - self.add_column(label=_('Age (Days)'), fieldname='age', fieldtype='Int', width=80) + self.add_column(label=_("Age (Days)"), fieldname="age", fieldtype="Int", width=80) - for i, label in enumerate(["0-{range1}".format(range1=self.filters["range1"]), - "{range1}-{range2}".format(range1=cint(self.filters["range1"])+ 1, range2=self.filters["range2"]), - "{range2}-{range3}".format(range2=cint(self.filters["range2"])+ 1, range3=self.filters["range3"]), - "{range3}-{range4}".format(range3=cint(self.filters["range3"])+ 1, range4=self.filters["range4"]), - "{range4}-{above}".format(range4=cint(self.filters["range4"])+ 1, above=_("Above"))]): - self.add_column(label=label, fieldname='range' + str(i+1)) - self.ageing_column_labels.append(label) + for i, label in enumerate( + [ + "0-{range1}".format(range1=self.filters["range1"]), + "{range1}-{range2}".format( + range1=cint(self.filters["range1"]) + 1, range2=self.filters["range2"] + ), + "{range2}-{range3}".format( + range2=cint(self.filters["range2"]) + 1, range3=self.filters["range3"] + ), + "{range3}-{range4}".format( + range3=cint(self.filters["range3"]) + 1, range4=self.filters["range4"] + ), + "{range4}-{above}".format(range4=cint(self.filters["range4"]) + 1, above=_("Above")), + ] + ): + self.add_column(label=label, fieldname="range" + str(i + 1)) + self.ageing_column_labels.append(label) def get_chart_data(self): rows = [] @@ -865,14 +1027,9 @@ class ReceivablePayableReport(object): if not cint(row.bold): values = [row.range1, row.range2, row.range3, row.range4, row.range5] precision = cint(frappe.db.get_default("float_precision")) or 2 - rows.append({ - 'values': [flt(val, precision) for val in values] - }) + rows.append({"values": [flt(val, precision) for val in values]}) self.chart = { - "data": { - 'labels': self.ageing_column_labels, - 'datasets': rows - }, - "type": 'percentage' + "data": {"labels": self.ageing_column_labels, "datasets": rows}, + "type": "percentage", } diff --git a/erpnext/accounts/report/accounts_receivable/test_accounts_receivable.py b/erpnext/accounts/report/accounts_receivable/test_accounts_receivable.py index b5408bd4c8f..f38890e980c 100644 --- a/erpnext/accounts/report/accounts_receivable/test_accounts_receivable.py +++ b/erpnext/accounts/report/accounts_receivable/test_accounts_receivable.py @@ -1,4 +1,3 @@ - import unittest import frappe @@ -15,13 +14,13 @@ class TestAccountsReceivable(unittest.TestCase): frappe.db.sql("delete from `tabGL Entry` where company='_Test Company 2'") filters = { - 'company': '_Test Company 2', - 'based_on_payment_terms': 1, - 'report_date': today(), - 'range1': 30, - 'range2': 60, - 'range3': 90, - 'range4': 120 + "company": "_Test Company 2", + "based_on_payment_terms": 1, + "report_date": today(), + "range1": 30, + "range2": 60, + "range3": 90, + "range4": 120, } # check invoice grand total and invoiced column's value for 3 payment terms @@ -31,8 +30,8 @@ class TestAccountsReceivable(unittest.TestCase): expected_data = [[100, 30], [100, 50], [100, 20]] for i in range(3): - row = report[1][i-1] - self.assertEqual(expected_data[i-1], [row.invoice_grand_total, row.invoiced]) + row = report[1][i - 1] + self.assertEqual(expected_data[i - 1], [row.invoice_grand_total, row.invoiced]) # check invoice grand total, invoiced, paid and outstanding column's value after payment make_payment(name) @@ -41,41 +40,65 @@ class TestAccountsReceivable(unittest.TestCase): expected_data_after_payment = [[100, 50, 10, 40], [100, 20, 0, 20]] for i in range(2): - row = report[1][i-1] - self.assertEqual(expected_data_after_payment[i-1], - [row.invoice_grand_total, row.invoiced, row.paid, row.outstanding]) + row = report[1][i - 1] + self.assertEqual( + expected_data_after_payment[i - 1], + [row.invoice_grand_total, row.invoiced, row.paid, row.outstanding], + ) # check invoice grand total, invoiced, paid and outstanding column's value after credit note make_credit_note(name) report = execute(filters) - expected_data_after_credit_note = [100, 0, 0, 40, -40] + expected_data_after_credit_note = [100, 0, 0, 40, -40, "Debtors - _TC2"] row = report[1][0] - self.assertEqual(expected_data_after_credit_note, - [row.invoice_grand_total, row.invoiced, row.paid, row.credit_note, row.outstanding]) + self.assertEqual( + expected_data_after_credit_note, + [ + row.invoice_grand_total, + row.invoiced, + row.paid, + row.credit_note, + row.outstanding, + row.party_account, + ], + ) + def make_sales_invoice(): frappe.set_user("Administrator") - si = create_sales_invoice(company="_Test Company 2", - customer = '_Test Customer 2', - currency = 'EUR', - warehouse = 'Finished Goods - _TC2', - debit_to = 'Debtors - _TC2', - income_account = 'Sales - _TC2', - expense_account = 'Cost of Goods Sold - _TC2', - cost_center = 'Main - _TC2', - do_not_save=1) + si = create_sales_invoice( + company="_Test Company 2", + customer="_Test Customer 2", + currency="EUR", + warehouse="Finished Goods - _TC2", + debit_to="Debtors - _TC2", + income_account="Sales - _TC2", + expense_account="Cost of Goods Sold - _TC2", + cost_center="Main - _TC2", + do_not_save=1, + ) - si.append('payment_schedule', dict(due_date=getdate(add_days(today(), 30)), invoice_portion=30.00, payment_amount=30)) - si.append('payment_schedule', dict(due_date=getdate(add_days(today(), 60)), invoice_portion=50.00, payment_amount=50)) - si.append('payment_schedule', dict(due_date=getdate(add_days(today(), 90)), invoice_portion=20.00, payment_amount=20)) + si.append( + "payment_schedule", + dict(due_date=getdate(add_days(today(), 30)), invoice_portion=30.00, payment_amount=30), + ) + si.append( + "payment_schedule", + dict(due_date=getdate(add_days(today(), 60)), invoice_portion=50.00, payment_amount=50), + ) + si.append( + "payment_schedule", + dict(due_date=getdate(add_days(today(), 90)), invoice_portion=20.00, payment_amount=20), + ) si.submit() return si.name + def make_payment(docname): pe = get_payment_entry("Sales Invoice", docname, bank_account="Cash - _TC2", party_amount=40) pe.paid_from = "Debtors - _TC2" @@ -84,14 +107,16 @@ def make_payment(docname): def make_credit_note(docname): - create_sales_invoice(company="_Test Company 2", - customer = '_Test Customer 2', - currency = 'EUR', - qty = -1, - warehouse = 'Finished Goods - _TC2', - debit_to = 'Debtors - _TC2', - income_account = 'Sales - _TC2', - expense_account = 'Cost of Goods Sold - _TC2', - cost_center = 'Main - _TC2', - is_return = 1, - return_against = docname) + create_sales_invoice( + company="_Test Company 2", + customer="_Test Customer 2", + currency="EUR", + qty=-1, + warehouse="Finished Goods - _TC2", + debit_to="Debtors - _TC2", + income_account="Sales - _TC2", + expense_account="Cost of Goods Sold - _TC2", + cost_center="Main - _TC2", + is_return=1, + return_against=docname, + ) diff --git a/erpnext/accounts/report/accounts_receivable_summary/accounts_receivable_summary.js b/erpnext/accounts/report/accounts_receivable_summary/accounts_receivable_summary.js index 305cddb102a..715cd6476e8 100644 --- a/erpnext/accounts/report/accounts_receivable_summary/accounts_receivable_summary.js +++ b/erpnext/accounts/report/accounts_receivable_summary/accounts_receivable_summary.js @@ -117,6 +117,11 @@ frappe.query_reports["Accounts Receivable Summary"] = { "label": __("Show Future Payments"), "fieldtype": "Check", }, + { + "fieldname":"show_gl_balance", + "label": __("Show GL Balance"), + "fieldtype": "Check", + }, ], onload: function(report) { diff --git a/erpnext/accounts/report/accounts_receivable_summary/accounts_receivable_summary.py b/erpnext/accounts/report/accounts_receivable_summary/accounts_receivable_summary.py index a95bcf83ef7..85baa82e83f 100644 --- a/erpnext/accounts/report/accounts_receivable_summary/accounts_receivable_summary.py +++ b/erpnext/accounts/report/accounts_receivable_summary/accounts_receivable_summary.py @@ -4,7 +4,7 @@ import frappe from frappe import _, scrub -from frappe.utils import cint +from frappe.utils import cint, flt from six import iteritems from erpnext.accounts.party import get_partywise_advanced_payment_amount @@ -19,10 +19,13 @@ def execute(filters=None): return AccountsReceivableSummary(filters).run(args) + class AccountsReceivableSummary(ReceivablePayableReport): def run(self, args): - self.party_type = args.get('party_type') - self.party_naming_by = frappe.db.get_value(args.get("naming_by")[0], None, args.get("naming_by")[1]) + self.party_type = args.get("party_type") + self.party_naming_by = frappe.db.get_value( + args.get("naming_by")[0], None, args.get("naming_by")[1] + ) self.get_columns() self.get_data(args) return self.columns, self.data @@ -34,8 +37,18 @@ class AccountsReceivableSummary(ReceivablePayableReport): self.get_party_total(args) - party_advance_amount = get_partywise_advanced_payment_amount(self.party_type, - self.filters.report_date, self.filters.show_future_payments, self.filters.company) or {} + party_advance_amount = ( + get_partywise_advanced_payment_amount( + self.party_type, + self.filters.report_date, + self.filters.show_future_payments, + self.filters.company, + ) + or {} + ) + + if self.filters.show_gl_balance: + gl_balance_map = get_gl_balance(self.filters.report_date) for party, party_dict in iteritems(self.party_total): if party_dict.outstanding == 0: @@ -45,7 +58,9 @@ class AccountsReceivableSummary(ReceivablePayableReport): row.party = party if self.party_naming_by == "Naming Series": - row.party_name = frappe.get_cached_value(self.party_type, party, scrub(self.party_type) + "_name") + row.party_name = frappe.get_cached_value( + self.party_type, party, scrub(self.party_type) + "_name" + ) row.update(party_dict) @@ -56,6 +71,10 @@ class AccountsReceivableSummary(ReceivablePayableReport): # but in summary report advance shown in separate column row.paid -= row.advance + if self.filters.show_gl_balance: + row.gl_balance = gl_balance_map.get(party) + row.diff = flt(row.outstanding) - flt(row.gl_balance) + self.data.append(row) def get_party_total(self, args): @@ -74,24 +93,29 @@ class AccountsReceivableSummary(ReceivablePayableReport): self.set_party_details(d) def init_party_total(self, row): - self.party_total.setdefault(row.party, frappe._dict({ - "invoiced": 0.0, - "paid": 0.0, - "credit_note": 0.0, - "outstanding": 0.0, - "range1": 0.0, - "range2": 0.0, - "range3": 0.0, - "range4": 0.0, - "range5": 0.0, - "total_due": 0.0, - "sales_person": [] - })) + self.party_total.setdefault( + row.party, + frappe._dict( + { + "invoiced": 0.0, + "paid": 0.0, + "credit_note": 0.0, + "outstanding": 0.0, + "range1": 0.0, + "range2": 0.0, + "range3": 0.0, + "range4": 0.0, + "range5": 0.0, + "total_due": 0.0, + "sales_person": [], + } + ), + ) def set_party_details(self, row): self.party_total[row.party].currency = row.currency - for key in ('territory', 'customer_group', 'supplier_group'): + for key in ("territory", "customer_group", "supplier_group"): if row.get(key): self.party_total[row.party][key] = row.get(key) @@ -100,44 +124,84 @@ class AccountsReceivableSummary(ReceivablePayableReport): def get_columns(self): self.columns = [] - self.add_column(label=_(self.party_type), fieldname='party', - fieldtype='Link', options=self.party_type, width=180) + self.add_column( + label=_(self.party_type), + fieldname="party", + fieldtype="Link", + options=self.party_type, + width=180, + ) if self.party_naming_by == "Naming Series": - self.add_column(_('{0} Name').format(self.party_type), - fieldname = 'party_name', fieldtype='Data') + self.add_column(_("{0} Name").format(self.party_type), fieldname="party_name", fieldtype="Data") - credit_debit_label = "Credit Note" if self.party_type == 'Customer' else "Debit Note" + credit_debit_label = "Credit Note" if self.party_type == "Customer" else "Debit Note" - self.add_column(_('Advance Amount'), fieldname='advance') - self.add_column(_('Invoiced Amount'), fieldname='invoiced') - self.add_column(_('Paid Amount'), fieldname='paid') - self.add_column(_(credit_debit_label), fieldname='credit_note') - self.add_column(_('Outstanding Amount'), fieldname='outstanding') + self.add_column(_("Advance Amount"), fieldname="advance") + self.add_column(_("Invoiced Amount"), fieldname="invoiced") + self.add_column(_("Paid Amount"), fieldname="paid") + self.add_column(_(credit_debit_label), fieldname="credit_note") + self.add_column(_("Outstanding Amount"), fieldname="outstanding") + + if self.filters.show_gl_balance: + self.add_column(_("GL Balance"), fieldname="gl_balance") + self.add_column(_("Difference"), fieldname="diff") self.setup_ageing_columns() if self.party_type == "Customer": - self.add_column(label=_('Territory'), fieldname='territory', fieldtype='Link', - options='Territory') - self.add_column(label=_('Customer Group'), fieldname='customer_group', fieldtype='Link', - options='Customer Group') + self.add_column( + label=_("Territory"), fieldname="territory", fieldtype="Link", options="Territory" + ) + self.add_column( + label=_("Customer Group"), + fieldname="customer_group", + fieldtype="Link", + options="Customer Group", + ) if self.filters.show_sales_person: - self.add_column(label=_('Sales Person'), fieldname='sales_person', fieldtype='Data') + self.add_column(label=_("Sales Person"), fieldname="sales_person", fieldtype="Data") else: - self.add_column(label=_('Supplier Group'), fieldname='supplier_group', fieldtype='Link', - options='Supplier Group') + self.add_column( + label=_("Supplier Group"), + fieldname="supplier_group", + fieldtype="Link", + options="Supplier Group", + ) - self.add_column(label=_('Currency'), fieldname='currency', fieldtype='Link', - options='Currency', width=80) + self.add_column( + label=_("Currency"), fieldname="currency", fieldtype="Link", options="Currency", width=80 + ) def setup_ageing_columns(self): - for i, label in enumerate(["0-{range1}".format(range1=self.filters["range1"]), - "{range1}-{range2}".format(range1=cint(self.filters["range1"])+ 1, range2=self.filters["range2"]), - "{range2}-{range3}".format(range2=cint(self.filters["range2"])+ 1, range3=self.filters["range3"]), - "{range3}-{range4}".format(range3=cint(self.filters["range3"])+ 1, range4=self.filters["range4"]), - "{range4}-{above}".format(range4=cint(self.filters["range4"])+ 1, above=_("Above"))]): - self.add_column(label=label, fieldname='range' + str(i+1)) + for i, label in enumerate( + [ + "0-{range1}".format(range1=self.filters["range1"]), + "{range1}-{range2}".format( + range1=cint(self.filters["range1"]) + 1, range2=self.filters["range2"] + ), + "{range2}-{range3}".format( + range2=cint(self.filters["range2"]) + 1, range3=self.filters["range3"] + ), + "{range3}-{range4}".format( + range3=cint(self.filters["range3"]) + 1, range4=self.filters["range4"] + ), + "{range4}-{above}".format(range4=cint(self.filters["range4"]) + 1, above=_("Above")), + ] + ): + self.add_column(label=label, fieldname="range" + str(i + 1)) # Add column for total due amount - self.add_column(label="Total Amount Due", fieldname='total_due') + self.add_column(label="Total Amount Due", fieldname="total_due") + + +def get_gl_balance(report_date): + return frappe._dict( + frappe.db.get_all( + "GL Entry", + fields=["party", "sum(debit - credit)"], + filters={"posting_date": ("<=", report_date), "is_cancelled": 0}, + group_by="party", + as_list=1, + ) + ) diff --git a/erpnext/accounts/report/asset_depreciation_ledger/asset_depreciation_ledger.py b/erpnext/accounts/report/asset_depreciation_ledger/asset_depreciation_ledger.py index 98f5b74eaac..57d80492ae0 100644 --- a/erpnext/accounts/report/asset_depreciation_ledger/asset_depreciation_ledger.py +++ b/erpnext/accounts/report/asset_depreciation_ledger/asset_depreciation_ledger.py @@ -11,34 +11,44 @@ def execute(filters=None): columns, data = get_columns(), get_data(filters) return columns, data + def get_data(filters): data = [] - depreciation_accounts = frappe.db.sql_list(""" select name from tabAccount - where ifnull(account_type, '') = 'Depreciation' """) + depreciation_accounts = frappe.db.sql_list( + """ select name from tabAccount + where ifnull(account_type, '') = 'Depreciation' """ + ) - filters_data = [["company", "=", filters.get('company')], - ["posting_date", ">=", filters.get('from_date')], - ["posting_date", "<=", filters.get('to_date')], + filters_data = [ + ["company", "=", filters.get("company")], + ["posting_date", ">=", filters.get("from_date")], + ["posting_date", "<=", filters.get("to_date")], ["against_voucher_type", "=", "Asset"], - ["account", "in", depreciation_accounts]] + ["account", "in", depreciation_accounts], + ] if filters.get("asset"): filters_data.append(["against_voucher", "=", filters.get("asset")]) if filters.get("asset_category"): - assets = frappe.db.sql_list("""select name from tabAsset - where asset_category = %s and docstatus=1""", filters.get("asset_category")) + assets = frappe.db.sql_list( + """select name from tabAsset + where asset_category = %s and docstatus=1""", + filters.get("asset_category"), + ) filters_data.append(["against_voucher", "in", assets]) if filters.get("finance_book"): - filters_data.append(["finance_book", "in", ['', filters.get('finance_book')]]) + filters_data.append(["finance_book", "in", ["", filters.get("finance_book")]]) - gl_entries = frappe.get_all('GL Entry', - filters= filters_data, - fields = ["against_voucher", "debit_in_account_currency as debit", "voucher_no", "posting_date"], - order_by= "against_voucher, posting_date") + gl_entries = frappe.get_all( + "GL Entry", + filters=filters_data, + fields=["against_voucher", "debit_in_account_currency as debit", "voucher_no", "posting_date"], + order_by="against_voucher, posting_date", + ) if not gl_entries: return data @@ -55,29 +65,40 @@ def get_data(filters): asset_data.accumulated_depreciation_amount += d.debit row = frappe._dict(asset_data) - row.update({ - "depreciation_amount": d.debit, - "depreciation_date": d.posting_date, - "amount_after_depreciation": (flt(row.gross_purchase_amount) - - flt(row.accumulated_depreciation_amount)), - "depreciation_entry": d.voucher_no - }) + row.update( + { + "depreciation_amount": d.debit, + "depreciation_date": d.posting_date, + "amount_after_depreciation": ( + flt(row.gross_purchase_amount) - flt(row.accumulated_depreciation_amount) + ), + "depreciation_entry": d.voucher_no, + } + ) data.append(row) return data + def get_assets_details(assets): assets_details = {} - fields = ["name as asset", "gross_purchase_amount", - "asset_category", "status", "depreciation_method", "purchase_date"] + fields = [ + "name as asset", + "gross_purchase_amount", + "asset_category", + "status", + "depreciation_method", + "purchase_date", + ] - for d in frappe.get_all("Asset", fields = fields, filters = {'name': ('in', assets)}): + for d in frappe.get_all("Asset", fields=fields, filters={"name": ("in", assets)}): assets_details.setdefault(d.asset, d) return assets_details + def get_columns(): return [ { @@ -85,68 +106,58 @@ def get_columns(): "fieldname": "asset", "fieldtype": "Link", "options": "Asset", - "width": 120 + "width": 120, }, { "label": _("Depreciation Date"), "fieldname": "depreciation_date", "fieldtype": "Date", - "width": 120 + "width": 120, }, { "label": _("Purchase Amount"), "fieldname": "gross_purchase_amount", "fieldtype": "Currency", - "width": 120 + "width": 120, }, { "label": _("Depreciation Amount"), "fieldname": "depreciation_amount", "fieldtype": "Currency", - "width": 140 + "width": 140, }, { "label": _("Accumulated Depreciation Amount"), "fieldname": "accumulated_depreciation_amount", "fieldtype": "Currency", - "width": 210 + "width": 210, }, { "label": _("Amount After Depreciation"), "fieldname": "amount_after_depreciation", "fieldtype": "Currency", - "width": 180 + "width": 180, }, { "label": _("Depreciation Entry"), "fieldname": "depreciation_entry", "fieldtype": "Link", "options": "Journal Entry", - "width": 140 + "width": 140, }, { "label": _("Asset Category"), "fieldname": "asset_category", "fieldtype": "Link", "options": "Asset Category", - "width": 120 - }, - { - "label": _("Current Status"), - "fieldname": "status", - "fieldtype": "Data", - "width": 120 + "width": 120, }, + {"label": _("Current Status"), "fieldname": "status", "fieldtype": "Data", "width": 120}, { "label": _("Depreciation Method"), "fieldname": "depreciation_method", "fieldtype": "Data", - "width": 130 + "width": 130, }, - { - "label": _("Purchase Date"), - "fieldname": "purchase_date", - "fieldtype": "Date", - "width": 120 - } + {"label": _("Purchase Date"), "fieldname": "purchase_date", "fieldtype": "Date", "width": 120}, ] diff --git a/erpnext/accounts/report/asset_depreciations_and_balances/asset_depreciations_and_balances.py b/erpnext/accounts/report/asset_depreciations_and_balances/asset_depreciations_and_balances.py index 0f9435f4a57..ad9b1ba58eb 100644 --- a/erpnext/accounts/report/asset_depreciations_and_balances/asset_depreciations_and_balances.py +++ b/erpnext/accounts/report/asset_depreciations_and_balances/asset_depreciations_and_balances.py @@ -24,18 +24,33 @@ def get_data(filters): # row.asset_category = asset_category row.update(asset_category) - row.cost_as_on_to_date = (flt(row.cost_as_on_from_date) + flt(row.cost_of_new_purchase) - - flt(row.cost_of_sold_asset) - flt(row.cost_of_scrapped_asset)) + row.cost_as_on_to_date = ( + flt(row.cost_as_on_from_date) + + flt(row.cost_of_new_purchase) + - flt(row.cost_of_sold_asset) + - flt(row.cost_of_scrapped_asset) + ) - row.update(next(asset for asset in assets if asset["asset_category"] == asset_category.get("asset_category", ""))) - row.accumulated_depreciation_as_on_to_date = (flt(row.accumulated_depreciation_as_on_from_date) + - flt(row.depreciation_amount_during_the_period) - flt(row.depreciation_eliminated_during_the_period)) + row.update( + next( + asset + for asset in assets + if asset["asset_category"] == asset_category.get("asset_category", "") + ) + ) + row.accumulated_depreciation_as_on_to_date = ( + flt(row.accumulated_depreciation_as_on_from_date) + + flt(row.depreciation_amount_during_the_period) + - flt(row.depreciation_eliminated_during_the_period) + ) - row.net_asset_value_as_on_from_date = (flt(row.cost_as_on_from_date) - - flt(row.accumulated_depreciation_as_on_from_date)) + row.net_asset_value_as_on_from_date = flt(row.cost_as_on_from_date) - flt( + row.accumulated_depreciation_as_on_from_date + ) - row.net_asset_value_as_on_to_date = (flt(row.cost_as_on_to_date) - - flt(row.accumulated_depreciation_as_on_to_date)) + row.net_asset_value_as_on_to_date = flt(row.cost_as_on_to_date) - flt( + row.accumulated_depreciation_as_on_to_date + ) data.append(row) @@ -43,7 +58,8 @@ def get_data(filters): def get_asset_categories(filters): - return frappe.db.sql(""" + return frappe.db.sql( + """ SELECT asset_category, ifnull(sum(case when purchase_date < %(from_date)s then case when ifnull(disposal_date, 0) = 0 or disposal_date >= %(from_date)s then @@ -84,10 +100,15 @@ def get_asset_categories(filters): from `tabAsset` where docstatus=1 and company=%(company)s and purchase_date <= %(to_date)s group by asset_category - """, {"to_date": filters.to_date, "from_date": filters.from_date, "company": filters.company}, as_dict=1) + """, + {"to_date": filters.to_date, "from_date": filters.from_date, "company": filters.company}, + as_dict=1, + ) + def get_assets(filters): - return frappe.db.sql(""" + return frappe.db.sql( + """ SELECT results.asset_category, sum(results.accumulated_depreciation_as_on_from_date) as accumulated_depreciation_as_on_from_date, sum(results.depreciation_eliminated_during_the_period) as depreciation_eliminated_during_the_period, @@ -130,7 +151,10 @@ def get_assets(filters): where a.docstatus=1 and a.company=%(company)s and a.purchase_date <= %(to_date)s group by a.asset_category) as results group by results.asset_category - """, {"to_date": filters.to_date, "from_date": filters.from_date, "company": filters.company}, as_dict=1) + """, + {"to_date": filters.to_date, "from_date": filters.from_date, "company": filters.company}, + as_dict=1, + ) def get_columns(filters): @@ -140,72 +164,72 @@ def get_columns(filters): "fieldname": "asset_category", "fieldtype": "Link", "options": "Asset Category", - "width": 120 + "width": 120, }, { "label": _("Cost as on") + " " + formatdate(filters.day_before_from_date), "fieldname": "cost_as_on_from_date", "fieldtype": "Currency", - "width": 140 + "width": 140, }, { "label": _("Cost of New Purchase"), "fieldname": "cost_of_new_purchase", "fieldtype": "Currency", - "width": 140 + "width": 140, }, { "label": _("Cost of Sold Asset"), "fieldname": "cost_of_sold_asset", "fieldtype": "Currency", - "width": 140 + "width": 140, }, { "label": _("Cost of Scrapped Asset"), "fieldname": "cost_of_scrapped_asset", "fieldtype": "Currency", - "width": 140 + "width": 140, }, { "label": _("Cost as on") + " " + formatdate(filters.to_date), "fieldname": "cost_as_on_to_date", "fieldtype": "Currency", - "width": 140 + "width": 140, }, { "label": _("Accumulated Depreciation as on") + " " + formatdate(filters.day_before_from_date), "fieldname": "accumulated_depreciation_as_on_from_date", "fieldtype": "Currency", - "width": 270 + "width": 270, }, { "label": _("Depreciation Amount during the period"), "fieldname": "depreciation_amount_during_the_period", "fieldtype": "Currency", - "width": 240 + "width": 240, }, { "label": _("Depreciation Eliminated due to disposal of assets"), "fieldname": "depreciation_eliminated_during_the_period", "fieldtype": "Currency", - "width": 300 + "width": 300, }, { "label": _("Accumulated Depreciation as on") + " " + formatdate(filters.to_date), "fieldname": "accumulated_depreciation_as_on_to_date", "fieldtype": "Currency", - "width": 270 + "width": 270, }, { "label": _("Net Asset value as on") + " " + formatdate(filters.day_before_from_date), "fieldname": "net_asset_value_as_on_from_date", "fieldtype": "Currency", - "width": 200 + "width": 200, }, { "label": _("Net Asset value as on") + " " + formatdate(filters.to_date), "fieldname": "net_asset_value_as_on_to_date", "fieldtype": "Currency", - "width": 200 - } + "width": 200, + }, ] diff --git a/erpnext/accounts/report/balance_sheet/balance_sheet.py b/erpnext/accounts/report/balance_sheet/balance_sheet.py index dc1f7aae42e..7b1e9793266 100644 --- a/erpnext/accounts/report/balance_sheet/balance_sheet.py +++ b/erpnext/accounts/report/balance_sheet/balance_sheet.py @@ -15,26 +15,53 @@ from erpnext.accounts.report.financial_statements import ( def execute(filters=None): - period_list = get_period_list(filters.from_fiscal_year, filters.to_fiscal_year, - filters.period_start_date, filters.period_end_date, filters.filter_based_on, - filters.periodicity, company=filters.company) + period_list = get_period_list( + filters.from_fiscal_year, + filters.to_fiscal_year, + filters.period_start_date, + filters.period_end_date, + filters.filter_based_on, + filters.periodicity, + company=filters.company, + ) - currency = filters.presentation_currency or frappe.get_cached_value('Company', filters.company, "default_currency") + currency = filters.presentation_currency or frappe.get_cached_value( + "Company", filters.company, "default_currency" + ) - asset = get_data(filters.company, "Asset", "Debit", period_list, - only_current_fiscal_year=False, filters=filters, - accumulated_values=filters.accumulated_values) + asset = get_data( + filters.company, + "Asset", + "Debit", + period_list, + only_current_fiscal_year=False, + filters=filters, + accumulated_values=filters.accumulated_values, + ) - liability = get_data(filters.company, "Liability", "Credit", period_list, - only_current_fiscal_year=False, filters=filters, - accumulated_values=filters.accumulated_values) + liability = get_data( + filters.company, + "Liability", + "Credit", + period_list, + only_current_fiscal_year=False, + filters=filters, + accumulated_values=filters.accumulated_values, + ) - equity = get_data(filters.company, "Equity", "Credit", period_list, - only_current_fiscal_year=False, filters=filters, - accumulated_values=filters.accumulated_values) + equity = get_data( + filters.company, + "Equity", + "Credit", + period_list, + only_current_fiscal_year=False, + filters=filters, + accumulated_values=filters.accumulated_values, + ) - provisional_profit_loss, total_credit = get_provisional_profit_loss(asset, liability, equity, - period_list, filters.company, currency) + provisional_profit_loss, total_credit = get_provisional_profit_loss( + asset, liability, equity, period_list, filters.company, currency + ) message, opening_balance = check_opening_balance(asset, liability, equity) @@ -42,19 +69,19 @@ def execute(filters=None): data.extend(asset or []) data.extend(liability or []) data.extend(equity or []) - if opening_balance and round(opening_balance,2) !=0: - unclosed ={ + if opening_balance and round(opening_balance, 2) != 0: + unclosed = { "account_name": "'" + _("Unclosed Fiscal Years Profit / Loss (Credit)") + "'", "account": "'" + _("Unclosed Fiscal Years Profit / Loss (Credit)") + "'", "warn_if_negative": True, - "currency": currency + "currency": currency, } for period in period_list: unclosed[period.key] = opening_balance if provisional_profit_loss: provisional_profit_loss[period.key] = provisional_profit_loss[period.key] - opening_balance - unclosed["total"]=opening_balance + unclosed["total"] = opening_balance data.append(unclosed) if provisional_profit_loss: @@ -62,26 +89,32 @@ def execute(filters=None): if total_credit: data.append(total_credit) - columns = get_columns(filters.periodicity, period_list, filters.accumulated_values, company=filters.company) + columns = get_columns( + filters.periodicity, period_list, filters.accumulated_values, company=filters.company + ) chart = get_chart_data(filters, columns, asset, liability, equity) - report_summary = get_report_summary(period_list, asset, liability, equity, provisional_profit_loss, - total_credit, currency, filters) + report_summary = get_report_summary( + period_list, asset, liability, equity, provisional_profit_loss, total_credit, currency, filters + ) return columns, data, message, chart, report_summary -def get_provisional_profit_loss(asset, liability, equity, period_list, company, currency=None, consolidated=False): + +def get_provisional_profit_loss( + asset, liability, equity, period_list, company, currency=None, consolidated=False +): provisional_profit_loss = {} total_row = {} if asset and (liability or equity): - total = total_row_total=0 - currency = currency or frappe.get_cached_value('Company', company, "default_currency") + total = total_row_total = 0 + currency = currency or frappe.get_cached_value("Company", company, "default_currency") total_row = { "account_name": "'" + _("Total (Credit)") + "'", "account": "'" + _("Total (Credit)") + "'", "warn_if_negative": True, - "currency": currency + "currency": currency, } has_value = False @@ -106,41 +139,54 @@ def get_provisional_profit_loss(asset, liability, equity, period_list, company, total_row["total"] = total_row_total if has_value: - provisional_profit_loss.update({ - "account_name": "'" + _("Provisional Profit / Loss (Credit)") + "'", - "account": "'" + _("Provisional Profit / Loss (Credit)") + "'", - "warn_if_negative": True, - "currency": currency - }) + provisional_profit_loss.update( + { + "account_name": "'" + _("Provisional Profit / Loss (Credit)") + "'", + "account": "'" + _("Provisional Profit / Loss (Credit)") + "'", + "warn_if_negative": True, + "currency": currency, + } + ) return provisional_profit_loss, total_row + def check_opening_balance(asset, liability, equity): # Check if previous year balance sheet closed opening_balance = 0 float_precision = cint(frappe.db.get_default("float_precision")) or 2 if asset: - opening_balance = flt(asset[0].get("opening_balance", 0), float_precision) + opening_balance = flt(asset[-1].get("opening_balance", 0), float_precision) if liability: - opening_balance -= flt(liability[0].get("opening_balance", 0), float_precision) + opening_balance -= flt(liability[-1].get("opening_balance", 0), float_precision) if equity: - opening_balance -= flt(equity[0].get("opening_balance", 0), float_precision) + opening_balance -= flt(equity[-1].get("opening_balance", 0), float_precision) opening_balance = flt(opening_balance, float_precision) if opening_balance: - return _("Previous Financial Year is not closed"),opening_balance - return None,None + return _("Previous Financial Year is not closed"), opening_balance + return None, None -def get_report_summary(period_list, asset, liability, equity, provisional_profit_loss, total_credit, currency, - filters, consolidated=False): + +def get_report_summary( + period_list, + asset, + liability, + equity, + provisional_profit_loss, + total_credit, + currency, + filters, + consolidated=False, +): net_asset, net_liability, net_equity, net_provisional_profit_loss = 0.0, 0.0, 0.0, 0.0 - if filters.get('accumulated_values'): + if filters.get("accumulated_values"): period_list = [period_list[-1]] # from consolidated financial statement - if filters.get('accumulated_in_group_company'): + if filters.get("accumulated_in_group_company"): period_list = get_filtered_list_for_consolidated_report(filters, period_list) for period in period_list: @@ -155,33 +201,24 @@ def get_report_summary(period_list, asset, liability, equity, provisional_profit net_provisional_profit_loss += provisional_profit_loss.get(key) return [ - { - "value": net_asset, - "label": "Total Asset", - "datatype": "Currency", - "currency": currency - }, + {"value": net_asset, "label": "Total Asset", "datatype": "Currency", "currency": currency}, { "value": net_liability, "label": "Total Liability", "datatype": "Currency", - "currency": currency - }, - { - "value": net_equity, - "label": "Total Equity", - "datatype": "Currency", - "currency": currency + "currency": currency, }, + {"value": net_equity, "label": "Total Equity", "datatype": "Currency", "currency": currency}, { "value": net_provisional_profit_loss, "label": "Provisional Profit / Loss (Credit)", "indicator": "Green" if net_provisional_profit_loss > 0 else "Red", "datatype": "Currency", - "currency": currency - } + "currency": currency, + }, ] + def get_chart_data(filters, columns, asset, liability, equity): labels = [d.get("label") for d in columns[2:]] @@ -197,18 +234,13 @@ def get_chart_data(filters, columns, asset, liability, equity): datasets = [] if asset_data: - datasets.append({'name': _('Assets'), 'values': asset_data}) + datasets.append({"name": _("Assets"), "values": asset_data}) if liability_data: - datasets.append({'name': _('Liabilities'), 'values': liability_data}) + datasets.append({"name": _("Liabilities"), "values": liability_data}) if equity_data: - datasets.append({'name': _('Equity'), 'values': equity_data}) + datasets.append({"name": _("Equity"), "values": equity_data}) - chart = { - "data": { - 'labels': labels, - 'datasets': datasets - } - } + chart = {"data": {"labels": labels, "datasets": datasets}} if not filters.accumulated_values: chart["type"] = "bar" diff --git a/erpnext/accounts/report/bank_clearance_summary/bank_clearance_summary.py b/erpnext/accounts/report/bank_clearance_summary/bank_clearance_summary.py index b456e89f344..9d2deea523b 100644 --- a/erpnext/accounts/report/bank_clearance_summary/bank_clearance_summary.py +++ b/erpnext/accounts/report/bank_clearance_summary/bank_clearance_summary.py @@ -8,86 +8,88 @@ from frappe.utils import getdate, nowdate def execute(filters=None): - if not filters: filters = {} + if not filters: + filters = {} columns = get_columns() data = get_entries(filters) return columns, data + def get_columns(): - columns = [{ + columns = [ + { "label": _("Payment Document Type"), "fieldname": "payment_document_type", "fieldtype": "Link", "options": "Doctype", - "width": 130 + "width": 130, }, { "label": _("Payment Entry"), "fieldname": "payment_entry", "fieldtype": "Dynamic Link", "options": "payment_document_type", - "width": 140 - }, - { - "label": _("Posting Date"), - "fieldname": "posting_date", - "fieldtype": "Date", - "width": 100 - }, - { - "label": _("Cheque/Reference No"), - "fieldname": "cheque_no", - "width": 120 - }, - { - "label": _("Clearance Date"), - "fieldname": "clearance_date", - "fieldtype": "Date", - "width": 100 + "width": 140, }, + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 100}, + {"label": _("Cheque/Reference No"), "fieldname": "cheque_no", "width": 120}, + {"label": _("Clearance Date"), "fieldname": "clearance_date", "fieldtype": "Date", "width": 100}, { "label": _("Against Account"), "fieldname": "against", "fieldtype": "Link", "options": "Account", - "width": 170 + "width": 170, }, - { - "label": _("Amount"), - "fieldname": "amount", - "width": 120 - }] + {"label": _("Amount"), "fieldname": "amount", "fieldtype": "Currency", "width": 120}, + ] return columns + def get_conditions(filters): conditions = "" - if filters.get("from_date"): conditions += " and posting_date>=%(from_date)s" - if filters.get("to_date"): conditions += " and posting_date<=%(to_date)s" + if filters.get("from_date"): + conditions += " and posting_date>=%(from_date)s" + if filters.get("to_date"): + conditions += " and posting_date<=%(to_date)s" return conditions + def get_entries(filters): conditions = get_conditions(filters) - journal_entries = frappe.db.sql("""SELECT + journal_entries = frappe.db.sql( + """SELECT "Journal Entry", jv.name, jv.posting_date, jv.cheque_no, jv.clearance_date, jvd.against_account, jvd.debit - jvd.credit FROM `tabJournal Entry Account` jvd, `tabJournal Entry` jv WHERE jvd.parent = jv.name and jv.docstatus=1 and jvd.account = %(account)s {0} - order by posting_date DESC, jv.name DESC""".format(conditions), filters, as_list=1) + order by posting_date DESC, jv.name DESC""".format( + conditions + ), + filters, + as_list=1, + ) - payment_entries = frappe.db.sql("""SELECT + payment_entries = frappe.db.sql( + """SELECT "Payment Entry", name, posting_date, reference_no, clearance_date, party, if(paid_from=%(account)s, paid_amount * -1, received_amount) FROM `tabPayment Entry` WHERE docstatus=1 and (paid_from = %(account)s or paid_to = %(account)s) {0} - order by posting_date DESC, name DESC""".format(conditions), filters, as_list=1) + order by posting_date DESC, name DESC""".format( + conditions + ), + filters, + as_list=1, + ) return sorted(journal_entries + payment_entries, key=lambda k: k[2] or getdate(nowdate())) diff --git a/erpnext/accounts/report/bank_reconciliation_statement/bank_reconciliation_statement.py b/erpnext/accounts/report/bank_reconciliation_statement/bank_reconciliation_statement.py index 6c401fb8f3b..c41d0d10ffe 100644 --- a/erpnext/accounts/report/bank_reconciliation_statement/bank_reconciliation_statement.py +++ b/erpnext/accounts/report/bank_reconciliation_statement/bank_reconciliation_statement.py @@ -4,121 +4,134 @@ import frappe from frappe import _ -from frappe.utils import flt, getdate, nowdate +from frappe.query_builder.custom import ConstantColumn +from frappe.query_builder.functions import Sum +from frappe.utils import flt, getdate +from pypika import CustomFunction + +from erpnext.accounts.utils import get_balance_on def execute(filters=None): - if not filters: filters = {} + if not filters: + filters = {} columns = get_columns() - if not filters.get("account"): return columns, [] + if not filters.get("account"): + return columns, [] account_currency = frappe.db.get_value("Account", filters.account, "account_currency") data = get_entries(filters) - from erpnext.accounts.utils import get_balance_on balance_as_per_system = get_balance_on(filters["account"], filters["report_date"]) - total_debit, total_credit = 0,0 + total_debit, total_credit = 0, 0 for d in data: total_debit += flt(d.debit) total_credit += flt(d.credit) amounts_not_reflected_in_system = get_amounts_not_reflected_in_system(filters) - bank_bal = flt(balance_as_per_system) - flt(total_debit) + flt(total_credit) \ + bank_bal = ( + flt(balance_as_per_system) + - flt(total_debit) + + flt(total_credit) + amounts_not_reflected_in_system + ) data += [ - get_balance_row(_("Bank Statement balance as per General Ledger"), balance_as_per_system, account_currency), + get_balance_row( + _("Bank Statement balance as per General Ledger"), balance_as_per_system, account_currency + ), {}, { "payment_entry": _("Outstanding Cheques and Deposits to clear"), "debit": total_debit, "credit": total_credit, - "account_currency": account_currency + "account_currency": account_currency, }, - get_balance_row(_("Cheques and Deposits incorrectly cleared"), amounts_not_reflected_in_system, - account_currency), + get_balance_row( + _("Cheques and Deposits incorrectly cleared"), amounts_not_reflected_in_system, account_currency + ), {}, - get_balance_row(_("Calculated Bank Statement balance"), bank_bal, account_currency) + get_balance_row(_("Calculated Bank Statement balance"), bank_bal, account_currency), ] return columns, data + def get_columns(): return [ - { - "fieldname": "posting_date", - "label": _("Posting Date"), - "fieldtype": "Date", - "width": 90 - }, + {"fieldname": "posting_date", "label": _("Posting Date"), "fieldtype": "Date", "width": 90}, { "fieldname": "payment_document", "label": _("Payment Document Type"), "fieldtype": "Data", - "width": 220 + "width": 220, }, { "fieldname": "payment_entry", "label": _("Payment Document"), "fieldtype": "Dynamic Link", "options": "payment_document", - "width": 220 + "width": 220, }, { "fieldname": "debit", "label": _("Debit"), "fieldtype": "Currency", "options": "account_currency", - "width": 120 + "width": 120, }, { "fieldname": "credit", "label": _("Credit"), "fieldtype": "Currency", "options": "account_currency", - "width": 120 + "width": 120, }, { "fieldname": "against_account", "label": _("Against Account"), "fieldtype": "Link", "options": "Account", - "width": 200 - }, - { - "fieldname": "reference_no", - "label": _("Reference"), - "fieldtype": "Data", - "width": 100 - }, - { - "fieldname": "ref_date", - "label": _("Ref Date"), - "fieldtype": "Date", - "width": 110 - }, - { - "fieldname": "clearance_date", - "label": _("Clearance Date"), - "fieldtype": "Date", - "width": 110 + "width": 200, }, + {"fieldname": "reference_no", "label": _("Reference"), "fieldtype": "Data", "width": 100}, + {"fieldname": "ref_date", "label": _("Ref Date"), "fieldtype": "Date", "width": 110}, + {"fieldname": "clearance_date", "label": _("Clearance Date"), "fieldtype": "Date", "width": 110}, { "fieldname": "account_currency", "label": _("Currency"), "fieldtype": "Link", "options": "Currency", - "width": 100 - } + "width": 100, + }, ] + def get_entries(filters): - journal_entries = frappe.db.sql(""" + journal_entries = get_journal_entries(filters) + + payment_entries = get_payment_entries(filters) + + loan_entries = get_loan_entries(filters) + + pos_entries = [] + if filters.include_pos_transactions: + pos_entries = get_pos_entries(filters) + + return sorted( + list(payment_entries) + list(journal_entries + list(pos_entries) + list(loan_entries)), + key=lambda k: getdate(k["posting_date"]), + ) + + +def get_journal_entries(filters): + return frappe.db.sql( + """ select "Journal Entry" as payment_document, jv.posting_date, jv.name as payment_entry, jvd.debit_in_account_currency as debit, jvd.credit_in_account_currency as credit, jvd.against_account, @@ -128,9 +141,15 @@ def get_entries(filters): where jvd.parent = jv.name and jv.docstatus=1 and jvd.account = %(account)s and jv.posting_date <= %(report_date)s and ifnull(jv.clearance_date, '4000-01-01') > %(report_date)s - and ifnull(jv.is_opening, 'No') = 'No'""", filters, as_dict=1) + and ifnull(jv.is_opening, 'No') = 'No'""", + filters, + as_dict=1, + ) - payment_entries = frappe.db.sql(""" + +def get_payment_entries(filters): + return frappe.db.sql( + """ select "Payment Entry" as payment_document, name as payment_entry, reference_no, reference_date as ref_date, @@ -143,11 +162,15 @@ def get_entries(filters): (paid_from=%(account)s or paid_to=%(account)s) and docstatus=1 and posting_date <= %(report_date)s and ifnull(clearance_date, '4000-01-01') > %(report_date)s - """, filters, as_dict=1) + """, + filters, + as_dict=1, + ) - pos_entries = [] - if filters.include_pos_transactions: - pos_entries = frappe.db.sql(""" + +def get_pos_entries(filters): + return frappe.db.sql( + """ select "Sales Invoice Payment" as payment_document, sip.name as payment_entry, sip.amount as debit, si.posting_date, si.debit_to as against_account, sip.clearance_date, @@ -159,30 +182,112 @@ def get_entries(filters): ifnull(sip.clearance_date, '4000-01-01') > %(report_date)s order by si.posting_date ASC, si.name DESC - """, filters, as_dict=1) + """, + filters, + as_dict=1, + ) + + +def get_loan_entries(filters): + loan_docs = [] + for doctype in ["Loan Disbursement", "Loan Repayment"]: + loan_doc = frappe.qb.DocType(doctype) + ifnull = CustomFunction("IFNULL", ["value", "default"]) + + if doctype == "Loan Disbursement": + amount_field = (loan_doc.disbursed_amount).as_("credit") + posting_date = (loan_doc.disbursement_date).as_("posting_date") + account = loan_doc.disbursement_account + salary_condition = loan_doc.docstatus == 1 + else: + amount_field = (loan_doc.amount_paid).as_("debit") + posting_date = (loan_doc.posting_date).as_("posting_date") + account = loan_doc.payment_account + salary_condition = loan_doc.repay_from_salary == 0 + + query = ( + frappe.qb.from_(loan_doc) + .select( + ConstantColumn(doctype).as_("payment_document"), + (loan_doc.name).as_("payment_entry"), + (loan_doc.reference_number).as_("reference_no"), + (loan_doc.reference_date).as_("ref_date"), + amount_field, + posting_date, + ) + .where(loan_doc.docstatus == 1) + .where(salary_condition) + .where(account == filters.get("account")) + .where(posting_date <= getdate(filters.get("report_date"))) + .where(ifnull(loan_doc.clearance_date, "4000-01-01") > getdate(filters.get("report_date"))) + ) + + entries = query.run(as_dict=1) + loan_docs.extend(entries) + + return loan_docs - return sorted(list(payment_entries)+list(journal_entries+list(pos_entries)), - key=lambda k: k['posting_date'] or getdate(nowdate())) def get_amounts_not_reflected_in_system(filters): - je_amount = frappe.db.sql(""" + je_amount = frappe.db.sql( + """ select sum(jvd.debit_in_account_currency - jvd.credit_in_account_currency) from `tabJournal Entry Account` jvd, `tabJournal Entry` jv where jvd.parent = jv.name and jv.docstatus=1 and jvd.account=%(account)s and jv.posting_date > %(report_date)s and jv.clearance_date <= %(report_date)s - and ifnull(jv.is_opening, 'No') = 'No' """, filters) + and ifnull(jv.is_opening, 'No') = 'No' """, + filters, + ) je_amount = flt(je_amount[0][0]) if je_amount else 0.0 - pe_amount = frappe.db.sql(""" + pe_amount = frappe.db.sql( + """ select sum(if(paid_from=%(account)s, paid_amount, received_amount)) from `tabPayment Entry` where (paid_from=%(account)s or paid_to=%(account)s) and docstatus=1 - and posting_date > %(report_date)s and clearance_date <= %(report_date)s""", filters) + and posting_date > %(report_date)s and clearance_date <= %(report_date)s""", + filters, + ) pe_amount = flt(pe_amount[0][0]) if pe_amount else 0.0 - return je_amount + pe_amount + loan_amount = get_loan_amount(filters) + + return je_amount + pe_amount + loan_amount + + +def get_loan_amount(filters): + total_amount = 0 + for doctype in ["Loan Disbursement", "Loan Repayment"]: + loan_doc = frappe.qb.DocType(doctype) + ifnull = CustomFunction("IFNULL", ["value", "default"]) + + if doctype == "Loan Disbursement": + amount_field = Sum(loan_doc.disbursed_amount) + posting_date = (loan_doc.disbursement_date).as_("posting_date") + account = loan_doc.disbursement_account + salary_condition = loan_doc.docstatus == 1 + else: + amount_field = Sum(loan_doc.amount_paid) + posting_date = (loan_doc.posting_date).as_("posting_date") + account = loan_doc.payment_account + salary_condition = loan_doc.repay_from_salary == 0 + amount = ( + frappe.qb.from_(loan_doc) + .select(amount_field) + .where(loan_doc.docstatus == 1) + .where(salary_condition) + .where(account == filters.get("account")) + .where(posting_date > getdate(filters.get("report_date"))) + .where(ifnull(loan_doc.clearance_date, "4000-01-01") <= getdate(filters.get("report_date"))) + .run()[0][0] + ) + + total_amount += flt(amount) + + return total_amount + def get_balance_row(label, amount, account_currency): if amount > 0: @@ -190,12 +295,12 @@ def get_balance_row(label, amount, account_currency): "payment_entry": label, "debit": amount, "credit": 0, - "account_currency": account_currency + "account_currency": account_currency, } else: return { "payment_entry": label, "debit": 0, "credit": abs(amount), - "account_currency": account_currency + "account_currency": account_currency, } diff --git a/erpnext/accounts/report/billed_items_to_be_received/billed_items_to_be_received.py b/erpnext/accounts/report/billed_items_to_be_received/billed_items_to_be_received.py index 1d7463c8920..62bee82590b 100644 --- a/erpnext/accounts/report/billed_items_to_be_received/billed_items_to_be_received.py +++ b/erpnext/accounts/report/billed_items_to_be_received/billed_items_to_be_received.py @@ -12,97 +12,70 @@ def execute(filters=None): return columns, data + def get_data(report_filters): filters = get_report_filters(report_filters) fields = get_report_fields() - return frappe.get_all('Purchase Invoice', - fields= fields, filters=filters) + return frappe.get_all("Purchase Invoice", fields=fields, filters=filters) + def get_report_filters(report_filters): - filters = [['Purchase Invoice','company','=',report_filters.get('company')], - ['Purchase Invoice','posting_date','<=',report_filters.get('posting_date')], ['Purchase Invoice','docstatus','=',1], - ['Purchase Invoice','per_received','<',100], ['Purchase Invoice','update_stock','=',0]] + filters = [ + ["Purchase Invoice", "company", "=", report_filters.get("company")], + ["Purchase Invoice", "posting_date", "<=", report_filters.get("posting_date")], + ["Purchase Invoice", "docstatus", "=", 1], + ["Purchase Invoice", "per_received", "<", 100], + ["Purchase Invoice", "update_stock", "=", 0], + ] - if report_filters.get('purchase_invoice'): - filters.append(['Purchase Invoice','per_received','in',[report_filters.get('purchase_invoice')]]) + if report_filters.get("purchase_invoice"): + filters.append( + ["Purchase Invoice", "per_received", "in", [report_filters.get("purchase_invoice")]] + ) return filters + def get_report_fields(): fields = [] - for p_field in ['name', 'supplier', 'company', 'posting_date', 'currency']: - fields.append('`tabPurchase Invoice`.`{}`'.format(p_field)) + for p_field in ["name", "supplier", "company", "posting_date", "currency"]: + fields.append("`tabPurchase Invoice`.`{}`".format(p_field)) - for c_field in ['item_code', 'item_name', 'uom', 'qty', 'received_qty', 'rate', 'amount']: - fields.append('`tabPurchase Invoice Item`.`{}`'.format(c_field)) + for c_field in ["item_code", "item_name", "uom", "qty", "received_qty", "rate", "amount"]: + fields.append("`tabPurchase Invoice Item`.`{}`".format(c_field)) return fields + def get_columns(): return [ { - 'label': _('Purchase Invoice'), - 'fieldname': 'name', - 'fieldtype': 'Link', - 'options': 'Purchase Invoice', - 'width': 170 + "label": _("Purchase Invoice"), + "fieldname": "name", + "fieldtype": "Link", + "options": "Purchase Invoice", + "width": 170, }, { - 'label': _('Supplier'), - 'fieldname': 'supplier', - 'fieldtype': 'Link', - 'options': 'Supplier', - 'width': 120 + "label": _("Supplier"), + "fieldname": "supplier", + "fieldtype": "Link", + "options": "Supplier", + "width": 120, }, + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 100}, { - 'label': _('Posting Date'), - 'fieldname': 'posting_date', - 'fieldtype': 'Date', - 'width': 100 + "label": _("Item Code"), + "fieldname": "item_code", + "fieldtype": "Link", + "options": "Item", + "width": 100, }, - { - 'label': _('Item Code'), - 'fieldname': 'item_code', - 'fieldtype': 'Link', - 'options': 'Item', - 'width': 100 - }, - { - 'label': _('Item Name'), - 'fieldname': 'item_name', - 'fieldtype': 'Data', - 'width': 100 - }, - { - 'label': _('UOM'), - 'fieldname': 'uom', - 'fieldtype': 'Link', - 'options': 'UOM', - 'width': 100 - }, - { - 'label': _('Invoiced Qty'), - 'fieldname': 'qty', - 'fieldtype': 'Float', - 'width': 100 - }, - { - 'label': _('Received Qty'), - 'fieldname': 'received_qty', - 'fieldtype': 'Float', - 'width': 100 - }, - { - 'label': _('Rate'), - 'fieldname': 'rate', - 'fieldtype': 'Currency', - 'width': 100 - }, - { - 'label': _('Amount'), - 'fieldname': 'amount', - 'fieldtype': 'Currency', - 'width': 100 - } + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 100}, + {"label": _("UOM"), "fieldname": "uom", "fieldtype": "Link", "options": "UOM", "width": 100}, + {"label": _("Invoiced Qty"), "fieldname": "qty", "fieldtype": "Float", "width": 100}, + {"label": _("Received Qty"), "fieldname": "received_qty", "fieldtype": "Float", "width": 100}, + {"label": _("Rate"), "fieldname": "rate", "fieldtype": "Currency", "width": 100}, + {"label": _("Amount"), "fieldname": "amount", "fieldtype": "Currency", "width": 100}, ] diff --git a/erpnext/accounts/report/budget_variance_report/budget_variance_report.py b/erpnext/accounts/report/budget_variance_report/budget_variance_report.py index ead67766785..95159476f2d 100644 --- a/erpnext/accounts/report/budget_variance_report/budget_variance_report.py +++ b/erpnext/accounts/report/budget_variance_report/budget_variance_report.py @@ -31,22 +31,28 @@ def execute(filters=None): if dimension_items: data = get_final_data(dimension, dimension_items, filters, period_month_ranges, data, 0) else: - DCC_allocation = frappe.db.sql('''SELECT parent, sum(percentage_allocation) as percentage_allocation + DCC_allocation = frappe.db.sql( + """SELECT parent, sum(percentage_allocation) as percentage_allocation FROM `tabDistributed Cost Center` WHERE cost_center IN %(dimension)s AND parent NOT IN %(dimension)s - GROUP BY parent''',{'dimension':[dimension]}) + GROUP BY parent""", + {"dimension": [dimension]}, + ) if DCC_allocation: - filters['budget_against_filter'] = [DCC_allocation[0][0]] + filters["budget_against_filter"] = [DCC_allocation[0][0]] ddc_cam_map = get_dimension_account_month_map(filters) dimension_items = ddc_cam_map.get(DCC_allocation[0][0]) if dimension_items: - data = get_final_data(dimension, dimension_items, filters, period_month_ranges, data, DCC_allocation[0][1]) + data = get_final_data( + dimension, dimension_items, filters, period_month_ranges, data, DCC_allocation[0][1] + ) chart = get_chart_data(filters, columns, data) return columns, data, None, chart + def get_final_data(dimension, dimension_items, filters, period_month_ranges, data, DCC_allocation): for account, monthwise_data in iteritems(dimension_items): row = [dimension, account] @@ -66,16 +72,16 @@ def get_final_data(dimension, dimension_items, filters, period_month_ranges, dat period_data[0] += last_total if DCC_allocation: - period_data[0] = period_data[0]*(DCC_allocation/100) - period_data[1] = period_data[1]*(DCC_allocation/100) + period_data[0] = period_data[0] * (DCC_allocation / 100) + period_data[1] = period_data[1] * (DCC_allocation / 100) - if(filters.get("show_cumulative")): + if filters.get("show_cumulative"): last_total = period_data[0] - period_data[1] period_data[2] = period_data[0] - period_data[1] row += period_data totals[2] = totals[0] - totals[1] - if filters["period"] != "Yearly" : + if filters["period"] != "Yearly": row += totals data.append(row) @@ -85,19 +91,19 @@ def get_final_data(dimension, dimension_items, filters, period_month_ranges, dat def get_columns(filters): columns = [ { - 'label': _(filters.get("budget_against")), - 'fieldtype': 'Link', - 'fieldname': 'budget_against', - 'options': filters.get('budget_against'), - 'width': 150 + "label": _(filters.get("budget_against")), + "fieldtype": "Link", + "fieldname": "budget_against", + "options": filters.get("budget_against"), + "width": 150, }, { - 'label': _('Account'), - 'fieldname': 'Account', - 'fieldtype': 'Link', - 'options': 'Account', - 'width': 150 - } + "label": _("Account"), + "fieldname": "Account", + "fieldtype": "Link", + "options": "Account", + "width": 150, + }, ] group_months = False if filters["period"] == "Monthly" else True @@ -110,45 +116,34 @@ def get_columns(filters): labels = [ _("Budget") + " " + str(year[0]), _("Actual ") + " " + str(year[0]), - _("Variance ") + " " + str(year[0]) + _("Variance ") + " " + str(year[0]), ] for label in labels: - columns.append({ - 'label': label, - 'fieldtype': 'Float', - 'fieldname': frappe.scrub(label), - 'width': 150 - }) + columns.append( + {"label": label, "fieldtype": "Float", "fieldname": frappe.scrub(label), "width": 150} + ) else: for label in [ _("Budget") + " (%s)" + " " + str(year[0]), _("Actual") + " (%s)" + " " + str(year[0]), - _("Variance") + " (%s)" + " " + str(year[0]) + _("Variance") + " (%s)" + " " + str(year[0]), ]: if group_months: label = label % ( - formatdate(from_date, format_string="MMM") - + "-" - + formatdate(to_date, format_string="MMM") + formatdate(from_date, format_string="MMM") + "-" + formatdate(to_date, format_string="MMM") ) else: label = label % formatdate(from_date, format_string="MMM") - columns.append({ - 'label': label, - 'fieldtype': 'Float', - 'fieldname': frappe.scrub(label), - 'width': 150 - }) + columns.append( + {"label": label, "fieldtype": "Float", "fieldname": frappe.scrub(label), "width": 150} + ) if filters["period"] != "Yearly": for label in [_("Total Budget"), _("Total Actual"), _("Total Variance")]: - columns.append({ - 'label': label, - 'fieldtype': 'Float', - 'fieldname': frappe.scrub(label), - 'width': 150 - }) + columns.append( + {"label": label, "fieldtype": "Float", "fieldname": frappe.scrub(label), "width": 150} + ) return columns else: @@ -170,8 +165,11 @@ def get_cost_centers(filters): where company = %s {order_by} - """.format(tab=filters.get("budget_against"), order_by=order_by), - filters.get("company")) + """.format( + tab=filters.get("budget_against"), order_by=order_by + ), + filters.get("company"), + ) else: return frappe.db.sql_list( """ @@ -179,7 +177,10 @@ def get_cost_centers(filters): name from `tab{tab}` - """.format(tab=filters.get("budget_against"))) # nosec + """.format( + tab=filters.get("budget_against") + ) + ) # nosec # Get dimension & target details @@ -187,8 +188,9 @@ def get_dimension_target_details(filters): budget_against = frappe.scrub(filters.get("budget_against")) cond = "" if filters.get("budget_against_filter"): - cond += """ and b.{budget_against} in (%s)""".format( - budget_against=budget_against) % ", ".join(["%s"] * len(filters.get("budget_against_filter"))) + cond += """ and b.{budget_against} in (%s)""".format(budget_against=budget_against) % ", ".join( + ["%s"] * len(filters.get("budget_against_filter")) + ) return frappe.db.sql( """ @@ -222,7 +224,9 @@ def get_dimension_target_details(filters): filters.company, ] + (filters.get("budget_against_filter") or []) - ), as_dict=True) + ), + as_dict=True, + ) # Get target distribution details of accounts of cost center @@ -243,13 +247,14 @@ def get_target_distribution_details(filters): order by md.fiscal_year """, - (filters.from_fiscal_year, filters.to_fiscal_year), as_dict=1): - target_details.setdefault(d.name, {}).setdefault( - d.month, flt(d.percentage_allocation) - ) + (filters.from_fiscal_year, filters.to_fiscal_year), + as_dict=1, + ): + target_details.setdefault(d.name, {}).setdefault(d.month, flt(d.percentage_allocation)) return target_details + # Get actual details from gl entry def get_actual_details(name, filters): budget_against = frappe.scrub(filters.get("budget_against")) @@ -260,7 +265,9 @@ def get_actual_details(name, filters): cond = """ and lft >= "{lft}" and rgt <= "{rgt}" - """.format(lft=cc_lft, rgt=cc_rgt) + """.format( + lft=cc_lft, rgt=cc_rgt + ) ac_details = frappe.db.sql( """ @@ -294,8 +301,12 @@ def get_actual_details(name, filters): group by gl.name order by gl.fiscal_year - """.format(tab=filters.budget_against, budget_against=budget_against, cond=cond), - (filters.from_fiscal_year, filters.to_fiscal_year, name), as_dict=1) + """.format( + tab=filters.budget_against, budget_against=budget_against, cond=cond + ), + (filters.from_fiscal_year, filters.to_fiscal_year, name), + as_dict=1, + ) cc_actual_details = {} for d in ac_details: @@ -303,6 +314,7 @@ def get_actual_details(name, filters): return cc_actual_details + def get_dimension_account_month_map(filters): dimension_target_details = get_dimension_target_details(filters) tdd = get_target_distribution_details(filters) @@ -314,17 +326,13 @@ def get_dimension_account_month_map(filters): for month_id in range(1, 13): month = datetime.date(2013, month_id, 1).strftime("%B") - cam_map.setdefault(ccd.budget_against, {}).setdefault( - ccd.account, {} - ).setdefault(ccd.fiscal_year, {}).setdefault( - month, frappe._dict({"target": 0.0, "actual": 0.0}) - ) + cam_map.setdefault(ccd.budget_against, {}).setdefault(ccd.account, {}).setdefault( + ccd.fiscal_year, {} + ).setdefault(month, frappe._dict({"target": 0.0, "actual": 0.0})) tav_dict = cam_map[ccd.budget_against][ccd.account][ccd.fiscal_year][month] month_percentage = ( - tdd.get(ccd.monthly_distribution, {}).get(month, 0) - if ccd.monthly_distribution - else 100.0 / 12 + tdd.get(ccd.monthly_distribution, {}).get(month, 0) if ccd.monthly_distribution else 100.0 / 12 ) tav_dict.target = flt(ccd.budget_amount) * month_percentage / 100 @@ -347,13 +355,12 @@ def get_fiscal_years(filters): where name between %(from_fiscal_year)s and %(to_fiscal_year)s """, - { - "from_fiscal_year": filters["from_fiscal_year"], - "to_fiscal_year": filters["to_fiscal_year"] - }) + {"from_fiscal_year": filters["from_fiscal_year"], "to_fiscal_year": filters["to_fiscal_year"]}, + ) return fiscal_year + def get_chart_data(filters, columns, data): if not data: @@ -366,12 +373,13 @@ def get_chart_data(filters, columns, data): for year in fiscal_year: for from_date, to_date in get_period_date_ranges(filters["period"], year[0]): - if filters['period'] == 'Yearly': + if filters["period"] == "Yearly": labels.append(year[0]) else: if group_months: - label = formatdate(from_date, format_string="MMM") + "-" \ - + formatdate(to_date, format_string="MMM") + label = ( + formatdate(from_date, format_string="MMM") + "-" + formatdate(to_date, format_string="MMM") + ) labels.append(label) else: label = formatdate(from_date, format_string="MMM") @@ -386,16 +394,16 @@ def get_chart_data(filters, columns, data): for i in range(no_of_columns): budget_values[i] += values[index] - actual_values[i] += values[index+1] + actual_values[i] += values[index + 1] index += 3 return { - 'data': { - 'labels': labels, - 'datasets': [ - {'name': 'Budget', 'chartType': 'bar', 'values': budget_values}, - {'name': 'Actual Expense', 'chartType': 'bar', 'values': actual_values} - ] + "data": { + "labels": labels, + "datasets": [ + {"name": "Budget", "chartType": "bar", "values": budget_values}, + {"name": "Actual Expense", "chartType": "bar", "values": actual_values}, + ], }, - 'type' : 'bar' + "type": "bar", } diff --git a/erpnext/accounts/report/cash_flow/cash_flow.py b/erpnext/accounts/report/cash_flow/cash_flow.py index 75365b81f22..ee924f86a6a 100644 --- a/erpnext/accounts/report/cash_flow/cash_flow.py +++ b/erpnext/accounts/report/cash_flow/cash_flow.py @@ -20,65 +20,103 @@ from erpnext.accounts.utils import get_fiscal_year def execute(filters=None): - if cint(frappe.db.get_single_value('Accounts Settings', 'use_custom_cash_flow')): + if cint(frappe.db.get_single_value("Accounts Settings", "use_custom_cash_flow")): from erpnext.accounts.report.cash_flow.custom_cash_flow import execute as execute_custom + return execute_custom(filters=filters) - period_list = get_period_list(filters.from_fiscal_year, filters.to_fiscal_year, - filters.period_start_date, filters.period_end_date, filters.filter_based_on, - filters.periodicity, company=filters.company) + period_list = get_period_list( + filters.from_fiscal_year, + filters.to_fiscal_year, + filters.period_start_date, + filters.period_end_date, + filters.filter_based_on, + filters.periodicity, + company=filters.company, + ) cash_flow_accounts = get_cash_flow_accounts() # compute net profit / loss - income = get_data(filters.company, "Income", "Credit", period_list, filters=filters, - accumulated_values=filters.accumulated_values, ignore_closing_entries=True, ignore_accumulated_values_for_fy= True) - expense = get_data(filters.company, "Expense", "Debit", period_list, filters=filters, - accumulated_values=filters.accumulated_values, ignore_closing_entries=True, ignore_accumulated_values_for_fy= True) + income = get_data( + filters.company, + "Income", + "Credit", + period_list, + filters=filters, + accumulated_values=filters.accumulated_values, + ignore_closing_entries=True, + ignore_accumulated_values_for_fy=True, + ) + expense = get_data( + filters.company, + "Expense", + "Debit", + period_list, + filters=filters, + accumulated_values=filters.accumulated_values, + ignore_closing_entries=True, + ignore_accumulated_values_for_fy=True, + ) net_profit_loss = get_net_profit_loss(income, expense, period_list, filters.company) data = [] summary_data = {} - company_currency = frappe.get_cached_value('Company', filters.company, "default_currency") + company_currency = frappe.get_cached_value("Company", filters.company, "default_currency") for cash_flow_account in cash_flow_accounts: section_data = [] - data.append({ - "account_name": cash_flow_account['section_header'], - "parent_account": None, - "indent": 0.0, - "account": cash_flow_account['section_header'] - }) + data.append( + { + "account_name": cash_flow_account["section_header"], + "parent_account": None, + "indent": 0.0, + "account": cash_flow_account["section_header"], + } + ) if len(data) == 1: # add first net income in operations section if net_profit_loss: - net_profit_loss.update({ - "indent": 1, - "parent_account": cash_flow_accounts[0]['section_header'] - }) + net_profit_loss.update( + {"indent": 1, "parent_account": cash_flow_accounts[0]["section_header"]} + ) data.append(net_profit_loss) section_data.append(net_profit_loss) - for account in cash_flow_account['account_types']: - account_data = get_account_type_based_data(filters.company, - account['account_type'], period_list, filters.accumulated_values, filters) - account_data.update({ - "account_name": account['label'], - "account": account['label'], - "indent": 1, - "parent_account": cash_flow_account['section_header'], - "currency": company_currency - }) + for account in cash_flow_account["account_types"]: + account_data = get_account_type_based_data( + filters.company, account["account_type"], period_list, filters.accumulated_values, filters + ) + account_data.update( + { + "account_name": account["label"], + "account": account["label"], + "indent": 1, + "parent_account": cash_flow_account["section_header"], + "currency": company_currency, + } + ) data.append(account_data) section_data.append(account_data) - add_total_row_account(data, section_data, cash_flow_account['section_footer'], - period_list, company_currency, summary_data, filters) + add_total_row_account( + data, + section_data, + cash_flow_account["section_footer"], + period_list, + company_currency, + summary_data, + filters, + ) - add_total_row_account(data, data, _("Net Change in Cash"), period_list, company_currency, summary_data, filters) - columns = get_columns(filters.periodicity, period_list, filters.accumulated_values, filters.company) + add_total_row_account( + data, data, _("Net Change in Cash"), period_list, company_currency, summary_data, filters + ) + columns = get_columns( + filters.periodicity, period_list, filters.accumulated_values, filters.company + ) chart = get_chart_data(columns, data) @@ -86,6 +124,7 @@ def execute(filters=None): return columns, data, None, chart, report_summary + def get_cash_flow_accounts(): operation_accounts = { "section_name": "Operations", @@ -95,39 +134,37 @@ def get_cash_flow_accounts(): {"account_type": "Depreciation", "label": _("Depreciation")}, {"account_type": "Receivable", "label": _("Net Change in Accounts Receivable")}, {"account_type": "Payable", "label": _("Net Change in Accounts Payable")}, - {"account_type": "Stock", "label": _("Net Change in Inventory")} - ] + {"account_type": "Stock", "label": _("Net Change in Inventory")}, + ], } investing_accounts = { "section_name": "Investing", "section_footer": _("Net Cash from Investing"), "section_header": _("Cash Flow from Investing"), - "account_types": [ - {"account_type": "Fixed Asset", "label": _("Net Change in Fixed Asset")} - ] + "account_types": [{"account_type": "Fixed Asset", "label": _("Net Change in Fixed Asset")}], } financing_accounts = { "section_name": "Financing", "section_footer": _("Net Cash from Financing"), "section_header": _("Cash Flow from Financing"), - "account_types": [ - {"account_type": "Equity", "label": _("Net Change in Equity")} - ] + "account_types": [{"account_type": "Equity", "label": _("Net Change in Equity")}], } # combine all cash flow accounts for iteration return [operation_accounts, investing_accounts, financing_accounts] + def get_account_type_based_data(company, account_type, period_list, accumulated_values, filters): data = {} total = 0 for period in period_list: start_date = get_start_date(period, accumulated_values, company) - amount = get_account_type_based_gl_data(company, start_date, - period['to_date'], account_type, filters) + amount = get_account_type_based_gl_data( + company, start_date, period["to_date"], account_type, filters + ) if amount and account_type == "Depreciation": amount *= -1 @@ -138,31 +175,42 @@ def get_account_type_based_data(company, account_type, period_list, accumulated_ data["total"] = total return data + def get_account_type_based_gl_data(company, start_date, end_date, account_type, filters=None): cond = "" filters = frappe._dict(filters or {}) if filters.include_default_book_entries: - company_fb = frappe.db.get_value("Company", company, 'default_finance_book') + company_fb = frappe.db.get_value("Company", company, "default_finance_book") cond = """ AND (finance_book in (%s, %s, '') OR finance_book IS NULL) - """ %(frappe.db.escape(filters.finance_book), frappe.db.escape(company_fb)) + """ % ( + frappe.db.escape(filters.finance_book), + frappe.db.escape(company_fb), + ) else: - cond = " AND (finance_book in (%s, '') OR finance_book IS NULL)" %(frappe.db.escape(cstr(filters.finance_book))) + cond = " AND (finance_book in (%s, '') OR finance_book IS NULL)" % ( + frappe.db.escape(cstr(filters.finance_book)) + ) - - gl_sum = frappe.db.sql_list(""" + gl_sum = frappe.db.sql_list( + """ select sum(credit) - sum(debit) from `tabGL Entry` where company=%s and posting_date >= %s and posting_date <= %s and voucher_type != 'Period Closing Voucher' and account in ( SELECT name FROM tabAccount WHERE account_type = %s) {cond} - """.format(cond=cond), (company, start_date, end_date, account_type)) + """.format( + cond=cond + ), + (company, start_date, end_date, account_type), + ) return gl_sum[0] if gl_sum and gl_sum[0] else 0 + def get_start_date(period, accumulated_values, company): - if not accumulated_values and period.get('from_date'): - return period['from_date'] + if not accumulated_values and period.get("from_date"): + return period["from_date"] start_date = period["year_start_date"] if accumulated_values: @@ -170,23 +218,26 @@ def get_start_date(period, accumulated_values, company): return start_date -def add_total_row_account(out, data, label, period_list, currency, summary_data, filters, consolidated=False): + +def add_total_row_account( + out, data, label, period_list, currency, summary_data, filters, consolidated=False +): total_row = { "account_name": "'" + _("{0}").format(label) + "'", "account": "'" + _("{0}").format(label) + "'", - "currency": currency + "currency": currency, } summary_data[label] = 0 # from consolidated financial statement - if filters.get('accumulated_in_group_company'): + if filters.get("accumulated_in_group_company"): period_list = get_filtered_list_for_consolidated_report(filters, period_list) for row in data: if row.get("parent_account"): for period in period_list: - key = period if consolidated else period['key'] + key = period if consolidated else period["key"] total_row.setdefault(key, 0.0) total_row[key] += row.get(key, 0.0) summary_data[label] += row.get(key) @@ -203,12 +254,7 @@ def get_report_summary(summary_data, currency): for label, value in iteritems(summary_data): report_summary.append( - { - "value": value, - "label": label, - "datatype": "Currency", - "currency": currency - } + {"value": value, "label": label, "datatype": "Currency", "currency": currency} ) return report_summary @@ -216,16 +262,17 @@ def get_report_summary(summary_data, currency): def get_chart_data(columns, data): labels = [d.get("label") for d in columns[2:]] - datasets = [{'name':account.get('account').replace("'", ""), 'values': [account.get('total')]} for account in data if account.get('parent_account') == None and account.get('currency')] + datasets = [ + { + "name": account.get("account").replace("'", ""), + "values": [account.get(d.get("fieldname")) for d in columns[2:]], + } + for account in data + if account.get("parent_account") == None and account.get("currency") + ] datasets = datasets[:-1] - chart = { - "data": { - 'labels': labels, - 'datasets': datasets - }, - "type": "bar" - } + chart = {"data": {"labels": labels, "datasets": datasets}, "type": "bar"} chart["fieldtype"] = "Currency" diff --git a/erpnext/accounts/report/cash_flow/custom_cash_flow.py b/erpnext/accounts/report/cash_flow/custom_cash_flow.py index 45d147e7a21..b165c88c068 100644 --- a/erpnext/accounts/report/cash_flow/custom_cash_flow.py +++ b/erpnext/accounts/report/cash_flow/custom_cash_flow.py @@ -4,7 +4,8 @@ import frappe from frappe import _ -from frappe.utils import add_to_date +from frappe.query_builder.functions import Sum +from frappe.utils import add_to_date, flt, get_date_str from erpnext.accounts.report.financial_statements import get_columns, get_data, get_period_list from erpnext.accounts.report.profit_and_loss_statement.profit_and_loss_statement import ( @@ -13,41 +14,59 @@ from erpnext.accounts.report.profit_and_loss_statement.profit_and_loss_statement def get_mapper_for(mappers, position): - mapper_list = list(filter(lambda x: x['position'] == position, mappers)) + mapper_list = list(filter(lambda x: x["position"] == position, mappers)) return mapper_list[0] if mapper_list else [] def get_mappers_from_db(): return frappe.get_all( - 'Cash Flow Mapper', + "Cash Flow Mapper", fields=[ - 'section_name', 'section_header', 'section_leader', 'section_subtotal', - 'section_footer', 'name', 'position'], - order_by='position' + "section_name", + "section_header", + "section_leader", + "section_subtotal", + "section_footer", + "name", + "position", + ], + order_by="position", ) def get_accounts_in_mappers(mapping_names): - return frappe.db.sql(''' - select cfma.name, cfm.label, cfm.is_working_capital, cfm.is_income_tax_liability, - cfm.is_income_tax_expense, cfm.is_finance_cost, cfm.is_finance_cost_adjustment - from `tabCash Flow Mapping Accounts` cfma - join `tabCash Flow Mapping` cfm on cfma.parent=cfm.name - where cfma.parent in (%s) - order by cfm.is_working_capital - ''', (', '.join('"%s"' % d for d in mapping_names))) + cfm = frappe.qb.DocType("Cash Flow Mapping") + cfma = frappe.qb.DocType("Cash Flow Mapping Accounts") + result = ( + frappe.qb.select( + cfma.name, + cfm.label, + cfm.is_working_capital, + cfm.is_income_tax_liability, + cfm.is_income_tax_expense, + cfm.is_finance_cost, + cfm.is_finance_cost_adjustment, + cfma.account, + ) + .from_(cfm) + .join(cfma) + .on(cfm.name == cfma.parent) + .where(cfma.parent.isin(mapping_names)) + ).run() + + return result def setup_mappers(mappers): cash_flow_accounts = [] for mapping in mappers: - mapping['account_types'] = [] - mapping['tax_liabilities'] = [] - mapping['tax_expenses'] = [] - mapping['finance_costs'] = [] - mapping['finance_costs_adjustments'] = [] - doc = frappe.get_doc('Cash Flow Mapper', mapping['name']) + mapping["account_types"] = [] + mapping["tax_liabilities"] = [] + mapping["tax_expenses"] = [] + mapping["finance_costs"] = [] + mapping["finance_costs_adjustments"] = [] + doc = frappe.get_doc("Cash Flow Mapper", mapping["name"]) mapping_names = [item.name for item in doc.accounts] if not mapping_names: @@ -57,96 +76,123 @@ def setup_mappers(mappers): account_types = [ dict( - name=account[0], label=account[1], is_working_capital=account[2], - is_income_tax_liability=account[3], is_income_tax_expense=account[4] - ) for account in accounts if not account[3]] + name=account[0], + account_name=account[7], + label=account[1], + is_working_capital=account[2], + is_income_tax_liability=account[3], + is_income_tax_expense=account[4], + ) + for account in accounts + if not account[3] + ] finance_costs_adjustments = [ dict( - name=account[0], label=account[1], is_finance_cost=account[5], - is_finance_cost_adjustment=account[6] - ) for account in accounts if account[6]] + name=account[0], + account_name=account[7], + label=account[1], + is_finance_cost=account[5], + is_finance_cost_adjustment=account[6], + ) + for account in accounts + if account[6] + ] tax_liabilities = [ dict( - name=account[0], label=account[1], is_income_tax_liability=account[3], - is_income_tax_expense=account[4] - ) for account in accounts if account[3]] + name=account[0], + account_name=account[7], + label=account[1], + is_income_tax_liability=account[3], + is_income_tax_expense=account[4], + ) + for account in accounts + if account[3] + ] tax_expenses = [ dict( - name=account[0], label=account[1], is_income_tax_liability=account[3], - is_income_tax_expense=account[4] - ) for account in accounts if account[4]] + name=account[0], + account_name=account[7], + label=account[1], + is_income_tax_liability=account[3], + is_income_tax_expense=account[4], + ) + for account in accounts + if account[4] + ] finance_costs = [ - dict( - name=account[0], label=account[1], is_finance_cost=account[5]) - for account in accounts if account[5]] + dict(name=account[0], account_name=account[7], label=account[1], is_finance_cost=account[5]) + for account in accounts + if account[5] + ] account_types_labels = sorted( set( - (d['label'], d['is_working_capital'], d['is_income_tax_liability'], d['is_income_tax_expense']) - for d in account_types + (d["label"], d["is_working_capital"], d["is_income_tax_liability"], d["is_income_tax_expense"]) + for d in account_types ), - key=lambda x: x[1] + key=lambda x: x[1], ) fc_adjustment_labels = sorted( set( - [(d['label'], d['is_finance_cost'], d['is_finance_cost_adjustment']) - for d in finance_costs_adjustments if d['is_finance_cost_adjustment']] + [ + (d["label"], d["is_finance_cost"], d["is_finance_cost_adjustment"]) + for d in finance_costs_adjustments + if d["is_finance_cost_adjustment"] + ] ), - key=lambda x: x[2] + key=lambda x: x[2], ) unique_liability_labels = sorted( set( - [(d['label'], d['is_income_tax_liability'], d['is_income_tax_expense']) - for d in tax_liabilities] + [ + (d["label"], d["is_income_tax_liability"], d["is_income_tax_expense"]) + for d in tax_liabilities + ] ), - key=lambda x: x[0] + key=lambda x: x[0], ) unique_expense_labels = sorted( set( - [(d['label'], d['is_income_tax_liability'], d['is_income_tax_expense']) - for d in tax_expenses] + [(d["label"], d["is_income_tax_liability"], d["is_income_tax_expense"]) for d in tax_expenses] ), - key=lambda x: x[0] + key=lambda x: x[0], ) unique_finance_costs_labels = sorted( - set( - [(d['label'], d['is_finance_cost']) for d in finance_costs] - ), - key=lambda x: x[0] + set([(d["label"], d["is_finance_cost"]) for d in finance_costs]), key=lambda x: x[0] ) for label in account_types_labels: - names = [d['name'] for d in account_types if d['label'] == label[0]] + names = [d["account_name"] for d in account_types if d["label"] == label[0]] m = dict(label=label[0], names=names, is_working_capital=label[1]) - mapping['account_types'].append(m) + mapping["account_types"].append(m) for label in fc_adjustment_labels: - names = [d['name'] for d in finance_costs_adjustments if d['label'] == label[0]] + names = [d["account_name"] for d in finance_costs_adjustments if d["label"] == label[0]] m = dict(label=label[0], names=names) - mapping['finance_costs_adjustments'].append(m) + mapping["finance_costs_adjustments"].append(m) for label in unique_liability_labels: - names = [d['name'] for d in tax_liabilities if d['label'] == label[0]] + names = [d["account_name"] for d in tax_liabilities if d["label"] == label[0]] m = dict(label=label[0], names=names, tax_liability=label[1], tax_expense=label[2]) - mapping['tax_liabilities'].append(m) + mapping["tax_liabilities"].append(m) for label in unique_expense_labels: - names = [d['name'] for d in tax_expenses if d['label'] == label[0]] + names = [d["account_name"] for d in tax_expenses if d["label"] == label[0]] m = dict(label=label[0], names=names, tax_liability=label[1], tax_expense=label[2]) - mapping['tax_expenses'].append(m) + mapping["tax_expenses"].append(m) for label in unique_finance_costs_labels: - names = [d['name'] for d in finance_costs if d['label'] == label[0]] + names = [d["account_name"] for d in finance_costs if d["label"] == label[0]] m = dict(label=label[0], names=names, is_finance_cost=label[1]) - mapping['finance_costs'].append(m) + mapping["finance_costs"].append(m) cash_flow_accounts.append(mapping) @@ -154,119 +200,145 @@ def setup_mappers(mappers): def add_data_for_operating_activities( - filters, company_currency, profit_data, period_list, light_mappers, mapper, data): + filters, company_currency, profit_data, period_list, light_mappers, mapper, data +): has_added_working_capital_header = False section_data = [] - data.append({ - "account_name": mapper['section_header'], - "parent_account": None, - "indent": 0.0, - "account": mapper['section_header'] - }) + data.append( + { + "account_name": mapper["section_header"], + "parent_account": None, + "indent": 0.0, + "account": mapper["section_header"], + } + ) if profit_data: - profit_data.update({ - "indent": 1, - "parent_account": get_mapper_for(light_mappers, position=1)['section_header'] - }) + profit_data.update( + {"indent": 1, "parent_account": get_mapper_for(light_mappers, position=1)["section_header"]} + ) data.append(profit_data) section_data.append(profit_data) - data.append({ - "account_name": mapper["section_leader"], - "parent_account": None, - "indent": 1.0, - "account": mapper["section_leader"] - }) - - for account in mapper['account_types']: - if account['is_working_capital'] and not has_added_working_capital_header: - data.append({ - "account_name": 'Movement in working capital', + data.append( + { + "account_name": mapper["section_leader"], "parent_account": None, "indent": 1.0, - "account": "" - }) + "account": mapper["section_leader"], + } + ) + + for account in mapper["account_types"]: + if account["is_working_capital"] and not has_added_working_capital_header: + data.append( + { + "account_name": "Movement in working capital", + "parent_account": None, + "indent": 1.0, + "account": "", + } + ) has_added_working_capital_header = True account_data = _get_account_type_based_data( - filters, account['names'], period_list, filters.accumulated_values) + filters, account["names"], period_list, filters.accumulated_values + ) - if not account['is_working_capital']: + if not account["is_working_capital"]: for key in account_data: - if key != 'total': + if key != "total": account_data[key] *= -1 - if account_data['total'] != 0: - account_data.update({ - "account_name": account['label'], - "account": account['names'], - "indent": 1.0, - "parent_account": mapper['section_header'], - "currency": company_currency - }) + if account_data["total"] != 0: + account_data.update( + { + "account_name": account["label"], + "account": account["names"], + "indent": 1.0, + "parent_account": mapper["section_header"], + "currency": company_currency, + } + ) data.append(account_data) section_data.append(account_data) _add_total_row_account( - data, section_data, mapper['section_subtotal'], period_list, company_currency, indent=1) + data, section_data, mapper["section_subtotal"], period_list, company_currency, indent=1 + ) # calculate adjustment for tax paid and add to data - if not mapper['tax_liabilities']: - mapper['tax_liabilities'] = [ - dict(label='Income tax paid', names=[''], tax_liability=1, tax_expense=0)] + if not mapper["tax_liabilities"]: + mapper["tax_liabilities"] = [ + dict(label="Income tax paid", names=[""], tax_liability=1, tax_expense=0) + ] - for account in mapper['tax_liabilities']: + for account in mapper["tax_liabilities"]: tax_paid = calculate_adjustment( - filters, mapper['tax_liabilities'], mapper['tax_expenses'], - filters.accumulated_values, period_list) + filters, + mapper["tax_liabilities"], + mapper["tax_expenses"], + filters.accumulated_values, + period_list, + ) if tax_paid: - tax_paid.update({ - 'parent_account': mapper['section_header'], - 'currency': company_currency, - 'account_name': account['label'], - 'indent': 1.0 - }) + tax_paid.update( + { + "parent_account": mapper["section_header"], + "currency": company_currency, + "account_name": account["label"], + "indent": 1.0, + } + ) data.append(tax_paid) section_data.append(tax_paid) - if not mapper['finance_costs_adjustments']: - mapper['finance_costs_adjustments'] = [dict(label='Interest Paid', names=[''])] + if not mapper["finance_costs_adjustments"]: + mapper["finance_costs_adjustments"] = [dict(label="Interest Paid", names=[""])] - for account in mapper['finance_costs_adjustments']: + for account in mapper["finance_costs_adjustments"]: interest_paid = calculate_adjustment( - filters, mapper['finance_costs_adjustments'], mapper['finance_costs'], - filters.accumulated_values, period_list + filters, + mapper["finance_costs_adjustments"], + mapper["finance_costs"], + filters.accumulated_values, + period_list, ) if interest_paid: - interest_paid.update({ - 'parent_account': mapper['section_header'], - 'currency': company_currency, - 'account_name': account['label'], - 'indent': 1.0 - }) + interest_paid.update( + { + "parent_account": mapper["section_header"], + "currency": company_currency, + "account_name": account["label"], + "indent": 1.0, + } + ) data.append(interest_paid) section_data.append(interest_paid) _add_total_row_account( - data, section_data, mapper['section_footer'], period_list, company_currency) + data, section_data, mapper["section_footer"], period_list, company_currency + ) -def calculate_adjustment(filters, non_expense_mapper, expense_mapper, use_accumulated_values, period_list): - liability_accounts = [d['names'] for d in non_expense_mapper] - expense_accounts = [d['names'] for d in expense_mapper] +def calculate_adjustment( + filters, non_expense_mapper, expense_mapper, use_accumulated_values, period_list +): + liability_accounts = [d["names"] for d in non_expense_mapper] + expense_accounts = [d["names"] for d in expense_mapper] - non_expense_closing = _get_account_type_based_data( - filters, liability_accounts, period_list, 0) + non_expense_closing = _get_account_type_based_data(filters, liability_accounts, period_list, 0) non_expense_opening = _get_account_type_based_data( - filters, liability_accounts, period_list, use_accumulated_values, opening_balances=1) + filters, liability_accounts, period_list, use_accumulated_values, opening_balances=1 + ) expense_data = _get_account_type_based_data( - filters, expense_accounts, period_list, use_accumulated_values) + filters, expense_accounts, period_list, use_accumulated_values + ) data = _calculate_adjustment(non_expense_closing, non_expense_opening, expense_data) return data @@ -276,7 +348,9 @@ def _calculate_adjustment(non_expense_closing, non_expense_opening, expense_data account_data = {} for month in non_expense_opening.keys(): if non_expense_opening[month] and non_expense_closing[month]: - account_data[month] = non_expense_opening[month] - expense_data[month] + non_expense_closing[month] + account_data[month] = ( + non_expense_opening[month] - expense_data[month] + non_expense_closing[month] + ) elif expense_data[month]: account_data[month] = expense_data[month] @@ -284,32 +358,39 @@ def _calculate_adjustment(non_expense_closing, non_expense_opening, expense_data def add_data_for_other_activities( - filters, company_currency, profit_data, period_list, light_mappers, mapper_list, data): + filters, company_currency, profit_data, period_list, light_mappers, mapper_list, data +): for mapper in mapper_list: section_data = [] - data.append({ - "account_name": mapper['section_header'], - "parent_account": None, - "indent": 0.0, - "account": mapper['section_header'] - }) + data.append( + { + "account_name": mapper["section_header"], + "parent_account": None, + "indent": 0.0, + "account": mapper["section_header"], + } + ) - for account in mapper['account_types']: - account_data = _get_account_type_based_data(filters, - account['names'], period_list, filters.accumulated_values) - if account_data['total'] != 0: - account_data.update({ - "account_name": account['label'], - "account": account['names'], - "indent": 1, - "parent_account": mapper['section_header'], - "currency": company_currency - }) + for account in mapper["account_types"]: + account_data = _get_account_type_based_data( + filters, account["names"], period_list, filters.accumulated_values + ) + if account_data["total"] != 0: + account_data.update( + { + "account_name": account["label"], + "account": account["names"], + "indent": 1, + "parent_account": mapper["section_header"], + "currency": company_currency, + } + ) data.append(account_data) section_data.append(account_data) - _add_total_row_account(data, section_data, mapper['section_footer'], - period_list, company_currency) + _add_total_row_account( + data, section_data, mapper["section_footer"], period_list, company_currency + ) def compute_data(filters, company_currency, profit_data, period_list, light_mappers, full_mapper): @@ -318,13 +399,18 @@ def compute_data(filters, company_currency, profit_data, period_list, light_mapp operating_activities_mapper = get_mapper_for(light_mappers, position=1) other_mappers = [ get_mapper_for(light_mappers, position=2), - get_mapper_for(light_mappers, position=3) + get_mapper_for(light_mappers, position=3), ] if operating_activities_mapper: add_data_for_operating_activities( - filters, company_currency, profit_data, period_list, light_mappers, - operating_activities_mapper, data + filters, + company_currency, + profit_data, + period_list, + light_mappers, + operating_activities_mapper, + data, ) if all(other_mappers): @@ -336,10 +422,17 @@ def compute_data(filters, company_currency, profit_data, period_list, light_mapp def execute(filters=None): - if not filters.periodicity: filters.periodicity = "Monthly" - period_list = get_period_list(filters.from_fiscal_year, filters.to_fiscal_year, - filters.period_start_date, filters.period_end_date, filters.filter_based_on, - filters.periodicity, company=filters.company) + if not filters.periodicity: + filters.periodicity = "Monthly" + period_list = get_period_list( + filters.from_fiscal_year, + filters.to_fiscal_year, + filters.period_start_date, + filters.period_end_date, + filters.filter_based_on, + filters.periodicity, + company=filters.company, + ) mappers = get_mappers_from_db() @@ -347,43 +440,72 @@ def execute(filters=None): # compute net profit / loss income = get_data( - filters.company, "Income", "Credit", period_list, filters=filters, - accumulated_values=filters.accumulated_values, ignore_closing_entries=True, - ignore_accumulated_values_for_fy=True + filters.company, + "Income", + "Credit", + period_list, + filters=filters, + accumulated_values=filters.accumulated_values, + ignore_closing_entries=True, + ignore_accumulated_values_for_fy=True, ) expense = get_data( - filters.company, "Expense", "Debit", period_list, filters=filters, - accumulated_values=filters.accumulated_values, ignore_closing_entries=True, - ignore_accumulated_values_for_fy=True + filters.company, + "Expense", + "Debit", + period_list, + filters=filters, + accumulated_values=filters.accumulated_values, + ignore_closing_entries=True, + ignore_accumulated_values_for_fy=True, ) net_profit_loss = get_net_profit_loss(income, expense, period_list, filters.company) - company_currency = frappe.get_cached_value('Company', filters.company, "default_currency") + company_currency = frappe.get_cached_value("Company", filters.company, "default_currency") - data = compute_data(filters, company_currency, net_profit_loss, period_list, mappers, cash_flow_accounts) + data = compute_data( + filters, company_currency, net_profit_loss, period_list, mappers, cash_flow_accounts + ) _add_total_row_account(data, data, _("Net Change in Cash"), period_list, company_currency) - columns = get_columns(filters.periodicity, period_list, filters.accumulated_values, filters.company) + columns = get_columns( + filters.periodicity, period_list, filters.accumulated_values, filters.company + ) return columns, data -def _get_account_type_based_data(filters, account_names, period_list, accumulated_values, opening_balances=0): +def _get_account_type_based_data( + filters, account_names, period_list, accumulated_values, opening_balances=0 +): + if not account_names or not account_names[0] or not type(account_names[0]) == str: + # only proceed if account_names is a list of account names + return {} + from erpnext.accounts.report.cash_flow.cash_flow import get_start_date company = filters.company data = {} total = 0 + GLEntry = frappe.qb.DocType("GL Entry") + Account = frappe.qb.DocType("Account") + for period in period_list: start_date = get_start_date(period, accumulated_values, company) - accounts = ', '.join('"%s"' % d for d in account_names) + + account_subquery = ( + frappe.qb.from_(Account) + .where((Account.name.isin(account_names)) | (Account.parent_account.isin(account_names))) + .select(Account.name) + .as_("account_subquery") + ) if opening_balances: date_info = dict(date=start_date) - months_map = {'Monthly': -1, 'Quarterly': -3, 'Half-Yearly': -6} - years_map = {'Yearly': -1} + months_map = {"Monthly": -1, "Quarterly": -3, "Half-Yearly": -6} + years_map = {"Yearly": -1} if months_map.get(filters.periodicity): date_info.update(months=months_map[filters.periodicity]) @@ -391,36 +513,35 @@ def _get_account_type_based_data(filters, account_names, period_list, accumulate date_info.update(years=years_map[filters.periodicity]) if accumulated_values: - start, end = add_to_date(start_date, years=-1), add_to_date(period['to_date'], years=-1) + start, end = add_to_date(start_date, years=-1), add_to_date(period["to_date"], years=-1) else: start, end = add_to_date(**date_info), add_to_date(**date_info) - gl_sum = frappe.db.sql_list(""" - select sum(credit) - sum(debit) - from `tabGL Entry` - where company=%s and posting_date >= %s and posting_date <= %s - and voucher_type != 'Period Closing Voucher' - and account in ( SELECT name FROM tabAccount WHERE name IN (%s) - OR parent_account IN (%s)) - """, (company, start, end, accounts, accounts)) - else: - gl_sum = frappe.db.sql_list(""" - select sum(credit) - sum(debit) - from `tabGL Entry` - where company=%s and posting_date >= %s and posting_date <= %s - and voucher_type != 'Period Closing Voucher' - and account in ( SELECT name FROM tabAccount WHERE name IN (%s) - OR parent_account IN (%s)) - """, (company, start_date if accumulated_values else period['from_date'], - period['to_date'], accounts, accounts)) + start, end = get_date_str(start), get_date_str(end) - if gl_sum and gl_sum[0]: - amount = gl_sum[0] else: - amount = 0 + start, end = start_date if accumulated_values else period["from_date"], period["to_date"] + start, end = get_date_str(start), get_date_str(end) - total += amount - data.setdefault(period["key"], amount) + result = ( + frappe.qb.from_(GLEntry) + .select(Sum(GLEntry.credit) - Sum(GLEntry.debit)) + .where( + (GLEntry.company == company) + & (GLEntry.posting_date >= start) + & (GLEntry.posting_date <= end) + & (GLEntry.voucher_type != "Period Closing Voucher") + & (GLEntry.account.isin(account_subquery)) + ) + ).run() + + if result and result[0]: + gl_sum = result[0][0] + else: + gl_sum = 0 + + total += flt(gl_sum) + data.setdefault(period["key"], flt(gl_sum)) data["total"] = total return data @@ -431,7 +552,7 @@ def _add_total_row_account(out, data, label, period_list, currency, indent=0.0): "indent": indent, "account_name": "'" + _("{0}").format(label) + "'", "account": "'" + _("{0}").format(label) + "'", - "currency": currency + "currency": currency, } for row in data: if row.get("parent_account"): diff --git a/erpnext/accounts/report/consolidated_financial_statement/consolidated_financial_statement.py b/erpnext/accounts/report/consolidated_financial_statement/consolidated_financial_statement.py index 758e3e93379..330e442a808 100644 --- a/erpnext/accounts/report/consolidated_financial_statement/consolidated_financial_statement.py +++ b/erpnext/accounts/report/consolidated_financial_statement/consolidated_financial_statement.py @@ -42,26 +42,32 @@ from erpnext.accounts.report.utils import convert, convert_to_presentation_curre def execute(filters=None): columns, data, message, chart = [], [], [], [] - if not filters.get('company'): + if not filters.get("company"): return columns, data, message, chart - fiscal_year = get_fiscal_year_data(filters.get('from_fiscal_year'), filters.get('to_fiscal_year')) + fiscal_year = get_fiscal_year_data(filters.get("from_fiscal_year"), filters.get("to_fiscal_year")) companies_column, companies = get_companies(filters) columns = get_columns(companies_column, filters) - if filters.get('report') == "Balance Sheet": - data, message, chart, report_summary = get_balance_sheet_data(fiscal_year, companies, columns, filters) - elif filters.get('report') == "Profit and Loss Statement": - data, message, chart, report_summary = get_profit_loss_data(fiscal_year, companies, columns, filters) + if filters.get("report") == "Balance Sheet": + data, message, chart, report_summary = get_balance_sheet_data( + fiscal_year, companies, columns, filters + ) + elif filters.get("report") == "Profit and Loss Statement": + data, message, chart, report_summary = get_profit_loss_data( + fiscal_year, companies, columns, filters + ) else: - if cint(frappe.db.get_single_value('Accounts Settings', 'use_custom_cash_flow')): + if cint(frappe.db.get_single_value("Accounts Settings", "use_custom_cash_flow")): from erpnext.accounts.report.cash_flow.custom_cash_flow import execute as execute_custom + return execute_custom(filters=filters) data, report_summary = get_cash_flow_data(fiscal_year, companies, filters) return columns, data, message, chart, report_summary + def get_balance_sheet_data(fiscal_year, companies, columns, filters): asset = get_data(companies, "Asset", "Debit", fiscal_year, filters=filters) @@ -75,24 +81,27 @@ def get_balance_sheet_data(fiscal_year, companies, columns, filters): data.extend(equity or []) company_currency = get_company_currency(filters) - provisional_profit_loss, total_credit = get_provisional_profit_loss(asset, liability, equity, - companies, filters.get('company'), company_currency, True) + provisional_profit_loss, total_credit = get_provisional_profit_loss( + asset, liability, equity, companies, filters.get("company"), company_currency, True + ) - message, opening_balance = prepare_companywise_opening_balance(asset, liability, equity, companies) + message, opening_balance = prepare_companywise_opening_balance( + asset, liability, equity, companies + ) if opening_balance: unclosed = { "account_name": "'" + _("Unclosed Fiscal Years Profit / Loss (Credit)") + "'", "account": "'" + _("Unclosed Fiscal Years Profit / Loss (Credit)") + "'", "warn_if_negative": True, - "currency": company_currency + "currency": company_currency, } for company in companies: unclosed[company] = opening_balance.get(company) if provisional_profit_loss and provisional_profit_loss.get(company): - provisional_profit_loss[company] = ( - flt(provisional_profit_loss[company]) - flt(opening_balance.get(company)) + provisional_profit_loss[company] = flt(provisional_profit_loss[company]) - flt( + opening_balance.get(company) ) unclosed["total"] = opening_balance.get(company) @@ -103,13 +112,23 @@ def get_balance_sheet_data(fiscal_year, companies, columns, filters): if total_credit: data.append(total_credit) - report_summary = get_bs_summary(companies, asset, liability, equity, provisional_profit_loss, total_credit, - company_currency, filters, True) + report_summary = get_bs_summary( + companies, + asset, + liability, + equity, + provisional_profit_loss, + total_credit, + company_currency, + filters, + True, + ) chart = get_chart_data(filters, columns, asset, liability, equity) return data, message, chart, report_summary + def prepare_companywise_opening_balance(asset_data, liability_data, equity_data, companies): opening_balance = {} for company in companies: @@ -119,29 +138,36 @@ def prepare_companywise_opening_balance(asset_data, liability_data, equity_data, for data in [asset_data, liability_data, equity_data]: if data: account_name = get_root_account_name(data[0].root_type, company) - opening_value += (get_opening_balance(account_name, data, company) or 0.0) + opening_value += get_opening_balance(account_name, data, company) or 0.0 opening_balance[company] = opening_value if opening_balance: return _("Previous Financial Year is not closed"), opening_balance - return '', {} + return "", {} + def get_opening_balance(account_name, data, company): for row in data: - if row.get('account_name') == account_name: - return row.get('company_wise_opening_bal', {}).get(company, 0.0) + if row.get("account_name") == account_name: + return row.get("company_wise_opening_bal", {}).get(company, 0.0) + def get_root_account_name(root_type, company): return frappe.get_all( - 'Account', - fields=['account_name'], - filters = {'root_type': root_type, 'is_group': 1, - 'company': company, 'parent_account': ('is', 'not set')}, - as_list=1 + "Account", + fields=["account_name"], + filters={ + "root_type": root_type, + "is_group": 1, + "company": company, + "parent_account": ("is", "not set"), + }, + as_list=1, )[0][0] + def get_profit_loss_data(fiscal_year, companies, columns, filters): income, expense, net_profit_loss = get_income_expense_data(companies, fiscal_year, filters) company_currency = get_company_currency(filters) @@ -154,20 +180,26 @@ def get_profit_loss_data(fiscal_year, companies, columns, filters): chart = get_pl_chart_data(filters, columns, income, expense, net_profit_loss) - report_summary = get_pl_summary(companies, '', income, expense, net_profit_loss, company_currency, filters, True) + report_summary = get_pl_summary( + companies, "", income, expense, net_profit_loss, company_currency, filters, True + ) return data, None, chart, report_summary + def get_income_expense_data(companies, fiscal_year, filters): company_currency = get_company_currency(filters) income = get_data(companies, "Income", "Credit", fiscal_year, filters, True) expense = get_data(companies, "Expense", "Debit", fiscal_year, filters, True) - net_profit_loss = get_net_profit_loss(income, expense, companies, filters.company, company_currency, True) + net_profit_loss = get_net_profit_loss( + income, expense, companies, filters.company, company_currency, True + ) return income, expense, net_profit_loss + def get_cash_flow_data(fiscal_year, companies, filters): cash_flow_accounts = get_cash_flow_accounts() @@ -179,50 +211,67 @@ def get_cash_flow_data(fiscal_year, companies, filters): for cash_flow_account in cash_flow_accounts: section_data = [] - data.append({ - "account_name": cash_flow_account['section_header'], - "parent_account": None, - "indent": 0.0, - "account": cash_flow_account['section_header'] - }) + data.append( + { + "account_name": cash_flow_account["section_header"], + "parent_account": None, + "indent": 0.0, + "account": cash_flow_account["section_header"], + } + ) if len(data) == 1: # add first net income in operations section if net_profit_loss: - net_profit_loss.update({ - "indent": 1, - "parent_account": cash_flow_accounts[0]['section_header'] - }) + net_profit_loss.update( + {"indent": 1, "parent_account": cash_flow_accounts[0]["section_header"]} + ) data.append(net_profit_loss) section_data.append(net_profit_loss) - for account in cash_flow_account['account_types']: - account_data = get_account_type_based_data(account['account_type'], companies, fiscal_year, filters) - account_data.update({ - "account_name": account['label'], - "account": account['label'], - "indent": 1, - "parent_account": cash_flow_account['section_header'], - "currency": company_currency - }) + for account in cash_flow_account["account_types"]: + account_data = get_account_type_based_data( + account["account_type"], companies, fiscal_year, filters + ) + account_data.update( + { + "account_name": account["label"], + "account": account["label"], + "indent": 1, + "parent_account": cash_flow_account["section_header"], + "currency": company_currency, + } + ) data.append(account_data) section_data.append(account_data) - add_total_row_account(data, section_data, cash_flow_account['section_footer'], - companies, company_currency, summary_data, filters, True) + add_total_row_account( + data, + section_data, + cash_flow_account["section_footer"], + companies, + company_currency, + summary_data, + filters, + True, + ) - add_total_row_account(data, data, _("Net Change in Cash"), companies, company_currency, summary_data, filters, True) + add_total_row_account( + data, data, _("Net Change in Cash"), companies, company_currency, summary_data, filters, True + ) report_summary = get_cash_flow_summary(summary_data, company_currency) return data, report_summary + def get_account_type_based_data(account_type, companies, fiscal_year, filters): data = {} total = 0 for company in companies: - amount = get_account_type_based_gl_data(company, - fiscal_year.year_start_date, fiscal_year.year_end_date, account_type, filters) + amount = get_account_type_based_gl_data( + company, fiscal_year.year_start_date, fiscal_year.year_end_date, account_type, filters + ) if amount and account_type == "Depreciation": amount *= -1 @@ -233,6 +282,7 @@ def get_account_type_based_data(account_type, companies, fiscal_year, filters): data["total"] = total return data + def get_columns(companies, filters): columns = [ { @@ -240,14 +290,15 @@ def get_columns(companies, filters): "label": _("Account"), "fieldtype": "Link", "options": "Account", - "width": 300 - }, { + "width": 300, + }, + { "fieldname": "currency", "label": _("Currency"), "fieldtype": "Link", "options": "Currency", - "hidden": 1 - } + "hidden": 1, + }, ] for company in companies: @@ -256,69 +307,96 @@ def get_columns(companies, filters): if not currency: currency = erpnext.get_company_currency(company) - columns.append({ - "fieldname": company, - "label": f'{company} ({currency})', - "fieldtype": "Currency", - "options": "currency", - "width": 150, - "apply_currency_formatter": apply_currency_formatter, - "company_name": company - }) + columns.append( + { + "fieldname": company, + "label": f"{company} ({currency})", + "fieldtype": "Currency", + "options": "currency", + "width": 150, + "apply_currency_formatter": apply_currency_formatter, + "company_name": company, + } + ) return columns -def get_data(companies, root_type, balance_must_be, fiscal_year, filters=None, ignore_closing_entries=False): - accounts, accounts_by_name, parent_children_map = get_account_heads(root_type, - companies, filters) - if not accounts: return [] +def get_data( + companies, root_type, balance_must_be, fiscal_year, filters=None, ignore_closing_entries=False +): + accounts, accounts_by_name, parent_children_map = get_account_heads(root_type, companies, filters) + + if not accounts: + return [] company_currency = get_company_currency(filters) - if filters.filter_based_on == 'Fiscal Year': - start_date = fiscal_year.year_start_date if filters.report != 'Balance Sheet' else None + if filters.filter_based_on == "Fiscal Year": + start_date = fiscal_year.year_start_date if filters.report != "Balance Sheet" else None end_date = fiscal_year.year_end_date else: - start_date = filters.period_start_date if filters.report != 'Balance Sheet' else None + start_date = filters.period_start_date if filters.report != "Balance Sheet" else None end_date = filters.period_end_date filters.end_date = end_date gl_entries_by_account = {} - for root in frappe.db.sql("""select lft, rgt from tabAccount - where root_type=%s and ifnull(parent_account, '') = ''""", root_type, as_dict=1): + for root in frappe.db.sql( + """select lft, rgt from tabAccount + where root_type=%s and ifnull(parent_account, '') = ''""", + root_type, + as_dict=1, + ): - set_gl_entries_by_account(start_date, - end_date, root.lft, root.rgt, filters, - gl_entries_by_account, accounts_by_name, accounts, ignore_closing_entries=False) + set_gl_entries_by_account( + start_date, + end_date, + root.lft, + root.rgt, + filters, + gl_entries_by_account, + accounts_by_name, + accounts, + ignore_closing_entries=False, + ) calculate_values(accounts_by_name, gl_entries_by_account, companies, filters, fiscal_year) accumulate_values_into_parents(accounts, accounts_by_name, companies) - out = prepare_data(accounts, start_date, end_date, balance_must_be, companies, company_currency, filters) + out = prepare_data( + accounts, start_date, end_date, balance_must_be, companies, company_currency, filters + ) - out = filter_out_zero_value_rows(out, parent_children_map, show_zero_values=filters.get("show_zero_values")) + out = filter_out_zero_value_rows( + out, parent_children_map, show_zero_values=filters.get("show_zero_values") + ) if out: add_total_row(out, root_type, balance_must_be, companies, company_currency) return out + def get_company_currency(filters=None): - return (filters.get('presentation_currency') - or frappe.get_cached_value('Company', filters.company, "default_currency")) + return filters.get("presentation_currency") or frappe.get_cached_value( + "Company", filters.company, "default_currency" + ) + def calculate_values(accounts_by_name, gl_entries_by_account, companies, filters, fiscal_year): - start_date = (fiscal_year.year_start_date - if filters.filter_based_on == 'Fiscal Year' else filters.period_start_date) + start_date = ( + fiscal_year.year_start_date + if filters.filter_based_on == "Fiscal Year" + else filters.period_start_date + ) for entries in gl_entries_by_account.values(): for entry in entries: if entry.account_number: - account_name = entry.account_number + ' - ' + entry.account_name + account_name = entry.account_number + " - " + entry.account_name else: - account_name = entry.account_name + account_name = entry.account_name d = accounts_by_name.get(account_name) @@ -326,48 +404,56 @@ def calculate_values(accounts_by_name, gl_entries_by_account, companies, filters debit, credit = 0, 0 for company in companies: # check if posting date is within the period - if (entry.company == company or (filters.get('accumulated_in_group_company')) - and entry.company in companies.get(company)): + if ( + entry.company == company + or (filters.get("accumulated_in_group_company")) + and entry.company in companies.get(company) + ): parent_company_currency = erpnext.get_company_currency(d.company) child_company_currency = erpnext.get_company_currency(entry.company) debit, credit = flt(entry.debit), flt(entry.credit) - if (not filters.get('presentation_currency') + if ( + not filters.get("presentation_currency") and entry.company != company and parent_company_currency != child_company_currency - and filters.get('accumulated_in_group_company')): + and filters.get("accumulated_in_group_company") + ): debit = convert(debit, parent_company_currency, child_company_currency, filters.end_date) credit = convert(credit, parent_company_currency, child_company_currency, filters.end_date) d[company] = d.get(company, 0.0) + flt(debit) - flt(credit) if entry.posting_date < getdate(start_date): - d['company_wise_opening_bal'][company] += (flt(debit) - flt(credit)) + d["company_wise_opening_bal"][company] += flt(debit) - flt(credit) if entry.posting_date < getdate(start_date): d["opening_balance"] = d.get("opening_balance", 0.0) + flt(debit) - flt(credit) + def accumulate_values_into_parents(accounts, accounts_by_name, companies): """accumulate children's values in parent accounts""" for d in reversed(accounts): if d.parent_account: account = d.parent_account_name - # if not accounts_by_name.get(account): - # continue - for company in companies: - accounts_by_name[account][company] = \ - accounts_by_name[account].get(company, 0.0) + d.get(company, 0.0) + accounts_by_name[account][company] = accounts_by_name[account].get(company, 0.0) + d.get( + company, 0.0 + ) - accounts_by_name[account]['company_wise_opening_bal'][company] += d.get('company_wise_opening_bal', {}).get(company, 0.0) + accounts_by_name[account]["company_wise_opening_bal"][company] += d.get( + "company_wise_opening_bal", {} + ).get(company, 0.0) + + accounts_by_name[account]["opening_balance"] = accounts_by_name[account].get( + "opening_balance", 0.0 + ) + d.get("opening_balance", 0.0) - accounts_by_name[account]["opening_balance"] = \ - accounts_by_name[account].get("opening_balance", 0.0) + d.get("opening_balance", 0.0) def get_account_heads(root_type, companies, filters): - accounts = get_accounts(root_type, filters) + accounts = get_accounts(root_type, companies) if not accounts: return None, None, None @@ -378,32 +464,34 @@ def get_account_heads(root_type, companies, filters): return accounts, accounts_by_name, parent_children_map + def update_parent_account_names(accounts): """Update parent_account_name in accounts list. - parent_name is `name` of parent account which could have other prefix - of account_number and suffix of company abbr. This function adds key called - `parent_account_name` which does not have such prefix/suffix. + parent_name is `name` of parent account which could have other prefix + of account_number and suffix of company abbr. This function adds key called + `parent_account_name` which does not have such prefix/suffix. """ name_to_account_map = {} for d in accounts: if d.account_number: - account_name = d.account_number + ' - ' + d.account_name + account_name = d.account_number + " - " + d.account_name else: - account_name = d.account_name + account_name = d.account_name name_to_account_map[d.name] = account_name for account in accounts: if account.parent_account: - account["parent_account_name"] = name_to_account_map[account.parent_account] + account["parent_account_name"] = name_to_account_map.get(account.parent_account) return accounts + def get_companies(filters): companies = {} - all_companies = get_subsidiary_companies(filters.get('company')) - companies.setdefault(filters.get('company'), all_companies) + all_companies = get_subsidiary_companies(filters.get("company")) + companies.setdefault(filters.get("company"), all_companies) for d in all_companies: if d not in companies: @@ -412,40 +500,77 @@ def get_companies(filters): return all_companies, companies + def get_subsidiary_companies(company): - lft, rgt = frappe.get_cached_value('Company', - company, ["lft", "rgt"]) + lft, rgt = frappe.get_cached_value("Company", company, ["lft", "rgt"]) - return frappe.db.sql_list("""select name from `tabCompany` - where lft >= {0} and rgt <= {1} order by lft, rgt""".format(lft, rgt)) + return frappe.db.sql_list( + """select name from `tabCompany` + where lft >= {0} and rgt <= {1} order by lft, rgt""".format( + lft, rgt + ) + ) -def get_accounts(root_type, filters): - return frappe.db.sql(""" select name, is_group, company, - parent_account, lft, rgt, root_type, report_type, account_name, account_number - from - `tabAccount` where company = %s and root_type = %s - """ , (filters.get('company'), root_type), as_dict=1) -def prepare_data(accounts, start_date, end_date, balance_must_be, companies, company_currency, filters): +def get_accounts(root_type, companies): + accounts = [] + added_accounts = [] + + for company in companies: + for account in frappe.get_all( + "Account", + fields=[ + "name", + "is_group", + "company", + "parent_account", + "lft", + "rgt", + "root_type", + "report_type", + "account_name", + "account_number", + ], + filters={"company": company, "root_type": root_type}, + ): + if account.account_name not in added_accounts: + accounts.append(account) + if account.account_number: + account_key = account.account_number + "-" + account.account_name + else: + account_key = account.account_name + added_accounts.append(account_key) + + return accounts + + +def prepare_data( + accounts, start_date, end_date, balance_must_be, companies, company_currency, filters +): data = [] for d in accounts: # add to output has_value = False total = 0 - row = frappe._dict({ - "account_name": ('%s - %s' %(_(d.account_number), _(d.account_name)) - if d.account_number else _(d.account_name)), - "account": _(d.name), - "parent_account": _(d.parent_account), - "indent": flt(d.indent), - "year_start_date": start_date, - "root_type": d.root_type, - "year_end_date": end_date, - "currency": filters.presentation_currency, - "company_wise_opening_bal": d.company_wise_opening_bal, - "opening_balance": d.get("opening_balance", 0.0) * (1 if balance_must_be == "Debit" else -1) - }) + row = frappe._dict( + { + "account_name": ( + "%s - %s" % (_(d.account_number), _(d.account_name)) + if d.account_number + else _(d.account_name) + ), + "account": _(d.name), + "parent_account": _(d.parent_account), + "indent": flt(d.indent), + "year_start_date": start_date, + "root_type": d.root_type, + "year_end_date": end_date, + "currency": filters.presentation_currency, + "company_wise_opening_bal": d.company_wise_opening_bal, + "opening_balance": d.get("opening_balance", 0.0) * (1 if balance_must_be == "Debit" else -1), + } + ) for company in companies: if d.get(company) and balance_must_be == "Credit": @@ -466,32 +591,49 @@ def prepare_data(accounts, start_date, end_date, balance_must_be, companies, com return data -def set_gl_entries_by_account(from_date, to_date, root_lft, root_rgt, filters, gl_entries_by_account, - accounts_by_name, accounts, ignore_closing_entries=False): + +def set_gl_entries_by_account( + from_date, + to_date, + root_lft, + root_rgt, + filters, + gl_entries_by_account, + accounts_by_name, + accounts, + ignore_closing_entries=False, +): """Returns a dict like { "account": [gl entries], ... }""" - company_lft, company_rgt = frappe.get_cached_value('Company', - filters.get('company'), ["lft", "rgt"]) + company_lft, company_rgt = frappe.get_cached_value( + "Company", filters.get("company"), ["lft", "rgt"] + ) additional_conditions = get_additional_conditions(from_date, ignore_closing_entries, filters) - companies = frappe.db.sql(""" select name, default_currency from `tabCompany` - where lft >= %(company_lft)s and rgt <= %(company_rgt)s""", { + companies = frappe.db.sql( + """ select name, default_currency from `tabCompany` + where lft >= %(company_lft)s and rgt <= %(company_rgt)s""", + { "company_lft": company_lft, "company_rgt": company_rgt, - }, as_dict=1) + }, + as_dict=1, + ) - currency_info = frappe._dict({ - 'report_date': to_date, - 'presentation_currency': filters.get('presentation_currency') - }) + currency_info = frappe._dict( + {"report_date": to_date, "presentation_currency": filters.get("presentation_currency")} + ) for d in companies: - gl_entries = frappe.db.sql("""select gl.posting_date, gl.account, gl.debit, gl.credit, gl.is_opening, gl.company, + gl_entries = frappe.db.sql( + """select gl.posting_date, gl.account, gl.debit, gl.credit, gl.is_opening, gl.company, gl.fiscal_year, gl.debit_in_account_currency, gl.credit_in_account_currency, gl.account_currency, acc.account_name, acc.account_number from `tabGL Entry` gl, `tabAccount` acc where acc.name = gl.account and gl.company = %(company)s and gl.is_cancelled = 0 {additional_conditions} and gl.posting_date <= %(to_date)s and acc.lft >= %(lft)s and acc.rgt <= %(rgt)s - order by gl.account, gl.posting_date""".format(additional_conditions=additional_conditions), + order by gl.account, gl.posting_date""".format( + additional_conditions=additional_conditions + ), { "from_date": from_date, "to_date": to_date, @@ -499,29 +641,47 @@ def set_gl_entries_by_account(from_date, to_date, root_lft, root_rgt, filters, g "rgt": root_rgt, "company": d.name, "finance_book": filters.get("finance_book"), - "company_fb": frappe.db.get_value("Company", d.name, 'default_finance_book') + "company_fb": frappe.db.get_value("Company", d.name, "default_finance_book"), }, - as_dict=True) + as_dict=True, + ) - if filters and filters.get('presentation_currency') != d.default_currency: - currency_info['company'] = d.name - currency_info['company_currency'] = d.default_currency - convert_to_presentation_currency(gl_entries, currency_info, filters.get('company')) + if filters and filters.get("presentation_currency") != d.default_currency: + currency_info["company"] = d.name + currency_info["company_currency"] = d.default_currency + convert_to_presentation_currency(gl_entries, currency_info, filters.get("company")) for entry in gl_entries: if entry.account_number: - account_name = entry.account_number + ' - ' + entry.account_name + account_name = entry.account_number + " - " + entry.account_name else: - account_name = entry.account_name + account_name = entry.account_name validate_entries(account_name, entry, accounts_by_name, accounts) gl_entries_by_account.setdefault(account_name, []).append(entry) return gl_entries_by_account + def get_account_details(account): - return frappe.get_cached_value('Account', account, ['name', 'report_type', 'root_type', 'company', - 'is_group', 'account_name', 'account_number', 'parent_account', 'lft', 'rgt'], as_dict=1) + return frappe.get_cached_value( + "Account", + account, + [ + "name", + "report_type", + "root_type", + "company", + "is_group", + "account_name", + "account_number", + "parent_account", + "lft", + "rgt", + ], + as_dict=1, + ) + def validate_entries(key, entry, accounts_by_name, accounts): # If an account present in the child company and not in the parent company @@ -531,15 +691,17 @@ def validate_entries(key, entry, accounts_by_name, accounts): if args.parent_account: parent_args = get_account_details(args.parent_account) - args.update({ - 'lft': parent_args.lft + 1, - 'rgt': parent_args.rgt - 1, - 'indent': 3, - 'root_type': parent_args.root_type, - 'report_type': parent_args.report_type, - 'parent_account_name': parent_args.account_name, - 'company_wise_opening_bal': defaultdict(float) - }) + args.update( + { + "lft": parent_args.lft + 1, + "rgt": parent_args.rgt - 1, + "indent": 3, + "root_type": parent_args.root_type, + "report_type": parent_args.report_type, + "parent_account_name": parent_args.account_name, + "company_wise_opening_bal": defaultdict(float), + } + ) accounts_by_name.setdefault(key, args) @@ -550,7 +712,8 @@ def validate_entries(key, entry, accounts_by_name, accounts): idx = index break - accounts.insert(idx+1, args) + accounts.insert(idx + 1, args) + def get_additional_conditions(from_date, ignore_closing_entries, filters): additional_conditions = [] @@ -562,17 +725,20 @@ def get_additional_conditions(from_date, ignore_closing_entries, filters): additional_conditions.append("gl.posting_date >= %(from_date)s") if filters.get("include_default_book_entries"): - additional_conditions.append("(finance_book in (%(finance_book)s, %(company_fb)s, '') OR finance_book IS NULL)") + additional_conditions.append( + "(finance_book in (%(finance_book)s, %(company_fb)s, '') OR finance_book IS NULL)" + ) else: additional_conditions.append("(finance_book in (%(finance_book)s, '') OR finance_book IS NULL)") return " and {}".format(" and ".join(additional_conditions)) if additional_conditions else "" + def add_total_row(out, root_type, balance_must_be, companies, company_currency): total_row = { "account_name": "'" + _("Total {0} ({1})").format(_(root_type), _(balance_must_be)) + "'", "account": "'" + _("Total {0} ({1})").format(_(root_type), _(balance_must_be)) + "'", - "currency": company_currency + "currency": company_currency, } for row in out: @@ -591,15 +757,16 @@ def add_total_row(out, root_type, balance_must_be, companies, company_currency): # blank row after Total out.append({}) + def filter_accounts(accounts, depth=10): parent_children_map = {} accounts_by_name = {} for d in accounts: if d.account_number: - account_name = d.account_number + ' - ' + d.account_name + account_name = d.account_number + " - " + d.account_name else: - account_name = d.account_name - d['company_wise_opening_bal'] = defaultdict(float) + account_name = d.account_name + d["company_wise_opening_bal"] = defaultdict(float) accounts_by_name[account_name] = d parent_children_map.setdefault(d.parent_account or None, []).append(d) @@ -609,7 +776,7 @@ def filter_accounts(accounts, depth=10): def add_to_list(parent, level): if level < depth: children = parent_children_map.get(parent) or [] - sort_accounts(children, is_root=True if parent==None else False) + sort_accounts(children, is_root=True if parent == None else False) for child in children: child.indent = level diff --git a/erpnext/accounts/report/customer_ledger_summary/customer_ledger_summary.py b/erpnext/accounts/report/customer_ledger_summary/customer_ledger_summary.py index 29546198464..3beaa2bfe74 100644 --- a/erpnext/accounts/report/customer_ledger_summary/customer_ledger_summary.py +++ b/erpnext/accounts/report/customer_ledger_summary/customer_ledger_summary.py @@ -15,14 +15,16 @@ class PartyLedgerSummaryReport(object): self.filters.to_date = getdate(self.filters.to_date or nowdate()) if not self.filters.get("company"): - self.filters["company"] = frappe.db.get_single_value('Global Defaults', 'default_company') + self.filters["company"] = frappe.db.get_single_value("Global Defaults", "default_company") def run(self, args): if self.filters.from_date > self.filters.to_date: frappe.throw(_("From Date must be before To Date")) self.filters.party_type = args.get("party_type") - self.party_naming_by = frappe.db.get_value(args.get("naming_by")[0], None, args.get("naming_by")[1]) + self.party_naming_by = frappe.db.get_value( + args.get("naming_by")[0], None, args.get("naming_by")[1] + ) self.get_gl_entries() self.get_return_invoices() @@ -33,21 +35,25 @@ class PartyLedgerSummaryReport(object): return columns, data def get_columns(self): - columns = [{ - "label": _(self.filters.party_type), - "fieldtype": "Link", - "fieldname": "party", - "options": self.filters.party_type, - "width": 200 - }] + columns = [ + { + "label": _(self.filters.party_type), + "fieldtype": "Link", + "fieldname": "party", + "options": self.filters.party_type, + "width": 200, + } + ] if self.party_naming_by == "Naming Series": - columns.append({ - "label": _(self.filters.party_type + "Name"), - "fieldtype": "Data", - "fieldname": "party_name", - "width": 110 - }) + columns.append( + { + "label": _(self.filters.party_type + "Name"), + "fieldtype": "Data", + "fieldname": "party_name", + "width": 110, + } + ) credit_or_debit_note = "Credit Note" if self.filters.party_type == "Customer" else "Debit Note" @@ -57,40 +63,42 @@ class PartyLedgerSummaryReport(object): "fieldname": "opening_balance", "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "label": _("Invoiced Amount"), "fieldname": "invoiced_amount", "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "label": _("Paid Amount"), "fieldname": "paid_amount", "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "label": _(credit_or_debit_note), "fieldname": "return_amount", "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, ] for account in self.party_adjustment_accounts: - columns.append({ - "label": account, - "fieldname": "adj_" + scrub(account), - "fieldtype": "Currency", - "options": "currency", - "width": 120, - "is_adjustment": 1 - }) + columns.append( + { + "label": account, + "fieldname": "adj_" + scrub(account), + "fieldtype": "Currency", + "options": "currency", + "width": 120, + "is_adjustment": 1, + } + ) columns += [ { @@ -98,36 +106,43 @@ class PartyLedgerSummaryReport(object): "fieldname": "closing_balance", "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "label": _("Currency"), "fieldname": "currency", "fieldtype": "Link", "options": "Currency", - "width": 50 - } + "width": 50, + }, ] return columns def get_data(self): - company_currency = frappe.get_cached_value('Company', self.filters.get("company"), "default_currency") + company_currency = frappe.get_cached_value( + "Company", self.filters.get("company"), "default_currency" + ) invoice_dr_or_cr = "debit" if self.filters.party_type == "Customer" else "credit" reverse_dr_or_cr = "credit" if self.filters.party_type == "Customer" else "debit" self.party_data = frappe._dict({}) for gle in self.gl_entries: - self.party_data.setdefault(gle.party, frappe._dict({ - "party": gle.party, - "party_name": gle.party_name, - "opening_balance": 0, - "invoiced_amount": 0, - "paid_amount": 0, - "return_amount": 0, - "closing_balance": 0, - "currency": company_currency - })) + self.party_data.setdefault( + gle.party, + frappe._dict( + { + "party": gle.party, + "party_name": gle.party_name, + "opening_balance": 0, + "invoiced_amount": 0, + "paid_amount": 0, + "return_amount": 0, + "closing_balance": 0, + "currency": company_currency, + } + ), + ) amount = gle.get(invoice_dr_or_cr) - gle.get(reverse_dr_or_cr) self.party_data[gle.party].closing_balance += amount @@ -144,8 +159,16 @@ class PartyLedgerSummaryReport(object): out = [] for party, row in iteritems(self.party_data): - if row.opening_balance or row.invoiced_amount or row.paid_amount or row.return_amount or row.closing_amount: - total_party_adjustment = sum(amount for amount in itervalues(self.party_adjustment_details.get(party, {}))) + if ( + row.opening_balance + or row.invoiced_amount + or row.paid_amount + or row.return_amount + or row.closing_amount + ): + total_party_adjustment = sum( + amount for amount in itervalues(self.party_adjustment_details.get(party, {})) + ) row.paid_amount -= total_party_adjustment adjustments = self.party_adjustment_details.get(party, {}) @@ -166,7 +189,8 @@ class PartyLedgerSummaryReport(object): join_field = ", p.supplier_name as party_name" join = "left join `tabSupplier` p on gle.party = p.name" - self.gl_entries = frappe.db.sql(""" + self.gl_entries = frappe.db.sql( + """ select gle.posting_date, gle.party, gle.voucher_type, gle.voucher_no, gle.against_voucher_type, gle.against_voucher, gle.debit, gle.credit, gle.is_opening {join_field} @@ -176,7 +200,12 @@ class PartyLedgerSummaryReport(object): gle.docstatus < 2 and gle.is_cancelled = 0 and gle.party_type=%(party_type)s and ifnull(gle.party, '') != '' and gle.posting_date <= %(to_date)s {conditions} order by gle.posting_date - """.format(join=join, join_field=join_field, conditions=conditions), self.filters, as_dict=True) + """.format( + join=join, join_field=join_field, conditions=conditions + ), + self.filters, + as_dict=True, + ) def prepare_conditions(self): conditions = [""] @@ -192,57 +221,88 @@ class PartyLedgerSummaryReport(object): if self.filters.party_type == "Customer": if self.filters.get("customer_group"): - lft, rgt = frappe.db.get_value("Customer Group", - self.filters.get("customer_group"), ["lft", "rgt"]) + lft, rgt = frappe.db.get_value( + "Customer Group", self.filters.get("customer_group"), ["lft", "rgt"] + ) - conditions.append("""party in (select name from tabCustomer + conditions.append( + """party in (select name from tabCustomer where exists(select name from `tabCustomer Group` where lft >= {0} and rgt <= {1} - and name=tabCustomer.customer_group))""".format(lft, rgt)) + and name=tabCustomer.customer_group))""".format( + lft, rgt + ) + ) if self.filters.get("territory"): - lft, rgt = frappe.db.get_value("Territory", - self.filters.get("territory"), ["lft", "rgt"]) + lft, rgt = frappe.db.get_value("Territory", self.filters.get("territory"), ["lft", "rgt"]) - conditions.append("""party in (select name from tabCustomer + conditions.append( + """party in (select name from tabCustomer where exists(select name from `tabTerritory` where lft >= {0} and rgt <= {1} - and name=tabCustomer.territory))""".format(lft, rgt)) + and name=tabCustomer.territory))""".format( + lft, rgt + ) + ) if self.filters.get("payment_terms_template"): - conditions.append("party in (select name from tabCustomer where payment_terms=%(payment_terms_template)s)") + conditions.append( + "party in (select name from tabCustomer where payment_terms=%(payment_terms_template)s)" + ) if self.filters.get("sales_partner"): - conditions.append("party in (select name from tabCustomer where default_sales_partner=%(sales_partner)s)") + conditions.append( + "party in (select name from tabCustomer where default_sales_partner=%(sales_partner)s)" + ) if self.filters.get("sales_person"): - lft, rgt = frappe.db.get_value("Sales Person", - self.filters.get("sales_person"), ["lft", "rgt"]) + lft, rgt = frappe.db.get_value( + "Sales Person", self.filters.get("sales_person"), ["lft", "rgt"] + ) - conditions.append("""exists(select name from `tabSales Team` steam where + conditions.append( + """exists(select name from `tabSales Team` steam where steam.sales_person in (select name from `tabSales Person` where lft >= {0} and rgt <= {1}) and ((steam.parent = voucher_no and steam.parenttype = voucher_type) or (steam.parent = against_voucher and steam.parenttype = against_voucher_type) - or (steam.parent = party and steam.parenttype = 'Customer')))""".format(lft, rgt)) + or (steam.parent = party and steam.parenttype = 'Customer')))""".format( + lft, rgt + ) + ) if self.filters.party_type == "Supplier": if self.filters.get("supplier_group"): - conditions.append("""party in (select name from tabSupplier - where supplier_group=%(supplier_group)s)""") + conditions.append( + """party in (select name from tabSupplier + where supplier_group=%(supplier_group)s)""" + ) return " and ".join(conditions) def get_return_invoices(self): doctype = "Sales Invoice" if self.filters.party_type == "Customer" else "Purchase Invoice" - self.return_invoices = [d.name for d in frappe.get_all(doctype, filters={"is_return": 1, "docstatus": 1, - "posting_date": ["between", [self.filters.from_date, self.filters.to_date]]})] + self.return_invoices = [ + d.name + for d in frappe.get_all( + doctype, + filters={ + "is_return": 1, + "docstatus": 1, + "posting_date": ["between", [self.filters.from_date, self.filters.to_date]], + }, + ) + ] def get_party_adjustment_amounts(self): conditions = self.prepare_conditions() - income_or_expense = "Expense Account" if self.filters.party_type == "Customer" else "Income Account" + income_or_expense = ( + "Expense Account" if self.filters.party_type == "Customer" else "Income Account" + ) invoice_dr_or_cr = "debit" if self.filters.party_type == "Customer" else "credit" reverse_dr_or_cr = "credit" if self.filters.party_type == "Customer" else "debit" - round_off_account = frappe.get_cached_value('Company', self.filters.company, "round_off_account") + round_off_account = frappe.get_cached_value("Company", self.filters.company, "round_off_account") - gl_entries = frappe.db.sql(""" + gl_entries = frappe.db.sql( + """ select posting_date, account, party, voucher_type, voucher_no, debit, credit from @@ -258,7 +318,12 @@ class PartyLedgerSummaryReport(object): where gle.party_type=%(party_type)s and ifnull(party, '') != '' and gle.posting_date between %(from_date)s and %(to_date)s and gle.docstatus < 2 {conditions} ) - """.format(conditions=conditions, income_or_expense=income_or_expense), self.filters, as_dict=True) + """.format( + conditions=conditions, income_or_expense=income_or_expense + ), + self.filters, + as_dict=True, + ) self.party_adjustment_details = {} self.party_adjustment_accounts = set() @@ -300,6 +365,7 @@ class PartyLedgerSummaryReport(object): self.party_adjustment_details[party].setdefault(account, 0) self.party_adjustment_details[party][account] += amount + def execute(filters=None): args = { "party_type": "Customer", diff --git a/erpnext/accounts/report/deferred_revenue_and_expense/__init__.py b/erpnext/accounts/report/deferred_revenue_and_expense/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.js b/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.js new file mode 100644 index 00000000000..0056b9e8f56 --- /dev/null +++ b/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.js @@ -0,0 +1,114 @@ +// Copyright (c) 2016, Frappe Technologies Pvt. Ltd. and contributors +// For license information, please see license.txt +/* eslint-disable */ + +function get_filters() { + let filters = [ + { + "fieldname":"company", + "label": __("Company"), + "fieldtype": "Link", + "options": "Company", + "default": frappe.defaults.get_user_default("Company"), + "reqd": 1 + }, + { + "fieldname":"filter_based_on", + "label": __("Filter Based On"), + "fieldtype": "Select", + "options": ["Fiscal Year", "Date Range"], + "default": ["Fiscal Year"], + "reqd": 1, + on_change: function() { + let filter_based_on = frappe.query_report.get_filter_value('filter_based_on'); + frappe.query_report.toggle_filter_display('from_fiscal_year', filter_based_on === 'Date Range'); + frappe.query_report.toggle_filter_display('to_fiscal_year', filter_based_on === 'Date Range'); + frappe.query_report.toggle_filter_display('period_start_date', filter_based_on === 'Fiscal Year'); + frappe.query_report.toggle_filter_display('period_end_date', filter_based_on === 'Fiscal Year'); + + frappe.query_report.refresh(); + } + }, + { + "fieldname":"period_start_date", + "label": __("Start Date"), + "fieldtype": "Date", + "hidden": 1, + "reqd": 1 + }, + { + "fieldname":"period_end_date", + "label": __("End Date"), + "fieldtype": "Date", + "hidden": 1, + "reqd": 1 + }, + { + "fieldname":"from_fiscal_year", + "label": __("Start Year"), + "fieldtype": "Link", + "options": "Fiscal Year", + "default": frappe.defaults.get_user_default("fiscal_year"), + "reqd": 1 + }, + { + "fieldname":"to_fiscal_year", + "label": __("End Year"), + "fieldtype": "Link", + "options": "Fiscal Year", + "default": frappe.defaults.get_user_default("fiscal_year"), + "reqd": 1 + }, + { + "fieldname": "periodicity", + "label": __("Periodicity"), + "fieldtype": "Select", + "options": [ + { "value": "Monthly", "label": __("Monthly") }, + { "value": "Quarterly", "label": __("Quarterly") }, + { "value": "Half-Yearly", "label": __("Half-Yearly") }, + { "value": "Yearly", "label": __("Yearly") } + ], + "default": "Monthly", + "reqd": 1 + }, + { + "fieldname": "type", + "label": __("Invoice Type"), + "fieldtype": "Select", + "options": [ + { "value": "Revenue", "label": __("Revenue") }, + { "value": "Expense", "label": __("Expense") } + ], + "default": "Revenue", + "reqd": 1 + }, + { + "fieldname" : "with_upcoming_postings", + "label": __("Show with upcoming revenue/expense"), + "fieldtype": "Check", + "default": 1 + } + ] + + return filters; +} + +frappe.query_reports["Deferred Revenue and Expense"] = { + "filters": get_filters(), + "formatter": function(value, row, column, data, default_formatter){ + return default_formatter(value, row, column, data); + }, + onload: function(report){ + let fiscal_year = frappe.defaults.get_user_default("fiscal_year"); + + frappe.model.with_doc("Fiscal Year", fiscal_year, function(r) { + var fy = frappe.model.get_doc("Fiscal Year", fiscal_year); + frappe.query_report.set_filter_value({ + period_start_date: fy.year_start_date, + period_end_date: fy.year_end_date + }); + }); + } +}; + diff --git a/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.json b/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.json new file mode 100644 index 00000000000..c7dfb3b7142 --- /dev/null +++ b/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.json @@ -0,0 +1,32 @@ +{ + "add_total_row": 0, + "columns": [], + "creation": "2021-12-10 19:27:14.654220", + "disable_prepared_report": 0, + "disabled": 0, + "docstatus": 0, + "doctype": "Report", + "filters": [], + "idx": 0, + "is_standard": "Yes", + "modified": "2021-12-10 19:27:14.654220", + "modified_by": "Administrator", + "module": "Accounts", + "name": "Deferred Revenue and Expense", + "owner": "Administrator", + "prepared_report": 0, + "ref_doctype": "GL Entry", + "report_name": "Deferred Revenue and Expense", + "report_type": "Script Report", + "roles": [ + { + "role": "Accounts User" + }, + { + "role": "Accounts Manager" + }, + { + "role": "Auditor" + } + ] +} \ No newline at end of file diff --git a/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.py b/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.py new file mode 100644 index 00000000000..1eb257ac853 --- /dev/null +++ b/erpnext/accounts/report/deferred_revenue_and_expense/deferred_revenue_and_expense.py @@ -0,0 +1,440 @@ +# Copyright (c) 2013, Frappe Technologies Pvt. Ltd. and contributors +# License: MIT. See LICENSE + +import frappe +from frappe import _, qb +from frappe.query_builder import Column, functions +from frappe.utils import add_days, date_diff, flt, get_first_day, get_last_day, rounded + +from erpnext.accounts.report.financial_statements import get_period_list + + +class Deferred_Item(object): + """ + Helper class for processing items with deferred revenue/expense + """ + + def __init__(self, item, inv, gle_entries): + self.name = item + self.parent = inv.name + self.item_name = gle_entries[0].item_name + self.service_start_date = gle_entries[0].service_start_date + self.service_end_date = gle_entries[0].service_end_date + self.base_net_amount = gle_entries[0].base_net_amount + self.filters = inv.filters + self.period_list = inv.period_list + + if gle_entries[0].deferred_revenue_account: + self.type = "Deferred Sale Item" + self.deferred_account = gle_entries[0].deferred_revenue_account + elif gle_entries[0].deferred_expense_account: + self.type = "Deferred Purchase Item" + self.deferred_account = gle_entries[0].deferred_expense_account + + self.gle_entries = [] + # holds period wise total for item + self.period_total = [] + self.last_entry_date = self.service_start_date + + if gle_entries: + self.gle_entries = gle_entries + for x in self.gle_entries: + if self.get_amount(x): + self.last_entry_date = x.gle_posting_date + + def report_data(self): + """ + Generate report data for output + """ + ret_data = frappe._dict({"name": self.item_name}) + for period in self.period_total: + ret_data[period.key] = period.total + ret_data.indent = 1 + return ret_data + + def get_amount(self, entry): + """ + For a given GL/Journal posting, get balance based on item type + """ + if self.type == "Deferred Sale Item": + return entry.debit - entry.credit + elif self.type == "Deferred Purchase Item": + return -(entry.credit - entry.debit) + return 0 + + def get_item_total(self): + """ + Helper method - calculate booked amount. Includes simulated postings as well + """ + total = 0 + for gle_posting in self.gle_entries: + total += self.get_amount(gle_posting) + + return total + + def calculate_amount(self, start_date, end_date): + """ + start_date, end_date - datetime.datetime.date + return - estimated amount to post for given period + Calculated based on already booked amount and item service period + """ + total_months = ( + (self.service_end_date.year - self.service_start_date.year) * 12 + + (self.service_end_date.month - self.service_start_date.month) + + 1 + ) + + prorate = date_diff(self.service_end_date, self.service_start_date) / date_diff( + get_last_day(self.service_end_date), get_first_day(self.service_start_date) + ) + + actual_months = rounded(total_months * prorate, 1) + + already_booked_amount = self.get_item_total() + base_amount = self.base_net_amount / actual_months + + if base_amount + already_booked_amount > self.base_net_amount: + base_amount = self.base_net_amount - already_booked_amount + + if not (get_first_day(start_date) == start_date and get_last_day(end_date) == end_date): + partial_month = flt(date_diff(end_date, start_date)) / flt( + date_diff(get_last_day(end_date), get_first_day(start_date)) + ) + base_amount *= rounded(partial_month, 1) + + return base_amount + + def make_dummy_gle(self, name, date, amount): + """ + return - frappe._dict() of a dummy gle entry + """ + entry = frappe._dict( + {"name": name, "gle_posting_date": date, "debit": 0, "credit": 0, "posted": "not"} + ) + if self.type == "Deferred Sale Item": + entry.debit = amount + elif self.type == "Deferred Purchase Item": + entry.credit = amount + return entry + + def simulate_future_posting(self): + """ + simulate future posting by creating dummy gl entries. starts from the last posting date. + """ + if self.service_start_date != self.service_end_date: + if add_days(self.last_entry_date, 1) < self.period_list[-1].to_date: + self.estimate_for_period_list = get_period_list( + self.filters.from_fiscal_year, + self.filters.to_fiscal_year, + add_days(self.last_entry_date, 1), + self.period_list[-1].to_date, + "Date Range", + "Monthly", + company=self.filters.company, + ) + for period in self.estimate_for_period_list: + amount = self.calculate_amount(period.from_date, period.to_date) + gle = self.make_dummy_gle(period.key, period.to_date, amount) + self.gle_entries.append(gle) + + def calculate_item_revenue_expense_for_period(self): + """ + calculate item postings for each period and update period_total list + """ + for period in self.period_list: + period_sum = 0 + actual = 0 + for posting in self.gle_entries: + # if period.from_date <= posting.posting_date <= period.to_date: + if period.from_date <= posting.gle_posting_date <= period.to_date: + period_sum += self.get_amount(posting) + if posting.posted == "posted": + actual += self.get_amount(posting) + + self.period_total.append( + frappe._dict({"key": period.key, "total": period_sum, "actual": actual}) + ) + return self.period_total + + +class Deferred_Invoice(object): + def __init__(self, invoice, items, filters, period_list): + """ + Helper class for processing invoices with deferred revenue/expense items + invoice - string : invoice name + items - list : frappe._dict() with item details. Refer Deferred_Item for required fields + """ + self.name = invoice + self.posting_date = items[0].posting_date + self.filters = filters + self.period_list = period_list + # holds period wise total for invoice + self.period_total = [] + + if items[0].deferred_revenue_account: + self.type = "Sales" + elif items[0].deferred_expense_account: + self.type = "Purchase" + + self.items = [] + # for each uniq items + self.uniq_items = set([x.item for x in items]) + for item in self.uniq_items: + self.items.append(Deferred_Item(item, self, [x for x in items if x.item == item])) + + def calculate_invoice_revenue_expense_for_period(self): + """ + calculate deferred revenue/expense for all items in invoice + """ + # initialize period_total list for invoice + for period in self.period_list: + self.period_total.append(frappe._dict({"key": period.key, "total": 0, "actual": 0})) + + for item in self.items: + item_total = item.calculate_item_revenue_expense_for_period() + # update invoice total + for idx, period in enumerate(self.period_list, 0): + self.period_total[idx].total += item_total[idx].total + self.period_total[idx].actual += item_total[idx].actual + return self.period_total + + def estimate_future(self): + """ + create dummy GL entries for upcoming months for all items in invoice + """ + [item.simulate_future_posting() for item in self.items] + + def report_data(self): + """ + generate report data for invoice, includes invoice total + """ + ret_data = [] + inv_total = frappe._dict({"name": self.name}) + for x in self.period_total: + inv_total[x.key] = x.total + inv_total.indent = 0 + ret_data.append(inv_total) + list(map(lambda item: ret_data.append(item.report_data()), self.items)) + return ret_data + + +class Deferred_Revenue_and_Expense_Report(object): + def __init__(self, filters=None): + """ + Initialize deferred revenue/expense report with user provided filters or system defaults, if none is provided + """ + + # If no filters are provided, get user defaults + if not filters: + fiscal_year = frappe.get_doc("Fiscal Year", frappe.defaults.get_user_default("fiscal_year")) + self.filters = frappe._dict( + { + "company": frappe.defaults.get_user_default("Company"), + "filter_based_on": "Fiscal Year", + "period_start_date": fiscal_year.year_start_date, + "period_end_date": fiscal_year.year_end_date, + "from_fiscal_year": fiscal_year.year, + "to_fiscal_year": fiscal_year.year, + "periodicity": "Monthly", + "type": "Revenue", + "with_upcoming_postings": True, + } + ) + else: + self.filters = frappe._dict(filters) + + self.period_list = None + self.deferred_invoices = [] + # holds period wise total for report + self.period_total = [] + + def get_period_list(self): + """ + Figure out selected period based on filters + """ + self.period_list = get_period_list( + self.filters.from_fiscal_year, + self.filters.to_fiscal_year, + self.filters.period_start_date, + self.filters.period_end_date, + self.filters.filter_based_on, + self.filters.periodicity, + company=self.filters.company, + ) + + def get_invoices(self): + """ + Get all sales and purchase invoices which has deferred revenue/expense items + """ + gle = qb.DocType("GL Entry") + # column doesn't have an alias option + posted = Column("posted") + + if self.filters.type == "Revenue": + inv = qb.DocType("Sales Invoice") + inv_item = qb.DocType("Sales Invoice Item") + deferred_flag_field = inv_item["enable_deferred_revenue"] + deferred_account_field = inv_item["deferred_revenue_account"] + + elif self.filters.type == "Expense": + inv = qb.DocType("Purchase Invoice") + inv_item = qb.DocType("Purchase Invoice Item") + deferred_flag_field = inv_item["enable_deferred_expense"] + deferred_account_field = inv_item["deferred_expense_account"] + + query = ( + qb.from_(inv_item) + .join(inv) + .on(inv.name == inv_item.parent) + .join(gle) + .on((inv_item.name == gle.voucher_detail_no) & (deferred_account_field == gle.account)) + .select( + inv.name.as_("doc"), + inv.posting_date, + inv_item.name.as_("item"), + inv_item.item_name, + inv_item.service_start_date, + inv_item.service_end_date, + inv_item.base_net_amount, + deferred_account_field, + gle.posting_date.as_("gle_posting_date"), + functions.Sum(gle.debit).as_("debit"), + functions.Sum(gle.credit).as_("credit"), + posted, + ) + .where( + (inv.docstatus == 1) + & (deferred_flag_field == 1) + & ( + ( + (self.period_list[0].from_date >= inv_item.service_start_date) + & (inv_item.service_end_date >= self.period_list[0].from_date) + ) + | ( + (inv_item.service_start_date >= self.period_list[0].from_date) + & (inv_item.service_start_date <= self.period_list[-1].to_date) + ) + ) + ) + .groupby(inv.name, inv_item.name, gle.posting_date) + .orderby(gle.posting_date) + ) + self.invoices = query.run(as_dict=True) + + uniq_invoice = set([x.doc for x in self.invoices]) + for inv in uniq_invoice: + self.deferred_invoices.append( + Deferred_Invoice( + inv, [x for x in self.invoices if x.doc == inv], self.filters, self.period_list + ) + ) + + def estimate_future(self): + """ + For all Invoices estimate upcoming postings + """ + for x in self.deferred_invoices: + x.estimate_future() + + def calculate_revenue_and_expense(self): + """ + calculate the deferred revenue/expense for all invoices + """ + # initialize period_total list for report + for period in self.period_list: + self.period_total.append(frappe._dict({"key": period.key, "total": 0, "actual": 0})) + + for inv in self.deferred_invoices: + inv_total = inv.calculate_invoice_revenue_expense_for_period() + # calculate total for whole report + for idx, period in enumerate(self.period_list, 0): + self.period_total[idx].total += inv_total[idx].total + self.period_total[idx].actual += inv_total[idx].actual + + def get_columns(self): + columns = [] + columns.append({"label": _("Name"), "fieldname": "name", "fieldtype": "Data", "read_only": 1}) + for period in self.period_list: + columns.append( + { + "label": _(period.label), + "fieldname": period.key, + "fieldtype": "Currency", + "read_only": 1, + } + ) + return columns + + def generate_report_data(self): + """ + Generate report data for all invoices. Adds total rows for revenue and expense + """ + ret = [] + + for inv in self.deferred_invoices: + ret += inv.report_data() + + # empty row for padding + ret += [{}] + + # add total row + if ret is not []: + if self.filters.type == "Revenue": + total_row = frappe._dict({"name": "Total Deferred Income"}) + elif self.filters.type == "Expense": + total_row = frappe._dict({"name": "Total Deferred Expense"}) + + for idx, period in enumerate(self.period_list, 0): + total_row[period.key] = self.period_total[idx].total + ret.append(total_row) + + return ret + + def prepare_chart(self): + chart = { + "data": { + "labels": [period.label for period in self.period_list], + "datasets": [ + { + "name": "Actual Posting", + "chartType": "bar", + "values": [x.actual for x in self.period_total], + } + ], + }, + "type": "axis-mixed", + "height": 500, + "axisOptions": {"xAxisMode": "Tick", "xIsSeries": True}, + "barOptions": {"stacked": False, "spaceRatio": 0.5}, + } + + if self.filters.with_upcoming_postings: + chart["data"]["datasets"].append( + {"name": "Expected", "chartType": "line", "values": [x.total for x in self.period_total]} + ) + + return chart + + def run(self, *args, **kwargs): + """ + Run report and generate data + """ + self.deferred_invoices.clear() + self.get_period_list() + self.get_invoices() + + if self.filters.with_upcoming_postings: + self.estimate_future() + self.calculate_revenue_and_expense() + + +def execute(filters=None): + report = Deferred_Revenue_and_Expense_Report(filters=filters) + report.run() + + columns = report.get_columns() + data = report.generate_report_data() + message = [] + chart = report.prepare_chart() + + return columns, data, message, chart diff --git a/erpnext/accounts/report/deferred_revenue_and_expense/test_deferred_revenue_and_expense.py b/erpnext/accounts/report/deferred_revenue_and_expense/test_deferred_revenue_and_expense.py new file mode 100644 index 00000000000..023ff225eea --- /dev/null +++ b/erpnext/accounts/report/deferred_revenue_and_expense/test_deferred_revenue_and_expense.py @@ -0,0 +1,350 @@ +import unittest + +import frappe +from frappe import qb +from frappe.utils import nowdate + +from erpnext.accounts.doctype.account.test_account import create_account +from erpnext.accounts.doctype.purchase_invoice.test_purchase_invoice import make_purchase_invoice +from erpnext.accounts.doctype.sales_invoice.test_sales_invoice import create_sales_invoice +from erpnext.accounts.report.deferred_revenue_and_expense.deferred_revenue_and_expense import ( + Deferred_Revenue_and_Expense_Report, +) +from erpnext.buying.doctype.supplier.test_supplier import create_supplier +from erpnext.stock.doctype.item.test_item import create_item + + +class TestDeferredRevenueAndExpense(unittest.TestCase): + @classmethod + def setUpClass(self): + clear_accounts_and_items() + create_company() + self.maxDiff = None + + def clear_old_entries(self): + sinv = qb.DocType("Sales Invoice") + sinv_item = qb.DocType("Sales Invoice Item") + pinv = qb.DocType("Purchase Invoice") + pinv_item = qb.DocType("Purchase Invoice Item") + + # delete existing invoices with deferred items + deferred_invoices = ( + qb.from_(sinv) + .join(sinv_item) + .on(sinv.name == sinv_item.parent) + .select(sinv.name) + .where(sinv_item.enable_deferred_revenue == 1) + .run() + ) + if deferred_invoices: + qb.from_(sinv).delete().where(sinv.name.isin(deferred_invoices)).run() + + deferred_invoices = ( + qb.from_(pinv) + .join(pinv_item) + .on(pinv.name == pinv_item.parent) + .select(pinv.name) + .where(pinv_item.enable_deferred_expense == 1) + .run() + ) + if deferred_invoices: + qb.from_(pinv).delete().where(pinv.name.isin(deferred_invoices)).run() + + def test_deferred_revenue(self): + self.clear_old_entries() + + # created deferred expense accounts, if not found + deferred_revenue_account = create_account( + account_name="Deferred Revenue", + parent_account="Current Liabilities - _CD", + company="_Test Company DR", + ) + + acc_settings = frappe.get_doc("Accounts Settings", "Accounts Settings") + acc_settings.book_deferred_entries_based_on = "Months" + acc_settings.save() + + customer = frappe.new_doc("Customer") + customer.customer_name = "_Test Customer DR" + customer.type = "Individual" + customer.insert() + + item = create_item( + "_Test Internet Subscription", + is_stock_item=0, + warehouse="All Warehouses - _CD", + company="_Test Company DR", + ) + item.enable_deferred_revenue = 1 + item.deferred_revenue_account = deferred_revenue_account + item.no_of_months = 3 + item.save() + + si = create_sales_invoice( + item=item.name, + company="_Test Company DR", + customer="_Test Customer DR", + debit_to="Debtors - _CD", + posting_date="2021-05-01", + parent_cost_center="Main - _CD", + cost_center="Main - _CD", + do_not_save=True, + rate=300, + price_list_rate=300, + ) + + si.items[0].income_account = "Sales - _CD" + si.items[0].enable_deferred_revenue = 1 + si.items[0].service_start_date = "2021-05-01" + si.items[0].service_end_date = "2021-08-01" + si.items[0].deferred_revenue_account = deferred_revenue_account + si.items[0].income_account = "Sales - _CD" + si.save() + si.submit() + + pda = frappe.get_doc( + dict( + doctype="Process Deferred Accounting", + posting_date=nowdate(), + start_date="2021-05-01", + end_date="2021-08-01", + type="Income", + company="_Test Company DR", + ) + ) + pda.insert() + pda.submit() + + # execute report + fiscal_year = frappe.get_doc("Fiscal Year", frappe.defaults.get_user_default("fiscal_year")) + self.filters = frappe._dict( + { + "company": frappe.defaults.get_user_default("Company"), + "filter_based_on": "Date Range", + "period_start_date": "2021-05-01", + "period_end_date": "2021-08-01", + "from_fiscal_year": fiscal_year.year, + "to_fiscal_year": fiscal_year.year, + "periodicity": "Monthly", + "type": "Revenue", + "with_upcoming_postings": False, + } + ) + + report = Deferred_Revenue_and_Expense_Report(filters=self.filters) + report.run() + expected = [ + {"key": "may_2021", "total": 100.0, "actual": 100.0}, + {"key": "jun_2021", "total": 100.0, "actual": 100.0}, + {"key": "jul_2021", "total": 100.0, "actual": 100.0}, + {"key": "aug_2021", "total": 0, "actual": 0}, + ] + self.assertEqual(report.period_total, expected) + + def test_deferred_expense(self): + self.clear_old_entries() + + # created deferred expense accounts, if not found + deferred_expense_account = create_account( + account_name="Deferred Expense", + parent_account="Current Assets - _CD", + company="_Test Company DR", + ) + + acc_settings = frappe.get_doc("Accounts Settings", "Accounts Settings") + acc_settings.book_deferred_entries_based_on = "Months" + acc_settings.save() + + supplier = create_supplier( + supplier_name="_Test Furniture Supplier", supplier_group="Local", supplier_type="Company" + ) + supplier.save() + + item = create_item( + "_Test Office Desk", + is_stock_item=0, + warehouse="All Warehouses - _CD", + company="_Test Company DR", + ) + item.enable_deferred_expense = 1 + item.deferred_expense_account = deferred_expense_account + item.no_of_months_exp = 3 + item.save() + + pi = make_purchase_invoice( + item=item.name, + company="_Test Company DR", + supplier="_Test Furniture Supplier", + is_return=False, + update_stock=False, + posting_date=frappe.utils.datetime.date(2021, 5, 1), + parent_cost_center="Main - _CD", + cost_center="Main - _CD", + do_not_save=True, + rate=300, + price_list_rate=300, + warehouse="All Warehouses - _CD", + qty=1, + ) + pi.set_posting_time = True + pi.items[0].enable_deferred_expense = 1 + pi.items[0].service_start_date = "2021-05-01" + pi.items[0].service_end_date = "2021-08-01" + pi.items[0].deferred_expense_account = deferred_expense_account + pi.items[0].expense_account = "Office Maintenance Expenses - _CD" + pi.save() + pi.submit() + + pda = frappe.get_doc( + dict( + doctype="Process Deferred Accounting", + posting_date=nowdate(), + start_date="2021-05-01", + end_date="2021-08-01", + type="Expense", + company="_Test Company DR", + ) + ) + pda.insert() + pda.submit() + + # execute report + fiscal_year = frappe.get_doc("Fiscal Year", frappe.defaults.get_user_default("fiscal_year")) + self.filters = frappe._dict( + { + "company": frappe.defaults.get_user_default("Company"), + "filter_based_on": "Date Range", + "period_start_date": "2021-05-01", + "period_end_date": "2021-08-01", + "from_fiscal_year": fiscal_year.year, + "to_fiscal_year": fiscal_year.year, + "periodicity": "Monthly", + "type": "Expense", + "with_upcoming_postings": False, + } + ) + + report = Deferred_Revenue_and_Expense_Report(filters=self.filters) + report.run() + expected = [ + {"key": "may_2021", "total": -100.0, "actual": -100.0}, + {"key": "jun_2021", "total": -100.0, "actual": -100.0}, + {"key": "jul_2021", "total": -100.0, "actual": -100.0}, + {"key": "aug_2021", "total": 0, "actual": 0}, + ] + self.assertEqual(report.period_total, expected) + + def test_zero_months(self): + self.clear_old_entries() + # created deferred expense accounts, if not found + deferred_revenue_account = create_account( + account_name="Deferred Revenue", + parent_account="Current Liabilities - _CD", + company="_Test Company DR", + ) + + acc_settings = frappe.get_doc("Accounts Settings", "Accounts Settings") + acc_settings.book_deferred_entries_based_on = "Months" + acc_settings.save() + + customer = frappe.new_doc("Customer") + customer.customer_name = "_Test Customer DR" + customer.type = "Individual" + customer.insert() + + item = create_item( + "_Test Internet Subscription", + is_stock_item=0, + warehouse="All Warehouses - _CD", + company="_Test Company DR", + ) + item.enable_deferred_revenue = 1 + item.deferred_revenue_account = deferred_revenue_account + item.no_of_months = 0 + item.save() + + si = create_sales_invoice( + item=item.name, + company="_Test Company DR", + customer="_Test Customer DR", + debit_to="Debtors - _CD", + posting_date="2021-05-01", + parent_cost_center="Main - _CD", + cost_center="Main - _CD", + do_not_save=True, + rate=300, + price_list_rate=300, + ) + + si.items[0].enable_deferred_revenue = 1 + si.items[0].income_account = "Sales - _CD" + si.items[0].deferred_revenue_account = deferred_revenue_account + si.items[0].income_account = "Sales - _CD" + si.save() + si.submit() + + pda = frappe.get_doc( + dict( + doctype="Process Deferred Accounting", + posting_date=nowdate(), + start_date="2021-05-01", + end_date="2021-08-01", + type="Income", + company="_Test Company DR", + ) + ) + pda.insert() + pda.submit() + + # execute report + fiscal_year = frappe.get_doc("Fiscal Year", frappe.defaults.get_user_default("fiscal_year")) + self.filters = frappe._dict( + { + "company": frappe.defaults.get_user_default("Company"), + "filter_based_on": "Date Range", + "period_start_date": "2021-05-01", + "period_end_date": "2021-08-01", + "from_fiscal_year": fiscal_year.year, + "to_fiscal_year": fiscal_year.year, + "periodicity": "Monthly", + "type": "Revenue", + "with_upcoming_postings": False, + } + ) + + report = Deferred_Revenue_and_Expense_Report(filters=self.filters) + report.run() + expected = [ + {"key": "may_2021", "total": 300.0, "actual": 300.0}, + {"key": "jun_2021", "total": 0, "actual": 0}, + {"key": "jul_2021", "total": 0, "actual": 0}, + {"key": "aug_2021", "total": 0, "actual": 0}, + ] + self.assertEqual(report.period_total, expected) + + +def create_company(): + company = frappe.db.exists("Company", "_Test Company DR") + if not company: + company = frappe.new_doc("Company") + company.company_name = "_Test Company DR" + company.default_currency = "INR" + company.chart_of_accounts = "Standard" + company.insert() + + +def clear_accounts_and_items(): + item = qb.DocType("Item") + account = qb.DocType("Account") + customer = qb.DocType("Customer") + supplier = qb.DocType("Supplier") + + qb.from_(account).delete().where( + (account.account_name == "Deferred Revenue") + | (account.account_name == "Deferred Expense") & (account.company == "_Test Company DR") + ).run() + qb.from_(item).delete().where( + (item.item_code == "_Test Internet Subscription") | (item.item_code == "_Test Office Rent") + ).run() + qb.from_(customer).delete().where(customer.customer_name == "_Test Customer DR").run() + qb.from_(supplier).delete().where(supplier.supplier_name == "_Test Furniture Supplier").run() diff --git a/erpnext/accounts/report/delivered_items_to_be_billed/delivered_items_to_be_billed.py b/erpnext/accounts/report/delivered_items_to_be_billed/delivered_items_to_be_billed.py index 004d09250ab..59914dc29ac 100644 --- a/erpnext/accounts/report/delivered_items_to_be_billed/delivered_items_to_be_billed.py +++ b/erpnext/accounts/report/delivered_items_to_be_billed/delivered_items_to_be_billed.py @@ -13,6 +13,7 @@ def execute(filters=None): data = get_ordered_to_be_billed_data(args) return columns, data + def get_column(): return [ { @@ -20,90 +21,76 @@ def get_column(): "fieldname": "name", "fieldtype": "Link", "options": "Delivery Note", - "width": 160 - }, - { - "label": _("Date"), - "fieldname": "date", - "fieldtype": "Date", - "width": 100 + "width": 160, }, + {"label": _("Date"), "fieldname": "date", "fieldtype": "Date", "width": 100}, { "label": _("Customer"), "fieldname": "customer", "fieldtype": "Link", "options": "Customer", - "width": 120 - }, - { - "label": _("Customer Name"), - "fieldname": "customer_name", - "fieldtype": "Data", - "width": 120 + "width": 120, }, + {"label": _("Customer Name"), "fieldname": "customer_name", "fieldtype": "Data", "width": 120}, { "label": _("Item Code"), "fieldname": "item_code", "fieldtype": "Link", "options": "Item", - "width": 120 + "width": 120, }, { "label": _("Amount"), "fieldname": "amount", "fieldtype": "Currency", "width": 100, - "options": "Company:company:default_currency" + "options": "Company:company:default_currency", }, { "label": _("Billed Amount"), "fieldname": "billed_amount", "fieldtype": "Currency", "width": 100, - "options": "Company:company:default_currency" + "options": "Company:company:default_currency", }, { "label": _("Returned Amount"), "fieldname": "returned_amount", "fieldtype": "Currency", "width": 120, - "options": "Company:company:default_currency" + "options": "Company:company:default_currency", }, { "label": _("Pending Amount"), "fieldname": "pending_amount", "fieldtype": "Currency", "width": 120, - "options": "Company:company:default_currency" - }, - { - "label": _("Item Name"), - "fieldname": "item_name", - "fieldtype": "Data", - "width": 120 - }, - { - "label": _("Description"), - "fieldname": "description", - "fieldtype": "Data", - "width": 120 + "options": "Company:company:default_currency", }, + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 120}, + {"label": _("Description"), "fieldname": "description", "fieldtype": "Data", "width": 120}, { "label": _("Project"), "fieldname": "project", "fieldtype": "Link", "options": "Project", - "width": 120 + "width": 120, }, { "label": _("Company"), "fieldname": "company", "fieldtype": "Link", "options": "Company", - "width": 120 - } + "width": 120, + }, ] + def get_args(): - return {'doctype': 'Delivery Note', 'party': 'customer', - 'date': 'posting_date', 'order': 'name', 'order_by': 'desc'} + return { + "doctype": "Delivery Note", + "party": "customer", + "date": "posting_date", + "order": "name", + "order_by": "desc", + } diff --git a/erpnext/accounts/report/dimension_wise_accounts_balance_report/dimension_wise_accounts_balance_report.js b/erpnext/accounts/report/dimension_wise_accounts_balance_report/dimension_wise_accounts_balance_report.js index 6a0394861b8..ea05a35b259 100644 --- a/erpnext/accounts/report/dimension_wise_accounts_balance_report/dimension_wise_accounts_balance_report.js +++ b/erpnext/accounts/report/dimension_wise_accounts_balance_report/dimension_wise_accounts_balance_report.js @@ -39,12 +39,14 @@ frappe.require("assets/erpnext/js/financial_statements.js", function() { "label": __("From Date"), "fieldtype": "Date", "default": frappe.defaults.get_user_default("year_start_date"), + "reqd": 1 }, { "fieldname": "to_date", "label": __("To Date"), "fieldtype": "Date", "default": frappe.defaults.get_user_default("year_end_date"), + "reqd": 1 }, { "fieldname": "finance_book", @@ -56,6 +58,7 @@ frappe.require("assets/erpnext/js/financial_statements.js", function() { "fieldname": "dimension", "label": __("Select Dimension"), "fieldtype": "Select", + "default": "Cost Center", "options": get_accounting_dimension_options(), "reqd": 1, }, @@ -70,7 +73,7 @@ frappe.require("assets/erpnext/js/financial_statements.js", function() { }); function get_accounting_dimension_options() { - let options =["", "Cost Center", "Project"]; + let options =["Cost Center", "Project"]; frappe.db.get_list('Accounting Dimension', {fields:['document_type']}).then((res) => { res.forEach((dimension) => { diff --git a/erpnext/accounts/report/dimension_wise_accounts_balance_report/dimension_wise_accounts_balance_report.py b/erpnext/accounts/report/dimension_wise_accounts_balance_report/dimension_wise_accounts_balance_report.py index c69bb3f70c5..9bc4c4b71da 100644 --- a/erpnext/accounts/report/dimension_wise_accounts_balance_report/dimension_wise_accounts_balance_report.py +++ b/erpnext/accounts/report/dimension_wise_accounts_balance_report/dimension_wise_accounts_balance_report.py @@ -16,21 +16,24 @@ from erpnext.accounts.report.trial_balance.trial_balance import validate_filters def execute(filters=None): - validate_filters(filters) - dimension_items_list = get_dimension_items_list(filters.dimension, filters.company) - if not dimension_items_list: + validate_filters(filters) + dimension_list = get_dimensions(filters) + + if not dimension_list: return [], [] - dimension_items_list = [''.join(d) for d in dimension_items_list] - columns = get_columns(dimension_items_list) - data = get_data(filters, dimension_items_list) + columns = get_columns(dimension_list) + data = get_data(filters, dimension_list) return columns, data -def get_data(filters, dimension_items_list): + +def get_data(filters, dimension_list): company_currency = erpnext.get_company_currency(filters.company) - acc = frappe.db.sql(""" + + acc = frappe.db.sql( + """ select name, account_number, parent_account, lft, rgt, root_type, report_type, account_name, include_in_gross, account_type, is_group @@ -38,88 +41,104 @@ def get_data(filters, dimension_items_list): `tabAccount` where company=%s - order by lft""", (filters.company), as_dict=True) + order by lft""", + (filters.company), + as_dict=True, + ) if not acc: return None accounts, accounts_by_name, parent_children_map = filter_accounts(acc) - min_lft, max_rgt = frappe.db.sql("""select min(lft), max(rgt) from `tabAccount` - where company=%s""", (filters.company))[0] + min_lft, max_rgt = frappe.db.sql( + """select min(lft), max(rgt) from `tabAccount` + where company=%s""", + (filters.company), + )[0] - account = frappe.db.sql_list("""select name from `tabAccount` - where lft >= %s and rgt <= %s and company = %s""", (min_lft, max_rgt, filters.company)) + account = frappe.db.sql_list( + """select name from `tabAccount` + where lft >= %s and rgt <= %s and company = %s""", + (min_lft, max_rgt, filters.company), + ) gl_entries_by_account = {} - set_gl_entries_by_account(dimension_items_list, filters, account, gl_entries_by_account) - format_gl_entries(gl_entries_by_account, accounts_by_name, dimension_items_list) - accumulate_values_into_parents(accounts, accounts_by_name, dimension_items_list) - out = prepare_data(accounts, filters, parent_children_map, company_currency, dimension_items_list) + set_gl_entries_by_account(dimension_list, filters, account, gl_entries_by_account) + format_gl_entries( + gl_entries_by_account, accounts_by_name, dimension_list, frappe.scrub(filters.get("dimension")) + ) + accumulate_values_into_parents(accounts, accounts_by_name, dimension_list) + out = prepare_data(accounts, filters, company_currency, dimension_list) out = filter_out_zero_value_rows(out, parent_children_map) return out -def set_gl_entries_by_account(dimension_items_list, filters, account, gl_entries_by_account): - for item in dimension_items_list: - condition = get_condition(filters.from_date, item, filters.dimension) - if account: - condition += " and account in ({})"\ - .format(", ".join([frappe.db.escape(d) for d in account])) - gl_filters = { - "company": filters.get("company"), - "from_date": filters.get("from_date"), - "to_date": filters.get("to_date"), - "finance_book": cstr(filters.get("finance_book")) - } +def set_gl_entries_by_account(dimension_list, filters, account, gl_entries_by_account): + condition = get_condition(filters.get("dimension")) - gl_filters['item'] = ''.join(item) + if account: + condition += " and account in ({})".format(", ".join([frappe.db.escape(d) for d in account])) - if filters.get("include_default_book_entries"): - gl_filters["company_fb"] = frappe.db.get_value("Company", - filters.company, 'default_finance_book') + gl_filters = { + "company": filters.get("company"), + "from_date": filters.get("from_date"), + "to_date": filters.get("to_date"), + "finance_book": cstr(filters.get("finance_book")), + } - for key, value in filters.items(): - if value: - gl_filters.update({ - key: value - }) + gl_filters["dimensions"] = set(dimension_list) - gl_entries = frappe.db.sql(""" + if filters.get("include_default_book_entries"): + gl_filters["company_fb"] = frappe.db.get_value( + "Company", filters.company, "default_finance_book" + ) + + gl_entries = frappe.db.sql( + """ select - posting_date, account, debit, credit, is_opening, fiscal_year, + posting_date, account, {dimension}, debit, credit, is_opening, fiscal_year, debit_in_account_currency, credit_in_account_currency, account_currency from `tabGL Entry` where company=%(company)s {condition} + and posting_date >= %(from_date)s and posting_date <= %(to_date)s and is_cancelled = 0 order by account, posting_date""".format( - condition=condition), - gl_filters, as_dict=True) #nosec + dimension=frappe.scrub(filters.get("dimension")), condition=condition + ), + gl_filters, + as_dict=True, + ) # nosec - for entry in gl_entries: - entry['dimension_item'] = ''.join(item) - gl_entries_by_account.setdefault(entry.account, []).append(entry) + for entry in gl_entries: + gl_entries_by_account.setdefault(entry.account, []).append(entry) -def format_gl_entries(gl_entries_by_account, accounts_by_name, dimension_items_list): + +def format_gl_entries(gl_entries_by_account, accounts_by_name, dimension_list, dimension_type): for entries in itervalues(gl_entries_by_account): for entry in entries: d = accounts_by_name.get(entry.account) if not d: frappe.msgprint( - _("Could not retrieve information for {0}.").format(entry.account), title="Error", - raise_exception=1 + _("Could not retrieve information for {0}.").format(entry.account), + title="Error", + raise_exception=1, ) - for item in dimension_items_list: - if item == entry.dimension_item: - d[frappe.scrub(item)] = d.get(frappe.scrub(item), 0.0) + flt(entry.debit) - flt(entry.credit) -def prepare_data(accounts, filters, parent_children_map, company_currency, dimension_items_list): + for dimension in dimension_list: + if dimension == entry.get(dimension_type): + d[frappe.scrub(dimension)] = ( + d.get(frappe.scrub(dimension), 0.0) + flt(entry.debit) - flt(entry.credit) + ) + + +def prepare_data(accounts, filters, company_currency, dimension_list): data = [] for d in accounts: @@ -132,17 +151,18 @@ def prepare_data(accounts, filters, parent_children_map, company_currency, dimen "from_date": filters.from_date, "to_date": filters.to_date, "currency": company_currency, - "account_name": ('{} - {}'.format(d.account_number, d.account_name) - if d.account_number else d.account_name) + "account_name": ( + "{} - {}".format(d.account_number, d.account_name) if d.account_number else d.account_name + ), } - for item in dimension_items_list: - row[frappe.scrub(item)] = flt(d.get(frappe.scrub(item), 0.0), 3) + for dimension in dimension_list: + row[frappe.scrub(dimension)] = flt(d.get(frappe.scrub(dimension), 0.0), 3) - if abs(row[frappe.scrub(item)]) >= 0.005: + if abs(row[frappe.scrub(dimension)]) >= 0.005: # ignore zero values has_value = True - total += flt(d.get(frappe.scrub(item), 0.0), 3) + total += flt(d.get(frappe.scrub(dimension), 0.0), 3) row["has_value"] = has_value row["total"] = total @@ -150,68 +170,72 @@ def prepare_data(accounts, filters, parent_children_map, company_currency, dimen return data -def accumulate_values_into_parents(accounts, accounts_by_name, dimension_items_list): + +def accumulate_values_into_parents(accounts, accounts_by_name, dimension_list): """accumulate children's values in parent accounts""" for d in reversed(accounts): if d.parent_account: - for item in dimension_items_list: - accounts_by_name[d.parent_account][frappe.scrub(item)] = \ - accounts_by_name[d.parent_account].get(frappe.scrub(item), 0.0) + d.get(frappe.scrub(item), 0.0) + for dimension in dimension_list: + accounts_by_name[d.parent_account][frappe.scrub(dimension)] = accounts_by_name[ + d.parent_account + ].get(frappe.scrub(dimension), 0.0) + d.get(frappe.scrub(dimension), 0.0) -def get_condition(from_date, item, dimension): + +def get_condition(dimension): conditions = [] - if from_date: - conditions.append("posting_date >= %(from_date)s") - if dimension: - if dimension not in ['Cost Center', 'Project']: - if dimension in ['Customer', 'Supplier']: - dimension = 'Party' - else: - dimension = 'Voucher No' - txt = "{0} = %(item)s".format(frappe.scrub(dimension)) - conditions.append(txt) + conditions.append("{0} in %(dimensions)s".format(frappe.scrub(dimension))) return " and {}".format(" and ".join(conditions)) if conditions else "" -def get_dimension_items_list(dimension, company): - meta = frappe.get_meta(dimension, cached=False) - fieldnames = [d.fieldname for d in meta.get("fields")] - filters = {} - if 'company' in fieldnames: - filters['company'] = company - return frappe.get_all(dimension, filters, as_list=True) -def get_columns(dimension_items_list, accumulated_values=1, company=None): - columns = [{ - "fieldname": "account", - "label": _("Account"), - "fieldtype": "Link", - "options": "Account", - "width": 300 - }] - if company: - columns.append({ +def get_dimensions(filters): + meta = frappe.get_meta(filters.get("dimension"), cached=False) + query_filters = {} + + if meta.has_field("company"): + query_filters = {"company": filters.get("company")} + + return frappe.get_all(filters.get("dimension"), filters=query_filters, pluck="name") + + +def get_columns(dimension_list): + columns = [ + { + "fieldname": "account", + "label": _("Account"), + "fieldtype": "Link", + "options": "Account", + "width": 300, + }, + { "fieldname": "currency", "label": _("Currency"), "fieldtype": "Link", "options": "Currency", - "hidden": 1 - }) - for item in dimension_items_list: - columns.append({ - "fieldname": frappe.scrub(item), - "label": item, - "fieldtype": "Currency", - "options": "currency", - "width": 150 - }) - columns.append({ + "hidden": 1, + }, + ] + + for dimension in dimension_list: + columns.append( + { + "fieldname": frappe.scrub(dimension), + "label": dimension, + "fieldtype": "Currency", + "options": "currency", + "width": 150, + } + ) + + columns.append( + { "fieldname": "total", "label": "Total", "fieldtype": "Currency", "options": "currency", - "width": 150 - }) + "width": 150, + } + ) return columns diff --git a/erpnext/accounts/report/financial_statements.py b/erpnext/accounts/report/financial_statements.py index 7bba2fcbe7d..2a3fbc9bdd7 100644 --- a/erpnext/accounts/report/financial_statements.py +++ b/erpnext/accounts/report/financial_statements.py @@ -1,4 +1,3 @@ - # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt @@ -21,12 +20,22 @@ from erpnext.accounts.report.utils import convert_to_presentation_currency, get_ from erpnext.accounts.utils import get_fiscal_year -def get_period_list(from_fiscal_year, to_fiscal_year, period_start_date, period_end_date, filter_based_on, periodicity, accumulated_values=False, - company=None, reset_period_on_fy_change=True, ignore_fiscal_year=False): +def get_period_list( + from_fiscal_year, + to_fiscal_year, + period_start_date, + period_end_date, + filter_based_on, + periodicity, + accumulated_values=False, + company=None, + reset_period_on_fy_change=True, + ignore_fiscal_year=False, +): """Get a list of dict {"from_date": from_date, "to_date": to_date, "key": key, "label": label} - Periodicity can be (Yearly, Quarterly, Monthly)""" + Periodicity can be (Yearly, Quarterly, Monthly)""" - if filter_based_on == 'Fiscal Year': + if filter_based_on == "Fiscal Year": fiscal_year = get_fiscal_year_data(from_fiscal_year, to_fiscal_year) validate_fiscal_year(fiscal_year, from_fiscal_year, to_fiscal_year) year_start_date = getdate(fiscal_year.year_start_date) @@ -36,12 +45,7 @@ def get_period_list(from_fiscal_year, to_fiscal_year, period_start_date, period_ year_start_date = getdate(period_start_date) year_end_date = getdate(period_end_date) - months_to_add = { - "Yearly": 12, - "Half-Yearly": 6, - "Quarterly": 3, - "Monthly": 1 - }[periodicity] + months_to_add = {"Yearly": 12, "Half-Yearly": 6, "Quarterly": 3, "Monthly": 1}[periodicity] period_list = [] @@ -49,11 +53,9 @@ def get_period_list(from_fiscal_year, to_fiscal_year, period_start_date, period_ months = get_months(year_start_date, year_end_date) for i in range(cint(math.ceil(months / months_to_add))): - period = frappe._dict({ - "from_date": start_date - }) + period = frappe._dict({"from_date": start_date}) - if i==0 and filter_based_on == 'Date Range': + if i == 0 and filter_based_on == "Date Range": to_date = add_months(get_first_day(start_date), months_to_add) else: to_date = add_months(start_date, months_to_add) @@ -93,32 +95,38 @@ def get_period_list(from_fiscal_year, to_fiscal_year, period_start_date, period_ else: label = get_label(periodicity, period_list[0].from_date, opts["to_date"]) - opts.update({ - "key": key.replace(" ", "_").replace("-", "_"), - "label": label, - "year_start_date": year_start_date, - "year_end_date": year_end_date - }) + opts.update( + { + "key": key.replace(" ", "_").replace("-", "_"), + "label": label, + "year_start_date": year_start_date, + "year_end_date": year_end_date, + } + ) return period_list def get_fiscal_year_data(from_fiscal_year, to_fiscal_year): - fiscal_year = frappe.db.sql("""select min(year_start_date) as year_start_date, + fiscal_year = frappe.db.sql( + """select min(year_start_date) as year_start_date, max(year_end_date) as year_end_date from `tabFiscal Year` where name between %(from_fiscal_year)s and %(to_fiscal_year)s""", - {'from_fiscal_year': from_fiscal_year, 'to_fiscal_year': to_fiscal_year}, as_dict=1) + {"from_fiscal_year": from_fiscal_year, "to_fiscal_year": to_fiscal_year}, + as_dict=1, + ) return fiscal_year[0] if fiscal_year else {} def validate_fiscal_year(fiscal_year, from_fiscal_year, to_fiscal_year): - if not fiscal_year.get('year_start_date') or not fiscal_year.get('year_end_date'): + if not fiscal_year.get("year_start_date") or not fiscal_year.get("year_end_date"): frappe.throw(_("Start Year and End Year are mandatory")) - if getdate(fiscal_year.get('year_end_date')) < getdate(fiscal_year.get('year_start_date')): + if getdate(fiscal_year.get("year_end_date")) < getdate(fiscal_year.get("year_start_date")): frappe.throw(_("End Year cannot be before Start Year")) + def validate_dates(from_date, to_date): if not from_date or not to_date: frappe.throw(_("From Date and To Date are mandatory")) @@ -126,6 +134,7 @@ def validate_dates(from_date, to_date): if to_date < from_date: frappe.throw(_("To Date cannot be less than From Date")) + def get_months(start_date, end_date): diff = (12 * end_date.year + end_date.month) - (12 * start_date.year + start_date.month) return diff + 1 @@ -144,9 +153,17 @@ def get_label(periodicity, from_date, to_date): def get_data( - company, root_type, balance_must_be, period_list, filters=None, - accumulated_values=1, only_current_fiscal_year=True, ignore_closing_entries=False, - ignore_accumulated_values_for_fy=False , total = True): + company, + root_type, + balance_must_be, + period_list, + filters=None, + accumulated_values=1, + only_current_fiscal_year=True, + ignore_closing_entries=False, + ignore_accumulated_values_for_fy=False, + total=True, +): accounts = get_accounts(company, root_type) if not accounts: @@ -157,19 +174,31 @@ def get_data( company_currency = get_appropriate_currency(company, filters) gl_entries_by_account = {} - for root in frappe.db.sql("""select lft, rgt from tabAccount - where root_type=%s and ifnull(parent_account, '') = ''""", root_type, as_dict=1): + for root in frappe.db.sql( + """select lft, rgt from tabAccount + where root_type=%s and ifnull(parent_account, '') = ''""", + root_type, + as_dict=1, + ): set_gl_entries_by_account( company, period_list[0]["year_start_date"] if only_current_fiscal_year else None, period_list[-1]["to_date"], - root.lft, root.rgt, filters, - gl_entries_by_account, ignore_closing_entries=ignore_closing_entries + root.lft, + root.rgt, + filters, + gl_entries_by_account, + ignore_closing_entries=ignore_closing_entries, ) calculate_values( - accounts_by_name, gl_entries_by_account, period_list, accumulated_values, ignore_accumulated_values_for_fy) + accounts_by_name, + gl_entries_by_account, + period_list, + accumulated_values, + ignore_accumulated_values_for_fy, + ) accumulate_values_into_parents(accounts, accounts_by_name, period_list) out = prepare_data(accounts, balance_must_be, period_list, company_currency) out = filter_out_zero_value_rows(out, parent_children_map) @@ -184,26 +213,32 @@ def get_appropriate_currency(company, filters=None): if filters and filters.get("presentation_currency"): return filters["presentation_currency"] else: - return frappe.get_cached_value('Company', company, "default_currency") + return frappe.get_cached_value("Company", company, "default_currency") def calculate_values( - accounts_by_name, gl_entries_by_account, period_list, accumulated_values, ignore_accumulated_values_for_fy): + accounts_by_name, + gl_entries_by_account, + period_list, + accumulated_values, + ignore_accumulated_values_for_fy, +): for entries in itervalues(gl_entries_by_account): for entry in entries: d = accounts_by_name.get(entry.account) if not d: frappe.msgprint( - _("Could not retrieve information for {0}.").format(entry.account), title="Error", - raise_exception=1 + _("Could not retrieve information for {0}.").format(entry.account), + title="Error", + raise_exception=1, ) for period in period_list: # check if posting date is within the period if entry.posting_date <= period.to_date: - if (accumulated_values or entry.posting_date >= period.from_date) and \ - (not ignore_accumulated_values_for_fy or - entry.fiscal_year == period.to_date_fiscal_year): + if (accumulated_values or entry.posting_date >= period.from_date) and ( + not ignore_accumulated_values_for_fy or entry.fiscal_year == period.to_date_fiscal_year + ): d[period.key] = d.get(period.key, 0.0) + flt(entry.debit) - flt(entry.credit) if entry.posting_date < period_list[0].year_start_date: @@ -215,11 +250,13 @@ def accumulate_values_into_parents(accounts, accounts_by_name, period_list): for d in reversed(accounts): if d.parent_account: for period in period_list: - accounts_by_name[d.parent_account][period.key] = \ - accounts_by_name[d.parent_account].get(period.key, 0.0) + d.get(period.key, 0.0) + accounts_by_name[d.parent_account][period.key] = accounts_by_name[d.parent_account].get( + period.key, 0.0 + ) + d.get(period.key, 0.0) - accounts_by_name[d.parent_account]["opening_balance"] = \ - accounts_by_name[d.parent_account].get("opening_balance", 0.0) + d.get("opening_balance", 0.0) + accounts_by_name[d.parent_account]["opening_balance"] = accounts_by_name[d.parent_account].get( + "opening_balance", 0.0 + ) + d.get("opening_balance", 0.0) def prepare_data(accounts, balance_must_be, period_list, company_currency): @@ -231,20 +268,25 @@ def prepare_data(accounts, balance_must_be, period_list, company_currency): # add to output has_value = False total = 0 - row = frappe._dict({ - "account": _(d.name), - "parent_account": _(d.parent_account) if d.parent_account else '', - "indent": flt(d.indent), - "year_start_date": year_start_date, - "year_end_date": year_end_date, - "currency": company_currency, - "include_in_gross": d.include_in_gross, - "account_type": d.account_type, - "is_group": d.is_group, - "opening_balance": d.get("opening_balance", 0.0) * (1 if balance_must_be=="Debit" else -1), - "account_name": ('%s - %s' %(_(d.account_number), _(d.account_name)) - if d.account_number else _(d.account_name)) - }) + row = frappe._dict( + { + "account": _(d.name), + "parent_account": _(d.parent_account) if d.parent_account else "", + "indent": flt(d.indent), + "year_start_date": year_start_date, + "year_end_date": year_end_date, + "currency": company_currency, + "include_in_gross": d.include_in_gross, + "account_type": d.account_type, + "is_group": d.is_group, + "opening_balance": d.get("opening_balance", 0.0) * (1 if balance_must_be == "Debit" else -1), + "account_name": ( + "%s - %s" % (_(d.account_number), _(d.account_name)) + if d.account_number + else _(d.account_name) + ), + } + ) for period in period_list: if d.get(period.key) and balance_must_be == "Credit": # change sign based on Debit or Credit, since calculation is done using (debit - credit) @@ -285,7 +327,8 @@ def add_total_row(out, root_type, balance_must_be, period_list, company_currency total_row = { "account_name": _("Total {0} ({1})").format(_(root_type), _(balance_must_be)), "account": _("Total {0} ({1})").format(_(root_type), _(balance_must_be)), - "currency": company_currency + "currency": company_currency, + "opening_balance": 0.0, } for row in out: @@ -297,6 +340,7 @@ def add_total_row(out, root_type, balance_must_be, period_list, company_currency total_row.setdefault("total", 0.0) total_row["total"] += flt(row["total"]) + total_row["opening_balance"] += row["opening_balance"] row["total"] = "" if "total" in total_row: @@ -307,10 +351,14 @@ def add_total_row(out, root_type, balance_must_be, period_list, company_currency def get_accounts(company, root_type): - return frappe.db.sql(""" + return frappe.db.sql( + """ select name, account_number, parent_account, lft, rgt, root_type, report_type, account_name, include_in_gross, account_type, is_group, lft, rgt from `tabAccount` - where company=%s and root_type=%s order by lft""", (company, root_type), as_dict=True) + where company=%s and root_type=%s order by lft""", + (company, root_type), + as_dict=True, + ) def filter_accounts(accounts, depth=20): @@ -325,7 +373,7 @@ def filter_accounts(accounts, depth=20): def add_to_list(parent, level): if level < depth: children = parent_children_map.get(parent) or [] - sort_accounts(children, is_root=True if parent==None else False) + sort_accounts(children, is_root=True if parent == None else False) for child in children: child.indent = level @@ -341,7 +389,7 @@ def sort_accounts(accounts, is_root=False, key="name"): """Sort root types as Asset, Liability, Equity, Income, Expense""" def compare_accounts(a, b): - if re.split(r'\W+', a[key])[0].isdigit(): + if re.split(r"\W+", a[key])[0].isdigit(): # if chart of accounts is numbered, then sort by number return cmp(a[key], b[key]) elif is_root: @@ -358,40 +406,50 @@ def sort_accounts(accounts, is_root=False, key="name"): return cmp(a[key], b[key]) return 1 - accounts.sort(key = functools.cmp_to_key(compare_accounts)) + accounts.sort(key=functools.cmp_to_key(compare_accounts)) + def set_gl_entries_by_account( - company, from_date, to_date, root_lft, root_rgt, filters, gl_entries_by_account, ignore_closing_entries=False): + company, + from_date, + to_date, + root_lft, + root_rgt, + filters, + gl_entries_by_account, + ignore_closing_entries=False, +): """Returns a dict like { "account": [gl entries], ... }""" additional_conditions = get_additional_conditions(from_date, ignore_closing_entries, filters) - accounts = frappe.db.sql_list("""select name from `tabAccount` - where lft >= %s and rgt <= %s and company = %s""", (root_lft, root_rgt, company)) + accounts = frappe.db.sql_list( + """select name from `tabAccount` + where lft >= %s and rgt <= %s and company = %s""", + (root_lft, root_rgt, company), + ) if accounts: - additional_conditions += " and account in ({})"\ - .format(", ".join(frappe.db.escape(d) for d in accounts)) + additional_conditions += " and account in ({})".format( + ", ".join(frappe.db.escape(d) for d in accounts) + ) gl_filters = { "company": company, "from_date": from_date, "to_date": to_date, - "finance_book": cstr(filters.get("finance_book")) + "finance_book": cstr(filters.get("finance_book")), } if filters.get("include_default_book_entries"): - gl_filters["company_fb"] = frappe.db.get_value("Company", - company, 'default_finance_book') + gl_filters["company_fb"] = frappe.db.get_value("Company", company, "default_finance_book") for key, value in filters.items(): if value: - gl_filters.update({ - key: value - }) + gl_filters.update({key: value}) distributed_cost_center_query = "" - if filters and filters.get('cost_center'): + if filters and filters.get("cost_center"): distributed_cost_center_query = """ UNION ALL SELECT posting_date, @@ -416,19 +474,26 @@ def set_gl_entries_by_account( AND posting_date <= %(to_date)s AND is_cancelled = 0 AND cost_center = DCC_allocation.parent - """.format(additional_conditions=additional_conditions.replace("and cost_center in %(cost_center)s ", '')) + """.format( + additional_conditions=additional_conditions.replace("and cost_center in %(cost_center)s ", "") + ) - gl_entries = frappe.db.sql("""select posting_date, account, debit, credit, is_opening, fiscal_year, debit_in_account_currency, credit_in_account_currency, account_currency from `tabGL Entry` + gl_entries = frappe.db.sql( + """select posting_date, account, debit, credit, is_opening, fiscal_year, debit_in_account_currency, credit_in_account_currency, account_currency from `tabGL Entry` where company=%(company)s {additional_conditions} and posting_date <= %(to_date)s and is_cancelled = 0 {distributed_cost_center_query}""".format( additional_conditions=additional_conditions, - distributed_cost_center_query=distributed_cost_center_query), gl_filters, as_dict=True) #nosec + distributed_cost_center_query=distributed_cost_center_query, + ), + gl_filters, + as_dict=True, + ) # nosec - if filters and filters.get('presentation_currency'): - convert_to_presentation_currency(gl_entries, get_currency(filters), filters.get('company')) + if filters and filters.get("presentation_currency"): + convert_to_presentation_currency(gl_entries, get_currency(filters), filters.get("company")) for entry in gl_entries: gl_entries_by_account.setdefault(entry.account, []).append(entry) @@ -459,25 +524,29 @@ def get_additional_conditions(from_date, ignore_closing_entries, filters): additional_conditions.append("cost_center in %(cost_center)s") if filters.get("include_default_book_entries"): - additional_conditions.append("(finance_book in (%(finance_book)s, %(company_fb)s, '') OR finance_book IS NULL)") + additional_conditions.append( + "(finance_book in (%(finance_book)s, %(company_fb)s, '') OR finance_book IS NULL)" + ) else: additional_conditions.append("(finance_book in (%(finance_book)s, '') OR finance_book IS NULL)") if accounting_dimensions: for dimension in accounting_dimensions: if filters.get(dimension.fieldname): - if frappe.get_cached_value('DocType', dimension.document_type, 'is_tree'): - filters[dimension.fieldname] = get_dimension_with_children(dimension.document_type, - filters.get(dimension.fieldname)) + if frappe.get_cached_value("DocType", dimension.document_type, "is_tree"): + filters[dimension.fieldname] = get_dimension_with_children( + dimension.document_type, filters.get(dimension.fieldname) + ) additional_conditions.append("{0} in %({0})s".format(dimension.fieldname)) else: - additional_conditions.append("{0} in (%({0})s)".format(dimension.fieldname)) + additional_conditions.append("{0} in %({0})s".format(dimension.fieldname)) return " and {}".format(" and ".join(additional_conditions)) if additional_conditions else "" + def get_cost_centers_with_children(cost_centers): if not isinstance(cost_centers, list): - cost_centers = [d.strip() for d in cost_centers.strip().split(',') if d] + cost_centers = [d.strip() for d in cost_centers.strip().split(",") if d] all_cost_centers = [] for d in cost_centers: @@ -490,45 +559,50 @@ def get_cost_centers_with_children(cost_centers): return list(set(all_cost_centers)) + def get_columns(periodicity, period_list, accumulated_values=1, company=None): - columns = [{ - "fieldname": "account", - "label": _("Account"), - "fieldtype": "Link", - "options": "Account", - "width": 300 - }] - if company: - columns.append({ - "fieldname": "currency", - "label": _("Currency"), + columns = [ + { + "fieldname": "account", + "label": _("Account"), "fieldtype": "Link", - "options": "Currency", - "hidden": 1 - }) + "options": "Account", + "width": 300, + } + ] + if company: + columns.append( + { + "fieldname": "currency", + "label": _("Currency"), + "fieldtype": "Link", + "options": "Currency", + "hidden": 1, + } + ) for period in period_list: - columns.append({ - "fieldname": period.key, - "label": period.label, - "fieldtype": "Currency", - "options": "currency", - "width": 150 - }) - if periodicity!="Yearly": - if not accumulated_values: - columns.append({ - "fieldname": "total", - "label": _("Total"), + columns.append( + { + "fieldname": period.key, + "label": period.label, "fieldtype": "Currency", - "width": 150 - }) + "options": "currency", + "width": 150, + } + ) + if periodicity != "Yearly": + if not accumulated_values: + columns.append( + {"fieldname": "total", "label": _("Total"), "fieldtype": "Currency", "width": 150} + ) return columns + def get_filtered_list_for_consolidated_report(filters, period_list): filtered_summary_list = [] for period in period_list: - if period == filters.get('company'): + if period == filters.get("company"): filtered_summary_list.append(period) return filtered_summary_list diff --git a/erpnext/accounts/report/general_ledger/general_ledger.js b/erpnext/accounts/report/general_ledger/general_ledger.js index b2968761c63..010284c2ea5 100644 --- a/erpnext/accounts/report/general_ledger/general_ledger.js +++ b/erpnext/accounts/report/general_ledger/general_ledger.js @@ -167,7 +167,7 @@ frappe.query_reports["General Ledger"] = { "fieldname": "include_dimensions", "label": __("Consider Accounting Dimensions"), "fieldtype": "Check", - "default": 0 + "default": 1 }, { "fieldname": "show_opening_entries", diff --git a/erpnext/accounts/report/general_ledger/general_ledger.py b/erpnext/accounts/report/general_ledger/general_ledger.py index 9aad52137b4..98c81086ab2 100644 --- a/erpnext/accounts/report/general_ledger/general_ledger.py +++ b/erpnext/accounts/report/general_ledger/general_ledger.py @@ -21,20 +21,20 @@ from erpnext.accounts.utils import get_account_currency # to cache translations TRANSLATIONS = frappe._dict() + def execute(filters=None): if not filters: return [], [] account_details = {} - if filters and filters.get('print_in_account_currency') and \ - not filters.get('account'): + if filters and filters.get("print_in_account_currency") and not filters.get("account"): frappe.throw(_("Select an account to print in account currency")) for acc in frappe.db.sql("""select name, is_group from tabAccount""", as_dict=1): account_details.setdefault(acc.name, acc) - if filters.get('party'): + if filters.get("party"): filters.party = frappe.parse_json(filters.get("party")) validate_filters(filters, account_details) @@ -51,46 +51,45 @@ def execute(filters=None): return columns, res + def update_translations(): TRANSLATIONS.update( - dict( - OPENING = _('Opening'), - TOTAL = _('Total'), - CLOSING_TOTAL = _('Closing (Opening + Total)') - ) + dict(OPENING=_("Opening"), TOTAL=_("Total"), CLOSING_TOTAL=_("Closing (Opening + Total)")) ) + def validate_filters(filters, account_details): if not filters.get("company"): frappe.throw(_("{0} is mandatory").format(_("Company"))) if not filters.get("from_date") and not filters.get("to_date"): - frappe.throw(_("{0} and {1} are mandatory").format(frappe.bold(_("From Date")), frappe.bold(_("To Date")))) + frappe.throw( + _("{0} and {1} are mandatory").format(frappe.bold(_("From Date")), frappe.bold(_("To Date"))) + ) - if filters.get('account'): - filters.account = frappe.parse_json(filters.get('account')) + if filters.get("account"): + filters.account = frappe.parse_json(filters.get("account")) for account in filters.account: if not account_details.get(account): frappe.throw(_("Account {0} does not exists").format(account)) - if (filters.get("account") and filters.get("group_by") == 'Group by Account'): - filters.account = frappe.parse_json(filters.get('account')) + if filters.get("account") and filters.get("group_by") == "Group by Account": + filters.account = frappe.parse_json(filters.get("account")) for account in filters.account: if account_details[account].is_group == 0: frappe.throw(_("Can not filter based on Child Account, if grouped by Account")) - if (filters.get("voucher_no") - and filters.get("group_by") in ['Group by Voucher']): + if filters.get("voucher_no") and filters.get("group_by") in ["Group by Voucher"]: frappe.throw(_("Can not filter based on Voucher No, if grouped by Voucher")) if filters.from_date > filters.to_date: frappe.throw(_("From Date must be before To Date")) - if filters.get('project'): - filters.project = frappe.parse_json(filters.get('project')) + if filters.get("project"): + filters.project = frappe.parse_json(filters.get("project")) - if filters.get('cost_center'): - filters.cost_center = frappe.parse_json(filters.get('cost_center')) + if filters.get("cost_center"): + filters.cost_center = frappe.parse_json(filters.get("cost_center")) def validate_party(filters): @@ -101,9 +100,12 @@ def validate_party(filters): if not frappe.db.exists(party_type, d): frappe.throw(_("Invalid {0}: {1}").format(party_type, d)) + def set_account_currency(filters): - if filters.get("account") or (filters.get('party') and len(filters.party) == 1): - filters["company_currency"] = frappe.get_cached_value('Company', filters.company, "default_currency") + if filters.get("account") or (filters.get("party") and len(filters.party) == 1): + filters["company_currency"] = frappe.get_cached_value( + "Company", filters.company, "default_currency" + ) account_currency = None if filters.get("account"): @@ -122,17 +124,19 @@ def set_account_currency(filters): elif filters.get("party"): gle_currency = frappe.db.get_value( - "GL Entry", { - "party_type": filters.party_type, "party": filters.party[0], "company": filters.company - }, - "account_currency" + "GL Entry", + {"party_type": filters.party_type, "party": filters.party[0], "company": filters.company}, + "account_currency", ) if gle_currency: account_currency = gle_currency else: - account_currency = (None if filters.party_type in ["Employee", "Student", "Shareholder", "Member"] else - frappe.db.get_value(filters.party_type, filters.party[0], "default_currency")) + account_currency = ( + None + if filters.party_type in ["Employee", "Student", "Shareholder", "Member"] + else frappe.db.get_value(filters.party_type, filters.party[0], "default_currency") + ) filters["account_currency"] = account_currency or filters.company_currency if filters.account_currency != filters.company_currency and not filters.presentation_currency: @@ -140,6 +144,7 @@ def set_account_currency(filters): return filters + def get_result(filters, account_details): accounting_dimensions = [] if filters.get("include_dimensions"): @@ -147,13 +152,13 @@ def get_result(filters, account_details): gl_entries = get_gl_entries(filters, accounting_dimensions) - data = get_data_with_opening_closing(filters, account_details, - accounting_dimensions, gl_entries) + data = get_data_with_opening_closing(filters, account_details, accounting_dimensions, gl_entries) result = get_result_as_list(data, filters) return result + def get_gl_entries(filters, accounting_dimensions): currency_map = get_currency(filters) select_fields = """, debit, credit, debit_in_account_currency, @@ -170,15 +175,16 @@ def get_gl_entries(filters, accounting_dimensions): order_by_statement = "order by account, posting_date, creation" if filters.get("include_default_book_entries"): - filters['company_fb'] = frappe.db.get_value("Company", - filters.get("company"), 'default_finance_book') + filters["company_fb"] = frappe.db.get_value( + "Company", filters.get("company"), "default_finance_book" + ) dimension_fields = "" if accounting_dimensions: - dimension_fields = ', '.join(accounting_dimensions) + ',' + dimension_fields = ", ".join(accounting_dimensions) + "," distributed_cost_center_query = "" - if filters and filters.get('cost_center'): + if filters and filters.get("cost_center"): select_fields_with_percentage = """, debit*(DCC_allocation.percentage_allocation/100) as debit, credit*(DCC_allocation.percentage_allocation/100) as credit, debit_in_account_currency*(DCC_allocation.percentage_allocation/100) as debit_in_account_currency, @@ -211,7 +217,11 @@ def get_gl_entries(filters, accounting_dimensions): {conditions} AND posting_date <= %(to_date)s AND cost_center = DCC_allocation.parent - """.format(dimension_fields=dimension_fields,select_fields_with_percentage=select_fields_with_percentage, conditions=get_conditions(filters).replace("and cost_center in %(cost_center)s ", '')) + """.format( + dimension_fields=dimension_fields, + select_fields_with_percentage=select_fields_with_percentage, + conditions=get_conditions(filters).replace("and cost_center in %(cost_center)s ", ""), + ) gl_entries = frappe.db.sql( """ @@ -226,13 +236,18 @@ def get_gl_entries(filters, accounting_dimensions): {distributed_cost_center_query} {order_by_statement} """.format( - dimension_fields=dimension_fields, select_fields=select_fields, conditions=get_conditions(filters), distributed_cost_center_query=distributed_cost_center_query, - order_by_statement=order_by_statement + dimension_fields=dimension_fields, + select_fields=select_fields, + conditions=get_conditions(filters), + distributed_cost_center_query=distributed_cost_center_query, + order_by_statement=order_by_statement, ), - filters, as_dict=1) + filters, + as_dict=1, + ) - if filters.get('presentation_currency'): - return convert_to_presentation_currency(gl_entries, currency_map, filters.get('company')) + if filters.get("presentation_currency"): + return convert_to_presentation_currency(gl_entries, currency_map, filters.get("company")) else: return gl_entries @@ -260,18 +275,23 @@ def get_conditions(filters): if filters.get("party"): conditions.append("party in %(party)s") - if not (filters.get("account") or filters.get("party") or - filters.get("group_by") in ["Group by Account", "Group by Party"]): - conditions.append("posting_date >=%(from_date)s") + if not ( + filters.get("account") + or filters.get("party") + or filters.get("group_by") in ["Group by Account", "Group by Party"] + ): + conditions.append("(posting_date >=%(from_date)s or is_opening = 'Yes')") - conditions.append("(posting_date <=%(to_date)s or is_opening = 'Yes')") + conditions.append("(posting_date <=%(to_date)s)") if filters.get("project"): conditions.append("project in %(project)s") if filters.get("finance_book"): if filters.get("include_default_book_entries"): - conditions.append("(finance_book in (%(finance_book)s, %(company_fb)s, '') OR finance_book IS NULL)") + conditions.append( + "(finance_book in (%(finance_book)s, %(company_fb)s, '') OR finance_book IS NULL)" + ) else: conditions.append("finance_book in (%(finance_book)s)") @@ -279,6 +299,7 @@ def get_conditions(filters): conditions.append("is_cancelled = 0") from frappe.desk.reportview import build_match_conditions + match_conditions = build_match_conditions("GL Entry") if match_conditions: @@ -291,18 +312,20 @@ def get_conditions(filters): for dimension in accounting_dimensions: if not dimension.disabled: if filters.get(dimension.fieldname): - if frappe.get_cached_value('DocType', dimension.document_type, 'is_tree'): - filters[dimension.fieldname] = get_dimension_with_children(dimension.document_type, - filters.get(dimension.fieldname)) + if frappe.get_cached_value("DocType", dimension.document_type, "is_tree"): + filters[dimension.fieldname] = get_dimension_with_children( + dimension.document_type, filters.get(dimension.fieldname) + ) conditions.append("{0} in %({0})s".format(dimension.fieldname)) else: - conditions.append("{0} in (%({0})s)".format(dimension.fieldname)) + conditions.append("{0} in %({0})s".format(dimension.fieldname)) return "and {}".format(" and ".join(conditions)) if conditions else "" + def get_accounts_with_children(accounts): if not isinstance(accounts, list): - accounts = [d.strip() for d in accounts.strip().split(',') if d] + accounts = [d.strip() for d in accounts.strip().split(",") if d] all_accounts = [] for d in accounts: @@ -315,6 +338,7 @@ def get_accounts_with_children(accounts): return list(set(all_accounts)) + def get_data_with_opening_closing(filters, account_details, accounting_dimensions, gl_entries): data = [] @@ -325,7 +349,7 @@ def get_data_with_opening_closing(filters, account_details, accounting_dimension # Opening for filtered account data.append(totals.opening) - if filters.get("group_by") != 'Group by Voucher (Consolidated)': + if filters.get("group_by") != "Group by Voucher (Consolidated)": for acc, acc_dict in iteritems(gle_map): # acc if acc_dict.entries: @@ -354,6 +378,7 @@ def get_data_with_opening_closing(filters, account_details, accounting_dimension return data + def get_totals_dict(): def _get_debit_credit_dict(label): return _dict( @@ -361,25 +386,28 @@ def get_totals_dict(): debit=0.0, credit=0.0, debit_in_account_currency=0.0, - credit_in_account_currency=0.0 + credit_in_account_currency=0.0, ) + return _dict( - opening = _get_debit_credit_dict(TRANSLATIONS.OPENING), - total = _get_debit_credit_dict(TRANSLATIONS.TOTAL), - closing = _get_debit_credit_dict(TRANSLATIONS.CLOSING_TOTAL) + opening=_get_debit_credit_dict(TRANSLATIONS.OPENING), + total=_get_debit_credit_dict(TRANSLATIONS.TOTAL), + closing=_get_debit_credit_dict(TRANSLATIONS.CLOSING_TOTAL), ) + def group_by_field(group_by): - if group_by == 'Group by Party': - return 'party' - elif group_by in ['Group by Voucher (Consolidated)', 'Group by Account']: - return 'account' + if group_by == "Group by Party": + return "party" + elif group_by in ["Group by Voucher (Consolidated)", "Group by Account"]: + return "account" else: - return 'voucher_no' + return "voucher_no" + def initialize_gle_map(gl_entries, filters): gle_map = OrderedDict() - group_by = group_by_field(filters.get('group_by')) + group_by = group_by_field(filters.get("group_by")) for gle in gl_entries: gle_map.setdefault(gle.get(group_by), _dict(totals=get_totals_dict(), entries=[])) @@ -390,11 +418,11 @@ def get_accountwise_gle(filters, accounting_dimensions, gl_entries, gle_map): totals = get_totals_dict() entries = [] consolidated_gle = OrderedDict() - group_by = group_by_field(filters.get('group_by')) - group_by_voucher_consolidated = filters.get("group_by") == 'Group by Voucher (Consolidated)' + group_by = group_by_field(filters.get("group_by")) + group_by_voucher_consolidated = filters.get("group_by") == "Group by Voucher (Consolidated)" - if filters.get('show_net_values_in_party_account'): - account_type_map = get_account_type_map(filters.get('company')) + if filters.get("show_net_values_in_party_account"): + account_type_map = get_account_type_map(filters.get("company")) def update_value_in_dict(data, key, gle): data[key].debit += gle.debit @@ -403,26 +431,28 @@ def get_accountwise_gle(filters, accounting_dimensions, gl_entries, gle_map): data[key].debit_in_account_currency += gle.debit_in_account_currency data[key].credit_in_account_currency += gle.credit_in_account_currency - if filters.get('show_net_values_in_party_account') and \ - account_type_map.get(data[key].account) in ('Receivable', 'Payable'): + if filters.get("show_net_values_in_party_account") and account_type_map.get( + data[key].account + ) in ("Receivable", "Payable"): net_value = data[key].debit - data[key].credit - net_value_in_account_currency = data[key].debit_in_account_currency \ - - data[key].credit_in_account_currency + net_value_in_account_currency = ( + data[key].debit_in_account_currency - data[key].credit_in_account_currency + ) if net_value < 0: - dr_or_cr = 'credit' - rev_dr_or_cr = 'debit' + dr_or_cr = "credit" + rev_dr_or_cr = "debit" else: - dr_or_cr = 'debit' - rev_dr_or_cr = 'credit' + dr_or_cr = "debit" + rev_dr_or_cr = "credit" data[key][dr_or_cr] = abs(net_value) - data[key][dr_or_cr+'_in_account_currency'] = abs(net_value_in_account_currency) + data[key][dr_or_cr + "_in_account_currency"] = abs(net_value_in_account_currency) data[key][rev_dr_or_cr] = 0 - data[key][rev_dr_or_cr+'_in_account_currency'] = 0 + data[key][rev_dr_or_cr + "_in_account_currency"] = 0 if data[key].against_voucher and gle.against_voucher: - data[key].against_voucher += ', ' + gle.against_voucher + data[key].against_voucher += ", " + gle.against_voucher from_date, to_date = getdate(filters.from_date), getdate(filters.to_date) show_opening_entries = filters.get("show_opening_entries") @@ -430,28 +460,36 @@ def get_accountwise_gle(filters, accounting_dimensions, gl_entries, gle_map): for gle in gl_entries: group_by_value = gle.get(group_by) - if (gle.posting_date < from_date or (cstr(gle.is_opening) == "Yes" and not show_opening_entries)): + if gle.posting_date < from_date or (cstr(gle.is_opening) == "Yes" and not show_opening_entries): if not group_by_voucher_consolidated: - update_value_in_dict(gle_map[group_by_value].totals, 'opening', gle) - update_value_in_dict(gle_map[group_by_value].totals, 'closing', gle) + update_value_in_dict(gle_map[group_by_value].totals, "opening", gle) + update_value_in_dict(gle_map[group_by_value].totals, "closing", gle) - update_value_in_dict(totals, 'opening', gle) - update_value_in_dict(totals, 'closing', gle) + update_value_in_dict(totals, "opening", gle) + update_value_in_dict(totals, "closing", gle) - elif gle.posting_date <= to_date: + elif gle.posting_date <= to_date or (cstr(gle.is_opening) == "Yes" and show_opening_entries): if not group_by_voucher_consolidated: - update_value_in_dict(gle_map[group_by_value].totals, 'total', gle) - update_value_in_dict(gle_map[group_by_value].totals, 'closing', gle) - update_value_in_dict(totals, 'total', gle) - update_value_in_dict(totals, 'closing', gle) + update_value_in_dict(gle_map[group_by_value].totals, "total", gle) + update_value_in_dict(gle_map[group_by_value].totals, "closing", gle) + update_value_in_dict(totals, "total", gle) + update_value_in_dict(totals, "closing", gle) gle_map[group_by_value].entries.append(gle) elif group_by_voucher_consolidated: - keylist = [gle.get("voucher_type"), gle.get("voucher_no"), gle.get("account")] - for dim in accounting_dimensions: - keylist.append(gle.get(dim)) - keylist.append(gle.get("cost_center")) + keylist = [ + gle.get("voucher_type"), + gle.get("voucher_no"), + gle.get("account"), + gle.get("party_type"), + gle.get("party"), + ] + if filters.get("include_dimensions"): + for dim in accounting_dimensions: + keylist.append(gle.get(dim)) + keylist.append(gle.get("cost_center")) + key = tuple(keylist) if key not in consolidated_gle: consolidated_gle.setdefault(key, gle) @@ -459,47 +497,58 @@ def get_accountwise_gle(filters, accounting_dimensions, gl_entries, gle_map): update_value_in_dict(consolidated_gle, key, gle) for key, value in consolidated_gle.items(): - update_value_in_dict(totals, 'total', value) - update_value_in_dict(totals, 'closing', value) + update_value_in_dict(totals, "total", value) + update_value_in_dict(totals, "closing", value) entries.append(value) return totals, entries + def get_account_type_map(company): - account_type_map = frappe._dict(frappe.get_all('Account', fields=['name', 'account_type'], - filters={'company': company}, as_list=1)) + account_type_map = frappe._dict( + frappe.get_all( + "Account", fields=["name", "account_type"], filters={"company": company}, as_list=1 + ) + ) return account_type_map + def get_result_as_list(data, filters): balance, balance_in_account_currency = 0, 0 inv_details = get_supplier_invoice_details() for d in data: - if not d.get('posting_date'): + if not d.get("posting_date"): balance, balance_in_account_currency = 0, 0 - balance = get_balance(d, balance, 'debit', 'credit') - d['balance'] = balance + balance = get_balance(d, balance, "debit", "credit") + d["balance"] = balance - d['account_currency'] = filters.account_currency - d['bill_no'] = inv_details.get(d.get('against_voucher'), '') + d["account_currency"] = filters.account_currency + d["bill_no"] = inv_details.get(d.get("against_voucher"), "") return data + def get_supplier_invoice_details(): inv_details = {} - for d in frappe.db.sql(""" select name, bill_no from `tabPurchase Invoice` - where docstatus = 1 and bill_no is not null and bill_no != '' """, as_dict=1): + for d in frappe.db.sql( + """ select name, bill_no from `tabPurchase Invoice` + where docstatus = 1 and bill_no is not null and bill_no != '' """, + as_dict=1, + ): inv_details[d.name] = d.bill_no return inv_details + def get_balance(row, balance, debit_field, credit_field): - balance += (row.get(debit_field, 0) - row.get(credit_field, 0)) + balance += row.get(debit_field, 0) - row.get(credit_field, 0) return balance + def get_columns(filters): if filters.get("presentation_currency"): currency = filters["presentation_currency"] @@ -516,116 +565,75 @@ def get_columns(filters): "fieldname": "gl_entry", "fieldtype": "Link", "options": "GL Entry", - "hidden": 1 - }, - { - "label": _("Posting Date"), - "fieldname": "posting_date", - "fieldtype": "Date", - "width": 90 + "hidden": 1, }, + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 90}, { "label": _("Account"), "fieldname": "account", "fieldtype": "Link", "options": "Account", - "width": 180 + "width": 180, }, { "label": _("Debit ({0})").format(currency), "fieldname": "debit", "fieldtype": "Float", - "width": 100 + "width": 100, }, { "label": _("Credit ({0})").format(currency), "fieldname": "credit", "fieldtype": "Float", - "width": 100 + "width": 100, }, { "label": _("Balance ({0})").format(currency), "fieldname": "balance", "fieldtype": "Float", - "width": 130 - } + "width": 130, + }, ] - columns.extend([ - { - "label": _("Voucher Type"), - "fieldname": "voucher_type", - "width": 120 - }, - { - "label": _("Voucher No"), - "fieldname": "voucher_no", - "fieldtype": "Dynamic Link", - "options": "voucher_type", - "width": 180 - }, - { - "label": _("Against Account"), - "fieldname": "against", - "width": 120 - }, - { - "label": _("Party Type"), - "fieldname": "party_type", - "width": 100 - }, - { - "label": _("Party"), - "fieldname": "party", - "width": 100 - }, - { - "label": _("Project"), - "options": "Project", - "fieldname": "project", - "width": 100 - } - ]) + columns.extend( + [ + {"label": _("Voucher Type"), "fieldname": "voucher_type", "width": 120}, + { + "label": _("Voucher No"), + "fieldname": "voucher_no", + "fieldtype": "Dynamic Link", + "options": "voucher_type", + "width": 180, + }, + {"label": _("Against Account"), "fieldname": "against", "width": 120}, + {"label": _("Party Type"), "fieldname": "party_type", "width": 100}, + {"label": _("Party"), "fieldname": "party", "width": 100}, + {"label": _("Project"), "options": "Project", "fieldname": "project", "width": 100}, + ] + ) if filters.get("include_dimensions"): - for dim in get_accounting_dimensions(as_list = False): - columns.append({ - "label": _(dim.label), - "options": dim.label, - "fieldname": dim.fieldname, - "width": 100 - }) + for dim in get_accounting_dimensions(as_list=False): + columns.append( + {"label": _(dim.label), "options": dim.label, "fieldname": dim.fieldname, "width": 100} + ) + columns.append( + {"label": _("Cost Center"), "options": "Cost Center", "fieldname": "cost_center", "width": 100} + ) - columns.extend([ - { - "label": _("Cost Center"), - "options": "Cost Center", - "fieldname": "cost_center", - "width": 100 - }, - { - "label": _("Against Voucher Type"), - "fieldname": "against_voucher_type", - "width": 100 - }, - { - "label": _("Against Voucher"), - "fieldname": "against_voucher", - "fieldtype": "Dynamic Link", - "options": "against_voucher_type", - "width": 100 - }, - { - "label": _("Supplier Invoice No"), - "fieldname": "bill_no", - "fieldtype": "Data", - "width": 100 - }, - { - "label": _("Remarks"), - "fieldname": "remarks", - "width": 400 - } - ]) + columns.extend( + [ + {"label": _("Against Voucher Type"), "fieldname": "against_voucher_type", "width": 100}, + { + "label": _("Against Voucher"), + "fieldname": "against_voucher", + "fieldtype": "Dynamic Link", + "options": "against_voucher_type", + "width": 100, + }, + {"label": _("Supplier Invoice No"), "fieldname": "bill_no", "fieldtype": "Data", "width": 100}, + {"label": _("Remarks"), "fieldname": "remarks", "width": 400}, + ] + ) return columns diff --git a/erpnext/accounts/report/general_ledger/test_general_ledger.py b/erpnext/accounts/report/general_ledger/test_general_ledger.py new file mode 100644 index 00000000000..b10e7696187 --- /dev/null +++ b/erpnext/accounts/report/general_ledger/test_general_ledger.py @@ -0,0 +1,152 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors +# MIT License. See license.txt + +import frappe +from frappe.tests.utils import FrappeTestCase +from frappe.utils import today + +from erpnext.accounts.report.general_ledger.general_ledger import execute + + +class TestGeneralLedger(FrappeTestCase): + def test_foreign_account_balance_after_exchange_rate_revaluation(self): + """ + Checks the correctness of balance after exchange rate revaluation + """ + # create a new account with USD currency + account_name = "Test USD Account for Revalutation" + company = "_Test Company" + account = frappe.get_doc( + { + "account_name": account_name, + "is_group": 0, + "company": company, + "root_type": "Asset", + "report_type": "Balance Sheet", + "account_currency": "USD", + "inter_company_account": 0, + "parent_account": "Bank Accounts - _TC", + "account_type": "Bank", + "doctype": "Account", + } + ) + account.insert(ignore_if_duplicate=True) + # create a JV to debit 1000 USD at 75 exchange rate + jv = frappe.new_doc("Journal Entry") + jv.posting_date = today() + jv.company = company + jv.multi_currency = 1 + jv.cost_center = "_Test Cost Center - _TC" + jv.set( + "accounts", + [ + { + "account": account.name, + "debit_in_account_currency": 1000, + "credit_in_account_currency": 0, + "exchange_rate": 75, + "cost_center": "_Test Cost Center - _TC", + }, + { + "account": "Cash - _TC", + "debit_in_account_currency": 0, + "credit_in_account_currency": 75000, + "cost_center": "_Test Cost Center - _TC", + }, + ], + ) + jv.save() + jv.submit() + # create a JV to credit 900 USD at 100 exchange rate + jv = frappe.new_doc("Journal Entry") + jv.posting_date = today() + jv.company = company + jv.multi_currency = 1 + jv.cost_center = "_Test Cost Center - _TC" + jv.set( + "accounts", + [ + { + "account": account.name, + "debit_in_account_currency": 0, + "credit_in_account_currency": 900, + "exchange_rate": 100, + "cost_center": "_Test Cost Center - _TC", + }, + { + "account": "Cash - _TC", + "debit_in_account_currency": 90000, + "credit_in_account_currency": 0, + "cost_center": "_Test Cost Center - _TC", + }, + ], + ) + jv.save() + jv.submit() + + # create an exchange rate revaluation entry at 77 exchange rate + revaluation = frappe.new_doc("Exchange Rate Revaluation") + revaluation.posting_date = today() + revaluation.company = company + revaluation.set( + "accounts", + [ + { + "account": account.name, + "account_currency": "USD", + "new_exchange_rate": 77, + "new_balance_in_base_currency": 7700, + "balance_in_base_currency": -15000, + "balance_in_account_currency": 100, + "current_exchange_rate": -150, + } + ], + ) + revaluation.save() + revaluation.submit() + + # post journal entry to revaluate + frappe.db.set_value( + "Company", company, "unrealized_exchange_gain_loss_account", "_Test Exchange Gain/Loss - _TC" + ) + revaluation_jv = revaluation.make_jv_entry() + revaluation_jv = frappe.get_doc(revaluation_jv) + revaluation_jv.cost_center = "_Test Cost Center - _TC" + for acc in revaluation_jv.get("accounts"): + acc.cost_center = "_Test Cost Center - _TC" + revaluation_jv.save() + revaluation_jv.submit() + + # check the balance of the account + balance = frappe.db.sql( + """ + select sum(debit_in_account_currency) - sum(credit_in_account_currency) + from `tabGL Entry` + where account = %s + group by account + """, + account.name, + ) + + self.assertEqual(balance[0][0], 100) + + # check if general ledger shows correct balance + columns, data = execute( + frappe._dict( + { + "company": company, + "from_date": today(), + "to_date": today(), + "account": [account.name], + "group_by": "Group by Voucher (Consolidated)", + } + ) + ) + + self.assertEqual(data[1]["account"], account.name) + self.assertEqual(data[1]["debit"], 1000) + self.assertEqual(data[1]["credit"], 0) + self.assertEqual(data[2]["debit"], 0) + self.assertEqual(data[2]["credit"], 900) + self.assertEqual(data[3]["debit"], 100) + self.assertEqual(data[3]["credit"], 100) diff --git a/erpnext/accounts/report/gross_and_net_profit_report/gross_and_net_profit_report.py b/erpnext/accounts/report/gross_and_net_profit_report/gross_and_net_profit_report.py index b18b940fd2b..cd5f3667071 100644 --- a/erpnext/accounts/report/gross_and_net_profit_report/gross_and_net_profit_report.py +++ b/erpnext/accounts/report/gross_and_net_profit_report/gross_and_net_profit_report.py @@ -12,30 +12,57 @@ from erpnext.accounts.report.financial_statements import get_columns, get_data, def execute(filters=None): - period_list = get_period_list(filters.from_fiscal_year, filters.to_fiscal_year, filters.period_start_date, - filters.period_end_date, filters.filter_based_on, filters.periodicity, filters.accumulated_values, filters.company) + period_list = get_period_list( + filters.from_fiscal_year, + filters.to_fiscal_year, + filters.period_start_date, + filters.period_end_date, + filters.filter_based_on, + filters.periodicity, + filters.accumulated_values, + filters.company, + ) columns, data = [], [] - income = get_data(filters.company, "Income", "Credit", period_list, filters = filters, + income = get_data( + filters.company, + "Income", + "Credit", + period_list, + filters=filters, accumulated_values=filters.accumulated_values, - ignore_closing_entries=True, ignore_accumulated_values_for_fy= True, total= False) + ignore_closing_entries=True, + ignore_accumulated_values_for_fy=True, + total=False, + ) - expense = get_data(filters.company, "Expense", "Debit", period_list, filters=filters, + expense = get_data( + filters.company, + "Expense", + "Debit", + period_list, + filters=filters, accumulated_values=filters.accumulated_values, - ignore_closing_entries=True, ignore_accumulated_values_for_fy= True, total= False) - - columns = get_columns(filters.periodicity, period_list, filters.accumulated_values, filters.company) + ignore_closing_entries=True, + ignore_accumulated_values_for_fy=True, + total=False, + ) + columns = get_columns( + filters.periodicity, period_list, filters.accumulated_values, filters.company + ) gross_income = get_revenue(income, period_list) gross_expense = get_revenue(expense, period_list) - if(len(gross_income)==0 and len(gross_expense)== 0): - data.append({ - "account_name": "'" + _("Nothing is included in gross") + "'", - "account": "'" + _("Nothing is included in gross") + "'" - }) + if len(gross_income) == 0 and len(gross_expense) == 0: + data.append( + { + "account_name": "'" + _("Nothing is included in gross") + "'", + "account": "'" + _("Nothing is included in gross") + "'", + } + ) return columns, data # to avoid error eg: gross_income[0] : list index out of range @@ -44,10 +71,12 @@ def execute(filters=None): if not gross_expense: gross_expense = [{}] - data.append({ - "account_name": "'" + _("Included in Gross Profit") + "'", - "account": "'" + _("Included in Gross Profit") + "'" - }) + data.append( + { + "account_name": "'" + _("Included in Gross Profit") + "'", + "account": "'" + _("Included in Gross Profit") + "'", + } + ) data.append({}) data.extend(gross_income or []) @@ -56,7 +85,14 @@ def execute(filters=None): data.extend(gross_expense or []) data.append({}) - gross_profit = get_profit(gross_income, gross_expense, period_list, filters.company, 'Gross Profit',filters.presentation_currency) + gross_profit = get_profit( + gross_income, + gross_expense, + period_list, + filters.company, + "Gross Profit", + filters.presentation_currency, + ) data.append(gross_profit) non_gross_income = get_revenue(income, period_list, 0) @@ -67,28 +103,40 @@ def execute(filters=None): data.append({}) data.extend(non_gross_expense or []) - net_profit = get_net_profit(non_gross_income, gross_income, gross_expense, non_gross_expense, period_list, filters.company,filters.presentation_currency) + net_profit = get_net_profit( + non_gross_income, + gross_income, + gross_expense, + non_gross_expense, + period_list, + filters.company, + filters.presentation_currency, + ) data.append({}) data.append(net_profit) return columns, data -def get_revenue(data, period_list, include_in_gross=1): - revenue = [item for item in data if item['include_in_gross']==include_in_gross or item['is_group']==1] - data_to_be_removed =True +def get_revenue(data, period_list, include_in_gross=1): + revenue = [ + item for item in data if item["include_in_gross"] == include_in_gross or item["is_group"] == 1 + ] + + data_to_be_removed = True while data_to_be_removed: revenue, data_to_be_removed = remove_parent_with_no_child(revenue, period_list) revenue = adjust_account(revenue, period_list) return copy.deepcopy(revenue) + def remove_parent_with_no_child(data, period_list): data_to_be_removed = False for parent in data: - if 'is_group' in parent and parent.get("is_group") == 1: + if "is_group" in parent and parent.get("is_group") == 1: have_child = False for child in data: - if 'parent_account' in child and child.get("parent_account") == parent.get("account"): + if "parent_account" in child and child.get("parent_account") == parent.get("account"): have_child = True break @@ -98,34 +146,39 @@ def remove_parent_with_no_child(data, period_list): return data, data_to_be_removed -def adjust_account(data, period_list, consolidated= False): - leaf_nodes = [item for item in data if item['is_group'] == 0] + +def adjust_account(data, period_list, consolidated=False): + leaf_nodes = [item for item in data if item["is_group"] == 0] totals = {} for node in leaf_nodes: set_total(node, node["total"], data, totals) for d in data: for period in period_list: key = period if consolidated else period.key - d[key] = totals[d["account"]] - d['total'] = totals[d["account"]] + d["total"] = totals[d["account"]] return data + def set_total(node, value, complete_list, totals): - if not totals.get(node['account']): + if not totals.get(node["account"]): totals[node["account"]] = 0 totals[node["account"]] += value - parent = node['parent_account'] - if not parent == '': - return set_total(next(item for item in complete_list if item['account'] == parent), value, complete_list, totals) + parent = node["parent_account"] + if not parent == "": + return set_total( + next(item for item in complete_list if item["account"] == parent), value, complete_list, totals + ) -def get_profit(gross_income, gross_expense, period_list, company, profit_type, currency=None, consolidated=False): +def get_profit( + gross_income, gross_expense, period_list, company, profit_type, currency=None, consolidated=False +): profit_loss = { "account_name": "'" + _(profit_type) + "'", "account": "'" + _(profit_type) + "'", "warn_if_negative": True, - "currency": currency or frappe.get_cached_value('Company', company, "default_currency") + "currency": currency or frappe.get_cached_value("Company", company, "default_currency"), } has_value = False @@ -137,17 +190,27 @@ def get_profit(gross_income, gross_expense, period_list, company, profit_type, c profit_loss[key] = gross_income_for_period - gross_expense_for_period if profit_loss[key]: - has_value=True + has_value = True if has_value: return profit_loss -def get_net_profit(non_gross_income, gross_income, gross_expense, non_gross_expense, period_list, company, currency=None, consolidated=False): + +def get_net_profit( + non_gross_income, + gross_income, + gross_expense, + non_gross_expense, + period_list, + company, + currency=None, + consolidated=False, +): profit_loss = { "account_name": "'" + _("Net Profit") + "'", "account": "'" + _("Net Profit") + "'", "warn_if_negative": True, - "currency": currency or frappe.get_cached_value('Company', company, "default_currency") + "currency": currency or frappe.get_cached_value("Company", company, "default_currency"), } has_value = False @@ -165,7 +228,7 @@ def get_net_profit(non_gross_income, gross_income, gross_expense, non_gross_expe profit_loss[key] = flt(total_income) - flt(total_expense) if profit_loss[key]: - has_value=True + has_value = True if has_value: return profit_loss diff --git a/erpnext/accounts/report/gross_profit/gross_profit.js b/erpnext/accounts/report/gross_profit/gross_profit.js index 685f2d6176b..4000d3baf29 100644 --- a/erpnext/accounts/report/gross_profit/gross_profit.js +++ b/erpnext/accounts/report/gross_profit/gross_profit.js @@ -8,20 +8,22 @@ frappe.query_reports["Gross Profit"] = { "label": __("Company"), "fieldtype": "Link", "options": "Company", - "reqd": 1, - "default": frappe.defaults.get_user_default("Company") + "default": frappe.defaults.get_user_default("Company"), + "reqd": 1 }, { "fieldname":"from_date", "label": __("From Date"), "fieldtype": "Date", - "default": frappe.defaults.get_user_default("year_start_date") + "default": frappe.defaults.get_user_default("year_start_date"), + "reqd": 1 }, { "fieldname":"to_date", "label": __("To Date"), "fieldtype": "Date", - "default": frappe.defaults.get_user_default("year_end_date") + "default": frappe.defaults.get_user_default("year_end_date"), + "reqd": 1 }, { "fieldname":"sales_invoice", @@ -42,9 +44,14 @@ frappe.query_reports["Gross Profit"] = { "parent_field": "parent_invoice", "initial_depth": 3, "formatter": function(value, row, column, data, default_formatter) { + if (column.fieldname == "sales_invoice" && column.options == "Item" && data && data.indent == 0) { + column._options = "Sales Invoice"; + } else { + column._options = "Item"; + } value = default_formatter(value, row, column, data); - if (data && (data.indent == 0.0 || row[1].content == "Total")) { + if (data && (data.indent == 0.0 || (row[1] && row[1].content == "Total"))) { value = $(`${value}`); var $value = $(value).css("font-weight", "bold"); value = $value.wrap("").parent().html(); diff --git a/erpnext/accounts/report/gross_profit/gross_profit.json b/erpnext/accounts/report/gross_profit/gross_profit.json index 76c560ad247..0730ffd77e5 100644 --- a/erpnext/accounts/report/gross_profit/gross_profit.json +++ b/erpnext/accounts/report/gross_profit/gross_profit.json @@ -1,5 +1,5 @@ { - "add_total_row": 0, + "add_total_row": 1, "columns": [], "creation": "2013-02-25 17:03:34", "disable_prepared_report": 0, @@ -9,7 +9,7 @@ "filters": [], "idx": 3, "is_standard": "Yes", - "modified": "2021-11-13 19:14:23.730198", + "modified": "2022-02-11 10:18:36.956558", "modified_by": "Administrator", "module": "Accounts", "name": "Gross Profit", diff --git a/erpnext/accounts/report/gross_profit/gross_profit.py b/erpnext/accounts/report/gross_profit/gross_profit.py index a8b5a0e28bd..7f6e2b99c89 100644 --- a/erpnext/accounts/report/gross_profit/gross_profit.py +++ b/erpnext/accounts/report/gross_profit/gross_profit.py @@ -11,38 +11,125 @@ from erpnext.stock.utils import get_incoming_rate def execute(filters=None): - if not filters: filters = frappe._dict() - filters.currency = frappe.get_cached_value('Company', filters.company, "default_currency") + if not filters: + filters = frappe._dict() + filters.currency = frappe.get_cached_value("Company", filters.company, "default_currency") gross_profit_data = GrossProfitGenerator(filters) data = [] - group_wise_columns = frappe._dict({ - "invoice": ["invoice_or_item", "customer", "customer_group", "posting_date","item_code", "item_name","item_group", "brand", "description", - "warehouse", "qty", "base_rate", "buying_rate", "base_amount", - "buying_amount", "gross_profit", "gross_profit_percent", "project"], - "item_code": ["item_code", "item_name", "brand", "description", "qty", "base_rate", - "buying_rate", "base_amount", "buying_amount", "gross_profit", "gross_profit_percent"], - "warehouse": ["warehouse", "qty", "base_rate", "buying_rate", "base_amount", "buying_amount", - "gross_profit", "gross_profit_percent"], - "brand": ["brand", "qty", "base_rate", "buying_rate", "base_amount", "buying_amount", - "gross_profit", "gross_profit_percent"], - "item_group": ["item_group", "qty", "base_rate", "buying_rate", "base_amount", "buying_amount", - "gross_profit", "gross_profit_percent"], - "customer": ["customer", "customer_group", "qty", "base_rate", "buying_rate", "base_amount", "buying_amount", - "gross_profit", "gross_profit_percent"], - "customer_group": ["customer_group", "qty", "base_rate", "buying_rate", "base_amount", "buying_amount", - "gross_profit", "gross_profit_percent"], - "sales_person": ["sales_person", "allocated_amount", "qty", "base_rate", "buying_rate", "base_amount", "buying_amount", - "gross_profit", "gross_profit_percent"], - "project": ["project", "base_amount", "buying_amount", "gross_profit", "gross_profit_percent"], - "territory": ["territory", "base_amount", "buying_amount", "gross_profit", "gross_profit_percent"] - }) + group_wise_columns = frappe._dict( + { + "invoice": [ + "invoice_or_item", + "customer", + "customer_group", + "posting_date", + "item_code", + "item_name", + "item_group", + "brand", + "description", + "warehouse", + "qty", + "base_rate", + "buying_rate", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + "project", + ], + "item_code": [ + "item_code", + "item_name", + "brand", + "description", + "qty", + "base_rate", + "buying_rate", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + ], + "warehouse": [ + "warehouse", + "qty", + "base_rate", + "buying_rate", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + ], + "brand": [ + "brand", + "qty", + "base_rate", + "buying_rate", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + ], + "item_group": [ + "item_group", + "qty", + "base_rate", + "buying_rate", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + ], + "customer": [ + "customer", + "customer_group", + "qty", + "base_rate", + "buying_rate", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + ], + "customer_group": [ + "customer_group", + "qty", + "base_rate", + "buying_rate", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + ], + "sales_person": [ + "sales_person", + "allocated_amount", + "qty", + "base_rate", + "buying_rate", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + ], + "project": ["project", "base_amount", "buying_amount", "gross_profit", "gross_profit_percent"], + "territory": [ + "territory", + "base_amount", + "buying_amount", + "gross_profit", + "gross_profit_percent", + ], + } + ) columns = get_columns(group_wise_columns, filters) - if filters.group_by == 'Invoice': + if filters.group_by == "Invoice": get_data_when_grouped_by_invoice(columns, gross_profit_data, filters, group_wise_columns, data) else: @@ -50,11 +137,14 @@ def execute(filters=None): return columns, data -def get_data_when_grouped_by_invoice(columns, gross_profit_data, filters, group_wise_columns, data): + +def get_data_when_grouped_by_invoice( + columns, gross_profit_data, filters, group_wise_columns, data +): column_names = get_column_names() # to display item as Item Code: Item Name - columns[0] = 'Sales Invoice:Link/Item:300' + columns[0] = "Sales Invoice:Link/Item:300" # removing Item Code and Item Name columns del columns[4:6] @@ -69,80 +159,207 @@ def get_data_when_grouped_by_invoice(columns, gross_profit_data, filters, group_ data.append(row) + def get_data_when_not_grouped_by_invoice(gross_profit_data, filters, group_wise_columns, data): - for idx, src in enumerate(gross_profit_data.grouped_data): + for src in gross_profit_data.grouped_data: row = [] for col in group_wise_columns.get(scrub(filters.group_by)): row.append(src.get(col)) row.append(filters.currency) - if idx == len(gross_profit_data.grouped_data)-1: - row[0] = "Total" data.append(row) + def get_columns(group_wise_columns, filters): columns = [] - column_map = frappe._dict({ - "parent": _("Sales Invoice") + ":Link/Sales Invoice:120", - "invoice_or_item": _("Sales Invoice") + ":Link/Sales Invoice:120", - "posting_date": _("Posting Date") + ":Date:100", - "posting_time": _("Posting Time") + ":Data:100", - "item_code": _("Item Code") + ":Link/Item:100", - "item_name": _("Item Name") + ":Data:100", - "item_group": _("Item Group") + ":Link/Item Group:100", - "brand": _("Brand") + ":Link/Brand:100", - "description": _("Description") +":Data:100", - "warehouse": _("Warehouse") + ":Link/Warehouse:100", - "qty": _("Qty") + ":Float:80", - "base_rate": _("Avg. Selling Rate") + ":Currency/currency:100", - "buying_rate": _("Valuation Rate") + ":Currency/currency:100", - "base_amount": _("Selling Amount") + ":Currency/currency:100", - "buying_amount": _("Buying Amount") + ":Currency/currency:100", - "gross_profit": _("Gross Profit") + ":Currency/currency:100", - "gross_profit_percent": _("Gross Profit %") + ":Percent:100", - "project": _("Project") + ":Link/Project:100", - "sales_person": _("Sales person"), - "allocated_amount": _("Allocated Amount") + ":Currency/currency:100", - "customer": _("Customer") + ":Link/Customer:100", - "customer_group": _("Customer Group") + ":Link/Customer Group:100", - "territory": _("Territory") + ":Link/Territory:100" - }) + column_map = frappe._dict( + { + "parent": { + "label": _("Sales Invoice"), + "fieldname": "parent_invoice", + "fieldtype": "Link", + "options": "Sales Invoice", + "width": 120, + }, + "invoice_or_item": { + "label": _("Sales Invoice"), + "fieldtype": "Link", + "options": "Sales Invoice", + "width": 120, + }, + "posting_date": { + "label": _("Posting Date"), + "fieldname": "posting_date", + "fieldtype": "Date", + "width": 100, + }, + "posting_time": { + "label": _("Posting Time"), + "fieldname": "posting_time", + "fieldtype": "Data", + "width": 100, + }, + "item_code": { + "label": _("Item Code"), + "fieldname": "item_code", + "fieldtype": "Link", + "options": "Item", + "width": 100, + }, + "item_name": { + "label": _("Item Name"), + "fieldname": "item_name", + "fieldtype": "Data", + "width": 100, + }, + "item_group": { + "label": _("Item Group"), + "fieldname": "item_group", + "fieldtype": "Link", + "options": "Item Group", + "width": 100, + }, + "brand": {"label": _("Brand"), "fieldtype": "Link", "options": "Brand", "width": 100}, + "description": { + "label": _("Description"), + "fieldname": "description", + "fieldtype": "Data", + "width": 100, + }, + "warehouse": { + "label": _("Warehouse"), + "fieldname": "warehouse", + "fieldtype": "Link", + "options": "warehouse", + "width": 100, + }, + "qty": {"label": _("Qty"), "fieldname": "qty", "fieldtype": "Float", "width": 80}, + "base_rate": { + "label": _("Avg. Selling Rate"), + "fieldname": "avg._selling_rate", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + "buying_rate": { + "label": _("Valuation Rate"), + "fieldname": "valuation_rate", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + "base_amount": { + "label": _("Selling Amount"), + "fieldname": "selling_amount", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + "buying_amount": { + "label": _("Buying Amount"), + "fieldname": "buying_amount", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + "gross_profit": { + "label": _("Gross Profit"), + "fieldname": "gross_profit", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + "gross_profit_percent": { + "label": _("Gross Profit Percent"), + "fieldname": "gross_profit_%", + "fieldtype": "Percent", + "width": 100, + }, + "project": { + "label": _("Project"), + "fieldname": "project", + "fieldtype": "Link", + "options": "Project", + "width": 100, + }, + "sales_person": { + "label": _("Sales Person"), + "fieldname": "sales_person", + "fieldtype": "Data", + "width": 100, + }, + "allocated_amount": { + "label": _("Allocated Amount"), + "fieldname": "allocated_amount", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + "customer": { + "label": _("Customer"), + "fieldname": "customer", + "fieldtype": "Link", + "options": "Customer", + "width": 100, + }, + "customer_group": { + "label": _("Customer Group"), + "fieldname": "customer_group", + "fieldtype": "Link", + "options": "customer", + "width": 100, + }, + "territory": { + "label": _("Territory"), + "fieldname": "territory", + "fieldtype": "Link", + "options": "territory", + "width": 100, + }, + } + ) for col in group_wise_columns.get(scrub(filters.group_by)): columns.append(column_map.get(col)) - columns.append({ - "fieldname": "currency", - "label" : _("Currency"), - "fieldtype": "Link", - "options": "Currency", - "hidden": 1 - }) + columns.append( + { + "fieldname": "currency", + "label": _("Currency"), + "fieldtype": "Link", + "options": "Currency", + "hidden": 1, + } + ) return columns + def get_column_names(): - return frappe._dict({ - 'invoice_or_item': 'sales_invoice', - 'customer': 'customer', - 'customer_group': 'customer_group', - 'posting_date': 'posting_date', - 'item_code': 'item_code', - 'item_name': 'item_name', - 'item_group': 'item_group', - 'brand': 'brand', - 'description': 'description', - 'warehouse': 'warehouse', - 'qty': 'qty', - 'base_rate': 'avg._selling_rate', - 'buying_rate': 'valuation_rate', - 'base_amount': 'selling_amount', - 'buying_amount': 'buying_amount', - 'gross_profit': 'gross_profit', - 'gross_profit_percent': 'gross_profit_%', - 'project': 'project' - }) + return frappe._dict( + { + "invoice_or_item": "sales_invoice", + "customer": "customer", + "customer_group": "customer_group", + "posting_date": "posting_date", + "item_code": "item_code", + "item_name": "item_name", + "item_group": "item_group", + "brand": "brand", + "description": "description", + "warehouse": "warehouse", + "qty": "qty", + "base_rate": "avg._selling_rate", + "buying_rate": "valuation_rate", + "base_amount": "selling_amount", + "buying_amount": "buying_amount", + "gross_profit": "gross_profit", + "gross_profit_percent": "gross_profit_%", + "project": "project", + } + ) + class GrossProfitGenerator(object): def __init__(self, filters=None): @@ -151,7 +368,7 @@ class GrossProfitGenerator(object): self.filters = frappe._dict(filters) self.load_invoice_items() - if filters.group_by == 'Invoice': + if filters.group_by == "Invoice": self.group_items_by_invoice() self.load_stock_ledger_entries() @@ -173,7 +390,7 @@ class GrossProfitGenerator(object): buying_amount = 0 for row in reversed(self.si_list): - if self.skip_row(row, self.product_bundles): + if self.skip_row(row): continue row.base_amount = flt(row.base_net_amount, self.currency_precision) @@ -182,17 +399,19 @@ class GrossProfitGenerator(object): if row.update_stock: product_bundles = self.product_bundles.get(row.parenttype, {}).get(row.parent, frappe._dict()) elif row.dn_detail: - product_bundles = self.product_bundles.get("Delivery Note", {})\ - .get(row.delivery_note, frappe._dict()) + product_bundles = self.product_bundles.get("Delivery Note", {}).get( + row.delivery_note, frappe._dict() + ) row.item_row = row.dn_detail # get buying amount if row.item_code in product_bundles: - row.buying_amount = flt(self.get_buying_amount_from_product_bundle(row, - product_bundles[row.item_code]), self.currency_precision) + row.buying_amount = flt( + self.get_buying_amount_from_product_bundle(row, product_bundles[row.item_code]), + self.currency_precision, + ) else: - row.buying_amount = flt(self.get_buying_amount(row, row.item_code), - self.currency_precision) + row.buying_amount = flt(self.get_buying_amount(row, row.item_code), self.currency_precision) if grouped_by_invoice: if row.indent == 1.0: @@ -212,7 +431,9 @@ class GrossProfitGenerator(object): # calculate gross profit row.gross_profit = flt(row.base_amount - row.buying_amount, self.currency_precision) if row.base_amount: - row.gross_profit_percent = flt((row.gross_profit / row.base_amount) * 100.0, self.currency_precision) + row.gross_profit_percent = flt( + (row.gross_profit / row.base_amount) * 100.0, self.currency_precision + ) else: row.gross_profit_percent = 0.0 @@ -223,20 +444,10 @@ class GrossProfitGenerator(object): self.get_average_rate_based_on_group_by() def get_average_rate_based_on_group_by(self): - # sum buying / selling totals for group - self.totals = frappe._dict( - qty=0, - base_amount=0, - buying_amount=0, - gross_profit=0, - gross_profit_percent=0, - base_rate=0, - buying_rate=0 - ) for key in list(self.grouped): if self.filters.get("group_by") != "Invoice": for i, row in enumerate(self.grouped[key]): - if i==0: + if i == 0: new_row = row else: new_row.qty += flt(row.qty) @@ -244,55 +455,53 @@ class GrossProfitGenerator(object): new_row.base_amount += flt(row.base_amount, self.currency_precision) new_row = self.set_average_rate(new_row) self.grouped_data.append(new_row) - self.add_to_totals(new_row) else: for i, row in enumerate(self.grouped[key]): if row.indent == 1.0: - if row.parent in self.returned_invoices \ - and row.item_code in self.returned_invoices[row.parent]: + if ( + row.parent in self.returned_invoices and row.item_code in self.returned_invoices[row.parent] + ): returned_item_rows = self.returned_invoices[row.parent][row.item_code] for returned_item_row in returned_item_rows: row.qty += flt(returned_item_row.qty) row.base_amount += flt(returned_item_row.base_amount, self.currency_precision) row.buying_amount = flt(flt(row.qty) * flt(row.buying_rate), self.currency_precision) - if (flt(row.qty) or row.base_amount): + if flt(row.qty) or row.base_amount: row = self.set_average_rate(row) self.grouped_data.append(row) - self.add_to_totals(row) - - self.set_average_gross_profit(self.totals) - - if self.filters.get("group_by") == "Invoice": - self.totals.indent = 0.0 - self.totals.parent_invoice = "" - self.totals.invoice_or_item = "Total" - self.si_list.append(self.totals) - else: - self.grouped_data.append(self.totals) def is_not_invoice_row(self, row): - return (self.filters.get("group_by") == "Invoice" and row.indent != 0.0) or self.filters.get("group_by") != "Invoice" + return (self.filters.get("group_by") == "Invoice" and row.indent != 0.0) or self.filters.get( + "group_by" + ) != "Invoice" def set_average_rate(self, new_row): self.set_average_gross_profit(new_row) - new_row.buying_rate = flt(new_row.buying_amount / new_row.qty, self.float_precision) if new_row.qty else 0 - new_row.base_rate = flt(new_row.base_amount / new_row.qty, self.float_precision) if new_row.qty else 0 + new_row.buying_rate = ( + flt(new_row.buying_amount / new_row.qty, self.float_precision) if new_row.qty else 0 + ) + new_row.base_rate = ( + flt(new_row.base_amount / new_row.qty, self.float_precision) if new_row.qty else 0 + ) return new_row def set_average_gross_profit(self, new_row): new_row.gross_profit = flt(new_row.base_amount - new_row.buying_amount, self.currency_precision) - new_row.gross_profit_percent = flt(((new_row.gross_profit / new_row.base_amount) * 100.0), self.currency_precision) \ - if new_row.base_amount else 0 - new_row.buying_rate = flt(new_row.buying_amount / flt(new_row.qty), self.float_precision) if flt(new_row.qty) else 0 - new_row.base_rate = flt(new_row.base_amount / flt(new_row.qty), self.float_precision) if flt(new_row.qty) else 0 - - def add_to_totals(self, new_row): - for key in self.totals: - if new_row.get(key): - self.totals[key] += new_row[key] + new_row.gross_profit_percent = ( + flt(((new_row.gross_profit / new_row.base_amount) * 100.0), self.currency_precision) + if new_row.base_amount + else 0 + ) + new_row.buying_rate = ( + flt(new_row.buying_amount / flt(new_row.qty), self.float_precision) if flt(new_row.qty) else 0 + ) + new_row.base_rate = ( + flt(new_row.base_amount / flt(new_row.qty), self.float_precision) if flt(new_row.qty) else 0 + ) def get_returned_invoice_items(self): - returned_invoices = frappe.db.sql(""" + returned_invoices = frappe.db.sql( + """ select si.name, si_item.item_code, si_item.stock_qty as qty, si_item.base_net_amount as base_amount, si.return_against from @@ -301,24 +510,27 @@ class GrossProfitGenerator(object): si.name = si_item.parent and si.docstatus = 1 and si.is_return = 1 - """, as_dict=1) + """, + as_dict=1, + ) self.returned_invoices = frappe._dict() for inv in returned_invoices: - self.returned_invoices.setdefault(inv.return_against, frappe._dict())\ - .setdefault(inv.item_code, []).append(inv) + self.returned_invoices.setdefault(inv.return_against, frappe._dict()).setdefault( + inv.item_code, [] + ).append(inv) - def skip_row(self, row, product_bundles): + def skip_row(self, row): if self.filters.get("group_by") != "Invoice": if not row.get(scrub(self.filters.get("group_by", ""))): return True - elif row.get("is_return") == 1: - return True + + return False def get_buying_amount_from_product_bundle(self, row, product_bundle): buying_amount = 0.0 for packed_item in product_bundle: - if packed_item.get("parent_detail_docname")==row.item_row: + if packed_item.get("parent_detail_docname") == row.item_row: buying_amount += self.get_buying_amount(row, packed_item.item_code) return flt(buying_amount, self.currency_precision) @@ -328,7 +540,7 @@ class GrossProfitGenerator(object): # stock_ledger_entries should already be filtered by item_code and warehouse and # sorted by posting_date desc, posting_time desc if item_code in self.non_stock_items and (row.project or row.cost_center): - #Issue 6089-Get last purchasing rate for non-stock item + # Issue 6089-Get last purchasing rate for non-stock item item_rate = self.get_last_purchase_rate(item_code, row) return flt(row.qty) * item_rate @@ -341,15 +553,17 @@ class GrossProfitGenerator(object): for i, sle in enumerate(my_sle): # find the stock valution rate from stock ledger entry - if sle.voucher_type == parenttype and parent == sle.voucher_no and \ - sle.voucher_detail_no == row.item_row: - previous_stock_value = len(my_sle) > i+1 and \ - flt(my_sle[i+1].stock_value) or 0.0 + if ( + sle.voucher_type == parenttype + and parent == sle.voucher_no + and sle.voucher_detail_no == row.item_row + ): + previous_stock_value = len(my_sle) > i + 1 and flt(my_sle[i + 1].stock_value) or 0.0 - if previous_stock_value: - return (previous_stock_value - flt(sle.stock_value)) * flt(row.qty) / abs(flt(sle.qty)) - else: - return flt(row.qty) * self.get_average_buying_rate(row, item_code) + if previous_stock_value: + return abs(previous_stock_value - flt(sle.stock_value)) * flt(row.qty) / abs(flt(sle.qty)) + else: + return flt(row.qty) * self.get_average_buying_rate(row, item_code) else: return flt(row.qty) * self.get_average_buying_rate(row, item_code) @@ -358,33 +572,43 @@ class GrossProfitGenerator(object): def get_average_buying_rate(self, row, item_code): args = row if not item_code in self.average_buying_rate: - args.update({ - 'voucher_type': row.parenttype, - 'voucher_no': row.parent, - 'allow_zero_valuation': True, - 'company': self.filters.company - }) + args.update( + { + "voucher_type": row.parenttype, + "voucher_no": row.parent, + "allow_zero_valuation": True, + "company": self.filters.company, + } + ) average_buying_rate = get_incoming_rate(args) - self.average_buying_rate[item_code] = flt(average_buying_rate) + self.average_buying_rate[item_code] = flt(average_buying_rate) return self.average_buying_rate[item_code] def get_last_purchase_rate(self, item_code, row): - condition = '' - if row.project: - condition += " AND a.project=%s" % (frappe.db.escape(row.project)) - elif row.cost_center: - condition += " AND a.cost_center=%s" % (frappe.db.escape(row.cost_center)) - if self.filters.to_date: - condition += " AND modified='%s'" % (self.filters.to_date) + purchase_invoice = frappe.qb.DocType("Purchase Invoice") + purchase_invoice_item = frappe.qb.DocType("Purchase Invoice Item") - last_purchase_rate = frappe.db.sql(""" - select (a.base_rate / a.conversion_factor) - from `tabPurchase Invoice Item` a - where a.item_code = %s and a.docstatus=1 - {0} - order by a.modified desc limit 1""".format(condition), item_code) + query = ( + frappe.qb.from_(purchase_invoice_item) + .inner_join(purchase_invoice) + .on(purchase_invoice.name == purchase_invoice_item.parent) + .select(purchase_invoice_item.base_rate / purchase_invoice_item.conversion_factor) + .where(purchase_invoice.docstatus == 1) + .where(purchase_invoice.posting_date <= self.filters.to_date) + .where(purchase_invoice_item.item_code == item_code) + ) + + if row.project: + query.where(purchase_invoice_item.project == row.project) + + if row.cost_center: + query.where(purchase_invoice_item.cost_center == row.cost_center) + + query.orderby(purchase_invoice.posting_date, order=frappe.qb.desc) + query.limit(1) + last_purchase_rate = query.run() return flt(last_purchase_rate[0][0]) if last_purchase_rate else 0 @@ -397,7 +621,7 @@ class GrossProfitGenerator(object): if self.filters.to_date: conditions += " and posting_date <= %(to_date)s" - if self.filters.group_by=="Sales Person": + if self.filters.group_by == "Sales Person": sales_person_cols = ", sales.sales_person, sales.allocated_amount, sales.incentives" sales_team_table = "left join `tabSales Team` sales on sales.parent = `tabSales Invoice`.name" else: @@ -410,7 +634,8 @@ class GrossProfitGenerator(object): if self.filters.get("item_code"): conditions += " and `tabSales Invoice Item`.item_code = %(item_code)s" - self.si_list = frappe.db.sql(""" + self.si_list = frappe.db.sql( + """ select `tabSales Invoice Item`.parenttype, `tabSales Invoice Item`.parent, `tabSales Invoice`.posting_date, `tabSales Invoice`.posting_time, @@ -432,13 +657,19 @@ class GrossProfitGenerator(object): where `tabSales Invoice`.docstatus=1 and `tabSales Invoice`.is_opening!='Yes' {conditions} {match_cond} order by - `tabSales Invoice`.posting_date desc, `tabSales Invoice`.posting_time desc""" - .format(conditions=conditions, sales_person_cols=sales_person_cols, - sales_team_table=sales_team_table, match_cond = get_match_cond('Sales Invoice')), self.filters, as_dict=1) + `tabSales Invoice`.posting_date desc, `tabSales Invoice`.posting_time desc""".format( + conditions=conditions, + sales_person_cols=sales_person_cols, + sales_team_table=sales_team_table, + match_cond=get_match_cond("Sales Invoice"), + ), + self.filters, + as_dict=1, + ) def group_items_by_invoice(self): """ - Turns list of Sales Invoice Items to a tree of Sales Invoices with their Items as children. + Turns list of Sales Invoice Items to a tree of Sales Invoices with their Items as children. """ parents = [] @@ -461,94 +692,96 @@ class GrossProfitGenerator(object): row.parent_invoice = row.parent row.invoice_or_item = row.item_code - if frappe.db.exists('Product Bundle', row.item_code): + if frappe.db.exists("Product Bundle", row.item_code): self.add_bundle_items(row, index) def get_invoice_row(self, row): - return frappe._dict({ - 'parent_invoice': "", - 'indent': 0.0, - 'invoice_or_item': row.parent, - 'parent': None, - 'posting_date': row.posting_date, - 'posting_time': row.posting_time, - 'project': row.project, - 'update_stock': row.update_stock, - 'customer': row.customer, - 'customer_group': row.customer_group, - 'item_code': None, - 'item_name': None, - 'description': None, - 'warehouse': None, - 'item_group': None, - 'brand': None, - 'dn_detail': None, - 'delivery_note': None, - 'qty': None, - 'item_row': None, - 'is_return': row.is_return, - 'cost_center': row.cost_center, - 'base_net_amount': frappe.db.get_value('Sales Invoice', row.parent, 'base_net_total') - }) + return frappe._dict( + { + "parent_invoice": "", + "indent": 0.0, + "invoice_or_item": row.parent, + "parent": None, + "posting_date": row.posting_date, + "posting_time": row.posting_time, + "project": row.project, + "update_stock": row.update_stock, + "customer": row.customer, + "customer_group": row.customer_group, + "item_code": None, + "item_name": None, + "description": None, + "warehouse": None, + "item_group": None, + "brand": None, + "dn_detail": None, + "delivery_note": None, + "qty": None, + "item_row": None, + "is_return": row.is_return, + "cost_center": row.cost_center, + "base_net_amount": frappe.db.get_value("Sales Invoice", row.parent, "base_net_total"), + } + ) def add_bundle_items(self, product_bundle, index): bundle_items = self.get_bundle_items(product_bundle) for i, item in enumerate(bundle_items): bundle_item = self.get_bundle_item_row(product_bundle, item) - self.si_list.insert((index+i+1), bundle_item) + self.si_list.insert((index + i + 1), bundle_item) def get_bundle_items(self, product_bundle): return frappe.get_all( - 'Product Bundle Item', - filters = { - 'parent': product_bundle.item_code - }, - fields = ['item_code', 'qty'] + "Product Bundle Item", filters={"parent": product_bundle.item_code}, fields=["item_code", "qty"] ) def get_bundle_item_row(self, product_bundle, item): item_name, description, item_group, brand = self.get_bundle_item_details(item.item_code) - return frappe._dict({ - 'parent_invoice': product_bundle.item_code, - 'indent': product_bundle.indent + 1, - 'parent': None, - 'invoice_or_item': item.item_code, - 'posting_date': product_bundle.posting_date, - 'posting_time': product_bundle.posting_time, - 'project': product_bundle.project, - 'customer': product_bundle.customer, - 'customer_group': product_bundle.customer_group, - 'item_code': item.item_code, - 'item_name': item_name, - 'description': description, - 'warehouse': product_bundle.warehouse, - 'item_group': item_group, - 'brand': brand, - 'dn_detail': product_bundle.dn_detail, - 'delivery_note': product_bundle.delivery_note, - 'qty': (flt(product_bundle.qty) * flt(item.qty)), - 'item_row': None, - 'is_return': product_bundle.is_return, - 'cost_center': product_bundle.cost_center - }) + return frappe._dict( + { + "parent_invoice": product_bundle.item_code, + "indent": product_bundle.indent + 1, + "parent": None, + "invoice_or_item": item.item_code, + "posting_date": product_bundle.posting_date, + "posting_time": product_bundle.posting_time, + "project": product_bundle.project, + "customer": product_bundle.customer, + "customer_group": product_bundle.customer_group, + "item_code": item.item_code, + "item_name": item_name, + "description": description, + "warehouse": product_bundle.warehouse, + "item_group": item_group, + "brand": brand, + "dn_detail": product_bundle.dn_detail, + "delivery_note": product_bundle.delivery_note, + "qty": (flt(product_bundle.qty) * flt(item.qty)), + "item_row": None, + "is_return": product_bundle.is_return, + "cost_center": product_bundle.cost_center, + } + ) def get_bundle_item_details(self, item_code): return frappe.db.get_value( - 'Item', - item_code, - ['item_name', 'description', 'item_group', 'brand'] + "Item", item_code, ["item_name", "description", "item_group", "brand"] ) def load_stock_ledger_entries(self): - res = frappe.db.sql("""select item_code, voucher_type, voucher_no, + res = frappe.db.sql( + """select item_code, voucher_type, voucher_no, voucher_detail_no, stock_value, warehouse, actual_qty as qty from `tabStock Ledger Entry` where company=%(company)s and is_cancelled = 0 order by item_code desc, warehouse desc, posting_date desc, - posting_time desc, creation desc""", self.filters, as_dict=True) + posting_time desc, creation desc""", + self.filters, + as_dict=True, + ) self.sle = {} for r in res: if (r.item_code, r.warehouse) not in self.sle: @@ -559,12 +792,18 @@ class GrossProfitGenerator(object): def load_product_bundle(self): self.product_bundles = {} - for d in frappe.db.sql("""select parenttype, parent, parent_item, + for d in frappe.db.sql( + """select parenttype, parent, parent_item, item_code, warehouse, -1*qty as total_qty, parent_detail_docname - from `tabPacked Item` where docstatus=1""", as_dict=True): - self.product_bundles.setdefault(d.parenttype, frappe._dict()).setdefault(d.parent, - frappe._dict()).setdefault(d.parent_item, []).append(d) + from `tabPacked Item` where docstatus=1""", + as_dict=True, + ): + self.product_bundles.setdefault(d.parenttype, frappe._dict()).setdefault( + d.parent, frappe._dict() + ).setdefault(d.parent_item, []).append(d) def load_non_stock_items(self): - self.non_stock_items = frappe.db.sql_list("""select name from tabItem - where is_stock_item=0""") + self.non_stock_items = frappe.db.sql_list( + """select name from tabItem + where is_stock_item=0""" + ) diff --git a/erpnext/accounts/report/inactive_sales_items/inactive_sales_items.py b/erpnext/accounts/report/inactive_sales_items/inactive_sales_items.py index 2f23c8ed1d6..8db72de22f3 100644 --- a/erpnext/accounts/report/inactive_sales_items/inactive_sales_items.py +++ b/erpnext/accounts/report/inactive_sales_items/inactive_sales_items.py @@ -12,6 +12,7 @@ def execute(filters=None): data = get_data(filters) return columns, data + def get_columns(): columns = [ { @@ -19,53 +20,36 @@ def get_columns(): "fieldtype": "Link", "label": _("Territory"), "options": "Territory", - "width": 100 + "width": 100, }, { "fieldname": "item_group", "fieldtype": "Link", "label": _("Item Group"), "options": "Item Group", - "width": 150 + "width": 150, }, - { - "fieldname": "item", - "fieldtype": "Link", - "options": "Item", - "label": "Item", - "width": 150 - }, - { - "fieldname": "item_name", - "fieldtype": "Data", - "label": _("Item Name"), - "width": 150 - }, - + {"fieldname": "item", "fieldtype": "Link", "options": "Item", "label": "Item", "width": 150}, + {"fieldname": "item_name", "fieldtype": "Data", "label": _("Item Name"), "width": 150}, { "fieldname": "customer", "fieldtype": "Link", "label": _("Customer"), "options": "Customer", - "width": 100 + "width": 100, }, { "fieldname": "last_order_date", "fieldtype": "Date", "label": _("Last Order Date"), - "width": 100 - }, - { - "fieldname": "qty", - "fieldtype": "Float", - "label": _("Quantity"), - "width": 100 + "width": 100, }, + {"fieldname": "qty", "fieldtype": "Float", "label": _("Quantity"), "width": 100}, { "fieldname": "days_since_last_order", "fieldtype": "Int", "label": _("Days Since Last Order"), - "width": 100 + "width": 100, }, ] @@ -84,19 +68,21 @@ def get_data(filters): "territory": territory.name, "item_group": item.item_group, "item": item.item_code, - "item_name": item.item_name + "item_name": item.item_name, } - if sales_invoice_data.get((territory.name,item.item_code)): - item_obj = sales_invoice_data[(territory.name,item.item_code)] - if item_obj.days_since_last_order > cint(filters['days']): - row.update({ - "territory": item_obj.territory, - "customer": item_obj.customer, - "last_order_date": item_obj.last_order_date, - "qty": item_obj.qty, - "days_since_last_order": item_obj.days_since_last_order - }) + if sales_invoice_data.get((territory.name, item.item_code)): + item_obj = sales_invoice_data[(territory.name, item.item_code)] + if item_obj.days_since_last_order > cint(filters["days"]): + row.update( + { + "territory": item_obj.territory, + "customer": item_obj.customer, + "last_order_date": item_obj.last_order_date, + "qty": item_obj.qty, + "days_since_last_order": item_obj.days_since_last_order, + } + ) else: continue @@ -111,45 +97,49 @@ def get_sales_details(filters): date_field = "s.transaction_date" if filters["based_on"] == "Sales Order" else "s.posting_date" - sales_data = frappe.db.sql(""" + sales_data = frappe.db.sql( + """ select s.territory, s.customer, si.item_group, si.item_code, si.qty, {date_field} as last_order_date, DATEDIFF(CURDATE(), {date_field}) as days_since_last_order from `tab{doctype}` s, `tab{doctype} Item` si where s.name = si.parent and s.docstatus = 1 - order by days_since_last_order """ #nosec - .format(date_field = date_field, doctype = filters['based_on']), as_dict=1) + order by days_since_last_order """.format( # nosec + date_field=date_field, doctype=filters["based_on"] + ), + as_dict=1, + ) for d in sales_data: - item_details_map.setdefault((d.territory,d.item_code), d) + item_details_map.setdefault((d.territory, d.item_code), d) return item_details_map + def get_territories(filters): filter_dict = {} if filters.get("territory"): - filter_dict.update({'name': filters['territory']}) + filter_dict.update({"name": filters["territory"]}) territories = frappe.get_all("Territory", fields=["name"], filters=filter_dict) return territories + def get_items(filters): - filters_dict = { - "disabled": 0, - "is_stock_item": 1 - } + filters_dict = {"disabled": 0, "is_stock_item": 1} if filters.get("item_group"): - filters_dict.update({ - "item_group": filters["item_group"] - }) + filters_dict.update({"item_group": filters["item_group"]}) if filters.get("item"): - filters_dict.update({ - "name": filters["item"] - }) + filters_dict.update({"name": filters["item"]}) - items = frappe.get_all("Item", fields=["name", "item_group", "item_name", "item_code"], filters=filters_dict, order_by="name") + items = frappe.get_all( + "Item", + fields=["name", "item_group", "item_name", "item_code"], + filters=filters_dict, + order_by="name", + ) return items diff --git a/erpnext/accounts/report/item_wise_purchase_register/item_wise_purchase_register.py b/erpnext/accounts/report/item_wise_purchase_register/item_wise_purchase_register.py index aaed58d070d..c04b9c71252 100644 --- a/erpnext/accounts/report/item_wise_purchase_register/item_wise_purchase_register.py +++ b/erpnext/accounts/report/item_wise_purchase_register/item_wise_purchase_register.py @@ -21,8 +21,10 @@ from erpnext.selling.report.item_wise_sales_history.item_wise_sales_history impo def execute(filters=None): return _execute(filters) + def _execute(filters=None, additional_table_columns=None, additional_query_columns=None): - if not filters: filters = {} + if not filters: + filters = {} columns = get_columns(additional_table_columns, filters) company_currency = erpnext.get_company_currency(filters.company) @@ -30,18 +32,23 @@ def _execute(filters=None, additional_table_columns=None, additional_query_colum item_list = get_items(filters, additional_query_columns) aii_account_map = get_aii_accounts() if item_list: - itemised_tax, tax_columns = get_tax_accounts(item_list, columns, company_currency, - doctype='Purchase Invoice', tax_doctype='Purchase Taxes and Charges') + itemised_tax, tax_columns = get_tax_accounts( + item_list, + columns, + company_currency, + doctype="Purchase Invoice", + tax_doctype="Purchase Taxes and Charges", + ) po_pr_map = get_purchase_receipts_against_purchase_order(item_list) data = [] total_row_map = {} skip_total_row = 0 - prev_group_by_value = '' + prev_group_by_value = "" - if filters.get('group_by'): - grand_total = get_grand_total(filters, 'Purchase Invoice') + if filters.get("group_by"): + grand_total = get_grand_total(filters, "Purchase Invoice") item_details = get_item_details() @@ -57,71 +64,81 @@ def _execute(filters=None, additional_table_columns=None, additional_query_colum elif d.po_detail: purchase_receipt = ", ".join(po_pr_map.get(d.po_detail, [])) - expense_account = d.unrealized_profit_loss_account or d.expense_account \ - or aii_account_map.get(d.company) + expense_account = ( + d.unrealized_profit_loss_account or d.expense_account or aii_account_map.get(d.company) + ) row = { - 'item_code': d.item_code, - 'item_name': item_record.item_name if item_record else d.item_name, - 'item_group': item_record.item_group if item_record else d.item_group, - 'description': d.description, - 'invoice': d.parent, - 'posting_date': d.posting_date, - 'supplier': d.supplier, - 'supplier_name': d.supplier_name + "item_code": d.item_code, + "item_name": item_record.item_name if item_record else d.item_name, + "item_group": item_record.item_group if item_record else d.item_group, + "description": d.description, + "invoice": d.parent, + "posting_date": d.posting_date, + "supplier": d.supplier, + "supplier_name": d.supplier_name, } if additional_query_columns: for col in additional_query_columns: - row.update({ - col: d.get(col) - }) + row.update({col: d.get(col)}) - row.update({ - 'credit_to': d.credit_to, - 'mode_of_payment': d.mode_of_payment, - 'project': d.project, - 'company': d.company, - 'purchase_order': d.purchase_order, - 'purchase_receipt': d.purchase_receipt, - 'expense_account': expense_account, - 'stock_qty': d.stock_qty, - 'stock_uom': d.stock_uom, - 'rate': d.base_net_amount / d.stock_qty, - 'amount': d.base_net_amount - }) + row.update( + { + "credit_to": d.credit_to, + "mode_of_payment": d.mode_of_payment, + "project": d.project, + "company": d.company, + "purchase_order": d.purchase_order, + "purchase_receipt": d.purchase_receipt, + "expense_account": expense_account, + "stock_qty": d.stock_qty, + "stock_uom": d.stock_uom, + "rate": d.base_net_amount / d.stock_qty, + "amount": d.base_net_amount, + } + ) total_tax = 0 for tax in tax_columns: item_tax = itemised_tax.get(d.name, {}).get(tax, {}) - row.update({ - frappe.scrub(tax + ' Rate'): item_tax.get('tax_rate', 0), - frappe.scrub(tax + ' Amount'): item_tax.get('tax_amount', 0), - }) - total_tax += flt(item_tax.get('tax_amount')) + row.update( + { + frappe.scrub(tax + " Rate"): item_tax.get("tax_rate", 0), + frappe.scrub(tax + " Amount"): item_tax.get("tax_amount", 0), + } + ) + total_tax += flt(item_tax.get("tax_amount")) - row.update({ - 'total_tax': total_tax, - 'total': d.base_net_amount + total_tax, - 'currency': company_currency - }) + row.update( + {"total_tax": total_tax, "total": d.base_net_amount + total_tax, "currency": company_currency} + ) - if filters.get('group_by'): - row.update({'percent_gt': flt(row['total']/grand_total) * 100}) + if filters.get("group_by"): + row.update({"percent_gt": flt(row["total"] / grand_total) * 100}) group_by_field, subtotal_display_field = get_group_by_and_display_fields(filters) - data, prev_group_by_value = add_total_row(data, filters, prev_group_by_value, d, total_row_map, - group_by_field, subtotal_display_field, grand_total, tax_columns) - add_sub_total_row(row, total_row_map, d.get(group_by_field, ''), tax_columns) + data, prev_group_by_value = add_total_row( + data, + filters, + prev_group_by_value, + d, + total_row_map, + group_by_field, + subtotal_display_field, + grand_total, + tax_columns, + ) + add_sub_total_row(row, total_row_map, d.get(group_by_field, ""), tax_columns) data.append(row) - if filters.get('group_by') and item_list: - total_row = total_row_map.get(prev_group_by_value or d.get('item_name')) - total_row['percent_gt'] = flt(total_row['total']/grand_total * 100) + if filters.get("group_by") and item_list: + total_row = total_row_map.get(prev_group_by_value or d.get("item_name")) + total_row["percent_gt"] = flt(total_row["total"] / grand_total * 100) data.append(total_row) data.append({}) - add_sub_total_row(total_row, total_row_map, 'total_row', tax_columns) - data.append(total_row_map.get('total_row')) + add_sub_total_row(total_row, total_row_map, "total_row", tax_columns) + data.append(total_row_map.get("total_row")) skip_total_row = 1 return columns, data, None, None, None, skip_total_row @@ -131,195 +148,180 @@ def get_columns(additional_table_columns, filters): columns = [] - if filters.get('group_by') != ('Item'): + if filters.get("group_by") != ("Item"): columns.extend( [ { - 'label': _('Item Code'), - 'fieldname': 'item_code', - 'fieldtype': 'Link', - 'options': 'Item', - 'width': 120 + "label": _("Item Code"), + "fieldname": "item_code", + "fieldtype": "Link", + "options": "Item", + "width": 120, }, + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 120}, + ] + ) + + if filters.get("group_by") not in ("Item", "Item Group"): + columns.extend( + [ { - 'label': _('Item Name'), - 'fieldname': 'item_name', - 'fieldtype': 'Data', - 'width': 120 + "label": _("Item Group"), + "fieldname": "item_group", + "fieldtype": "Link", + "options": "Item Group", + "width": 120, } ] ) - if filters.get('group_by') not in ('Item', 'Item Group'): - columns.extend([ + columns.extend( + [ + {"label": _("Description"), "fieldname": "description", "fieldtype": "Data", "width": 150}, { - 'label': _('Item Group'), - 'fieldname': 'item_group', - 'fieldtype': 'Link', - 'options': 'Item Group', - 'width': 120 - } - ]) - - columns.extend([ - { - 'label': _('Description'), - 'fieldname': 'description', - 'fieldtype': 'Data', - 'width': 150 - }, - { - 'label': _('Invoice'), - 'fieldname': 'invoice', - 'fieldtype': 'Link', - 'options': 'Purchase Invoice', - 'width': 120 - }, - { - 'label': _('Posting Date'), - 'fieldname': 'posting_date', - 'fieldtype': 'Date', - 'width': 120 - } - ]) - - if filters.get('group_by') != 'Supplier': - columns.extend([ - { - 'label': _('Supplier'), - 'fieldname': 'supplier', - 'fieldtype': 'Link', - 'options': 'Supplier', - 'width': 120 + "label": _("Invoice"), + "fieldname": "invoice", + "fieldtype": "Link", + "options": "Purchase Invoice", + "width": 120, }, - { - 'label': _('Supplier Name'), - 'fieldname': 'supplier_name', - 'fieldtype': 'Data', - 'width': 120 - } - ]) + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 120}, + ] + ) + + if filters.get("group_by") != "Supplier": + columns.extend( + [ + { + "label": _("Supplier"), + "fieldname": "supplier", + "fieldtype": "Link", + "options": "Supplier", + "width": 120, + }, + {"label": _("Supplier Name"), "fieldname": "supplier_name", "fieldtype": "Data", "width": 120}, + ] + ) if additional_table_columns: columns += additional_table_columns columns += [ { - 'label': _('Payable Account'), - 'fieldname': 'credit_to', - 'fieldtype': 'Link', - 'options': 'Account', - 'width': 80 + "label": _("Payable Account"), + "fieldname": "credit_to", + "fieldtype": "Link", + "options": "Account", + "width": 80, }, { - 'label': _('Mode Of Payment'), - 'fieldname': 'mode_of_payment', - 'fieldtype': 'Link', - 'options': 'Mode of Payment', - 'width': 120 + "label": _("Mode Of Payment"), + "fieldname": "mode_of_payment", + "fieldtype": "Link", + "options": "Mode of Payment", + "width": 120, }, { - 'label': _('Project'), - 'fieldname': 'project', - 'fieldtype': 'Link', - 'options': 'Project', - 'width': 80 + "label": _("Project"), + "fieldname": "project", + "fieldtype": "Link", + "options": "Project", + "width": 80, }, { - 'label': _('Company'), - 'fieldname': 'company', - 'fieldtype': 'Link', - 'options': 'Company', - 'width': 80 + "label": _("Company"), + "fieldname": "company", + "fieldtype": "Link", + "options": "Company", + "width": 80, }, { - 'label': _('Purchase Order'), - 'fieldname': 'purchase_order', - 'fieldtype': 'Link', - 'options': 'Purchase Order', - 'width': 100 + "label": _("Purchase Order"), + "fieldname": "purchase_order", + "fieldtype": "Link", + "options": "Purchase Order", + "width": 100, }, { - 'label': _("Purchase Receipt"), - 'fieldname': 'Purchase Receipt', - 'fieldtype': 'Link', - 'options': 'Purchase Receipt', - 'width': 100 + "label": _("Purchase Receipt"), + "fieldname": "Purchase Receipt", + "fieldtype": "Link", + "options": "Purchase Receipt", + "width": 100, }, { - 'label': _('Expense Account'), - 'fieldname': 'expense_account', - 'fieldtype': 'Link', - 'options': 'Account', - 'width': 100 + "label": _("Expense Account"), + "fieldname": "expense_account", + "fieldtype": "Link", + "options": "Account", + "width": 100, + }, + {"label": _("Stock Qty"), "fieldname": "stock_qty", "fieldtype": "Float", "width": 100}, + { + "label": _("Stock UOM"), + "fieldname": "stock_uom", + "fieldtype": "Link", + "options": "UOM", + "width": 100, }, { - 'label': _('Stock Qty'), - 'fieldname': 'stock_qty', - 'fieldtype': 'Float', - 'width': 100 + "label": _("Rate"), + "fieldname": "rate", + "fieldtype": "Float", + "options": "currency", + "width": 100, }, { - 'label': _('Stock UOM'), - 'fieldname': 'stock_uom', - 'fieldtype': 'Link', - 'options': 'UOM', - 'width': 100 + "label": _("Amount"), + "fieldname": "amount", + "fieldtype": "Currency", + "options": "currency", + "width": 100, }, - { - 'label': _('Rate'), - 'fieldname': 'rate', - 'fieldtype': 'Float', - 'options': 'currency', - 'width': 100 - }, - { - 'label': _('Amount'), - 'fieldname': 'amount', - 'fieldtype': 'Currency', - 'options': 'currency', - 'width': 100 - } ] - if filters.get('group_by'): - columns.append({ - 'label': _('% Of Grand Total'), - 'fieldname': 'percent_gt', - 'fieldtype': 'Float', - 'width': 80 - }) + if filters.get("group_by"): + columns.append( + {"label": _("% Of Grand Total"), "fieldname": "percent_gt", "fieldtype": "Float", "width": 80} + ) return columns + def get_conditions(filters): conditions = "" - for opts in (("company", " and company=%(company)s"), + for opts in ( + ("company", " and company=%(company)s"), ("supplier", " and `tabPurchase Invoice`.supplier = %(supplier)s"), ("item_code", " and `tabPurchase Invoice Item`.item_code = %(item_code)s"), ("from_date", " and `tabPurchase Invoice`.posting_date>=%(from_date)s"), ("to_date", " and `tabPurchase Invoice`.posting_date<=%(to_date)s"), - ("mode_of_payment", " and ifnull(mode_of_payment, '') = %(mode_of_payment)s")): - if filters.get(opts[0]): - conditions += opts[1] + ("mode_of_payment", " and ifnull(mode_of_payment, '') = %(mode_of_payment)s"), + ): + if filters.get(opts[0]): + conditions += opts[1] if not filters.get("group_by"): - conditions += "ORDER BY `tabPurchase Invoice`.posting_date desc, `tabPurchase Invoice Item`.item_code desc" + conditions += ( + "ORDER BY `tabPurchase Invoice`.posting_date desc, `tabPurchase Invoice Item`.item_code desc" + ) else: - conditions += get_group_by_conditions(filters, 'Purchase Invoice') + conditions += get_group_by_conditions(filters, "Purchase Invoice") return conditions + def get_items(filters, additional_query_columns): conditions = get_conditions(filters) if additional_query_columns: - additional_query_columns = ', ' + ', '.join(additional_query_columns) + additional_query_columns = ", " + ", ".join(additional_query_columns) else: - additional_query_columns = '' + additional_query_columns = "" - return frappe.db.sql(""" + return frappe.db.sql( + """ select `tabPurchase Invoice Item`.`name`, `tabPurchase Invoice Item`.`parent`, `tabPurchase Invoice`.posting_date, `tabPurchase Invoice`.credit_to, `tabPurchase Invoice`.company, @@ -335,22 +337,35 @@ def get_items(filters, additional_query_columns): from `tabPurchase Invoice`, `tabPurchase Invoice Item` where `tabPurchase Invoice`.name = `tabPurchase Invoice Item`.`parent` and `tabPurchase Invoice`.docstatus = 1 %s - """.format(additional_query_columns) % (conditions), filters, as_dict=1) + """.format( + additional_query_columns + ) + % (conditions), + filters, + as_dict=1, + ) + def get_aii_accounts(): return dict(frappe.db.sql("select name, stock_received_but_not_billed from tabCompany")) + def get_purchase_receipts_against_purchase_order(item_list): po_pr_map = frappe._dict() po_item_rows = list(set(d.po_detail for d in item_list)) if po_item_rows: - purchase_receipts = frappe.db.sql(""" + purchase_receipts = frappe.db.sql( + """ select parent, purchase_order_item from `tabPurchase Receipt Item` where docstatus=1 and purchase_order_item in (%s) group by purchase_order_item, parent - """ % (', '.join(['%s']*len(po_item_rows))), tuple(po_item_rows), as_dict=1) + """ + % (", ".join(["%s"] * len(po_item_rows))), + tuple(po_item_rows), + as_dict=1, + ) for pr in purchase_receipts: po_pr_map.setdefault(pr.po_detail, []).append(pr.parent) diff --git a/erpnext/accounts/report/item_wise_sales_register/item_wise_sales_register.py b/erpnext/accounts/report/item_wise_sales_register/item_wise_sales_register.py index 9b35538bb68..dd9c0736128 100644 --- a/erpnext/accounts/report/item_wise_sales_register/item_wise_sales_register.py +++ b/erpnext/accounts/report/item_wise_sales_register/item_wise_sales_register.py @@ -18,13 +18,20 @@ from erpnext.selling.report.item_wise_sales_history.item_wise_sales_history impo def execute(filters=None): return _execute(filters) -def _execute(filters=None, additional_table_columns=None, additional_query_columns=None): - if not filters: filters = {} + +def _execute( + filters=None, + additional_table_columns=None, + additional_query_columns=None, + additional_conditions=None, +): + if not filters: + filters = {} columns = get_columns(additional_table_columns, filters) - company_currency = frappe.get_cached_value('Company', filters.get('company'), 'default_currency') + company_currency = frappe.get_cached_value("Company", filters.get("company"), "default_currency") - item_list = get_items(filters, additional_query_columns) + item_list = get_items(filters, additional_query_columns, additional_conditions) if item_list: itemised_tax, tax_columns = get_tax_accounts(item_list, columns, company_currency) @@ -34,10 +41,10 @@ def _execute(filters=None, additional_table_columns=None, additional_query_colum data = [] total_row_map = {} skip_total_row = 0 - prev_group_by_value = '' + prev_group_by_value = "" - if filters.get('group_by'): - grand_total = get_grand_total(filters, 'Sales Invoice') + if filters.get("group_by"): + grand_total = get_grand_total(filters, "Sales Invoice") customer_details = get_customer_details() item_details = get_item_details() @@ -56,289 +63,291 @@ def _execute(filters=None, additional_table_columns=None, additional_query_colum delivery_note = d.parent row = { - 'item_code': d.item_code, - 'item_name': item_record.item_name if item_record else d.item_name, - 'item_group': item_record.item_group if item_record else d.item_group, - 'description': d.description, - 'invoice': d.parent, - 'posting_date': d.posting_date, - 'customer': d.customer, - 'customer_name': customer_record.customer_name, - 'customer_group': customer_record.customer_group, + "item_code": d.item_code, + "item_name": item_record.item_name if item_record else d.item_name, + "item_group": item_record.item_group if item_record else d.item_group, + "description": d.description, + "invoice": d.parent, + "posting_date": d.posting_date, + "customer": d.customer, + "customer_name": customer_record.customer_name, + "customer_group": customer_record.customer_group, } if additional_query_columns: for col in additional_query_columns: - row.update({ - col: d.get(col) - }) + row.update({col: d.get(col)}) - row.update({ - 'debit_to': d.debit_to, - 'mode_of_payment': ", ".join(mode_of_payments.get(d.parent, [])), - 'territory': d.territory, - 'project': d.project, - 'company': d.company, - 'sales_order': d.sales_order, - 'delivery_note': d.delivery_note, - 'income_account': d.unrealized_profit_loss_account if d.is_internal_customer == 1 else d.income_account, - 'cost_center': d.cost_center, - 'stock_qty': d.stock_qty, - 'stock_uom': d.stock_uom - }) + row.update( + { + "debit_to": d.debit_to, + "mode_of_payment": ", ".join(mode_of_payments.get(d.parent, [])), + "territory": d.territory, + "project": d.project, + "company": d.company, + "sales_order": d.sales_order, + "delivery_note": d.delivery_note, + "income_account": d.unrealized_profit_loss_account + if d.is_internal_customer == 1 + else d.income_account, + "cost_center": d.cost_center, + "stock_qty": d.stock_qty, + "stock_uom": d.stock_uom, + } + ) if d.stock_uom != d.uom and d.stock_qty: - row.update({ - 'rate': (d.base_net_rate * d.qty)/d.stock_qty, - 'amount': d.base_net_amount - }) + row.update({"rate": (d.base_net_rate * d.qty) / d.stock_qty, "amount": d.base_net_amount}) else: - row.update({ - 'rate': d.base_net_rate, - 'amount': d.base_net_amount - }) + row.update({"rate": d.base_net_rate, "amount": d.base_net_amount}) total_tax = 0 + total_other_charges = 0 for tax in tax_columns: item_tax = itemised_tax.get(d.name, {}).get(tax, {}) - row.update({ - frappe.scrub(tax + ' Rate'): item_tax.get('tax_rate', 0), - frappe.scrub(tax + ' Amount'): item_tax.get('tax_amount', 0), - }) - total_tax += flt(item_tax.get('tax_amount')) + row.update( + { + frappe.scrub(tax + " Rate"): item_tax.get("tax_rate", 0), + frappe.scrub(tax + " Amount"): item_tax.get("tax_amount", 0), + } + ) + if item_tax.get("is_other_charges"): + total_other_charges += flt(item_tax.get("tax_amount")) + else: + total_tax += flt(item_tax.get("tax_amount")) - row.update({ - 'total_tax': total_tax, - 'total': d.base_net_amount + total_tax, - 'currency': company_currency - }) + row.update( + { + "total_tax": total_tax, + "total_other_charges": total_other_charges, + "total": d.base_net_amount + total_tax, + "currency": company_currency, + } + ) - if filters.get('group_by'): - row.update({'percent_gt': flt(row['total']/grand_total) * 100}) + if filters.get("group_by"): + row.update({"percent_gt": flt(row["total"] / grand_total) * 100}) group_by_field, subtotal_display_field = get_group_by_and_display_fields(filters) - data, prev_group_by_value = add_total_row(data, filters, prev_group_by_value, d, total_row_map, - group_by_field, subtotal_display_field, grand_total, tax_columns) - add_sub_total_row(row, total_row_map, d.get(group_by_field, ''), tax_columns) + data, prev_group_by_value = add_total_row( + data, + filters, + prev_group_by_value, + d, + total_row_map, + group_by_field, + subtotal_display_field, + grand_total, + tax_columns, + ) + add_sub_total_row(row, total_row_map, d.get(group_by_field, ""), tax_columns) data.append(row) - if filters.get('group_by') and item_list: - total_row = total_row_map.get(prev_group_by_value or d.get('item_name')) - total_row['percent_gt'] = flt(total_row['total']/grand_total * 100) + if filters.get("group_by") and item_list: + total_row = total_row_map.get(prev_group_by_value or d.get("item_name")) + total_row["percent_gt"] = flt(total_row["total"] / grand_total * 100) data.append(total_row) data.append({}) - add_sub_total_row(total_row, total_row_map, 'total_row', tax_columns) - data.append(total_row_map.get('total_row')) + add_sub_total_row(total_row, total_row_map, "total_row", tax_columns) + data.append(total_row_map.get("total_row")) skip_total_row = 1 return columns, data, None, None, None, skip_total_row + def get_columns(additional_table_columns, filters): columns = [] - if filters.get('group_by') != ('Item'): + if filters.get("group_by") != ("Item"): columns.extend( [ { - 'label': _('Item Code'), - 'fieldname': 'item_code', - 'fieldtype': 'Link', - 'options': 'Item', - 'width': 120 + "label": _("Item Code"), + "fieldname": "item_code", + "fieldtype": "Link", + "options": "Item", + "width": 120, }, + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 120}, + ] + ) + + if filters.get("group_by") not in ("Item", "Item Group"): + columns.extend( + [ { - 'label': _('Item Name'), - 'fieldname': 'item_name', - 'fieldtype': 'Data', - 'width': 120 + "label": _("Item Group"), + "fieldname": "item_group", + "fieldtype": "Link", + "options": "Item Group", + "width": 120, } ] ) - if filters.get('group_by') not in ('Item', 'Item Group'): - columns.extend([ + columns.extend( + [ + {"label": _("Description"), "fieldname": "description", "fieldtype": "Data", "width": 150}, { - 'label': _('Item Group'), - 'fieldname': 'item_group', - 'fieldtype': 'Link', - 'options': 'Item Group', - 'width': 120 - } - ]) - - columns.extend([ - { - 'label': _('Description'), - 'fieldname': 'description', - 'fieldtype': 'Data', - 'width': 150 - }, - { - 'label': _('Invoice'), - 'fieldname': 'invoice', - 'fieldtype': 'Link', - 'options': 'Sales Invoice', - 'width': 120 - }, - { - 'label': _('Posting Date'), - 'fieldname': 'posting_date', - 'fieldtype': 'Date', - 'width': 120 - } - ]) - - if filters.get('group_by') != 'Customer': - columns.extend([ - { - 'label': _('Customer Group'), - 'fieldname': 'customer_group', - 'fieldtype': 'Link', - 'options': 'Customer Group', - 'width': 120 - } - ]) - - if filters.get('group_by') not in ('Customer', 'Customer Group'): - columns.extend([ - { - 'label': _('Customer'), - 'fieldname': 'customer', - 'fieldtype': 'Link', - 'options': 'Customer', - 'width': 120 + "label": _("Invoice"), + "fieldname": "invoice", + "fieldtype": "Link", + "options": "Sales Invoice", + "width": 120, }, - { - 'label': _('Customer Name'), - 'fieldname': 'customer_name', - 'fieldtype': 'Data', - 'width': 120 - } - ]) + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 120}, + ] + ) + + if filters.get("group_by") != "Customer": + columns.extend( + [ + { + "label": _("Customer Group"), + "fieldname": "customer_group", + "fieldtype": "Link", + "options": "Customer Group", + "width": 120, + } + ] + ) + + if filters.get("group_by") not in ("Customer", "Customer Group"): + columns.extend( + [ + { + "label": _("Customer"), + "fieldname": "customer", + "fieldtype": "Link", + "options": "Customer", + "width": 120, + }, + {"label": _("Customer Name"), "fieldname": "customer_name", "fieldtype": "Data", "width": 120}, + ] + ) if additional_table_columns: columns += additional_table_columns columns += [ { - 'label': _('Receivable Account'), - 'fieldname': 'debit_to', - 'fieldtype': 'Link', - 'options': 'Account', - 'width': 80 + "label": _("Receivable Account"), + "fieldname": "debit_to", + "fieldtype": "Link", + "options": "Account", + "width": 80, }, { - 'label': _('Mode Of Payment'), - 'fieldname': 'mode_of_payment', - 'fieldtype': 'Data', - 'width': 120 - } + "label": _("Mode Of Payment"), + "fieldname": "mode_of_payment", + "fieldtype": "Data", + "width": 120, + }, ] - if filters.get('group_by') != 'Territory': - columns.extend([ - { - 'label': _('Territory'), - 'fieldname': 'territory', - 'fieldtype': 'Link', - 'options': 'Territory', - 'width': 80 - } - ]) - + if filters.get("group_by") != "Territory": + columns.extend( + [ + { + "label": _("Territory"), + "fieldname": "territory", + "fieldtype": "Link", + "options": "Territory", + "width": 80, + } + ] + ) columns += [ { - 'label': _('Project'), - 'fieldname': 'project', - 'fieldtype': 'Link', - 'options': 'Project', - 'width': 80 + "label": _("Project"), + "fieldname": "project", + "fieldtype": "Link", + "options": "Project", + "width": 80, }, { - 'label': _('Company'), - 'fieldname': 'company', - 'fieldtype': 'Link', - 'options': 'Company', - 'width': 80 + "label": _("Company"), + "fieldname": "company", + "fieldtype": "Link", + "options": "Company", + "width": 80, }, { - 'label': _('Sales Order'), - 'fieldname': 'sales_order', - 'fieldtype': 'Link', - 'options': 'Sales Order', - 'width': 100 + "label": _("Sales Order"), + "fieldname": "sales_order", + "fieldtype": "Link", + "options": "Sales Order", + "width": 100, }, { - 'label': _("Delivery Note"), - 'fieldname': 'delivery_note', - 'fieldtype': 'Link', - 'options': 'Delivery Note', - 'width': 100 + "label": _("Delivery Note"), + "fieldname": "delivery_note", + "fieldtype": "Link", + "options": "Delivery Note", + "width": 100, }, { - 'label': _('Income Account'), - 'fieldname': 'income_account', - 'fieldtype': 'Link', - 'options': 'Account', - 'width': 100 + "label": _("Income Account"), + "fieldname": "income_account", + "fieldtype": "Link", + "options": "Account", + "width": 100, }, { - 'label': _("Cost Center"), - 'fieldname': 'cost_center', - 'fieldtype': 'Link', - 'options': 'Cost Center', - 'width': 100 + "label": _("Cost Center"), + "fieldname": "cost_center", + "fieldtype": "Link", + "options": "Cost Center", + "width": 100, + }, + {"label": _("Stock Qty"), "fieldname": "stock_qty", "fieldtype": "Float", "width": 100}, + { + "label": _("Stock UOM"), + "fieldname": "stock_uom", + "fieldtype": "Link", + "options": "UOM", + "width": 100, }, { - 'label': _('Stock Qty'), - 'fieldname': 'stock_qty', - 'fieldtype': 'Float', - 'width': 100 + "label": _("Rate"), + "fieldname": "rate", + "fieldtype": "Float", + "options": "currency", + "width": 100, }, { - 'label': _('Stock UOM'), - 'fieldname': 'stock_uom', - 'fieldtype': 'Link', - 'options': 'UOM', - 'width': 100 + "label": _("Amount"), + "fieldname": "amount", + "fieldtype": "Currency", + "options": "currency", + "width": 100, }, - { - 'label': _('Rate'), - 'fieldname': 'rate', - 'fieldtype': 'Float', - 'options': 'currency', - 'width': 100 - }, - { - 'label': _('Amount'), - 'fieldname': 'amount', - 'fieldtype': 'Currency', - 'options': 'currency', - 'width': 100 - } ] - if filters.get('group_by'): - columns.append({ - 'label': _('% Of Grand Total'), - 'fieldname': 'percent_gt', - 'fieldtype': 'Float', - 'width': 80 - }) + if filters.get("group_by"): + columns.append( + {"label": _("% Of Grand Total"), "fieldname": "percent_gt", "fieldtype": "Float", "width": 80} + ) return columns -def get_conditions(filters): + +def get_conditions(filters, additional_conditions=None): conditions = "" - for opts in (("company", " and company=%(company)s"), + for opts in ( + ("company", " and company=%(company)s"), ("customer", " and `tabSales Invoice`.customer = %(customer)s"), ("item_code", " and `tabSales Invoice Item`.item_code = %(item_code)s"), ("from_date", " and `tabSales Invoice`.posting_date>=%(from_date)s"), - ("to_date", " and `tabSales Invoice`.posting_date<=%(to_date)s")): - if filters.get(opts[0]): - conditions += opts[1] + ("to_date", " and `tabSales Invoice`.posting_date<=%(to_date)s"), + ): + if filters.get(opts[0]): + conditions += opts[1] + + if additional_conditions: + conditions += additional_conditions if filters.get("mode_of_payment"): conditions += """ and exists(select name from `tabSales Invoice Payment` @@ -346,41 +355,45 @@ def get_conditions(filters): and ifnull(`tabSales Invoice Payment`.mode_of_payment, '') = %(mode_of_payment)s)""" if filters.get("warehouse"): - conditions += """and ifnull(`tabSales Invoice Item`.warehouse, '') = %(warehouse)s""" - + conditions += """and ifnull(`tabSales Invoice Item`.warehouse, '') = %(warehouse)s""" if filters.get("brand"): - conditions += """and ifnull(`tabSales Invoice Item`.brand, '') = %(brand)s""" + conditions += """and ifnull(`tabSales Invoice Item`.brand, '') = %(brand)s""" if filters.get("item_group"): - conditions += """and ifnull(`tabSales Invoice Item`.item_group, '') = %(item_group)s""" + conditions += """and ifnull(`tabSales Invoice Item`.item_group, '') = %(item_group)s""" if not filters.get("group_by"): - conditions += "ORDER BY `tabSales Invoice`.posting_date desc, `tabSales Invoice Item`.item_group desc" + conditions += ( + "ORDER BY `tabSales Invoice`.posting_date desc, `tabSales Invoice Item`.item_group desc" + ) else: - conditions += get_group_by_conditions(filters, 'Sales Invoice') + conditions += get_group_by_conditions(filters, "Sales Invoice") return conditions -def get_group_by_conditions(filters, doctype): - if filters.get("group_by") == 'Invoice': - return "ORDER BY `tab{0} Item`.parent desc".format(doctype) - elif filters.get("group_by") == 'Item': - return "ORDER BY `tab{0} Item`.`item_code`".format(doctype) - elif filters.get("group_by") == 'Item Group': - return "ORDER BY `tab{0} Item`.{1}".format(doctype, frappe.scrub(filters.get('group_by'))) - elif filters.get("group_by") in ('Customer', 'Customer Group', 'Territory', 'Supplier'): - return "ORDER BY `tab{0}`.{1}".format(doctype, frappe.scrub(filters.get('group_by'))) -def get_items(filters, additional_query_columns): - conditions = get_conditions(filters) +def get_group_by_conditions(filters, doctype): + if filters.get("group_by") == "Invoice": + return "ORDER BY `tab{0} Item`.parent desc".format(doctype) + elif filters.get("group_by") == "Item": + return "ORDER BY `tab{0} Item`.`item_code`".format(doctype) + elif filters.get("group_by") == "Item Group": + return "ORDER BY `tab{0} Item`.{1}".format(doctype, frappe.scrub(filters.get("group_by"))) + elif filters.get("group_by") in ("Customer", "Customer Group", "Territory", "Supplier"): + return "ORDER BY `tab{0}`.{1}".format(doctype, frappe.scrub(filters.get("group_by"))) + + +def get_items(filters, additional_query_columns, additional_conditions=None): + conditions = get_conditions(filters, additional_conditions) if additional_query_columns: - additional_query_columns = ', ' + ', '.join(additional_query_columns) + additional_query_columns = ", " + ", ".join(additional_query_columns) else: - additional_query_columns = '' + additional_query_columns = "" - return frappe.db.sql(""" + return frappe.db.sql( + """ select `tabSales Invoice Item`.name, `tabSales Invoice Item`.parent, `tabSales Invoice`.posting_date, `tabSales Invoice`.debit_to, @@ -399,47 +412,75 @@ def get_items(filters, additional_query_columns): from `tabSales Invoice`, `tabSales Invoice Item` where `tabSales Invoice`.name = `tabSales Invoice Item`.parent and `tabSales Invoice`.docstatus = 1 {1} - """.format(additional_query_columns or '', conditions), filters, as_dict=1) #nosec + """.format( + additional_query_columns or "", conditions + ), + filters, + as_dict=1, + ) # nosec + def get_delivery_notes_against_sales_order(item_list): so_dn_map = frappe._dict() so_item_rows = list(set([d.so_detail for d in item_list])) if so_item_rows: - delivery_notes = frappe.db.sql(""" + delivery_notes = frappe.db.sql( + """ select parent, so_detail from `tabDelivery Note Item` where docstatus=1 and so_detail in (%s) group by so_detail, parent - """ % (', '.join(['%s']*len(so_item_rows))), tuple(so_item_rows), as_dict=1) + """ + % (", ".join(["%s"] * len(so_item_rows))), + tuple(so_item_rows), + as_dict=1, + ) for dn in delivery_notes: so_dn_map.setdefault(dn.so_detail, []).append(dn.parent) return so_dn_map + def get_grand_total(filters, doctype): - return frappe.db.sql(""" SELECT + return frappe.db.sql( + """ SELECT SUM(`tab{0}`.base_grand_total) FROM `tab{0}` WHERE `tab{0}`.docstatus = 1 and posting_date between %s and %s - """.format(doctype), (filters.get('from_date'), filters.get('to_date')))[0][0] #nosec + """.format( + doctype + ), + (filters.get("from_date"), filters.get("to_date")), + )[0][ + 0 + ] # nosec -def get_deducted_taxes(): - return frappe.db.sql_list("select name from `tabPurchase Taxes and Charges` where add_deduct_tax = 'Deduct'") -def get_tax_accounts(item_list, columns, company_currency, - doctype='Sales Invoice', tax_doctype='Sales Taxes and Charges'): +def get_tax_accounts( + item_list, + columns, + company_currency, + doctype="Sales Invoice", + tax_doctype="Sales Taxes and Charges", +): import json + item_row_map = {} tax_columns = [] invoice_item_row = {} itemised_tax = {} + add_deduct_tax = "charge_type" - tax_amount_precision = get_field_precision(frappe.get_meta(tax_doctype).get_field('tax_amount'), - currency=company_currency) or 2 + tax_amount_precision = ( + get_field_precision( + frappe.get_meta(tax_doctype).get_field("tax_amount"), currency=company_currency + ) + or 2 + ) for d in item_list: invoice_item_row.setdefault(d.parent, []).append(d) @@ -448,12 +489,13 @@ def get_tax_accounts(item_list, columns, company_currency, conditions = "" if doctype == "Purchase Invoice": conditions = " and category in ('Total', 'Valuation and Total') and base_tax_amount_after_discount_amount != 0" + add_deduct_tax = "add_deduct_tax" - deducted_tax = get_deducted_taxes() - tax_details = frappe.db.sql(""" + tax_details = frappe.db.sql( + """ select - name, parent, description, item_wise_tax_detail, - charge_type, base_tax_amount_after_discount_amount + name, parent, description, item_wise_tax_detail, account_head, + charge_type, {add_deduct_tax}, base_tax_amount_after_discount_amount from `tab%s` where parenttype = %s and docstatus = 1 @@ -461,10 +503,33 @@ def get_tax_accounts(item_list, columns, company_currency, and parent in (%s) %s order by description - """ % (tax_doctype, '%s', ', '.join(['%s']*len(invoice_item_row)), conditions), - tuple([doctype] + list(invoice_item_row))) + """.format( + add_deduct_tax=add_deduct_tax + ) + % (tax_doctype, "%s", ", ".join(["%s"] * len(invoice_item_row)), conditions), + tuple([doctype] + list(invoice_item_row)), + ) - for name, parent, description, item_wise_tax_detail, charge_type, tax_amount in tax_details: + account_doctype = frappe.qb.DocType("Account") + + query = ( + frappe.qb.from_(account_doctype) + .select(account_doctype.name) + .where((account_doctype.account_type == "Tax")) + ) + + tax_accounts = query.run() + + for ( + name, + parent, + description, + item_wise_tax_detail, + account_head, + charge_type, + add_deduct_tax, + tax_amount, + ) in tax_details: description = handle_html(description) if description not in tax_columns and tax_amount: # as description is text editor earlier and markup can break the column convention in reports @@ -483,151 +548,200 @@ def get_tax_accounts(item_list, columns, company_currency, tax_rate = tax_data tax_amount = 0 - if charge_type == 'Actual' and not tax_rate: - tax_rate = 'NA' + if charge_type == "Actual" and not tax_rate: + tax_rate = "NA" - item_net_amount = sum([flt(d.base_net_amount) - for d in item_row_map.get(parent, {}).get(item_code, [])]) + item_net_amount = sum( + [flt(d.base_net_amount) for d in item_row_map.get(parent, {}).get(item_code, [])] + ) for d in item_row_map.get(parent, {}).get(item_code, []): - item_tax_amount = flt((tax_amount * d.base_net_amount) / item_net_amount) \ - if item_net_amount else 0 + item_tax_amount = ( + flt((tax_amount * d.base_net_amount) / item_net_amount) if item_net_amount else 0 + ) if item_tax_amount: tax_value = flt(item_tax_amount, tax_amount_precision) - tax_value = (tax_value * -1 - if (doctype == 'Purchase Invoice' and name in deducted_tax) else tax_value) + tax_value = ( + tax_value * -1 + if (doctype == "Purchase Invoice" and add_deduct_tax == "Deduct") + else tax_value + ) - itemised_tax.setdefault(d.name, {})[description] = frappe._dict({ - 'tax_rate': tax_rate, - 'tax_amount': tax_value - }) + itemised_tax.setdefault(d.name, {})[description] = frappe._dict( + { + "tax_rate": tax_rate, + "tax_amount": tax_value, + "is_other_charges": 0 if tuple([account_head]) in tax_accounts else 1, + } + ) except ValueError: continue - elif charge_type == 'Actual' and tax_amount: + elif charge_type == "Actual" and tax_amount: for d in invoice_item_row.get(parent, []): - itemised_tax.setdefault(d.name, {})[description] = frappe._dict({ - 'tax_rate': 'NA', - 'tax_amount': flt((tax_amount * d.base_net_amount) / d.base_net_total, - tax_amount_precision) - }) + itemised_tax.setdefault(d.name, {})[description] = frappe._dict( + { + "tax_rate": "NA", + "tax_amount": flt((tax_amount * d.base_net_amount) / d.base_net_total, tax_amount_precision), + } + ) tax_columns.sort() for desc in tax_columns: - columns.append({ - 'label': _(desc + ' Rate'), - 'fieldname': frappe.scrub(desc + ' Rate'), - 'fieldtype': 'Float', - 'width': 100 - }) + columns.append( + { + "label": _(desc + " Rate"), + "fieldname": frappe.scrub(desc + " Rate"), + "fieldtype": "Float", + "width": 100, + } + ) - columns.append({ - 'label': _(desc + ' Amount'), - 'fieldname': frappe.scrub(desc + ' Amount'), - 'fieldtype': 'Currency', - 'options': 'currency', - 'width': 100 - }) + columns.append( + { + "label": _(desc + " Amount"), + "fieldname": frappe.scrub(desc + " Amount"), + "fieldtype": "Currency", + "options": "currency", + "width": 100, + } + ) columns += [ { - 'label': _('Total Tax'), - 'fieldname': 'total_tax', - 'fieldtype': 'Currency', - 'options': 'currency', - 'width': 100 + "label": _("Total Tax"), + "fieldname": "total_tax", + "fieldtype": "Currency", + "options": "currency", + "width": 100, }, { - 'label': _('Total'), - 'fieldname': 'total', - 'fieldtype': 'Currency', - 'options': 'currency', - 'width': 100 + "label": _("Total Other Charges"), + "fieldname": "total_other_charges", + "fieldtype": "Currency", + "options": "currency", + "width": 100, }, { - 'fieldname': 'currency', - 'label': _('Currency'), - 'fieldtype': 'Currency', - 'width': 80, - 'hidden': 1 - } + "label": _("Total"), + "fieldname": "total", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + { + "fieldname": "currency", + "label": _("Currency"), + "fieldtype": "Currency", + "width": 80, + "hidden": 1, + }, ] return itemised_tax, tax_columns -def add_total_row(data, filters, prev_group_by_value, item, total_row_map, - group_by_field, subtotal_display_field, grand_total, tax_columns): - if prev_group_by_value != item.get(group_by_field, ''): + +def add_total_row( + data, + filters, + prev_group_by_value, + item, + total_row_map, + group_by_field, + subtotal_display_field, + grand_total, + tax_columns, +): + if prev_group_by_value != item.get(group_by_field, ""): if prev_group_by_value: total_row = total_row_map.get(prev_group_by_value) data.append(total_row) data.append({}) - add_sub_total_row(total_row, total_row_map, 'total_row', tax_columns) + add_sub_total_row(total_row, total_row_map, "total_row", tax_columns) - prev_group_by_value = item.get(group_by_field, '') + prev_group_by_value = item.get(group_by_field, "") - total_row_map.setdefault(item.get(group_by_field, ''), { - subtotal_display_field: get_display_value(filters, group_by_field, item), - 'stock_qty': 0.0, - 'amount': 0.0, - 'bold': 1, - 'total_tax': 0.0, - 'total': 0.0, - 'percent_gt': 0.0 - }) + total_row_map.setdefault( + item.get(group_by_field, ""), + { + subtotal_display_field: get_display_value(filters, group_by_field, item), + "stock_qty": 0.0, + "amount": 0.0, + "bold": 1, + "total_tax": 0.0, + "total": 0.0, + "percent_gt": 0.0, + }, + ) - total_row_map.setdefault('total_row', { - subtotal_display_field: 'Total', - 'stock_qty': 0.0, - 'amount': 0.0, - 'bold': 1, - 'total_tax': 0.0, - 'total': 0.0, - 'percent_gt': 0.0 - }) + total_row_map.setdefault( + "total_row", + { + subtotal_display_field: "Total", + "stock_qty": 0.0, + "amount": 0.0, + "bold": 1, + "total_tax": 0.0, + "total": 0.0, + "percent_gt": 0.0, + }, + ) return data, prev_group_by_value + def get_display_value(filters, group_by_field, item): - if filters.get('group_by') == 'Item': - if item.get('item_code') != item.get('item_name'): - value = cstr(item.get('item_code')) + "" + \ - "" + cstr(item.get('item_name')) + "" + if filters.get("group_by") == "Item": + if item.get("item_code") != item.get("item_name"): + value = ( + cstr(item.get("item_code")) + + "
" + + "" + + cstr(item.get("item_name")) + + "" + ) else: - value = item.get('item_code', '') - elif filters.get('group_by') in ('Customer', 'Supplier'): - party = frappe.scrub(filters.get('group_by')) - if item.get(party) != item.get(party+'_name'): - value = item.get(party) + "
" + \ - "" + item.get(party+'_name') + "" + value = item.get("item_code", "") + elif filters.get("group_by") in ("Customer", "Supplier"): + party = frappe.scrub(filters.get("group_by")) + if item.get(party) != item.get(party + "_name"): + value = ( + item.get(party) + + "
" + + "" + + item.get(party + "_name") + + "" + ) else: - value = item.get(party) + value = item.get(party) else: value = item.get(group_by_field) return value + def get_group_by_and_display_fields(filters): - if filters.get('group_by') == 'Item': - group_by_field = 'item_code' - subtotal_display_field = 'invoice' - elif filters.get('group_by') == 'Invoice': - group_by_field = 'parent' - subtotal_display_field = 'item_code' + if filters.get("group_by") == "Item": + group_by_field = "item_code" + subtotal_display_field = "invoice" + elif filters.get("group_by") == "Invoice": + group_by_field = "parent" + subtotal_display_field = "item_code" else: - group_by_field = frappe.scrub(filters.get('group_by')) - subtotal_display_field = 'item_code' + group_by_field = frappe.scrub(filters.get("group_by")) + subtotal_display_field = "item_code" return group_by_field, subtotal_display_field + def add_sub_total_row(item, total_row_map, group_by_value, tax_columns): total_row = total_row_map.get(group_by_value) - total_row['stock_qty'] += item['stock_qty'] - total_row['amount'] += item['amount'] - total_row['total_tax'] += item['total_tax'] - total_row['total'] += item['total'] - total_row['percent_gt'] += item['percent_gt'] + total_row["stock_qty"] += item["stock_qty"] + total_row["amount"] += item["amount"] + total_row["total_tax"] += item["total_tax"] + total_row["total"] += item["total"] + total_row["percent_gt"] += item["percent_gt"] for tax in tax_columns: - total_row.setdefault(frappe.scrub(tax + ' Amount'), 0.0) - total_row[frappe.scrub(tax + ' Amount')] += flt(item[frappe.scrub(tax + ' Amount')]) + total_row.setdefault(frappe.scrub(tax + " Amount"), 0.0) + total_row[frappe.scrub(tax + " Amount")] += flt(item[frappe.scrub(tax + " Amount")]) diff --git a/erpnext/accounts/report/non_billed_report.py b/erpnext/accounts/report/non_billed_report.py index a421bc5c206..39c5311cd99 100644 --- a/erpnext/accounts/report/non_billed_report.py +++ b/erpnext/accounts/report/non_billed_report.py @@ -9,14 +9,19 @@ from erpnext import get_default_currency def get_ordered_to_be_billed_data(args): - doctype, party = args.get('doctype'), args.get('party') + doctype, party = args.get("doctype"), args.get("party") child_tab = doctype + " Item" - precision = get_field_precision(frappe.get_meta(child_tab).get_field("billed_amt"), - currency=get_default_currency()) or 2 + precision = ( + get_field_precision( + frappe.get_meta(child_tab).get_field("billed_amt"), currency=get_default_currency() + ) + or 2 + ) project_field = get_project_field(doctype, party) - return frappe.db.sql(""" + return frappe.db.sql( + """ Select `{parent_tab}`.name, `{parent_tab}`.{date_field}, `{parent_tab}`.{party}, `{parent_tab}`.{party}_name, @@ -40,9 +45,20 @@ def get_ordered_to_be_billed_data(args): (`{child_tab}`.base_rate * ifnull(`{child_tab}`.returned_qty, 0))) > 0 order by `{parent_tab}`.{order} {order_by} - """.format(parent_tab = 'tab' + doctype, child_tab = 'tab' + child_tab, precision= precision, party = party, - date_field = args.get('date'), project_field = project_field, order= args.get('order'), order_by = args.get('order_by'))) + """.format( + parent_tab="tab" + doctype, + child_tab="tab" + child_tab, + precision=precision, + party=party, + date_field=args.get("date"), + project_field=project_field, + order=args.get("order"), + order_by=args.get("order_by"), + ) + ) + def get_project_field(doctype, party): - if party == "supplier": doctype = doctype + ' Item' - return "`tab%s`.project"%(doctype) + if party == "supplier": + doctype = doctype + " Item" + return "`tab%s`.project" % (doctype) diff --git a/erpnext/accounts/report/payment_period_based_on_invoice_date/payment_period_based_on_invoice_date.py b/erpnext/accounts/report/payment_period_based_on_invoice_date/payment_period_based_on_invoice_date.py index 6c12093763d..00f5948a1b6 100644 --- a/erpnext/accounts/report/payment_period_based_on_invoice_date/payment_period_based_on_invoice_date.py +++ b/erpnext/accounts/report/payment_period_based_on_invoice_date/payment_period_based_on_invoice_date.py @@ -28,21 +28,28 @@ def execute(filters=None): else: payment_amount = flt(d.credit) or -1 * flt(d.debit) - d.update({ - "range1": 0, - "range2": 0, - "range3": 0, - "range4": 0, - "outstanding": payment_amount - }) + d.update({"range1": 0, "range2": 0, "range3": 0, "range4": 0, "outstanding": payment_amount}) if d.against_voucher: ReceivablePayableReport(filters).get_ageing_data(invoice.posting_date, d) row = [ - d.voucher_type, d.voucher_no, d.party_type, d.party, d.posting_date, d.against_voucher, - invoice.posting_date, invoice.due_date, d.debit, d.credit, d.remarks, - d.age, d.range1, d.range2, d.range3, d.range4 + d.voucher_type, + d.voucher_no, + d.party_type, + d.party, + d.posting_date, + d.against_voucher, + invoice.posting_date, + invoice.due_date, + d.debit, + d.credit, + d.remarks, + d.age, + d.range1, + d.range2, + d.range3, + d.range4, ] if invoice.due_date: @@ -52,11 +59,17 @@ def execute(filters=None): return columns, data + def validate_filters(filters): - if (filters.get("payment_type") == _("Incoming") and filters.get("party_type") == "Supplier") or \ - (filters.get("payment_type") == _("Outgoing") and filters.get("party_type") == "Customer"): - frappe.throw(_("{0} payment entries can not be filtered by {1}")\ - .format(filters.payment_type, filters.party_type)) + if (filters.get("payment_type") == _("Incoming") and filters.get("party_type") == "Supplier") or ( + filters.get("payment_type") == _("Outgoing") and filters.get("party_type") == "Customer" + ): + frappe.throw( + _("{0} payment entries can not be filtered by {1}").format( + filters.payment_type, filters.party_type + ) + ) + def get_columns(filters): return [ @@ -64,109 +77,57 @@ def get_columns(filters): "fieldname": "payment_document", "label": _("Payment Document Type"), "fieldtype": "Data", - "width": 100 + "width": 100, }, { "fieldname": "payment_entry", "label": _("Payment Document"), "fieldtype": "Dynamic Link", "options": "payment_document", - "width": 160 - }, - { - "fieldname": "party_type", - "label": _("Party Type"), - "fieldtype": "Data", - "width": 100 + "width": 160, }, + {"fieldname": "party_type", "label": _("Party Type"), "fieldtype": "Data", "width": 100}, { "fieldname": "party", "label": _("Party"), "fieldtype": "Dynamic Link", "options": "party_type", - "width": 160 - }, - { - "fieldname": "posting_date", - "label": _("Posting Date"), - "fieldtype": "Date", - "width": 100 + "width": 160, }, + {"fieldname": "posting_date", "label": _("Posting Date"), "fieldtype": "Date", "width": 100}, { "fieldname": "invoice", "label": _("Invoice"), "fieldtype": "Link", - "options": "Purchase Invoice" if filters.get("payment_type") == _("Outgoing") else "Sales Invoice", - "width": 160 + "options": "Purchase Invoice" + if filters.get("payment_type") == _("Outgoing") + else "Sales Invoice", + "width": 160, }, { "fieldname": "invoice_posting_date", "label": _("Invoice Posting Date"), "fieldtype": "Date", - "width": 100 + "width": 100, }, + {"fieldname": "due_date", "label": _("Payment Due Date"), "fieldtype": "Date", "width": 100}, + {"fieldname": "debit", "label": _("Debit"), "fieldtype": "Currency", "width": 140}, + {"fieldname": "credit", "label": _("Credit"), "fieldtype": "Currency", "width": 140}, + {"fieldname": "remarks", "label": _("Remarks"), "fieldtype": "Data", "width": 200}, + {"fieldname": "age", "label": _("Age"), "fieldtype": "Int", "width": 50}, + {"fieldname": "range1", "label": "0-30", "fieldtype": "Currency", "width": 140}, + {"fieldname": "range2", "label": "30-60", "fieldtype": "Currency", "width": 140}, + {"fieldname": "range3", "label": "60-90", "fieldtype": "Currency", "width": 140}, + {"fieldname": "range4", "label": _("90 Above"), "fieldtype": "Currency", "width": 140}, { - "fieldname": "due_date", - "label": _("Payment Due Date"), - "fieldtype": "Date", - "width": 100 - }, - { - "fieldname": "debit", - "label": _("Debit"), - "fieldtype": "Currency", - "width": 140 - }, - { - "fieldname": "credit", - "label": _("Credit"), - "fieldtype": "Currency", - "width": 140 - }, - { - "fieldname": "remarks", - "label": _("Remarks"), - "fieldtype": "Data", - "width": 200 - }, - { - "fieldname": "age", - "label": _("Age"), - "fieldtype": "Int", - "width": 50 - }, - { - "fieldname": "range1", - "label": "0-30", - "fieldtype": "Currency", - "width": 140 - }, - { - "fieldname": "range2", - "label": "30-60", - "fieldtype": "Currency", - "width": 140 - }, - { - "fieldname": "range3", - "label": "60-90", - "fieldtype": "Currency", - "width": 140 - }, - { - "fieldname": "range4", - "label": _("90 Above"), - "fieldtype": "Currency", - "width": 140 - }, - { "fieldname": "delay_in_payment", "label": _("Delay in payment (Days)"), "fieldtype": "Int", - "width": 100 - } + "width": 100, + }, ] + def get_conditions(filters): conditions = [] @@ -184,7 +145,9 @@ def get_conditions(filters): if filters.party_type: conditions.append("against_voucher_type=%(reference_type)s") - filters["reference_type"] = "Sales Invoice" if filters.party_type=="Customer" else "Purchase Invoice" + filters["reference_type"] = ( + "Sales Invoice" if filters.party_type == "Customer" else "Purchase Invoice" + ) if filters.get("from_date"): conditions.append("posting_date >= %(from_date)s") @@ -194,12 +157,20 @@ def get_conditions(filters): return "and " + " and ".join(conditions) if conditions else "" + def get_entries(filters): - return frappe.db.sql("""select + return frappe.db.sql( + """select voucher_type, voucher_no, party_type, party, posting_date, debit, credit, remarks, against_voucher from `tabGL Entry` where company=%(company)s and voucher_type in ('Journal Entry', 'Payment Entry') {0} - """.format(get_conditions(filters)), filters, as_dict=1) + """.format( + get_conditions(filters) + ), + filters, + as_dict=1, + ) + def get_invoice_posting_date_map(filters): invoice_details = {} diff --git a/erpnext/accounts/report/pos_register/pos_register.py b/erpnext/accounts/report/pos_register/pos_register.py index 77e7568533e..9c0aba332ef 100644 --- a/erpnext/accounts/report/pos_register/pos_register.py +++ b/erpnext/accounts/report/pos_register/pos_register.py @@ -37,11 +37,14 @@ def execute(filters=None): add_subtotal_row(grouped_data, invoices, group_by_field, key) # move group by column to first position - column_index = next((index for (index, d) in enumerate(columns) if d["fieldname"] == group_by_field), None) + column_index = next( + (index for (index, d) in enumerate(columns) if d["fieldname"] == group_by_field), None + ) columns.insert(0, columns.pop(column_index)) return columns, grouped_data + def get_pos_entries(filters, group_by_field): conditions = get_conditions(filters) order_by = "p.posting_date" @@ -59,7 +62,7 @@ def get_pos_entries(filters, group_by_field): """ SELECT p.posting_date, p.name as pos_invoice, p.pos_profile, - p.owner, p.base_grand_total as grand_total, p.base_paid_amount as paid_amount, + p.owner, p.base_grand_total as grand_total, p.base_paid_amount - p.change_amount as paid_amount, p.customer, p.is_return {select_mop_field} FROM `tabPOS Invoice` p {from_sales_invoice_payment} @@ -74,8 +77,12 @@ def get_pos_entries(filters, group_by_field): from_sales_invoice_payment=from_sales_invoice_payment, group_by_mop_condition=group_by_mop_condition, conditions=conditions, - order_by=order_by - ), filters, as_dict=1) + order_by=order_by, + ), + filters, + as_dict=1, + ) + def concat_mode_of_payments(pos_entries): mode_of_payments = get_mode_of_payments(set(d.pos_invoice for d in pos_entries)) @@ -83,41 +90,50 @@ def concat_mode_of_payments(pos_entries): if mode_of_payments.get(entry.pos_invoice): entry.mode_of_payment = ", ".join(mode_of_payments.get(entry.pos_invoice, [])) + def add_subtotal_row(data, group_invoices, group_by_field, group_by_value): grand_total = sum(d.grand_total for d in group_invoices) paid_amount = sum(d.paid_amount for d in group_invoices) - data.append({ - group_by_field: group_by_value, - "grand_total": grand_total, - "paid_amount": paid_amount, - "bold": 1 - }) + data.append( + { + group_by_field: group_by_value, + "grand_total": grand_total, + "paid_amount": paid_amount, + "bold": 1, + } + ) data.append({}) + def validate_filters(filters): if not filters.get("company"): frappe.throw(_("{0} is mandatory").format(_("Company"))) if not filters.get("from_date") and not filters.get("to_date"): - frappe.throw(_("{0} and {1} are mandatory").format(frappe.bold(_("From Date")), frappe.bold(_("To Date")))) + frappe.throw( + _("{0} and {1} are mandatory").format(frappe.bold(_("From Date")), frappe.bold(_("To Date"))) + ) if filters.from_date > filters.to_date: frappe.throw(_("From Date must be before To Date")) - if (filters.get("pos_profile") and filters.get("group_by") == _('POS Profile')): + if filters.get("pos_profile") and filters.get("group_by") == _("POS Profile"): frappe.throw(_("Can not filter based on POS Profile, if grouped by POS Profile")) - if (filters.get("customer") and filters.get("group_by") == _('Customer')): + if filters.get("customer") and filters.get("group_by") == _("Customer"): frappe.throw(_("Can not filter based on Customer, if grouped by Customer")) - if (filters.get("owner") and filters.get("group_by") == _('Cashier')): + if filters.get("owner") and filters.get("group_by") == _("Cashier"): frappe.throw(_("Can not filter based on Cashier, if grouped by Cashier")) - if (filters.get("mode_of_payment") and filters.get("group_by") == _('Payment Method')): + if filters.get("mode_of_payment") and filters.get("group_by") == _("Payment Method"): frappe.throw(_("Can not filter based on Payment Method, if grouped by Payment Method")) + def get_conditions(filters): - conditions = "company = %(company)s AND posting_date >= %(from_date)s AND posting_date <= %(to_date)s" + conditions = ( + "company = %(company)s AND posting_date >= %(from_date)s AND posting_date <= %(to_date)s" + ) if filters.get("pos_profile"): conditions += " AND pos_profile = %(pos_profile)s" @@ -140,6 +156,7 @@ def get_conditions(filters): return conditions + def get_group_by_field(group_by): group_by_field = "" @@ -154,68 +171,59 @@ def get_group_by_field(group_by): return group_by_field + def get_columns(filters): columns = [ - { - "label": _("Posting Date"), - "fieldname": "posting_date", - "fieldtype": "Date", - "width": 90 - }, + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 90}, { "label": _("POS Invoice"), "fieldname": "pos_invoice", "fieldtype": "Link", "options": "POS Invoice", - "width": 120 + "width": 120, }, { "label": _("Customer"), "fieldname": "customer", "fieldtype": "Link", "options": "Customer", - "width": 120 + "width": 120, }, { "label": _("POS Profile"), "fieldname": "pos_profile", "fieldtype": "Link", "options": "POS Profile", - "width": 160 + "width": 160, }, { "label": _("Cashier"), "fieldname": "owner", "fieldtype": "Link", "options": "User", - "width": 140 + "width": 140, }, { "label": _("Grand Total"), "fieldname": "grand_total", "fieldtype": "Currency", "options": "company:currency", - "width": 120 + "width": 120, }, { "label": _("Paid Amount"), "fieldname": "paid_amount", "fieldtype": "Currency", "options": "company:currency", - "width": 120 + "width": 120, }, { "label": _("Payment Method"), "fieldname": "mode_of_payment", "fieldtype": "Data", - "width": 150 - }, - { - "label": _("Is Return"), - "fieldname": "is_return", - "fieldtype": "Data", - "width": 80 + "width": 150, }, + {"label": _("Is Return"), "fieldname": "is_return", "fieldtype": "Data", "width": 80}, ] return columns diff --git a/erpnext/accounts/report/profit_and_loss_statement/profit_and_loss_statement.py b/erpnext/accounts/report/profit_and_loss_statement/profit_and_loss_statement.py index 882e411246b..66353358a06 100644 --- a/erpnext/accounts/report/profit_and_loss_statement/profit_and_loss_statement.py +++ b/erpnext/accounts/report/profit_and_loss_statement/profit_and_loss_statement.py @@ -15,19 +15,41 @@ from erpnext.accounts.report.financial_statements import ( def execute(filters=None): - period_list = get_period_list(filters.from_fiscal_year, filters.to_fiscal_year, - filters.period_start_date, filters.period_end_date, filters.filter_based_on, filters.periodicity, - company=filters.company) + period_list = get_period_list( + filters.from_fiscal_year, + filters.to_fiscal_year, + filters.period_start_date, + filters.period_end_date, + filters.filter_based_on, + filters.periodicity, + company=filters.company, + ) - income = get_data(filters.company, "Income", "Credit", period_list, filters = filters, + income = get_data( + filters.company, + "Income", + "Credit", + period_list, + filters=filters, accumulated_values=filters.accumulated_values, - ignore_closing_entries=True, ignore_accumulated_values_for_fy= True) + ignore_closing_entries=True, + ignore_accumulated_values_for_fy=True, + ) - expense = get_data(filters.company, "Expense", "Debit", period_list, filters=filters, + expense = get_data( + filters.company, + "Expense", + "Debit", + period_list, + filters=filters, accumulated_values=filters.accumulated_values, - ignore_closing_entries=True, ignore_accumulated_values_for_fy= True) + ignore_closing_entries=True, + ignore_accumulated_values_for_fy=True, + ) - net_profit_loss = get_net_profit_loss(income, expense, period_list, filters.company, filters.presentation_currency) + net_profit_loss = get_net_profit_loss( + income, expense, period_list, filters.company, filters.presentation_currency + ) data = [] data.extend(income or []) @@ -35,20 +57,29 @@ def execute(filters=None): if net_profit_loss: data.append(net_profit_loss) - columns = get_columns(filters.periodicity, period_list, filters.accumulated_values, filters.company) + columns = get_columns( + filters.periodicity, period_list, filters.accumulated_values, filters.company + ) chart = get_chart_data(filters, columns, income, expense, net_profit_loss) - currency = filters.presentation_currency or frappe.get_cached_value('Company', filters.company, "default_currency") - report_summary = get_report_summary(period_list, filters.periodicity, income, expense, net_profit_loss, currency, filters) + currency = filters.presentation_currency or frappe.get_cached_value( + "Company", filters.company, "default_currency" + ) + report_summary = get_report_summary( + period_list, filters.periodicity, income, expense, net_profit_loss, currency, filters + ) return columns, data, None, chart, report_summary -def get_report_summary(period_list, periodicity, income, expense, net_profit_loss, currency, filters, consolidated=False): + +def get_report_summary( + period_list, periodicity, income, expense, net_profit_loss, currency, filters, consolidated=False +): net_income, net_expense, net_profit = 0.0, 0.0, 0.0 # from consolidated financial statement - if filters.get('accumulated_in_group_company'): + if filters.get("accumulated_in_group_company"): period_list = get_filtered_list_for_consolidated_report(filters, period_list) for period in period_list: @@ -60,37 +91,27 @@ def get_report_summary(period_list, periodicity, income, expense, net_profit_los if net_profit_loss: net_profit += net_profit_loss.get(key) - if (len(period_list) == 1 and periodicity== 'Yearly'): - profit_label = _("Profit This Year") - income_label = _("Total Income This Year") - expense_label = _("Total Expense This Year") + if len(period_list) == 1 and periodicity == "Yearly": + profit_label = _("Profit This Year") + income_label = _("Total Income This Year") + expense_label = _("Total Expense This Year") else: profit_label = _("Net Profit") income_label = _("Total Income") expense_label = _("Total Expense") return [ - { - "value": net_income, - "label": income_label, - "datatype": "Currency", - "currency": currency - }, - { "type": "separator", "value": "-"}, - { - "value": net_expense, - "label": expense_label, - "datatype": "Currency", - "currency": currency - }, - { "type": "separator", "value": "=", "color": "blue"}, + {"value": net_income, "label": income_label, "datatype": "Currency", "currency": currency}, + {"type": "separator", "value": "-"}, + {"value": net_expense, "label": expense_label, "datatype": "Currency", "currency": currency}, + {"type": "separator", "value": "=", "color": "blue"}, { "value": net_profit, "indicator": "Green" if net_profit > 0 else "Red", "label": profit_label, "datatype": "Currency", - "currency": currency - } + "currency": currency, + }, ] @@ -100,7 +121,7 @@ def get_net_profit_loss(income, expense, period_list, company, currency=None, co "account_name": "'" + _("Profit for the year") + "'", "account": "'" + _("Profit for the year") + "'", "warn_if_negative": True, - "currency": currency or frappe.get_cached_value('Company', company, "default_currency") + "currency": currency or frappe.get_cached_value("Company", company, "default_currency"), } has_value = False @@ -113,7 +134,7 @@ def get_net_profit_loss(income, expense, period_list, company, currency=None, co net_profit_loss[key] = total_income - total_expense if net_profit_loss[key]: - has_value=True + has_value = True total += flt(net_profit_loss[key]) net_profit_loss["total"] = total @@ -121,6 +142,7 @@ def get_net_profit_loss(income, expense, period_list, company, currency=None, co if has_value: return net_profit_loss + def get_chart_data(filters, columns, income, expense, net_profit_loss): labels = [d.get("label") for d in columns[2:]] @@ -136,18 +158,13 @@ def get_chart_data(filters, columns, income, expense, net_profit_loss): datasets = [] if income_data: - datasets.append({'name': _('Income'), 'values': income_data}) + datasets.append({"name": _("Income"), "values": income_data}) if expense_data: - datasets.append({'name': _('Expense'), 'values': expense_data}) + datasets.append({"name": _("Expense"), "values": expense_data}) if net_profit: - datasets.append({'name': _('Net Profit/Loss'), 'values': net_profit}) + datasets.append({"name": _("Net Profit/Loss"), "values": net_profit}) - chart = { - "data": { - 'labels': labels, - 'datasets': datasets - } - } + chart = {"data": {"labels": labels, "datasets": datasets}} if not filters.accumulated_values: chart["type"] = "bar" diff --git a/erpnext/accounts/report/profitability_analysis/profitability_analysis.py b/erpnext/accounts/report/profitability_analysis/profitability_analysis.py index 3dcb86267c1..fd613da5694 100644 --- a/erpnext/accounts/report/profitability_analysis/profitability_analysis.py +++ b/erpnext/accounts/report/profitability_analysis/profitability_analysis.py @@ -14,31 +14,39 @@ from erpnext.accounts.report.trial_balance.trial_balance import validate_filters value_fields = ("income", "expense", "gross_profit_loss") -def execute(filters=None): - if not filters.get('based_on'): filters["based_on"] = 'Cost Center' - based_on = filters.based_on.replace(' ', '_').lower() +def execute(filters=None): + if not filters.get("based_on"): + filters["based_on"] = "Cost Center" + + based_on = filters.based_on.replace(" ", "_").lower() validate_filters(filters) accounts = get_accounts_data(based_on, filters.get("company")) data = get_data(accounts, filters, based_on) columns = get_columns(filters) return columns, data + def get_accounts_data(based_on, company): - if based_on == 'cost_center': - return frappe.db.sql("""select name, parent_cost_center as parent_account, cost_center_name as account_name, lft, rgt - from `tabCost Center` where company=%s order by name""", company, as_dict=True) - elif based_on == 'project': - return frappe.get_all('Project', fields = ["name"], filters = {'company': company}, order_by = 'name') + if based_on == "cost_center": + return frappe.db.sql( + """select name, parent_cost_center as parent_account, cost_center_name as account_name, lft, rgt + from `tabCost Center` where company=%s order by name""", + company, + as_dict=True, + ) + elif based_on == "project": + return frappe.get_all("Project", fields=["name"], filters={"company": company}, order_by="name") else: filters = {} doctype = frappe.unscrub(based_on) - has_company = frappe.db.has_column(doctype, 'company') + has_company = frappe.db.has_column(doctype, "company") if has_company: - filters.update({'company': company}) + filters.update({"company": company}) + + return frappe.get_all(doctype, fields=["name"], filters=filters, order_by="name") - return frappe.get_all(doctype, fields = ["name"], filters = filters, order_by = 'name') def get_data(accounts, filters, based_on): if not accounts: @@ -48,24 +56,28 @@ def get_data(accounts, filters, based_on): gl_entries_by_account = {} - set_gl_entries_by_account(filters.get("company"), filters.get("from_date"), - filters.get("to_date"), based_on, gl_entries_by_account, ignore_closing_entries=not flt(filters.get("with_period_closing_entry"))) + set_gl_entries_by_account( + filters.get("company"), + filters.get("from_date"), + filters.get("to_date"), + based_on, + gl_entries_by_account, + ignore_closing_entries=not flt(filters.get("with_period_closing_entry")), + ) total_row = calculate_values(accounts, gl_entries_by_account, filters) accumulate_values_into_parents(accounts, accounts_by_name) data = prepare_data(accounts, filters, total_row, parent_children_map, based_on) - data = filter_out_zero_value_rows(data, parent_children_map, - show_zero_values=filters.get("show_zero_values")) + data = filter_out_zero_value_rows( + data, parent_children_map, show_zero_values=filters.get("show_zero_values") + ) return data + def calculate_values(accounts, gl_entries_by_account, filters): - init = { - "income": 0.0, - "expense": 0.0, - "gross_profit_loss": 0.0 - } + init = {"income": 0.0, "expense": 0.0, "gross_profit_loss": 0.0} total_row = { "cost_center": None, @@ -77,7 +89,7 @@ def calculate_values(accounts, gl_entries_by_account, filters): "account": "'" + _("Total") + "'", "parent_account": None, "indent": 0, - "has_value": True + "has_value": True, } for d in accounts: @@ -87,9 +99,9 @@ def calculate_values(accounts, gl_entries_by_account, filters): for entry in gl_entries_by_account.get(d.name, []): if cstr(entry.is_opening) != "Yes": - if entry.type == 'Income': + if entry.type == "Income": d["income"] += flt(entry.credit) - flt(entry.debit) - if entry.type == 'Expense': + if entry.type == "Expense": d["expense"] += flt(entry.debit) - flt(entry.credit) d["gross_profit_loss"] = d.get("income") - d.get("expense") @@ -101,16 +113,18 @@ def calculate_values(accounts, gl_entries_by_account, filters): return total_row + def accumulate_values_into_parents(accounts, accounts_by_name): for d in reversed(accounts): if d.parent_account: for key in value_fields: accounts_by_name[d.parent_account][key] += d[key] + def prepare_data(accounts, filters, total_row, parent_children_map, based_on): data = [] new_accounts = accounts - company_currency = frappe.get_cached_value('Company', filters.get("company"), "default_currency") + company_currency = frappe.get_cached_value("Company", filters.get("company"), "default_currency") for d in accounts: has_value = False @@ -121,21 +135,24 @@ def prepare_data(accounts, filters, total_row, parent_children_map, based_on): "indent": d.indent, "fiscal_year": filters.get("fiscal_year"), "currency": company_currency, - "based_on": based_on + "based_on": based_on, } - if based_on == 'cost_center': - cost_center_doc = frappe.get_doc("Cost Center",d.name) + if based_on == "cost_center": + cost_center_doc = frappe.get_doc("Cost Center", d.name) if not cost_center_doc.enable_distributed_cost_center: - DCC_allocation = frappe.db.sql("""SELECT parent, sum(percentage_allocation) as percentage_allocation + DCC_allocation = frappe.db.sql( + """SELECT parent, sum(percentage_allocation) as percentage_allocation FROM `tabDistributed Cost Center` WHERE cost_center IN %(cost_center)s AND parent NOT IN %(cost_center)s - GROUP BY parent""",{'cost_center': [d.name]}) + GROUP BY parent""", + {"cost_center": [d.name]}, + ) if DCC_allocation: for account in new_accounts: - if account['name'] == DCC_allocation[0][0]: + if account["name"] == DCC_allocation[0][0]: for value in value_fields: - d[value] += account[value]*(DCC_allocation[0][1]/100) + d[value] += account[value] * (DCC_allocation[0][1] / 100) for key in value_fields: row[key] = flt(d.get(key, 0.0), 3) @@ -147,10 +164,11 @@ def prepare_data(accounts, filters, total_row, parent_children_map, based_on): row["has_value"] = has_value data.append(row) - data.extend([{},total_row]) + data.extend([{}, total_row]) return data + def get_columns(filters): return [ { @@ -158,43 +176,42 @@ def get_columns(filters): "label": _(filters.get("based_on")), "fieldtype": "Link", "options": filters.get("based_on"), - "width": 300 + "width": 300, }, { "fieldname": "currency", "label": _("Currency"), "fieldtype": "Link", "options": "Currency", - "hidden": 1 + "hidden": 1, }, { "fieldname": "income", "label": _("Income"), "fieldtype": "Currency", "options": "currency", - "width": 305 - + "width": 305, }, { "fieldname": "expense", "label": _("Expense"), "fieldtype": "Currency", "options": "currency", - "width": 305 - + "width": 305, }, { "fieldname": "gross_profit_loss", "label": _("Gross Profit / Loss"), "fieldtype": "Currency", "options": "currency", - "width": 307 - - } + "width": 307, + }, ] -def set_gl_entries_by_account(company, from_date, to_date, based_on, gl_entries_by_account, - ignore_closing_entries=False): + +def set_gl_entries_by_account( + company, from_date, to_date, based_on, gl_entries_by_account, ignore_closing_entries=False +): """Returns a dict like { "account": [gl entries], ... }""" additional_conditions = [] @@ -204,19 +221,20 @@ def set_gl_entries_by_account(company, from_date, to_date, based_on, gl_entries_ if from_date: additional_conditions.append("and posting_date >= %(from_date)s") - gl_entries = frappe.db.sql("""select posting_date, {based_on} as based_on, debit, credit, + gl_entries = frappe.db.sql( + """select posting_date, {based_on} as based_on, debit, credit, is_opening, (select root_type from `tabAccount` where name = account) as type from `tabGL Entry` where company=%(company)s {additional_conditions} and posting_date <= %(to_date)s and {based_on} is not null - order by {based_on}, posting_date""".format(additional_conditions="\n".join(additional_conditions), based_on= based_on), - { - "company": company, - "from_date": from_date, - "to_date": to_date - }, - as_dict=True) + and is_cancelled = 0 + order by {based_on}, posting_date""".format( + additional_conditions="\n".join(additional_conditions), based_on=based_on + ), + {"company": company, "from_date": from_date, "to_date": to_date}, + as_dict=True, + ) for entry in gl_entries: gl_entries_by_account.setdefault(entry.based_on, []).append(entry) diff --git a/erpnext/accounts/report/purchase_invoice_trends/purchase_invoice_trends.py b/erpnext/accounts/report/purchase_invoice_trends/purchase_invoice_trends.py index 406f7a50e8b..8af9bb3ac89 100644 --- a/erpnext/accounts/report/purchase_invoice_trends/purchase_invoice_trends.py +++ b/erpnext/accounts/report/purchase_invoice_trends/purchase_invoice_trends.py @@ -6,7 +6,8 @@ from erpnext.controllers.trends import get_columns, get_data def execute(filters=None): - if not filters: filters ={} + if not filters: + filters = {} data = [] conditions = get_columns(filters, "Purchase Invoice") data = get_data(filters, conditions) diff --git a/erpnext/accounts/report/purchase_register/purchase_register.py b/erpnext/accounts/report/purchase_register/purchase_register.py index a9696bd104a..e8a1e795d92 100644 --- a/erpnext/accounts/report/purchase_register/purchase_register.py +++ b/erpnext/accounts/report/purchase_register/purchase_register.py @@ -15,12 +15,15 @@ from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import ( def execute(filters=None): return _execute(filters) + def _execute(filters=None, additional_table_columns=None, additional_query_columns=None): - if not filters: filters = {} + if not filters: + filters = {} invoice_list = get_invoices(filters, additional_query_columns) - columns, expense_accounts, tax_accounts, unrealized_profit_loss_accounts \ - = get_columns(invoice_list, additional_table_columns) + columns, expense_accounts, tax_accounts, unrealized_profit_loss_accounts = get_columns( + invoice_list, additional_table_columns + ) if not invoice_list: msgprint(_("No record found")) @@ -28,13 +31,14 @@ def _execute(filters=None, additional_table_columns=None, additional_query_colum invoice_expense_map = get_invoice_expense_map(invoice_list) internal_invoice_map = get_internal_invoice_map(invoice_list) - invoice_expense_map, invoice_tax_map = get_invoice_tax_map(invoice_list, - invoice_expense_map, expense_accounts) + invoice_expense_map, invoice_tax_map = get_invoice_tax_map( + invoice_list, invoice_expense_map, expense_accounts + ) invoice_po_pr_map = get_invoice_po_pr_map(invoice_list) suppliers = list(set(d.supplier for d in invoice_list)) supplier_details = get_supplier_details(suppliers) - company_currency = frappe.get_cached_value('Company', filters.company, "default_currency") + company_currency = frappe.get_cached_value("Company", filters.company, "default_currency") data = [] for inv in invoice_list: @@ -50,10 +54,17 @@ def _execute(filters=None, additional_table_columns=None, additional_query_colum row.append(inv.get(col)) row += [ - supplier_details.get(inv.supplier), # supplier_group - inv.tax_id, inv.credit_to, inv.mode_of_payment, ", ".join(project), - inv.bill_no, inv.bill_date, inv.remarks, - ", ".join(purchase_order), ", ".join(purchase_receipt), company_currency + supplier_details.get(inv.supplier), # supplier_group + inv.tax_id, + inv.credit_to, + inv.mode_of_payment, + ", ".join(project), + inv.bill_no, + inv.bill_date, + inv.remarks, + ", ".join(purchase_order), + ", ".join(purchase_receipt), + company_currency, ] # map expense values @@ -91,85 +102,117 @@ def _execute(filters=None, additional_table_columns=None, additional_query_colum def get_columns(invoice_list, additional_table_columns): """return columns based on filters""" columns = [ - _("Invoice") + ":Link/Purchase Invoice:120", _("Posting Date") + ":Date:80", - _("Supplier Id") + "::120", _("Supplier Name") + "::120"] + _("Invoice") + ":Link/Purchase Invoice:120", + _("Posting Date") + ":Date:80", + _("Supplier Id") + "::120", + _("Supplier Name") + "::120", + ] if additional_table_columns: columns += additional_table_columns columns += [ - _("Supplier Group") + ":Link/Supplier Group:120", _("Tax Id") + "::80", _("Payable Account") + ":Link/Account:120", - _("Mode of Payment") + ":Link/Mode of Payment:80", _("Project") + ":Link/Project:80", - _("Bill No") + "::120", _("Bill Date") + ":Date:80", _("Remarks") + "::150", + _("Supplier Group") + ":Link/Supplier Group:120", + _("Tax Id") + "::80", + _("Payable Account") + ":Link/Account:120", + _("Mode of Payment") + ":Link/Mode of Payment:80", + _("Project") + ":Link/Project:80", + _("Bill No") + "::120", + _("Bill Date") + ":Date:80", + _("Remarks") + "::150", _("Purchase Order") + ":Link/Purchase Order:100", _("Purchase Receipt") + ":Link/Purchase Receipt:100", - { - "fieldname": "currency", - "label": _("Currency"), - "fieldtype": "Data", - "width": 80 - } + {"fieldname": "currency", "label": _("Currency"), "fieldtype": "Data", "width": 80}, ] - expense_accounts = tax_accounts = expense_columns = tax_columns = unrealized_profit_loss_accounts = \ - unrealized_profit_loss_account_columns = [] + + expense_accounts = [] + tax_accounts = [] + unrealized_profit_loss_accounts = [] if invoice_list: - expense_accounts = frappe.db.sql_list("""select distinct expense_account + expense_accounts = frappe.db.sql_list( + """select distinct expense_account from `tabPurchase Invoice Item` where docstatus = 1 and (expense_account is not null and expense_account != '') - and parent in (%s) order by expense_account""" % - ', '.join(['%s']*len(invoice_list)), tuple([inv.name for inv in invoice_list])) + and parent in (%s) order by expense_account""" + % ", ".join(["%s"] * len(invoice_list)), + tuple([inv.name for inv in invoice_list]), + ) - tax_accounts = frappe.db.sql_list("""select distinct account_head + tax_accounts = frappe.db.sql_list( + """select distinct account_head from `tabPurchase Taxes and Charges` where parenttype = 'Purchase Invoice' and docstatus = 1 and (account_head is not null and account_head != '') and category in ('Total', 'Valuation and Total') - and parent in (%s) order by account_head""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list)) + and parent in (%s) order by account_head""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + ) - unrealized_profit_loss_accounts = frappe.db.sql_list("""SELECT distinct unrealized_profit_loss_account + unrealized_profit_loss_accounts = frappe.db.sql_list( + """SELECT distinct unrealized_profit_loss_account from `tabPurchase Invoice` where docstatus = 1 and name in (%s) and ifnull(unrealized_profit_loss_account, '') != '' - order by unrealized_profit_loss_account""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list)) + order by unrealized_profit_loss_account""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + ) expense_columns = [(account + ":Currency/currency:120") for account in expense_accounts] - unrealized_profit_loss_account_columns = [(account + ":Currency/currency:120") for account in unrealized_profit_loss_accounts] + unrealized_profit_loss_account_columns = [ + (account + ":Currency/currency:120") for account in unrealized_profit_loss_accounts + ] + tax_columns = [ + (account + ":Currency/currency:120") + for account in tax_accounts + if account not in expense_accounts + ] - for account in tax_accounts: - if account not in expense_accounts: - tax_columns.append(account + ":Currency/currency:120") - - columns = columns + expense_columns + unrealized_profit_loss_account_columns + \ - [_("Net Total") + ":Currency/currency:120"] + tax_columns + \ - [_("Total Tax") + ":Currency/currency:120", _("Grand Total") + ":Currency/currency:120", - _("Rounded Total") + ":Currency/currency:120", _("Outstanding Amount") + ":Currency/currency:120"] + columns = ( + columns + + expense_columns + + unrealized_profit_loss_account_columns + + [_("Net Total") + ":Currency/currency:120"] + + tax_columns + + [ + _("Total Tax") + ":Currency/currency:120", + _("Grand Total") + ":Currency/currency:120", + _("Rounded Total") + ":Currency/currency:120", + _("Outstanding Amount") + ":Currency/currency:120", + ] + ) return columns, expense_accounts, tax_accounts, unrealized_profit_loss_accounts + def get_conditions(filters): conditions = "" - if filters.get("company"): conditions += " and company=%(company)s" - if filters.get("supplier"): conditions += " and supplier = %(supplier)s" + if filters.get("company"): + conditions += " and company=%(company)s" + if filters.get("supplier"): + conditions += " and supplier = %(supplier)s" - if filters.get("from_date"): conditions += " and posting_date>=%(from_date)s" - if filters.get("to_date"): conditions += " and posting_date<=%(to_date)s" + if filters.get("from_date"): + conditions += " and posting_date>=%(from_date)s" + if filters.get("to_date"): + conditions += " and posting_date<=%(to_date)s" - if filters.get("mode_of_payment"): conditions += " and ifnull(mode_of_payment, '') = %(mode_of_payment)s" + if filters.get("mode_of_payment"): + conditions += " and ifnull(mode_of_payment, '') = %(mode_of_payment)s" if filters.get("cost_center"): - conditions += """ and exists(select name from `tabPurchase Invoice Item` + conditions += """ and exists(select name from `tabPurchase Invoice Item` where parent=`tabPurchase Invoice`.name and ifnull(`tabPurchase Invoice Item`.cost_center, '') = %(cost_center)s)""" if filters.get("warehouse"): - conditions += """ and exists(select name from `tabPurchase Invoice Item` + conditions += """ and exists(select name from `tabPurchase Invoice Item` where parent=`tabPurchase Invoice`.name and ifnull(`tabPurchase Invoice Item`.warehouse, '') = %(warehouse)s)""" if filters.get("item_group"): - conditions += """ and exists(select name from `tabPurchase Invoice Item` + conditions += """ and exists(select name from `tabPurchase Invoice Item` where parent=`tabPurchase Invoice`.name and ifnull(`tabPurchase Invoice Item`.item_group, '') = %(item_group)s)""" @@ -182,38 +225,58 @@ def get_conditions(filters): """ for dimension in accounting_dimensions: if filters.get(dimension.fieldname): - if frappe.get_cached_value('DocType', dimension.document_type, 'is_tree'): - filters[dimension.fieldname] = get_dimension_with_children(dimension.document_type, - filters.get(dimension.fieldname)) + if frappe.get_cached_value("DocType", dimension.document_type, "is_tree"): + filters[dimension.fieldname] = get_dimension_with_children( + dimension.document_type, filters.get(dimension.fieldname) + ) - conditions += common_condition + "and ifnull(`tabPurchase Invoice Item`.{0}, '') in %({0})s)".format(dimension.fieldname) + conditions += ( + common_condition + + "and ifnull(`tabPurchase Invoice Item`.{0}, '') in %({0})s)".format(dimension.fieldname) + ) else: - conditions += common_condition + "and ifnull(`tabPurchase Invoice Item`.{0}, '') in (%({0})s))".format(dimension.fieldname) + conditions += ( + common_condition + + "and ifnull(`tabPurchase Invoice Item`.{0}, '') in %({0})s)".format(dimension.fieldname) + ) return conditions + def get_invoices(filters, additional_query_columns): if additional_query_columns: - additional_query_columns = ', ' + ', '.join(additional_query_columns) + additional_query_columns = ", " + ", ".join(additional_query_columns) conditions = get_conditions(filters) - return frappe.db.sql(""" + return frappe.db.sql( + """ select name, posting_date, credit_to, supplier, supplier_name, tax_id, bill_no, bill_date, remarks, base_net_total, base_grand_total, outstanding_amount, mode_of_payment {0} from `tabPurchase Invoice` where docstatus = 1 %s - order by posting_date desc, name desc""".format(additional_query_columns or '') % conditions, filters, as_dict=1) + order by posting_date desc, name desc""".format( + additional_query_columns or "" + ) + % conditions, + filters, + as_dict=1, + ) def get_invoice_expense_map(invoice_list): - expense_details = frappe.db.sql(""" + expense_details = frappe.db.sql( + """ select parent, expense_account, sum(base_net_amount) as amount from `tabPurchase Invoice Item` where parent in (%s) group by parent, expense_account - """ % ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + """ + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) invoice_expense_map = {} for d in expense_details: @@ -222,11 +285,16 @@ def get_invoice_expense_map(invoice_list): return invoice_expense_map + def get_internal_invoice_map(invoice_list): - unrealized_amount_details = frappe.db.sql("""SELECT name, unrealized_profit_loss_account, + unrealized_amount_details = frappe.db.sql( + """SELECT name, unrealized_profit_loss_account, base_net_total as amount from `tabPurchase Invoice` where name in (%s) - and is_internal_supplier = 1 and company = represents_company""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + and is_internal_supplier = 1 and company = represents_company""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) internal_invoice_map = {} for d in unrealized_amount_details: @@ -235,15 +303,21 @@ def get_internal_invoice_map(invoice_list): return internal_invoice_map + def get_invoice_tax_map(invoice_list, invoice_expense_map, expense_accounts): - tax_details = frappe.db.sql(""" + tax_details = frappe.db.sql( + """ select parent, account_head, case add_deduct_tax when "Add" then sum(base_tax_amount_after_discount_amount) else sum(base_tax_amount_after_discount_amount) * -1 end as tax_amount from `tabPurchase Taxes and Charges` where parent in (%s) and category in ('Total', 'Valuation and Total') and base_tax_amount_after_discount_amount != 0 group by parent, account_head, add_deduct_tax - """ % ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + """ + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) invoice_tax_map = {} for d in tax_details: @@ -258,48 +332,71 @@ def get_invoice_tax_map(invoice_list, invoice_expense_map, expense_accounts): return invoice_expense_map, invoice_tax_map + def get_invoice_po_pr_map(invoice_list): - pi_items = frappe.db.sql(""" + pi_items = frappe.db.sql( + """ select parent, purchase_order, purchase_receipt, po_detail, project from `tabPurchase Invoice Item` where parent in (%s) - """ % ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + """ + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) invoice_po_pr_map = {} for d in pi_items: if d.purchase_order: - invoice_po_pr_map.setdefault(d.parent, frappe._dict()).setdefault( - "purchase_order", []).append(d.purchase_order) + invoice_po_pr_map.setdefault(d.parent, frappe._dict()).setdefault("purchase_order", []).append( + d.purchase_order + ) pr_list = None if d.purchase_receipt: pr_list = [d.purchase_receipt] elif d.po_detail: - pr_list = frappe.db.sql_list("""select distinct parent from `tabPurchase Receipt Item` - where docstatus=1 and purchase_order_item=%s""", d.po_detail) + pr_list = frappe.db.sql_list( + """select distinct parent from `tabPurchase Receipt Item` + where docstatus=1 and purchase_order_item=%s""", + d.po_detail, + ) if pr_list: invoice_po_pr_map.setdefault(d.parent, frappe._dict()).setdefault("purchase_receipt", pr_list) if d.project: - invoice_po_pr_map.setdefault(d.parent, frappe._dict()).setdefault( - "project", []).append(d.project) + invoice_po_pr_map.setdefault(d.parent, frappe._dict()).setdefault("project", []).append( + d.project + ) return invoice_po_pr_map + def get_account_details(invoice_list): account_map = {} accounts = list(set([inv.credit_to for inv in invoice_list])) - for acc in frappe.db.sql("""select name, parent_account from tabAccount - where name in (%s)""" % ", ".join(["%s"]*len(accounts)), tuple(accounts), as_dict=1): - account_map[acc.name] = acc.parent_account + for acc in frappe.db.sql( + """select name, parent_account from tabAccount + where name in (%s)""" + % ", ".join(["%s"] * len(accounts)), + tuple(accounts), + as_dict=1, + ): + account_map[acc.name] = acc.parent_account return account_map + def get_supplier_details(suppliers): supplier_details = {} - for supp in frappe.db.sql("""select name, supplier_group from `tabSupplier` - where name in (%s)""" % ", ".join(["%s"]*len(suppliers)), tuple(suppliers), as_dict=1): - supplier_details.setdefault(supp.name, supp.supplier_group) + for supp in frappe.db.sql( + """select name, supplier_group from `tabSupplier` + where name in (%s)""" + % ", ".join(["%s"] * len(suppliers)), + tuple(suppliers), + as_dict=1, + ): + supplier_details.setdefault(supp.name, supp.supplier_group) return supplier_details diff --git a/erpnext/accounts/report/received_items_to_be_billed/received_items_to_be_billed.py b/erpnext/accounts/report/received_items_to_be_billed/received_items_to_be_billed.py index e88675bb8d6..1dcacb97420 100644 --- a/erpnext/accounts/report/received_items_to_be_billed/received_items_to_be_billed.py +++ b/erpnext/accounts/report/received_items_to_be_billed/received_items_to_be_billed.py @@ -13,6 +13,7 @@ def execute(filters=None): data = get_ordered_to_be_billed_data(args) return columns, data + def get_column(): return [ { @@ -20,90 +21,76 @@ def get_column(): "fieldname": "name", "fieldtype": "Link", "options": "Purchase Receipt", - "width": 160 - }, - { - "label": _("Date"), - "fieldname": "date", - "fieldtype": "Date", - "width": 100 + "width": 160, }, + {"label": _("Date"), "fieldname": "date", "fieldtype": "Date", "width": 100}, { "label": _("Supplier"), "fieldname": "supplier", "fieldtype": "Link", "options": "Supplier", - "width": 120 - }, - { - "label": _("Supplier Name"), - "fieldname": "supplier_name", - "fieldtype": "Data", - "width": 120 + "width": 120, }, + {"label": _("Supplier Name"), "fieldname": "supplier_name", "fieldtype": "Data", "width": 120}, { "label": _("Item Code"), "fieldname": "item_code", "fieldtype": "Link", "options": "Item", - "width": 120 + "width": 120, }, { "label": _("Amount"), "fieldname": "amount", "fieldtype": "Currency", "width": 100, - "options": "Company:company:default_currency" + "options": "Company:company:default_currency", }, { "label": _("Billed Amount"), "fieldname": "billed_amount", "fieldtype": "Currency", "width": 100, - "options": "Company:company:default_currency" + "options": "Company:company:default_currency", }, { "label": _("Returned Amount"), "fieldname": "returned_amount", "fieldtype": "Currency", "width": 120, - "options": "Company:company:default_currency" + "options": "Company:company:default_currency", }, { "label": _("Pending Amount"), "fieldname": "pending_amount", "fieldtype": "Currency", "width": 120, - "options": "Company:company:default_currency" - }, - { - "label": _("Item Name"), - "fieldname": "item_name", - "fieldtype": "Data", - "width": 120 - }, - { - "label": _("Description"), - "fieldname": "description", - "fieldtype": "Data", - "width": 120 + "options": "Company:company:default_currency", }, + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 120}, + {"label": _("Description"), "fieldname": "description", "fieldtype": "Data", "width": 120}, { "label": _("Project"), "fieldname": "project", "fieldtype": "Link", "options": "Project", - "width": 120 + "width": 120, }, { "label": _("Company"), "fieldname": "company", "fieldtype": "Link", "options": "Company", - "width": 120 - } + "width": 120, + }, ] + def get_args(): - return {'doctype': 'Purchase Receipt', 'party': 'supplier', - 'date': 'posting_date', 'order': 'name', 'order_by': 'desc'} + return { + "doctype": "Purchase Receipt", + "party": "supplier", + "date": "posting_date", + "order": "name", + "order_by": "desc", + } diff --git a/erpnext/accounts/report/sales_invoice_trends/sales_invoice_trends.py b/erpnext/accounts/report/sales_invoice_trends/sales_invoice_trends.py index 966b1d4fd01..483debaf8bf 100644 --- a/erpnext/accounts/report/sales_invoice_trends/sales_invoice_trends.py +++ b/erpnext/accounts/report/sales_invoice_trends/sales_invoice_trends.py @@ -6,7 +6,8 @@ from erpnext.controllers.trends import get_columns, get_data def execute(filters=None): - if not filters: filters ={} + if not filters: + filters = {} data = [] conditions = get_columns(filters, "Sales Invoice") data = get_data(filters, conditions) diff --git a/erpnext/accounts/report/sales_payment_summary/sales_payment_summary.py b/erpnext/accounts/report/sales_payment_summary/sales_payment_summary.py index 3b736282cf9..0432ad181fe 100644 --- a/erpnext/accounts/report/sales_payment_summary/sales_payment_summary.py +++ b/erpnext/accounts/report/sales_payment_summary/sales_payment_summary.py @@ -9,7 +9,11 @@ from frappe.utils import cstr def execute(filters=None): columns, data = [], [] columns = get_columns(filters) - data = get_pos_sales_payment_data(filters) if filters.get('is_pos') else get_sales_payment_data(filters, columns) + data = ( + get_pos_sales_payment_data(filters) + if filters.get("is_pos") + else get_sales_payment_data(filters, columns) + ) return columns, data @@ -22,12 +26,12 @@ def get_pos_columns(): _("Taxes") + ":Currency/currency:120", _("Payments") + ":Currency/currency:120", _("Warehouse") + ":Data:200", - _("Cost Center") + ":Data:200" + _("Cost Center") + ":Data:200", ] def get_columns(filters): - if filters.get('is_pos'): + if filters.get("is_pos"): return get_pos_columns() else: return [ @@ -44,15 +48,17 @@ def get_pos_sales_payment_data(filters): sales_invoice_data = get_pos_invoice_data(filters) data = [ [ - row['posting_date'], - row['owner'], - row['mode_of_payment'], - row['net_total'], - row['total_taxes'], - row['paid_amount'], - row['warehouse'], - row['cost_center'] - ] for row in sales_invoice_data] + row["posting_date"], + row["owner"], + row["mode_of_payment"], + row["net_total"], + row["total_taxes"], + row["paid_amount"], + row["warehouse"], + row["cost_center"], + ] + for row in sales_invoice_data + ] return data @@ -71,19 +77,25 @@ def get_sales_payment_data(filters, columns): show_payment_detail = False for inv in sales_invoice_data: - owner_posting_date = inv["owner"]+cstr(inv["posting_date"]) + owner_posting_date = inv["owner"] + cstr(inv["posting_date"]) if show_payment_detail: - row = [inv.posting_date, inv.owner," ",inv.net_total,inv.total_taxes, 0] + row = [inv.posting_date, inv.owner, " ", inv.net_total, inv.total_taxes, 0] data.append(row) - for mop_detail in mode_of_payment_details.get(owner_posting_date,[]): - row = [inv.posting_date, inv.owner,mop_detail[0],0,0,mop_detail[1],0] + for mop_detail in mode_of_payment_details.get(owner_posting_date, []): + row = [inv.posting_date, inv.owner, mop_detail[0], 0, 0, mop_detail[1], 0] data.append(row) else: total_payment = 0 - for mop_detail in mode_of_payment_details.get(owner_posting_date,[]): + for mop_detail in mode_of_payment_details.get(owner_posting_date, []): total_payment = total_payment + mop_detail[1] - row = [inv.posting_date, inv.owner,", ".join(mode_of_payments.get(owner_posting_date, [])), - inv.net_total,inv.total_taxes,total_payment] + row = [ + inv.posting_date, + inv.owner, + ", ".join(mode_of_payments.get(owner_posting_date, [])), + inv.net_total, + inv.total_taxes, + total_payment, + ] data.append(row) return data @@ -107,40 +119,44 @@ def get_conditions(filters): def get_pos_invoice_data(filters): conditions = get_conditions(filters) - result = frappe.db.sql('' - 'SELECT ' - 'posting_date, owner, sum(net_total) as "net_total", sum(total_taxes) as "total_taxes", ' - 'sum(paid_amount) as "paid_amount", sum(outstanding_amount) as "outstanding_amount", ' - 'mode_of_payment, warehouse, cost_center ' - 'FROM (' - 'SELECT ' - 'parent, item_code, sum(amount) as "base_total", warehouse, cost_center ' - 'from `tabSales Invoice Item` group by parent' - ') t1 ' - 'left join ' - '(select parent, mode_of_payment from `tabSales Invoice Payment` group by parent) t3 ' - 'on (t3.parent = t1.parent) ' - 'JOIN (' - 'SELECT ' - 'docstatus, company, is_pos, name, posting_date, owner, sum(base_total) as "base_total", ' - 'sum(net_total) as "net_total", sum(total_taxes_and_charges) as "total_taxes", ' - 'sum(base_paid_amount) as "paid_amount", sum(outstanding_amount) as "outstanding_amount" ' - 'FROM `tabSales Invoice` ' - 'GROUP BY name' - ') a ' - 'ON (' - 't1.parent = a.name and t1.base_total = a.base_total) ' - 'WHERE a.docstatus = 1' - ' AND {conditions} ' - 'GROUP BY ' - 'owner, posting_date, warehouse'.format(conditions=conditions), filters, as_dict=1 - ) + result = frappe.db.sql( + "" + "SELECT " + 'posting_date, owner, sum(net_total) as "net_total", sum(total_taxes) as "total_taxes", ' + 'sum(paid_amount) as "paid_amount", sum(outstanding_amount) as "outstanding_amount", ' + "mode_of_payment, warehouse, cost_center " + "FROM (" + "SELECT " + 'parent, item_code, sum(amount) as "base_total", warehouse, cost_center ' + "from `tabSales Invoice Item` group by parent" + ") t1 " + "left join " + "(select parent, mode_of_payment from `tabSales Invoice Payment` group by parent) t3 " + "on (t3.parent = t1.parent) " + "JOIN (" + "SELECT " + 'docstatus, company, is_pos, name, posting_date, owner, sum(base_total) as "base_total", ' + 'sum(net_total) as "net_total", sum(total_taxes_and_charges) as "total_taxes", ' + 'sum(base_paid_amount) as "paid_amount", sum(outstanding_amount) as "outstanding_amount" ' + "FROM `tabSales Invoice` " + "GROUP BY name" + ") a " + "ON (" + "t1.parent = a.name and t1.base_total = a.base_total) " + "WHERE a.docstatus = 1" + " AND {conditions} " + "GROUP BY " + "owner, posting_date, warehouse".format(conditions=conditions), + filters, + as_dict=1, + ) return result def get_sales_invoice_data(filters): conditions = get_conditions(filters) - return frappe.db.sql(""" + return frappe.db.sql( + """ select a.posting_date, a.owner, sum(a.net_total) as "net_total", @@ -152,15 +168,21 @@ def get_sales_invoice_data(filters): and {conditions} group by a.owner, a.posting_date - """.format(conditions=conditions), filters, as_dict=1) + """.format( + conditions=conditions + ), + filters, + as_dict=1, + ) def get_mode_of_payments(filters): mode_of_payments = {} invoice_list = get_invoices(filters) - invoice_list_names = ",".join('"' + invoice['name'] + '"' for invoice in invoice_list) + invoice_list_names = ",".join('"' + invoice["name"] + '"' for invoice in invoice_list) if invoice_list: - inv_mop = frappe.db.sql("""select a.owner,a.posting_date, ifnull(b.mode_of_payment, '') as mode_of_payment + inv_mop = frappe.db.sql( + """select a.owner,a.posting_date, ifnull(b.mode_of_payment, '') as mode_of_payment from `tabSales Invoice` a, `tabSales Invoice Payment` b where a.name = b.parent and a.docstatus = 1 @@ -180,26 +202,36 @@ def get_mode_of_payments(filters): and a.docstatus = 1 and b.reference_type = "Sales Invoice" and b.reference_name in ({invoice_list_names}) - """.format(invoice_list_names=invoice_list_names), as_dict=1) + """.format( + invoice_list_names=invoice_list_names + ), + as_dict=1, + ) for d in inv_mop: - mode_of_payments.setdefault(d["owner"]+cstr(d["posting_date"]), []).append(d.mode_of_payment) + mode_of_payments.setdefault(d["owner"] + cstr(d["posting_date"]), []).append(d.mode_of_payment) return mode_of_payments def get_invoices(filters): conditions = get_conditions(filters) - return frappe.db.sql("""select a.name + return frappe.db.sql( + """select a.name from `tabSales Invoice` a - where a.docstatus = 1 and {conditions}""".format(conditions=conditions), - filters, as_dict=1) + where a.docstatus = 1 and {conditions}""".format( + conditions=conditions + ), + filters, + as_dict=1, + ) def get_mode_of_payment_details(filters): mode_of_payment_details = {} invoice_list = get_invoices(filters) - invoice_list_names = ",".join('"' + invoice['name'] + '"' for invoice in invoice_list) + invoice_list_names = ",".join('"' + invoice["name"] + '"' for invoice in invoice_list) if invoice_list: - inv_mop_detail = frappe.db.sql("""select a.owner, a.posting_date, + inv_mop_detail = frappe.db.sql( + """select a.owner, a.posting_date, ifnull(b.mode_of_payment, '') as mode_of_payment, sum(b.base_amount) as paid_amount from `tabSales Invoice` a, `tabSales Invoice Payment` b where a.name = b.parent @@ -224,24 +256,39 @@ def get_mode_of_payment_details(filters): and b.reference_type = "Sales Invoice" and b.reference_name in ({invoice_list_names}) group by a.owner, a.posting_date, mode_of_payment - """.format(invoice_list_names=invoice_list_names), as_dict=1) + """.format( + invoice_list_names=invoice_list_names + ), + as_dict=1, + ) - inv_change_amount = frappe.db.sql("""select a.owner, a.posting_date, + inv_change_amount = frappe.db.sql( + """select a.owner, a.posting_date, ifnull(b.mode_of_payment, '') as mode_of_payment, sum(a.base_change_amount) as change_amount from `tabSales Invoice` a, `tabSales Invoice Payment` b where a.name = b.parent and a.name in ({invoice_list_names}) and b.mode_of_payment = 'Cash' and a.base_change_amount > 0 - group by a.owner, a.posting_date, mode_of_payment""".format(invoice_list_names=invoice_list_names), as_dict=1) + group by a.owner, a.posting_date, mode_of_payment""".format( + invoice_list_names=invoice_list_names + ), + as_dict=1, + ) for d in inv_change_amount: for det in inv_mop_detail: - if det["owner"] == d["owner"] and det["posting_date"] == d["posting_date"] and det["mode_of_payment"] == d["mode_of_payment"]: + if ( + det["owner"] == d["owner"] + and det["posting_date"] == d["posting_date"] + and det["mode_of_payment"] == d["mode_of_payment"] + ): paid_amount = det["paid_amount"] - d["change_amount"] det["paid_amount"] = paid_amount for d in inv_mop_detail: - mode_of_payment_details.setdefault(d["owner"]+cstr(d["posting_date"]), []).append((d.mode_of_payment,d.paid_amount)) + mode_of_payment_details.setdefault(d["owner"] + cstr(d["posting_date"]), []).append( + (d.mode_of_payment, d.paid_amount) + ) return mode_of_payment_details diff --git a/erpnext/accounts/report/sales_payment_summary/test_sales_payment_summary.py b/erpnext/accounts/report/sales_payment_summary/test_sales_payment_summary.py index b3f6c72a3ef..3ad0ff2ce26 100644 --- a/erpnext/accounts/report/sales_payment_summary/test_sales_payment_summary.py +++ b/erpnext/accounts/report/sales_payment_summary/test_sales_payment_summary.py @@ -15,6 +15,7 @@ from erpnext.accounts.report.sales_payment_summary.sales_payment_summary import test_dependencies = ["Sales Invoice"] + class TestSalesPaymentSummary(unittest.TestCase): @classmethod def setUpClass(self): @@ -37,7 +38,7 @@ class TestSalesPaymentSummary(unittest.TestCase): si.insert() si.submit() - if int(si.name[-3:])%2 == 0: + if int(si.name[-3:]) % 2 == 0: bank_account = "_Test Cash - _TC" mode_of_payment = "Cash" else: @@ -52,18 +53,22 @@ class TestSalesPaymentSummary(unittest.TestCase): pe.submit() mop = get_mode_of_payments(filters) - self.assertTrue('Credit Card' in list(mop.values())[0]) - self.assertTrue('Cash' in list(mop.values())[0]) + self.assertTrue("Credit Card" in list(mop.values())[0]) + self.assertTrue("Cash" in list(mop.values())[0]) # Cancel all Cash payment entry and check if this mode of payment is still fetched. - payment_entries = frappe.get_all("Payment Entry", filters={"mode_of_payment": "Cash", "docstatus": 1}, fields=["name", "docstatus"]) + payment_entries = frappe.get_all( + "Payment Entry", + filters={"mode_of_payment": "Cash", "docstatus": 1}, + fields=["name", "docstatus"], + ) for payment_entry in payment_entries: pe = frappe.get_doc("Payment Entry", payment_entry.name) pe.cancel() mop = get_mode_of_payments(filters) - self.assertTrue('Credit Card' in list(mop.values())[0]) - self.assertTrue('Cash' not in list(mop.values())[0]) + self.assertTrue("Credit Card" in list(mop.values())[0]) + self.assertTrue("Cash" not in list(mop.values())[0]) def test_get_mode_of_payments_details(self): filters = get_filters() @@ -73,7 +78,7 @@ class TestSalesPaymentSummary(unittest.TestCase): si.insert() si.submit() - if int(si.name[-3:])%2 == 0: + if int(si.name[-3:]) % 2 == 0: bank_account = "_Test Cash - _TC" mode_of_payment = "Cash" else: @@ -95,7 +100,11 @@ class TestSalesPaymentSummary(unittest.TestCase): cc_init_amount = mopd_value[1] # Cancel one Credit Card Payment Entry and check that it is not fetched in mode of payment details. - payment_entries = frappe.get_all("Payment Entry", filters={"mode_of_payment": "Credit Card", "docstatus": 1}, fields=["name", "docstatus"]) + payment_entries = frappe.get_all( + "Payment Entry", + filters={"mode_of_payment": "Credit Card", "docstatus": 1}, + fields=["name", "docstatus"], + ) for payment_entry in payment_entries[:1]: pe = frappe.get_doc("Payment Entry", payment_entry.name) pe.cancel() @@ -108,63 +117,72 @@ class TestSalesPaymentSummary(unittest.TestCase): self.assertTrue(cc_init_amount > cc_final_amount) + def get_filters(): - return { - "from_date": "1900-01-01", - "to_date": today(), - "company": "_Test Company" - } + return {"from_date": "1900-01-01", "to_date": today(), "company": "_Test Company"} + def create_sales_invoice_record(qty=1): # return sales invoice doc object - return frappe.get_doc({ - "doctype": "Sales Invoice", - "customer": frappe.get_doc('Customer', {"customer_name": "Prestiga-Biz"}).name, - "company": '_Test Company', - "due_date": today(), - "posting_date": today(), - "currency": "INR", - "taxes_and_charges": "", - "debit_to": "Debtors - _TC", - "taxes": [], - "items": [{ - 'doctype': 'Sales Invoice Item', - 'item_code': frappe.get_doc('Item', {'item_name': 'Consulting'}).name, - 'qty': qty, - "rate": 10000, - 'income_account': 'Sales - _TC', - 'cost_center': 'Main - _TC', - 'expense_account': 'Cost of Goods Sold - _TC' - }] - }) + return frappe.get_doc( + { + "doctype": "Sales Invoice", + "customer": frappe.get_doc("Customer", {"customer_name": "Prestiga-Biz"}).name, + "company": "_Test Company", + "due_date": today(), + "posting_date": today(), + "currency": "INR", + "taxes_and_charges": "", + "debit_to": "Debtors - _TC", + "taxes": [], + "items": [ + { + "doctype": "Sales Invoice Item", + "item_code": frappe.get_doc("Item", {"item_name": "Consulting"}).name, + "qty": qty, + "rate": 10000, + "income_account": "Sales - _TC", + "cost_center": "Main - _TC", + "expense_account": "Cost of Goods Sold - _TC", + } + ], + } + ) + def create_records(): if frappe.db.exists("Customer", "Prestiga-Biz"): return - #customer - frappe.get_doc({ - "customer_group": "_Test Customer Group", - "customer_name": "Prestiga-Biz", - "customer_type": "Company", - "doctype": "Customer", - "territory": "_Test Territory" - }).insert() + # customer + frappe.get_doc( + { + "customer_group": "_Test Customer Group", + "customer_name": "Prestiga-Biz", + "customer_type": "Company", + "doctype": "Customer", + "territory": "_Test Territory", + } + ).insert() # item - item = frappe.get_doc({ - "doctype": "Item", - "item_code": "Consulting", - "item_name": "Consulting", - "item_group": "All Item Groups", - "company": "_Test Company", - "is_stock_item": 0 - }).insert() + item = frappe.get_doc( + { + "doctype": "Item", + "item_code": "Consulting", + "item_name": "Consulting", + "item_group": "All Item Groups", + "company": "_Test Company", + "is_stock_item": 0, + } + ).insert() # item price - frappe.get_doc({ - "doctype": "Item Price", - "price_list": "Standard Selling", - "item_code": item.item_code, - "price_list_rate": 10000 - }).insert() + frappe.get_doc( + { + "doctype": "Item Price", + "price_list": "Standard Selling", + "item_code": item.item_code, + "price_list_rate": 10000, + } + ).insert() diff --git a/erpnext/accounts/report/sales_register/sales_register.py b/erpnext/accounts/report/sales_register/sales_register.py index a9d0081bacc..33bd3c74965 100644 --- a/erpnext/accounts/report/sales_register/sales_register.py +++ b/erpnext/accounts/report/sales_register/sales_register.py @@ -16,11 +16,15 @@ from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import ( def execute(filters=None): return _execute(filters) + def _execute(filters, additional_table_columns=None, additional_query_columns=None): - if not filters: filters = frappe._dict({}) + if not filters: + filters = frappe._dict({}) invoice_list = get_invoices(filters, additional_query_columns) - columns, income_accounts, tax_accounts, unrealized_profit_loss_accounts = get_columns(invoice_list, additional_table_columns) + columns, income_accounts, tax_accounts, unrealized_profit_loss_accounts = get_columns( + invoice_list, additional_table_columns + ) if not invoice_list: msgprint(_("No record found")) @@ -28,12 +32,13 @@ def _execute(filters, additional_table_columns=None, additional_query_columns=No invoice_income_map = get_invoice_income_map(invoice_list) internal_invoice_map = get_internal_invoice_map(invoice_list) - invoice_income_map, invoice_tax_map = get_invoice_tax_map(invoice_list, - invoice_income_map, income_accounts) - #Cost Center & Warehouse Map + invoice_income_map, invoice_tax_map = get_invoice_tax_map( + invoice_list, invoice_income_map, income_accounts + ) + # Cost Center & Warehouse Map invoice_cc_wh_map = get_invoice_cc_wh_map(invoice_list) invoice_so_dn_map = get_invoice_so_dn_map(invoice_list) - company_currency = frappe.get_cached_value('Company', filters.get("company"), "default_currency") + company_currency = frappe.get_cached_value("Company", filters.get("company"), "default_currency") mode_of_payments = get_mode_of_payments([inv.name for inv in invoice_list]) data = [] @@ -45,33 +50,33 @@ def _execute(filters, additional_table_columns=None, additional_query_columns=No warehouse = list(set(invoice_cc_wh_map.get(inv.name, {}).get("warehouse", []))) row = { - 'invoice': inv.name, - 'posting_date': inv.posting_date, - 'customer': inv.customer, - 'customer_name': inv.customer_name + "invoice": inv.name, + "posting_date": inv.posting_date, + "customer": inv.customer, + "customer_name": inv.customer_name, } if additional_query_columns: for col in additional_query_columns: - row.update({ - col: inv.get(col) - }) + row.update({col: inv.get(col)}) - row.update({ - 'customer_group': inv.get("customer_group"), - 'territory': inv.get("territory"), - 'tax_id': inv.get("tax_id"), - 'receivable_account': inv.debit_to, - 'mode_of_payment': ", ".join(mode_of_payments.get(inv.name, [])), - 'project': inv.project, - 'owner': inv.owner, - 'remarks': inv.remarks, - 'sales_order': ", ".join(sales_order), - 'delivery_note': ", ".join(delivery_note), - 'cost_center': ", ".join(cost_center), - 'warehouse': ", ".join(warehouse), - 'currency': company_currency - }) + row.update( + { + "customer_group": inv.get("customer_group"), + "territory": inv.get("territory"), + "tax_id": inv.get("tax_id"), + "receivable_account": inv.debit_to, + "mode_of_payment": ", ".join(mode_of_payments.get(inv.name, [])), + "project": inv.project, + "owner": inv.owner, + "remarks": inv.remarks, + "sales_order": ", ".join(sales_order), + "delivery_note": ", ".join(delivery_note), + "cost_center": ", ".join(cost_center), + "warehouse": ", ".join(warehouse), + "currency": company_currency, + } + ) # map income values base_net_total = 0 @@ -82,164 +87,138 @@ def _execute(filters, additional_table_columns=None, additional_query_columns=No income_amount = flt(invoice_income_map.get(inv.name, {}).get(income_acc)) base_net_total += income_amount - row.update({ - frappe.scrub(income_acc): income_amount - }) + row.update({frappe.scrub(income_acc): income_amount}) # Add amount in unrealized account for account in unrealized_profit_loss_accounts: - row.update({ - frappe.scrub(account+"_unrealized"): flt(internal_invoice_map.get((inv.name, account))) - }) + row.update( + {frappe.scrub(account + "_unrealized"): flt(internal_invoice_map.get((inv.name, account)))} + ) # net total - row.update({'net_total': base_net_total or inv.base_net_total}) + row.update({"net_total": base_net_total or inv.base_net_total}) # tax account total_tax = 0 for tax_acc in tax_accounts: if tax_acc not in income_accounts: - tax_amount_precision = get_field_precision(frappe.get_meta("Sales Taxes and Charges").get_field("tax_amount"), currency=company_currency) or 2 + tax_amount_precision = ( + get_field_precision( + frappe.get_meta("Sales Taxes and Charges").get_field("tax_amount"), currency=company_currency + ) + or 2 + ) tax_amount = flt(invoice_tax_map.get(inv.name, {}).get(tax_acc), tax_amount_precision) total_tax += tax_amount - row.update({ - frappe.scrub(tax_acc): tax_amount - }) + row.update({frappe.scrub(tax_acc): tax_amount}) # total tax, grand total, outstanding amount & rounded total - row.update({ - 'tax_total': total_tax, - 'grand_total': inv.base_grand_total, - 'rounded_total': inv.base_rounded_total, - 'outstanding_amount': inv.outstanding_amount - }) + row.update( + { + "tax_total": total_tax, + "grand_total": inv.base_grand_total, + "rounded_total": inv.base_rounded_total, + "outstanding_amount": inv.outstanding_amount, + } + ) data.append(row) return columns, data + def get_columns(invoice_list, additional_table_columns): """return columns based on filters""" columns = [ { - 'label': _("Invoice"), - 'fieldname': 'invoice', - 'fieldtype': 'Link', - 'options': 'Sales Invoice', - 'width': 120 + "label": _("Invoice"), + "fieldname": "invoice", + "fieldtype": "Link", + "options": "Sales Invoice", + "width": 120, }, + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 80}, { - 'label': _("Posting Date"), - 'fieldname': 'posting_date', - 'fieldtype': 'Date', - 'width': 80 - }, - { - 'label': _("Customer"), - 'fieldname': 'customer', - 'fieldtype': 'Link', - 'options': 'Customer', - 'width': 120 - }, - { - 'label': _("Customer Name"), - 'fieldname': 'customer_name', - 'fieldtype': 'Data', - 'width': 120 + "label": _("Customer"), + "fieldname": "customer", + "fieldtype": "Link", + "options": "Customer", + "width": 120, }, + {"label": _("Customer Name"), "fieldname": "customer_name", "fieldtype": "Data", "width": 120}, ] if additional_table_columns: columns += additional_table_columns - columns +=[ + columns += [ { - 'label': _("Customer Group"), - 'fieldname': 'customer_group', - 'fieldtype': 'Link', - 'options': 'Customer Group', - 'width': 120 + "label": _("Customer Group"), + "fieldname": "customer_group", + "fieldtype": "Link", + "options": "Customer Group", + "width": 120, }, { - 'label': _("Territory"), - 'fieldname': 'territory', - 'fieldtype': 'Link', - 'options': 'Territory', - 'width': 80 + "label": _("Territory"), + "fieldname": "territory", + "fieldtype": "Link", + "options": "Territory", + "width": 80, + }, + {"label": _("Tax Id"), "fieldname": "tax_id", "fieldtype": "Data", "width": 120}, + { + "label": _("Receivable Account"), + "fieldname": "receivable_account", + "fieldtype": "Link", + "options": "Account", + "width": 80, }, { - 'label': _("Tax Id"), - 'fieldname': 'tax_id', - 'fieldtype': 'Data', - 'width': 120 - }, - { - 'label': _("Receivable Account"), - 'fieldname': 'receivable_account', - 'fieldtype': 'Link', - 'options': 'Account', - 'width': 80 - }, - { - 'label': _("Mode Of Payment"), - 'fieldname': 'mode_of_payment', - 'fieldtype': 'Data', - 'width': 120 - }, - { - 'label': _("Project"), - 'fieldname': 'project', - 'fieldtype': 'Link', - 'options': 'Project', - 'width': 80 - }, - { - 'label': _("Owner"), - 'fieldname': 'owner', - 'fieldtype': 'Data', - 'width': 150 - }, - { - 'label': _("Remarks"), - 'fieldname': 'remarks', - 'fieldtype': 'Data', - 'width': 150 - }, - { - 'label': _("Sales Order"), - 'fieldname': 'sales_order', - 'fieldtype': 'Link', - 'options': 'Sales Order', - 'width': 100 - }, - { - 'label': _("Delivery Note"), - 'fieldname': 'delivery_note', - 'fieldtype': 'Link', - 'options': 'Delivery Note', - 'width': 100 - }, - { - 'label': _("Cost Center"), - 'fieldname': 'cost_center', - 'fieldtype': 'Link', - 'options': 'Cost Center', - 'width': 100 - }, - { - 'label': _("Warehouse"), - 'fieldname': 'warehouse', - 'fieldtype': 'Link', - 'options': 'Warehouse', - 'width': 100 - }, - { - "fieldname": "currency", - "label": _("Currency"), + "label": _("Mode Of Payment"), + "fieldname": "mode_of_payment", "fieldtype": "Data", - "width": 80 - } + "width": 120, + }, + { + "label": _("Project"), + "fieldname": "project", + "fieldtype": "Link", + "options": "Project", + "width": 80, + }, + {"label": _("Owner"), "fieldname": "owner", "fieldtype": "Data", "width": 150}, + {"label": _("Remarks"), "fieldname": "remarks", "fieldtype": "Data", "width": 150}, + { + "label": _("Sales Order"), + "fieldname": "sales_order", + "fieldtype": "Link", + "options": "Sales Order", + "width": 100, + }, + { + "label": _("Delivery Note"), + "fieldname": "delivery_note", + "fieldtype": "Link", + "options": "Delivery Note", + "width": 100, + }, + { + "label": _("Cost Center"), + "fieldname": "cost_center", + "fieldtype": "Link", + "options": "Cost Center", + "width": 100, + }, + { + "label": _("Warehouse"), + "fieldname": "warehouse", + "fieldtype": "Link", + "options": "Warehouse", + "width": 100, + }, + {"fieldname": "currency", "label": _("Currency"), "fieldtype": "Data", "width": 80}, ] income_accounts = [] @@ -250,133 +229,152 @@ def get_columns(invoice_list, additional_table_columns): unrealized_profit_loss_account_columns = [] if invoice_list: - income_accounts = frappe.db.sql_list("""select distinct income_account + income_accounts = frappe.db.sql_list( + """select distinct income_account from `tabSales Invoice Item` where docstatus = 1 and parent in (%s) - order by income_account""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list)) + order by income_account""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + ) - tax_accounts = frappe.db.sql_list("""select distinct account_head + tax_accounts = frappe.db.sql_list( + """select distinct account_head from `tabSales Taxes and Charges` where parenttype = 'Sales Invoice' and docstatus = 1 and base_tax_amount_after_discount_amount != 0 - and parent in (%s) order by account_head""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list)) + and parent in (%s) order by account_head""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + ) - unrealized_profit_loss_accounts = frappe.db.sql_list("""SELECT distinct unrealized_profit_loss_account + unrealized_profit_loss_accounts = frappe.db.sql_list( + """SELECT distinct unrealized_profit_loss_account from `tabSales Invoice` where docstatus = 1 and name in (%s) and is_internal_customer = 1 and ifnull(unrealized_profit_loss_account, '') != '' - order by unrealized_profit_loss_account""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list)) + order by unrealized_profit_loss_account""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + ) for account in income_accounts: - income_columns.append({ - "label": account, - "fieldname": frappe.scrub(account), - "fieldtype": "Currency", - "options": "currency", - "width": 120 - }) - - for account in tax_accounts: - if account not in income_accounts: - tax_columns.append({ + income_columns.append( + { "label": account, "fieldname": frappe.scrub(account), "fieldtype": "Currency", "options": "currency", - "width": 120 - }) + "width": 120, + } + ) + + for account in tax_accounts: + if account not in income_accounts: + tax_columns.append( + { + "label": account, + "fieldname": frappe.scrub(account), + "fieldtype": "Currency", + "options": "currency", + "width": 120, + } + ) for account in unrealized_profit_loss_accounts: - unrealized_profit_loss_account_columns.append({ - "label": account, - "fieldname": frappe.scrub(account+"_unrealized"), + unrealized_profit_loss_account_columns.append( + { + "label": account, + "fieldname": frappe.scrub(account + "_unrealized"), + "fieldtype": "Currency", + "options": "currency", + "width": 120, + } + ) + + net_total_column = [ + { + "label": _("Net Total"), + "fieldname": "net_total", "fieldtype": "Currency", "options": "currency", - "width": 120 - }) - - net_total_column = [{ - "label": _("Net Total"), - "fieldname": "net_total", - "fieldtype": "Currency", - "options": "currency", - "width": 120 - }] + "width": 120, + } + ] total_columns = [ { "label": _("Tax Total"), "fieldname": "tax_total", "fieldtype": "Currency", - "options": 'currency', - "width": 120 + "options": "currency", + "width": 120, }, { "label": _("Grand Total"), "fieldname": "grand_total", "fieldtype": "Currency", - "options": 'currency', - "width": 120 + "options": "currency", + "width": 120, }, { "label": _("Rounded Total"), "fieldname": "rounded_total", "fieldtype": "Currency", - "options": 'currency', - "width": 120 + "options": "currency", + "width": 120, }, { "label": _("Outstanding Amount"), "fieldname": "outstanding_amount", "fieldtype": "Currency", - "options": 'currency', - "width": 120 - } + "options": "currency", + "width": 120, + }, ] - columns = columns + income_columns + unrealized_profit_loss_account_columns + \ - net_total_column + tax_columns + total_columns + columns = ( + columns + + income_columns + + unrealized_profit_loss_account_columns + + net_total_column + + tax_columns + + total_columns + ) return columns, income_accounts, tax_accounts, unrealized_profit_loss_accounts + def get_conditions(filters): conditions = "" - if filters.get("company"): conditions += " and company=%(company)s" - if filters.get("customer"): conditions += " and customer = %(customer)s" + accounting_dimensions = get_accounting_dimensions(as_list=False) or [] + accounting_dimensions_list = [d.fieldname for d in accounting_dimensions] - if filters.get("from_date"): conditions += " and posting_date >= %(from_date)s" - if filters.get("to_date"): conditions += " and posting_date <= %(to_date)s" + if filters.get("company"): + conditions += " and company=%(company)s" - if filters.get("owner"): conditions += " and owner = %(owner)s" + if filters.get("customer") and "customer" not in accounting_dimensions_list: + conditions += " and customer = %(customer)s" - if filters.get("mode_of_payment"): - conditions += """ and exists(select name from `tabSales Invoice Payment` - where parent=`tabSales Invoice`.name - and ifnull(`tabSales Invoice Payment`.mode_of_payment, '') = %(mode_of_payment)s)""" + if filters.get("from_date"): + conditions += " and posting_date >= %(from_date)s" + if filters.get("to_date"): + conditions += " and posting_date <= %(to_date)s" - if filters.get("cost_center"): - conditions += """ and exists(select name from `tabSales Invoice Item` - where parent=`tabSales Invoice`.name - and ifnull(`tabSales Invoice Item`.cost_center, '') = %(cost_center)s)""" + if filters.get("owner"): + conditions += " and owner = %(owner)s" - if filters.get("warehouse"): - conditions += """ and exists(select name from `tabSales Invoice Item` - where parent=`tabSales Invoice`.name - and ifnull(`tabSales Invoice Item`.warehouse, '') = %(warehouse)s)""" + def get_sales_invoice_item_field_condition(field, table="Sales Invoice Item") -> str: + if not filters.get(field) or field in accounting_dimensions_list: + return "" + return f""" and exists(select name from `tab{table}` + where parent=`tabSales Invoice`.name + and ifnull(`tab{table}`.{field}, '') = %({field})s)""" - if filters.get("brand"): - conditions += """ and exists(select name from `tabSales Invoice Item` - where parent=`tabSales Invoice`.name - and ifnull(`tabSales Invoice Item`.brand, '') = %(brand)s)""" - - if filters.get("item_group"): - conditions += """ and exists(select name from `tabSales Invoice Item` - where parent=`tabSales Invoice`.name - and ifnull(`tabSales Invoice Item`.item_group, '') = %(item_group)s)""" - - accounting_dimensions = get_accounting_dimensions(as_list=False) + conditions += get_sales_invoice_item_field_condition("mode_of_payments", "Sales Invoice Payment") + conditions += get_sales_invoice_item_field_condition("cost_center") + conditions += get_sales_invoice_item_field_condition("warehouse") + conditions += get_sales_invoice_item_field_condition("brand") + conditions += get_sales_invoice_item_field_condition("item_group") if accounting_dimensions: common_condition = """ @@ -385,34 +383,53 @@ def get_conditions(filters): """ for dimension in accounting_dimensions: if filters.get(dimension.fieldname): - if frappe.get_cached_value('DocType', dimension.document_type, 'is_tree'): - filters[dimension.fieldname] = get_dimension_with_children(dimension.document_type, - filters.get(dimension.fieldname)) + if frappe.get_cached_value("DocType", dimension.document_type, "is_tree"): + filters[dimension.fieldname] = get_dimension_with_children( + dimension.document_type, filters.get(dimension.fieldname) + ) - conditions += common_condition + "and ifnull(`tabSales Invoice Item`.{0}, '') in %({0})s)".format(dimension.fieldname) + conditions += ( + common_condition + + "and ifnull(`tabSales Invoice Item`.{0}, '') in %({0})s)".format(dimension.fieldname) + ) else: - conditions += common_condition + "and ifnull(`tabSales Invoice Item`.{0}, '') in (%({0})s))".format(dimension.fieldname) + conditions += ( + common_condition + + "and ifnull(`tabSales Invoice Item`.{0}, '') in %({0})s)".format(dimension.fieldname) + ) return conditions + def get_invoices(filters, additional_query_columns): if additional_query_columns: - additional_query_columns = ', ' + ', '.join(additional_query_columns) + additional_query_columns = ", " + ", ".join(additional_query_columns) conditions = get_conditions(filters) - return frappe.db.sql(""" + return frappe.db.sql( + """ select name, posting_date, debit_to, project, customer, customer_name, owner, remarks, territory, tax_id, customer_group, base_net_total, base_grand_total, base_rounded_total, outstanding_amount, is_internal_customer, represents_company, company {0} from `tabSales Invoice` - where docstatus = 1 %s order by posting_date desc, name desc""".format(additional_query_columns or '') % - conditions, filters, as_dict=1) + where docstatus = 1 %s order by posting_date desc, name desc""".format( + additional_query_columns or "" + ) + % conditions, + filters, + as_dict=1, + ) + def get_invoice_income_map(invoice_list): - income_details = frappe.db.sql("""select parent, income_account, sum(base_net_amount) as amount - from `tabSales Invoice Item` where parent in (%s) group by parent, income_account""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + income_details = frappe.db.sql( + """select parent, income_account, sum(base_net_amount) as amount + from `tabSales Invoice Item` where parent in (%s) group by parent, income_account""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) invoice_income_map = {} for d in income_details: @@ -421,11 +438,16 @@ def get_invoice_income_map(invoice_list): return invoice_income_map + def get_internal_invoice_map(invoice_list): - unrealized_amount_details = frappe.db.sql("""SELECT name, unrealized_profit_loss_account, + unrealized_amount_details = frappe.db.sql( + """SELECT name, unrealized_profit_loss_account, base_net_total as amount from `tabSales Invoice` where name in (%s) - and is_internal_customer = 1 and company = represents_company""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + and is_internal_customer = 1 and company = represents_company""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) internal_invoice_map = {} for d in unrealized_amount_details: @@ -434,11 +456,16 @@ def get_internal_invoice_map(invoice_list): return internal_invoice_map + def get_invoice_tax_map(invoice_list, invoice_income_map, income_accounts): - tax_details = frappe.db.sql("""select parent, account_head, + tax_details = frappe.db.sql( + """select parent, account_head, sum(base_tax_amount_after_discount_amount) as tax_amount - from `tabSales Taxes and Charges` where parent in (%s) group by parent, account_head""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + from `tabSales Taxes and Charges` where parent in (%s) group by parent, account_head""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) invoice_tax_map = {} for d in tax_details: @@ -453,54 +480,77 @@ def get_invoice_tax_map(invoice_list, invoice_income_map, income_accounts): return invoice_income_map, invoice_tax_map + def get_invoice_so_dn_map(invoice_list): - si_items = frappe.db.sql("""select parent, sales_order, delivery_note, so_detail + si_items = frappe.db.sql( + """select parent, sales_order, delivery_note, so_detail from `tabSales Invoice Item` where parent in (%s) - and (ifnull(sales_order, '') != '' or ifnull(delivery_note, '') != '')""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + and (ifnull(sales_order, '') != '' or ifnull(delivery_note, '') != '')""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) invoice_so_dn_map = {} for d in si_items: if d.sales_order: - invoice_so_dn_map.setdefault(d.parent, frappe._dict()).setdefault( - "sales_order", []).append(d.sales_order) + invoice_so_dn_map.setdefault(d.parent, frappe._dict()).setdefault("sales_order", []).append( + d.sales_order + ) delivery_note_list = None if d.delivery_note: delivery_note_list = [d.delivery_note] elif d.sales_order: - delivery_note_list = frappe.db.sql_list("""select distinct parent from `tabDelivery Note Item` - where docstatus=1 and so_detail=%s""", d.so_detail) + delivery_note_list = frappe.db.sql_list( + """select distinct parent from `tabDelivery Note Item` + where docstatus=1 and so_detail=%s""", + d.so_detail, + ) if delivery_note_list: - invoice_so_dn_map.setdefault(d.parent, frappe._dict()).setdefault("delivery_note", delivery_note_list) + invoice_so_dn_map.setdefault(d.parent, frappe._dict()).setdefault( + "delivery_note", delivery_note_list + ) return invoice_so_dn_map + def get_invoice_cc_wh_map(invoice_list): - si_items = frappe.db.sql("""select parent, cost_center, warehouse + si_items = frappe.db.sql( + """select parent, cost_center, warehouse from `tabSales Invoice Item` where parent in (%s) - and (ifnull(cost_center, '') != '' or ifnull(warehouse, '') != '')""" % - ', '.join(['%s']*len(invoice_list)), tuple(inv.name for inv in invoice_list), as_dict=1) + and (ifnull(cost_center, '') != '' or ifnull(warehouse, '') != '')""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(inv.name for inv in invoice_list), + as_dict=1, + ) invoice_cc_wh_map = {} for d in si_items: if d.cost_center: - invoice_cc_wh_map.setdefault(d.parent, frappe._dict()).setdefault( - "cost_center", []).append(d.cost_center) + invoice_cc_wh_map.setdefault(d.parent, frappe._dict()).setdefault("cost_center", []).append( + d.cost_center + ) if d.warehouse: - invoice_cc_wh_map.setdefault(d.parent, frappe._dict()).setdefault( - "warehouse", []).append(d.warehouse) + invoice_cc_wh_map.setdefault(d.parent, frappe._dict()).setdefault("warehouse", []).append( + d.warehouse + ) return invoice_cc_wh_map + def get_mode_of_payments(invoice_list): mode_of_payments = {} if invoice_list: - inv_mop = frappe.db.sql("""select parent, mode_of_payment - from `tabSales Invoice Payment` where parent in (%s) group by parent, mode_of_payment""" % - ', '.join(['%s']*len(invoice_list)), tuple(invoice_list), as_dict=1) + inv_mop = frappe.db.sql( + """select parent, mode_of_payment + from `tabSales Invoice Payment` where parent in (%s) group by parent, mode_of_payment""" + % ", ".join(["%s"] * len(invoice_list)), + tuple(invoice_list), + as_dict=1, + ) for d in inv_mop: mode_of_payments.setdefault(d.parent, []).append(d.mode_of_payment) diff --git a/erpnext/accounts/report/share_balance/share_balance.py b/erpnext/accounts/report/share_balance/share_balance.py index 943c4e150f0..d02f53b0d2b 100644 --- a/erpnext/accounts/report/share_balance/share_balance.py +++ b/erpnext/accounts/report/share_balance/share_balance.py @@ -7,7 +7,8 @@ from frappe import _ def execute(filters=None): - if not filters: filters = {} + if not filters: + filters = {} if not filters.get("date"): frappe.throw(_("Please select date")) @@ -38,22 +39,29 @@ def execute(filters=None): break # new entry if not row: - row = [filters.get("shareholder"), - share_entry.share_type, share_entry.no_of_shares, share_entry.rate, share_entry.amount] + row = [ + filters.get("shareholder"), + share_entry.share_type, + share_entry.no_of_shares, + share_entry.rate, + share_entry.amount, + ] data.append(row) return columns, data + def get_columns(filters): columns = [ _("Shareholder") + ":Link/Shareholder:150", _("Share Type") + "::90", _("No of Shares") + "::90", _("Average Rate") + ":Currency:90", - _("Amount") + ":Currency:90" + _("Amount") + ":Currency:90", ] return columns + def get_all_shares(shareholder): - return frappe.get_doc('Shareholder', shareholder).share_balance + return frappe.get_doc("Shareholder", shareholder).share_balance diff --git a/erpnext/accounts/report/share_ledger/share_ledger.py b/erpnext/accounts/report/share_ledger/share_ledger.py index b3ff6e48a6f..d6c3bd059f4 100644 --- a/erpnext/accounts/report/share_ledger/share_ledger.py +++ b/erpnext/accounts/report/share_ledger/share_ledger.py @@ -7,7 +7,8 @@ from frappe import _ def execute(filters=None): - if not filters: filters = {} + if not filters: + filters = {} if not filters.get("date"): frappe.throw(_("Please select date")) @@ -23,19 +24,28 @@ def execute(filters=None): else: transfers = get_all_transfers(date, filters.get("shareholder")) for transfer in transfers: - if transfer.transfer_type == 'Transfer': + if transfer.transfer_type == "Transfer": if transfer.from_shareholder == filters.get("shareholder"): - transfer.transfer_type += ' to {}'.format(transfer.to_shareholder) + transfer.transfer_type += " to {}".format(transfer.to_shareholder) else: - transfer.transfer_type += ' from {}'.format(transfer.from_shareholder) - row = [filters.get("shareholder"), transfer.date, transfer.transfer_type, - transfer.share_type, transfer.no_of_shares, transfer.rate, transfer.amount, - transfer.company, transfer.name] + transfer.transfer_type += " from {}".format(transfer.from_shareholder) + row = [ + filters.get("shareholder"), + transfer.date, + transfer.transfer_type, + transfer.share_type, + transfer.no_of_shares, + transfer.rate, + transfer.amount, + transfer.company, + transfer.name, + ] data.append(row) return columns, data + def get_columns(filters): columns = [ _("Shareholder") + ":Link/Shareholder:150", @@ -46,16 +56,22 @@ def get_columns(filters): _("Rate") + ":Currency:90", _("Amount") + ":Currency:90", _("Company") + "::150", - _("Share Transfer") + ":Link/Share Transfer:90" + _("Share Transfer") + ":Link/Share Transfer:90", ] return columns + def get_all_transfers(date, shareholder): - condition = ' ' + condition = " " # if company: # condition = 'AND company = %(company)s ' - return frappe.db.sql("""SELECT * FROM `tabShare Transfer` + return frappe.db.sql( + """SELECT * FROM `tabShare Transfer` WHERE (DATE(date) <= %(date)s AND from_shareholder = %(shareholder)s {condition}) OR (DATE(date) <= %(date)s AND to_shareholder = %(shareholder)s {condition}) - ORDER BY date""".format(condition=condition), - {'date': date, 'shareholder': shareholder}, as_dict=1) + ORDER BY date""".format( + condition=condition + ), + {"date": date, "shareholder": shareholder}, + as_dict=1, + ) diff --git a/erpnext/accounts/report/tds_computation_summary/tds_computation_summary.py b/erpnext/accounts/report/tds_computation_summary/tds_computation_summary.py index d576c273a27..db3d5d44a0c 100644 --- a/erpnext/accounts/report/tds_computation_summary/tds_computation_summary.py +++ b/erpnext/accounts/report/tds_computation_summary/tds_computation_summary.py @@ -1,4 +1,3 @@ - import frappe from frappe import _ @@ -12,18 +11,19 @@ from erpnext.accounts.utils import get_fiscal_year def execute(filters=None): validate_filters(filters) - filters.naming_series = frappe.db.get_single_value('Buying Settings', 'supp_master_name') + filters.naming_series = frappe.db.get_single_value("Buying Settings", "supp_master_name") columns = get_columns(filters) - tds_docs, tds_accounts, tax_category_map = get_tds_docs(filters) + tds_docs, tds_accounts, tax_category_map, journal_entry_party_map = get_tds_docs(filters) - res = get_result(filters, tds_docs, tds_accounts, tax_category_map) + res = get_result(filters, tds_docs, tds_accounts, tax_category_map, journal_entry_party_map) final_result = group_by_supplier_and_category(res) return columns, final_result + def validate_filters(filters): - ''' Validate if dates are properly set and lie in the same fiscal year''' + """Validate if dates are properly set and lie in the same fiscal year""" if filters.from_date > filters.to_date: frappe.throw(_("From Date must be before To Date")) @@ -34,26 +34,32 @@ def validate_filters(filters): filters["fiscal_year"] = from_year + def group_by_supplier_and_category(data): supplier_category_wise_map = {} for row in data: - supplier_category_wise_map.setdefault((row.get('supplier'), row.get('section_code')), { - 'pan': row.get('pan'), - 'supplier': row.get('supplier'), - 'supplier_name': row.get('supplier_name'), - 'section_code': row.get('section_code'), - 'entity_type': row.get('entity_type'), - 'tds_rate': row.get('tds_rate'), - 'total_amount_credited': 0.0, - 'tds_deducted': 0.0 - }) + supplier_category_wise_map.setdefault( + (row.get("supplier"), row.get("section_code")), + { + "pan": row.get("pan"), + "supplier": row.get("supplier"), + "supplier_name": row.get("supplier_name"), + "section_code": row.get("section_code"), + "entity_type": row.get("entity_type"), + "tds_rate": row.get("tds_rate"), + "total_amount_credited": 0.0, + "tds_deducted": 0.0, + }, + ) - supplier_category_wise_map.get((row.get('supplier'), row.get('section_code')))['total_amount_credited'] += \ - row.get('total_amount_credited', 0.0) + supplier_category_wise_map.get((row.get("supplier"), row.get("section_code")))[ + "total_amount_credited" + ] += row.get("total_amount_credited", 0.0) - supplier_category_wise_map.get((row.get('supplier'), row.get('section_code')))['tds_deducted'] += \ - row.get('tds_deducted', 0.0) + supplier_category_wise_map.get((row.get("supplier"), row.get("section_code")))[ + "tds_deducted" + ] += row.get("tds_deducted", 0.0) final_result = get_final_result(supplier_category_wise_map) @@ -67,62 +73,48 @@ def get_final_result(supplier_category_wise_map): return out + def get_columns(filters): columns = [ - { - "label": _("PAN"), - "fieldname": "pan", - "fieldtype": "Data", - "width": 90 - }, + {"label": _("PAN"), "fieldname": "pan", "fieldtype": "Data", "width": 90}, { "label": _("Supplier"), "options": "Supplier", "fieldname": "supplier", "fieldtype": "Link", - "width": 180 - }] + "width": 180, + }, + ] - if filters.naming_series == 'Naming Series': - columns.append({ - "label": _("Supplier Name"), - "fieldname": "supplier_name", - "fieldtype": "Data", - "width": 180 - }) + if filters.naming_series == "Naming Series": + columns.append( + {"label": _("Supplier Name"), "fieldname": "supplier_name", "fieldtype": "Data", "width": 180} + ) - columns.extend([ - { - "label": _("Section Code"), - "options": "Tax Withholding Category", - "fieldname": "section_code", - "fieldtype": "Link", - "width": 180 - }, - { - "label": _("Entity Type"), - "fieldname": "entity_type", - "fieldtype": "Data", - "width": 180 - }, - { - "label": _("TDS Rate %"), - "fieldname": "tds_rate", - "fieldtype": "Percent", - "width": 90 - }, - { - "label": _("Total Amount Credited"), - "fieldname": "total_amount_credited", - "fieldtype": "Float", - "width": 90 - }, - { - "label": _("Amount of TDS Deducted"), - "fieldname": "tds_deducted", - "fieldtype": "Float", - "width": 90 - } - ]) + columns.extend( + [ + { + "label": _("Section Code"), + "options": "Tax Withholding Category", + "fieldname": "section_code", + "fieldtype": "Link", + "width": 180, + }, + {"label": _("Entity Type"), "fieldname": "entity_type", "fieldtype": "Data", "width": 180}, + {"label": _("TDS Rate %"), "fieldname": "tds_rate", "fieldtype": "Percent", "width": 90}, + { + "label": _("Total Amount Credited"), + "fieldname": "total_amount_credited", + "fieldtype": "Float", + "width": 90, + }, + { + "label": _("Amount of TDS Deducted"), + "fieldname": "tds_deducted", + "fieldtype": "Float", + "width": 90, + }, + ] + ) return columns diff --git a/erpnext/accounts/report/tds_payable_monthly/tds_payable_monthly.py b/erpnext/accounts/report/tds_payable_monthly/tds_payable_monthly.py index caee1a10bbb..f2809a99c55 100644 --- a/erpnext/accounts/report/tds_payable_monthly/tds_payable_monthly.py +++ b/erpnext/accounts/report/tds_payable_monthly/tds_payable_monthly.py @@ -8,22 +8,24 @@ from frappe import _ def execute(filters=None): validate_filters(filters) - tds_docs, tds_accounts, tax_category_map = get_tds_docs(filters) + tds_docs, tds_accounts, tax_category_map, journal_entry_party_map = get_tds_docs(filters) columns = get_columns(filters) - res = get_result(filters, tds_docs, tds_accounts, tax_category_map) + res = get_result(filters, tds_docs, tds_accounts, tax_category_map, journal_entry_party_map) return columns, res + def validate_filters(filters): - ''' Validate if dates are properly set ''' + """Validate if dates are properly set""" if filters.from_date > filters.to_date: frappe.throw(_("From Date must be before To Date")) -def get_result(filters, tds_docs, tds_accounts, tax_category_map): + +def get_result(filters, tds_docs, tds_accounts, tax_category_map, journal_entry_party_map): supplier_map = get_supplier_pan_map() tax_rate_map = get_tax_rate_map(filters) - gle_map = get_gle_map(filters, tds_docs) + gle_map = get_gle_map(tds_docs) out = [] for name, details in gle_map.items(): @@ -36,58 +38,69 @@ def get_result(filters, tds_docs, tds_accounts, tax_category_map): posting_date = entry.posting_date voucher_type = entry.voucher_type + if voucher_type == "Journal Entry": + suppliers = journal_entry_party_map.get(name) + if suppliers: + supplier = suppliers[0] + if not tax_withholding_category: - tax_withholding_category = supplier_map.get(supplier, {}).get('tax_withholding_category') + tax_withholding_category = supplier_map.get(supplier, {}).get("tax_withholding_category") rate = tax_rate_map.get(tax_withholding_category) if entry.account in tds_accounts: - tds_deducted += (entry.credit - entry.debit) + tds_deducted += entry.credit - entry.debit - total_amount_credited += (entry.credit - entry.debit) + total_amount_credited += entry.credit if tds_deducted: row = { - 'pan' if frappe.db.has_column('Supplier', 'pan') else 'tax_id': supplier_map.get(supplier, {}).get('pan'), - 'supplier': supplier_map.get(supplier, {}).get('name') + "pan" + if frappe.db.has_column("Supplier", "pan") + else "tax_id": supplier_map.get(supplier, {}).get("pan"), + "supplier": supplier_map.get(supplier, {}).get("name"), } - if filters.naming_series == 'Naming Series': - row.update({'supplier_name': supplier_map.get(supplier, {}).get('supplier_name')}) + if filters.naming_series == "Naming Series": + row.update({"supplier_name": supplier_map.get(supplier, {}).get("supplier_name")}) - row.update({ - 'section_code': tax_withholding_category, - 'entity_type': supplier_map.get(supplier, {}).get('supplier_type'), - 'tds_rate': rate, - 'total_amount_credited': total_amount_credited, - 'tds_deducted': tds_deducted, - 'transaction_date': posting_date, - 'transaction_type': voucher_type, - 'ref_no': name - }) + row.update( + { + "section_code": tax_withholding_category, + "entity_type": supplier_map.get(supplier, {}).get("supplier_type"), + "tds_rate": rate, + "total_amount_credited": total_amount_credited, + "tds_deducted": tds_deducted, + "transaction_date": posting_date, + "transaction_type": voucher_type, + "ref_no": name, + } + ) out.append(row) return out + def get_supplier_pan_map(): supplier_map = frappe._dict() - suppliers = frappe.db.get_all('Supplier', fields=['name', 'pan', 'supplier_type', 'supplier_name', 'tax_withholding_category']) + suppliers = frappe.db.get_all( + "Supplier", fields=["name", "pan", "supplier_type", "supplier_name", "tax_withholding_category"] + ) for d in suppliers: supplier_map[d.name] = d return supplier_map -def get_gle_map(filters, documents): + +def get_gle_map(documents): # create gle_map of the form # {"purchase_invoice": list of dict of all gle created for this invoice} gle_map = {} - gle = frappe.db.get_all('GL Entry', - { - "voucher_no": ["in", documents], - "credit": (">", 0) - }, + gle = frappe.db.get_all( + "GL Entry", + {"voucher_no": ["in", documents], "is_cancelled": 0}, ["credit", "debit", "account", "voucher_no", "posting_date", "voucher_type", "against", "party"], ) @@ -99,106 +112,100 @@ def get_gle_map(filters, documents): return gle_map + def get_columns(filters): pan = "pan" if frappe.db.has_column("Supplier", "pan") else "tax_id" columns = [ - { - "label": _(frappe.unscrub(pan)), - "fieldname": pan, - "fieldtype": "Data", - "width": 90 - }, + {"label": _(frappe.unscrub(pan)), "fieldname": pan, "fieldtype": "Data", "width": 90}, { "label": _("Supplier"), "options": "Supplier", "fieldname": "supplier", "fieldtype": "Link", - "width": 180 - }] + "width": 180, + }, + ] - if filters.naming_series == 'Naming Series': - columns.append({ - "label": _("Supplier Name"), - "fieldname": "supplier_name", - "fieldtype": "Data", - "width": 180 - }) + if filters.naming_series == "Naming Series": + columns.append( + {"label": _("Supplier Name"), "fieldname": "supplier_name", "fieldtype": "Data", "width": 180} + ) - columns.extend([ - { - "label": _("Section Code"), - "options": "Tax Withholding Category", - "fieldname": "section_code", - "fieldtype": "Link", - "width": 180 - }, - { - "label": _("Entity Type"), - "fieldname": "entity_type", - "fieldtype": "Data", - "width": 180 - }, - { - "label": _("TDS Rate %"), - "fieldname": "tds_rate", - "fieldtype": "Percent", - "width": 90 - }, - { - "label": _("Total Amount Credited"), - "fieldname": "total_amount_credited", - "fieldtype": "Float", - "width": 90 - }, - { - "label": _("Amount of TDS Deducted"), - "fieldname": "tds_deducted", - "fieldtype": "Float", - "width": 90 - }, - { - "label": _("Date of Transaction"), - "fieldname": "transaction_date", - "fieldtype": "Date", - "width": 90 - }, - { - "label": _("Transaction Type"), - "fieldname": "transaction_type", - "width": 90 - }, - { - "label": _("Reference No."), - "fieldname": "ref_no", - "fieldtype": "Dynamic Link", - "options": "transaction_type", - "width": 90 - } - ]) + columns.extend( + [ + { + "label": _("Section Code"), + "options": "Tax Withholding Category", + "fieldname": "section_code", + "fieldtype": "Link", + "width": 180, + }, + {"label": _("Entity Type"), "fieldname": "entity_type", "fieldtype": "Data", "width": 180}, + {"label": _("TDS Rate %"), "fieldname": "tds_rate", "fieldtype": "Percent", "width": 90}, + { + "label": _("Total Amount Credited"), + "fieldname": "total_amount_credited", + "fieldtype": "Float", + "width": 90, + }, + { + "label": _("Amount of TDS Deducted"), + "fieldname": "tds_deducted", + "fieldtype": "Float", + "width": 90, + }, + { + "label": _("Date of Transaction"), + "fieldname": "transaction_date", + "fieldtype": "Date", + "width": 90, + }, + {"label": _("Transaction Type"), "fieldname": "transaction_type", "width": 90}, + { + "label": _("Reference No."), + "fieldname": "ref_no", + "fieldtype": "Dynamic Link", + "options": "transaction_type", + "width": 90, + }, + ] + ) return columns + def get_tds_docs(filters): tds_documents = [] purchase_invoices = [] payment_entries = [] journal_entries = [] tax_category_map = {} + or_filters = {} + journal_entry_party_map = {} + bank_accounts = frappe.get_all("Account", {"is_group": 0, "account_type": "Bank"}, pluck="name") - tds_accounts = frappe.get_all("Tax Withholding Account", {'company': filters.get('company')}, - pluck="account") + tds_accounts = frappe.get_all( + "Tax Withholding Account", {"company": filters.get("company")}, pluck="account" + ) query_filters = { - "credit": ('>', 0), "account": ("in", tds_accounts), "posting_date": ("between", [filters.get("from_date"), filters.get("to_date")]), - "is_cancelled": 0 + "is_cancelled": 0, + "against": ("not in", bank_accounts), } - if filters.get('supplier'): - query_filters.update({'against': filters.get('supplier')}) + if filters.get("supplier"): + del query_filters["account"] + del query_filters["against"] + or_filters = {"against": filters.get("supplier"), "party": filters.get("supplier")} - tds_docs = frappe.get_all("GL Entry", query_filters, ["voucher_no", "voucher_type", "against", "party"]) + tds_docs = frappe.get_all( + "GL Entry", + filters=query_filters, + or_filters=or_filters, + fields=["voucher_no", "voucher_type", "against", "party"], + ) for d in tds_docs: if d.voucher_type == "Purchase Invoice": @@ -211,24 +218,54 @@ def get_tds_docs(filters): tds_documents.append(d.voucher_no) if purchase_invoices: - get_tax_category_map(purchase_invoices, 'Purchase Invoice', tax_category_map) + get_tax_category_map(purchase_invoices, "Purchase Invoice", tax_category_map) if payment_entries: - get_tax_category_map(payment_entries, 'Payment Entry', tax_category_map) + get_tax_category_map(payment_entries, "Payment Entry", tax_category_map) if journal_entries: - get_tax_category_map(journal_entries, 'Journal Entry', tax_category_map) + journal_entry_party_map = get_journal_entry_party_map(journal_entries) + get_tax_category_map(journal_entries, "Journal Entry", tax_category_map) + + return tds_documents, tds_accounts, tax_category_map, journal_entry_party_map + + +def get_journal_entry_party_map(journal_entries): + journal_entry_party_map = {} + for d in frappe.db.get_all( + "Journal Entry Account", + {"parent": ("in", journal_entries), "party_type": "Supplier", "party": ("is", "set")}, + ["parent", "party"], + ): + if d.parent not in journal_entry_party_map: + journal_entry_party_map[d.parent] = [] + journal_entry_party_map[d.parent].append(d.party) + + return journal_entry_party_map - return tds_documents, tds_accounts, tax_category_map def get_tax_category_map(vouchers, doctype, tax_category_map): - tax_category_map.update(frappe._dict(frappe.get_all(doctype, - filters = {'name': ('in', vouchers)}, fields=['name', 'tax_withholding_category'], as_list=1))) + tax_category_map.update( + frappe._dict( + frappe.get_all( + doctype, + filters={"name": ("in", vouchers)}, + fields=["name", "tax_withholding_category"], + as_list=1, + ) + ) + ) + def get_tax_rate_map(filters): - rate_map = frappe.get_all('Tax Withholding Rate', filters={ - 'from_date': ('<=', filters.get('from_date')), - 'to_date': ('>=', filters.get('to_date')) - }, fields=['parent', 'tax_withholding_rate'], as_list=1) + rate_map = frappe.get_all( + "Tax Withholding Rate", + filters={ + "from_date": ("<=", filters.get("from_date")), + "to_date": (">=", filters.get("to_date")), + }, + fields=["parent", "tax_withholding_rate"], + as_list=1, + ) - return frappe._dict(rate_map) \ No newline at end of file + return frappe._dict(rate_map) diff --git a/erpnext/accounts/report/trial_balance/trial_balance.py b/erpnext/accounts/report/trial_balance/trial_balance.py index bda44f66aa1..6d2cd8ed411 100644 --- a/erpnext/accounts/report/trial_balance/trial_balance.py +++ b/erpnext/accounts/report/trial_balance/trial_balance.py @@ -17,7 +17,15 @@ from erpnext.accounts.report.financial_statements import ( set_gl_entries_by_account, ) -value_fields = ("opening_debit", "opening_credit", "debit", "credit", "closing_debit", "closing_credit") +value_fields = ( + "opening_debit", + "opening_credit", + "debit", + "credit", + "closing_debit", + "closing_credit", +) + def execute(filters=None): validate_filters(filters) @@ -25,11 +33,14 @@ def execute(filters=None): columns = get_columns() return columns, data + def validate_filters(filters): if not filters.fiscal_year: frappe.throw(_("Fiscal Year {0} is required").format(filters.fiscal_year)) - fiscal_year = frappe.db.get_value("Fiscal Year", filters.fiscal_year, ["year_start_date", "year_end_date"], as_dict=True) + fiscal_year = frappe.db.get_value( + "Fiscal Year", filters.fiscal_year, ["year_start_date", "year_end_date"], as_dict=True + ) if not fiscal_year: frappe.throw(_("Fiscal Year {0} does not exist").format(filters.fiscal_year)) else: @@ -49,21 +60,32 @@ def validate_filters(filters): frappe.throw(_("From Date cannot be greater than To Date")) if (filters.from_date < filters.year_start_date) or (filters.from_date > filters.year_end_date): - frappe.msgprint(_("From Date should be within the Fiscal Year. Assuming From Date = {0}")\ - .format(formatdate(filters.year_start_date))) + frappe.msgprint( + _("From Date should be within the Fiscal Year. Assuming From Date = {0}").format( + formatdate(filters.year_start_date) + ) + ) filters.from_date = filters.year_start_date if (filters.to_date < filters.year_start_date) or (filters.to_date > filters.year_end_date): - frappe.msgprint(_("To Date should be within the Fiscal Year. Assuming To Date = {0}")\ - .format(formatdate(filters.year_end_date))) + frappe.msgprint( + _("To Date should be within the Fiscal Year. Assuming To Date = {0}").format( + formatdate(filters.year_end_date) + ) + ) filters.to_date = filters.year_end_date + def get_data(filters): - accounts = frappe.db.sql("""select name, account_number, parent_account, account_name, root_type, report_type, lft, rgt + accounts = frappe.db.sql( + """select name, account_number, parent_account, account_name, root_type, report_type, lft, rgt - from `tabAccount` where company=%s order by lft""", filters.company, as_dict=True) + from `tabAccount` where company=%s order by lft""", + filters.company, + as_dict=True, + ) company_currency = filters.presentation_currency or erpnext.get_company_currency(filters.company) if not accounts: @@ -71,28 +93,44 @@ def get_data(filters): accounts, accounts_by_name, parent_children_map = filter_accounts(accounts) - min_lft, max_rgt = frappe.db.sql("""select min(lft), max(rgt) from `tabAccount` - where company=%s""", (filters.company,))[0] + min_lft, max_rgt = frappe.db.sql( + """select min(lft), max(rgt) from `tabAccount` + where company=%s""", + (filters.company,), + )[0] gl_entries_by_account = {} opening_balances = get_opening_balances(filters) - #add filter inside list so that the query in financial_statements.py doesn't break + # add filter inside list so that the query in financial_statements.py doesn't break if filters.project: filters.project = [filters.project] - set_gl_entries_by_account(filters.company, filters.from_date, - filters.to_date, min_lft, max_rgt, filters, gl_entries_by_account, ignore_closing_entries=not flt(filters.with_period_closing_entry)) + set_gl_entries_by_account( + filters.company, + filters.from_date, + filters.to_date, + min_lft, + max_rgt, + filters, + gl_entries_by_account, + ignore_closing_entries=not flt(filters.with_period_closing_entry), + ) - total_row = calculate_values(accounts, gl_entries_by_account, opening_balances, filters, company_currency) + total_row = calculate_values( + accounts, gl_entries_by_account, opening_balances, filters, company_currency + ) accumulate_values_into_parents(accounts, accounts_by_name) data = prepare_data(accounts, filters, total_row, parent_children_map, company_currency) - data = filter_out_zero_value_rows(data, parent_children_map, show_zero_values=filters.get("show_zero_values")) + data = filter_out_zero_value_rows( + data, parent_children_map, show_zero_values=filters.get("show_zero_values") + ) return data + def get_opening_balances(filters): balance_sheet_opening = get_rootwise_opening_balances(filters, "Balance Sheet") pl_opening = get_rootwise_opening_balances(filters, "Profit and Loss") @@ -104,64 +142,74 @@ def get_opening_balances(filters): def get_rootwise_opening_balances(filters, report_type): additional_conditions = "" if not filters.show_unclosed_fy_pl_balances: - additional_conditions = " and posting_date >= %(year_start_date)s" \ - if report_type == "Profit and Loss" else "" + additional_conditions = ( + " and posting_date >= %(year_start_date)s" if report_type == "Profit and Loss" else "" + ) if not flt(filters.with_period_closing_entry): additional_conditions += " and ifnull(voucher_type, '')!='Period Closing Voucher'" if filters.cost_center: - lft, rgt = frappe.db.get_value('Cost Center', filters.cost_center, ['lft', 'rgt']) + lft, rgt = frappe.db.get_value("Cost Center", filters.cost_center, ["lft", "rgt"]) additional_conditions += """ and cost_center in (select name from `tabCost Center` - where lft >= %s and rgt <= %s)""" % (lft, rgt) + where lft >= %s and rgt <= %s)""" % ( + lft, + rgt, + ) if filters.project: additional_conditions += " and project = %(project)s" - if filters.finance_book: - fb_conditions = " AND finance_book = %(finance_book)s" - if filters.include_default_book_entries: - fb_conditions = " AND (finance_book in (%(finance_book)s, %(company_fb)s, '') OR finance_book IS NULL)" - - additional_conditions += fb_conditions + if filters.get("include_default_book_entries"): + additional_conditions += ( + " AND (finance_book in (%(finance_book)s, %(company_fb)s, '') OR finance_book IS NULL)" + ) + else: + additional_conditions += " AND (finance_book in (%(finance_book)s, '') OR finance_book IS NULL)" accounting_dimensions = get_accounting_dimensions(as_list=False) query_filters = { "company": filters.company, "from_date": filters.from_date, + "to_date": filters.to_date, "report_type": report_type, "year_start_date": filters.year_start_date, "project": filters.project, "finance_book": filters.finance_book, - "company_fb": frappe.db.get_value("Company", filters.company, 'default_finance_book') + "company_fb": frappe.db.get_value("Company", filters.company, "default_finance_book"), } if accounting_dimensions: for dimension in accounting_dimensions: if filters.get(dimension.fieldname): - if frappe.get_cached_value('DocType', dimension.document_type, 'is_tree'): - filters[dimension.fieldname] = get_dimension_with_children(dimension.document_type, - filters.get(dimension.fieldname)) - additional_conditions += "and {0} in %({0})s".format(dimension.fieldname) + if frappe.get_cached_value("DocType", dimension.document_type, "is_tree"): + filters[dimension.fieldname] = get_dimension_with_children( + dimension.document_type, filters.get(dimension.fieldname) + ) + additional_conditions += " and {0} in %({0})s".format(dimension.fieldname) else: - additional_conditions += "and {0} in (%({0})s)".format(dimension.fieldname) + additional_conditions += " and {0} in %({0})s".format(dimension.fieldname) - query_filters.update({ - dimension.fieldname: filters.get(dimension.fieldname) - }) + query_filters.update({dimension.fieldname: filters.get(dimension.fieldname)}) - gle = frappe.db.sql(""" + gle = frappe.db.sql( + """ select account, sum(debit) as opening_debit, sum(credit) as opening_credit from `tabGL Entry` where company=%(company)s {additional_conditions} - and (posting_date < %(from_date)s or ifnull(is_opening, 'No') = 'Yes') + and (posting_date < %(from_date)s or (ifnull(is_opening, 'No') = 'Yes' and posting_date <= %(to_date)s)) and account in (select name from `tabAccount` where report_type=%(report_type)s) and is_cancelled = 0 - group by account""".format(additional_conditions=additional_conditions), query_filters , as_dict=True) + group by account""".format( + additional_conditions=additional_conditions + ), + query_filters, + as_dict=True, + ) opening = frappe._dict() for d in gle: @@ -169,6 +217,7 @@ def get_rootwise_opening_balances(filters, report_type): return opening + def calculate_values(accounts, gl_entries_by_account, opening_balances, filters, company_currency): init = { "opening_debit": 0.0, @@ -176,7 +225,7 @@ def calculate_values(accounts, gl_entries_by_account, opening_balances, filters, "debit": 0.0, "credit": 0.0, "closing_debit": 0.0, - "closing_credit": 0.0 + "closing_credit": 0.0, } total_row = { @@ -192,7 +241,7 @@ def calculate_values(accounts, gl_entries_by_account, opening_balances, filters, "parent_account": None, "indent": 0, "has_value": True, - "currency": company_currency + "currency": company_currency, } for d in accounts: @@ -217,12 +266,14 @@ def calculate_values(accounts, gl_entries_by_account, opening_balances, filters, return total_row + def accumulate_values_into_parents(accounts, accounts_by_name): for d in reversed(accounts): if d.parent_account: for key in value_fields: accounts_by_name[d.parent_account][key] += d[key] + def prepare_data(accounts, filters, total_row, parent_children_map, company_currency): data = [] @@ -239,8 +290,9 @@ def prepare_data(accounts, filters, total_row, parent_children_map, company_curr "from_date": filters.from_date, "to_date": filters.to_date, "currency": company_currency, - "account_name": ('{} - {}'.format(d.account_number, d.account_name) - if d.account_number else d.account_name) + "account_name": ( + "{} - {}".format(d.account_number, d.account_name) if d.account_number else d.account_name + ), } for key in value_fields: @@ -253,10 +305,11 @@ def prepare_data(accounts, filters, total_row, parent_children_map, company_curr row["has_value"] = has_value data.append(row) - data.extend([{},total_row]) + data.extend([{}, total_row]) return data + def get_columns(): return [ { @@ -264,59 +317,60 @@ def get_columns(): "label": _("Account"), "fieldtype": "Link", "options": "Account", - "width": 300 + "width": 300, }, { "fieldname": "currency", "label": _("Currency"), "fieldtype": "Link", "options": "Currency", - "hidden": 1 + "hidden": 1, }, { "fieldname": "opening_debit", "label": _("Opening (Dr)"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "opening_credit", "label": _("Opening (Cr)"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "debit", "label": _("Debit"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "credit", "label": _("Credit"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "closing_debit", "label": _("Closing (Dr)"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "closing_credit", "label": _("Closing (Cr)"), "fieldtype": "Currency", "options": "currency", - "width": 120 - } + "width": 120, + }, ] + def prepare_opening_closing(row): dr_or_cr = "debit" if row["root_type"] in ["Asset", "Equity", "Expense"] else "credit" reverse_dr_or_cr = "credit" if dr_or_cr == "debit" else "debit" diff --git a/erpnext/accounts/report/trial_balance_for_party/trial_balance_for_party.py b/erpnext/accounts/report/trial_balance_for_party/trial_balance_for_party.py index d843dfd3ce3..7ef2d22e309 100644 --- a/erpnext/accounts/report/trial_balance_for_party/trial_balance_for_party.py +++ b/erpnext/accounts/report/trial_balance_for_party/trial_balance_for_party.py @@ -19,102 +19,106 @@ def execute(filters=None): return columns, data + def get_data(filters, show_party_name): - if filters.get('party_type') in ('Customer', 'Supplier', 'Employee', 'Member'): - party_name_field = "{0}_name".format(frappe.scrub(filters.get('party_type'))) - elif filters.get('party_type') == 'Student': - party_name_field = 'first_name' - elif filters.get('party_type') == 'Shareholder': - party_name_field = 'title' + if filters.get("party_type") in ("Customer", "Supplier", "Employee", "Member"): + party_name_field = "{0}_name".format(frappe.scrub(filters.get("party_type"))) + elif filters.get("party_type") == "Student": + party_name_field = "first_name" + elif filters.get("party_type") == "Shareholder": + party_name_field = "title" else: - party_name_field = 'name' + party_name_field = "name" party_filters = {"name": filters.get("party")} if filters.get("party") else {} - parties = frappe.get_all(filters.get("party_type"), fields = ["name", party_name_field], - filters = party_filters, order_by="name") - company_currency = frappe.get_cached_value('Company', filters.company, "default_currency") + parties = frappe.get_all( + filters.get("party_type"), + fields=["name", party_name_field], + filters=party_filters, + order_by="name", + ) + company_currency = frappe.get_cached_value("Company", filters.company, "default_currency") opening_balances = get_opening_balances(filters) balances_within_period = get_balances_within_period(filters) data = [] # total_debit, total_credit = 0, 0 - total_row = frappe._dict({ - "opening_debit": 0, - "opening_credit": 0, - "debit": 0, - "credit": 0, - "closing_debit": 0, - "closing_credit": 0 - }) + total_row = frappe._dict( + { + "opening_debit": 0, + "opening_credit": 0, + "debit": 0, + "credit": 0, + "closing_debit": 0, + "closing_credit": 0, + } + ) for party in parties: - row = { "party": party.name } + row = {"party": party.name} if show_party_name: row["party_name"] = party.get(party_name_field) # opening opening_debit, opening_credit = opening_balances.get(party.name, [0, 0]) - row.update({ - "opening_debit": opening_debit, - "opening_credit": opening_credit - }) + row.update({"opening_debit": opening_debit, "opening_credit": opening_credit}) # within period debit, credit = balances_within_period.get(party.name, [0, 0]) - row.update({ - "debit": debit, - "credit": credit - }) + row.update({"debit": debit, "credit": credit}) # closing - closing_debit, closing_credit = toggle_debit_credit(opening_debit + debit, opening_credit + credit) - row.update({ - "closing_debit": closing_debit, - "closing_credit": closing_credit - }) + closing_debit, closing_credit = toggle_debit_credit( + opening_debit + debit, opening_credit + credit + ) + row.update({"closing_debit": closing_debit, "closing_credit": closing_credit}) # totals for col in total_row: total_row[col] += row.get(col) - row.update({ - "currency": company_currency - }) + row.update({"currency": company_currency}) has_value = False - if (opening_debit or opening_credit or debit or credit or closing_debit or closing_credit): - has_value =True + if opening_debit or opening_credit or debit or credit or closing_debit or closing_credit: + has_value = True if cint(filters.show_zero_values) or has_value: data.append(row) # Add total row - total_row.update({ - "party": "'" + _("Totals") + "'", - "currency": company_currency - }) + total_row.update({"party": "'" + _("Totals") + "'", "currency": company_currency}) data.append(total_row) return data + def get_opening_balances(filters): - account_filter = '' - if filters.get('account'): - account_filter = "and account = %s" % (frappe.db.escape(filters.get('account'))) + account_filter = "" + if filters.get("account"): + account_filter = "and account = %s" % (frappe.db.escape(filters.get("account"))) - gle = frappe.db.sql(""" + gle = frappe.db.sql( + """ select party, sum(debit) as opening_debit, sum(credit) as opening_credit from `tabGL Entry` where company=%(company)s + and is_cancelled=0 and ifnull(party_type, '') = %(party_type)s and ifnull(party, '') != '' - and (posting_date < %(from_date)s or ifnull(is_opening, 'No') = 'Yes') + and (posting_date < %(from_date)s or (ifnull(is_opening, 'No') = 'Yes' and posting_date <= %(to_date)s)) {account_filter} - group by party""".format(account_filter=account_filter), { + group by party""".format( + account_filter=account_filter + ), + { "company": filters.company, "from_date": filters.from_date, - "party_type": filters.party_type - }, as_dict=True) + "to_date": filters.to_date, + "party_type": filters.party_type, + }, + as_dict=True, + ) opening = frappe._dict() for d in gle: @@ -123,26 +127,34 @@ def get_opening_balances(filters): return opening + def get_balances_within_period(filters): - account_filter = '' - if filters.get('account'): - account_filter = "and account = %s" % (frappe.db.escape(filters.get('account'))) + account_filter = "" + if filters.get("account"): + account_filter = "and account = %s" % (frappe.db.escape(filters.get("account"))) - gle = frappe.db.sql(""" + gle = frappe.db.sql( + """ select party, sum(debit) as debit, sum(credit) as credit from `tabGL Entry` where company=%(company)s + and is_cancelled = 0 and ifnull(party_type, '') = %(party_type)s and ifnull(party, '') != '' and posting_date >= %(from_date)s and posting_date <= %(to_date)s and ifnull(is_opening, 'No') = 'No' {account_filter} - group by party""".format(account_filter=account_filter), { + group by party""".format( + account_filter=account_filter + ), + { "company": filters.company, "from_date": filters.from_date, "to_date": filters.to_date, - "party_type": filters.party_type - }, as_dict=True) + "party_type": filters.party_type, + }, + as_dict=True, + ) balances_within_period = frappe._dict() for d in gle: @@ -150,6 +162,7 @@ def get_balances_within_period(filters): return balances_within_period + def toggle_debit_credit(debit, credit): if flt(debit) > flt(credit): debit = flt(debit) - flt(credit) @@ -160,6 +173,7 @@ def toggle_debit_credit(debit, credit): return debit, credit + def get_columns(filters, show_party_name): columns = [ { @@ -167,73 +181,77 @@ def get_columns(filters, show_party_name): "label": _(filters.party_type), "fieldtype": "Link", "options": filters.party_type, - "width": 200 + "width": 200, }, { "fieldname": "opening_debit", "label": _("Opening (Dr)"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "opening_credit", "label": _("Opening (Cr)"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "debit", "label": _("Debit"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "credit", "label": _("Credit"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "closing_debit", "label": _("Closing (Dr)"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "closing_credit", "label": _("Closing (Cr)"), "fieldtype": "Currency", "options": "currency", - "width": 120 + "width": 120, }, { "fieldname": "currency", "label": _("Currency"), "fieldtype": "Link", "options": "Currency", - "hidden": 1 - } + "hidden": 1, + }, ] if show_party_name: - columns.insert(1, { - "fieldname": "party_name", - "label": _(filters.party_type) + " Name", - "fieldtype": "Data", - "width": 200 - }) + columns.insert( + 1, + { + "fieldname": "party_name", + "label": _(filters.party_type) + " Name", + "fieldtype": "Data", + "width": 200, + }, + ) return columns + def is_party_name_visible(filters): show_party_name = False - if filters.get('party_type') in ['Customer', 'Supplier']: + if filters.get("party_type") in ["Customer", "Supplier"]: if filters.get("party_type") == "Customer": party_naming_by = frappe.db.get_single_value("Selling Settings", "cust_master_name") else: diff --git a/erpnext/accounts/report/unpaid_expense_claim/unpaid_expense_claim.py b/erpnext/accounts/report/unpaid_expense_claim/unpaid_expense_claim.py index 26b938966b3..62b4f63b3a3 100644 --- a/erpnext/accounts/report/unpaid_expense_claim/unpaid_expense_claim.py +++ b/erpnext/accounts/report/unpaid_expense_claim/unpaid_expense_claim.py @@ -12,16 +12,25 @@ def execute(filters=None): data = get_unclaimed_expese_claims(filters) return columns, data + def get_columns(): - return [_("Employee") + ":Link/Employee:120", _("Employee Name") + "::120",_("Expense Claim") + ":Link/Expense Claim:120", - _("Sanctioned Amount") + ":Currency:120", _("Paid Amount") + ":Currency:120", _("Outstanding Amount") + ":Currency:150"] + return [ + _("Employee") + ":Link/Employee:120", + _("Employee Name") + "::120", + _("Expense Claim") + ":Link/Expense Claim:120", + _("Sanctioned Amount") + ":Currency:120", + _("Paid Amount") + ":Currency:120", + _("Outstanding Amount") + ":Currency:150", + ] + def get_unclaimed_expese_claims(filters): cond = "1=1" if filters.get("employee"): cond = "ec.employee = %(employee)s" - return frappe.db.sql(""" + return frappe.db.sql( + """ select ec.employee, ec.employee_name, ec.name, ec.total_sanctioned_amount, ec.total_amount_reimbursed, sum(gle.credit_in_account_currency - gle.debit_in_account_currency) as outstanding_amt @@ -32,4 +41,9 @@ def get_unclaimed_expese_claims(filters): and gle.party is not null and ec.docstatus = 1 and ec.is_paid = 0 and {cond} group by ec.name having outstanding_amt > 0 - """.format(cond=cond), filters, as_list=1) + """.format( + cond=cond + ), + filters, + as_list=1, + ) diff --git a/erpnext/accounts/report/utils.py b/erpnext/accounts/report/utils.py index 89cc0a8c8cc..eed58367739 100644 --- a/erpnext/accounts/report/utils.py +++ b/erpnext/accounts/report/utils.py @@ -1,4 +1,3 @@ - import frappe from frappe.utils import flt, formatdate, get_datetime_str @@ -8,6 +7,7 @@ from erpnext.setup.utils import get_exchange_rate __exchange_rates = {} + def get_currency(filters): """ Returns a dictionary containing currency information. The keys of the dict are @@ -24,15 +24,22 @@ def get_currency(filters): """ company = get_appropriate_company(filters) company_currency = get_company_currency(company) - presentation_currency = filters['presentation_currency'] if filters.get('presentation_currency') else company_currency + presentation_currency = ( + filters["presentation_currency"] if filters.get("presentation_currency") else company_currency + ) - report_date = filters.get('to_date') + report_date = filters.get("to_date") if not report_date: - fiscal_year_to_date = get_from_and_to_date(filters.get('to_fiscal_year'))["to_date"] + fiscal_year_to_date = get_from_and_to_date(filters.get("to_fiscal_year"))["to_date"] report_date = formatdate(get_datetime_str(fiscal_year_to_date), "dd-MM-yyyy") - currency_map = dict(company=company, company_currency=company_currency, presentation_currency=presentation_currency, report_date=report_date) + currency_map = dict( + company=company, + company_currency=company_currency, + presentation_currency=presentation_currency, + report_date=report_date, + ) return currency_map @@ -63,13 +70,14 @@ def get_rate_as_at(date, from_currency, to_currency): :return: Retrieved exchange rate """ - rate = __exchange_rates.get('{0}-{1}@{2}'.format(from_currency, to_currency, date)) + rate = __exchange_rates.get("{0}-{1}@{2}".format(from_currency, to_currency, date)) if not rate: rate = get_exchange_rate(from_currency, to_currency, date) or 1 - __exchange_rates['{0}-{1}@{2}'.format(from_currency, to_currency, date)] = rate + __exchange_rates["{0}-{1}@{2}".format(from_currency, to_currency, date)] = rate return rate + def convert_to_presentation_currency(gl_entries, currency_info, company): """ Take a list of GL Entries and change the 'debit' and 'credit' values to currencies @@ -79,35 +87,35 @@ def convert_to_presentation_currency(gl_entries, currency_info, company): :return: """ converted_gl_list = [] - presentation_currency = currency_info['presentation_currency'] - company_currency = currency_info['company_currency'] + presentation_currency = currency_info["presentation_currency"] + company_currency = currency_info["company_currency"] - account_currencies = list(set(entry['account_currency'] for entry in gl_entries)) + account_currencies = list(set(entry["account_currency"] for entry in gl_entries)) for entry in gl_entries: - account = entry['account'] - debit = flt(entry['debit']) - credit = flt(entry['credit']) - debit_in_account_currency = flt(entry['debit_in_account_currency']) - credit_in_account_currency = flt(entry['credit_in_account_currency']) - account_currency = entry['account_currency'] + account = entry["account"] + debit = flt(entry["debit"]) + credit = flt(entry["credit"]) + debit_in_account_currency = flt(entry["debit_in_account_currency"]) + credit_in_account_currency = flt(entry["credit_in_account_currency"]) + account_currency = entry["account_currency"] if len(account_currencies) == 1 and account_currency == presentation_currency: - if entry.get('debit'): - entry['debit'] = debit_in_account_currency + if debit_in_account_currency: + entry["debit"] = debit_in_account_currency - if entry.get('credit'): - entry['credit'] = credit_in_account_currency + if credit_in_account_currency: + entry["credit"] = credit_in_account_currency else: - date = currency_info['report_date'] + date = currency_info["report_date"] converted_debit_value = convert(debit, presentation_currency, company_currency, date) converted_credit_value = convert(credit, presentation_currency, company_currency, date) - if entry.get('debit'): - entry['debit'] = converted_debit_value + if entry.get("debit"): + entry["debit"] = converted_debit_value - if entry.get('credit'): - entry['credit'] = converted_credit_value + if entry.get("credit"): + entry["credit"] = converted_credit_value converted_gl_list.append(entry) @@ -115,26 +123,29 @@ def convert_to_presentation_currency(gl_entries, currency_info, company): def get_appropriate_company(filters): - if filters.get('company'): - company = filters['company'] + if filters.get("company"): + company = filters["company"] else: company = get_default_company() return company + @frappe.whitelist() -def get_invoiced_item_gross_margin(sales_invoice=None, item_code=None, company=None, with_item_data=False): +def get_invoiced_item_gross_margin( + sales_invoice=None, item_code=None, company=None, with_item_data=False +): from erpnext.accounts.report.gross_profit.gross_profit import GrossProfitGenerator - sales_invoice = sales_invoice or frappe.form_dict.get('sales_invoice') - item_code = item_code or frappe.form_dict.get('item_code') - company = company or frappe.get_cached_value("Sales Invoice", sales_invoice, 'company') + sales_invoice = sales_invoice or frappe.form_dict.get("sales_invoice") + item_code = item_code or frappe.form_dict.get("item_code") + company = company or frappe.get_cached_value("Sales Invoice", sales_invoice, "company") filters = { - 'sales_invoice': sales_invoice, - 'item_code': item_code, - 'company': company, - 'group_by': 'Invoice' + "sales_invoice": sales_invoice, + "item_code": item_code, + "company": company, + "group_by": "Invoice", } gross_profit_data = GrossProfitGenerator(filters) diff --git a/erpnext/accounts/test/test_reports.py b/erpnext/accounts/test/test_reports.py new file mode 100644 index 00000000000..609f74eadbd --- /dev/null +++ b/erpnext/accounts/test/test_reports.py @@ -0,0 +1,49 @@ +import unittest +from typing import List, Tuple + +from erpnext.tests.utils import ReportFilters, ReportName, execute_script_report + +DEFAULT_FILTERS = { + "company": "_Test Company", + "from_date": "2010-01-01", + "to_date": "2030-01-01", + "period_start_date": "2010-01-01", + "period_end_date": "2030-01-01", +} + + +REPORT_FILTER_TEST_CASES: List[Tuple[ReportName, ReportFilters]] = [ + ("General Ledger", {"group_by": "Group by Voucher (Consolidated)"}), + ("General Ledger", {"group_by": "Group by Voucher (Consolidated)", "include_dimensions": 1}), + ("Accounts Payable", {"range1": 30, "range2": 60, "range3": 90, "range4": 120}), + ("Accounts Receivable", {"range1": 30, "range2": 60, "range3": 90, "range4": 120}), + ("Consolidated Financial Statement", {"report": "Balance Sheet"}), + ("Consolidated Financial Statement", {"report": "Profit and Loss Statement"}), + ("Consolidated Financial Statement", {"report": "Cash Flow"}), + ("Gross Profit", {"group_by": "Invoice"}), + ("Gross Profit", {"group_by": "Item Code"}), + ("Gross Profit", {"group_by": "Item Group"}), + ("Gross Profit", {"group_by": "Customer"}), + ("Gross Profit", {"group_by": "Customer Group"}), + ("Item-wise Sales Register", {}), + ("Item-wise Purchase Register", {}), + ("Sales Register", {}), + ("Sales Register", {"item_group": "All Item Groups"}), + ("Purchase Register", {}), +] + +OPTIONAL_FILTERS = {} + + +class TestReports(unittest.TestCase): + def test_execute_all_accounts_reports(self): + """Test that all script report in stock modules are executable with supported filters""" + for report, filter in REPORT_FILTER_TEST_CASES: + with self.subTest(report=report): + execute_script_report( + report_name=report, + module="Accounts", + filters=filter, + default_filters=DEFAULT_FILTERS, + optional_filters=OPTIONAL_FILTERS if filter.get("_optional") else None, + ) diff --git a/erpnext/accounts/test/test_utils.py b/erpnext/accounts/test/test_utils.py index 4aca40cf6c0..882cd694a32 100644 --- a/erpnext/accounts/test/test_utils.py +++ b/erpnext/accounts/test/test_utils.py @@ -1,11 +1,17 @@ - import unittest +import frappe from frappe.test_runner import make_test_objects from erpnext.accounts.party import get_party_shipping_address -from erpnext.accounts.utils import get_future_stock_vouchers, get_voucherwise_gl_entries +from erpnext.accounts.utils import ( + get_future_stock_vouchers, + get_voucherwise_gl_entries, + sort_stock_vouchers_by_posting_date, +) +from erpnext.stock.doctype.item.test_item import make_item from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import make_purchase_receipt +from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry class TestUtils(unittest.TestCase): @@ -44,9 +50,29 @@ class TestUtils(unittest.TestCase): posting_date = "2021-01-01" gl_entries = get_voucherwise_gl_entries(future_vouchers, posting_date) self.assertTrue( - voucher_type_and_no in gl_entries, msg="get_voucherwise_gl_entries not returning expected GLes", + voucher_type_and_no in gl_entries, + msg="get_voucherwise_gl_entries not returning expected GLes", ) + def test_stock_voucher_sorting(self): + vouchers = [] + + item = make_item().name + + stock_entry = {"item": item, "to_warehouse": "_Test Warehouse - _TC", "qty": 1, "rate": 10} + + se1 = make_stock_entry(posting_date="2022-01-01", **stock_entry) + se3 = make_stock_entry(posting_date="2022-03-01", **stock_entry) + se2 = make_stock_entry(posting_date="2022-02-01", **stock_entry) + + for doc in (se1, se2, se3): + vouchers.append((doc.doctype, doc.name)) + + vouchers.append(("Stock Entry", "Wat")) + + sorted_vouchers = sort_stock_vouchers_by_posting_date(list(reversed(vouchers))) + self.assertEqual(sorted_vouchers, vouchers) + ADDRESS_RECORDS = [ { diff --git a/erpnext/accounts/test_party.py b/erpnext/accounts/test_party.py new file mode 100644 index 00000000000..9d3de5e8282 --- /dev/null +++ b/erpnext/accounts/test_party.py @@ -0,0 +1,18 @@ +import frappe +from frappe.tests.utils import FrappeTestCase + +from erpnext.accounts.party import get_default_price_list + + +class PartyTestCase(FrappeTestCase): + def test_get_default_price_list_should_return_none_for_invalid_group(self): + customer = frappe.get_doc( + { + "doctype": "Customer", + "customer_name": "test customer", + } + ).insert(ignore_permissions=True, ignore_mandatory=True) + customer.customer_group = None + customer.save() + price_list = get_default_price_list(customer) + assert price_list is None diff --git a/erpnext/accounts/utils.py b/erpnext/accounts/utils.py index 10c61e7b20f..c4fafba2669 100644 --- a/erpnext/accounts/utils.py +++ b/erpnext/accounts/utils.py @@ -3,12 +3,23 @@ from json import loads +from typing import TYPE_CHECKING, List, Optional, Tuple import frappe import frappe.defaults from frappe import _, throw from frappe.model.meta import get_field_precision -from frappe.utils import cint, cstr, flt, formatdate, get_number_format_info, getdate, now, nowdate +from frappe.utils import ( + cint, + create_batch, + cstr, + flt, + formatdate, + get_number_format_info, + getdate, + now, + nowdate, +) from six import string_types import erpnext @@ -18,16 +29,31 @@ from erpnext.accounts.doctype.account.account import get_account_currency # noq from erpnext.stock import get_warehouse_account_map from erpnext.stock.utils import get_stock_value_on +if TYPE_CHECKING: + from erpnext.stock.doctype.repost_item_valuation.repost_item_valuation import RepostItemValuation + + +class FiscalYearError(frappe.ValidationError): + pass + + +class PaymentEntryUnlinkError(frappe.ValidationError): + pass + + +GL_REPOSTING_CHUNK = 100 -class StockValueAndAccountBalanceOutOfSync(frappe.ValidationError): pass -class FiscalYearError(frappe.ValidationError): pass -class PaymentEntryUnlinkError(frappe.ValidationError): pass @frappe.whitelist() -def get_fiscal_year(date=None, fiscal_year=None, label="Date", verbose=1, company=None, as_dict=False): +def get_fiscal_year( + date=None, fiscal_year=None, label="Date", verbose=1, company=None, as_dict=False +): return get_fiscal_years(date, fiscal_year, label, verbose, company, as_dict=as_dict)[0] -def get_fiscal_years(transaction_date=None, fiscal_year=None, label="Date", verbose=1, company=None, as_dict=False): + +def get_fiscal_years( + transaction_date=None, fiscal_year=None, label="Date", verbose=1, company=None, as_dict=False +): fiscal_years = frappe.cache().hget("fiscal_years", company) or [] if not fiscal_years: @@ -47,7 +73,8 @@ def get_fiscal_years(transaction_date=None, fiscal_year=None, label="Date", verb ) """ - fiscal_years = frappe.db.sql(""" + fiscal_years = frappe.db.sql( + """ select fy.name, fy.year_start_date, fy.year_end_date from @@ -55,9 +82,12 @@ def get_fiscal_years(transaction_date=None, fiscal_year=None, label="Date", verb where disabled = 0 {0} order by - fy.year_start_date desc""".format(cond), { - "company": company - }, as_dict=True) + fy.year_start_date desc""".format( + cond + ), + {"company": company}, + as_dict=True, + ) frappe.cache().hset("fiscal_years", company, fiscal_years) @@ -72,8 +102,11 @@ def get_fiscal_years(transaction_date=None, fiscal_year=None, label="Date", verb if fiscal_year and fy.name == fiscal_year: matched = True - if (transaction_date and getdate(fy.year_start_date) <= transaction_date - and getdate(fy.year_end_date) >= transaction_date): + if ( + transaction_date + and getdate(fy.year_start_date) <= transaction_date + and getdate(fy.year_end_date) >= transaction_date + ): matched = True if matched: @@ -82,30 +115,35 @@ def get_fiscal_years(transaction_date=None, fiscal_year=None, label="Date", verb else: return ((fy.name, fy.year_start_date, fy.year_end_date),) - error_msg = _("""{0} {1} is not in any active Fiscal Year""").format(label, formatdate(transaction_date)) + error_msg = _("""{0} {1} is not in any active Fiscal Year""").format( + label, formatdate(transaction_date) + ) if company: error_msg = _("""{0} for {1}""").format(error_msg, frappe.bold(company)) - if verbose==1: frappe.msgprint(error_msg) + if verbose == 1: + frappe.msgprint(error_msg) raise FiscalYearError(error_msg) + @frappe.whitelist() def get_fiscal_year_filter_field(company=None): - field = { - "fieldtype": "Select", - "options": [], - "operator": "Between", - "query_value": True - } + field = {"fieldtype": "Select", "options": [], "operator": "Between", "query_value": True} fiscal_years = get_fiscal_years(company=company) for fiscal_year in fiscal_years: - field["options"].append({ - "label": fiscal_year.name, - "value": fiscal_year.name, - "query_value": [fiscal_year.year_start_date.strftime("%Y-%m-%d"), fiscal_year.year_end_date.strftime("%Y-%m-%d")] - }) + field["options"].append( + { + "label": fiscal_year.name, + "value": fiscal_year.name, + "query_value": [ + fiscal_year.year_start_date.strftime("%Y-%m-%d"), + fiscal_year.year_end_date.strftime("%Y-%m-%d"), + ], + } + ) return field + def validate_fiscal_year(date, fiscal_year, company, label="Date", doc=None): years = [f[0] for f in get_fiscal_years(date, label=_(label), company=company)] if fiscal_year not in years: @@ -114,9 +152,18 @@ def validate_fiscal_year(date, fiscal_year, company, label="Date", doc=None): else: throw(_("{0} '{1}' not in Fiscal Year {2}").format(label, formatdate(date), fiscal_year)) + @frappe.whitelist() -def get_balance_on(account=None, date=None, party_type=None, party=None, company=None, - in_account_currency=True, cost_center=None, ignore_account_permission=False): +def get_balance_on( + account=None, + date=None, + party_type=None, + party=None, + company=None, + in_account_currency=True, + cost_center=None, + ignore_account_permission=False, +): if not account and frappe.form_dict.get("account"): account = frappe.form_dict.get("account") if not date and frappe.form_dict.get("date"): @@ -128,7 +175,6 @@ def get_balance_on(account=None, date=None, party_type=None, party=None, company if not cost_center and frappe.form_dict.get("cost_center"): cost_center = frappe.form_dict.get("cost_center") - cond = ["is_cancelled=0"] if date: cond.append("posting_date <= %s" % frappe.db.escape(cstr(date))) @@ -156,45 +202,52 @@ def get_balance_on(account=None, date=None, party_type=None, party=None, company else: report_type = "" - if cost_center and report_type == 'Profit and Loss': + if cost_center and report_type == "Profit and Loss": cc = frappe.get_doc("Cost Center", cost_center) if cc.is_group: - cond.append(""" exists ( + cond.append( + """ exists ( select 1 from `tabCost Center` cc where cc.name = gle.cost_center and cc.lft >= %s and cc.rgt <= %s - )""" % (cc.lft, cc.rgt)) + )""" + % (cc.lft, cc.rgt) + ) else: - cond.append("""gle.cost_center = %s """ % (frappe.db.escape(cost_center, percent=False), )) - + cond.append("""gle.cost_center = %s """ % (frappe.db.escape(cost_center, percent=False),)) if account: - if not (frappe.flags.ignore_account_permission - or ignore_account_permission): + if not (frappe.flags.ignore_account_permission or ignore_account_permission): acc.check_permission("read") - if report_type == 'Profit and Loss': + if report_type == "Profit and Loss": # for pl accounts, get balance within a fiscal year - cond.append("posting_date >= '%s' and voucher_type != 'Period Closing Voucher'" \ - % year_start_date) + cond.append( + "posting_date >= '%s' and voucher_type != 'Period Closing Voucher'" % year_start_date + ) # different filter for group and ledger - improved performance if acc.is_group: - cond.append("""exists ( + cond.append( + """exists ( select name from `tabAccount` ac where ac.name = gle.account and ac.lft >= %s and ac.rgt <= %s - )""" % (acc.lft, acc.rgt)) + )""" + % (acc.lft, acc.rgt) + ) # If group and currency same as company, # always return balance based on debit and credit in company currency - if acc.account_currency == frappe.get_cached_value('Company', acc.company, "default_currency"): + if acc.account_currency == frappe.get_cached_value("Company", acc.company, "default_currency"): in_account_currency = False else: - cond.append("""gle.account = %s """ % (frappe.db.escape(account, percent=False), )) + cond.append("""gle.account = %s """ % (frappe.db.escape(account, percent=False),)) if party_type and party: - cond.append("""gle.party_type = %s and gle.party = %s """ % - (frappe.db.escape(party_type), frappe.db.escape(party, percent=False))) + cond.append( + """gle.party_type = %s and gle.party = %s """ + % (frappe.db.escape(party_type), frappe.db.escape(party, percent=False)) + ) if company: cond.append("""gle.company = %s """ % (frappe.db.escape(company, percent=False))) @@ -204,14 +257,19 @@ def get_balance_on(account=None, date=None, party_type=None, party=None, company select_field = "sum(debit_in_account_currency) - sum(credit_in_account_currency)" else: select_field = "sum(debit) - sum(credit)" - bal = frappe.db.sql(""" + bal = frappe.db.sql( + """ SELECT {0} FROM `tabGL Entry` gle - WHERE {1}""".format(select_field, " and ".join(cond)))[0][0] + WHERE {1}""".format( + select_field, " and ".join(cond) + ) + )[0][0] # if bal is None, return 0 return flt(bal) + def get_count_on(account, fieldname, date): cond = ["is_cancelled=0"] if date: @@ -239,53 +297,71 @@ def get_count_on(account, fieldname, date): acc.check_permission("read") # for pl accounts, get balance within a fiscal year - if acc.report_type == 'Profit and Loss': - cond.append("posting_date >= '%s' and voucher_type != 'Period Closing Voucher'" \ - % year_start_date) + if acc.report_type == "Profit and Loss": + cond.append( + "posting_date >= '%s' and voucher_type != 'Period Closing Voucher'" % year_start_date + ) # different filter for group and ledger - improved performance if acc.is_group: - cond.append("""exists ( + cond.append( + """exists ( select name from `tabAccount` ac where ac.name = gle.account and ac.lft >= %s and ac.rgt <= %s - )""" % (acc.lft, acc.rgt)) + )""" + % (acc.lft, acc.rgt) + ) else: - cond.append("""gle.account = %s """ % (frappe.db.escape(account, percent=False), )) + cond.append("""gle.account = %s """ % (frappe.db.escape(account, percent=False),)) - entries = frappe.db.sql(""" + entries = frappe.db.sql( + """ SELECT name, posting_date, account, party_type, party,debit,credit, voucher_type, voucher_no, against_voucher_type, against_voucher FROM `tabGL Entry` gle - WHERE {0}""".format(" and ".join(cond)), as_dict=True) + WHERE {0}""".format( + " and ".join(cond) + ), + as_dict=True, + ) count = 0 for gle in entries: - if fieldname not in ('invoiced_amount','payables'): + if fieldname not in ("invoiced_amount", "payables"): count += 1 else: dr_or_cr = "debit" if fieldname == "invoiced_amount" else "credit" cr_or_dr = "credit" if fieldname == "invoiced_amount" else "debit" - select_fields = "ifnull(sum(credit-debit),0)" \ - if fieldname == "invoiced_amount" else "ifnull(sum(debit-credit),0)" + select_fields = ( + "ifnull(sum(credit-debit),0)" + if fieldname == "invoiced_amount" + else "ifnull(sum(debit-credit),0)" + ) - if ((not gle.against_voucher) or (gle.against_voucher_type in ["Sales Order", "Purchase Order"]) or - (gle.against_voucher==gle.voucher_no and gle.get(dr_or_cr) > 0)): - payment_amount = frappe.db.sql(""" + if ( + (not gle.against_voucher) + or (gle.against_voucher_type in ["Sales Order", "Purchase Order"]) + or (gle.against_voucher == gle.voucher_no and gle.get(dr_or_cr) > 0) + ): + payment_amount = frappe.db.sql( + """ SELECT {0} FROM `tabGL Entry` gle WHERE docstatus < 2 and posting_date <= %(date)s and against_voucher = %(voucher_no)s - and party = %(party)s and name != %(name)s""" - .format(select_fields), - {"date": date, "voucher_no": gle.voucher_no, - "party": gle.party, "name": gle.name})[0][0] + and party = %(party)s and name != %(name)s""".format( + select_fields + ), + {"date": date, "voucher_no": gle.voucher_no, "party": gle.party, "name": gle.name}, + )[0][0] outstanding_amount = flt(gle.get(dr_or_cr)) - flt(gle.get(cr_or_dr)) - payment_amount currency_precision = get_currency_precision() or 2 - if abs(flt(outstanding_amount)) > 0.1/10**currency_precision: + if abs(flt(outstanding_amount)) > 0.1 / 10**currency_precision: count += 1 return count + @frappe.whitelist() def add_ac(args=None): from frappe.desk.treeview import make_tree_args @@ -317,6 +393,7 @@ def add_ac(args=None): return ac.name + @frappe.whitelist() def add_cc(args=None): from frappe.desk.treeview import make_tree_args @@ -328,8 +405,9 @@ def add_cc(args=None): args = make_tree_args(**args) if args.parent_cost_center == args.company: - args.parent_cost_center = "{0} - {1}".format(args.parent_cost_center, - frappe.get_cached_value('Company', args.company, 'abbr')) + args.parent_cost_center = "{0} - {1}".format( + args.parent_cost_center, frappe.get_cached_value("Company", args.company, "abbr") + ) cc = frappe.new_doc("Cost Center") cc.update(args) @@ -341,9 +419,10 @@ def add_cc(args=None): cc.insert() return cc.name + def reconcile_against_document(args): """ - Cancel PE or JV, Update against document, split if required and resubmit + Cancel PE or JV, Update against document, split if required and resubmit """ # To optimize making GL Entry for PE or JV with multiple references reconciled_entries = {} @@ -375,36 +454,44 @@ def reconcile_against_document(args): doc.save(ignore_permissions=True) # re-submit advance entry doc = frappe.get_doc(entry.voucher_type, entry.voucher_no) - doc.make_gl_entries(cancel = 0, adv_adj =1) + doc.make_gl_entries(cancel=0, adv_adj=1) frappe.flags.ignore_party_validation = False - if entry.voucher_type in ('Payment Entry', 'Journal Entry'): + if entry.voucher_type in ("Payment Entry", "Journal Entry"): doc.update_expense_claim() + def check_if_advance_entry_modified(args): """ - check if there is already a voucher reference - check if amount is same - check if jv is submitted + check if there is already a voucher reference + check if amount is same + check if jv is submitted """ - if not args.get('unreconciled_amount'): - args.update({'unreconciled_amount': args.get('unadjusted_amount')}) + if not args.get("unreconciled_amount"): + args.update({"unreconciled_amount": args.get("unadjusted_amount")}) ret = None if args.voucher_type == "Journal Entry": - ret = frappe.db.sql(""" + ret = frappe.db.sql( + """ select t2.{dr_or_cr} from `tabJournal Entry` t1, `tabJournal Entry Account` t2 where t1.name = t2.parent and t2.account = %(account)s and t2.party_type = %(party_type)s and t2.party = %(party)s and (t2.reference_type is null or t2.reference_type in ("", "Sales Order", "Purchase Order")) and t1.name = %(voucher_no)s and t2.name = %(voucher_detail_no)s - and t1.docstatus=1 """.format(dr_or_cr = args.get("dr_or_cr")), args) + and t1.docstatus=1 """.format( + dr_or_cr=args.get("dr_or_cr") + ), + args, + ) else: - party_account_field = ("paid_from" - if erpnext.get_party_account_type(args.party_type) == 'Receivable' else "paid_to") + party_account_field = ( + "paid_from" if erpnext.get_party_account_type(args.party_type) == "Receivable" else "paid_to" + ) if args.voucher_detail_no: - ret = frappe.db.sql("""select t1.name + ret = frappe.db.sql( + """select t1.name from `tabPayment Entry` t1, `tabPayment Entry Reference` t2 where t1.name = t2.parent and t1.docstatus = 1 @@ -412,37 +499,53 @@ def check_if_advance_entry_modified(args): and t1.party_type = %(party_type)s and t1.party = %(party)s and t1.{0} = %(account)s and t2.reference_doctype in ("", "Sales Order", "Purchase Order") and t2.allocated_amount = %(unreconciled_amount)s - """.format(party_account_field), args) + """.format( + party_account_field + ), + args, + ) else: - ret = frappe.db.sql("""select name from `tabPayment Entry` + ret = frappe.db.sql( + """select name from `tabPayment Entry` where name = %(voucher_no)s and docstatus = 1 and party_type = %(party_type)s and party = %(party)s and {0} = %(account)s and unallocated_amount = %(unreconciled_amount)s - """.format(party_account_field), args) + """.format( + party_account_field + ), + args, + ) if not ret: throw(_("""Payment Entry has been modified after you pulled it. Please pull it again.""")) + def validate_allocated_amount(args): - precision = args.get('precision') or frappe.db.get_single_value("System Settings", "currency_precision") + precision = args.get("precision") or frappe.db.get_single_value( + "System Settings", "currency_precision" + ) if args.get("allocated_amount") < 0: throw(_("Allocated amount cannot be negative")) elif flt(args.get("allocated_amount"), precision) > flt(args.get("unadjusted_amount"), precision): throw(_("Allocated amount cannot be greater than unadjusted amount")) + def update_reference_in_journal_entry(d, journal_entry, do_not_save=False): """ - Updates against document, if partial amount splits into rows + Updates against document, if partial amount splits into rows """ jv_detail = journal_entry.get("accounts", {"name": d["voucher_detail_no"]})[0] - if flt(d['unadjusted_amount']) - flt(d['allocated_amount']) != 0: + if flt(d["unadjusted_amount"]) - flt(d["allocated_amount"]) != 0: # adjust the unreconciled balance - amount_in_account_currency = flt(d['unadjusted_amount']) - flt(d['allocated_amount']) + amount_in_account_currency = flt(d["unadjusted_amount"]) - flt(d["allocated_amount"]) amount_in_company_currency = amount_in_account_currency * flt(jv_detail.exchange_rate) - jv_detail.set(d['dr_or_cr'], amount_in_account_currency) - jv_detail.set('debit' if d['dr_or_cr'] == 'debit_in_account_currency' else 'credit', amount_in_company_currency) + jv_detail.set(d["dr_or_cr"], amount_in_account_currency) + jv_detail.set( + "debit" if d["dr_or_cr"] == "debit_in_account_currency" else "credit", + amount_in_company_currency, + ) else: journal_entry.remove(jv_detail) @@ -452,12 +555,18 @@ def update_reference_in_journal_entry(d, journal_entry, do_not_save=False): new_row.update((frappe.copy_doc(jv_detail)).as_dict()) new_row.set(d["dr_or_cr"], d["allocated_amount"]) - new_row.set('debit' if d['dr_or_cr'] == 'debit_in_account_currency' else 'credit', - d["allocated_amount"] * flt(jv_detail.exchange_rate)) + new_row.set( + "debit" if d["dr_or_cr"] == "debit_in_account_currency" else "credit", + d["allocated_amount"] * flt(jv_detail.exchange_rate), + ) - new_row.set('credit_in_account_currency' if d['dr_or_cr'] == 'debit_in_account_currency' - else 'debit_in_account_currency', 0) - new_row.set('credit' if d['dr_or_cr'] == 'debit_in_account_currency' else 'debit', 0) + new_row.set( + "credit_in_account_currency" + if d["dr_or_cr"] == "debit_in_account_currency" + else "debit_in_account_currency", + 0, + ) + new_row.set("credit" if d["dr_or_cr"] == "debit_in_account_currency" else "debit", 0) new_row.set("reference_type", d["against_voucher_type"]) new_row.set("reference_name", d["against_voucher"]) @@ -471,6 +580,7 @@ def update_reference_in_journal_entry(d, journal_entry, do_not_save=False): if not do_not_save: journal_entry.save(ignore_permissions=True) + def update_reference_in_payment_entry(d, payment_entry, do_not_save=False): reference_details = { "reference_doctype": d.against_voucher_type, @@ -478,8 +588,10 @@ def update_reference_in_payment_entry(d, payment_entry, do_not_save=False): "total_amount": d.grand_total, "outstanding_amount": d.outstanding_amount, "allocated_amount": d.allocated_amount, - "exchange_rate": d.exchange_rate if not d.exchange_gain_loss else payment_entry.get_exchange_rate(), - "exchange_gain_loss": d.exchange_gain_loss # only populated from invoice in case of advance allocation + "exchange_rate": d.exchange_rate + if not d.exchange_gain_loss + else payment_entry.get_exchange_rate(), + "exchange_gain_loss": d.exchange_gain_loss, # only populated from invoice in case of advance allocation } if d.voucher_detail_no: @@ -506,57 +618,75 @@ def update_reference_in_payment_entry(d, payment_entry, do_not_save=False): if d.difference_amount and d.difference_account: account_details = { - 'account': d.difference_account, - 'cost_center': payment_entry.cost_center or frappe.get_cached_value('Company', - payment_entry.company, "cost_center") + "account": d.difference_account, + "cost_center": payment_entry.cost_center + or frappe.get_cached_value("Company", payment_entry.company, "cost_center"), } if d.difference_amount: - account_details['amount'] = d.difference_amount + account_details["amount"] = d.difference_amount payment_entry.set_gain_or_loss(account_details=account_details) if not do_not_save: payment_entry.save(ignore_permissions=True) + def unlink_ref_doc_from_payment_entries(ref_doc): remove_ref_doc_link_from_jv(ref_doc.doctype, ref_doc.name) remove_ref_doc_link_from_pe(ref_doc.doctype, ref_doc.name) - frappe.db.sql("""update `tabGL Entry` + frappe.db.sql( + """update `tabGL Entry` set against_voucher_type=null, against_voucher=null, modified=%s, modified_by=%s where against_voucher_type=%s and against_voucher=%s and voucher_no != ifnull(against_voucher, '')""", - (now(), frappe.session.user, ref_doc.doctype, ref_doc.name)) + (now(), frappe.session.user, ref_doc.doctype, ref_doc.name), + ) if ref_doc.doctype in ("Sales Invoice", "Purchase Invoice"): ref_doc.set("advances", []) - frappe.db.sql("""delete from `tab{0} Advance` where parent = %s""" - .format(ref_doc.doctype), ref_doc.name) + frappe.db.sql( + """delete from `tab{0} Advance` where parent = %s""".format(ref_doc.doctype), ref_doc.name + ) + def remove_ref_doc_link_from_jv(ref_type, ref_no): - linked_jv = frappe.db.sql_list("""select parent from `tabJournal Entry Account` - where reference_type=%s and reference_name=%s and docstatus < 2""", (ref_type, ref_no)) + linked_jv = frappe.db.sql_list( + """select parent from `tabJournal Entry Account` + where reference_type=%s and reference_name=%s and docstatus < 2""", + (ref_type, ref_no), + ) if linked_jv: - frappe.db.sql("""update `tabJournal Entry Account` + frappe.db.sql( + """update `tabJournal Entry Account` set reference_type=null, reference_name = null, modified=%s, modified_by=%s where reference_type=%s and reference_name=%s - and docstatus < 2""", (now(), frappe.session.user, ref_type, ref_no)) + and docstatus < 2""", + (now(), frappe.session.user, ref_type, ref_no), + ) frappe.msgprint(_("Journal Entries {0} are un-linked").format("\n".join(linked_jv))) + def remove_ref_doc_link_from_pe(ref_type, ref_no): - linked_pe = frappe.db.sql_list("""select parent from `tabPayment Entry Reference` - where reference_doctype=%s and reference_name=%s and docstatus < 2""", (ref_type, ref_no)) + linked_pe = frappe.db.sql_list( + """select parent from `tabPayment Entry Reference` + where reference_doctype=%s and reference_name=%s and docstatus < 2""", + (ref_type, ref_no), + ) if linked_pe: - frappe.db.sql("""update `tabPayment Entry Reference` + frappe.db.sql( + """update `tabPayment Entry Reference` set allocated_amount=0, modified=%s, modified_by=%s where reference_doctype=%s and reference_name=%s - and docstatus < 2""", (now(), frappe.session.user, ref_type, ref_no)) + and docstatus < 2""", + (now(), frappe.session.user, ref_type, ref_no), + ) for pe in linked_pe: try: @@ -566,42 +696,62 @@ def remove_ref_doc_link_from_pe(ref_type, ref_no): pe_doc.validate_payment_type_with_outstanding() except Exception as e: msg = _("There were issues unlinking payment entry {0}.").format(pe_doc.name) - msg += '
' + msg += "
" msg += _("Please cancel payment entry manually first") frappe.throw(msg, exc=PaymentEntryUnlinkError, title=_("Payment Unlink Error")) - frappe.db.sql("""update `tabPayment Entry` set total_allocated_amount=%s, + frappe.db.sql( + """update `tabPayment Entry` set total_allocated_amount=%s, base_total_allocated_amount=%s, unallocated_amount=%s, modified=%s, modified_by=%s - where name=%s""", (pe_doc.total_allocated_amount, pe_doc.base_total_allocated_amount, - pe_doc.unallocated_amount, now(), frappe.session.user, pe)) + where name=%s""", + ( + pe_doc.total_allocated_amount, + pe_doc.base_total_allocated_amount, + pe_doc.unallocated_amount, + now(), + frappe.session.user, + pe, + ), + ) frappe.msgprint(_("Payment Entries {0} are un-linked").format("\n".join(linked_pe))) + @frappe.whitelist() def get_company_default(company, fieldname, ignore_validation=False): - value = frappe.get_cached_value('Company', company, fieldname) + value = frappe.get_cached_value("Company", company, fieldname) if not ignore_validation and not value: - throw(_("Please set default {0} in Company {1}") - .format(frappe.get_meta("Company").get_label(fieldname), company)) + throw( + _("Please set default {0} in Company {1}").format( + frappe.get_meta("Company").get_label(fieldname), company + ) + ) return value + def fix_total_debit_credit(): - vouchers = frappe.db.sql("""select voucher_type, voucher_no, + vouchers = frappe.db.sql( + """select voucher_type, voucher_no, sum(debit) - sum(credit) as diff from `tabGL Entry` group by voucher_type, voucher_no - having sum(debit) != sum(credit)""", as_dict=1) + having sum(debit) != sum(credit)""", + as_dict=1, + ) for d in vouchers: if abs(d.diff) > 0: dr_or_cr = d.voucher_type == "Sales Invoice" and "credit" or "debit" - frappe.db.sql("""update `tabGL Entry` set %s = %s + %s - where voucher_type = %s and voucher_no = %s and %s > 0 limit 1""" % - (dr_or_cr, dr_or_cr, '%s', '%s', '%s', dr_or_cr), - (d.diff, d.voucher_type, d.voucher_no)) + frappe.db.sql( + """update `tabGL Entry` set %s = %s + %s + where voucher_type = %s and voucher_no = %s and %s > 0 limit 1""" + % (dr_or_cr, dr_or_cr, "%s", "%s", "%s", dr_or_cr), + (d.diff, d.voucher_type, d.voucher_no), + ) + def get_currency_precision(): precision = cint(frappe.db.get_default("currency_precision")) @@ -611,29 +761,41 @@ def get_currency_precision(): return precision -def get_stock_rbnb_difference(posting_date, company): - stock_items = frappe.db.sql_list("""select distinct item_code - from `tabStock Ledger Entry` where company=%s""", company) - pr_valuation_amount = frappe.db.sql(""" +def get_stock_rbnb_difference(posting_date, company): + stock_items = frappe.db.sql_list( + """select distinct item_code + from `tabStock Ledger Entry` where company=%s""", + company, + ) + + pr_valuation_amount = frappe.db.sql( + """ select sum(pr_item.valuation_rate * pr_item.qty * pr_item.conversion_factor) from `tabPurchase Receipt Item` pr_item, `tabPurchase Receipt` pr where pr.name = pr_item.parent and pr.docstatus=1 and pr.company=%s - and pr.posting_date <= %s and pr_item.item_code in (%s)""" % - ('%s', '%s', ', '.join(['%s']*len(stock_items))), tuple([company, posting_date] + stock_items))[0][0] + and pr.posting_date <= %s and pr_item.item_code in (%s)""" + % ("%s", "%s", ", ".join(["%s"] * len(stock_items))), + tuple([company, posting_date] + stock_items), + )[0][0] - pi_valuation_amount = frappe.db.sql(""" + pi_valuation_amount = frappe.db.sql( + """ select sum(pi_item.valuation_rate * pi_item.qty * pi_item.conversion_factor) from `tabPurchase Invoice Item` pi_item, `tabPurchase Invoice` pi where pi.name = pi_item.parent and pi.docstatus=1 and pi.company=%s - and pi.posting_date <= %s and pi_item.item_code in (%s)""" % - ('%s', '%s', ', '.join(['%s']*len(stock_items))), tuple([company, posting_date] + stock_items))[0][0] + and pi.posting_date <= %s and pi_item.item_code in (%s)""" + % ("%s", "%s", ", ".join(["%s"] * len(stock_items))), + tuple([company, posting_date] + stock_items), + )[0][0] # Balance should be stock_rbnb = flt(pr_valuation_amount, 2) - flt(pi_valuation_amount, 2) # Balance as per system - stock_rbnb_account = "Stock Received But Not Billed - " + frappe.get_cached_value('Company', company, "abbr") + stock_rbnb_account = "Stock Received But Not Billed - " + frappe.get_cached_value( + "Company", company, "abbr" + ) sys_bal = get_balance_on(stock_rbnb_account, posting_date, in_account_currency=False) # Amount should be credited @@ -646,28 +808,55 @@ def get_held_invoices(party_type, party): """ held_invoices = None - if party_type == 'Supplier': + if party_type == "Supplier": held_invoices = frappe.db.sql( - 'select name from `tabPurchase Invoice` where release_date IS NOT NULL and release_date > CURDATE()', - as_dict=1 + "select name from `tabPurchase Invoice` where release_date IS NOT NULL and release_date > CURDATE()", + as_dict=1, ) - held_invoices = set(d['name'] for d in held_invoices) + held_invoices = set(d["name"] for d in held_invoices) return held_invoices +def remove_return_pos_invoices(party_type, party, invoice_list): + if invoice_list: + + if party_type == "Customer": + sinv = frappe.qb.DocType("Sales Invoice") + return_pos = ( + frappe.qb.from_(sinv) + .select(sinv.name) + .where((sinv.is_pos == 1) & (sinv.docstatus == 1) & (sinv.is_return == 1)) + .run() + ) + + if return_pos: + return_pos = [x[0] for x in return_pos] + else: + return invoice_list + + # remove pos return invoices from invoice_list + for idx, inv in enumerate(invoice_list, 0): + if inv.voucher_no in return_pos: + del invoice_list[idx] + + return invoice_list + + def get_outstanding_invoices(party_type, party, account, condition=None, filters=None): outstanding_invoices = [] precision = frappe.get_precision("Sales Invoice", "outstanding_amount") or 2 if account: - root_type, account_type = frappe.get_cached_value("Account", account, ["root_type", "account_type"]) + root_type, account_type = frappe.get_cached_value( + "Account", account, ["root_type", "account_type"] + ) party_account_type = "Receivable" if root_type == "Asset" else "Payable" party_account_type = account_type or party_account_type else: party_account_type = erpnext.get_party_account_type(party_type) - if party_account_type == 'Receivable': + if party_account_type == "Receivable": dr_or_cr = "debit_in_account_currency - credit_in_account_currency" payment_dr_or_cr = "credit_in_account_currency - debit_in_account_currency" else: @@ -676,7 +865,8 @@ def get_outstanding_invoices(party_type, party, account, condition=None, filters held_invoices = get_held_invoices(party_type, party) - invoice_list = frappe.db.sql(""" + invoice_list = frappe.db.sql( + """ select voucher_no, voucher_type, posting_date, due_date, ifnull(sum({dr_or_cr}), 0) as invoice_amount, @@ -693,15 +883,20 @@ def get_outstanding_invoices(party_type, party, account, condition=None, filters or (voucher_type not in ('Journal Entry', 'Payment Entry'))) group by voucher_type, voucher_no order by posting_date, name""".format( - dr_or_cr=dr_or_cr, - condition=condition or "" - ), { + dr_or_cr=dr_or_cr, condition=condition or "" + ), + { "party_type": party_type, "party": party, "account": account, - }, as_dict=True) + }, + as_dict=True, + ) - payment_entries = frappe.db.sql(""" + invoice_list = remove_return_pos_invoices(party_type, party, invoice_list) + + payment_entries = frappe.db.sql( + """ select against_voucher_type, against_voucher, ifnull(sum({payment_dr_or_cr}), 0) as payment_amount from `tabGL Entry` @@ -711,11 +906,12 @@ def get_outstanding_invoices(party_type, party, account, condition=None, filters and against_voucher is not null and against_voucher != '' and is_cancelled=0 group by against_voucher_type, against_voucher - """.format(payment_dr_or_cr=payment_dr_or_cr), { - "party_type": party_type, - "party": party, - "account": account - }, as_dict=True) + """.format( + payment_dr_or_cr=payment_dr_or_cr + ), + {"party_type": party_type, "party": party, "account": account}, + as_dict=True, + ) pe_map = frappe._dict() for d in payment_entries: @@ -725,73 +921,87 @@ def get_outstanding_invoices(party_type, party, account, condition=None, filters payment_amount = pe_map.get((d.voucher_type, d.voucher_no), 0) outstanding_amount = flt(d.invoice_amount - payment_amount, precision) if outstanding_amount > 0.5 / (10**precision): - if (filters and filters.get("outstanding_amt_greater_than") and - not (outstanding_amount >= filters.get("outstanding_amt_greater_than") and - outstanding_amount <= filters.get("outstanding_amt_less_than"))): + if ( + filters + and filters.get("outstanding_amt_greater_than") + and not ( + outstanding_amount >= filters.get("outstanding_amt_greater_than") + and outstanding_amount <= filters.get("outstanding_amt_less_than") + ) + ): continue if not d.voucher_type == "Purchase Invoice" or d.voucher_no not in held_invoices: outstanding_invoices.append( - frappe._dict({ - 'voucher_no': d.voucher_no, - 'voucher_type': d.voucher_type, - 'posting_date': d.posting_date, - 'invoice_amount': flt(d.invoice_amount), - 'payment_amount': payment_amount, - 'outstanding_amount': outstanding_amount, - 'due_date': d.due_date, - 'currency': d.currency - }) + frappe._dict( + { + "voucher_no": d.voucher_no, + "voucher_type": d.voucher_type, + "posting_date": d.posting_date, + "invoice_amount": flt(d.invoice_amount), + "payment_amount": payment_amount, + "outstanding_amount": outstanding_amount, + "due_date": d.due_date, + "currency": d.currency, + } + ) ) - outstanding_invoices = sorted(outstanding_invoices, key=lambda k: k['due_date'] or getdate(nowdate())) + outstanding_invoices = sorted( + outstanding_invoices, key=lambda k: k["due_date"] or getdate(nowdate()) + ) return outstanding_invoices -def get_account_name(account_type=None, root_type=None, is_group=None, account_currency=None, company=None): +def get_account_name( + account_type=None, root_type=None, is_group=None, account_currency=None, company=None +): """return account based on matching conditions""" - return frappe.db.get_value("Account", { - "account_type": account_type or '', - "root_type": root_type or '', - "is_group": is_group or 0, - "account_currency": account_currency or frappe.defaults.get_defaults().currency, - "company": company or frappe.defaults.get_defaults().company - }, "name") + return frappe.db.get_value( + "Account", + { + "account_type": account_type or "", + "root_type": root_type or "", + "is_group": is_group or 0, + "account_currency": account_currency or frappe.defaults.get_defaults().currency, + "company": company or frappe.defaults.get_defaults().company, + }, + "name", + ) + @frappe.whitelist() def get_companies(): """get a list of companies based on permission""" - return [d.name for d in frappe.get_list("Company", fields=["name"], - order_by="name")] + return [d.name for d in frappe.get_list("Company", fields=["name"], order_by="name")] + @frappe.whitelist() def get_children(doctype, parent, company, is_root=False): from erpnext.accounts.report.financial_statements import sort_accounts - parent_fieldname = 'parent_' + doctype.lower().replace(' ', '_') - fields = [ - 'name as value', - 'is_group as expandable' - ] - filters = [['docstatus', '<', 2]] + parent_fieldname = "parent_" + doctype.lower().replace(" ", "_") + fields = ["name as value", "is_group as expandable"] + filters = [["docstatus", "<", 2]] - filters.append(['ifnull(`{0}`,"")'.format(parent_fieldname), '=', '' if is_root else parent]) + filters.append(['ifnull(`{0}`,"")'.format(parent_fieldname), "=", "" if is_root else parent]) if is_root: - fields += ['root_type', 'report_type', 'account_currency'] if doctype == 'Account' else [] - filters.append(['company', '=', company]) + fields += ["root_type", "report_type", "account_currency"] if doctype == "Account" else [] + filters.append(["company", "=", company]) else: - fields += ['root_type', 'account_currency'] if doctype == 'Account' else [] - fields += [parent_fieldname + ' as parent'] + fields += ["root_type", "account_currency"] if doctype == "Account" else [] + fields += [parent_fieldname + " as parent"] acc = frappe.get_list(doctype, fields=fields, filters=filters) - if doctype == 'Account': + if doctype == "Account": sort_accounts(acc, is_root, key="value") return acc + @frappe.whitelist() def get_account_balances(accounts, company): @@ -801,16 +1011,19 @@ def get_account_balances(accounts, company): if not accounts: return [] - company_currency = frappe.get_cached_value("Company", company, "default_currency") + company_currency = frappe.get_cached_value("Company", company, "default_currency") for account in accounts: account["company_currency"] = company_currency - account["balance"] = flt(get_balance_on(account["value"], in_account_currency=False, company=company)) + account["balance"] = flt( + get_balance_on(account["value"], in_account_currency=False, company=company) + ) if account["account_currency"] and account["account_currency"] != company_currency: account["balance_in_account_currency"] = flt(get_balance_on(account["value"], company=company)) return accounts + def create_payment_gateway_account(gateway, payment_channel="Email"): from erpnext.setup.setup_wizard.operations.install_fixtures import create_bank_account @@ -819,13 +1032,21 @@ def create_payment_gateway_account(gateway, payment_channel="Email"): return # NOTE: we translate Payment Gateway account name because that is going to be used by the end user - bank_account = frappe.db.get_value("Account", {"account_name": _(gateway), "company": company}, - ["name", 'account_currency'], as_dict=1) + bank_account = frappe.db.get_value( + "Account", + {"account_name": _(gateway), "company": company}, + ["name", "account_currency"], + as_dict=1, + ) if not bank_account: # check for untranslated one - bank_account = frappe.db.get_value("Account", {"account_name": gateway, "company": company}, - ["name", 'account_currency'], as_dict=1) + bank_account = frappe.db.get_value( + "Account", + {"account_name": gateway, "company": company}, + ["name", "account_currency"], + as_dict=1, + ) if not bank_account: # try creating one @@ -836,30 +1057,35 @@ def create_payment_gateway_account(gateway, payment_channel="Email"): return # if payment gateway account exists, return - if frappe.db.exists("Payment Gateway Account", - {"payment_gateway": gateway, "currency": bank_account.account_currency}): + if frappe.db.exists( + "Payment Gateway Account", + {"payment_gateway": gateway, "currency": bank_account.account_currency}, + ): return try: - frappe.get_doc({ - "doctype": "Payment Gateway Account", - "is_default": 1, - "payment_gateway": gateway, - "payment_account": bank_account.name, - "currency": bank_account.account_currency, - "payment_channel": payment_channel - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Payment Gateway Account", + "is_default": 1, + "payment_gateway": gateway, + "payment_account": bank_account.name, + "currency": bank_account.account_currency, + "payment_channel": payment_channel, + } + ).insert(ignore_permissions=True) except frappe.DuplicateEntryError: # already exists, due to a reinstall? pass + @frappe.whitelist() def update_cost_center(docname, cost_center_name, cost_center_number, company, merge): - ''' - Renames the document by adding the number as a prefix to the current name and updates - all transaction where it was present. - ''' + """ + Renames the document by adding the number as a prefix to the current name and updates + all transaction where it was present. + """ validate_field_number("Cost Center", docname, cost_center_number, company, "cost_center_number") if cost_center_number: @@ -874,8 +1100,9 @@ def update_cost_center(docname, cost_center_name, cost_center_number, company, m frappe.rename_doc("Cost Center", docname, new_name, force=1, merge=merge) return new_name + def validate_field_number(doctype_name, docname, number_value, company, field_name): - ''' Validate if the number entered isn't already assigned to some other document. ''' + """Validate if the number entered isn't already assigned to some other document.""" if number_value: filters = {field_name: number_value, "name": ["!=", docname]} if company: @@ -884,20 +1111,25 @@ def validate_field_number(doctype_name, docname, number_value, company, field_na doctype_with_same_number = frappe.db.get_value(doctype_name, filters) if doctype_with_same_number: - frappe.throw(_("{0} Number {1} is already used in {2} {3}") - .format(doctype_name, number_value, doctype_name.lower(), doctype_with_same_number)) + frappe.throw( + _("{0} Number {1} is already used in {2} {3}").format( + doctype_name, number_value, doctype_name.lower(), doctype_with_same_number + ) + ) + def get_autoname_with_number(number_value, doc_title, name, company): - ''' append title with prefix as number and suffix as company's abbreviation separated by '-' ''' + """append title with prefix as number and suffix as company's abbreviation separated by '-'""" if name: - name_split=name.split("-") - parts = [doc_title.strip(), name_split[len(name_split)-1].strip()] + name_split = name.split("-") + parts = [doc_title.strip(), name_split[len(name_split) - 1].strip()] else: - abbr = frappe.get_cached_value('Company', company, ["abbr"], as_dict=True) + abbr = frappe.get_cached_value("Company", company, ["abbr"], as_dict=True) parts = [doc_title.strip(), abbr.abbr] if cstr(number_value).strip(): parts.insert(0, cstr(number_value).strip()) - return ' - '.join(parts) + return " - ".join(parts) + @frappe.whitelist() def get_coa(doctype, parent, is_root, chart=None): @@ -909,43 +1141,108 @@ def get_coa(doctype, parent, is_root, chart=None): chart = chart if chart else frappe.flags.chart frappe.flags.chart = chart - parent = None if parent==_('All Accounts') else parent - accounts = build_tree_from_json(chart) # returns alist of dict in a tree render-able form + parent = None if parent == _("All Accounts") else parent + accounts = build_tree_from_json(chart) # returns alist of dict in a tree render-able form # filter out to show data for the selected node only - accounts = [d for d in accounts if d['parent_account']==parent] + accounts = [d for d in accounts if d["parent_account"] == parent] return accounts -def update_gl_entries_after(posting_date, posting_time, for_warehouses=None, for_items=None, - warehouse_account=None, company=None): - stock_vouchers = get_future_stock_vouchers(posting_date, posting_time, for_warehouses, for_items, company) + +def update_gl_entries_after( + posting_date, + posting_time, + for_warehouses=None, + for_items=None, + warehouse_account=None, + company=None, +): + stock_vouchers = get_future_stock_vouchers( + posting_date, posting_time, for_warehouses, for_items, company + ) repost_gle_for_stock_vouchers(stock_vouchers, posting_date, company, warehouse_account) -def repost_gle_for_stock_vouchers(stock_vouchers, posting_date, company=None, warehouse_account=None): - def _delete_gl_entries(voucher_type, voucher_no): - frappe.db.sql("""delete from `tabGL Entry` - where voucher_type=%s and voucher_no=%s""", (voucher_type, voucher_no)) +def repost_gle_for_stock_vouchers( + stock_vouchers: List[Tuple[str, str]], + posting_date: str, + company: Optional[str] = None, + warehouse_account=None, + repost_doc: Optional["RepostItemValuation"] = None, +): + if not stock_vouchers: + return if not warehouse_account: warehouse_account = get_warehouse_account_map(company) precision = get_field_precision(frappe.get_meta("GL Entry").get_field("debit")) or 2 - gle = get_voucherwise_gl_entries(stock_vouchers, posting_date) - for voucher_type, voucher_no in stock_vouchers: - existing_gle = gle.get((voucher_type, voucher_no), []) - voucher_obj = frappe.get_cached_doc(voucher_type, voucher_no) - expected_gle = voucher_obj.get_gl_entries(warehouse_account) - if expected_gle: - if not existing_gle or not compare_existing_and_expected_gle(existing_gle, expected_gle, precision): - _delete_gl_entries(voucher_type, voucher_no) - voucher_obj.make_gl_entries(gl_entries=expected_gle, from_repost=True) - else: - _delete_gl_entries(voucher_type, voucher_no) + stock_vouchers = sort_stock_vouchers_by_posting_date(stock_vouchers) + if repost_doc and repost_doc.gl_reposting_index: + # Restore progress + stock_vouchers = stock_vouchers[cint(repost_doc.gl_reposting_index) :] -def get_future_stock_vouchers(posting_date, posting_time, for_warehouses=None, for_items=None, company=None): + for stock_vouchers_chunk in create_batch(stock_vouchers, GL_REPOSTING_CHUNK): + gle = get_voucherwise_gl_entries(stock_vouchers_chunk, posting_date) + for voucher_type, voucher_no in stock_vouchers_chunk: + existing_gle = gle.get((voucher_type, voucher_no), []) + voucher_obj = frappe.get_doc(voucher_type, voucher_no) + expected_gle = voucher_obj.get_gl_entries(warehouse_account) + if expected_gle: + if not existing_gle or not compare_existing_and_expected_gle( + existing_gle, expected_gle, precision + ): + _delete_gl_entries(voucher_type, voucher_no) + voucher_obj.make_gl_entries(gl_entries=expected_gle, from_repost=True) + else: + _delete_gl_entries(voucher_type, voucher_no) + + if not frappe.flags.in_test: + frappe.db.commit() + + if repost_doc: + repost_doc.db_set( + "gl_reposting_index", cint(repost_doc.gl_reposting_index) + len(stock_vouchers_chunk) + ) + + +def _delete_gl_entries(voucher_type, voucher_no): + frappe.db.sql( + """delete from `tabGL Entry` + where voucher_type=%s and voucher_no=%s""", + (voucher_type, voucher_no), + ) + + +def sort_stock_vouchers_by_posting_date( + stock_vouchers: List[Tuple[str, str]] +) -> List[Tuple[str, str]]: + sle = frappe.qb.DocType("Stock Ledger Entry") + voucher_nos = [v[1] for v in stock_vouchers] + + sles = ( + frappe.qb.from_(sle) + .select(sle.voucher_type, sle.voucher_no, sle.posting_date, sle.posting_time, sle.creation) + .where((sle.is_cancelled == 0) & (sle.voucher_no.isin(voucher_nos))) + .groupby(sle.voucher_type, sle.voucher_no) + .orderby(sle.posting_date) + .orderby(sle.posting_time) + .orderby(sle.creation) + ).run(as_dict=True) + sorted_vouchers = [(sle.voucher_type, sle.voucher_no) for sle in sles] + + unknown_vouchers = set(stock_vouchers) - set(sorted_vouchers) + if unknown_vouchers: + sorted_vouchers.extend(unknown_vouchers) + + return sorted_vouchers + + +def get_future_stock_vouchers( + posting_date, posting_time, for_warehouses=None, for_items=None, company=None +): values = [] condition = "" @@ -961,25 +1258,31 @@ def get_future_stock_vouchers(posting_date, posting_time, for_warehouses=None, f condition += " and company = %s" values.append(company) - future_stock_vouchers = frappe.db.sql("""select distinct sle.voucher_type, sle.voucher_no + future_stock_vouchers = frappe.db.sql( + """select distinct sle.voucher_type, sle.voucher_no from `tabStock Ledger Entry` sle where timestamp(sle.posting_date, sle.posting_time) >= timestamp(%s, %s) and is_cancelled = 0 {condition} - order by timestamp(sle.posting_date, sle.posting_time) asc, creation asc for update""".format(condition=condition), - tuple([posting_date, posting_time] + values), as_dict=True) + order by timestamp(sle.posting_date, sle.posting_time) asc, creation asc for update""".format( + condition=condition + ), + tuple([posting_date, posting_time] + values), + as_dict=True, + ) return [(d.voucher_type, d.voucher_no) for d in future_stock_vouchers] + def get_voucherwise_gl_entries(future_stock_vouchers, posting_date): - """ Get voucherwise list of GL entries. + """Get voucherwise list of GL entries. Only fetches GLE fields required for comparing with new GLE. Check compare_existing_and_expected_gle function below. returns: - Dict[Tuple[voucher_type, voucher_no], List[GL Entries]] + Dict[Tuple[voucher_type, voucher_no], List[GL Entries]] """ gl_entries = {} if not future_stock_vouchers: @@ -987,19 +1290,23 @@ def get_voucherwise_gl_entries(future_stock_vouchers, posting_date): voucher_nos = [d[1] for d in future_stock_vouchers] - gles = frappe.db.sql(""" + gles = frappe.db.sql( + """ select name, account, credit, debit, cost_center, project, voucher_type, voucher_no from `tabGL Entry` where - posting_date >= %s and voucher_no in (%s)""" % - ('%s', ', '.join(['%s'] * len(voucher_nos))), - tuple([posting_date] + voucher_nos), as_dict=1) + posting_date >= %s and voucher_no in (%s)""" + % ("%s", ", ".join(["%s"] * len(voucher_nos))), + tuple([posting_date] + voucher_nos), + as_dict=1, + ) for d in gles: gl_entries.setdefault((d.voucher_type, d.voucher_no), []).append(d) return gl_entries + def compare_existing_and_expected_gle(existing_gle, expected_gle, precision): if len(existing_gle) != len(expected_gle): return False @@ -1010,10 +1317,14 @@ def compare_existing_and_expected_gle(existing_gle, expected_gle, precision): for e in existing_gle: if entry.account == e.account: account_existed = True - if (entry.account == e.account - and (not entry.cost_center or not e.cost_center or entry.cost_center == e.cost_center) - and ( flt(entry.debit, precision) != flt(e.debit, precision) or - flt(entry.credit, precision) != flt(e.credit, precision))): + if ( + entry.account == e.account + and (not entry.cost_center or not e.cost_center or entry.cost_center == e.cost_center) + and ( + flt(entry.debit, precision) != flt(e.debit, precision) + or flt(entry.credit, precision) != flt(e.credit, precision) + ) + ): matched = False break if not account_existed: @@ -1021,69 +1332,51 @@ def compare_existing_and_expected_gle(existing_gle, expected_gle, precision): break return matched -def check_if_stock_and_account_balance_synced(posting_date, company, voucher_type=None, voucher_no=None): - if not cint(erpnext.is_perpetual_inventory_enabled(company)): - return - - accounts = get_stock_accounts(company, voucher_type, voucher_no) - stock_adjustment_account = frappe.db.get_value("Company", company, "stock_adjustment_account") - - for account in accounts: - account_bal, stock_bal, warehouse_list = get_stock_and_account_balance(account, - posting_date, company) - - if abs(account_bal - stock_bal) > 0.1: - precision = get_field_precision(frappe.get_meta("GL Entry").get_field("debit"), - currency=frappe.get_cached_value('Company', company, "default_currency")) - - diff = flt(stock_bal - account_bal, precision) - - error_reason = _("Stock Value ({0}) and Account Balance ({1}) are out of sync for account {2} and it's linked warehouses as on {3}.").format( - stock_bal, account_bal, frappe.bold(account), posting_date) - error_resolution = _("Please create an adjustment Journal Entry for amount {0} on {1}")\ - .format(frappe.bold(diff), frappe.bold(posting_date)) - - frappe.msgprint( - msg="""{0}
{1}
""".format(error_reason, error_resolution), - raise_exception=StockValueAndAccountBalanceOutOfSync, - title=_('Values Out Of Sync'), - primary_action={ - 'label': _('Make Journal Entry'), - 'client_action': 'erpnext.route_to_adjustment_jv', - 'args': get_journal_entry(account, stock_adjustment_account, diff) - }) def get_stock_accounts(company, voucher_type=None, voucher_no=None): - stock_accounts = [d.name for d in frappe.db.get_all("Account", { - "account_type": "Stock", - "company": company, - "is_group": 0 - })] + stock_accounts = [ + d.name + for d in frappe.db.get_all( + "Account", {"account_type": "Stock", "company": company, "is_group": 0} + ) + ] if voucher_type and voucher_no: if voucher_type == "Journal Entry": - stock_accounts = [d.account for d in frappe.db.get_all("Journal Entry Account", { - "parent": voucher_no, - "account": ["in", stock_accounts] - }, "account")] + stock_accounts = [ + d.account + for d in frappe.db.get_all( + "Journal Entry Account", {"parent": voucher_no, "account": ["in", stock_accounts]}, "account" + ) + ] else: - stock_accounts = [d.account for d in frappe.db.get_all("GL Entry", { - "voucher_type": voucher_type, - "voucher_no": voucher_no, - "account": ["in", stock_accounts] - }, "account")] + stock_accounts = [ + d.account + for d in frappe.db.get_all( + "GL Entry", + {"voucher_type": voucher_type, "voucher_no": voucher_no, "account": ["in", stock_accounts]}, + "account", + ) + ] return stock_accounts + def get_stock_and_account_balance(account=None, posting_date=None, company=None): - if not posting_date: posting_date = nowdate() + if not posting_date: + posting_date = nowdate() warehouse_account = get_warehouse_account_map(company) - account_balance = get_balance_on(account, posting_date, in_account_currency=False, ignore_account_permission=True) + account_balance = get_balance_on( + account, posting_date, in_account_currency=False, ignore_account_permission=True + ) - related_warehouses = [wh for wh, wh_details in warehouse_account.items() - if wh_details.account == account and not wh_details.is_group] + related_warehouses = [ + wh + for wh, wh_details in warehouse_account.items() + if wh_details.account == account and not wh_details.is_group + ] total_stock_value = 0.0 for warehouse in related_warehouses: @@ -1093,27 +1386,26 @@ def get_stock_and_account_balance(account=None, posting_date=None, company=None) precision = frappe.get_precision("Journal Entry Account", "debit_in_account_currency") return flt(account_balance, precision), flt(total_stock_value, precision), related_warehouses + def get_journal_entry(account, stock_adjustment_account, amount): - db_or_cr_warehouse_account =('credit_in_account_currency' if amount < 0 else 'debit_in_account_currency') - db_or_cr_stock_adjustment_account = ('debit_in_account_currency' if amount < 0 else 'credit_in_account_currency') + db_or_cr_warehouse_account = ( + "credit_in_account_currency" if amount < 0 else "debit_in_account_currency" + ) + db_or_cr_stock_adjustment_account = ( + "debit_in_account_currency" if amount < 0 else "credit_in_account_currency" + ) return { - 'accounts':[{ - 'account': account, - db_or_cr_warehouse_account: abs(amount) - }, { - 'account': stock_adjustment_account, - db_or_cr_stock_adjustment_account : abs(amount) - }] + "accounts": [ + {"account": account, db_or_cr_warehouse_account: abs(amount)}, + {"account": stock_adjustment_account, db_or_cr_stock_adjustment_account: abs(amount)}, + ] } + def check_and_delete_linked_reports(report): - """ Check if reports are referenced in Desktop Icon """ - icons = frappe.get_all("Desktop Icon", - fields = ['name'], - filters = { - "_report": report - }) + """Check if reports are referenced in Desktop Icon""" + icons = frappe.get_all("Desktop Icon", fields=["name"], filters={"_report": report}) if icons: for icon in icons: frappe.delete_doc("Desktop Icon", icon) diff --git a/erpnext/agriculture/doctype/crop/crop.py b/erpnext/agriculture/doctype/crop/crop.py index ed2073cebf8..b2a193a2c17 100644 --- a/erpnext/agriculture/doctype/crop/crop.py +++ b/erpnext/agriculture/doctype/crop/crop.py @@ -27,5 +27,5 @@ class Crop(Document): @frappe.whitelist() def get_item_details(item_code): - item = frappe.get_doc('Item', item_code) + item = frappe.get_doc("Item", item_code) return {"uom": item.stock_uom, "rate": item.valuation_rate} diff --git a/erpnext/agriculture/doctype/crop/crop_dashboard.py b/erpnext/agriculture/doctype/crop/crop_dashboard.py index 772ed611373..1b975e17a6f 100644 --- a/erpnext/agriculture/doctype/crop/crop_dashboard.py +++ b/erpnext/agriculture/doctype/crop/crop_dashboard.py @@ -1,13 +1,5 @@ - from frappe import _ def get_data(): - return { - 'transactions': [ - { - 'label': _('Crop Cycle'), - 'items': ['Crop Cycle'] - } - ] - } + return {"transactions": [{"label": _("Crop Cycle"), "items": ["Crop Cycle"]}]} diff --git a/erpnext/agriculture/doctype/crop/test_crop.py b/erpnext/agriculture/doctype/crop/test_crop.py index c79a3672199..3859ebc7764 100644 --- a/erpnext/agriculture/doctype/crop/test_crop.py +++ b/erpnext/agriculture/doctype/crop/test_crop.py @@ -7,7 +7,8 @@ import frappe test_dependencies = ["Fertilizer"] + class TestCrop(unittest.TestCase): def test_crop_period(self): - basil = frappe.get_doc('Crop', 'Basil from seed') + basil = frappe.get_doc("Crop", "Basil from seed") self.assertEqual(basil.period, 15) diff --git a/erpnext/agriculture/doctype/crop_cycle/crop_cycle.py b/erpnext/agriculture/doctype/crop_cycle/crop_cycle.py index 43c5bbde82f..470d900310d 100644 --- a/erpnext/agriculture/doctype/crop_cycle/crop_cycle.py +++ b/erpnext/agriculture/doctype/crop_cycle/crop_cycle.py @@ -22,7 +22,7 @@ class CropCycle(Document): self.create_tasks_for_diseases() def set_missing_values(self): - crop = frappe.get_doc('Crop', self.crop) + crop = frappe.get_doc("Crop", self.crop) if not self.crop_spacing_uom: self.crop_spacing_uom = crop.crop_spacing_uom @@ -31,7 +31,7 @@ class CropCycle(Document): self.row_spacing_uom = crop.row_spacing_uom def create_crop_cycle_project(self): - crop = frappe.get_doc('Crop', self.crop) + crop = frappe.get_doc("Crop", self.crop) self.project = self.create_project(crop.period, crop.agriculture_task) self.create_task(crop.agriculture_task, self.project, self.start_date) @@ -42,49 +42,56 @@ class CropCycle(Document): self.import_disease_tasks(disease.disease, disease.start_date) disease.tasks_created = True - frappe.msgprint(_("Tasks have been created for managing the {0} disease (on row {1})").format(disease.disease, disease.idx)) + frappe.msgprint( + _("Tasks have been created for managing the {0} disease (on row {1})").format( + disease.disease, disease.idx + ) + ) def import_disease_tasks(self, disease, start_date): - disease_doc = frappe.get_doc('Disease', disease) + disease_doc = frappe.get_doc("Disease", disease) self.create_task(disease_doc.treatment_task, self.project, start_date) def create_project(self, period, crop_tasks): - project = frappe.get_doc({ - "doctype": "Project", - "project_name": self.title, - "expected_start_date": self.start_date, - "expected_end_date": add_days(self.start_date, period - 1) - }).insert() + project = frappe.get_doc( + { + "doctype": "Project", + "project_name": self.title, + "expected_start_date": self.start_date, + "expected_end_date": add_days(self.start_date, period - 1), + } + ).insert() return project.name def create_task(self, crop_tasks, project_name, start_date): for crop_task in crop_tasks: - frappe.get_doc({ - "doctype": "Task", - "subject": crop_task.get("task_name"), - "priority": crop_task.get("priority"), - "project": project_name, - "exp_start_date": add_days(start_date, crop_task.get("start_day") - 1), - "exp_end_date": add_days(start_date, crop_task.get("end_day") - 1) - }).insert() + frappe.get_doc( + { + "doctype": "Task", + "subject": crop_task.get("task_name"), + "priority": crop_task.get("priority"), + "project": project_name, + "exp_start_date": add_days(start_date, crop_task.get("start_day") - 1), + "exp_end_date": add_days(start_date, crop_task.get("end_day") - 1), + } + ).insert() @frappe.whitelist() def reload_linked_analysis(self): - linked_doctypes = ['Soil Texture', 'Soil Analysis', 'Plant Analysis'] - required_fields = ['location', 'name', 'collection_datetime'] + linked_doctypes = ["Soil Texture", "Soil Analysis", "Plant Analysis"] + required_fields = ["location", "name", "collection_datetime"] output = {} for doctype in linked_doctypes: output[doctype] = frappe.get_all(doctype, fields=required_fields) - output['Location'] = [] + output["Location"] = [] for location in self.linked_location: - output['Location'].append(frappe.get_doc('Location', location.location)) + output["Location"].append(frappe.get_doc("Location", location.location)) - frappe.publish_realtime("List of Linked Docs", - output, user=frappe.session.user) + frappe.publish_realtime("List of Linked Docs", output, user=frappe.session.user) @frappe.whitelist() def append_to_child(self, obj_to_append): @@ -96,11 +103,11 @@ class CropCycle(Document): def get_coordinates(doc): - return ast.literal_eval(doc.location).get('features')[0].get('geometry').get('coordinates') + return ast.literal_eval(doc.location).get("features")[0].get("geometry").get("coordinates") def get_geometry_type(doc): - return ast.literal_eval(doc.location).get('features')[0].get('geometry').get('type') + return ast.literal_eval(doc.location).get("features")[0].get("geometry").get("type") def is_in_location(point, vs): @@ -114,8 +121,7 @@ def is_in_location(point, vs): xi, yi = vs[i] xj, yj = vs[j] - intersect = ((yi > y) != (yj > y)) and ( - x < (xj - xi) * (y - yi) / (yj - yi) + xi) + intersect = ((yi > y) != (yj > y)) and (x < (xj - xi) * (y - yi) / (yj - yi) + xi) if intersect: inside = not inside diff --git a/erpnext/agriculture/doctype/crop_cycle/test_crop_cycle.py b/erpnext/agriculture/doctype/crop_cycle/test_crop_cycle.py index e4765a57c0b..2b494f8476e 100644 --- a/erpnext/agriculture/doctype/crop_cycle/test_crop_cycle.py +++ b/erpnext/agriculture/doctype/crop_cycle/test_crop_cycle.py @@ -11,8 +11,8 @@ test_dependencies = ["Crop", "Fertilizer", "Location", "Disease"] class TestCropCycle(unittest.TestCase): def test_crop_cycle_creation(self): - cycle = frappe.get_doc('Crop Cycle', 'Basil from seed 2017') - self.assertTrue(frappe.db.exists('Crop Cycle', 'Basil from seed 2017')) + cycle = frappe.get_doc("Crop Cycle", "Basil from seed 2017") + self.assertTrue(frappe.db.exists("Crop Cycle", "Basil from seed 2017")) # check if the tasks were created self.assertEqual(check_task_creation(), True) @@ -23,45 +23,48 @@ def check_task_creation(): all_task_dict = { "Survey and find the aphid locations": { "exp_start_date": datetime.date(2017, 11, 21), - "exp_end_date": datetime.date(2017, 11, 22) + "exp_end_date": datetime.date(2017, 11, 22), }, "Apply Pesticides": { "exp_start_date": datetime.date(2017, 11, 23), - "exp_end_date": datetime.date(2017, 11, 23) + "exp_end_date": datetime.date(2017, 11, 23), }, "Plough the field": { "exp_start_date": datetime.date(2017, 11, 11), - "exp_end_date": datetime.date(2017, 11, 11) + "exp_end_date": datetime.date(2017, 11, 11), }, "Plant the seeds": { "exp_start_date": datetime.date(2017, 11, 12), - "exp_end_date": datetime.date(2017, 11, 13) + "exp_end_date": datetime.date(2017, 11, 13), }, "Water the field": { "exp_start_date": datetime.date(2017, 11, 14), - "exp_end_date": datetime.date(2017, 11, 14) + "exp_end_date": datetime.date(2017, 11, 14), }, "First harvest": { "exp_start_date": datetime.date(2017, 11, 18), - "exp_end_date": datetime.date(2017, 11, 18) + "exp_end_date": datetime.date(2017, 11, 18), }, "Add the fertilizer": { "exp_start_date": datetime.date(2017, 11, 20), - "exp_end_date": datetime.date(2017, 11, 22) + "exp_end_date": datetime.date(2017, 11, 22), }, "Final cut": { "exp_start_date": datetime.date(2017, 11, 25), - "exp_end_date": datetime.date(2017, 11, 25) - } + "exp_end_date": datetime.date(2017, 11, 25), + }, } - all_tasks = frappe.get_all('Task') + all_tasks = frappe.get_all("Task") for task in all_tasks: - sample_task = frappe.get_doc('Task', task.name) + sample_task = frappe.get_doc("Task", task.name) if sample_task.subject in list(all_task_dict): - if sample_task.exp_start_date != all_task_dict[sample_task.subject]['exp_start_date'] or sample_task.exp_end_date != all_task_dict[sample_task.subject]['exp_end_date']: + if ( + sample_task.exp_start_date != all_task_dict[sample_task.subject]["exp_start_date"] + or sample_task.exp_end_date != all_task_dict[sample_task.subject]["exp_end_date"] + ): return False all_task_dict.pop(sample_task.subject) @@ -69,4 +72,4 @@ def check_task_creation(): def check_project_creation(): - return True if frappe.db.exists('Project', {'project_name': 'Basil from seed 2017'}) else False + return True if frappe.db.exists("Project", {"project_name": "Basil from seed 2017"}) else False diff --git a/erpnext/agriculture/doctype/disease/disease.py b/erpnext/agriculture/doctype/disease/disease.py index 30ab298376a..dfab47895ef 100644 --- a/erpnext/agriculture/doctype/disease/disease.py +++ b/erpnext/agriculture/doctype/disease/disease.py @@ -15,5 +15,6 @@ class Disease(Document): if task.start_day > task.end_day: frappe.throw(_("Start day is greater than end day in task '{0}'").format(task.task_name)) # to calculate the period of the Crop Cycle - if task.end_day > max_period: max_period = task.end_day + if task.end_day > max_period: + max_period = task.end_day self.treatment_period = max_period diff --git a/erpnext/agriculture/doctype/disease/test_disease.py b/erpnext/agriculture/doctype/disease/test_disease.py index 6a6f1e70a94..f6eda359983 100644 --- a/erpnext/agriculture/doctype/disease/test_disease.py +++ b/erpnext/agriculture/doctype/disease/test_disease.py @@ -8,5 +8,5 @@ import frappe class TestDisease(unittest.TestCase): def test_treatment_period(self): - disease = frappe.get_doc('Disease', 'Aphids') + disease = frappe.get_doc("Disease", "Aphids") self.assertEqual(disease.treatment_period, 3) diff --git a/erpnext/agriculture/doctype/fertilizer/fertilizer.py b/erpnext/agriculture/doctype/fertilizer/fertilizer.py index 2408302bd18..1796d240ec1 100644 --- a/erpnext/agriculture/doctype/fertilizer/fertilizer.py +++ b/erpnext/agriculture/doctype/fertilizer/fertilizer.py @@ -9,6 +9,6 @@ from frappe.model.document import Document class Fertilizer(Document): @frappe.whitelist() def load_contents(self): - docs = frappe.get_all("Agriculture Analysis Criteria", filters={'linked_doctype':'Fertilizer'}) + docs = frappe.get_all("Agriculture Analysis Criteria", filters={"linked_doctype": "Fertilizer"}) for doc in docs: - self.append('fertilizer_contents', {'title': str(doc.name)}) + self.append("fertilizer_contents", {"title": str(doc.name)}) diff --git a/erpnext/agriculture/doctype/fertilizer/test_fertilizer.py b/erpnext/agriculture/doctype/fertilizer/test_fertilizer.py index c8630ef1f87..aa6d96ce6cd 100644 --- a/erpnext/agriculture/doctype/fertilizer/test_fertilizer.py +++ b/erpnext/agriculture/doctype/fertilizer/test_fertilizer.py @@ -8,4 +8,4 @@ import frappe class TestFertilizer(unittest.TestCase): def test_fertilizer_creation(self): - self.assertEqual(frappe.db.exists('Fertilizer', 'Urea'), 'Urea') + self.assertEqual(frappe.db.exists("Fertilizer", "Urea"), "Urea") diff --git a/erpnext/agriculture/doctype/plant_analysis/plant_analysis.py b/erpnext/agriculture/doctype/plant_analysis/plant_analysis.py index 9a939cde0b4..5f2d46fa048 100644 --- a/erpnext/agriculture/doctype/plant_analysis/plant_analysis.py +++ b/erpnext/agriculture/doctype/plant_analysis/plant_analysis.py @@ -9,6 +9,8 @@ from frappe.model.document import Document class PlantAnalysis(Document): @frappe.whitelist() def load_contents(self): - docs = frappe.get_all("Agriculture Analysis Criteria", filters={'linked_doctype':'Plant Analysis'}) + docs = frappe.get_all( + "Agriculture Analysis Criteria", filters={"linked_doctype": "Plant Analysis"} + ) for doc in docs: - self.append('plant_analysis_criteria', {'title': str(doc.name)}) + self.append("plant_analysis_criteria", {"title": str(doc.name)}) diff --git a/erpnext/agriculture/doctype/soil_analysis/soil_analysis.py b/erpnext/agriculture/doctype/soil_analysis/soil_analysis.py index 03667fbcae9..0017b56546e 100644 --- a/erpnext/agriculture/doctype/soil_analysis/soil_analysis.py +++ b/erpnext/agriculture/doctype/soil_analysis/soil_analysis.py @@ -9,6 +9,8 @@ from frappe.model.document import Document class SoilAnalysis(Document): @frappe.whitelist() def load_contents(self): - docs = frappe.get_all("Agriculture Analysis Criteria", filters={'linked_doctype':'Soil Analysis'}) + docs = frappe.get_all( + "Agriculture Analysis Criteria", filters={"linked_doctype": "Soil Analysis"} + ) for doc in docs: - self.append('soil_analysis_criteria', {'title': str(doc.name)}) + self.append("soil_analysis_criteria", {"title": str(doc.name)}) diff --git a/erpnext/agriculture/doctype/soil_texture/soil_texture.py b/erpnext/agriculture/doctype/soil_texture/soil_texture.py index b1fc9a063d0..94e031db052 100644 --- a/erpnext/agriculture/doctype/soil_texture/soil_texture.py +++ b/erpnext/agriculture/doctype/soil_texture/soil_texture.py @@ -10,62 +10,74 @@ from frappe.utils import cint, flt class SoilTexture(Document): soil_edit_order = [2, 1, 0] - soil_types = ['clay_composition', 'sand_composition', 'silt_composition'] + soil_types = ["clay_composition", "sand_composition", "silt_composition"] @frappe.whitelist() def load_contents(self): - docs = frappe.get_all("Agriculture Analysis Criteria", filters={'linked_doctype':'Soil Texture'}) + docs = frappe.get_all( + "Agriculture Analysis Criteria", filters={"linked_doctype": "Soil Texture"} + ) for doc in docs: - self.append('soil_texture_criteria', {'title': str(doc.name)}) + self.append("soil_texture_criteria", {"title": str(doc.name)}) def validate(self): - self.update_soil_edit('sand_composition') + self.update_soil_edit("sand_composition") for soil_type in self.soil_types: if self.get(soil_type) > 100 or self.get(soil_type) < 0: frappe.throw(_("{0} should be a value between 0 and 100").format(soil_type)) if sum(self.get(soil_type) for soil_type in self.soil_types) != 100: - frappe.throw(_('Soil compositions do not add up to 100')) + frappe.throw(_("Soil compositions do not add up to 100")) @frappe.whitelist() def update_soil_edit(self, soil_type): - self.soil_edit_order[self.soil_types.index(soil_type)] = max(self.soil_edit_order)+1 + self.soil_edit_order[self.soil_types.index(soil_type)] = max(self.soil_edit_order) + 1 self.soil_type = self.get_soil_type() def get_soil_type(self): # update the last edited soil type - if sum(self.soil_edit_order) < 5: return + if sum(self.soil_edit_order) < 5: + return last_edit_index = self.soil_edit_order.index(min(self.soil_edit_order)) # set composition of the last edited soil - self.set(self.soil_types[last_edit_index], - 100 - sum(cint(self.get(soil_type)) for soil_type in self.soil_types) + cint(self.get(self.soil_types[last_edit_index]))) + self.set( + self.soil_types[last_edit_index], + 100 + - sum(cint(self.get(soil_type)) for soil_type in self.soil_types) + + cint(self.get(self.soil_types[last_edit_index])), + ) # calculate soil type c, sa, si = flt(self.clay_composition), flt(self.sand_composition), flt(self.silt_composition) if si + (1.5 * c) < 15: - return 'Sand' + return "Sand" elif si + 1.5 * c >= 15 and si + 2 * c < 30: - return 'Loamy Sand' - elif ((c >= 7 and c < 20) or (sa > 52) and ((si + 2*c) >= 30) or (c < 7 and si < 50 and (si+2*c) >= 30)): - return 'Sandy Loam' - elif ((c >= 7 and c < 27) and (si >= 28 and si < 50) and (sa <= 52)): - return 'Loam' - elif ((si >= 50 and (c >= 12 and c < 27)) or ((si >= 50 and si < 80) and c < 12)): - return 'Silt Loam' - elif (si >= 80 and c < 12): - return 'Silt' - elif ((c >= 20 and c < 35) and (si < 28) and (sa > 45)): - return 'Sandy Clay Loam' - elif ((c >= 27 and c < 40) and (sa > 20 and sa <= 45)): - return 'Clay Loam' - elif ((c >= 27 and c < 40) and (sa <= 20)): - return 'Silty Clay Loam' - elif (c >= 35 and sa > 45): - return 'Sandy Clay' - elif (c >= 40 and si >= 40): - return 'Silty Clay' - elif (c >= 40 and sa <= 45 and si < 40): - return 'Clay' + return "Loamy Sand" + elif ( + (c >= 7 and c < 20) + or (sa > 52) + and ((si + 2 * c) >= 30) + or (c < 7 and si < 50 and (si + 2 * c) >= 30) + ): + return "Sandy Loam" + elif (c >= 7 and c < 27) and (si >= 28 and si < 50) and (sa <= 52): + return "Loam" + elif (si >= 50 and (c >= 12 and c < 27)) or ((si >= 50 and si < 80) and c < 12): + return "Silt Loam" + elif si >= 80 and c < 12: + return "Silt" + elif (c >= 20 and c < 35) and (si < 28) and (sa > 45): + return "Sandy Clay Loam" + elif (c >= 27 and c < 40) and (sa > 20 and sa <= 45): + return "Clay Loam" + elif (c >= 27 and c < 40) and (sa <= 20): + return "Silty Clay Loam" + elif c >= 35 and sa > 45: + return "Sandy Clay" + elif c >= 40 and si >= 40: + return "Silty Clay" + elif c >= 40 and sa <= 45 and si < 40: + return "Clay" else: - return 'Select' + return "Select" diff --git a/erpnext/agriculture/doctype/soil_texture/test_soil_texture.py b/erpnext/agriculture/doctype/soil_texture/test_soil_texture.py index 45497675cec..7233ea96e2a 100644 --- a/erpnext/agriculture/doctype/soil_texture/test_soil_texture.py +++ b/erpnext/agriculture/doctype/soil_texture/test_soil_texture.py @@ -8,7 +8,9 @@ import frappe class TestSoilTexture(unittest.TestCase): def test_texture_selection(self): - soil_tex = frappe.get_all('Soil Texture', fields=['name'], filters={'collection_datetime': '2017-11-08'}) - doc = frappe.get_doc('Soil Texture', soil_tex[0].name) + soil_tex = frappe.get_all( + "Soil Texture", fields=["name"], filters={"collection_datetime": "2017-11-08"} + ) + doc = frappe.get_doc("Soil Texture", soil_tex[0].name) self.assertEqual(doc.silt_composition, 50) - self.assertEqual(doc.soil_type, 'Silt Loam') + self.assertEqual(doc.soil_type, "Silt Loam") diff --git a/erpnext/agriculture/doctype/water_analysis/water_analysis.py b/erpnext/agriculture/doctype/water_analysis/water_analysis.py index 434acecc6e3..b5fe48ad5bd 100644 --- a/erpnext/agriculture/doctype/water_analysis/water_analysis.py +++ b/erpnext/agriculture/doctype/water_analysis/water_analysis.py @@ -10,9 +10,11 @@ from frappe.model.document import Document class WaterAnalysis(Document): @frappe.whitelist() def load_contents(self): - docs = frappe.get_all("Agriculture Analysis Criteria", filters={'linked_doctype':'Water Analysis'}) + docs = frappe.get_all( + "Agriculture Analysis Criteria", filters={"linked_doctype": "Water Analysis"} + ) for doc in docs: - self.append('water_analysis_criteria', {'title': str(doc.name)}) + self.append("water_analysis_criteria", {"title": str(doc.name)}) @frappe.whitelist() def update_lab_result_date(self): @@ -21,6 +23,6 @@ class WaterAnalysis(Document): def validate(self): if self.collection_datetime > self.laboratory_testing_datetime: - frappe.throw(_('Lab testing datetime cannot be before collection datetime')) + frappe.throw(_("Lab testing datetime cannot be before collection datetime")) if self.laboratory_testing_datetime > self.result_datetime: - frappe.throw(_('Lab result datetime cannot be before testing datetime')) + frappe.throw(_("Lab result datetime cannot be before testing datetime")) diff --git a/erpnext/agriculture/doctype/weather/weather.py b/erpnext/agriculture/doctype/weather/weather.py index 8750709c564..082bf8b0fdf 100644 --- a/erpnext/agriculture/doctype/weather/weather.py +++ b/erpnext/agriculture/doctype/weather/weather.py @@ -9,6 +9,6 @@ from frappe.model.document import Document class Weather(Document): @frappe.whitelist() def load_contents(self): - docs = frappe.get_all("Agriculture Analysis Criteria", filters={'linked_doctype':'Weather'}) + docs = frappe.get_all("Agriculture Analysis Criteria", filters={"linked_doctype": "Weather"}) for doc in docs: - self.append('weather_parameter', {'title': str(doc.name)}) + self.append("weather_parameter", {"title": str(doc.name)}) diff --git a/erpnext/agriculture/setup.py b/erpnext/agriculture/setup.py index 433466bf1b7..ce1ecec0ad7 100644 --- a/erpnext/agriculture/setup.py +++ b/erpnext/agriculture/setup.py @@ -1,4 +1,3 @@ - import frappe from frappe import _ @@ -6,427 +5,493 @@ from erpnext.setup.utils import insert_record def setup_agriculture(): - if frappe.get_all('Agriculture Analysis Criteria'): + if frappe.get_all("Agriculture Analysis Criteria"): # already setup return create_agriculture_data() + def create_agriculture_data(): records = [ dict( - doctype='Item Group', - item_group_name='Fertilizer', + doctype="Item Group", + item_group_name="Fertilizer", is_group=0, - parent_item_group=_('All Item Groups')), + parent_item_group=_("All Item Groups"), + ), dict( - doctype='Item Group', - item_group_name='Seed', + doctype="Item Group", item_group_name="Seed", is_group=0, parent_item_group=_("All Item Groups") + ), + dict( + doctype="Item Group", + item_group_name="By-product", is_group=0, - parent_item_group=_('All Item Groups')), + parent_item_group=_("All Item Groups"), + ), dict( - doctype='Item Group', - item_group_name='By-product', + doctype="Item Group", + item_group_name="Produce", is_group=0, - parent_item_group=_('All Item Groups')), + parent_item_group=_("All Item Groups"), + ), dict( - doctype='Item Group', - item_group_name='Produce', - is_group=0, - parent_item_group=_('All Item Groups')), - dict( - doctype='Agriculture Analysis Criteria', - title='Nitrogen Content', + doctype="Agriculture Analysis Criteria", + title="Nitrogen Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Phosphorous Content', + doctype="Agriculture Analysis Criteria", + title="Phosphorous Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Potassium Content', + doctype="Agriculture Analysis Criteria", + title="Potassium Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Calcium Content', + doctype="Agriculture Analysis Criteria", + title="Calcium Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Sulphur Content', + doctype="Agriculture Analysis Criteria", + title="Sulphur Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Magnesium Content', + doctype="Agriculture Analysis Criteria", + title="Magnesium Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Iron Content', + doctype="Agriculture Analysis Criteria", + title="Iron Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Copper Content', + doctype="Agriculture Analysis Criteria", + title="Copper Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Zinc Content', + doctype="Agriculture Analysis Criteria", + title="Zinc Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Boron Content', + doctype="Agriculture Analysis Criteria", + title="Boron Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Manganese Content', + doctype="Agriculture Analysis Criteria", + title="Manganese Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Chlorine Content', + doctype="Agriculture Analysis Criteria", + title="Chlorine Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Molybdenum Content', + doctype="Agriculture Analysis Criteria", + title="Molybdenum Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Sodium Content', + doctype="Agriculture Analysis Criteria", + title="Sodium Content", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Humic Acid', + doctype="Agriculture Analysis Criteria", + title="Humic Acid", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Fulvic Acid', + doctype="Agriculture Analysis Criteria", + title="Fulvic Acid", standard=1, - linked_doctype='Fertilizer'), + linked_doctype="Fertilizer", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Inert', - standard=1, - linked_doctype='Fertilizer'), + doctype="Agriculture Analysis Criteria", title="Inert", standard=1, linked_doctype="Fertilizer" + ), dict( - doctype='Agriculture Analysis Criteria', - title='Others', - standard=1, - linked_doctype='Fertilizer'), + doctype="Agriculture Analysis Criteria", title="Others", standard=1, linked_doctype="Fertilizer" + ), dict( - doctype='Agriculture Analysis Criteria', - title='Nitrogen', + doctype="Agriculture Analysis Criteria", + title="Nitrogen", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Phosphorous', + doctype="Agriculture Analysis Criteria", + title="Phosphorous", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Potassium', + doctype="Agriculture Analysis Criteria", + title="Potassium", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Calcium', + doctype="Agriculture Analysis Criteria", + title="Calcium", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Magnesium', + doctype="Agriculture Analysis Criteria", + title="Magnesium", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Sulphur', + doctype="Agriculture Analysis Criteria", + title="Sulphur", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Boron', + doctype="Agriculture Analysis Criteria", + title="Boron", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Copper', + doctype="Agriculture Analysis Criteria", + title="Copper", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Iron', + doctype="Agriculture Analysis Criteria", + title="Iron", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Manganese', + doctype="Agriculture Analysis Criteria", + title="Manganese", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Zinc', + doctype="Agriculture Analysis Criteria", + title="Zinc", standard=1, - linked_doctype='Plant Analysis'), + linked_doctype="Plant Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Depth (in cm)', + doctype="Agriculture Analysis Criteria", + title="Depth (in cm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Soil pH', + doctype="Agriculture Analysis Criteria", + title="Soil pH", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Salt Concentration (%)', + doctype="Agriculture Analysis Criteria", + title="Salt Concentration (%)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Organic Matter (%)', + doctype="Agriculture Analysis Criteria", + title="Organic Matter (%)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='CEC (Cation Exchange Capacity) (MAQ/100mL)', + doctype="Agriculture Analysis Criteria", + title="CEC (Cation Exchange Capacity) (MAQ/100mL)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Potassium Saturation (%)', + doctype="Agriculture Analysis Criteria", + title="Potassium Saturation (%)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Calcium Saturation (%)', + doctype="Agriculture Analysis Criteria", + title="Calcium Saturation (%)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Manganese Saturation (%)', + doctype="Agriculture Analysis Criteria", + title="Manganese Saturation (%)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Nirtogen (ppm)', + doctype="Agriculture Analysis Criteria", + title="Nirtogen (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Phosphorous (ppm)', + doctype="Agriculture Analysis Criteria", + title="Phosphorous (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Potassium (ppm)', + doctype="Agriculture Analysis Criteria", + title="Potassium (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Calcium (ppm)', + doctype="Agriculture Analysis Criteria", + title="Calcium (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Magnesium (ppm)', + doctype="Agriculture Analysis Criteria", + title="Magnesium (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Sulphur (ppm)', + doctype="Agriculture Analysis Criteria", + title="Sulphur (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Copper (ppm)', + doctype="Agriculture Analysis Criteria", + title="Copper (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Iron (ppm)', + doctype="Agriculture Analysis Criteria", + title="Iron (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Manganese (ppm)', + doctype="Agriculture Analysis Criteria", + title="Manganese (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Zinc (ppm)', + doctype="Agriculture Analysis Criteria", + title="Zinc (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Aluminium (ppm)', + doctype="Agriculture Analysis Criteria", + title="Aluminium (ppm)", standard=1, - linked_doctype='Soil Analysis'), + linked_doctype="Soil Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Water pH', + doctype="Agriculture Analysis Criteria", + title="Water pH", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Conductivity (mS/cm)', + doctype="Agriculture Analysis Criteria", + title="Conductivity (mS/cm)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Hardness (mg/CaCO3)', + doctype="Agriculture Analysis Criteria", + title="Hardness (mg/CaCO3)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Turbidity (NTU)', + doctype="Agriculture Analysis Criteria", + title="Turbidity (NTU)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Odor', + doctype="Agriculture Analysis Criteria", + title="Odor", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Color', + doctype="Agriculture Analysis Criteria", + title="Color", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Nitrate (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Nitrate (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Nirtite (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Nirtite (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Calcium (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Calcium (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Magnesium (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Magnesium (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Sulphate (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Sulphate (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Boron (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Boron (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Copper (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Copper (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Iron (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Iron (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Manganese (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Manganese (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Zinc (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Zinc (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Chlorine (mg/L)', + doctype="Agriculture Analysis Criteria", + title="Chlorine (mg/L)", standard=1, - linked_doctype='Water Analysis'), + linked_doctype="Water Analysis", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Bulk Density', + doctype="Agriculture Analysis Criteria", + title="Bulk Density", standard=1, - linked_doctype='Soil Texture'), + linked_doctype="Soil Texture", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Field Capacity', + doctype="Agriculture Analysis Criteria", + title="Field Capacity", standard=1, - linked_doctype='Soil Texture'), + linked_doctype="Soil Texture", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Wilting Point', + doctype="Agriculture Analysis Criteria", + title="Wilting Point", standard=1, - linked_doctype='Soil Texture'), + linked_doctype="Soil Texture", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Hydraulic Conductivity', + doctype="Agriculture Analysis Criteria", + title="Hydraulic Conductivity", standard=1, - linked_doctype='Soil Texture'), + linked_doctype="Soil Texture", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Organic Matter', + doctype="Agriculture Analysis Criteria", + title="Organic Matter", standard=1, - linked_doctype='Soil Texture'), + linked_doctype="Soil Texture", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Temperature High', + doctype="Agriculture Analysis Criteria", + title="Temperature High", standard=1, - linked_doctype='Weather'), + linked_doctype="Weather", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Temperature Low', + doctype="Agriculture Analysis Criteria", + title="Temperature Low", standard=1, - linked_doctype='Weather'), + linked_doctype="Weather", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Temperature Average', + doctype="Agriculture Analysis Criteria", + title="Temperature Average", standard=1, - linked_doctype='Weather'), + linked_doctype="Weather", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Dew Point', - standard=1, - linked_doctype='Weather'), + doctype="Agriculture Analysis Criteria", title="Dew Point", standard=1, linked_doctype="Weather" + ), dict( - doctype='Agriculture Analysis Criteria', - title='Precipitation Received', + doctype="Agriculture Analysis Criteria", + title="Precipitation Received", standard=1, - linked_doctype='Weather'), + linked_doctype="Weather", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Humidity', - standard=1, - linked_doctype='Weather'), + doctype="Agriculture Analysis Criteria", title="Humidity", standard=1, linked_doctype="Weather" + ), dict( - doctype='Agriculture Analysis Criteria', - title='Pressure', - standard=1, - linked_doctype='Weather'), + doctype="Agriculture Analysis Criteria", title="Pressure", standard=1, linked_doctype="Weather" + ), dict( - doctype='Agriculture Analysis Criteria', - title='Insolation/ PAR (Photosynthetically Active Radiation)', + doctype="Agriculture Analysis Criteria", + title="Insolation/ PAR (Photosynthetically Active Radiation)", standard=1, - linked_doctype='Weather'), + linked_doctype="Weather", + ), dict( - doctype='Agriculture Analysis Criteria', - title='Degree Days', + doctype="Agriculture Analysis Criteria", + title="Degree Days", standard=1, - linked_doctype='Weather') + linked_doctype="Weather", + ), ] insert_record(records) diff --git a/erpnext/assets/dashboard_fixtures.py b/erpnext/assets/dashboard_fixtures.py index 39f0f1a88be..fc9ba386a38 100644 --- a/erpnext/assets/dashboard_fixtures.py +++ b/erpnext/assets/dashboard_fixtures.py @@ -18,30 +18,36 @@ def get_data(): if not fiscal_year: return frappe._dict() - year_start_date = get_date_str(fiscal_year.get('year_start_date')) - year_end_date = get_date_str(fiscal_year.get('year_end_date')) + year_start_date = get_date_str(fiscal_year.get("year_start_date")) + year_end_date = get_date_str(fiscal_year.get("year_end_date")) + + return frappe._dict( + { + "dashboards": get_dashboards(), + "charts": get_charts(fiscal_year, year_start_date, year_end_date), + "number_cards": get_number_cards(fiscal_year, year_start_date, year_end_date), + } + ) - return frappe._dict({ - "dashboards": get_dashboards(), - "charts": get_charts(fiscal_year, year_start_date, year_end_date), - "number_cards": get_number_cards(fiscal_year, year_start_date, year_end_date), - }) def get_dashboards(): - return [{ - "name": "Asset", - "dashboard_name": "Asset", - "charts": [ - { "chart": "Asset Value Analytics", "width": "Full" }, - { "chart": "Category-wise Asset Value", "width": "Half" }, - { "chart": "Location-wise Asset Value", "width": "Half" }, - ], - "cards": [ - {"card": "Total Assets"}, - {"card": "New Assets (This Year)"}, - {"card": "Asset Value"} - ] - }] + return [ + { + "name": "Asset", + "dashboard_name": "Asset", + "charts": [ + {"chart": "Asset Value Analytics", "width": "Full"}, + {"chart": "Category-wise Asset Value", "width": "Half"}, + {"chart": "Location-wise Asset Value", "width": "Half"}, + ], + "cards": [ + {"card": "Total Assets"}, + {"card": "New Assets (This Year)"}, + {"card": "Asset Value"}, + ], + } + ] + def get_charts(fiscal_year, year_start_date, year_end_date): company = get_company_for_dashboards() @@ -58,26 +64,30 @@ def get_charts(fiscal_year, year_start_date, year_end_date): "timespan": "Last Year", "time_interval": "Yearly", "timeseries": 0, - "filters_json": json.dumps({ - "company": company, - "status": "In Location", - "filter_based_on": "Fiscal Year", - "from_fiscal_year": fiscal_year.get('name'), - "to_fiscal_year": fiscal_year.get('name'), - "period_start_date": year_start_date, - "period_end_date": year_end_date, - "date_based_on": "Purchase Date", - "group_by": "--Select a group--" - }), + "filters_json": json.dumps( + { + "company": company, + "status": "In Location", + "filter_based_on": "Fiscal Year", + "from_fiscal_year": fiscal_year.get("name"), + "to_fiscal_year": fiscal_year.get("name"), + "period_start_date": year_start_date, + "period_end_date": year_end_date, + "date_based_on": "Purchase Date", + "group_by": "--Select a group--", + } + ), "type": "Bar", - "custom_options": json.dumps({ - "type": "bar", - "barOptions": { "stacked": 1 }, - "axisOptions": { "shortenYAxisNumbers": 1 }, - "tooltipOptions": {} - }), + "custom_options": json.dumps( + { + "type": "bar", + "barOptions": {"stacked": 1}, + "axisOptions": {"shortenYAxisNumbers": 1}, + "tooltipOptions": {}, + } + ), "doctype": "Dashboard Chart", - "y_axis": [] + "y_axis": [], }, { "name": "Category-wise Asset Value", @@ -86,12 +96,14 @@ def get_charts(fiscal_year, year_start_date, year_end_date): "report_name": "Fixed Asset Register", "x_field": "asset_category", "timeseries": 0, - "filters_json": json.dumps({ - "company": company, - "status":"In Location", - "group_by":"Asset Category", - "is_existing_asset":0 - }), + "filters_json": json.dumps( + { + "company": company, + "status": "In Location", + "group_by": "Asset Category", + "is_existing_asset": 0, + } + ), "type": "Donut", "doctype": "Dashboard Chart", "y_axis": [ @@ -100,14 +112,12 @@ def get_charts(fiscal_year, year_start_date, year_end_date): "parentfield": "y_axis", "parenttype": "Dashboard Chart", "y_field": "asset_value", - "doctype": "Dashboard Chart Field" + "doctype": "Dashboard Chart Field", } ], - "custom_options": json.dumps({ - "type": "donut", - "height": 300, - "axisOptions": {"shortenYAxisNumbers": 1} - }) + "custom_options": json.dumps( + {"type": "donut", "height": 300, "axisOptions": {"shortenYAxisNumbers": 1}} + ), }, { "name": "Location-wise Asset Value", @@ -116,12 +126,9 @@ def get_charts(fiscal_year, year_start_date, year_end_date): "report_name": "Fixed Asset Register", "x_field": "location", "timeseries": 0, - "filters_json": json.dumps({ - "company": company, - "status":"In Location", - "group_by":"Location", - "is_existing_asset":0 - }), + "filters_json": json.dumps( + {"company": company, "status": "In Location", "group_by": "Location", "is_existing_asset": 0} + ), "type": "Donut", "doctype": "Dashboard Chart", "y_axis": [ @@ -130,17 +137,16 @@ def get_charts(fiscal_year, year_start_date, year_end_date): "parentfield": "y_axis", "parenttype": "Dashboard Chart", "y_field": "asset_value", - "doctype": "Dashboard Chart Field" + "doctype": "Dashboard Chart Field", } ], - "custom_options": json.dumps({ - "type": "donut", - "height": 300, - "axisOptions": {"shortenYAxisNumbers": 1} - }) - } + "custom_options": json.dumps( + {"type": "donut", "height": 300, "axisOptions": {"shortenYAxisNumbers": 1}} + ), + }, ] + def get_number_cards(fiscal_year, year_start_date, year_end_date): return [ { @@ -162,9 +168,9 @@ def get_number_cards(fiscal_year, year_start_date, year_end_date): "is_public": 1, "show_percentage_stats": 1, "stats_time_interval": "Monthly", - "filters_json": json.dumps([ - ['Asset', 'creation', 'between', [year_start_date, year_end_date]] - ]), + "filters_json": json.dumps( + [["Asset", "creation", "between", [year_start_date, year_end_date]]] + ), "doctype": "Number Card", }, { @@ -177,6 +183,6 @@ def get_number_cards(fiscal_year, year_start_date, year_end_date): "show_percentage_stats": 1, "stats_time_interval": "Monthly", "filters_json": "[]", - "doctype": "Number Card" - } + "doctype": "Number Card", + }, ] diff --git a/erpnext/assets/doctype/asset/asset.json b/erpnext/assets/doctype/asset/asset.json index de060757e2e..04e9c32f379 100644 --- a/erpnext/assets/doctype/asset/asset.json +++ b/erpnext/assets/doctype/asset/asset.json @@ -38,7 +38,6 @@ "purchase_date", "section_break_23", "calculate_depreciation", - "allow_monthly_depreciation", "column_break_33", "opening_accumulated_depreciation", "number_of_depreciations_booked", @@ -141,6 +140,7 @@ }, { "allow_on_submit": 1, + "fetch_from": "item_code.image", "fieldname": "image", "fieldtype": "Attach Image", "hidden": 1, @@ -453,13 +453,6 @@ "fieldname": "dimension_col_break", "fieldtype": "Column Break" }, - { - "default": "0", - "depends_on": "calculate_depreciation", - "fieldname": "allow_monthly_depreciation", - "fieldtype": "Check", - "label": "Allow Monthly Depreciation" - }, { "collapsible": 1, "collapsible_depends_on": "is_existing_asset", @@ -502,7 +495,7 @@ "link_fieldname": "asset" } ], - "modified": "2021-06-24 14:58:51.097908", + "modified": "2022-07-20 16:22:44.437579", "modified_by": "Administrator", "module": "Assets", "name": "Asset", diff --git a/erpnext/assets/doctype/asset/asset.py b/erpnext/assets/doctype/asset/asset.py index 90257c784ee..1ce815ae2bd 100644 --- a/erpnext/assets/doctype/asset/asset.py +++ b/erpnext/assets/doctype/asset/asset.py @@ -37,6 +37,7 @@ class Asset(AccountsController): self.validate_asset_values() self.validate_asset_and_reference() self.validate_item() + self.validate_cost_center() self.set_missing_values() self.prepare_depreciation_data() self.validate_gross_and_purchase_amount() @@ -57,21 +58,26 @@ class Asset(AccountsController): self.cancel_movement_entries() self.delete_depreciation_entries() self.set_status() - self.ignore_linked_doctypes = ('GL Entry', 'Stock Ledger Entry') - make_reverse_gl_entries(voucher_type='Asset', voucher_no=self.name) - self.db_set('booked_fixed_asset', 0) + self.ignore_linked_doctypes = ("GL Entry", "Stock Ledger Entry") + make_reverse_gl_entries(voucher_type="Asset", voucher_no=self.name) + self.db_set("booked_fixed_asset", 0) def validate_asset_and_reference(self): if self.purchase_invoice or self.purchase_receipt: - reference_doc = 'Purchase Invoice' if self.purchase_invoice else 'Purchase Receipt' + reference_doc = "Purchase Invoice" if self.purchase_invoice else "Purchase Receipt" reference_name = self.purchase_invoice or self.purchase_receipt reference_doc = frappe.get_doc(reference_doc, reference_name) - if reference_doc.get('company') != self.company: - frappe.throw(_("Company of asset {0} and purchase document {1} doesn't matches.").format(self.name, reference_doc.get('name'))) - + if reference_doc.get("company") != self.company: + frappe.throw( + _("Company of asset {0} and purchase document {1} doesn't matches.").format( + self.name, reference_doc.get("name") + ) + ) if self.is_existing_asset and self.purchase_invoice: - frappe.throw(_("Purchase Invoice cannot be made against an existing asset {0}").format(self.name)) + frappe.throw( + _("Purchase Invoice cannot be made against an existing asset {0}").format(self.name) + ) def prepare_depreciation_data(self, date_of_sale=None, date_of_return=None): if self.calculate_depreciation: @@ -81,12 +87,14 @@ class Asset(AccountsController): self.set_accumulated_depreciation(date_of_sale, date_of_return) else: self.finance_books = [] - self.value_after_depreciation = (flt(self.gross_purchase_amount) - - flt(self.opening_accumulated_depreciation)) + self.value_after_depreciation = flt(self.gross_purchase_amount) - flt( + self.opening_accumulated_depreciation + ) def validate_item(self): - item = frappe.get_cached_value("Item", self.item_code, - ["is_fixed_asset", "is_stock_item", "disabled"], as_dict=1) + item = frappe.get_cached_value( + "Item", self.item_code, ["is_fixed_asset", "is_stock_item", "disabled"], as_dict=1 + ) if not item: frappe.throw(_("Item {0} does not exist").format(self.item_code)) elif item.disabled: @@ -96,22 +104,39 @@ class Asset(AccountsController): elif item.is_stock_item: frappe.throw(_("Item {0} must be a non-stock item").format(self.item_code)) + def validate_cost_center(self): + if not self.cost_center: + return + + cost_center_company = frappe.db.get_value("Cost Center", self.cost_center, "company") + if cost_center_company != self.company: + frappe.throw( + _("Selected Cost Center {} doesn't belongs to {}").format( + frappe.bold(self.cost_center), frappe.bold(self.company) + ), + title=_("Invalid Cost Center"), + ) + def validate_in_use_date(self): if not self.available_for_use_date: frappe.throw(_("Available for use date is required")) for d in self.finance_books: if d.depreciation_start_date == self.available_for_use_date: - frappe.throw(_("Row #{}: Depreciation Posting Date should not be equal to Available for Use Date.").format(d.idx), - title=_("Incorrect Date")) + frappe.throw( + _("Row #{}: Depreciation Posting Date should not be equal to Available for Use Date.").format( + d.idx + ), + title=_("Incorrect Date"), + ) def set_missing_values(self): if not self.asset_category: self.asset_category = frappe.get_cached_value("Item", self.item_code, "asset_category") - if self.item_code and not self.get('finance_books'): + if self.item_code and not self.get("finance_books"): finance_books = get_item_details(self.item_code, self.asset_category) - self.set('finance_books', finance_books) + self.set("finance_books", finance_books) def validate_asset_values(self): if not self.asset_category: @@ -122,13 +147,20 @@ class Asset(AccountsController): if is_cwip_accounting_enabled(self.asset_category): if not self.is_existing_asset and not (self.purchase_receipt or self.purchase_invoice): - frappe.throw(_("Please create purchase receipt or purchase invoice for the item {0}"). - format(self.item_code)) + frappe.throw( + _("Please create purchase receipt or purchase invoice for the item {0}").format( + self.item_code + ) + ) - if (not self.purchase_receipt and self.purchase_invoice - and not frappe.db.get_value('Purchase Invoice', self.purchase_invoice, 'update_stock')): - frappe.throw(_("Update stock must be enable for the purchase invoice {0}"). - format(self.purchase_invoice)) + if ( + not self.purchase_receipt + and self.purchase_invoice + and not frappe.db.get_value("Purchase Invoice", self.purchase_invoice, "update_stock") + ): + frappe.throw( + _("Update stock must be enable for the purchase invoice {0}").format(self.purchase_invoice) + ) if not self.calculate_depreciation: return @@ -138,218 +170,252 @@ class Asset(AccountsController): if self.is_existing_asset: return - if self.available_for_use_date and getdate(self.available_for_use_date) < getdate(self.purchase_date): + if self.available_for_use_date and getdate(self.available_for_use_date) < getdate( + self.purchase_date + ): frappe.throw(_("Available-for-use Date should be after purchase date")) def validate_gross_and_purchase_amount(self): - if self.is_existing_asset: return + if self.is_existing_asset: + return if self.gross_purchase_amount and self.gross_purchase_amount != self.purchase_receipt_amount: - error_message = _("Gross Purchase Amount should be equal to purchase amount of one single Asset.") + error_message = _( + "Gross Purchase Amount should be equal to purchase amount of one single Asset." + ) error_message += "
" error_message += _("Please do not book expense of multiple assets against one single Asset.") frappe.throw(error_message, title=_("Invalid Gross Purchase Amount")) def make_asset_movement(self): - reference_doctype = 'Purchase Receipt' if self.purchase_receipt else 'Purchase Invoice' + reference_doctype = "Purchase Receipt" if self.purchase_receipt else "Purchase Invoice" reference_docname = self.purchase_receipt or self.purchase_invoice transaction_date = getdate(self.purchase_date) if reference_docname: - posting_date, posting_time = frappe.db.get_value(reference_doctype, reference_docname, ["posting_date", "posting_time"]) + posting_date, posting_time = frappe.db.get_value( + reference_doctype, reference_docname, ["posting_date", "posting_time"] + ) transaction_date = get_datetime("{} {}".format(posting_date, posting_time)) - assets = [{ - 'asset': self.name, - 'asset_name': self.asset_name, - 'target_location': self.location, - 'to_employee': self.custodian - }] - asset_movement = frappe.get_doc({ - 'doctype': 'Asset Movement', - 'assets': assets, - 'purpose': 'Receipt', - 'company': self.company, - 'transaction_date': transaction_date, - 'reference_doctype': reference_doctype, - 'reference_name': reference_docname - }).insert() + assets = [ + { + "asset": self.name, + "asset_name": self.asset_name, + "target_location": self.location, + "to_employee": self.custodian, + } + ] + asset_movement = frappe.get_doc( + { + "doctype": "Asset Movement", + "assets": assets, + "purpose": "Receipt", + "company": self.company, + "transaction_date": transaction_date, + "reference_doctype": reference_doctype, + "reference_name": reference_docname, + } + ).insert() asset_movement.submit() def set_depreciation_rate(self): for d in self.get("finance_books"): - d.rate_of_depreciation = flt(self.get_depreciation_rate(d, on_validate=True), - d.precision("rate_of_depreciation")) + d.rate_of_depreciation = flt( + self.get_depreciation_rate(d, on_validate=True), d.precision("rate_of_depreciation") + ) def make_depreciation_schedule(self, date_of_sale): - if 'Manual' not in [d.depreciation_method for d in self.finance_books] and not self.get('schedules'): + if "Manual" not in [d.depreciation_method for d in self.finance_books] and not self.get( + "schedules" + ): self.schedules = [] if not self.available_for_use_date: return - for d in self.get('finance_books'): - self.validate_asset_finance_books(d) + start = self.clear_depreciation_schedule() - start = self.clear_depreciation_schedule() + for finance_book in self.get("finance_books"): + self.validate_asset_finance_books(finance_book) # value_after_depreciation - current Asset value - if self.docstatus == 1 and d.value_after_depreciation: - value_after_depreciation = flt(d.value_after_depreciation) + if self.docstatus == 1 and finance_book.value_after_depreciation: + value_after_depreciation = flt(finance_book.value_after_depreciation) else: - value_after_depreciation = (flt(self.gross_purchase_amount) - - flt(self.opening_accumulated_depreciation)) + value_after_depreciation = flt(self.gross_purchase_amount) - flt( + self.opening_accumulated_depreciation + ) - d.value_after_depreciation = value_after_depreciation + finance_book.value_after_depreciation = value_after_depreciation - number_of_pending_depreciations = cint(d.total_number_of_depreciations) - \ - cint(self.number_of_depreciations_booked) + number_of_pending_depreciations = cint(finance_book.total_number_of_depreciations) - cint( + self.number_of_depreciations_booked + ) - has_pro_rata = self.check_is_pro_rata(d) + has_pro_rata = self.check_is_pro_rata(finance_book) if has_pro_rata: number_of_pending_depreciations += 1 skip_row = False - for n in range(start, number_of_pending_depreciations): - # If depreciation is already completed (for double declining balance) - if skip_row: continue + should_get_last_day = is_last_day_of_the_month(finance_book.depreciation_start_date) - depreciation_amount = get_depreciation_amount(self, value_after_depreciation, d) + for n in range(start[finance_book.idx - 1], number_of_pending_depreciations): + # If depreciation is already completed (for double declining balance) + if skip_row: + continue + + depreciation_amount = get_depreciation_amount(self, value_after_depreciation, finance_book) if not has_pro_rata or n < cint(number_of_pending_depreciations) - 1: - schedule_date = add_months(d.depreciation_start_date, - n * cint(d.frequency_of_depreciation)) + schedule_date = add_months( + finance_book.depreciation_start_date, n * cint(finance_book.frequency_of_depreciation) + ) + + if should_get_last_day: + schedule_date = get_last_day(schedule_date) # schedule date will be a year later from start date # so monthly schedule date is calculated by removing 11 months from it - monthly_schedule_date = add_months(schedule_date, - d.frequency_of_depreciation + 1) + monthly_schedule_date = add_months(schedule_date, -finance_book.frequency_of_depreciation + 1) # if asset is being sold if date_of_sale: - from_date = self.get_from_date(d.finance_book) - depreciation_amount, days, months = self.get_pro_rata_amt(d, depreciation_amount, - from_date, date_of_sale) + from_date = self.get_from_date(finance_book.finance_book) + depreciation_amount, days, months = self.get_pro_rata_amt( + finance_book, depreciation_amount, from_date, date_of_sale + ) if depreciation_amount > 0: - self.append("schedules", { - "schedule_date": date_of_sale, - "depreciation_amount": depreciation_amount, - "depreciation_method": d.depreciation_method, - "finance_book": d.finance_book, - "finance_book_id": d.idx - }) + self.append( + "schedules", + { + "schedule_date": date_of_sale, + "depreciation_amount": depreciation_amount, + "depreciation_method": finance_book.depreciation_method, + "finance_book": finance_book.finance_book, + "finance_book_id": finance_book.idx, + }, + ) break # For first row - if has_pro_rata and not self.opening_accumulated_depreciation and n==0: - depreciation_amount, days, months = self.get_pro_rata_amt(d, depreciation_amount, - self.available_for_use_date, d.depreciation_start_date) + if has_pro_rata and not self.opening_accumulated_depreciation and n == 0: + from_date = add_days( + self.available_for_use_date, -1 + ) # needed to calc depr amount for available_for_use_date too + depreciation_amount, days, months = self.get_pro_rata_amt( + finance_book, depreciation_amount, from_date, finance_book.depreciation_start_date + ) # For first depr schedule date will be the start date # so monthly schedule date is calculated by removing month difference between use date and start date - monthly_schedule_date = add_months(d.depreciation_start_date, - months + 1) + monthly_schedule_date = add_months(finance_book.depreciation_start_date, -months + 1) # For last row elif has_pro_rata and n == cint(number_of_pending_depreciations) - 1: if not self.flags.increase_in_asset_life: # In case of increase_in_asset_life, the self.to_date is already set on asset_repair submission - self.to_date = add_months(self.available_for_use_date, - (n + self.number_of_depreciations_booked) * cint(d.frequency_of_depreciation)) + self.to_date = add_months( + self.available_for_use_date, + (n + self.number_of_depreciations_booked) * cint(finance_book.frequency_of_depreciation), + ) depreciation_amount_without_pro_rata = depreciation_amount - depreciation_amount, days, months = self.get_pro_rata_amt(d, - depreciation_amount, schedule_date, self.to_date) + depreciation_amount, days, months = self.get_pro_rata_amt( + finance_book, depreciation_amount, schedule_date, self.to_date + ) - depreciation_amount = self.get_adjusted_depreciation_amount(depreciation_amount_without_pro_rata, - depreciation_amount, d.finance_book) + depreciation_amount = self.get_adjusted_depreciation_amount( + depreciation_amount_without_pro_rata, depreciation_amount, finance_book.finance_book + ) monthly_schedule_date = add_months(schedule_date, 1) schedule_date = add_days(schedule_date, days) last_schedule_date = schedule_date - if not depreciation_amount: continue - value_after_depreciation -= flt(depreciation_amount, - self.precision("gross_purchase_amount")) + if not depreciation_amount: + continue + value_after_depreciation -= flt(depreciation_amount, self.precision("gross_purchase_amount")) # Adjust depreciation amount in the last period based on the expected value after useful life - if d.expected_value_after_useful_life and ((n == cint(number_of_pending_depreciations) - 1 - and value_after_depreciation != d.expected_value_after_useful_life) - or value_after_depreciation < d.expected_value_after_useful_life): - depreciation_amount += (value_after_depreciation - d.expected_value_after_useful_life) + if finance_book.expected_value_after_useful_life and ( + ( + n == cint(number_of_pending_depreciations) - 1 + and value_after_depreciation != finance_book.expected_value_after_useful_life + ) + or value_after_depreciation < finance_book.expected_value_after_useful_life + ): + depreciation_amount += ( + value_after_depreciation - finance_book.expected_value_after_useful_life + ) skip_row = True if depreciation_amount > 0: - # With monthly depreciation, each depreciation is divided by months remaining until next date - if self.allow_monthly_depreciation: - # month range is 1 to 12 - # In pro rata case, for first and last depreciation, month range would be different - month_range = months \ - if (has_pro_rata and n==0) or (has_pro_rata and n == cint(number_of_pending_depreciations) - 1) \ - else d.frequency_of_depreciation - - for r in range(month_range): - if (has_pro_rata and n == 0): - # For first entry of monthly depr - if r == 0: - days_until_first_depr = date_diff(monthly_schedule_date, self.available_for_use_date) - per_day_amt = depreciation_amount / days - depreciation_amount_for_current_month = per_day_amt * days_until_first_depr - depreciation_amount -= depreciation_amount_for_current_month - date = monthly_schedule_date - amount = depreciation_amount_for_current_month - else: - date = add_months(monthly_schedule_date, r) - amount = depreciation_amount / (month_range - 1) - elif (has_pro_rata and n == cint(number_of_pending_depreciations) - 1) and r == cint(month_range) - 1: - # For last entry of monthly depr - date = last_schedule_date - amount = depreciation_amount / month_range - else: - date = add_months(monthly_schedule_date, r) - amount = depreciation_amount / month_range - - self.append("schedules", { - "schedule_date": date, - "depreciation_amount": amount, - "depreciation_method": d.depreciation_method, - "finance_book": d.finance_book, - "finance_book_id": d.idx - }) - else: - self.append("schedules", { + self.append( + "schedules", + { "schedule_date": schedule_date, "depreciation_amount": depreciation_amount, - "depreciation_method": d.depreciation_method, - "finance_book": d.finance_book, - "finance_book_id": d.idx - }) + "depreciation_method": finance_book.depreciation_method, + "finance_book": finance_book.finance_book, + "finance_book_id": finance_book.idx, + }, + ) - # used when depreciation schedule needs to be modified due to increase in asset life + # depreciation schedules need to be cleared before modification due to increase in asset life/asset sales + # JE: Journal Entry, FB: Finance Book def clear_depreciation_schedule(self): - start = 0 - for n in range(len(self.schedules)): - if not self.schedules[n].journal_entry: - del self.schedules[n:] - start = n - break + start = [] + num_of_depreciations_completed = 0 + depr_schedule = [] + + for schedule in self.get("schedules"): + + # to update start when there are JEs linked with all the schedule rows corresponding to an FB + if len(start) == (int(schedule.finance_book_id) - 2): + start.append(num_of_depreciations_completed) + num_of_depreciations_completed = 0 + + # to ensure that start will only be updated once for each FB + if len(start) == (int(schedule.finance_book_id) - 1): + if schedule.journal_entry: + num_of_depreciations_completed += 1 + depr_schedule.append(schedule) + else: + start.append(num_of_depreciations_completed) + num_of_depreciations_completed = 0 + + # to update start when all the schedule rows corresponding to the last FB are linked with JEs + if len(start) == (len(self.finance_books) - 1): + start.append(num_of_depreciations_completed) + + # when the Depreciation Schedule is being created for the first time + if start == []: + start = [0] * len(self.finance_books) + else: + self.schedules = depr_schedule + return start def get_from_date(self, finance_book): - if not self.get('schedules'): + if not self.get("schedules"): return self.available_for_use_date if len(self.finance_books) == 1: return self.schedules[-1].schedule_date from_date = "" - for schedule in self.get('schedules'): + for schedule in self.get("schedules"): if schedule.finance_book == finance_book: from_date = schedule.schedule_date if from_date: return from_date - return self.available_for_use_date + + # since depr for available_for_use_date is not yet booked + return add_days(self.available_for_use_date, -1) # if it returns True, depreciation_amount will not be equal for the first and last rows def check_is_pro_rata(self, row): @@ -370,16 +436,25 @@ class Asset(AccountsController): return has_pro_rata def get_modified_available_for_use_date(self, row): - return add_months(self.available_for_use_date, (self.number_of_depreciations_booked * row.frequency_of_depreciation)) + return add_months( + self.available_for_use_date, + (self.number_of_depreciations_booked * row.frequency_of_depreciation), + ) def validate_asset_finance_books(self, row): if flt(row.expected_value_after_useful_life) >= flt(self.gross_purchase_amount): - frappe.throw(_("Row {0}: Expected Value After Useful Life must be less than Gross Purchase Amount") - .format(row.idx)) + frappe.throw( + _("Row {0}: Expected Value After Useful Life must be less than Gross Purchase Amount").format( + row.idx + ), + title=_("Invalid Schedule"), + ) if not row.depreciation_start_date: if not self.available_for_use_date: - frappe.throw(_("Row {0}: Depreciation Start Date is required").format(row.idx)) + frappe.throw( + _("Row {0}: Depreciation Start Date is required").format(row.idx), title=_("Invalid Schedule") + ) row.depreciation_start_date = get_last_day(self.available_for_use_date) if not self.is_existing_asset: @@ -388,8 +463,11 @@ class Asset(AccountsController): else: depreciable_amount = flt(self.gross_purchase_amount) - flt(row.expected_value_after_useful_life) if flt(self.opening_accumulated_depreciation) > depreciable_amount: - frappe.throw(_("Opening Accumulated Depreciation must be less than equal to {0}") - .format(depreciable_amount)) + frappe.throw( + _("Opening Accumulated Depreciation must be less than equal to {0}").format( + depreciable_amount + ) + ) if self.opening_accumulated_depreciation: if not self.number_of_depreciations_booked: @@ -397,24 +475,46 @@ class Asset(AccountsController): else: self.number_of_depreciations_booked = 0 - if cint(self.number_of_depreciations_booked) > cint(row.total_number_of_depreciations): - frappe.throw(_("Number of Depreciations Booked cannot be greater than Total Number of Depreciations")) + if flt(row.total_number_of_depreciations) <= cint(self.number_of_depreciations_booked): + frappe.throw( + _( + "Row {0}: Total Number of Depreciations cannot be less than or equal to Number of Depreciations Booked" + ).format(row.idx), + title=_("Invalid Schedule"), + ) - if row.depreciation_start_date and getdate(row.depreciation_start_date) < getdate(self.purchase_date): - frappe.throw(_("Depreciation Row {0}: Next Depreciation Date cannot be before Purchase Date") - .format(row.idx)) + if row.depreciation_start_date and getdate(row.depreciation_start_date) < getdate( + self.purchase_date + ): + frappe.throw( + _("Depreciation Row {0}: Next Depreciation Date cannot be before Purchase Date").format( + row.idx + ) + ) - if row.depreciation_start_date and getdate(row.depreciation_start_date) < getdate(self.available_for_use_date): - frappe.throw(_("Depreciation Row {0}: Next Depreciation Date cannot be before Available-for-use Date") - .format(row.idx)) + if row.depreciation_start_date and getdate(row.depreciation_start_date) < getdate( + self.available_for_use_date + ): + frappe.throw( + _( + "Depreciation Row {0}: Next Depreciation Date cannot be before Available-for-use Date" + ).format(row.idx) + ) # to ensure that final accumulated depreciation amount is accurate - def get_adjusted_depreciation_amount(self, depreciation_amount_without_pro_rata, depreciation_amount_for_last_row, finance_book): + def get_adjusted_depreciation_amount( + self, depreciation_amount_without_pro_rata, depreciation_amount_for_last_row, finance_book + ): if not self.opening_accumulated_depreciation: depreciation_amount_for_first_row = self.get_depreciation_amount_for_first_row(finance_book) - if depreciation_amount_for_first_row + depreciation_amount_for_last_row != depreciation_amount_without_pro_rata: - depreciation_amount_for_last_row = depreciation_amount_without_pro_rata - depreciation_amount_for_first_row + if ( + depreciation_amount_for_first_row + depreciation_amount_for_last_row + != depreciation_amount_without_pro_rata + ): + depreciation_amount_for_last_row = ( + depreciation_amount_without_pro_rata - depreciation_amount_for_first_row + ) return depreciation_amount_for_last_row @@ -430,8 +530,12 @@ class Asset(AccountsController): if len(self.finance_books) == 1: return True - def set_accumulated_depreciation(self, date_of_sale=None, date_of_return=None, ignore_booked_entry = False): - straight_line_idx = [d.idx for d in self.get("schedules") if d.depreciation_method == 'Straight Line'] + def set_accumulated_depreciation( + self, date_of_sale=None, date_of_return=None, ignore_booked_entry=False + ): + straight_line_idx = [ + d.idx for d in self.get("schedules") if d.depreciation_method == "Straight Line" + ] finance_books = [] for i, d in enumerate(self.get("schedules")): @@ -447,41 +551,64 @@ class Asset(AccountsController): value_after_depreciation -= flt(depreciation_amount) # for the last row, if depreciation method = Straight Line - if straight_line_idx and i == max(straight_line_idx) - 1 and not date_of_sale and not date_of_return: - book = self.get('finance_books')[cint(d.finance_book_id) - 1] - depreciation_amount += flt(value_after_depreciation - - flt(book.expected_value_after_useful_life), d.precision("depreciation_amount")) + if ( + straight_line_idx + and i == max(straight_line_idx) - 1 + and not date_of_sale + and not date_of_return + ): + book = self.get("finance_books")[cint(d.finance_book_id) - 1] + depreciation_amount += flt( + value_after_depreciation - flt(book.expected_value_after_useful_life), + d.precision("depreciation_amount"), + ) d.depreciation_amount = depreciation_amount accumulated_depreciation += d.depreciation_amount - d.accumulated_depreciation_amount = flt(accumulated_depreciation, - d.precision("accumulated_depreciation_amount")) + d.accumulated_depreciation_amount = flt( + accumulated_depreciation, d.precision("accumulated_depreciation_amount") + ) def get_value_after_depreciation(self, idx): - return flt(self.get('finance_books')[cint(idx)-1].value_after_depreciation) + return flt(self.get("finance_books")[cint(idx) - 1].value_after_depreciation) def validate_expected_value_after_useful_life(self): - for row in self.get('finance_books'): - accumulated_depreciation_after_full_schedule = [d.accumulated_depreciation_amount - for d in self.get("schedules") if cint(d.finance_book_id) == row.idx] + for row in self.get("finance_books"): + accumulated_depreciation_after_full_schedule = [ + d.accumulated_depreciation_amount + for d in self.get("schedules") + if cint(d.finance_book_id) == row.idx + ] if accumulated_depreciation_after_full_schedule: - accumulated_depreciation_after_full_schedule = max(accumulated_depreciation_after_full_schedule) + accumulated_depreciation_after_full_schedule = max( + accumulated_depreciation_after_full_schedule + ) asset_value_after_full_schedule = flt( - flt(self.gross_purchase_amount) - - flt(accumulated_depreciation_after_full_schedule), self.precision('gross_purchase_amount')) + flt(self.gross_purchase_amount) - flt(accumulated_depreciation_after_full_schedule), + row.precision("expected_value_after_useful_life"), + ) - if (row.expected_value_after_useful_life and - row.expected_value_after_useful_life < asset_value_after_full_schedule): - frappe.throw(_("Depreciation Row {0}: Expected value after useful life must be greater than or equal to {1}") - .format(row.idx, asset_value_after_full_schedule)) + if ( + row.expected_value_after_useful_life + and row.expected_value_after_useful_life < asset_value_after_full_schedule + ): + frappe.throw( + _( + "Depreciation Row {0}: Expected value after useful life must be greater than or equal to {1}" + ).format(row.idx, asset_value_after_full_schedule) + ) elif not row.expected_value_after_useful_life: row.expected_value_after_useful_life = asset_value_after_full_schedule def validate_cancellation(self): if self.status in ("In Maintenance", "Out of Order"): - frappe.throw(_("There are active maintenance or repairs against the asset. You must complete all of them before cancelling the asset.")) + frappe.throw( + _( + "There are active maintenance or repairs against the asset. You must complete all of them before cancelling the asset." + ) + ) if self.status not in ("Submitted", "Partially Depreciated", "Fully Depreciated"): frappe.throw(_("Asset cannot be cancelled, as it is already {0}").format(self.status)) @@ -489,10 +616,13 @@ class Asset(AccountsController): movements = frappe.db.sql( """SELECT asm.name, asm.docstatus FROM `tabAsset Movement` asm, `tabAsset Movement Item` asm_item - WHERE asm_item.parent=asm.name and asm_item.asset=%s and asm.docstatus=1""", self.name, as_dict=1) + WHERE asm_item.parent=asm.name and asm_item.asset=%s and asm.docstatus=1""", + self.name, + as_dict=1, + ) for movement in movements: - movement = frappe.get_doc('Asset Movement', movement.get('name')) + movement = frappe.get_doc("Asset Movement", movement.get("name")) movement.cancel() def delete_depreciation_entries(self): @@ -501,17 +631,19 @@ class Asset(AccountsController): frappe.get_doc("Journal Entry", d.journal_entry).cancel() d.db_set("journal_entry", None) - self.db_set("value_after_depreciation", - (flt(self.gross_purchase_amount) - flt(self.opening_accumulated_depreciation))) + self.db_set( + "value_after_depreciation", + (flt(self.gross_purchase_amount) - flt(self.opening_accumulated_depreciation)), + ) def set_status(self, status=None): - '''Get and update status''' + """Get and update status""" if not status: status = self.get_status() self.db_set("status", status) def get_status(self): - '''Returns status based on whether it is draft, submitted, scrapped or depreciated''' + """Returns status based on whether it is draft, submitted, scrapped or depreciated""" if self.docstatus == 0: status = "Draft" elif self.docstatus == 1: @@ -528,17 +660,17 @@ class Asset(AccountsController): if flt(value_after_depreciation) <= expected_value_after_useful_life: status = "Fully Depreciated" elif flt(value_after_depreciation) < flt(self.gross_purchase_amount): - status = 'Partially Depreciated' + status = "Partially Depreciated" elif self.docstatus == 2: status = "Cancelled" return status def get_default_finance_book_idx(self): - if not self.get('default_finance_book') and self.company: + if not self.get("default_finance_book") and self.company: self.default_finance_book = erpnext.get_default_finance_book(self.company) - if self.get('default_finance_book'): - for d in self.get('finance_books'): + if self.get("default_finance_book"): + for d in self.get("finance_books"): if d.finance_book == self.default_finance_book: return cint(d.idx) - 1 @@ -547,7 +679,7 @@ class Asset(AccountsController): if not purchase_document: return False - asset_bought_with_invoice = (purchase_document == self.purchase_invoice) + asset_bought_with_invoice = purchase_document == self.purchase_invoice fixed_asset_account = self.get_fixed_asset_account() cwip_enabled = is_cwip_accounting_enabled(self.asset_category) @@ -577,18 +709,34 @@ class Asset(AccountsController): return cwip_booked def get_purchase_document(self): - asset_bought_with_invoice = self.purchase_invoice and frappe.db.get_value('Purchase Invoice', self.purchase_invoice, 'update_stock') + asset_bought_with_invoice = self.purchase_invoice and frappe.db.get_value( + "Purchase Invoice", self.purchase_invoice, "update_stock" + ) purchase_document = self.purchase_invoice if asset_bought_with_invoice else self.purchase_receipt return purchase_document def get_fixed_asset_account(self): - return get_asset_category_account('fixed_asset_account', None, self.name, None, self.asset_category, self.company) + fixed_asset_account = get_asset_category_account( + "fixed_asset_account", None, self.name, None, self.asset_category, self.company + ) + if not fixed_asset_account: + frappe.throw( + _("Set {0} in asset category {1} for company {2}").format( + frappe.bold("Fixed Asset Account"), + frappe.bold(self.asset_category), + frappe.bold(self.company), + ), + title=_("Account not Found"), + ) + return fixed_asset_account def get_cwip_account(self, cwip_enabled=False): cwip_account = None try: - cwip_account = get_asset_account("capital_work_in_progress_account", self.name, self.asset_category, self.company) + cwip_account = get_asset_account( + "capital_work_in_progress_account", self.name, self.asset_category, self.company + ) except Exception: # if no cwip account found in category or company and "cwip is enabled" then raise else silently pass if cwip_enabled: @@ -602,33 +750,45 @@ class Asset(AccountsController): purchase_document = self.get_purchase_document() fixed_asset_account, cwip_account = self.get_fixed_asset_account(), self.get_cwip_account() - if (purchase_document and self.purchase_receipt_amount and self.available_for_use_date <= nowdate()): + if ( + purchase_document and self.purchase_receipt_amount and self.available_for_use_date <= nowdate() + ): - gl_entries.append(self.get_gl_dict({ - "account": cwip_account, - "against": fixed_asset_account, - "remarks": self.get("remarks") or _("Accounting Entry for Asset"), - "posting_date": self.available_for_use_date, - "credit": self.purchase_receipt_amount, - "credit_in_account_currency": self.purchase_receipt_amount, - "cost_center": self.cost_center - }, item=self)) + gl_entries.append( + self.get_gl_dict( + { + "account": cwip_account, + "against": fixed_asset_account, + "remarks": self.get("remarks") or _("Accounting Entry for Asset"), + "posting_date": self.available_for_use_date, + "credit": self.purchase_receipt_amount, + "credit_in_account_currency": self.purchase_receipt_amount, + "cost_center": self.cost_center, + }, + item=self, + ) + ) - gl_entries.append(self.get_gl_dict({ - "account": fixed_asset_account, - "against": cwip_account, - "remarks": self.get("remarks") or _("Accounting Entry for Asset"), - "posting_date": self.available_for_use_date, - "debit": self.purchase_receipt_amount, - "debit_in_account_currency": self.purchase_receipt_amount, - "cost_center": self.cost_center - }, item=self)) + gl_entries.append( + self.get_gl_dict( + { + "account": fixed_asset_account, + "against": cwip_account, + "remarks": self.get("remarks") or _("Accounting Entry for Asset"), + "posting_date": self.available_for_use_date, + "debit": self.purchase_receipt_amount, + "debit_in_account_currency": self.purchase_receipt_amount, + "cost_center": self.cost_center, + }, + item=self, + ) + ) if gl_entries: from erpnext.accounts.general_ledger import make_gl_entries make_gl_entries(gl_entries) - self.db_set('booked_fixed_asset', 1) + self.db_set("booked_fixed_asset", 1) @frappe.whitelist() def get_depreciation_rate(self, args, on_validate=False): @@ -637,20 +797,18 @@ class Asset(AccountsController): float_precision = cint(frappe.db.get_default("float_precision")) or 2 - if args.get("depreciation_method") == 'Double Declining Balance': + if args.get("depreciation_method") == "Double Declining Balance": return 200.0 / args.get("total_number_of_depreciations") if args.get("depreciation_method") == "Written Down Value": if args.get("rate_of_depreciation") and on_validate: return args.get("rate_of_depreciation") - no_of_years = flt(args.get("total_number_of_depreciations") * flt(args.get("frequency_of_depreciation"))) / 12 value = flt(args.get("expected_value_after_useful_life")) / flt(self.gross_purchase_amount) - # square root of flt(salvage_value) / flt(asset_cost) - depreciation_rate = math.pow(value, 1.0/flt(no_of_years, 2)) + depreciation_rate = math.pow(value, 1.0 / flt(args.get("total_number_of_depreciations"), 2)) - return 100 * (1 - flt(depreciation_rate, float_precision)) + return flt((100 * (1 - depreciation_rate)), float_precision) def get_pro_rata_amt(self, row, depreciation_amount, from_date, to_date): days = date_diff(to_date, from_date) @@ -659,93 +817,104 @@ class Asset(AccountsController): return (depreciation_amount * flt(days)) / flt(total_days), days, months + def update_maintenance_status(): - assets = frappe.get_all( - "Asset", filters={"docstatus": 1, "maintenance_required": 1} - ) + assets = frappe.get_all("Asset", filters={"docstatus": 1, "maintenance_required": 1}) for asset in assets: asset = frappe.get_doc("Asset", asset.name) if frappe.db.exists("Asset Repair", {"asset_name": asset.name, "repair_status": "Pending"}): asset.set_status("Out of Order") - elif frappe.db.exists("Asset Maintenance Task", {"parent": asset.name, "next_due_date": today()}): + elif frappe.db.exists( + "Asset Maintenance Task", {"parent": asset.name, "next_due_date": today()} + ): asset.set_status("In Maintenance") else: asset.set_status() + def make_post_gl_entry(): - asset_categories = frappe.db.get_all('Asset Category', fields = ['name', 'enable_cwip_accounting']) + asset_categories = frappe.db.get_all("Asset Category", fields=["name", "enable_cwip_accounting"]) for asset_category in asset_categories: if cint(asset_category.enable_cwip_accounting): - assets = frappe.db.sql_list(""" select name from `tabAsset` + assets = frappe.db.sql_list( + """ select name from `tabAsset` where asset_category = %s and ifnull(booked_fixed_asset, 0) = 0 - and available_for_use_date = %s""", (asset_category.name, nowdate())) + and available_for_use_date = %s""", + (asset_category.name, nowdate()), + ) for asset in assets: - doc = frappe.get_doc('Asset', asset) + doc = frappe.get_doc("Asset", asset) doc.make_gl_entries() + def get_asset_naming_series(): - meta = frappe.get_meta('Asset') + meta = frappe.get_meta("Asset") return meta.get_field("naming_series").options + @frappe.whitelist() def make_sales_invoice(asset, item_code, company, serial_no=None): si = frappe.new_doc("Sales Invoice") si.company = company - si.currency = frappe.get_cached_value('Company', company, "default_currency") + si.currency = frappe.get_cached_value("Company", company, "default_currency") disposal_account, depreciation_cost_center = get_disposal_account_and_cost_center(company) - si.append("items", { - "item_code": item_code, - "is_fixed_asset": 1, - "asset": asset, - "income_account": disposal_account, - "serial_no": serial_no, - "cost_center": depreciation_cost_center, - "qty": 1 - }) + si.append( + "items", + { + "item_code": item_code, + "is_fixed_asset": 1, + "asset": asset, + "income_account": disposal_account, + "serial_no": serial_no, + "cost_center": depreciation_cost_center, + "qty": 1, + }, + ) si.set_missing_values() return si + @frappe.whitelist() def create_asset_maintenance(asset, item_code, item_name, asset_category, company): asset_maintenance = frappe.new_doc("Asset Maintenance") - asset_maintenance.update({ - "asset_name": asset, - "company": company, - "item_code": item_code, - "item_name": item_name, - "asset_category": asset_category - }) + asset_maintenance.update( + { + "asset_name": asset, + "company": company, + "item_code": item_code, + "item_name": item_name, + "asset_category": asset_category, + } + ) return asset_maintenance + @frappe.whitelist() def create_asset_repair(asset, asset_name): asset_repair = frappe.new_doc("Asset Repair") - asset_repair.update({ - "asset": asset, - "asset_name": asset_name - }) + asset_repair.update({"asset": asset, "asset_name": asset_name}) return asset_repair + @frappe.whitelist() def create_asset_value_adjustment(asset, asset_category, company): asset_value_adjustment = frappe.new_doc("Asset Value Adjustment") - asset_value_adjustment.update({ - "asset": asset, - "company": company, - "asset_category": asset_category - }) + asset_value_adjustment.update( + {"asset": asset, "company": company, "asset_category": asset_category} + ) return asset_value_adjustment + @frappe.whitelist() def transfer_asset(args): args = json.loads(args) - if args.get('serial_no'): - args['quantity'] = len(args.get('serial_no').split('\n')) + if args.get("serial_no"): + args["quantity"] = len(args.get("serial_no").split("\n")) movement_entry = frappe.new_doc("Asset Movement") movement_entry.update(args) @@ -754,52 +923,73 @@ def transfer_asset(args): frappe.db.commit() - frappe.msgprint(_("Asset Movement record {0} created").format("{0}").format(movement_entry.name)) + frappe.msgprint( + _("Asset Movement record {0} created") + .format("{0}") + .format(movement_entry.name) + ) + @frappe.whitelist() def get_item_details(item_code, asset_category): - asset_category_doc = frappe.get_doc('Asset Category', asset_category) + asset_category_doc = frappe.get_doc("Asset Category", asset_category) books = [] for d in asset_category_doc.finance_books: - books.append({ - 'finance_book': d.finance_book, - 'depreciation_method': d.depreciation_method, - 'total_number_of_depreciations': d.total_number_of_depreciations, - 'frequency_of_depreciation': d.frequency_of_depreciation, - 'start_date': nowdate() - }) + books.append( + { + "finance_book": d.finance_book, + "depreciation_method": d.depreciation_method, + "total_number_of_depreciations": d.total_number_of_depreciations, + "frequency_of_depreciation": d.frequency_of_depreciation, + "start_date": nowdate(), + } + ) return books + def get_asset_account(account_name, asset=None, asset_category=None, company=None): account = None if asset: - account = get_asset_category_account(account_name, asset=asset, - asset_category = asset_category, company = company) + account = get_asset_category_account( + account_name, asset=asset, asset_category=asset_category, company=company + ) if not asset and not account: - account = get_asset_category_account(account_name, asset_category = asset_category, company = company) + account = get_asset_category_account( + account_name, asset_category=asset_category, company=company + ) if not account: - account = frappe.get_cached_value('Company', company, account_name) + account = frappe.get_cached_value("Company", company, account_name) if not account: if not asset_category: - frappe.throw(_("Set {0} in company {1}").format(account_name.replace('_', ' ').title(), company)) + frappe.throw( + _("Set {0} in company {1}").format(account_name.replace("_", " ").title(), company) + ) else: - frappe.throw(_("Set {0} in asset category {1} or company {2}") - .format(account_name.replace('_', ' ').title(), asset_category, company)) + frappe.throw( + _("Set {0} in asset category {1} or company {2}").format( + account_name.replace("_", " ").title(), asset_category, company + ) + ) return account + @frappe.whitelist() def make_journal_entry(asset_name): asset = frappe.get_doc("Asset", asset_name) - fixed_asset_account, accumulated_depreciation_account, depreciation_expense_account = \ - get_depreciation_accounts(asset) + ( + fixed_asset_account, + accumulated_depreciation_account, + depreciation_expense_account, + ) = get_depreciation_accounts(asset) - depreciation_cost_center, depreciation_series = frappe.db.get_value("Company", asset.company, - ["depreciation_cost_center", "series_for_depreciation_entry"]) + depreciation_cost_center, depreciation_series = frappe.db.get_value( + "Company", asset.company, ["depreciation_cost_center", "series_for_depreciation_entry"] + ) depreciation_cost_center = asset.cost_center or depreciation_cost_center je = frappe.new_doc("Journal Entry") @@ -808,21 +998,28 @@ def make_journal_entry(asset_name): je.company = asset.company je.remark = "Depreciation Entry against asset {0}".format(asset_name) - je.append("accounts", { - "account": depreciation_expense_account, - "reference_type": "Asset", - "reference_name": asset.name, - "cost_center": depreciation_cost_center - }) + je.append( + "accounts", + { + "account": depreciation_expense_account, + "reference_type": "Asset", + "reference_name": asset.name, + "cost_center": depreciation_cost_center, + }, + ) - je.append("accounts", { - "account": accumulated_depreciation_account, - "reference_type": "Asset", - "reference_name": asset.name - }) + je.append( + "accounts", + { + "account": accumulated_depreciation_account, + "reference_type": "Asset", + "reference_name": asset.name, + }, + ) return je + @frappe.whitelist() def make_asset_movement(assets, purpose=None): import json @@ -833,43 +1030,59 @@ def make_asset_movement(assets, purpose=None): assets = json.loads(assets) if len(assets) == 0: - frappe.throw(_('Atleast one asset has to be selected.')) + frappe.throw(_("Atleast one asset has to be selected.")) asset_movement = frappe.new_doc("Asset Movement") asset_movement.quantity = len(assets) for asset in assets: - asset = frappe.get_doc('Asset', asset.get('name')) - asset_movement.company = asset.get('company') - asset_movement.append("assets", { - 'asset': asset.get('name'), - 'source_location': asset.get('location'), - 'from_employee': asset.get('custodian') - }) + asset = frappe.get_doc("Asset", asset.get("name")) + asset_movement.company = asset.get("company") + asset_movement.append( + "assets", + { + "asset": asset.get("name"), + "source_location": asset.get("location"), + "from_employee": asset.get("custodian"), + }, + ) - if asset_movement.get('assets'): + if asset_movement.get("assets"): return asset_movement.as_dict() + def is_cwip_accounting_enabled(asset_category): return cint(frappe.db.get_value("Asset Category", asset_category, "enable_cwip_accounting")) + def get_total_days(date, frequency): - period_start_date = add_months(date, - cint(frequency) * -1) + period_start_date = add_months(date, cint(frequency) * -1) + + if is_last_day_of_the_month(date): + period_start_date = get_last_day(period_start_date) return date_diff(date, period_start_date) + +def is_last_day_of_the_month(date): + last_day_of_the_month = get_last_day(date) + + return getdate(last_day_of_the_month) == getdate(date) + + @erpnext.allow_regional def get_depreciation_amount(asset, depreciable_value, row): if row.depreciation_method in ("Straight Line", "Manual"): # if the Depreciation Schedule is being prepared for the first time if not asset.flags.increase_in_asset_life: - depreciation_amount = (flt(asset.gross_purchase_amount) - - flt(row.expected_value_after_useful_life)) / flt(row.total_number_of_depreciations) + depreciation_amount = ( + flt(asset.gross_purchase_amount) - flt(row.expected_value_after_useful_life) + ) / flt(row.total_number_of_depreciations) # if the Depreciation Schedule is being modified after Asset Repair else: - depreciation_amount = (flt(row.value_after_depreciation) - - flt(row.expected_value_after_useful_life)) / (date_diff(asset.to_date, asset.available_for_use_date) / 365) + depreciation_amount = ( + flt(row.value_after_depreciation) - flt(row.expected_value_after_useful_life) + ) / (date_diff(asset.to_date, asset.available_for_use_date) / 365) else: depreciation_amount = flt(depreciable_value * (flt(row.rate_of_depreciation) / 100)) diff --git a/erpnext/assets/doctype/asset/asset_dashboard.py b/erpnext/assets/doctype/asset/asset_dashboard.py index c9efe3d0848..9a45bcb0f9a 100644 --- a/erpnext/assets/doctype/asset/asset_dashboard.py +++ b/erpnext/assets/doctype/asset/asset_dashboard.py @@ -1,14 +1,8 @@ +from frappe import _ def get_data(): return { - 'non_standard_fieldnames': { - 'Asset Movement': 'asset' - }, - 'transactions': [ - { - 'label': ['Movement'], - 'items': ['Asset Movement'] - } - ] + "non_standard_fieldnames": {"Asset Movement": "asset"}, + "transactions": [{"label": _("Movement"), "items": ["Asset Movement"]}], } diff --git a/erpnext/assets/doctype/asset/depreciation.py b/erpnext/assets/doctype/asset/depreciation.py index 874fb630f87..3f7e9459943 100644 --- a/erpnext/assets/doctype/asset/depreciation.py +++ b/erpnext/assets/doctype/asset/depreciation.py @@ -13,7 +13,9 @@ from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import ( def post_depreciation_entries(date=None): # Return if automatic booking of asset depreciation is disabled - if not cint(frappe.db.get_value("Accounts Settings", None, "book_asset_depreciation_entry_automatically")): + if not cint( + frappe.db.get_value("Accounts Settings", None, "book_asset_depreciation_entry_automatically") + ): return if not date: @@ -22,26 +24,35 @@ def post_depreciation_entries(date=None): make_depreciation_entry(asset, date) frappe.db.commit() + def get_depreciable_assets(date): - return frappe.db.sql_list("""select a.name + return frappe.db.sql_list( + """select distinct a.name from tabAsset a, `tabDepreciation Schedule` ds where a.name = ds.parent and a.docstatus=1 and ds.schedule_date<=%s and a.calculate_depreciation = 1 and a.status in ('Submitted', 'Partially Depreciated') - and ifnull(ds.journal_entry, '')=''""", date) + and ifnull(ds.journal_entry, '')=''""", + date, + ) + @frappe.whitelist() def make_depreciation_entry(asset_name, date=None): - frappe.has_permission('Journal Entry', throw=True) + frappe.has_permission("Journal Entry", throw=True) if not date: date = today() asset = frappe.get_doc("Asset", asset_name) - fixed_asset_account, accumulated_depreciation_account, depreciation_expense_account = \ - get_depreciation_accounts(asset) + ( + fixed_asset_account, + accumulated_depreciation_account, + depreciation_expense_account, + ) = get_depreciation_accounts(asset) - depreciation_cost_center, depreciation_series = frappe.get_cached_value('Company', asset.company, - ["depreciation_cost_center", "series_for_depreciation_entry"]) + depreciation_cost_center, depreciation_series = frappe.get_cached_value( + "Company", asset.company, ["depreciation_cost_center", "series_for_depreciation_entry"] + ) depreciation_cost_center = asset.cost_center or depreciation_cost_center @@ -57,14 +68,16 @@ def make_depreciation_entry(asset_name, date=None): je.finance_book = d.finance_book je.remark = "Depreciation Entry against {0} worth {1}".format(asset_name, d.depreciation_amount) - credit_account, debit_account = get_credit_and_debit_accounts(accumulated_depreciation_account, depreciation_expense_account) + credit_account, debit_account = get_credit_and_debit_accounts( + accumulated_depreciation_account, depreciation_expense_account + ) credit_entry = { "account": credit_account, "credit_in_account_currency": d.depreciation_amount, "reference_type": "Asset", "reference_name": asset.name, - "cost_center": depreciation_cost_center + "cost_center": depreciation_cost_center, } debit_entry = { @@ -72,19 +85,25 @@ def make_depreciation_entry(asset_name, date=None): "debit_in_account_currency": d.depreciation_amount, "reference_type": "Asset", "reference_name": asset.name, - "cost_center": depreciation_cost_center + "cost_center": depreciation_cost_center, } for dimension in accounting_dimensions: - if (asset.get(dimension['fieldname']) or dimension.get('mandatory_for_bs')): - credit_entry.update({ - dimension['fieldname']: asset.get(dimension['fieldname']) or dimension.get('default_dimension') - }) + if asset.get(dimension["fieldname"]) or dimension.get("mandatory_for_bs"): + credit_entry.update( + { + dimension["fieldname"]: asset.get(dimension["fieldname"]) + or dimension.get("default_dimension") + } + ) - if (asset.get(dimension['fieldname']) or dimension.get('mandatory_for_pl')): - debit_entry.update({ - dimension['fieldname']: asset.get(dimension['fieldname']) or dimension.get('default_dimension') - }) + if asset.get(dimension["fieldname"]) or dimension.get("mandatory_for_pl"): + debit_entry.update( + { + dimension["fieldname"]: asset.get(dimension["fieldname"]) + or dimension.get("default_dimension") + } + ) je.append("accounts", credit_entry) @@ -98,7 +117,7 @@ def make_depreciation_entry(asset_name, date=None): d.db_set("journal_entry", je.name) idx = cint(d.finance_book_id) - finance_books = asset.get('finance_books')[idx - 1] + finance_books = asset.get("finance_books")[idx - 1] finance_books.value_after_depreciation -= d.depreciation_amount finance_books.db_update() @@ -106,13 +125,20 @@ def make_depreciation_entry(asset_name, date=None): return asset + def get_depreciation_accounts(asset): fixed_asset_account = accumulated_depreciation_account = depreciation_expense_account = None - accounts = frappe.db.get_value("Asset Category Account", - filters={'parent': asset.asset_category, 'company_name': asset.company}, - fieldname = ['fixed_asset_account', 'accumulated_depreciation_account', - 'depreciation_expense_account'], as_dict=1) + accounts = frappe.db.get_value( + "Asset Category Account", + filters={"parent": asset.asset_category, "company_name": asset.company}, + fieldname=[ + "fixed_asset_account", + "accumulated_depreciation_account", + "depreciation_expense_account", + ], + as_dict=1, + ) if accounts: fixed_asset_account = accounts.fixed_asset_account @@ -120,20 +146,29 @@ def get_depreciation_accounts(asset): depreciation_expense_account = accounts.depreciation_expense_account if not accumulated_depreciation_account or not depreciation_expense_account: - accounts = frappe.get_cached_value('Company', asset.company, - ["accumulated_depreciation_account", "depreciation_expense_account"]) + accounts = frappe.get_cached_value( + "Company", asset.company, ["accumulated_depreciation_account", "depreciation_expense_account"] + ) if not accumulated_depreciation_account: accumulated_depreciation_account = accounts[0] if not depreciation_expense_account: depreciation_expense_account = accounts[1] - if not fixed_asset_account or not accumulated_depreciation_account or not depreciation_expense_account: - frappe.throw(_("Please set Depreciation related Accounts in Asset Category {0} or Company {1}") - .format(asset.asset_category, asset.company)) + if ( + not fixed_asset_account + or not accumulated_depreciation_account + or not depreciation_expense_account + ): + frappe.throw( + _("Please set Depreciation related Accounts in Asset Category {0} or Company {1}").format( + asset.asset_category, asset.company + ) + ) return fixed_asset_account, accumulated_depreciation_account, depreciation_expense_account + def get_credit_and_debit_accounts(accumulated_depreciation_account, depreciation_expense_account): root_type = frappe.get_value("Account", depreciation_expense_account, "root_type") @@ -148,6 +183,7 @@ def get_credit_and_debit_accounts(accumulated_depreciation_account, depreciation return credit_account, debit_account + @frappe.whitelist() def scrap_asset(asset_name): asset = frappe.get_doc("Asset", asset_name) @@ -155,9 +191,13 @@ def scrap_asset(asset_name): if asset.docstatus != 1: frappe.throw(_("Asset {0} must be submitted").format(asset.name)) elif asset.status in ("Cancelled", "Sold", "Scrapped"): - frappe.throw(_("Asset {0} cannot be scrapped, as it is already {1}").format(asset.name, asset.status)) + frappe.throw( + _("Asset {0} cannot be scrapped, as it is already {1}").format(asset.name, asset.status) + ) - depreciation_series = frappe.get_cached_value('Company', asset.company, "series_for_depreciation_entry") + depreciation_series = frappe.get_cached_value( + "Company", asset.company, "series_for_depreciation_entry" + ) je = frappe.new_doc("Journal Entry") je.voucher_type = "Journal Entry" @@ -167,10 +207,7 @@ def scrap_asset(asset_name): je.remark = "Scrap Entry for asset {0}".format(asset_name) for entry in get_gl_entries_on_asset_disposal(asset): - entry.update({ - "reference_type": "Asset", - "reference_name": asset_name - }) + entry.update({"reference_type": "Asset", "reference_name": asset_name}) je.append("accounts", entry) je.flags.ignore_permissions = True @@ -182,6 +219,7 @@ def scrap_asset(asset_name): frappe.msgprint(_("Asset scrapped via Journal Entry {0}").format(je.name)) + @frappe.whitelist() def restore_asset(asset_name): asset = frappe.get_doc("Asset", asset_name) @@ -195,23 +233,31 @@ def restore_asset(asset_name): asset.set_status() + def get_gl_entries_on_asset_regain(asset, selling_amount=0, finance_book=None): - fixed_asset_account, asset, depreciation_cost_center, accumulated_depr_account, accumulated_depr_amount, disposal_account, value_after_depreciation = \ - get_asset_details(asset, finance_book) + ( + fixed_asset_account, + asset, + depreciation_cost_center, + accumulated_depr_account, + accumulated_depr_amount, + disposal_account, + value_after_depreciation, + ) = get_asset_details(asset, finance_book) gl_entries = [ { "account": fixed_asset_account, "debit_in_account_currency": asset.gross_purchase_amount, "debit": asset.gross_purchase_amount, - "cost_center": depreciation_cost_center + "cost_center": depreciation_cost_center, }, { "account": accumulated_depr_account, "credit_in_account_currency": accumulated_depr_amount, "credit": accumulated_depr_amount, - "cost_center": depreciation_cost_center - } + "cost_center": depreciation_cost_center, + }, ] profit_amount = abs(flt(value_after_depreciation)) - abs(flt(selling_amount)) @@ -220,23 +266,31 @@ def get_gl_entries_on_asset_regain(asset, selling_amount=0, finance_book=None): return gl_entries + def get_gl_entries_on_asset_disposal(asset, selling_amount=0, finance_book=None): - fixed_asset_account, asset, depreciation_cost_center, accumulated_depr_account, accumulated_depr_amount, disposal_account, value_after_depreciation = \ - get_asset_details(asset, finance_book) + ( + fixed_asset_account, + asset, + depreciation_cost_center, + accumulated_depr_account, + accumulated_depr_amount, + disposal_account, + value_after_depreciation, + ) = get_asset_details(asset, finance_book) gl_entries = [ { "account": fixed_asset_account, "credit_in_account_currency": asset.gross_purchase_amount, "credit": asset.gross_purchase_amount, - "cost_center": depreciation_cost_center + "cost_center": depreciation_cost_center, }, { "account": accumulated_depr_account, "debit_in_account_currency": accumulated_depr_amount, "debit": accumulated_depr_amount, - "cost_center": depreciation_cost_center - } + "cost_center": depreciation_cost_center, + }, ] profit_amount = flt(selling_amount) - flt(value_after_depreciation) @@ -245,8 +299,11 @@ def get_gl_entries_on_asset_disposal(asset, selling_amount=0, finance_book=None) return gl_entries + def get_asset_details(asset, finance_book=None): - fixed_asset_account, accumulated_depr_account, depr_expense_account = get_depreciation_accounts(asset) + fixed_asset_account, accumulated_depr_account, depr_expense_account = get_depreciation_accounts( + asset + ) disposal_account, depreciation_cost_center = get_disposal_account_and_cost_center(asset.company) depreciation_cost_center = asset.cost_center or depreciation_cost_center @@ -257,28 +314,46 @@ def get_asset_details(asset, finance_book=None): idx = d.idx break - value_after_depreciation = (asset.finance_books[idx - 1].value_after_depreciation - if asset.calculate_depreciation else asset.value_after_depreciation) + value_after_depreciation = ( + asset.finance_books[idx - 1].value_after_depreciation + if asset.calculate_depreciation + else asset.value_after_depreciation + ) accumulated_depr_amount = flt(asset.gross_purchase_amount) - flt(value_after_depreciation) - return fixed_asset_account, asset, depreciation_cost_center, accumulated_depr_account, accumulated_depr_amount, disposal_account, value_after_depreciation + return ( + fixed_asset_account, + asset, + depreciation_cost_center, + accumulated_depr_account, + accumulated_depr_amount, + disposal_account, + value_after_depreciation, + ) + def get_profit_gl_entries(profit_amount, gl_entries, disposal_account, depreciation_cost_center): debit_or_credit = "debit" if profit_amount < 0 else "credit" - gl_entries.append({ - "account": disposal_account, - "cost_center": depreciation_cost_center, - debit_or_credit: abs(profit_amount), - debit_or_credit + "_in_account_currency": abs(profit_amount) - }) + gl_entries.append( + { + "account": disposal_account, + "cost_center": depreciation_cost_center, + debit_or_credit: abs(profit_amount), + debit_or_credit + "_in_account_currency": abs(profit_amount), + } + ) + @frappe.whitelist() def get_disposal_account_and_cost_center(company): - disposal_account, depreciation_cost_center = frappe.get_cached_value('Company', company, - ["disposal_account", "depreciation_cost_center"]) + disposal_account, depreciation_cost_center = frappe.get_cached_value( + "Company", company, ["disposal_account", "depreciation_cost_center"] + ) if not disposal_account: - frappe.throw(_("Please set 'Gain/Loss Account on Asset Disposal' in Company {0}").format(company)) + frappe.throw( + _("Please set 'Gain/Loss Account on Asset Disposal' in Company {0}").format(company) + ) if not depreciation_cost_center: frappe.throw(_("Please set 'Asset Depreciation Cost Center' in Company {0}").format(company)) diff --git a/erpnext/assets/doctype/asset/test_asset.py b/erpnext/assets/doctype/asset/test_asset.py index ba4dbee72da..13475f34c39 100644 --- a/erpnext/assets/doctype/asset/test_asset.py +++ b/erpnext/assets/doctype/asset/test_asset.py @@ -32,6 +32,7 @@ class AssetSetup(unittest.TestCase): def tearDownClass(cls): frappe.db.rollback() + class TestAsset(AssetSetup): def test_asset_category_is_fetched(self): """Tests if the Item's Asset Category value is assigned to the Asset, if the field is empty.""" @@ -52,7 +53,7 @@ class TestAsset(AssetSetup): """Tests if either PI or PR is present if CWIP is enabled and is_existing_asset=0.""" asset = create_asset(item_code="Macbook Pro", do_not_save=1) - asset.is_existing_asset=0 + asset.is_existing_asset = 0 self.assertRaises(frappe.ValidationError, asset.save) @@ -67,7 +68,7 @@ class TestAsset(AssetSetup): def test_item_exists(self): asset = create_asset(item_code="MacBook", do_not_save=1) - self.assertRaises(frappe.DoesNotExistError, asset.save) + self.assertRaises(frappe.ValidationError, asset.save) def test_validate_item(self): asset = create_asset(item_code="MacBook Pro", do_not_save=1) @@ -86,11 +87,12 @@ class TestAsset(AssetSetup): self.assertRaises(frappe.ValidationError, asset.save) def test_purchase_asset(self): - pr = make_purchase_receipt(item_code="Macbook Pro", - qty=1, rate=100000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=1, rate=100000.0, location="Test Location" + ) - asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, 'name') - asset = frappe.get_doc('Asset', asset_name) + asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, "name") + asset = frappe.get_doc("Asset", asset_name) asset.calculate_depreciation = 1 month_end_date = get_last_day(nowdate()) @@ -98,13 +100,16 @@ class TestAsset(AssetSetup): asset.available_for_use_date = purchase_date asset.purchase_date = purchase_date - asset.append("finance_books", { - "expected_value_after_useful_life": 10000, - "depreciation_method": "Straight Line", - "total_number_of_depreciations": 3, - "frequency_of_depreciation": 10, - "depreciation_start_date": month_end_date - }) + asset.append( + "finance_books", + { + "expected_value_after_useful_life": 10000, + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 3, + "frequency_of_depreciation": 10, + "depreciation_start_date": month_end_date, + }, + ) asset.submit() pi = make_invoice(pr.name) @@ -119,12 +124,15 @@ class TestAsset(AssetSetup): expected_gle = ( ("Asset Received But Not Billed - _TC", 100000.0, 0.0), - ("Creditors - _TC", 0.0, 100000.0) + ("Creditors - _TC", 0.0, 100000.0), ) - gle = frappe.db.sql("""select account, debit, credit from `tabGL Entry` + gle = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no = %s - order by account""", pi.name) + order by account""", + pi.name, + ) self.assertEqual(gle, expected_gle) pi.cancel() @@ -135,30 +143,27 @@ class TestAsset(AssetSetup): self.assertEqual(asset.docstatus, 2) def test_is_fixed_asset_set(self): - asset = create_asset(is_existing_asset = 1) - doc = frappe.new_doc('Purchase Invoice') - doc.supplier = '_Test Supplier' - doc.append('items', { - 'item_code': 'Macbook Pro', - 'qty': 1, - 'asset': asset.name - }) + asset = create_asset(is_existing_asset=1) + doc = frappe.new_doc("Purchase Invoice") + doc.company = "_Test Company" + doc.supplier = "_Test Supplier" + doc.append("items", {"item_code": "Macbook Pro", "qty": 1, "asset": asset.name}) doc.set_missing_values() self.assertEqual(doc.items[0].is_fixed_asset, 1) def test_scrap_asset(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = '2020-01-01', - purchase_date = '2020-01-01', - expected_value_after_useful_life = 10000, - total_number_of_depreciations = 10, - frequency_of_depreciation = 1, - submit = 1 + calculate_depreciation=1, + available_for_use_date="2020-01-01", + purchase_date="2020-01-01", + expected_value_after_useful_life=10000, + total_number_of_depreciations=10, + frequency_of_depreciation=1, + submit=1, ) - post_depreciation_entries(date=add_months('2020-01-01', 4)) + post_depreciation_entries(date=add_months("2020-01-01", 4)) scrap_asset(asset.name) @@ -169,12 +174,15 @@ class TestAsset(AssetSetup): expected_gle = ( ("_Test Accumulated Depreciations - _TC", 36000.0, 0.0), ("_Test Fixed Asset - _TC", 0.0, 100000.0), - ("_Test Gain/Loss on Asset Disposal - _TC", 64000.0, 0.0) + ("_Test Gain/Loss on Asset Disposal - _TC", 64000.0, 0.0), ) - gle = frappe.db.sql("""select account, debit, credit from `tabGL Entry` + gle = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Journal Entry' and voucher_no = %s - order by account""", asset.journal_entry_for_scrap) + order by account""", + asset.journal_entry_for_scrap, + ) self.assertEqual(gle, expected_gle) restore_asset(asset.name) @@ -185,83 +193,102 @@ class TestAsset(AssetSetup): def test_gle_made_by_asset_sale(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = '2020-06-06', - purchase_date = '2020-01-01', - expected_value_after_useful_life = 10000, - total_number_of_depreciations = 3, - frequency_of_depreciation = 10, - depreciation_start_date = '2020-12-31', - submit = 1 + calculate_depreciation=1, + available_for_use_date="2020-06-06", + purchase_date="2020-01-01", + expected_value_after_useful_life=10000, + total_number_of_depreciations=3, + frequency_of_depreciation=10, + depreciation_start_date="2020-12-31", + submit=1, ) - post_depreciation_entries(date="2021-01-01") si = make_sales_invoice(asset=asset.name, item_code="Macbook Pro", company="_Test Company") si.customer = "_Test Customer" - si.due_date = nowdate() - si.get("items")[0].rate = 25000 - si.insert() + si.set_posting_time = 1 + si.posting_date = "2021-10-31" + si.due_date = "2021-10-31" + si.get("items")[0].rate = 75000 si.submit() self.assertEqual(frappe.db.get_value("Asset", asset.name, "status"), "Sold") expected_gle = ( - ("_Test Accumulated Depreciations - _TC", 20392.16, 0.0), + ("_Test Accumulated Depreciations - _TC", 50490.2, 0.0), ("_Test Fixed Asset - _TC", 0.0, 100000.0), - ("_Test Gain/Loss on Asset Disposal - _TC", 54607.84, 0.0), - ("Debtors - _TC", 25000.0, 0.0) + ("_Test Gain/Loss on Asset Disposal - _TC", 0.0, 25490.2), + ("Debtors - _TC", 75000.0, 0.0), ) - gle = frappe.db.sql("""select account, debit, credit from `tabGL Entry` + gle = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Sales Invoice' and voucher_no = %s - order by account""", si.name) + order by account""", + si.name, + ) - self.assertEqual(gle, expected_gle) + for i, gle_entry in enumerate(gle): + self.assertEqual(gle_entry[0], expected_gle[i][0]) + self.assertEqual(flt(gle_entry[1], 1), flt(expected_gle[i][1], 1)) + self.assertEqual(flt(gle_entry[2], 1), flt(expected_gle[i][2], 1)) + si.load_from_db() si.cancel() + self.assertEqual(frappe.db.get_value("Asset", asset.name, "status"), "Partially Depreciated") def test_expense_head(self): - pr = make_purchase_receipt(item_code="Macbook Pro", - qty=2, rate=200000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=2, rate=200000.0, location="Test Location" + ) doc = make_invoice(pr.name) - self.assertEqual('Asset Received But Not Billed - _TC', doc.items[0].expense_account) + self.assertEqual("Asset Received But Not Billed - _TC", doc.items[0].expense_account) # CWIP: Capital Work In Progress def test_cwip_accounting(self): - pr = make_purchase_receipt(item_code="Macbook Pro", - qty=1, rate=5000, do_not_submit=True, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=1, rate=5000, do_not_submit=True, location="Test Location" + ) - pr.set('taxes', [{ - 'category': 'Total', - 'add_deduct_tax': 'Add', - 'charge_type': 'On Net Total', - 'account_head': '_Test Account Service Tax - _TC', - 'description': '_Test Account Service Tax', - 'cost_center': 'Main - _TC', - 'rate': 5.0 - }, { - 'category': 'Valuation and Total', - 'add_deduct_tax': 'Add', - 'charge_type': 'On Net Total', - 'account_head': '_Test Account Shipping Charges - _TC', - 'description': '_Test Account Shipping Charges', - 'cost_center': 'Main - _TC', - 'rate': 5.0 - }]) + pr.set( + "taxes", + [ + { + "category": "Total", + "add_deduct_tax": "Add", + "charge_type": "On Net Total", + "account_head": "_Test Account Service Tax - _TC", + "description": "_Test Account Service Tax", + "cost_center": "Main - _TC", + "rate": 5.0, + }, + { + "category": "Valuation and Total", + "add_deduct_tax": "Add", + "charge_type": "On Net Total", + "account_head": "_Test Account Shipping Charges - _TC", + "description": "_Test Account Shipping Charges", + "cost_center": "Main - _TC", + "rate": 5.0, + }, + ], + ) pr.submit() expected_gle = ( ("Asset Received But Not Billed - _TC", 0.0, 5250.0), - ("CWIP Account - _TC", 5250.0, 0.0) + ("CWIP Account - _TC", 5250.0, 0.0), ) - pr_gle = frappe.db.sql("""select account, debit, credit from `tabGL Entry` + pr_gle = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Purchase Receipt' and voucher_no = %s - order by account""", pr.name) + order by account""", + pr.name, + ) self.assertEqual(pr_gle, expected_gle) @@ -276,45 +303,53 @@ class TestAsset(AssetSetup): ("Expenses Included In Asset Valuation - _TC", 0.0, 250.0), ) - pi_gle = frappe.db.sql("""select account, debit, credit from `tabGL Entry` + pi_gle = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Purchase Invoice' and voucher_no = %s - order by account""", pi.name) + order by account""", + pi.name, + ) self.assertEqual(pi_gle, expected_gle) - asset = frappe.db.get_value('Asset', - {'purchase_receipt': pr.name, 'docstatus': 0}, 'name') + asset = frappe.db.get_value("Asset", {"purchase_receipt": pr.name, "docstatus": 0}, "name") - asset_doc = frappe.get_doc('Asset', asset) + asset_doc = frappe.get_doc("Asset", asset) month_end_date = get_last_day(nowdate()) - asset_doc.available_for_use_date = nowdate() if nowdate() != month_end_date else add_days(nowdate(), -15) + asset_doc.available_for_use_date = ( + nowdate() if nowdate() != month_end_date else add_days(nowdate(), -15) + ) self.assertEqual(asset_doc.gross_purchase_amount, 5250.0) - asset_doc.append("finance_books", { - "expected_value_after_useful_life": 200, - "depreciation_method": "Straight Line", - "total_number_of_depreciations": 3, - "frequency_of_depreciation": 10, - "depreciation_start_date": month_end_date - }) + asset_doc.append( + "finance_books", + { + "expected_value_after_useful_life": 200, + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 3, + "frequency_of_depreciation": 10, + "depreciation_start_date": month_end_date, + }, + ) asset_doc.submit() - expected_gle = ( - ("_Test Fixed Asset - _TC", 5250.0, 0.0), - ("CWIP Account - _TC", 0.0, 5250.0) - ) + expected_gle = (("_Test Fixed Asset - _TC", 5250.0, 0.0), ("CWIP Account - _TC", 0.0, 5250.0)) - gle = frappe.db.sql("""select account, debit, credit from `tabGL Entry` + gle = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s - order by account""", asset_doc.name) - + order by account""", + asset_doc.name, + ) self.assertEqual(gle, expected_gle) def test_asset_cwip_toggling_cases(self): cwip = frappe.db.get_value("Asset Category", "Computers", "enable_cwip_accounting") - name = frappe.db.get_value("Asset Category Account", filters={"parent": "Computers"}, fieldname=["name"]) + name = frappe.db.get_value( + "Asset Category Account", filters={"parent": "Computers"}, fieldname=["name"] + ) cwip_acc = "CWIP Account - _TC" frappe.db.set_value("Asset Category", "Computers", "enable_cwip_accounting", 0) @@ -322,197 +357,231 @@ class TestAsset(AssetSetup): frappe.db.get_value("Company", "_Test Company", "capital_work_in_progress_account", "") # case 0 -- PI with cwip disable, Asset with cwip disabled, No cwip account set - pi = make_purchase_invoice(item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location", update_stock=1) - asset = frappe.db.get_value('Asset', {'purchase_invoice': pi.name, 'docstatus': 0}, 'name') - asset_doc = frappe.get_doc('Asset', asset) + pi = make_purchase_invoice( + item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location", update_stock=1 + ) + asset = frappe.db.get_value("Asset", {"purchase_invoice": pi.name, "docstatus": 0}, "name") + asset_doc = frappe.get_doc("Asset", asset) asset_doc.available_for_use_date = nowdate() asset_doc.calculate_depreciation = 0 asset_doc.submit() - gle = frappe.db.sql("""select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", asset_doc.name) + gle = frappe.db.sql( + """select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", + asset_doc.name, + ) self.assertFalse(gle) # case 1 -- PR with cwip disabled, Asset with cwip enabled - pr = make_purchase_receipt(item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location" + ) frappe.db.set_value("Asset Category", "Computers", "enable_cwip_accounting", 1) frappe.db.set_value("Asset Category Account", name, "capital_work_in_progress_account", cwip_acc) - asset = frappe.db.get_value('Asset', {'purchase_receipt': pr.name, 'docstatus': 0}, 'name') - asset_doc = frappe.get_doc('Asset', asset) + asset = frappe.db.get_value("Asset", {"purchase_receipt": pr.name, "docstatus": 0}, "name") + asset_doc = frappe.get_doc("Asset", asset) asset_doc.available_for_use_date = nowdate() asset_doc.calculate_depreciation = 0 asset_doc.submit() - gle = frappe.db.sql("""select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", asset_doc.name) + gle = frappe.db.sql( + """select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", + asset_doc.name, + ) self.assertFalse(gle) # case 2 -- PR with cwip enabled, Asset with cwip disabled - pr = make_purchase_receipt(item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location" + ) frappe.db.set_value("Asset Category", "Computers", "enable_cwip_accounting", 0) - asset = frappe.db.get_value('Asset', {'purchase_receipt': pr.name, 'docstatus': 0}, 'name') - asset_doc = frappe.get_doc('Asset', asset) + asset = frappe.db.get_value("Asset", {"purchase_receipt": pr.name, "docstatus": 0}, "name") + asset_doc = frappe.get_doc("Asset", asset) asset_doc.available_for_use_date = nowdate() asset_doc.calculate_depreciation = 0 asset_doc.submit() - gle = frappe.db.sql("""select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", asset_doc.name) + gle = frappe.db.sql( + """select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", + asset_doc.name, + ) self.assertTrue(gle) # case 3 -- PI with cwip disabled, Asset with cwip enabled - pi = make_purchase_invoice(item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location", update_stock=1) + pi = make_purchase_invoice( + item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location", update_stock=1 + ) frappe.db.set_value("Asset Category", "Computers", "enable_cwip_accounting", 1) - asset = frappe.db.get_value('Asset', {'purchase_invoice': pi.name, 'docstatus': 0}, 'name') - asset_doc = frappe.get_doc('Asset', asset) + asset = frappe.db.get_value("Asset", {"purchase_invoice": pi.name, "docstatus": 0}, "name") + asset_doc = frappe.get_doc("Asset", asset) asset_doc.available_for_use_date = nowdate() asset_doc.calculate_depreciation = 0 asset_doc.submit() - gle = frappe.db.sql("""select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", asset_doc.name) + gle = frappe.db.sql( + """select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", + asset_doc.name, + ) self.assertFalse(gle) # case 4 -- PI with cwip enabled, Asset with cwip disabled - pi = make_purchase_invoice(item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location", update_stock=1) + pi = make_purchase_invoice( + item_code="Macbook Pro", qty=1, rate=200000.0, location="Test Location", update_stock=1 + ) frappe.db.set_value("Asset Category", "Computers", "enable_cwip_accounting", 0) - asset = frappe.db.get_value('Asset', {'purchase_invoice': pi.name, 'docstatus': 0}, 'name') - asset_doc = frappe.get_doc('Asset', asset) + asset = frappe.db.get_value("Asset", {"purchase_invoice": pi.name, "docstatus": 0}, "name") + asset_doc = frappe.get_doc("Asset", asset) asset_doc.available_for_use_date = nowdate() asset_doc.calculate_depreciation = 0 asset_doc.submit() - gle = frappe.db.sql("""select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", asset_doc.name) + gle = frappe.db.sql( + """select name from `tabGL Entry` where voucher_type='Asset' and voucher_no = %s""", + asset_doc.name, + ) self.assertTrue(gle) frappe.db.set_value("Asset Category", "Computers", "enable_cwip_accounting", cwip) frappe.db.set_value("Asset Category Account", name, "capital_work_in_progress_account", cwip_acc) frappe.db.get_value("Company", "_Test Company", "capital_work_in_progress_account", cwip_acc) + class TestDepreciationMethods(AssetSetup): def test_schedule_for_straight_line_method(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = "2030-01-01", - purchase_date = "2030-01-01", - expected_value_after_useful_life = 10000, - depreciation_start_date = "2030-12-31", - total_number_of_depreciations = 3, - frequency_of_depreciation = 12 + calculate_depreciation=1, + available_for_use_date="2030-01-01", + purchase_date="2030-01-01", + expected_value_after_useful_life=10000, + depreciation_start_date="2030-12-31", + total_number_of_depreciations=3, + frequency_of_depreciation=12, ) self.assertEqual(asset.status, "Draft") expected_schedules = [ ["2030-12-31", 30000.00, 30000.00], ["2031-12-31", 30000.00, 60000.00], - ["2032-12-31", 30000.00, 90000.00] + ["2032-12-31", 30000.00, 90000.00], ] - schedules = [[cstr(d.schedule_date), d.depreciation_amount, d.accumulated_depreciation_amount] - for d in asset.get("schedules")] + schedules = [ + [cstr(d.schedule_date), d.depreciation_amount, d.accumulated_depreciation_amount] + for d in asset.get("schedules") + ] self.assertEqual(schedules, expected_schedules) def test_schedule_for_straight_line_method_for_existing_asset(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = "2030-06-06", - is_existing_asset = 1, - number_of_depreciations_booked = 2, - opening_accumulated_depreciation = 47095.89, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2032-12-31", - total_number_of_depreciations = 3, - frequency_of_depreciation = 12 + calculate_depreciation=1, + available_for_use_date="2030-06-06", + is_existing_asset=1, + number_of_depreciations_booked=2, + opening_accumulated_depreciation=47095.89, + expected_value_after_useful_life=10000, + depreciation_start_date="2032-12-31", + total_number_of_depreciations=3, + frequency_of_depreciation=12, ) self.assertEqual(asset.status, "Draft") - expected_schedules = [ - ["2032-12-31", 30000.0, 77095.89], - ["2033-06-06", 12904.11, 90000.0] + expected_schedules = [["2032-12-31", 30000.0, 77095.89], ["2033-06-06", 12904.11, 90000.0]] + schedules = [ + [cstr(d.schedule_date), flt(d.depreciation_amount, 2), d.accumulated_depreciation_amount] + for d in asset.get("schedules") ] - schedules = [[cstr(d.schedule_date), flt(d.depreciation_amount, 2), d.accumulated_depreciation_amount] - for d in asset.get("schedules")] self.assertEqual(schedules, expected_schedules) def test_schedule_for_double_declining_method(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = "2030-01-01", - purchase_date = "2030-01-01", - depreciation_method = "Double Declining Balance", - expected_value_after_useful_life = 10000, - depreciation_start_date = "2030-12-31", - total_number_of_depreciations = 3, - frequency_of_depreciation = 12 + calculate_depreciation=1, + available_for_use_date="2030-01-01", + purchase_date="2030-01-01", + depreciation_method="Double Declining Balance", + expected_value_after_useful_life=10000, + depreciation_start_date="2030-12-31", + total_number_of_depreciations=3, + frequency_of_depreciation=12, ) self.assertEqual(asset.status, "Draft") expected_schedules = [ - ['2030-12-31', 66667.00, 66667.00], - ['2031-12-31', 22222.11, 88889.11], - ['2032-12-31', 1110.89, 90000.0] + ["2030-12-31", 66667.00, 66667.00], + ["2031-12-31", 22222.11, 88889.11], + ["2032-12-31", 1110.89, 90000.0], ] - schedules = [[cstr(d.schedule_date), d.depreciation_amount, d.accumulated_depreciation_amount] - for d in asset.get("schedules")] + schedules = [ + [cstr(d.schedule_date), d.depreciation_amount, d.accumulated_depreciation_amount] + for d in asset.get("schedules") + ] self.assertEqual(schedules, expected_schedules) def test_schedule_for_double_declining_method_for_existing_asset(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = "2030-01-01", - is_existing_asset = 1, - depreciation_method = "Double Declining Balance", - number_of_depreciations_booked = 1, - opening_accumulated_depreciation = 50000, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2030-12-31", - total_number_of_depreciations = 3, - frequency_of_depreciation = 12 + calculate_depreciation=1, + available_for_use_date="2030-01-01", + is_existing_asset=1, + depreciation_method="Double Declining Balance", + number_of_depreciations_booked=1, + opening_accumulated_depreciation=50000, + expected_value_after_useful_life=10000, + depreciation_start_date="2030-12-31", + total_number_of_depreciations=3, + frequency_of_depreciation=12, ) self.assertEqual(asset.status, "Draft") - expected_schedules = [ - ["2030-12-31", 33333.50, 83333.50], - ["2031-12-31", 6666.50, 90000.0] - ] + expected_schedules = [["2030-12-31", 33333.50, 83333.50], ["2031-12-31", 6666.50, 90000.0]] - schedules = [[cstr(d.schedule_date), d.depreciation_amount, d.accumulated_depreciation_amount] - for d in asset.get("schedules")] + schedules = [ + [cstr(d.schedule_date), d.depreciation_amount, d.accumulated_depreciation_amount] + for d in asset.get("schedules") + ] self.assertEqual(schedules, expected_schedules) def test_schedule_for_prorated_straight_line_method(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = "2030-01-30", - purchase_date = "2030-01-30", - depreciation_method = "Straight Line", - expected_value_after_useful_life = 10000, - depreciation_start_date = "2030-12-31", - total_number_of_depreciations = 3, - frequency_of_depreciation = 12 + calculate_depreciation=1, + available_for_use_date="2030-01-30", + purchase_date="2030-01-30", + depreciation_method="Straight Line", + expected_value_after_useful_life=10000, + depreciation_start_date="2030-12-31", + total_number_of_depreciations=3, + frequency_of_depreciation=12, ) expected_schedules = [ - ["2030-12-31", 27534.25, 27534.25], - ["2031-12-31", 30000.0, 57534.25], - ["2032-12-31", 30000.0, 87534.25], - ["2033-01-30", 2465.75, 90000.0] + ["2030-12-31", 27616.44, 27616.44], + ["2031-12-31", 30000.0, 57616.44], + ["2032-12-31", 30000.0, 87616.44], + ["2033-01-30", 2383.56, 90000.0], ] - schedules = [[cstr(d.schedule_date), flt(d.depreciation_amount, 2), flt(d.accumulated_depreciation_amount, 2)] - for d in asset.get("schedules")] + schedules = [ + [ + cstr(d.schedule_date), + flt(d.depreciation_amount, 2), + flt(d.accumulated_depreciation_amount, 2), + ] + for d in asset.get("schedules") + ] self.assertEqual(schedules, expected_schedules) # WDV: Written Down Value method def test_depreciation_entry_for_wdv_without_pro_rata(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = "2030-01-01", - purchase_date = "2030-01-01", - depreciation_method = "Written Down Value", - expected_value_after_useful_life = 12500, - depreciation_start_date = "2030-12-31", - total_number_of_depreciations = 3, - frequency_of_depreciation = 12 + calculate_depreciation=1, + available_for_use_date="2030-01-01", + purchase_date="2030-01-01", + depreciation_method="Written Down Value", + expected_value_after_useful_life=12500, + depreciation_start_date="2030-12-31", + total_number_of_depreciations=3, + frequency_of_depreciation=12, ) self.assertEqual(asset.finance_books[0].rate_of_depreciation, 50.0) @@ -523,35 +592,47 @@ class TestDepreciationMethods(AssetSetup): ["2032-12-31", 12500.0, 87500.0], ] - schedules = [[cstr(d.schedule_date), flt(d.depreciation_amount, 2), flt(d.accumulated_depreciation_amount, 2)] - for d in asset.get("schedules")] + schedules = [ + [ + cstr(d.schedule_date), + flt(d.depreciation_amount, 2), + flt(d.accumulated_depreciation_amount, 2), + ] + for d in asset.get("schedules") + ] self.assertEqual(schedules, expected_schedules) # WDV: Written Down Value method def test_pro_rata_depreciation_entry_for_wdv(self): asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = "2030-06-06", - purchase_date = "2030-01-01", - depreciation_method = "Written Down Value", - expected_value_after_useful_life = 12500, - depreciation_start_date = "2030-12-31", - total_number_of_depreciations = 3, - frequency_of_depreciation = 12 + calculate_depreciation=1, + available_for_use_date="2030-06-06", + purchase_date="2030-01-01", + depreciation_method="Written Down Value", + expected_value_after_useful_life=12500, + depreciation_start_date="2030-12-31", + total_number_of_depreciations=3, + frequency_of_depreciation=12, ) self.assertEqual(asset.finance_books[0].rate_of_depreciation, 50.0) expected_schedules = [ - ["2030-12-31", 28493.15, 28493.15], - ["2031-12-31", 35753.43, 64246.58], - ["2032-12-31", 17876.71, 82123.29], - ["2033-06-06", 5376.71, 87500.0] + ["2030-12-31", 28630.14, 28630.14], + ["2031-12-31", 35684.93, 64315.07], + ["2032-12-31", 17842.47, 82157.54], + ["2033-06-06", 5342.46, 87500.0], ] - schedules = [[cstr(d.schedule_date), flt(d.depreciation_amount, 2), flt(d.accumulated_depreciation_amount, 2)] - for d in asset.get("schedules")] + schedules = [ + [ + cstr(d.schedule_date), + flt(d.depreciation_amount, 2), + flt(d.accumulated_depreciation_amount, 2), + ] + for d in asset.get("schedules") + ] self.assertEqual(schedules, expected_schedules) @@ -563,31 +644,37 @@ class TestDepreciationMethods(AssetSetup): finance_book = frappe.new_doc("Finance Book") finance_book.finance_book_name = "Income Tax" finance_book.for_income_tax = 1 - finance_book.insert(ignore_if_duplicate = True) + finance_book.insert(ignore_if_duplicate=True) asset = create_asset( - calculate_depreciation = 1, - available_for_use_date = "2030-07-12", - purchase_date = "2030-01-01", - finance_book = finance_book.name, - depreciation_method = "Written Down Value", - expected_value_after_useful_life = 12500, - depreciation_start_date = "2030-12-31", - total_number_of_depreciations = 3, - frequency_of_depreciation = 12 + calculate_depreciation=1, + available_for_use_date="2030-07-12", + purchase_date="2030-01-01", + finance_book=finance_book.name, + depreciation_method="Written Down Value", + expected_value_after_useful_life=12500, + depreciation_start_date="2030-12-31", + total_number_of_depreciations=3, + frequency_of_depreciation=12, ) self.assertEqual(asset.finance_books[0].rate_of_depreciation, 50.0) expected_schedules = [ - ["2030-12-31", 11780.82, 11780.82], - ["2031-12-31", 44109.59, 55890.41], - ["2032-12-31", 22054.8, 77945.21], - ["2033-07-12", 9554.79, 87500.0] + ["2030-12-31", 11849.32, 11849.32], + ["2031-12-31", 44075.34, 55924.66], + ["2032-12-31", 22037.67, 77962.33], + ["2033-07-12", 9537.67, 87500.0], ] - schedules = [[cstr(d.schedule_date), flt(d.depreciation_amount, 2), flt(d.accumulated_depreciation_amount, 2)] - for d in asset.get("schedules")] + schedules = [ + [ + cstr(d.schedule_date), + flt(d.depreciation_amount, 2), + flt(d.accumulated_depreciation_amount, 2), + ] + for d in asset.get("schedules") + ] self.assertEqual(schedules, expected_schedules) @@ -596,8 +683,8 @@ class TestDepreciationMethods(AssetSetup): def test_expected_value_change(self): """ - tests if changing `expected_value_after_useful_life` - affects `value_after_depreciation` + tests if changing `expected_value_after_useful_life` + affects `value_after_depreciation` """ asset = create_asset(calculate_depreciation=1) @@ -615,22 +702,58 @@ class TestDepreciationMethods(AssetSetup): asset.reload() self.assertEquals(asset.finance_books[0].value_after_depreciation, 98000.0) + def test_monthly_depreciation_by_wdv_method(self): + existing_precision = frappe.db.get_default("float_precision") + frappe.db.set_default("float_precision", 3) + asset = create_asset( + calculate_depreciation=1, + available_for_use_date="2022-02-15", + purchase_date="2022-02-15", + depreciation_method="Written Down Value", + gross_purchase_amount=10000, + expected_value_after_useful_life=5000, + depreciation_start_date="2022-02-28", + total_number_of_depreciations=5, + frequency_of_depreciation=1, + ) + + expected_schedules = [ + ["2022-02-28", 647.25, 647.25], + ["2022-03-31", 1210.71, 1857.96], + ["2022-04-30", 1053.99, 2911.95], + ["2022-05-31", 917.55, 3829.5], + ["2022-06-30", 798.77, 4628.27], + ["2022-07-15", 371.73, 5000.0], + ] + + schedules = [ + [ + cstr(d.schedule_date), + flt(d.depreciation_amount, 2), + flt(d.accumulated_depreciation_amount, 2), + ] + for d in asset.get("schedules") + ] + self.assertEqual(schedules, expected_schedules) + frappe.db.set_default("float_precision", existing_precision) + + class TestDepreciationBasics(AssetSetup): def test_depreciation_without_pro_rata(self): asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = getdate("2019-12-31"), - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = getdate("2020-12-31"), - submit = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date=getdate("2019-12-31"), + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date=getdate("2020-12-31"), + submit=1, ) expected_values = [ ["2020-12-31", 30000, 30000], ["2021-12-31", 30000, 60000], - ["2022-12-31", 30000, 90000] + ["2022-12-31", 30000, 90000], ] for i, schedule in enumerate(asset.schedules): @@ -640,20 +763,20 @@ class TestDepreciationBasics(AssetSetup): def test_depreciation_with_pro_rata(self): asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = getdate("2019-12-31"), - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = getdate("2020-07-01"), - submit = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date=getdate("2020-01-01"), + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date=getdate("2020-07-01"), + submit=1, ) expected_values = [ ["2020-07-01", 15000, 15000], ["2021-07-01", 30000, 45000], ["2022-07-01", 30000, 75000], - ["2022-12-31", 15000, 90000] + ["2023-01-01", 15000, 90000], ] for i, schedule in enumerate(asset.schedules): @@ -666,19 +789,19 @@ class TestDepreciationBasics(AssetSetup): from erpnext.assets.doctype.asset.asset import get_depreciation_amount - asset = create_asset( - item_code = "Macbook Pro", - available_for_use_date = "2019-12-31" - ) + asset = create_asset(item_code="Macbook Pro", available_for_use_date="2019-12-31") asset.calculate_depreciation = 1 - asset.append("finance_books", { - "depreciation_method": "Straight Line", - "frequency_of_depreciation": 12, - "total_number_of_depreciations": 3, - "expected_value_after_useful_life": 10000, - "depreciation_start_date": "2020-12-31" - }) + asset.append( + "finance_books", + { + "depreciation_method": "Straight Line", + "frequency_of_depreciation": 12, + "total_number_of_depreciations": 3, + "expected_value_after_useful_life": 10000, + "depreciation_start_date": "2020-12-31", + }, + ) depreciation_amount = get_depreciation_amount(asset, 100000, asset.finance_books[0]) self.assertEqual(depreciation_amount, 30000) @@ -687,38 +810,34 @@ class TestDepreciationBasics(AssetSetup): """Tests if make_depreciation_schedule() returns the right values.""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - depreciation_method = "Straight Line", - frequency_of_depreciation = 12, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2020-12-31" + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + depreciation_method="Straight Line", + frequency_of_depreciation=12, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date="2020-12-31", ) - expected_values = [ - ['2020-12-31', 30000.0], - ['2021-12-31', 30000.0], - ['2022-12-31', 30000.0] - ] + expected_values = [["2020-12-31", 30000.0], ["2021-12-31", 30000.0], ["2022-12-31", 30000.0]] for i, schedule in enumerate(asset.schedules): - self.assertEqual(expected_values[i][0], schedule.schedule_date) + self.assertEqual(getdate(expected_values[i][0]), schedule.schedule_date) self.assertEqual(expected_values[i][1], schedule.depreciation_amount) def test_set_accumulated_depreciation(self): """Tests if set_accumulated_depreciation() returns the right values.""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - depreciation_method = "Straight Line", - frequency_of_depreciation = 12, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2020-12-31" + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + depreciation_method="Straight Line", + frequency_of_depreciation=12, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date="2020-12-31", ) expected_values = [30000.0, 60000.0, 90000.0] @@ -729,32 +848,34 @@ class TestDepreciationBasics(AssetSetup): def test_check_is_pro_rata(self): """Tests if check_is_pro_rata() returns the right value(i.e. checks if has_pro_rata is accurate).""" - asset = create_asset( - item_code = "Macbook Pro", - available_for_use_date = "2019-12-31", - do_not_save = 1 - ) + asset = create_asset(item_code="Macbook Pro", available_for_use_date="2019-12-31", do_not_save=1) asset.calculate_depreciation = 1 - asset.append("finance_books", { - "depreciation_method": "Straight Line", - "frequency_of_depreciation": 12, - "total_number_of_depreciations": 3, - "expected_value_after_useful_life": 10000, - "depreciation_start_date": "2020-12-31" - }) + asset.append( + "finance_books", + { + "depreciation_method": "Straight Line", + "frequency_of_depreciation": 12, + "total_number_of_depreciations": 3, + "expected_value_after_useful_life": 10000, + "depreciation_start_date": "2020-12-31", + }, + ) has_pro_rata = asset.check_is_pro_rata(asset.finance_books[0]) self.assertFalse(has_pro_rata) asset.finance_books = [] - asset.append("finance_books", { - "depreciation_method": "Straight Line", - "frequency_of_depreciation": 12, - "total_number_of_depreciations": 3, - "expected_value_after_useful_life": 10000, - "depreciation_start_date": "2020-07-01" - }) + asset.append( + "finance_books", + { + "depreciation_method": "Straight Line", + "frequency_of_depreciation": 12, + "total_number_of_depreciations": 3, + "expected_value_after_useful_life": 10000, + "depreciation_start_date": "2020-07-01", + }, + ) has_pro_rata = asset.check_is_pro_rata(asset.finance_books[0]) self.assertTrue(has_pro_rata) @@ -763,13 +884,13 @@ class TestDepreciationBasics(AssetSetup): """Tests if an error is raised when expected_value_after_useful_life(110,000) > gross_purchase_amount(100,000).""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - total_number_of_depreciations = 3, - expected_value_after_useful_life = 110000, - depreciation_start_date = "2020-07-01", - do_not_save = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + total_number_of_depreciations=3, + expected_value_after_useful_life=110000, + depreciation_start_date="2020-07-01", + do_not_save=1, ) self.assertRaises(frappe.ValidationError, asset.save) @@ -778,11 +899,11 @@ class TestDepreciationBasics(AssetSetup): """Tests if an error is raised when neither depreciation_start_date nor available_for_use_date are specified.""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 110000, - do_not_save = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + total_number_of_depreciations=3, + expected_value_after_useful_life=110000, + do_not_save=1, ) self.assertRaises(frappe.ValidationError, asset.save) @@ -791,14 +912,14 @@ class TestDepreciationBasics(AssetSetup): """Tests if an error is raised when opening_accumulated_depreciation > (gross_purchase_amount - expected_value_after_useful_life).""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2020-07-01", - opening_accumulated_depreciation = 100000, - do_not_save = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date="2020-07-01", + opening_accumulated_depreciation=100000, + do_not_save=1, ) self.assertRaises(frappe.ValidationError, asset.save) @@ -807,57 +928,73 @@ class TestDepreciationBasics(AssetSetup): """Tests if an error is raised when number_of_depreciations_booked is not specified when opening_accumulated_depreciation is.""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2020-07-01", - opening_accumulated_depreciation = 10000, - do_not_save = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date="2020-07-01", + opening_accumulated_depreciation=10000, + do_not_save=1, ) self.assertRaises(frappe.ValidationError, asset.save) def test_number_of_depreciations(self): - """Tests if an error is raised when number_of_depreciations_booked > total_number_of_depreciations.""" + """Tests if an error is raised when number_of_depreciations_booked >= total_number_of_depreciations.""" + # number_of_depreciations_booked > total_number_of_depreciations asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2020-07-01", - opening_accumulated_depreciation = 10000, - number_of_depreciations_booked = 5, - do_not_save = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date="2020-07-01", + opening_accumulated_depreciation=10000, + number_of_depreciations_booked=5, + do_not_save=1, ) self.assertRaises(frappe.ValidationError, asset.save) + # number_of_depreciations_booked = total_number_of_depreciations + asset_2 = create_asset( + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + total_number_of_depreciations=5, + expected_value_after_useful_life=10000, + depreciation_start_date="2020-07-01", + opening_accumulated_depreciation=10000, + number_of_depreciations_booked=5, + do_not_save=1, + ) + + self.assertRaises(frappe.ValidationError, asset_2.save) + def test_depreciation_start_date_is_before_purchase_date(self): asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2014-07-01", - do_not_save = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date="2014-07-01", + do_not_save=1, ) self.assertRaises(frappe.ValidationError, asset.save) def test_depreciation_start_date_is_before_available_for_use_date(self): asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - depreciation_start_date = "2018-07-01", - do_not_save = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + depreciation_start_date="2018-07-01", + do_not_save=1, ) self.assertRaises(frappe.ValidationError, asset.save) @@ -872,14 +1009,14 @@ class TestDepreciationBasics(AssetSetup): """Tests if post_depreciation_entries() works as expected.""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - depreciation_start_date = "2020-12-31", - frequency_of_depreciation = 12, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - submit = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + depreciation_start_date="2020-12-31", + frequency_of_depreciation=12, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + submit=1, ) post_depreciation_entries(date="2021-06-01") @@ -893,21 +1030,24 @@ class TestDepreciationBasics(AssetSetup): """Tests if the Depreciation Expense Account gets debited and the Accumulated Depreciation Account gets credited when the former's an Expense Account.""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - depreciation_start_date = "2020-12-31", - frequency_of_depreciation = 12, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - submit = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + depreciation_start_date="2020-12-31", + frequency_of_depreciation=12, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + submit=1, ) post_depreciation_entries(date="2021-06-01") asset.load_from_db() je = frappe.get_doc("Journal Entry", asset.schedules[0].journal_entry) - accounting_entries = [{"account": entry.account, "debit": entry.debit, "credit": entry.credit} for entry in je.accounts] + accounting_entries = [ + {"account": entry.account, "debit": entry.debit, "credit": entry.credit} + for entry in je.accounts + ] for entry in accounting_entries: if entry["account"] == "_Test Depreciations - _TC": @@ -926,21 +1066,24 @@ class TestDepreciationBasics(AssetSetup): depr_expense_account.save() asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - depreciation_start_date = "2020-12-31", - frequency_of_depreciation = 12, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - submit = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + depreciation_start_date="2020-12-31", + frequency_of_depreciation=12, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + submit=1, ) post_depreciation_entries(date="2021-06-01") asset.load_from_db() je = frappe.get_doc("Journal Entry", asset.schedules[0].journal_entry) - accounting_entries = [{"account": entry.account, "debit": entry.debit, "credit": entry.credit} for entry in je.accounts] + accounting_entries = [ + {"account": entry.account, "debit": entry.debit, "credit": entry.credit} + for entry in je.accounts + ] for entry in accounting_entries: if entry["account"] == "_Test Depreciations - _TC": @@ -959,14 +1102,14 @@ class TestDepreciationBasics(AssetSetup): """Tests if clear_depreciation_schedule() works as expected.""" asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2019-12-31", - depreciation_start_date = "2020-12-31", - frequency_of_depreciation = 12, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - submit = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2019-12-31", + depreciation_start_date="2020-12-31", + frequency_of_depreciation=12, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + submit=1, ) post_depreciation_entries(date="2021-06-01") @@ -976,17 +1119,100 @@ class TestDepreciationBasics(AssetSetup): self.assertEqual(len(asset.schedules), 1) + def test_clear_depreciation_schedule_for_multiple_finance_books(self): + asset = create_asset(item_code="Macbook Pro", available_for_use_date="2019-12-31", do_not_save=1) + + asset.calculate_depreciation = 1 + asset.append( + "finance_books", + { + "depreciation_method": "Straight Line", + "frequency_of_depreciation": 1, + "total_number_of_depreciations": 3, + "expected_value_after_useful_life": 10000, + "depreciation_start_date": "2020-01-31", + }, + ) + asset.append( + "finance_books", + { + "depreciation_method": "Straight Line", + "frequency_of_depreciation": 1, + "total_number_of_depreciations": 6, + "expected_value_after_useful_life": 10000, + "depreciation_start_date": "2020-01-31", + }, + ) + asset.append( + "finance_books", + { + "depreciation_method": "Straight Line", + "frequency_of_depreciation": 12, + "total_number_of_depreciations": 3, + "expected_value_after_useful_life": 10000, + "depreciation_start_date": "2020-12-31", + }, + ) + asset.submit() + + post_depreciation_entries(date="2020-04-01") + asset.load_from_db() + + asset.clear_depreciation_schedule() + + self.assertEqual(len(asset.schedules), 6) + + for schedule in asset.schedules: + if schedule.idx <= 3: + self.assertEqual(schedule.finance_book_id, "1") + else: + self.assertEqual(schedule.finance_book_id, "2") + + def test_depreciation_schedules_are_set_up_for_multiple_finance_books(self): + asset = create_asset(item_code="Macbook Pro", available_for_use_date="2019-12-31", do_not_save=1) + + asset.calculate_depreciation = 1 + asset.append( + "finance_books", + { + "depreciation_method": "Straight Line", + "frequency_of_depreciation": 12, + "total_number_of_depreciations": 3, + "expected_value_after_useful_life": 10000, + "depreciation_start_date": "2020-12-31", + }, + ) + asset.append( + "finance_books", + { + "depreciation_method": "Straight Line", + "frequency_of_depreciation": 12, + "total_number_of_depreciations": 6, + "expected_value_after_useful_life": 10000, + "depreciation_start_date": "2020-12-31", + }, + ) + asset.save() + + self.assertEqual(len(asset.schedules), 9) + + for schedule in asset.schedules: + if schedule.idx <= 3: + self.assertEqual(schedule.finance_book_id, 1) + else: + self.assertEqual(schedule.finance_book_id, 2) + def test_depreciation_entry_cancellation(self): asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - purchase_date = "2020-06-06", - available_for_use_date = "2020-06-06", - depreciation_start_date = "2020-12-31", - frequency_of_depreciation = 10, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - submit = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + purchase_date="2020-06-06", + available_for_use_date="2020-06-06", + depreciation_start_date="2020-12-31", + frequency_of_depreciation=10, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + submit=1, ) post_depreciation_entries(date="2021-01-01") @@ -1004,34 +1230,38 @@ class TestDepreciationBasics(AssetSetup): def test_asset_expected_value_after_useful_life(self): asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - available_for_use_date = "2020-06-06", - purchase_date = "2020-06-06", - frequency_of_depreciation = 10, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000 + item_code="Macbook Pro", + calculate_depreciation=1, + available_for_use_date="2020-06-06", + purchase_date="2020-06-06", + frequency_of_depreciation=10, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, ) - accumulated_depreciation_after_full_schedule = \ - max(d.accumulated_depreciation_amount for d in asset.get("schedules")) + accumulated_depreciation_after_full_schedule = max( + d.accumulated_depreciation_amount for d in asset.get("schedules") + ) - asset_value_after_full_schedule = (flt(asset.gross_purchase_amount) - - flt(accumulated_depreciation_after_full_schedule)) + asset_value_after_full_schedule = flt(asset.gross_purchase_amount) - flt( + accumulated_depreciation_after_full_schedule + ) - self.assertTrue(asset.finance_books[0].expected_value_after_useful_life >= asset_value_after_full_schedule) + self.assertTrue( + asset.finance_books[0].expected_value_after_useful_life >= asset_value_after_full_schedule + ) def test_gle_made_by_depreciation_entries(self): asset = create_asset( - item_code = "Macbook Pro", - calculate_depreciation = 1, - purchase_date = "2020-01-30", - available_for_use_date = "2020-01-30", - depreciation_start_date = "2020-12-31", - frequency_of_depreciation = 10, - total_number_of_depreciations = 3, - expected_value_after_useful_life = 10000, - submit = 1 + item_code="Macbook Pro", + calculate_depreciation=1, + purchase_date="2020-01-30", + available_for_use_date="2020-01-30", + depreciation_start_date="2020-12-31", + frequency_of_depreciation=10, + total_number_of_depreciations=3, + expected_value_after_useful_life=10000, + submit=1, ) self.assertEqual(asset.status, "Submitted") @@ -1045,16 +1275,55 @@ class TestDepreciationBasics(AssetSetup): expected_gle = ( ("_Test Accumulated Depreciations - _TC", 0.0, 30000.0), - ("_Test Depreciations - _TC", 30000.0, 0.0) + ("_Test Depreciations - _TC", 30000.0, 0.0), ) - gle = frappe.db.sql("""select account, debit, credit from `tabGL Entry` + gle = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where against_voucher_type='Asset' and against_voucher = %s - order by account""", asset.name) + order by account""", + asset.name, + ) self.assertEqual(gle, expected_gle) self.assertEqual(asset.get("value_after_depreciation"), 0) + def test_asset_cost_center(self): + asset = create_asset(is_existing_asset=1, do_not_save=1) + asset.cost_center = "Main - WP" + + self.assertRaises(frappe.ValidationError, asset.submit) + + asset.cost_center = "Main - _TC" + asset.submit() + + def test_depreciation_on_final_day_of_the_month(self): + """Tests if final day of the month is picked each time, if the depreciation start date is the last day of the month.""" + + asset = create_asset( + item_code="Macbook Pro", + calculate_depreciation=1, + purchase_date="2020-01-30", + available_for_use_date="2020-02-15", + depreciation_start_date="2020-02-29", + frequency_of_depreciation=1, + total_number_of_depreciations=5, + submit=1, + ) + + expected_dates = [ + "2020-02-29", + "2020-03-31", + "2020-04-30", + "2020-05-31", + "2020-06-30", + "2020-07-15", + ] + + for i, schedule in enumerate(asset.schedules): + self.assertEqual(getdate(expected_dates[i]), getdate(schedule.schedule_date)) + + def create_asset_data(): if not frappe.db.exists("Asset Category", "Computers"): create_asset_category() @@ -1063,44 +1332,47 @@ def create_asset_data(): create_fixed_asset_item() if not frappe.db.exists("Location", "Test Location"): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': 'Test Location' - }).insert() + frappe.get_doc({"doctype": "Location", "location_name": "Test Location"}).insert() + def create_asset(**args): args = frappe._dict(args) create_asset_data() - asset = frappe.get_doc({ - "doctype": "Asset", - "asset_name": args.asset_name or "Macbook Pro 1", - "asset_category": args.asset_category or "Computers", - "item_code": args.item_code or "Macbook Pro", - "company": args.company or "_Test Company", - "purchase_date": args.purchase_date or "2015-01-01", - "calculate_depreciation": args.calculate_depreciation or 0, - "opening_accumulated_depreciation": args.opening_accumulated_depreciation or 0, - "number_of_depreciations_booked": args.number_of_depreciations_booked or 0, - "gross_purchase_amount": args.gross_purchase_amount or 100000, - "purchase_receipt_amount": args.purchase_receipt_amount or 100000, - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "available_for_use_date": args.available_for_use_date or "2020-06-06", - "location": args.location or "Test Location", - "asset_owner": args.asset_owner or "Company", - "is_existing_asset": args.is_existing_asset or 1 - }) + asset = frappe.get_doc( + { + "doctype": "Asset", + "asset_name": args.asset_name or "Macbook Pro 1", + "asset_category": args.asset_category or "Computers", + "item_code": args.item_code or "Macbook Pro", + "company": args.company or "_Test Company", + "purchase_date": args.purchase_date or "2015-01-01", + "calculate_depreciation": args.calculate_depreciation or 0, + "opening_accumulated_depreciation": args.opening_accumulated_depreciation or 0, + "number_of_depreciations_booked": args.number_of_depreciations_booked or 0, + "gross_purchase_amount": args.gross_purchase_amount or 100000, + "purchase_receipt_amount": args.purchase_receipt_amount or 100000, + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "available_for_use_date": args.available_for_use_date or "2020-06-06", + "location": args.location or "Test Location", + "asset_owner": args.asset_owner or "Company", + "is_existing_asset": args.is_existing_asset or 1, + } + ) if asset.calculate_depreciation: - asset.append("finance_books", { - "finance_book": args.finance_book, - "depreciation_method": args.depreciation_method or "Straight Line", - "frequency_of_depreciation": args.frequency_of_depreciation or 12, - "total_number_of_depreciations": args.total_number_of_depreciations or 5, - "expected_value_after_useful_life": args.expected_value_after_useful_life or 0, - "depreciation_start_date": args.depreciation_start_date - }) + asset.append( + "finance_books", + { + "finance_book": args.finance_book, + "depreciation_method": args.depreciation_method or "Straight Line", + "frequency_of_depreciation": args.frequency_of_depreciation or 12, + "total_number_of_depreciations": args.total_number_of_depreciations or 5, + "expected_value_after_useful_life": args.expected_value_after_useful_life or 0, + "depreciation_start_date": args.depreciation_start_date, + }, + ) if not args.do_not_save: try: @@ -1113,40 +1385,48 @@ def create_asset(**args): return asset + def create_asset_category(): asset_category = frappe.new_doc("Asset Category") asset_category.asset_category_name = "Computers" asset_category.total_number_of_depreciations = 3 asset_category.frequency_of_depreciation = 3 asset_category.enable_cwip_accounting = 1 - asset_category.append("accounts", { - "company_name": "_Test Company", - "fixed_asset_account": "_Test Fixed Asset - _TC", - "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", - "depreciation_expense_account": "_Test Depreciations - _TC" - }) + asset_category.append( + "accounts", + { + "company_name": "_Test Company", + "fixed_asset_account": "_Test Fixed Asset - _TC", + "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", + "depreciation_expense_account": "_Test Depreciations - _TC", + }, + ) asset_category.insert() + def create_fixed_asset_item(): - meta = frappe.get_meta('Asset') - naming_series = meta.get_field("naming_series").options.splitlines()[0] or 'ACC-ASS-.YYYY.-' + meta = frappe.get_meta("Asset") + naming_series = meta.get_field("naming_series").options.splitlines()[0] or "ACC-ASS-.YYYY.-" try: - frappe.get_doc({ - "doctype": "Item", - "item_code": "Macbook Pro", - "item_name": "Macbook Pro", - "description": "Macbook Pro Retina Display", - "asset_category": "Computers", - "item_group": "All Item Groups", - "stock_uom": "Nos", - "is_stock_item": 0, - "is_fixed_asset": 1, - "auto_create_assets": 1, - "asset_naming_series": naming_series - }).insert() + frappe.get_doc( + { + "doctype": "Item", + "item_code": "Macbook Pro", + "item_name": "Macbook Pro", + "description": "Macbook Pro Retina Display", + "asset_category": "Computers", + "item_group": "All Item Groups", + "stock_uom": "Nos", + "is_stock_item": 0, + "is_fixed_asset": 1, + "auto_create_assets": 1, + "asset_naming_series": naming_series, + } + ).insert() except frappe.DuplicateEntryError: pass + def set_depreciation_settings_in_company(): company = frappe.get_doc("Company", "_Test Company") company.accumulated_depreciation_account = "_Test Accumulated Depreciations - _TC" @@ -1158,5 +1438,6 @@ def set_depreciation_settings_in_company(): # Enable booking asset depreciation entry automatically frappe.db.set_value("Accounts Settings", None, "book_asset_depreciation_entry_automatically", 1) + def enable_cwip_accounting(asset_category, enable=1): frappe.db.set_value("Asset Category", asset_category, "enable_cwip_accounting", enable) diff --git a/erpnext/assets/doctype/asset_category/asset_category.py b/erpnext/assets/doctype/asset_category/asset_category.py index bd573bf479d..7291daf2b33 100644 --- a/erpnext/assets/doctype/asset_category/asset_category.py +++ b/erpnext/assets/doctype/asset_category/asset_category.py @@ -18,79 +18,104 @@ class AssetCategory(Document): def validate_finance_books(self): for d in self.finance_books: for field in ("Total Number of Depreciations", "Frequency of Depreciation"): - if cint(d.get(frappe.scrub(field)))<1: - frappe.throw(_("Row {0}: {1} must be greater than 0").format(d.idx, field), frappe.MandatoryError) + if cint(d.get(frappe.scrub(field))) < 1: + frappe.throw( + _("Row {0}: {1} must be greater than 0").format(d.idx, field), frappe.MandatoryError + ) def validate_account_currency(self): account_types = [ - 'fixed_asset_account', 'accumulated_depreciation_account', 'depreciation_expense_account', 'capital_work_in_progress_account' + "fixed_asset_account", + "accumulated_depreciation_account", + "depreciation_expense_account", + "capital_work_in_progress_account", ] invalid_accounts = [] for d in self.accounts: - company_currency = frappe.get_value('Company', d.get('company_name'), 'default_currency') + company_currency = frappe.get_value("Company", d.get("company_name"), "default_currency") for type_of_account in account_types: if d.get(type_of_account): account_currency = frappe.get_value("Account", d.get(type_of_account), "account_currency") if account_currency != company_currency: - invalid_accounts.append(frappe._dict({ 'type': type_of_account, 'idx': d.idx, 'account': d.get(type_of_account) })) + invalid_accounts.append( + frappe._dict({"type": type_of_account, "idx": d.idx, "account": d.get(type_of_account)}) + ) for d in invalid_accounts: - frappe.throw(_("Row #{}: Currency of {} - {} doesn't matches company currency.") - .format(d.idx, frappe.bold(frappe.unscrub(d.type)), frappe.bold(d.account)), - title=_("Invalid Account")) - + frappe.throw( + _("Row #{}: Currency of {} - {} doesn't matches company currency.").format( + d.idx, frappe.bold(frappe.unscrub(d.type)), frappe.bold(d.account) + ), + title=_("Invalid Account"), + ) def validate_account_types(self): account_type_map = { - 'fixed_asset_account': {'account_type': ['Fixed Asset']}, - 'accumulated_depreciation_account': {'account_type': ['Accumulated Depreciation']}, - 'depreciation_expense_account': {'root_type': ['Expense', 'Income']}, - 'capital_work_in_progress_account': {'account_type': ['Capital Work in Progress']} + "fixed_asset_account": {"account_type": ["Fixed Asset"]}, + "accumulated_depreciation_account": {"account_type": ["Accumulated Depreciation"]}, + "depreciation_expense_account": {"root_type": ["Expense", "Income"]}, + "capital_work_in_progress_account": {"account_type": ["Capital Work in Progress"]}, } for d in self.accounts: for fieldname in account_type_map.keys(): if d.get(fieldname): selected_account = d.get(fieldname) - key_to_match = next(iter(account_type_map.get(fieldname))) # acount_type or root_type - selected_key_type = frappe.db.get_value('Account', selected_account, key_to_match) + key_to_match = next(iter(account_type_map.get(fieldname))) # acount_type or root_type + selected_key_type = frappe.db.get_value("Account", selected_account, key_to_match) expected_key_types = account_type_map[fieldname][key_to_match] if selected_key_type not in expected_key_types: - frappe.throw(_("Row #{}: {} of {} should be {}. Please modify the account or select a different account.") - .format(d.idx, frappe.unscrub(key_to_match), frappe.bold(selected_account), frappe.bold(expected_key_types)), - title=_("Invalid Account")) + frappe.throw( + _( + "Row #{}: {} of {} should be {}. Please modify the account or select a different account." + ).format( + d.idx, + frappe.unscrub(key_to_match), + frappe.bold(selected_account), + frappe.bold(expected_key_types), + ), + title=_("Invalid Account"), + ) def valide_cwip_account(self): if self.enable_cwip_accounting: missing_cwip_accounts_for_company = [] for d in self.accounts: - if (not d.capital_work_in_progress_account and - not frappe.db.get_value("Company", d.company_name, "capital_work_in_progress_account")): + if not d.capital_work_in_progress_account and not frappe.db.get_value( + "Company", d.company_name, "capital_work_in_progress_account" + ): missing_cwip_accounts_for_company.append(get_link_to_form("Company", d.company_name)) if missing_cwip_accounts_for_company: msg = _("""To enable Capital Work in Progress Accounting, """) msg += _("""you must select Capital Work in Progress Account in accounts table""") msg += "
" - msg += _("You can also set default CWIP account in Company {}").format(", ".join(missing_cwip_accounts_for_company)) + msg += _("You can also set default CWIP account in Company {}").format( + ", ".join(missing_cwip_accounts_for_company) + ) frappe.throw(msg, title=_("Missing Account")) @frappe.whitelist() -def get_asset_category_account(fieldname, item=None, asset=None, account=None, asset_category = None, company = None): +def get_asset_category_account( + fieldname, item=None, asset=None, account=None, asset_category=None, company=None +): if item and frappe.db.get_value("Item", item, "is_fixed_asset"): asset_category = frappe.db.get_value("Item", item, ["asset_category"]) elif not asset_category or not company: if account: if frappe.db.get_value("Account", account, "account_type") != "Fixed Asset": - account=None + account = None if not account: asset_details = frappe.db.get_value("Asset", asset, ["asset_category", "company"]) asset_category, company = asset_details or [None, None] - account = frappe.db.get_value("Asset Category Account", - filters={"parent": asset_category, "company_name": company}, fieldname=fieldname) + account = frappe.db.get_value( + "Asset Category Account", + filters={"parent": asset_category, "company_name": company}, + fieldname=fieldname, + ) return account diff --git a/erpnext/assets/doctype/asset_category/test_asset_category.py b/erpnext/assets/doctype/asset_category/test_asset_category.py index 3d19fa39d1e..e221bfabb01 100644 --- a/erpnext/assets/doctype/asset_category/test_asset_category.py +++ b/erpnext/assets/doctype/asset_category/test_asset_category.py @@ -15,12 +15,15 @@ class TestAssetCategory(unittest.TestCase): asset_category.total_number_of_depreciations = 3 asset_category.frequency_of_depreciation = 3 - asset_category.append("accounts", { - "company_name": "_Test Company", - "fixed_asset_account": "_Test Fixed Asset - _TC", - "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", - "depreciation_expense_account": "_Test Depreciations - _TC" - }) + asset_category.append( + "accounts", + { + "company_name": "_Test Company", + "fixed_asset_account": "_Test Fixed Asset - _TC", + "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", + "depreciation_expense_account": "_Test Depreciations - _TC", + }, + ) try: asset_category.insert() @@ -28,7 +31,9 @@ class TestAssetCategory(unittest.TestCase): pass def test_cwip_accounting(self): - company_cwip_acc = frappe.db.get_value("Company", "_Test Company", "capital_work_in_progress_account") + company_cwip_acc = frappe.db.get_value( + "Company", "_Test Company", "capital_work_in_progress_account" + ) frappe.db.set_value("Company", "_Test Company", "capital_work_in_progress_account", "") asset_category = frappe.new_doc("Asset Category") @@ -37,11 +42,14 @@ class TestAssetCategory(unittest.TestCase): asset_category.total_number_of_depreciations = 3 asset_category.frequency_of_depreciation = 3 - asset_category.append("accounts", { - "company_name": "_Test Company", - "fixed_asset_account": "_Test Fixed Asset - _TC", - "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", - "depreciation_expense_account": "_Test Depreciations - _TC" - }) + asset_category.append( + "accounts", + { + "company_name": "_Test Company", + "fixed_asset_account": "_Test Fixed Asset - _TC", + "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", + "depreciation_expense_account": "_Test Depreciations - _TC", + }, + ) self.assertRaises(frappe.ValidationError, asset_category.insert) diff --git a/erpnext/assets/doctype/asset_maintenance/asset_maintenance.js b/erpnext/assets/doctype/asset_maintenance/asset_maintenance.js index 52996e93475..5c03b98873b 100644 --- a/erpnext/assets/doctype/asset_maintenance/asset_maintenance.js +++ b/erpnext/assets/doctype/asset_maintenance/asset_maintenance.js @@ -48,7 +48,7 @@ frappe.ui.form.on('Asset Maintenance', { `).appendTo(rows); diff --git a/erpnext/assets/doctype/asset_maintenance/asset_maintenance.py b/erpnext/assets/doctype/asset_maintenance/asset_maintenance.py index 4fc4c4cb993..e603d346266 100644 --- a/erpnext/assets/doctype/asset_maintenance/asset_maintenance.py +++ b/erpnext/assets/doctype/asset_maintenance/asset_maintenance.py @@ -11,7 +11,7 @@ from frappe.utils import add_days, add_months, add_years, getdate, nowdate class AssetMaintenance(Document): def validate(self): - for task in self.get('asset_maintenance_tasks'): + for task in self.get("asset_maintenance_tasks"): if task.end_date and (getdate(task.start_date) >= getdate(task.end_date)): throw(_("Start date should be less than end date for task {0}").format(task.maintenance_task)) if getdate(task.next_due_date) < getdate(nowdate()): @@ -20,83 +20,109 @@ class AssetMaintenance(Document): throw(_("Row #{}: Please asign task to a member.").format(task.idx)) def on_update(self): - for task in self.get('asset_maintenance_tasks'): + for task in self.get("asset_maintenance_tasks"): assign_tasks(self.name, task.assign_to, task.maintenance_task, task.next_due_date) self.sync_maintenance_tasks() def sync_maintenance_tasks(self): tasks_names = [] - for task in self.get('asset_maintenance_tasks'): + for task in self.get("asset_maintenance_tasks"): tasks_names.append(task.name) - update_maintenance_log(asset_maintenance = self.name, item_code = self.item_code, item_name = self.item_name, task = task) - asset_maintenance_logs = frappe.get_all("Asset Maintenance Log", fields=["name"], filters = {"asset_maintenance": self.name, - "task": ("not in", tasks_names)}) + update_maintenance_log( + asset_maintenance=self.name, item_code=self.item_code, item_name=self.item_name, task=task + ) + asset_maintenance_logs = frappe.get_all( + "Asset Maintenance Log", + fields=["name"], + filters={"asset_maintenance": self.name, "task": ("not in", tasks_names)}, + ) if asset_maintenance_logs: for asset_maintenance_log in asset_maintenance_logs: - maintenance_log = frappe.get_doc('Asset Maintenance Log', asset_maintenance_log.name) - maintenance_log.db_set('maintenance_status', 'Cancelled') + maintenance_log = frappe.get_doc("Asset Maintenance Log", asset_maintenance_log.name) + maintenance_log.db_set("maintenance_status", "Cancelled") + @frappe.whitelist() def assign_tasks(asset_maintenance_name, assign_to_member, maintenance_task, next_due_date): - team_member = frappe.db.get_value('User', assign_to_member, "email") + team_member = frappe.db.get_value("User", assign_to_member, "email") args = { - 'doctype' : 'Asset Maintenance', - 'assign_to' : [team_member], - 'name' : asset_maintenance_name, - 'description' : maintenance_task, - 'date' : next_due_date + "doctype": "Asset Maintenance", + "assign_to": [team_member], + "name": asset_maintenance_name, + "description": maintenance_task, + "date": next_due_date, } - if not frappe.db.sql("""select owner from `tabToDo` + if not frappe.db.sql( + """select owner from `tabToDo` where reference_type=%(doctype)s and reference_name=%(name)s and status="Open" - and owner=%(assign_to)s""", args): + and owner=%(assign_to)s""", + args, + ): assign_to.add(args) + @frappe.whitelist() -def calculate_next_due_date(periodicity, start_date = None, end_date = None, last_completion_date = None, next_due_date = None): +def calculate_next_due_date( + periodicity, start_date=None, end_date=None, last_completion_date=None, next_due_date=None +): if not start_date and not last_completion_date: start_date = frappe.utils.now() - if last_completion_date and ((start_date and last_completion_date > start_date) or not start_date): + if last_completion_date and ( + (start_date and last_completion_date > start_date) or not start_date + ): start_date = last_completion_date - if periodicity == 'Daily': + if periodicity == "Daily": next_due_date = add_days(start_date, 1) - if periodicity == 'Weekly': + if periodicity == "Weekly": next_due_date = add_days(start_date, 7) - if periodicity == 'Monthly': + if periodicity == "Monthly": next_due_date = add_months(start_date, 1) - if periodicity == 'Yearly': + if periodicity == "Yearly": next_due_date = add_years(start_date, 1) - if periodicity == '2 Yearly': + if periodicity == "2 Yearly": next_due_date = add_years(start_date, 2) - if periodicity == 'Quarterly': + if periodicity == "Quarterly": next_due_date = add_months(start_date, 3) - if end_date and ((start_date and start_date >= end_date) or (last_completion_date and last_completion_date >= end_date) or next_due_date): + if end_date and ( + (start_date and start_date >= end_date) + or (last_completion_date and last_completion_date >= end_date) + or next_due_date + ): next_due_date = "" return next_due_date def update_maintenance_log(asset_maintenance, item_code, item_name, task): - asset_maintenance_log = frappe.get_value("Asset Maintenance Log", {"asset_maintenance": asset_maintenance, - "task": task.name, "maintenance_status": ('in',['Planned','Overdue'])}) + asset_maintenance_log = frappe.get_value( + "Asset Maintenance Log", + { + "asset_maintenance": asset_maintenance, + "task": task.name, + "maintenance_status": ("in", ["Planned", "Overdue"]), + }, + ) if not asset_maintenance_log: - asset_maintenance_log = frappe.get_doc({ - "doctype": "Asset Maintenance Log", - "asset_maintenance": asset_maintenance, - "asset_name": asset_maintenance, - "item_code": item_code, - "item_name": item_name, - "task": task.name, - "has_certificate": task.certificate_required, - "description": task.description, - "assign_to_name": task.assign_to_name, - "periodicity": str(task.periodicity), - "maintenance_type": task.maintenance_type, - "due_date": task.next_due_date - }) + asset_maintenance_log = frappe.get_doc( + { + "doctype": "Asset Maintenance Log", + "asset_maintenance": asset_maintenance, + "asset_name": asset_maintenance, + "item_code": item_code, + "item_name": item_name, + "task": task.name, + "has_certificate": task.certificate_required, + "description": task.description, + "assign_to_name": task.assign_to_name, + "periodicity": str(task.periodicity), + "maintenance_type": task.maintenance_type, + "due_date": task.next_due_date, + } + ) asset_maintenance_log.insert() else: - maintenance_log = frappe.get_doc('Asset Maintenance Log', asset_maintenance_log) + maintenance_log = frappe.get_doc("Asset Maintenance Log", asset_maintenance_log) maintenance_log.assign_to_name = task.assign_to_name maintenance_log.has_certificate = task.certificate_required maintenance_log.description = task.description @@ -105,15 +131,22 @@ def update_maintenance_log(asset_maintenance, item_code, item_name, task): maintenance_log.due_date = task.next_due_date maintenance_log.save() + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_team_members(doctype, txt, searchfield, start, page_len, filters): - return frappe.db.get_values('Maintenance Team Member', { 'parent': filters.get("maintenance_team") }, "team_member") + return frappe.db.get_values( + "Maintenance Team Member", {"parent": filters.get("maintenance_team")}, "team_member" + ) + @frappe.whitelist() def get_maintenance_log(asset_name): - return frappe.db.sql(""" + return frappe.db.sql( + """ select maintenance_status, count(asset_name) as count, asset_name from `tabAsset Maintenance Log` where asset_name=%s group by maintenance_status""", - (asset_name), as_dict=1) + (asset_name), + as_dict=1, + ) diff --git a/erpnext/assets/doctype/asset_maintenance/test_asset_maintenance.py b/erpnext/assets/doctype/asset_maintenance/test_asset_maintenance.py index 8acb61b9671..e40a5519eb2 100644 --- a/erpnext/assets/doctype/asset_maintenance/test_asset_maintenance.py +++ b/erpnext/assets/doctype/asset_maintenance/test_asset_maintenance.py @@ -17,11 +17,12 @@ class TestAssetMaintenance(unittest.TestCase): create_maintenance_team() def test_create_asset_maintenance(self): - pr = make_purchase_receipt(item_code="Photocopier", - qty=1, rate=100000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Photocopier", qty=1, rate=100000.0, location="Test Location" + ) - asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, 'name') - asset_doc = frappe.get_doc('Asset', asset_name) + asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, "name") + asset_doc = frappe.get_doc("Asset", asset_name) month_end_date = get_last_day(nowdate()) purchase_date = nowdate() if nowdate() != month_end_date else add_days(nowdate(), -15) @@ -30,66 +31,74 @@ class TestAssetMaintenance(unittest.TestCase): asset_doc.purchase_date = purchase_date asset_doc.calculate_depreciation = 1 - asset_doc.append("finance_books", { - "expected_value_after_useful_life": 200, - "depreciation_method": "Straight Line", - "total_number_of_depreciations": 3, - "frequency_of_depreciation": 10, - "depreciation_start_date": month_end_date - }) + asset_doc.append( + "finance_books", + { + "expected_value_after_useful_life": 200, + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 3, + "frequency_of_depreciation": 10, + "depreciation_start_date": month_end_date, + }, + ) asset_doc.save() if not frappe.db.exists("Asset Maintenance", "Photocopier"): - asset_maintenance = frappe.get_doc({ + asset_maintenance = frappe.get_doc( + { "doctype": "Asset Maintenance", "asset_name": "Photocopier", "maintenance_team": "Team Awesome", "company": "_Test Company", - "asset_maintenance_tasks": get_maintenance_tasks() - }).insert() + "asset_maintenance_tasks": get_maintenance_tasks(), + } + ).insert() next_due_date = calculate_next_due_date(nowdate(), "Monthly") self.assertEqual(asset_maintenance.asset_maintenance_tasks[0].next_due_date, next_due_date) def test_create_asset_maintenance_log(self): if not frappe.db.exists("Asset Maintenance Log", "Photocopier"): - asset_maintenance_log = frappe.get_doc({ + asset_maintenance_log = frappe.get_doc( + { "doctype": "Asset Maintenance Log", "asset_maintenance": "Photocopier", "task": "Change Oil", "completion_date": add_days(nowdate(), 2), - "maintenance_status": "Completed" - }).insert() + "maintenance_status": "Completed", + } + ).insert() asset_maintenance = frappe.get_doc("Asset Maintenance", "Photocopier") next_due_date = calculate_next_due_date(asset_maintenance_log.completion_date, "Monthly") self.assertEqual(asset_maintenance.asset_maintenance_tasks[0].next_due_date, next_due_date) + def create_asset_data(): if not frappe.db.exists("Asset Category", "Equipment"): create_asset_category() if not frappe.db.exists("Location", "Test Location"): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': 'Test Location' - }).insert() + frappe.get_doc({"doctype": "Location", "location_name": "Test Location"}).insert() if not frappe.db.exists("Item", "Photocopier"): - meta = frappe.get_meta('Asset') + meta = frappe.get_meta("Asset") naming_series = meta.get_field("naming_series").options - frappe.get_doc({ - "doctype": "Item", - "item_code": "Photocopier", - "item_name": "Photocopier", - "item_group": "All Item Groups", - "company": "_Test Company", - "is_fixed_asset": 1, - "is_stock_item": 0, - "asset_category": "Equipment", - "auto_create_assets": 1, - "asset_naming_series": naming_series - }).insert() + frappe.get_doc( + { + "doctype": "Item", + "item_code": "Photocopier", + "item_name": "Photocopier", + "item_group": "All Item Groups", + "company": "_Test Company", + "is_fixed_asset": 1, + "is_stock_item": 0, + "asset_category": "Equipment", + "auto_create_assets": 1, + "asset_naming_series": naming_series, + } + ).insert() + def create_maintenance_team(): user_list = ["marcus@abc.com", "thalia@abc.com", "mathias@abc.com"] @@ -97,60 +106,73 @@ def create_maintenance_team(): frappe.get_doc({"doctype": "Role", "role_name": "Technician"}).insert() for user in user_list: if not frappe.db.get_value("User", user): - frappe.get_doc({ - "doctype": "User", - "email": user, - "first_name": user, - "new_password": "password", - "roles": [{"doctype": "Has Role", "role": "Technician"}] - }).insert() + frappe.get_doc( + { + "doctype": "User", + "email": user, + "first_name": user, + "new_password": "password", + "roles": [{"doctype": "Has Role", "role": "Technician"}], + } + ).insert() if not frappe.db.exists("Asset Maintenance Team", "Team Awesome"): - frappe.get_doc({ - "doctype": "Asset Maintenance Team", - "maintenance_manager": "marcus@abc.com", - "maintenance_team_name": "Team Awesome", - "company": "_Test Company", - "maintenance_team_members": get_maintenance_team(user_list) - }).insert() + frappe.get_doc( + { + "doctype": "Asset Maintenance Team", + "maintenance_manager": "marcus@abc.com", + "maintenance_team_name": "Team Awesome", + "company": "_Test Company", + "maintenance_team_members": get_maintenance_team(user_list), + } + ).insert() + def get_maintenance_team(user_list): - return [{"team_member": user, - "full_name": user, - "maintenance_role": "Technician" - } - for user in user_list[1:]] + return [ + {"team_member": user, "full_name": user, "maintenance_role": "Technician"} + for user in user_list[1:] + ] + def get_maintenance_tasks(): - return [{"maintenance_task": "Change Oil", + return [ + { + "maintenance_task": "Change Oil", "start_date": nowdate(), "periodicity": "Monthly", "maintenance_type": "Preventive Maintenance", "maintenance_status": "Planned", - "assign_to": "marcus@abc.com" - }, - {"maintenance_task": "Check Gears", + "assign_to": "marcus@abc.com", + }, + { + "maintenance_task": "Check Gears", "start_date": nowdate(), "periodicity": "Yearly", "maintenance_type": "Calibration", "maintenance_status": "Planned", - "assign_to": "thalia@abc.com" - } - ] + "assign_to": "thalia@abc.com", + }, + ] + def create_asset_category(): asset_category = frappe.new_doc("Asset Category") asset_category.asset_category_name = "Equipment" asset_category.total_number_of_depreciations = 3 asset_category.frequency_of_depreciation = 3 - asset_category.append("accounts", { - "company_name": "_Test Company", - "fixed_asset_account": "_Test Fixed Asset - _TC", - "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", - "depreciation_expense_account": "_Test Depreciations - _TC" - }) + asset_category.append( + "accounts", + { + "company_name": "_Test Company", + "fixed_asset_account": "_Test Fixed Asset - _TC", + "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", + "depreciation_expense_account": "_Test Depreciations - _TC", + }, + ) asset_category.insert() + def set_depreciation_settings_in_company(): company = frappe.get_doc("Company", "_Test Company") company.accumulated_depreciation_account = "_Test Accumulated Depreciations - _TC" diff --git a/erpnext/assets/doctype/asset_maintenance_log/asset_maintenance_log.py b/erpnext/assets/doctype/asset_maintenance_log/asset_maintenance_log.py index 7d3453fc982..ff791b27549 100644 --- a/erpnext/assets/doctype/asset_maintenance_log/asset_maintenance_log.py +++ b/erpnext/assets/doctype/asset_maintenance_log/asset_maintenance_log.py @@ -12,7 +12,10 @@ from erpnext.assets.doctype.asset_maintenance.asset_maintenance import calculate class AssetMaintenanceLog(Document): def validate(self): - if getdate(self.due_date) < getdate(nowdate()) and self.maintenance_status not in ["Completed", "Cancelled"]: + if getdate(self.due_date) < getdate(nowdate()) and self.maintenance_status not in [ + "Completed", + "Cancelled", + ]: self.maintenance_status = "Overdue" if self.maintenance_status == "Completed" and not self.completion_date: @@ -22,15 +25,17 @@ class AssetMaintenanceLog(Document): frappe.throw(_("Please select Maintenance Status as Completed or remove Completion Date")) def on_submit(self): - if self.maintenance_status not in ['Completed', 'Cancelled']: + if self.maintenance_status not in ["Completed", "Cancelled"]: frappe.throw(_("Maintenance Status has to be Cancelled or Completed to Submit")) self.update_maintenance_task() def update_maintenance_task(self): - asset_maintenance_doc = frappe.get_doc('Asset Maintenance Task', self.task) + asset_maintenance_doc = frappe.get_doc("Asset Maintenance Task", self.task) if self.maintenance_status == "Completed": if asset_maintenance_doc.last_completion_date != self.completion_date: - next_due_date = calculate_next_due_date(periodicity = self.periodicity, last_completion_date = self.completion_date) + next_due_date = calculate_next_due_date( + periodicity=self.periodicity, last_completion_date=self.completion_date + ) asset_maintenance_doc.last_completion_date = self.completion_date asset_maintenance_doc.next_due_date = next_due_date asset_maintenance_doc.maintenance_status = "Planned" @@ -38,11 +43,14 @@ class AssetMaintenanceLog(Document): if self.maintenance_status == "Cancelled": asset_maintenance_doc.maintenance_status = "Cancelled" asset_maintenance_doc.save() - asset_maintenance_doc = frappe.get_doc('Asset Maintenance', self.asset_maintenance) + asset_maintenance_doc = frappe.get_doc("Asset Maintenance", self.asset_maintenance) asset_maintenance_doc.save() + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_maintenance_tasks(doctype, txt, searchfield, start, page_len, filters): - asset_maintenance_tasks = frappe.db.get_values('Asset Maintenance Task', {'parent':filters.get("asset_maintenance")}, 'maintenance_task') + asset_maintenance_tasks = frappe.db.get_values( + "Asset Maintenance Task", {"parent": filters.get("asset_maintenance")}, "maintenance_task" + ) return asset_maintenance_tasks diff --git a/erpnext/assets/doctype/asset_movement/asset_movement.py b/erpnext/assets/doctype/asset_movement/asset_movement.py index 07bea616da6..e61efadb123 100644 --- a/erpnext/assets/doctype/asset_movement/asset_movement.py +++ b/erpnext/assets/doctype/asset_movement/asset_movement.py @@ -16,7 +16,7 @@ class AssetMovement(Document): def validate_asset(self): for d in self.assets: status, company = frappe.db.get_value("Asset", d.asset, ["status", "company"]) - if self.purpose == 'Transfer' and status in ("Draft", "Scrapped", "Sold"): + if self.purpose == "Transfer" and status in ("Draft", "Scrapped", "Sold"): frappe.throw(_("{0} asset cannot be transferred").format(status)) if company != self.company: @@ -27,7 +27,7 @@ class AssetMovement(Document): def validate_location(self): for d in self.assets: - if self.purpose in ['Transfer', 'Issue']: + if self.purpose in ["Transfer", "Issue"]: if not d.source_location: d.source_location = frappe.db.get_value("Asset", d.asset, "location") @@ -38,52 +38,76 @@ class AssetMovement(Document): current_location = frappe.db.get_value("Asset", d.asset, "location") if current_location != d.source_location: - frappe.throw(_("Asset {0} does not belongs to the location {1}"). - format(d.asset, d.source_location)) + frappe.throw( + _("Asset {0} does not belongs to the location {1}").format(d.asset, d.source_location) + ) - if self.purpose == 'Issue': + if self.purpose == "Issue": if d.target_location: - frappe.throw(_("Issuing cannot be done to a location. \ - Please enter employee who has issued Asset {0}").format(d.asset), title="Incorrect Movement Purpose") + frappe.throw( + _( + "Issuing cannot be done to a location. \ + Please enter employee who has issued Asset {0}" + ).format(d.asset), + title="Incorrect Movement Purpose", + ) if not d.to_employee: frappe.throw(_("Employee is required while issuing Asset {0}").format(d.asset)) - if self.purpose == 'Transfer': + if self.purpose == "Transfer": if d.to_employee: - frappe.throw(_("Transferring cannot be done to an Employee. \ - Please enter location where Asset {0} has to be transferred").format( - d.asset), title="Incorrect Movement Purpose") + frappe.throw( + _( + "Transferring cannot be done to an Employee. \ + Please enter location where Asset {0} has to be transferred" + ).format(d.asset), + title="Incorrect Movement Purpose", + ) if not d.target_location: frappe.throw(_("Target Location is required while transferring Asset {0}").format(d.asset)) if d.source_location == d.target_location: frappe.throw(_("Source and Target Location cannot be same")) - if self.purpose == 'Receipt': + if self.purpose == "Receipt": # only when asset is bought and first entry is made if not d.source_location and not (d.target_location or d.to_employee): - frappe.throw(_("Target Location or To Employee is required while receiving Asset {0}").format(d.asset)) + frappe.throw( + _("Target Location or To Employee is required while receiving Asset {0}").format(d.asset) + ) elif d.source_location: # when asset is received from an employee if d.target_location and not d.from_employee: - frappe.throw(_("From employee is required while receiving Asset {0} to a target location").format(d.asset)) + frappe.throw( + _("From employee is required while receiving Asset {0} to a target location").format( + d.asset + ) + ) if d.from_employee and not d.target_location: - frappe.throw(_("Target Location is required while receiving Asset {0} from an employee").format(d.asset)) + frappe.throw( + _("Target Location is required while receiving Asset {0} from an employee").format(d.asset) + ) if d.to_employee and d.target_location: - frappe.throw(_("Asset {0} cannot be received at a location and \ - given to employee in a single movement").format(d.asset)) + frappe.throw( + _( + "Asset {0} cannot be received at a location and \ + given to employee in a single movement" + ).format(d.asset) + ) def validate_employee(self): for d in self.assets: if d.from_employee: - current_custodian = frappe.db.get_value("Asset", d.asset, "custodian") + current_custodian = frappe.db.get_value("Asset", d.asset, "custodian") - if current_custodian != d.from_employee: - frappe.throw(_("Asset {0} does not belongs to the custodian {1}"). - format(d.asset, d.from_employee)) + if current_custodian != d.from_employee: + frappe.throw( + _("Asset {0} does not belongs to the custodian {1}").format(d.asset, d.from_employee) + ) if d.to_employee and frappe.db.get_value("Employee", d.to_employee, "company") != self.company: - frappe.throw(_("Employee {0} does not belongs to the company {1}"). - format(d.to_employee, self.company)) + frappe.throw( + _("Employee {0} does not belongs to the company {1}").format(d.to_employee, self.company) + ) def on_submit(self): self.set_latest_location_in_asset() @@ -92,14 +116,11 @@ class AssetMovement(Document): self.set_latest_location_in_asset() def set_latest_location_in_asset(self): - current_location, current_employee = '', '' + current_location, current_employee = "", "" cond = "1=1" for d in self.assets: - args = { - 'asset': d.asset, - 'company': self.company - } + args = {"asset": d.asset, "company": self.company} # latest entry corresponds to current document's location, employee when transaction date > previous dates # In case of cancellation it corresponds to previous latest document's location, employee @@ -114,10 +135,14 @@ class AssetMovement(Document): asm.docstatus=1 and {0} ORDER BY asm.transaction_date desc limit 1 - """.format(cond), args) + """.format( + cond + ), + args, + ) if latest_movement_entry: current_location = latest_movement_entry[0][0] current_employee = latest_movement_entry[0][1] - frappe.db.set_value('Asset', d.asset, 'location', current_location) - frappe.db.set_value('Asset', d.asset, 'custodian', current_employee) + frappe.db.set_value("Asset", d.asset, "location", current_location) + frappe.db.set_value("Asset", d.asset, "custodian", current_employee) diff --git a/erpnext/assets/doctype/asset_movement/test_asset_movement.py b/erpnext/assets/doctype/asset_movement/test_asset_movement.py index 025facc4fda..a5fe52cefa2 100644 --- a/erpnext/assets/doctype/asset_movement/test_asset_movement.py +++ b/erpnext/assets/doctype/asset_movement/test_asset_movement.py @@ -13,95 +13,122 @@ from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import make_pu class TestAssetMovement(unittest.TestCase): def setUp(self): - frappe.db.set_value("Company", "_Test Company", "capital_work_in_progress_account", "CWIP Account - _TC") + frappe.db.set_value( + "Company", "_Test Company", "capital_work_in_progress_account", "CWIP Account - _TC" + ) create_asset_data() make_location() def test_movement(self): - pr = make_purchase_receipt(item_code="Macbook Pro", - qty=1, rate=100000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=1, rate=100000.0, location="Test Location" + ) - asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, 'name') - asset = frappe.get_doc('Asset', asset_name) + asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, "name") + asset = frappe.get_doc("Asset", asset_name) asset.calculate_depreciation = 1 - asset.available_for_use_date = '2020-06-06' - asset.purchase_date = '2020-06-06' - asset.append("finance_books", { - "expected_value_after_useful_life": 10000, - "next_depreciation_date": "2020-12-31", - "depreciation_method": "Straight Line", - "total_number_of_depreciations": 3, - "frequency_of_depreciation": 10 - }) + asset.available_for_use_date = "2020-06-06" + asset.purchase_date = "2020-06-06" + asset.append( + "finance_books", + { + "expected_value_after_useful_life": 10000, + "next_depreciation_date": "2020-12-31", + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 3, + "frequency_of_depreciation": 10, + }, + ) if asset.docstatus == 0: asset.submit() # check asset movement is created if not frappe.db.exists("Location", "Test Location 2"): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': 'Test Location 2' - }).insert() + frappe.get_doc({"doctype": "Location", "location_name": "Test Location 2"}).insert() - movement1 = create_asset_movement(purpose = 'Transfer', company = asset.company, - assets = [{ 'asset': asset.name , 'source_location': 'Test Location', 'target_location': 'Test Location 2'}], - reference_doctype = 'Purchase Receipt', reference_name = pr.name) + movement1 = create_asset_movement( + purpose="Transfer", + company=asset.company, + assets=[ + {"asset": asset.name, "source_location": "Test Location", "target_location": "Test Location 2"} + ], + reference_doctype="Purchase Receipt", + reference_name=pr.name, + ) self.assertEqual(frappe.db.get_value("Asset", asset.name, "location"), "Test Location 2") - create_asset_movement(purpose = 'Transfer', company = asset.company, - assets = [{ 'asset': asset.name , 'source_location': 'Test Location 2', 'target_location': 'Test Location'}], - reference_doctype = 'Purchase Receipt', reference_name = pr.name) + create_asset_movement( + purpose="Transfer", + company=asset.company, + assets=[ + {"asset": asset.name, "source_location": "Test Location 2", "target_location": "Test Location"} + ], + reference_doctype="Purchase Receipt", + reference_name=pr.name, + ) self.assertEqual(frappe.db.get_value("Asset", asset.name, "location"), "Test Location") movement1.cancel() self.assertEqual(frappe.db.get_value("Asset", asset.name, "location"), "Test Location") employee = make_employee("testassetmovemp@example.com", company="_Test Company") - create_asset_movement(purpose = 'Issue', company = asset.company, - assets = [{ 'asset': asset.name , 'source_location': 'Test Location', 'to_employee': employee}], - reference_doctype = 'Purchase Receipt', reference_name = pr.name) + create_asset_movement( + purpose="Issue", + company=asset.company, + assets=[{"asset": asset.name, "source_location": "Test Location", "to_employee": employee}], + reference_doctype="Purchase Receipt", + reference_name=pr.name, + ) # after issuing asset should belong to an employee not at a location self.assertEqual(frappe.db.get_value("Asset", asset.name, "location"), None) self.assertEqual(frappe.db.get_value("Asset", asset.name, "custodian"), employee) def test_last_movement_cancellation(self): - pr = make_purchase_receipt(item_code="Macbook Pro", - qty=1, rate=100000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=1, rate=100000.0, location="Test Location" + ) - asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, 'name') - asset = frappe.get_doc('Asset', asset_name) + asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, "name") + asset = frappe.get_doc("Asset", asset_name) asset.calculate_depreciation = 1 - asset.available_for_use_date = '2020-06-06' - asset.purchase_date = '2020-06-06' - asset.append("finance_books", { - "expected_value_after_useful_life": 10000, - "next_depreciation_date": "2020-12-31", - "depreciation_method": "Straight Line", - "total_number_of_depreciations": 3, - "frequency_of_depreciation": 10 - }) + asset.available_for_use_date = "2020-06-06" + asset.purchase_date = "2020-06-06" + asset.append( + "finance_books", + { + "expected_value_after_useful_life": 10000, + "next_depreciation_date": "2020-12-31", + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 3, + "frequency_of_depreciation": 10, + }, + ) if asset.docstatus == 0: asset.submit() if not frappe.db.exists("Location", "Test Location 2"): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': 'Test Location 2' - }).insert() + frappe.get_doc({"doctype": "Location", "location_name": "Test Location 2"}).insert() - movement = frappe.get_doc({'doctype': 'Asset Movement', 'reference_name': pr.name }) + movement = frappe.get_doc({"doctype": "Asset Movement", "reference_name": pr.name}) self.assertRaises(frappe.ValidationError, movement.cancel) - movement1 = create_asset_movement(purpose = 'Transfer', company = asset.company, - assets = [{ 'asset': asset.name , 'source_location': 'Test Location', 'target_location': 'Test Location 2'}], - reference_doctype = 'Purchase Receipt', reference_name = pr.name) + movement1 = create_asset_movement( + purpose="Transfer", + company=asset.company, + assets=[ + {"asset": asset.name, "source_location": "Test Location", "target_location": "Test Location 2"} + ], + reference_doctype="Purchase Receipt", + reference_name=pr.name, + ) self.assertEqual(frappe.db.get_value("Asset", asset.name, "location"), "Test Location 2") movement1.cancel() self.assertEqual(frappe.db.get_value("Asset", asset.name, "location"), "Test Location") + def create_asset_movement(**args): args = frappe._dict(args) @@ -109,24 +136,26 @@ def create_asset_movement(**args): args.transaction_date = now() movement = frappe.new_doc("Asset Movement") - movement.update({ - "assets": args.assets, - "transaction_date": args.transaction_date, - "company": args.company, - 'purpose': args.purpose or 'Receipt', - 'reference_doctype': args.reference_doctype, - 'reference_name': args.reference_name - }) + movement.update( + { + "assets": args.assets, + "transaction_date": args.transaction_date, + "company": args.company, + "purpose": args.purpose or "Receipt", + "reference_doctype": args.reference_doctype, + "reference_name": args.reference_name, + } + ) movement.insert() movement.submit() return movement + def make_location(): - for location in ['Pune', 'Mumbai', 'Nagpur']: - if not frappe.db.exists('Location', location): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': location - }).insert(ignore_permissions = True) + for location in ["Pune", "Mumbai", "Nagpur"]: + if not frappe.db.exists("Location", location): + frappe.get_doc({"doctype": "Location", "location_name": location}).insert( + ignore_permissions=True + ) diff --git a/erpnext/assets/doctype/asset_repair/asset_repair.js b/erpnext/assets/doctype/asset_repair/asset_repair.js index d554d52a718..3fe6b2d0d5d 100644 --- a/erpnext/assets/doctype/asset_repair/asset_repair.js +++ b/erpnext/assets/doctype/asset_repair/asset_repair.js @@ -68,6 +68,28 @@ frappe.ui.form.on('Asset Repair', { }); frappe.ui.form.on('Asset Repair Consumed Item', { + item_code: function(frm, cdt, cdn) { + var item = locals[cdt][cdn]; + + let item_args = { + 'item_code': item.item_code, + 'warehouse': frm.doc.warehouse, + 'qty': item.consumed_quantity, + 'serial_no': item.serial_no, + 'company': frm.doc.company + }; + + frappe.call({ + method: 'erpnext.stock.utils.get_incoming_rate', + args: { + args: item_args + }, + callback: function(r) { + frappe.model.set_value(cdt, cdn, 'valuation_rate', r.message); + } + }); + }, + consumed_quantity: function(frm, cdt, cdn) { var row = locals[cdt][cdn]; frappe.model.set_value(cdt, cdn, 'total_value', row.consumed_quantity * row.valuation_rate); diff --git a/erpnext/assets/doctype/asset_repair/asset_repair.py b/erpnext/assets/doctype/asset_repair/asset_repair.py index 36848e9f15c..94b4c641333 100644 --- a/erpnext/assets/doctype/asset_repair/asset_repair.py +++ b/erpnext/assets/doctype/asset_repair/asset_repair.py @@ -13,21 +13,21 @@ from erpnext.controllers.accounts_controller import AccountsController class AssetRepair(AccountsController): def validate(self): - self.asset_doc = frappe.get_doc('Asset', self.asset) + self.asset_doc = frappe.get_doc("Asset", self.asset) self.update_status() - if self.get('stock_items'): + if self.get("stock_items"): self.set_total_value() self.calculate_total_repair_cost() def update_status(self): - if self.repair_status == 'Pending': - frappe.db.set_value('Asset', self.asset, 'status', 'Out of Order') + if self.repair_status == "Pending": + frappe.db.set_value("Asset", self.asset, "status", "Out of Order") else: self.asset_doc.set_status() def set_total_value(self): - for item in self.get('stock_items'): + for item in self.get("stock_items"): item.total_value = flt(item.valuation_rate) * flt(item.consumed_quantity) def calculate_total_repair_cost(self): @@ -39,46 +39,63 @@ class AssetRepair(AccountsController): def before_submit(self): self.check_repair_status() - if self.get('stock_consumption') or self.get('capitalize_repair_cost'): + if self.get("stock_consumption") or self.get("capitalize_repair_cost"): self.increase_asset_value() - if self.get('stock_consumption'): - self.check_for_stock_items_and_warehouse() - self.decrease_stock_quantity() - if self.get('capitalize_repair_cost'): - self.make_gl_entries() - if frappe.db.get_value('Asset', self.asset, 'calculate_depreciation') and self.increase_in_asset_life: - self.modify_depreciation_schedule() - self.asset_doc.flags.ignore_validate_update_after_submit = True - self.asset_doc.prepare_depreciation_data() - self.asset_doc.save() + if self.get("stock_consumption"): + self.check_for_stock_items_and_warehouse() + self.decrease_stock_quantity() + + if self.get("capitalize_repair_cost"): + self.make_gl_entries() + + if ( + frappe.db.get_value("Asset", self.asset, "calculate_depreciation") + and self.increase_in_asset_life + ): + self.modify_depreciation_schedule() + + self.asset_doc.flags.ignore_validate_update_after_submit = True + self.asset_doc.prepare_depreciation_data() + self.asset_doc.save() def before_cancel(self): - self.asset_doc = frappe.get_doc('Asset', self.asset) + self.asset_doc = frappe.get_doc("Asset", self.asset) - if self.get('stock_consumption') or self.get('capitalize_repair_cost'): + if self.get("stock_consumption") or self.get("capitalize_repair_cost"): self.decrease_asset_value() - if self.get('stock_consumption'): - self.increase_stock_quantity() - if self.get('capitalize_repair_cost'): - self.ignore_linked_doctypes = ('GL Entry', 'Stock Ledger Entry') - self.make_gl_entries(cancel=True) - if frappe.db.get_value('Asset', self.asset, 'calculate_depreciation') and self.increase_in_asset_life: - self.revert_depreciation_schedule_on_cancellation() - self.asset_doc.flags.ignore_validate_update_after_submit = True - self.asset_doc.prepare_depreciation_data() - self.asset_doc.save() + if self.get("stock_consumption"): + self.increase_stock_quantity() + + if self.get("capitalize_repair_cost"): + self.ignore_linked_doctypes = ("GL Entry", "Stock Ledger Entry") + self.make_gl_entries(cancel=True) + + if ( + frappe.db.get_value("Asset", self.asset, "calculate_depreciation") + and self.increase_in_asset_life + ): + self.revert_depreciation_schedule_on_cancellation() + + self.asset_doc.flags.ignore_validate_update_after_submit = True + self.asset_doc.prepare_depreciation_data() + self.asset_doc.save() def check_repair_status(self): if self.repair_status == "Pending": frappe.throw(_("Please update Repair Status.")) def check_for_stock_items_and_warehouse(self): - if not self.get('stock_items'): - frappe.throw(_("Please enter Stock Items consumed during the Repair."), title=_("Missing Items")) + if not self.get("stock_items"): + frappe.throw( + _("Please enter Stock Items consumed during the Repair."), title=_("Missing Items") + ) if not self.warehouse: - frappe.throw(_("Please enter Warehouse from which Stock Items consumed during the Repair were taken."), title=_("Missing Warehouse")) + frappe.throw( + _("Please enter Warehouse from which Stock Items consumed during the Repair were taken."), + title=_("Missing Warehouse"), + ) def increase_asset_value(self): total_value_of_stock_consumed = self.get_total_value_of_stock_consumed() @@ -102,35 +119,36 @@ class AssetRepair(AccountsController): def get_total_value_of_stock_consumed(self): total_value_of_stock_consumed = 0 - if self.get('stock_consumption'): - for item in self.get('stock_items'): + if self.get("stock_consumption"): + for item in self.get("stock_items"): total_value_of_stock_consumed += item.total_value return total_value_of_stock_consumed def decrease_stock_quantity(self): - stock_entry = frappe.get_doc({ - "doctype": "Stock Entry", - "stock_entry_type": "Material Issue", - "company": self.company - }) + stock_entry = frappe.get_doc( + {"doctype": "Stock Entry", "stock_entry_type": "Material Issue", "company": self.company} + ) - for stock_item in self.get('stock_items'): - stock_entry.append('items', { - "s_warehouse": self.warehouse, - "item_code": stock_item.item_code, - "qty": stock_item.consumed_quantity, - "basic_rate": stock_item.valuation_rate, - "serial_no": stock_item.serial_no - }) + for stock_item in self.get("stock_items"): + stock_entry.append( + "items", + { + "s_warehouse": self.warehouse, + "item_code": stock_item.item_code, + "qty": stock_item.consumed_quantity, + "basic_rate": stock_item.valuation_rate, + "serial_no": stock_item.serial_no, + }, + ) stock_entry.insert() stock_entry.submit() - self.db_set('stock_entry', stock_entry.name) + self.db_set("stock_entry", stock_entry.name) def increase_stock_quantity(self): - stock_entry = frappe.get_doc('Stock Entry', self.stock_entry) + stock_entry = frappe.get_doc("Stock Entry", self.stock_entry) stock_entry.flags.ignore_links = True stock_entry.cancel() @@ -141,63 +159,78 @@ class AssetRepair(AccountsController): def get_gl_entries(self): gl_entries = [] - repair_and_maintenance_account = frappe.db.get_value('Company', self.company, 'repair_and_maintenance_account') - fixed_asset_account = get_asset_account("fixed_asset_account", asset=self.asset, company=self.company) - expense_account = frappe.get_doc('Purchase Invoice', self.purchase_invoice).items[0].expense_account - - gl_entries.append( - self.get_gl_dict({ - "account": expense_account, - "credit": self.repair_cost, - "credit_in_account_currency": self.repair_cost, - "against": repair_and_maintenance_account, - "voucher_type": self.doctype, - "voucher_no": self.name, - "cost_center": self.cost_center, - "posting_date": getdate(), - "company": self.company - }, item=self) + repair_and_maintenance_account = frappe.db.get_value( + "Company", self.company, "repair_and_maintenance_account" + ) + fixed_asset_account = get_asset_account( + "fixed_asset_account", asset=self.asset, company=self.company + ) + expense_account = ( + frappe.get_doc("Purchase Invoice", self.purchase_invoice).items[0].expense_account ) - if self.get('stock_consumption'): + gl_entries.append( + self.get_gl_dict( + { + "account": expense_account, + "credit": self.repair_cost, + "credit_in_account_currency": self.repair_cost, + "against": repair_and_maintenance_account, + "voucher_type": self.doctype, + "voucher_no": self.name, + "cost_center": self.cost_center, + "posting_date": getdate(), + "company": self.company, + }, + item=self, + ) + ) + + if self.get("stock_consumption"): # creating GL Entries for each row in Stock Items based on the Stock Entry created for it - stock_entry = frappe.get_doc('Stock Entry', self.stock_entry) + stock_entry = frappe.get_doc("Stock Entry", self.stock_entry) for item in stock_entry.items: gl_entries.append( - self.get_gl_dict({ - "account": item.expense_account, - "credit": item.amount, - "credit_in_account_currency": item.amount, - "against": repair_and_maintenance_account, - "voucher_type": self.doctype, - "voucher_no": self.name, - "cost_center": self.cost_center, - "posting_date": getdate(), - "company": self.company - }, item=self) + self.get_gl_dict( + { + "account": item.expense_account, + "credit": item.amount, + "credit_in_account_currency": item.amount, + "against": repair_and_maintenance_account, + "voucher_type": self.doctype, + "voucher_no": self.name, + "cost_center": self.cost_center, + "posting_date": getdate(), + "company": self.company, + }, + item=self, + ) ) gl_entries.append( - self.get_gl_dict({ - "account": fixed_asset_account, - "debit": self.total_repair_cost, - "debit_in_account_currency": self.total_repair_cost, - "against": expense_account, - "voucher_type": self.doctype, - "voucher_no": self.name, - "cost_center": self.cost_center, - "posting_date": getdate(), - "against_voucher_type": "Purchase Invoice", - "against_voucher": self.purchase_invoice, - "company": self.company - }, item=self) + self.get_gl_dict( + { + "account": fixed_asset_account, + "debit": self.total_repair_cost, + "debit_in_account_currency": self.total_repair_cost, + "against": expense_account, + "voucher_type": self.doctype, + "voucher_no": self.name, + "cost_center": self.cost_center, + "posting_date": getdate(), + "against_voucher_type": "Purchase Invoice", + "against_voucher": self.purchase_invoice, + "company": self.company, + }, + item=self, + ) ) return gl_entries def modify_depreciation_schedule(self): for row in self.asset_doc.finance_books: - row.total_number_of_depreciations += self.increase_in_asset_life/row.frequency_of_depreciation + row.total_number_of_depreciations += self.increase_in_asset_life / row.frequency_of_depreciation self.asset_doc.flags.increase_in_asset_life = False extra_months = self.increase_in_asset_life % row.frequency_of_depreciation @@ -207,26 +240,29 @@ class AssetRepair(AccountsController): # to help modify depreciation schedule when increase_in_asset_life is not a multiple of frequency_of_depreciation def calculate_last_schedule_date(self, asset, row, extra_months): asset.flags.increase_in_asset_life = True - number_of_pending_depreciations = cint(row.total_number_of_depreciations) - \ - cint(asset.number_of_depreciations_booked) + number_of_pending_depreciations = cint(row.total_number_of_depreciations) - cint( + asset.number_of_depreciations_booked + ) # the Schedule Date in the final row of the old Depreciation Schedule - last_schedule_date = asset.schedules[len(asset.schedules)-1].schedule_date + last_schedule_date = asset.schedules[len(asset.schedules) - 1].schedule_date # the Schedule Date in the final row of the new Depreciation Schedule asset.to_date = add_months(last_schedule_date, extra_months) # the latest possible date at which the depreciation can occur, without increasing the Total Number of Depreciations # if depreciations happen yearly and the Depreciation Posting Date is 01-01-2020, this could be 01-01-2021, 01-01-2022... - schedule_date = add_months(row.depreciation_start_date, - number_of_pending_depreciations * cint(row.frequency_of_depreciation)) + schedule_date = add_months( + row.depreciation_start_date, + number_of_pending_depreciations * cint(row.frequency_of_depreciation), + ) if asset.to_date > schedule_date: row.total_number_of_depreciations += 1 def revert_depreciation_schedule_on_cancellation(self): for row in self.asset_doc.finance_books: - row.total_number_of_depreciations -= self.increase_in_asset_life/row.frequency_of_depreciation + row.total_number_of_depreciations -= self.increase_in_asset_life / row.frequency_of_depreciation self.asset_doc.flags.increase_in_asset_life = False extra_months = self.increase_in_asset_life % row.frequency_of_depreciation @@ -235,23 +271,27 @@ class AssetRepair(AccountsController): def calculate_last_schedule_date_before_modification(self, asset, row, extra_months): asset.flags.increase_in_asset_life = True - number_of_pending_depreciations = cint(row.total_number_of_depreciations) - \ - cint(asset.number_of_depreciations_booked) + number_of_pending_depreciations = cint(row.total_number_of_depreciations) - cint( + asset.number_of_depreciations_booked + ) # the Schedule Date in the final row of the modified Depreciation Schedule - last_schedule_date = asset.schedules[len(asset.schedules)-1].schedule_date + last_schedule_date = asset.schedules[len(asset.schedules) - 1].schedule_date # the Schedule Date in the final row of the original Depreciation Schedule asset.to_date = add_months(last_schedule_date, -extra_months) # the latest possible date at which the depreciation can occur, without decreasing the Total Number of Depreciations # if depreciations happen yearly and the Depreciation Posting Date is 01-01-2020, this could be 01-01-2021, 01-01-2022... - schedule_date = add_months(row.depreciation_start_date, - (number_of_pending_depreciations - 1) * cint(row.frequency_of_depreciation)) + schedule_date = add_months( + row.depreciation_start_date, + (number_of_pending_depreciations - 1) * cint(row.frequency_of_depreciation), + ) if asset.to_date < schedule_date: row.total_number_of_depreciations -= 1 + @frappe.whitelist() def get_downtime(failure_date, completion_date): downtime = time_diff_in_hours(completion_date, failure_date) diff --git a/erpnext/assets/doctype/asset_repair/test_asset_repair.py b/erpnext/assets/doctype/asset_repair/test_asset_repair.py index 7c0d05748e1..4e7cf78090b 100644 --- a/erpnext/assets/doctype/asset_repair/test_asset_repair.py +++ b/erpnext/assets/doctype/asset_repair/test_asset_repair.py @@ -25,7 +25,7 @@ class TestAssetRepair(unittest.TestCase): def test_update_status(self): asset = create_asset(submit=1) initial_status = asset.status - asset_repair = create_asset_repair(asset = asset) + asset_repair = create_asset_repair(asset=asset) if asset_repair.repair_status == "Pending": asset.reload() @@ -37,14 +37,14 @@ class TestAssetRepair(unittest.TestCase): self.assertEqual(asset_status, initial_status) def test_stock_item_total_value(self): - asset_repair = create_asset_repair(stock_consumption = 1) + asset_repair = create_asset_repair(stock_consumption=1) for item in asset_repair.stock_items: total_value = flt(item.valuation_rate) * flt(item.consumed_quantity) self.assertEqual(item.total_value, total_value) def test_total_repair_cost(self): - asset_repair = create_asset_repair(stock_consumption = 1) + asset_repair = create_asset_repair(stock_consumption=1) total_repair_cost = asset_repair.repair_cost self.assertEqual(total_repair_cost, asset_repair.repair_cost) @@ -54,22 +54,22 @@ class TestAssetRepair(unittest.TestCase): self.assertEqual(total_repair_cost, asset_repair.total_repair_cost) def test_repair_status_after_submit(self): - asset_repair = create_asset_repair(submit = 1) + asset_repair = create_asset_repair(submit=1) self.assertNotEqual(asset_repair.repair_status, "Pending") def test_stock_items(self): - asset_repair = create_asset_repair(stock_consumption = 1) + asset_repair = create_asset_repair(stock_consumption=1) self.assertTrue(asset_repair.stock_consumption) self.assertTrue(asset_repair.stock_items) def test_warehouse(self): - asset_repair = create_asset_repair(stock_consumption = 1) + asset_repair = create_asset_repair(stock_consumption=1) self.assertTrue(asset_repair.stock_consumption) self.assertTrue(asset_repair.warehouse) def test_decrease_stock_quantity(self): - asset_repair = create_asset_repair(stock_consumption = 1, submit = 1) - stock_entry = frappe.get_last_doc('Stock Entry') + asset_repair = create_asset_repair(stock_consumption=1, submit=1) + stock_entry = frappe.get_last_doc("Stock Entry") self.assertEqual(stock_entry.stock_entry_type, "Material Issue") self.assertEqual(stock_entry.items[0].s_warehouse, asset_repair.warehouse) @@ -85,58 +85,72 @@ class TestAssetRepair(unittest.TestCase): serial_no = serial_nos.split("\n")[0] # should not raise any error - create_asset_repair(stock_consumption = 1, item_code = stock_entry.get("items")[0].item_code, - warehouse = "_Test Warehouse - _TC", serial_no = serial_no, submit = 1) + create_asset_repair( + stock_consumption=1, + item_code=stock_entry.get("items")[0].item_code, + warehouse="_Test Warehouse - _TC", + serial_no=serial_no, + submit=1, + ) # should raise error - asset_repair = create_asset_repair(stock_consumption = 1, warehouse = "_Test Warehouse - _TC", - item_code = stock_entry.get("items")[0].item_code) + asset_repair = create_asset_repair( + stock_consumption=1, + warehouse="_Test Warehouse - _TC", + item_code=stock_entry.get("items")[0].item_code, + ) asset_repair.repair_status = "Completed" self.assertRaises(SerialNoRequiredError, asset_repair.submit) def test_increase_in_asset_value_due_to_stock_consumption(self): - asset = create_asset(calculate_depreciation = 1, submit=1) + asset = create_asset(calculate_depreciation=1, submit=1) initial_asset_value = get_asset_value(asset) - asset_repair = create_asset_repair(asset= asset, stock_consumption = 1, submit = 1) + asset_repair = create_asset_repair(asset=asset, stock_consumption=1, submit=1) asset.reload() increase_in_asset_value = get_asset_value(asset) - initial_asset_value self.assertEqual(asset_repair.stock_items[0].total_value, increase_in_asset_value) def test_increase_in_asset_value_due_to_repair_cost_capitalisation(self): - asset = create_asset(calculate_depreciation = 1, submit=1) + asset = create_asset(calculate_depreciation=1, submit=1) initial_asset_value = get_asset_value(asset) - asset_repair = create_asset_repair(asset= asset, capitalize_repair_cost = 1, submit = 1) + asset_repair = create_asset_repair(asset=asset, capitalize_repair_cost=1, submit=1) asset.reload() increase_in_asset_value = get_asset_value(asset) - initial_asset_value self.assertEqual(asset_repair.repair_cost, increase_in_asset_value) def test_purchase_invoice(self): - asset_repair = create_asset_repair(capitalize_repair_cost = 1, submit = 1) + asset_repair = create_asset_repair(capitalize_repair_cost=1, submit=1) self.assertTrue(asset_repair.purchase_invoice) def test_gl_entries(self): - asset_repair = create_asset_repair(capitalize_repair_cost = 1, submit = 1) - gl_entry = frappe.get_last_doc('GL Entry') + asset_repair = create_asset_repair(capitalize_repair_cost=1, submit=1) + gl_entry = frappe.get_last_doc("GL Entry") self.assertEqual(asset_repair.name, gl_entry.voucher_no) def test_increase_in_asset_life(self): - asset = create_asset(calculate_depreciation = 1, submit=1) + asset = create_asset(calculate_depreciation=1, submit=1) initial_num_of_depreciations = num_of_depreciations(asset) - create_asset_repair(asset= asset, capitalize_repair_cost = 1, submit = 1) + create_asset_repair(asset=asset, capitalize_repair_cost=1, submit=1) asset.reload() self.assertEqual((initial_num_of_depreciations + 1), num_of_depreciations(asset)) - self.assertEqual(asset.schedules[-1].accumulated_depreciation_amount, asset.finance_books[0].value_after_depreciation) + self.assertEqual( + asset.schedules[-1].accumulated_depreciation_amount, + asset.finance_books[0].value_after_depreciation, + ) + def get_asset_value(asset): return asset.finance_books[0].value_after_depreciation + def num_of_depreciations(asset): return asset.finance_books[0].total_number_of_depreciations + def create_asset_repair(**args): from erpnext.accounts.doctype.purchase_invoice.test_purchase_invoice import make_purchase_invoice from erpnext.stock.doctype.warehouse.test_warehouse import create_warehouse @@ -146,26 +160,33 @@ def create_asset_repair(**args): if args.asset: asset = args.asset else: - asset = create_asset(is_existing_asset = 1, submit=1) + asset = create_asset(is_existing_asset=1, submit=1) asset_repair = frappe.new_doc("Asset Repair") - asset_repair.update({ - "asset": asset.name, - "asset_name": asset.asset_name, - "failure_date": nowdate(), - "description": "Test Description", - "repair_cost": 0, - "company": asset.company - }) + asset_repair.update( + { + "asset": asset.name, + "asset_name": asset.asset_name, + "failure_date": nowdate(), + "description": "Test Description", + "repair_cost": 0, + "company": asset.company, + } + ) if args.stock_consumption: asset_repair.stock_consumption = 1 - asset_repair.warehouse = args.warehouse or create_warehouse("Test Warehouse", company = asset.company) - asset_repair.append("stock_items", { - "item_code": args.item_code or "_Test Stock Item", - "valuation_rate": args.rate if args.get("rate") is not None else 100, - "consumed_quantity": args.qty or 1, - "serial_no": args.serial_no - }) + asset_repair.warehouse = args.warehouse or create_warehouse( + "Test Warehouse", company=asset.company + ) + asset_repair.append( + "stock_items", + { + "item_code": args.item_code or "_Test Stock Item", + "valuation_rate": args.rate if args.get("rate") is not None else 100, + "consumed_quantity": args.qty or 1, + "serial_no": args.serial_no, + }, + ) asset_repair.insert(ignore_if_duplicate=True) @@ -174,16 +195,17 @@ def create_asset_repair(**args): asset_repair.cost_center = "_Test Cost Center - _TC" if args.stock_consumption: - stock_entry = frappe.get_doc({ - "doctype": "Stock Entry", - "stock_entry_type": "Material Receipt", - "company": asset.company - }) - stock_entry.append('items', { - "t_warehouse": asset_repair.warehouse, - "item_code": asset_repair.stock_items[0].item_code, - "qty": asset_repair.stock_items[0].consumed_quantity - }) + stock_entry = frappe.get_doc( + {"doctype": "Stock Entry", "stock_entry_type": "Material Receipt", "company": asset.company} + ) + stock_entry.append( + "items", + { + "t_warehouse": asset_repair.warehouse, + "item_code": asset_repair.stock_items[0].item_code, + "qty": asset_repair.stock_items[0].consumed_quantity, + }, + ) stock_entry.submit() if args.capitalize_repair_cost: diff --git a/erpnext/assets/doctype/asset_repair_consumed_item/asset_repair_consumed_item.json b/erpnext/assets/doctype/asset_repair_consumed_item/asset_repair_consumed_item.json index f63add12356..4685a09db63 100644 --- a/erpnext/assets/doctype/asset_repair_consumed_item/asset_repair_consumed_item.json +++ b/erpnext/assets/doctype/asset_repair_consumed_item/asset_repair_consumed_item.json @@ -13,12 +13,10 @@ ], "fields": [ { - "fetch_from": "item.valuation_rate", "fieldname": "valuation_rate", "fieldtype": "Currency", "in_list_view": 1, - "label": "Valuation Rate", - "read_only": 1 + "label": "Valuation Rate" }, { "fieldname": "consumed_quantity", @@ -49,7 +47,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-11-11 18:23:00.492483", + "modified": "2022-02-08 17:37:20.028290", "modified_by": "Administrator", "module": "Assets", "name": "Asset Repair Consumed Item", diff --git a/erpnext/assets/doctype/asset_value_adjustment/asset_value_adjustment.py b/erpnext/assets/doctype/asset_value_adjustment/asset_value_adjustment.py index 0b646ed4ede..9953c61a811 100644 --- a/erpnext/assets/doctype/asset_value_adjustment/asset_value_adjustment.py +++ b/erpnext/assets/doctype/asset_value_adjustment/asset_value_adjustment.py @@ -31,10 +31,14 @@ class AssetValueAdjustment(Document): self.reschedule_depreciations(self.current_asset_value) def validate_date(self): - asset_purchase_date = frappe.db.get_value('Asset', self.asset, 'purchase_date') + asset_purchase_date = frappe.db.get_value("Asset", self.asset, "purchase_date") if getdate(self.date) < getdate(asset_purchase_date): - frappe.throw(_("Asset Value Adjustment cannot be posted before Asset's purchase date {0}.") - .format(formatdate(asset_purchase_date)), title="Incorrect Date") + frappe.throw( + _("Asset Value Adjustment cannot be posted before Asset's purchase date {0}.").format( + formatdate(asset_purchase_date) + ), + title="Incorrect Date", + ) def set_difference_amount(self): self.difference_amount = flt(self.current_asset_value - self.new_asset_value) @@ -45,11 +49,15 @@ class AssetValueAdjustment(Document): def make_depreciation_entry(self): asset = frappe.get_doc("Asset", self.asset) - fixed_asset_account, accumulated_depreciation_account, depreciation_expense_account = \ - get_depreciation_accounts(asset) + ( + fixed_asset_account, + accumulated_depreciation_account, + depreciation_expense_account, + ) = get_depreciation_accounts(asset) - depreciation_cost_center, depreciation_series = frappe.get_cached_value('Company', asset.company, - ["depreciation_cost_center", "series_for_depreciation_entry"]) + depreciation_cost_center, depreciation_series = frappe.get_cached_value( + "Company", asset.company, ["depreciation_cost_center", "series_for_depreciation_entry"] + ) je = frappe.new_doc("Journal Entry") je.voucher_type = "Depreciation Entry" @@ -62,27 +70,33 @@ class AssetValueAdjustment(Document): credit_entry = { "account": accumulated_depreciation_account, "credit_in_account_currency": self.difference_amount, - "cost_center": depreciation_cost_center or self.cost_center + "cost_center": depreciation_cost_center or self.cost_center, } debit_entry = { "account": depreciation_expense_account, "debit_in_account_currency": self.difference_amount, - "cost_center": depreciation_cost_center or self.cost_center + "cost_center": depreciation_cost_center or self.cost_center, } accounting_dimensions = get_checks_for_pl_and_bs_accounts() for dimension in accounting_dimensions: - if dimension.get('mandatory_for_bs'): - credit_entry.update({ - dimension['fieldname']: self.get(dimension['fieldname']) or dimension.get('default_dimension') - }) + if dimension.get("mandatory_for_bs"): + credit_entry.update( + { + dimension["fieldname"]: self.get(dimension["fieldname"]) + or dimension.get("default_dimension") + } + ) - if dimension.get('mandatory_for_pl'): - debit_entry.update({ - dimension['fieldname']: self.get(dimension['fieldname']) or dimension.get('default_dimension') - }) + if dimension.get("mandatory_for_pl"): + debit_entry.update( + { + dimension["fieldname"]: self.get(dimension["fieldname"]) + or dimension.get("default_dimension") + } + ) je.append("accounts", credit_entry) je.append("accounts", debit_entry) @@ -93,8 +107,8 @@ class AssetValueAdjustment(Document): self.db_set("journal_entry", je.name) def reschedule_depreciations(self, asset_value): - asset = frappe.get_doc('Asset', self.asset) - country = frappe.get_value('Company', self.company, 'country') + asset = frappe.get_doc("Asset", self.asset) + country = frappe.get_value("Company", self.company, "country") for d in asset.finance_books: d.value_after_depreciation = asset_value @@ -105,8 +119,11 @@ class AssetValueAdjustment(Document): rate_per_day = flt(d.value_after_depreciation) / flt(total_days) from_date = self.date else: - no_of_depreciations = len([s.name for s in asset.schedules - if (cint(s.finance_book_id) == d.idx and not s.journal_entry)]) + no_of_depreciations = len( + [ + s.name for s in asset.schedules if (cint(s.finance_book_id) == d.idx and not s.journal_entry) + ] + ) value_after_depreciation = d.value_after_depreciation for data in asset.schedules: @@ -132,10 +149,11 @@ class AssetValueAdjustment(Document): if not asset_data.journal_entry: asset_data.db_update() + @frappe.whitelist() def get_current_asset_value(asset, finance_book=None): - cond = {'parent': asset, 'parenttype': 'Asset'} + cond = {"parent": asset, "parenttype": "Asset"} if finance_book: - cond.update({'finance_book': finance_book}) + cond.update({"finance_book": finance_book}) - return frappe.db.get_value('Asset Finance Book', cond, 'value_after_depreciation') + return frappe.db.get_value("Asset Finance Book", cond, "value_after_depreciation") diff --git a/erpnext/assets/doctype/asset_value_adjustment/test_asset_value_adjustment.py b/erpnext/assets/doctype/asset_value_adjustment/test_asset_value_adjustment.py index ef13c5617f5..ebeb174d135 100644 --- a/erpnext/assets/doctype/asset_value_adjustment/test_asset_value_adjustment.py +++ b/erpnext/assets/doctype/asset_value_adjustment/test_asset_value_adjustment.py @@ -18,11 +18,12 @@ class TestAssetValueAdjustment(unittest.TestCase): create_asset_data() def test_current_asset_value(self): - pr = make_purchase_receipt(item_code="Macbook Pro", - qty=1, rate=100000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=1, rate=100000.0, location="Test Location" + ) - asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, 'name') - asset_doc = frappe.get_doc('Asset', asset_name) + asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, "name") + asset_doc = frappe.get_doc("Asset", asset_name) month_end_date = get_last_day(nowdate()) purchase_date = nowdate() if nowdate() != month_end_date else add_days(nowdate(), -15) @@ -30,24 +31,28 @@ class TestAssetValueAdjustment(unittest.TestCase): asset_doc.available_for_use_date = purchase_date asset_doc.purchase_date = purchase_date asset_doc.calculate_depreciation = 1 - asset_doc.append("finance_books", { - "expected_value_after_useful_life": 200, - "depreciation_method": "Straight Line", - "total_number_of_depreciations": 3, - "frequency_of_depreciation": 10, - "depreciation_start_date": month_end_date - }) + asset_doc.append( + "finance_books", + { + "expected_value_after_useful_life": 200, + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 3, + "frequency_of_depreciation": 10, + "depreciation_start_date": month_end_date, + }, + ) asset_doc.submit() current_value = get_current_asset_value(asset_doc.name) self.assertEqual(current_value, 100000.0) def test_asset_depreciation_value_adjustment(self): - pr = make_purchase_receipt(item_code="Macbook Pro", - qty=1, rate=100000.0, location="Test Location") + pr = make_purchase_receipt( + item_code="Macbook Pro", qty=1, rate=100000.0, location="Test Location" + ) - asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, 'name') - asset_doc = frappe.get_doc('Asset', asset_name) + asset_name = frappe.db.get_value("Asset", {"purchase_receipt": pr.name}, "name") + asset_doc = frappe.get_doc("Asset", asset_name) asset_doc.calculate_depreciation = 1 month_end_date = get_last_day(nowdate()) @@ -56,42 +61,52 @@ class TestAssetValueAdjustment(unittest.TestCase): asset_doc.available_for_use_date = purchase_date asset_doc.purchase_date = purchase_date asset_doc.calculate_depreciation = 1 - asset_doc.append("finance_books", { - "expected_value_after_useful_life": 200, - "depreciation_method": "Straight Line", - "total_number_of_depreciations": 3, - "frequency_of_depreciation": 10, - "depreciation_start_date": month_end_date - }) + asset_doc.append( + "finance_books", + { + "expected_value_after_useful_life": 200, + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 3, + "frequency_of_depreciation": 10, + "depreciation_start_date": month_end_date, + }, + ) asset_doc.submit() current_value = get_current_asset_value(asset_doc.name) - adj_doc = make_asset_value_adjustment(asset = asset_doc.name, - current_asset_value = current_value, new_asset_value = 50000.0) + adj_doc = make_asset_value_adjustment( + asset=asset_doc.name, current_asset_value=current_value, new_asset_value=50000.0 + ) adj_doc.submit() expected_gle = ( ("_Test Accumulated Depreciations - _TC", 0.0, 50000.0), - ("_Test Depreciations - _TC", 50000.0, 0.0) + ("_Test Depreciations - _TC", 50000.0, 0.0), ) - gle = frappe.db.sql("""select account, debit, credit from `tabGL Entry` + gle = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Journal Entry' and voucher_no = %s - order by account""", adj_doc.journal_entry) + order by account""", + adj_doc.journal_entry, + ) self.assertEqual(gle, expected_gle) + def make_asset_value_adjustment(**args): args = frappe._dict(args) - doc = frappe.get_doc({ - "doctype": "Asset Value Adjustment", - "company": args.company or "_Test Company", - "asset": args.asset, - "date": args.date or nowdate(), - "new_asset_value": args.new_asset_value, - "current_asset_value": args.current_asset_value, - "cost_center": args.cost_center or "Main - _TC" - }).insert() + doc = frappe.get_doc( + { + "doctype": "Asset Value Adjustment", + "company": args.company or "_Test Company", + "asset": args.asset, + "date": args.date or nowdate(), + "new_asset_value": args.new_asset_value, + "current_asset_value": args.current_asset_value, + "cost_center": args.cost_center or "Main - _TC", + } + ).insert() return doc diff --git a/erpnext/assets/doctype/location/location.py b/erpnext/assets/doctype/location/location.py index abc7325cf6c..0d87bb2bf4d 100644 --- a/erpnext/assets/doctype/location/location.py +++ b/erpnext/assets/doctype/location/location.py @@ -13,12 +13,12 @@ EARTH_RADIUS = 6378137 class Location(NestedSet): - nsm_parent_field = 'parent_location' + nsm_parent_field = "parent_location" def validate(self): self.calculate_location_area() - if not self.is_new() and self.get('parent_location'): + if not self.is_new() and self.get("parent_location"): self.update_ancestor_location_features() def on_update(self): @@ -42,7 +42,7 @@ class Location(NestedSet): if not self.location: return [] - features = json.loads(self.location).get('features') + features = json.loads(self.location).get("features") if not isinstance(features, list): features = json.loads(features) @@ -54,15 +54,15 @@ class Location(NestedSet): self.location = '{"type":"FeatureCollection","features":[]}' location = json.loads(self.location) - location['features'] = features + location["features"] = features - self.db_set('location', json.dumps(location), commit=True) + self.db_set("location", json.dumps(location), commit=True) def update_ancestor_location_features(self): self_features = set(self.add_child_property()) for ancestor in self.get_ancestors(): - ancestor_doc = frappe.get_doc('Location', ancestor) + ancestor_doc = frappe.get_doc("Location", ancestor) child_features, ancestor_features = ancestor_doc.feature_seperator(child_feature=self.name) ancestor_features = list(set(ancestor_features)) @@ -84,25 +84,27 @@ class Location(NestedSet): ancestor_features[index] = json.loads(feature) ancestor_doc.set_location_features(features=ancestor_features) - ancestor_doc.db_set('area', ancestor_doc.area + self.area_difference, commit=True) + ancestor_doc.db_set("area", ancestor_doc.area + self.area_difference, commit=True) def remove_ancestor_location_features(self): for ancestor in self.get_ancestors(): - ancestor_doc = frappe.get_doc('Location', ancestor) + ancestor_doc = frappe.get_doc("Location", ancestor) child_features, ancestor_features = ancestor_doc.feature_seperator(child_feature=self.name) for index, feature in enumerate(ancestor_features): ancestor_features[index] = json.loads(feature) ancestor_doc.set_location_features(features=ancestor_features) - ancestor_doc.db_set('area', ancestor_doc.area - self.area, commit=True) + ancestor_doc.db_set("area", ancestor_doc.area - self.area, commit=True) def add_child_property(self): features = self.get_location_features() - filter_features = [feature for feature in features if not feature.get('properties').get('child_feature')] + filter_features = [ + feature for feature in features if not feature.get("properties").get("child_feature") + ] for index, feature in enumerate(filter_features): - feature['properties'].update({'child_feature': True, 'feature_of': self.location_name}) + feature["properties"].update({"child_feature": True, "feature_of": self.location_name}) filter_features[index] = json.dumps(filter_features[index]) return filter_features @@ -112,7 +114,7 @@ class Location(NestedSet): features = self.get_location_features() for feature in features: - if feature.get('properties').get('feature_of') == child_feature: + if feature.get("properties").get("feature_of") == child_feature: child_features.extend([json.dumps(feature)]) else: non_child_features.extend([json.dumps(feature)]) @@ -126,22 +128,22 @@ def compute_area(features): Reference from https://github.com/scisco/area. Args: - `features` (list of dict): Features marked on the map as - GeoJSON data + `features` (list of dict): Features marked on the map as + GeoJSON data Returns: - float: The approximate signed geodesic area (in sq. meters) + float: The approximate signed geodesic area (in sq. meters) """ layer_area = 0.0 for feature in features: - feature_type = feature.get('geometry', {}).get('type') + feature_type = feature.get("geometry", {}).get("type") - if feature_type == 'Polygon': - layer_area += _polygon_area(coords=feature.get('geometry').get('coordinates')) - elif feature_type == 'Point' and feature.get('properties').get('point_type') == 'circle': - layer_area += math.pi * math.pow(feature.get('properties').get('radius'), 2) + if feature_type == "Polygon": + layer_area += _polygon_area(coords=feature.get("geometry").get("coordinates")) + elif feature_type == "Point" and feature.get("properties").get("point_type") == "circle": + layer_area += math.pi * math.pow(feature.get("properties").get("radius"), 2) return layer_area @@ -192,7 +194,8 @@ def get_children(doctype, parent=None, location=None, is_root=False): if parent is None or parent == "All Locations": parent = "" - return frappe.db.sql(""" + return frappe.db.sql( + """ select name as value, is_group as expandable @@ -201,17 +204,20 @@ def get_children(doctype, parent=None, location=None, is_root=False): where ifnull(parent_location, "")={parent} """.format( - doctype=doctype, - parent=frappe.db.escape(parent) - ), as_dict=1) + doctype=doctype, parent=frappe.db.escape(parent) + ), + as_dict=1, + ) + @frappe.whitelist() def add_node(): from frappe.desk.treeview import make_tree_args + args = frappe.form_dict args = make_tree_args(**args) - if args.parent_location == 'All Locations': + if args.parent_location == "All Locations": args.parent_location = None frappe.get_doc(args).insert() diff --git a/erpnext/assets/doctype/location/test_location.py b/erpnext/assets/doctype/location/test_location.py index 36e1dd4ce4b..b8563cb0a29 100644 --- a/erpnext/assets/doctype/location/test_location.py +++ b/erpnext/assets/doctype/location/test_location.py @@ -6,29 +6,34 @@ import unittest import frappe -test_records = frappe.get_test_records('Location') +test_records = frappe.get_test_records("Location") + class TestLocation(unittest.TestCase): def runTest(self): - locations = ['Basil Farm', 'Division 1', 'Field 1', 'Block 1'] + locations = ["Basil Farm", "Division 1", "Field 1", "Block 1"] area = 0 formatted_locations = [] for location in locations: - doc = frappe.get_doc('Location', location) + doc = frappe.get_doc("Location", location) doc.save() area += doc.area temp = json.loads(doc.location) - temp['features'][0]['properties']['child_feature'] = True - temp['features'][0]['properties']['feature_of'] = location - formatted_locations.extend(temp['features']) + temp["features"][0]["properties"]["child_feature"] = True + temp["features"][0]["properties"]["feature_of"] = location + formatted_locations.extend(temp["features"]) - test_location = frappe.get_doc('Location', 'Test Location Area') + test_location = frappe.get_doc("Location", "Test Location Area") test_location.save() - test_location_features = json.loads(test_location.get('location'))['features'] - ordered_test_location_features = sorted(test_location_features, key=lambda x: x['properties']['feature_of']) - ordered_formatted_locations = sorted(formatted_locations, key=lambda x: x['properties']['feature_of']) + test_location_features = json.loads(test_location.get("location"))["features"] + ordered_test_location_features = sorted( + test_location_features, key=lambda x: x["properties"]["feature_of"] + ) + ordered_formatted_locations = sorted( + formatted_locations, key=lambda x: x["properties"]["feature_of"] + ) self.assertEqual(ordered_formatted_locations, ordered_test_location_features) - self.assertEqual(area, test_location.get('area')) + self.assertEqual(area, test_location.get("area")) diff --git a/erpnext/assets/report/fixed_asset_register/fixed_asset_register.py b/erpnext/assets/report/fixed_asset_register/fixed_asset_register.py index db513364f49..6b14dce084e 100644 --- a/erpnext/assets/report/fixed_asset_register/fixed_asset_register.py +++ b/erpnext/assets/report/fixed_asset_register/fixed_asset_register.py @@ -17,16 +17,21 @@ def execute(filters=None): filters = frappe._dict(filters or {}) columns = get_columns(filters) data = get_data(filters) - chart = prepare_chart_data(data, filters) if filters.get("group_by") not in ("Asset Category", "Location") else {} + chart = ( + prepare_chart_data(data, filters) + if filters.get("group_by") not in ("Asset Category", "Location") + else {} + ) return columns, data, None, chart + def get_conditions(filters): - conditions = { 'docstatus': 1 } + conditions = {"docstatus": 1} status = filters.status date_field = frappe.scrub(filters.date_based_on or "Purchase Date") - if filters.get('company'): + if filters.get("company"): conditions["company"] = filters.company if filters.filter_based_on == "Date Range": conditions[date_field] = ["between", [filters.from_date, filters.to_date]] @@ -37,23 +42,24 @@ def get_conditions(filters): filters.year_end_date = getdate(fiscal_year.year_end_date) conditions[date_field] = ["between", [filters.year_start_date, filters.year_end_date]] - if filters.get('is_existing_asset'): - conditions["is_existing_asset"] = filters.get('is_existing_asset') - if filters.get('asset_category'): - conditions["asset_category"] = filters.get('asset_category') - if filters.get('cost_center'): - conditions["cost_center"] = filters.get('cost_center') + if filters.get("is_existing_asset"): + conditions["is_existing_asset"] = filters.get("is_existing_asset") + if filters.get("asset_category"): + conditions["asset_category"] = filters.get("asset_category") + if filters.get("cost_center"): + conditions["cost_center"] = filters.get("cost_center") if status: # In Store assets are those that are not sold or scrapped - operand = 'not in' - if status not in 'In Location': - operand = 'in' + operand = "not in" + if status not in "In Location": + operand = "in" - conditions['status'] = (operand, ['Sold', 'Scrapped']) + conditions["status"] = (operand, ["Sold", "Scrapped"]) return conditions + def get_data(filters): data = [] @@ -74,21 +80,37 @@ def get_data(filters): assets_record = frappe.db.get_all("Asset", filters=conditions, fields=fields, group_by=group_by) else: - fields = ["name as asset_id", "asset_name", "status", "department", "cost_center", "purchase_receipt", - "asset_category", "purchase_date", "gross_purchase_amount", "location", - "available_for_use_date", "purchase_invoice", "opening_accumulated_depreciation"] + fields = [ + "name as asset_id", + "asset_name", + "status", + "department", + "cost_center", + "purchase_receipt", + "asset_category", + "purchase_date", + "gross_purchase_amount", + "location", + "available_for_use_date", + "purchase_invoice", + "opening_accumulated_depreciation", + ] assets_record = frappe.db.get_all("Asset", filters=conditions, fields=fields) for asset in assets_record: - asset_value = asset.gross_purchase_amount - flt(asset.opening_accumulated_depreciation) \ + asset_value = ( + asset.gross_purchase_amount + - flt(asset.opening_accumulated_depreciation) - flt(depreciation_amount_map.get(asset.name)) + ) row = { "asset_id": asset.asset_id, "asset_name": asset.asset_name, "status": asset.status, "department": asset.department, "cost_center": asset.cost_center, - "vendor_name": pr_supplier_map.get(asset.purchase_receipt) or pi_supplier_map.get(asset.purchase_invoice), + "vendor_name": pr_supplier_map.get(asset.purchase_receipt) + or pi_supplier_map.get(asset.purchase_invoice), "gross_purchase_amount": asset.gross_purchase_amount, "opening_accumulated_depreciation": asset.opening_accumulated_depreciation, "depreciated_amount": depreciation_amount_map.get(asset.asset_id) or 0.0, @@ -96,21 +118,31 @@ def get_data(filters): "location": asset.location, "asset_category": asset.asset_category, "purchase_date": asset.purchase_date, - "asset_value": asset_value + "asset_value": asset_value, } data.append(row) return data + def prepare_chart_data(data, filters): labels_values_map = {} date_field = frappe.scrub(filters.date_based_on) - period_list = get_period_list(filters.from_fiscal_year, filters.to_fiscal_year, - filters.from_date, filters.to_date, filters.filter_based_on, "Monthly", company=filters.company) + period_list = get_period_list( + filters.from_fiscal_year, + filters.to_fiscal_year, + filters.from_date, + filters.to_date, + filters.filter_based_on, + "Monthly", + company=filters.company, + ) for d in period_list: - labels_values_map.setdefault(d.get('label'), frappe._dict({'asset_value': 0, 'depreciated_amount': 0})) + labels_values_map.setdefault( + d.get("label"), frappe._dict({"asset_value": 0, "depreciated_amount": 0}) + ) for d in data: date = d.get(date_field) @@ -120,23 +152,30 @@ def prepare_chart_data(data, filters): labels_values_map[belongs_to_month].depreciated_amount += d.get("depreciated_amount") return { - "data" : { + "data": { "labels": labels_values_map.keys(), "datasets": [ - { 'name': _('Asset Value'), 'values': [d.get("asset_value") for d in labels_values_map.values()] }, - { 'name': _('Depreciatied Amount'), 'values': [d.get("depreciated_amount") for d in labels_values_map.values()] } - ] + { + "name": _("Asset Value"), + "values": [d.get("asset_value") for d in labels_values_map.values()], + }, + { + "name": _("Depreciatied Amount"), + "values": [d.get("depreciated_amount") for d in labels_values_map.values()], + }, + ], }, "type": "bar", - "barOptions": { - "stacked": 1 - }, + "barOptions": {"stacked": 1}, } + def get_finance_book_value_map(filters): date = filters.to_date if filters.filter_based_on == "Date Range" else filters.year_end_date - return frappe._dict(frappe.db.sql(''' Select + return frappe._dict( + frappe.db.sql( + """ Select parent, SUM(depreciation_amount) FROM `tabDepreciation Schedule` WHERE @@ -144,27 +183,41 @@ def get_finance_book_value_map(filters): AND schedule_date<=%s AND journal_entry IS NOT NULL AND ifnull(finance_book, '')=%s - GROUP BY parent''', (date, cstr(filters.finance_book or '')))) + GROUP BY parent""", + (date, cstr(filters.finance_book or "")), + ) + ) + def get_purchase_receipt_supplier_map(): - return frappe._dict(frappe.db.sql(''' Select + return frappe._dict( + frappe.db.sql( + """ Select pr.name, pr.supplier FROM `tabPurchase Receipt` pr, `tabPurchase Receipt Item` pri WHERE pri.parent = pr.name AND pri.is_fixed_asset=1 AND pr.docstatus=1 - AND pr.is_return=0''')) + AND pr.is_return=0""" + ) + ) + def get_purchase_invoice_supplier_map(): - return frappe._dict(frappe.db.sql(''' Select + return frappe._dict( + frappe.db.sql( + """ Select pi.name, pi.supplier FROM `tabPurchase Invoice` pi, `tabPurchase Invoice Item` pii WHERE pii.parent = pi.name AND pii.is_fixed_asset=1 AND pi.docstatus=1 - AND pi.is_return=0''')) + AND pi.is_return=0""" + ) + ) + def get_columns(filters): if filters.get("group_by") in ["Asset Category", "Location"]: @@ -174,36 +227,36 @@ def get_columns(filters): "fieldtype": "Link", "fieldname": frappe.scrub(filters.get("group_by")), "options": filters.get("group_by"), - "width": 120 + "width": 120, }, { "label": _("Gross Purchase Amount"), "fieldname": "gross_purchase_amount", "fieldtype": "Currency", "options": "company:currency", - "width": 100 + "width": 100, }, { "label": _("Opening Accumulated Depreciation"), "fieldname": "opening_accumulated_depreciation", "fieldtype": "Currency", "options": "company:currency", - "width": 90 + "width": 90, }, { "label": _("Depreciated Amount"), "fieldname": "depreciated_amount", "fieldtype": "Currency", "options": "company:currency", - "width": 100 + "width": 100, }, { "label": _("Asset Value"), "fieldname": "asset_value", "fieldtype": "Currency", "options": "company:currency", - "width": 100 - } + "width": 100, + }, ] return [ @@ -212,92 +265,72 @@ def get_columns(filters): "fieldtype": "Link", "fieldname": "asset_id", "options": "Asset", - "width": 60 - }, - { - "label": _("Asset Name"), - "fieldtype": "Data", - "fieldname": "asset_name", - "width": 140 + "width": 60, }, + {"label": _("Asset Name"), "fieldtype": "Data", "fieldname": "asset_name", "width": 140}, { "label": _("Asset Category"), "fieldtype": "Link", "fieldname": "asset_category", "options": "Asset Category", - "width": 100 - }, - { - "label": _("Status"), - "fieldtype": "Data", - "fieldname": "status", - "width": 80 - }, - { - "label": _("Purchase Date"), - "fieldtype": "Date", - "fieldname": "purchase_date", - "width": 90 + "width": 100, }, + {"label": _("Status"), "fieldtype": "Data", "fieldname": "status", "width": 80}, + {"label": _("Purchase Date"), "fieldtype": "Date", "fieldname": "purchase_date", "width": 90}, { "label": _("Available For Use Date"), "fieldtype": "Date", "fieldname": "available_for_use_date", - "width": 90 + "width": 90, }, { "label": _("Gross Purchase Amount"), "fieldname": "gross_purchase_amount", "fieldtype": "Currency", "options": "company:currency", - "width": 100 + "width": 100, }, { "label": _("Asset Value"), "fieldname": "asset_value", "fieldtype": "Currency", "options": "company:currency", - "width": 100 + "width": 100, }, { "label": _("Opening Accumulated Depreciation"), "fieldname": "opening_accumulated_depreciation", "fieldtype": "Currency", "options": "company:currency", - "width": 90 + "width": 90, }, { "label": _("Depreciated Amount"), "fieldname": "depreciated_amount", "fieldtype": "Currency", "options": "company:currency", - "width": 100 + "width": 100, }, { "label": _("Cost Center"), "fieldtype": "Link", "fieldname": "cost_center", "options": "Cost Center", - "width": 100 + "width": 100, }, { "label": _("Department"), "fieldtype": "Link", "fieldname": "department", "options": "Department", - "width": 100 - }, - { - "label": _("Vendor Name"), - "fieldtype": "Data", - "fieldname": "vendor_name", - "width": 100 + "width": 100, }, + {"label": _("Vendor Name"), "fieldtype": "Data", "fieldname": "vendor_name", "width": 100}, { "label": _("Location"), "fieldtype": "Link", "fieldname": "location", "options": "Location", - "width": 100 + "width": 100, }, ] diff --git a/erpnext/buying/doctype/buying_settings/buying_settings.py b/erpnext/buying/doctype/buying_settings/buying_settings.py index 2b6ff43530f..5507254bbc2 100644 --- a/erpnext/buying/doctype/buying_settings/buying_settings.py +++ b/erpnext/buying/doctype/buying_settings/buying_settings.py @@ -14,5 +14,10 @@ class BuyingSettings(Document): frappe.db.set_default(key, self.get(key, "")) from erpnext.setup.doctype.naming_series.naming_series import set_by_naming_series - set_by_naming_series("Supplier", "supplier_name", - self.get("supp_master_name")=="Naming Series", hide_name_field=False) + + set_by_naming_series( + "Supplier", + "supplier_name", + self.get("supp_master_name") == "Naming Series", + hide_name_field=False, + ) diff --git a/erpnext/buying/doctype/purchase_order/purchase_order.js b/erpnext/buying/doctype/purchase_order/purchase_order.js index 6e943c2832d..b6f5ff92191 100644 --- a/erpnext/buying/doctype/purchase_order/purchase_order.js +++ b/erpnext/buying/doctype/purchase_order/purchase_order.js @@ -43,8 +43,6 @@ frappe.ui.form.on("Purchase Order", { erpnext.queries.setup_queries(frm, "Warehouse", function() { return erpnext.queries.warehouse(frm.doc); }); - - erpnext.accounts.dimensions.setup_dimension_filters(frm, frm.doctype); }, apply_tds: function(frm) { @@ -427,7 +425,7 @@ erpnext.buying.PurchaseOrderController = erpnext.buying.BuyingController.extend( company: me.frm.doc.company }, allow_child_item_selection: true, - child_fielname: "items", + child_fieldname: "items", child_columns: ["item_code", "qty"] }) }, __("Get Items From")); diff --git a/erpnext/buying/doctype/purchase_order/purchase_order.json b/erpnext/buying/doctype/purchase_order/purchase_order.json index 896208f25e1..c5bfcd57738 100644 --- a/erpnext/buying/doctype/purchase_order/purchase_order.json +++ b/erpnext/buying/doctype/purchase_order/purchase_order.json @@ -23,6 +23,10 @@ "order_confirmation_no", "order_confirmation_date", "amended_from", + "accounting_dimensions_section", + "cost_center", + "dimension_col_break", + "project", "drop_ship", "customer", "customer_name", @@ -435,7 +439,6 @@ "fieldname": "ignore_pricing_rule", "fieldtype": "Check", "label": "Ignore Pricing Rule", - "no_copy": 1, "permlevel": 1, "print_hide": 1 }, @@ -1138,16 +1141,39 @@ "fieldtype": "Link", "label": "Tax Withholding Category", "options": "Tax Withholding Category" + }, + { + "collapsible": 1, + "fieldname": "accounting_dimensions_section", + "fieldtype": "Section Break", + "label": "Accounting Dimensions " + }, + { + "fieldname": "cost_center", + "fieldtype": "Link", + "label": "Cost Center", + "options": "Cost Center" + }, + { + "fieldname": "dimension_col_break", + "fieldtype": "Column Break" + }, + { + "fieldname": "project", + "fieldtype": "Link", + "label": "Project", + "options": "Project" } ], "icon": "fa fa-file-text", "idx": 105, "is_submittable": 1, "links": [], - "modified": "2021-09-28 13:10:47.955401", + "modified": "2022-09-16 17:45:04.954055", "modified_by": "Administrator", "module": "Buying", "name": "Purchase Order", + "naming_rule": "By \"Naming Series\" field", "owner": "Administrator", "permissions": [ { @@ -1194,6 +1220,7 @@ "show_name_in_global_search": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "timeline_field": "supplier", "title_field": "supplier_name", "track_changes": 1 diff --git a/erpnext/buying/doctype/purchase_order/purchase_order.py b/erpnext/buying/doctype/purchase_order/purchase_order.py index 1b5f35efbb4..250faa7c88b 100644 --- a/erpnext/buying/doctype/purchase_order/purchase_order.py +++ b/erpnext/buying/doctype/purchase_order/purchase_order.py @@ -26,24 +26,25 @@ from erpnext.stock.doctype.item.item import get_item_defaults, get_last_purchase from erpnext.stock.stock_balance import get_ordered_qty, update_bin_qty from erpnext.stock.utils import get_bin -form_grid_templates = { - "items": "templates/form_grid/item_grid.html" -} +form_grid_templates = {"items": "templates/form_grid/item_grid.html"} + class PurchaseOrder(BuyingController): def __init__(self, *args, **kwargs): super(PurchaseOrder, self).__init__(*args, **kwargs) - self.status_updater = [{ - 'source_dt': 'Purchase Order Item', - 'target_dt': 'Material Request Item', - 'join_field': 'material_request_item', - 'target_field': 'ordered_qty', - 'target_parent_dt': 'Material Request', - 'target_parent_field': 'per_ordered', - 'target_ref_field': 'stock_qty', - 'source_field': 'stock_qty', - 'percent_join_field': 'material_request' - }] + self.status_updater = [ + { + "source_dt": "Purchase Order Item", + "target_dt": "Material Request Item", + "join_field": "material_request_item", + "target_field": "ordered_qty", + "target_parent_dt": "Material Request", + "target_parent_field": "per_ordered", + "target_ref_field": "stock_qty", + "source_field": "stock_qty", + "percent_join_field": "material_request", + } + ] def onload(self): supplier_tds = frappe.db.get_value("Supplier", self.supplier, "tax_withholding_category") @@ -71,35 +72,44 @@ class PurchaseOrder(BuyingController): self.validate_bom_for_subcontracting_items() self.create_raw_materials_supplied("supplied_items") self.set_received_qty_for_drop_ship_items() - validate_inter_company_party(self.doctype, self.supplier, self.company, self.inter_company_order_reference) + validate_inter_company_party( + self.doctype, self.supplier, self.company, self.inter_company_order_reference + ) self.reset_default_field_value("set_warehouse", "items", "warehouse") def validate_with_previous_doc(self): - super(PurchaseOrder, self).validate_with_previous_doc({ - "Supplier Quotation": { - "ref_dn_field": "supplier_quotation", - "compare_fields": [["supplier", "="], ["company", "="], ["currency", "="]], - }, - "Supplier Quotation Item": { - "ref_dn_field": "supplier_quotation_item", - "compare_fields": [["project", "="], ["item_code", "="], - ["uom", "="], ["conversion_factor", "="]], - "is_child_table": True - }, - "Material Request": { - "ref_dn_field": "material_request", - "compare_fields": [["company", "="]], - }, - "Material Request Item": { - "ref_dn_field": "material_request_item", - "compare_fields": [["project", "="], ["item_code", "="]], - "is_child_table": True + super(PurchaseOrder, self).validate_with_previous_doc( + { + "Supplier Quotation": { + "ref_dn_field": "supplier_quotation", + "compare_fields": [["supplier", "="], ["company", "="], ["currency", "="]], + }, + "Supplier Quotation Item": { + "ref_dn_field": "supplier_quotation_item", + "compare_fields": [ + ["project", "="], + ["item_code", "="], + ["uom", "="], + ["conversion_factor", "="], + ], + "is_child_table": True, + }, + "Material Request": { + "ref_dn_field": "material_request", + "compare_fields": [["company", "="]], + }, + "Material Request Item": { + "ref_dn_field": "material_request_item", + "compare_fields": [["project", "="], ["item_code", "="]], + "is_child_table": True, + }, } - }) + ) - - if cint(frappe.db.get_single_value('Buying Settings', 'maintain_same_rate')): - self.validate_rate_with_reference_doc([["Supplier Quotation", "supplier_quotation", "supplier_quotation_item"]]) + if cint(frappe.db.get_single_value("Buying Settings", "maintain_same_rate")): + self.validate_rate_with_reference_doc( + [["Supplier Quotation", "supplier_quotation", "supplier_quotation_item"]] + ) def set_tax_withholding(self): if not self.apply_tds: @@ -119,8 +129,11 @@ class PurchaseOrder(BuyingController): if not accounts or tax_withholding_details.get("account_head") not in accounts: self.append("taxes", tax_withholding_details) - to_remove = [d for d in self.taxes - if not d.tax_amount and d.account_head == tax_withholding_details.get("account_head")] + to_remove = [ + d + for d in self.taxes + if not d.tax_amount and d.account_head == tax_withholding_details.get("account_head") + ] for d in to_remove: self.remove(d) @@ -129,26 +142,43 @@ class PurchaseOrder(BuyingController): self.calculate_taxes_and_totals() def validate_supplier(self): - prevent_po = frappe.db.get_value("Supplier", self.supplier, 'prevent_pos') + prevent_po = frappe.db.get_value("Supplier", self.supplier, "prevent_pos") if prevent_po: - standing = frappe.db.get_value("Supplier Scorecard", self.supplier, 'status') + standing = frappe.db.get_value("Supplier Scorecard", self.supplier, "status") if standing: - frappe.throw(_("Purchase Orders are not allowed for {0} due to a scorecard standing of {1}.") - .format(self.supplier, standing)) + frappe.throw( + _("Purchase Orders are not allowed for {0} due to a scorecard standing of {1}.").format( + self.supplier, standing + ) + ) - warn_po = frappe.db.get_value("Supplier", self.supplier, 'warn_pos') + warn_po = frappe.db.get_value("Supplier", self.supplier, "warn_pos") if warn_po: - standing = frappe.db.get_value("Supplier Scorecard",self.supplier, 'status') - frappe.msgprint(_("{0} currently has a {1} Supplier Scorecard standing, and Purchase Orders to this supplier should be issued with caution.").format(self.supplier, standing), title=_("Caution"), indicator='orange') + standing = frappe.db.get_value("Supplier Scorecard", self.supplier, "status") + frappe.msgprint( + _( + "{0} currently has a {1} Supplier Scorecard standing, and Purchase Orders to this supplier should be issued with caution." + ).format(self.supplier, standing), + title=_("Caution"), + indicator="orange", + ) self.party_account_currency = get_party_account_currency("Supplier", self.supplier, self.company) def validate_minimum_order_qty(self): - if not self.get("items"): return + if not self.get("items"): + return items = list(set(d.item_code for d in self.get("items"))) - itemwise_min_order_qty = frappe._dict(frappe.db.sql("""select name, min_order_qty - from tabItem where name in ({0})""".format(", ".join(["%s"] * len(items))), items)) + itemwise_min_order_qty = frappe._dict( + frappe.db.sql( + """select name, min_order_qty + from tabItem where name in ({0})""".format( + ", ".join(["%s"] * len(items)) + ), + items, + ) + ) itemwise_qty = frappe._dict() for d in self.get("items"): @@ -157,36 +187,43 @@ class PurchaseOrder(BuyingController): for item_code, qty in itemwise_qty.items(): if flt(qty) < flt(itemwise_min_order_qty.get(item_code)): - frappe.throw(_("Item {0}: Ordered qty {1} cannot be less than minimum order qty {2} (defined in Item).").format(item_code, - qty, itemwise_min_order_qty.get(item_code))) + frappe.throw( + _( + "Item {0}: Ordered qty {1} cannot be less than minimum order qty {2} (defined in Item)." + ).format(item_code, qty, itemwise_min_order_qty.get(item_code)) + ) def validate_bom_for_subcontracting_items(self): if self.is_subcontracted == "Yes": for item in self.items: if not item.bom: - frappe.throw(_("BOM is not specified for subcontracting item {0} at row {1}") - .format(item.item_code, item.idx)) + frappe.throw( + _("BOM is not specified for subcontracting item {0} at row {1}").format( + item.item_code, item.idx + ) + ) def get_schedule_dates(self): - for d in self.get('items'): + for d in self.get("items"): if d.material_request_item and not d.schedule_date: - d.schedule_date = frappe.db.get_value("Material Request Item", - d.material_request_item, "schedule_date") - + d.schedule_date = frappe.db.get_value( + "Material Request Item", d.material_request_item, "schedule_date" + ) @frappe.whitelist() def get_last_purchase_rate(self): """get last purchase rates for all items""" - conversion_rate = flt(self.get('conversion_rate')) or 1.0 + conversion_rate = flt(self.get("conversion_rate")) or 1.0 for d in self.get("items"): if d.item_code: last_purchase_details = get_last_purchase_details(d.item_code, self.name) if last_purchase_details: - d.base_price_list_rate = (last_purchase_details['base_price_list_rate'] * - (flt(d.conversion_factor) or 1.0)) - d.discount_percentage = last_purchase_details['discount_percentage'] - d.base_rate = last_purchase_details['base_rate'] * (flt(d.conversion_factor) or 1.0) + d.base_price_list_rate = last_purchase_details["base_price_list_rate"] * ( + flt(d.conversion_factor) or 1.0 + ) + d.discount_percentage = last_purchase_details["discount_percentage"] + d.base_rate = last_purchase_details["base_rate"] * (flt(d.conversion_factor) or 1.0) d.price_list_rate = d.base_price_list_rate / conversion_rate d.rate = d.base_rate / conversion_rate d.last_purchase_rate = d.rate @@ -194,16 +231,21 @@ class PurchaseOrder(BuyingController): item_last_purchase_rate = frappe.get_cached_value("Item", d.item_code, "last_purchase_rate") if item_last_purchase_rate: - d.base_price_list_rate = d.base_rate = d.price_list_rate \ - = d.rate = d.last_purchase_rate = item_last_purchase_rate + d.base_price_list_rate = ( + d.base_rate + ) = d.price_list_rate = d.rate = d.last_purchase_rate = item_last_purchase_rate # Check for Closed status def check_on_hold_or_closed_status(self): - check_list =[] - for d in self.get('items'): - if d.meta.get_field('material_request') and d.material_request and d.material_request not in check_list: + check_list = [] + for d in self.get("items"): + if ( + d.meta.get_field("material_request") + and d.material_request + and d.material_request not in check_list + ): check_list.append(d.material_request) - check_on_hold_or_closed_status('Material Request', d.material_request) + check_on_hold_or_closed_status("Material Request", d.material_request) def update_requested_qty(self): material_request_map = {} @@ -216,7 +258,9 @@ class PurchaseOrder(BuyingController): mr_obj = frappe.get_doc("Material Request", mr) if mr_obj.status in ["Stopped", "Cancelled"]: - frappe.throw(_("Material Request {0} is cancelled or stopped").format(mr), frappe.InvalidStatusError) + frappe.throw( + _("Material Request {0} is cancelled or stopped").format(mr), frappe.InvalidStatusError + ) mr_obj.update_requested_qty(mr_item_rows) @@ -224,24 +268,26 @@ class PurchaseOrder(BuyingController): """update requested qty (before ordered_qty is updated)""" item_wh_list = [] for d in self.get("items"): - if (not po_item_rows or d.name in po_item_rows) \ - and [d.item_code, d.warehouse] not in item_wh_list \ - and frappe.get_cached_value("Item", d.item_code, "is_stock_item") \ - and d.warehouse and not d.delivered_by_supplier: - item_wh_list.append([d.item_code, d.warehouse]) + if ( + (not po_item_rows or d.name in po_item_rows) + and [d.item_code, d.warehouse] not in item_wh_list + and frappe.get_cached_value("Item", d.item_code, "is_stock_item") + and d.warehouse + and not d.delivered_by_supplier + ): + item_wh_list.append([d.item_code, d.warehouse]) for item_code, warehouse in item_wh_list: - update_bin_qty(item_code, warehouse, { - "ordered_qty": get_ordered_qty(item_code, warehouse) - }) + update_bin_qty(item_code, warehouse, {"ordered_qty": get_ordered_qty(item_code, warehouse)}) def check_modified_date(self): - mod_db = frappe.db.sql("select modified from `tabPurchase Order` where name = %s", - self.name) + mod_db = frappe.db.sql("select modified from `tabPurchase Order` where name = %s", self.name) date_diff = frappe.db.sql("select '%s' - '%s' " % (mod_db[0][0], cstr(self.modified))) if date_diff and date_diff[0][0]: - msgprint(_("{0} {1} has been modified. Please refresh.").format(self.doctype, self.name), - raise_exception=True) + msgprint( + _("{0} {1} has been modified. Please refresh.").format(self.doctype, self.name), + raise_exception=True, + ) def update_status(self, status): self.check_modified_date() @@ -268,8 +314,9 @@ class PurchaseOrder(BuyingController): if self.is_subcontracted == "Yes": self.update_reserved_qty_for_subcontract() - frappe.get_doc('Authorization Control').validate_approving_authority(self.doctype, - self.company, self.base_grand_total) + frappe.get_doc("Authorization Control").validate_approving_authority( + self.doctype, self.company, self.base_grand_total + ) self.update_blanket_order() @@ -289,7 +336,7 @@ class PurchaseOrder(BuyingController): self.check_on_hold_or_closed_status() - frappe.db.set(self,'status','Cancelled') + frappe.db.set(self, "status", "Cancelled") self.update_prevdoc_status() @@ -306,16 +353,30 @@ class PurchaseOrder(BuyingController): pass def update_status_updater(self): - self.status_updater.append({ - 'source_dt': 'Purchase Order Item', - 'target_dt': 'Sales Order Item', - 'target_field': 'ordered_qty', - 'target_parent_dt': 'Sales Order', - 'target_parent_field': '', - 'join_field': 'sales_order_item', - 'target_ref_field': 'stock_qty', - 'source_field': 'stock_qty' - }) + self.status_updater.append( + { + "source_dt": "Purchase Order Item", + "target_dt": "Sales Order Item", + "target_field": "ordered_qty", + "target_parent_dt": "Sales Order", + "target_parent_field": "", + "join_field": "sales_order_item", + "target_ref_field": "stock_qty", + "source_field": "stock_qty", + } + ) + self.status_updater.append( + { + "source_dt": "Purchase Order Item", + "target_dt": "Packed Item", + "target_field": "ordered_qty", + "target_parent_dt": "Sales Order", + "target_parent_field": "", + "join_field": "sales_order_packed_item", + "target_ref_field": "qty", + "source_field": "stock_qty", + } + ) def update_delivered_qty_in_sales_order(self): """Update delivered qty in Sales Order for drop ship""" @@ -354,24 +415,28 @@ class PurchaseOrder(BuyingController): received_qty += item.received_qty total_qty += item.qty if total_qty: - self.db_set("per_received", flt(received_qty/total_qty) * 100, update_modified=False) + self.db_set("per_received", flt(received_qty / total_qty) * 100, update_modified=False) else: self.db_set("per_received", 0, update_modified=False) -def item_last_purchase_rate(name, conversion_rate, item_code, conversion_factor= 1.0): + +def item_last_purchase_rate(name, conversion_rate, item_code, conversion_factor=1.0): """get last purchase rate for an item""" conversion_rate = flt(conversion_rate) or 1.0 - last_purchase_details = get_last_purchase_details(item_code, name) + last_purchase_details = get_last_purchase_details(item_code, name) if last_purchase_details: - last_purchase_rate = (last_purchase_details['base_net_rate'] * (flt(conversion_factor) or 1.0)) / conversion_rate + last_purchase_rate = ( + last_purchase_details["base_net_rate"] * (flt(conversion_factor) or 1.0) + ) / conversion_rate return last_purchase_rate else: item_last_purchase_rate = frappe.get_cached_value("Item", item_code, "last_purchase_rate") if item_last_purchase_rate: return item_last_purchase_rate + @frappe.whitelist() def close_or_unclose_purchase_orders(names, status): if not frappe.has_permission("Purchase Order", "write"): @@ -382,7 +447,7 @@ def close_or_unclose_purchase_orders(names, status): po = frappe.get_doc("Purchase Order", name) if po.docstatus == 1: if status == "Closed": - if po.status not in ( "Cancelled", "Closed") and (po.per_received < 100 or po.per_billed < 100): + if po.status not in ("Cancelled", "Closed") and (po.per_received < 100 or po.per_billed < 100): po.update_status(status) else: if po.status == "Closed": @@ -391,69 +456,78 @@ def close_or_unclose_purchase_orders(names, status): frappe.local.message_log = [] + def set_missing_values(source, target): - target.ignore_pricing_rule = 1 target.run_method("set_missing_values") target.run_method("calculate_taxes_and_totals") + @frappe.whitelist() def make_purchase_receipt(source_name, target_doc=None): def update_item(obj, target, source_parent): target.qty = flt(obj.qty) - flt(obj.received_qty) target.stock_qty = (flt(obj.qty) - flt(obj.received_qty)) * flt(obj.conversion_factor) target.amount = (flt(obj.qty) - flt(obj.received_qty)) * flt(obj.rate) - target.base_amount = (flt(obj.qty) - flt(obj.received_qty)) * \ - flt(obj.rate) * flt(source_parent.conversion_rate) + target.base_amount = ( + (flt(obj.qty) - flt(obj.received_qty)) * flt(obj.rate) * flt(source_parent.conversion_rate) + ) - doc = get_mapped_doc("Purchase Order", source_name, { - "Purchase Order": { - "doctype": "Purchase Receipt", - "field_map": { - "supplier_warehouse":"supplier_warehouse" + doc = get_mapped_doc( + "Purchase Order", + source_name, + { + "Purchase Order": { + "doctype": "Purchase Receipt", + "field_map": {"supplier_warehouse": "supplier_warehouse"}, + "validation": { + "docstatus": ["=", 1], + }, }, - "validation": { - "docstatus": ["=", 1], - } - }, - "Purchase Order Item": { - "doctype": "Purchase Receipt Item", - "field_map": { - "name": "purchase_order_item", - "parent": "purchase_order", - "bom": "bom", - "material_request": "material_request", - "material_request_item": "material_request_item" + "Purchase Order Item": { + "doctype": "Purchase Receipt Item", + "field_map": { + "name": "purchase_order_item", + "parent": "purchase_order", + "bom": "bom", + "material_request": "material_request", + "material_request_item": "material_request_item", + }, + "postprocess": update_item, + "condition": lambda doc: abs(doc.received_qty) < abs(doc.qty) + and doc.delivered_by_supplier != 1, }, - "postprocess": update_item, - "condition": lambda doc: abs(doc.received_qty) < abs(doc.qty) and doc.delivered_by_supplier!=1 + "Purchase Taxes and Charges": {"doctype": "Purchase Taxes and Charges", "add_if_empty": True}, }, - "Purchase Taxes and Charges": { - "doctype": "Purchase Taxes and Charges", - "add_if_empty": True - } - }, target_doc, set_missing_values) + target_doc, + set_missing_values, + ) + + doc.set_onload("ignore_price_list", True) return doc + @frappe.whitelist() def make_purchase_invoice(source_name, target_doc=None): return get_mapped_purchase_invoice(source_name, target_doc) + @frappe.whitelist() def make_purchase_invoice_from_portal(purchase_order_name): doc = get_mapped_purchase_invoice(purchase_order_name, ignore_permissions=True) if doc.contact_email != frappe.session.user: - frappe.throw(_('Not Permitted'), frappe.PermissionError) + frappe.throw(_("Not Permitted"), frappe.PermissionError) doc.save() frappe.db.commit() - frappe.response['type'] = 'redirect' - frappe.response.location = '/purchase-invoices/' + doc.name + frappe.response["type"] = "redirect" + frappe.response.location = "/purchase-invoices/" + doc.name + def get_mapped_purchase_invoice(source_name, target_doc=None, ignore_permissions=False): def postprocess(source, target): target.flags.ignore_permissions = ignore_permissions set_missing_values(source, target) - #Get the advance paid Journal Entries in Purchase Invoice Advance + # Get the advance paid Journal Entries in Purchase Invoice Advance if target.get("allocate_advances_automatically"): target.set_advances() @@ -462,26 +536,30 @@ def get_mapped_purchase_invoice(source_name, target_doc=None, ignore_permissions def update_item(obj, target, source_parent): target.amount = flt(obj.amount) - flt(obj.billed_amt) target.base_amount = target.amount * flt(source_parent.conversion_rate) - target.qty = target.amount / flt(obj.rate) if (flt(obj.rate) and flt(obj.billed_amt)) else flt(obj.qty) + target.qty = ( + target.amount / flt(obj.rate) if (flt(obj.rate) and flt(obj.billed_amt)) else flt(obj.qty) + ) item = get_item_defaults(target.item_code, source_parent.company) item_group = get_item_group_defaults(target.item_code, source_parent.company) - target.cost_center = (obj.cost_center + target.cost_center = ( + obj.cost_center or frappe.db.get_value("Project", obj.project, "cost_center") or item.get("buying_cost_center") - or item_group.get("buying_cost_center")) + or item_group.get("buying_cost_center") + ) fields = { "Purchase Order": { "doctype": "Purchase Invoice", "field_map": { "party_account_currency": "party_account_currency", - "supplier_warehouse":"supplier_warehouse" + "supplier_warehouse": "supplier_warehouse", }, - "field_no_map" : ["payment_terms_template"], + "field_no_map": ["payment_terms_template"], "validation": { "docstatus": ["=", 1], - } + }, }, "Purchase Order Item": { "doctype": "Purchase Invoice Item", @@ -490,19 +568,24 @@ def get_mapped_purchase_invoice(source_name, target_doc=None, ignore_permissions "parent": "purchase_order", }, "postprocess": update_item, - "condition": lambda doc: (doc.base_amount==0 or abs(doc.billed_amt) < abs(doc.amount)) - }, - "Purchase Taxes and Charges": { - "doctype": "Purchase Taxes and Charges", - "add_if_empty": True + "condition": lambda doc: (doc.base_amount == 0 or abs(doc.billed_amt) < abs(doc.amount)), }, + "Purchase Taxes and Charges": {"doctype": "Purchase Taxes and Charges", "add_if_empty": True}, } - doc = get_mapped_doc("Purchase Order", source_name, fields, - target_doc, postprocess, ignore_permissions=ignore_permissions) + doc = get_mapped_doc( + "Purchase Order", + source_name, + fields, + target_doc, + postprocess, + ignore_permissions=ignore_permissions, + ) + doc.set_onload("ignore_price_list", True) return doc + @frappe.whitelist() def make_rm_stock_entry(purchase_order, rm_items): rm_items_list = rm_items @@ -543,71 +626,90 @@ def make_rm_stock_entry(purchase_order, rm_items): rm_item_code: { "po_detail": rm_item_data.get("name"), "item_name": rm_item_data["item_name"], - "description": item_wh.get(rm_item_code, {}).get('description', ""), - 'qty': rm_item_data["qty"], - 'from_warehouse': rm_item_data["warehouse"], - 'stock_uom': rm_item_data["stock_uom"], - 'serial_no': rm_item_data.get('serial_no'), - 'batch_no': rm_item_data.get('batch_no'), - 'main_item_code': rm_item_data["item_code"], - 'allow_alternative_item': item_wh.get(rm_item_code, {}).get('allow_alternative_item') + "description": item_wh.get(rm_item_code, {}).get("description", ""), + "qty": rm_item_data["qty"], + "from_warehouse": rm_item_data["warehouse"], + "stock_uom": rm_item_data["stock_uom"], + "serial_no": rm_item_data.get("serial_no"), + "batch_no": rm_item_data.get("batch_no"), + "main_item_code": rm_item_data["item_code"], + "allow_alternative_item": item_wh.get(rm_item_code, {}).get("allow_alternative_item"), } } stock_entry.add_to_stock_entry_detail(items_dict) + + stock_entry.set_missing_values() return stock_entry.as_dict() else: frappe.throw(_("No Items selected for transfer")) return purchase_order.name + def get_item_details(items): item_details = {} - for d in frappe.db.sql("""select item_code, description, allow_alternative_item from `tabItem` - where name in ({0})""".format(", ".join(["%s"] * len(items))), items, as_dict=1): + for d in frappe.db.sql( + """select item_code, description, allow_alternative_item from `tabItem` + where name in ({0})""".format( + ", ".join(["%s"] * len(items)) + ), + items, + as_dict=1, + ): item_details[d.item_code] = d return item_details + def get_list_context(context=None): from erpnext.controllers.website_list_for_contact import get_list_context + list_context = get_list_context(context) - list_context.update({ - 'show_sidebar': True, - 'show_search': True, - 'no_breadcrumbs': True, - 'title': _('Purchase Orders'), - }) + list_context.update( + { + "show_sidebar": True, + "show_search": True, + "no_breadcrumbs": True, + "title": _("Purchase Orders"), + } + ) return list_context + @frappe.whitelist() def update_status(status, name): po = frappe.get_doc("Purchase Order", name) po.update_status(status) po.update_delivered_qty_in_sales_order() + @frappe.whitelist() def make_inter_company_sales_order(source_name, target_doc=None): from erpnext.accounts.doctype.sales_invoice.sales_invoice import make_inter_company_transaction + return make_inter_company_transaction("Purchase Order", source_name, target_doc) + @frappe.whitelist() def get_materials_from_supplier(purchase_order, po_details): if isinstance(po_details, str): po_details = json.loads(po_details) - doc = frappe.get_cached_doc('Purchase Order', purchase_order) + doc = frappe.get_cached_doc("Purchase Order", purchase_order) doc.initialized_fields() doc.purchase_orders = [doc.name] doc.get_available_materials() if not doc.available_materials: - frappe.throw(_('Materials are already received against the purchase order {0}') - .format(purchase_order)) + frappe.throw( + _("Materials are already received against the purchase order {0}").format(purchase_order) + ) return make_return_stock_entry_for_subcontract(doc.available_materials, doc, po_details) + def make_return_stock_entry_for_subcontract(available_materials, po_doc, po_details): - ste_doc = frappe.new_doc('Stock Entry') - ste_doc.purpose = 'Material Transfer' + ste_doc = frappe.new_doc("Stock Entry") + ste_doc.purpose = "Material Transfer" ste_doc.purchase_order = po_doc.name ste_doc.company = po_doc.company ste_doc.is_return = 1 @@ -624,22 +726,25 @@ def make_return_stock_entry_for_subcontract(available_materials, po_doc, po_deta add_items_in_ste(ste_doc, value, value.qty, po_details) ste_doc.set_stock_entry_type() - ste_doc.calculate_rate_and_amount() + ste_doc.set_missing_values() return ste_doc + def add_items_in_ste(ste_doc, row, qty, po_details, batch_no=None): - item = ste_doc.append('items', row.item_details) + item = ste_doc.append("items", row.item_details) po_detail = list(set(row.po_details).intersection(po_details)) - item.update({ - 'qty': qty, - 'batch_no': batch_no, - 'basic_rate': row.item_details['rate'], - 'po_detail': po_detail[0] if po_detail else '', - 's_warehouse': row.item_details['t_warehouse'], - 't_warehouse': row.item_details['s_warehouse'], - 'item_code': row.item_details['rm_item_code'], - 'subcontracted_item': row.item_details['main_item_code'], - 'serial_no': '\n'.join(row.serial_no) if row.serial_no else '' - }) + item.update( + { + "qty": qty, + "batch_no": batch_no, + "basic_rate": row.item_details["rate"], + "po_detail": po_detail[0] if po_detail else "", + "s_warehouse": row.item_details["t_warehouse"], + "t_warehouse": row.item_details["s_warehouse"], + "item_code": row.item_details["rm_item_code"], + "subcontracted_item": row.item_details["main_item_code"], + "serial_no": "\n".join(row.serial_no) if row.serial_no else "", + } + ) diff --git a/erpnext/buying/doctype/purchase_order/purchase_order_dashboard.py b/erpnext/buying/doctype/purchase_order/purchase_order_dashboard.py index 8588c002d5e..e656fa1071d 100644 --- a/erpnext/buying/doctype/purchase_order/purchase_order_dashboard.py +++ b/erpnext/buying/doctype/purchase_order/purchase_order_dashboard.py @@ -1,36 +1,26 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'purchase_order', - 'non_standard_fieldnames': { - 'Journal Entry': 'reference_name', - 'Payment Entry': 'reference_name', - 'Auto Repeat': 'reference_document' + "fieldname": "purchase_order", + "non_standard_fieldnames": { + "Journal Entry": "reference_name", + "Payment Entry": "reference_name", + "Auto Repeat": "reference_document", }, - 'internal_links': { - 'Material Request': ['items', 'material_request'], - 'Supplier Quotation': ['items', 'supplier_quotation'], - 'Project': ['items', 'project'], + "internal_links": { + "Material Request": ["items", "material_request"], + "Supplier Quotation": ["items", "supplier_quotation"], + "Project": ["items", "project"], }, - 'transactions': [ + "transactions": [ + {"label": _("Related"), "items": ["Purchase Receipt", "Purchase Invoice"]}, + {"label": _("Payment"), "items": ["Payment Entry", "Journal Entry"]}, { - 'label': _('Related'), - 'items': ['Purchase Receipt', 'Purchase Invoice'] + "label": _("Reference"), + "items": ["Material Request", "Supplier Quotation", "Project", "Auto Repeat"], }, - { - 'label': _('Payment'), - 'items': ['Payment Entry', 'Journal Entry'] - }, - { - 'label': _('Reference'), - 'items': ['Material Request', 'Supplier Quotation', 'Project', 'Auto Repeat'] - }, - { - 'label': _('Sub-contracting'), - 'items': ['Stock Entry'] - }, - ] + {"label": _("Sub-contracting"), "items": ["Stock Entry"]}, + ], } diff --git a/erpnext/buying/doctype/purchase_order/test_purchase_order.py b/erpnext/buying/doctype/purchase_order/test_purchase_order.py index 9a63afc1303..590370e808c 100644 --- a/erpnext/buying/doctype/purchase_order/test_purchase_order.py +++ b/erpnext/buying/doctype/purchase_order/test_purchase_order.py @@ -3,9 +3,9 @@ import json -import unittest import frappe +from frappe.tests.utils import FrappeTestCase from frappe.utils import add_days, flt, getdate, nowdate from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry @@ -27,7 +27,7 @@ from erpnext.stock.doctype.purchase_receipt.purchase_receipt import ( from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry -class TestPurchaseOrder(unittest.TestCase): +class TestPurchaseOrder(FrappeTestCase): def test_make_purchase_receipt(self): po = create_purchase_order(do_not_submit=True) self.assertRaises(frappe.ValidationError, make_purchase_receipt, po.name) @@ -51,7 +51,7 @@ class TestPurchaseOrder(unittest.TestCase): po.load_from_db() self.assertEqual(po.get("items")[0].received_qty, 4) - frappe.db.set_value('Item', '_Test Item', 'over_delivery_receipt_allowance', 50) + frappe.db.set_value("Item", "_Test Item", "over_delivery_receipt_allowance", 50) pr = create_pr_against_po(po.name, received_qty=8) self.assertEqual(get_ordered_qty(), existing_ordered_qty) @@ -71,8 +71,8 @@ class TestPurchaseOrder(unittest.TestCase): self.assertEqual(get_ordered_qty(), existing_ordered_qty + 10) - frappe.db.set_value('Item', '_Test Item', 'over_delivery_receipt_allowance', 50) - frappe.db.set_value('Item', '_Test Item', 'over_billing_allowance', 20) + frappe.db.set_value("Item", "_Test Item", "over_delivery_receipt_allowance", 50) + frappe.db.set_value("Item", "_Test Item", "over_billing_allowance", 20) pi = make_pi_from_po(po.name) pi.update_stock = 1 @@ -91,8 +91,8 @@ class TestPurchaseOrder(unittest.TestCase): po.load_from_db() self.assertEqual(po.get("items")[0].received_qty, 0) - frappe.db.set_value('Item', '_Test Item', 'over_delivery_receipt_allowance', 0) - frappe.db.set_value('Item', '_Test Item', 'over_billing_allowance', 0) + frappe.db.set_value("Item", "_Test Item", "over_delivery_receipt_allowance", 0) + frappe.db.set_value("Item", "_Test Item", "over_billing_allowance", 0) frappe.db.set_value("Accounts Settings", None, "over_billing_allowance", 0) def test_update_remove_child_linked_to_mr(self): @@ -104,41 +104,78 @@ class TestPurchaseOrder(unittest.TestCase): po.submit() first_item_of_po = po.get("items")[0] - existing_ordered_qty = get_ordered_qty() # 10 - existing_requested_qty = get_requested_qty() # 0 + existing_ordered_qty = get_ordered_qty() # 10 + existing_requested_qty = get_requested_qty() # 0 # decrease ordered qty by 3 (10 -> 7) and add item - trans_item = json.dumps([ - { - 'item_code': first_item_of_po.item_code, - 'rate': first_item_of_po.rate, - 'qty': 7, - 'docname': first_item_of_po.name - }, - {'item_code' : '_Test Item 2', 'rate' : 200, 'qty' : 2} - ]) - update_child_qty_rate('Purchase Order', trans_item, po.name) + trans_item = json.dumps( + [ + { + "item_code": first_item_of_po.item_code, + "rate": first_item_of_po.rate, + "qty": 7, + "docname": first_item_of_po.name, + }, + {"item_code": "_Test Item 2", "rate": 200, "qty": 2}, + ] + ) + update_child_qty_rate("Purchase Order", trans_item, po.name) mr.reload() # requested qty increases as ordered qty decreases - self.assertEqual(get_requested_qty(), existing_requested_qty + 3) # 3 + self.assertEqual(get_requested_qty(), existing_requested_qty + 3) # 3 self.assertEqual(mr.items[0].ordered_qty, 7) - self.assertEqual(get_ordered_qty(), existing_ordered_qty - 3) # 7 + self.assertEqual(get_ordered_qty(), existing_ordered_qty - 3) # 7 # delete first item linked to Material Request - trans_item = json.dumps([ - {'item_code' : '_Test Item 2', 'rate' : 200, 'qty' : 2} - ]) - update_child_qty_rate('Purchase Order', trans_item, po.name) + trans_item = json.dumps([{"item_code": "_Test Item 2", "rate": 200, "qty": 2}]) + update_child_qty_rate("Purchase Order", trans_item, po.name) mr.reload() # requested qty increases as ordered qty is 0 (deleted row) - self.assertEqual(get_requested_qty(), existing_requested_qty + 10) # 10 + self.assertEqual(get_requested_qty(), existing_requested_qty + 10) # 10 self.assertEqual(mr.items[0].ordered_qty, 0) # ordered qty decreases as ordered qty is 0 (deleted row) - self.assertEqual(get_ordered_qty(), existing_ordered_qty - 10) # 0 + self.assertEqual(get_ordered_qty(), existing_ordered_qty - 10) # 0 + + def test_supplied_items_validations_on_po_update_after_submit(self): + po = create_purchase_order(item_code="_Test FG Item", is_subcontracted="Yes", qty=5, rate=100) + item = po.items[0] + + original_supplied_items = {po.name: po.required_qty for po in po.supplied_items} + + # Just update rate + trans_item = [ + { + "item_code": "_Test FG Item", + "rate": 20, + "qty": 5, + "conversion_factor": 1.0, + "docname": item.name, + } + ] + update_child_qty_rate("Purchase Order", json.dumps(trans_item), po.name) + po.reload() + + new_supplied_items = {po.name: po.required_qty for po in po.supplied_items} + self.assertEqual(set(original_supplied_items.keys()), set(new_supplied_items.keys())) + + # Update qty to 2x + trans_item[0]["qty"] *= 2 + update_child_qty_rate("Purchase Order", json.dumps(trans_item), po.name) + po.reload() + + new_supplied_items = {po.name: po.required_qty for po in po.supplied_items} + self.assertEqual(2 * sum(original_supplied_items.values()), sum(new_supplied_items.values())) + + # Set transfer qty and attempt to update qty, shouldn't be allowed + po.supplied_items[0].supplied_qty = 2 + po.supplied_items[0].db_update() + trans_item[0]["qty"] *= 2 + with self.assertRaises(frappe.ValidationError): + update_child_qty_rate("Purchase Order", json.dumps(trans_item), po.name) def test_update_child(self): mr = make_material_request(qty=10) @@ -155,8 +192,10 @@ class TestPurchaseOrder(unittest.TestCase): existing_ordered_qty = get_ordered_qty() existing_requested_qty = get_requested_qty() - trans_item = json.dumps([{'item_code' : '_Test Item', 'rate' : 200, 'qty' : 7, 'docname': po.items[0].name}]) - update_child_qty_rate('Purchase Order', trans_item, po.name) + trans_item = json.dumps( + [{"item_code": "_Test Item", "rate": 200, "qty": 7, "docname": po.items[0].name}] + ) + update_child_qty_rate("Purchase Order", trans_item, po.name) mr.reload() self.assertEqual(mr.items[0].ordered_qty, 7) @@ -180,20 +219,22 @@ class TestPurchaseOrder(unittest.TestCase): existing_ordered_qty = get_ordered_qty() first_item_of_po = po.get("items")[0] - trans_item = json.dumps([ - { - 'item_code': first_item_of_po.item_code, - 'rate': first_item_of_po.rate, - 'qty': first_item_of_po.qty, - 'docname': first_item_of_po.name - }, - {'item_code' : '_Test Item', 'rate' : 200, 'qty' : 7} - ]) - update_child_qty_rate('Purchase Order', trans_item, po.name) + trans_item = json.dumps( + [ + { + "item_code": first_item_of_po.item_code, + "rate": first_item_of_po.rate, + "qty": first_item_of_po.qty, + "docname": first_item_of_po.name, + }, + {"item_code": "_Test Item", "rate": 200, "qty": 7}, + ] + ) + update_child_qty_rate("Purchase Order", trans_item, po.name) po.reload() - self.assertEqual(len(po.get('items')), 2) - self.assertEqual(po.status, 'To Receive and Bill') + self.assertEqual(len(po.get("items")), 2) + self.assertEqual(po.status, "To Receive and Bill") # ordered qty should increase on row addition self.assertEqual(get_ordered_qty(), existing_ordered_qty + 7) @@ -208,15 +249,18 @@ class TestPurchaseOrder(unittest.TestCase): first_item_of_po = po.get("items")[0] existing_ordered_qty = get_ordered_qty() # add an item - trans_item = json.dumps([ - { - 'item_code': first_item_of_po.item_code, - 'rate': first_item_of_po.rate, - 'qty': first_item_of_po.qty, - 'docname': first_item_of_po.name - }, - {'item_code' : '_Test Item', 'rate' : 200, 'qty' : 7}]) - update_child_qty_rate('Purchase Order', trans_item, po.name) + trans_item = json.dumps( + [ + { + "item_code": first_item_of_po.item_code, + "rate": first_item_of_po.rate, + "qty": first_item_of_po.qty, + "docname": first_item_of_po.name, + }, + {"item_code": "_Test Item", "rate": 200, "qty": 7}, + ] + ) + update_child_qty_rate("Purchase Order", trans_item, po.name) po.reload() @@ -224,115 +268,145 @@ class TestPurchaseOrder(unittest.TestCase): self.assertEqual(get_ordered_qty(), existing_ordered_qty + 7) # check if can remove received item - trans_item = json.dumps([{'item_code' : '_Test Item', 'rate' : 200, 'qty' : 7, 'docname': po.get("items")[1].name}]) - self.assertRaises(frappe.ValidationError, update_child_qty_rate, 'Purchase Order', trans_item, po.name) + trans_item = json.dumps( + [{"item_code": "_Test Item", "rate": 200, "qty": 7, "docname": po.get("items")[1].name}] + ) + self.assertRaises( + frappe.ValidationError, update_child_qty_rate, "Purchase Order", trans_item, po.name + ) first_item_of_po = po.get("items")[0] - trans_item = json.dumps([ - { - 'item_code': first_item_of_po.item_code, - 'rate': first_item_of_po.rate, - 'qty': first_item_of_po.qty, - 'docname': first_item_of_po.name - } - ]) - update_child_qty_rate('Purchase Order', trans_item, po.name) + trans_item = json.dumps( + [ + { + "item_code": first_item_of_po.item_code, + "rate": first_item_of_po.rate, + "qty": first_item_of_po.qty, + "docname": first_item_of_po.name, + } + ] + ) + update_child_qty_rate("Purchase Order", trans_item, po.name) po.reload() - self.assertEqual(len(po.get('items')), 1) - self.assertEqual(po.status, 'To Receive and Bill') + self.assertEqual(len(po.get("items")), 1) + self.assertEqual(po.status, "To Receive and Bill") # ordered qty should decrease (back to initial) on row deletion self.assertEqual(get_ordered_qty(), existing_ordered_qty) def test_update_child_perm(self): - po = create_purchase_order(item_code= "_Test Item", qty=4) + po = create_purchase_order(item_code="_Test Item", qty=4) - user = 'test@example.com' - test_user = frappe.get_doc('User', user) + user = "test@example.com" + test_user = frappe.get_doc("User", user) test_user.add_roles("Accounts User") frappe.set_user(user) # update qty - trans_item = json.dumps([{'item_code' : '_Test Item', 'rate' : 200, 'qty' : 7, 'docname': po.items[0].name}]) - self.assertRaises(frappe.ValidationError, update_child_qty_rate,'Purchase Order', trans_item, po.name) + trans_item = json.dumps( + [{"item_code": "_Test Item", "rate": 200, "qty": 7, "docname": po.items[0].name}] + ) + self.assertRaises( + frappe.ValidationError, update_child_qty_rate, "Purchase Order", trans_item, po.name + ) # add new item - trans_item = json.dumps([{'item_code' : '_Test Item', 'rate' : 100, 'qty' : 2}]) - self.assertRaises(frappe.ValidationError, update_child_qty_rate,'Purchase Order', trans_item, po.name) + trans_item = json.dumps([{"item_code": "_Test Item", "rate": 100, "qty": 2}]) + self.assertRaises( + frappe.ValidationError, update_child_qty_rate, "Purchase Order", trans_item, po.name + ) frappe.set_user("Administrator") def test_update_child_with_tax_template(self): """ - Test Action: Create a PO with one item having its tax account head already in the PO. - Add the same item + new item with tax template via Update Items. - Expected result: First Item's tax row is updated. New tax row is added for second Item. + Test Action: Create a PO with one item having its tax account head already in the PO. + Add the same item + new item with tax template via Update Items. + Expected result: First Item's tax row is updated. New tax row is added for second Item. """ if not frappe.db.exists("Item", "Test Item with Tax"): - make_item("Test Item with Tax", { - 'is_stock_item': 1, - }) + make_item( + "Test Item with Tax", + { + "is_stock_item": 1, + }, + ) - if not frappe.db.exists("Item Tax Template", {"title": 'Test Update Items Template'}): - frappe.get_doc({ - 'doctype': 'Item Tax Template', - 'title': 'Test Update Items Template', - 'company': '_Test Company', - 'taxes': [ - { - 'tax_type': "_Test Account Service Tax - _TC", - 'tax_rate': 10, - } - ] - }).insert() + if not frappe.db.exists("Item Tax Template", {"title": "Test Update Items Template"}): + frappe.get_doc( + { + "doctype": "Item Tax Template", + "title": "Test Update Items Template", + "company": "_Test Company", + "taxes": [ + { + "tax_type": "_Test Account Service Tax - _TC", + "tax_rate": 10, + } + ], + } + ).insert() new_item_with_tax = frappe.get_doc("Item", "Test Item with Tax") - if not frappe.db.exists("Item Tax", - {"item_tax_template": "Test Update Items Template - _TC", "parent": "Test Item with Tax"}): - new_item_with_tax.append("taxes", { - "item_tax_template": "Test Update Items Template - _TC", - "valid_from": nowdate() - }) + if not frappe.db.exists( + "Item Tax", + {"item_tax_template": "Test Update Items Template - _TC", "parent": "Test Item with Tax"}, + ): + new_item_with_tax.append( + "taxes", {"item_tax_template": "Test Update Items Template - _TC", "valid_from": nowdate()} + ) new_item_with_tax.save() tax_template = "_Test Account Excise Duty @ 10 - _TC" - item = "_Test Item Home Desktop 100" - if not frappe.db.exists("Item Tax", {"parent":item, "item_tax_template":tax_template}): + item = "_Test Item Home Desktop 100" + if not frappe.db.exists("Item Tax", {"parent": item, "item_tax_template": tax_template}): item_doc = frappe.get_doc("Item", item) - item_doc.append("taxes", { - "item_tax_template": tax_template, - "valid_from": nowdate() - }) + item_doc.append("taxes", {"item_tax_template": tax_template, "valid_from": nowdate()}) item_doc.save() else: # update valid from - frappe.db.sql("""UPDATE `tabItem Tax` set valid_from = CURDATE() + frappe.db.sql( + """UPDATE `tabItem Tax` set valid_from = CURDATE() where parent = %(item)s and item_tax_template = %(tax)s""", - {"item": item, "tax": tax_template}) + {"item": item, "tax": tax_template}, + ) po = create_purchase_order(item_code=item, qty=1, do_not_save=1) - po.append("taxes", { - "account_head": "_Test Account Excise Duty - _TC", - "charge_type": "On Net Total", - "cost_center": "_Test Cost Center - _TC", - "description": "Excise Duty", - "doctype": "Purchase Taxes and Charges", - "rate": 10 - }) + po.append( + "taxes", + { + "account_head": "_Test Account Excise Duty - _TC", + "charge_type": "On Net Total", + "cost_center": "_Test Cost Center - _TC", + "description": "Excise Duty", + "doctype": "Purchase Taxes and Charges", + "rate": 10, + }, + ) po.insert() po.submit() self.assertEqual(po.taxes[0].tax_amount, 50) self.assertEqual(po.taxes[0].total, 550) - items = json.dumps([ - {'item_code' : item, 'rate' : 500, 'qty' : 1, 'docname': po.items[0].name}, - {'item_code' : item, 'rate' : 100, 'qty' : 1}, # added item whose tax account head already exists in PO - {'item_code' : new_item_with_tax.name, 'rate' : 100, 'qty' : 1} # added item whose tax account head is missing in PO - ]) - update_child_qty_rate('Purchase Order', items, po.name) + items = json.dumps( + [ + {"item_code": item, "rate": 500, "qty": 1, "docname": po.items[0].name}, + { + "item_code": item, + "rate": 100, + "qty": 1, + }, # added item whose tax account head already exists in PO + { + "item_code": new_item_with_tax.name, + "rate": 100, + "qty": 1, + }, # added item whose tax account head is missing in PO + ] + ) + update_child_qty_rate("Purchase Order", items, po.name) po.reload() self.assertEqual(po.taxes[0].tax_amount, 70) @@ -342,8 +416,11 @@ class TestPurchaseOrder(unittest.TestCase): self.assertEqual(po.taxes[1].total, 840) # teardown - frappe.db.sql("""UPDATE `tabItem Tax` set valid_from = NULL - where parent = %(item)s and item_tax_template = %(tax)s""", {"item": item, "tax": tax_template}) + frappe.db.sql( + """UPDATE `tabItem Tax` set valid_from = NULL + where parent = %(item)s and item_tax_template = %(tax)s""", + {"item": item, "tax": tax_template}, + ) po.cancel() po.delete() new_item_with_tax.delete() @@ -353,18 +430,24 @@ class TestPurchaseOrder(unittest.TestCase): po = create_purchase_order(item_code="_Test FG Item", is_subcontracted="Yes") total_reqd_qty = sum([d.get("required_qty") for d in po.as_dict().get("supplied_items")]) - trans_item = json.dumps([{ - 'item_code': po.get("items")[0].item_code, - 'rate': po.get("items")[0].rate, - 'qty': po.get("items")[0].qty, - 'uom': "_Test UOM 1", - 'conversion_factor': 2, - 'docname': po.get("items")[0].name - }]) - update_child_qty_rate('Purchase Order', trans_item, po.name) + trans_item = json.dumps( + [ + { + "item_code": po.get("items")[0].item_code, + "rate": po.get("items")[0].rate, + "qty": po.get("items")[0].qty, + "uom": "_Test UOM 1", + "conversion_factor": 2, + "docname": po.get("items")[0].name, + } + ] + ) + update_child_qty_rate("Purchase Order", trans_item, po.name) po.reload() - total_reqd_qty_after_change = sum(d.get("required_qty") for d in po.as_dict().get("supplied_items")) + total_reqd_qty_after_change = sum( + d.get("required_qty") for d in po.as_dict().get("supplied_items") + ) self.assertEqual(total_reqd_qty_after_change, 2 * total_reqd_qty) @@ -401,8 +484,6 @@ class TestPurchaseOrder(unittest.TestCase): po.load_from_db() self.assertEqual(po.get("items")[0].received_qty, 6) - - def test_return_against_purchase_order(self): po = create_purchase_order() @@ -428,17 +509,20 @@ class TestPurchaseOrder(unittest.TestCase): make_purchase_receipt as make_purchase_receipt_return, ) - pr1 = make_purchase_receipt_return(is_return=1, return_against=pr.name, qty=-3, do_not_submit=True) + pr1 = make_purchase_receipt_return( + is_return=1, return_against=pr.name, qty=-3, do_not_submit=True + ) pr1.items[0].purchase_order = po.name pr1.items[0].purchase_order_item = po.items[0].name pr1.submit() - pi1= make_purchase_invoice_return(is_return=1, return_against=pi2.name, qty=-1, update_stock=1, do_not_submit=True) + pi1 = make_purchase_invoice_return( + is_return=1, return_against=pi2.name, qty=-1, update_stock=1, do_not_submit=True + ) pi1.items[0].purchase_order = po.name pi1.items[0].po_detail = po.items[0].name pi1.submit() - po.load_from_db() self.assertEqual(po.get("items")[0].received_qty, 5) @@ -484,13 +568,12 @@ class TestPurchaseOrder(unittest.TestCase): def test_purchase_order_on_hold(self): po = create_purchase_order(item_code="_Test Product Bundle Item") - po.db_set('Status', "On Hold") + po.db_set("Status", "On Hold") pi = make_pi_from_po(po.name) pr = make_purchase_receipt(po.name) self.assertRaises(frappe.ValidationError, pr.submit) self.assertRaises(frappe.ValidationError, pi.submit) - def test_make_purchase_invoice_with_terms(self): from erpnext.selling.doctype.sales_order.test_sales_order import ( automatically_fetch_payment_terms, @@ -501,9 +584,7 @@ class TestPurchaseOrder(unittest.TestCase): self.assertRaises(frappe.ValidationError, make_pi_from_po, po.name) - po.update( - {"payment_terms_template": "_Test Payment Term Template"} - ) + po.update({"payment_terms_template": "_Test Payment Term Template"}) po.save() po.submit() @@ -511,7 +592,9 @@ class TestPurchaseOrder(unittest.TestCase): self.assertEqual(po.payment_schedule[0].payment_amount, 2500.0) self.assertEqual(getdate(po.payment_schedule[0].due_date), getdate(po.transaction_date)) self.assertEqual(po.payment_schedule[1].payment_amount, 2500.0) - self.assertEqual(getdate(po.payment_schedule[1].due_date), add_days(getdate(po.transaction_date), 30)) + self.assertEqual( + getdate(po.payment_schedule[1].due_date), add_days(getdate(po.transaction_date), 30) + ) pi = make_pi_from_po(po.name) pi.save() @@ -521,7 +604,9 @@ class TestPurchaseOrder(unittest.TestCase): self.assertEqual(pi.payment_schedule[0].payment_amount, 2500.0) self.assertEqual(getdate(pi.payment_schedule[0].due_date), getdate(po.transaction_date)) self.assertEqual(pi.payment_schedule[1].payment_amount, 2500.0) - self.assertEqual(getdate(pi.payment_schedule[1].due_date), add_days(getdate(po.transaction_date), 30)) + self.assertEqual( + getdate(pi.payment_schedule[1].due_date), add_days(getdate(po.transaction_date), 30) + ) automatically_fetch_payment_terms(enable=0) def test_subcontracting(self): @@ -530,66 +615,78 @@ class TestPurchaseOrder(unittest.TestCase): def test_warehouse_company_validation(self): from erpnext.stock.utils import InvalidWarehouseCompany + po = create_purchase_order(company="_Test Company 1", do_not_save=True) self.assertRaises(InvalidWarehouseCompany, po.insert) def test_uom_integer_validation(self): from erpnext.utilities.transaction_base import UOMMustBeIntegerError + po = create_purchase_order(qty=3.4, do_not_save=True) self.assertRaises(UOMMustBeIntegerError, po.insert) def test_ordered_qty_for_closing_po(self): - bin = frappe.get_all("Bin", filters={"item_code": "_Test Item", "warehouse": "_Test Warehouse - _TC"}, - fields=["ordered_qty"]) + bin = frappe.get_all( + "Bin", + filters={"item_code": "_Test Item", "warehouse": "_Test Warehouse - _TC"}, + fields=["ordered_qty"], + ) existing_ordered_qty = bin[0].ordered_qty if bin else 0.0 - po = create_purchase_order(item_code= "_Test Item", qty=1) + po = create_purchase_order(item_code="_Test Item", qty=1) - self.assertEqual(get_ordered_qty(item_code= "_Test Item", warehouse="_Test Warehouse - _TC"), existing_ordered_qty+1) + self.assertEqual( + get_ordered_qty(item_code="_Test Item", warehouse="_Test Warehouse - _TC"), + existing_ordered_qty + 1, + ) po.update_status("Closed") - self.assertEqual(get_ordered_qty(item_code="_Test Item", warehouse="_Test Warehouse - _TC"), existing_ordered_qty) + self.assertEqual( + get_ordered_qty(item_code="_Test Item", warehouse="_Test Warehouse - _TC"), existing_ordered_qty + ) def test_group_same_items(self): frappe.db.set_value("Buying Settings", None, "allow_multiple_items", 1) - frappe.get_doc({ - "doctype": "Purchase Order", - "company": "_Test Company", - "supplier" : "_Test Supplier", - "is_subcontracted" : "No", - "schedule_date": add_days(nowdate(), 1), - "currency" : frappe.get_cached_value('Company', "_Test Company", "default_currency"), - "conversion_factor" : 1, - "items" : get_same_items(), - "group_same_items": 1 - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Purchase Order", + "company": "_Test Company", + "supplier": "_Test Supplier", + "is_subcontracted": "No", + "schedule_date": add_days(nowdate(), 1), + "currency": frappe.get_cached_value("Company", "_Test Company", "default_currency"), + "conversion_factor": 1, + "items": get_same_items(), + "group_same_items": 1, + } + ).insert(ignore_permissions=True) def test_make_po_without_terms(self): po = create_purchase_order(do_not_save=1) - self.assertFalse(po.get('payment_schedule')) + self.assertFalse(po.get("payment_schedule")) po.insert() - self.assertTrue(po.get('payment_schedule')) + self.assertTrue(po.get("payment_schedule")) def test_po_for_blocked_supplier_all(self): - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 supplier.save() - self.assertEqual(supplier.hold_type, 'All') + self.assertEqual(supplier.hold_type, "All") self.assertRaises(frappe.ValidationError, create_purchase_order) supplier.on_hold = 0 supplier.save() def test_po_for_blocked_supplier_invoices(self): - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 - supplier.hold_type = 'Invoices' + supplier.hold_type = "Invoices" supplier.save() self.assertRaises(frappe.ValidationError, create_purchase_order) @@ -598,30 +695,40 @@ class TestPurchaseOrder(unittest.TestCase): supplier.save() def test_po_for_blocked_supplier_payments(self): - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 - supplier.hold_type = 'Payments' + supplier.hold_type = "Payments" supplier.save() po = create_purchase_order() self.assertRaises( - frappe.ValidationError, get_payment_entry, dt='Purchase Order', dn=po.name, bank_account="_Test Bank - _TC") + frappe.ValidationError, + get_payment_entry, + dt="Purchase Order", + dn=po.name, + bank_account="_Test Bank - _TC", + ) supplier.on_hold = 0 supplier.save() def test_po_for_blocked_supplier_payments_with_today_date(self): - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 supplier.release_date = nowdate() - supplier.hold_type = 'Payments' + supplier.hold_type = "Payments" supplier.save() po = create_purchase_order() self.assertRaises( - frappe.ValidationError, get_payment_entry, dt='Purchase Order', dn=po.name, bank_account="_Test Bank - _TC") + frappe.ValidationError, + get_payment_entry, + dt="Purchase Order", + dn=po.name, + bank_account="_Test Bank - _TC", + ) supplier.on_hold = 0 supplier.save() @@ -630,14 +737,14 @@ class TestPurchaseOrder(unittest.TestCase): # this test is meant to fail only if something fails in the try block with self.assertRaises(Exception): try: - supplier = frappe.get_doc('Supplier', '_Test Supplier') + supplier = frappe.get_doc("Supplier", "_Test Supplier") supplier.on_hold = 1 - supplier.hold_type = 'Payments' - supplier.release_date = '2018-03-01' + supplier.hold_type = "Payments" + supplier.release_date = "2018-03-01" supplier.save() po = create_purchase_order() - get_payment_entry('Purchase Order', po.name, bank_account='_Test Bank - _TC') + get_payment_entry("Purchase Order", po.name, bank_account="_Test Bank - _TC") supplier.on_hold = 0 supplier.save() @@ -648,87 +755,124 @@ class TestPurchaseOrder(unittest.TestCase): def test_terms_are_not_copied_if_automatically_fetch_payment_terms_is_unchecked(self): po = create_purchase_order(do_not_save=1) - po.payment_terms_template = '_Test Payment Term Template' + po.payment_terms_template = "_Test Payment Term Template" po.save() po.submit() - frappe.db.set_value('Company', '_Test Company', 'payment_terms', '_Test Payment Term Template 1') + frappe.db.set_value("Company", "_Test Company", "payment_terms", "_Test Payment Term Template 1") pi = make_pi_from_po(po.name) pi.save() - self.assertEqual(pi.get('payment_terms_template'), '_Test Payment Term Template 1') - frappe.db.set_value('Company', '_Test Company', 'payment_terms', '') + self.assertEqual(pi.get("payment_terms_template"), "_Test Payment Term Template 1") + frappe.db.set_value("Company", "_Test Company", "payment_terms", "") def test_terms_copied(self): po = create_purchase_order(do_not_save=1) - po.payment_terms_template = '_Test Payment Term Template' + po.payment_terms_template = "_Test Payment Term Template" po.insert() po.submit() - self.assertTrue(po.get('payment_schedule')) + self.assertTrue(po.get("payment_schedule")) pi = make_pi_from_po(po.name) pi.insert() - self.assertTrue(pi.get('payment_schedule')) + self.assertTrue(pi.get("payment_schedule")) def test_reserved_qty_subcontract_po(self): # Make stock available for raw materials make_stock_entry(target="_Test Warehouse - _TC", qty=10, basic_rate=100) - make_stock_entry(target="_Test Warehouse - _TC", item_code="_Test Item Home Desktop 100", - qty=20, basic_rate=100) - make_stock_entry(target="_Test Warehouse 1 - _TC", item_code="_Test Item", - qty=30, basic_rate=100) - make_stock_entry(target="_Test Warehouse 1 - _TC", item_code="_Test Item Home Desktop 100", - qty=30, basic_rate=100) + make_stock_entry( + target="_Test Warehouse - _TC", item_code="_Test Item Home Desktop 100", qty=20, basic_rate=100 + ) + make_stock_entry( + target="_Test Warehouse 1 - _TC", item_code="_Test Item", qty=30, basic_rate=100 + ) + make_stock_entry( + target="_Test Warehouse 1 - _TC", + item_code="_Test Item Home Desktop 100", + qty=30, + basic_rate=100, + ) - bin1 = frappe.db.get_value("Bin", + bin1 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname=["reserved_qty_for_sub_contract", "projected_qty"], as_dict=1) + fieldname=["reserved_qty_for_sub_contract", "projected_qty", "modified"], + as_dict=1, + ) # Submit PO po = create_purchase_order(item_code="_Test FG Item", is_subcontracted="Yes") - bin2 = frappe.db.get_value("Bin", + bin2 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname=["reserved_qty_for_sub_contract", "projected_qty"], as_dict=1) + fieldname=["reserved_qty_for_sub_contract", "projected_qty", "modified"], + as_dict=1, + ) self.assertEqual(bin2.reserved_qty_for_sub_contract, bin1.reserved_qty_for_sub_contract + 10) self.assertEqual(bin2.projected_qty, bin1.projected_qty - 10) + self.assertNotEqual(bin1.modified, bin2.modified) # Create stock transfer - rm_item = [{"item_code":"_Test FG Item","rm_item_code":"_Test Item","item_name":"_Test Item", - "qty":6,"warehouse":"_Test Warehouse - _TC","rate":100,"amount":600,"stock_uom":"Nos"}] + rm_item = [ + { + "item_code": "_Test FG Item", + "rm_item_code": "_Test Item", + "item_name": "_Test Item", + "qty": 6, + "warehouse": "_Test Warehouse - _TC", + "rate": 100, + "amount": 600, + "stock_uom": "Nos", + } + ] rm_item_string = json.dumps(rm_item) se = frappe.get_doc(make_subcontract_transfer_entry(po.name, rm_item_string)) se.to_warehouse = "_Test Warehouse 1 - _TC" se.save() se.submit() - bin3 = frappe.db.get_value("Bin", + bin3 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin3.reserved_qty_for_sub_contract, bin2.reserved_qty_for_sub_contract - 6) # close PO po.update_status("Closed") - bin4 = frappe.db.get_value("Bin", + bin4 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin4.reserved_qty_for_sub_contract, bin1.reserved_qty_for_sub_contract) # Re-open PO po.update_status("Submitted") - bin5 = frappe.db.get_value("Bin", + bin5 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin5.reserved_qty_for_sub_contract, bin2.reserved_qty_for_sub_contract - 6) - make_stock_entry(target="_Test Warehouse 1 - _TC", item_code="_Test Item", - qty=40, basic_rate=100) - make_stock_entry(target="_Test Warehouse 1 - _TC", item_code="_Test Item Home Desktop 100", - qty=40, basic_rate=100) + make_stock_entry( + target="_Test Warehouse 1 - _TC", item_code="_Test Item", qty=40, basic_rate=100 + ) + make_stock_entry( + target="_Test Warehouse 1 - _TC", + item_code="_Test Item Home Desktop 100", + qty=40, + basic_rate=100, + ) # make Purchase Receipt against PO pr = make_purchase_receipt(po.name) @@ -736,17 +880,23 @@ class TestPurchaseOrder(unittest.TestCase): pr.save() pr.submit() - bin6 = frappe.db.get_value("Bin", + bin6 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin6.reserved_qty_for_sub_contract, bin1.reserved_qty_for_sub_contract) # Cancel PR pr.cancel() - bin7 = frappe.db.get_value("Bin", + bin7 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin7.reserved_qty_for_sub_contract, bin2.reserved_qty_for_sub_contract - 6) @@ -756,34 +906,46 @@ class TestPurchaseOrder(unittest.TestCase): pi.supplier_warehouse = "_Test Warehouse 1 - _TC" pi.insert() pi.submit() - bin8 = frappe.db.get_value("Bin", + bin8 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin8.reserved_qty_for_sub_contract, bin1.reserved_qty_for_sub_contract) # Cancel PR pi.cancel() - bin9 = frappe.db.get_value("Bin", + bin9 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin9.reserved_qty_for_sub_contract, bin2.reserved_qty_for_sub_contract - 6) # Cancel Stock Entry se.cancel() - bin10 = frappe.db.get_value("Bin", + bin10 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin10.reserved_qty_for_sub_contract, bin1.reserved_qty_for_sub_contract + 10) # Cancel PO po.reload() po.cancel() - bin11 = frappe.db.get_value("Bin", + bin11 = frappe.db.get_value( + "Bin", filters={"warehouse": "_Test Warehouse - _TC", "item_code": "_Test Item"}, - fieldname="reserved_qty_for_sub_contract", as_dict=1) + fieldname="reserved_qty_for_sub_contract", + as_dict=1, + ) self.assertEqual(bin11.reserved_qty_for_sub_contract, bin1.reserved_qty_for_sub_contract) @@ -791,56 +953,101 @@ class TestPurchaseOrder(unittest.TestCase): item_code = "_Test Subcontracted FG Item 11" make_subcontracted_item(item_code=item_code) - po = create_purchase_order(item_code=item_code, qty=1, - is_subcontracted="Yes", supplier_warehouse="_Test Warehouse 1 - _TC", include_exploded_items=1) + po = create_purchase_order( + item_code=item_code, + qty=1, + is_subcontracted="Yes", + supplier_warehouse="_Test Warehouse 1 - _TC", + include_exploded_items=1, + ) - name = frappe.db.get_value('BOM', {'item': item_code}, 'name') - bom = frappe.get_doc('BOM', name) + name = frappe.db.get_value("BOM", {"item": item_code}, "name") + bom = frappe.get_doc("BOM", name) - exploded_items = sorted([d.item_code for d in bom.exploded_items if not d.get('sourced_by_supplier')]) + exploded_items = sorted( + [d.item_code for d in bom.exploded_items if not d.get("sourced_by_supplier")] + ) supplied_items = sorted([d.rm_item_code for d in po.supplied_items]) self.assertEqual(exploded_items, supplied_items) - po1 = create_purchase_order(item_code=item_code, qty=1, - is_subcontracted="Yes", supplier_warehouse="_Test Warehouse 1 - _TC", include_exploded_items=0) + po1 = create_purchase_order( + item_code=item_code, + qty=1, + is_subcontracted="Yes", + supplier_warehouse="_Test Warehouse 1 - _TC", + include_exploded_items=0, + ) supplied_items1 = sorted([d.rm_item_code for d in po1.supplied_items]) - bom_items = sorted([d.item_code for d in bom.items if not d.get('sourced_by_supplier')]) + bom_items = sorted([d.item_code for d in bom.items if not d.get("sourced_by_supplier")]) self.assertEqual(supplied_items1, bom_items) def test_backflush_based_on_stock_entry(self): item_code = "_Test Subcontracted FG Item 1" make_subcontracted_item(item_code=item_code) - make_item('Sub Contracted Raw Material 1', { - 'is_stock_item': 1, - 'is_sub_contracted_item': 1 - }) + make_item("Sub Contracted Raw Material 1", {"is_stock_item": 1, "is_sub_contracted_item": 1}) update_backflush_based_on("Material Transferred for Subcontract") order_qty = 5 - po = create_purchase_order(item_code=item_code, qty=order_qty, - is_subcontracted="Yes", supplier_warehouse="_Test Warehouse 1 - _TC") + po = create_purchase_order( + item_code=item_code, + qty=order_qty, + is_subcontracted="Yes", + supplier_warehouse="_Test Warehouse 1 - _TC", + ) - make_stock_entry(target="_Test Warehouse - _TC", - item_code="_Test Item Home Desktop 100", qty=20, basic_rate=100) - make_stock_entry(target="_Test Warehouse - _TC", - item_code = "Test Extra Item 1", qty=100, basic_rate=100) - make_stock_entry(target="_Test Warehouse - _TC", - item_code = "Test Extra Item 2", qty=10, basic_rate=100) - make_stock_entry(target="_Test Warehouse - _TC", - item_code = "Sub Contracted Raw Material 1", qty=10, basic_rate=100) + make_stock_entry( + target="_Test Warehouse - _TC", item_code="_Test Item Home Desktop 100", qty=20, basic_rate=100 + ) + make_stock_entry( + target="_Test Warehouse - _TC", item_code="Test Extra Item 1", qty=100, basic_rate=100 + ) + make_stock_entry( + target="_Test Warehouse - _TC", item_code="Test Extra Item 2", qty=10, basic_rate=100 + ) + make_stock_entry( + target="_Test Warehouse - _TC", + item_code="Sub Contracted Raw Material 1", + qty=10, + basic_rate=100, + ) rm_items = [ - {"item_code":item_code,"rm_item_code":"Sub Contracted Raw Material 1","item_name":"_Test Item", - "qty":10,"warehouse":"_Test Warehouse - _TC", "stock_uom":"Nos"}, - {"item_code":item_code,"rm_item_code":"_Test Item Home Desktop 100","item_name":"_Test Item Home Desktop 100", - "qty":20,"warehouse":"_Test Warehouse - _TC", "stock_uom":"Nos"}, - {"item_code":item_code,"rm_item_code":"Test Extra Item 1","item_name":"Test Extra Item 1", - "qty":10,"warehouse":"_Test Warehouse - _TC", "stock_uom":"Nos"}, - {'item_code': item_code, 'rm_item_code': 'Test Extra Item 2', 'stock_uom':'Nos', - 'qty': 10, 'warehouse': '_Test Warehouse - _TC', 'item_name':'Test Extra Item 2'}] + { + "item_code": item_code, + "rm_item_code": "Sub Contracted Raw Material 1", + "item_name": "_Test Item", + "qty": 10, + "warehouse": "_Test Warehouse - _TC", + "stock_uom": "Nos", + }, + { + "item_code": item_code, + "rm_item_code": "_Test Item Home Desktop 100", + "item_name": "_Test Item Home Desktop 100", + "qty": 20, + "warehouse": "_Test Warehouse - _TC", + "stock_uom": "Nos", + }, + { + "item_code": item_code, + "rm_item_code": "Test Extra Item 1", + "item_name": "Test Extra Item 1", + "qty": 10, + "warehouse": "_Test Warehouse - _TC", + "stock_uom": "Nos", + }, + { + "item_code": item_code, + "rm_item_code": "Test Extra Item 2", + "stock_uom": "Nos", + "qty": 10, + "warehouse": "_Test Warehouse - _TC", + "item_name": "Test Extra Item 2", + }, + ] rm_item_string = json.dumps(rm_items) se = frappe.get_doc(make_subcontract_transfer_entry(po.name, rm_item_string)) @@ -850,61 +1057,80 @@ class TestPurchaseOrder(unittest.TestCase): received_qty = 2 # partial receipt - pr.get('items')[0].qty = received_qty + pr.get("items")[0].qty = received_qty pr.save() pr.submit() - transferred_items = sorted([d.item_code for d in se.get('items') if se.purchase_order == po.name]) - issued_items = sorted([d.rm_item_code for d in pr.get('supplied_items')]) + transferred_items = sorted( + [d.item_code for d in se.get("items") if se.purchase_order == po.name] + ) + issued_items = sorted([d.rm_item_code for d in pr.get("supplied_items")]) self.assertEqual(transferred_items, issued_items) - self.assertEqual(pr.get('items')[0].rm_supp_cost, 2000) - + self.assertEqual(pr.get("items")[0].rm_supp_cost, 2000) transferred_rm_map = frappe._dict() for item in rm_items: - transferred_rm_map[item.get('rm_item_code')] = item + transferred_rm_map[item.get("rm_item_code")] = item update_backflush_based_on("BOM") def test_supplied_qty_against_subcontracted_po(self): item_code = "_Test Subcontracted FG Item 5" - make_item('Sub Contracted Raw Material 4', { - 'is_stock_item': 1, - 'is_sub_contracted_item': 1 - }) + make_item("Sub Contracted Raw Material 4", {"is_stock_item": 1, "is_sub_contracted_item": 1}) make_subcontracted_item(item_code=item_code, raw_materials=["Sub Contracted Raw Material 4"]) update_backflush_based_on("Material Transferred for Subcontract") order_qty = 250 - po = create_purchase_order(item_code=item_code, qty=order_qty, - is_subcontracted="Yes", supplier_warehouse="_Test Warehouse 1 - _TC", do_not_save=True) + po = create_purchase_order( + item_code=item_code, + qty=order_qty, + is_subcontracted="Yes", + supplier_warehouse="_Test Warehouse 1 - _TC", + do_not_save=True, + ) # Add same subcontracted items multiple times - po.append("items", { - "item_code": item_code, - "qty": order_qty, - "schedule_date": add_days(nowdate(), 1), - "warehouse": "_Test Warehouse - _TC" - }) + po.append( + "items", + { + "item_code": item_code, + "qty": order_qty, + "schedule_date": add_days(nowdate(), 1), + "warehouse": "_Test Warehouse - _TC", + }, + ) po.set_missing_values() po.submit() # Material receipt entry for the raw materials which will be send to supplier - make_stock_entry(target="_Test Warehouse - _TC", - item_code = "Sub Contracted Raw Material 4", qty=500, basic_rate=100) + make_stock_entry( + target="_Test Warehouse - _TC", + item_code="Sub Contracted Raw Material 4", + qty=500, + basic_rate=100, + ) rm_items = [ { - "item_code":item_code,"rm_item_code":"Sub Contracted Raw Material 4","item_name":"_Test Item", - "qty":250,"warehouse":"_Test Warehouse - _TC", "stock_uom":"Nos", "name": po.supplied_items[0].name + "item_code": item_code, + "rm_item_code": "Sub Contracted Raw Material 4", + "item_name": "_Test Item", + "qty": 250, + "warehouse": "_Test Warehouse - _TC", + "stock_uom": "Nos", + "name": po.supplied_items[0].name, }, { - "item_code":item_code,"rm_item_code":"Sub Contracted Raw Material 4","item_name":"_Test Item", - "qty":250,"warehouse":"_Test Warehouse - _TC", "stock_uom":"Nos" + "item_code": item_code, + "rm_item_code": "Sub Contracted Raw Material 4", + "item_name": "_Test Item", + "qty": 250, + "warehouse": "_Test Warehouse - _TC", + "stock_uom": "Nos", }, ] @@ -926,8 +1152,10 @@ class TestPurchaseOrder(unittest.TestCase): def test_advance_payment_entry_unlink_against_purchase_order(self): from erpnext.accounts.doctype.payment_entry.test_payment_entry import get_payment_entry - frappe.db.set_value("Accounts Settings", "Accounts Settings", - "unlink_advance_payment_on_cancelation_of_order", 1) + + frappe.db.set_value( + "Accounts Settings", "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order", 1 + ) po_doc = create_purchase_order() @@ -942,24 +1170,23 @@ class TestPurchaseOrder(unittest.TestCase): pe.save(ignore_permissions=True) pe.submit() - po_doc = frappe.get_doc('Purchase Order', po_doc.name) + po_doc = frappe.get_doc("Purchase Order", po_doc.name) po_doc.cancel() - pe_doc = frappe.get_doc('Payment Entry', pe.name) + pe_doc = frappe.get_doc("Payment Entry", pe.name) pe_doc.cancel() - frappe.db.set_value("Accounts Settings", "Accounts Settings", - "unlink_advance_payment_on_cancelation_of_order", 0) + frappe.db.set_value( + "Accounts Settings", "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order", 0 + ) def test_schedule_date(self): po = create_purchase_order(do_not_submit=True) po.schedule_date = None - po.append("items", { - "item_code": "_Test Item", - "qty": 1, - "rate": 100, - "schedule_date": add_days(nowdate(), 5) - }) + po.append( + "items", + {"item_code": "_Test Item", "qty": 1, "rate": 100, "schedule_date": add_days(nowdate(), 5)}, + ) po.save() self.assertEqual(po.schedule_date, add_days(nowdate(), 1)) @@ -967,22 +1194,21 @@ class TestPurchaseOrder(unittest.TestCase): po.save() self.assertEqual(po.schedule_date, add_days(nowdate(), 2)) - def test_po_optional_blanket_order(self): """ - Expected result: Blanket order Ordered Quantity should only be affected on Purchase Order with against_blanket_order = 1. - Second Purchase Order should not add on to Blanket Orders Ordered Quantity. + Expected result: Blanket order Ordered Quantity should only be affected on Purchase Order with against_blanket_order = 1. + Second Purchase Order should not add on to Blanket Orders Ordered Quantity. """ - bo = make_blanket_order(blanket_order_type = "Purchasing", quantity = 10, rate = 10) + bo = make_blanket_order(blanket_order_type="Purchasing", quantity=10, rate=10) - po = create_purchase_order(item_code= "_Test Item", qty = 5, against_blanket_order = 1) - po_doc = frappe.get_doc('Purchase Order', po.get('name')) + po = create_purchase_order(item_code="_Test Item", qty=5, against_blanket_order=1) + po_doc = frappe.get_doc("Purchase Order", po.get("name")) # To test if the PO has a Blanket Order self.assertTrue(po_doc.items[0].blanket_order) - po = create_purchase_order(item_code= "_Test Item", qty = 5, against_blanket_order = 0) - po_doc = frappe.get_doc('Purchase Order', po.get('name')) + po = create_purchase_order(item_code="_Test Item", qty=5, against_blanket_order=0) + po_doc = frappe.get_doc("Purchase Order", po.get("name")) # To test if the PO does NOT have a Blanket Order self.assertEqual(po_doc.items[0].blanket_order, None) @@ -1000,7 +1226,7 @@ class TestPurchaseOrder(unittest.TestCase): po = create_purchase_order(qty=10, rate=100, do_not_save=1) create_payment_terms_template() - po.payment_terms_template = 'Test Receivable Template' + po.payment_terms_template = "Test Receivable Template" po.submit() pi = make_purchase_invoice(qty=10, rate=100, do_not_save=1) @@ -1013,6 +1239,7 @@ class TestPurchaseOrder(unittest.TestCase): automatically_fetch_payment_terms(enable=0) + def make_pr_against_po(po, received_qty=0): pr = make_purchase_receipt(po) pr.get("items")[0].qty = received_qty or 5 @@ -1020,39 +1247,51 @@ def make_pr_against_po(po, received_qty=0): pr.submit() return pr + def make_subcontracted_item(**args): from erpnext.manufacturing.doctype.production_plan.test_production_plan import make_bom args = frappe._dict(args) - if not frappe.db.exists('Item', args.item_code): - make_item(args.item_code, { - 'is_stock_item': 1, - 'is_sub_contracted_item': 1, - 'has_batch_no': args.get("has_batch_no") or 0 - }) + if not frappe.db.exists("Item", args.item_code): + make_item( + args.item_code, + { + "is_stock_item": 1, + "is_sub_contracted_item": 1, + "has_batch_no": args.get("has_batch_no") or 0, + }, + ) if not args.raw_materials: - if not frappe.db.exists('Item', "Test Extra Item 1"): - make_item("Test Extra Item 1", { - 'is_stock_item': 1, - }) + if not frappe.db.exists("Item", "Test Extra Item 1"): + make_item( + "Test Extra Item 1", + { + "is_stock_item": 1, + }, + ) - if not frappe.db.exists('Item', "Test Extra Item 2"): - make_item("Test Extra Item 2", { - 'is_stock_item': 1, - }) + if not frappe.db.exists("Item", "Test Extra Item 2"): + make_item( + "Test Extra Item 2", + { + "is_stock_item": 1, + }, + ) - args.raw_materials = ['_Test FG Item', 'Test Extra Item 1'] + args.raw_materials = ["_Test FG Item", "Test Extra Item 1"] + + if not frappe.db.get_value("BOM", {"item": args.item_code}, "name"): + make_bom(item=args.item_code, raw_materials=args.get("raw_materials")) - if not frappe.db.get_value('BOM', {'item': args.item_code}, 'name'): - make_bom(item = args.item_code, raw_materials = args.get("raw_materials")) def update_backflush_based_on(based_on): - doc = frappe.get_doc('Buying Settings') + doc = frappe.get_doc("Buying Settings") doc.backflush_raw_materials_of_subcontract_based_on = based_on doc.save() + def get_same_items(): return [ { @@ -1060,17 +1299,18 @@ def get_same_items(): "warehouse": "_Test Warehouse - _TC", "qty": 1, "rate": 500, - "schedule_date": add_days(nowdate(), 1) + "schedule_date": add_days(nowdate(), 1), }, { "item_code": "_Test FG Item", "warehouse": "_Test Warehouse - _TC", "qty": 4, "rate": 500, - "schedule_date": add_days(nowdate(), 1) - } + "schedule_date": add_days(nowdate(), 1), + }, ] + def create_purchase_order(**args): po = frappe.new_doc("Purchase Order") args = frappe._dict(args) @@ -1081,7 +1321,7 @@ def create_purchase_order(**args): po.company = args.company or "_Test Company" po.supplier = args.supplier or "_Test Supplier" po.is_subcontracted = args.is_subcontracted or "No" - po.currency = args.currency or frappe.get_cached_value('Company', po.company, "default_currency") + po.currency = args.currency or frappe.get_cached_value("Company", po.company, "default_currency") po.conversion_factor = args.conversion_factor or 1 po.supplier_warehouse = args.supplier_warehouse or None @@ -1089,15 +1329,18 @@ def create_purchase_order(**args): for row in args.rm_items: po.append("items", row) else: - po.append("items", { - "item_code": args.item or args.item_code or "_Test Item", - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "qty": args.qty or 10, - "rate": args.rate or 500, - "schedule_date": add_days(nowdate(), 1), - "include_exploded_items": args.get('include_exploded_items', 1), - "against_blanket_order": args.against_blanket_order - }) + po.append( + "items", + { + "item_code": args.item or args.item_code or "_Test Item", + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "qty": args.qty or 10, + "rate": args.rate or 500, + "schedule_date": add_days(nowdate(), 1), + "include_exploded_items": args.get("include_exploded_items", 1), + "against_blanket_order": args.against_blanket_order, + }, + ) po.set_missing_values() if not args.do_not_save: @@ -1112,6 +1355,7 @@ def create_purchase_order(**args): return po + def create_pr_against_po(po, received_qty=4): pr = make_purchase_receipt(po) pr.get("items")[0].qty = received_qty @@ -1119,14 +1363,19 @@ def create_pr_against_po(po, received_qty=4): pr.submit() return pr + def get_ordered_qty(item_code="_Test Item", warehouse="_Test Warehouse - _TC"): - return flt(frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse}, - "ordered_qty")) + return flt( + frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse}, "ordered_qty") + ) + def get_requested_qty(item_code="_Test Item", warehouse="_Test Warehouse - _TC"): - return flt(frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse}, - "indented_qty")) + return flt( + frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse}, "indented_qty") + ) + test_dependencies = ["BOM", "Item Price"] -test_records = frappe.get_test_records('Purchase Order') +test_records = frappe.get_test_records("Purchase Order") diff --git a/erpnext/buying/doctype/purchase_order_item/purchase_order_item.json b/erpnext/buying/doctype/purchase_order_item/purchase_order_item.json index 87cd57517e2..a18c527644e 100644 --- a/erpnext/buying/doctype/purchase_order_item/purchase_order_item.json +++ b/erpnext/buying/doctype/purchase_order_item/purchase_order_item.json @@ -63,6 +63,7 @@ "material_request_item", "sales_order", "sales_order_item", + "sales_order_packed_item", "supplier_quotation", "supplier_quotation_item", "col_break5", @@ -837,21 +838,30 @@ "label": "Product Bundle", "options": "Product Bundle", "read_only": 1 + }, + { + "fieldname": "sales_order_packed_item", + "fieldtype": "Data", + "label": "Sales Order Packed Item", + "no_copy": 1, + "print_hide": 1 } ], "idx": 1, "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-08-30 20:06:26.712097", + "modified": "2022-02-02 13:10:18.398976", "modified_by": "Administrator", "module": "Buying", "name": "Purchase Order Item", + "naming_rule": "Random", "owner": "Administrator", "permissions": [], "quick_entry": 1, "search_fields": "item_name", "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/buying/doctype/purchase_order_item/purchase_order_item.py b/erpnext/buying/doctype/purchase_order_item/purchase_order_item.py index 0cef0deee55..a8bafda0029 100644 --- a/erpnext/buying/doctype/purchase_order_item/purchase_order_item.py +++ b/erpnext/buying/doctype/purchase_order_item/purchase_order_item.py @@ -9,5 +9,6 @@ from frappe.model.document import Document class PurchaseOrderItem(Document): pass + def on_doctype_update(): frappe.db.add_index("Purchase Order Item", ["item_code", "warehouse"]) diff --git a/erpnext/buying/doctype/request_for_quotation/request_for_quotation.js b/erpnext/buying/doctype/request_for_quotation/request_for_quotation.js index b76c3784a47..3cc25580013 100644 --- a/erpnext/buying/doctype/request_for_quotation/request_for_quotation.js +++ b/erpnext/buying/doctype/request_for_quotation/request_for_quotation.js @@ -15,9 +15,12 @@ frappe.ui.form.on("Request for Quotation",{ frm.fields_dict["suppliers"].grid.get_field("contact").get_query = function(doc, cdt, cdn) { let d = locals[cdt][cdn]; return { - query: "erpnext.buying.doctype.request_for_quotation.request_for_quotation.get_supplier_contacts", - filters: {'supplier': d.supplier} - } + query: "frappe.contacts.doctype.contact.contact.contact_query", + filters: { + link_doctype: "Supplier", + link_name: d.supplier || "" + } + }; } }, @@ -31,7 +34,7 @@ frappe.ui.form.on("Request for Quotation",{ if (frm.doc.docstatus === 1) { frm.add_custom_button(__('Supplier Quotation'), - function(){ frm.trigger("make_suppplier_quotation") }, __("Create")); + function(){ frm.trigger("make_supplier_quotation") }, __("Create")); frm.add_custom_button(__("Send Emails to Suppliers"), function() { @@ -87,16 +90,24 @@ frappe.ui.form.on("Request for Quotation",{ }, - make_suppplier_quotation: function(frm) { + make_supplier_quotation: function(frm) { var doc = frm.doc; var dialog = new frappe.ui.Dialog({ title: __("Create Supplier Quotation"), fields: [ - { "fieldtype": "Select", "label": __("Supplier"), + { "fieldtype": "Link", + "label": __("Supplier"), "fieldname": "supplier", - "options": doc.suppliers.map(d => d.supplier), + "options": 'Supplier', "reqd": 1, - "default": doc.suppliers.length === 1 ? doc.suppliers[0].supplier_name : "" }, + get_query: () => { + return { + filters: [ + ["Supplier", "name", "in", frm.doc.suppliers.map((row) => {return row.supplier;})] + ] + } + } + } ], primary_action_label: __("Create"), primary_action: (args) => { @@ -124,6 +135,14 @@ frappe.ui.form.on("Request for Quotation",{ dialog.show() }, + schedule_date(frm) { + if(frm.doc.schedule_date){ + frm.doc.items.forEach((item) => { + item.schedule_date = frm.doc.schedule_date; + }) + } + refresh_field("items"); + }, preview: (frm) => { let dialog = new frappe.ui.Dialog({ title: __('Preview Email'), @@ -184,7 +203,13 @@ frappe.ui.form.on("Request for Quotation",{ dialog.show(); } }) - +frappe.ui.form.on("Request for Quotation Item", { + items_add(frm, cdt, cdn) { + if (frm.doc.schedule_date) { + frappe.model.set_value(cdt, cdn, 'schedule_date', frm.doc.schedule_date); + } + } +}); frappe.ui.form.on("Request for Quotation Supplier",{ supplier: function(frm, cdt, cdn) { var d = locals[cdt][cdn] diff --git a/erpnext/buying/doctype/request_for_quotation/request_for_quotation.json b/erpnext/buying/doctype/request_for_quotation/request_for_quotation.json index 4ce4100a7fc..083cab78f76 100644 --- a/erpnext/buying/doctype/request_for_quotation/request_for_quotation.json +++ b/erpnext/buying/doctype/request_for_quotation/request_for_quotation.json @@ -12,6 +12,7 @@ "vendor", "column_break1", "transaction_date", + "schedule_date", "status", "amended_from", "suppliers_section", @@ -31,7 +32,9 @@ "terms", "printing_settings", "select_print_heading", - "letter_head" + "letter_head", + "more_info", + "opportunity" ], "fields": [ { @@ -192,6 +195,23 @@ "options": "Letter Head", "print_hide": 1 }, + { + "collapsible": 1, + "fieldname": "more_info", + "fieldtype": "Section Break", + "label": "More Information", + "oldfieldtype": "Section Break", + "options": "fa fa-file-text", + "print_hide": 1 + }, + { + "fieldname": "opportunity", + "fieldtype": "Link", + "label": "Opportunity", + "options": "Opportunity", + "print_hide": 1, + "read_only": 1 + }, { "fieldname": "status", "fieldtype": "Select", @@ -246,16 +266,22 @@ "fieldname": "sec_break_email_2", "fieldtype": "Section Break", "hide_border": 1 + }, + { + "fieldname": "schedule_date", + "fieldtype": "Date", + "label": "Required Date" } ], "icon": "fa fa-shopping-cart", "index_web_pages_for_search": 1, "is_submittable": 1, "links": [], - "modified": "2020-11-05 22:04:29.017134", + "modified": "2022-04-06 17:47:49.909000", "modified_by": "Administrator", "module": "Buying", "name": "Request for Quotation", + "naming_rule": "By \"Naming Series\" field", "owner": "Administrator", "permissions": [ { @@ -320,4 +346,4 @@ "show_name_in_global_search": 1, "sort_field": "modified", "sort_order": "DESC" -} \ No newline at end of file +} diff --git a/erpnext/buying/doctype/request_for_quotation/request_for_quotation.py b/erpnext/buying/doctype/request_for_quotation/request_for_quotation.py index b670bd58d48..45a2ad43e7c 100644 --- a/erpnext/buying/doctype/request_for_quotation/request_for_quotation.py +++ b/erpnext/buying/doctype/request_for_quotation/request_for_quotation.py @@ -21,6 +21,7 @@ from erpnext.stock.doctype.material_request.material_request import set_missing_ STANDARD_USERS = ("Guest", "Administrator") + class RequestforQuotation(BuyingController): def validate(self): self.validate_duplicate_supplier() @@ -31,7 +32,7 @@ class RequestforQuotation(BuyingController): if self.docstatus < 1: # after amend and save, status still shows as cancelled, until submit - frappe.db.set(self, 'status', 'Draft') + frappe.db.set(self, "status", "Draft") def validate_duplicate_supplier(self): supplier_list = [d.supplier for d in self.suppliers] @@ -40,14 +41,24 @@ class RequestforQuotation(BuyingController): def validate_supplier_list(self): for d in self.suppliers: - prevent_rfqs = frappe.db.get_value("Supplier", d.supplier, 'prevent_rfqs') + prevent_rfqs = frappe.db.get_value("Supplier", d.supplier, "prevent_rfqs") if prevent_rfqs: - standing = frappe.db.get_value("Supplier Scorecard",d.supplier, 'status') - frappe.throw(_("RFQs are not allowed for {0} due to a scorecard standing of {1}").format(d.supplier, standing)) - warn_rfqs = frappe.db.get_value("Supplier", d.supplier, 'warn_rfqs') + standing = frappe.db.get_value("Supplier Scorecard", d.supplier, "status") + frappe.throw( + _("RFQs are not allowed for {0} due to a scorecard standing of {1}").format( + d.supplier, standing + ) + ) + warn_rfqs = frappe.db.get_value("Supplier", d.supplier, "warn_rfqs") if warn_rfqs: - standing = frappe.db.get_value("Supplier Scorecard",d.supplier, 'status') - frappe.msgprint(_("{0} currently has a {1} Supplier Scorecard standing, and RFQs to this supplier should be issued with caution.").format(d.supplier, standing), title=_("Caution"), indicator='orange') + standing = frappe.db.get_value("Supplier Scorecard", d.supplier, "status") + frappe.msgprint( + _( + "{0} currently has a {1} Supplier Scorecard standing, and RFQs to this supplier should be issued with caution." + ).format(d.supplier, standing), + title=_("Caution"), + indicator="orange", + ) def update_email_id(self): for rfq_supplier in self.suppliers: @@ -56,17 +67,21 @@ class RequestforQuotation(BuyingController): def validate_email_id(self, args): if not args.email_id: - frappe.throw(_("Row {0}: For Supplier {1}, Email Address is Required to send an email").format(args.idx, frappe.bold(args.supplier))) + frappe.throw( + _("Row {0}: For Supplier {1}, Email Address is Required to send an email").format( + args.idx, frappe.bold(args.supplier) + ) + ) def on_submit(self): - frappe.db.set(self, 'status', 'Submitted') + frappe.db.set(self, "status", "Submitted") for supplier in self.suppliers: supplier.email_sent = 0 - supplier.quote_status = 'Pending' + supplier.quote_status = "Pending" self.send_to_supplier() def on_cancel(self): - frappe.db.set(self, 'status', 'Cancelled') + frappe.db.set(self, "status", "Cancelled") @frappe.whitelist() def get_supplier_email_preview(self, supplier): @@ -76,7 +91,7 @@ class RequestforQuotation(BuyingController): self.validate_email_id(rfq_supplier) - message = self.supplier_rfq_mail(rfq_supplier, '', self.get_link(), True) + message = self.supplier_rfq_mail(rfq_supplier, "", self.get_link(), True) return message @@ -98,17 +113,18 @@ class RequestforQuotation(BuyingController): def get_link(self): # RFQ link for supplier portal - return get_url("/rfq/" + self.name) + return get_url("/app/request-for-quotation/" + self.name) def update_supplier_part_no(self, supplier): self.vendor = supplier for item in self.items: - item.supplier_part_no = frappe.db.get_value('Item Supplier', - {'parent': item.item_code, 'supplier': supplier}, 'supplier_part_no') + item.supplier_part_no = frappe.db.get_value( + "Item Supplier", {"parent": item.item_code, "supplier": supplier}, "supplier_part_no" + ) def update_supplier_contact(self, rfq_supplier, link): - '''Create a new user for the supplier if not set in contact''' - update_password_link, contact = '', '' + """Create a new user for the supplier if not set in contact""" + update_password_link, contact = "", "" if frappe.db.exists("User", rfq_supplier.email_id): user = frappe.get_doc("User", rfq_supplier.email_id) @@ -126,14 +142,8 @@ class RequestforQuotation(BuyingController): else: contact = frappe.new_doc("Contact") contact.first_name = rfq_supplier.supplier_name or rfq_supplier.supplier - contact.append('links', { - 'link_doctype': 'Supplier', - 'link_name': rfq_supplier.supplier - }) - contact.append('email_ids', { - 'email_id': user.name, - 'is_primary': 1 - }) + contact.append("links", {"link_doctype": "Supplier", "link_name": rfq_supplier.supplier}) + contact.append("email_ids", {"email_id": user.name, "is_primary": 1}) if not contact.email_id and not contact.user: contact.email_id = user.name @@ -146,39 +156,46 @@ class RequestforQuotation(BuyingController): return contact.name def create_user(self, rfq_supplier, link): - user = frappe.get_doc({ - 'doctype': 'User', - 'send_welcome_email': 0, - 'email': rfq_supplier.email_id, - 'first_name': rfq_supplier.supplier_name or rfq_supplier.supplier, - 'user_type': 'Website User', - 'redirect_url': link - }) + user = frappe.get_doc( + { + "doctype": "User", + "send_welcome_email": 0, + "email": rfq_supplier.email_id, + "first_name": rfq_supplier.supplier_name or rfq_supplier.supplier, + "user_type": "Website User", + "redirect_url": link, + } + ) user.save(ignore_permissions=True) update_password_link = user.reset_password() return user, update_password_link def supplier_rfq_mail(self, data, update_password_link, rfq_link, preview=False): - full_name = get_user_fullname(frappe.session['user']) + full_name = get_user_fullname(frappe.session["user"]) if full_name == "Guest": full_name = "Administrator" # send document dict and some important data from suppliers row # to render message_for_supplier from any template doc_args = self.as_dict() - doc_args.update({ - 'supplier': data.get('supplier'), - 'supplier_name': data.get('supplier_name') - }) + doc_args.update({"supplier": data.get("supplier"), "supplier_name": data.get("supplier_name")}) + + # Get Contact Full Name + supplier_name = None + if data.get("contact"): + contact_name = frappe.db.get_value( + "Contact", data.get("contact"), ["first_name", "middle_name", "last_name"] + ) + supplier_name = (" ").join(x for x in contact_name if x) # remove any blank values args = { - 'update_password_link': update_password_link, - 'message': frappe.render_template(self.message_for_supplier, doc_args), - 'rfq_link': rfq_link, - 'user_fullname': full_name, - 'supplier_name' : data.get('supplier_name'), - 'supplier_salutation' : self.salutation or 'Dear Mx.', + "update_password_link": update_password_link, + "message": frappe.render_template(self.message_for_supplier, doc_args), + "rfq_link": rfq_link, + "user_fullname": full_name, + "supplier_name": supplier_name or data.get("supplier_name"), + "supplier_salutation": self.salutation or "Dear Mx.", } subject = self.subject or _("Request for Quotation") @@ -194,9 +211,16 @@ class RequestforQuotation(BuyingController): self.send_email(data, sender, subject, message, attachments) def send_email(self, data, sender, subject, message, attachments): - make(subject = subject, content=message,recipients=data.email_id, - sender=sender,attachments = attachments, send_email=True, - doctype=self.doctype, name=self.name)["name"] + make( + subject=subject, + content=message, + recipients=data.email_id, + sender=sender, + attachments=attachments, + send_email=True, + doctype=self.doctype, + name=self.name, + )["name"] frappe.msgprint(_("Email Sent to Supplier {0}").format(data.supplier)) @@ -208,9 +232,10 @@ class RequestforQuotation(BuyingController): def update_rfq_supplier_status(self, sup_name=None): for supplier in self.suppliers: if sup_name == None or supplier.supplier == sup_name: - quote_status = _('Received') + quote_status = _("Received") for item in self.items: - sqi_count = frappe.db.sql(""" + sqi_count = frappe.db.sql( + """ SELECT COUNT(sqi.name) as count FROM @@ -220,42 +245,47 @@ class RequestforQuotation(BuyingController): AND sqi.docstatus = 1 AND sqi.request_for_quotation_item = %(rqi)s AND sqi.parent = sq.name""", - {"supplier": supplier.supplier, "rqi": item.name}, as_dict=1)[0] + {"supplier": supplier.supplier, "rqi": item.name}, + as_dict=1, + )[0] if (sqi_count.count) == 0: - quote_status = _('Pending') + quote_status = _("Pending") supplier.quote_status = quote_status @frappe.whitelist() def send_supplier_emails(rfq_name): - check_portal_enabled('Request for Quotation') + check_portal_enabled("Request for Quotation") rfq = frappe.get_doc("Request for Quotation", rfq_name) - if rfq.docstatus==1: + if rfq.docstatus == 1: rfq.send_to_supplier() + def check_portal_enabled(reference_doctype): - if not frappe.db.get_value('Portal Menu Item', - {'reference_doctype': reference_doctype}, 'enabled'): - frappe.throw(_("The Access to Request for Quotation From Portal is Disabled. To Allow Access, Enable it in Portal Settings.")) + if not frappe.db.get_value( + "Portal Menu Item", {"reference_doctype": reference_doctype}, "enabled" + ): + frappe.throw( + _( + "The Access to Request for Quotation From Portal is Disabled. To Allow Access, Enable it in Portal Settings." + ) + ) + def get_list_context(context=None): from erpnext.controllers.website_list_for_contact import get_list_context + list_context = get_list_context(context) - list_context.update({ - 'show_sidebar': True, - 'show_search': True, - 'no_breadcrumbs': True, - 'title': _('Request for Quotation'), - }) + list_context.update( + { + "show_sidebar": True, + "show_search": True, + "no_breadcrumbs": True, + "title": _("Request for Quotation"), + } + ) return list_context -@frappe.whitelist() -@frappe.validate_and_sanitize_search_inputs -def get_supplier_contacts(doctype, txt, searchfield, start, page_len, filters): - return frappe.db.sql("""select `tabContact`.name from `tabContact`, `tabDynamic Link` - where `tabDynamic Link`.link_doctype = 'Supplier' and (`tabDynamic Link`.link_name=%(name)s - and `tabDynamic Link`.link_name like %(txt)s) and `tabContact`.name = `tabDynamic Link`.parent - limit %(start)s, %(page_len)s""", {"start": start, "page_len":page_len, "txt": "%%%s%%" % txt, "name": filters.get('supplier')}) @frappe.whitelist() def make_supplier_quotation_from_rfq(source_name, target_doc=None, for_supplier=None): @@ -263,28 +293,34 @@ def make_supplier_quotation_from_rfq(source_name, target_doc=None, for_supplier= if for_supplier: target_doc.supplier = for_supplier args = get_party_details(for_supplier, party_type="Supplier", ignore_permissions=True) - target_doc.currency = args.currency or get_party_account_currency('Supplier', for_supplier, source.company) - target_doc.buying_price_list = args.buying_price_list or frappe.db.get_value('Buying Settings', None, 'buying_price_list') + target_doc.currency = args.currency or get_party_account_currency( + "Supplier", for_supplier, source.company + ) + target_doc.buying_price_list = args.buying_price_list or frappe.db.get_value( + "Buying Settings", None, "buying_price_list" + ) set_missing_values(source, target_doc) - doclist = get_mapped_doc("Request for Quotation", source_name, { - "Request for Quotation": { - "doctype": "Supplier Quotation", - "validation": { - "docstatus": ["=", 1] - } - }, - "Request for Quotation Item": { - "doctype": "Supplier Quotation Item", - "field_map": { - "name": "request_for_quotation_item", - "parent": "request_for_quotation" + doclist = get_mapped_doc( + "Request for Quotation", + source_name, + { + "Request for Quotation": { + "doctype": "Supplier Quotation", + "validation": {"docstatus": ["=", 1]}, }, - } - }, target_doc, postprocess) + "Request for Quotation Item": { + "doctype": "Supplier Quotation Item", + "field_map": {"name": "request_for_quotation_item", "parent": "request_for_quotation"}, + }, + }, + target_doc, + postprocess, + ) return doclist + # This method is used to make supplier quotation from supplier's portal. @frappe.whitelist() def create_supplier_quotation(doc): @@ -292,15 +328,19 @@ def create_supplier_quotation(doc): doc = json.loads(doc) try: - sq_doc = frappe.get_doc({ - "doctype": "Supplier Quotation", - "supplier": doc.get('supplier'), - "terms": doc.get("terms"), - "company": doc.get("company"), - "currency": doc.get('currency') or get_party_account_currency('Supplier', doc.get('supplier'), doc.get('company')), - "buying_price_list": doc.get('buying_price_list') or frappe.db.get_value('Buying Settings', None, 'buying_price_list') - }) - add_items(sq_doc, doc.get('supplier'), doc.get('items')) + sq_doc = frappe.get_doc( + { + "doctype": "Supplier Quotation", + "supplier": doc.get("supplier"), + "terms": doc.get("terms"), + "company": doc.get("company"), + "currency": doc.get("currency") + or get_party_account_currency("Supplier", doc.get("supplier"), doc.get("company")), + "buying_price_list": doc.get("buying_price_list") + or frappe.db.get_value("Buying Settings", None, "buying_price_list"), + } + ) + add_items(sq_doc, doc.get("supplier"), doc.get("items")) sq_doc.flags.ignore_permissions = True sq_doc.run_method("set_missing_values") sq_doc.save() @@ -309,6 +349,7 @@ def create_supplier_quotation(doc): except Exception: return None + def add_items(sq_doc, supplier, items): for data in items: if data.get("qty") > 0: @@ -317,21 +358,36 @@ def add_items(sq_doc, supplier, items): create_rfq_items(sq_doc, supplier, data) + def create_rfq_items(sq_doc, supplier, data): args = {} - for field in ['item_code', 'item_name', 'description', 'qty', 'rate', 'conversion_factor', - 'warehouse', 'material_request', 'material_request_item', 'stock_qty']: + for field in [ + "item_code", + "item_name", + "description", + "qty", + "rate", + "conversion_factor", + "warehouse", + "material_request", + "material_request_item", + "stock_qty", + ]: args[field] = data.get(field) - args.update({ - "request_for_quotation_item": data.name, - "request_for_quotation": data.parent, - "supplier_part_no": frappe.db.get_value("Item Supplier", - {'parent': data.item_code, 'supplier': supplier}, "supplier_part_no") - }) + args.update( + { + "request_for_quotation_item": data.name, + "request_for_quotation": data.parent, + "supplier_part_no": frappe.db.get_value( + "Item Supplier", {"parent": data.item_code, "supplier": supplier}, "supplier_part_no" + ), + } + ) + + sq_doc.append("items", args) - sq_doc.append('items', args) @frappe.whitelist() def get_pdf(doctype, name, supplier): @@ -339,15 +395,18 @@ def get_pdf(doctype, name, supplier): if doc: download_pdf(doctype, name, doc=doc) + def get_rfq_doc(doctype, name, supplier): if supplier: doc = frappe.get_doc(doctype, name) doc.update_supplier_part_no(supplier) return doc + @frappe.whitelist() -def get_item_from_material_requests_based_on_supplier(source_name, target_doc = None): - mr_items_list = frappe.db.sql(""" +def get_item_from_material_requests_based_on_supplier(source_name, target_doc=None): + mr_items_list = frappe.db.sql( + """ SELECT mr.name, mr_item.item_code FROM @@ -362,52 +421,65 @@ def get_item_from_material_requests_based_on_supplier(source_name, target_doc = AND mr.status != "Stopped" AND mr.material_request_type = "Purchase" AND mr.docstatus = 1 - AND mr.per_ordered < 99.99""", {"supplier": source_name}, as_dict=1) + AND mr.per_ordered < 99.99""", + {"supplier": source_name}, + as_dict=1, + ) material_requests = {} for d in mr_items_list: material_requests.setdefault(d.name, []).append(d.item_code) for mr, items in material_requests.items(): - target_doc = get_mapped_doc("Material Request", mr, { - "Material Request": { - "doctype": "Request for Quotation", - "validation": { - "docstatus": ["=", 1], - "material_request_type": ["=", "Purchase"], - } + target_doc = get_mapped_doc( + "Material Request", + mr, + { + "Material Request": { + "doctype": "Request for Quotation", + "validation": { + "docstatus": ["=", 1], + "material_request_type": ["=", "Purchase"], + }, + }, + "Material Request Item": { + "doctype": "Request for Quotation Item", + "condition": lambda row: row.item_code in items, + "field_map": [ + ["name", "material_request_item"], + ["parent", "material_request"], + ["uom", "uom"], + ], + }, }, - "Material Request Item": { - "doctype": "Request for Quotation Item", - "condition": lambda row: row.item_code in items, - "field_map": [ - ["name", "material_request_item"], - ["parent", "material_request"], - ["uom", "uom"] - ] - } - }, target_doc) + target_doc, + ) return target_doc + @frappe.whitelist() def get_supplier_tag(): filters = {"document_type": "Supplier"} - tags = list(set(tag.tag for tag in frappe.get_all("Tag Link", filters=filters, fields=["tag"]) if tag)) + tags = list( + set(tag.tag for tag in frappe.get_all("Tag Link", filters=filters, fields=["tag"]) if tag) + ) return tags + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_rfq_containing_supplier(doctype, txt, searchfield, start, page_len, filters): conditions = "" if txt: - conditions += "and rfq.name like '%%"+txt+"%%' " + conditions += "and rfq.name like '%%" + txt + "%%' " if filters.get("transaction_date"): conditions += "and rfq.transaction_date = '{0}'".format(filters.get("transaction_date")) - rfq_data = frappe.db.sql(""" + rfq_data = frappe.db.sql( + """ select distinct rfq.name, rfq.transaction_date, rfq.company @@ -420,8 +492,11 @@ def get_rfq_containing_supplier(doctype, txt, searchfield, start, page_len, filt and rfq.company = '{1}' {2} order by rfq.transaction_date ASC - limit %(page_len)s offset %(start)s """ \ - .format(filters.get("supplier"), filters.get("company"), conditions), - {"page_len": page_len, "start": start}, as_dict=1) + limit %(page_len)s offset %(start)s """.format( + filters.get("supplier"), filters.get("company"), conditions + ), + {"page_len": page_len, "start": start}, + as_dict=1, + ) return rfq_data diff --git a/erpnext/buying/doctype/request_for_quotation/request_for_quotation_dashboard.py b/erpnext/buying/doctype/request_for_quotation/request_for_quotation_dashboard.py index 21ef33294e3..505e3e0f674 100644 --- a/erpnext/buying/doctype/request_for_quotation/request_for_quotation_dashboard.py +++ b/erpnext/buying/doctype/request_for_quotation/request_for_quotation_dashboard.py @@ -1,12 +1,8 @@ - - def get_data(): return { - 'docstatus': 1, - 'fieldname': 'request_for_quotation', - 'transactions': [ - { - 'items': ['Supplier Quotation'] - }, - ] + "docstatus": 1, + "fieldname": "request_for_quotation", + "transactions": [ + {"items": ["Supplier Quotation"]}, + ], } diff --git a/erpnext/buying/doctype/request_for_quotation/test_request_for_quotation.py b/erpnext/buying/doctype/request_for_quotation/test_request_for_quotation.py index 51901991b5a..064b806e953 100644 --- a/erpnext/buying/doctype/request_for_quotation/test_request_for_quotation.py +++ b/erpnext/buying/doctype/request_for_quotation/test_request_for_quotation.py @@ -1,9 +1,9 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt -import unittest import frappe +from frappe.tests.utils import FrappeTestCase from frappe.utils import nowdate from erpnext.buying.doctype.request_for_quotation.request_for_quotation import ( @@ -16,40 +16,40 @@ from erpnext.stock.doctype.item.test_item import make_item from erpnext.templates.pages.rfq import check_supplier_has_docname_access -class TestRequestforQuotation(unittest.TestCase): +class TestRequestforQuotation(FrappeTestCase): def test_quote_status(self): rfq = make_request_for_quotation() - self.assertEqual(rfq.get('suppliers')[0].quote_status, 'Pending') - self.assertEqual(rfq.get('suppliers')[1].quote_status, 'Pending') + self.assertEqual(rfq.get("suppliers")[0].quote_status, "Pending") + self.assertEqual(rfq.get("suppliers")[1].quote_status, "Pending") # Submit the first supplier quotation - sq = make_supplier_quotation_from_rfq(rfq.name, for_supplier=rfq.get('suppliers')[0].supplier) + sq = make_supplier_quotation_from_rfq(rfq.name, for_supplier=rfq.get("suppliers")[0].supplier) sq.submit() - rfq.update_rfq_supplier_status() #rfq.get('suppliers')[1].supplier) + rfq.update_rfq_supplier_status() # rfq.get('suppliers')[1].supplier) - self.assertEqual(rfq.get('suppliers')[0].quote_status, 'Received') - self.assertEqual(rfq.get('suppliers')[1].quote_status, 'Pending') + self.assertEqual(rfq.get("suppliers")[0].quote_status, "Received") + self.assertEqual(rfq.get("suppliers")[1].quote_status, "Pending") def test_make_supplier_quotation(self): rfq = make_request_for_quotation() - sq = make_supplier_quotation_from_rfq(rfq.name, for_supplier=rfq.get('suppliers')[0].supplier) + sq = make_supplier_quotation_from_rfq(rfq.name, for_supplier=rfq.get("suppliers")[0].supplier) sq.submit() - sq1 = make_supplier_quotation_from_rfq(rfq.name, for_supplier=rfq.get('suppliers')[1].supplier) + sq1 = make_supplier_quotation_from_rfq(rfq.name, for_supplier=rfq.get("suppliers")[1].supplier) sq1.submit() - self.assertEqual(sq.supplier, rfq.get('suppliers')[0].supplier) - self.assertEqual(sq.get('items')[0].request_for_quotation, rfq.name) - self.assertEqual(sq.get('items')[0].item_code, "_Test Item") - self.assertEqual(sq.get('items')[0].qty, 5) + self.assertEqual(sq.supplier, rfq.get("suppliers")[0].supplier) + self.assertEqual(sq.get("items")[0].request_for_quotation, rfq.name) + self.assertEqual(sq.get("items")[0].item_code, "_Test Item") + self.assertEqual(sq.get("items")[0].qty, 5) - self.assertEqual(sq1.supplier, rfq.get('suppliers')[1].supplier) - self.assertEqual(sq1.get('items')[0].request_for_quotation, rfq.name) - self.assertEqual(sq1.get('items')[0].item_code, "_Test Item") - self.assertEqual(sq1.get('items')[0].qty, 5) + self.assertEqual(sq1.supplier, rfq.get("suppliers")[1].supplier) + self.assertEqual(sq1.get("items")[0].request_for_quotation, rfq.name) + self.assertEqual(sq1.get("items")[0].item_code, "_Test Item") + self.assertEqual(sq1.get("items")[0].qty, 5) def test_make_supplier_quotation_with_special_characters(self): frappe.delete_doc_if_exists("Supplier", "_Test Supplier '1", force=1) @@ -60,52 +60,49 @@ class TestRequestforQuotation(unittest.TestCase): rfq = make_request_for_quotation(supplier_data=supplier_wt_appos) - sq = make_supplier_quotation_from_rfq(rfq.name, for_supplier=supplier_wt_appos[0].get("supplier")) + sq = make_supplier_quotation_from_rfq( + rfq.name, for_supplier=supplier_wt_appos[0].get("supplier") + ) sq.submit() - frappe.form_dict = frappe.local("form_dict") frappe.form_dict.name = rfq.name - self.assertEqual( - check_supplier_has_docname_access(supplier_wt_appos[0].get('supplier')), - True - ) + self.assertEqual(check_supplier_has_docname_access(supplier_wt_appos[0].get("supplier")), True) # reset form_dict frappe.form_dict.name = None def test_make_supplier_quotation_from_portal(self): rfq = make_request_for_quotation() - rfq.get('items')[0].rate = 100 + rfq.get("items")[0].rate = 100 rfq.supplier = rfq.suppliers[0].supplier supplier_quotation_name = create_supplier_quotation(rfq) - supplier_quotation_doc = frappe.get_doc('Supplier Quotation', supplier_quotation_name) + supplier_quotation_doc = frappe.get_doc("Supplier Quotation", supplier_quotation_name) - self.assertEqual(supplier_quotation_doc.supplier, rfq.get('suppliers')[0].supplier) - self.assertEqual(supplier_quotation_doc.get('items')[0].request_for_quotation, rfq.name) - self.assertEqual(supplier_quotation_doc.get('items')[0].item_code, "_Test Item") - self.assertEqual(supplier_quotation_doc.get('items')[0].qty, 5) - self.assertEqual(supplier_quotation_doc.get('items')[0].amount, 500) + self.assertEqual(supplier_quotation_doc.supplier, rfq.get("suppliers")[0].supplier) + self.assertEqual(supplier_quotation_doc.get("items")[0].request_for_quotation, rfq.name) + self.assertEqual(supplier_quotation_doc.get("items")[0].item_code, "_Test Item") + self.assertEqual(supplier_quotation_doc.get("items")[0].qty, 5) + self.assertEqual(supplier_quotation_doc.get("items")[0].amount, 500) def test_make_multi_uom_supplier_quotation(self): item_code = "_Test Multi UOM RFQ Item" - if not frappe.db.exists('Item', item_code): - item = make_item(item_code, {'stock_uom': '_Test UOM'}) - row = item.append('uoms', { - 'uom': 'Kg', - 'conversion_factor': 2 - }) + if not frappe.db.exists("Item", item_code): + item = make_item(item_code, {"stock_uom": "_Test UOM"}) + row = item.append("uoms", {"uom": "Kg", "conversion_factor": 2}) row.db_update() - rfq = make_request_for_quotation(item_code="_Test Multi UOM RFQ Item", uom="Kg", conversion_factor=2) - rfq.get('items')[0].rate = 100 + rfq = make_request_for_quotation( + item_code="_Test Multi UOM RFQ Item", uom="Kg", conversion_factor=2 + ) + rfq.get("items")[0].rate = 100 rfq.supplier = rfq.suppliers[0].supplier self.assertEqual(rfq.items[0].stock_qty, 10) supplier_quotation_name = create_supplier_quotation(rfq) - supplier_quotation = frappe.get_doc('Supplier Quotation', supplier_quotation_name) + supplier_quotation = frappe.get_doc("Supplier Quotation", supplier_quotation_name) self.assertEqual(supplier_quotation.items[0].qty, 5) self.assertEqual(supplier_quotation.items[0].stock_qty, 10) @@ -116,58 +113,62 @@ class TestRequestforQuotation(unittest.TestCase): rfq = make_rfq(opportunity.name) self.assertEqual(len(rfq.get("items")), len(opportunity.get("items"))) - rfq.message_for_supplier = 'Please supply the specified items at the best possible rates.' + rfq.message_for_supplier = "Please supply the specified items at the best possible rates." for item in rfq.items: item.warehouse = "_Test Warehouse - _TC" for data in supplier_data: - rfq.append('suppliers', data) + rfq.append("suppliers", data) - rfq.status = 'Draft' + rfq.status = "Draft" rfq.submit() + def make_request_for_quotation(**args): """ :param supplier_data: List containing supplier data """ args = frappe._dict(args) supplier_data = args.get("supplier_data") if args.get("supplier_data") else get_supplier_data() - rfq = frappe.new_doc('Request for Quotation') + rfq = frappe.new_doc("Request for Quotation") rfq.transaction_date = nowdate() - rfq.status = 'Draft' - rfq.company = '_Test Company' - rfq.message_for_supplier = 'Please supply the specified items at the best possible rates.' + rfq.status = "Draft" + rfq.company = "_Test Company" + rfq.message_for_supplier = "Please supply the specified items at the best possible rates." for data in supplier_data: - rfq.append('suppliers', data) + rfq.append("suppliers", data) - rfq.append("items", { - "item_code": args.item_code or "_Test Item", - "description": "_Test Item", - "uom": args.uom or "_Test UOM", - "stock_uom": args.stock_uom or "_Test UOM", - "qty": args.qty or 5, - "conversion_factor": args.conversion_factor or 1.0, - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "schedule_date": nowdate() - }) + rfq.append( + "items", + { + "item_code": args.item_code or "_Test Item", + "description": "_Test Item", + "uom": args.uom or "_Test UOM", + "stock_uom": args.stock_uom or "_Test UOM", + "qty": args.qty or 5, + "conversion_factor": args.conversion_factor or 1.0, + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "schedule_date": nowdate(), + }, + ) rfq.submit() return rfq -def get_supplier_data(): - return [{ - "supplier": "_Test Supplier", - "supplier_name": "_Test Supplier" - }, - { - "supplier": "_Test Supplier 1", - "supplier_name": "_Test Supplier 1" - }] -supplier_wt_appos = [{ - "supplier": "_Test Supplier '1", - "supplier_name": "_Test Supplier '1", -}] +def get_supplier_data(): + return [ + {"supplier": "_Test Supplier", "supplier_name": "_Test Supplier"}, + {"supplier": "_Test Supplier 1", "supplier_name": "_Test Supplier 1"}, + ] + + +supplier_wt_appos = [ + { + "supplier": "_Test Supplier '1", + "supplier_name": "_Test Supplier '1", + } +] diff --git a/erpnext/buying/doctype/supplier/supplier.py b/erpnext/buying/doctype/supplier/supplier.py index 14d2ccdb50d..6fdeaaa4c1e 100644 --- a/erpnext/buying/doctype/supplier/supplier.py +++ b/erpnext/buying/doctype/supplier/supplier.py @@ -30,27 +30,27 @@ class Supplier(TransactionBase): def before_save(self): if not self.on_hold: - self.hold_type = '' - self.release_date = '' + self.hold_type = "" + self.release_date = "" elif self.on_hold and not self.hold_type: - self.hold_type = 'All' + self.hold_type = "All" def load_dashboard_info(self): info = get_dashboard_info(self.doctype, self.name) - self.set_onload('dashboard_info', info) + self.set_onload("dashboard_info", info) def autoname(self): - supp_master_name = frappe.defaults.get_global_default('supp_master_name') - if supp_master_name == 'Supplier Name': + supp_master_name = frappe.defaults.get_global_default("supp_master_name") + if supp_master_name == "Supplier Name": self.name = self.supplier_name - elif supp_master_name == 'Naming Series': + elif supp_master_name == "Naming Series": set_name_by_naming_series(self) else: self.name = set_name_from_naming_options(frappe.get_meta(self.doctype).autoname, self) def on_update(self): if not self.naming_series: - self.naming_series = '' + self.naming_series = "" self.create_primary_contact() self.create_primary_address() @@ -59,7 +59,7 @@ class Supplier(TransactionBase): self.flags.is_new_doc = self.is_new() # validation for Naming Series mandatory field... - if frappe.defaults.get_global_default('supp_master_name') == 'Naming Series': + if frappe.defaults.get_global_default("supp_master_name") == "Naming Series": if not self.naming_series: msgprint(_("Series is mandatory"), raise_exception=1) @@ -68,13 +68,13 @@ class Supplier(TransactionBase): @frappe.whitelist() def get_supplier_group_details(self): - doc = frappe.get_doc('Supplier Group', self.supplier_group) + doc = frappe.get_doc("Supplier Group", self.supplier_group) self.payment_terms = "" self.accounts = [] if doc.accounts: for account in doc.accounts: - child = self.append('accounts') + child = self.append("accounts") child.company = account.company child.account = account.account @@ -84,12 +84,25 @@ class Supplier(TransactionBase): self.save() def validate_internal_supplier(self): - internal_supplier = frappe.db.get_value("Supplier", - {"is_internal_supplier": 1, "represents_company": self.represents_company, "name": ("!=", self.name)}, "name") + if not self.is_internal_supplier: + self.represents_company = "" + + internal_supplier = frappe.db.get_value( + "Supplier", + { + "is_internal_supplier": 1, + "represents_company": self.represents_company, + "name": ("!=", self.name), + }, + "name", + ) if internal_supplier: - frappe.throw(_("Internal Supplier for company {0} already exists").format( - frappe.bold(self.represents_company))) + frappe.throw( + _("Internal Supplier for company {0} already exists").format( + frappe.bold(self.represents_company) + ) + ) def create_primary_contact(self): from erpnext.selling.doctype.customer.customer import make_contact @@ -97,16 +110,16 @@ class Supplier(TransactionBase): if not self.supplier_primary_contact: if self.mobile_no or self.email_id: contact = make_contact(self) - self.db_set('supplier_primary_contact', contact.name) - self.db_set('mobile_no', self.mobile_no) - self.db_set('email_id', self.email_id) + self.db_set("supplier_primary_contact", contact.name) + self.db_set("mobile_no", self.mobile_no) + self.db_set("email_id", self.email_id) def create_primary_address(self): from frappe.contacts.doctype.address.address import get_address_display from erpnext.selling.doctype.customer.customer import make_address - if self.flags.is_new_doc and self.get('address_line1'): + if self.flags.is_new_doc and self.get("address_line1"): address = make_address(self) address_display = get_address_display(address.name) @@ -115,7 +128,8 @@ class Supplier(TransactionBase): def on_trash(self): if self.supplier_primary_contact: - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabSupplier` SET supplier_primary_contact=null, @@ -123,41 +137,48 @@ class Supplier(TransactionBase): mobile_no=null, email_id=null, primary_address=null - WHERE name=%(name)s""", {"name": self.name}) + WHERE name=%(name)s""", + {"name": self.name}, + ) - delete_contact_and_address('Supplier', self.name) + delete_contact_and_address("Supplier", self.name) def after_rename(self, olddn, newdn, merge=False): - if frappe.defaults.get_global_default('supp_master_name') == 'Supplier Name': + if frappe.defaults.get_global_default("supp_master_name") == "Supplier Name": frappe.db.set(self, "supplier_name", newdn) def create_onboarding_docs(self, args): - company = frappe.defaults.get_defaults().get('company') or \ - frappe.db.get_single_value('Global Defaults', 'default_company') + company = frappe.defaults.get_defaults().get("company") or frappe.db.get_single_value( + "Global Defaults", "default_company" + ) - for i in range(1, args.get('max_count')): - supplier = args.get('supplier_name_' + str(i)) + for i in range(1, args.get("max_count")): + supplier = args.get("supplier_name_" + str(i)) if supplier: try: - doc = frappe.get_doc({ - 'doctype': self.doctype, - 'supplier_name': supplier, - 'supplier_group': _('Local'), - 'company': company - }).insert() + doc = frappe.get_doc( + { + "doctype": self.doctype, + "supplier_name": supplier, + "supplier_group": _("Local"), + "company": company, + } + ).insert() - if args.get('supplier_email_' + str(i)): + if args.get("supplier_email_" + str(i)): from erpnext.selling.doctype.customer.customer import create_contact - create_contact(supplier, 'Supplier', - doc.name, args.get('supplier_email_' + str(i))) + + create_contact(supplier, "Supplier", doc.name, args.get("supplier_email_" + str(i))) except frappe.NameError: pass + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_supplier_primary_contact(doctype, txt, searchfield, start, page_len, filters): supplier = filters.get("supplier") - return frappe.db.sql(""" + return frappe.db.sql( + """ SELECT `tabContact`.name from `tabContact`, `tabDynamic Link` @@ -166,7 +187,6 @@ def get_supplier_primary_contact(doctype, txt, searchfield, start, page_len, fil and `tabDynamic Link`.link_name = %(supplier)s and `tabDynamic Link`.link_doctype = 'Supplier' and `tabContact`.name like %(txt)s - """, { - 'supplier': supplier, - 'txt': '%%%s%%' % txt - }) + """, + {"supplier": supplier, "txt": "%%%s%%" % txt}, + ) diff --git a/erpnext/buying/doctype/supplier/supplier_dashboard.py b/erpnext/buying/doctype/supplier/supplier_dashboard.py index cfa0375e2ed..11bb06e0caa 100644 --- a/erpnext/buying/doctype/supplier/supplier_dashboard.py +++ b/erpnext/buying/doctype/supplier/supplier_dashboard.py @@ -1,32 +1,18 @@ - from frappe import _ def get_data(): return { - 'heatmap': True, - 'heatmap_message': _('This is based on transactions against this Supplier. See timeline below for details'), - 'fieldname': 'supplier', - 'non_standard_fieldnames': { - 'Payment Entry': 'party_name', - 'Bank Account': 'party' - }, - 'transactions': [ - { - 'label': _('Procurement'), - 'items': ['Request for Quotation', 'Supplier Quotation'] - }, - { - 'label': _('Orders'), - 'items': ['Purchase Order', 'Purchase Receipt', 'Purchase Invoice'] - }, - { - 'label': _('Payments'), - 'items': ['Payment Entry', 'Bank Account'] - }, - { - 'label': _('Pricing'), - 'items': ['Pricing Rule'] - } - ] + "heatmap": True, + "heatmap_message": _( + "This is based on transactions against this Supplier. See timeline below for details" + ), + "fieldname": "supplier", + "non_standard_fieldnames": {"Payment Entry": "party_name", "Bank Account": "party"}, + "transactions": [ + {"label": _("Procurement"), "items": ["Request for Quotation", "Supplier Quotation"]}, + {"label": _("Orders"), "items": ["Purchase Order", "Purchase Receipt", "Purchase Invoice"]}, + {"label": _("Payments"), "items": ["Payment Entry", "Bank Account"]}, + {"label": _("Pricing"), "items": ["Pricing Rule"]}, + ], } diff --git a/erpnext/buying/doctype/supplier/test_supplier.py b/erpnext/buying/doctype/supplier/test_supplier.py index 13fe9df13ee..b3cb0e82bdd 100644 --- a/erpnext/buying/doctype/supplier/test_supplier.py +++ b/erpnext/buying/doctype/supplier/test_supplier.py @@ -1,164 +1,172 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt -import unittest import frappe from frappe.test_runner import make_test_records +from frappe.tests.utils import FrappeTestCase from erpnext.accounts.party import get_due_date from erpnext.exceptions import PartyDisabled -test_dependencies = ['Payment Term', 'Payment Terms Template'] -test_records = frappe.get_test_records('Supplier') +test_dependencies = ["Payment Term", "Payment Terms Template"] +test_records = frappe.get_test_records("Supplier") -class TestSupplier(unittest.TestCase): - def test_get_supplier_group_details(self): - doc = frappe.new_doc("Supplier Group") - doc.supplier_group_name = "_Testing Supplier Group" - doc.payment_terms = "_Test Payment Term Template 3" - doc.accounts = [] - test_account_details = { - "company": "_Test Company", - "account": "Creditors - _TC", - } - doc.append("accounts", test_account_details) - doc.save() - s_doc = frappe.new_doc("Supplier") - s_doc.supplier_name = "Testing Supplier" - s_doc.supplier_group = "_Testing Supplier Group" - s_doc.payment_terms = "" - s_doc.accounts = [] - s_doc.insert() - s_doc.get_supplier_group_details() - self.assertEqual(s_doc.payment_terms, "_Test Payment Term Template 3") - self.assertEqual(s_doc.accounts[0].company, "_Test Company") - self.assertEqual(s_doc.accounts[0].account, "Creditors - _TC") - s_doc.delete() - doc.delete() +class TestSupplier(FrappeTestCase): + def test_get_supplier_group_details(self): + doc = frappe.new_doc("Supplier Group") + doc.supplier_group_name = "_Testing Supplier Group" + doc.payment_terms = "_Test Payment Term Template 3" + doc.accounts = [] + test_account_details = { + "company": "_Test Company", + "account": "Creditors - _TC", + } + doc.append("accounts", test_account_details) + doc.save() + s_doc = frappe.new_doc("Supplier") + s_doc.supplier_name = "Testing Supplier" + s_doc.supplier_group = "_Testing Supplier Group" + s_doc.payment_terms = "" + s_doc.accounts = [] + s_doc.insert() + s_doc.get_supplier_group_details() + self.assertEqual(s_doc.payment_terms, "_Test Payment Term Template 3") + self.assertEqual(s_doc.accounts[0].company, "_Test Company") + self.assertEqual(s_doc.accounts[0].account, "Creditors - _TC") + s_doc.delete() + doc.delete() - def test_supplier_default_payment_terms(self): - # Payment Term based on Days after invoice date - frappe.db.set_value( - "Supplier", "_Test Supplier With Template 1", "payment_terms", "_Test Payment Term Template 3") + def test_supplier_default_payment_terms(self): + # Payment Term based on Days after invoice date + frappe.db.set_value( + "Supplier", "_Test Supplier With Template 1", "payment_terms", "_Test Payment Term Template 3" + ) - due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier With Template 1") - self.assertEqual(due_date, "2016-02-21") + due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier With Template 1") + self.assertEqual(due_date, "2016-02-21") - due_date = get_due_date("2017-01-22", "Supplier", "_Test Supplier With Template 1") - self.assertEqual(due_date, "2017-02-21") + due_date = get_due_date("2017-01-22", "Supplier", "_Test Supplier With Template 1") + self.assertEqual(due_date, "2017-02-21") - # Payment Term based on last day of month - frappe.db.set_value( - "Supplier", "_Test Supplier With Template 1", "payment_terms", "_Test Payment Term Template 1") + # Payment Term based on last day of month + frappe.db.set_value( + "Supplier", "_Test Supplier With Template 1", "payment_terms", "_Test Payment Term Template 1" + ) - due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier With Template 1") - self.assertEqual(due_date, "2016-02-29") + due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier With Template 1") + self.assertEqual(due_date, "2016-02-29") - due_date = get_due_date("2017-01-22", "Supplier", "_Test Supplier With Template 1") - self.assertEqual(due_date, "2017-02-28") + due_date = get_due_date("2017-01-22", "Supplier", "_Test Supplier With Template 1") + self.assertEqual(due_date, "2017-02-28") - frappe.db.set_value("Supplier", "_Test Supplier With Template 1", "payment_terms", "") + frappe.db.set_value("Supplier", "_Test Supplier With Template 1", "payment_terms", "") - # Set credit limit for the supplier group instead of supplier and evaluate the due date - frappe.db.set_value("Supplier Group", "_Test Supplier Group", "payment_terms", "_Test Payment Term Template 3") + # Set credit limit for the supplier group instead of supplier and evaluate the due date + frappe.db.set_value( + "Supplier Group", "_Test Supplier Group", "payment_terms", "_Test Payment Term Template 3" + ) - due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier With Template 1") - self.assertEqual(due_date, "2016-02-21") + due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier With Template 1") + self.assertEqual(due_date, "2016-02-21") - # Payment terms for Supplier Group instead of supplier and evaluate the due date - frappe.db.set_value("Supplier Group", "_Test Supplier Group", "payment_terms", "_Test Payment Term Template 1") + # Payment terms for Supplier Group instead of supplier and evaluate the due date + frappe.db.set_value( + "Supplier Group", "_Test Supplier Group", "payment_terms", "_Test Payment Term Template 1" + ) - # Leap year - due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier With Template 1") - self.assertEqual(due_date, "2016-02-29") - # # Non Leap year - due_date = get_due_date("2017-01-22", "Supplier", "_Test Supplier With Template 1") - self.assertEqual(due_date, "2017-02-28") + # Leap year + due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier With Template 1") + self.assertEqual(due_date, "2016-02-29") + # # Non Leap year + due_date = get_due_date("2017-01-22", "Supplier", "_Test Supplier With Template 1") + self.assertEqual(due_date, "2017-02-28") - # Supplier with no default Payment Terms Template - frappe.db.set_value("Supplier Group", "_Test Supplier Group", "payment_terms", "") - frappe.db.set_value("Supplier", "_Test Supplier", "payment_terms", "") + # Supplier with no default Payment Terms Template + frappe.db.set_value("Supplier Group", "_Test Supplier Group", "payment_terms", "") + frappe.db.set_value("Supplier", "_Test Supplier", "payment_terms", "") - due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier") - self.assertEqual(due_date, "2016-01-22") - # # Non Leap year - due_date = get_due_date("2017-01-22", "Supplier", "_Test Supplier") - self.assertEqual(due_date, "2017-01-22") + due_date = get_due_date("2016-01-22", "Supplier", "_Test Supplier") + self.assertEqual(due_date, "2016-01-22") + # # Non Leap year + due_date = get_due_date("2017-01-22", "Supplier", "_Test Supplier") + self.assertEqual(due_date, "2017-01-22") - def test_supplier_disabled(self): - make_test_records("Item") + def test_supplier_disabled(self): + make_test_records("Item") - frappe.db.set_value("Supplier", "_Test Supplier", "disabled", 1) + frappe.db.set_value("Supplier", "_Test Supplier", "disabled", 1) - from erpnext.buying.doctype.purchase_order.test_purchase_order import create_purchase_order + from erpnext.buying.doctype.purchase_order.test_purchase_order import create_purchase_order - po = create_purchase_order(do_not_save=True) + po = create_purchase_order(do_not_save=True) - self.assertRaises(PartyDisabled, po.save) + self.assertRaises(PartyDisabled, po.save) - frappe.db.set_value("Supplier", "_Test Supplier", "disabled", 0) + frappe.db.set_value("Supplier", "_Test Supplier", "disabled", 0) - po.save() + po.save() - def test_supplier_country(self): - # Test that country field exists in Supplier DocType - supplier = frappe.get_doc('Supplier', '_Test Supplier with Country') - self.assertTrue('country' in supplier.as_dict()) + def test_supplier_country(self): + # Test that country field exists in Supplier DocType + supplier = frappe.get_doc("Supplier", "_Test Supplier with Country") + self.assertTrue("country" in supplier.as_dict()) - # Test if test supplier field record is 'Greece' - self.assertEqual(supplier.country, "Greece") + # Test if test supplier field record is 'Greece' + self.assertEqual(supplier.country, "Greece") - # Test update Supplier instance country value - supplier = frappe.get_doc('Supplier', '_Test Supplier') - supplier.country = 'Greece' - supplier.save() - self.assertEqual(supplier.country, "Greece") + # Test update Supplier instance country value + supplier = frappe.get_doc("Supplier", "_Test Supplier") + supplier.country = "Greece" + supplier.save() + self.assertEqual(supplier.country, "Greece") - def test_party_details_tax_category(self): - from erpnext.accounts.party import get_party_details + def test_party_details_tax_category(self): + from erpnext.accounts.party import get_party_details - frappe.delete_doc_if_exists("Address", "_Test Address With Tax Category-Billing") + frappe.delete_doc_if_exists("Address", "_Test Address With Tax Category-Billing") - # Tax Category without Address - details = get_party_details("_Test Supplier With Tax Category", party_type="Supplier") - self.assertEqual(details.tax_category, "_Test Tax Category 1") + # Tax Category without Address + details = get_party_details("_Test Supplier With Tax Category", party_type="Supplier") + self.assertEqual(details.tax_category, "_Test Tax Category 1") - address = frappe.get_doc(dict( - doctype='Address', - address_title='_Test Address With Tax Category', - tax_category='_Test Tax Category 2', - address_type='Billing', - address_line1='Station Road', - city='_Test City', - country='India', - links=[dict( - link_doctype='Supplier', - link_name='_Test Supplier With Tax Category' - )] - )).insert() + address = frappe.get_doc( + dict( + doctype="Address", + address_title="_Test Address With Tax Category", + tax_category="_Test Tax Category 2", + address_type="Billing", + address_line1="Station Road", + city="_Test City", + country="India", + links=[dict(link_doctype="Supplier", link_name="_Test Supplier With Tax Category")], + ) + ).insert() - # Tax Category with Address - details = get_party_details("_Test Supplier With Tax Category", party_type="Supplier") - self.assertEqual(details.tax_category, "_Test Tax Category 2") + # Tax Category with Address + details = get_party_details("_Test Supplier With Tax Category", party_type="Supplier") + self.assertEqual(details.tax_category, "_Test Tax Category 2") + + # Rollback + address.delete() - # Rollback - address.delete() def create_supplier(**args): - args = frappe._dict(args) + args = frappe._dict(args) - try: - doc = frappe.get_doc({ - "doctype": "Supplier", - "supplier_name": args.supplier_name, - "supplier_group": args.supplier_group or "Services", - "supplier_type": args.supplier_type or "Company", - "tax_withholding_category": args.tax_withholding_category - }).insert() + try: + doc = frappe.get_doc( + { + "doctype": "Supplier", + "supplier_name": args.supplier_name, + "supplier_group": args.supplier_group or "Services", + "supplier_type": args.supplier_type or "Company", + "tax_withholding_category": args.tax_withholding_category, + } + ).insert() - return doc + return doc - except frappe.DuplicateEntryError: - return frappe.get_doc("Supplier", args.supplier_name) + except frappe.DuplicateEntryError: + return frappe.get_doc("Supplier", args.supplier_name) diff --git a/erpnext/buying/doctype/supplier_quotation/supplier_quotation.json b/erpnext/buying/doctype/supplier_quotation/supplier_quotation.json index 023c95d697d..567e41fb61f 100644 --- a/erpnext/buying/doctype/supplier_quotation/supplier_quotation.json +++ b/erpnext/buying/doctype/supplier_quotation/supplier_quotation.json @@ -72,8 +72,8 @@ "section_break_46", "base_grand_total", "base_rounding_adjustment", - "base_in_words", "base_rounded_total", + "base_in_words", "column_break4", "grand_total", "rounding_adjustment", @@ -635,6 +635,7 @@ "fieldname": "rounded_total", "fieldtype": "Currency", "label": "Rounded Total", + "options": "currency", "read_only": 1 }, { @@ -810,7 +811,7 @@ "index_web_pages_for_search": 1, "is_submittable": 1, "links": [], - "modified": "2021-12-11 06:43:20.924080", + "modified": "2022-03-14 16:13:20.284572", "modified_by": "Administrator", "module": "Buying", "name": "Supplier Quotation", @@ -875,6 +876,7 @@ "show_name_in_global_search": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "timeline_field": "supplier", "title_field": "title" } \ No newline at end of file diff --git a/erpnext/buying/doctype/supplier_quotation/supplier_quotation.py b/erpnext/buying/doctype/supplier_quotation/supplier_quotation.py index d65ab94a6d3..78f3317bb42 100644 --- a/erpnext/buying/doctype/supplier_quotation/supplier_quotation.py +++ b/erpnext/buying/doctype/supplier_quotation/supplier_quotation.py @@ -10,9 +10,8 @@ from frappe.utils import flt, getdate, nowdate from erpnext.buying.utils import validate_for_items from erpnext.controllers.buying_controller import BuyingController -form_grid_templates = { - "items": "templates/form_grid/item_grid.html" -} +form_grid_templates = {"items": "templates/form_grid/item_grid.html"} + class SupplierQuotation(BuyingController): def validate(self): @@ -22,8 +21,8 @@ class SupplierQuotation(BuyingController): self.status = "Draft" from erpnext.controllers.status_updater import validate_status - validate_status(self.status, ["Draft", "Submitted", "Stopped", - "Cancelled"]) + + validate_status(self.status, ["Draft", "Submitted", "Stopped", "Cancelled"]) validate_for_items(self) self.validate_with_previous_doc() @@ -42,17 +41,19 @@ class SupplierQuotation(BuyingController): pass def validate_with_previous_doc(self): - super(SupplierQuotation, self).validate_with_previous_doc({ - "Material Request": { - "ref_dn_field": "prevdoc_docname", - "compare_fields": [["company", "="]], - }, - "Material Request Item": { - "ref_dn_field": "prevdoc_detail_docname", - "compare_fields": [["item_code", "="], ["uom", "="]], - "is_child_table": True + super(SupplierQuotation, self).validate_with_previous_doc( + { + "Material Request": { + "ref_dn_field": "prevdoc_docname", + "compare_fields": [["company", "="]], + }, + "Material Request Item": { + "ref_dn_field": "prevdoc_detail_docname", + "compare_fields": [["item_code", "="], ["uom", "="]], + "is_child_table": True, + }, } - }) + ) def validate_valid_till(self): if self.valid_till and getdate(self.valid_till) < getdate(self.transaction_date): @@ -64,18 +65,28 @@ class SupplierQuotation(BuyingController): if item.request_for_quotation: rfq_list.add(item.request_for_quotation) for rfq in rfq_list: - doc = frappe.get_doc('Request for Quotation', rfq) - doc_sup = frappe.get_all('Request for Quotation Supplier', filters= - {'parent': doc.name, 'supplier': self.supplier}, fields=['name', 'quote_status']) + doc = frappe.get_doc("Request for Quotation", rfq) + doc_sup = frappe.get_all( + "Request for Quotation Supplier", + filters={"parent": doc.name, "supplier": self.supplier}, + fields=["name", "quote_status"], + ) doc_sup = doc_sup[0] if doc_sup else None if not doc_sup: - frappe.throw(_("Supplier {0} not found in {1}").format(self.supplier, - " Request for Quotation {0} ".format(doc.name))) + frappe.throw( + _("Supplier {0} not found in {1}").format( + self.supplier, + " Request for Quotation {0} ".format( + doc.name + ), + ) + ) - quote_status = _('Received') + quote_status = _("Received") for item in doc.items: - sqi_count = frappe.db.sql(""" + sqi_count = frappe.db.sql( + """ SELECT COUNT(sqi.name) as count FROM @@ -86,30 +97,41 @@ class SupplierQuotation(BuyingController): AND sq.name != %(me)s AND sqi.request_for_quotation_item = %(rqi)s AND sqi.parent = sq.name""", - {"supplier": self.supplier, "rqi": item.name, 'me': self.name}, as_dict=1)[0] - self_count = sum(my_item.request_for_quotation_item == item.name - for my_item in self.items) if include_me else 0 + {"supplier": self.supplier, "rqi": item.name, "me": self.name}, + as_dict=1, + )[0] + self_count = ( + sum(my_item.request_for_quotation_item == item.name for my_item in self.items) + if include_me + else 0 + ) if (sqi_count.count + self_count) == 0: - quote_status = _('Pending') + quote_status = _("Pending") + + frappe.db.set_value( + "Request for Quotation Supplier", doc_sup.name, "quote_status", quote_status + ) - frappe.db.set_value('Request for Quotation Supplier', doc_sup.name, 'quote_status', quote_status) def get_list_context(context=None): from erpnext.controllers.website_list_for_contact import get_list_context + list_context = get_list_context(context) - list_context.update({ - 'show_sidebar': True, - 'show_search': True, - 'no_breadcrumbs': True, - 'title': _('Supplier Quotation'), - }) + list_context.update( + { + "show_sidebar": True, + "show_search": True, + "no_breadcrumbs": True, + "title": _("Supplier Quotation"), + } + ) return list_context + @frappe.whitelist() def make_purchase_order(source_name, target_doc=None): def set_missing_values(source, target): - target.ignore_pricing_rule = 1 target.run_method("set_missing_values") target.run_method("get_schedule_dates") target.run_method("calculate_taxes_and_totals") @@ -117,53 +139,70 @@ def make_purchase_order(source_name, target_doc=None): def update_item(obj, target, source_parent): target.stock_qty = flt(obj.qty) * flt(obj.conversion_factor) - doclist = get_mapped_doc("Supplier Quotation", source_name, { - "Supplier Quotation": { - "doctype": "Purchase Order", - "validation": { - "docstatus": ["=", 1], - } + doclist = get_mapped_doc( + "Supplier Quotation", + source_name, + { + "Supplier Quotation": { + "doctype": "Purchase Order", + "validation": { + "docstatus": ["=", 1], + }, + }, + "Supplier Quotation Item": { + "doctype": "Purchase Order Item", + "field_map": [ + ["name", "supplier_quotation_item"], + ["parent", "supplier_quotation"], + ["material_request", "material_request"], + ["material_request_item", "material_request_item"], + ["sales_order", "sales_order"], + ], + "postprocess": update_item, + }, + "Purchase Taxes and Charges": { + "doctype": "Purchase Taxes and Charges", + }, }, - "Supplier Quotation Item": { - "doctype": "Purchase Order Item", - "field_map": [ - ["name", "supplier_quotation_item"], - ["parent", "supplier_quotation"], - ["material_request", "material_request"], - ["material_request_item", "material_request_item"], - ["sales_order", "sales_order"] - ], - "postprocess": update_item - }, - "Purchase Taxes and Charges": { - "doctype": "Purchase Taxes and Charges", - }, - }, target_doc, set_missing_values) + target_doc, + set_missing_values, + ) + doclist.set_onload("ignore_price_list", True) return doclist + @frappe.whitelist() def make_quotation(source_name, target_doc=None): - doclist = get_mapped_doc("Supplier Quotation", source_name, { - "Supplier Quotation": { - "doctype": "Quotation", - "field_map": { - "name": "supplier_quotation", - } + doclist = get_mapped_doc( + "Supplier Quotation", + source_name, + { + "Supplier Quotation": { + "doctype": "Quotation", + "field_map": { + "name": "supplier_quotation", + }, + }, + "Supplier Quotation Item": { + "doctype": "Quotation Item", + "condition": lambda doc: frappe.db.get_value("Item", doc.item_code, "is_sales_item") == 1, + "add_if_empty": True, + }, }, - "Supplier Quotation Item": { - "doctype": "Quotation Item", - "condition": lambda doc: frappe.db.get_value("Item", doc.item_code, "is_sales_item")==1, - "add_if_empty": True - } - }, target_doc) + target_doc, + ) return doclist + def set_expired_status(): - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabSupplier Quotation` SET `status` = 'Expired' WHERE `status` not in ('Cancelled', 'Stopped') AND `valid_till` < %s - """, (nowdate())) + """, + (nowdate()), + ) diff --git a/erpnext/buying/doctype/supplier_quotation/supplier_quotation_dashboard.py b/erpnext/buying/doctype/supplier_quotation/supplier_quotation_dashboard.py index 1680efc53c7..369fc94deee 100644 --- a/erpnext/buying/doctype/supplier_quotation/supplier_quotation_dashboard.py +++ b/erpnext/buying/doctype/supplier_quotation/supplier_quotation_dashboard.py @@ -1,31 +1,18 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'supplier_quotation', - 'non_standard_fieldnames': { - 'Auto Repeat': 'reference_document' + "fieldname": "supplier_quotation", + "non_standard_fieldnames": {"Auto Repeat": "reference_document"}, + "internal_links": { + "Material Request": ["items", "material_request"], + "Request for Quotation": ["items", "request_for_quotation"], + "Project": ["items", "project"], }, - 'internal_links': { - 'Material Request': ['items', 'material_request'], - 'Request for Quotation': ['items', 'request_for_quotation'], - 'Project': ['items', 'project'], - }, - 'transactions': [ - { - 'label': _('Related'), - 'items': ['Purchase Order', 'Quotation'] - }, - { - 'label': _('Reference'), - 'items': ['Material Request', 'Request for Quotation', 'Project'] - }, - { - 'label': _('Subscription'), - 'items': ['Auto Repeat'] - }, - ] - + "transactions": [ + {"label": _("Related"), "items": ["Purchase Order", "Quotation"]}, + {"label": _("Reference"), "items": ["Material Request", "Request for Quotation", "Project"]}, + {"label": _("Subscription"), "items": ["Auto Repeat"]}, + ], } diff --git a/erpnext/buying/doctype/supplier_quotation/test_supplier_quotation.py b/erpnext/buying/doctype/supplier_quotation/test_supplier_quotation.py index d48ac7eb3b4..13c851c7353 100644 --- a/erpnext/buying/doctype/supplier_quotation/test_supplier_quotation.py +++ b/erpnext/buying/doctype/supplier_quotation/test_supplier_quotation.py @@ -2,20 +2,17 @@ # License: GNU General Public License v3. See license.txt - -import unittest - import frappe +from frappe.tests.utils import FrappeTestCase -class TestPurchaseOrder(unittest.TestCase): +class TestPurchaseOrder(FrappeTestCase): def test_make_purchase_order(self): from erpnext.buying.doctype.supplier_quotation.supplier_quotation import make_purchase_order sq = frappe.copy_doc(test_records[0]).insert() - self.assertRaises(frappe.ValidationError, make_purchase_order, - sq.name) + self.assertRaises(frappe.ValidationError, make_purchase_order, sq.name) sq = frappe.get_doc("Supplier Quotation", sq.name) sq.submit() @@ -32,4 +29,5 @@ class TestPurchaseOrder(unittest.TestCase): po.insert() -test_records = frappe.get_test_records('Supplier Quotation') + +test_records = frappe.get_test_records("Supplier Quotation") diff --git a/erpnext/buying/doctype/supplier_scorecard/supplier_scorecard.py b/erpnext/buying/doctype/supplier_scorecard/supplier_scorecard.py index 3bcc0debae9..992bc805a55 100644 --- a/erpnext/buying/doctype/supplier_scorecard/supplier_scorecard.py +++ b/erpnext/buying/doctype/supplier_scorecard/supplier_scorecard.py @@ -16,7 +16,6 @@ from erpnext.buying.doctype.supplier_scorecard_period.supplier_scorecard_period class SupplierScorecard(Document): - def validate(self): self.validate_standings() self.validate_criteria_weights() @@ -34,12 +33,16 @@ class SupplierScorecard(Document): for c1 in self.standings: for c2 in self.standings: if c1 != c2: - if (c1.max_grade > c2.min_grade and c1.min_grade < c2.max_grade): - throw(_('Overlap in scoring between {0} and {1}').format(c1.standing_name,c2.standing_name)) + if c1.max_grade > c2.min_grade and c1.min_grade < c2.max_grade: + throw(_("Overlap in scoring between {0} and {1}").format(c1.standing_name, c2.standing_name)) if c2.min_grade == score: score = c2.max_grade if score < 100: - throw(_('Unable to find score starting at {0}. You need to have standing scores covering 0 to 100').format(score)) + throw( + _( + "Unable to find score starting at {0}. You need to have standing scores covering 0 to 100" + ).format(score) + ) def validate_criteria_weights(self): @@ -48,10 +51,11 @@ class SupplierScorecard(Document): weight += c.weight if weight != 100: - throw(_('Criteria weights must add up to 100%')) + throw(_("Criteria weights must add up to 100%")) def calculate_total_score(self): - scorecards = frappe.db.sql(""" + scorecards = frappe.db.sql( + """ SELECT scp.name FROM @@ -61,18 +65,20 @@ class SupplierScorecard(Document): AND scp.docstatus = 1 ORDER BY scp.end_date DESC""", - {"sc": self.name}, as_dict=1) + {"sc": self.name}, + as_dict=1, + ) period = 0 total_score = 0 total_max_score = 0 for scp in scorecards: - my_sc = frappe.get_doc('Supplier Scorecard Period', scp.name) + my_sc = frappe.get_doc("Supplier Scorecard Period", scp.name) my_scp_weight = self.weighting_function - my_scp_weight = my_scp_weight.replace('{period_number}', str(period)) + my_scp_weight = my_scp_weight.replace("{period_number}", str(period)) - my_scp_maxweight = my_scp_weight.replace('{total_score}', '100') - my_scp_weight = my_scp_weight.replace('{total_score}', str(my_sc.total_score)) + my_scp_maxweight = my_scp_weight.replace("{total_score}", "100") + my_scp_weight = my_scp_weight.replace("{total_score}", str(my_sc.total_score)) max_score = my_sc.calculate_weighted_score(my_scp_maxweight) score = my_sc.calculate_weighted_score(my_scp_weight) @@ -81,24 +87,25 @@ class SupplierScorecard(Document): total_max_score += max_score period += 1 if total_max_score > 0: - self.supplier_score = round(100.0 * (total_score / total_max_score) ,1) + self.supplier_score = round(100.0 * (total_score / total_max_score), 1) else: - self.supplier_score = 100 + self.supplier_score = 100 def update_standing(self): # Get the setup document for standing in self.standings: - if (not standing.min_grade or (standing.min_grade <= self.supplier_score)) and \ - (not standing.max_grade or (standing.max_grade > self.supplier_score)): + if (not standing.min_grade or (standing.min_grade <= self.supplier_score)) and ( + not standing.max_grade or (standing.max_grade > self.supplier_score) + ): self.status = standing.standing_name self.indicator_color = standing.standing_color self.notify_supplier = standing.notify_supplier self.notify_employee = standing.notify_employee self.employee_link = standing.employee_link - #Update supplier standing info - for fieldname in ('prevent_pos', 'prevent_rfqs','warn_rfqs','warn_pos'): + # Update supplier standing info + for fieldname in ("prevent_pos", "prevent_rfqs", "warn_rfqs", "warn_pos"): self.set(fieldname, standing.get(fieldname)) frappe.db.set_value("Supplier", self.supplier, fieldname, self.get(fieldname)) @@ -109,7 +116,8 @@ def get_timeline_data(doctype, name): scs = frappe.get_doc(doctype, name) out = {} timeline_data = {} - scorecards = frappe.db.sql(""" + scorecards = frappe.db.sql( + """ SELECT sc.name FROM @@ -117,39 +125,48 @@ def get_timeline_data(doctype, name): WHERE sc.scorecard = %(scs)s AND sc.docstatus = 1""", - {"scs": scs.name}, as_dict=1) + {"scs": scs.name}, + as_dict=1, + ) for sc in scorecards: - start_date, end_date, total_score = frappe.db.get_value('Supplier Scorecard Period', sc.name, ['start_date', 'end_date', 'total_score']) + start_date, end_date, total_score = frappe.db.get_value( + "Supplier Scorecard Period", sc.name, ["start_date", "end_date", "total_score"] + ) for single_date in daterange(start_date, end_date): - timeline_data[time.mktime(single_date.timetuple())] = total_score + timeline_data[time.mktime(single_date.timetuple())] = total_score - out['timeline_data'] = timeline_data + out["timeline_data"] = timeline_data return out + def daterange(start_date, end_date): - for n in range(int ((end_date - start_date).days)+1): - yield start_date + timedelta(n) + for n in range(int((end_date - start_date).days) + 1): + yield start_date + timedelta(n) + def refresh_scorecards(): - scorecards = frappe.db.sql(""" + scorecards = frappe.db.sql( + """ SELECT sc.name FROM `tabSupplier Scorecard` sc""", - {}, as_dict=1) + {}, + as_dict=1, + ) for sc in scorecards: # Check to see if any new scorecard periods are created if make_all_scorecards(sc.name) > 0: # Save the scorecard to update the score and standings - frappe.get_doc('Supplier Scorecard', sc.name).save() + frappe.get_doc("Supplier Scorecard", sc.name).save() @frappe.whitelist() def make_all_scorecards(docname): - sc = frappe.get_doc('Supplier Scorecard', docname) - supplier = frappe.get_doc('Supplier',sc.supplier) + sc = frappe.get_doc("Supplier Scorecard", docname) + supplier = frappe.get_doc("Supplier", sc.supplier) start_date = getdate(supplier.creation) end_date = get_scorecard_date(sc.period, start_date) @@ -161,7 +178,8 @@ def make_all_scorecards(docname): while (start_date < todays) and (end_date <= todays): # check to make sure there is no scorecard period already created - scorecards = frappe.db.sql(""" + scorecards = frappe.db.sql( + """ SELECT scp.name FROM @@ -177,7 +195,9 @@ def make_all_scorecards(docname): AND scp.end_date > %(start_date)s)) ORDER BY scp.end_date DESC""", - {"sc": docname, "start_date": start_date, "end_date": end_date}, as_dict=1) + {"sc": docname, "start_date": start_date, "end_date": end_date}, + as_dict=1, + ) if len(scorecards) == 0: period_card = make_supplier_scorecard(docname, None) period_card.start_date = start_date @@ -189,82 +209,178 @@ def make_all_scorecards(docname): first_start_date = start_date last_end_date = end_date - start_date = getdate(add_days(end_date,1)) + start_date = getdate(add_days(end_date, 1)) end_date = get_scorecard_date(sc.period, start_date) if scp_count > 0: - frappe.msgprint(_("Created {0} scorecards for {1} between: ").format(scp_count, sc.supplier) + str(first_start_date) + " - " + str(last_end_date)) + frappe.msgprint( + _("Created {0} scorecards for {1} between: ").format(scp_count, sc.supplier) + + str(first_start_date) + + " - " + + str(last_end_date) + ) return scp_count + def get_scorecard_date(period, start_date): - if period == 'Per Week': - end_date = getdate(add_days(start_date,7)) - elif period == 'Per Month': + if period == "Per Week": + end_date = getdate(add_days(start_date, 7)) + elif period == "Per Month": end_date = get_last_day(start_date) - elif period == 'Per Year': - end_date = add_days(add_years(start_date,1), -1) + elif period == "Per Year": + end_date = add_days(add_years(start_date, 1), -1) return end_date + def make_default_records(): install_variable_docs = [ - {"param_name": "total_accepted_items", "variable_label": "Total Accepted Items", \ - "path": "get_total_accepted_items"}, - {"param_name": "total_accepted_amount", "variable_label": "Total Accepted Amount", \ - "path": "get_total_accepted_amount"}, - {"param_name": "total_rejected_items", "variable_label": "Total Rejected Items", \ - "path": "get_total_rejected_items"}, - {"param_name": "total_rejected_amount", "variable_label": "Total Rejected Amount", \ - "path": "get_total_rejected_amount"}, - {"param_name": "total_received_items", "variable_label": "Total Received Items", \ - "path": "get_total_received_items"}, - {"param_name": "total_received_amount", "variable_label": "Total Received Amount", \ - "path": "get_total_received_amount"}, - {"param_name": "rfq_response_days", "variable_label": "RFQ Response Days", \ - "path": "get_rfq_response_days"}, - {"param_name": "sq_total_items", "variable_label": "SQ Total Items", \ - "path": "get_sq_total_items"}, - {"param_name": "sq_total_number", "variable_label": "SQ Total Number", \ - "path": "get_sq_total_number"}, - {"param_name": "rfq_total_number", "variable_label": "RFQ Total Number", \ - "path": "get_rfq_total_number"}, - {"param_name": "rfq_total_items", "variable_label": "RFQ Total Items", \ - "path": "get_rfq_total_items"}, - {"param_name": "tot_item_days", "variable_label": "Total Item Days", \ - "path": "get_item_workdays"}, - {"param_name": "on_time_shipment_num", "variable_label": "# of On Time Shipments", "path": \ - "get_on_time_shipments"}, - {"param_name": "cost_of_delayed_shipments", "variable_label": "Cost of Delayed Shipments", \ - "path": "get_cost_of_delayed_shipments"}, - {"param_name": "cost_of_on_time_shipments", "variable_label": "Cost of On Time Shipments", \ - "path": "get_cost_of_on_time_shipments"}, - {"param_name": "total_working_days", "variable_label": "Total Working Days", \ - "path": "get_total_workdays"}, - {"param_name": "tot_cost_shipments", "variable_label": "Total Cost of Shipments", \ - "path": "get_total_cost_of_shipments"}, - {"param_name": "tot_days_late", "variable_label": "Total Days Late", \ - "path": "get_total_days_late"}, - {"param_name": "total_shipments", "variable_label": "Total Shipments", \ - "path": "get_total_shipments"} + { + "param_name": "total_accepted_items", + "variable_label": "Total Accepted Items", + "path": "get_total_accepted_items", + }, + { + "param_name": "total_accepted_amount", + "variable_label": "Total Accepted Amount", + "path": "get_total_accepted_amount", + }, + { + "param_name": "total_rejected_items", + "variable_label": "Total Rejected Items", + "path": "get_total_rejected_items", + }, + { + "param_name": "total_rejected_amount", + "variable_label": "Total Rejected Amount", + "path": "get_total_rejected_amount", + }, + { + "param_name": "total_received_items", + "variable_label": "Total Received Items", + "path": "get_total_received_items", + }, + { + "param_name": "total_received_amount", + "variable_label": "Total Received Amount", + "path": "get_total_received_amount", + }, + { + "param_name": "rfq_response_days", + "variable_label": "RFQ Response Days", + "path": "get_rfq_response_days", + }, + { + "param_name": "sq_total_items", + "variable_label": "SQ Total Items", + "path": "get_sq_total_items", + }, + { + "param_name": "sq_total_number", + "variable_label": "SQ Total Number", + "path": "get_sq_total_number", + }, + { + "param_name": "rfq_total_number", + "variable_label": "RFQ Total Number", + "path": "get_rfq_total_number", + }, + { + "param_name": "rfq_total_items", + "variable_label": "RFQ Total Items", + "path": "get_rfq_total_items", + }, + { + "param_name": "tot_item_days", + "variable_label": "Total Item Days", + "path": "get_item_workdays", + }, + { + "param_name": "on_time_shipment_num", + "variable_label": "# of On Time Shipments", + "path": "get_on_time_shipments", + }, + { + "param_name": "cost_of_delayed_shipments", + "variable_label": "Cost of Delayed Shipments", + "path": "get_cost_of_delayed_shipments", + }, + { + "param_name": "cost_of_on_time_shipments", + "variable_label": "Cost of On Time Shipments", + "path": "get_cost_of_on_time_shipments", + }, + { + "param_name": "total_working_days", + "variable_label": "Total Working Days", + "path": "get_total_workdays", + }, + { + "param_name": "tot_cost_shipments", + "variable_label": "Total Cost of Shipments", + "path": "get_total_cost_of_shipments", + }, + { + "param_name": "tot_days_late", + "variable_label": "Total Days Late", + "path": "get_total_days_late", + }, + { + "param_name": "total_shipments", + "variable_label": "Total Shipments", + "path": "get_total_shipments", + }, ] install_standing_docs = [ - {"min_grade": 0.0, "prevent_rfqs": 1, "notify_supplier": 0, "max_grade": 30.0, "prevent_pos": 1, \ - "standing_color": "Red", "notify_employee": 0, "standing_name": "Very Poor"}, - {"min_grade": 30.0, "prevent_rfqs": 1, "notify_supplier": 0, "max_grade": 50.0, "prevent_pos": 0, \ - "standing_color": "Red", "notify_employee": 0, "standing_name": "Poor"}, - {"min_grade": 50.0, "prevent_rfqs": 0, "notify_supplier": 0, "max_grade": 80.0, "prevent_pos": 0, \ - "standing_color": "Green", "notify_employee": 0, "standing_name": "Average"}, - {"min_grade": 80.0, "prevent_rfqs": 0, "notify_supplier": 0, "max_grade": 100.0, "prevent_pos": 0, \ - "standing_color": "Blue", "notify_employee": 0, "standing_name": "Excellent"}, + { + "min_grade": 0.0, + "prevent_rfqs": 1, + "notify_supplier": 0, + "max_grade": 30.0, + "prevent_pos": 1, + "standing_color": "Red", + "notify_employee": 0, + "standing_name": "Very Poor", + }, + { + "min_grade": 30.0, + "prevent_rfqs": 1, + "notify_supplier": 0, + "max_grade": 50.0, + "prevent_pos": 0, + "standing_color": "Red", + "notify_employee": 0, + "standing_name": "Poor", + }, + { + "min_grade": 50.0, + "prevent_rfqs": 0, + "notify_supplier": 0, + "max_grade": 80.0, + "prevent_pos": 0, + "standing_color": "Green", + "notify_employee": 0, + "standing_name": "Average", + }, + { + "min_grade": 80.0, + "prevent_rfqs": 0, + "notify_supplier": 0, + "max_grade": 100.0, + "prevent_pos": 0, + "standing_color": "Blue", + "notify_employee": 0, + "standing_name": "Excellent", + }, ] for d in install_variable_docs: try: - d['doctype'] = "Supplier Scorecard Variable" + d["doctype"] = "Supplier Scorecard Variable" frappe.get_doc(d).insert() except frappe.NameError: pass for d in install_standing_docs: try: - d['doctype'] = "Supplier Scorecard Standing" + d["doctype"] = "Supplier Scorecard Standing" frappe.get_doc(d).insert() except frappe.NameError: pass diff --git a/erpnext/buying/doctype/supplier_scorecard/supplier_scorecard_dashboard.py b/erpnext/buying/doctype/supplier_scorecard/supplier_scorecard_dashboard.py index e021c9c6be1..e3557bd0d81 100644 --- a/erpnext/buying/doctype/supplier_scorecard/supplier_scorecard_dashboard.py +++ b/erpnext/buying/doctype/supplier_scorecard/supplier_scorecard_dashboard.py @@ -1,17 +1,11 @@ - from frappe import _ def get_data(): return { - 'heatmap': True, - 'heatmap_message': _('This covers all scorecards tied to this Setup'), - 'fieldname': 'supplier', - 'method' : 'erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.get_timeline_data', - 'transactions': [ - { - 'label': _('Scorecards'), - 'items': ['Supplier Scorecard Period'] - } - ] + "heatmap": True, + "heatmap_message": _("This covers all scorecards tied to this Setup"), + "fieldname": "supplier", + "method": "erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.get_timeline_data", + "transactions": [{"label": _("Scorecards"), "items": ["Supplier Scorecard Period"]}], } diff --git a/erpnext/buying/doctype/supplier_scorecard/test_supplier_scorecard.py b/erpnext/buying/doctype/supplier_scorecard/test_supplier_scorecard.py index 49e33517e6f..2694f96fbe3 100644 --- a/erpnext/buying/doctype/supplier_scorecard/test_supplier_scorecard.py +++ b/erpnext/buying/doctype/supplier_scorecard/test_supplier_scorecard.py @@ -1,13 +1,12 @@ # Copyright (c) 2017, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt -import unittest import frappe +from frappe.tests.utils import FrappeTestCase -class TestSupplierScorecard(unittest.TestCase): - +class TestSupplierScorecard(FrappeTestCase): def test_create_scorecard(self): doc = make_supplier_scorecard().insert() self.assertEqual(doc.name, valid_scorecard[0].get("supplier")) @@ -17,7 +16,8 @@ class TestSupplierScorecard(unittest.TestCase): my_doc = make_supplier_scorecard() for d in my_doc.criteria: d.weight = 0 - self.assertRaises(frappe.ValidationError,my_doc.insert) + self.assertRaises(frappe.ValidationError, my_doc.insert) + def make_supplier_scorecard(): my_doc = frappe.get_doc(valid_scorecard[0]) @@ -36,95 +36,106 @@ def delete_test_scorecards(): my_doc = make_supplier_scorecard() if frappe.db.exists("Supplier Scorecard", my_doc.name): # Delete all the periods, then delete the scorecard - frappe.db.sql("""delete from `tabSupplier Scorecard Period` where scorecard = %(scorecard)s""", {'scorecard': my_doc.name}) - frappe.db.sql("""delete from `tabSupplier Scorecard Scoring Criteria` where parenttype = 'Supplier Scorecard Period'""") - frappe.db.sql("""delete from `tabSupplier Scorecard Scoring Standing` where parenttype = 'Supplier Scorecard Period'""") - frappe.db.sql("""delete from `tabSupplier Scorecard Scoring Variable` where parenttype = 'Supplier Scorecard Period'""") + frappe.db.sql( + """delete from `tabSupplier Scorecard Period` where scorecard = %(scorecard)s""", + {"scorecard": my_doc.name}, + ) + frappe.db.sql( + """delete from `tabSupplier Scorecard Scoring Criteria` where parenttype = 'Supplier Scorecard Period'""" + ) + frappe.db.sql( + """delete from `tabSupplier Scorecard Scoring Standing` where parenttype = 'Supplier Scorecard Period'""" + ) + frappe.db.sql( + """delete from `tabSupplier Scorecard Scoring Variable` where parenttype = 'Supplier Scorecard Period'""" + ) frappe.delete_doc(my_doc.doctype, my_doc.name) + valid_scorecard = [ { - "standings":[ + "standings": [ { - "min_grade":0.0,"name":"Very Poor", - "prevent_rfqs":1, - "notify_supplier":0, - "doctype":"Supplier Scorecard Standing", - "max_grade":30.0, - "prevent_pos":1, - "warn_pos":0, - "warn_rfqs":0, - "standing_color":"Red", - "notify_employee":0, - "standing_name":"Very Poor", - "parenttype":"Supplier Scorecard", - "parentfield":"standings" + "min_grade": 0.0, + "name": "Very Poor", + "prevent_rfqs": 1, + "notify_supplier": 0, + "doctype": "Supplier Scorecard Scoring Standing", + "max_grade": 30.0, + "prevent_pos": 1, + "warn_pos": 0, + "warn_rfqs": 0, + "standing_color": "Red", + "notify_employee": 0, + "standing_name": "Very Poor", + "parenttype": "Supplier Scorecard", + "parentfield": "standings", }, { - "min_grade":30.0, - "name":"Poor", - "prevent_rfqs":1, - "notify_supplier":0, - "doctype":"Supplier Scorecard Standing", - "max_grade":50.0, - "prevent_pos":0, - "warn_pos":0, - "warn_rfqs":0, - "standing_color":"Red", - "notify_employee":0, - "standing_name":"Poor", - "parenttype":"Supplier Scorecard", - "parentfield":"standings" + "min_grade": 30.0, + "name": "Poor", + "prevent_rfqs": 1, + "notify_supplier": 0, + "doctype": "Supplier Scorecard Scoring Standing", + "max_grade": 50.0, + "prevent_pos": 0, + "warn_pos": 0, + "warn_rfqs": 0, + "standing_color": "Red", + "notify_employee": 0, + "standing_name": "Poor", + "parenttype": "Supplier Scorecard", + "parentfield": "standings", }, { - "min_grade":50.0, - "name":"Average", - "prevent_rfqs":0, - "notify_supplier":0, - "doctype":"Supplier Scorecard Standing", - "max_grade":80.0, - "prevent_pos":0, - "warn_pos":0, - "warn_rfqs":0, - "standing_color":"Green", - "notify_employee":0, - "standing_name":"Average", - "parenttype":"Supplier Scorecard", - "parentfield":"standings" + "min_grade": 50.0, + "name": "Average", + "prevent_rfqs": 0, + "notify_supplier": 0, + "doctype": "Supplier Scorecard Scoring Standing", + "max_grade": 80.0, + "prevent_pos": 0, + "warn_pos": 0, + "warn_rfqs": 0, + "standing_color": "Green", + "notify_employee": 0, + "standing_name": "Average", + "parenttype": "Supplier Scorecard", + "parentfield": "standings", }, { - "min_grade":80.0, - "name":"Excellent", - "prevent_rfqs":0, - "notify_supplier":0, - "doctype":"Supplier Scorecard Standing", - "max_grade":100.0, - "prevent_pos":0, - "warn_pos":0, - "warn_rfqs":0, - "standing_color":"Blue", - "notify_employee":0, - "standing_name":"Excellent", - "parenttype":"Supplier Scorecard", - "parentfield":"standings" + "min_grade": 80.0, + "name": "Excellent", + "prevent_rfqs": 0, + "notify_supplier": 0, + "doctype": "Supplier Scorecard Scoring Standing", + "max_grade": 100.0, + "prevent_pos": 0, + "warn_pos": 0, + "warn_rfqs": 0, + "standing_color": "Blue", + "notify_employee": 0, + "standing_name": "Excellent", + "parenttype": "Supplier Scorecard", + "parentfield": "standings", + }, + ], + "prevent_pos": 0, + "period": "Per Month", + "doctype": "Supplier Scorecard", + "warn_pos": 0, + "warn_rfqs": 0, + "notify_supplier": 0, + "criteria": [ + { + "weight": 100.0, + "doctype": "Supplier Scorecard Scoring Criteria", + "criteria_name": "Delivery", + "formula": "100", } ], - "prevent_pos":0, - "period":"Per Month", - "doctype":"Supplier Scorecard", - "warn_pos":0, - "warn_rfqs":0, - "notify_supplier":0, - "criteria":[ - { - "weight":100.0, - "doctype":"Supplier Scorecard Scoring Criteria", - "criteria_name":"Delivery", - "formula": "100" - } - ], - "supplier":"_Test Supplier", - "name":"_Test Supplier", - "weighting_function":"{total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )" + "supplier": "_Test Supplier", + "name": "_Test Supplier", + "weighting_function": "{total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )", } ] diff --git a/erpnext/buying/doctype/supplier_scorecard_criteria/supplier_scorecard_criteria.py b/erpnext/buying/doctype/supplier_scorecard_criteria/supplier_scorecard_criteria.py index 7cd18c31e8b..130adc97d40 100644 --- a/erpnext/buying/doctype/supplier_scorecard_criteria/supplier_scorecard_criteria.py +++ b/erpnext/buying/doctype/supplier_scorecard_criteria/supplier_scorecard_criteria.py @@ -9,7 +9,9 @@ from frappe import _ from frappe.model.document import Document -class InvalidFormulaVariable(frappe.ValidationError): pass +class InvalidFormulaVariable(frappe.ValidationError): + pass + class SupplierScorecardCriteria(Document): def validate(self): @@ -29,28 +31,34 @@ class SupplierScorecardCriteria(Document): mylist = re.finditer(regex, test_formula, re.MULTILINE | re.DOTALL) for dummy1, match in enumerate(mylist): for dummy2 in range(0, len(match.groups())): - test_formula = test_formula.replace('{' + match.group(1) + '}', "0") + test_formula = test_formula.replace("{" + match.group(1) + "}", "0") try: - frappe.safe_eval(test_formula, None, {'max':max, 'min': min}) + frappe.safe_eval(test_formula, None, {"max": max, "min": min}) except Exception: frappe.throw(_("Error evaluating the criteria formula")) + @frappe.whitelist() def get_criteria_list(): - criteria = frappe.db.sql(""" + criteria = frappe.db.sql( + """ SELECT scs.name FROM `tabSupplier Scorecard Criteria` scs""", - {}, as_dict=1) + {}, + as_dict=1, + ) return criteria + def get_variables(criteria_name): criteria = frappe.get_doc("Supplier Scorecard Criteria", criteria_name) return _get_variables(criteria) + def _get_variables(criteria): my_variables = [] regex = r"\{(.*?)\}" @@ -59,16 +67,19 @@ def _get_variables(criteria): for dummy1, match in enumerate(mylist): for dummy2 in range(0, len(match.groups())): try: - var = frappe.db.sql(""" + var = frappe.db.sql( + """ SELECT scv.variable_label, scv.description, scv.param_name, scv.path FROM `tabSupplier Scorecard Variable` scv WHERE param_name=%(param)s""", - {'param':match.group(1)}, as_dict=1)[0] + {"param": match.group(1)}, + as_dict=1, + )[0] my_variables.append(var) except Exception: - frappe.throw(_('Unable to find variable: ') + str(match.group(1)), InvalidFormulaVariable) + frappe.throw(_("Unable to find variable: ") + str(match.group(1)), InvalidFormulaVariable) return my_variables diff --git a/erpnext/buying/doctype/supplier_scorecard_criteria/test_supplier_scorecard_criteria.py b/erpnext/buying/doctype/supplier_scorecard_criteria/test_supplier_scorecard_criteria.py index dacc982420e..90468d6c168 100644 --- a/erpnext/buying/doctype/supplier_scorecard_criteria/test_supplier_scorecard_criteria.py +++ b/erpnext/buying/doctype/supplier_scorecard_criteria/test_supplier_scorecard_criteria.py @@ -1,30 +1,37 @@ # Copyright (c) 2017, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt -import unittest import frappe +from frappe.tests.utils import FrappeTestCase -class TestSupplierScorecardCriteria(unittest.TestCase): +class TestSupplierScorecardCriteria(FrappeTestCase): def test_variables_exist(self): delete_test_scorecards() for d in test_good_criteria: frappe.get_doc(d).insert() - self.assertRaises(frappe.ValidationError,frappe.get_doc(test_bad_criteria[0]).insert) + self.assertRaises(frappe.ValidationError, frappe.get_doc(test_bad_criteria[0]).insert) def test_formula_validate(self): delete_test_scorecards() - self.assertRaises(frappe.ValidationError,frappe.get_doc(test_bad_criteria[1]).insert) - self.assertRaises(frappe.ValidationError,frappe.get_doc(test_bad_criteria[2]).insert) + self.assertRaises(frappe.ValidationError, frappe.get_doc(test_bad_criteria[1]).insert) + self.assertRaises(frappe.ValidationError, frappe.get_doc(test_bad_criteria[2]).insert) + def delete_test_scorecards(): # Delete all the periods so we can delete all the criteria frappe.db.sql("""delete from `tabSupplier Scorecard Period`""") - frappe.db.sql("""delete from `tabSupplier Scorecard Scoring Criteria` where parenttype = 'Supplier Scorecard Period'""") - frappe.db.sql("""delete from `tabSupplier Scorecard Scoring Standing` where parenttype = 'Supplier Scorecard Period'""") - frappe.db.sql("""delete from `tabSupplier Scorecard Scoring Variable` where parenttype = 'Supplier Scorecard Period'""") + frappe.db.sql( + """delete from `tabSupplier Scorecard Scoring Criteria` where parenttype = 'Supplier Scorecard Period'""" + ) + frappe.db.sql( + """delete from `tabSupplier Scorecard Scoring Standing` where parenttype = 'Supplier Scorecard Period'""" + ) + frappe.db.sql( + """delete from `tabSupplier Scorecard Scoring Variable` where parenttype = 'Supplier Scorecard Period'""" + ) for d in test_good_criteria: if frappe.db.exists("Supplier Scorecard Criteria", d.get("name")): @@ -36,40 +43,41 @@ def delete_test_scorecards(): # Delete all the periods, then delete the scorecard frappe.delete_doc(d.get("doctype"), d.get("name")) + test_good_criteria = [ { - "name":"Delivery", - "weight":40.0, - "doctype":"Supplier Scorecard Criteria", - "formula":"(({cost_of_on_time_shipments} / {tot_cost_shipments}) if {tot_cost_shipments} > 0 else 1 )* 100", - "criteria_name":"Delivery", - "max_score":100.0 + "name": "Delivery", + "weight": 40.0, + "doctype": "Supplier Scorecard Criteria", + "formula": "(({cost_of_on_time_shipments} / {tot_cost_shipments}) if {tot_cost_shipments} > 0 else 1 )* 100", + "criteria_name": "Delivery", + "max_score": 100.0, }, ] test_bad_criteria = [ { - "name":"Fake Criteria 1", - "weight":40.0, - "doctype":"Supplier Scorecard Criteria", - "formula":"(({fake_variable} / {tot_cost_shipments}) if {tot_cost_shipments} > 0 else 1 )* 100", # Invalid variable name - "criteria_name":"Fake Criteria 1", - "max_score":100.0 + "name": "Fake Criteria 1", + "weight": 40.0, + "doctype": "Supplier Scorecard Criteria", + "formula": "(({fake_variable} / {tot_cost_shipments}) if {tot_cost_shipments} > 0 else 1 )* 100", # Invalid variable name + "criteria_name": "Fake Criteria 1", + "max_score": 100.0, }, { - "name":"Fake Criteria 2", - "weight":40.0, - "doctype":"Supplier Scorecard Criteria", - "formula":"(({cost_of_on_time_shipments} / {tot_cost_shipments}))* 100", # Force 0 divided by 0 - "criteria_name":"Fake Criteria 2", - "max_score":100.0 + "name": "Fake Criteria 2", + "weight": 40.0, + "doctype": "Supplier Scorecard Criteria", + "formula": "(({cost_of_on_time_shipments} / {tot_cost_shipments}))* 100", # Force 0 divided by 0 + "criteria_name": "Fake Criteria 2", + "max_score": 100.0, }, { - "name":"Fake Criteria 3", - "weight":40.0, - "doctype":"Supplier Scorecard Criteria", - "formula":"(({cost_of_on_time_shipments} {cost_of_on_time_shipments} / {tot_cost_shipments}))* 100", # Two variables beside eachother - "criteria_name":"Fake Criteria 3", - "max_score":100.0 + "name": "Fake Criteria 3", + "weight": 40.0, + "doctype": "Supplier Scorecard Criteria", + "formula": "(({cost_of_on_time_shipments} {cost_of_on_time_shipments} / {tot_cost_shipments}))* 100", # Two variables beside eachother + "criteria_name": "Fake Criteria 3", + "max_score": 100.0, }, ] diff --git a/erpnext/buying/doctype/supplier_scorecard_period/supplier_scorecard_period.py b/erpnext/buying/doctype/supplier_scorecard_period/supplier_scorecard_period.py index c247241cf35..a8b76db0931 100644 --- a/erpnext/buying/doctype/supplier_scorecard_period/supplier_scorecard_period.py +++ b/erpnext/buying/doctype/supplier_scorecard_period/supplier_scorecard_period.py @@ -14,7 +14,6 @@ from erpnext.buying.doctype.supplier_scorecard_criteria.supplier_scorecard_crite class SupplierScorecardPeriod(Document): - def validate(self): self.validate_criteria_weights() self.calculate_variables() @@ -28,69 +27,84 @@ class SupplierScorecardPeriod(Document): weight += c.weight if weight != 100: - throw(_('Criteria weights must add up to 100%')) + throw(_("Criteria weights must add up to 100%")) def calculate_variables(self): for var in self.variables: - if '.' in var.path: + if "." in var.path: method_to_call = import_string_path(var.path) var.value = method_to_call(self) else: method_to_call = getattr(variable_functions, var.path) var.value = method_to_call(self) - - def calculate_criteria(self): for crit in self.criteria: try: - crit.score = min(crit.max_score, max( 0 ,frappe.safe_eval(self.get_eval_statement(crit.formula), None, {'max':max, 'min': min}))) + crit.score = min( + crit.max_score, + max( + 0, frappe.safe_eval(self.get_eval_statement(crit.formula), None, {"max": max, "min": min}) + ), + ) except Exception: - frappe.throw(_("Could not solve criteria score function for {0}. Make sure the formula is valid.").format(crit.criteria_name),frappe.ValidationError) + frappe.throw( + _("Could not solve criteria score function for {0}. Make sure the formula is valid.").format( + crit.criteria_name + ), + frappe.ValidationError, + ) crit.score = 0 def calculate_score(self): myscore = 0 for crit in self.criteria: - myscore += crit.score * crit.weight/100.0 + myscore += crit.score * crit.weight / 100.0 self.total_score = myscore def calculate_weighted_score(self, weighing_function): try: - weighed_score = frappe.safe_eval(self.get_eval_statement(weighing_function), None, {'max':max, 'min': min}) + weighed_score = frappe.safe_eval( + self.get_eval_statement(weighing_function), None, {"max": max, "min": min} + ) except Exception: - frappe.throw(_("Could not solve weighted score function. Make sure the formula is valid."),frappe.ValidationError) + frappe.throw( + _("Could not solve weighted score function. Make sure the formula is valid."), + frappe.ValidationError, + ) weighed_score = 0 return weighed_score - def get_eval_statement(self, formula): my_eval_statement = formula.replace("\r", "").replace("\n", "") for var in self.variables: - if var.value: - if var.param_name in my_eval_statement: - my_eval_statement = my_eval_statement.replace('{' + var.param_name + '}', "{:.2f}".format(var.value)) - else: - if var.param_name in my_eval_statement: - my_eval_statement = my_eval_statement.replace('{' + var.param_name + '}', '0.0') + if var.value: + if var.param_name in my_eval_statement: + my_eval_statement = my_eval_statement.replace( + "{" + var.param_name + "}", "{:.2f}".format(var.value) + ) + else: + if var.param_name in my_eval_statement: + my_eval_statement = my_eval_statement.replace("{" + var.param_name + "}", "0.0") return my_eval_statement def import_string_path(path): - components = path.split('.') - mod = __import__(components[0]) - for comp in components[1:]: - mod = getattr(mod, comp) - return mod + components = path.split(".") + mod = __import__(components[0]) + for comp in components[1:]: + mod = getattr(mod, comp) + return mod @frappe.whitelist() def make_supplier_scorecard(source_name, target_doc=None): def update_criteria_fields(obj, target, source_parent): - target.max_score, target.formula = frappe.db.get_value('Supplier Scorecard Criteria', - obj.criteria_name, ['max_score', 'formula']) + target.max_score, target.formula = frappe.db.get_value( + "Supplier Scorecard Criteria", obj.criteria_name, ["max_score", "formula"] + ) def post_process(source, target): variables = [] @@ -99,16 +113,21 @@ def make_supplier_scorecard(source_name, target_doc=None): if var not in variables: variables.append(var) - target.extend('variables', variables) + target.extend("variables", variables) - doc = get_mapped_doc("Supplier Scorecard", source_name, { - "Supplier Scorecard": { - "doctype": "Supplier Scorecard Period" + doc = get_mapped_doc( + "Supplier Scorecard", + source_name, + { + "Supplier Scorecard": {"doctype": "Supplier Scorecard Period"}, + "Supplier Scorecard Scoring Criteria": { + "doctype": "Supplier Scorecard Scoring Criteria", + "postprocess": update_criteria_fields, + }, }, - "Supplier Scorecard Scoring Criteria": { - "doctype": "Supplier Scorecard Scoring Criteria", - "postprocess": update_criteria_fields, - } - }, target_doc, post_process, ignore_permissions=True) + target_doc, + post_process, + ignore_permissions=True, + ) return doc diff --git a/erpnext/buying/doctype/supplier_scorecard_standing/supplier_scorecard_standing.py b/erpnext/buying/doctype/supplier_scorecard_standing/supplier_scorecard_standing.py index 11ebe6da13c..929e8a363fd 100644 --- a/erpnext/buying/doctype/supplier_scorecard_standing/supplier_scorecard_standing.py +++ b/erpnext/buying/doctype/supplier_scorecard_standing/supplier_scorecard_standing.py @@ -19,11 +19,14 @@ def get_scoring_standing(standing_name): @frappe.whitelist() def get_standings_list(): - standings = frappe.db.sql(""" + standings = frappe.db.sql( + """ SELECT scs.name FROM `tabSupplier Scorecard Standing` scs""", - {}, as_dict=1) + {}, + as_dict=1, + ) return standings diff --git a/erpnext/buying/doctype/supplier_scorecard_variable/supplier_scorecard_variable.py b/erpnext/buying/doctype/supplier_scorecard_variable/supplier_scorecard_variable.py index 217aadba6bd..fb8819eaf81 100644 --- a/erpnext/buying/doctype/supplier_scorecard_variable/supplier_scorecard_variable.py +++ b/erpnext/buying/doctype/supplier_scorecard_variable/supplier_scorecard_variable.py @@ -10,18 +10,21 @@ from frappe.model.document import Document from frappe.utils import getdate -class VariablePathNotFound(frappe.ValidationError): pass +class VariablePathNotFound(frappe.ValidationError): + pass + class SupplierScorecardVariable(Document): def validate(self): self.validate_path_exists() def validate_path_exists(self): - if '.' in self.path: + if "." in self.path: try: from erpnext.buying.doctype.supplier_scorecard_period.supplier_scorecard_period import ( import_string_path, ) + import_string_path(self.path) except AttributeError: frappe.throw(_("Could not find path for " + self.path), VariablePathNotFound) @@ -30,15 +33,18 @@ class SupplierScorecardVariable(Document): if not hasattr(sys.modules[__name__], self.path): frappe.throw(_("Could not find path for " + self.path), VariablePathNotFound) + def get_total_workdays(scorecard): - """ Gets the number of days in this period""" + """Gets the number of days in this period""" delta = getdate(scorecard.end_date) - getdate(scorecard.start_date) return delta.days + def get_item_workdays(scorecard): - """ Gets the number of days in this period""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) - total_item_days = frappe.db.sql(""" + """Gets the number of days in this period""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) + total_item_days = frappe.db.sql( + """ SELECT SUM(DATEDIFF( %(end_date)s, po_item.schedule_date) * (po_item.qty)) FROM @@ -49,20 +55,22 @@ def get_item_workdays(scorecard): AND po_item.received_qty < po_item.qty AND po_item.schedule_date BETWEEN %(start_date)s AND %(end_date)s AND po_item.parent = po.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not total_item_days: total_item_days = 0 return total_item_days - def get_total_cost_of_shipments(scorecard): - """ Gets the total cost of all shipments in the period (based on Purchase Orders)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total cost of all shipments in the period (based on Purchase Orders)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT SUM(po_item.base_amount) FROM @@ -73,24 +81,29 @@ def get_total_cost_of_shipments(scorecard): AND po_item.schedule_date BETWEEN %(start_date)s AND %(end_date)s AND po_item.docstatus = 1 AND po_item.parent = po.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if data: return data else: return 0 + def get_cost_of_delayed_shipments(scorecard): - """ Gets the total cost of all delayed shipments in the period (based on Purchase Receipts - POs)""" + """Gets the total cost of all delayed shipments in the period (based on Purchase Receipts - POs)""" return get_total_cost_of_shipments(scorecard) - get_cost_of_on_time_shipments(scorecard) + def get_cost_of_on_time_shipments(scorecard): - """ Gets the total cost of all on_time shipments in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total cost of all on_time shipments in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - total_delivered_on_time_costs = frappe.db.sql(""" + total_delivered_on_time_costs = frappe.db.sql( + """ SELECT SUM(pr_item.base_amount) FROM @@ -106,7 +119,9 @@ def get_cost_of_on_time_shipments(scorecard): AND pr_item.purchase_order_item = po_item.name AND po_item.parent = po.name AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if total_delivered_on_time_costs: return total_delivered_on_time_costs @@ -115,9 +130,10 @@ def get_cost_of_on_time_shipments(scorecard): def get_total_days_late(scorecard): - """ Gets the number of item days late in the period (based on Purchase Receipts vs POs)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) - total_delivered_late_days = frappe.db.sql(""" + """Gets the number of item days late in the period (based on Purchase Receipts vs POs)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) + total_delivered_late_days = frappe.db.sql( + """ SELECT SUM(DATEDIFF(pr.posting_date,po_item.schedule_date)* pr_item.qty) FROM @@ -133,11 +149,14 @@ def get_total_days_late(scorecard): AND pr_item.purchase_order_item = po_item.name AND po_item.parent = po.name AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not total_delivered_late_days: total_delivered_late_days = 0 - total_missed_late_days = frappe.db.sql(""" + total_missed_late_days = frappe.db.sql( + """ SELECT SUM(DATEDIFF( %(end_date)s, po_item.schedule_date) * (po_item.qty - po_item.received_qty)) FROM @@ -148,19 +167,23 @@ def get_total_days_late(scorecard): AND po_item.received_qty < po_item.qty AND po_item.schedule_date BETWEEN %(start_date)s AND %(end_date)s AND po_item.parent = po.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not total_missed_late_days: total_missed_late_days = 0 return total_missed_late_days + total_delivered_late_days -def get_on_time_shipments(scorecard): - """ Gets the number of late shipments (counting each item) in the period (based on Purchase Receipts vs POs)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) +def get_on_time_shipments(scorecard): + """Gets the number of late shipments (counting each item) in the period (based on Purchase Receipts vs POs)""" + + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - total_items_delivered_on_time = frappe.db.sql(""" + total_items_delivered_on_time = frappe.db.sql( + """ SELECT COUNT(pr_item.qty) FROM @@ -177,22 +200,27 @@ def get_on_time_shipments(scorecard): AND pr_item.purchase_order_item = po_item.name AND po_item.parent = po.name AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not total_items_delivered_on_time: total_items_delivered_on_time = 0 return total_items_delivered_on_time + def get_late_shipments(scorecard): - """ Gets the number of late shipments (counting each item) in the period (based on Purchase Receipts vs POs)""" + """Gets the number of late shipments (counting each item) in the period (based on Purchase Receipts vs POs)""" return get_total_shipments(scorecard) - get_on_time_shipments(scorecard) + def get_total_received(scorecard): - """ Gets the total number of received shipments in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of received shipments in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT COUNT(pr_item.base_amount) FROM @@ -203,18 +231,22 @@ def get_total_received(scorecard): AND pr.posting_date BETWEEN %(start_date)s AND %(end_date)s AND pr_item.docstatus = 1 AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_total_received_amount(scorecard): - """ Gets the total amount (in company currency) received in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total amount (in company currency) received in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT SUM(pr_item.received_qty * pr_item.base_rate) FROM @@ -225,18 +257,22 @@ def get_total_received_amount(scorecard): AND pr.posting_date BETWEEN %(start_date)s AND %(end_date)s AND pr_item.docstatus = 1 AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_total_received_items(scorecard): - """ Gets the total number of received shipments in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of received shipments in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT SUM(pr_item.received_qty) FROM @@ -247,18 +283,22 @@ def get_total_received_items(scorecard): AND pr.posting_date BETWEEN %(start_date)s AND %(end_date)s AND pr_item.docstatus = 1 AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_total_rejected_amount(scorecard): - """ Gets the total amount (in company currency) rejected in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total amount (in company currency) rejected in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT SUM(pr_item.rejected_qty * pr_item.base_rate) FROM @@ -269,18 +309,22 @@ def get_total_rejected_amount(scorecard): AND pr.posting_date BETWEEN %(start_date)s AND %(end_date)s AND pr_item.docstatus = 1 AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_total_rejected_items(scorecard): - """ Gets the total number of rejected items in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of rejected items in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT SUM(pr_item.rejected_qty) FROM @@ -291,18 +335,22 @@ def get_total_rejected_items(scorecard): AND pr.posting_date BETWEEN %(start_date)s AND %(end_date)s AND pr_item.docstatus = 1 AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_total_accepted_amount(scorecard): - """ Gets the total amount (in company currency) accepted in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total amount (in company currency) accepted in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT SUM(pr_item.qty * pr_item.base_rate) FROM @@ -313,18 +361,22 @@ def get_total_accepted_amount(scorecard): AND pr.posting_date BETWEEN %(start_date)s AND %(end_date)s AND pr_item.docstatus = 1 AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_total_accepted_items(scorecard): - """ Gets the total number of rejected items in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of rejected items in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT SUM(pr_item.qty) FROM @@ -335,18 +387,22 @@ def get_total_accepted_items(scorecard): AND pr.posting_date BETWEEN %(start_date)s AND %(end_date)s AND pr_item.docstatus = 1 AND pr_item.parent = pr.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_total_shipments(scorecard): - """ Gets the total number of ordered shipments to arrive in the period (based on Purchase Receipts)""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of ordered shipments to arrive in the period (based on Purchase Receipts)""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT COUNT(po_item.base_amount) FROM @@ -357,18 +413,22 @@ def get_total_shipments(scorecard): AND po_item.schedule_date BETWEEN %(start_date)s AND %(end_date)s AND po_item.docstatus = 1 AND po_item.parent = po.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_rfq_total_number(scorecard): - """ Gets the total number of RFQs sent to supplier""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of RFQs sent to supplier""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT COUNT(rfq.name) as total_rfqs FROM @@ -381,18 +441,22 @@ def get_rfq_total_number(scorecard): AND rfq_item.docstatus = 1 AND rfq_item.parent = rfq.name AND rfq_sup.parent = rfq.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_rfq_total_items(scorecard): - """ Gets the total number of RFQ items sent to supplier""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of RFQ items sent to supplier""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT COUNT(rfq_item.name) as total_rfqs FROM @@ -405,18 +469,21 @@ def get_rfq_total_items(scorecard): AND rfq_item.docstatus = 1 AND rfq_item.parent = rfq.name AND rfq_sup.parent = rfq.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data def get_sq_total_number(scorecard): - """ Gets the total number of RFQ items sent to supplier""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of RFQ items sent to supplier""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT COUNT(sq.name) as total_sqs FROM @@ -435,17 +502,21 @@ def get_sq_total_number(scorecard): AND sq_item.parent = sq.name AND rfq_item.parent = rfq.name AND rfq_sup.parent = rfq.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_sq_total_items(scorecard): - """ Gets the total number of RFQ items sent to supplier""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) + """Gets the total number of RFQ items sent to supplier""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) # Look up all PO Items with delivery dates between our dates - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT COUNT(sq_item.name) as total_sqs FROM @@ -464,15 +535,19 @@ def get_sq_total_items(scorecard): AND rfq_item.docstatus = 1 AND rfq_item.parent = rfq.name AND rfq_sup.parent = rfq.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not data: data = 0 return data + def get_rfq_response_days(scorecard): - """ Gets the total number of days it has taken a supplier to respond to rfqs in the period""" - supplier = frappe.get_doc('Supplier', scorecard.supplier) - total_sq_days = frappe.db.sql(""" + """Gets the total number of days it has taken a supplier to respond to rfqs in the period""" + supplier = frappe.get_doc("Supplier", scorecard.supplier) + total_sq_days = frappe.db.sql( + """ SELECT SUM(DATEDIFF(sq.transaction_date, rfq.transaction_date)) FROM @@ -491,9 +566,10 @@ def get_rfq_response_days(scorecard): AND rfq_item.docstatus = 1 AND rfq_item.parent = rfq.name AND rfq_sup.parent = rfq.name""", - {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, as_dict=0)[0][0] + {"supplier": supplier.name, "start_date": scorecard.start_date, "end_date": scorecard.end_date}, + as_dict=0, + )[0][0] if not total_sq_days: total_sq_days = 0 - return total_sq_days diff --git a/erpnext/buying/doctype/supplier_scorecard_variable/test_supplier_scorecard_variable.py b/erpnext/buying/doctype/supplier_scorecard_variable/test_supplier_scorecard_variable.py index 4d75981125f..60d84644cf5 100644 --- a/erpnext/buying/doctype/supplier_scorecard_variable/test_supplier_scorecard_variable.py +++ b/erpnext/buying/doctype/supplier_scorecard_variable/test_supplier_scorecard_variable.py @@ -1,22 +1,22 @@ # Copyright (c) 2017, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt -import unittest import frappe +from frappe.tests.utils import FrappeTestCase from erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable import ( VariablePathNotFound, ) -class TestSupplierScorecardVariable(unittest.TestCase): +class TestSupplierScorecardVariable(FrappeTestCase): def test_variable_exist(self): for d in test_existing_variables: my_doc = frappe.get_doc("Supplier Scorecard Variable", d.get("name")) - self.assertEqual(my_doc.param_name, d.get('param_name')) - self.assertEqual(my_doc.variable_label, d.get('variable_label')) - self.assertEqual(my_doc.path, d.get('path')) + self.assertEqual(my_doc.param_name, d.get("param_name")) + self.assertEqual(my_doc.variable_label, d.get("variable_label")) + self.assertEqual(my_doc.path, d.get("path")) def test_path_exists(self): for d in test_good_variables: @@ -25,34 +25,35 @@ class TestSupplierScorecardVariable(unittest.TestCase): frappe.get_doc(d).insert() for d in test_bad_variables: - self.assertRaises(VariablePathNotFound,frappe.get_doc(d).insert) + self.assertRaises(VariablePathNotFound, frappe.get_doc(d).insert) + test_existing_variables = [ { - "param_name":"total_accepted_items", - "name":"Total Accepted Items", - "doctype":"Supplier Scorecard Variable", - "variable_label":"Total Accepted Items", - "path":"get_total_accepted_items" + "param_name": "total_accepted_items", + "name": "Total Accepted Items", + "doctype": "Supplier Scorecard Variable", + "variable_label": "Total Accepted Items", + "path": "get_total_accepted_items", }, ] test_good_variables = [ { - "param_name":"good_variable1", - "name":"Good Variable 1", - "doctype":"Supplier Scorecard Variable", - "variable_label":"Good Variable 1", - "path":"get_total_accepted_items" + "param_name": "good_variable1", + "name": "Good Variable 1", + "doctype": "Supplier Scorecard Variable", + "variable_label": "Good Variable 1", + "path": "get_total_accepted_items", }, ] test_bad_variables = [ { - "param_name":"fake_variable1", - "name":"Fake Variable 1", - "doctype":"Supplier Scorecard Variable", - "variable_label":"Fake Variable 1", - "path":"get_fake_variable1" + "param_name": "fake_variable1", + "name": "Fake Variable 1", + "doctype": "Supplier Scorecard Variable", + "variable_label": "Fake Variable 1", + "path": "get_fake_variable1", }, ] diff --git a/erpnext/buying/report/procurement_tracker/procurement_tracker.py b/erpnext/buying/report/procurement_tracker/procurement_tracker.py index 295a19d052e..e0b02ee4e2a 100644 --- a/erpnext/buying/report/procurement_tracker/procurement_tracker.py +++ b/erpnext/buying/report/procurement_tracker/procurement_tracker.py @@ -12,152 +12,143 @@ def execute(filters=None): data = get_data(filters) return columns, data + def get_columns(filters): columns = [ { "label": _("Material Request Date"), "fieldname": "material_request_date", "fieldtype": "Date", - "width": 140 + "width": 140, }, { "label": _("Material Request No"), "options": "Material Request", "fieldname": "material_request_no", "fieldtype": "Link", - "width": 140 + "width": 140, }, { "label": _("Cost Center"), "options": "Cost Center", "fieldname": "cost_center", "fieldtype": "Link", - "width": 140 + "width": 140, }, { "label": _("Project"), "options": "Project", "fieldname": "project", "fieldtype": "Link", - "width": 140 + "width": 140, }, { "label": _("Requesting Site"), "options": "Warehouse", "fieldname": "requesting_site", "fieldtype": "Link", - "width": 140 + "width": 140, }, { "label": _("Requestor"), "options": "Employee", "fieldname": "requestor", "fieldtype": "Link", - "width": 140 + "width": 140, }, { "label": _("Item"), "fieldname": "item_code", "fieldtype": "Link", "options": "Item", - "width": 150 - }, - { - "label": _("Quantity"), - "fieldname": "quantity", - "fieldtype": "Float", - "width": 140 + "width": 150, }, + {"label": _("Quantity"), "fieldname": "quantity", "fieldtype": "Float", "width": 140}, { "label": _("Unit of Measure"), "options": "UOM", "fieldname": "unit_of_measurement", "fieldtype": "Link", - "width": 140 - }, - { - "label": _("Status"), - "fieldname": "status", - "fieldtype": "data", - "width": 140 + "width": 140, }, + {"label": _("Status"), "fieldname": "status", "fieldtype": "data", "width": 140}, { "label": _("Purchase Order Date"), "fieldname": "purchase_order_date", "fieldtype": "Date", - "width": 140 + "width": 140, }, { "label": _("Purchase Order"), "options": "Purchase Order", "fieldname": "purchase_order", "fieldtype": "Link", - "width": 140 + "width": 140, }, { "label": _("Supplier"), "options": "Supplier", "fieldname": "supplier", "fieldtype": "Link", - "width": 140 + "width": 140, }, { "label": _("Estimated Cost"), "fieldname": "estimated_cost", "fieldtype": "Float", - "width": 140 - }, - { - "label": _("Actual Cost"), - "fieldname": "actual_cost", - "fieldtype": "Float", - "width": 140 + "width": 140, }, + {"label": _("Actual Cost"), "fieldname": "actual_cost", "fieldtype": "Float", "width": 140}, { "label": _("Purchase Order Amount"), "fieldname": "purchase_order_amt", "fieldtype": "Float", - "width": 140 + "width": 140, }, { "label": _("Purchase Order Amount(Company Currency)"), "fieldname": "purchase_order_amt_in_company_currency", "fieldtype": "Float", - "width": 140 + "width": 140, }, { "label": _("Expected Delivery Date"), "fieldname": "expected_delivery_date", "fieldtype": "Date", - "width": 140 + "width": 140, }, { "label": _("Actual Delivery Date"), "fieldname": "actual_delivery_date", "fieldtype": "Date", - "width": 140 + "width": 140, }, ] return columns + def get_conditions(filters): conditions = "" if filters.get("company"): - conditions += " AND parent.company=%s" % frappe.db.escape(filters.get('company')) + conditions += " AND parent.company=%s" % frappe.db.escape(filters.get("company")) if filters.get("cost_center") or filters.get("project"): conditions += """ AND (child.`cost_center`=%s OR child.`project`=%s) - """ % (frappe.db.escape(filters.get('cost_center')), frappe.db.escape(filters.get('project'))) + """ % ( + frappe.db.escape(filters.get("cost_center")), + frappe.db.escape(filters.get("project")), + ) if filters.get("from_date"): - conditions += " AND parent.transaction_date>='%s'" % filters.get('from_date') + conditions += " AND parent.transaction_date>='%s'" % filters.get("from_date") if filters.get("to_date"): - conditions += " AND parent.transaction_date<='%s'" % filters.get('to_date') + conditions += " AND parent.transaction_date<='%s'" % filters.get("to_date") return conditions + def get_data(filters): conditions = get_conditions(filters) purchase_order_entry = get_po_entries(conditions) @@ -165,14 +156,14 @@ def get_data(filters): pr_records = get_mapped_pr_records() pi_records = get_mapped_pi_records() - procurement_record=[] + procurement_record = [] if procurement_record_against_mr: procurement_record += procurement_record_against_mr for po in purchase_order_entry: # fetch material records linked to the purchase order item mr_record = mr_records.get(po.material_request_item, [{}])[0] procurement_detail = { - "material_request_date": mr_record.get('transaction_date'), + "material_request_date": mr_record.get("transaction_date"), "cost_center": po.cost_center, "project": po.project, "requesting_site": po.warehouse, @@ -185,19 +176,21 @@ def get_data(filters): "purchase_order_date": po.transaction_date, "purchase_order": po.parent, "supplier": po.supplier, - "estimated_cost": flt(mr_record.get('amount')), + "estimated_cost": flt(mr_record.get("amount")), "actual_cost": flt(pi_records.get(po.name)), "purchase_order_amt": flt(po.amount), "purchase_order_amt_in_company_currency": flt(po.base_amount), "expected_delivery_date": po.schedule_date, - "actual_delivery_date": pr_records.get(po.name) + "actual_delivery_date": pr_records.get(po.name), } procurement_record.append(procurement_detail) return procurement_record + def get_mapped_mr_details(conditions): mr_records = {} - mr_details = frappe.db.sql(""" + mr_details = frappe.db.sql( + """ SELECT parent.transaction_date, parent.per_ordered, @@ -217,7 +210,11 @@ def get_mapped_mr_details(conditions): AND parent.name=child.parent AND parent.docstatus=1 {conditions} - """.format(conditions=conditions), as_dict=1) #nosec + """.format( + conditions=conditions + ), + as_dict=1, + ) # nosec procurement_record_against_mr = [] for record in mr_details: @@ -236,14 +233,17 @@ def get_mapped_mr_details(conditions): actual_cost=0, purchase_order_amt=0, purchase_order_amt_in_company_currency=0, - project = record.project, - cost_center = record.cost_center + project=record.project, + cost_center=record.cost_center, ) procurement_record_against_mr.append(procurement_record_details) return mr_records, procurement_record_against_mr + def get_mapped_pi_records(): - return frappe._dict(frappe.db.sql(""" + return frappe._dict( + frappe.db.sql( + """ SELECT pi_item.po_detail, pi_item.base_amount @@ -254,10 +254,15 @@ def get_mapped_pi_records(): pi_item.docstatus = 1 AND po.status not in ("Closed","Completed","Cancelled") AND pi_item.po_detail IS NOT NULL - """)) + """ + ) + ) + def get_mapped_pr_records(): - return frappe._dict(frappe.db.sql(""" + return frappe._dict( + frappe.db.sql( + """ SELECT pr_item.purchase_order_item, pr.posting_date @@ -267,10 +272,14 @@ def get_mapped_pr_records(): AND pr.name=pr_item.parent AND pr_item.purchase_order_item IS NOT NULL AND pr.status not in ("Closed","Completed","Cancelled") - """)) + """ + ) + ) + def get_po_entries(conditions): - return frappe.db.sql(""" + return frappe.db.sql( + """ SELECT child.name, child.parent, @@ -297,4 +306,8 @@ def get_po_entries(conditions): {conditions} GROUP BY parent.name, child.item_code - """.format(conditions=conditions), as_dict=1) #nosec + """.format( + conditions=conditions + ), + as_dict=1, + ) # nosec diff --git a/erpnext/buying/report/procurement_tracker/test_procurement_tracker.py b/erpnext/buying/report/procurement_tracker/test_procurement_tracker.py index 84de8c67438..47a66ad46f2 100644 --- a/erpnext/buying/report/procurement_tracker/test_procurement_tracker.py +++ b/erpnext/buying/report/procurement_tracker/test_procurement_tracker.py @@ -2,10 +2,10 @@ # For license information, please see license.txt -import unittest from datetime import datetime import frappe +from frappe.tests.utils import FrappeTestCase from erpnext.buying.doctype.purchase_order.purchase_order import make_purchase_receipt from erpnext.buying.report.procurement_tracker.procurement_tracker import execute @@ -14,29 +14,30 @@ from erpnext.stock.doctype.material_request.test_material_request import make_ma from erpnext.stock.doctype.warehouse.test_warehouse import create_warehouse -class TestProcurementTracker(unittest.TestCase): +class TestProcurementTracker(FrappeTestCase): def test_result_for_procurement_tracker(self): - filters = { - 'company': '_Test Procurement Company', - 'cost_center': 'Main - _TPC' - } + filters = {"company": "_Test Procurement Company", "cost_center": "Main - _TPC"} expected_data = self.generate_expected_data() report = execute(filters) length = len(report[1]) - self.assertEqual(expected_data, report[1][length-1]) + self.assertEqual(expected_data, report[1][length - 1]) def generate_expected_data(self): if not frappe.db.exists("Company", "_Test Procurement Company"): - frappe.get_doc(dict( - doctype="Company", - company_name="_Test Procurement Company", - abbr="_TPC", - default_currency="INR", - country="Pakistan" - )).insert() + frappe.get_doc( + dict( + doctype="Company", + company_name="_Test Procurement Company", + abbr="_TPC", + default_currency="INR", + country="Pakistan", + ) + ).insert() warehouse = create_warehouse("_Test Procurement Warehouse", company="_Test Procurement Company") - mr = make_material_request(company="_Test Procurement Company", warehouse=warehouse, cost_center="Main - _TPC") + mr = make_material_request( + company="_Test Procurement Company", warehouse=warehouse, cost_center="Main - _TPC" + ) po = make_purchase_order(mr.name) po.supplier = "_Test Supplier" po.get("items")[0].cost_center = "Main - _TPC" @@ -55,7 +56,7 @@ class TestProcurementTracker(unittest.TestCase): "requesting_site": "_Test Procurement Warehouse - _TPC", "requestor": "Administrator", "material_request_no": mr.name, - "item_code": '_Test Item', + "item_code": "_Test Item", "quantity": 10.0, "unit_of_measurement": "_Test UOM", "status": "To Bill", @@ -67,7 +68,7 @@ class TestProcurementTracker(unittest.TestCase): "purchase_order_amt": po.net_total, "purchase_order_amt_in_company_currency": po.base_net_total, "expected_delivery_date": date_obj, - "actual_delivery_date": date_obj + "actual_delivery_date": date_obj, } return expected_data diff --git a/erpnext/buying/report/purchase_order_analysis/purchase_order_analysis.js b/erpnext/buying/report/purchase_order_analysis/purchase_order_analysis.js index ca3be03da6e..721e54e46f5 100644 --- a/erpnext/buying/report/purchase_order_analysis/purchase_order_analysis.js +++ b/erpnext/buying/report/purchase_order_analysis/purchase_order_analysis.js @@ -59,6 +59,7 @@ frappe.query_reports["Purchase Order Analysis"] = { for (let option of status){ options.push({ "value": option, + "label": __(option), "description": "" }) } diff --git a/erpnext/buying/report/purchase_order_analysis/purchase_order_analysis.py b/erpnext/buying/report/purchase_order_analysis/purchase_order_analysis.py index 9dd912118ff..a5c464910de 100644 --- a/erpnext/buying/report/purchase_order_analysis/purchase_order_analysis.py +++ b/erpnext/buying/report/purchase_order_analysis/purchase_order_analysis.py @@ -27,6 +27,7 @@ def execute(filters=None): return columns, data, None, chart_data + def validate_filters(filters): from_date, to_date = filters.get("from_date"), filters.get("to_date") @@ -35,25 +36,28 @@ def validate_filters(filters): elif date_diff(to_date, from_date) < 0: frappe.throw(_("To Date cannot be before From Date.")) + def get_conditions(filters): conditions = "" if filters.get("from_date") and filters.get("to_date"): conditions += " and po.transaction_date between %(from_date)s and %(to_date)s" - for field in ['company', 'name']: + for field in ["company", "name"]: if filters.get(field): conditions += f" and po.{field} = %({field})s" - if filters.get('status'): + if filters.get("status"): conditions += " and po.status in %(status)s" - if filters.get('project'): + if filters.get("project"): conditions += " and poi.project = %(project)s" return conditions + def get_data(conditions, filters): - data = frappe.db.sql(""" + data = frappe.db.sql( + """ SELECT po.transaction_date as date, poi.schedule_date as required_date, @@ -81,13 +85,19 @@ def get_data(conditions, filters): {0} GROUP BY poi.name ORDER BY po.transaction_date ASC - """.format(conditions), filters, as_dict=1) + """.format( + conditions + ), + filters, + as_dict=1, + ) return data + def prepare_data(data, filters): completed, pending = 0, 0 - pending_field = "pending_amount" + pending_field = "pending_amount" completed_field = "billed_amount" if filters.get("group_by_po"): @@ -114,8 +124,17 @@ def prepare_data(data, filters): po_row["required_date"] = min(getdate(po_row["required_date"]), getdate(row["required_date"])) # sum numeric columns - fields = ["qty", "received_qty", "pending_qty", "billed_qty", "qty_to_bill", "amount", - "received_qty_amount", "billed_amount", "pending_amount"] + fields = [ + "qty", + "received_qty", + "pending_qty", + "billed_qty", + "qty_to_bill", + "amount", + "received_qty_amount", + "billed_amount", + "pending_amount", + ] for field in fields: po_row[field] = flt(row[field]) + flt(po_row[field]) @@ -129,152 +148,140 @@ def prepare_data(data, filters): return data, chart_data + def prepare_chart_data(pending, completed): labels = ["Amount to Bill", "Billed Amount"] return { - "data" : { - "labels": labels, - "datasets": [ - {"values": [pending, completed]} - ] - }, - "type": 'donut', - "height": 300 + "data": {"labels": labels, "datasets": [{"values": [pending, completed]}]}, + "type": "donut", + "height": 300, } + def get_columns(filters): columns = [ - { - "label":_("Date"), - "fieldname": "date", - "fieldtype": "Date", - "width": 90 - }, - { - "label":_("Required By"), - "fieldname": "required_date", - "fieldtype": "Date", - "width": 90 - }, + {"label": _("Date"), "fieldname": "date", "fieldtype": "Date", "width": 90}, + {"label": _("Required By"), "fieldname": "required_date", "fieldtype": "Date", "width": 90}, { "label": _("Purchase Order"), "fieldname": "purchase_order", "fieldtype": "Link", "options": "Purchase Order", - "width": 160 - }, - { - "label":_("Status"), - "fieldname": "status", - "fieldtype": "Data", - "width": 130 + "width": 160, }, + {"label": _("Status"), "fieldname": "status", "fieldtype": "Data", "width": 130}, { "label": _("Supplier"), "fieldname": "supplier", "fieldtype": "Link", "options": "Supplier", - "width": 130 - },{ + "width": 130, + }, + { "label": _("Project"), "fieldname": "project", "fieldtype": "Link", "options": "Project", - "width": 130 - }] + "width": 130, + }, + ] if not filters.get("group_by_po"): - columns.append({ - "label":_("Item Code"), - "fieldname": "item_code", - "fieldtype": "Link", - "options": "Item", - "width": 100 - }) + columns.append( + { + "label": _("Item Code"), + "fieldname": "item_code", + "fieldtype": "Link", + "options": "Item", + "width": 100, + } + ) - columns.extend([ - { - "label": _("Qty"), - "fieldname": "qty", - "fieldtype": "Float", - "width": 120, - "convertible": "qty" - }, - { - "label": _("Received Qty"), - "fieldname": "received_qty", - "fieldtype": "Float", - "width": 120, - "convertible": "qty" - }, - { - "label": _("Pending Qty"), - "fieldname": "pending_qty", - "fieldtype": "Float", - "width": 80, - "convertible": "qty" - }, - { - "label": _("Billed Qty"), - "fieldname": "billed_qty", - "fieldtype": "Float", - "width": 80, - "convertible": "qty" - }, - { - "label": _("Qty to Bill"), - "fieldname": "qty_to_bill", - "fieldtype": "Float", - "width": 80, - "convertible": "qty" - }, - { - "label": _("Amount"), - "fieldname": "amount", - "fieldtype": "Currency", - "width": 110, - "options": "Company:company:default_currency", - "convertible": "rate" - }, - { - "label": _("Billed Amount"), - "fieldname": "billed_amount", - "fieldtype": "Currency", - "width": 110, - "options": "Company:company:default_currency", - "convertible": "rate" - }, - { - "label": _("Pending Amount"), - "fieldname": "pending_amount", - "fieldtype": "Currency", - "width": 130, - "options": "Company:company:default_currency", - "convertible": "rate" - }, - { - "label": _("Received Qty Amount"), - "fieldname": "received_qty_amount", - "fieldtype": "Currency", - "width": 130, - "options": "Company:company:default_currency", - "convertible": "rate" - }, - { - "label": _("Warehouse"), - "fieldname": "warehouse", - "fieldtype": "Link", - "options": "Warehouse", - "width": 100 - }, - { - "label": _("Company"), - "fieldname": "company", - "fieldtype": "Link", - "options": "Company", - "width": 100 - } - ]) + columns.extend( + [ + { + "label": _("Qty"), + "fieldname": "qty", + "fieldtype": "Float", + "width": 120, + "convertible": "qty", + }, + { + "label": _("Received Qty"), + "fieldname": "received_qty", + "fieldtype": "Float", + "width": 120, + "convertible": "qty", + }, + { + "label": _("Pending Qty"), + "fieldname": "pending_qty", + "fieldtype": "Float", + "width": 80, + "convertible": "qty", + }, + { + "label": _("Billed Qty"), + "fieldname": "billed_qty", + "fieldtype": "Float", + "width": 80, + "convertible": "qty", + }, + { + "label": _("Qty to Bill"), + "fieldname": "qty_to_bill", + "fieldtype": "Float", + "width": 80, + "convertible": "qty", + }, + { + "label": _("Amount"), + "fieldname": "amount", + "fieldtype": "Currency", + "width": 110, + "options": "Company:company:default_currency", + "convertible": "rate", + }, + { + "label": _("Billed Amount"), + "fieldname": "billed_amount", + "fieldtype": "Currency", + "width": 110, + "options": "Company:company:default_currency", + "convertible": "rate", + }, + { + "label": _("Pending Amount"), + "fieldname": "pending_amount", + "fieldtype": "Currency", + "width": 130, + "options": "Company:company:default_currency", + "convertible": "rate", + }, + { + "label": _("Received Qty Amount"), + "fieldname": "received_qty_amount", + "fieldtype": "Currency", + "width": 130, + "options": "Company:company:default_currency", + "convertible": "rate", + }, + { + "label": _("Warehouse"), + "fieldname": "warehouse", + "fieldtype": "Link", + "options": "Warehouse", + "width": 100, + }, + { + "label": _("Company"), + "fieldname": "company", + "fieldtype": "Link", + "options": "Company", + "width": 100, + }, + ] + ) return columns diff --git a/erpnext/buying/report/purchase_order_trends/purchase_order_trends.py b/erpnext/buying/report/purchase_order_trends/purchase_order_trends.py index 21643a896b7..11a74491a4c 100644 --- a/erpnext/buying/report/purchase_order_trends/purchase_order_trends.py +++ b/erpnext/buying/report/purchase_order_trends/purchase_order_trends.py @@ -8,7 +8,8 @@ from erpnext.controllers.trends import get_columns, get_data def execute(filters=None): - if not filters: filters ={} + if not filters: + filters = {} data = [] conditions = get_columns(filters, "Purchase Order") data = get_data(filters, conditions) @@ -16,6 +17,7 @@ def execute(filters=None): return conditions["columns"], data, None, chart_data + def get_chart_data(data, conditions, filters): if not (data and conditions): return [] @@ -28,32 +30,27 @@ def get_chart_data(data, conditions, filters): # fetch only periodic columns as labels columns = conditions.get("columns")[start:-2][1::2] - labels = [column.split(':')[0] for column in columns] + labels = [column.split(":")[0] for column in columns] datapoints = [0] * len(labels) for row in data: # If group by filter, don't add first row of group (it's already summed) - if not row[start-1]: + if not row[start - 1]: continue # Remove None values and compute only periodic data row = [x if x else 0 for x in row[start:-2]] - row = row[1::2] + row = row[1::2] for i in range(len(row)): datapoints[i] += row[i] return { - "data" : { - "labels" : labels, - "datasets" : [ - { - "name" : _("{0}").format(filters.get("period")) + _(" Purchase Value"), - "values" : datapoints - } - ] + "data": { + "labels": labels, + "datasets": [ + {"name": _("{0}").format(filters.get("period")) + _(" Purchase Value"), "values": datapoints} + ], }, - "type" : "line", - "lineOptions": { - "regionFill": 1 - } + "type": "line", + "lineOptions": {"regionFill": 1}, } diff --git a/erpnext/buying/report/requested_items_to_order_and_receive/requested_items_to_order_and_receive.py b/erpnext/buying/report/requested_items_to_order_and_receive/requested_items_to_order_and_receive.py index f98e5f12c2d..21241e08603 100644 --- a/erpnext/buying/report/requested_items_to_order_and_receive/requested_items_to_order_and_receive.py +++ b/erpnext/buying/report/requested_items_to_order_and_receive/requested_items_to_order_and_receive.py @@ -6,26 +6,25 @@ import copy import frappe from frappe import _ +from frappe.query_builder.functions import Coalesce, Sum from frappe.utils import date_diff, flt, getdate def execute(filters=None): if not filters: - return [],[] + return [], [] validate_filters(filters) columns = get_columns(filters) - conditions = get_conditions(filters) + data = get_data(filters) - #get queried data - data = get_data(filters, conditions) - - #prepare data for report and chart views + # prepare data for report and chart views data, chart_data = prepare_data(data, filters) return columns, data, None, chart_data + def validate_filters(filters): from_date, to_date = filters.get("from_date"), filters.get("to_date") @@ -34,59 +33,74 @@ def validate_filters(filters): elif date_diff(to_date, from_date) < 0: frappe.throw(_("To Date cannot be before From Date.")) -def get_conditions(filters): - conditions = '' +def get_data(filters): + mr = frappe.qb.DocType("Material Request") + mr_item = frappe.qb.DocType("Material Request Item") + + query = ( + frappe.qb.from_(mr) + .join(mr_item) + .on(mr_item.parent == mr.name) + .select( + mr.name.as_("material_request"), + mr.transaction_date.as_("date"), + mr_item.schedule_date.as_("required_date"), + mr_item.item_code.as_("item_code"), + Sum(Coalesce(mr_item.stock_qty, 0)).as_("qty"), + Coalesce(mr_item.stock_uom, "").as_("uom"), + Sum(Coalesce(mr_item.ordered_qty, 0)).as_("ordered_qty"), + Sum(Coalesce(mr_item.received_qty, 0)).as_("received_qty"), + (Sum(Coalesce(mr_item.stock_qty, 0)) - Sum(Coalesce(mr_item.received_qty, 0))).as_( + "qty_to_receive" + ), + Sum(Coalesce(mr_item.received_qty, 0)).as_("received_qty"), + (Sum(Coalesce(mr_item.stock_qty, 0)) - Sum(Coalesce(mr_item.ordered_qty, 0))).as_( + "qty_to_order" + ), + mr_item.item_name, + mr_item.description, + mr.company, + ) + .where( + (mr.material_request_type == "Purchase") + & (mr.docstatus == 1) + & (mr.status != "Stopped") + & (mr.per_received < 100) + ) + ) + + query = get_conditions(filters, query, mr, mr_item) # add conditional conditions + + query = query.groupby(mr.name, mr_item.item_code).orderby(mr.transaction_date, mr.schedule_date) + data = query.run(as_dict=True) + return data + + +def get_conditions(filters, query, mr, mr_item): if filters.get("from_date") and filters.get("to_date"): - conditions += " and mr.transaction_date between '{0}' and '{1}'".format(filters.get("from_date"),filters.get("to_date")) - + query = query.where( + (mr.transaction_date >= filters.get("from_date")) + & (mr.transaction_date <= filters.get("to_date")) + ) if filters.get("company"): - conditions += " and mr.company = '{0}'".format(filters.get("company")) + query = query.where(mr.company == filters.get("company")) if filters.get("material_request"): - conditions += " and mr.name = '{0}'".format(filters.get("material_request")) + query = query.where(mr.name == filters.get("material_request")) if filters.get("item_code"): - conditions += " and mr_item.item_code = '{0}'".format(filters.get("item_code")) + query = query.where(mr_item.item_code == filters.get("item_code")) - return conditions + return query -def get_data(filters, conditions): - data = frappe.db.sql(""" - select - mr.name as material_request, - mr.transaction_date as date, - mr_item.schedule_date as required_date, - mr_item.item_code as item_code, - sum(ifnull(mr_item.stock_qty, 0)) as qty, - ifnull(mr_item.stock_uom, '') as uom, - sum(ifnull(mr_item.ordered_qty, 0)) as ordered_qty, - sum(ifnull(mr_item.received_qty, 0)) as received_qty, - (sum(ifnull(mr_item.stock_qty, 0)) - sum(ifnull(mr_item.received_qty, 0))) as qty_to_receive, - (sum(ifnull(mr_item.stock_qty, 0)) - sum(ifnull(mr_item.ordered_qty, 0))) as qty_to_order, - mr_item.item_name as item_name, - mr_item.description as "description", - mr.company as company - from - `tabMaterial Request` mr, `tabMaterial Request Item` mr_item - where - mr_item.parent = mr.name - and mr.material_request_type = "Purchase" - and mr.docstatus = 1 - and mr.status != "Stopped" - {conditions} - group by mr.name, mr_item.item_code - having - sum(ifnull(mr_item.ordered_qty, 0)) < sum(ifnull(mr_item.stock_qty, 0)) - order by mr.transaction_date, mr.schedule_date""".format(conditions=conditions), as_dict=1) - - return data def update_qty_columns(row_to_update, data_row): fields = ["qty", "ordered_qty", "received_qty", "qty_to_receive", "qty_to_order"] for field in fields: row_to_update[field] += flt(data_row[field]) + def prepare_data(data, filters): """Prepare consolidated Report data and Chart data""" material_request_map, item_qty_map = {}, {} @@ -95,11 +109,11 @@ def prepare_data(data, filters): # item wise map for charts if not row["item_code"] in item_qty_map: item_qty_map[row["item_code"]] = { - "qty" : row["qty"], - "ordered_qty" : row["ordered_qty"], + "qty": row["qty"], + "ordered_qty": row["ordered_qty"], "received_qty": row["received_qty"], "qty_to_receive": row["qty_to_receive"], - "qty_to_order" : row["qty_to_order"], + "qty_to_order": row["qty_to_order"], } else: item_entry = item_qty_map[row["item_code"]] @@ -115,19 +129,20 @@ def prepare_data(data, filters): mr_row = material_request_map[row["material_request"]] mr_row["required_date"] = min(getdate(mr_row["required_date"]), getdate(row["required_date"])) - #sum numeric columns + # sum numeric columns update_qty_columns(mr_row, row) chart_data = prepare_chart_data(item_qty_map) if filters.get("group_by_mr"): - data =[] + data = [] for mr in material_request_map: data.append(material_request_map[mr]) return data, chart_data return data, chart_data + def prepare_chart_data(item_data): labels, qty_to_order, ordered_qty, received_qty, qty_to_receive = [], [], [], [], [] @@ -143,35 +158,22 @@ def prepare_chart_data(item_data): qty_to_receive.append(mr_row["qty_to_receive"]) chart_data = { - "data" : { + "data": { "labels": labels, "datasets": [ - { - 'name': _('Qty to Order'), - 'values': qty_to_order - }, - { - 'name': _('Ordered Qty'), - 'values': ordered_qty - }, - { - 'name': _('Received Qty'), - 'values': received_qty - }, - { - 'name': _('Qty to Receive'), - 'values': qty_to_receive - } - ] + {"name": _("Qty to Order"), "values": qty_to_order}, + {"name": _("Ordered Qty"), "values": ordered_qty}, + {"name": _("Received Qty"), "values": received_qty}, + {"name": _("Qty to Receive"), "values": qty_to_receive}, + ], }, "type": "bar", - "barOptions": { - "stacked": 1 - }, + "barOptions": {"stacked": 1}, } return chart_data + def get_columns(filters): columns = [ { @@ -179,92 +181,78 @@ def get_columns(filters): "fieldname": "material_request", "fieldtype": "Link", "options": "Material Request", - "width": 150 + "width": 150, }, - { - "label":_("Date"), - "fieldname": "date", - "fieldtype": "Date", - "width": 90 - }, - { - "label":_("Required By"), - "fieldname": "required_date", - "fieldtype": "Date", - "width": 100 - } + {"label": _("Date"), "fieldname": "date", "fieldtype": "Date", "width": 90}, + {"label": _("Required By"), "fieldname": "required_date", "fieldtype": "Date", "width": 100}, ] if not filters.get("group_by_mr"): - columns.extend([{ - "label":_("Item Code"), - "fieldname": "item_code", - "fieldtype": "Link", - "options": "Item", - "width": 100 - }, - { - "label":_("Item Name"), - "fieldname": "item_name", - "fieldtype": "Data", - "width": 100 - }, - { - "label": _("Description"), - "fieldname": "description", - "fieldtype": "Data", - "width": 200 - }, - { - "label": _("Stock UOM"), - "fieldname": "uom", - "fieldtype": "Data", - "width": 100, - }]) + columns.extend( + [ + { + "label": _("Item Code"), + "fieldname": "item_code", + "fieldtype": "Link", + "options": "Item", + "width": 100, + }, + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 100}, + {"label": _("Description"), "fieldname": "description", "fieldtype": "Data", "width": 200}, + { + "label": _("Stock UOM"), + "fieldname": "uom", + "fieldtype": "Data", + "width": 100, + }, + ] + ) - columns.extend([ - { - "label": _("Stock Qty"), - "fieldname": "qty", - "fieldtype": "Float", - "width": 120, - "convertible": "qty" - }, - { - "label": _("Ordered Qty"), - "fieldname": "ordered_qty", - "fieldtype": "Float", - "width": 120, - "convertible": "qty" - }, - { - "label": _("Received Qty"), - "fieldname": "received_qty", - "fieldtype": "Float", - "width": 120, - "convertible": "qty" - }, - { - "label": _("Qty to Receive"), - "fieldname": "qty_to_receive", - "fieldtype": "Float", - "width": 120, - "convertible": "qty" - }, - { - "label": _("Qty to Order"), - "fieldname": "qty_to_order", - "fieldtype": "Float", - "width": 120, - "convertible": "qty" - }, - { - "label": _("Company"), - "fieldname": "company", - "fieldtype": "Link", - "options": "Company", - "width": 100 - } - ]) + columns.extend( + [ + { + "label": _("Stock Qty"), + "fieldname": "qty", + "fieldtype": "Float", + "width": 120, + "convertible": "qty", + }, + { + "label": _("Ordered Qty"), + "fieldname": "ordered_qty", + "fieldtype": "Float", + "width": 120, + "convertible": "qty", + }, + { + "label": _("Received Qty"), + "fieldname": "received_qty", + "fieldtype": "Float", + "width": 120, + "convertible": "qty", + }, + { + "label": _("Qty to Receive"), + "fieldname": "qty_to_receive", + "fieldtype": "Float", + "width": 120, + "convertible": "qty", + }, + { + "label": _("Qty to Order"), + "fieldname": "qty_to_order", + "fieldtype": "Float", + "width": 120, + "convertible": "qty", + }, + { + "label": _("Company"), + "fieldname": "company", + "fieldtype": "Link", + "options": "Company", + "width": 100, + }, + ] + ) return columns diff --git a/erpnext/buying/report/requested_items_to_order_and_receive/test_requested_items_to_order_and_receive.py b/erpnext/buying/report/requested_items_to_order_and_receive/test_requested_items_to_order_and_receive.py new file mode 100644 index 00000000000..5b84113a9cf --- /dev/null +++ b/erpnext/buying/report/requested_items_to_order_and_receive/test_requested_items_to_order_and_receive.py @@ -0,0 +1,69 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors +# See license.txt + +import frappe +from frappe.tests.utils import FrappeTestCase +from frappe.utils import add_days, today + +from erpnext.buying.doctype.purchase_order.purchase_order import make_purchase_receipt +from erpnext.buying.report.requested_items_to_order_and_receive.requested_items_to_order_and_receive import ( + get_data, +) +from erpnext.stock.doctype.item.test_item import create_item +from erpnext.stock.doctype.material_request.material_request import make_purchase_order + + +class TestRequestedItemsToOrderAndReceive(FrappeTestCase): + def setUp(self) -> None: + create_item("Test MR Report Item") + self.setup_material_request() # to order and receive + self.setup_material_request(order=True, days=1) # to receive (ordered) + self.setup_material_request(order=True, receive=True, days=2) # complete (ordered & received) + + self.filters = frappe._dict( + company="_Test Company", + from_date=today(), + to_date=add_days(today(), 30), + item_code="Test MR Report Item", + ) + + def tearDown(self) -> None: + frappe.db.rollback() + + def test_date_range(self): + data = get_data(self.filters) + self.assertEqual(len(data), 2) # MRs today should be fetched + + data = get_data(self.filters.update({"from_date": add_days(today(), 10)})) + self.assertEqual(len(data), 0) # MRs today should not be fetched as from date is in future + + def test_ordered_received_material_requests(self): + data = get_data(self.filters) + + # from the 3 MRs made, only 2 (to receive) should be fetched + self.assertEqual(len(data), 2) + self.assertEqual(data[0].ordered_qty, 0.0) + self.assertEqual(data[1].ordered_qty, 57.0) + + def setup_material_request(self, order=False, receive=False, days=0): + po = None + test_records = frappe.get_test_records("Material Request") + + mr = frappe.copy_doc(test_records[0]) + mr.transaction_date = add_days(today(), days) + mr.schedule_date = add_days(mr.transaction_date, 1) + for row in mr.items: + row.item_code = "Test MR Report Item" + row.item_name = "Test MR Report Item" + row.description = "Test MR Report Item" + row.uom = "Nos" + row.schedule_date = mr.schedule_date + mr.submit() + + if order or receive: + po = make_purchase_order(mr.name) + po.supplier = "_Test Supplier" + po.submit() + if receive: + pr = make_purchase_receipt(po.name) + pr.submit() diff --git a/erpnext/buying/report/subcontract_order_summary/subcontract_order_summary.py b/erpnext/buying/report/subcontract_order_summary/subcontract_order_summary.py index 8e5c2f9a30d..1b2705a7be3 100644 --- a/erpnext/buying/report/subcontract_order_summary/subcontract_order_summary.py +++ b/erpnext/buying/report/subcontract_order_summary/subcontract_order_summary.py @@ -13,6 +13,7 @@ def execute(filters=None): return columns, data + def get_data(report_filters): data = [] orders = get_subcontracted_orders(report_filters) @@ -24,57 +25,85 @@ def get_data(report_filters): return data + def get_subcontracted_orders(report_filters): - fields = ['`tabPurchase Order Item`.`parent` as po_id', '`tabPurchase Order Item`.`item_code`', - '`tabPurchase Order Item`.`item_name`', '`tabPurchase Order Item`.`qty`', '`tabPurchase Order Item`.`name`', - '`tabPurchase Order Item`.`received_qty`', '`tabPurchase Order`.`status`'] + fields = [ + "`tabPurchase Order Item`.`parent` as po_id", + "`tabPurchase Order Item`.`item_code`", + "`tabPurchase Order Item`.`item_name`", + "`tabPurchase Order Item`.`qty`", + "`tabPurchase Order Item`.`name`", + "`tabPurchase Order Item`.`received_qty`", + "`tabPurchase Order`.`status`", + ] filters = get_filters(report_filters) - return frappe.get_all('Purchase Order', fields = fields, filters=filters) or [] + return frappe.get_all("Purchase Order", fields=fields, filters=filters) or [] + def get_filters(report_filters): - filters = [['Purchase Order', 'docstatus', '=', 1], ['Purchase Order', 'is_subcontracted', '=', 'Yes'], - ['Purchase Order', 'transaction_date', 'between', (report_filters.from_date, report_filters.to_date)]] + filters = [ + ["Purchase Order", "docstatus", "=", 1], + ["Purchase Order", "is_subcontracted", "=", "Yes"], + [ + "Purchase Order", + "transaction_date", + "between", + (report_filters.from_date, report_filters.to_date), + ], + ] - for field in ['name', 'company']: + for field in ["name", "company"]: if report_filters.get(field): - filters.append(['Purchase Order', field, '=', report_filters.get(field)]) + filters.append(["Purchase Order", field, "=", report_filters.get(field)]) return filters + def get_supplied_items(orders, report_filters): if not orders: return [] - fields = ['parent', 'main_item_code', 'rm_item_code', 'required_qty', - 'supplied_qty', 'returned_qty', 'total_supplied_qty', 'consumed_qty', 'reference_name'] + fields = [ + "parent", + "main_item_code", + "rm_item_code", + "required_qty", + "supplied_qty", + "returned_qty", + "total_supplied_qty", + "consumed_qty", + "reference_name", + ] - filters = {'parent': ('in', [d.po_id for d in orders]), 'docstatus': 1} + filters = {"parent": ("in", [d.po_id for d in orders]), "docstatus": 1} supplied_items = {} - for row in frappe.get_all('Purchase Order Item Supplied', fields = fields, filters=filters): + for row in frappe.get_all("Purchase Order Item Supplied", fields=fields, filters=filters): new_key = (row.parent, row.reference_name, row.main_item_code) supplied_items.setdefault(new_key, []).append(row) return supplied_items + def prepare_subcontracted_data(orders, supplied_items): po_details = {} for row in orders: key = (row.po_id, row.name, row.item_code) if key not in po_details: - po_details.setdefault(key, frappe._dict({'po_item': row, 'supplied_items': []})) + po_details.setdefault(key, frappe._dict({"po_item": row, "supplied_items": []})) details = po_details[key] if supplied_items.get(key): for supplied_item in supplied_items[key]: - details['supplied_items'].append(supplied_item) + details["supplied_items"].append(supplied_item) return po_details + def get_subcontracted_data(po_details, data): for key, details in po_details.items(): res = details.po_item @@ -85,6 +114,7 @@ def get_subcontracted_data(po_details, data): res.update(row) data.append(res) + def get_columns(): return [ { @@ -92,62 +122,27 @@ def get_columns(): "fieldname": "po_id", "fieldtype": "Link", "options": "Purchase Order", - "width": 100 - }, - { - "label": _("Status"), - "fieldname": "status", - "fieldtype": "Data", - "width": 80 + "width": 100, }, + {"label": _("Status"), "fieldname": "status", "fieldtype": "Data", "width": 80}, { "label": _("Subcontracted Item"), "fieldname": "item_code", "fieldtype": "Link", "options": "Item", - "width": 160 - }, - { - "label": _("Order Qty"), - "fieldname": "qty", - "fieldtype": "Float", - "width": 90 - }, - { - "label": _("Received Qty"), - "fieldname": "received_qty", - "fieldtype": "Float", - "width": 110 + "width": 160, }, + {"label": _("Order Qty"), "fieldname": "qty", "fieldtype": "Float", "width": 90}, + {"label": _("Received Qty"), "fieldname": "received_qty", "fieldtype": "Float", "width": 110}, { "label": _("Supplied Item"), "fieldname": "rm_item_code", "fieldtype": "Link", "options": "Item", - "width": 160 + "width": 160, }, - { - "label": _("Required Qty"), - "fieldname": "required_qty", - "fieldtype": "Float", - "width": 110 - }, - { - "label": _("Supplied Qty"), - "fieldname": "supplied_qty", - "fieldtype": "Float", - "width": 110 - }, - { - "label": _("Consumed Qty"), - "fieldname": "consumed_qty", - "fieldtype": "Float", - "width": 120 - }, - { - "label": _("Returned Qty"), - "fieldname": "returned_qty", - "fieldtype": "Float", - "width": 110 - } + {"label": _("Required Qty"), "fieldname": "required_qty", "fieldtype": "Float", "width": 110}, + {"label": _("Supplied Qty"), "fieldname": "supplied_qty", "fieldtype": "Float", "width": 110}, + {"label": _("Consumed Qty"), "fieldname": "consumed_qty", "fieldtype": "Float", "width": 120}, + {"label": _("Returned Qty"), "fieldname": "returned_qty", "fieldtype": "Float", "width": 110}, ] diff --git a/erpnext/buying/report/subcontracted_item_to_be_received/subcontracted_item_to_be_received.py b/erpnext/buying/report/subcontracted_item_to_be_received/subcontracted_item_to_be_received.py index 67e275f9851..004657b6e86 100644 --- a/erpnext/buying/report/subcontracted_item_to_be_received/subcontracted_item_to_be_received.py +++ b/erpnext/buying/report/subcontracted_item_to_be_received/subcontracted_item_to_be_received.py @@ -12,9 +12,10 @@ def execute(filters=None): data = [] columns = get_columns() - get_data(data , filters) + get_data(data, filters) return columns, data + def get_columns(): return [ { @@ -22,54 +23,39 @@ def get_columns(): "fieldtype": "Link", "fieldname": "purchase_order", "options": "Purchase Order", - "width": 150 - }, - { - "label": _("Date"), - "fieldtype": "Date", - "fieldname": "date", - "hidden": 1, - "width": 150 + "width": 150, }, + {"label": _("Date"), "fieldtype": "Date", "fieldname": "date", "hidden": 1, "width": 150}, { "label": _("Supplier"), "fieldtype": "Link", "fieldname": "supplier", "options": "Supplier", - "width": 150 + "width": 150, }, { "label": _("Finished Good Item Code"), "fieldtype": "Data", "fieldname": "fg_item_code", - "width": 100 - }, - { - "label": _("Item name"), - "fieldtype": "Data", - "fieldname": "item_name", - "width": 100 + "width": 100, }, + {"label": _("Item name"), "fieldtype": "Data", "fieldname": "item_name", "width": 100}, { "label": _("Required Quantity"), "fieldtype": "Float", "fieldname": "required_qty", - "width": 100 + "width": 100, }, { "label": _("Received Quantity"), "fieldtype": "Float", "fieldname": "received_qty", - "width": 100 + "width": 100, }, - { - "label": _("Pending Quantity"), - "fieldtype": "Float", - "fieldname": "pending_qty", - "width": 100 - } + {"label": _("Pending Quantity"), "fieldtype": "Float", "fieldname": "pending_qty", "width": 100}, ] + def get_data(data, filters): po = get_po(filters) po_name = [v.name for v in po] @@ -77,29 +63,35 @@ def get_data(data, filters): for item in sub_items: for order in po: if order.name == item.parent and item.received_qty < item.qty: - row ={ - 'purchase_order': item.parent, - 'date': order.transaction_date, - 'supplier': order.supplier, - 'fg_item_code': item.item_code, - 'item_name': item.item_name, - 'required_qty': item.qty, - 'received_qty':item.received_qty, - 'pending_qty':item.qty - item.received_qty + row = { + "purchase_order": item.parent, + "date": order.transaction_date, + "supplier": order.supplier, + "fg_item_code": item.item_code, + "item_name": item.item_name, + "required_qty": item.qty, + "received_qty": item.received_qty, + "pending_qty": item.qty - item.received_qty, } data.append(row) + def get_po(filters): record_filters = [ - ["is_subcontracted", "=", "Yes"], - ["supplier", "=", filters.supplier], - ["transaction_date", "<=", filters.to_date], - ["transaction_date", ">=", filters.from_date], - ["docstatus", "=", 1] - ] - return frappe.get_all("Purchase Order", filters=record_filters, fields=["name", "transaction_date", "supplier"]) + ["is_subcontracted", "=", "Yes"], + ["supplier", "=", filters.supplier], + ["transaction_date", "<=", filters.to_date], + ["transaction_date", ">=", filters.from_date], + ["docstatus", "=", 1], + ] + return frappe.get_all( + "Purchase Order", filters=record_filters, fields=["name", "transaction_date", "supplier"] + ) + def get_purchase_order_item_supplied(po): - return frappe.get_all("Purchase Order Item", filters=[ - ('parent', 'IN', po) - ], fields=["parent", "item_code", "item_name", "qty", "received_qty"]) + return frappe.get_all( + "Purchase Order Item", + filters=[("parent", "IN", po)], + fields=["parent", "item_code", "item_name", "qty", "received_qty"], + ) diff --git a/erpnext/buying/report/subcontracted_item_to_be_received/test_subcontracted_item_to_be_received.py b/erpnext/buying/report/subcontracted_item_to_be_received/test_subcontracted_item_to_be_received.py index 144523ad522..26e4243eeee 100644 --- a/erpnext/buying/report/subcontracted_item_to_be_received/test_subcontracted_item_to_be_received.py +++ b/erpnext/buying/report/subcontracted_item_to_be_received/test_subcontracted_item_to_be_received.py @@ -3,9 +3,9 @@ # Compiled at: 2019-05-06 09:51:46 # Decompiled by https://python-decompiler.com -import unittest import frappe +from frappe.tests.utils import FrappeTestCase from erpnext.buying.doctype.purchase_order.purchase_order import make_purchase_receipt from erpnext.buying.doctype.purchase_order.test_purchase_order import create_purchase_order @@ -15,27 +15,41 @@ from erpnext.buying.report.subcontracted_item_to_be_received.subcontracted_item_ from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry -class TestSubcontractedItemToBeReceived(unittest.TestCase): - +class TestSubcontractedItemToBeReceived(FrappeTestCase): def test_pending_and_received_qty(self): - po = create_purchase_order(item_code='_Test FG Item', is_subcontracted='Yes') + po = create_purchase_order(item_code="_Test FG Item", is_subcontracted="Yes") transfer_param = [] - make_stock_entry(item_code='_Test Item', target='_Test Warehouse 1 - _TC', qty=100, basic_rate=100) - make_stock_entry(item_code='_Test Item Home Desktop 100', target='_Test Warehouse 1 - _TC', qty=100, basic_rate=100) + make_stock_entry( + item_code="_Test Item", target="_Test Warehouse 1 - _TC", qty=100, basic_rate=100 + ) + make_stock_entry( + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse 1 - _TC", + qty=100, + basic_rate=100, + ) make_purchase_receipt_against_po(po.name) po.reload() - col, data = execute(filters=frappe._dict({'supplier': po.supplier, - 'from_date': frappe.utils.get_datetime(frappe.utils.add_to_date(po.transaction_date, days=-10)), - 'to_date': frappe.utils.get_datetime(frappe.utils.add_to_date(po.transaction_date, days=10))})) - self.assertEqual(data[0]['pending_qty'], 5) - self.assertEqual(data[0]['received_qty'], 5) - self.assertEqual(data[0]['purchase_order'], po.name) - self.assertEqual(data[0]['supplier'], po.supplier) + col, data = execute( + filters=frappe._dict( + { + "supplier": po.supplier, + "from_date": frappe.utils.get_datetime( + frappe.utils.add_to_date(po.transaction_date, days=-10) + ), + "to_date": frappe.utils.get_datetime(frappe.utils.add_to_date(po.transaction_date, days=10)), + } + ) + ) + self.assertEqual(data[0]["pending_qty"], 5) + self.assertEqual(data[0]["received_qty"], 5) + self.assertEqual(data[0]["purchase_order"], po.name) + self.assertEqual(data[0]["supplier"], po.supplier) def make_purchase_receipt_against_po(po, quantity=5): pr = make_purchase_receipt(po) pr.items[0].qty = quantity - pr.supplier_warehouse = '_Test Warehouse 1 - _TC' + pr.supplier_warehouse = "_Test Warehouse 1 - _TC" pr.insert() pr.submit() diff --git a/erpnext/buying/report/subcontracted_raw_materials_to_be_transferred/subcontracted_raw_materials_to_be_transferred.py b/erpnext/buying/report/subcontracted_raw_materials_to_be_transferred/subcontracted_raw_materials_to_be_transferred.py index 6b605add4c7..98b18da4acb 100644 --- a/erpnext/buying/report/subcontracted_raw_materials_to_be_transferred/subcontracted_raw_materials_to_be_transferred.py +++ b/erpnext/buying/report/subcontracted_raw_materials_to_be_transferred/subcontracted_raw_materials_to_be_transferred.py @@ -15,6 +15,7 @@ def execute(filters=None): return columns, data or [] + def get_columns(): return [ { @@ -22,47 +23,28 @@ def get_columns(): "fieldtype": "Link", "fieldname": "purchase_order", "options": "Purchase Order", - "width": 200 - }, - { - "label": _("Date"), - "fieldtype": "Date", - "fieldname": "date", - "width": 150 + "width": 200, }, + {"label": _("Date"), "fieldtype": "Date", "fieldname": "date", "width": 150}, { "label": _("Supplier"), "fieldtype": "Link", "fieldname": "supplier", "options": "Supplier", - "width": 150 - }, - { - "label": _("Item Code"), - "fieldtype": "Data", - "fieldname": "rm_item_code", - "width": 150 - }, - { - "label": _("Required Quantity"), - "fieldtype": "Float", - "fieldname": "reqd_qty", - "width": 150 + "width": 150, }, + {"label": _("Item Code"), "fieldtype": "Data", "fieldname": "rm_item_code", "width": 150}, + {"label": _("Required Quantity"), "fieldtype": "Float", "fieldname": "reqd_qty", "width": 150}, { "label": _("Transferred Quantity"), "fieldtype": "Float", "fieldname": "transferred_qty", - "width": 200 + "width": 200, }, - { - "label": _("Pending Quantity"), - "fieldtype": "Float", - "fieldname": "p_qty", - "width": 150 - } + {"label": _("Pending Quantity"), "fieldtype": "Float", "fieldname": "p_qty", "width": 150}, ] + def get_data(filters): po_rm_item_details = get_po_items_to_supply(filters) @@ -76,6 +58,7 @@ def get_data(filters): return data + def get_po_items_to_supply(filters): return frappe.db.get_all( "Purchase Order", @@ -85,14 +68,14 @@ def get_po_items_to_supply(filters): "supplier as supplier", "`tabPurchase Order Item Supplied`.rm_item_code as rm_item_code", "`tabPurchase Order Item Supplied`.required_qty as reqd_qty", - "`tabPurchase Order Item Supplied`.supplied_qty as transferred_qty" + "`tabPurchase Order Item Supplied`.supplied_qty as transferred_qty", ], - filters = [ + filters=[ ["Purchase Order", "per_received", "<", "100"], ["Purchase Order", "is_subcontracted", "=", "Yes"], ["Purchase Order", "supplier", "=", filters.supplier], ["Purchase Order", "transaction_date", "<=", filters.to_date], ["Purchase Order", "transaction_date", ">=", filters.from_date], - ["Purchase Order", "docstatus", "=", 1] - ] + ["Purchase Order", "docstatus", "=", 1], + ], ) diff --git a/erpnext/buying/report/subcontracted_raw_materials_to_be_transferred/test_subcontracted_raw_materials_to_be_transferred.py b/erpnext/buying/report/subcontracted_raw_materials_to_be_transferred/test_subcontracted_raw_materials_to_be_transferred.py index 3c203ac23fa..401176d5cef 100644 --- a/erpnext/buying/report/subcontracted_raw_materials_to_be_transferred/test_subcontracted_raw_materials_to_be_transferred.py +++ b/erpnext/buying/report/subcontracted_raw_materials_to_be_transferred/test_subcontracted_raw_materials_to_be_transferred.py @@ -4,9 +4,9 @@ # Decompiled by https://python-decompiler.com import json -import unittest import frappe +from frappe.tests.utils import FrappeTestCase from erpnext.buying.doctype.purchase_order.purchase_order import make_rm_stock_entry from erpnext.buying.doctype.purchase_order.test_purchase_order import create_purchase_order @@ -16,83 +16,88 @@ from erpnext.buying.report.subcontracted_raw_materials_to_be_transferred.subcont from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry -class TestSubcontractedItemToBeTransferred(unittest.TestCase): - +class TestSubcontractedItemToBeTransferred(FrappeTestCase): def test_pending_and_transferred_qty(self): - po = create_purchase_order(item_code='_Test FG Item', is_subcontracted='Yes', supplier_warehouse="_Test Warehouse 1 - _TC") + po = create_purchase_order( + item_code="_Test FG Item", is_subcontracted="Yes", supplier_warehouse="_Test Warehouse 1 - _TC" + ) # Material Receipt of RMs - make_stock_entry(item_code='_Test Item', target='_Test Warehouse - _TC', qty=100, basic_rate=100) - make_stock_entry(item_code='_Test Item Home Desktop 100', target='_Test Warehouse - _TC', qty=100, basic_rate=100) + make_stock_entry(item_code="_Test Item", target="_Test Warehouse - _TC", qty=100, basic_rate=100) + make_stock_entry( + item_code="_Test Item Home Desktop 100", target="_Test Warehouse - _TC", qty=100, basic_rate=100 + ) se = transfer_subcontracted_raw_materials(po) - col, data = execute(filters=frappe._dict( - { - 'supplier': po.supplier, - 'from_date': frappe.utils.get_datetime(frappe.utils.add_to_date(po.transaction_date, days=-10)), - 'to_date': frappe.utils.get_datetime(frappe.utils.add_to_date(po.transaction_date, days=10)) - } - )) + col, data = execute( + filters=frappe._dict( + { + "supplier": po.supplier, + "from_date": frappe.utils.get_datetime( + frappe.utils.add_to_date(po.transaction_date, days=-10) + ), + "to_date": frappe.utils.get_datetime(frappe.utils.add_to_date(po.transaction_date, days=10)), + } + ) + ) po.reload() - po_data = [row for row in data if row.get('purchase_order') == po.name] + po_data = [row for row in data if row.get("purchase_order") == po.name] # Alphabetically sort to be certain of order - po_data = sorted(po_data, key = lambda i: i['rm_item_code']) + po_data = sorted(po_data, key=lambda i: i["rm_item_code"]) self.assertEqual(len(po_data), 2) - self.assertEqual(po_data[0]['purchase_order'], po.name) + self.assertEqual(po_data[0]["purchase_order"], po.name) - self.assertEqual(po_data[0]['rm_item_code'], '_Test Item') - self.assertEqual(po_data[0]['p_qty'], 8) - self.assertEqual(po_data[0]['transferred_qty'], 2) + self.assertEqual(po_data[0]["rm_item_code"], "_Test Item") + self.assertEqual(po_data[0]["p_qty"], 8) + self.assertEqual(po_data[0]["transferred_qty"], 2) - self.assertEqual(po_data[1]['rm_item_code'], '_Test Item Home Desktop 100') - self.assertEqual(po_data[1]['p_qty'], 19) - self.assertEqual(po_data[1]['transferred_qty'], 1) + self.assertEqual(po_data[1]["rm_item_code"], "_Test Item Home Desktop 100") + self.assertEqual(po_data[1]["p_qty"], 19) + self.assertEqual(po_data[1]["transferred_qty"], 1) se.cancel() po.cancel() + def transfer_subcontracted_raw_materials(po): # Order of supplied items fetched in PO is flaky - transfer_qty_map = { - '_Test Item': 2, - '_Test Item Home Desktop 100': 1 - } + transfer_qty_map = {"_Test Item": 2, "_Test Item Home Desktop 100": 1} item_1 = po.supplied_items[0].rm_item_code item_2 = po.supplied_items[1].rm_item_code rm_item = [ { - 'name': po.supplied_items[0].name, - 'item_code': item_1, - 'rm_item_code': item_1, - 'item_name': item_1, - 'qty': transfer_qty_map[item_1], - 'warehouse': '_Test Warehouse - _TC', - 'rate': 100, - 'amount': 100 * transfer_qty_map[item_1], - 'stock_uom': 'Nos' + "name": po.supplied_items[0].name, + "item_code": item_1, + "rm_item_code": item_1, + "item_name": item_1, + "qty": transfer_qty_map[item_1], + "warehouse": "_Test Warehouse - _TC", + "rate": 100, + "amount": 100 * transfer_qty_map[item_1], + "stock_uom": "Nos", }, { - 'name': po.supplied_items[1].name, - 'item_code': item_2, - 'rm_item_code': item_2, - 'item_name': item_2, - 'qty': transfer_qty_map[item_2], - 'warehouse': '_Test Warehouse - _TC', - 'rate': 100, - 'amount': 100 * transfer_qty_map[item_2], - 'stock_uom': 'Nos' - } + "name": po.supplied_items[1].name, + "item_code": item_2, + "rm_item_code": item_2, + "item_name": item_2, + "qty": transfer_qty_map[item_2], + "warehouse": "_Test Warehouse - _TC", + "rate": 100, + "amount": 100 * transfer_qty_map[item_2], + "stock_uom": "Nos", + }, ] rm_item_string = json.dumps(rm_item) se = frappe.get_doc(make_rm_stock_entry(po.name, rm_item_string)) - se.from_warehouse = '_Test Warehouse - _TC' - se.to_warehouse = '_Test Warehouse - _TC' - se.stock_entry_type = 'Send to Subcontractor' + se.from_warehouse = "_Test Warehouse - _TC" + se.to_warehouse = "_Test Warehouse - _TC" + se.stock_entry_type = "Send to Subcontractor" se.save() se.submit() return se diff --git a/erpnext/buying/report/supplier_quotation_comparison/supplier_quotation_comparison.py b/erpnext/buying/report/supplier_quotation_comparison/supplier_quotation_comparison.py index 65f9ce3c57e..3013b6d1607 100644 --- a/erpnext/buying/report/supplier_quotation_comparison/supplier_quotation_comparison.py +++ b/erpnext/buying/report/supplier_quotation_comparison/supplier_quotation_comparison.py @@ -24,6 +24,7 @@ def execute(filters=None): return columns, data, message, chart_data + def get_conditions(filters): conditions = "" if filters.get("item_code"): @@ -43,8 +44,10 @@ def get_conditions(filters): return conditions + def get_data(filters, conditions): - supplier_quotation_data = frappe.db.sql(""" + supplier_quotation_data = frappe.db.sql( + """ SELECT sqi.parent, sqi.item_code, sqi.qty, sqi.stock_qty, sqi.amount, @@ -60,23 +63,33 @@ def get_data(filters, conditions): AND sq.company = %(company)s AND sq.transaction_date between %(from_date)s and %(to_date)s {0} - order by sq.transaction_date, sqi.item_code""".format(conditions), filters, as_dict=1) + order by sq.transaction_date, sqi.item_code""".format( + conditions + ), + filters, + as_dict=1, + ) return supplier_quotation_data + def prepare_data(supplier_quotation_data, filters): out, groups, qty_list, suppliers, chart_data = [], [], [], [], [] group_wise_map = defaultdict(list) supplier_qty_price_map = {} - group_by_field = "supplier_name" if filters.get("group_by") == "Group by Supplier" else "item_code" + group_by_field = ( + "supplier_name" if filters.get("group_by") == "Group by Supplier" else "item_code" + ) company_currency = frappe.db.get_default("currency") float_precision = cint(frappe.db.get_default("float_precision")) or 2 for data in supplier_quotation_data: - group = data.get(group_by_field) # get item or supplier value for this row + group = data.get(group_by_field) # get item or supplier value for this row - supplier_currency = frappe.db.get_value("Supplier", data.get("supplier_name"), "default_currency") + supplier_currency = frappe.db.get_value( + "Supplier", data.get("supplier_name"), "default_currency" + ) if supplier_currency: exchange_rate = get_exchange_rate(supplier_currency, company_currency) @@ -84,16 +97,18 @@ def prepare_data(supplier_quotation_data, filters): exchange_rate = 1 row = { - "item_code": "" if group_by_field=="item_code" else data.get("item_code"), # leave blank if group by field - "supplier_name": "" if group_by_field=="supplier_name" else data.get("supplier_name"), + "item_code": "" + if group_by_field == "item_code" + else data.get("item_code"), # leave blank if group by field + "supplier_name": "" if group_by_field == "supplier_name" else data.get("supplier_name"), "quotation": data.get("parent"), "qty": data.get("qty"), "price": flt(data.get("amount") * exchange_rate, float_precision), "uom": data.get("uom"), - "stock_uom": data.get('stock_uom'), + "stock_uom": data.get("stock_uom"), "request_for_quotation": data.get("request_for_quotation"), - "valid_till": data.get('valid_till'), - "lead_time_days": data.get('lead_time_days') + "valid_till": data.get("valid_till"), + "lead_time_days": data.get("lead_time_days"), } row["price_per_unit"] = flt(row["price"]) / (flt(data.get("stock_qty")) or 1) @@ -119,8 +134,8 @@ def prepare_data(supplier_quotation_data, filters): # final data format for report view for group in groups: - group_entries = group_wise_map[group] # all entries pertaining to item/supplier - group_entries[0].update({group_by_field : group}) # Add item/supplier name in first group row + group_entries = group_wise_map[group] # all entries pertaining to item/supplier + group_entries[0].update({group_by_field: group}) # Add item/supplier name in first group row if highlight_min_price: prices = [group_entry["price_per_unit"] for group_entry in group_entries] @@ -137,6 +152,7 @@ def prepare_data(supplier_quotation_data, filters): return out, chart_data + def prepare_chart_data(suppliers, qty_list, supplier_qty_price_map): data_points_map = {} qty_list.sort() @@ -157,107 +173,89 @@ def prepare_chart_data(suppliers, qty_list, supplier_qty_price_map): for qty in qty_list: datapoints = { "name": currency_symbol + " (Qty " + str(qty) + " )", - "values": data_points_map[qty] + "values": data_points_map[qty], } dataset.append(datapoints) - chart_data = { - "data": { - "labels": suppliers, - "datasets": dataset - }, - "type": "bar" - } + chart_data = {"data": {"labels": suppliers, "datasets": dataset}, "type": "bar"} return chart_data + def get_columns(filters): group_by_columns = [ - { - "fieldname": "supplier_name", - "label": _("Supplier"), - "fieldtype": "Link", - "options": "Supplier", - "width": 150 - }, - { - "fieldname": "item_code", - "label": _("Item"), - "fieldtype": "Link", - "options": "Item", - "width": 150 - }] + { + "fieldname": "supplier_name", + "label": _("Supplier"), + "fieldtype": "Link", + "options": "Supplier", + "width": 150, + }, + { + "fieldname": "item_code", + "label": _("Item"), + "fieldtype": "Link", + "options": "Item", + "width": 150, + }, + ] columns = [ - { - "fieldname": "uom", - "label": _("UOM"), - "fieldtype": "Link", - "options": "UOM", - "width": 90 - }, - { - "fieldname": "qty", - "label": _("Quantity"), - "fieldtype": "Float", - "width": 80 - }, - { - "fieldname": "price", - "label": _("Price"), - "fieldtype": "Currency", - "options": "Company:company:default_currency", - "width": 110 - }, - { - "fieldname": "stock_uom", - "label": _("Stock UOM"), - "fieldtype": "Link", - "options": "UOM", - "width": 90 - }, - { - "fieldname": "price_per_unit", - "label": _("Price per Unit (Stock UOM)"), - "fieldtype": "Currency", - "options": "Company:company:default_currency", - "width": 120 - }, - { - "fieldname": "quotation", - "label": _("Supplier Quotation"), - "fieldtype": "Link", - "options": "Supplier Quotation", - "width": 200 - }, - { - "fieldname": "valid_till", - "label": _("Valid Till"), - "fieldtype": "Date", - "width": 100 - }, - { - "fieldname": "lead_time_days", - "label": _("Lead Time (Days)"), - "fieldtype": "Int", - "width": 100 - }, - { - "fieldname": "request_for_quotation", - "label": _("Request for Quotation"), - "fieldtype": "Link", - "options": "Request for Quotation", - "width": 150 - }] + {"fieldname": "uom", "label": _("UOM"), "fieldtype": "Link", "options": "UOM", "width": 90}, + {"fieldname": "qty", "label": _("Quantity"), "fieldtype": "Float", "width": 80}, + { + "fieldname": "price", + "label": _("Price"), + "fieldtype": "Currency", + "options": "Company:company:default_currency", + "width": 110, + }, + { + "fieldname": "stock_uom", + "label": _("Stock UOM"), + "fieldtype": "Link", + "options": "UOM", + "width": 90, + }, + { + "fieldname": "price_per_unit", + "label": _("Price per Unit (Stock UOM)"), + "fieldtype": "Currency", + "options": "Company:company:default_currency", + "width": 120, + }, + { + "fieldname": "quotation", + "label": _("Supplier Quotation"), + "fieldtype": "Link", + "options": "Supplier Quotation", + "width": 200, + }, + {"fieldname": "valid_till", "label": _("Valid Till"), "fieldtype": "Date", "width": 100}, + { + "fieldname": "lead_time_days", + "label": _("Lead Time (Days)"), + "fieldtype": "Int", + "width": 100, + }, + { + "fieldname": "request_for_quotation", + "label": _("Request for Quotation"), + "fieldtype": "Link", + "options": "Request for Quotation", + "width": 150, + }, + ] if filters.get("group_by") == "Group by Item": group_by_columns.reverse() - columns[0:0] = group_by_columns # add positioned group by columns to the report + columns[0:0] = group_by_columns # add positioned group by columns to the report return columns + def get_message(): - return """ + return """ Valid till : diff --git a/erpnext/buying/utils.py b/erpnext/buying/utils.py index 66c60d56379..e904af0dce3 100644 --- a/erpnext/buying/utils.py +++ b/erpnext/buying/utils.py @@ -3,18 +3,19 @@ import json +from typing import Dict import frappe from frappe import _ -from frappe.utils import cint, cstr, flt +from frappe.utils import cint, cstr, flt, getdate from erpnext.stock.doctype.item.item import get_last_purchase_details, validate_end_of_life -def update_last_purchase_rate(doc, is_submit): +def update_last_purchase_rate(doc, is_submit) -> None: """updates last_purchase_rate in item table for each item""" - import frappe.utils - this_purchase_date = frappe.utils.getdate(doc.get('posting_date') or doc.get('transaction_date')) + + this_purchase_date = getdate(doc.get("posting_date") or doc.get("transaction_date")) for d in doc.get("items"): # get last purchase details @@ -22,9 +23,10 @@ def update_last_purchase_rate(doc, is_submit): # compare last purchase date and this transaction's date last_purchase_rate = None - if last_purchase_details and \ - (doc.get('docstatus') == 2 or last_purchase_details.purchase_date > this_purchase_date): - last_purchase_rate = last_purchase_details['base_net_rate'] + if last_purchase_details and ( + doc.get("docstatus") == 2 or last_purchase_details.purchase_date > this_purchase_date + ): + last_purchase_rate = last_purchase_details["base_net_rate"] elif is_submit == 1: # even if this transaction is the latest one, it should be submitted # for it to be considered for latest purchase rate @@ -36,12 +38,10 @@ def update_last_purchase_rate(doc, is_submit): frappe.throw(_("UOM Conversion factor is required in row {0}").format(d.idx)) # update last purchsae rate - frappe.db.set_value('Item', d.item_code, 'last_purchase_rate', flt(last_purchase_rate)) + frappe.db.set_value("Item", d.item_code, "last_purchase_rate", flt(last_purchase_rate)) - - -def validate_for_items(doc): +def validate_for_items(doc) -> None: items = [] for d in doc.get("items"): if not d.qty: @@ -49,45 +49,87 @@ def validate_for_items(doc): continue frappe.throw(_("Please enter quantity for Item {0}").format(d.item_code)) - # update with latest quantities - bin = frappe.db.sql("""select projected_qty from `tabBin` where - item_code = %s and warehouse = %s""", (d.item_code, d.warehouse), as_dict=1) - - f_lst ={'projected_qty': bin and flt(bin[0]['projected_qty']) or 0, 'ordered_qty': 0, 'received_qty' : 0} - if d.doctype in ('Purchase Receipt Item', 'Purchase Invoice Item'): - f_lst.pop('received_qty') - for x in f_lst : - if d.meta.get_field(x): - d.set(x, f_lst[x]) - - item = frappe.db.sql("""select is_stock_item, - is_sub_contracted_item, end_of_life, disabled from `tabItem` where name=%s""", - d.item_code, as_dict=1)[0] - + set_stock_levels(row=d) # update with latest quantities + item = validate_item_and_get_basic_data(row=d) + validate_stock_item_warehouse(row=d, item=item) validate_end_of_life(d.item_code, item.end_of_life, item.disabled) - # validate stock item - if item.is_stock_item==1 and d.qty and not d.warehouse and not d.get("delivered_by_supplier"): - frappe.throw(_("Warehouse is mandatory for stock Item {0} in row {1}").format(d.item_code, d.idx)) - items.append(cstr(d.item_code)) - if items and len(items) != len(set(items)) and \ - not cint(frappe.db.get_single_value("Buying Settings", "allow_multiple_items") or 0): + if ( + items + and len(items) != len(set(items)) + and not cint(frappe.db.get_single_value("Buying Settings", "allow_multiple_items") or 0) + ): frappe.throw(_("Same item cannot be entered multiple times.")) -def check_on_hold_or_closed_status(doctype, docname): + +def set_stock_levels(row) -> None: + projected_qty = frappe.db.get_value( + "Bin", + { + "item_code": row.item_code, + "warehouse": row.warehouse, + }, + "projected_qty", + ) + + qty_data = { + "projected_qty": flt(projected_qty), + "ordered_qty": 0, + "received_qty": 0, + } + if row.doctype in ("Purchase Receipt Item", "Purchase Invoice Item"): + qty_data.pop("received_qty") + + for field in qty_data: + if row.meta.get_field(field): + row.set(field, qty_data[field]) + + +def validate_item_and_get_basic_data(row) -> Dict: + item = frappe.db.get_values( + "Item", + filters={"name": row.item_code}, + fieldname=["is_stock_item", "is_sub_contracted_item", "end_of_life", "disabled"], + as_dict=1, + ) + if not item: + frappe.throw(_("Row #{0}: Item {1} does not exist").format(row.idx, frappe.bold(row.item_code))) + + return item[0] + + +def validate_stock_item_warehouse(row, item) -> None: + if ( + item.is_stock_item == 1 + and row.qty + and not row.warehouse + and not row.get("delivered_by_supplier") + ): + frappe.throw( + _("Row #{1}: Warehouse is mandatory for stock Item {0}").format( + frappe.bold(row.item_code), row.idx + ) + ) + + +def check_on_hold_or_closed_status(doctype, docname) -> None: status = frappe.db.get_value(doctype, docname, "status") if status in ("Closed", "On Hold"): - frappe.throw(_("{0} {1} status is {2}").format(doctype, docname, status), frappe.InvalidStatusError) + frappe.throw( + _("{0} {1} status is {2}").format(doctype, docname, status), frappe.InvalidStatusError + ) + @frappe.whitelist() def get_linked_material_requests(items): items = json.loads(items) mr_list = [] for item in items: - material_request = frappe.db.sql("""SELECT distinct mr.name AS mr_name, + material_request = frappe.db.sql( + """SELECT distinct mr.name AS mr_name, (mr_item.qty - mr_item.ordered_qty) AS qty, mr_item.item_code AS item_code, mr_item.name AS mr_item @@ -98,7 +140,10 @@ def get_linked_material_requests(items): AND mr.per_ordered < 99.99 AND mr.docstatus = 1 AND mr.status != 'Stopped' - ORDER BY mr_item.item_code ASC""",{"item": item}, as_dict=1) + ORDER BY mr_item.item_code ASC""", + {"item": item}, + as_dict=1, + ) if material_request: mr_list.append(material_request) diff --git a/erpnext/change_log/v13/v13_18_0.md b/erpnext/change_log/v13/v13_18_0.md new file mode 100644 index 00000000000..d0d83623384 --- /dev/null +++ b/erpnext/change_log/v13/v13_18_0.md @@ -0,0 +1,43 @@ +# Version 13.18.0 Release Notes + +### Features & Enhancements + +- Deferred Revenue and Expense report with actual and upcoming postings ([#28822](https://github.com/frappe/erpnext/pull/28822)) +- 'Invoice Number' field in Opening Invoice Creation Tool ([#29147](https://github.com/frappe/erpnext/pull/29147)) +- Added required_date field to set date in child table ([#28432](https://github.com/frappe/erpnext/pull/28432)) + +### Fixes + +- Enable ksa POS Invoice print format ([#28911](https://github.com/frappe/erpnext/pull/28911)) +- Rename non existent doctype field to the right one ([#29055](https://github.com/frappe/erpnext/pull/29055)) +- Mapped accounting dimensions for Bank Entry against Payroll Entry ([#29142](https://github.com/frappe/erpnext/pull/29142)) +- Validate Finished Goods for independent Manufacture entries ([#28555](https://github.com/frappe/erpnext/pull/28555)) +- Incorrect posting time fetching incorrect stock quantity in stock reconciliation ([#29103](https://github.com/frappe/erpnext/pull/29103)) +- Stock Ageing Report - Negative Opening Stock ([#28966](https://github.com/frappe/erpnext/pull/28966)) +- Can't change valuation_method on item ([#28876](https://github.com/frappe/erpnext/pull/28876)) +- Optimize rate updation on changing price list ([#28953](https://github.com/frappe/erpnext/pull/28953)) +- Added filter for dispatch address ([#28937](https://github.com/frappe/erpnext/pull/28937)) +- Convert Item links to Website Item links in `Item Card Group` template data ([#28985](https://github.com/frappe/erpnext/pull/28985)) +- Earned Leave allocation from Leave Policy Assignment ([#29163](https://github.com/frappe/erpnext/pull/29163)) +- Items not mapped when trying to create a Maintenance Visit via Maintenance Schedule ([#28917](https://github.com/frappe/erpnext/pull/28917)) +- For performance improvement, removed forcing of posting sort index on stock balance report ([#28902](https://github.com/frappe/erpnext/pull/28902)) +- Future recurring period calculation ([#29083](https://github.com/frappe/erpnext/pull/29083)) +- Nonstock items are showing in the Itemwise Recommended Reorder Level report ([#28873](https://github.com/frappe/erpnext/pull/28873)) +- Incorrect amount based on payment days in timesheet salary slip ([#28845](https://github.com/frappe/erpnext/pull/28845)) +- Currency fix for `cost` field in subscription plan ([#28821](https://github.com/frappe/erpnext/pull/28821)) +- Fetch selling price with pricing rule ([#28951](https://github.com/frappe/erpnext/pull/28951)) +- Filter out Claimed employee advances in Expense Claim ([#29046](https://github.com/frappe/erpnext/pull/29046)) +- Tax and Charges template not getting fetched based on tax category assigned ([#29092](https://github.com/frappe/erpnext/pull/29092)) +- Ignore links while setting default notification templates in Settings ([#29042](https://github.com/frappe/erpnext/pull/29042)) +- Reset "Value After Depreciation" on reversing journal entry during Asset return ([#28975](https://github.com/frappe/erpnext/pull/28975)) +- Multicurrency invoices using subscription ([#28916](https://github.com/frappe/erpnext/pull/28916)) +- Fetch the appointment letter content in the same order as template ([#28968](https://github.com/frappe/erpnext/pull/28968)) +- Incorrect serial no valuation report showing cancelled entries ([#29172](https://github.com/frappe/erpnext/pull/29172)) +- Start date validation for deferred invoices ([#29009](https://github.com/frappe/erpnext/pull/29009)) +- HSN-Wise summary report is incorrect if an invoice has same item code multiple times ([#28783](https://github.com/frappe/erpnext/pull/28783)) +- Incorrect logic for the "Reserved Qty for Production" field in BIN ([#28880](https://github.com/frappe/erpnext/pull/28880)) +- Issues in Bank Reconciliation tool ([#28996](https://github.com/frappe/erpnext/pull/28996)) +- Hide Raw Material table in the Job Card if material transfer is against work order ([#28746](https://github.com/frappe/erpnext/pull/28746)) +- Added "Is Reverse Charge" checkbox in Tax Category for Indian Companies ([#28935](https://github.com/frappe/erpnext/pull/28935)) +- Updates in term loan processing ([#28034](https://github.com/frappe/erpnext/pull/28034)) +- Incorrect bin qty on backdated reconciliation ([#28588](https://github.com/frappe/erpnext/pull/28588)) \ No newline at end of file diff --git a/erpnext/change_log/v13/v13_19_0.md b/erpnext/change_log/v13/v13_19_0.md new file mode 100644 index 00000000000..c4f7421dafd --- /dev/null +++ b/erpnext/change_log/v13/v13_19_0.md @@ -0,0 +1,52 @@ +## Version 13.19.0 Release Notes + +### Features & Enhancements + +- Allow user to change the parent company ([#28983](https://github.com/frappe/erpnext/pull/28983)) +- Option to exclude holidays while marking monthly attendance ([#29185](https://github.com/frappe/erpnext/pull/29185)) +- Early payment discount on sales & purchase orders ([#29101](https://github.com/frappe/erpnext/pull/29101)) + +### Fixes + +- Filter query in bank reconciliation tool ([#29098](https://github.com/frappe/erpnext/pull/29098)) +- Compute batch ledger in python ([#29324](https://github.com/frappe/erpnext/pull/29324)) +- GL Entries for loan repayment via Salary ([#29169](https://github.com/frappe/erpnext/pull/29169)) +- Group by Cost Center in General Ledger report only if include_dimensions is checked ([#28883](https://github.com/frappe/erpnext/pull/28883)) +- Filter for leave period in Bulk Leave Policy Assignment ([#29272](https://github.com/frappe/erpnext/pull/29272)) +- Update idx after updating items in so/po ([#29134](https://github.com/frappe/erpnext/pull/29134)) +- Avoid resetting default warehouse fields for Manufacture Entry ([#29257](https://github.com/frappe/erpnext/pull/29257)) +- Don't validate FG in repack entry ([#29271](https://github.com/frappe/erpnext/pull/29271)) +- Map Accounting Dimensions for Bank Entry against Payroll Entry ([#29142](https://github.com/frappe/erpnext/pull/29142)) +- Ignore cancelled SLEs ([#29303](https://github.com/frappe/erpnext/pull/29303)) +- Show work order progress bar even it is closed ([#29312](https://github.com/frappe/erpnext/pull/29312)) +- Incorrect serial no valuation report showing cancelled entries ([#29172](https://github.com/frappe/erpnext/pull/29172)) +- Not able to make a reverse journal entry ([#29125](https://github.com/frappe/erpnext/pull/29125)) +- Show ledger balance in Accounts Receivable and Payable summary ([#29135](https://github.com/frappe/erpnext/pull/29135)) +- Add stock queue in SLE for FIFO valuation method ([#29302](https://github.com/frappe/erpnext/pull/29302)) +- Threshold fields shows incorrect currency ([#29270](https://github.com/frappe/erpnext/pull/29270)) +- Added patch to trim whitespace from the serial numbers ([#29306](https://github.com/frappe/erpnext/pull/29306)) +- Task Depends on not removed from Gantt chart ([#28309](https://github.com/frappe/erpnext/pull/28309)) +- Earned Leave allocation from Leave Policy Assignment ([#29163](https://github.com/frappe/erpnext/pull/29163)) +- Exclude existing serial numbers while auto creating new serial numbers ([#29292](https://github.com/frappe/erpnext/pull/29292)) +- Deferred revenue booking for multi currency invoices via Journal Entry ([#29115](https://github.com/frappe/erpnext/pull/29115)) +- Fixed autoname generated for Job Applicant ([#29260](https://github.com/frappe/erpnext/pull/29260)) +- Incorrect scrap item quantity calculated in the Manufacture type stock entry ([#29179](https://github.com/frappe/erpnext/pull/29179)) +- Inconsistency in calculating outstanding amount ([#29176](https://github.com/frappe/erpnext/pull/29176)) +- Accounts are coming from different company in the dropdown ([#29280](https://github.com/frappe/erpnext/pull/29280)) +- Can't create debit note with zero quantity ([#28994](https://github.com/frappe/erpnext/pull/28994)) +- "Update Cost" should ignore overridden routing times ([#29154](https://github.com/frappe/erpnext/pull/29154)) +- Modifying Opening invoice creation tool timestamp ([#29127](https://github.com/frappe/erpnext/pull/29127)) +- Future recurring period calculation ([#29083](https://github.com/frappe/erpnext/pull/29083)) +- India localization: NIL Rated, Exempted and Non GST Invoices in GSTR-1 report ([#29208](https://github.com/frappe/erpnext/pull/29208)) +- Purchase to Stock UOM conversion on Production Plan ([#28570](https://github.com/frappe/erpnext/pull/28570)) +- Validation in POS for item batch no stock quantity ([#28907](https://github.com/frappe/erpnext/pull/28907)) +- Shopping cart total quantity ([#29076](https://github.com/frappe/erpnext/pull/29076)) +- POS items added to cart despite low quantity ([#29126](https://github.com/frappe/erpnext/pull/29126)) +- Exclude unpublished items while fetching items from other item groups ([#29211](https://github.com/frappe/erpnext/pull/29211)) +- Get project from PO into payment entry ([#29182](https://github.com/frappe/erpnext/pull/29182)) +- Cover case when all material needs to be bought ([#29326](https://github.com/frappe/erpnext/pull/29326)) +- Validate setup on clicking Mark Attendance button in Shift Type ([#29146](https://github.com/frappe/erpnext/pull/29146)) +- Can't ignore pricing rule for one particular POS invoice ([#29222](https://github.com/frappe/erpnext/pull/29222)) +- Cart & Popup Logic of Item variant without Website Item ([#29383](https://github.com/frappe/erpnext/pull/29383)) +- Not able to submit salary slips from amended payroll entry. ([#29228](https://github.com/frappe/erpnext/pull/29228)) +- Tax and Charges template not getting fetched based on tax category assigned ([#29092](https://github.com/frappe/erpnext/pull/29092)) \ No newline at end of file diff --git a/erpnext/change_log/v13/v13_20_0.md b/erpnext/change_log/v13/v13_20_0.md new file mode 100644 index 00000000000..10c8fc70d20 --- /dev/null +++ b/erpnext/change_log/v13/v13_20_0.md @@ -0,0 +1,32 @@ +## Version 13.20.0 Release Notes + +### Features & Enhancements + +- Provisional accounting for expenses ([#29451](https://github.com/frappe/erpnext/pull/29451)) + +### Fixes + +- Incorrect number of items fetched while creating delivery note ([#29454](https://github.com/frappe/erpnext/pull/29454)) +- Incorrect raw materials quantity in manufacture stock entry ([#29419](https://github.com/frappe/erpnext/pull/29419)) +- Refactored the update_serial_no function for old Maintenance Visits ([#28843](https://github.com/frappe/erpnext/pull/28843)) +- Ignore empty customer/supplier in item query ([#29610](https://github.com/frappe/erpnext/pull/29610)) +- The "Bypass Credit Limit Check" from customer has not fetched in the Customer Credit Balance report ([#29367](https://github.com/frappe/erpnext/pull/29367)) +- Reset conversion facture after changing the Stock UOM ([#29062](https://github.com/frappe/erpnext/pull/29062)) +- Cart Items rendering issue ([#29398](https://github.com/frappe/erpnext/pull/29398)) +- Honour 'include holidays' setting while marking attendance for leave application ([#29425](https://github.com/frappe/erpnext/pull/29425)) +- Cost of poor quality report time filters not working ([#28958](https://github.com/frappe/erpnext/pull/28958)) +- Incorrect packing items getting fetched on Sales Return / Credit Note ([#28607](https://github.com/frappe/erpnext/pull/28607)) +- Regenerate packing items on newly mapped doc ([#29642](https://github.com/frappe/erpnext/pull/29642)) +- From Time and To Time not updated in drag and drop action for Course Schedule ([#29114](https://github.com/frappe/erpnext/pull/29114)) +- Employee: set user image and validate user id only if user data is found ([#29452](https://github.com/frappe/erpnext/pull/29452)) +- Clear Depreciation Schedule before modification ([#28507](https://github.com/frappe/erpnext/pull/28507)) +- Fixed shopping cart qty badge ([#29077](https://github.com/frappe/erpnext/pull/29077)) +- Fetch "transfer material against" from BOM ([#29435](https://github.com/frappe/erpnext/pull/29435)) +- Cart & Popup Logic of Item variant without Website Item ([#29383](https://github.com/frappe/erpnext/pull/29383)) +- Timesheets: calculate to time based on from time and hours ([#28589](https://github.com/frappe/erpnext/pull/28589)) +- Dynamically compute BOM Level ([#29522](https://github.com/frappe/erpnext/pull/29522)) +- Contact duplication on converting lead to customer ([#29337](https://github.com/frappe/erpnext/pull/29337)) +- Fixed populate practitioner selected in form to check availability popup ([#29405](https://github.com/frappe/erpnext/pull/29405)) +- Compute batch ledger in python ([#29324](https://github.com/frappe/erpnext/pull/29324)) +- Incorrect packing list for recurring items & code cleanup ([#29456](https://github.com/frappe/erpnext/pull/29456)) +- Opening invoice creation tool can fetch multiple accounting dimension ([#29407](https://github.com/frappe/erpnext/pull/29407)) \ No newline at end of file diff --git a/erpnext/change_log/v13/v13_21_0.md b/erpnext/change_log/v13/v13_21_0.md new file mode 100644 index 00000000000..a1f36e83e80 --- /dev/null +++ b/erpnext/change_log/v13/v13_21_0.md @@ -0,0 +1,49 @@ +## Version 13.21.0 Release Notes + +### Features & Enhancements + +- Provisional accounting for expenses ([#29451](https://github.com/frappe/erpnext/pull/29451)) +- Allowing non stock items in POS ([#29556](https://github.com/frappe/erpnext/pull/29556)) +- Option to disable Item Tax Template and Tax Category ([#29349](https://github.com/frappe/erpnext/pull/29349)) + +### Fixes + +- Ignore linked invoices on Journal Entry cancel ([#29641](https://github.com/frappe/erpnext/pull/29641)) +- Do not hide Loan Repayment Entry field in salary slip ([#29535](https://github.com/frappe/erpnext/pull/29535)) +- Coupon code is applied even if ignore_pricing_rule is enabled ([#29859](https://github.com/frappe/erpnext/pull/29859)) +- Reserved for Production calculation considered closed work orders ([#29723](https://github.com/frappe/erpnext/pull/29723)) +- Disable rounded total in opening invoice creation tool ([#29789](https://github.com/frappe/erpnext/pull/29789)) +- Report GSTR-1 minor fixes ([#29700](https://github.com/frappe/erpnext/pull/29700)) +- Ignore rate validation for work order ([#29690](https://github.com/frappe/erpnext/pull/29690)) +- Incorrect provisional profit and loss in balance sheet ([#29601](https://github.com/frappe/erpnext/pull/29601)) +- Multiple WO for a single Production Plan Item ([#29603](https://github.com/frappe/erpnext/pull/29603)) +- Validation for invalid serial nos at POS invoice level ([#29447](https://github.com/frappe/erpnext/pull/29447)) +- Incorrect Grand Total in case of inclusive taxes on item ([#29701](https://github.com/frappe/erpnext/pull/29701)) +- Currency in bank reconciliation chart ([#29709](https://github.com/frappe/erpnext/pull/29709)) +- Set Pending Qty in Prod Plan after updating Work Order ([#29705](https://github.com/frappe/erpnext/pull/29705)) +- Enable Allow on Submit for 'Is Active' field in Salary Structure ([#29630](https://github.com/frappe/erpnext/pull/29630)) +- Bypass "Validate Selling Price for Item Against Purchase Rate or Valuation Rate" for free items ([#29359](https://github.com/frappe/erpnext/pull/29359)) +- Generate Warehouse wise FIFO Queue always and later aggregate if required ([#29788](https://github.com/frappe/erpnext/pull/29788)) +- Fixes in TDS payable monthly report ([#29791](https://github.com/frappe/erpnext/pull/29791)) +- Incorrect pricing rule filtering on selecting first item ([#29778](https://github.com/frappe/erpnext/pull/29778)) +- Stock Ageing Transfer Bucket logic for Repack Entry with split batch rows ([#29816](https://github.com/frappe/erpnext/pull/29816)) +- Incorrect packing list for recurring items & code cleanup ([#29456](https://github.com/frappe/erpnext/pull/29456)) +- Cost center validation of asset ([#29373](https://github.com/frappe/erpnext/pull/29373)) +- Coupon code item pricing dynamic updation issue in pos screen ([#29599](https://github.com/frappe/erpnext/pull/29599)) +- Billed amount in delivery note items ([#29290](https://github.com/frappe/erpnext/pull/29290)) +- Regenerate packed items on newly mapped doc ([#29642](https://github.com/frappe/erpnext/pull/29642)) +- Cannot jump to sales invoice in gross profit report ([#29748](https://github.com/frappe/erpnext/pull/29748)) +- Fetch image form item ([#29523](https://github.com/frappe/erpnext/pull/29523)) +- Add missing key in Loan ([#29660](https://github.com/frappe/erpnext/pull/29660)) +- Weed out disabled variants via sql query instead of pythonic looping separately ([#29639](https://github.com/frappe/erpnext/pull/29639 ()) +- Loan repayment via Salary Slip ([#29716](https://github.com/frappe/erpnext/pull/29716)) +- Earned leaves not allocated if assignment is created on month-end based on Leave Policy ([#29650](https://github.com/frappe/erpnext/pull/29650)) +- Time out error while making work orders from production plan ([#29736](https://github.com/frappe/erpnext/pull/29736)) +- Removal of coupon code ([#29896](https://github.com/frappe/erpnext/pull/29896)) +- Earned Leave allocation based on joining date fixes ([#29711](https://github.com/frappe/erpnext/pull/29711)) +- Total Credit amount in TDS Payable monthly report ([#29907](https://github.com/frappe/erpnext/pull/29907)) +- Pricing rule on transactions doesn't work ([#29597](https://github.com/frappe/erpnext/pull/29597)) +- Billing status for zero amount reference doc ([#29659](https://github.com/frappe/erpnext/pull/29659)) +- Zero rated exports in GSTR-3B report ([#29609](https://github.com/frappe/erpnext/pull/29609)) +- Update SO via Work Order made from MR ([#29803](https://github.com/frappe/erpnext/pull/29803)) +- Currency in bank reconciliation tool ([#29848](https://github.com/frappe/erpnext/pull/29848)) \ No newline at end of file diff --git a/erpnext/change_log/v13/v13_22_0.md b/erpnext/change_log/v13/v13_22_0.md new file mode 100644 index 00000000000..24e3539d833 --- /dev/null +++ b/erpnext/change_log/v13/v13_22_0.md @@ -0,0 +1,42 @@ +## Version 13.22.0 Release Notes + +### Features & Enhancements + +- feat: Payment Terms Status report (backport #29137) ([#29137](https://github.com/frappe/erpnext/pull/29137)) + +### Fixes + +- fix(LMS): program enrollment does not give any feedback (backport #29922) ([#29922](https://github.com/frappe/erpnext/pull/29922)) +- fix: Update SO via Work Order made from MR (attached to SO) (backport #29803) ([#29803](https://github.com/frappe/erpnext/pull/29803)) +- fix: org chart connectors not rendered when Employee Naming is set to Full Name ([#29997](https://github.com/frappe/erpnext/pull/29997)) +- perf: Weed out disabled variants via sql query instead of pythonic looping separately (backport #29639) ([#29639](https://github.com/frappe/erpnext/pull/29639)) +- fix: task status loop ([#26006](https://github.com/frappe/erpnext/pull/26006)) +- fix: Commission not applied while making Sales Order from Quotation (backport #29978) ([#29978](https://github.com/frappe/erpnext/pull/29978)) +- fix: Validate party account with company (backport #29879) ([#29879](https://github.com/frappe/erpnext/pull/29879)) +- fix: add supported currencies for GoCardless (backport #29805) ([#29805](https://github.com/frappe/erpnext/pull/29805)) +- fix(asset): no. of depr booked cannot be equal to total no. of depr (backport #29900) ([#29900](https://github.com/frappe/erpnext/pull/29900)) +- fix: Fetch conversion factor even if it already existed in row, on item change ([#29917](https://github.com/frappe/erpnext/pull/29917)) +- fix(ux): make "allow zero valuation rate" readonly if "s_warehouse" is set ([#29681](https://github.com/frappe/erpnext/pull/29681)) +- fix: Block merging items if both have product bundles (backport #29913) ([#29913](https://github.com/frappe/erpnext/pull/29913)) +- fix: JobCard TimeLog to_date (backport #29872) ([#29872](https://github.com/frappe/erpnext/pull/29872)) +- fix: Stock Ageing Transfer Bucket logic for Repack Entry with split batch rows (backport #29816) ([#29816](https://github.com/frappe/erpnext/pull/29816)) +- fix(Salary Slip): TypeError while clearing any amount field in components (backport #29931) ([#29931](https://github.com/frappe/erpnext/pull/29931)) +- fix: allow renaming and merging ([#29830](https://github.com/frappe/erpnext/pull/29830)) +- fix(pos): minor fixes (backport #29991) ([#29991](https://github.com/frappe/erpnext/pull/29991)) +- fix(e-commerce): Unique Shopping Cart Per Logged In User ([#29994](https://github.com/frappe/erpnext/pull/29994)) +- fix: currency in bank reconciliation tool (backport #29848) ([#29848](https://github.com/frappe/erpnext/pull/29848)) +- fix: Account filter in PSOA (backport #29928) ([#29928](https://github.com/frappe/erpnext/pull/29928)) +- fix: Taxjar minor fixes (backport #29942) ([#29942](https://github.com/frappe/erpnext/pull/29942)) +- fix: Total taxes and charges in payment entry for multi-currency payments (backport #29977) ([#29977](https://github.com/frappe/erpnext/pull/29977)) +- fix(e-invoicing): remove batch no from e-invoices (backport #30084) ([#30084](https://github.com/frappe/erpnext/pull/30084)) +- fix: Total Credit amount in TDS Payable monthly report (backport #29907) ([#29907](https://github.com/frappe/erpnext/pull/29907)) +- fix: GSTIN filter for GSTR-1 report (backport #29869) ([#29869](https://github.com/frappe/erpnext/pull/29869)) +- fix: coupon code is applied even if ignore_pricing_rule is enabled (backport #29859) ([#29859](https://github.com/frappe/erpnext/pull/29859)) +- feat: update ordered qty for packed items (backport #29939) ([#29939](https://github.com/frappe/erpnext/pull/29939)) +- fix: validate Work Order qty against Production Plan ([#29721](https://github.com/frappe/erpnext/pull/29721)) +- fix: Fetch valuation rate for stock items consumed during asset repair ([#29714](https://github.com/frappe/erpnext/pull/29714)) +- fix: Email translations (backport #29956) ([#29956](https://github.com/frappe/erpnext/pull/29956)) +- fix(Timesheet): fetch exchange rate only if currency is set (backport #30057) ([#30057](https://github.com/frappe/erpnext/pull/30057)) +- refactor: removed validation to check zero qty (backport #30015) ([#30015](https://github.com/frappe/erpnext/pull/30015)) +- fix(pos): removal of coupon code (backport #29896) ([#29896](https://github.com/frappe/erpnext/pull/29896)) +- fix: Error in consolidated financial statements (backport #29771) ([#29771](https://github.com/frappe/erpnext/pull/29771)) \ No newline at end of file diff --git a/erpnext/change_log/v13/v13_23_0.md b/erpnext/change_log/v13/v13_23_0.md new file mode 100644 index 00000000000..2c87bb9f673 --- /dev/null +++ b/erpnext/change_log/v13/v13_23_0.md @@ -0,0 +1,63 @@ +## Version 13.23.0 Release Notes + +### Features & Enhancements + +- feat: Bank Reconciliation for loan documents (backport #29865) ([#29865](https://github.com/frappe/erpnext/pull/29865)) +- feat: Include child item group products in Item Group Page & cleanup (backport #30091) ([#30091](https://github.com/frappe/erpnext/pull/30091)) +- refactor: Employee Leave Balance (backport #29439) ([#29439](https://github.com/frappe/erpnext/pull/29439)) + +### Fixes + +- perf(asset): fetch only distinct depreciable assets (backport #30114) ([#30114](https://github.com/frappe/erpnext/pull/30114)) +- fix(pos): do not reset mode of payments in case of consolidation (backport #30198) ([#30198](https://github.com/frappe/erpnext/pull/30198)) +- fix(pos): loyalty points in case of returned pos invoice (backport #30242) ([#30242](https://github.com/frappe/erpnext/pull/30242)) +- fix(psoa): add company filter to account (backport #30145) ([#30145](https://github.com/frappe/erpnext/pull/30145)) +- fix(psoa): no such element: dict object['account'] (backport #30153) ([#30153](https://github.com/frappe/erpnext/pull/30153)) +- fix(translation) - correction for assets translation (backport #30000) ([#30000](https://github.com/frappe/erpnext/pull/30000)) +- fix(ux): Improve label for better understanding (backport #30096) ([#30096](https://github.com/frappe/erpnext/pull/30096)) +- fix: 'save_quotations_as_draft' checkbox not honoured (backport #30160) ([#30160](https://github.com/frappe/erpnext/pull/30160)) +- fix: Add missing currency option in Supplier Quotation's `rounded_total` field (backport #30229) ([#30229](https://github.com/frappe/erpnext/pull/30229)) +- fix: Ambigous column in picklist query (backport #30102) ([#30102](https://github.com/frappe/erpnext/pull/30102)) +- fix: Cleanup and fixes in Dimension-wise Accounts Balance Report (backport #30284) ([#30284](https://github.com/frappe/erpnext/pull/30284)) +- fix: Do not consider cancelled entries (backport #30207) ([#30207](https://github.com/frappe/erpnext/pull/30207)) +- fix: Do not update ignore pricing rule check implicitly (backport #30269) ([#30269](https://github.com/frappe/erpnext/pull/30269)) +- fix: Error in bank reconciliation statement (backport #30261) ([#30261](https://github.com/frappe/erpnext/pull/30261)) +- fix: Get MRs that are yet to be received but fully ordered in Report `Requested Items to Order and Receive` (backport #29987) ([#29987](https://github.com/frappe/erpnext/pull/29987)) +- fix: Item discounts for quotation and other docs (backport #29940) ([#29940](https://github.com/frappe/erpnext/pull/29940)) +- fix: Item-wise sales history report (backport #30080) ([#30080](https://github.com/frappe/erpnext/pull/30080)) +- fix: Job Card sub operations status and list view ([#30243](https://github.com/frappe/erpnext/pull/30243)) +- fix: KSA E-Invoice QR Code showing wrong VAT amount (backport #30230) ([#30230](https://github.com/frappe/erpnext/pull/30230)) +- fix: Leave Policy Assignment creation patch ([#30215](https://github.com/frappe/erpnext/pull/30215)) +- fix: Multi-currency bank reconciliation fixes (backport #29979) ([#29979](https://github.com/frappe/erpnext/pull/29979)) +- fix: Multiple fixes in Gross Profit report (backport #29740) ([#29740](https://github.com/frappe/erpnext/pull/29740)) +- fix: Nil and Exempted values in GSTR-3B Report (backport #30039) ([#30039](https://github.com/frappe/erpnext/pull/30039)) +- fix: Non Profit fixes ([#30280](https://github.com/frappe/erpnext/pull/30280)) +- fix: Pos return payment mode issue ([#26872](https://github.com/frappe/erpnext/pull/26872)) +- fix: Remove tax invoice no field (backport #30136) ([#30136](https://github.com/frappe/erpnext/pull/30136)) +- fix: Sales and Purchase return optimization (backport #30152) ([#30152](https://github.com/frappe/erpnext/pull/30152)) +- fix: Search query of payroll entry reference in Journal Entry ([#30225](https://github.com/frappe/erpnext/pull/30225)) +- fix: Shipping rule application fixes (backport #30181) ([#30181](https://github.com/frappe/erpnext/pull/30181)) +- fix: Sub-Category Routing in Item Group Page Listing pills (backport #30258) ([#30258](https://github.com/frappe/erpnext/pull/30258)) +- fix: Validate income/expense account in sales and purchase invoice (backport #30266) ([#30266](https://github.com/frappe/erpnext/pull/30266)) +- fix: cannot create multicurrency sales order with product bundles (backport #30166) ([#30166](https://github.com/frappe/erpnext/pull/30166)) +- fix: cannot create purchase order from sales order (backport #30217) ([#30217](https://github.com/frappe/erpnext/pull/30217)) +- fix: customer credit limit validation on update (backport #30110) ([#30110](https://github.com/frappe/erpnext/pull/30110)) +- fix: disable "get items" buttons from submitted production plan (backport #30223) ([#30223](https://github.com/frappe/erpnext/pull/30223)) +- fix: do not reset asset_category (backport #29696) ([#29696](https://github.com/frappe/erpnext/pull/29696)) +- fix: dont fetch entire barcode table in get_item_details ([#30131](https://github.com/frappe/erpnext/pull/30131)) +- fix: dont reset UOM in MR on every get_item_detail call (backport #30164) ([#30164](https://github.com/frappe/erpnext/pull/30164)) +- fix: fetch new fields from routing to bom ([#30169](https://github.com/frappe/erpnext/pull/30169)) +- fix: filter default_discount_account field in item_group_defaults table is_group = 0 ([#30095](https://github.com/frappe/erpnext/pull/30095)) +- fix: ignore non-unique swift numbers while migrating (backport #30132) ([#30132](https://github.com/frappe/erpnext/pull/30132)) +- fix: incorrect debit credit amount in presentation currency (backport #30244) ([#30244](https://github.com/frappe/erpnext/pull/30244)) +- fix: leave allocation records query ([#30118](https://github.com/frappe/erpnext/pull/30118)) +- fix: max_qty validation condition in WO (backport #30216) ([#30216](https://github.com/frappe/erpnext/pull/30216)) +- fix: pos return payment mode issue (#26872) ([#30220](https://github.com/frappe/erpnext/pull/30220)) +- fix: program enrollment button labels (backport #30148) ([#30148](https://github.com/frappe/erpnext/pull/30148)) +- fix: respect db multi_tenancy while fetching precision (backport #30301) ([#30301](https://github.com/frappe/erpnext/pull/30301)) +- fix: salary slip amount rounding errors ([#30248](https://github.com/frappe/erpnext/pull/30248)) +- fix: packed items return when items are removed ([#30263](https://github.com/frappe/erpnext/pull/30263)) +- fix: wrong payment days in salary slip for employees joining/leaving during mid payroll dates (backport #29082) ([#29082](https://github.com/frappe/erpnext/pull/29082)) +- refactor: removed unrequired code and test for standalone delivery note serial return ([#30276](https://github.com/frappe/erpnext/pull/30276)) +- revert: BU Schlüssel (a21f76f) (backport #29654) ([#29654](https://github.com/frappe/erpnext/pull/29654)) +- chore: add German translations (backport #30265) ([#30265](https://github.com/frappe/erpnext/pull/30265)) diff --git a/erpnext/change_log/v13/v13_24_0.md b/erpnext/change_log/v13/v13_24_0.md new file mode 100644 index 00000000000..d6920d67a5d --- /dev/null +++ b/erpnext/change_log/v13/v13_24_0.md @@ -0,0 +1,40 @@ +## Version 13.24.0 Release Notes + +### Features & Enhancements + +- feat: Create single PL/DN from several SO. ([#30238](https://github.com/frappe/erpnext/pull/30238)) + +### Fixes + +- fix: Changing item prices on converting orders/receipts to invoices ([#30365](https://github.com/frappe/erpnext/pull/30365)) +- fix(India): Auto tax fetching based on GSTIN ([#30385](https://github.com/frappe/erpnext/pull/30385)) +- fix: broken production item links on production plan ([#30399](https://github.com/frappe/erpnext/pull/30399)) +- fix(ux): warning for disabled carry forwarding in Policy Assignment ([#30331](https://github.com/frappe/erpnext/pull/30331)) +- fix: failing broken patches ([#30409](https://github.com/frappe/erpnext/pull/30409)) +- fix: Payment Request Amount calculation in case of multi-currency ([#30254](https://github.com/frappe/erpnext/pull/30254)) +- fix: disable deferred naming on SLE/GLE if hash method is used. ([#30286](https://github.com/frappe/erpnext/pull/30286)) +- fix: Rate change issue on save and mapping from other doc ([#30406](https://github.com/frappe/erpnext/pull/30406)) +- fix: Error in bank reconciliation statement ([#30261](https://github.com/frappe/erpnext/pull/30261)) +- fix: clear "Retain Sample" and "Max Sample Quantity" in Item card if Has Batch No is uncheck ([#30307](https://github.com/frappe/erpnext/pull/30307)) +- fix: (ux) Add `is_group=0` filter on website warehouse field in Website Item ([#30396](https://github.com/frappe/erpnext/pull/30396)) +- fix: Allow draft PE, PA to link to Vital Signs ([#29934](https://github.com/frappe/erpnext/pull/29934)) +- fix: Clean and fixes in Dimension-wise Accounts Balance Report ([#30284](https://github.com/frappe/erpnext/pull/30284)) +- fix: Write off amount wrongly calculated in POS Invoice ([#30395](https://github.com/frappe/erpnext/pull/30395)) +- fix: custom cash flow mapper doesn't show any data ([#30287](https://github.com/frappe/erpnext/pull/30287)) +- fix: unsupported operand type(s) for +=: 'int' and 'NoneType' ([#30420](https://github.com/frappe/erpnext/pull/30420)) +- fix: Check for onload property ([#30429](https://github.com/frappe/erpnext/pull/30429)) +- fix: Reset GST State number ([#30334](https://github.com/frappe/erpnext/pull/30334)) +- fix: Future recurring period calculation for additional salary ([#29581](https://github.com/frappe/erpnext/pull/29581)) +- fix: GST account not showing up in tax templates ([#30361](https://github.com/frappe/erpnext/pull/30361)) +- fix: P&L account validation on cancellation ([#30317](https://github.com/frappe/erpnext/pull/30317)) +- refactor: remove redundant if-statement ([#30311](https://github.com/frappe/erpnext/pull/30311)) +- fix: respect db multi_tenancy while fetching precision ([#30301](https://github.com/frappe/erpnext/pull/30301)) +- fix: show subassembly table always ([#30422](https://github.com/frappe/erpnext/pull/30422)) +- fix: Validate income/expense account in sales and purchase invoice ([#30266](https://github.com/frappe/erpnext/pull/30266)) +- fix: Add permission for KSA VAT documents ([#30304](https://github.com/frappe/erpnext/pull/30304)) +- fix(UX): misc serial no selector + warehouse.py refactor ([#30309](https://github.com/frappe/erpnext/pull/30309)) +- fix: While creating Payment Request from other forms, open a new Payment Request form without saving ([#30228](https://github.com/frappe/erpnext/pull/30228)) +- fix: Product Filters Lookup ([#30336](https://github.com/frappe/erpnext/pull/30336)) +- fix: Allow on Submit for Material Request Item Required Date ([#30174](https://github.com/frappe/erpnext/pull/30174)) +- fix: Taxes not getting fetched from item tax template ([#30343](https://github.com/frappe/erpnext/pull/30343)) +- fix: Incorrect default amount to pay for POS invoices ([#30438](https://github.com/frappe/erpnext/pull/30438)) diff --git a/erpnext/change_log/v13/v13_25_0.md b/erpnext/change_log/v13/v13_25_0.md new file mode 100644 index 00000000000..6c21a839870 --- /dev/null +++ b/erpnext/change_log/v13/v13_25_0.md @@ -0,0 +1,47 @@ +## Version 13.25.0 Release Notes + +### Features & Enhancements + +- feat: minor, pick list item reference on delivery note item table ([#30527](https://github.com/frappe/erpnext/pull/30527)) +- feat: configurable Contract naming ([#30450](https://github.com/frappe/erpnext/pull/30450)) + +### Fixes + +- fix: Account currency validation ([#30486](https://github.com/frappe/erpnext/pull/30486)) +- fix(india): minor e-invoicing fixes ([#30553](https://github.com/frappe/erpnext/pull/30553)) +- feat: Redisearch with consent (bp) ([#30539](https://github.com/frappe/erpnext/pull/30539)) +- fix: maintain FIFO queue even if outgoing_rate is not found ([#30563](https://github.com/frappe/erpnext/pull/30563)) +- fix(lead): reload address and contact before updating their links ([#29968](https://github.com/frappe/erpnext/pull/29968)) +- fix(lead): reload contact before updating links ([#29966](https://github.com/frappe/erpnext/pull/29966)) +- fix: Add non-existent Item check and cleanup in `validate_for_items` ([#30509](https://github.com/frappe/erpnext/pull/30509)) +- fix: incorrect payable amount for loan closure ([#30191](https://github.com/frappe/erpnext/pull/30191)) +- fix: Do not apply shipping rule for POS transactions ([#30575](https://github.com/frappe/erpnext/pull/30575)) +- perf: index barcode for faster scans ([#30543](https://github.com/frappe/erpnext/pull/30543)) +- fix: don't check for failed repost while freezing ([#30472](https://github.com/frappe/erpnext/pull/30472)) +- fix: if accepted warehouse not selected during rejection then stock ledger not created ([#30564](https://github.com/frappe/erpnext/pull/30564)) +- fix: hide pending qty only if original item is assigned ([#30599](https://github.com/frappe/erpnext/pull/30599)) +- fix(ux): refresh update to zero val checkbox ([#30567](https://github.com/frappe/erpnext/pull/30567)) +- refactor: Add exception handling in background job within BOM Update Tool ([#30146](https://github.com/frappe/erpnext/pull/30146)) +- fix: bom valuation - handle lack of LPP ([#30454](https://github.com/frappe/erpnext/pull/30454)) +- fix: total leaves allocated not validated and recalculated on updates post submission ([#30569](https://github.com/frappe/erpnext/pull/30569)) +- fix: convert dates to datetime before comparing in leave days calculation and fix half day edge case ([#30538](https://github.com/frappe/erpnext/pull/30538)) +- fix: Ignore user perm for party account company ([#30555](https://github.com/frappe/erpnext/pull/30555)) +- fix(asset): do not validate warehouse on asset purchase ([#30461](https://github.com/frappe/erpnext/pull/30461)) +- fix: credit limit validation in delivery note ([#30470](https://github.com/frappe/erpnext/pull/30470)) +- fix: enable row deletion in reference table ([#30453](https://github.com/frappe/erpnext/pull/30453)) +- fix: use `name` for links not `item_code` ([#30462](https://github.com/frappe/erpnext/pull/30462)) +- fix: multiple pos issues (copy #30324) ([#30515](https://github.com/frappe/erpnext/pull/30515)) +- fix: fetch from fields not working in eway bill dialog ([#30579](https://github.com/frappe/erpnext/pull/30579)) +- fix(pos): do not reset search input on item selection ([#30537](https://github.com/frappe/erpnext/pull/30537)) +- fix: explicitly check if additional salary is recurring while fetching components for payroll ([#30489](https://github.com/frappe/erpnext/pull/30489)) +- fix(India): Tax fetching based on tax category ([#30500](https://github.com/frappe/erpnext/pull/30500)) +- fix: submit Work Order when “Make Serial No / Batch from Work Order” is enabled ([#30468](https://github.com/frappe/erpnext/pull/30468)) +- fix: Dont set `idx` while adding WO items to Stock Entry ([#30377](https://github.com/frappe/erpnext/pull/30377)) +- fix(India): Auto tax fetching based on GSTIN ([#30385](https://github.com/frappe/erpnext/pull/30385)) +- fix: validate 0 transfer qty in stock entry (copy #30476) ([#30479](https://github.com/frappe/erpnext/pull/30479)) +- fix: Issues on loan repayment ([#30557](https://github.com/frappe/erpnext/pull/30557)) +- fix: Added validation for single_threshold in Tax With Holding Category ([#30382](https://github.com/frappe/erpnext/pull/30382)) +- fix: Remove trailing slashes "/" from route ([#30531](https://github.com/frappe/erpnext/pull/30531)) +- fix: validate 0 transfer qty in stock entry ([#30476](https://github.com/frappe/erpnext/pull/30476)) +- fix: Taxes getting overriden from mapped to target doc ([#30510](https://github.com/frappe/erpnext/pull/30510)) +- fix: move item tax to item tax template patch ([#30419](https://github.com/frappe/erpnext/pull/30419)) diff --git a/erpnext/change_log/v13/v13_26_0.md b/erpnext/change_log/v13/v13_26_0.md new file mode 100644 index 00000000000..b29d018039e --- /dev/null +++ b/erpnext/change_log/v13/v13_26_0.md @@ -0,0 +1,31 @@ +## Version 13.26.0 Release Notes + +### Features & Enhancements + +- feat: Receivable/Payable Account column and filter in AR/AP report ([#30620](https://github.com/frappe/erpnext/pull/30620)) +- feat(india): e-invoicing for intra-state union territory transactions ([#30626](https://github.com/frappe/erpnext/pull/30626)) +- feat: Ignore permlevel for specific fields ([#30686](https://github.com/frappe/erpnext/pull/30686)) +- feat: 'customer' column and more filter to Payment terms status report ([#30499](https://github.com/frappe/erpnext/pull/30499)) + +### Fixes + +- fix: fallback to item_name if description is not found ([#30619](https://github.com/frappe/erpnext/pull/30619)) +- fix: Deferred Revenue/Expense Account validation ([#30602](https://github.com/frappe/erpnext/pull/30602)) +- fix(pos): reload doc before set value ([#30610](https://github.com/frappe/erpnext/pull/30610)) +- fix: Exchange gain and loss button in Payment Entry ([#30606](https://github.com/frappe/erpnext/pull/30606)) +- fix(pos): cannot change paid amount in pos payments ([#30657](https://github.com/frappe/erpnext/pull/30657)) +- fix: hide pending qty only if original item is assigned ([#30599](https://github.com/frappe/erpnext/pull/30599)) +- fix(pos): reload doc before set value ([#30611](https://github.com/frappe/erpnext/pull/30611)) +- fix: Handle multiple item transfer in separate SEs against WO ([#30674](https://github.com/frappe/erpnext/pull/30674)) +- fix(patch): check null values in is_cancelled patch ([#30594](https://github.com/frappe/erpnext/pull/30594)) +- fix: Download JSON for GSTR-1 report ([#30651](https://github.com/frappe/erpnext/pull/30651)) +- fix: remove bad defaults from BOM operation ([#30644](https://github.com/frappe/erpnext/pull/30644)) +- fix: update translation ([#30474](https://github.com/frappe/erpnext/pull/30474)) +- fix: dont reassign mutable (list) to a different field ([#30634](https://github.com/frappe/erpnext/pull/30634)) +- fix: update translation ([#30654](https://github.com/frappe/erpnext/pull/30654)) +- fix: ignore item-less maintenance visit for sr no ([#30684](https://github.com/frappe/erpnext/pull/30684)) +- fix: removed unused courses template ([#30596](https://github.com/frappe/erpnext/pull/30596)) +- fix: Implicit ignore pricing rule check on returns ([#30662](https://github.com/frappe/erpnext/pull/30662)) +- fix: warehouse naming when suffix is present ([#30621](https://github.com/frappe/erpnext/pull/30621)) +- fix: Ignore disabled tax categories ([#30542](https://github.com/frappe/erpnext/pull/30542)) + diff --git a/erpnext/commands/__init__.py b/erpnext/commands/__init__.py index 59311192148..13e5c5bd15b 100644 --- a/erpnext/commands/__init__.py +++ b/erpnext/commands/__init__.py @@ -9,18 +9,17 @@ from frappe.commands import get_site, pass_context def call_command(cmd, context): return click.Context(cmd, obj=context).forward(cmd) -@click.command('make-demo') -@click.option('--site', help='site name') -@click.option('--domain', default='Manufacturing') -@click.option('--days', default=100, - help='Run the demo for so many days. Default 100') -@click.option('--resume', default=False, is_flag=True, - help='Continue running the demo for given days') -@click.option('--reinstall', default=False, is_flag=True, - help='Reinstall site before demo') + +@click.command("make-demo") +@click.option("--site", help="site name") +@click.option("--domain", default="Manufacturing") +@click.option("--days", default=100, help="Run the demo for so many days. Default 100") +@click.option( + "--resume", default=False, is_flag=True, help="Continue running the demo for given days" +) +@click.option("--reinstall", default=False, is_flag=True, help="Reinstall site before demo") @pass_context -def make_demo(context, site, domain='Manufacturing', days=100, - resume=False, reinstall=False): +def make_demo(context, site, domain="Manufacturing", days=100, resume=False, reinstall=False): "Reinstall site and setup demo" from frappe.commands.site import _reinstall from frappe.installer import install_app @@ -31,19 +30,20 @@ def make_demo(context, site, domain='Manufacturing', days=100, with frappe.init_site(site): frappe.connect() from erpnext.demo import demo + demo.simulate(days=days) else: if reinstall: _reinstall(site, yes=True) with frappe.init_site(site=site): frappe.connect() - if not 'erpnext' in frappe.get_installed_apps(): - install_app('erpnext') + if not "erpnext" in frappe.get_installed_apps(): + install_app("erpnext") # import needs site from erpnext.demo import demo + demo.make(domain, days) -commands = [ - make_demo -] + +commands = [make_demo] diff --git a/erpnext/config/education.py b/erpnext/config/education.py index 3ead3ef9572..c37cf2b196e 100644 --- a/erpnext/config/education.py +++ b/erpnext/config/education.py @@ -1,4 +1,3 @@ - from frappe import _ @@ -12,113 +11,61 @@ def get_data(): "name": "Student", "onboard": 1, }, - { - "type": "doctype", - "name": "Guardian" - }, - { - "type": "doctype", - "name": "Student Log" - }, - { - "type": "doctype", - "name": "Student Group" - } - ] + {"type": "doctype", "name": "Guardian"}, + {"type": "doctype", "name": "Student Log"}, + {"type": "doctype", "name": "Student Group"}, + ], }, { "label": _("Admission"), "items": [ - - { - "type": "doctype", - "name": "Student Applicant" - }, - { - "type": "doctype", - "name": "Web Academy Applicant" - }, - { - "type": "doctype", - "name": "Student Admission" - }, - { - "type": "doctype", - "name": "Program Enrollment" - } - ] + {"type": "doctype", "name": "Student Applicant"}, + {"type": "doctype", "name": "Web Academy Applicant"}, + {"type": "doctype", "name": "Student Admission"}, + {"type": "doctype", "name": "Program Enrollment"}, + ], }, { "label": _("Attendance"), "items": [ - { - "type": "doctype", - "name": "Student Attendance" - }, - { - "type": "doctype", - "name": "Student Leave Application" - }, + {"type": "doctype", "name": "Student Attendance"}, + {"type": "doctype", "name": "Student Leave Application"}, { "type": "report", "is_query_report": True, "name": "Absent Student Report", - "doctype": "Student Attendance" + "doctype": "Student Attendance", }, { "type": "report", "is_query_report": True, "name": "Student Batch-Wise Attendance", - "doctype": "Student Attendance" + "doctype": "Student Attendance", }, - ] + ], }, { "label": _("Tools"), "items": [ - { - "type": "doctype", - "name": "Student Attendance Tool" - }, - { - "type": "doctype", - "name": "Assessment Result Tool" - }, - { - "type": "doctype", - "name": "Student Group Creation Tool" - }, - { - "type": "doctype", - "name": "Program Enrollment Tool" - }, - { - "type": "doctype", - "name": "Course Scheduling Tool" - } - ] + {"type": "doctype", "name": "Student Attendance Tool"}, + {"type": "doctype", "name": "Assessment Result Tool"}, + {"type": "doctype", "name": "Student Group Creation Tool"}, + {"type": "doctype", "name": "Program Enrollment Tool"}, + {"type": "doctype", "name": "Course Scheduling Tool"}, + ], }, { "label": _("Assessment"), "items": [ - { - "type": "doctype", - "name": "Assessment Plan" - }, + {"type": "doctype", "name": "Assessment Plan"}, { "type": "doctype", "name": "Assessment Group", "link": "Tree/Assessment Group", }, - { - "type": "doctype", - "name": "Assessment Result" - }, - { - "type": "doctype", - "name": "Assessment Criteria" - } - ] + {"type": "doctype", "name": "Assessment Result"}, + {"type": "doctype", "name": "Assessment Criteria"}, + ], }, { "label": _("Assessment Reports"), @@ -127,60 +74,38 @@ def get_data(): "type": "report", "is_query_report": True, "name": "Course wise Assessment Report", - "doctype": "Assessment Result" + "doctype": "Assessment Result", }, { "type": "report", "is_query_report": True, "name": "Final Assessment Grades", - "doctype": "Assessment Result" + "doctype": "Assessment Result", }, { "type": "report", "is_query_report": True, "name": "Assessment Plan Status", - "doctype": "Assessment Plan" + "doctype": "Assessment Plan", }, - { - "type": "doctype", - "name": "Student Report Generation Tool" - } - ] + {"type": "doctype", "name": "Student Report Generation Tool"}, + ], }, { "label": _("Fees"), "items": [ - { - "type": "doctype", - "name": "Fees" - }, - { - "type": "doctype", - "name": "Fee Schedule" - }, - { - "type": "doctype", - "name": "Fee Structure" - }, - { - "type": "doctype", - "name": "Fee Category" - } - ] + {"type": "doctype", "name": "Fees"}, + {"type": "doctype", "name": "Fee Schedule"}, + {"type": "doctype", "name": "Fee Structure"}, + {"type": "doctype", "name": "Fee Category"}, + ], }, { "label": _("Schedule"), "items": [ - { - "type": "doctype", - "name": "Course Schedule", - "route": "/app/List/Course Schedule/Calendar" - }, - { - "type": "doctype", - "name": "Course Scheduling Tool" - } - ] + {"type": "doctype", "name": "Course Schedule", "route": "/app/List/Course Schedule/Calendar"}, + {"type": "doctype", "name": "Course Scheduling Tool"}, + ], }, { "label": _("Masters"), @@ -207,72 +132,39 @@ def get_data(): "type": "doctype", "name": "Room", "onboard": 1, - } - ] + }, + ], }, { "label": _("Content Masters"), "items": [ - { - "type": "doctype", - "name": "Article" - }, - { - "type": "doctype", - "name": "Video" - }, - { - "type": "doctype", - "name": "Quiz" - } - ] + {"type": "doctype", "name": "Article"}, + {"type": "doctype", "name": "Video"}, + {"type": "doctype", "name": "Quiz"}, + ], }, { "label": _("LMS Activity"), "items": [ - { - "type": "doctype", - "name": "Course Enrollment" - }, - { - "type": "doctype", - "name": "Course Activity" - }, - { - "type": "doctype", - "name": "Quiz Activity" - } - ] + {"type": "doctype", "name": "Course Enrollment"}, + {"type": "doctype", "name": "Course Activity"}, + {"type": "doctype", "name": "Quiz Activity"}, + ], }, { "label": _("Settings"), "items": [ - { - "type": "doctype", - "name": "Student Category" - }, - { - "type": "doctype", - "name": "Student Batch Name" - }, + {"type": "doctype", "name": "Student Category"}, + {"type": "doctype", "name": "Student Batch Name"}, { "type": "doctype", "name": "Grading Scale", "onboard": 1, }, - { - "type": "doctype", - "name": "Academic Term" - }, - { - "type": "doctype", - "name": "Academic Year" - }, - { - "type": "doctype", - "name": "Education Settings" - } - ] + {"type": "doctype", "name": "Academic Term"}, + {"type": "doctype", "name": "Academic Year"}, + {"type": "doctype", "name": "Education Settings"}, + ], }, { "label": _("Other Reports"), @@ -281,20 +173,20 @@ def get_data(): "type": "report", "is_query_report": True, "name": "Student and Guardian Contact Details", - "doctype": "Program Enrollment" + "doctype": "Program Enrollment", }, { "type": "report", "is_query_report": True, "name": "Student Monthly Attendance Sheet", - "doctype": "Student Attendance" + "doctype": "Student Attendance", }, { "type": "report", "name": "Student Fee Collection", "doctype": "Fees", - "is_query_report": True - } - ] - } + "is_query_report": True, + }, + ], + }, ] diff --git a/erpnext/config/projects.py b/erpnext/config/projects.py index 168dead9bf4..6186a4e8204 100644 --- a/erpnext/config/projects.py +++ b/erpnext/config/projects.py @@ -1,4 +1,3 @@ - from frappe import _ @@ -45,7 +44,7 @@ def get_data(): "description": _("Project Update."), "dependencies": ["Project"], }, - ] + ], }, { "label": _("Time Tracking"), @@ -68,7 +67,7 @@ def get_data(): "description": _("Cost of various activities"), "dependencies": ["Activity Type"], }, - ] + ], }, { "label": _("Reports"), @@ -96,7 +95,6 @@ def get_data(): "doctype": "Project", "dependencies": ["Project"], }, - ] + ], }, - ] diff --git a/erpnext/controllers/accounts_controller.py b/erpnext/controllers/accounts_controller.py index 6ac720fec92..527c9389d8a 100644 --- a/erpnext/controllers/accounts_controller.py +++ b/erpnext/controllers/accounts_controller.py @@ -7,6 +7,7 @@ import json import frappe from frappe import _, throw from frappe.model.workflow import get_workflow_name, is_transition_condition_satisfied +from frappe.query_builder.functions import Sum from frappe.utils import ( add_days, add_months, @@ -34,6 +35,7 @@ from erpnext.accounts.doctype.pricing_rule.utils import ( from erpnext.accounts.party import ( get_party_account, get_party_account_currency, + get_party_gle_currency, validate_party_frozen_disabled, ) from erpnext.accounts.utils import get_account_currency, get_fiscal_years, validate_fiscal_year @@ -45,6 +47,7 @@ from erpnext.controllers.print_settings import ( from erpnext.controllers.sales_and_purchase_return import validate_return from erpnext.exceptions import InvalidCurrency from erpnext.setup.utils import get_exchange_rate +from erpnext.stock.doctype.item.item import get_uom_conv_factor from erpnext.stock.doctype.packed_item.packed_item import make_packing_list from erpnext.stock.get_item_details import ( _get_item_tax_template, @@ -56,10 +59,22 @@ from erpnext.stock.get_item_details import ( from erpnext.utilities.transaction_base import TransactionBase -class AccountMissingError(frappe.ValidationError): pass +class AccountMissingError(frappe.ValidationError): + pass + + +force_item_fields = ( + "item_group", + "brand", + "stock_uom", + "is_fixed_asset", + "item_tax_rate", + "pricing_rules", + "weight_per_unit", + "weight_uom", + "total_weight", +) -force_item_fields = ("item_group", "brand", "stock_uom", "is_fixed_asset", "item_tax_rate", - "pricing_rules", "weight_per_unit", "weight_uom", "total_weight") class AccountsController(TransactionBase): def __init__(self, *args, **kwargs): @@ -67,14 +82,14 @@ class AccountsController(TransactionBase): def get_print_settings(self): print_setting_fields = [] - items_field = self.meta.get_field('items') + items_field = self.meta.get_field("items") - if items_field and items_field.fieldtype == 'Table': - print_setting_fields += ['compact_item_print', 'print_uom_after_quantity'] + if items_field and items_field.fieldtype == "Table": + print_setting_fields += ["compact_item_print", "print_uom_after_quantity"] - taxes_field = self.meta.get_field('taxes') - if taxes_field and taxes_field.fieldtype == 'Table': - print_setting_fields += ['print_taxes_with_zero_amount'] + taxes_field = self.meta.get_field("taxes") + if taxes_field and taxes_field.fieldtype == "Table": + print_setting_fields += ["print_taxes_with_zero_amount"] return print_setting_fields @@ -86,34 +101,44 @@ class AccountsController(TransactionBase): return self.__company_currency def onload(self): - self.set_onload("make_payment_via_journal_entry", - frappe.db.get_single_value('Accounts Settings', 'make_payment_via_journal_entry')) + self.set_onload( + "make_payment_via_journal_entry", + frappe.db.get_single_value("Accounts Settings", "make_payment_via_journal_entry"), + ) if self.is_new(): - relevant_docs = ("Quotation", "Purchase Order", "Sales Order", - "Purchase Invoice", "Sales Invoice") + relevant_docs = ( + "Quotation", + "Purchase Order", + "Sales Order", + "Purchase Invoice", + "Sales Invoice", + ) if self.doctype in relevant_docs: self.set_payment_schedule() def ensure_supplier_is_not_blocked(self): - is_supplier_payment = self.doctype == 'Payment Entry' and self.party_type == 'Supplier' - is_buying_invoice = self.doctype in ['Purchase Invoice', 'Purchase Order'] + is_supplier_payment = self.doctype == "Payment Entry" and self.party_type == "Supplier" + is_buying_invoice = self.doctype in ["Purchase Invoice", "Purchase Order"] supplier = None supplier_name = None if is_buying_invoice or is_supplier_payment: supplier_name = self.supplier if is_buying_invoice else self.party - supplier = frappe.get_doc('Supplier', supplier_name) + supplier = frappe.get_doc("Supplier", supplier_name) if supplier and supplier_name and supplier.on_hold: - if (is_buying_invoice and supplier.hold_type in ['All', 'Invoices']) or \ - (is_supplier_payment and supplier.hold_type in ['All', 'Payments']): + if (is_buying_invoice and supplier.hold_type in ["All", "Invoices"]) or ( + is_supplier_payment and supplier.hold_type in ["All", "Payments"] + ): if not supplier.release_date or getdate(nowdate()) <= supplier.release_date: frappe.msgprint( - _('{0} is blocked so this transaction cannot proceed').format(supplier_name), raise_exception=1) + _("{0} is blocked so this transaction cannot proceed").format(supplier_name), + raise_exception=1, + ) def validate(self): - if not self.get('is_return'): + if not self.get("is_return") and not self.get("is_debit_note"): self.validate_qty_is_not_zero() if self.get("_action") and self._action != "update_after_submit": @@ -126,6 +151,7 @@ class AccountsController(TransactionBase): self.validate_inter_company_reference() + self.disable_pricing_rule_on_internal_transfer() self.set_incoming_rate() if self.meta.get_field("currency"): @@ -145,9 +171,10 @@ class AccountsController(TransactionBase): self.validate_party() self.validate_currency() + self.validate_party_account_currency() - if self.doctype in ['Purchase Invoice', 'Sales Invoice']: - pos_check_field = "is_pos" if self.doctype=="Sales Invoice" else "is_paid" + if self.doctype in ["Purchase Invoice", "Sales Invoice"]: + pos_check_field = "is_pos" if self.doctype == "Sales Invoice" else "is_paid" if cint(self.allocate_advances_automatically) and not cint(self.get(pos_check_field)): self.set_advances() @@ -158,9 +185,10 @@ class AccountsController(TransactionBase): else: self.validate_deferred_start_and_end_date() + self.validate_deferred_income_expense_account() self.set_inter_company_account() - if self.doctype == 'Purchase Invoice': + if self.doctype == "Purchase Invoice": self.calculate_paid_amount() # apply tax withholding only if checked and applicable self.set_tax_withholding() @@ -169,7 +197,7 @@ class AccountsController(TransactionBase): validate_einvoice_fields(self) - if self.doctype != 'Material Request': + if self.doctype != "Material Request": apply_pricing_rule_on_transaction(self) def before_cancel(self): @@ -177,26 +205,58 @@ class AccountsController(TransactionBase): def on_trash(self): # delete sl and gl entries on deletion of transaction - if frappe.db.get_single_value('Accounts Settings', 'delete_linked_ledger_entries'): - frappe.db.sql("delete from `tabGL Entry` where voucher_type=%s and voucher_no=%s", (self.doctype, self.name)) - frappe.db.sql("delete from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s", (self.doctype, self.name)) + if frappe.db.get_single_value("Accounts Settings", "delete_linked_ledger_entries"): + frappe.db.sql( + "delete from `tabGL Entry` where voucher_type=%s and voucher_no=%s", (self.doctype, self.name) + ) + frappe.db.sql( + "delete from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s", + (self.doctype, self.name), + ) + + def validate_deferred_income_expense_account(self): + field_map = { + "Sales Invoice": "deferred_revenue_account", + "Purchase Invoice": "deferred_expense_account", + } + + for item in self.get("items"): + if item.get("enable_deferred_revenue") or item.get("enable_deferred_expense"): + if not item.get(field_map.get(self.doctype)): + default_deferred_account = frappe.db.get_value( + "Company", self.company, "default_" + field_map.get(self.doctype) + ) + if not default_deferred_account: + frappe.throw( + _( + "Row #{0}: Please update deferred revenue/expense account in item row or default account in company master" + ).format(item.idx) + ) + else: + item.set(field_map.get(self.doctype), default_deferred_account) def validate_deferred_start_and_end_date(self): for d in self.items: if d.get("enable_deferred_revenue") or d.get("enable_deferred_expense"): if not (d.service_start_date and d.service_end_date): - frappe.throw(_("Row #{0}: Service Start and End Date is required for deferred accounting").format(d.idx)) + frappe.throw( + _("Row #{0}: Service Start and End Date is required for deferred accounting").format(d.idx) + ) elif getdate(d.service_start_date) > getdate(d.service_end_date): - frappe.throw(_("Row #{0}: Service Start Date cannot be greater than Service End Date").format(d.idx)) + frappe.throw( + _("Row #{0}: Service Start Date cannot be greater than Service End Date").format(d.idx) + ) elif getdate(self.posting_date) > getdate(d.service_end_date): - frappe.throw(_("Row #{0}: Service End Date cannot be before Invoice Posting Date").format(d.idx)) + frappe.throw( + _("Row #{0}: Service End Date cannot be before Invoice Posting Date").format(d.idx) + ) def validate_invoice_documents_schedule(self): self.validate_payment_schedule_dates() self.set_due_date() self.set_payment_schedule() self.validate_payment_schedule_amount() - if not self.get('ignore_default_payment_terms_template'): + if not self.get("ignore_default_payment_terms_template"): self.validate_due_date() self.validate_advance_entries() @@ -212,8 +272,16 @@ class AccountsController(TransactionBase): self.validate_non_invoice_documents_schedule() def before_print(self, settings=None): - if self.doctype in ['Purchase Order', 'Sales Order', 'Sales Invoice', 'Purchase Invoice', - 'Supplier Quotation', 'Purchase Receipt', 'Delivery Note', 'Quotation']: + if self.doctype in [ + "Purchase Order", + "Sales Order", + "Sales Invoice", + "Purchase Invoice", + "Supplier Quotation", + "Purchase Receipt", + "Delivery Note", + "Quotation", + ]: if self.get("group_same_items"): self.group_similar_items() @@ -234,7 +302,9 @@ class AccountsController(TransactionBase): if is_paid: if not self.cash_bank_account: # show message that the amount is not paid - frappe.throw(_("Note: Payment Entry will not be created since 'Cash or Bank Account' was not specified")) + frappe.throw( + _("Note: Payment Entry will not be created since 'Cash or Bank Account' was not specified") + ) if cint(self.is_return) and self.grand_total > self.paid_amount: self.paid_amount = flt(flt(self.grand_total), self.precision("paid_amount")) @@ -242,8 +312,9 @@ class AccountsController(TransactionBase): elif not flt(self.paid_amount) and flt(self.outstanding_amount) > 0: self.paid_amount = flt(flt(self.outstanding_amount), self.precision("paid_amount")) - self.base_paid_amount = flt(self.paid_amount * self.conversion_rate, - self.precision("base_paid_amount")) + self.base_paid_amount = flt( + self.paid_amount * self.conversion_rate, self.precision("base_paid_amount") + ) def set_missing_values(self, for_validate=False): if frappe.flags.in_test: @@ -254,13 +325,14 @@ class AccountsController(TransactionBase): def calculate_taxes_and_totals(self): from erpnext.controllers.taxes_and_totals import calculate_taxes_and_totals + calculate_taxes_and_totals(self) if self.doctype in ( - 'Sales Order', - 'Delivery Note', - 'Sales Invoice', - 'POS Invoice', + "Sales Order", + "Delivery Note", + "Sales Invoice", + "POS Invoice", ): self.calculate_commission() self.calculate_contribution() @@ -274,50 +346,83 @@ class AccountsController(TransactionBase): date_field = "transaction_date" if date_field and self.get(date_field): - validate_fiscal_year(self.get(date_field), self.fiscal_year, self.company, - self.meta.get_label(date_field), self) + validate_fiscal_year( + self.get(date_field), self.fiscal_year, self.company, self.meta.get_label(date_field), self + ) def validate_party_accounts(self): - if self.doctype not in ('Sales Invoice', 'Purchase Invoice'): + if self.doctype not in ("Sales Invoice", "Purchase Invoice"): return - if self.doctype == 'Sales Invoice': - party_account_field = 'debit_to' - item_field = 'income_account' + if self.doctype == "Sales Invoice": + party_account_field = "debit_to" + item_field = "income_account" else: - party_account_field = 'credit_to' - item_field = 'expense_account' + party_account_field = "credit_to" + item_field = "expense_account" - for item in self.get('items'): + for item in self.get("items"): if item.get(item_field) == self.get(party_account_field): - frappe.throw(_("Row {0}: {1} {2} cannot be same as {3} (Party Account) {4}").format(item.idx, - frappe.bold(frappe.unscrub(item_field)), item.get(item_field), - frappe.bold(frappe.unscrub(party_account_field)), self.get(party_account_field))) + frappe.throw( + _("Row {0}: {1} {2} cannot be same as {3} (Party Account) {4}").format( + item.idx, + frappe.bold(frappe.unscrub(item_field)), + item.get(item_field), + frappe.bold(frappe.unscrub(party_account_field)), + self.get(party_account_field), + ) + ) def validate_inter_company_reference(self): - if self.doctype not in ('Purchase Invoice', 'Purchase Receipt', 'Purchase Order'): + if self.doctype not in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"): return if self.is_internal_transfer(): - if not (self.get('inter_company_reference') or self.get('inter_company_invoice_reference') - or self.get('inter_company_order_reference')): + if not ( + self.get("inter_company_reference") + or self.get("inter_company_invoice_reference") + or self.get("inter_company_order_reference") + ): msg = _("Internal Sale or Delivery Reference missing.") msg += _("Please create purchase from internal sale or delivery document itself") frappe.throw(msg, title=_("Internal Sales Reference Missing")) + def disable_pricing_rule_on_internal_transfer(self): + if not self.get("ignore_pricing_rule") and self.is_internal_transfer(): + self.ignore_pricing_rule = 1 + frappe.msgprint( + _("Disabled pricing rules since this {} is an internal transfer").format(self.doctype), + alert=1, + ) + def validate_due_date(self): - if self.get('is_pos'): return + if self.get("is_pos"): + return from erpnext.accounts.party import validate_due_date + if self.doctype == "Sales Invoice": if not self.due_date: frappe.throw(_("Due Date is mandatory")) - validate_due_date(self.posting_date, self.due_date, - "Customer", self.customer, self.company, self.payment_terms_template) + validate_due_date( + self.posting_date, + self.due_date, + "Customer", + self.customer, + self.company, + self.payment_terms_template, + ) elif self.doctype == "Purchase Invoice": - validate_due_date(self.bill_date or self.posting_date, self.due_date, - "Supplier", self.supplier, self.company, self.bill_date, self.payment_terms_template) + validate_due_date( + self.bill_date or self.posting_date, + self.due_date, + "Supplier", + self.supplier, + self.company, + self.bill_date, + self.payment_terms_template, + ) def set_price_list_currency(self, buying_or_selling): if self.meta.get_field("posting_date"): @@ -335,15 +440,15 @@ class AccountsController(TransactionBase): args = "for_buying" if self.meta.get_field(fieldname) and self.get(fieldname): - self.price_list_currency = frappe.db.get_value("Price List", - self.get(fieldname), "currency") + self.price_list_currency = frappe.db.get_value("Price List", self.get(fieldname), "currency") if self.price_list_currency == self.company_currency: self.plc_conversion_rate = 1.0 elif not self.plc_conversion_rate: - self.plc_conversion_rate = get_exchange_rate(self.price_list_currency, - self.company_currency, transaction_date, args) + self.plc_conversion_rate = get_exchange_rate( + self.price_list_currency, self.company_currency, transaction_date, args + ) # currency if not self.currency: @@ -352,8 +457,9 @@ class AccountsController(TransactionBase): elif self.currency == self.company_currency: self.conversion_rate = 1.0 elif not self.conversion_rate: - self.conversion_rate = get_exchange_rate(self.currency, - self.company_currency, transaction_date, args) + self.conversion_rate = get_exchange_rate( + self.currency, self.company_currency, transaction_date, args + ) def set_missing_item_details(self, for_validate=False): """set missing item values""" @@ -369,7 +475,11 @@ class AccountsController(TransactionBase): parent_dict.update({"document_type": document_type}) # party_name field used for customer in quotation - if self.doctype == "Quotation" and self.quotation_to == "Customer" and parent_dict.get("party_name"): + if ( + self.doctype == "Quotation" + and self.quotation_to == "Customer" + and parent_dict.get("party_name") + ): parent_dict.update({"customer": parent_dict.get("party_name")}) self.pricing_rules = [] @@ -381,7 +491,9 @@ class AccountsController(TransactionBase): args["doctype"] = self.doctype args["name"] = self.name args["child_docname"] = item.name - args["ignore_pricing_rule"] = self.ignore_pricing_rule if hasattr(self, 'ignore_pricing_rule') else 0 + args["ignore_pricing_rule"] = ( + self.ignore_pricing_rule if hasattr(self, "ignore_pricing_rule") else 0 + ) if not args.get("transaction_date"): args["transaction_date"] = args.get("posting_date") @@ -393,10 +505,10 @@ class AccountsController(TransactionBase): for fieldname, value in ret.items(): if item.meta.get_field(fieldname) and value is not None: - if (item.get(fieldname) is None or fieldname in force_item_fields): + if item.get(fieldname) is None or fieldname in force_item_fields: item.set(fieldname, value) - elif fieldname in ['cost_center', 'conversion_factor'] and not item.get(fieldname): + elif fieldname in ["cost_center", "conversion_factor"] and not item.get(fieldname): item.set(fieldname, value) elif fieldname == "serial_no": @@ -404,20 +516,49 @@ class AccountsController(TransactionBase): item_conversion_factor = item.get("conversion_factor") or 1.0 item_qty = abs(item.get("qty")) * item_conversion_factor - if item_qty != len(get_serial_nos(item.get('serial_no'))): + if item_qty != len(get_serial_nos(item.get("serial_no"))): item.set(fieldname, value) - if self.doctype in ["Purchase Invoice", "Sales Invoice"] and item.meta.get_field('is_fixed_asset'): - item.set('is_fixed_asset', ret.get('is_fixed_asset', 0)) + elif ( + ret.get("pricing_rule_removed") + and value is not None + and fieldname + in [ + "discount_percentage", + "discount_amount", + "rate", + "margin_rate_or_amount", + "margin_type", + "remove_free_item", + ] + ): + # reset pricing rule fields if pricing_rule_removed + item.set(fieldname, value) + + if self.doctype in ["Purchase Invoice", "Sales Invoice"] and item.meta.get_field( + "is_fixed_asset" + ): + item.set("is_fixed_asset", ret.get("is_fixed_asset", 0)) # Double check for cost center # Items add via promotional scheme may not have cost center set - if hasattr(item, 'cost_center') and not item.get('cost_center'): - item.set('cost_center', self.get('cost_center') or erpnext.get_default_cost_center(self.company)) + if hasattr(item, "cost_center") and not item.get("cost_center"): + item.set( + "cost_center", self.get("cost_center") or erpnext.get_default_cost_center(self.company) + ) if ret.get("pricing_rules"): self.apply_pricing_rule_on_items(item, ret) self.set_pricing_rule_details(item, ret) + else: + # Transactions line item without item code + + uom = item.get("uom") + stock_uom = item.get("stock_uom") + if bool(uom) != bool(stock_uom): # xor + item.stock_uom = item.uom = uom or stock_uom + + item.conversion_factor = get_uom_conv_factor(item.get("uom"), item.get("stock_uom")) if self.doctype == "Purchase Invoice": self.set_expense_account(for_validate) @@ -425,7 +566,7 @@ class AccountsController(TransactionBase): def apply_pricing_rule_on_items(self, item, pricing_rule_args): if not pricing_rule_args.get("validate_applied_rule", 0): # if user changed the discount percentage then set user's discount percentage ? - if pricing_rule_args.get("price_or_product_discount") == 'Price': + if pricing_rule_args.get("price_or_product_discount") == "Price": item.set("pricing_rules", pricing_rule_args.get("pricing_rules")) item.set("discount_percentage", pricing_rule_args.get("discount_percentage")) item.set("discount_amount", pricing_rule_args.get("discount_amount")) @@ -433,39 +574,48 @@ class AccountsController(TransactionBase): item.set("price_list_rate", pricing_rule_args.get("price_list_rate")) if item.get("price_list_rate"): - item.rate = flt(item.price_list_rate * - (1.0 - (flt(item.discount_percentage) / 100.0)), item.precision("rate")) + item.rate = flt( + item.price_list_rate * (1.0 - (flt(item.discount_percentage) / 100.0)), + item.precision("rate"), + ) - if item.get('discount_amount'): + if item.get("discount_amount"): item.rate = item.price_list_rate - item.discount_amount if item.get("apply_discount_on_discounted_rate") and pricing_rule_args.get("rate"): item.rate = pricing_rule_args.get("rate") - elif pricing_rule_args.get('free_item_data'): - apply_pricing_rule_for_free_items(self, pricing_rule_args.get('free_item_data')) + elif pricing_rule_args.get("free_item_data"): + apply_pricing_rule_for_free_items(self, pricing_rule_args.get("free_item_data")) elif pricing_rule_args.get("validate_applied_rule"): - for pricing_rule in get_applied_pricing_rules(item.get('pricing_rules')): + for pricing_rule in get_applied_pricing_rules(item.get("pricing_rules")): pricing_rule_doc = frappe.get_cached_doc("Pricing Rule", pricing_rule) - for field in ['discount_percentage', 'discount_amount', 'rate']: + for field in ["discount_percentage", "discount_amount", "rate"]: if item.get(field) < pricing_rule_doc.get(field): title = get_link_to_form("Pricing Rule", pricing_rule) - frappe.msgprint(_("Row {0}: user has not applied the rule {1} on the item {2}") - .format(item.idx, frappe.bold(title), frappe.bold(item.item_code))) + frappe.msgprint( + _("Row {0}: user has not applied the rule {1} on the item {2}").format( + item.idx, frappe.bold(title), frappe.bold(item.item_code) + ) + ) def set_pricing_rule_details(self, item_row, args): pricing_rules = get_applied_pricing_rules(args.get("pricing_rules")) - if not pricing_rules: return + if not pricing_rules: + return for pricing_rule in pricing_rules: - self.append("pricing_rules", { - "pricing_rule": pricing_rule, - "item_code": item_row.item_code, - "child_docname": item_row.name, - "rule_applied": True - }) + self.append( + "pricing_rules", + { + "pricing_rule": pricing_rule, + "item_code": item_row.item_code, + "child_docname": item_row.name, + "rule_applied": True, + }, + ) def set_taxes(self): if not self.meta.get_field("taxes"): @@ -476,14 +626,18 @@ class AccountsController(TransactionBase): if (self.is_new() or self.is_pos_profile_changed()) and not self.get("taxes"): if self.company and not self.get("taxes_and_charges"): # get the default tax master - self.taxes_and_charges = frappe.db.get_value(tax_master_doctype, - {"is_default": 1, 'company': self.company}) + self.taxes_and_charges = frappe.db.get_value( + tax_master_doctype, {"is_default": 1, "company": self.company} + ) self.append_taxes_from_master(tax_master_doctype) def is_pos_profile_changed(self): - if (self.doctype == 'Sales Invoice' and self.is_pos and - self.pos_profile != frappe.db.get_value('Sales Invoice', self.name, 'pos_profile')): + if ( + self.doctype == "Sales Invoice" + and self.is_pos + and self.pos_profile != frappe.db.get_value("Sales Invoice", self.name, "pos_profile") + ): return True def append_taxes_from_master(self, tax_master_doctype=None): @@ -500,44 +654,54 @@ class AccountsController(TransactionBase): def validate_enabled_taxes_and_charges(self): taxes_and_charges_doctype = self.meta.get_options("taxes_and_charges") if frappe.db.get_value(taxes_and_charges_doctype, self.taxes_and_charges, "disabled"): - frappe.throw(_("{0} '{1}' is disabled").format(taxes_and_charges_doctype, self.taxes_and_charges)) + frappe.throw( + _("{0} '{1}' is disabled").format(taxes_and_charges_doctype, self.taxes_and_charges) + ) def validate_tax_account_company(self): for d in self.get("taxes"): if d.account_head: tax_account_company = frappe.db.get_value("Account", d.account_head, "company") if tax_account_company != self.company: - frappe.throw(_("Row #{0}: Account {1} does not belong to company {2}") - .format(d.idx, d.account_head, self.company)) + frappe.throw( + _("Row #{0}: Account {1} does not belong to company {2}").format( + d.idx, d.account_head, self.company + ) + ) def get_gl_dict(self, args, account_currency=None, item=None): """this method populates the common properties of a gl entry record""" - posting_date = args.get('posting_date') or self.get('posting_date') + posting_date = args.get("posting_date") or self.get("posting_date") fiscal_years = get_fiscal_years(posting_date, company=self.company) if len(fiscal_years) > 1: - frappe.throw(_("Multiple fiscal years exist for the date {0}. Please set company in Fiscal Year").format( - formatdate(posting_date))) + frappe.throw( + _("Multiple fiscal years exist for the date {0}. Please set company in Fiscal Year").format( + formatdate(posting_date) + ) + ) else: fiscal_year = fiscal_years[0][0] - gl_dict = frappe._dict({ - 'company': self.company, - 'posting_date': posting_date, - 'fiscal_year': fiscal_year, - 'voucher_type': self.doctype, - 'voucher_no': self.name, - 'remarks': self.get("remarks") or self.get("remark"), - 'debit': 0, - 'credit': 0, - 'debit_in_account_currency': 0, - 'credit_in_account_currency': 0, - 'is_opening': self.get("is_opening") or "No", - 'party_type': None, - 'party': None, - 'project': self.get("project"), - 'post_net_value': args.get('post_net_value') - }) + gl_dict = frappe._dict( + { + "company": self.company, + "posting_date": posting_date, + "fiscal_year": fiscal_year, + "voucher_type": self.doctype, + "voucher_no": self.name, + "remarks": self.get("remarks") or self.get("remark"), + "debit": 0, + "credit": 0, + "debit_in_account_currency": 0, + "credit_in_account_currency": 0, + "is_opening": self.get("is_opening") or "No", + "party_type": None, + "party": None, + "project": self.get("project"), + "post_net_value": args.get("post_net_value"), + } + ) accounting_dimensions = get_accounting_dimensions() dimension_dict = frappe._dict() @@ -553,13 +717,24 @@ class AccountsController(TransactionBase): if not account_currency: account_currency = get_account_currency(gl_dict.account) - if gl_dict.account and self.doctype not in ["Journal Entry", - "Period Closing Voucher", "Payment Entry", "Purchase Receipt", "Purchase Invoice", "Stock Entry"]: + if gl_dict.account and self.doctype not in [ + "Journal Entry", + "Period Closing Voucher", + "Payment Entry", + "Purchase Receipt", + "Purchase Invoice", + "Stock Entry", + ]: self.validate_account_currency(gl_dict.account, account_currency) - if gl_dict.account and self.doctype not in ["Journal Entry", "Period Closing Voucher", "Payment Entry"]: - set_balance_in_account_currency(gl_dict, account_currency, self.get("conversion_rate"), - self.company_currency) + if gl_dict.account and self.doctype not in [ + "Journal Entry", + "Period Closing Voucher", + "Payment Entry", + ]: + set_balance_in_account_currency( + gl_dict, account_currency, self.get("conversion_rate"), self.company_currency + ) return gl_dict @@ -575,14 +750,21 @@ class AccountsController(TransactionBase): valid_currency.append(self.currency) if account_currency not in valid_currency: - frappe.throw(_("Account {0} is invalid. Account Currency must be {1}") - .format(account, (' ' + _("or") + ' ').join(valid_currency))) + frappe.throw( + _("Account {0} is invalid. Account Currency must be {1}").format( + account, (" " + _("or") + " ").join(valid_currency) + ) + ) def clear_unallocated_advances(self, childtype, parentfield): self.set(parentfield, self.get(parentfield, {"allocated_amount": ["not in", [0, None, ""]]})) - frappe.db.sql("""delete from `tab%s` where parentfield=%s and parent = %s - and allocated_amount = 0""" % (childtype, '%s', '%s'), (parentfield, self.name)) + frappe.db.sql( + """delete from `tab%s` where parentfield=%s and parent = %s + and allocated_amount = 0""" + % (childtype, "%s", "%s"), + (parentfield, self.name), + ) @frappe.whitelist() def apply_shipping_rule(self): @@ -592,16 +774,16 @@ class AccountsController(TransactionBase): self.calculate_taxes_and_totals() def get_shipping_address(self): - '''Returns Address object from shipping address fields if present''' + """Returns Address object from shipping address fields if present""" # shipping address fields can be `shipping_address_name` or `shipping_address` # try getting value from both - for fieldname in ('shipping_address_name', 'shipping_address'): + for fieldname in ("shipping_address_name", "shipping_address"): shipping_field = self.meta.get_field(fieldname) - if shipping_field and shipping_field.fieldtype == 'Link': + if shipping_field and shipping_field.fieldtype == "Link": if self.get(fieldname): - return frappe.get_doc('Address', self.get(fieldname)) + return frappe.get_doc("Address", self.get(fieldname)) return {} @@ -617,10 +799,10 @@ class AccountsController(TransactionBase): if d.against_order: allocated_amount = flt(d.amount) else: - if self.get('party_account_currency') == self.company_currency: - amount = self.get('base_rounded_total') or self.base_grand_total + if self.get("party_account_currency") == self.company_currency: + amount = self.get("base_rounded_total") or self.base_grand_total else: - amount = self.get('rounded_total') or self.grand_total + amount = self.get("rounded_total") or self.grand_total allocated_amount = min(amount - advance_allocated, d.amount) advance_allocated += flt(allocated_amount) @@ -633,7 +815,7 @@ class AccountsController(TransactionBase): "remarks": d.remarks, "advance_amount": flt(d.amount), "allocated_amount": allocated_amount, - "ref_exchange_rate": flt(d.exchange_rate) # exchange_rate of advance entry + "ref_exchange_rate": flt(d.exchange_rate), # exchange_rate of advance entry } self.append("advances", advance_row) @@ -654,21 +836,24 @@ class AccountsController(TransactionBase): order_field = "purchase_order" order_doctype = "Purchase Order" - order_list = list(set(d.get(order_field) - for d in self.get("items") if d.get(order_field))) + order_list = list(set(d.get(order_field) for d in self.get("items") if d.get(order_field))) - journal_entries = get_advance_journal_entries(party_type, party, party_account, - amount_field, order_doctype, order_list, include_unallocated) + journal_entries = get_advance_journal_entries( + party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated + ) - payment_entries = get_advance_payment_entries(party_type, party, party_account, - order_doctype, order_list, include_unallocated) + payment_entries = get_advance_payment_entries( + party_type, party, party_account, order_doctype, order_list, include_unallocated + ) res = journal_entries + payment_entries return res def is_inclusive_tax(self): - is_inclusive = cint(frappe.db.get_single_value("Accounts Settings", "show_inclusive_tax_in_print")) + is_inclusive = cint( + frappe.db.get_single_value("Accounts Settings", "show_inclusive_tax_in_print") + ) if is_inclusive: is_inclusive = 0 @@ -679,10 +864,10 @@ class AccountsController(TransactionBase): def validate_advance_entries(self): order_field = "sales_order" if self.doctype == "Sales Invoice" else "purchase_order" - order_list = list(set(d.get(order_field) - for d in self.get("items") if d.get(order_field))) + order_list = list(set(d.get(order_field) for d in self.get("items") if d.get(order_field))) - if not order_list: return + if not order_list: + return advance_entries = self.get_advance_entries(include_unallocated=False) @@ -690,22 +875,24 @@ class AccountsController(TransactionBase): advance_entries_against_si = [d.reference_name for d in self.get("advances")] for d in advance_entries: if not advance_entries_against_si or d.reference_name not in advance_entries_against_si: - frappe.msgprint(_( - "Payment Entry {0} is linked against Order {1}, check if it should be pulled as advance in this invoice.") - .format(d.reference_name, d.against_order)) + frappe.msgprint( + _( + "Payment Entry {0} is linked against Order {1}, check if it should be pulled as advance in this invoice." + ).format(d.reference_name, d.against_order) + ) def set_advance_gain_or_loss(self): - if self.get('conversion_rate') == 1 or not self.get("advances"): + if self.get("conversion_rate") == 1 or not self.get("advances"): return - is_purchase_invoice = self.doctype == 'Purchase Invoice' + is_purchase_invoice = self.doctype == "Purchase Invoice" party_account = self.credit_to if is_purchase_invoice else self.debit_to if get_account_currency(party_account) != self.currency: return for d in self.get("advances"): advance_exchange_rate = d.ref_exchange_rate - if (d.allocated_amount and self.conversion_rate != advance_exchange_rate): + if d.allocated_amount and self.conversion_rate != advance_exchange_rate: base_allocated_amount_in_ref_rate = advance_exchange_rate * d.allocated_amount base_allocated_amount_in_inv_rate = self.conversion_rate * d.allocated_amount @@ -714,61 +901,71 @@ class AccountsController(TransactionBase): d.exchange_gain_loss = difference def make_exchange_gain_loss_gl_entries(self, gl_entries): - if self.get('doctype') in ['Purchase Invoice', 'Sales Invoice']: + if self.get("doctype") in ["Purchase Invoice", "Sales Invoice"]: for d in self.get("advances"): if d.exchange_gain_loss: - is_purchase_invoice = self.get('doctype') == 'Purchase Invoice' + is_purchase_invoice = self.get("doctype") == "Purchase Invoice" party = self.supplier if is_purchase_invoice else self.customer party_account = self.credit_to if is_purchase_invoice else self.debit_to party_type = "Supplier" if is_purchase_invoice else "Customer" - gain_loss_account = frappe.db.get_value('Company', self.company, 'exchange_gain_loss_account') + gain_loss_account = frappe.db.get_value("Company", self.company, "exchange_gain_loss_account") if not gain_loss_account: - frappe.throw(_("Please set default Exchange Gain/Loss Account in Company {}") - .format(self.get('company'))) + frappe.throw( + _("Please set default Exchange Gain/Loss Account in Company {}").format(self.get("company")) + ) account_currency = get_account_currency(gain_loss_account) if account_currency != self.company_currency: - frappe.throw(_("Currency for {0} must be {1}").format(gain_loss_account, self.company_currency)) + frappe.throw( + _("Currency for {0} must be {1}").format(gain_loss_account, self.company_currency) + ) # for purchase - dr_or_cr = 'debit' if d.exchange_gain_loss > 0 else 'credit' + dr_or_cr = "debit" if d.exchange_gain_loss > 0 else "credit" if not is_purchase_invoice: # just reverse for sales? - dr_or_cr = 'debit' if dr_or_cr == 'credit' else 'credit' + dr_or_cr = "debit" if dr_or_cr == "credit" else "credit" gl_entries.append( - self.get_gl_dict({ - "account": gain_loss_account, - "account_currency": account_currency, - "against": party, - dr_or_cr + "_in_account_currency": abs(d.exchange_gain_loss), - dr_or_cr: abs(d.exchange_gain_loss), - "cost_center": self.cost_center or erpnext.get_default_cost_center(self.company), - "project": self.project - }, item=d) + self.get_gl_dict( + { + "account": gain_loss_account, + "account_currency": account_currency, + "against": party, + dr_or_cr + "_in_account_currency": abs(d.exchange_gain_loss), + dr_or_cr: abs(d.exchange_gain_loss), + "cost_center": self.cost_center or erpnext.get_default_cost_center(self.company), + "project": self.project, + }, + item=d, + ) ) - dr_or_cr = 'debit' if dr_or_cr == 'credit' else 'credit' + dr_or_cr = "debit" if dr_or_cr == "credit" else "credit" gl_entries.append( - self.get_gl_dict({ - "account": party_account, - "party_type": party_type, - "party": party, - "against": gain_loss_account, - dr_or_cr + "_in_account_currency": flt(abs(d.exchange_gain_loss) / self.conversion_rate), - dr_or_cr: abs(d.exchange_gain_loss), - "cost_center": self.cost_center, - "project": self.project - }, self.party_account_currency, item=self) + self.get_gl_dict( + { + "account": party_account, + "party_type": party_type, + "party": party, + "against": gain_loss_account, + dr_or_cr + "_in_account_currency": flt(abs(d.exchange_gain_loss) / self.conversion_rate), + dr_or_cr: abs(d.exchange_gain_loss), + "cost_center": self.cost_center, + "project": self.project, + }, + self.party_account_currency, + item=self, + ) ) def update_against_document_in_jv(self): """ - Links invoice and advance voucher: - 1. cancel advance voucher - 2. split into multiple rows if partially adjusted, assign against voucher - 3. submit advance voucher + Links invoice and advance voucher: + 1. cancel advance voucher + 2. split into multiple rows if partially adjusted, assign against voucher + 3. submit advance voucher """ if self.doctype == "Sales Invoice": @@ -783,45 +980,56 @@ class AccountsController(TransactionBase): dr_or_cr = "debit_in_account_currency" lst = [] - for d in self.get('advances'): + for d in self.get("advances"): if flt(d.allocated_amount) > 0: - args = frappe._dict({ - 'voucher_type': d.reference_type, - 'voucher_no': d.reference_name, - 'voucher_detail_no': d.reference_row, - 'against_voucher_type': self.doctype, - 'against_voucher': self.name, - 'account': party_account, - 'party_type': party_type, - 'party': party, - 'is_advance': 'Yes', - 'dr_or_cr': dr_or_cr, - 'unadjusted_amount': flt(d.advance_amount), - 'allocated_amount': flt(d.allocated_amount), - 'precision': d.precision('advance_amount'), - 'exchange_rate': (self.conversion_rate - if self.party_account_currency != self.company_currency else 1), - 'grand_total': (self.base_grand_total - if self.party_account_currency == self.company_currency else self.grand_total), - 'outstanding_amount': self.outstanding_amount, - 'difference_account': frappe.db.get_value('Company', self.company, 'exchange_gain_loss_account'), - 'exchange_gain_loss': flt(d.get('exchange_gain_loss')) - }) + args = frappe._dict( + { + "voucher_type": d.reference_type, + "voucher_no": d.reference_name, + "voucher_detail_no": d.reference_row, + "against_voucher_type": self.doctype, + "against_voucher": self.name, + "account": party_account, + "party_type": party_type, + "party": party, + "is_advance": "Yes", + "dr_or_cr": dr_or_cr, + "unadjusted_amount": flt(d.advance_amount), + "allocated_amount": flt(d.allocated_amount), + "precision": d.precision("advance_amount"), + "exchange_rate": ( + self.conversion_rate if self.party_account_currency != self.company_currency else 1 + ), + "grand_total": ( + self.base_grand_total + if self.party_account_currency == self.company_currency + else self.grand_total + ), + "outstanding_amount": self.outstanding_amount, + "difference_account": frappe.db.get_value( + "Company", self.company, "exchange_gain_loss_account" + ), + "exchange_gain_loss": flt(d.get("exchange_gain_loss")), + } + ) lst.append(args) if lst: from erpnext.accounts.utils import reconcile_against_document + reconcile_against_document(lst) def on_cancel(self): from erpnext.accounts.utils import unlink_ref_doc_from_payment_entries if self.doctype in ["Sales Invoice", "Purchase Invoice"]: - if frappe.db.get_single_value('Accounts Settings', 'unlink_payment_on_cancellation_of_invoice'): + if frappe.db.get_single_value("Accounts Settings", "unlink_payment_on_cancellation_of_invoice"): unlink_ref_doc_from_payment_entries(self) elif self.doctype in ["Sales Order", "Purchase Order"]: - if frappe.db.get_single_value('Accounts Settings', 'unlink_advance_payment_on_cancelation_of_order'): + if frappe.db.get_single_value( + "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order" + ): unlink_ref_doc_from_payment_entries(self) if self.doctype == "Sales Order": @@ -832,33 +1040,32 @@ class AccountsController(TransactionBase): for item in self.items: so_items.append(item.name) - linked_po = list(set(frappe.get_all( - 'Purchase Order Item', - filters = { - 'sales_order': self.name, - 'sales_order_item': ['in', so_items], - 'docstatus': ['<', 2] - }, - pluck='parent' - ))) + linked_po = list( + set( + frappe.get_all( + "Purchase Order Item", + filters={ + "sales_order": self.name, + "sales_order_item": ["in", so_items], + "docstatus": ["<", 2], + }, + pluck="parent", + ) + ) + ) if linked_po: frappe.db.set_value( - 'Purchase Order Item', { - 'sales_order': self.name, - 'sales_order_item': ['in', so_items], - 'docstatus': ['<', 2] - },{ - 'sales_order': None, - 'sales_order_item': None - } + "Purchase Order Item", + {"sales_order": self.name, "sales_order_item": ["in", so_items], "docstatus": ["<", 2]}, + {"sales_order": None, "sales_order_item": None}, ) frappe.msgprint(_("Purchase Orders {0} are un-linked").format("\n".join(linked_po))) def get_tax_map(self): tax_map = {} - for tax in self.get('taxes'): + for tax in self.get("taxes"): tax_map.setdefault(tax.account_head, 0.0) tax_map[tax.account_head] += tax.tax_amount @@ -868,7 +1075,11 @@ class AccountsController(TransactionBase): amount = item.net_amount base_amount = item.base_net_amount - if enable_discount_accounting and self.get('discount_amount') and self.get('additional_discount_account'): + if ( + enable_discount_accounting + and self.get("discount_amount") + and self.get("additional_discount_account") + ): amount = item.amount base_amount = item.base_amount @@ -878,75 +1089,102 @@ class AccountsController(TransactionBase): amount = tax.tax_amount_after_discount_amount base_amount = tax.base_tax_amount_after_discount_amount - if enable_discount_accounting and self.get('discount_amount') and self.get('additional_discount_account') \ - and self.get('apply_discount_on') == 'Grand Total': + if ( + enable_discount_accounting + and self.get("discount_amount") + and self.get("additional_discount_account") + and self.get("apply_discount_on") == "Grand Total" + ): amount = tax.tax_amount base_amount = tax.base_tax_amount return amount, base_amount def make_discount_gl_entries(self, gl_entries): - enable_discount_accounting = cint(frappe.db.get_single_value('Accounts Settings', 'enable_discount_accounting')) + enable_discount_accounting = cint( + frappe.db.get_single_value("Accounts Settings", "enable_discount_accounting") + ) + + if self.doctype == "Purchase Invoice": + dr_or_cr = "credit" + rev_dr_cr = "debit" + supplier_or_customer = self.supplier + + else: + dr_or_cr = "debit" + rev_dr_cr = "credit" + supplier_or_customer = self.customer if enable_discount_accounting: - if self.doctype == "Purchase Invoice": - dr_or_cr = "credit" - rev_dr_cr = "debit" - supplier_or_customer = self.supplier - - else: - dr_or_cr = "debit" - rev_dr_cr = "credit" - supplier_or_customer = self.customer - for item in self.get("items"): - if item.get('discount_amount') and item.get('discount_account'): + if item.get("discount_amount") and item.get("discount_account"): discount_amount = item.discount_amount * item.qty if self.doctype == "Purchase Invoice": - income_or_expense_account = (item.expense_account + income_or_expense_account = ( + item.expense_account if (not item.enable_deferred_expense or self.is_return) - else item.deferred_expense_account) + else item.deferred_expense_account + ) else: - income_or_expense_account = (item.income_account + income_or_expense_account = ( + item.income_account if (not item.enable_deferred_revenue or self.is_return) - else item.deferred_revenue_account) + else item.deferred_revenue_account + ) account_currency = get_account_currency(item.discount_account) gl_entries.append( - self.get_gl_dict({ - "account": item.discount_account, - "against": supplier_or_customer, - dr_or_cr: flt(discount_amount, item.precision('discount_amount')), - dr_or_cr + "_in_account_currency": flt(discount_amount * self.get('conversion_rate'), - item.precision('discount_amount')), - "cost_center": item.cost_center, - "project": item.project - }, account_currency, item=item) + self.get_gl_dict( + { + "account": item.discount_account, + "against": supplier_or_customer, + dr_or_cr: flt( + discount_amount * self.get("conversion_rate"), item.precision("discount_amount") + ), + dr_or_cr + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")), + "cost_center": item.cost_center, + "project": item.project, + }, + account_currency, + item=item, + ) ) account_currency = get_account_currency(income_or_expense_account) gl_entries.append( - self.get_gl_dict({ - "account": income_or_expense_account, - "against": supplier_or_customer, - rev_dr_cr: flt(discount_amount, item.precision('discount_amount')), - rev_dr_cr + "_in_account_currency": flt(discount_amount * self.get('conversion_rate'), - item.precision('discount_amount')), - "cost_center": item.cost_center, - "project": item.project or self.project - }, account_currency, item=item) + self.get_gl_dict( + { + "account": income_or_expense_account, + "against": supplier_or_customer, + rev_dr_cr: flt( + discount_amount * self.get("conversion_rate"), item.precision("discount_amount") + ), + rev_dr_cr + + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")), + "cost_center": item.cost_center, + "project": item.project or self.project, + }, + account_currency, + item=item, + ) ) - if self.get('discount_amount') and self.get('additional_discount_account'): - gl_entries.append( - self.get_gl_dict({ + if ( + (enable_discount_accounting or self.get("is_cash_or_non_trade_discount")) + and self.get("additional_discount_account") + and self.get("discount_amount") + ): + gl_entries.append( + self.get_gl_dict( + { "account": self.additional_discount_account, "against": supplier_or_customer, dr_or_cr: self.discount_amount, - "cost_center": self.cost_center - }, item=self) + "cost_center": self.cost_center, + }, + item=self, ) - + ) def validate_multiple_billing(self, ref_dt, item_ref_dn, based_on, parentfield): from erpnext.controllers.status_updater import get_allowance_for @@ -954,7 +1192,9 @@ class AccountsController(TransactionBase): item_allowance = {} global_qty_allowance, global_amount_allowance = None, None - role_allowed_to_over_bill = frappe.db.get_single_value('Accounts Settings', 'role_allowed_to_over_bill') + role_allowed_to_over_bill = frappe.db.get_single_value( + "Accounts Settings", "role_allowed_to_over_bill" + ) user_roles = frappe.get_roles() total_overbilled_amt = 0.0 @@ -963,21 +1203,29 @@ class AccountsController(TransactionBase): if not item.get(item_ref_dn): continue - ref_amt = flt(frappe.db.get_value(ref_dt + " Item", - item.get(item_ref_dn), based_on), self.precision(based_on, item)) + ref_amt = flt( + frappe.db.get_value(ref_dt + " Item", item.get(item_ref_dn), based_on), + self.precision(based_on, item), + ) if not ref_amt: frappe.msgprint( - _("System will not check overbilling since amount for Item {0} in {1} is zero") - .format(item.item_code, ref_dt), title=_("Warning"), indicator="orange") + _("System will not check overbilling since amount for Item {0} in {1} is zero").format( + item.item_code, ref_dt + ), + title=_("Warning"), + indicator="orange", + ) continue already_billed = self.get_billed_amount_for_item(item, item_ref_dn, based_on) - total_billed_amt = flt(flt(already_billed) + flt(item.get(based_on)), - self.precision(based_on, item)) + total_billed_amt = flt( + flt(already_billed) + flt(item.get(based_on)), self.precision(based_on, item) + ) - allowance, item_allowance, global_qty_allowance, global_amount_allowance = \ - get_allowance_for(item.item_code, item_allowance, global_qty_allowance, global_amount_allowance, "amount") + allowance, item_allowance, global_qty_allowance, global_amount_allowance = get_allowance_for( + item.item_code, item_allowance, global_qty_allowance, global_amount_allowance, "amount" + ) max_allowed_amt = flt(ref_amt * (100 + allowance) / 100) @@ -992,20 +1240,29 @@ class AccountsController(TransactionBase): if overbill_amt > 0.01 and role_allowed_to_over_bill not in user_roles: if self.doctype != "Purchase Invoice": self.throw_overbill_exception(item, max_allowed_amt) - elif not cint(frappe.db.get_single_value("Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice")): + elif not cint( + frappe.db.get_single_value( + "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice" + ) + ): self.throw_overbill_exception(item, max_allowed_amt) if role_allowed_to_over_bill in user_roles and total_overbilled_amt > 0.1: - frappe.msgprint(_("Overbilling of {} ignored because you have {} role.") - .format(total_overbilled_amt, role_allowed_to_over_bill), indicator="orange", alert=True) + frappe.msgprint( + _("Overbilling of {} ignored because you have {} role.").format( + total_overbilled_amt, role_allowed_to_over_bill + ), + indicator="orange", + alert=True, + ) def get_billed_amount_for_item(self, item, item_ref_dn, based_on): - ''' - Returns Sum of Amount of - Sales/Purchase Invoice Items - that are linked to `item_ref_dn` (`dn_detail` / `pr_detail`) - that are submitted OR not submitted but are under current invoice - ''' + """ + Returns Sum of Amount of + Sales/Purchase Invoice Items + that are linked to `item_ref_dn` (`dn_detail` / `pr_detail`) + that are submitted OR not submitted but are under current invoice + """ from frappe.query_builder import Criterion from frappe.query_builder.functions import Sum @@ -1017,41 +1274,51 @@ class AccountsController(TransactionBase): result = ( frappe.qb.from_(item_doctype) .select(Sum(based_on_field)) + .where(join_field == item.get(item_ref_dn)) .where( - join_field == item.get(item_ref_dn) - ).where( - Criterion.any([ # select all items from other invoices OR current invoices - Criterion.all([ # for selecting items from other invoices - item_doctype.docstatus == 1, - item_doctype.parent != self.name - ]), - Criterion.all([ # for selecting items from current invoice, that are linked to same reference - item_doctype.docstatus == 0, - item_doctype.parent == self.name, - item_doctype.name != item.name - ]) - ]) + Criterion.any( + [ # select all items from other invoices OR current invoices + Criterion.all( + [ # for selecting items from other invoices + item_doctype.docstatus == 1, + item_doctype.parent != self.name, + ] + ), + Criterion.all( + [ # for selecting items from current invoice, that are linked to same reference + item_doctype.docstatus == 0, + item_doctype.parent == self.name, + item_doctype.name != item.name, + ] + ), + ] + ) ) ).run() return result[0][0] if result else 0 def throw_overbill_exception(self, item, max_allowed_amt): - frappe.throw(_("Cannot overbill for Item {0} in row {1} more than {2}. To allow over-billing, please set allowance in Accounts Settings") - .format(item.item_code, item.idx, max_allowed_amt)) + frappe.throw( + _( + "Cannot overbill for Item {0} in row {1} more than {2}. To allow over-billing, please set allowance in Accounts Settings" + ).format(item.item_code, item.idx, max_allowed_amt) + ) def get_company_default(self, fieldname, ignore_validation=False): from erpnext.accounts.utils import get_company_default + return get_company_default(self.company, fieldname, ignore_validation=ignore_validation) def get_stock_items(self): stock_items = [] item_codes = list(set(item.item_code for item in self.get("items"))) if item_codes: - stock_items = [r[0] for r in frappe.db.sql(""" - select name from `tabItem` - where name in (%s) and is_stock_item=1 - """ % (", ".join((["%s"] * len(item_codes))),), item_codes)] + stock_items = frappe.db.get_values( + "Item", {"name": ["in", item_codes], "is_stock_item": 1}, as_dict=True, cache=True + ) + if stock_items: + stock_items = [d.get("name") for d in stock_items] return stock_items @@ -1065,7 +1332,8 @@ class AccountsController(TransactionBase): rev_dr_or_cr = "credit_in_account_currency" party = self.supplier - advance = frappe.db.sql(""" + advance = frappe.db.sql( + """ select account_currency, sum({dr_or_cr}) - sum({rev_dr_cr}) as amount from @@ -1073,17 +1341,22 @@ class AccountsController(TransactionBase): where against_voucher_type = %s and against_voucher = %s and party=%s and docstatus = 1 - """.format(dr_or_cr=dr_or_cr, rev_dr_cr=rev_dr_or_cr), (self.doctype, self.name, party), as_dict=1) #nosec + """.format( + dr_or_cr=dr_or_cr, rev_dr_cr=rev_dr_or_cr + ), + (self.doctype, self.name, party), + as_dict=1, + ) # nosec if advance: advance = advance[0] advance_paid = flt(advance.amount, self.precision("advance_paid")) - formatted_advance_paid = fmt_money(advance_paid, precision=self.precision("advance_paid"), - currency=advance.account_currency) + formatted_advance_paid = fmt_money( + advance_paid, precision=self.precision("advance_paid"), currency=advance.account_currency + ) - frappe.db.set_value(self.doctype, self.name, "party_account_currency", - advance.account_currency) + frappe.db.set_value(self.doctype, self.name, "party_account_currency", advance.account_currency) if advance.account_currency == self.currency: order_total = self.get("rounded_total") or self.grand_total @@ -1092,34 +1365,50 @@ class AccountsController(TransactionBase): order_total = self.get("base_rounded_total") or self.base_grand_total precision = "base_rounded_total" if self.get("base_rounded_total") else "base_grand_total" - formatted_order_total = fmt_money(order_total, precision=self.precision(precision), - currency=advance.account_currency) + formatted_order_total = fmt_money( + order_total, precision=self.precision(precision), currency=advance.account_currency + ) if self.currency == self.company_currency and advance_paid > order_total: - frappe.throw(_("Total advance ({0}) against Order {1} cannot be greater than the Grand Total ({2})") - .format(formatted_advance_paid, self.name, formatted_order_total)) + frappe.throw( + _( + "Total advance ({0}) against Order {1} cannot be greater than the Grand Total ({2})" + ).format(formatted_advance_paid, self.name, formatted_order_total) + ) frappe.db.set_value(self.doctype, self.name, "advance_paid", advance_paid) @property def company_abbr(self): if not hasattr(self, "_abbr"): - self._abbr = frappe.db.get_value('Company', self.company, "abbr") + self._abbr = frappe.db.get_value("Company", self.company, "abbr") return self._abbr def raise_missing_debit_credit_account_error(self, party_type, party): """Raise an error if debit to/credit to account does not exist.""" - db_or_cr = frappe.bold("Debit To") if self.doctype == "Sales Invoice" else frappe.bold("Credit To") + db_or_cr = ( + frappe.bold("Debit To") if self.doctype == "Sales Invoice" else frappe.bold("Credit To") + ) rec_or_pay = "Receivable" if self.doctype == "Sales Invoice" else "Payable" link_to_party = frappe.utils.get_link_to_form(party_type, party) link_to_company = frappe.utils.get_link_to_form("Company", self.company) - message = _("{0} Account not found against Customer {1}.").format(db_or_cr, frappe.bold(party) or '') + message = _("{0} Account not found against Customer {1}.").format( + db_or_cr, frappe.bold(party) or "" + ) message += "
" + _("Please set one of the following:") + "
" - message += "
- " + _("'Account' in the Accounting section of Customer {0}").format(link_to_party) + " " - message += "
- " + _("'Default {0} Account' in Company {1}").format(rec_or_pay, link_to_company) + "
- " + + _("'Account' in the Accounting section of Customer {0}").format(link_to_party) + + " " + ) + message += ( + "
- " + + _("'Default {0} Account' in Company {1}").format(rec_or_pay, link_to_company) + + "
' + '
'.join(li) - frappe.throw(_("Rows with duplicate due dates in other rows were found: {0}").format(duplicates)) + duplicates = "
" + "
".join(li) + frappe.throw( + _("Rows with duplicate due dates in other rows were found: {0}").format(duplicates) + ) def validate_payment_schedule_amount(self): - if self.doctype == 'Sales Invoice' and self.is_pos: return + if self.doctype == "Sales Invoice" and self.is_pos: + return - party_account_currency = self.get('party_account_currency') + party_account_currency = self.get("party_account_currency") if not party_account_currency: party_type, party = self.get_party() @@ -1369,14 +1733,25 @@ class AccountsController(TransactionBase): if self.get("total_advance"): if party_account_currency == self.company_currency: base_grand_total -= self.get("total_advance") - grand_total = flt(base_grand_total / self.get("conversion_rate"), self.precision("grand_total")) + grand_total = flt( + base_grand_total / self.get("conversion_rate"), self.precision("grand_total") + ) else: grand_total -= self.get("total_advance") - base_grand_total = flt(grand_total * self.get("conversion_rate"), self.precision("base_grand_total")) + base_grand_total = flt( + grand_total * self.get("conversion_rate"), self.precision("base_grand_total") + ) - if flt(total, self.precision("grand_total")) - flt(grand_total, self.precision("grand_total")) > 0.1 or \ - flt(base_total, self.precision("base_grand_total")) - flt(base_grand_total, self.precision("base_grand_total")) > 0.1: - frappe.throw(_("Total Payment Amount in Payment Schedule must be equal to Grand / Rounded Total")) + if ( + flt(total, self.precision("grand_total")) - flt(grand_total, self.precision("grand_total")) + > 0.1 + or flt(base_total, self.precision("base_grand_total")) + - flt(base_grand_total, self.precision("base_grand_total")) + > 0.1 + ): + frappe.throw( + _("Total Payment Amount in Payment Schedule must be equal to Grand / Rounded Total") + ) def is_rounded_total_disabled(self): if self.meta.get_field("disable_rounded_total"): @@ -1386,30 +1761,35 @@ class AccountsController(TransactionBase): def set_inter_company_account(self): """ - Set intercompany account for inter warehouse transactions - This account will be used in case billing company and internal customer's - representation company is same + Set intercompany account for inter warehouse transactions + This account will be used in case billing company and internal customer's + representation company is same """ if self.is_internal_transfer() and not self.unrealized_profit_loss_account: - unrealized_profit_loss_account = frappe.db.get_value('Company', self.company, 'unrealized_profit_loss_account') + unrealized_profit_loss_account = frappe.db.get_value( + "Company", self.company, "unrealized_profit_loss_account" + ) if not unrealized_profit_loss_account: - msg = _("Please select Unrealized Profit / Loss account or add default Unrealized Profit / Loss account account for company {0}").format( - frappe.bold(self.company)) + msg = _( + "Please select Unrealized Profit / Loss account or add default Unrealized Profit / Loss account account for company {0}" + ).format(frappe.bold(self.company)) frappe.throw(msg) self.unrealized_profit_loss_account = unrealized_profit_loss_account def is_internal_transfer(self): """ - It will an internal transfer if its an internal customer and representation - company is same as billing company + It will an internal transfer if its an internal customer and representation + company is same as billing company """ - if self.doctype in ('Sales Invoice', 'Delivery Note', 'Sales Order'): - internal_party_field = 'is_internal_customer' - elif self.doctype in ('Purchase Invoice', 'Purchase Receipt', 'Purchase Order'): - internal_party_field = 'is_internal_supplier' + if self.doctype in ("Sales Invoice", "Delivery Note", "Sales Order"): + internal_party_field = "is_internal_customer" + elif self.doctype in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"): + internal_party_field = "is_internal_supplier" + else: + return False if self.get(internal_party_field) and (self.represents_company == self.company): return True @@ -1417,11 +1797,11 @@ class AccountsController(TransactionBase): return False def process_common_party_accounting(self): - is_invoice = self.doctype in ['Sales Invoice', 'Purchase Invoice'] + is_invoice = self.doctype in ["Sales Invoice", "Purchase Invoice"] if not is_invoice: return - if frappe.db.get_single_value('Accounts Settings', 'enable_common_party_accounting'): + if frappe.db.get_single_value("Accounts Settings", "enable_common_party_accounting"): party_link = self.get_common_party_link() if party_link and self.outstanding_amount: self.create_advance_and_reconcile(party_link) @@ -1429,10 +1809,10 @@ class AccountsController(TransactionBase): def get_common_party_link(self): party_type, party = self.get_party() return frappe.db.get_value( - doctype='Party Link', - filters={'secondary_role': party_type, 'secondary_party': party}, - fieldname=['primary_role', 'primary_party'], - as_dict=True + doctype="Party Link", + filters={"secondary_role": party_type, "secondary_party": party}, + fieldname=["primary_role", "primary_party"], + as_dict=True, ) def create_advance_and_reconcile(self, party_link): @@ -1442,11 +1822,11 @@ class AccountsController(TransactionBase): primary_account = get_party_account(primary_party_type, primary_party, self.company) secondary_account = get_party_account(secondary_party_type, secondary_party, self.company) - jv = frappe.new_doc('Journal Entry') - jv.voucher_type = 'Journal Entry' + jv = frappe.new_doc("Journal Entry") + jv.voucher_type = "Journal Entry" jv.posting_date = self.posting_date jv.company = self.company - jv.remark = 'Adjustment for {} {}'.format(self.doctype, self.name) + jv.remark = "Adjustment for {} {}".format(self.doctype, self.name) reconcilation_entry = frappe._dict() advance_entry = frappe._dict() @@ -1462,21 +1842,33 @@ class AccountsController(TransactionBase): advance_entry.party_type = primary_party_type advance_entry.party = primary_party advance_entry.cost_center = self.cost_center - advance_entry.is_advance = 'Yes' + advance_entry.is_advance = "Yes" - if self.doctype == 'Sales Invoice': + if self.doctype == "Sales Invoice": reconcilation_entry.credit_in_account_currency = self.outstanding_amount advance_entry.debit_in_account_currency = self.outstanding_amount else: advance_entry.credit_in_account_currency = self.outstanding_amount reconcilation_entry.debit_in_account_currency = self.outstanding_amount - jv.append('accounts', reconcilation_entry) - jv.append('accounts', advance_entry) + jv.append("accounts", reconcilation_entry) + jv.append("accounts", advance_entry) jv.save() jv.submit() + def check_conversion_rate(self): + default_currency = erpnext.get_company_currency(self.company) + if not default_currency: + throw(_("Please enter default currency in Company Master")) + if ( + (self.currency == default_currency and flt(self.conversion_rate) != 1.00) + or not self.conversion_rate + or (self.currency != default_currency and flt(self.conversion_rate) == 1.00) + ): + throw(_("Conversion rate cannot be 0 or 1")) + + @frappe.whitelist() def get_tax_rate(account_head): return frappe.db.get_value("Account", account_head, ["tax_rate", "account_name"], as_dict=True) @@ -1484,7 +1876,8 @@ def get_tax_rate(account_head): @frappe.whitelist() def get_default_taxes_and_charges(master_doctype, tax_template=None, company=None): - if not company: return {} + if not company: + return {} if tax_template and company: tax_template_company = frappe.db.get_value(master_doctype, tax_template, "company") @@ -1494,8 +1887,8 @@ def get_default_taxes_and_charges(master_doctype, tax_template=None, company=Non default_tax = frappe.db.get_value(master_doctype, {"is_default": 1, "company": company}) return { - 'taxes_and_charges': default_tax, - 'taxes': get_taxes_and_charges(master_doctype, default_tax) + "taxes_and_charges": default_tax, + "taxes": get_taxes_and_charges(master_doctype, default_tax), } @@ -1504,6 +1897,7 @@ def get_taxes_and_charges(master_doctype, master_name): if not master_name: return from frappe.model import default_fields + tax_master = frappe.get_doc(master_doctype, master_name) taxes_and_charges = [] @@ -1522,110 +1916,162 @@ def get_taxes_and_charges(master_doctype, master_name): def validate_conversion_rate(currency, conversion_rate, conversion_rate_label, company): """common validation for currency and price list currency""" - company_currency = frappe.get_cached_value('Company', company, "default_currency") + company_currency = frappe.get_cached_value("Company", company, "default_currency") if not conversion_rate: throw( - _("{0} is mandatory. Maybe Currency Exchange record is not created for {1} to {2}.") - .format(conversion_rate_label, currency, company_currency) + _("{0} is mandatory. Maybe Currency Exchange record is not created for {1} to {2}.").format( + conversion_rate_label, currency, company_currency + ) ) def validate_taxes_and_charges(tax): - if tax.charge_type in ['Actual', 'On Net Total', 'On Paid Amount'] and tax.row_id: - frappe.throw(_("Can refer row only if the charge type is 'On Previous Row Amount' or 'Previous Row Total'")) - elif tax.charge_type in ['On Previous Row Amount', 'On Previous Row Total']: + if tax.charge_type in ["Actual", "On Net Total", "On Paid Amount"] and tax.row_id: + frappe.throw( + _("Can refer row only if the charge type is 'On Previous Row Amount' or 'Previous Row Total'") + ) + elif tax.charge_type in ["On Previous Row Amount", "On Previous Row Total"]: if cint(tax.idx) == 1: frappe.throw( - _("Cannot select charge type as 'On Previous Row Amount' or 'On Previous Row Total' for first row")) + _( + "Cannot select charge type as 'On Previous Row Amount' or 'On Previous Row Total' for first row" + ) + ) elif not tax.row_id: - frappe.throw(_("Please specify a valid Row ID for row {0} in table {1}").format(tax.idx, _(tax.doctype))) + frappe.throw( + _("Please specify a valid Row ID for row {0} in table {1}").format(tax.idx, _(tax.doctype)) + ) elif tax.row_id and cint(tax.row_id) >= cint(tax.idx): - frappe.throw(_("Cannot refer row number greater than or equal to current row number for this Charge type")) + frappe.throw( + _("Cannot refer row number greater than or equal to current row number for this Charge type") + ) if tax.charge_type == "Actual": tax.rate = None -def validate_account_head(tax, doc): - company = frappe.get_cached_value('Account', - tax.account_head, 'company') +def validate_account_head(idx, account, company, context=""): + account_company = frappe.get_cached_value("Account", account, "company") - if company != doc.company: - frappe.throw(_('Row {0}: Account {1} does not belong to Company {2}') - .format(tax.idx, frappe.bold(tax.account_head), frappe.bold(doc.company)), title=_('Invalid Account')) + if account_company != company: + frappe.throw( + _("Row {0}: {3} Account {1} does not belong to Company {2}").format( + idx, frappe.bold(account), frappe.bold(company), context + ), + title=_("Invalid Account"), + ) def validate_cost_center(tax, doc): if not tax.cost_center: return - company = frappe.get_cached_value('Cost Center', - tax.cost_center, 'company') + company = frappe.get_cached_value("Cost Center", tax.cost_center, "company") if company != doc.company: - frappe.throw(_('Row {0}: Cost Center {1} does not belong to Company {2}') - .format(tax.idx, frappe.bold(tax.cost_center), frappe.bold(doc.company)), title=_('Invalid Cost Center')) + frappe.throw( + _("Row {0}: Cost Center {1} does not belong to Company {2}").format( + tax.idx, frappe.bold(tax.cost_center), frappe.bold(doc.company) + ), + title=_("Invalid Cost Center"), + ) def validate_inclusive_tax(tax, doc): def _on_previous_row_error(row_range): - throw(_("To include tax in row {0} in Item rate, taxes in rows {1} must also be included").format(tax.idx, row_range)) + throw( + _("To include tax in row {0} in Item rate, taxes in rows {1} must also be included").format( + tax.idx, row_range + ) + ) if cint(getattr(tax, "included_in_print_rate", None)): if tax.charge_type == "Actual": # inclusive tax cannot be of type Actual - throw(_("Charge of type 'Actual' in row {0} cannot be included in Item Rate or Paid Amount").format(tax.idx)) - elif tax.charge_type == "On Previous Row Amount" and \ - not cint(doc.get("taxes")[cint(tax.row_id) - 1].included_in_print_rate): + throw( + _("Charge of type 'Actual' in row {0} cannot be included in Item Rate or Paid Amount").format( + tax.idx + ) + ) + elif tax.charge_type == "On Previous Row Amount" and not cint( + doc.get("taxes")[cint(tax.row_id) - 1].included_in_print_rate + ): # referred row should also be inclusive _on_previous_row_error(tax.row_id) - elif tax.charge_type == "On Previous Row Total" and \ - not all([cint(t.included_in_print_rate) for t in doc.get("taxes")[:cint(tax.row_id) - 1]]): + elif tax.charge_type == "On Previous Row Total" and not all( + [cint(t.included_in_print_rate) for t in doc.get("taxes")[: cint(tax.row_id) - 1]] + ): # all rows about the referred tax should be inclusive _on_previous_row_error("1 - %d" % (tax.row_id,)) elif tax.get("category") == "Valuation": frappe.throw(_("Valuation type charges can not be marked as Inclusive")) -def set_balance_in_account_currency(gl_dict, account_currency=None, conversion_rate=None, company_currency=None): +def set_balance_in_account_currency( + gl_dict, account_currency=None, conversion_rate=None, company_currency=None +): if (not conversion_rate) and (account_currency != company_currency): - frappe.throw(_("Account: {0} with currency: {1} can not be selected") - .format(gl_dict.account, account_currency)) + frappe.throw( + _("Account: {0} with currency: {1} can not be selected").format( + gl_dict.account, account_currency + ) + ) - gl_dict["account_currency"] = company_currency if account_currency == company_currency \ - else account_currency + gl_dict["account_currency"] = ( + company_currency if account_currency == company_currency else account_currency + ) # set debit/credit in account currency if not provided if flt(gl_dict.debit) and not flt(gl_dict.debit_in_account_currency): - gl_dict.debit_in_account_currency = gl_dict.debit if account_currency == company_currency \ + gl_dict.debit_in_account_currency = ( + gl_dict.debit + if account_currency == company_currency else flt(gl_dict.debit / conversion_rate, 2) + ) if flt(gl_dict.credit) and not flt(gl_dict.credit_in_account_currency): - gl_dict.credit_in_account_currency = gl_dict.credit if account_currency == company_currency \ + gl_dict.credit_in_account_currency = ( + gl_dict.credit + if account_currency == company_currency else flt(gl_dict.credit / conversion_rate, 2) + ) -def get_advance_journal_entries(party_type, party, party_account, amount_field, - order_doctype, order_list, include_unallocated=True): - dr_or_cr = "credit_in_account_currency" if party_type == "Customer" else "debit_in_account_currency" +def get_advance_journal_entries( + party_type, + party, + party_account, + amount_field, + order_doctype, + order_list, + include_unallocated=True, +): + dr_or_cr = ( + "credit_in_account_currency" if party_type == "Customer" else "debit_in_account_currency" + ) conditions = [] if include_unallocated: conditions.append("ifnull(t2.reference_name, '')=''") if order_list: - order_condition = ', '.join(['%s'] * len(order_list)) - conditions.append(" (t2.reference_type = '{0}' and ifnull(t2.reference_name, '') in ({1}))" \ - .format(order_doctype, order_condition)) + order_condition = ", ".join(["%s"] * len(order_list)) + conditions.append( + " (t2.reference_type = '{0}' and ifnull(t2.reference_name, '') in ({1}))".format( + order_doctype, order_condition + ) + ) reference_condition = " and (" + " or ".join(conditions) + ")" if conditions else "" - journal_entries = frappe.db.sql(""" + # nosemgrep + journal_entries = frappe.db.sql( + """ select "Journal Entry" as reference_type, t1.name as reference_name, t1.remark as remarks, t2.{0} as amount, t2.name as reference_row, - t2.reference_name as against_order + t2.reference_name as against_order, t2.exchange_rate from `tabJournal Entry` t1, `tabJournal Entry Account` t2 where @@ -1633,31 +2079,50 @@ def get_advance_journal_entries(party_type, party, party_account, amount_field, and t2.party_type = %s and t2.party = %s and t2.is_advance = 'Yes' and t1.docstatus = 1 and {1} > 0 {2} - order by t1.posting_date""".format(amount_field, dr_or_cr, reference_condition), - [party_account, party_type, party] + order_list, as_dict=1) + order by t1.posting_date""".format( + amount_field, dr_or_cr, reference_condition + ), + [party_account, party_type, party] + order_list, + as_dict=1, + ) return list(journal_entries) -def get_advance_payment_entries(party_type, party, party_account, order_doctype, - order_list=None, include_unallocated=True, against_all_orders=False, limit=None, condition=None): +def get_advance_payment_entries( + party_type, + party, + party_account, + order_doctype, + order_list=None, + include_unallocated=True, + against_all_orders=False, + limit=None, + condition=None, +): party_account_field = "paid_from" if party_type == "Customer" else "paid_to" - currency_field = "paid_from_account_currency" if party_type == "Customer" else "paid_to_account_currency" + currency_field = ( + "paid_from_account_currency" if party_type == "Customer" else "paid_to_account_currency" + ) payment_type = "Receive" if party_type == "Customer" else "Pay" - exchange_rate_field = "source_exchange_rate" if payment_type == "Receive" else "target_exchange_rate" + exchange_rate_field = ( + "source_exchange_rate" if payment_type == "Receive" else "target_exchange_rate" + ) payment_entries_against_order, unallocated_payment_entries = [], [] limit_cond = "limit %s" % limit if limit else "" if order_list or against_all_orders: if order_list: - reference_condition = " and t2.reference_name in ({0})" \ - .format(', '.join(['%s'] * len(order_list))) + reference_condition = " and t2.reference_name in ({0})".format( + ", ".join(["%s"] * len(order_list)) + ) else: reference_condition = "" order_list = [] - payment_entries_against_order = frappe.db.sql(""" + payment_entries_against_order = frappe.db.sql( + """ select "Payment Entry" as reference_type, t1.name as reference_name, t1.remarks, t2.allocated_amount as amount, t2.name as reference_row, @@ -1669,12 +2134,16 @@ def get_advance_payment_entries(party_type, party, party_account, order_doctype, and t1.party_type = %s and t1.party = %s and t1.docstatus = 1 and t2.reference_doctype = %s {2} order by t1.posting_date {3} - """.format(currency_field, party_account_field, reference_condition, limit_cond, exchange_rate_field), - [party_account, payment_type, party_type, party, - order_doctype] + order_list, as_dict=1) + """.format( + currency_field, party_account_field, reference_condition, limit_cond, exchange_rate_field + ), + [party_account, payment_type, party_type, party, order_doctype] + order_list, + as_dict=1, + ) if include_unallocated: - unallocated_payment_entries = frappe.db.sql(""" + unallocated_payment_entries = frappe.db.sql( + """ select "Payment Entry" as reference_type, name as reference_name, posting_date, remarks, unallocated_amount as amount, {2} as exchange_rate, {3} as currency from `tabPayment Entry` @@ -1682,68 +2151,76 @@ def get_advance_payment_entries(party_type, party, party_account, order_doctype, {0} = %s and party_type = %s and party = %s and payment_type = %s and docstatus = 1 and unallocated_amount > 0 {condition} order by posting_date {1} - """.format(party_account_field, limit_cond, exchange_rate_field, currency_field, condition=condition or ""), - (party_account, party_type, party, payment_type), as_dict=1) + """.format( + party_account_field, limit_cond, exchange_rate_field, currency_field, condition=condition or "" + ), + (party_account, party_type, party, payment_type), + as_dict=1, + ) return list(payment_entries_against_order) + list(unallocated_payment_entries) + def update_invoice_status(): """Updates status as Overdue for applicable invoices. Runs daily.""" today = getdate() - + payment_schedule = frappe.qb.DocType("Payment Schedule") for doctype in ("Sales Invoice", "Purchase Invoice"): - frappe.db.sql(""" - UPDATE `tab{doctype}` invoice SET invoice.status = 'Overdue' - WHERE invoice.docstatus = 1 - AND invoice.status REGEXP '^Unpaid|^Partly Paid' - AND invoice.outstanding_amount > 0 - AND ( - {or_condition} - ( - ( - CASE - WHEN invoice.party_account_currency = invoice.currency - THEN ( - CASE - WHEN invoice.disable_rounded_total - THEN invoice.grand_total - ELSE invoice.rounded_total - END - ) - ELSE ( - CASE - WHEN invoice.disable_rounded_total - THEN invoice.base_grand_total - ELSE invoice.base_rounded_total - END - ) - END - ) - invoice.outstanding_amount - ) < ( - SELECT SUM( - CASE - WHEN invoice.party_account_currency = invoice.currency - THEN ps.payment_amount - ELSE ps.base_payment_amount - END - ) - FROM `tabPayment Schedule` ps - WHERE ps.parent = invoice.name - AND ps.due_date < %(today)s - ) - ) - """.format( - doctype=doctype, - or_condition=( - "invoice.is_pos AND invoice.due_date < %(today)s OR" - if doctype == "Sales Invoice" - else "" - ) - ), {"today": today} + invoice = frappe.qb.DocType(doctype) + + consider_base_amount = invoice.party_account_currency != invoice.currency + payment_amount = ( + frappe.qb.terms.Case() + .when(consider_base_amount, payment_schedule.base_payment_amount) + .else_(payment_schedule.payment_amount) ) + payable_amount = ( + frappe.qb.from_(payment_schedule) + .select(Sum(payment_amount)) + .where((payment_schedule.parent == invoice.name) & (payment_schedule.due_date < today)) + ) + + total = ( + frappe.qb.terms.Case() + .when(invoice.disable_rounded_total, invoice.grand_total) + .else_(invoice.rounded_total) + ) + + base_total = ( + frappe.qb.terms.Case() + .when(invoice.disable_rounded_total, invoice.base_grand_total) + .else_(invoice.base_rounded_total) + ) + + total_amount = frappe.qb.terms.Case().when(consider_base_amount, base_total).else_(total) + + is_overdue = total_amount - invoice.outstanding_amount < payable_amount + + conditions = ( + (invoice.docstatus == 1) + & (invoice.outstanding_amount > 0) + & (invoice.status.like("Unpaid%") | invoice.status.like("Partly Paid%")) + & ( + ((invoice.is_pos & invoice.due_date < today) | is_overdue) + if doctype == "Sales Invoice" + else is_overdue + ) + ) + + status = ( + frappe.qb.terms.Case() + .when(invoice.status.like("%Discounted"), "Overdue and Discounted") + .else_("Overdue") + ) + + frappe.qb.update(invoice).set("status", status).where(conditions).run() + + @frappe.whitelist() -def get_payment_terms(terms_template, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None): +def get_payment_terms( + terms_template, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None +): if not terms_template: return @@ -1751,14 +2228,18 @@ def get_payment_terms(terms_template, posting_date=None, grand_total=None, base_ schedule = [] for d in terms_doc.get("terms"): - term_details = get_payment_term_details(d, posting_date, grand_total, base_grand_total, bill_date) + term_details = get_payment_term_details( + d, posting_date, grand_total, base_grand_total, bill_date + ) schedule.append(term_details) return schedule @frappe.whitelist() -def get_payment_term_details(term, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None): +def get_payment_term_details( + term, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None +): term_details = frappe._dict() if isinstance(term, text_type): term = frappe.get_doc("Payment Term", term) @@ -1785,6 +2266,7 @@ def get_payment_term_details(term, posting_date=None, grand_total=None, base_gra return term_details + def get_due_date(term, posting_date=None, bill_date=None): due_date = None date = bill_date or posting_date @@ -1796,6 +2278,7 @@ def get_due_date(term, posting_date=None, bill_date=None): due_date = add_months(get_last_day(date), term.credit_months) return due_date + def get_discount_date(term, posting_date=None, bill_date=None): discount_validity = None date = bill_date or posting_date @@ -1807,64 +2290,73 @@ def get_discount_date(term, posting_date=None, bill_date=None): discount_validity = add_months(get_last_day(date), term.discount_validity) return discount_validity + def get_supplier_block_status(party_name): """ Returns a dict containing the values of `on_hold`, `release_date` and `hold_type` of a `Supplier` """ - supplier = frappe.get_doc('Supplier', party_name) + supplier = frappe.get_doc("Supplier", party_name) info = { - 'on_hold': supplier.on_hold, - 'release_date': supplier.release_date, - 'hold_type': supplier.hold_type + "on_hold": supplier.on_hold, + "release_date": supplier.release_date, + "hold_type": supplier.hold_type, } return info + def set_child_tax_template_and_map(item, child_item, parent_doc): args = { - 'item_code': item.item_code, - 'posting_date': parent_doc.transaction_date, - 'tax_category': parent_doc.get('tax_category'), - 'company': parent_doc.get('company') - } + "item_code": item.item_code, + "posting_date": parent_doc.transaction_date, + "tax_category": parent_doc.get("tax_category"), + "company": parent_doc.get("company"), + } child_item.item_tax_template = _get_item_tax_template(args, item.taxes) if child_item.get("item_tax_template"): - child_item.item_tax_rate = get_item_tax_map(parent_doc.get('company'), child_item.item_tax_template, as_json=True) + child_item.item_tax_rate = get_item_tax_map( + parent_doc.get("company"), child_item.item_tax_template, as_json=True + ) + def add_taxes_from_tax_template(child_item, parent_doc, db_insert=True): - add_taxes_from_item_tax_template = frappe.db.get_single_value("Accounts Settings", "add_taxes_from_item_tax_template") + add_taxes_from_item_tax_template = frappe.db.get_single_value( + "Accounts Settings", "add_taxes_from_item_tax_template" + ) if child_item.get("item_tax_rate") and add_taxes_from_item_tax_template: tax_map = json.loads(child_item.get("item_tax_rate")) for tax_type in tax_map: tax_rate = flt(tax_map[tax_type]) - taxes = parent_doc.get('taxes') or [] + taxes = parent_doc.get("taxes") or [] # add new row for tax head only if missing found = any(tax.account_head == tax_type for tax in taxes) if not found: tax_row = parent_doc.append("taxes", {}) - tax_row.update({ - "description" : str(tax_type).split(' - ')[0], - "charge_type" : "On Net Total", - "account_head" : tax_type, - "rate" : tax_rate - }) + tax_row.update( + { + "description": str(tax_type).split(" - ")[0], + "charge_type": "On Net Total", + "account_head": tax_type, + "rate": tax_rate, + } + ) if parent_doc.doctype == "Purchase Order": - tax_row.update({ - "category" : "Total", - "add_deduct_tax" : "Add" - }) + tax_row.update({"category": "Total", "add_deduct_tax": "Add"}) if db_insert: tax_row.db_insert() -def set_order_defaults(parent_doctype, parent_doctype_name, child_doctype, child_docname, trans_item): + +def set_order_defaults( + parent_doctype, parent_doctype_name, child_doctype, child_docname, trans_item +): """ Returns a Sales/Purchase Order Item child item containing the default values """ p_doc = frappe.get_doc(parent_doctype, parent_doctype_name) child_item = frappe.new_doc(child_doctype, p_doc, child_docname) - item = frappe.get_doc("Item", trans_item.get('item_code')) + item = frappe.get_doc("Item", trans_item.get("item_code")) for field in ("item_code", "item_name", "description", "item_group"): child_item.update({field: item.get(field)}) @@ -1874,8 +2366,10 @@ def set_order_defaults(parent_doctype, parent_doctype_name, child_doctype, child child_item.stock_uom = item.stock_uom child_item.uom = trans_item.get("uom") or item.stock_uom child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True) - conversion_factor = flt(get_conversion_factor(item.item_code, child_item.uom).get("conversion_factor")) - child_item.conversion_factor = flt(trans_item.get('conversion_factor')) or conversion_factor + conversion_factor = flt( + get_conversion_factor(item.item_code, child_item.uom).get("conversion_factor") + ) + child_item.conversion_factor = flt(trans_item.get("conversion_factor")) or conversion_factor if child_doctype == "Purchase Order Item": # Initialized value will update in parent validation @@ -1884,28 +2378,53 @@ def set_order_defaults(parent_doctype, parent_doctype_name, child_doctype, child if child_doctype == "Sales Order Item": child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True) if not child_item.warehouse: - frappe.throw(_("Cannot find {} for item {}. Please set the same in Item Master or Stock Settings.") - .format(frappe.bold("default warehouse"), frappe.bold(item.item_code))) + frappe.throw( + _("Cannot find {} for item {}. Please set the same in Item Master or Stock Settings.").format( + frappe.bold("default warehouse"), frappe.bold(item.item_code) + ) + ) set_child_tax_template_and_map(item, child_item, p_doc) add_taxes_from_tax_template(child_item, p_doc) return child_item + def validate_child_on_delete(row, parent): """Check if partially transacted item (row) is being deleted.""" if parent.doctype == "Sales Order": if flt(row.delivered_qty): - frappe.throw(_("Row #{0}: Cannot delete item {1} which has already been delivered").format(row.idx, row.item_code)) + frappe.throw( + _("Row #{0}: Cannot delete item {1} which has already been delivered").format( + row.idx, row.item_code + ) + ) if flt(row.work_order_qty): - frappe.throw(_("Row #{0}: Cannot delete item {1} which has work order assigned to it.").format(row.idx, row.item_code)) + frappe.throw( + _("Row #{0}: Cannot delete item {1} which has work order assigned to it.").format( + row.idx, row.item_code + ) + ) if flt(row.ordered_qty): - frappe.throw(_("Row #{0}: Cannot delete item {1} which is assigned to customer's purchase order.").format(row.idx, row.item_code)) + frappe.throw( + _("Row #{0}: Cannot delete item {1} which is assigned to customer's purchase order.").format( + row.idx, row.item_code + ) + ) if parent.doctype == "Purchase Order" and flt(row.received_qty): - frappe.throw(_("Row #{0}: Cannot delete item {1} which has already been received").format(row.idx, row.item_code)) + frappe.throw( + _("Row #{0}: Cannot delete item {1} which has already been received").format( + row.idx, row.item_code + ) + ) if flt(row.billed_amt): - frappe.throw(_("Row #{0}: Cannot delete item {1} which has already been billed.").format(row.idx, row.item_code)) + frappe.throw( + _("Row #{0}: Cannot delete item {1} which has already been billed.").format( + row.idx, row.item_code + ) + ) + def update_bin_on_delete(row, doctype): """Update bin for deleted item (row).""" @@ -1915,6 +2434,7 @@ def update_bin_on_delete(row, doctype): get_reserved_qty, update_bin_qty, ) + qty_dict = {} if doctype == "Sales Order": @@ -1925,9 +2445,11 @@ def update_bin_on_delete(row, doctype): qty_dict["ordered_qty"] = get_ordered_qty(row.item_code, row.warehouse) - update_bin_qty(row.item_code, row.warehouse, qty_dict) + if row.warehouse: + update_bin_qty(row.item_code, row.warehouse, qty_dict) -def validate_and_delete_children(parent, data): + +def validate_and_delete_children(parent, data) -> bool: deleted_children = [] updated_item_names = [d.get("docname") for d in data] for item in parent.items: @@ -1946,17 +2468,23 @@ def validate_and_delete_children(parent, data): for d in deleted_children: update_bin_on_delete(d, parent.doctype) + return bool(deleted_children) + @frappe.whitelist() def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, child_docname="items"): - def check_doc_permissions(doc, perm_type='create'): + def check_doc_permissions(doc, perm_type="create"): try: doc.check_permission(perm_type) except frappe.PermissionError: - actions = { 'create': 'add', 'write': 'update'} + actions = {"create": "add", "write": "update"} - frappe.throw(_("You do not have permissions to {} items in a {}.") - .format(actions[perm_type], parent_doctype), title=_("Insufficient Permissions")) + frappe.throw( + _("You do not have permissions to {} items in a {}.").format( + actions[perm_type], parent_doctype + ), + title=_("Insufficient Permissions"), + ) def validate_workflow_conditions(doc): workflow = get_workflow_name(doc.doctype) @@ -1976,28 +2504,67 @@ def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, chil if not transitions: frappe.throw( - _("You are not allowed to update as per the conditions set in {} Workflow.").format(get_link_to_form("Workflow", workflow)), - title=_("Insufficient Permissions") + _("You are not allowed to update as per the conditions set in {} Workflow.").format( + get_link_to_form("Workflow", workflow) + ), + title=_("Insufficient Permissions"), ) def get_new_child_item(item_row): child_doctype = "Sales Order Item" if parent_doctype == "Sales Order" else "Purchase Order Item" - return set_order_defaults(parent_doctype, parent_doctype_name, child_doctype, child_docname, item_row) + return set_order_defaults( + parent_doctype, parent_doctype_name, child_doctype, child_docname, item_row + ) - def validate_quantity(child_item, d): - if parent_doctype == "Sales Order" and flt(d.get("qty")) < flt(child_item.delivered_qty): + def validate_quantity(child_item, new_data): + if not flt(new_data.get("qty")): + frappe.throw( + _("Row # {0}: Quantity for Item {1} cannot be zero").format( + new_data.get("idx"), frappe.bold(new_data.get("item_code")) + ), + title=_("Invalid Qty"), + ) + + if parent_doctype == "Sales Order" and flt(new_data.get("qty")) < flt(child_item.delivered_qty): frappe.throw(_("Cannot set quantity less than delivered quantity")) - if parent_doctype == "Purchase Order" and flt(d.get("qty")) < flt(child_item.received_qty): + if parent_doctype == "Purchase Order" and flt(new_data.get("qty")) < flt( + child_item.received_qty + ): frappe.throw(_("Cannot set quantity less than received quantity")) + def should_update_supplied_items(doc) -> bool: + """Subcontracted PO can allow following changes *after submit*: + + 1. Change rate of subcontracting - regardless of other changes. + 2. Change qty and/or add new items and/or remove items + Exception: Transfer/Consumption is already made, qty change not allowed. + """ + + supplied_items_processed = any( + item.supplied_qty or item.consumed_qty or item.returned_qty for item in doc.supplied_items + ) + + update_supplied_items = ( + any_qty_changed or items_added_or_removed or any_conversion_factor_changed + ) + if update_supplied_items and supplied_items_processed: + frappe.throw(_("Item qty can not be updated as raw materials are already processed.")) + + return update_supplied_items + data = json.loads(trans_items) - sales_doctypes = ['Sales Order', 'Sales Invoice', 'Delivery Note', 'Quotation'] + any_qty_changed = False # updated to true if any item's qty changes + items_added_or_removed = False # updated to true if any new item is added or removed + any_conversion_factor_changed = False + + sales_doctypes = ["Sales Order", "Sales Invoice", "Delivery Note", "Quotation"] parent = frappe.get_doc(parent_doctype, parent_doctype_name) - check_doc_permissions(parent, 'write') - validate_and_delete_children(parent, data) + check_doc_permissions(parent, "write") + _removed_items = validate_and_delete_children(parent, data) + items_added_or_removed |= _removed_items for d in data: new_child_flag = False @@ -2008,40 +2575,59 @@ def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, chil if not d.get("docname"): new_child_flag = True - check_doc_permissions(parent, 'create') + items_added_or_removed = True + check_doc_permissions(parent, "create") child_item = get_new_child_item(d) else: - check_doc_permissions(parent, 'write') - child_item = frappe.get_doc(parent_doctype + ' Item', d.get("docname")) + check_doc_permissions(parent, "write") + child_item = frappe.get_doc(parent_doctype + " Item", d.get("docname")) prev_rate, new_rate = flt(child_item.get("rate")), flt(d.get("rate")) prev_qty, new_qty = flt(child_item.get("qty")), flt(d.get("qty")) - prev_con_fac, new_con_fac = flt(child_item.get("conversion_factor")), flt(d.get("conversion_factor")) + prev_con_fac, new_con_fac = flt(child_item.get("conversion_factor")), flt( + d.get("conversion_factor") + ) prev_uom, new_uom = child_item.get("uom"), d.get("uom") - if parent_doctype == 'Sales Order': + if parent_doctype == "Sales Order": prev_date, new_date = child_item.get("delivery_date"), d.get("delivery_date") - elif parent_doctype == 'Purchase Order': + elif parent_doctype == "Purchase Order": prev_date, new_date = child_item.get("schedule_date"), d.get("schedule_date") rate_unchanged = prev_rate == new_rate qty_unchanged = prev_qty == new_qty uom_unchanged = prev_uom == new_uom conversion_factor_unchanged = prev_con_fac == new_con_fac - date_unchanged = prev_date == getdate(new_date) if prev_date and new_date else False # in case of delivery note etc - if rate_unchanged and qty_unchanged and conversion_factor_unchanged and uom_unchanged and date_unchanged: + any_conversion_factor_changed |= not conversion_factor_unchanged + date_unchanged = ( + prev_date == getdate(new_date) if prev_date and new_date else False + ) # in case of delivery note etc + if ( + rate_unchanged + and qty_unchanged + and conversion_factor_unchanged + and uom_unchanged + and date_unchanged + ): continue validate_quantity(child_item, d) + if flt(child_item.get("qty")) != flt(d.get("qty")): + any_qty_changed = True child_item.qty = flt(d.get("qty")) rate_precision = child_item.precision("rate") or 2 conv_fac_precision = child_item.precision("conversion_factor") or 2 qty_precision = child_item.precision("qty") or 2 - if flt(child_item.billed_amt, rate_precision) > flt(flt(d.get("rate"), rate_precision) * flt(d.get("qty"), qty_precision), rate_precision): - frappe.throw(_("Row #{0}: Cannot set Rate if amount is greater than billed amount for Item {1}.") - .format(child_item.idx, child_item.item_code)) + if flt(child_item.billed_amt, rate_precision) > flt( + flt(d.get("rate"), rate_precision) * flt(d.get("qty"), qty_precision), rate_precision + ): + frappe.throw( + _("Row #{0}: Cannot set Rate if amount is greater than billed amount for Item {1}.").format( + child_item.idx, child_item.item_code + ) + ) else: child_item.rate = flt(d.get("rate"), rate_precision) @@ -2049,18 +2635,22 @@ def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, chil if child_item.stock_uom == child_item.uom: child_item.conversion_factor = 1 else: - child_item.conversion_factor = flt(d.get('conversion_factor'), conv_fac_precision) + child_item.conversion_factor = flt(d.get("conversion_factor"), conv_fac_precision) if d.get("uom"): child_item.uom = d.get("uom") - conversion_factor = flt(get_conversion_factor(child_item.item_code, child_item.uom).get("conversion_factor")) - child_item.conversion_factor = flt(d.get('conversion_factor'), conv_fac_precision) or conversion_factor + conversion_factor = flt( + get_conversion_factor(child_item.item_code, child_item.uom).get("conversion_factor") + ) + child_item.conversion_factor = ( + flt(d.get("conversion_factor"), conv_fac_precision) or conversion_factor + ) - if d.get("delivery_date") and parent_doctype == 'Sales Order': - child_item.delivery_date = d.get('delivery_date') + if d.get("delivery_date") and parent_doctype == "Sales Order": + child_item.delivery_date = d.get("delivery_date") - if d.get("schedule_date") and parent_doctype == 'Purchase Order': - child_item.schedule_date = d.get('schedule_date') + if d.get("schedule_date") and parent_doctype == "Purchase Order": + child_item.schedule_date = d.get("schedule_date") if flt(child_item.price_list_rate): if flt(child_item.rate) > flt(child_item.price_list_rate): @@ -2070,14 +2660,16 @@ def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, chil if parent_doctype in sales_doctypes: child_item.margin_type = "Amount" - child_item.margin_rate_or_amount = flt(child_item.rate - child_item.price_list_rate, - child_item.precision("margin_rate_or_amount")) + child_item.margin_rate_or_amount = flt( + child_item.rate - child_item.price_list_rate, child_item.precision("margin_rate_or_amount") + ) child_item.rate_with_margin = child_item.rate else: - child_item.discount_percentage = flt((1 - flt(child_item.rate) / flt(child_item.price_list_rate)) * 100.0, - child_item.precision("discount_percentage")) - child_item.discount_amount = flt( - child_item.price_list_rate) - flt(child_item.rate) + child_item.discount_percentage = flt( + (1 - flt(child_item.rate) / flt(child_item.price_list_rate)) * 100.0, + child_item.precision("discount_percentage"), + ) + child_item.discount_amount = flt(child_item.price_list_rate) - flt(child_item.rate) if parent_doctype in sales_doctypes: child_item.margin_type = "" @@ -2100,34 +2692,42 @@ def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, chil if parent_doctype == "Sales Order": make_packing_list(parent) parent.set_gross_profit() - frappe.get_doc('Authorization Control').validate_approving_authority(parent.doctype, - parent.company, parent.base_grand_total) + frappe.get_doc("Authorization Control").validate_approving_authority( + parent.doctype, parent.company, parent.base_grand_total + ) parent.set_payment_schedule() - if parent_doctype == 'Purchase Order': + if parent_doctype == "Purchase Order": parent.validate_minimum_order_qty() parent.validate_budget() if parent.is_against_so(): parent.update_status_updater() else: parent.check_credit_limit() + + # reset index of child table + for idx, row in enumerate(parent.get(child_docname), start=1): + row.idx = idx + parent.save() - if parent_doctype == 'Purchase Order': - update_last_purchase_rate(parent, is_submit = 1) + if parent_doctype == "Purchase Order": + update_last_purchase_rate(parent, is_submit=1) parent.update_prevdoc_status() parent.update_requested_qty() parent.update_ordered_qty() parent.update_ordered_and_reserved_qty() parent.update_receiving_percentage() if parent.is_subcontracted == "Yes": - parent.update_reserved_qty_for_subcontract() - parent.create_raw_materials_supplied("supplied_items") + if should_update_supplied_items(parent): + parent.update_reserved_qty_for_subcontract() + parent.create_raw_materials_supplied("supplied_items") parent.save() - else: + else: # Sales Order + parent.validate_warehouse() parent.update_reserved_qty() parent.update_project() - parent.update_prevdoc_status('submit') + parent.update_prevdoc_status("submit") parent.update_delivery_status() parent.reload() @@ -2137,10 +2737,12 @@ def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, chil parent.update_billing_percentage() parent.set_status() + @erpnext.allow_regional def validate_regional(doc): pass + @erpnext.allow_regional def validate_einvoice_fields(doc): pass diff --git a/erpnext/controllers/buying_controller.py b/erpnext/controllers/buying_controller.py index a3d2502268e..ffd021773c9 100644 --- a/erpnext/controllers/buying_controller.py +++ b/erpnext/controllers/buying_controller.py @@ -20,12 +20,14 @@ from erpnext.stock.utils import get_incoming_rate class QtyMismatchError(ValidationError): pass + class BuyingController(StockController, Subcontracting): + def __setup__(self): + self.flags.ignore_permlevel_for_fields = ["buying_price_list", "price_list_currency"] def get_feed(self): if self.get("supplier_name"): - return _("From {0} | {1} {2}").format(self.supplier_name, self.currency, - self.grand_total) + return _("From {0} | {1} {2}").format(self.supplier_name, self.currency, self.grand_total) def validate(self): super(BuyingController, self).validate() @@ -40,16 +42,18 @@ class BuyingController(StockController, Subcontracting): self.set_supplier_address() self.validate_asset_return() - if self.doctype=="Purchase Invoice": + if self.doctype == "Purchase Invoice": self.validate_purchase_receipt_if_update_stock() - if self.doctype=="Purchase Receipt" or (self.doctype=="Purchase Invoice" and self.update_stock): + if self.doctype == "Purchase Receipt" or ( + self.doctype == "Purchase Invoice" and self.update_stock + ): # self.validate_purchase_return() self.validate_rejected_warehouse() self.validate_accepted_rejected_qty() validate_for_items(self) - #sub-contracting + # sub-contracting self.validate_for_subcontracting() self.create_raw_materials_supplied("supplied_items") self.set_landed_cost_voucher_amount() @@ -59,8 +63,12 @@ class BuyingController(StockController, Subcontracting): def onload(self): super(BuyingController, self).onload() - self.set_onload("backflush_based_on", frappe.db.get_single_value('Buying Settings', - 'backflush_raw_materials_of_subcontract_based_on')) + self.set_onload( + "backflush_based_on", + frappe.db.get_single_value( + "Buying Settings", "backflush_raw_materials_of_subcontract_based_on" + ), + ) def set_missing_values(self, for_validate=False): super(BuyingController, self).set_missing_values(for_validate) @@ -70,23 +78,35 @@ class BuyingController(StockController, Subcontracting): # set contact and address details for supplier, if they are not mentioned if getattr(self, "supplier", None): - self.update_if_missing(get_party_details(self.supplier, party_type="Supplier", ignore_permissions=self.flags.ignore_permissions, - doctype=self.doctype, company=self.company, party_address=self.supplier_address, shipping_address=self.get('shipping_address'), - fetch_payment_terms_template= not self.get('ignore_default_payment_terms_template'))) + self.update_if_missing( + get_party_details( + self.supplier, + party_type="Supplier", + doctype=self.doctype, + company=self.company, + party_address=self.get("supplier_address"), + shipping_address=self.get("shipping_address"), + company_address=self.get("billing_address"), + fetch_payment_terms_template=not self.get("ignore_default_payment_terms_template"), + ignore_permissions=self.flags.ignore_permissions, + ) + ) self.set_missing_item_details(for_validate) def set_supplier_from_item_default(self): if self.meta.get_field("supplier") and not self.supplier: for d in self.get("items"): - supplier = frappe.db.get_value("Item Default", - {"parent": d.item_code, "company": self.company}, "default_supplier") + supplier = frappe.db.get_value( + "Item Default", {"parent": d.item_code, "company": self.company}, "default_supplier" + ) if supplier: self.supplier = supplier else: item_group = frappe.db.get_value("Item", d.item_code, "item_group") - supplier = frappe.db.get_value("Item Default", - {"parent": item_group, "company": self.company}, "default_supplier") + supplier = frappe.db.get_value( + "Item Default", {"parent": item_group, "company": self.company}, "default_supplier" + ) if supplier: self.supplier = supplier break @@ -97,55 +117,71 @@ class BuyingController(StockController, Subcontracting): self.update_tax_category(msg) def update_tax_category(self, msg): - tax_for_valuation = [d for d in self.get("taxes") - if d.category in ["Valuation", "Valuation and Total"]] + tax_for_valuation = [ + d for d in self.get("taxes") if d.category in ["Valuation", "Valuation and Total"] + ] if tax_for_valuation: for d in tax_for_valuation: - d.category = 'Total' + d.category = "Total" msgprint(msg) def validate_asset_return(self): - if self.doctype not in ['Purchase Receipt', 'Purchase Invoice'] or not self.is_return: + if self.doctype not in ["Purchase Receipt", "Purchase Invoice"] or not self.is_return: return - purchase_doc_field = 'purchase_receipt' if self.doctype == 'Purchase Receipt' else 'purchase_invoice' - not_cancelled_asset = [d.name for d in frappe.db.get_all("Asset", { - purchase_doc_field: self.return_against, - "docstatus": 1 - })] + purchase_doc_field = ( + "purchase_receipt" if self.doctype == "Purchase Receipt" else "purchase_invoice" + ) + not_cancelled_asset = [ + d.name + for d in frappe.db.get_all("Asset", {purchase_doc_field: self.return_against, "docstatus": 1}) + ] if self.is_return and len(not_cancelled_asset): - frappe.throw(_("{} has submitted assets linked to it. You need to cancel the assets to create purchase return.") - .format(self.return_against), title=_("Not Allowed")) + frappe.throw( + _( + "{} has submitted assets linked to it. You need to cancel the assets to create purchase return." + ).format(self.return_against), + title=_("Not Allowed"), + ) def get_asset_items(self): - if self.doctype not in ['Purchase Order', 'Purchase Invoice', 'Purchase Receipt']: + if self.doctype not in ["Purchase Order", "Purchase Invoice", "Purchase Receipt"]: return [] return [d.item_code for d in self.items if d.is_fixed_asset] def set_landed_cost_voucher_amount(self): for d in self.get("items"): - lc_voucher_data = frappe.db.sql("""select sum(applicable_charges), cost_center + lc_voucher_data = frappe.db.sql( + """select sum(applicable_charges), cost_center from `tabLanded Cost Item` - where docstatus = 1 and purchase_receipt_item = %s""", d.name) + where docstatus = 1 and purchase_receipt_item = %s""", + d.name, + ) d.landed_cost_voucher_amount = lc_voucher_data[0][0] if lc_voucher_data else 0.0 if not d.cost_center and lc_voucher_data and lc_voucher_data[0][1]: - d.db_set('cost_center', lc_voucher_data[0][1]) + d.db_set("cost_center", lc_voucher_data[0][1]) def validate_from_warehouse(self): - for item in self.get('items'): - if item.get('from_warehouse') and (item.get('from_warehouse') == item.get('warehouse')): - frappe.throw(_("Row #{0}: Accepted Warehouse and Supplier Warehouse cannot be same").format(item.idx)) + for item in self.get("items"): + if item.get("from_warehouse") and (item.get("from_warehouse") == item.get("warehouse")): + frappe.throw( + _("Row #{0}: Accepted Warehouse and Supplier Warehouse cannot be same").format(item.idx) + ) - if item.get('from_warehouse') and self.get('is_subcontracted') == 'Yes': - frappe.throw(_("Row #{0}: Cannot select Supplier Warehouse while suppling raw materials to subcontractor").format(item.idx)) + if item.get("from_warehouse") and self.get("is_subcontracted") == "Yes": + frappe.throw( + _( + "Row #{0}: Cannot select Supplier Warehouse while suppling raw materials to subcontractor" + ).format(item.idx) + ) def set_supplier_address(self): address_dict = { - 'supplier_address': 'address_display', - 'shipping_address': 'shipping_address_display' + "supplier_address": "address_display", + "shipping_address": "shipping_address_display", } for address_field, address_display_field in address_dict.items(): @@ -154,28 +190,29 @@ class BuyingController(StockController, Subcontracting): def set_total_in_words(self): from frappe.utils import money_in_words + if self.meta.get_field("base_in_words"): if self.meta.get_field("base_rounded_total") and not self.is_rounded_total_disabled(): - amount = self.base_rounded_total + amount = abs(self.base_rounded_total) else: - amount = self.base_grand_total + amount = abs(self.base_grand_total) self.base_in_words = money_in_words(amount, self.company_currency) if self.meta.get_field("in_words"): if self.meta.get_field("rounded_total") and not self.is_rounded_total_disabled(): - amount = self.rounded_total + amount = abs(self.rounded_total) else: - amount = self.grand_total + amount = abs(self.grand_total) self.in_words = money_in_words(amount, self.currency) # update valuation rate def update_valuation_rate(self, reset_outgoing_rate=True): """ - item_tax_amount is the total tax amount applied on that item - stored for valuation + item_tax_amount is the total tax amount applied on that item + stored for valuation - TODO: rename item_tax_amount to valuation_tax_amount + TODO: rename item_tax_amount to valuation_tax_amount """ stock_and_asset_items = [] stock_and_asset_items = self.get_stock_items() + self.get_asset_items() @@ -183,36 +220,50 @@ class BuyingController(StockController, Subcontracting): stock_and_asset_items_qty, stock_and_asset_items_amount = 0, 0 last_item_idx = 1 for d in self.get("items"): - if (d.item_code and d.item_code in stock_and_asset_items): + if d.item_code and d.item_code in stock_and_asset_items: stock_and_asset_items_qty += flt(d.qty) stock_and_asset_items_amount += flt(d.base_net_amount) last_item_idx = d.idx - total_valuation_amount = sum(flt(d.base_tax_amount_after_discount_amount) for d in self.get("taxes") - if d.category in ["Valuation", "Valuation and Total"]) + total_valuation_amount = sum( + flt(d.base_tax_amount_after_discount_amount) + for d in self.get("taxes") + if d.category in ["Valuation", "Valuation and Total"] + ) valuation_amount_adjustment = total_valuation_amount for i, item in enumerate(self.get("items")): if item.item_code and item.qty and item.item_code in stock_and_asset_items: - item_proportion = flt(item.base_net_amount) / stock_and_asset_items_amount if stock_and_asset_items_amount \ + item_proportion = ( + flt(item.base_net_amount) / stock_and_asset_items_amount + if stock_and_asset_items_amount else flt(item.qty) / stock_and_asset_items_qty + ) if i == (last_item_idx - 1): - item.item_tax_amount = flt(valuation_amount_adjustment, - self.precision("item_tax_amount", item)) + item.item_tax_amount = flt( + valuation_amount_adjustment, self.precision("item_tax_amount", item) + ) else: - item.item_tax_amount = flt(item_proportion * total_valuation_amount, - self.precision("item_tax_amount", item)) + item.item_tax_amount = flt( + item_proportion * total_valuation_amount, self.precision("item_tax_amount", item) + ) valuation_amount_adjustment -= item.item_tax_amount self.round_floats_in(item) - if flt(item.conversion_factor)==0.0: - item.conversion_factor = get_conversion_factor(item.item_code, item.uom).get("conversion_factor") or 1.0 + if flt(item.conversion_factor) == 0.0: + item.conversion_factor = ( + get_conversion_factor(item.item_code, item.uom).get("conversion_factor") or 1.0 + ) qty_in_stock_uom = flt(item.qty * item.conversion_factor) item.rm_supp_cost = self.get_supplied_items_cost(item.name, reset_outgoing_rate) - item.valuation_rate = ((item.base_net_amount + item.item_tax_amount + item.rm_supp_cost - + flt(item.landed_cost_voucher_amount)) / qty_in_stock_uom) + item.valuation_rate = ( + item.base_net_amount + + item.item_tax_amount + + item.rm_supp_cost + + flt(item.landed_cost_voucher_amount) + ) / qty_in_stock_uom else: item.valuation_rate = 0.0 @@ -233,44 +284,59 @@ class BuyingController(StockController, Subcontracting): # Get outgoing rate based on original item cost based on valuation method if not d.get(frappe.scrub(ref_doctype)): - outgoing_rate = get_incoming_rate({ - "item_code": d.item_code, - "warehouse": d.get('from_warehouse'), - "posting_date": self.get('posting_date') or self.get('transation_date'), - "posting_time": self.get('posting_time'), - "qty": -1 * flt(d.get('stock_qty')), - "serial_no": d.get('serial_no'), - "company": self.company, - "voucher_type": self.doctype, - "voucher_no": self.name, - "allow_zero_valuation": d.get("allow_zero_valuation") - }, raise_error_if_no_rate=False) + outgoing_rate = get_incoming_rate( + { + "item_code": d.item_code, + "warehouse": d.get("from_warehouse"), + "posting_date": self.get("posting_date") or self.get("transation_date"), + "posting_time": self.get("posting_time"), + "qty": -1 * flt(d.get("stock_qty")), + "serial_no": d.get("serial_no"), + "company": self.company, + "voucher_type": self.doctype, + "voucher_no": self.name, + "allow_zero_valuation": d.get("allow_zero_valuation"), + }, + raise_error_if_no_rate=False, + ) - rate = flt(outgoing_rate * d.conversion_factor, d.precision('rate')) + rate = flt(outgoing_rate * (d.conversion_factor or 1), d.precision("rate")) else: - rate = frappe.db.get_value(ref_doctype, d.get(frappe.scrub(ref_doctype)), 'rate') + field = "incoming_rate" if self.get("is_internal_supplier") else "rate" + rate = flt( + frappe.db.get_value(ref_doctype, d.get(frappe.scrub(ref_doctype)), field) + * (d.conversion_factor or 1), + d.precision("rate"), + ) if self.is_internal_transfer(): if rate != d.rate: d.rate = rate - d.discount_percentage = 0 - d.discount_amount = 0 - frappe.msgprint(_("Row {0}: Item rate has been updated as per valuation rate since its an internal stock transfer") - .format(d.idx), alert=1) + frappe.msgprint( + _( + "Row {0}: Item rate has been updated as per valuation rate since its an internal stock transfer" + ).format(d.idx), + alert=1, + ) + d.discount_percentage = 0.0 + d.discount_amount = 0.0 + d.margin_rate_or_amount = 0.0 def get_supplied_items_cost(self, item_row_id, reset_outgoing_rate=True): supplied_items_cost = 0.0 for d in self.get("supplied_items"): if d.reference_name == item_row_id: - if reset_outgoing_rate and frappe.get_cached_value('Item', d.rm_item_code, 'is_stock_item'): - rate = get_incoming_rate({ - "item_code": d.rm_item_code, - "warehouse": self.supplier_warehouse, - "posting_date": self.posting_date, - "posting_time": self.posting_time, - "qty": -1 * d.consumed_qty, - "serial_no": d.serial_no - }) + if reset_outgoing_rate and frappe.get_cached_value("Item", d.rm_item_code, "is_stock_item"): + rate = get_incoming_rate( + { + "item_code": d.rm_item_code, + "warehouse": self.supplier_warehouse, + "posting_date": self.posting_date, + "posting_time": self.posting_time, + "qty": -1 * d.consumed_qty, + "serial_no": d.serial_no, + } + ) if rate > 0: d.rate = rate @@ -305,7 +371,7 @@ class BuyingController(StockController, Subcontracting): item.bom = None def create_raw_materials_supplied(self, raw_material_table): - if self.is_subcontracted=="Yes": + if self.is_subcontracted == "Yes": self.set_materials_for_subcontracted_items(raw_material_table) elif self.doctype in ["Purchase Receipt", "Purchase Invoice"]: @@ -313,19 +379,17 @@ class BuyingController(StockController, Subcontracting): item.rm_supp_cost = 0.0 if self.is_subcontracted == "No" and self.get("supplied_items"): - self.set('supplied_items', []) + self.set("supplied_items", []) @property def sub_contracted_items(self): if not hasattr(self, "_sub_contracted_items"): self._sub_contracted_items = [] - item_codes = list(set(item.item_code for item in - self.get("items"))) + item_codes = list(set(item.item_code for item in self.get("items"))) if item_codes: - items = frappe.get_all('Item', filters={ - 'name': ['in', item_codes], - 'is_sub_contracted_item': 1 - }) + items = frappe.get_all( + "Item", filters={"name": ["in", item_codes], "is_sub_contracted_item": 1} + ) self._sub_contracted_items = [item.name for item in items] return self._sub_contracted_items @@ -339,9 +403,11 @@ class BuyingController(StockController, Subcontracting): frappe.throw(_("Row {0}: Conversion Factor is mandatory").format(d.idx)) d.stock_qty = flt(d.qty) * flt(d.conversion_factor) - if self.doctype=="Purchase Receipt" and d.meta.get_field("received_stock_qty"): + if self.doctype == "Purchase Receipt" and d.meta.get_field("received_stock_qty"): # Set Received Qty in Stock UOM - d.received_stock_qty = flt(d.received_qty) * flt(d.conversion_factor, d.precision("conversion_factor")) + d.received_stock_qty = flt(d.received_qty) * flt( + d.conversion_factor, d.precision("conversion_factor") + ) def validate_purchase_return(self): for d in self.get("items"): @@ -357,20 +423,26 @@ class BuyingController(StockController, Subcontracting): d.rejected_warehouse = self.rejected_warehouse if not d.rejected_warehouse: - frappe.throw(_("Row #{0}: Rejected Warehouse is mandatory against rejected Item {1}").format(d.idx, d.item_code)) + frappe.throw( + _("Row #{0}: Rejected Warehouse is mandatory against rejected Item {1}").format( + d.idx, d.item_code + ) + ) # validate accepted and rejected qty def validate_accepted_rejected_qty(self): for d in self.get("items"): - self.validate_negative_quantity(d, ["received_qty","qty", "rejected_qty"]) + self.validate_negative_quantity(d, ["received_qty", "qty", "rejected_qty"]) if not flt(d.received_qty) and (flt(d.qty) or flt(d.rejected_qty)): d.received_qty = flt(d.qty) + flt(d.rejected_qty) # Check Received Qty = Accepted Qty + Rejected Qty val = flt(d.qty) + flt(d.rejected_qty) - if (flt(val, d.precision("received_qty")) != flt(d.received_qty, d.precision("received_qty"))): - message = _("Row #{0}: Received Qty must be equal to Accepted + Rejected Qty for Item {1}").format(d.idx, d.item_code) + if flt(val, d.precision("received_qty")) != flt(d.received_qty, d.precision("received_qty")): + message = _( + "Row #{0}: Received Qty must be equal to Accepted + Rejected Qty for Item {1}" + ).format(d.idx, d.item_code) frappe.throw(msg=message, title=_("Mismatch"), exc=QtyMismatchError) def validate_negative_quantity(self, item_row, field_list): @@ -380,15 +452,20 @@ class BuyingController(StockController, Subcontracting): item_row = item_row.as_dict() for fieldname in field_list: if flt(item_row[fieldname]) < 0: - frappe.throw(_("Row #{0}: {1} can not be negative for item {2}").format(item_row['idx'], - frappe.get_meta(item_row.doctype).get_label(fieldname), item_row['item_code'])) + frappe.throw( + _("Row #{0}: {1} can not be negative for item {2}").format( + item_row["idx"], + frappe.get_meta(item_row.doctype).get_label(fieldname), + item_row["item_code"], + ) + ) def check_for_on_hold_or_closed_status(self, ref_doctype, ref_fieldname): for d in self.get("items"): if d.get(ref_fieldname): status = frappe.db.get_value(ref_doctype, d.get(ref_fieldname), "status") if status in ("Closed", "On Hold"): - frappe.throw(_("{0} {1} is {2}").format(ref_doctype,d.get(ref_fieldname), status)) + frappe.throw(_("{0} {1} is {2}").format(ref_doctype, d.get(ref_fieldname), status)) def update_stock_ledger(self, allow_negative_stock=False, via_landed_cost_voucher=False): self.update_ordered_and_reserved_qty() @@ -396,76 +473,92 @@ class BuyingController(StockController, Subcontracting): sl_entries = [] stock_items = self.get_stock_items() - for d in self.get('items'): - if d.item_code in stock_items and d.warehouse: + for d in self.get("items"): + if d.item_code not in stock_items: + continue + + if d.warehouse: pr_qty = flt(d.qty) * flt(d.conversion_factor) if pr_qty: - if d.from_warehouse and ((not cint(self.is_return) and self.docstatus==1) - or (cint(self.is_return) and self.docstatus==2)): - from_warehouse_sle = self.get_sl_entries(d, { - "actual_qty": -1 * pr_qty, - "warehouse": d.from_warehouse, - "outgoing_rate": d.rate, - "recalculate_rate": 1, - "dependant_sle_voucher_detail_no": d.name - }) + if d.from_warehouse and ( + (not cint(self.is_return) and self.docstatus == 1) + or (cint(self.is_return) and self.docstatus == 2) + ): + from_warehouse_sle = self.get_sl_entries( + d, + { + "actual_qty": -1 * pr_qty, + "warehouse": d.from_warehouse, + "outgoing_rate": d.rate, + "recalculate_rate": 1, + "dependant_sle_voucher_detail_no": d.name, + }, + ) sl_entries.append(from_warehouse_sle) - sle = self.get_sl_entries(d, { - "actual_qty": flt(pr_qty), - "serial_no": cstr(d.serial_no).strip() - }) - if self.is_return: - outgoing_rate = get_rate_for_return(self.doctype, self.name, d.item_code, self.return_against, item_row=d) + sle = self.get_sl_entries( + d, {"actual_qty": flt(pr_qty), "serial_no": cstr(d.serial_no).strip()} + ) - sle.update({ - "outgoing_rate": outgoing_rate, - "recalculate_rate": 1 - }) + if self.is_return: + outgoing_rate = get_rate_for_return( + self.doctype, self.name, d.item_code, self.return_against, item_row=d + ) + + sle.update({"outgoing_rate": outgoing_rate, "recalculate_rate": 1}) if d.from_warehouse: sle.dependant_sle_voucher_detail_no = d.name else: val_rate_db_precision = 6 if cint(self.precision("valuation_rate", d)) <= 6 else 9 incoming_rate = flt(d.valuation_rate, val_rate_db_precision) - sle.update({ - "incoming_rate": incoming_rate, - "recalculate_rate": 1 if (self.is_subcontracted and d.bom) or d.from_warehouse else 0 - }) + sle.update( + { + "incoming_rate": incoming_rate, + "recalculate_rate": 1 if (self.is_subcontracted and d.bom) or d.from_warehouse else 0, + } + ) sl_entries.append(sle) - if d.from_warehouse and ((not cint(self.is_return) and self.docstatus==2) - or (cint(self.is_return) and self.docstatus==1)): - from_warehouse_sle = self.get_sl_entries(d, { - "actual_qty": -1 * pr_qty, - "warehouse": d.from_warehouse, - "recalculate_rate": 1 - }) + if d.from_warehouse and ( + (not cint(self.is_return) and self.docstatus == 2) + or (cint(self.is_return) and self.docstatus == 1) + ): + from_warehouse_sle = self.get_sl_entries( + d, {"actual_qty": -1 * pr_qty, "warehouse": d.from_warehouse, "recalculate_rate": 1} + ) sl_entries.append(from_warehouse_sle) - if flt(d.rejected_qty) != 0: - sl_entries.append(self.get_sl_entries(d, { - "warehouse": d.rejected_warehouse, - "actual_qty": flt(d.rejected_qty) * flt(d.conversion_factor), - "serial_no": cstr(d.rejected_serial_no).strip(), - "incoming_rate": 0.0 - })) + if flt(d.rejected_qty) != 0: + sl_entries.append( + self.get_sl_entries( + d, + { + "warehouse": d.rejected_warehouse, + "actual_qty": flt(d.rejected_qty) * flt(d.conversion_factor), + "serial_no": cstr(d.rejected_serial_no).strip(), + "incoming_rate": 0.0, + }, + ) + ) self.make_sl_entries_for_supplier_warehouse(sl_entries) - self.make_sl_entries(sl_entries, allow_negative_stock=allow_negative_stock, - via_landed_cost_voucher=via_landed_cost_voucher) + self.make_sl_entries( + sl_entries, + allow_negative_stock=allow_negative_stock, + via_landed_cost_voucher=via_landed_cost_voucher, + ) def update_ordered_and_reserved_qty(self): po_map = {} for d in self.get("items"): - if self.doctype=="Purchase Receipt" \ - and d.purchase_order: - po_map.setdefault(d.purchase_order, []).append(d.purchase_order_item) + if self.doctype == "Purchase Receipt" and d.purchase_order: + po_map.setdefault(d.purchase_order, []).append(d.purchase_order_item) - elif self.doctype=="Purchase Invoice" and d.purchase_order and d.po_detail: + elif self.doctype == "Purchase Invoice" and d.purchase_order and d.po_detail: po_map.setdefault(d.purchase_order, []).append(d.po_detail) for po, po_item_rows in po_map.items(): @@ -473,68 +566,78 @@ class BuyingController(StockController, Subcontracting): po_obj = frappe.get_doc("Purchase Order", po) if po_obj.status in ["Closed", "Cancelled"]: - frappe.throw(_("{0} {1} is cancelled or closed").format(_("Purchase Order"), po), - frappe.InvalidStatusError) + frappe.throw( + _("{0} {1} is cancelled or closed").format(_("Purchase Order"), po), + frappe.InvalidStatusError, + ) po_obj.update_ordered_qty(po_item_rows) if self.is_subcontracted: po_obj.update_reserved_qty_for_subcontract() def make_sl_entries_for_supplier_warehouse(self, sl_entries): - if hasattr(self, 'supplied_items'): - for d in self.get('supplied_items'): + if hasattr(self, "supplied_items"): + for d in self.get("supplied_items"): # negative quantity is passed, as raw material qty has to be decreased # when PR is submitted and it has to be increased when PR is cancelled - sl_entries.append(self.get_sl_entries(d, { - "item_code": d.rm_item_code, - "warehouse": self.supplier_warehouse, - "actual_qty": -1*flt(d.consumed_qty), - "dependant_sle_voucher_detail_no": d.reference_name - })) + sl_entries.append( + self.get_sl_entries( + d, + { + "item_code": d.rm_item_code, + "warehouse": self.supplier_warehouse, + "actual_qty": -1 * flt(d.consumed_qty), + "dependant_sle_voucher_detail_no": d.reference_name, + }, + ) + ) def on_submit(self): - if self.get('is_return'): + if self.get("is_return"): return - if self.doctype in ['Purchase Receipt', 'Purchase Invoice']: - field = 'purchase_invoice' if self.doctype == 'Purchase Invoice' else 'purchase_receipt' + if self.doctype in ["Purchase Receipt", "Purchase Invoice"]: + field = "purchase_invoice" if self.doctype == "Purchase Invoice" else "purchase_receipt" self.process_fixed_asset() self.update_fixed_asset(field) - if self.doctype in ['Purchase Order', 'Purchase Receipt']: - update_last_purchase_rate(self, is_submit = 1) + if self.doctype in ["Purchase Order", "Purchase Receipt"]: + update_last_purchase_rate(self, is_submit=1) def on_cancel(self): super(BuyingController, self).on_cancel() - if self.get('is_return'): + if self.get("is_return"): return - if self.doctype in ['Purchase Order', 'Purchase Receipt']: - update_last_purchase_rate(self, is_submit = 0) + if self.doctype in ["Purchase Order", "Purchase Receipt"]: + update_last_purchase_rate(self, is_submit=0) - if self.doctype in ['Purchase Receipt', 'Purchase Invoice']: - field = 'purchase_invoice' if self.doctype == 'Purchase Invoice' else 'purchase_receipt' + if self.doctype in ["Purchase Receipt", "Purchase Invoice"]: + field = "purchase_invoice" if self.doctype == "Purchase Invoice" else "purchase_receipt" self.delete_linked_asset() self.update_fixed_asset(field, delete_asset=True) def validate_budget(self): if self.docstatus == 1: - for data in self.get('items'): + for data in self.get("items"): args = data.as_dict() - args.update({ - 'doctype': self.doctype, - 'company': self.company, - 'posting_date': (self.schedule_date - if self.doctype == 'Material Request' else self.transaction_date) - }) + args.update( + { + "doctype": self.doctype, + "company": self.company, + "posting_date": ( + self.schedule_date if self.doctype == "Material Request" else self.transaction_date + ), + } + ) validate_expense_against_budget(args) def process_fixed_asset(self): - if self.doctype == 'Purchase Invoice' and not self.update_stock: + if self.doctype == "Purchase Invoice" and not self.update_stock: return asset_items = self.get_asset_items() @@ -549,10 +652,10 @@ class BuyingController(StockController, Subcontracting): if d.is_fixed_asset: item_data = items_data.get(d.item_code) - if item_data.get('auto_create_assets'): + if item_data.get("auto_create_assets"): # If asset has to be auto created # Check for asset naming series - if item_data.get('asset_naming_series'): + if item_data.get("asset_naming_series"): created_assets = [] for qty in range(cint(d.qty)): @@ -561,21 +664,31 @@ class BuyingController(StockController, Subcontracting): if len(created_assets) > 5: # dont show asset form links if more than 5 assets are created - messages.append(_('{} Assets created for {}').format(len(created_assets), frappe.bold(d.item_code))) - else: - assets_link = list(map(lambda d: frappe.utils.get_link_to_form('Asset', d), created_assets)) - assets_link = frappe.bold(','.join(assets_link)) - - is_plural = 's' if len(created_assets) != 1 else '' messages.append( - _('Asset{} {assets_link} created for {}').format(is_plural, frappe.bold(d.item_code), assets_link=assets_link) + _("{} Assets created for {}").format(len(created_assets), frappe.bold(d.item_code)) + ) + else: + assets_link = list(map(lambda d: frappe.utils.get_link_to_form("Asset", d), created_assets)) + assets_link = frappe.bold(",".join(assets_link)) + + is_plural = "s" if len(created_assets) != 1 else "" + messages.append( + _("Asset{} {assets_link} created for {}").format( + is_plural, frappe.bold(d.item_code), assets_link=assets_link + ) ) else: - frappe.throw(_("Row {}: Asset Naming Series is mandatory for the auto creation for item {}") - .format(d.idx, frappe.bold(d.item_code))) + frappe.throw( + _("Row {}: Asset Naming Series is mandatory for the auto creation for item {}").format( + d.idx, frappe.bold(d.item_code) + ) + ) else: - messages.append(_("Assets not created for {0}. You will have to create asset manually.") - .format(frappe.bold(d.item_code))) + messages.append( + _("Assets not created for {0}. You will have to create asset manually.").format( + frappe.bold(d.item_code) + ) + ) for message in messages: frappe.msgprint(message, title="Success", indicator="green") @@ -584,26 +697,29 @@ class BuyingController(StockController, Subcontracting): if not row.asset_location: frappe.throw(_("Row {0}: Enter location for the asset item {1}").format(row.idx, row.item_code)) - item_data = frappe.db.get_value('Item', - row.item_code, ['asset_naming_series', 'asset_category'], as_dict=1) + item_data = frappe.db.get_value( + "Item", row.item_code, ["asset_naming_series", "asset_category"], as_dict=1 + ) purchase_amount = flt(row.base_rate + row.item_tax_amount) - asset = frappe.get_doc({ - 'doctype': 'Asset', - 'item_code': row.item_code, - 'asset_name': row.item_name, - 'naming_series': item_data.get('asset_naming_series') or 'AST', - 'asset_category': item_data.get('asset_category'), - 'location': row.asset_location, - 'company': self.company, - 'supplier': self.supplier, - 'purchase_date': self.posting_date, - 'calculate_depreciation': 1, - 'purchase_receipt_amount': purchase_amount, - 'gross_purchase_amount': purchase_amount, - 'purchase_receipt': self.name if self.doctype == 'Purchase Receipt' else None, - 'purchase_invoice': self.name if self.doctype == 'Purchase Invoice' else None - }) + asset = frappe.get_doc( + { + "doctype": "Asset", + "item_code": row.item_code, + "asset_name": row.item_name, + "naming_series": item_data.get("asset_naming_series") or "AST", + "asset_category": item_data.get("asset_category"), + "location": row.asset_location, + "company": self.company, + "supplier": self.supplier, + "purchase_date": self.posting_date, + "calculate_depreciation": 1, + "purchase_receipt_amount": purchase_amount, + "gross_purchase_amount": purchase_amount, + "purchase_receipt": self.name if self.doctype == "Purchase Receipt" else None, + "purchase_invoice": self.name if self.doctype == "Purchase Invoice" else None, + } + ) asset.flags.ignore_validate = True asset.flags.ignore_mandatory = True @@ -612,22 +728,25 @@ class BuyingController(StockController, Subcontracting): return asset.name - def update_fixed_asset(self, field, delete_asset = False): + def update_fixed_asset(self, field, delete_asset=False): for d in self.get("items"): if d.is_fixed_asset: - is_auto_create_enabled = frappe.db.get_value('Item', d.item_code, 'auto_create_assets') - assets = frappe.db.get_all('Asset', filters={ field : self.name, 'item_code' : d.item_code }) + is_auto_create_enabled = frappe.db.get_value("Item", d.item_code, "auto_create_assets") + assets = frappe.db.get_all("Asset", filters={field: self.name, "item_code": d.item_code}) for asset in assets: - asset = frappe.get_doc('Asset', asset.name) + asset = frappe.get_doc("Asset", asset.name) if delete_asset and is_auto_create_enabled: # need to delete movements to delete assets otherwise throws link exists error movements = frappe.db.sql( """SELECT asm.name FROM `tabAsset Movement` asm, `tabAsset Movement Item` asm_item - WHERE asm_item.parent=asm.name and asm_item.asset=%s""", asset.name, as_dict=1) + WHERE asm_item.parent=asm.name and asm_item.asset=%s""", + asset.name, + as_dict=1, + ) for movement in movements: - frappe.delete_doc('Asset Movement', movement.name, force=1) + frappe.delete_doc("Asset Movement", movement.name, force=1) frappe.delete_doc("Asset", asset.name, force=1) continue @@ -640,8 +759,11 @@ class BuyingController(StockController, Subcontracting): asset.set(field, None) asset.supplier = None if asset.docstatus == 1 and delete_asset: - frappe.throw(_('Cannot cancel this document as it is linked with submitted asset {0}. Please cancel it to continue.') - .format(frappe.utils.get_link_to_form('Asset', asset.name))) + frappe.throw( + _( + "Cannot cancel this document as it is linked with submitted asset {0}. Please cancel it to continue." + ).format(frappe.utils.get_link_to_form("Asset", asset.name)) + ) asset.flags.ignore_validate_update_after_submit = True asset.flags.ignore_mandatory = True @@ -651,7 +773,7 @@ class BuyingController(StockController, Subcontracting): asset.save() def delete_linked_asset(self): - if self.doctype == 'Purchase Invoice' and not self.get('update_stock'): + if self.doctype == "Purchase Invoice" and not self.get("update_stock"): return frappe.db.sql("delete from `tabAsset Movement` where reference_name=%s", self.name) @@ -662,37 +784,47 @@ class BuyingController(StockController, Subcontracting): if any(d.schedule_date for d in self.get("items")): # Select earliest schedule_date. - self.schedule_date = min(d.schedule_date for d in self.get("items") - if d.schedule_date is not None) + self.schedule_date = min( + d.schedule_date for d in self.get("items") if d.schedule_date is not None + ) if self.schedule_date: - for d in self.get('items'): + for d in self.get("items"): if not d.schedule_date: d.schedule_date = self.schedule_date - if (d.schedule_date and self.transaction_date and - getdate(d.schedule_date) < getdate(self.transaction_date)): + if ( + d.schedule_date + and self.transaction_date + and getdate(d.schedule_date) < getdate(self.transaction_date) + ): frappe.throw(_("Row #{0}: Reqd by Date cannot be before Transaction Date").format(d.idx)) else: frappe.throw(_("Please enter Reqd by Date")) def validate_items(self): # validate items to see if they have is_purchase_item or is_subcontracted_item enabled - if self.doctype=="Material Request": return + if self.doctype == "Material Request": + return - if hasattr(self, "is_subcontracted") and self.is_subcontracted == 'Yes': + if hasattr(self, "is_subcontracted") and self.is_subcontracted == "Yes": validate_item_type(self, "is_sub_contracted_item", "subcontracted") else: validate_item_type(self, "is_purchase_item", "purchase") + def get_asset_item_details(asset_items): asset_items_data = {} - for d in frappe.get_all('Item', fields = ["name", "auto_create_assets", "asset_naming_series"], - filters = {'name': ('in', asset_items)}): + for d in frappe.get_all( + "Item", + fields=["name", "auto_create_assets", "asset_naming_series"], + filters={"name": ("in", asset_items)}, + ): asset_items_data.setdefault(d.name, d) return asset_items_data + def validate_item_type(doc, fieldname, message): # iterate through items and check if they are valid sales or purchase items items = [d.item_code for d in doc.items if d.item_code] @@ -703,16 +835,28 @@ def validate_item_type(doc, fieldname, message): item_list = ", ".join(["%s" % frappe.db.escape(d) for d in items]) - invalid_items = [d[0] for d in frappe.db.sql(""" + invalid_items = [ + d[0] + for d in frappe.db.sql( + """ select item_code from tabItem where name in ({0}) and {1}=0 - """.format(item_list, fieldname), as_list=True)] + """.format( + item_list, fieldname + ), + as_list=True, + ) + ] if invalid_items: items = ", ".join([d for d in invalid_items]) if len(invalid_items) > 1: - error_message = _("Following items {0} are not marked as {1} item. You can enable them as {1} item from its Item master").format(items, message) + error_message = _( + "Following items {0} are not marked as {1} item. You can enable them as {1} item from its Item master" + ).format(items, message) else: - error_message = _("Following item {0} is not marked as {1} item. You can enable them as {1} item from its Item master").format(items, message) + error_message = _( + "Following item {0} is not marked as {1} item. You can enable them as {1} item from its Item master" + ).format(items, message) frappe.throw(error_message) diff --git a/erpnext/controllers/item_variant.py b/erpnext/controllers/item_variant.py index fb405ff81aa..c26f815b30b 100644 --- a/erpnext/controllers/item_variant.py +++ b/erpnext/controllers/item_variant.py @@ -11,24 +11,30 @@ from frappe.utils import cstr, flt from six import string_types -class ItemVariantExistsError(frappe.ValidationError): pass -class InvalidItemAttributeValueError(frappe.ValidationError): pass -class ItemTemplateCannotHaveStock(frappe.ValidationError): pass +class ItemVariantExistsError(frappe.ValidationError): + pass + + +class InvalidItemAttributeValueError(frappe.ValidationError): + pass + + +class ItemTemplateCannotHaveStock(frappe.ValidationError): + pass + @frappe.whitelist() -def get_variant(template, args=None, variant=None, manufacturer=None, - manufacturer_part_no=None): +def get_variant(template, args=None, variant=None, manufacturer=None, manufacturer_part_no=None): """Validates Attributes and their Values, then looks for an exactly - matching Item Variant + matching Item Variant - :param item: Template Item - :param args: A dictionary with "Attribute" as key and "Attribute Value" as value + :param item: Template Item + :param args: A dictionary with "Attribute" as key and "Attribute Value" as value """ - item_template = frappe.get_doc('Item', template) + item_template = frappe.get_doc("Item", template) - if item_template.variant_based_on=='Manufacturer' and manufacturer: - return make_variant_based_on_manufacturer(item_template, manufacturer, - manufacturer_part_no) + if item_template.variant_based_on == "Manufacturer" and manufacturer: + return make_variant_based_on_manufacturer(item_template, manufacturer, manufacturer_part_no) else: if isinstance(args, string_types): args = json.loads(args) @@ -37,28 +43,30 @@ def get_variant(template, args=None, variant=None, manufacturer=None, frappe.throw(_("Please specify at least one attribute in the Attributes table")) return find_variant(template, args, variant) + def make_variant_based_on_manufacturer(template, manufacturer, manufacturer_part_no): - '''Make and return a new variant based on manufacturer and - manufacturer part no''' + """Make and return a new variant based on manufacturer and + manufacturer part no""" from frappe.model.naming import append_number_if_name_exists - variant = frappe.new_doc('Item') + variant = frappe.new_doc("Item") copy_attributes_to_variant(template, variant) variant.manufacturer = manufacturer variant.manufacturer_part_no = manufacturer_part_no - variant.item_code = append_number_if_name_exists('Item', template.name) + variant.item_code = append_number_if_name_exists("Item", template.name) return variant + def validate_item_variant_attributes(item, args=None): if isinstance(item, string_types): - item = frappe.get_doc('Item', item) + item = frappe.get_doc("Item", item) if not args: - args = {d.attribute.lower():d.attribute_value for d in item.attributes} + args = {d.attribute.lower(): d.attribute_value for d in item.attributes} attribute_values, numeric_values = get_attribute_values(item) @@ -74,6 +82,7 @@ def validate_item_variant_attributes(item, args=None): attributes_list = attribute_values.get(attribute.lower(), []) validate_item_attribute_value(attributes_list, attribute, value, item.name, from_variant=True) + def validate_is_incremental(numeric_attribute, attribute, value, item): from_range = numeric_attribute.from_range to_range = numeric_attribute.to_range @@ -85,30 +94,48 @@ def validate_is_incremental(numeric_attribute, attribute, value, item): is_in_range = from_range <= flt(value) <= to_range precision = max(len(cstr(v).split(".")[-1].rstrip("0")) for v in (value, increment)) - #avoid precision error by rounding the remainder + # avoid precision error by rounding the remainder remainder = flt((flt(value) - from_range) % increment, precision) - is_incremental = remainder==0 or remainder==increment + is_incremental = remainder == 0 or remainder == increment if not (is_in_range and is_incremental): - frappe.throw(_("Value for Attribute {0} must be within the range of {1} to {2} in the increments of {3} for Item {4}")\ - .format(attribute, from_range, to_range, increment, item), - InvalidItemAttributeValueError, title=_('Invalid Attribute')) + frappe.throw( + _( + "Value for Attribute {0} must be within the range of {1} to {2} in the increments of {3} for Item {4}" + ).format(attribute, from_range, to_range, increment, item), + InvalidItemAttributeValueError, + title=_("Invalid Attribute"), + ) -def validate_item_attribute_value(attributes_list, attribute, attribute_value, item, from_variant=True): - allow_rename_attribute_value = frappe.db.get_single_value('Item Variant Settings', 'allow_rename_attribute_value') + +def validate_item_attribute_value( + attributes_list, attribute, attribute_value, item, from_variant=True +): + allow_rename_attribute_value = frappe.db.get_single_value( + "Item Variant Settings", "allow_rename_attribute_value" + ) if allow_rename_attribute_value: pass elif attribute_value not in attributes_list: if from_variant: - frappe.throw(_("{0} is not a valid Value for Attribute {1} of Item {2}.").format( - frappe.bold(attribute_value), frappe.bold(attribute), frappe.bold(item)), InvalidItemAttributeValueError, title=_("Invalid Value")) + frappe.throw( + _("{0} is not a valid Value for Attribute {1} of Item {2}.").format( + frappe.bold(attribute_value), frappe.bold(attribute), frappe.bold(item) + ), + InvalidItemAttributeValueError, + title=_("Invalid Value"), + ) else: msg = _("The value {0} is already assigned to an existing Item {1}.").format( - frappe.bold(attribute_value), frappe.bold(item)) - msg += "
" + _("To still proceed with editing this Attribute Value, enable {0} in Item Variant Settings.").format(frappe.bold("Allow Rename Attribute Value")) + frappe.bold(attribute_value), frappe.bold(item) + ) + msg += "
" + _( + "To still proceed with editing this Attribute Value, enable {0} in Item Variant Settings." + ).format(frappe.bold("Allow Rename Attribute Value")) + + frappe.throw(msg, InvalidItemAttributeValueError, title=_("Edit Not Allowed")) - frappe.throw(msg, InvalidItemAttributeValueError, title=_('Edit Not Allowed')) def get_attribute_values(item): if not frappe.flags.attribute_values: @@ -117,9 +144,11 @@ def get_attribute_values(item): for t in frappe.get_all("Item Attribute Value", fields=["parent", "attribute_value"]): attribute_values.setdefault(t.parent.lower(), []).append(t.attribute_value) - for t in frappe.get_all('Item Variant Attribute', + for t in frappe.get_all( + "Item Variant Attribute", fields=["attribute", "from_range", "to_range", "increment"], - filters={'numeric_values': 1, 'parent': item.variant_of}): + filters={"numeric_values": 1, "parent": item.variant_of}, + ): numeric_values[t.attribute.lower()] = t frappe.flags.attribute_values = attribute_values @@ -127,14 +156,22 @@ def get_attribute_values(item): return frappe.flags.attribute_values, frappe.flags.numeric_values + def find_variant(template, args, variant_item_code=None): - conditions = ["""(iv_attribute.attribute={0} and iv_attribute.attribute_value={1})"""\ - .format(frappe.db.escape(key), frappe.db.escape(cstr(value))) for key, value in args.items()] + conditions = [ + """(iv_attribute.attribute={0} and iv_attribute.attribute_value={1})""".format( + frappe.db.escape(key), frappe.db.escape(cstr(value)) + ) + for key, value in args.items() + ] conditions = " or ".join(conditions) from erpnext.e_commerce.variant_selector.utils import get_item_codes_by_attributes - possible_variants = [i for i in get_item_codes_by_attributes(args, template) if i != variant_item_code] + + possible_variants = [ + i for i in get_item_codes_by_attributes(args, template) if i != variant_item_code + ] for variant in possible_variants: variant = frappe.get_doc("Item", variant) @@ -146,7 +183,7 @@ def find_variant(template, args, variant_item_code=None): for attribute, value in args.items(): for row in variant.attributes: - if row.attribute==attribute and row.attribute_value== cstr(value): + if row.attribute == attribute and row.attribute_value == cstr(value): # this row matches match_count += 1 break @@ -154,6 +191,7 @@ def find_variant(template, args, variant_item_code=None): if match_count == len(args.keys()): return variant.name + @frappe.whitelist() def create_variant(item, args): if isinstance(args, string_types): @@ -161,14 +199,11 @@ def create_variant(item, args): template = frappe.get_doc("Item", item) variant = frappe.new_doc("Item") - variant.variant_based_on = 'Item Attribute' + variant.variant_based_on = "Item Attribute" variant_attributes = [] for d in template.attributes: - variant_attributes.append({ - "attribute": d.attribute, - "attribute_value": args.get(d.attribute) - }) + variant_attributes.append({"attribute": d.attribute, "attribute_value": args.get(d.attribute)}) variant.set("attributes", variant_attributes) copy_attributes_to_variant(template, variant) @@ -176,6 +211,7 @@ def create_variant(item, args): return variant + @frappe.whitelist() def enqueue_multiple_variant_creation(item, args): # There can be innumerable attribute combinations, enqueue @@ -190,9 +226,14 @@ def enqueue_multiple_variant_creation(item, args): if total_variants < 10: return create_multiple_variants(item, args) else: - frappe.enqueue("erpnext.controllers.item_variant.create_multiple_variants", - item=item, args=args, now=frappe.flags.in_test); - return 'queued' + frappe.enqueue( + "erpnext.controllers.item_variant.create_multiple_variants", + item=item, + args=args, + now=frappe.flags.in_test, + ) + return "queued" + def create_multiple_variants(item, args): count = 0 @@ -205,26 +246,27 @@ def create_multiple_variants(item, args): if not get_variant(item, args=attribute_values): variant = create_variant(item, attribute_values) variant.save() - count +=1 + count += 1 return count + def generate_keyed_value_combinations(args): """ From this: - args = {"attr1": ["a", "b", "c"], "attr2": ["1", "2"], "attr3": ["A"]} + args = {"attr1": ["a", "b", "c"], "attr2": ["1", "2"], "attr3": ["A"]} To this: - [ - {u'attr1': u'a', u'attr2': u'1', u'attr3': u'A'}, - {u'attr1': u'b', u'attr2': u'1', u'attr3': u'A'}, - {u'attr1': u'c', u'attr2': u'1', u'attr3': u'A'}, - {u'attr1': u'a', u'attr2': u'2', u'attr3': u'A'}, - {u'attr1': u'b', u'attr2': u'2', u'attr3': u'A'}, - {u'attr1': u'c', u'attr2': u'2', u'attr3': u'A'} - ] + [ + {u'attr1': u'a', u'attr2': u'1', u'attr3': u'A'}, + {u'attr1': u'b', u'attr2': u'1', u'attr3': u'A'}, + {u'attr1': u'c', u'attr2': u'1', u'attr3': u'A'}, + {u'attr1': u'a', u'attr2': u'2', u'attr3': u'A'}, + {u'attr1': u'b', u'attr2': u'2', u'attr3': u'A'}, + {u'attr1': u'c', u'attr2': u'2', u'attr3': u'A'} + ] """ # Return empty list if empty @@ -260,17 +302,27 @@ def generate_keyed_value_combinations(args): return results + def copy_attributes_to_variant(item, variant): # copy non no-copy fields - exclude_fields = ["naming_series", "item_code", "item_name", "published_in_website", - "opening_stock", "variant_of", "valuation_rate", "has_variants", "attributes"] + exclude_fields = [ + "naming_series", + "item_code", + "item_name", + "published_in_website", + "opening_stock", + "variant_of", + "valuation_rate", + "has_variants", + "attributes", + ] - if item.variant_based_on=='Manufacturer': + if item.variant_based_on == "Manufacturer": # don't copy manufacturer values if based on part no - exclude_fields += ['manufacturer', 'manufacturer_part_no'] + exclude_fields += ["manufacturer", "manufacturer_part_no"] - allow_fields = [d.field_name for d in frappe.get_all("Variant Field", fields = ['field_name'])] + allow_fields = [d.field_name for d in frappe.get_all("Variant Field", fields=["field_name"])] if "variant_based_on" not in allow_fields: allow_fields.append("variant_based_on") for field in item.meta.fields: @@ -289,11 +341,11 @@ def copy_attributes_to_variant(item, variant): variant.variant_of = item.name - if 'description' not in allow_fields: + if "description" not in allow_fields: if not variant.description: - variant.description = "" + variant.description = "" else: - if item.variant_based_on=='Item Attribute': + if item.variant_based_on == "Item Attribute": if variant.attributes: attributes_description = item.description + " " for d in variant.attributes: @@ -302,6 +354,7 @@ def copy_attributes_to_variant(item, variant): if attributes_description not in variant.description: variant.description = attributes_description + def make_variant_item_code(template_item_code, template_item_name, variant): """Uses template's item code and abbreviations to make variant's item code""" if variant.item_code: @@ -309,13 +362,14 @@ def make_variant_item_code(template_item_code, template_item_name, variant): abbreviations = [] for attr in variant.attributes: - item_attribute = frappe.db.sql("""select i.numeric_values, v.abbr + item_attribute = frappe.db.sql( + """select i.numeric_values, v.abbr from `tabItem Attribute` i left join `tabItem Attribute Value` v on (i.name=v.parent) - where i.name=%(attribute)s and (v.attribute_value=%(attribute_value)s or i.numeric_values = 1)""", { - "attribute": attr.attribute, - "attribute_value": attr.attribute_value - }, as_dict=True) + where i.name=%(attribute)s and (v.attribute_value=%(attribute_value)s or i.numeric_values = 1)""", + {"attribute": attr.attribute, "attribute_value": attr.attribute_value}, + as_dict=True, + ) if not item_attribute: continue @@ -323,13 +377,16 @@ def make_variant_item_code(template_item_code, template_item_name, variant): # frappe.bold(attr.attribute_value)), title=_('Invalid Attribute'), # exc=InvalidItemAttributeValueError) - abbr_or_value = cstr(attr.attribute_value) if item_attribute[0].numeric_values else item_attribute[0].abbr + abbr_or_value = ( + cstr(attr.attribute_value) if item_attribute[0].numeric_values else item_attribute[0].abbr + ) abbreviations.append(abbr_or_value) if abbreviations: variant.item_code = "{0}-{1}".format(template_item_code, "-".join(abbreviations)) variant.item_name = "{0}-{1}".format(template_item_name, "-".join(abbreviations)) + @frappe.whitelist() def create_variant_doc_for_quick_entry(template, args): variant_based_on = frappe.db.get_value("Item", template, "variant_based_on") diff --git a/erpnext/controllers/print_settings.py b/erpnext/controllers/print_settings.py index cf9de52d4cd..d2c80961a36 100644 --- a/erpnext/controllers/print_settings.py +++ b/erpnext/controllers/print_settings.py @@ -2,7 +2,6 @@ # License: GNU General Public License v3. See license.txt - def set_print_templates_for_item_table(doc, settings): doc.print_templates = { "items": "templates/print_formats/includes/items.html", @@ -20,16 +19,21 @@ def set_print_templates_for_item_table(doc, settings): doc.flags.compact_item_fields = ["description", "qty", "rate", "amount"] if settings.compact_item_print: - doc.child_print_templates["items"]["description"] =\ - "templates/print_formats/includes/item_table_description.html" + doc.child_print_templates["items"][ + "description" + ] = "templates/print_formats/includes/item_table_description.html" doc.flags.format_columns = format_columns + def set_print_templates_for_taxes(doc, settings): doc.flags.show_inclusive_tax_in_print = doc.is_inclusive_tax() - doc.print_templates.update({ - "total": "templates/print_formats/includes/total.html", - "taxes": "templates/print_formats/includes/taxes.html" - }) + doc.print_templates.update( + { + "total": "templates/print_formats/includes/total.html", + "taxes": "templates/print_formats/includes/taxes.html", + } + ) + def format_columns(display_columns, compact_fields): compact_fields = compact_fields + ["image", "item_code", "item_name"] diff --git a/erpnext/controllers/queries.py b/erpnext/controllers/queries.py index ef5ee36a758..53a17422004 100644 --- a/erpnext/controllers/queries.py +++ b/erpnext/controllers/queries.py @@ -18,10 +18,12 @@ from erpnext.stock.get_item_details import _get_item_tax_template @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def employee_query(doctype, txt, searchfield, start, page_len, filters): + doctype = "Employee" conditions = [] - fields = get_fields("Employee", ["name", "employee_name"]) + fields = get_fields(doctype, ["name", "employee_name"]) - return frappe.db.sql("""select {fields} from `tabEmployee` + return frappe.db.sql( + """select {fields} from `tabEmployee` where status in ('Active', 'Suspended') and docstatus < 2 and ({key} like %(txt)s @@ -32,26 +34,27 @@ def employee_query(doctype, txt, searchfield, start, page_len, filters): if(locate(%(_txt)s, employee_name), locate(%(_txt)s, employee_name), 99999), idx desc, name, employee_name - limit %(start)s, %(page_len)s""".format(**{ - 'fields': ", ".join(fields), - 'key': searchfield, - 'fcond': get_filters_cond(doctype, filters, conditions), - 'mcond': get_match_cond(doctype) - }), { - 'txt': "%%%s%%" % txt, - '_txt': txt.replace("%", ""), - 'start': start, - 'page_len': page_len - }) + limit %(start)s, %(page_len)s""".format( + **{ + "fields": ", ".join(fields), + "key": searchfield, + "fcond": get_filters_cond(doctype, filters, conditions), + "mcond": get_match_cond(doctype), + } + ), + {"txt": "%%%s%%" % txt, "_txt": txt.replace("%", ""), "start": start, "page_len": page_len}, + ) # searches for leads which are not converted @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def lead_query(doctype, txt, searchfield, start, page_len, filters): - fields = get_fields("Lead", ["name", "lead_name", "company_name"]) + doctype = "Lead" + fields = get_fields(doctype, ["name", "lead_name", "company_name"]) - return frappe.db.sql("""select {fields} from `tabLead` + return frappe.db.sql( + """select {fields} from `tabLead` where docstatus < 2 and ifnull(status, '') != 'Converted' and ({key} like %(txt)s @@ -64,22 +67,19 @@ def lead_query(doctype, txt, searchfield, start, page_len, filters): if(locate(%(_txt)s, company_name), locate(%(_txt)s, company_name), 99999), idx desc, name, lead_name - limit %(start)s, %(page_len)s""".format(**{ - 'fields': ", ".join(fields), - 'key': searchfield, - 'mcond':get_match_cond(doctype) - }), { - 'txt': "%%%s%%" % txt, - '_txt': txt.replace("%", ""), - 'start': start, - 'page_len': page_len - }) + limit %(start)s, %(page_len)s""".format( + **{"fields": ", ".join(fields), "key": searchfield, "mcond": get_match_cond(doctype)} + ), + {"txt": "%%%s%%" % txt, "_txt": txt.replace("%", ""), "start": start, "page_len": page_len}, + ) + + # searches for customer - # searches for customer @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def customer_query(doctype, txt, searchfield, start, page_len, filters): + doctype = "Customer" conditions = [] cust_master_name = frappe.defaults.get_user_default("cust_master_name") @@ -88,12 +88,13 @@ def customer_query(doctype, txt, searchfield, start, page_len, filters): else: fields = ["name", "customer_name", "customer_group", "territory"] - fields = get_fields("Customer", fields) + fields = get_fields(doctype, fields) - searchfields = frappe.get_meta("Customer").get_search_fields() + searchfields = frappe.get_meta(doctype).get_search_fields() searchfields = " or ".join(field + " like %(txt)s" for field in searchfields) - return frappe.db.sql("""select {fields} from `tabCustomer` + return frappe.db.sql( + """select {fields} from `tabCustomer` where docstatus < 2 and ({scond}) and disabled=0 {fcond} {mcond} @@ -102,23 +103,23 @@ def customer_query(doctype, txt, searchfield, start, page_len, filters): if(locate(%(_txt)s, customer_name), locate(%(_txt)s, customer_name), 99999), idx desc, name, customer_name - limit %(start)s, %(page_len)s""".format(**{ - "fields": ", ".join(fields), - "scond": searchfields, - "mcond": get_match_cond(doctype), - "fcond": get_filters_cond(doctype, filters, conditions).replace('%', '%%'), - }), { - 'txt': "%%%s%%" % txt, - '_txt': txt.replace("%", ""), - 'start': start, - 'page_len': page_len - }) + limit %(start)s, %(page_len)s""".format( + **{ + "fields": ", ".join(fields), + "scond": searchfields, + "mcond": get_match_cond(doctype), + "fcond": get_filters_cond(doctype, filters, conditions).replace("%", "%%"), + } + ), + {"txt": "%%%s%%" % txt, "_txt": txt.replace("%", ""), "start": start, "page_len": page_len}, + ) # searches for supplier @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def supplier_query(doctype, txt, searchfield, start, page_len, filters): + doctype = "Supplier" supp_master_name = frappe.defaults.get_user_default("supp_master_name") if supp_master_name == "Supplier Name": @@ -126,9 +127,10 @@ def supplier_query(doctype, txt, searchfield, start, page_len, filters): else: fields = ["name", "supplier_name", "supplier_group"] - fields = get_fields("Supplier", fields) + fields = get_fields(doctype, fields) - return frappe.db.sql("""select {field} from `tabSupplier` + return frappe.db.sql( + """select {field} from `tabSupplier` where docstatus < 2 and ({key} like %(txt)s or supplier_name like %(txt)s) and disabled=0 @@ -139,36 +141,34 @@ def supplier_query(doctype, txt, searchfield, start, page_len, filters): if(locate(%(_txt)s, supplier_name), locate(%(_txt)s, supplier_name), 99999), idx desc, name, supplier_name - limit %(start)s, %(page_len)s """.format(**{ - 'field': ', '.join(fields), - 'key': searchfield, - 'mcond':get_match_cond(doctype) - }), { - 'txt': "%%%s%%" % txt, - '_txt': txt.replace("%", ""), - 'start': start, - 'page_len': page_len - }) + limit %(start)s, %(page_len)s """.format( + **{"field": ", ".join(fields), "key": searchfield, "mcond": get_match_cond(doctype)} + ), + {"txt": "%%%s%%" % txt, "_txt": txt.replace("%", ""), "start": start, "page_len": page_len}, + ) @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def tax_account_query(doctype, txt, searchfield, start, page_len, filters): - company_currency = erpnext.get_company_currency(filters.get('company')) + doctype = "Account" + company_currency = erpnext.get_company_currency(filters.get("company")) def get_accounts(with_account_type_filter): - account_type_condition = '' + account_type_condition = "" if with_account_type_filter: account_type_condition = "AND account_type in %(account_types)s" - accounts = frappe.db.sql(""" + accounts = frappe.db.sql( + """ SELECT name, parent_account FROM `tabAccount` WHERE `tabAccount`.docstatus!=2 {account_type_condition} AND is_group = 0 AND company = %(company)s - AND account_currency = %(currency)s + AND disabled = %(disabled)s + AND (account_currency = %(currency)s or ifnull(account_currency, '') = '') AND `{searchfield}` LIKE %(txt)s {mcond} ORDER BY idx DESC, name @@ -176,16 +176,17 @@ def tax_account_query(doctype, txt, searchfield, start, page_len, filters): """.format( account_type_condition=account_type_condition, searchfield=searchfield, - mcond=get_match_cond(doctype) + mcond=get_match_cond(doctype), ), dict( account_types=filters.get("account_type"), company=filters.get("company"), + disabled=filters.get("disabled", 0), currency=company_currency, txt="%{}%".format(txt), offset=start, - limit=page_len - ) + limit=page_len, + ), ) return accounts @@ -201,13 +202,14 @@ def tax_account_query(doctype, txt, searchfield, start, page_len, filters): @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def item_query(doctype, txt, searchfield, start, page_len, filters, as_dict=False): + doctype = "Item" conditions = [] if isinstance(filters, str): filters = json.loads(filters) - #Get searchfields from meta and use in Item Link field query - meta = frappe.get_meta("Item", cached=True) + # Get searchfields from meta and use in Item Link field query + meta = frappe.get_meta(doctype, cached=True) searchfields = meta.get_search_fields() # these are handled separately @@ -216,46 +218,56 @@ def item_query(doctype, txt, searchfield, start, page_len, filters, as_dict=Fals if ignored_field in searchfields: searchfields.remove(ignored_field) - columns = '' - extra_searchfields = [field for field in searchfields - if not field in ["name", "item_group", "description", "item_name"]] + columns = "" + extra_searchfields = [ + field + for field in searchfields + if not field in ["name", "item_group", "description", "item_name"] + ] if extra_searchfields: columns = ", " + ", ".join(extra_searchfields) - searchfields = searchfields + [field for field in[searchfield or "name", "item_code", "item_group", "item_name"] - if not field in searchfields] + searchfields = searchfields + [ + field + for field in [searchfield or "name", "item_code", "item_group", "item_name"] + if not field in searchfields + ] searchfields = " or ".join([field + " like %(txt)s" for field in searchfields]) if filters and isinstance(filters, dict): - if filters.get('customer') or filters.get('supplier'): - party = filters.get('customer') or filters.get('supplier') - item_rules_list = frappe.get_all('Party Specific Item', - filters = {'party': party}, fields = ['restrict_based_on', 'based_on_value']) + if filters.get("customer") or filters.get("supplier"): + party = filters.get("customer") or filters.get("supplier") + item_rules_list = frappe.get_all( + "Party Specific Item", filters={"party": party}, fields=["restrict_based_on", "based_on_value"] + ) filters_dict = {} for rule in item_rules_list: - if rule['restrict_based_on'] == 'Item': - rule['restrict_based_on'] = 'name' + if rule["restrict_based_on"] == "Item": + rule["restrict_based_on"] = "name" filters_dict[rule.restrict_based_on] = [] for rule in item_rules_list: filters_dict[rule.restrict_based_on].append(rule.based_on_value) for filter in filters_dict: - filters[scrub(filter)] = ['in', filters_dict[filter]] + filters[scrub(filter)] = ["in", filters_dict[filter]] - if filters.get('customer'): - del filters['customer'] + if filters.get("customer"): + del filters["customer"] else: - del filters['supplier'] + del filters["supplier"] + else: + filters.pop("customer", None) + filters.pop("supplier", None) - - description_cond = '' - if frappe.db.count('Item', cache=True) < 50000: + description_cond = "" + if frappe.db.count(doctype, cache=True) < 50000: # scan description only if items are less than 50000 - description_cond = 'or tabItem.description LIKE %(txt)s' - return frappe.db.sql("""select + description_cond = "or tabItem.description LIKE %(txt)s" + return frappe.db.sql( + """select tabItem.name, tabItem.item_name, tabItem.item_group, if(length(tabItem.description) > 40, \ concat(substr(tabItem.description, 1, 40), "..."), description) as description @@ -276,25 +288,30 @@ def item_query(doctype, txt, searchfield, start, page_len, filters, as_dict=Fals limit %(start)s, %(page_len)s """.format( columns=columns, scond=searchfields, - fcond=get_filters_cond(doctype, filters, conditions).replace('%', '%%'), - mcond=get_match_cond(doctype).replace('%', '%%'), - description_cond = description_cond), - { - "today": nowdate(), - "txt": "%%%s%%" % txt, - "_txt": txt.replace("%", ""), - "start": start, - "page_len": page_len - }, as_dict=as_dict) + fcond=get_filters_cond(doctype, filters, conditions).replace("%", "%%"), + mcond=get_match_cond(doctype).replace("%", "%%"), + description_cond=description_cond, + ), + { + "today": nowdate(), + "txt": "%%%s%%" % txt, + "_txt": txt.replace("%", ""), + "start": start, + "page_len": page_len, + }, + as_dict=as_dict, + ) @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def bom(doctype, txt, searchfield, start, page_len, filters): + doctype = "BOM" conditions = [] - fields = get_fields("BOM", ["name", "item"]) + fields = get_fields(doctype, ["name", "item"]) - return frappe.db.sql("""select {fields} + return frappe.db.sql( + """select {fields} from tabBOM where tabBOM.docstatus=1 and tabBOM.is_active=1 @@ -305,30 +322,36 @@ def bom(doctype, txt, searchfield, start, page_len, filters): idx desc, name limit %(start)s, %(page_len)s """.format( fields=", ".join(fields), - fcond=get_filters_cond(doctype, filters, conditions).replace('%', '%%'), - mcond=get_match_cond(doctype).replace('%', '%%'), - key=searchfield), + fcond=get_filters_cond(doctype, filters, conditions).replace("%", "%%"), + mcond=get_match_cond(doctype).replace("%", "%%"), + key=searchfield, + ), { - 'txt': '%' + txt + '%', - '_txt': txt.replace("%", ""), - 'start': start or 0, - 'page_len': page_len or 20 - }) + "txt": "%" + txt + "%", + "_txt": txt.replace("%", ""), + "start": start or 0, + "page_len": page_len or 20, + }, + ) @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_project_name(doctype, txt, searchfield, start, page_len, filters): - cond = '' - if filters and filters.get('customer'): + doctype = "Project" + cond = "" + if filters and filters.get("customer"): cond = """(`tabProject`.customer = %s or - ifnull(`tabProject`.customer,"")="") and""" %(frappe.db.escape(filters.get("customer"))) + ifnull(`tabProject`.customer,"")="") and""" % ( + frappe.db.escape(filters.get("customer")) + ) - fields = get_fields("Project", ["name", "project_name"]) - searchfields = frappe.get_meta("Project").get_search_fields() - searchfields = " or ".join([field + " like %(txt)s" for field in searchfields]) + fields = get_fields(doctype, ["name", "project_name"]) + searchfields = frappe.get_meta(doctype).get_search_fields() + searchfields = " or ".join(["`tabProject`." + field + " like %(txt)s" for field in searchfields]) - return frappe.db.sql("""select {fields} from `tabProject` + return frappe.db.sql( + """select {fields} from `tabProject` where `tabProject`.status not in ("Completed", "Cancelled") and {cond} {scond} {match_cond} @@ -337,23 +360,25 @@ def get_project_name(doctype, txt, searchfield, start, page_len, filters): idx desc, `tabProject`.name asc limit {start}, {page_len}""".format( - fields=", ".join(['`tabProject`.{0}'.format(f) for f in fields]), + fields=", ".join(["`tabProject`.{0}".format(f) for f in fields]), cond=cond, scond=searchfields, match_cond=get_match_cond(doctype), start=start, - page_len=page_len), { - "txt": "%{0}%".format(txt), - "_txt": txt.replace('%', '') - }) + page_len=page_len, + ), + {"txt": "%{0}%".format(txt), "_txt": txt.replace("%", "")}, + ) @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_delivery_notes_to_be_billed(doctype, txt, searchfield, start, page_len, filters, as_dict): - fields = get_fields("Delivery Note", ["name", "customer", "posting_date"]) + doctype = "Delivery Note" + fields = get_fields(doctype, ["name", "customer", "posting_date"]) - return frappe.db.sql(""" + return frappe.db.sql( + """ select %(fields)s from `tabDelivery Note` where `tabDelivery Note`.`%(key)s` like %(txt)s and @@ -368,55 +393,61 @@ def get_delivery_notes_to_be_billed(doctype, txt, searchfield, start, page_len, ) ) %(mcond)s order by `tabDelivery Note`.`%(key)s` asc limit %(start)s, %(page_len)s - """ % { - "fields": ", ".join(["`tabDelivery Note`.{0}".format(f) for f in fields]), - "key": searchfield, - "fcond": get_filters_cond(doctype, filters, []), - "mcond": get_match_cond(doctype), - "start": start, - "page_len": page_len, - "txt": "%(txt)s" - }, {"txt": ("%%%s%%" % txt)}, as_dict=as_dict) + """ + % { + "fields": ", ".join(["`tabDelivery Note`.{0}".format(f) for f in fields]), + "key": searchfield, + "fcond": get_filters_cond(doctype, filters, []), + "mcond": get_match_cond(doctype), + "start": start, + "page_len": page_len, + "txt": "%(txt)s", + }, + {"txt": ("%%%s%%" % txt)}, + as_dict=as_dict, + ) @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_batch_no(doctype, txt, searchfield, start, page_len, filters): + doctype = "Batch" cond = "" if filters.get("posting_date"): cond = "and (batch.expiry_date is null or batch.expiry_date >= %(posting_date)s)" batch_nos = None args = { - 'item_code': filters.get("item_code"), - 'warehouse': filters.get("warehouse"), - 'posting_date': filters.get('posting_date'), - 'txt': "%{0}%".format(txt), + "item_code": filters.get("item_code"), + "warehouse": filters.get("warehouse"), + "posting_date": filters.get("posting_date"), + "txt": "%{0}%".format(txt), "start": start, - "page_len": page_len + "page_len": page_len, } having_clause = "having sum(sle.actual_qty) > 0" if filters.get("is_return"): having_clause = "" - meta = frappe.get_meta("Batch", cached=True) + meta = frappe.get_meta(doctype, cached=True) searchfields = meta.get_search_fields() - search_columns = '' - search_cond = '' + search_columns = "" + search_cond = "" if searchfields: search_columns = ", " + ", ".join(searchfields) search_cond = " or " + " or ".join([field + " like %(txt)s" for field in searchfields]) - if args.get('warehouse'): - searchfields = ['batch.' + field for field in searchfields] + if args.get("warehouse"): + searchfields = ["batch." + field for field in searchfields] if searchfields: search_columns = ", " + ", ".join(searchfields) search_cond = " or " + " or ".join([field + " like %(txt)s" for field in searchfields]) - batch_nos = frappe.db.sql("""select sle.batch_no, round(sum(sle.actual_qty),2), sle.stock_uom, + batch_nos = frappe.db.sql( + """select sle.batch_no, round(sum(sle.actual_qty),2), sle.stock_uom, concat('MFG-',batch.manufacturing_date), concat('EXP-',batch.expiry_date) {search_columns} from `tabStock Ledger Entry` sle @@ -436,16 +467,19 @@ def get_batch_no(doctype, txt, searchfield, start, page_len, filters): group by batch_no {having_clause} order by batch.expiry_date, sle.batch_no desc limit %(start)s, %(page_len)s""".format( - search_columns = search_columns, + search_columns=search_columns, cond=cond, match_conditions=get_match_cond(doctype), - having_clause = having_clause, - search_cond = search_cond - ), args) + having_clause=having_clause, + search_cond=search_cond, + ), + args, + ) return batch_nos else: - return frappe.db.sql("""select name, concat('MFG-', manufacturing_date), concat('EXP-',expiry_date) + return frappe.db.sql( + """select name, concat('MFG-', manufacturing_date), concat('EXP-',expiry_date) {search_columns} from `tabBatch` batch where batch.disabled = 0 @@ -459,13 +493,20 @@ def get_batch_no(doctype, txt, searchfield, start, page_len, filters): {match_conditions} order by expiry_date, name desc - limit %(start)s, %(page_len)s""".format(cond, search_columns = search_columns, - search_cond = search_cond, match_conditions=get_match_cond(doctype)), args) + limit %(start)s, %(page_len)s""".format( + cond, + search_columns=search_columns, + search_cond=search_cond, + match_conditions=get_match_cond(doctype), + ), + args, + ) @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_account_list(doctype, txt, searchfield, start, page_len, filters): + doctype = "Account" filter_list = [] if isinstance(filters, dict): @@ -483,25 +524,33 @@ def get_account_list(doctype, txt, searchfield, start, page_len, filters): if searchfield and txt: filter_list.append([doctype, searchfield, "like", "%%%s%%" % txt]) - return frappe.desk.reportview.execute("Account", filters = filter_list, - fields = ["name", "parent_account"], - limit_start=start, limit_page_length=page_len, as_list=True) + return frappe.desk.reportview.execute( + doctype, + filters=filter_list, + fields=["name", "parent_account"], + limit_start=start, + limit_page_length=page_len, + as_list=True, + ) + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_blanket_orders(doctype, txt, searchfield, start, page_len, filters): - return frappe.db.sql("""select distinct bo.name, bo.blanket_order_type, bo.to_date + return frappe.db.sql( + """select distinct bo.name, bo.blanket_order_type, bo.to_date from `tabBlanket Order` bo, `tabBlanket Order Item` boi where boi.parent = bo.name and boi.item_code = {item_code} and bo.blanket_order_type = '{blanket_order_type}' and bo.company = {company} - and bo.docstatus = 1""" - .format(item_code = frappe.db.escape(filters.get("item")), - blanket_order_type = filters.get("blanket_order_type"), - company = frappe.db.escape(filters.get("company")) - )) + and bo.docstatus = 1""".format( + item_code=frappe.db.escape(filters.get("item")), + blanket_order_type=filters.get("blanket_order_type"), + company=frappe.db.escape(filters.get("company")), + ) + ) @frappe.whitelist() @@ -512,23 +561,27 @@ def get_income_account(doctype, txt, searchfield, start, page_len, filters): # income account can be any Credit account, # but can also be a Asset account with account_type='Income Account' in special circumstances. # Hence the first condition is an "OR" - if not filters: filters = {} + if not filters: + filters = {} + doctype = "Account" condition = "" if filters.get("company"): condition += "and tabAccount.company = %(company)s" - return frappe.db.sql("""select tabAccount.name from `tabAccount` + return frappe.db.sql( + """select tabAccount.name from `tabAccount` where (tabAccount.report_type = "Profit and Loss" or tabAccount.account_type in ("Income Account", "Temporary")) and tabAccount.is_group=0 and tabAccount.`{key}` LIKE %(txt)s {condition} {match_condition} - order by idx desc, name""" - .format(condition=condition, match_condition=get_match_cond(doctype), key=searchfield), { - 'txt': '%' + txt + '%', - 'company': filters.get("company", "") - }) + order by idx desc, name""".format( + condition=condition, match_condition=get_match_cond(doctype), key=searchfield + ), + {"txt": "%" + txt + "%", "company": filters.get("company", "")}, + ) + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs @@ -536,74 +589,81 @@ def get_filtered_dimensions(doctype, txt, searchfield, start, page_len, filters) from erpnext.accounts.doctype.accounting_dimension_filter.accounting_dimension_filter import ( get_dimension_filter_map, ) + dimension_filters = get_dimension_filter_map() - dimension_filters = dimension_filters.get((filters.get('dimension'),filters.get('account'))) + dimension_filters = dimension_filters.get((filters.get("dimension"), filters.get("account"))) query_filters = [] or_filters = [] - fields = ['name'] + fields = ["name"] searchfields = frappe.get_meta(doctype).get_search_fields() meta = frappe.get_meta(doctype) if meta.is_tree: - query_filters.append(['is_group', '=', 0]) + query_filters.append(["is_group", "=", 0]) - if meta.has_field('disabled'): - query_filters.append(['disabled', '!=', 1]) + if meta.has_field("disabled"): + query_filters.append(["disabled", "!=", 1]) - if meta.has_field('company'): - query_filters.append(['company', '=', filters.get('company')]) + if meta.has_field("company"): + query_filters.append(["company", "=", filters.get("company")]) for field in searchfields: - or_filters.append([field, 'LIKE', "%%%s%%" % txt]) + or_filters.append([field, "LIKE", "%%%s%%" % txt]) fields.append(field) if dimension_filters: - if dimension_filters['allow_or_restrict'] == 'Allow': - query_selector = 'in' + if dimension_filters["allow_or_restrict"] == "Allow": + query_selector = "in" else: - query_selector = 'not in' + query_selector = "not in" - if len(dimension_filters['allowed_dimensions']) == 1: - dimensions = tuple(dimension_filters['allowed_dimensions'] * 2) + if len(dimension_filters["allowed_dimensions"]) == 1: + dimensions = tuple(dimension_filters["allowed_dimensions"] * 2) else: - dimensions = tuple(dimension_filters['allowed_dimensions']) + dimensions = tuple(dimension_filters["allowed_dimensions"]) - query_filters.append(['name', query_selector, dimensions]) + query_filters.append(["name", query_selector, dimensions]) - output = frappe.get_list(doctype, fields=fields, filters=query_filters, or_filters=or_filters, as_list=1) + output = frappe.get_list( + doctype, fields=fields, filters=query_filters, or_filters=or_filters, as_list=1 + ) return [tuple(d) for d in set(output)] + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_expense_account(doctype, txt, searchfield, start, page_len, filters): from erpnext.controllers.queries import get_match_cond - if not filters: filters = {} + if not filters: + filters = {} + doctype = "Account" condition = "" if filters.get("company"): condition += "and tabAccount.company = %(company)s" - return frappe.db.sql("""select tabAccount.name from `tabAccount` + return frappe.db.sql( + """select tabAccount.name from `tabAccount` where (tabAccount.report_type = "Profit and Loss" or tabAccount.account_type in ("Expense Account", "Fixed Asset", "Temporary", "Asset Received But Not Billed", "Capital Work in Progress")) and tabAccount.is_group=0 and tabAccount.docstatus!=2 and tabAccount.{key} LIKE %(txt)s - {condition} {match_condition}""" - .format(condition=condition, key=searchfield, - match_condition=get_match_cond(doctype)), { - 'company': filters.get("company", ""), - 'txt': '%' + txt + '%' - }) + {condition} {match_condition}""".format( + condition=condition, key=searchfield, match_condition=get_match_cond(doctype) + ), + {"company": filters.get("company", ""), "txt": "%" + txt + "%"}, + ) @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def warehouse_query(doctype, txt, searchfield, start, page_len, filters): # Should be used when item code is passed in filters. + doctype = "Warehouse" conditions, bin_conditions = [], [] filter_dict = get_doctype_wise_filters(filters) @@ -618,14 +678,16 @@ def warehouse_query(doctype, txt, searchfield, start, page_len, filters): limit {start}, {page_len} """.format( - bin_conditions=get_filters_cond(doctype, filter_dict.get("Bin"),bin_conditions, ignore_permissions=True), - key=searchfield, - fcond=get_filters_cond(doctype, filter_dict.get("Warehouse"), conditions), - mcond=get_match_cond(doctype), - start=start, - page_len=page_len, - txt=frappe.db.escape('%{0}%'.format(txt)) - ) + bin_conditions=get_filters_cond( + doctype, filter_dict.get("Bin"), bin_conditions, ignore_permissions=True + ), + key=searchfield, + fcond=get_filters_cond(doctype, filter_dict.get("Warehouse"), conditions), + mcond=get_match_cond(doctype), + start=start, + page_len=page_len, + txt=frappe.db.escape("%{0}%".format(txt)), + ) return frappe.db.sql(query) @@ -644,10 +706,12 @@ def get_batch_numbers(doctype, txt, searchfield, start, page_len, filters): query = """select batch_id from `tabBatch` where disabled = 0 and (expiry_date >= CURDATE() or expiry_date IS NULL) - and name like {txt}""".format(txt = frappe.db.escape('%{0}%'.format(txt))) + and name like {txt}""".format( + txt=frappe.db.escape("%{0}%".format(txt)) + ) - if filters and filters.get('item'): - query += " and item = {item}".format(item = frappe.db.escape(filters.get('item'))) + if filters and filters.get("item"): + query += " and item = {item}".format(item=frappe.db.escape(filters.get("item"))) return frappe.db.sql(query, filters) @@ -656,8 +720,8 @@ def get_batch_numbers(doctype, txt, searchfield, start, page_len, filters): @frappe.validate_and_sanitize_search_inputs def item_manufacturer_query(doctype, txt, searchfield, start, page_len, filters): item_filters = [ - ['manufacturer', 'like', '%' + txt + '%'], - ['item_code', '=', filters.get("item_code")] + ["manufacturer", "like", "%" + txt + "%"], + ["item_code", "=", filters.get("item_code")], ] item_manufacturers = frappe.get_all( @@ -666,7 +730,7 @@ def item_manufacturer_query(doctype, txt, searchfield, start, page_len, filters) filters=item_filters, limit_start=start, limit_page_length=page_len, - as_list=1 + as_list=1, ) return item_manufacturers @@ -678,10 +742,14 @@ def get_purchase_receipts(doctype, txt, searchfield, start, page_len, filters): select pr.name from `tabPurchase Receipt` pr, `tabPurchase Receipt Item` pritem where pr.docstatus = 1 and pritem.parent = pr.name - and pr.name like {txt}""".format(txt = frappe.db.escape('%{0}%'.format(txt))) + and pr.name like {txt}""".format( + txt=frappe.db.escape("%{0}%".format(txt)) + ) - if filters and filters.get('item_code'): - query += " and pritem.item_code = {item_code}".format(item_code = frappe.db.escape(filters.get('item_code'))) + if filters and filters.get("item_code"): + query += " and pritem.item_code = {item_code}".format( + item_code=frappe.db.escape(filters.get("item_code")) + ) return frappe.db.sql(query, filters) @@ -693,10 +761,14 @@ def get_purchase_invoices(doctype, txt, searchfield, start, page_len, filters): select pi.name from `tabPurchase Invoice` pi, `tabPurchase Invoice Item` piitem where pi.docstatus = 1 and piitem.parent = pi.name - and pi.name like {txt}""".format(txt = frappe.db.escape('%{0}%'.format(txt))) + and pi.name like {txt}""".format( + txt=frappe.db.escape("%{0}%".format(txt)) + ) - if filters and filters.get('item_code'): - query += " and piitem.item_code = {item_code}".format(item_code = frappe.db.escape(filters.get('item_code'))) + if filters and filters.get("item_code"): + query += " and piitem.item_code = {item_code}".format( + item_code=frappe.db.escape(filters.get("item_code")) + ) return frappe.db.sql(query, filters) @@ -711,18 +783,22 @@ def get_healthcare_service_units(doctype, txt, searchfield, start, page_len, fil is_group = 0 and company = {company} and name like {txt}""".format( - company = frappe.db.escape(filters.get('company')), txt = frappe.db.escape('%{0}%'.format(txt))) + company=frappe.db.escape(filters.get("company")), txt=frappe.db.escape("%{0}%".format(txt)) + ) - if filters and filters.get('inpatient_record'): + if filters and filters.get("inpatient_record"): from erpnext.healthcare.doctype.inpatient_medication_entry.inpatient_medication_entry import ( get_current_healthcare_service_unit, ) - service_unit = get_current_healthcare_service_unit(filters.get('inpatient_record')) + + service_unit = get_current_healthcare_service_unit(filters.get("inpatient_record")) # if the patient is admitted, then appointments should be allowed against the admission service unit, # inspite of it being an Inpatient Occupancy service unit if service_unit: - query += " and (allow_appointments = 1 or name = {service_unit})".format(service_unit = frappe.db.escape(service_unit)) + query += " and (allow_appointments = 1 or name = {service_unit})".format( + service_unit=frappe.db.escape(service_unit) + ) else: query += " and allow_appointments = 1" else: @@ -735,26 +811,29 @@ def get_healthcare_service_units(doctype, txt, searchfield, start, page_len, fil @frappe.validate_and_sanitize_search_inputs def get_tax_template(doctype, txt, searchfield, start, page_len, filters): - item_doc = frappe.get_cached_doc('Item', filters.get('item_code')) - item_group = filters.get('item_group') + item_doc = frappe.get_cached_doc("Item", filters.get("item_code")) + item_group = filters.get("item_group") + company = filters.get("company") taxes = item_doc.taxes or [] while item_group: - item_group_doc = frappe.get_cached_doc('Item Group', item_group) + item_group_doc = frappe.get_cached_doc("Item Group", item_group) taxes += item_group_doc.taxes or [] item_group = item_group_doc.parent_item_group if not taxes: - return frappe.db.sql(""" SELECT name FROM `tabItem Tax Template` """) + return frappe.get_all( + "Item Tax Template", filters={"disabled": 0, "company": company}, as_list=True + ) else: - valid_from = filters.get('valid_from') + valid_from = filters.get("valid_from") valid_from = valid_from[1] if isinstance(valid_from, list) else valid_from args = { - 'item_code': filters.get('item_code'), - 'posting_date': valid_from, - 'tax_category': filters.get('tax_category'), - 'company': filters.get('company') + "item_code": filters.get("item_code"), + "posting_date": valid_from, + "tax_category": filters.get("tax_category"), + "company": company, } taxes = _get_item_tax_template(args, taxes, for_validate=True) diff --git a/erpnext/controllers/sales_and_purchase_return.py b/erpnext/controllers/sales_and_purchase_return.py index df3c5f10c1b..1e7dcfb2b6d 100644 --- a/erpnext/controllers/sales_and_purchase_return.py +++ b/erpnext/controllers/sales_and_purchase_return.py @@ -11,7 +11,9 @@ import erpnext from erpnext.stock.utils import get_incoming_rate -class StockOverReturnError(frappe.ValidationError): pass +class StockOverReturnError(frappe.ValidationError): + pass + def validate_return(doc): if not doc.meta.get_field("is_return") or not doc.is_return: @@ -21,32 +23,50 @@ def validate_return(doc): validate_return_against(doc) validate_returned_items(doc) + def validate_return_against(doc): if not frappe.db.exists(doc.doctype, doc.return_against): - frappe.throw(_("Invalid {0}: {1}") - .format(doc.meta.get_label("return_against"), doc.return_against)) + frappe.throw( + _("Invalid {0}: {1}").format(doc.meta.get_label("return_against"), doc.return_against) + ) else: ref_doc = frappe.get_doc(doc.doctype, doc.return_against) party_type = "customer" if doc.doctype in ("Sales Invoice", "Delivery Note") else "supplier" - if ref_doc.company == doc.company and ref_doc.get(party_type) == doc.get(party_type) and ref_doc.docstatus == 1: + if ( + ref_doc.company == doc.company + and ref_doc.get(party_type) == doc.get(party_type) + and ref_doc.docstatus == 1 + ): # validate posting date time return_posting_datetime = "%s %s" % (doc.posting_date, doc.get("posting_time") or "00:00:00") - ref_posting_datetime = "%s %s" % (ref_doc.posting_date, ref_doc.get("posting_time") or "00:00:00") + ref_posting_datetime = "%s %s" % ( + ref_doc.posting_date, + ref_doc.get("posting_time") or "00:00:00", + ) if get_datetime(return_posting_datetime) < get_datetime(ref_posting_datetime): - frappe.throw(_("Posting timestamp must be after {0}").format(format_datetime(ref_posting_datetime))) + frappe.throw( + _("Posting timestamp must be after {0}").format(format_datetime(ref_posting_datetime)) + ) # validate same exchange rate if doc.conversion_rate != ref_doc.conversion_rate: - frappe.throw(_("Exchange Rate must be same as {0} {1} ({2})") - .format(doc.doctype, doc.return_against, ref_doc.conversion_rate)) + frappe.throw( + _("Exchange Rate must be same as {0} {1} ({2})").format( + doc.doctype, doc.return_against, ref_doc.conversion_rate + ) + ) # validate update stock if doc.doctype == "Sales Invoice" and doc.update_stock and not ref_doc.update_stock: - frappe.throw(_("'Update Stock' can not be checked because items are not delivered via {0}") - .format(doc.return_against)) + frappe.throw( + _("'Update Stock' can not be checked because items are not delivered via {0}").format( + doc.return_against + ) + ) + def validate_returned_items(doc): from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos @@ -54,43 +74,61 @@ def validate_returned_items(doc): valid_items = frappe._dict() select_fields = "item_code, qty, stock_qty, rate, parenttype, conversion_factor" - if doc.doctype != 'Purchase Invoice': + if doc.doctype != "Purchase Invoice": select_fields += ",serial_no, batch_no" - if doc.doctype in ['Purchase Invoice', 'Purchase Receipt']: + if doc.doctype in ["Purchase Invoice", "Purchase Receipt"]: select_fields += ",rejected_qty, received_qty" - for d in frappe.db.sql("""select {0} from `tab{1} Item` where parent = %s""" - .format(select_fields, doc.doctype), doc.return_against, as_dict=1): - valid_items = get_ref_item_dict(valid_items, d) + for d in frappe.db.sql( + """select {0} from `tab{1} Item` where parent = %s""".format(select_fields, doc.doctype), + doc.return_against, + as_dict=1, + ): + valid_items = get_ref_item_dict(valid_items, d) if doc.doctype in ("Delivery Note", "Sales Invoice"): - for d in frappe.db.sql("""select item_code, qty, serial_no, batch_no from `tabPacked Item` - where parent = %s""", doc.return_against, as_dict=1): - valid_items = get_ref_item_dict(valid_items, d) + for d in frappe.db.sql( + """select item_code, qty, serial_no, batch_no from `tabPacked Item` + where parent = %s""", + doc.return_against, + as_dict=1, + ): + valid_items = get_ref_item_dict(valid_items, d) already_returned_items = get_already_returned_items(doc) # ( not mandatory when it is Purchase Invoice or a Sales Invoice without Update Stock ) - warehouse_mandatory = not ((doc.doctype=="Purchase Invoice" or doc.doctype=="Sales Invoice") and not doc.update_stock) + warehouse_mandatory = not ( + (doc.doctype == "Purchase Invoice" or doc.doctype == "Sales Invoice") and not doc.update_stock + ) items_returned = False for d in doc.get("items"): - if d.item_code and (flt(d.qty) < 0 or flt(d.get('received_qty')) < 0): + if d.item_code and (flt(d.qty) < 0 or flt(d.get("received_qty")) < 0): if d.item_code not in valid_items: - frappe.throw(_("Row # {0}: Returned Item {1} does not exist in {2} {3}") - .format(d.idx, d.item_code, doc.doctype, doc.return_against)) + frappe.throw( + _("Row # {0}: Returned Item {1} does not exist in {2} {3}").format( + d.idx, d.item_code, doc.doctype, doc.return_against + ) + ) else: ref = valid_items.get(d.item_code, frappe._dict()) validate_quantity(doc, d, ref, valid_items, already_returned_items) if ref.rate and doc.doctype in ("Delivery Note", "Sales Invoice") and flt(d.rate) > ref.rate: - frappe.throw(_("Row # {0}: Rate cannot be greater than the rate used in {1} {2}") - .format(d.idx, doc.doctype, doc.return_against)) + frappe.throw( + _("Row # {0}: Rate cannot be greater than the rate used in {1} {2}").format( + d.idx, doc.doctype, doc.return_against + ) + ) elif ref.batch_no and d.batch_no not in ref.batch_no: - frappe.throw(_("Row # {0}: Batch No must be same as {1} {2}") - .format(d.idx, doc.doctype, doc.return_against)) + frappe.throw( + _("Row # {0}: Batch No must be same as {1} {2}").format( + d.idx, doc.doctype, doc.return_against + ) + ) elif ref.serial_no: if not d.serial_no: @@ -99,11 +137,16 @@ def validate_returned_items(doc): serial_nos = get_serial_nos(d.serial_no) for s in serial_nos: if s not in ref.serial_no: - frappe.throw(_("Row # {0}: Serial No {1} does not match with {2} {3}") - .format(d.idx, s, doc.doctype, doc.return_against)) + frappe.throw( + _("Row # {0}: Serial No {1} does not match with {2} {3}").format( + d.idx, s, doc.doctype, doc.return_against + ) + ) - if (warehouse_mandatory and not d.get("warehouse") and - frappe.db.get_value("Item", d.item_code, "is_stock_item") + if ( + warehouse_mandatory + and not d.get("warehouse") + and frappe.db.get_value("Item", d.item_code, "is_stock_item") ): frappe.throw(_("Warehouse is mandatory")) @@ -115,21 +158,23 @@ def validate_returned_items(doc): if not items_returned: frappe.throw(_("Atleast one item should be entered with negative quantity in return document")) + def validate_quantity(doc, args, ref, valid_items, already_returned_items): - fields = ['stock_qty'] - if doc.doctype in ['Purchase Receipt', 'Purchase Invoice']: - fields.extend(['received_qty', 'rejected_qty']) + fields = ["stock_qty"] + if doc.doctype in ["Purchase Receipt", "Purchase Invoice"]: + fields.extend(["received_qty", "rejected_qty"]) already_returned_data = already_returned_items.get(args.item_code) or {} company_currency = erpnext.get_company_currency(doc.company) - stock_qty_precision = get_field_precision(frappe.get_meta(doc.doctype + " Item") - .get_field("stock_qty"), company_currency) + stock_qty_precision = get_field_precision( + frappe.get_meta(doc.doctype + " Item").get_field("stock_qty"), company_currency + ) for column in fields: returned_qty = flt(already_returned_data.get(column, 0)) if len(already_returned_data) > 0 else 0 - if column == 'stock_qty': + if column == "stock_qty": reference_qty = ref.get(column) current_stock_qty = args.get(column) else: @@ -137,38 +182,49 @@ def validate_quantity(doc, args, ref, valid_items, already_returned_items): current_stock_qty = args.get(column) * args.get("conversion_factor", 1.0) max_returnable_qty = flt(reference_qty, stock_qty_precision) - returned_qty - label = column.replace('_', ' ').title() + label = column.replace("_", " ").title() if reference_qty: if flt(args.get(column)) > 0: frappe.throw(_("{0} must be negative in return document").format(label)) elif returned_qty >= reference_qty and args.get(column): - frappe.throw(_("Item {0} has already been returned") - .format(args.item_code), StockOverReturnError) + frappe.throw( + _("Item {0} has already been returned").format(args.item_code), StockOverReturnError + ) elif abs(flt(current_stock_qty, stock_qty_precision)) > max_returnable_qty: - frappe.throw(_("Row # {0}: Cannot return more than {1} for Item {2}") - .format(args.idx, max_returnable_qty, args.item_code), StockOverReturnError) + frappe.throw( + _("Row # {0}: Cannot return more than {1} for Item {2}").format( + args.idx, max_returnable_qty, args.item_code + ), + StockOverReturnError, + ) + def get_ref_item_dict(valid_items, ref_item_row): from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos - valid_items.setdefault(ref_item_row.item_code, frappe._dict({ - "qty": 0, - "rate": 0, - "stock_qty": 0, - "rejected_qty": 0, - "received_qty": 0, - "serial_no": [], - "conversion_factor": ref_item_row.get("conversion_factor", 1), - "batch_no": [] - })) + valid_items.setdefault( + ref_item_row.item_code, + frappe._dict( + { + "qty": 0, + "rate": 0, + "stock_qty": 0, + "rejected_qty": 0, + "received_qty": 0, + "serial_no": [], + "conversion_factor": ref_item_row.get("conversion_factor", 1), + "batch_no": [], + } + ), + ) item_dict = valid_items[ref_item_row.item_code] item_dict["qty"] += ref_item_row.qty - item_dict["stock_qty"] += ref_item_row.get('stock_qty', 0) + item_dict["stock_qty"] += ref_item_row.get("stock_qty", 0) if ref_item_row.get("rate", 0) > item_dict["rate"]: item_dict["rate"] = ref_item_row.get("rate", 0) - if ref_item_row.parenttype in ['Purchase Invoice', 'Purchase Receipt']: + if ref_item_row.parenttype in ["Purchase Invoice", "Purchase Receipt"]: item_dict["received_qty"] += ref_item_row.received_qty item_dict["rejected_qty"] += ref_item_row.rejected_qty @@ -180,13 +236,15 @@ def get_ref_item_dict(valid_items, ref_item_row): return valid_items + def get_already_returned_items(doc): - column = 'child.item_code, sum(abs(child.qty)) as qty, sum(abs(child.stock_qty)) as stock_qty' - if doc.doctype in ['Purchase Invoice', 'Purchase Receipt']: + column = "child.item_code, sum(abs(child.qty)) as qty, sum(abs(child.stock_qty)) as stock_qty" + if doc.doctype in ["Purchase Invoice", "Purchase Receipt"]: column += """, sum(abs(child.rejected_qty) * child.conversion_factor) as rejected_qty, sum(abs(child.received_qty) * child.conversion_factor) as received_qty""" - data = frappe.db.sql(""" + data = frappe.db.sql( + """ select {0} from `tab{1} Item` child, `tab{2}` par @@ -194,60 +252,84 @@ def get_already_returned_items(doc): child.parent = par.name and par.docstatus = 1 and par.is_return = 1 and par.return_against = %s group by item_code - """.format(column, doc.doctype, doc.doctype), doc.return_against, as_dict=1) + """.format( + column, doc.doctype, doc.doctype + ), + doc.return_against, + as_dict=1, + ) items = {} for d in data: - items.setdefault(d.item_code, frappe._dict({ - "qty": d.get("qty"), - "stock_qty": d.get("stock_qty"), - "received_qty": d.get("received_qty"), - "rejected_qty": d.get("rejected_qty") - })) + items.setdefault( + d.item_code, + frappe._dict( + { + "qty": d.get("qty"), + "stock_qty": d.get("stock_qty"), + "received_qty": d.get("received_qty"), + "rejected_qty": d.get("rejected_qty"), + } + ), + ) return items -def get_returned_qty_map_for_row(row_name, doctype): + +def get_returned_qty_map_for_row(return_against, party, row_name, doctype): child_doctype = doctype + " Item" reference_field = "dn_detail" if doctype == "Delivery Note" else frappe.scrub(child_doctype) + if doctype in ("Purchase Receipt", "Purchase Invoice"): + party_type = "supplier" + else: + party_type = "customer" + fields = [ "sum(abs(`tab{0}`.qty)) as qty".format(child_doctype), - "sum(abs(`tab{0}`.stock_qty)) as stock_qty".format(child_doctype) + "sum(abs(`tab{0}`.stock_qty)) as stock_qty".format(child_doctype), ] if doctype in ("Purchase Receipt", "Purchase Invoice"): fields += [ "sum(abs(`tab{0}`.rejected_qty)) as rejected_qty".format(child_doctype), - "sum(abs(`tab{0}`.received_qty)) as received_qty".format(child_doctype) + "sum(abs(`tab{0}`.received_qty)) as received_qty".format(child_doctype), ] if doctype == "Purchase Receipt": fields += ["sum(abs(`tab{0}`.received_stock_qty)) as received_stock_qty".format(child_doctype)] - data = frappe.db.get_list(doctype, - fields = fields, - filters = [ + # Used retrun against and supplier and is_retrun because there is an index added for it + data = frappe.db.get_list( + doctype, + fields=fields, + filters=[ + [doctype, "return_against", "=", return_against], + [doctype, party_type, "=", party], [doctype, "docstatus", "=", 1], [doctype, "is_return", "=", 1], - [child_doctype, reference_field, "=", row_name] - ]) + [child_doctype, reference_field, "=", row_name], + ], + ) return data[0] -def make_return_doc(doctype, source_name, target_doc=None): + +def make_return_doc(doctype: str, source_name: str, target_doc=None): from frappe.model.mapper import get_mapped_doc from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos + company = frappe.db.get_value("Delivery Note", source_name, "company") - default_warehouse_for_sales_return = frappe.db.get_value("Company", company, "default_warehouse_for_sales_return") + default_warehouse_for_sales_return = frappe.db.get_value( + "Company", company, "default_warehouse_for_sales_return" + ) def set_missing_values(source, target): doc = frappe.get_doc(target) doc.is_return = 1 doc.return_against = source.name - doc.ignore_pricing_rule = 1 doc.set_warehouse = "" if doctype == "Sales Invoice" or doctype == "POS Invoice": doc.is_pos = source.is_pos @@ -265,29 +347,34 @@ def make_return_doc(doctype, source_name, target_doc=None): tax.tax_amount = -1 * tax.tax_amount if doc.get("is_return"): - if doc.doctype == 'Sales Invoice' or doc.doctype == 'POS Invoice': + if doc.doctype == "Sales Invoice" or doc.doctype == "POS Invoice": doc.consolidated_invoice = "" - doc.set('payments', []) + doc.set("payments", []) for data in source.payments: paid_amount = 0.00 base_paid_amount = 0.00 - data.base_amount = flt(data.amount*source.conversion_rate, source.precision("base_paid_amount")) + data.base_amount = flt( + data.amount * source.conversion_rate, source.precision("base_paid_amount") + ) paid_amount += data.amount base_paid_amount += data.base_amount - doc.append('payments', { - 'mode_of_payment': data.mode_of_payment, - 'type': data.type, - 'amount': -1 * paid_amount, - 'base_amount': -1 * base_paid_amount, - 'account': data.account, - 'default': data.default - }) + doc.append( + "payments", + { + "mode_of_payment": data.mode_of_payment, + "type": data.type, + "amount": -1 * paid_amount, + "base_amount": -1 * base_paid_amount, + "account": data.account, + "default": data.default, + }, + ) if doc.is_pos: doc.paid_amount = -1 * source.paid_amount - elif doc.doctype == 'Purchase Invoice': + elif doc.doctype == "Purchase Invoice": doc.paid_amount = -1 * source.paid_amount doc.base_paid_amount = -1 * source.base_paid_amount - doc.payment_terms_template = '' + doc.payment_terms_template = "" doc.payment_schedule = [] if doc.get("is_return") and hasattr(doc, "packed_items"): @@ -304,16 +391,24 @@ def make_return_doc(doctype, source_name, target_doc=None): returned_serial_nos = get_returned_serial_nos(source_doc, source_parent) serial_nos = list(set(get_serial_nos(source_doc.serial_no)) - set(returned_serial_nos)) if serial_nos: - target_doc.serial_no = '\n'.join(serial_nos) + target_doc.serial_no = "\n".join(serial_nos) if doctype == "Purchase Receipt": - returned_qty_map = get_returned_qty_map_for_row(source_doc.name, doctype) - target_doc.received_qty = -1 * flt(source_doc.received_qty - (returned_qty_map.get('received_qty') or 0)) - target_doc.rejected_qty = -1 * flt(source_doc.rejected_qty - (returned_qty_map.get('rejected_qty') or 0)) - target_doc.qty = -1 * flt(source_doc.qty - (returned_qty_map.get('qty') or 0)) + returned_qty_map = get_returned_qty_map_for_row( + source_parent.name, source_parent.supplier, source_doc.name, doctype + ) + target_doc.received_qty = -1 * flt( + source_doc.received_qty - (returned_qty_map.get("received_qty") or 0) + ) + target_doc.rejected_qty = -1 * flt( + source_doc.rejected_qty - (returned_qty_map.get("rejected_qty") or 0) + ) + target_doc.qty = -1 * flt(source_doc.qty - (returned_qty_map.get("qty") or 0)) - target_doc.stock_qty = -1 * flt(source_doc.stock_qty - (returned_qty_map.get('stock_qty') or 0)) - target_doc.received_stock_qty = -1 * flt(source_doc.received_stock_qty - (returned_qty_map.get('received_stock_qty') or 0)) + target_doc.stock_qty = -1 * flt(source_doc.stock_qty - (returned_qty_map.get("stock_qty") or 0)) + target_doc.received_stock_qty = -1 * flt( + source_doc.received_stock_qty - (returned_qty_map.get("received_stock_qty") or 0) + ) target_doc.purchase_order = source_doc.purchase_order target_doc.purchase_order_item = source_doc.purchase_order_item @@ -321,12 +416,18 @@ def make_return_doc(doctype, source_name, target_doc=None): target_doc.purchase_receipt_item = source_doc.name elif doctype == "Purchase Invoice": - returned_qty_map = get_returned_qty_map_for_row(source_doc.name, doctype) - target_doc.received_qty = -1 * flt(source_doc.received_qty - (returned_qty_map.get('received_qty') or 0)) - target_doc.rejected_qty = -1 * flt(source_doc.rejected_qty - (returned_qty_map.get('rejected_qty') or 0)) - target_doc.qty = -1 * flt(source_doc.qty - (returned_qty_map.get('qty') or 0)) + returned_qty_map = get_returned_qty_map_for_row( + source_parent.name, source_parent.supplier, source_doc.name, doctype + ) + target_doc.received_qty = -1 * flt( + source_doc.received_qty - (returned_qty_map.get("received_qty") or 0) + ) + target_doc.rejected_qty = -1 * flt( + source_doc.rejected_qty - (returned_qty_map.get("rejected_qty") or 0) + ) + target_doc.qty = -1 * flt(source_doc.qty - (returned_qty_map.get("qty") or 0)) - target_doc.stock_qty = -1 * flt(source_doc.stock_qty - (returned_qty_map.get('stock_qty') or 0)) + target_doc.stock_qty = -1 * flt(source_doc.stock_qty - (returned_qty_map.get("stock_qty") or 0)) target_doc.purchase_order = source_doc.purchase_order target_doc.purchase_receipt = source_doc.purchase_receipt target_doc.rejected_warehouse = source_doc.rejected_warehouse @@ -335,9 +436,11 @@ def make_return_doc(doctype, source_name, target_doc=None): target_doc.purchase_invoice_item = source_doc.name elif doctype == "Delivery Note": - returned_qty_map = get_returned_qty_map_for_row(source_doc.name, doctype) - target_doc.qty = -1 * flt(source_doc.qty - (returned_qty_map.get('qty') or 0)) - target_doc.stock_qty = -1 * flt(source_doc.stock_qty - (returned_qty_map.get('stock_qty') or 0)) + returned_qty_map = get_returned_qty_map_for_row( + source_parent.name, source_parent.customer, source_doc.name, doctype + ) + target_doc.qty = -1 * flt(source_doc.qty - (returned_qty_map.get("qty") or 0)) + target_doc.stock_qty = -1 * flt(source_doc.stock_qty - (returned_qty_map.get("stock_qty") or 0)) target_doc.against_sales_order = source_doc.against_sales_order target_doc.against_sales_invoice = source_doc.against_sales_invoice @@ -348,9 +451,11 @@ def make_return_doc(doctype, source_name, target_doc=None): if default_warehouse_for_sales_return: target_doc.warehouse = default_warehouse_for_sales_return elif doctype == "Sales Invoice" or doctype == "POS Invoice": - returned_qty_map = get_returned_qty_map_for_row(source_doc.name, doctype) - target_doc.qty = -1 * flt(source_doc.qty - (returned_qty_map.get('qty') or 0)) - target_doc.stock_qty = -1 * flt(source_doc.stock_qty - (returned_qty_map.get('stock_qty') or 0)) + returned_qty_map = get_returned_qty_map_for_row( + source_parent.name, source_parent.customer, source_doc.name, doctype + ) + target_doc.qty = -1 * flt(source_doc.qty - (returned_qty_map.get("qty") or 0)) + target_doc.stock_qty = -1 * flt(source_doc.stock_qty - (returned_qty_map.get("stock_qty") or 0)) target_doc.sales_order = source_doc.sales_order target_doc.delivery_note = source_doc.delivery_note @@ -369,39 +474,56 @@ def make_return_doc(doctype, source_name, target_doc=None): def update_terms(source_doc, target_doc, source_parent): target_doc.payment_amount = -source_doc.payment_amount - doclist = get_mapped_doc(doctype, source_name, { - doctype: { - "doctype": doctype, - - "validation": { - "docstatus": ["=", 1], - } - }, - doctype +" Item": { - "doctype": doctype + " Item", - "field_map": { - "serial_no": "serial_no", - "batch_no": "batch_no" + doclist = get_mapped_doc( + doctype, + source_name, + { + doctype: { + "doctype": doctype, + "validation": { + "docstatus": ["=", 1], + }, }, - "postprocess": update_item + doctype + + " Item": { + "doctype": doctype + " Item", + "field_map": {"serial_no": "serial_no", "batch_no": "batch_no"}, + "postprocess": update_item, + }, + "Payment Schedule": {"doctype": "Payment Schedule", "postprocess": update_terms}, }, - "Payment Schedule": { - "doctype": "Payment Schedule", - "postprocess": update_terms - } - }, target_doc, set_missing_values) + target_doc, + set_missing_values, + ) + + doclist.set_onload("ignore_price_list", True) return doclist -def get_rate_for_return(voucher_type, voucher_no, item_code, return_against=None, - item_row=None, voucher_detail_no=None, sle=None): + +def get_rate_for_return( + voucher_type, + voucher_no, + item_code, + return_against=None, + item_row=None, + voucher_detail_no=None, + sle=None, +): if not return_against: return_against = frappe.get_cached_value(voucher_type, voucher_no, "return_against") return_against_item_field = get_return_against_item_fields(voucher_type) - filters = get_filters(voucher_type, voucher_no, voucher_detail_no, - return_against, item_code, return_against_item_field, item_row) + filters = get_filters( + voucher_type, + voucher_no, + voucher_detail_no, + return_against, + item_code, + return_against_item_field, + item_row, + ) if voucher_type in ("Purchase Receipt", "Purchase Invoice"): select_field = "incoming_rate" @@ -409,52 +531,65 @@ def get_rate_for_return(voucher_type, voucher_no, item_code, return_against=None select_field = "abs(stock_value_difference / actual_qty)" rate = flt(frappe.db.get_value("Stock Ledger Entry", filters, select_field)) - if not (rate and return_against) and voucher_type in ['Sales Invoice', 'Delivery Note']: - rate = frappe.db.get_value(f'{voucher_type} Item', voucher_detail_no, 'incoming_rate') + if not (rate and return_against) and voucher_type in ["Sales Invoice", "Delivery Note"]: + rate = frappe.db.get_value(f"{voucher_type} Item", voucher_detail_no, "incoming_rate") if not rate and sle: - rate = get_incoming_rate({ - "item_code": sle.item_code, - "warehouse": sle.warehouse, - "posting_date": sle.get('posting_date'), - "posting_time": sle.get('posting_time'), - "qty": sle.actual_qty, - "serial_no": sle.get('serial_no'), - "company": sle.company, - "voucher_type": sle.voucher_type, - "voucher_no": sle.voucher_no - }, raise_error_if_no_rate=False) + rate = get_incoming_rate( + { + "item_code": sle.item_code, + "warehouse": sle.warehouse, + "posting_date": sle.get("posting_date"), + "posting_time": sle.get("posting_time"), + "qty": sle.actual_qty, + "serial_no": sle.get("serial_no"), + "company": sle.company, + "voucher_type": sle.voucher_type, + "voucher_no": sle.voucher_no, + }, + raise_error_if_no_rate=False, + ) return rate + def get_return_against_item_fields(voucher_type): return_against_item_fields = { "Purchase Receipt": "purchase_receipt_item", "Purchase Invoice": "purchase_invoice_item", "Delivery Note": "dn_detail", - "Sales Invoice": "sales_invoice_item" + "Sales Invoice": "sales_invoice_item", } return return_against_item_fields[voucher_type] -def get_filters(voucher_type, voucher_no, voucher_detail_no, return_against, item_code, return_against_item_field, item_row): - filters = { - "voucher_type": voucher_type, - "voucher_no": return_against, - "item_code": item_code - } + +def get_filters( + voucher_type, + voucher_no, + voucher_detail_no, + return_against, + item_code, + return_against_item_field, + item_row, +): + filters = {"voucher_type": voucher_type, "voucher_no": return_against, "item_code": item_code} if item_row: reference_voucher_detail_no = item_row.get(return_against_item_field) else: - reference_voucher_detail_no = frappe.db.get_value(voucher_type + " Item", voucher_detail_no, return_against_item_field) + reference_voucher_detail_no = frappe.db.get_value( + voucher_type + " Item", voucher_detail_no, return_against_item_field + ) if reference_voucher_detail_no: filters["voucher_detail_no"] = reference_voucher_detail_no return filters + def get_returned_serial_nos(child_doc, parent_doc): from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos + return_ref_field = frappe.scrub(child_doc.doctype) if child_doc.doctype == "Delivery Note Item": return_ref_field = "dn_detail" @@ -463,10 +598,14 @@ def get_returned_serial_nos(child_doc, parent_doc): fields = ["`{0}`.`serial_no`".format("tab" + child_doc.doctype)] - filters = [[parent_doc.doctype, "return_against", "=", parent_doc.name], [parent_doc.doctype, "is_return", "=", 1], - [child_doc.doctype, return_ref_field, "=", child_doc.name], [parent_doc.doctype, "docstatus", "=", 1]] + filters = [ + [parent_doc.doctype, "return_against", "=", parent_doc.name], + [parent_doc.doctype, "is_return", "=", 1], + [child_doc.doctype, return_ref_field, "=", child_doc.name], + [parent_doc.doctype, "docstatus", "=", 1], + ] - for row in frappe.get_all(parent_doc.doctype, fields = fields, filters=filters): + for row in frappe.get_all(parent_doc.doctype, fields=fields, filters=filters): serial_nos.extend(get_serial_nos(row.serial_no)) return serial_nos diff --git a/erpnext/controllers/selling_controller.py b/erpnext/controllers/selling_controller.py index cc773b75963..8a26d9e2c89 100644 --- a/erpnext/controllers/selling_controller.py +++ b/erpnext/controllers/selling_controller.py @@ -16,9 +16,11 @@ from erpnext.stock.utils import get_incoming_rate class SellingController(StockController): + def __setup__(self): + self.flags.ignore_permlevel_for_fields = ["selling_price_list", "price_list_currency"] + def get_feed(self): - return _("To {0} | {1} {2}").format(self.customer_name, self.currency, - self.grand_total) + return _("To {0} | {1} {2}").format(self.customer_name, self.currency, self.grand_total) def onload(self): super(SellingController, self).onload() @@ -64,31 +66,43 @@ class SellingController(StockController): if customer: from erpnext.accounts.party import _get_party_details + fetch_payment_terms_template = False - if (self.get("__islocal") or - self.company != frappe.db.get_value(self.doctype, self.name, 'company')): + if self.get("__islocal") or self.company != frappe.db.get_value( + self.doctype, self.name, "company" + ): fetch_payment_terms_template = True - party_details = _get_party_details(customer, + party_details = _get_party_details( + customer, ignore_permissions=self.flags.ignore_permissions, - doctype=self.doctype, company=self.company, - posting_date=self.get('posting_date'), + doctype=self.doctype, + company=self.company, + posting_date=self.get("posting_date"), fetch_payment_terms_template=fetch_payment_terms_template, - party_address=self.customer_address, shipping_address=self.shipping_address_name) + party_address=self.customer_address, + shipping_address=self.shipping_address_name, + company_address=self.get("company_address"), + ) if not self.meta.get_field("sales_team"): party_details.pop("sales_team") self.update_if_missing(party_details) elif lead: from erpnext.crm.doctype.lead.lead import get_lead_details - self.update_if_missing(get_lead_details(lead, - posting_date=self.get('transaction_date') or self.get('posting_date'), - company=self.company)) - if self.get('taxes_and_charges') and not self.get('taxes') and not for_validate: - taxes = get_taxes_and_charges('Sales Taxes and Charges Template', self.taxes_and_charges) + self.update_if_missing( + get_lead_details( + lead, + posting_date=self.get("transaction_date") or self.get("posting_date"), + company=self.company, + ) + ) + + if self.get("taxes_and_charges") and not self.get("taxes") and not for_validate: + taxes = get_taxes_and_charges("Sales Taxes and Charges Template", self.taxes_and_charges) for tax in taxes: - self.append('taxes', tax) + self.append("taxes", tax) def set_price_list_and_item_details(self, for_validate=False): self.set_price_list_currency("Selling") @@ -97,12 +111,15 @@ class SellingController(StockController): def remove_shipping_charge(self): if self.shipping_rule: shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule) - existing_shipping_charge = self.get("taxes", { - "doctype": "Sales Taxes and Charges", - "charge_type": "Actual", - "account_head": shipping_rule.account, - "cost_center": shipping_rule.cost_center - }) + existing_shipping_charge = self.get( + "taxes", + { + "doctype": "Sales Taxes and Charges", + "charge_type": "Actual", + "account_head": shipping_rule.account, + "cost_center": shipping_rule.cost_center, + }, + ) if existing_shipping_charge: self.get("taxes").remove(existing_shipping_charge[-1]) self.calculate_taxes_and_totals() @@ -111,8 +128,9 @@ class SellingController(StockController): from frappe.utils import money_in_words if self.meta.get_field("base_in_words"): - base_amount = abs(self.base_grand_total - if self.is_rounded_total_disabled() else self.base_rounded_total) + base_amount = abs( + self.base_grand_total if self.is_rounded_total_disabled() else self.base_rounded_total + ) self.base_in_words = money_in_words(base_amount, self.company_currency) if self.meta.get_field("in_words"): @@ -123,15 +141,15 @@ class SellingController(StockController): if not self.meta.get_field("commission_rate"): return - self.round_floats_in( - self, ("amount_eligible_for_commission", "commission_rate") - ) + self.round_floats_in(self, ("amount_eligible_for_commission", "commission_rate")) if not (0 <= self.commission_rate <= 100.0): - throw("{} {}".format( - _(self.meta.get_label("commission_rate")), - _("must be between 0 and 100"), - )) + throw( + "{} {}".format( + _(self.meta.get_label("commission_rate")), + _("must be between 0 and 100"), + ) + ) self.amount_eligible_for_commission = sum( item.base_net_amount for item in self.items if item.grant_commission @@ -139,7 +157,7 @@ class SellingController(StockController): self.total_commission = flt( self.amount_eligible_for_commission * self.commission_rate / 100.0, - self.precision("total_commission") + self.precision("total_commission"), ) def calculate_contribution(self): @@ -153,12 +171,14 @@ class SellingController(StockController): sales_person.allocated_amount = flt( self.amount_eligible_for_commission * sales_person.allocated_percentage / 100.0, - self.precision("allocated_amount", sales_person)) + self.precision("allocated_amount", sales_person), + ) if sales_person.commission_rate: sales_person.incentives = flt( sales_person.allocated_amount * flt(sales_person.commission_rate) / 100.0, - self.precision("incentives", sales_person)) + self.precision("incentives", sales_person), + ) total += sales_person.allocated_percentage @@ -182,46 +202,43 @@ class SellingController(StockController): def validate_selling_price(self): def throw_message(idx, item_name, rate, ref_rate_field): - throw(_("""Row #{0}: Selling rate for item {1} is lower than its {2}. + throw( + _( + """Row #{0}: Selling rate for item {1} is lower than its {2}. Selling {3} should be atleast {4}.
Alternatively, you can disable selling price validation in {5} to bypass - this validation.""").format( - idx, - bold(item_name), - bold(ref_rate_field), - bold("net rate"), - bold(rate), - get_link_to_form("Selling Settings", "Selling Settings"), - ), title=_("Invalid Selling Price")) + this validation.""" + ).format( + idx, + bold(item_name), + bold(ref_rate_field), + bold("net rate"), + bold(rate), + get_link_to_form("Selling Settings", "Selling Settings"), + ), + title=_("Invalid Selling Price"), + ) - if ( - self.get("is_return") - or not frappe.db.get_single_value("Selling Settings", "validate_selling_price") + if self.get("is_return") or not frappe.db.get_single_value( + "Selling Settings", "validate_selling_price" ): return - is_internal_customer = self.get('is_internal_customer') + is_internal_customer = self.get("is_internal_customer") valuation_rate_map = {} for item in self.items: - if not item.item_code: + if not item.item_code or item.is_free_item: continue last_purchase_rate, is_stock_item = frappe.get_cached_value( "Item", item.item_code, ("last_purchase_rate", "is_stock_item") ) - last_purchase_rate_in_sales_uom = ( - last_purchase_rate * (item.conversion_factor or 1) - ) + last_purchase_rate_in_sales_uom = last_purchase_rate * (item.conversion_factor or 1) if flt(item.base_net_rate) < flt(last_purchase_rate_in_sales_uom): - throw_message( - item.idx, - item.item_name, - last_purchase_rate_in_sales_uom, - "last purchase rate" - ) + throw_message(item.idx, item.item_name, last_purchase_rate_in_sales_uom, "last purchase rate") if is_internal_customer or not is_stock_item: continue @@ -237,7 +254,8 @@ class SellingController(StockController): for valuation_rate in valuation_rate_map ) - valuation_rates = frappe.db.sql(f""" + valuation_rates = frappe.db.sql( + f""" select item_code, warehouse, valuation_rate from @@ -245,33 +263,26 @@ class SellingController(StockController): where ({" or ".join(or_conditions)}) and valuation_rate > 0 - """, as_dict=True) + """, + as_dict=True, + ) for rate in valuation_rates: valuation_rate_map[(rate.item_code, rate.warehouse)] = rate.valuation_rate for item in self.items: - if not item.item_code: + if not item.item_code or item.is_free_item: continue - last_valuation_rate = valuation_rate_map.get( - (item.item_code, item.warehouse) - ) + last_valuation_rate = valuation_rate_map.get((item.item_code, item.warehouse)) if not last_valuation_rate: continue - last_valuation_rate_in_sales_uom = ( - last_valuation_rate * (item.conversion_factor or 1) - ) + last_valuation_rate_in_sales_uom = last_valuation_rate * (item.conversion_factor or 1) if flt(item.base_net_rate) < flt(last_valuation_rate_in_sales_uom): - throw_message( - item.idx, - item.item_name, - last_valuation_rate_in_sales_uom, - "valuation rate" - ) + throw_message(item.idx, item.item_name, last_valuation_rate_in_sales_uom, "valuation rate") def get_item_list(self): il = [] @@ -283,68 +294,90 @@ class SellingController(StockController): for p in self.get("packed_items"): if p.parent_detail_docname == d.name and p.parent_item == d.item_code: # the packing details table's qty is already multiplied with parent's qty - il.append(frappe._dict({ - 'warehouse': p.warehouse or d.warehouse, - 'item_code': p.item_code, - 'qty': flt(p.qty), - 'uom': p.uom, - 'batch_no': cstr(p.batch_no).strip(), - 'serial_no': cstr(p.serial_no).strip(), - 'name': d.name, - 'target_warehouse': p.target_warehouse, - 'company': self.company, - 'voucher_type': self.doctype, - 'allow_zero_valuation': d.allow_zero_valuation_rate, - 'sales_invoice_item': d.get("sales_invoice_item"), - 'dn_detail': d.get("dn_detail"), - 'incoming_rate': p.get("incoming_rate") - })) + il.append( + frappe._dict( + { + "warehouse": p.warehouse or d.warehouse, + "item_code": p.item_code, + "qty": flt(p.qty), + "uom": p.uom, + "batch_no": cstr(p.batch_no).strip(), + "serial_no": cstr(p.serial_no).strip(), + "name": d.name, + "target_warehouse": p.target_warehouse, + "company": self.company, + "voucher_type": self.doctype, + "allow_zero_valuation": d.allow_zero_valuation_rate, + "sales_invoice_item": d.get("sales_invoice_item"), + "dn_detail": d.get("dn_detail"), + "incoming_rate": p.get("incoming_rate"), + } + ) + ) else: - il.append(frappe._dict({ - 'warehouse': d.warehouse, - 'item_code': d.item_code, - 'qty': d.stock_qty, - 'uom': d.uom, - 'stock_uom': d.stock_uom, - 'conversion_factor': d.conversion_factor, - 'batch_no': cstr(d.get("batch_no")).strip(), - 'serial_no': cstr(d.get("serial_no")).strip(), - 'name': d.name, - 'target_warehouse': d.target_warehouse, - 'company': self.company, - 'voucher_type': self.doctype, - 'allow_zero_valuation': d.allow_zero_valuation_rate, - 'sales_invoice_item': d.get("sales_invoice_item"), - 'dn_detail': d.get("dn_detail"), - 'incoming_rate': d.get("incoming_rate") - })) + il.append( + frappe._dict( + { + "warehouse": d.warehouse, + "item_code": d.item_code, + "qty": d.stock_qty, + "uom": d.uom, + "stock_uom": d.stock_uom, + "conversion_factor": d.conversion_factor, + "batch_no": cstr(d.get("batch_no")).strip(), + "serial_no": cstr(d.get("serial_no")).strip(), + "name": d.name, + "target_warehouse": d.target_warehouse, + "company": self.company, + "voucher_type": self.doctype, + "allow_zero_valuation": d.allow_zero_valuation_rate, + "sales_invoice_item": d.get("sales_invoice_item"), + "dn_detail": d.get("dn_detail"), + "incoming_rate": d.get("incoming_rate"), + } + ) + ) return il def has_product_bundle(self, item_code): - return frappe.db.sql("""select name from `tabProduct Bundle` - where new_item_code=%s and docstatus != 2""", item_code) + return frappe.db.sql( + """select name from `tabProduct Bundle` + where new_item_code=%s and docstatus != 2""", + item_code, + ) def get_already_delivered_qty(self, current_docname, so, so_detail): - delivered_via_dn = frappe.db.sql("""select sum(qty) from `tabDelivery Note Item` + delivered_via_dn = frappe.db.sql( + """select sum(qty) from `tabDelivery Note Item` where so_detail = %s and docstatus = 1 and against_sales_order = %s - and parent != %s""", (so_detail, so, current_docname)) + and parent != %s""", + (so_detail, so, current_docname), + ) - delivered_via_si = frappe.db.sql("""select sum(si_item.qty) + delivered_via_si = frappe.db.sql( + """select sum(si_item.qty) from `tabSales Invoice Item` si_item, `tabSales Invoice` si where si_item.parent = si.name and si.update_stock = 1 and si_item.so_detail = %s and si.docstatus = 1 and si_item.sales_order = %s - and si.name != %s""", (so_detail, so, current_docname)) + and si.name != %s""", + (so_detail, so, current_docname), + ) - total_delivered_qty = (flt(delivered_via_dn[0][0]) if delivered_via_dn else 0) \ - + (flt(delivered_via_si[0][0]) if delivered_via_si else 0) + total_delivered_qty = (flt(delivered_via_dn[0][0]) if delivered_via_dn else 0) + ( + flt(delivered_via_si[0][0]) if delivered_via_si else 0 + ) return total_delivered_qty def get_so_qty_and_warehouse(self, so_detail): - so_item = frappe.db.sql("""select qty, warehouse from `tabSales Order Item` - where name = %s and docstatus = 1""", so_detail, as_dict=1) + so_item = frappe.db.sql( + """select qty, warehouse from `tabSales Order Item` + where name = %s and docstatus = 1""", + so_detail, + as_dict=1, + ) so_qty = so_item and flt(so_item[0]["qty"]) or 0.0 so_warehouse = so_item and so_item[0]["warehouse"] or "" return so_qty, so_warehouse @@ -370,8 +403,9 @@ class SellingController(StockController): sales_order = frappe.get_doc("Sales Order", so) if sales_order.status in ["Closed", "Cancelled"]: - frappe.throw(_("{0} {1} is cancelled or closed").format(_("Sales Order"), so), - frappe.InvalidStatusError) + frappe.throw( + _("{0} {1} is cancelled or closed").format(_("Sales Order"), so), frappe.InvalidStatusError + ) sales_order.update_reserved_qty(so_item_rows) @@ -383,42 +417,52 @@ class SellingController(StockController): for d in items: if not self.get("return_against"): # Get incoming rate based on original item cost based on valuation method - qty = flt(d.get('stock_qty') or d.get('actual_qty')) + qty = flt(d.get("stock_qty") or d.get("actual_qty")) - if not d.incoming_rate: - d.incoming_rate = get_incoming_rate({ - "item_code": d.item_code, - "warehouse": d.warehouse, - "posting_date": self.get('posting_date') or self.get('transaction_date'), - "posting_time": self.get('posting_time') or nowtime(), - "qty": qty if cint(self.get("is_return")) else (-1 * qty), - "serial_no": d.get('serial_no'), - "company": self.company, - "voucher_type": self.doctype, - "voucher_no": self.name, - "allow_zero_valuation": d.get("allow_zero_valuation") - }, raise_error_if_no_rate=False) + if not (self.get("is_return") and d.incoming_rate): + d.incoming_rate = get_incoming_rate( + { + "item_code": d.item_code, + "warehouse": d.warehouse, + "posting_date": self.get("posting_date") or self.get("transaction_date"), + "posting_time": self.get("posting_time") or nowtime(), + "qty": qty if cint(self.get("is_return")) else (-1 * qty), + "serial_no": d.get("serial_no"), + "company": self.company, + "voucher_type": self.doctype, + "voucher_no": self.name, + "allow_zero_valuation": d.get("allow_zero_valuation"), + }, + raise_error_if_no_rate=False, + ) # For internal transfers use incoming rate as the valuation rate if self.is_internal_transfer(): if d.doctype == "Packed Item": - incoming_rate = flt(d.incoming_rate * d.conversion_factor, d.precision('incoming_rate')) + incoming_rate = flt(d.incoming_rate * d.conversion_factor, d.precision("incoming_rate")) if d.incoming_rate != incoming_rate: d.incoming_rate = incoming_rate else: - rate = flt(d.incoming_rate * d.conversion_factor, d.precision('rate')) + rate = flt(d.incoming_rate * d.conversion_factor, d.precision("rate")) if d.rate != rate: d.rate = rate + frappe.msgprint( + _( + "Row {0}: Item rate has been updated as per valuation rate since its an internal stock transfer" + ).format(d.idx), + alert=1, + ) - d.discount_percentage = 0 - d.discount_amount = 0 - frappe.msgprint(_("Row {0}: Item rate has been updated as per valuation rate since its an internal stock transfer") - .format(d.idx), alert=1) + d.discount_percentage = 0.0 + d.discount_amount = 0.0 + d.margin_rate_or_amount = 0.0 elif self.get("return_against"): # Get incoming rate of return entry from reference document # based on original item cost as per valuation method - d.incoming_rate = get_rate_for_return(self.doctype, self.name, d.item_code, self.return_against, item_row=d) + d.incoming_rate = get_rate_for_return( + self.doctype, self.name, d.item_code, self.return_against, item_row=d + ) def update_stock_ledger(self): self.update_reserved_qty() @@ -427,63 +471,66 @@ class SellingController(StockController): # Loop over items and packed items table for d in self.get_item_list(): if frappe.get_cached_value("Item", d.item_code, "is_stock_item") == 1 and flt(d.qty): - if flt(d.conversion_factor)==0.0: - d.conversion_factor = get_conversion_factor(d.item_code, d.uom).get("conversion_factor") or 1.0 + if flt(d.conversion_factor) == 0.0: + d.conversion_factor = ( + get_conversion_factor(d.item_code, d.uom).get("conversion_factor") or 1.0 + ) # On cancellation or return entry submission, make stock ledger entry for # target warehouse first, to update serial no values properly - if d.warehouse and ((not cint(self.is_return) and self.docstatus==1) - or (cint(self.is_return) and self.docstatus==2)): - sl_entries.append(self.get_sle_for_source_warehouse(d)) + if d.warehouse and ( + (not cint(self.is_return) and self.docstatus == 1) + or (cint(self.is_return) and self.docstatus == 2) + ): + sl_entries.append(self.get_sle_for_source_warehouse(d)) if d.target_warehouse: sl_entries.append(self.get_sle_for_target_warehouse(d)) - if d.warehouse and ((not cint(self.is_return) and self.docstatus==2) - or (cint(self.is_return) and self.docstatus==1)): - sl_entries.append(self.get_sle_for_source_warehouse(d)) + if d.warehouse and ( + (not cint(self.is_return) and self.docstatus == 2) + or (cint(self.is_return) and self.docstatus == 1) + ): + sl_entries.append(self.get_sle_for_source_warehouse(d)) self.make_sl_entries(sl_entries) def get_sle_for_source_warehouse(self, item_row): - sle = self.get_sl_entries(item_row, { - "actual_qty": -1*flt(item_row.qty), - "incoming_rate": item_row.incoming_rate, - "recalculate_rate": cint(self.is_return) - }) + sle = self.get_sl_entries( + item_row, + { + "actual_qty": -1 * flt(item_row.qty), + "incoming_rate": item_row.incoming_rate, + "recalculate_rate": cint(self.is_return), + }, + ) if item_row.target_warehouse and not cint(self.is_return): sle.dependant_sle_voucher_detail_no = item_row.name return sle def get_sle_for_target_warehouse(self, item_row): - sle = self.get_sl_entries(item_row, { - "actual_qty": flt(item_row.qty), - "warehouse": item_row.target_warehouse - }) + sle = self.get_sl_entries( + item_row, {"actual_qty": flt(item_row.qty), "warehouse": item_row.target_warehouse} + ) if self.docstatus == 1: if not cint(self.is_return): - sle.update({ - "incoming_rate": item_row.incoming_rate, - "recalculate_rate": 1 - }) + sle.update({"incoming_rate": item_row.incoming_rate, "recalculate_rate": 1}) else: - sle.update({ - "outgoing_rate": item_row.incoming_rate - }) + sle.update({"outgoing_rate": item_row.incoming_rate}) if item_row.warehouse: sle.dependant_sle_voucher_detail_no = item_row.name return sle def set_po_nos(self, for_validate=False): - if self.doctype == 'Sales Invoice' and hasattr(self, "items"): + if self.doctype == "Sales Invoice" and hasattr(self, "items"): if for_validate and self.po_no: return self.set_pos_for_sales_invoice() - if self.doctype == 'Delivery Note' and hasattr(self, "items"): + if self.doctype == "Delivery Note" and hasattr(self, "items"): if for_validate and self.po_no: return self.set_pos_for_delivery_note() @@ -492,34 +539,39 @@ class SellingController(StockController): po_nos = [] if self.po_no: po_nos.append(self.po_no) - self.get_po_nos('Sales Order', 'sales_order', po_nos) - self.get_po_nos('Delivery Note', 'delivery_note', po_nos) - self.po_no = ', '.join(list(set(x.strip() for x in ','.join(po_nos).split(',')))) + self.get_po_nos("Sales Order", "sales_order", po_nos) + self.get_po_nos("Delivery Note", "delivery_note", po_nos) + self.po_no = ", ".join(list(set(x.strip() for x in ",".join(po_nos).split(",")))) def set_pos_for_delivery_note(self): po_nos = [] if self.po_no: po_nos.append(self.po_no) - self.get_po_nos('Sales Order', 'against_sales_order', po_nos) - self.get_po_nos('Sales Invoice', 'against_sales_invoice', po_nos) - self.po_no = ', '.join(list(set(x.strip() for x in ','.join(po_nos).split(',')))) + self.get_po_nos("Sales Order", "against_sales_order", po_nos) + self.get_po_nos("Sales Invoice", "against_sales_invoice", po_nos) + self.po_no = ", ".join(list(set(x.strip() for x in ",".join(po_nos).split(",")))) def get_po_nos(self, ref_doctype, ref_fieldname, po_nos): doc_list = list(set(d.get(ref_fieldname) for d in self.items if d.get(ref_fieldname))) if doc_list: - po_nos += [d.po_no for d in frappe.get_all(ref_doctype, 'po_no', filters = {'name': ('in', doc_list)}) if d.get('po_no')] + po_nos += [ + d.po_no + for d in frappe.get_all(ref_doctype, "po_no", filters={"name": ("in", doc_list)}) + if d.get("po_no") + ] def set_gross_profit(self): if self.doctype in ["Sales Order", "Quotation"]: for item in self.items: - item.gross_profit = flt(((item.base_rate - item.valuation_rate) * item.stock_qty), self.precision("amount", item)) - + item.gross_profit = flt( + ((item.base_rate - item.valuation_rate) * item.stock_qty), self.precision("amount", item) + ) def set_customer_address(self): address_dict = { - 'customer_address': 'address_display', - 'shipping_address_name': 'shipping_address', - 'company_address': 'company_address_display' + "customer_address": "address_display", + "shipping_address_name": "shipping_address", + "company_address": "company_address_display", } for address_field, address_display_field in address_dict.items(): @@ -535,24 +587,40 @@ class SellingController(StockController): if self.doctype == "POS Invoice": return - for d in self.get('items'): + for d in self.get("items"): if self.doctype == "Sales Invoice": - stock_items = [d.item_code, d.description, d.warehouse, d.sales_order or d.delivery_note, d.batch_no or ''] + stock_items = [ + d.item_code, + d.description, + d.warehouse, + d.sales_order or d.delivery_note, + d.batch_no or "", + ] non_stock_items = [d.item_code, d.description, d.sales_order or d.delivery_note] elif self.doctype == "Delivery Note": - stock_items = [d.item_code, d.description, d.warehouse, d.against_sales_order or d.against_sales_invoice, d.batch_no or ''] - non_stock_items = [d.item_code, d.description, d.against_sales_order or d.against_sales_invoice] + stock_items = [ + d.item_code, + d.description, + d.warehouse, + d.against_sales_order or d.against_sales_invoice, + d.batch_no or "", + ] + non_stock_items = [ + d.item_code, + d.description, + d.against_sales_order or d.against_sales_invoice, + ] elif self.doctype in ["Sales Order", "Quotation"]: - stock_items = [d.item_code, d.description, d.warehouse, ''] + stock_items = [d.item_code, d.description, d.warehouse, ""] non_stock_items = [d.item_code, d.description] + duplicate_items_msg = _("Item {0} entered multiple times.").format(frappe.bold(d.item_code)) + duplicate_items_msg += "
" + duplicate_items_msg += _("Please enable {} in {} to allow same item in multiple rows").format( + frappe.bold("Allow Item to Be Added Multiple Times in a Transaction"), + get_link_to_form("Selling Settings", "Selling Settings"), + ) if frappe.db.get_value("Item", d.item_code, "is_stock_item") == 1: - duplicate_items_msg = _("Item {0} entered multiple times.").format(frappe.bold(d.item_code)) - duplicate_items_msg += "
" - duplicate_items_msg += _("Please enable {} in {} to allow same item in multiple rows").format( - frappe.bold("Allow Item to Be Added Multiple Times in a Transaction"), - get_link_to_form("Selling Settings", "Selling Settings") - ) if stock_items in check_list: frappe.throw(duplicate_items_msg) else: @@ -569,22 +637,26 @@ class SellingController(StockController): for d in items: if d.get("target_warehouse") and d.get("warehouse") == d.get("target_warehouse"): warehouse = frappe.bold(d.get("target_warehouse")) - frappe.throw(_("Row {0}: Delivery Warehouse ({1}) and Customer Warehouse ({2}) can not be same") - .format(d.idx, warehouse, warehouse)) + frappe.throw( + _("Row {0}: Delivery Warehouse ({1}) and Customer Warehouse ({2}) can not be same").format( + d.idx, warehouse, warehouse + ) + ) if not self.get("is_internal_customer") and any(d.get("target_warehouse") for d in items): msg = _("Target Warehouse is set for some items but the customer is not an internal customer.") msg += " " + _("This {} will be treated as material transfer.").format(_(self.doctype)) frappe.msgprint(msg, title="Internal Transfer", alert=True) - def validate_items(self): # validate items to see if they have is_sales_item enabled from erpnext.controllers.buying_controller import validate_item_type + validate_item_type(self, "is_sales_item", "sales") + def set_default_income_account_for_item(obj): for d in obj.get("items"): if d.item_code: if getattr(d, "income_account", None): - set_item_default(d.item_code, obj.company, 'income_account', d.income_account) + set_item_default(d.item_code, obj.company, "income_account", d.income_account) diff --git a/erpnext/controllers/status_updater.py b/erpnext/controllers/status_updater.py index 76a7cdab516..517e080c972 100644 --- a/erpnext/controllers/status_updater.py +++ b/erpnext/controllers/status_updater.py @@ -8,12 +8,15 @@ from frappe.model.document import Document from frappe.utils import comma_or, flt, getdate, now, nowdate -class OverAllowanceError(frappe.ValidationError): pass +class OverAllowanceError(frappe.ValidationError): + pass + def validate_status(status, options): if status not in options: frappe.throw(_("Status must be one of {0}").format(comma_or(options))) + status_map = { "Lead": [ ["Lost Quotation", "has_lost_quotation"], @@ -26,31 +29,53 @@ status_map = { ["Lost", "has_lost_quotation"], ["Quotation", "has_active_quotation"], ["Converted", "has_ordered_quotation"], - ["Closed", "eval:self.status=='Closed'"] + ["Closed", "eval:self.status=='Closed'"], ], "Quotation": [ ["Draft", None], ["Open", "eval:self.docstatus==1"], ["Lost", "eval:self.status=='Lost'"], - ["Ordered", "has_sales_order"], + ["Partially Ordered", "is_partially_ordered"], + ["Ordered", "is_fully_ordered"], ["Cancelled", "eval:self.docstatus==2"], ], "Sales Order": [ ["Draft", None], - ["To Deliver and Bill", "eval:self.per_delivered < 100 and self.per_billed < 100 and self.docstatus == 1"], - ["To Bill", "eval:(self.per_delivered == 100 or self.skip_delivery_note) and self.per_billed < 100 and self.docstatus == 1"], - ["To Deliver", "eval:self.per_delivered < 100 and self.per_billed == 100 and self.docstatus == 1 and not self.skip_delivery_note"], - ["Completed", "eval:(self.per_delivered == 100 or self.skip_delivery_note) and self.per_billed == 100 and self.docstatus == 1"], + [ + "To Deliver and Bill", + "eval:self.per_delivered < 100 and self.per_billed < 100 and self.docstatus == 1", + ], + [ + "To Bill", + "eval:(self.per_delivered == 100 or self.skip_delivery_note) and self.per_billed < 100 and self.docstatus == 1", + ], + [ + "To Deliver", + "eval:self.per_delivered < 100 and self.per_billed == 100 and self.docstatus == 1 and not self.skip_delivery_note", + ], + [ + "Completed", + "eval:(self.per_delivered == 100 or self.skip_delivery_note) and self.per_billed == 100 and self.docstatus == 1", + ], ["Cancelled", "eval:self.docstatus==2"], ["Closed", "eval:self.status=='Closed'"], ["On Hold", "eval:self.status=='On Hold'"], ], "Purchase Order": [ ["Draft", None], - ["To Receive and Bill", "eval:self.per_received < 100 and self.per_billed < 100 and self.docstatus == 1"], + [ + "To Receive and Bill", + "eval:self.per_received < 100 and self.per_billed < 100 and self.docstatus == 1", + ], ["To Bill", "eval:self.per_received >= 100 and self.per_billed < 100 and self.docstatus == 1"], - ["To Receive", "eval:self.per_received < 100 and self.per_billed == 100 and self.docstatus == 1"], - ["Completed", "eval:self.per_received >= 100 and self.per_billed == 100 and self.docstatus == 1"], + [ + "To Receive", + "eval:self.per_received < 100 and self.per_billed == 100 and self.docstatus == 1", + ], + [ + "Completed", + "eval:self.per_received >= 100 and self.per_billed == 100 and self.docstatus == 1", + ], ["Delivered", "eval:self.status=='Delivered'"], ["Cancelled", "eval:self.docstatus==2"], ["On Hold", "eval:self.status=='On Hold'"], @@ -77,18 +102,39 @@ status_map = { ["Stopped", "eval:self.status == 'Stopped'"], ["Cancelled", "eval:self.docstatus == 2"], ["Pending", "eval:self.status != 'Stopped' and self.per_ordered == 0 and self.docstatus == 1"], - ["Ordered", "eval:self.status != 'Stopped' and self.per_ordered == 100 and self.docstatus == 1 and self.material_request_type == 'Purchase'"], - ["Transferred", "eval:self.status != 'Stopped' and self.per_ordered == 100 and self.docstatus == 1 and self.material_request_type == 'Material Transfer'"], - ["Issued", "eval:self.status != 'Stopped' and self.per_ordered == 100 and self.docstatus == 1 and self.material_request_type == 'Material Issue'"], - ["Received", "eval:self.status != 'Stopped' and self.per_received == 100 and self.docstatus == 1 and self.material_request_type == 'Purchase'"], - ["Partially Received", "eval:self.status != 'Stopped' and self.per_received > 0 and self.per_received < 100 and self.docstatus == 1 and self.material_request_type == 'Purchase'"], - ["Partially Ordered", "eval:self.status != 'Stopped' and self.per_ordered < 100 and self.per_ordered > 0 and self.docstatus == 1"], - ["Manufactured", "eval:self.status != 'Stopped' and self.per_ordered == 100 and self.docstatus == 1 and self.material_request_type == 'Manufacture'"] + [ + "Ordered", + "eval:self.status != 'Stopped' and self.per_ordered == 100 and self.docstatus == 1 and self.material_request_type == 'Purchase'", + ], + [ + "Transferred", + "eval:self.status != 'Stopped' and self.per_ordered == 100 and self.docstatus == 1 and self.material_request_type == 'Material Transfer'", + ], + [ + "Issued", + "eval:self.status != 'Stopped' and self.per_ordered == 100 and self.docstatus == 1 and self.material_request_type == 'Material Issue'", + ], + [ + "Received", + "eval:self.status != 'Stopped' and self.per_received == 100 and self.docstatus == 1 and self.material_request_type == 'Purchase'", + ], + [ + "Partially Received", + "eval:self.status != 'Stopped' and self.per_received > 0 and self.per_received < 100 and self.docstatus == 1 and self.material_request_type == 'Purchase'", + ], + [ + "Partially Ordered", + "eval:self.status != 'Stopped' and self.per_ordered < 100 and self.per_ordered > 0 and self.docstatus == 1", + ], + [ + "Manufactured", + "eval:self.status != 'Stopped' and self.per_ordered == 100 and self.docstatus == 1 and self.material_request_type == 'Manufacture'", + ], ], "Bank Transaction": [ ["Unreconciled", "eval:self.docstatus == 1 and self.unallocated_amount>0"], ["Reconciled", "eval:self.docstatus == 1 and self.unallocated_amount<=0"], - ["Cancelled", "eval:self.docstatus == 2"] + ["Cancelled", "eval:self.docstatus == 2"], ], "POS Opening Entry": [ ["Draft", None], @@ -106,15 +152,16 @@ status_map = { "Transaction Deletion Record": [ ["Draft", None], ["Completed", "eval:self.docstatus == 1"], - ] + ], } + class StatusUpdater(Document): """ - Updates the status of the calling records - Delivery Note: Update Delivered Qty, Update Percent and Validate over delivery - Sales Invoice: Update Billed Amt, Update Percent and Validate over billing - Installation Note: Update Installed Qty, Update Percent Qty and Validate over installation + Updates the status of the calling records + Delivery Note: Update Delivered Qty, Update Percent and Validate over delivery + Sales Invoice: Update Billed Amt, Update Percent and Validate over billing + Installation Note: Update Installed Qty, Update Percent Qty and Validate over installation """ def update_prevdoc_status(self): @@ -123,8 +170,8 @@ class StatusUpdater(Document): def set_status(self, update=False, status=None, update_modified=True): if self.is_new(): - if self.get('amended_from'): - self.status = 'Draft' + if self.get("amended_from"): + self.status = "Draft" return if self.doctype in status_map: @@ -139,20 +186,33 @@ class StatusUpdater(Document): self.status = s[0] break elif s[1].startswith("eval:"): - if frappe.safe_eval(s[1][5:], None, { "self": self.as_dict(), "getdate": getdate, - "nowdate": nowdate, "get_value": frappe.db.get_value }): + if frappe.safe_eval( + s[1][5:], + None, + { + "self": self.as_dict(), + "getdate": getdate, + "nowdate": nowdate, + "get_value": frappe.db.get_value, + }, + ): self.status = s[0] break elif getattr(self, s[1])(): self.status = s[0] break - if self.status != _status and self.status not in ("Cancelled", "Partially Ordered", - "Ordered", "Issued", "Transferred"): + if self.status != _status and self.status not in ( + "Cancelled", + "Partially Ordered", + "Ordered", + "Issued", + "Transferred", + ): self.add_comment("Label", _(self.status)) if update: - self.db_set('status', self.status, update_modified = update_modified) + self.db_set("status", self.status, update_modified=update_modified) def validate_qty(self): """Validates qty at row level""" @@ -167,57 +227,78 @@ class StatusUpdater(Document): # get unique transactions to update for d in self.get_all_children(): - if hasattr(d, 'qty') and d.qty < 0 and not self.get('is_return'): + if hasattr(d, "qty") and d.qty < 0 and not self.get("is_return"): frappe.throw(_("For an item {0}, quantity must be positive number").format(d.item_code)) - if hasattr(d, 'qty') and d.qty > 0 and self.get('is_return'): + if hasattr(d, "qty") and d.qty > 0 and self.get("is_return"): frappe.throw(_("For an item {0}, quantity must be negative number").format(d.item_code)) - if d.doctype == args['source_dt'] and d.get(args["join_field"]): - args['name'] = d.get(args['join_field']) + if d.doctype == args["source_dt"] and d.get(args["join_field"]): + args["name"] = d.get(args["join_field"]) # get all qty where qty > target_field - item = frappe.db.sql("""select item_code, `{target_ref_field}`, + item = frappe.db.sql( + """select item_code, `{target_ref_field}`, `{target_field}`, parenttype, parent from `tab{target_dt}` where `{target_ref_field}` < `{target_field}` - and name=%s and docstatus=1""".format(**args), - args['name'], as_dict=1) + and name=%s and docstatus=1""".format( + **args + ), + args["name"], + as_dict=1, + ) if item: item = item[0] - item['idx'] = d.idx - item['target_ref_field'] = args['target_ref_field'].replace('_', ' ') + item["idx"] = d.idx + item["target_ref_field"] = args["target_ref_field"].replace("_", " ") # if not item[args['target_ref_field']]: # msgprint(_("Note: System will not check over-delivery and over-booking for Item {0} as quantity or amount is 0").format(item.item_code)) - if args.get('no_allowance'): - item['reduce_by'] = item[args['target_field']] - item[args['target_ref_field']] - if item['reduce_by'] > .01: + if args.get("no_allowance"): + item["reduce_by"] = item[args["target_field"]] - item[args["target_ref_field"]] + if item["reduce_by"] > 0.01: self.limits_crossed_error(args, item, "qty") - elif item[args['target_ref_field']]: + elif item[args["target_ref_field"]]: self.check_overflow_with_allowance(item, args) def check_overflow_with_allowance(self, item, args): """ - Checks if there is overflow condering a relaxation allowance + Checks if there is overflow condering a relaxation allowance """ - qty_or_amount = "qty" if "qty" in args['target_ref_field'] else "amount" + qty_or_amount = "qty" if "qty" in args["target_ref_field"] else "amount" # check if overflow is within allowance - allowance, self.item_allowance, self.global_qty_allowance, self.global_amount_allowance = \ - get_allowance_for(item['item_code'], self.item_allowance, - self.global_qty_allowance, self.global_amount_allowance, qty_or_amount) + ( + allowance, + self.item_allowance, + self.global_qty_allowance, + self.global_amount_allowance, + ) = get_allowance_for( + item["item_code"], + self.item_allowance, + self.global_qty_allowance, + self.global_amount_allowance, + qty_or_amount, + ) - role_allowed_to_over_deliver_receive = frappe.db.get_single_value('Stock Settings', 'role_allowed_to_over_deliver_receive') - role_allowed_to_over_bill = frappe.db.get_single_value('Accounts Settings', 'role_allowed_to_over_bill') - role = role_allowed_to_over_deliver_receive if qty_or_amount == 'qty' else role_allowed_to_over_bill + role_allowed_to_over_deliver_receive = frappe.db.get_single_value( + "Stock Settings", "role_allowed_to_over_deliver_receive" + ) + role_allowed_to_over_bill = frappe.db.get_single_value( + "Accounts Settings", "role_allowed_to_over_bill" + ) + role = ( + role_allowed_to_over_deliver_receive if qty_or_amount == "qty" else role_allowed_to_over_bill + ) - overflow_percent = ((item[args['target_field']] - item[args['target_ref_field']]) / - item[args['target_ref_field']]) * 100 + overflow_percent = ( + (item[args["target_field"]] - item[args["target_ref_field"]]) / item[args["target_ref_field"]] + ) * 100 if overflow_percent - allowance > 0.01: - item['max_allowed'] = flt(item[args['target_ref_field']] * (100+allowance)/100) - item['reduce_by'] = item[args['target_field']] - item['max_allowed'] + item["max_allowed"] = flt(item[args["target_ref_field"]] * (100 + allowance) / 100) + item["reduce_by"] = item[args["target_field"]] - item["max_allowed"] if role not in frappe.get_roles(): self.limits_crossed_error(args, item, qty_or_amount) @@ -225,45 +306,55 @@ class StatusUpdater(Document): self.warn_about_bypassing_with_role(item, qty_or_amount, role) def limits_crossed_error(self, args, item, qty_or_amount): - '''Raise exception for limits crossed''' + """Raise exception for limits crossed""" if qty_or_amount == "qty": - action_msg = _('To allow over receipt / delivery, update "Over Receipt/Delivery Allowance" in Stock Settings or the Item.') + action_msg = _( + 'To allow over receipt / delivery, update "Over Receipt/Delivery Allowance" in Stock Settings or the Item.' + ) else: - action_msg = _('To allow over billing, update "Over Billing Allowance" in Accounts Settings or the Item.') + action_msg = _( + 'To allow over billing, update "Over Billing Allowance" in Accounts Settings or the Item.' + ) - frappe.throw(_('This document is over limit by {0} {1} for item {4}. Are you making another {3} against the same {2}?') - .format( + frappe.throw( + _( + "This document is over limit by {0} {1} for item {4}. Are you making another {3} against the same {2}?" + ).format( frappe.bold(_(item["target_ref_field"].title())), frappe.bold(item["reduce_by"]), - frappe.bold(_(args.get('target_dt'))), + frappe.bold(_(args.get("target_dt"))), frappe.bold(_(self.doctype)), - frappe.bold(item.get('item_code')) - ) + '
' + action_msg, OverAllowanceError, title = _('Limit Crossed')) + frappe.bold(item.get("item_code")), + ) + + "
" + + action_msg, + OverAllowanceError, + title=_("Limit Crossed"), + ) def warn_about_bypassing_with_role(self, item, qty_or_amount, role): action = _("Over Receipt/Delivery") if qty_or_amount == "qty" else _("Overbilling") - msg = (_("{} of {} {} ignored for item {} because you have {} role.") - .format( - action, - _(item["target_ref_field"].title()), - frappe.bold(item["reduce_by"]), - frappe.bold(item.get('item_code')), - role) - ) + msg = _("{} of {} {} ignored for item {} because you have {} role.").format( + action, + _(item["target_ref_field"].title()), + frappe.bold(item["reduce_by"]), + frappe.bold(item.get("item_code")), + role, + ) frappe.msgprint(msg, indicator="orange", alert=True) def update_qty(self, update_modified=True): """Updates qty or amount at row level - :param update_modified: If true, updates `modified` and `modified_by` for target parent doc + :param update_modified: If true, updates `modified` and `modified_by` for target parent doc """ for args in self.status_updater: # condition to include current record (if submit or no if cancel) if self.docstatus == 1: - args['cond'] = ' or parent="%s"' % self.name.replace('"', '\"') + args["cond"] = ' or parent="%s"' % self.name.replace('"', '"') else: - args['cond'] = ' and parent!="%s"' % self.name.replace('"', '\"') + args["cond"] = ' and parent!="%s"' % self.name.replace('"', '"') self._update_children(args, update_modified) @@ -273,56 +364,73 @@ class StatusUpdater(Document): def _update_children(self, args, update_modified): """Update quantities or amount in child table""" for d in self.get_all_children(): - if d.doctype != args['source_dt']: + if d.doctype != args["source_dt"]: continue self._update_modified(args, update_modified) # updates qty in the child table - args['detail_id'] = d.get(args['join_field']) + args["detail_id"] = d.get(args["join_field"]) - args['second_source_condition'] = "" - if args.get('second_source_dt') and args.get('second_source_field') \ - and args.get('second_join_field'): + args["second_source_condition"] = "" + if ( + args.get("second_source_dt") + and args.get("second_source_field") + and args.get("second_join_field") + ): if not args.get("second_source_extra_cond"): args["second_source_extra_cond"] = "" - args['second_source_condition'] = frappe.db.sql(""" select ifnull((select sum(%(second_source_field)s) + args["second_source_condition"] = frappe.db.sql( + """ select ifnull((select sum(%(second_source_field)s) from `tab%(second_source_dt)s` where `%(second_join_field)s`="%(detail_id)s" and (`tab%(second_source_dt)s`.docstatus=1) - %(second_source_extra_cond)s), 0) """ % args)[0][0] + %(second_source_extra_cond)s), 0) """ + % args + )[0][0] - if args['detail_id']: - if not args.get("extra_cond"): args["extra_cond"] = "" + if args["detail_id"]: + if not args.get("extra_cond"): + args["extra_cond"] = "" - args["source_dt_value"] = frappe.db.sql(""" + args["source_dt_value"] = ( + frappe.db.sql( + """ (select ifnull(sum(%(source_field)s), 0) from `tab%(source_dt)s` where `%(join_field)s`="%(detail_id)s" and (docstatus=1 %(cond)s) %(extra_cond)s) - """ % args)[0][0] or 0.0 + """ + % args + )[0][0] + or 0.0 + ) - if args['second_source_condition']: - args["source_dt_value"] += flt(args['second_source_condition']) + if args["second_source_condition"]: + args["source_dt_value"] += flt(args["second_source_condition"]) - frappe.db.sql("""update `tab%(target_dt)s` + frappe.db.sql( + """update `tab%(target_dt)s` set %(target_field)s = %(source_dt_value)s %(update_modified)s - where name='%(detail_id)s'""" % args) + where name='%(detail_id)s'""" + % args + ) def _update_percent_field_in_targets(self, args, update_modified=True): """Update percent field in parent transaction""" - if args.get('percent_join_field_parent'): + if args.get("percent_join_field_parent"): # if reference to target doc where % is to be updated, is # in source doc's parent form, consider percent_join_field_parent - args['name'] = self.get(args['percent_join_field_parent']) + args["name"] = self.get(args["percent_join_field_parent"]) self._update_percent_field(args, update_modified) else: - distinct_transactions = set(d.get(args['percent_join_field']) - for d in self.get_all_children(args['source_dt'])) + distinct_transactions = set( + d.get(args["percent_join_field"]) for d in self.get_all_children(args["source_dt"]) + ) for name in distinct_transactions: if name: - args['name'] = name + args["name"] = name self._update_percent_field(args, update_modified) def _update_percent_field(self, args, update_modified=True): @@ -330,23 +438,29 @@ class StatusUpdater(Document): self._update_modified(args, update_modified) - if args.get('target_parent_field'): - frappe.db.sql("""update `tab%(target_parent_dt)s` + if args.get("target_parent_field"): + frappe.db.sql( + """update `tab%(target_parent_dt)s` set %(target_parent_field)s = round( ifnull((select ifnull(sum(if(abs(%(target_ref_field)s) > abs(%(target_field)s), abs(%(target_field)s), abs(%(target_ref_field)s))), 0) / sum(abs(%(target_ref_field)s)) * 100 from `tab%(target_dt)s` where parent="%(name)s" having sum(abs(%(target_ref_field)s)) > 0), 0), 6) %(update_modified)s - where name='%(name)s'""" % args) + where name='%(name)s'""" + % args + ) # update field - if args.get('status_field'): - frappe.db.sql("""update `tab%(target_parent_dt)s` + if args.get("status_field"): + frappe.db.sql( + """update `tab%(target_parent_dt)s` set %(status_field)s = if(%(target_parent_field)s<0.001, 'Not %(keyword)s', if(%(target_parent_field)s>=99.999999, 'Fully %(keyword)s', 'Partly %(keyword)s')) - where name='%(name)s'""" % args) + where name='%(name)s'""" + % args + ) if update_modified: target = frappe.get_doc(args["target_parent_dt"], args["name"]) @@ -355,22 +469,24 @@ class StatusUpdater(Document): def _update_modified(self, args, update_modified): if not update_modified: - args['update_modified'] = '' + args["update_modified"] = "" return - args['update_modified'] = ', modified = {0}, modified_by = {1}'.format( - frappe.db.escape(now()), - frappe.db.escape(frappe.session.user) + args["update_modified"] = ", modified = {0}, modified_by = {1}".format( + frappe.db.escape(now()), frappe.db.escape(frappe.session.user) ) def update_billing_status_for_zero_amount_refdoc(self, ref_dt): ref_fieldname = frappe.scrub(ref_dt) - ref_docs = [item.get(ref_fieldname) for item in (self.get('items') or []) if item.get(ref_fieldname)] + ref_docs = [ + item.get(ref_fieldname) for item in (self.get("items") or []) if item.get(ref_fieldname) + ] if not ref_docs: return - zero_amount_refdocs = frappe.db.sql_list(""" + zero_amount_refdocs = frappe.db.sql_list( + """ SELECT name from @@ -379,52 +495,97 @@ class StatusUpdater(Document): docstatus = 1 and base_net_total = 0 and name in %(ref_docs)s - """.format(ref_dt=ref_dt), { - 'ref_docs': ref_docs - }) + """.format( + ref_dt=ref_dt + ), + {"ref_docs": ref_docs}, + ) if zero_amount_refdocs: self.update_billing_status(zero_amount_refdocs, ref_dt, ref_fieldname) def update_billing_status(self, zero_amount_refdoc, ref_dt, ref_fieldname): for ref_dn in zero_amount_refdoc: - ref_doc_qty = flt(frappe.db.sql("""select ifnull(sum(qty), 0) from `tab%s Item` - where parent=%s""" % (ref_dt, '%s'), (ref_dn))[0][0]) + ref_doc_qty = flt( + frappe.db.sql( + """select ifnull(sum(qty), 0) from `tab%s Item` + where parent=%s""" + % (ref_dt, "%s"), + (ref_dn), + )[0][0] + ) - billed_qty = flt(frappe.db.sql("""select ifnull(sum(qty), 0) - from `tab%s Item` where %s=%s and docstatus=1""" % - (self.doctype, ref_fieldname, '%s'), (ref_dn))[0][0]) + billed_qty = flt( + frappe.db.sql( + """select ifnull(sum(qty), 0) + from `tab%s Item` where %s=%s and docstatus=1""" + % (self.doctype, ref_fieldname, "%s"), + (ref_dn), + )[0][0] + ) per_billed = (min(ref_doc_qty, billed_qty) / ref_doc_qty) * 100 ref_doc = frappe.get_doc(ref_dt, ref_dn) ref_doc.db_set("per_billed", per_billed) + + # set billling status + if hasattr(ref_doc, "billing_status"): + if ref_doc.per_billed < 0.001: + ref_doc.db_set("billing_status", "Not Billed") + elif ref_doc.per_billed > 99.999999: + ref_doc.db_set("billing_status", "Fully Billed") + else: + ref_doc.db_set("billing_status", "Partly Billed") + ref_doc.set_status(update=True) -def get_allowance_for(item_code, item_allowance=None, global_qty_allowance=None, global_amount_allowance=None, qty_or_amount="qty"): + +def get_allowance_for( + item_code, + item_allowance=None, + global_qty_allowance=None, + global_amount_allowance=None, + qty_or_amount="qty", +): """ - Returns the allowance for the item, if not set, returns global allowance + Returns the allowance for the item, if not set, returns global allowance """ if item_allowance is None: item_allowance = {} if qty_or_amount == "qty": if item_allowance.get(item_code, frappe._dict()).get("qty"): - return item_allowance[item_code].qty, item_allowance, global_qty_allowance, global_amount_allowance + return ( + item_allowance[item_code].qty, + item_allowance, + global_qty_allowance, + global_amount_allowance, + ) else: if item_allowance.get(item_code, frappe._dict()).get("amount"): - return item_allowance[item_code].amount, item_allowance, global_qty_allowance, global_amount_allowance + return ( + item_allowance[item_code].amount, + item_allowance, + global_qty_allowance, + global_amount_allowance, + ) - qty_allowance, over_billing_allowance = \ - frappe.db.get_value('Item', item_code, ['over_delivery_receipt_allowance', 'over_billing_allowance']) + qty_allowance, over_billing_allowance = frappe.db.get_value( + "Item", item_code, ["over_delivery_receipt_allowance", "over_billing_allowance"] + ) if qty_or_amount == "qty" and not qty_allowance: if global_qty_allowance == None: - global_qty_allowance = flt(frappe.db.get_single_value('Stock Settings', 'over_delivery_receipt_allowance')) + global_qty_allowance = flt( + frappe.db.get_single_value("Stock Settings", "over_delivery_receipt_allowance") + ) qty_allowance = global_qty_allowance elif qty_or_amount == "amount" and not over_billing_allowance: if global_amount_allowance == None: - global_amount_allowance = flt(frappe.db.get_single_value('Accounts Settings', 'over_billing_allowance')) + global_amount_allowance = flt( + frappe.db.get_single_value("Accounts Settings", "over_billing_allowance") + ) over_billing_allowance = global_amount_allowance if qty_or_amount == "qty": diff --git a/erpnext/controllers/stock_controller.py b/erpnext/controllers/stock_controller.py index 7073e32f536..2eea0bde8c6 100644 --- a/erpnext/controllers/stock_controller.py +++ b/erpnext/controllers/stock_controller.py @@ -3,6 +3,7 @@ import json from collections import defaultdict +from typing import List, Tuple import frappe from frappe import _ @@ -17,17 +18,29 @@ from erpnext.accounts.general_ledger import ( from erpnext.accounts.utils import get_fiscal_year from erpnext.controllers.accounts_controller import AccountsController from erpnext.stock import get_warehouse_account_map -from erpnext.stock.stock_ledger import get_items_to_be_repost, get_valuation_rate +from erpnext.stock.stock_ledger import get_items_to_be_repost -class QualityInspectionRequiredError(frappe.ValidationError): pass -class QualityInspectionRejectedError(frappe.ValidationError): pass -class QualityInspectionNotSubmittedError(frappe.ValidationError): pass +class QualityInspectionRequiredError(frappe.ValidationError): + pass + + +class QualityInspectionRejectedError(frappe.ValidationError): + pass + + +class QualityInspectionNotSubmittedError(frappe.ValidationError): + pass + + +class BatchExpiredError(frappe.ValidationError): + pass + class StockController(AccountsController): def validate(self): super(StockController, self).validate() - if not self.get('is_return'): + if not self.get("is_return"): self.validate_inspection() self.validate_serialized_batch() self.clean_serial_nos() @@ -40,57 +53,81 @@ class StockController(AccountsController): if self.docstatus == 2: make_reverse_gl_entries(voucher_type=self.doctype, voucher_no=self.name) - if cint(erpnext.is_perpetual_inventory_enabled(self.company)): + provisional_accounting_for_non_stock_items = cint( + frappe.db.get_value( + "Company", self.company, "enable_provisional_accounting_for_non_stock_items" + ) + ) + + if ( + cint(erpnext.is_perpetual_inventory_enabled(self.company)) + or provisional_accounting_for_non_stock_items + ): warehouse_account = get_warehouse_account_map(self.company) - if self.docstatus==1: + if self.docstatus == 1: if not gl_entries: gl_entries = self.get_gl_entries(warehouse_account) make_gl_entries(gl_entries, from_repost=from_repost) - elif self.doctype in ['Purchase Receipt', 'Purchase Invoice'] and self.docstatus == 1: + elif self.doctype in ["Purchase Receipt", "Purchase Invoice"] and self.docstatus == 1: gl_entries = [] gl_entries = self.get_asset_gl_entry(gl_entries) make_gl_entries(gl_entries, from_repost=from_repost) def validate_serialized_batch(self): from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos + + is_material_issue = False + if self.doctype == "Stock Entry" and self.purpose == "Material Issue": + is_material_issue = True + for d in self.get("items"): - if hasattr(d, 'serial_no') and hasattr(d, 'batch_no') and d.serial_no and d.batch_no: - serial_nos = frappe.get_all("Serial No", + if hasattr(d, "serial_no") and hasattr(d, "batch_no") and d.serial_no and d.batch_no: + serial_nos = frappe.get_all( + "Serial No", fields=["batch_no", "name", "warehouse"], - filters={ - "name": ("in", get_serial_nos(d.serial_no)) - } + filters={"name": ("in", get_serial_nos(d.serial_no))}, ) for row in serial_nos: if row.warehouse and row.batch_no != d.batch_no: - frappe.throw(_("Row #{0}: Serial No {1} does not belong to Batch {2}") - .format(d.idx, row.name, d.batch_no)) + frappe.throw( + _("Row #{0}: Serial No {1} does not belong to Batch {2}").format( + d.idx, row.name, d.batch_no + ) + ) + + if is_material_issue: + continue if flt(d.qty) > 0.0 and d.get("batch_no") and self.get("posting_date") and self.docstatus < 2: expiry_date = frappe.get_cached_value("Batch", d.get("batch_no"), "expiry_date") if expiry_date and getdate(expiry_date) < getdate(self.posting_date): - frappe.throw(_("Row #{0}: The batch {1} has already expired.") - .format(d.idx, get_link_to_form("Batch", d.get("batch_no")))) + frappe.throw( + _("Row #{0}: The batch {1} has already expired.").format( + d.idx, get_link_to_form("Batch", d.get("batch_no")) + ), + BatchExpiredError, + ) def clean_serial_nos(self): + from erpnext.stock.doctype.serial_no.serial_no import clean_serial_no_string + for row in self.get("items"): if hasattr(row, "serial_no") and row.serial_no: - # replace commas by linefeed - row.serial_no = row.serial_no.replace(",", "\n") + # remove extra whitespace and store one serial no on each line + row.serial_no = clean_serial_no_string(row.serial_no) - # strip preceeding and succeeding spaces for each SN - # (SN could have valid spaces in between e.g. SN - 123 - 2021) - serial_no_list = row.serial_no.split("\n") - serial_no_list = [sn.strip() for sn in serial_no_list] + for row in self.get("packed_items") or []: + if hasattr(row, "serial_no") and row.serial_no: + # remove extra whitespace and store one serial no on each line + row.serial_no = clean_serial_no_string(row.serial_no) - row.serial_no = "\n".join(serial_no_list) - - def get_gl_entries(self, warehouse_account=None, default_expense_account=None, - default_cost_center=None): + def get_gl_entries( + self, warehouse_account=None, default_expense_account=None, default_cost_center=None + ): if not warehouse_account: warehouse_account = get_warehouse_account_map(self.company) @@ -111,91 +148,81 @@ class StockController(AccountsController): self.check_expense_account(item_row) - # If the item does not have the allow zero valuation rate flag set - # and ( valuation rate not mentioned in an incoming entry - # or incoming entry not found while delivering the item), - # try to pick valuation rate from previous sle or Item master and update in SLE - # Otherwise, throw an exception - - if not sle.stock_value_difference and self.doctype != "Stock Reconciliation" \ - and not item_row.get("allow_zero_valuation_rate"): - - sle = self.update_stock_ledger_entries(sle) - # expense account/ target_warehouse / source_warehouse - if item_row.get('target_warehouse'): - warehouse = item_row.get('target_warehouse') + if item_row.get("target_warehouse"): + warehouse = item_row.get("target_warehouse") expense_account = warehouse_account[warehouse]["account"] else: expense_account = item_row.expense_account - gl_list.append(self.get_gl_dict({ - "account": warehouse_account[sle.warehouse]["account"], - "against": expense_account, - "cost_center": item_row.cost_center, - "project": item_row.project or self.get('project'), - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "debit": flt(sle.stock_value_difference, precision), - "is_opening": item_row.get("is_opening") or self.get("is_opening") or "No", - }, warehouse_account[sle.warehouse]["account_currency"], item=item_row)) + gl_list.append( + self.get_gl_dict( + { + "account": warehouse_account[sle.warehouse]["account"], + "against": expense_account, + "cost_center": item_row.cost_center, + "project": item_row.project or self.get("project"), + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "debit": flt(sle.stock_value_difference, precision), + "is_opening": item_row.get("is_opening") or self.get("is_opening") or "No", + }, + warehouse_account[sle.warehouse]["account_currency"], + item=item_row, + ) + ) - gl_list.append(self.get_gl_dict({ - "account": expense_account, - "against": warehouse_account[sle.warehouse]["account"], - "cost_center": item_row.cost_center, - "remarks": self.get("remarks") or _("Accounting Entry for Stock"), - "credit": flt(sle.stock_value_difference, precision), - "project": item_row.get("project") or self.get("project"), - "is_opening": item_row.get("is_opening") or self.get("is_opening") or "No" - }, item=item_row)) + gl_list.append( + self.get_gl_dict( + { + "account": expense_account, + "against": warehouse_account[sle.warehouse]["account"], + "cost_center": item_row.cost_center, + "remarks": self.get("remarks") or _("Accounting Entry for Stock"), + "debit": -1 * flt(sle.stock_value_difference, precision), + "project": item_row.get("project") or self.get("project"), + "is_opening": item_row.get("is_opening") or self.get("is_opening") or "No", + }, + item=item_row, + ) + ) elif sle.warehouse not in warehouse_with_no_account: warehouse_with_no_account.append(sle.warehouse) if warehouse_with_no_account: for wh in warehouse_with_no_account: if frappe.db.get_value("Warehouse", wh, "company"): - frappe.throw(_("Warehouse {0} is not linked to any account, please mention the account in the warehouse record or set default inventory account in company {1}.").format(wh, self.company)) + frappe.throw( + _( + "Warehouse {0} is not linked to any account, please mention the account in the warehouse record or set default inventory account in company {1}." + ).format(wh, self.company) + ) return process_gl_map(gl_list, precision=precision) def get_debit_field_precision(self): if not frappe.flags.debit_field_precision: - frappe.flags.debit_field_precision = frappe.get_precision("GL Entry", "debit_in_account_currency") + frappe.flags.debit_field_precision = frappe.get_precision( + "GL Entry", "debit_in_account_currency" + ) return frappe.flags.debit_field_precision - def update_stock_ledger_entries(self, sle): - sle.valuation_rate = get_valuation_rate(sle.item_code, sle.warehouse, - self.doctype, self.name, currency=self.company_currency, company=self.company) - - sle.stock_value = flt(sle.qty_after_transaction) * flt(sle.valuation_rate) - sle.stock_value_difference = flt(sle.actual_qty) * flt(sle.valuation_rate) - - if sle.name: - frappe.db.sql(""" - update - `tabStock Ledger Entry` - set - stock_value = %(stock_value)s, - valuation_rate = %(valuation_rate)s, - stock_value_difference = %(stock_value_difference)s - where - name = %(name)s""", (sle)) - - return sle - def get_voucher_details(self, default_expense_account, default_cost_center, sle_map): if self.doctype == "Stock Reconciliation": reconciliation_purpose = frappe.db.get_value(self.doctype, self.name, "purpose") is_opening = "Yes" if reconciliation_purpose == "Opening Stock" else "No" details = [] for voucher_detail_no in sle_map: - details.append(frappe._dict({ - "name": voucher_detail_no, - "expense_account": default_expense_account, - "cost_center": default_cost_center, - "is_opening": is_opening - })) + details.append( + frappe._dict( + { + "name": voucher_detail_no, + "expense_account": default_expense_account, + "cost_center": default_cost_center, + "is_opening": is_opening, + } + ) + ) return details else: details = self.get("items") @@ -209,37 +236,33 @@ class StockController(AccountsController): return details - def get_items_and_warehouses(self): - items, warehouses = [], [] + def get_items_and_warehouses(self) -> Tuple[List[str], List[str]]: + """Get list of items and warehouses affected by a transaction""" - if hasattr(self, "items"): - item_doclist = self.get("items") - elif self.doctype == "Stock Reconciliation": - item_doclist = [] - data = json.loads(self.reconciliation_json) - for row in data[data.index(self.head_row)+1:]: - d = frappe._dict(zip(["item_code", "warehouse", "qty", "valuation_rate"], row)) - item_doclist.append(d) + if not (hasattr(self, "items") or hasattr(self, "packed_items")): + return [], [] - if item_doclist: - for d in item_doclist: - if d.item_code and d.item_code not in items: - items.append(d.item_code) + item_rows = (self.get("items") or []) + (self.get("packed_items") or []) - if d.get("warehouse") and d.warehouse not in warehouses: - warehouses.append(d.warehouse) + items = {d.item_code for d in item_rows if d.item_code} - if self.doctype == "Stock Entry": - if d.get("s_warehouse") and d.s_warehouse not in warehouses: - warehouses.append(d.s_warehouse) - if d.get("t_warehouse") and d.t_warehouse not in warehouses: - warehouses.append(d.t_warehouse) + warehouses = set() + for d in item_rows: + if d.get("warehouse"): + warehouses.add(d.warehouse) - return items, warehouses + if self.doctype == "Stock Entry": + if d.get("s_warehouse"): + warehouses.add(d.s_warehouse) + if d.get("t_warehouse"): + warehouses.add(d.t_warehouse) + + return list(items), list(warehouses) def get_stock_ledger_details(self): stock_ledger = {} - stock_ledger_entries = frappe.db.sql(""" + stock_ledger_entries = frappe.db.sql( + """ select name, warehouse, stock_value_difference, valuation_rate, voucher_detail_no, item_code, posting_date, posting_time, @@ -247,115 +270,155 @@ class StockController(AccountsController): from `tabStock Ledger Entry` where - voucher_type=%s and voucher_no=%s - """, (self.doctype, self.name), as_dict=True) + voucher_type=%s and voucher_no=%s and is_cancelled = 0 + """, + (self.doctype, self.name), + as_dict=True, + ) for sle in stock_ledger_entries: stock_ledger.setdefault(sle.voucher_detail_no, []).append(sle) return stock_ledger def make_batches(self, warehouse_field): - '''Create batches if required. Called before submit''' + """Create batches if required. Called before submit""" for d in self.items: if d.get(warehouse_field) and not d.batch_no: - has_batch_no, create_new_batch = frappe.db.get_value('Item', d.item_code, ['has_batch_no', 'create_new_batch']) + has_batch_no, create_new_batch = frappe.db.get_value( + "Item", d.item_code, ["has_batch_no", "create_new_batch"] + ) if has_batch_no and create_new_batch: - d.batch_no = frappe.get_doc(dict( - doctype='Batch', - item=d.item_code, - supplier=getattr(self, 'supplier', None), - reference_doctype=self.doctype, - reference_name=self.name)).insert().name + d.batch_no = ( + frappe.get_doc( + dict( + doctype="Batch", + item=d.item_code, + supplier=getattr(self, "supplier", None), + reference_doctype=self.doctype, + reference_name=self.name, + ) + ) + .insert() + .name + ) def check_expense_account(self, item): if not item.get("expense_account"): msg = _("Please set an Expense Account in the Items table") - frappe.throw(_("Row #{0}: Expense Account not set for the Item {1}. {2}") - .format(item.idx, frappe.bold(item.item_code), msg), title=_("Expense Account Missing")) + frappe.throw( + _("Row #{0}: Expense Account not set for the Item {1}. {2}").format( + item.idx, frappe.bold(item.item_code), msg + ), + title=_("Expense Account Missing"), + ) else: - is_expense_account = frappe.get_cached_value("Account", - item.get("expense_account"), "report_type")=="Profit and Loss" - if self.doctype not in ("Purchase Receipt", "Purchase Invoice", "Stock Reconciliation", "Stock Entry") and not is_expense_account: - frappe.throw(_("Expense / Difference account ({0}) must be a 'Profit or Loss' account") - .format(item.get("expense_account"))) + is_expense_account = ( + frappe.get_cached_value("Account", item.get("expense_account"), "report_type") + == "Profit and Loss" + ) + if ( + self.doctype + not in ("Purchase Receipt", "Purchase Invoice", "Stock Reconciliation", "Stock Entry") + and not is_expense_account + ): + frappe.throw( + _("Expense / Difference account ({0}) must be a 'Profit or Loss' account").format( + item.get("expense_account") + ) + ) if is_expense_account and not item.get("cost_center"): - frappe.throw(_("{0} {1}: Cost Center is mandatory for Item {2}").format( - _(self.doctype), self.name, item.get("item_code"))) + frappe.throw( + _("{0} {1}: Cost Center is mandatory for Item {2}").format( + _(self.doctype), self.name, item.get("item_code") + ) + ) def delete_auto_created_batches(self): for d in self.items: - if not d.batch_no: continue + if not d.batch_no: + continue - serial_nos = [sr.name for sr in frappe.get_all("Serial No", - {'batch_no': d.batch_no, 'status': 'Inactive'})] - - if serial_nos: - frappe.db.set_value("Serial No", { 'name': ['in', serial_nos] }, "batch_no", None) + frappe.db.set_value( + "Serial No", {"batch_no": d.batch_no, "status": "Inactive"}, "batch_no", None + ) d.batch_no = None d.db_set("batch_no", None) - for data in frappe.get_all("Batch", - {'reference_name': self.name, 'reference_doctype': self.doctype}): + for data in frappe.get_all( + "Batch", {"reference_name": self.name, "reference_doctype": self.doctype} + ): frappe.delete_doc("Batch", data.name) def get_sl_entries(self, d, args): - sl_dict = frappe._dict({ - "item_code": d.get("item_code", None), - "warehouse": d.get("warehouse", None), - "posting_date": self.posting_date, - "posting_time": self.posting_time, - 'fiscal_year': get_fiscal_year(self.posting_date, company=self.company)[0], - "voucher_type": self.doctype, - "voucher_no": self.name, - "voucher_detail_no": d.name, - "actual_qty": (self.docstatus==1 and 1 or -1)*flt(d.get("stock_qty")), - "stock_uom": frappe.db.get_value("Item", args.get("item_code") or d.get("item_code"), "stock_uom"), - "incoming_rate": 0, - "company": self.company, - "batch_no": cstr(d.get("batch_no")).strip(), - "serial_no": d.get("serial_no"), - "project": d.get("project") or self.get('project'), - "is_cancelled": 1 if self.docstatus==2 else 0 - }) + sl_dict = frappe._dict( + { + "item_code": d.get("item_code", None), + "warehouse": d.get("warehouse", None), + "posting_date": self.posting_date, + "posting_time": self.posting_time, + "fiscal_year": get_fiscal_year(self.posting_date, company=self.company)[0], + "voucher_type": self.doctype, + "voucher_no": self.name, + "voucher_detail_no": d.name, + "actual_qty": (self.docstatus == 1 and 1 or -1) * flt(d.get("stock_qty")), + "stock_uom": frappe.db.get_value( + "Item", args.get("item_code") or d.get("item_code"), "stock_uom" + ), + "incoming_rate": 0, + "company": self.company, + "batch_no": cstr(d.get("batch_no")).strip(), + "serial_no": d.get("serial_no"), + "project": d.get("project") or self.get("project"), + "is_cancelled": 1 if self.docstatus == 2 else 0, + } + ) sl_dict.update(args) return sl_dict - def make_sl_entries(self, sl_entries, allow_negative_stock=False, - via_landed_cost_voucher=False): + def make_sl_entries(self, sl_entries, allow_negative_stock=False, via_landed_cost_voucher=False): from erpnext.stock.stock_ledger import make_sl_entries + make_sl_entries(sl_entries, allow_negative_stock, via_landed_cost_voucher) def make_gl_entries_on_cancel(self): - if frappe.db.sql("""select name from `tabGL Entry` where voucher_type=%s - and voucher_no=%s""", (self.doctype, self.name)): - self.make_gl_entries() + if frappe.db.sql( + """select name from `tabGL Entry` where voucher_type=%s + and voucher_no=%s""", + (self.doctype, self.name), + ): + self.make_gl_entries() def get_serialized_items(self): serialized_items = [] item_codes = list(set(d.item_code for d in self.get("items"))) if item_codes: - serialized_items = frappe.db.sql_list("""select name from `tabItem` - where has_serial_no=1 and name in ({})""".format(", ".join(["%s"]*len(item_codes))), - tuple(item_codes)) + serialized_items = frappe.db.sql_list( + """select name from `tabItem` + where has_serial_no=1 and name in ({})""".format( + ", ".join(["%s"] * len(item_codes)) + ), + tuple(item_codes), + ) return serialized_items def validate_warehouse(self): from erpnext.stock.utils import validate_disabled_warehouse, validate_warehouse_company - warehouses = list(set(d.warehouse for d in - self.get("items") if getattr(d, "warehouse", None))) + warehouses = list(set(d.warehouse for d in self.get("items") if getattr(d, "warehouse", None))) - target_warehouses = list(set([d.target_warehouse for d in - self.get("items") if getattr(d, "target_warehouse", None)])) + target_warehouses = list( + set([d.target_warehouse for d in self.get("items") if getattr(d, "target_warehouse", None)]) + ) warehouses.extend(target_warehouses) - from_warehouse = list(set([d.from_warehouse for d in - self.get("items") if getattr(d, "from_warehouse", None)])) + from_warehouse = list( + set([d.from_warehouse for d in self.get("items") if getattr(d, "from_warehouse", None)]) + ) warehouses.extend(from_warehouse) @@ -368,14 +431,17 @@ class StockController(AccountsController): if self.doctype == "Delivery Note": target_ref_field = "amount - (returned_qty * rate)" - self._update_percent_field({ - "target_dt": self.doctype + " Item", - "target_parent_dt": self.doctype, - "target_parent_field": "per_billed", - "target_ref_field": target_ref_field, - "target_field": "billed_amt", - "name": self.name, - }, update_modified) + self._update_percent_field( + { + "target_dt": self.doctype + " Item", + "target_parent_dt": self.doctype, + "target_parent_field": "per_billed", + "target_ref_field": target_ref_field, + "target_field": "billed_amt", + "name": self.name, + }, + update_modified, + ) def validate_inspection(self): """Checks if quality inspection is set/ is valid for Items that require inspection.""" @@ -383,24 +449,28 @@ class StockController(AccountsController): "Purchase Receipt": "inspection_required_before_purchase", "Purchase Invoice": "inspection_required_before_purchase", "Sales Invoice": "inspection_required_before_delivery", - "Delivery Note": "inspection_required_before_delivery" + "Delivery Note": "inspection_required_before_delivery", } inspection_required_fieldname = inspection_fieldname_map.get(self.doctype) # return if inspection is not required on document level - if ((not inspection_required_fieldname and self.doctype != "Stock Entry") or - (self.doctype == "Stock Entry" and not self.inspection_required) or - (self.doctype in ["Sales Invoice", "Purchase Invoice"] and not self.update_stock)): - return + if ( + (not inspection_required_fieldname and self.doctype != "Stock Entry") + or (self.doctype == "Stock Entry" and not self.inspection_required) + or (self.doctype in ["Sales Invoice", "Purchase Invoice"] and not self.update_stock) + ): + return - for row in self.get('items'): + for row in self.get("items"): qi_required = False - if (inspection_required_fieldname and frappe.db.get_value("Item", row.item_code, inspection_required_fieldname)): + if inspection_required_fieldname and frappe.db.get_value( + "Item", row.item_code, inspection_required_fieldname + ): qi_required = True elif self.doctype == "Stock Entry" and row.t_warehouse: - qi_required = True # inward stock needs inspection + qi_required = True # inward stock needs inspection - if qi_required: # validate row only if inspection is required on item level + if qi_required: # validate row only if inspection is required on item level self.validate_qi_presence(row) if self.docstatus == 1: self.validate_qi_submission(row) @@ -417,12 +487,16 @@ class StockController(AccountsController): def validate_qi_submission(self, row): """Check if QI is submitted on row level, during submission""" - action = frappe.db.get_single_value("Stock Settings", "action_if_quality_inspection_is_not_submitted") + action = frappe.db.get_single_value( + "Stock Settings", "action_if_quality_inspection_is_not_submitted" + ) qa_docstatus = frappe.db.get_value("Quality Inspection", row.quality_inspection, "docstatus") if not qa_docstatus == 1: - link = frappe.utils.get_link_to_form('Quality Inspection', row.quality_inspection) - msg = f"Row #{row.idx}: Quality Inspection {link} is not submitted for the item: {row.item_code}" + link = frappe.utils.get_link_to_form("Quality Inspection", row.quality_inspection) + msg = ( + f"Row #{row.idx}: Quality Inspection {link} is not submitted for the item: {row.item_code}" + ) if action == "Stop": frappe.throw(_(msg), title=_("Inspection Submission"), exc=QualityInspectionNotSubmittedError) else: @@ -434,7 +508,7 @@ class StockController(AccountsController): qa_status = frappe.db.get_value("Quality Inspection", row.quality_inspection, "status") if qa_status == "Rejected": - link = frappe.utils.get_link_to_form('Quality Inspection', row.quality_inspection) + link = frappe.utils.get_link_to_form("Quality Inspection", row.quality_inspection) msg = f"Row #{row.idx}: Quality Inspection {link} was rejected for item {row.item_code}" if action == "Stop": frappe.throw(_(msg), title=_("Inspection Rejected"), exc=QualityInspectionRejectedError) @@ -447,48 +521,71 @@ class StockController(AccountsController): frappe.get_doc("Blanket Order", blanket_order).update_ordered_qty() def validate_customer_provided_item(self): - for d in self.get('items'): + for d in self.get("items"): # Customer Provided parts will have zero valuation rate - if frappe.db.get_value('Item', d.item_code, 'is_customer_provided_item'): + if frappe.db.get_value("Item", d.item_code, "is_customer_provided_item"): d.allow_zero_valuation_rate = 1 def set_rate_of_stock_uom(self): - if self.doctype in ["Purchase Receipt", "Purchase Invoice", "Purchase Order", "Sales Invoice", "Sales Order", "Delivery Note", "Quotation"]: + if self.doctype in [ + "Purchase Receipt", + "Purchase Invoice", + "Purchase Order", + "Sales Invoice", + "Sales Order", + "Delivery Note", + "Quotation", + ]: for d in self.get("items"): d.stock_uom_rate = d.rate / (d.conversion_factor or 1) def validate_internal_transfer(self): - if self.doctype in ('Sales Invoice', 'Delivery Note', 'Purchase Invoice', 'Purchase Receipt') \ - and self.is_internal_transfer(): + if ( + self.doctype in ("Sales Invoice", "Delivery Note", "Purchase Invoice", "Purchase Receipt") + and self.is_internal_transfer() + ): self.validate_in_transit_warehouses() self.validate_multi_currency() self.validate_packed_items() def validate_in_transit_warehouses(self): - if (self.doctype == 'Sales Invoice' and self.get('update_stock')) or self.doctype == 'Delivery Note': - for item in self.get('items'): + if ( + self.doctype == "Sales Invoice" and self.get("update_stock") + ) or self.doctype == "Delivery Note": + for item in self.get("items"): if not item.target_warehouse: - frappe.throw(_("Row {0}: Target Warehouse is mandatory for internal transfers").format(item.idx)) + frappe.throw( + _("Row {0}: Target Warehouse is mandatory for internal transfers").format(item.idx) + ) - if (self.doctype == 'Purchase Invoice' and self.get('update_stock')) or self.doctype == 'Purchase Receipt': - for item in self.get('items'): + if ( + self.doctype == "Purchase Invoice" and self.get("update_stock") + ) or self.doctype == "Purchase Receipt": + for item in self.get("items"): if not item.from_warehouse: - frappe.throw(_("Row {0}: From Warehouse is mandatory for internal transfers").format(item.idx)) + frappe.throw( + _("Row {0}: From Warehouse is mandatory for internal transfers").format(item.idx) + ) def validate_multi_currency(self): if self.currency != self.company_currency: frappe.throw(_("Internal transfers can only be done in company's default currency")) def validate_packed_items(self): - if self.doctype in ('Sales Invoice', 'Delivery Note Item') and self.get('packed_items'): + if self.doctype in ("Sales Invoice", "Delivery Note Item") and self.get("packed_items"): frappe.throw(_("Packed Items cannot be transferred internally")) def validate_putaway_capacity(self): # if over receipt is attempted while 'apply putaway rule' is disabled # and if rule was applied on the transaction, validate it. from erpnext.stock.doctype.putaway_rule.putaway_rule import get_available_putaway_capacity - valid_doctype = self.doctype in ("Purchase Receipt", "Stock Entry", "Purchase Invoice", - "Stock Reconciliation") + + valid_doctype = self.doctype in ( + "Purchase Receipt", + "Stock Entry", + "Purchase Invoice", + "Stock Reconciliation", + ) if self.doctype == "Purchase Invoice" and self.get("update_stock") == 0: valid_doctype = False @@ -497,14 +594,15 @@ class StockController(AccountsController): rule_map = defaultdict(dict) for item in self.get("items"): warehouse_field = "t_warehouse" if self.doctype == "Stock Entry" else "warehouse" - rule = frappe.db.get_value("Putaway Rule", - { - "item_code": item.get("item_code"), - "warehouse": item.get(warehouse_field) - }, - ["name", "disable"], as_dict=True) + rule = frappe.db.get_value( + "Putaway Rule", + {"item_code": item.get("item_code"), "warehouse": item.get(warehouse_field)}, + ["name", "disable"], + as_dict=True, + ) if rule: - if rule.get("disabled"): continue # dont validate for disabled rule + if rule.get("disabled"): + continue # dont validate for disabled rule if self.doctype == "Stock Reconciliation": stock_qty = flt(item.qty) @@ -525,32 +623,69 @@ class StockController(AccountsController): frappe.throw(msg=message, title=_("Over Receipt")) def prepare_over_receipt_message(self, rule, values): - message = _("{0} qty of Item {1} is being received into Warehouse {2} with capacity {3}.") \ - .format( - frappe.bold(values["qty_put"]), frappe.bold(values["item"]), - frappe.bold(values["warehouse"]), frappe.bold(values["capacity"]) - ) + message = _( + "{0} qty of Item {1} is being received into Warehouse {2} with capacity {3}." + ).format( + frappe.bold(values["qty_put"]), + frappe.bold(values["item"]), + frappe.bold(values["warehouse"]), + frappe.bold(values["capacity"]), + ) message += "
" rule_link = frappe.utils.get_link_to_form("Putaway Rule", rule) message += _("Please adjust the qty or edit {0} to proceed.").format(rule_link) return message def repost_future_sle_and_gle(self): - args = frappe._dict({ - "posting_date": self.posting_date, - "posting_time": self.posting_time, - "voucher_type": self.doctype, - "voucher_no": self.name, - "company": self.company - }) - if future_sle_exists(args): - item_based_reposting = cint(frappe.db.get_single_value("Stock Reposting Settings", "item_based_reposting")) + args = frappe._dict( + { + "posting_date": self.posting_date, + "posting_time": self.posting_time, + "voucher_type": self.doctype, + "voucher_no": self.name, + "company": self.company, + } + ) + + if future_sle_exists(args) or repost_required_for_queue(self): + item_based_reposting = cint( + frappe.db.get_single_value("Stock Reposting Settings", "item_based_reposting") + ) if item_based_reposting: create_item_wise_repost_entries(voucher_type=self.doctype, voucher_no=self.name) else: create_repost_item_valuation_entry(args) +def repost_required_for_queue(doc: StockController) -> bool: + """check if stock document contains repeated item-warehouse with queue based valuation. + + if queue exists for repeated items then SLEs need to reprocessed in background again. + """ + + consuming_sles = frappe.db.get_all( + "Stock Ledger Entry", + filters={ + "voucher_type": doc.doctype, + "voucher_no": doc.name, + "actual_qty": ("<", 0), + "is_cancelled": 0, + }, + fields=["item_code", "warehouse", "stock_queue"], + ) + item_warehouses = [(sle.item_code, sle.warehouse) for sle in consuming_sles] + + unique_item_warehouses = set(item_warehouses) + + if len(unique_item_warehouses) == len(item_warehouses): + return False + + for sle in consuming_sles: + if sle.stock_queue != "[]": # using FIFO/LIFO valuation + return True + return False + + @frappe.whitelist() def make_quality_inspections(doctype, docname, items): if isinstance(items, str): @@ -559,32 +694,41 @@ def make_quality_inspections(doctype, docname, items): inspections = [] for item in items: if flt(item.get("sample_size")) > flt(item.get("qty")): - frappe.throw(_("{item_name}'s Sample Size ({sample_size}) cannot be greater than the Accepted Quantity ({accepted_quantity})").format( - item_name=item.get("item_name"), - sample_size=item.get("sample_size"), - accepted_quantity=item.get("qty") - )) + frappe.throw( + _( + "{item_name}'s Sample Size ({sample_size}) cannot be greater than the Accepted Quantity ({accepted_quantity})" + ).format( + item_name=item.get("item_name"), + sample_size=item.get("sample_size"), + accepted_quantity=item.get("qty"), + ) + ) - quality_inspection = frappe.get_doc({ - "doctype": "Quality Inspection", - "inspection_type": "Incoming", - "inspected_by": frappe.session.user, - "reference_type": doctype, - "reference_name": docname, - "item_code": item.get("item_code"), - "description": item.get("description"), - "sample_size": flt(item.get("sample_size")), - "item_serial_no": item.get("serial_no").split("\n")[0] if item.get("serial_no") else None, - "batch_no": item.get("batch_no") - }).insert() + quality_inspection = frappe.get_doc( + { + "doctype": "Quality Inspection", + "inspection_type": "Incoming", + "inspected_by": frappe.session.user, + "reference_type": doctype, + "reference_name": docname, + "item_code": item.get("item_code"), + "description": item.get("description"), + "sample_size": flt(item.get("sample_size")), + "item_serial_no": item.get("serial_no").split("\n")[0] if item.get("serial_no") else None, + "batch_no": item.get("batch_no"), + } + ).insert() quality_inspection.save() inspections.append(quality_inspection.name) return inspections + def is_reposting_pending(): - return frappe.db.exists("Repost Item Valuation", - {'docstatus': 1, 'status': ['in', ['Queued','In Progress']]}) + return frappe.db.exists( + "Repost Item Valuation", {"docstatus": 1, "status": ["in", ["Queued", "In Progress"]]} + ) + def future_sle_exists(args, sl_entries=None): key = (args.voucher_type, args.voucher_no) @@ -601,7 +745,8 @@ def future_sle_exists(args, sl_entries=None): or_conditions = get_conditions_to_validate_future_sle(sl_entries) - data = frappe.db.sql(""" + data = frappe.db.sql( + """ select item_code, warehouse, count(name) as total_row from `tabStock Ledger Entry` force index (item_warehouse) where @@ -612,43 +757,55 @@ def future_sle_exists(args, sl_entries=None): and is_cancelled = 0 GROUP BY item_code, warehouse - """.format(" or ".join(or_conditions)), args, as_dict=1) + """.format( + " or ".join(or_conditions) + ), + args, + as_dict=1, + ) for d in data: frappe.local.future_sle[key][(d.item_code, d.warehouse)] = d.total_row return len(data) -def validate_future_sle_not_exists(args, key, sl_entries=None): - item_key = '' - if args.get('item_code'): - item_key = (args.get('item_code'), args.get('warehouse')) - if not sl_entries and hasattr(frappe.local, 'future_sle'): - if (not frappe.local.future_sle.get(key) or - (item_key and item_key not in frappe.local.future_sle.get(key))): +def validate_future_sle_not_exists(args, key, sl_entries=None): + item_key = "" + if args.get("item_code"): + item_key = (args.get("item_code"), args.get("warehouse")) + + if not sl_entries and hasattr(frappe.local, "future_sle"): + if not frappe.local.future_sle.get(key) or ( + item_key and item_key not in frappe.local.future_sle.get(key) + ): return True + def get_cached_data(args, key): - if not hasattr(frappe.local, 'future_sle'): + if not hasattr(frappe.local, "future_sle"): frappe.local.future_sle = {} if key not in frappe.local.future_sle: frappe.local.future_sle[key] = frappe._dict({}) - if args.get('item_code'): - item_key = (args.get('item_code'), args.get('warehouse')) + if args.get("item_code"): + item_key = (args.get("item_code"), args.get("warehouse")) count = frappe.local.future_sle[key].get(item_key) return True if (count or count == 0) else False else: return frappe.local.future_sle[key] + def get_sle_entries_against_voucher(args): - return frappe.get_all("Stock Ledger Entry", + return frappe.get_all( + "Stock Ledger Entry", filters={"voucher_type": args.voucher_type, "voucher_no": args.voucher_no}, fields=["item_code", "warehouse"], - order_by="creation asc") + order_by="creation asc", + ) + def get_conditions_to_validate_future_sle(sl_entries): warehouse_items_map = {} @@ -662,16 +819,18 @@ def get_conditions_to_validate_future_sle(sl_entries): for warehouse, items in warehouse_items_map.items(): or_conditions.append( f"""warehouse = {frappe.db.escape(warehouse)} - and item_code in ({', '.join(frappe.db.escape(item) for item in items)})""") + and item_code in ({', '.join(frappe.db.escape(item) for item in items)})""" + ) return or_conditions + def create_repost_item_valuation_entry(args): args = frappe._dict(args) repost_entry = frappe.new_doc("Repost Item Valuation") repost_entry.based_on = args.based_on if not args.based_on: - repost_entry.based_on = 'Transaction' if args.voucher_no else "Item and Warehouse" + repost_entry.based_on = "Transaction" if args.voucher_no else "Item and Warehouse" repost_entry.voucher_type = args.voucher_type repost_entry.voucher_no = args.voucher_no repost_entry.item_code = args.item_code diff --git a/erpnext/controllers/subcontracting.py b/erpnext/controllers/subcontracting.py index 3addb91aaa0..2ed963cf91f 100644 --- a/erpnext/controllers/subcontracting.py +++ b/erpnext/controllers/subcontracting.py @@ -8,9 +8,9 @@ from frappe.utils import cint, flt, get_link_to_form from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos -class Subcontracting(): +class Subcontracting: def set_materials_for_subcontracted_items(self, raw_material_table): - if self.doctype == 'Purchase Invoice' and not self.update_stock: + if self.doctype == "Purchase Invoice" and not self.update_stock: return self.raw_material_table = raw_material_table @@ -33,13 +33,14 @@ class Subcontracting(): self.__get_backflush_based_on() def __get_backflush_based_on(self): - self.backflush_based_on = frappe.db.get_single_value("Buying Settings", - "backflush_raw_materials_of_subcontract_based_on") + self.backflush_based_on = frappe.db.get_single_value( + "Buying Settings", "backflush_raw_materials_of_subcontract_based_on" + ) def __get_purchase_orders(self): self.purchase_orders = [] - if self.doctype == 'Purchase Order': + if self.doctype == "Purchase Order": return self.purchase_orders = [d.purchase_order for d in self.items if d.purchase_order] @@ -48,7 +49,7 @@ class Subcontracting(): self.__changed_name = [] self.__reference_name = [] - if self.doctype == 'Purchase Order' or self.is_new(): + if self.doctype == "Purchase Order" or self.is_new(): self.set(self.raw_material_table, []) return @@ -68,20 +69,20 @@ class Subcontracting(): def __get_data_before_save(self): item_dict = {} - if self.doctype in ['Purchase Receipt', 'Purchase Invoice'] and self._doc_before_save: - for row in self._doc_before_save.get('items'): + if self.doctype in ["Purchase Receipt", "Purchase Invoice"] and self._doc_before_save: + for row in self._doc_before_save.get("items"): item_dict[row.name] = (row.item_code, row.qty) return item_dict def get_available_materials(self): - ''' Get the available raw materials which has been transferred to the supplier. - available_materials = { - (item_code, subcontracted_item, purchase_order): { - 'qty': 1, 'serial_no': [ABC], 'batch_no': {'batch1': 1}, 'data': item_details - } - } - ''' + """Get the available raw materials which has been transferred to the supplier. + available_materials = { + (item_code, subcontracted_item, purchase_order): { + 'qty': 1, 'serial_no': [ABC], 'batch_no': {'batch1': 1}, 'data': item_details + } + } + """ if not self.purchase_orders: return @@ -89,8 +90,17 @@ class Subcontracting(): key = (row.rm_item_code, row.main_item_code, row.purchase_order) if key not in self.available_materials: - self.available_materials.setdefault(key, frappe._dict({'qty': 0, 'serial_no': [], - 'batch_no': defaultdict(float), 'item_details': row, 'po_details': []}) + self.available_materials.setdefault( + key, + frappe._dict( + { + "qty": 0, + "serial_no": [], + "batch_no": defaultdict(float), + "item_details": row, + "po_details": [], + } + ), ) details = self.available_materials[key] @@ -106,17 +116,17 @@ class Subcontracting(): self.__set_alternative_item_details(row) self.__transferred_items = copy.deepcopy(self.available_materials) - for doctype in ['Purchase Receipt', 'Purchase Invoice']: + for doctype in ["Purchase Receipt", "Purchase Invoice"]: self.__update_consumed_materials(doctype) def __update_consumed_materials(self, doctype, return_consumed_items=False): - '''Deduct the consumed materials from the available materials.''' + """Deduct the consumed materials from the available materials.""" pr_items = self.__get_received_items(doctype) if not pr_items: return ([], {}) if return_consumed_items else None - pr_items = {d.name: d.get(self.get('po_field') or 'purchase_order') for d in pr_items} + pr_items = {d.name: d.get(self.get("po_field") or "purchase_order") for d in pr_items} consumed_materials = self.__get_consumed_items(doctype, pr_items.keys()) if return_consumed_items: @@ -127,97 +137,153 @@ class Subcontracting(): if not self.available_materials.get(key): continue - self.available_materials[key]['qty'] -= row.consumed_qty + self.available_materials[key]["qty"] -= row.consumed_qty if row.serial_no: - self.available_materials[key]['serial_no'] = list( - set(self.available_materials[key]['serial_no']) - set(get_serial_nos(row.serial_no)) + self.available_materials[key]["serial_no"] = list( + set(self.available_materials[key]["serial_no"]) - set(get_serial_nos(row.serial_no)) ) if row.batch_no: - self.available_materials[key]['batch_no'][row.batch_no] -= row.consumed_qty + self.available_materials[key]["batch_no"][row.batch_no] -= row.consumed_qty def __get_transferred_items(self): - fields = ['`tabStock Entry`.`purchase_order`'] - alias_dict = {'item_code': 'rm_item_code', 'subcontracted_item': 'main_item_code', 'basic_rate': 'rate'} + fields = ["`tabStock Entry`.`purchase_order`"] + alias_dict = { + "item_code": "rm_item_code", + "subcontracted_item": "main_item_code", + "basic_rate": "rate", + } - child_table_fields = ['item_code', 'item_name', 'description', 'qty', 'basic_rate', 'amount', - 'serial_no', 'uom', 'subcontracted_item', 'stock_uom', 'batch_no', 'conversion_factor', - 's_warehouse', 't_warehouse', 'item_group', 'po_detail'] + child_table_fields = [ + "item_code", + "item_name", + "description", + "qty", + "basic_rate", + "amount", + "serial_no", + "uom", + "subcontracted_item", + "stock_uom", + "batch_no", + "conversion_factor", + "s_warehouse", + "t_warehouse", + "item_group", + "po_detail", + ] - if self.backflush_based_on == 'BOM': - child_table_fields.append('original_item') + if self.backflush_based_on == "BOM": + child_table_fields.append("original_item") for field in child_table_fields: - fields.append(f'`tabStock Entry Detail`.`{field}` As {alias_dict.get(field, field)}') + fields.append(f"`tabStock Entry Detail`.`{field}` As {alias_dict.get(field, field)}") - filters = [['Stock Entry', 'docstatus', '=', 1], ['Stock Entry', 'purpose', '=', 'Send to Subcontractor'], - ['Stock Entry', 'purchase_order', 'in', self.purchase_orders]] + filters = [ + ["Stock Entry", "docstatus", "=", 1], + ["Stock Entry", "purpose", "=", "Send to Subcontractor"], + ["Stock Entry", "purchase_order", "in", self.purchase_orders], + ] - return frappe.get_all('Stock Entry', fields = fields, filters=filters) + return frappe.get_all("Stock Entry", fields=fields, filters=filters) def __get_received_items(self, doctype): fields = [] - self.po_field = 'purchase_order' + self.po_field = "purchase_order" - for field in ['name', self.po_field, 'parent']: - fields.append(f'`tab{doctype} Item`.`{field}`') + for field in ["name", self.po_field, "parent"]: + fields.append(f"`tab{doctype} Item`.`{field}`") - filters = [[doctype, 'docstatus', '=', 1], [f'{doctype} Item', self.po_field, 'in', self.purchase_orders]] - if doctype == 'Purchase Invoice': - filters.append(['Purchase Invoice', 'update_stock', "=", 1]) + filters = [ + [doctype, "docstatus", "=", 1], + [f"{doctype} Item", self.po_field, "in", self.purchase_orders], + ] + if doctype == "Purchase Invoice": + filters.append(["Purchase Invoice", "update_stock", "=", 1]) - return frappe.get_all(f'{doctype}', fields = fields, filters = filters) + return frappe.get_all(f"{doctype}", fields=fields, filters=filters) def __get_consumed_items(self, doctype, pr_items): - return frappe.get_all('Purchase Receipt Item Supplied', - fields = ['serial_no', 'rm_item_code', 'reference_name', 'batch_no', 'consumed_qty', 'main_item_code'], - filters = {'docstatus': 1, 'reference_name': ('in', list(pr_items)), 'parenttype': doctype}) + return frappe.get_all( + "Purchase Receipt Item Supplied", + fields=[ + "serial_no", + "rm_item_code", + "reference_name", + "batch_no", + "consumed_qty", + "main_item_code", + ], + filters={"docstatus": 1, "reference_name": ("in", list(pr_items)), "parenttype": doctype}, + ) def __set_alternative_item_details(self, row): - if row.get('original_item'): - self.alternative_item_details[row.get('original_item')] = row + if row.get("original_item"): + self.alternative_item_details[row.get("original_item")] = row def __get_pending_qty_to_receive(self): - '''Get qty to be received against the purchase order.''' + """Get qty to be received against the purchase order.""" self.qty_to_be_received = defaultdict(float) - if self.doctype != 'Purchase Order' and self.backflush_based_on != 'BOM' and self.purchase_orders: - for row in frappe.get_all('Purchase Order Item', - fields = ['item_code', '(qty - received_qty) as qty', 'parent', 'name'], - filters = {'docstatus': 1, 'parent': ('in', self.purchase_orders)}): + if ( + self.doctype != "Purchase Order" and self.backflush_based_on != "BOM" and self.purchase_orders + ): + for row in frappe.get_all( + "Purchase Order Item", + fields=["item_code", "(qty - received_qty) as qty", "parent", "name"], + filters={"docstatus": 1, "parent": ("in", self.purchase_orders)}, + ): self.qty_to_be_received[(row.item_code, row.parent)] += row.qty def __get_materials_from_bom(self, item_code, bom_no, exploded_item=0): - doctype = 'BOM Item' if not exploded_item else 'BOM Explosion Item' - fields = [f'`tab{doctype}`.`stock_qty` / `tabBOM`.`quantity` as qty_consumed_per_unit'] + doctype = "BOM Item" if not exploded_item else "BOM Explosion Item" + fields = [f"`tab{doctype}`.`stock_qty` / `tabBOM`.`quantity` as qty_consumed_per_unit"] - alias_dict = {'item_code': 'rm_item_code', 'name': 'bom_detail_no', 'source_warehouse': 'reserve_warehouse'} - for field in ['item_code', 'name', 'rate', 'stock_uom', - 'source_warehouse', 'description', 'item_name', 'stock_uom']: - fields.append(f'`tab{doctype}`.`{field}` As {alias_dict.get(field, field)}') + alias_dict = { + "item_code": "rm_item_code", + "name": "bom_detail_no", + "source_warehouse": "reserve_warehouse", + } + for field in [ + "item_code", + "name", + "rate", + "stock_uom", + "source_warehouse", + "description", + "item_name", + "stock_uom", + ]: + fields.append(f"`tab{doctype}`.`{field}` As {alias_dict.get(field, field)}") - filters = [[doctype, 'parent', '=', bom_no], [doctype, 'docstatus', '=', 1], - ['BOM', 'item', '=', item_code], [doctype, 'sourced_by_supplier', '=', 0]] + filters = [ + [doctype, "parent", "=", bom_no], + [doctype, "docstatus", "=", 1], + ["BOM", "item", "=", item_code], + [doctype, "sourced_by_supplier", "=", 0], + ] - return frappe.get_all('BOM', fields = fields, filters=filters, order_by = f'`tab{doctype}`.`idx`') or [] + return ( + frappe.get_all("BOM", fields=fields, filters=filters, order_by=f"`tab{doctype}`.`idx`") or [] + ) def __remove_changed_rows(self): if not self.__changed_name: return - i=1 + i = 1 self.set(self.raw_material_table, []) for d in self._doc_before_save.supplied_items: if d.reference_name in self.__changed_name: continue - if (d.reference_name not in self.__reference_name): + if d.reference_name not in self.__reference_name: continue d.idx = i - self.append('supplied_items', d) + self.append("supplied_items", d) i += 1 @@ -226,31 +292,35 @@ class Subcontracting(): has_supplied_items = True if self.get(self.raw_material_table) else False for row in self.items: - if (self.doctype != 'Purchase Order' and ((self.__changed_name and row.name not in self.__changed_name) - or (has_supplied_items and not self.__changed_name))): + if self.doctype != "Purchase Order" and ( + (self.__changed_name and row.name not in self.__changed_name) + or (has_supplied_items and not self.__changed_name) + ): continue - if self.doctype == 'Purchase Order' or self.backflush_based_on == 'BOM': - for bom_item in self.__get_materials_from_bom(row.item_code, row.bom, row.get('include_exploded_items')): - qty = (flt(bom_item.qty_consumed_per_unit) * flt(row.qty) * row.conversion_factor) + if self.doctype == "Purchase Order" or self.backflush_based_on == "BOM": + for bom_item in self.__get_materials_from_bom( + row.item_code, row.bom, row.get("include_exploded_items") + ): + qty = flt(bom_item.qty_consumed_per_unit) * flt(row.qty) * row.conversion_factor bom_item.main_item_code = row.item_code self.__update_reserve_warehouse(bom_item, row) self.__set_alternative_item(bom_item) self.__add_supplied_item(row, bom_item, qty) - elif self.backflush_based_on != 'BOM': + elif self.backflush_based_on != "BOM": for key, transfer_item in self.available_materials.items(): if (key[1], key[2]) == (row.item_code, row.purchase_order) and transfer_item.qty > 0: qty = self.__get_qty_based_on_material_transfer(row, transfer_item) or 0 transfer_item.qty -= qty - self.__add_supplied_item(row, transfer_item.get('item_details'), qty) + self.__add_supplied_item(row, transfer_item.get("item_details"), qty) if self.qty_to_be_received: self.qty_to_be_received[(row.item_code, row.purchase_order)] -= row.qty def __update_reserve_warehouse(self, row, item): - if self.doctype == 'Purchase Order': - row.reserve_warehouse = (self.set_reserve_warehouse or item.warehouse) + if self.doctype == "Purchase Order": + row.reserve_warehouse = self.set_reserve_warehouse or item.warehouse def __get_qty_based_on_material_transfer(self, item_row, transfer_item): key = (item_row.item_code, item_row.purchase_order) @@ -262,8 +332,9 @@ class Subcontracting(): qty = (flt(item_row.qty) * flt(transfer_item.qty)) / flt(self.qty_to_be_received.get(key, 0)) transfer_item.item_details.required_qty = transfer_item.qty - if (transfer_item.serial_no or frappe.get_cached_value('UOM', - transfer_item.item_details.stock_uom, 'must_be_whole_number')): + if transfer_item.serial_no or frappe.get_cached_value( + "UOM", transfer_item.item_details.stock_uom, "must_be_whole_number" + ): return frappe.utils.ceil(qty) return qty @@ -277,22 +348,24 @@ class Subcontracting(): rm_obj = self.append(self.raw_material_table, bom_item) rm_obj.reference_name = item_row.name - if self.doctype == 'Purchase Order': + if self.doctype == "Purchase Order": rm_obj.required_qty = qty else: rm_obj.consumed_qty = 0 rm_obj.purchase_order = item_row.purchase_order self.__set_batch_nos(bom_item, item_row, rm_obj, qty) + rm_obj.amount = flt(rm_obj.required_qty) * flt(rm_obj.rate) + def __set_batch_nos(self, bom_item, item_row, rm_obj, qty): key = (rm_obj.rm_item_code, item_row.item_code, item_row.purchase_order) - if (self.available_materials.get(key) and self.available_materials[key]['batch_no']): + if self.available_materials.get(key) and self.available_materials[key]["batch_no"]: new_rm_obj = None - for batch_no, batch_qty in self.available_materials[key]['batch_no'].items(): + for batch_no, batch_qty in self.available_materials[key]["batch_no"].items(): if batch_qty >= qty: self.__set_batch_no_as_per_qty(item_row, rm_obj, batch_no, qty) - self.available_materials[key]['batch_no'][batch_no] -= qty + self.available_materials[key]["batch_no"][batch_no] -= qty return elif qty > 0 and batch_qty > 0: @@ -300,7 +373,7 @@ class Subcontracting(): new_rm_obj = self.append(self.raw_material_table, bom_item) new_rm_obj.reference_name = item_row.name self.__set_batch_no_as_per_qty(item_row, new_rm_obj, batch_no, batch_qty) - self.available_materials[key]['batch_no'][batch_no] = 0 + self.available_materials[key]["batch_no"][batch_no] = 0 if abs(qty) > 0 and not new_rm_obj: self.__set_consumed_qty(rm_obj, qty) @@ -313,29 +386,35 @@ class Subcontracting(): rm_obj.consumed_qty = consumed_qty def __set_batch_no_as_per_qty(self, item_row, rm_obj, batch_no, qty): - rm_obj.update({'consumed_qty': qty, 'batch_no': batch_no, - 'required_qty': qty, 'purchase_order': item_row.purchase_order}) + rm_obj.update( + { + "consumed_qty": qty, + "batch_no": batch_no, + "required_qty": qty, + "purchase_order": item_row.purchase_order, + } + ) self.__set_serial_nos(item_row, rm_obj) def __set_serial_nos(self, item_row, rm_obj): key = (rm_obj.rm_item_code, item_row.item_code, item_row.purchase_order) - if (self.available_materials.get(key) and self.available_materials[key]['serial_no']): - used_serial_nos = self.available_materials[key]['serial_no'][0: cint(rm_obj.consumed_qty)] - rm_obj.serial_no = '\n'.join(used_serial_nos) + if self.available_materials.get(key) and self.available_materials[key]["serial_no"]: + used_serial_nos = self.available_materials[key]["serial_no"][0 : cint(rm_obj.consumed_qty)] + rm_obj.serial_no = "\n".join(used_serial_nos) # Removed the used serial nos from the list for sn in used_serial_nos: - self.available_materials[key]['serial_no'].remove(sn) + self.available_materials[key]["serial_no"].remove(sn) def set_consumed_qty_in_po(self): # Update consumed qty back in the purchase order - if self.is_subcontracted != 'Yes': + if self.is_subcontracted != "Yes": return self.__get_purchase_orders() itemwise_consumed_qty = defaultdict(float) - for doctype in ['Purchase Receipt', 'Purchase Invoice']: + for doctype in ["Purchase Receipt", "Purchase Invoice"]: consumed_items, pr_items = self.__update_consumed_materials(doctype, return_consumed_items=True) for row in consumed_items: @@ -345,10 +424,12 @@ class Subcontracting(): self.__update_consumed_qty_in_po(itemwise_consumed_qty) def __update_consumed_qty_in_po(self, itemwise_consumed_qty): - fields = ['main_item_code', 'rm_item_code', 'parent', 'supplied_qty', 'name'] - filters = {'docstatus': 1, 'parent': ('in', self.purchase_orders)} + fields = ["main_item_code", "rm_item_code", "parent", "supplied_qty", "name"] + filters = {"docstatus": 1, "parent": ("in", self.purchase_orders)} - for row in frappe.get_all('Purchase Order Item Supplied', fields = fields, filters=filters, order_by='idx'): + for row in frappe.get_all( + "Purchase Order Item Supplied", fields=fields, filters=filters, order_by="idx" + ): key = (row.rm_item_code, row.main_item_code, row.parent) consumed_qty = itemwise_consumed_qty.get(key, 0) @@ -356,15 +437,13 @@ class Subcontracting(): consumed_qty = row.supplied_qty itemwise_consumed_qty[key] -= consumed_qty - frappe.db.set_value('Purchase Order Item Supplied', row.name, 'consumed_qty', consumed_qty) + frappe.db.set_value("Purchase Order Item Supplied", row.name, "consumed_qty", consumed_qty) def __validate_supplied_items(self): - if self.doctype not in ['Purchase Invoice', 'Purchase Receipt']: + if self.doctype not in ["Purchase Invoice", "Purchase Receipt"]: return for row in self.get(self.raw_material_table): - self.__validate_consumed_qty(row) - key = (row.rm_item_code, row.main_item_code, row.purchase_order) if not self.__transferred_items or not self.__transferred_items.get(key): return @@ -372,25 +451,21 @@ class Subcontracting(): self.__validate_batch_no(row, key) self.__validate_serial_no(row, key) - def __validate_consumed_qty(self, row): - if self.backflush_based_on != 'BOM' and flt(row.consumed_qty) == 0.0: - msg = f'Row {row.idx}: the consumed qty cannot be zero for the item {frappe.bold(row.rm_item_code)}' - - frappe.throw(_(msg),title=_('Consumed Items Qty Check')) - def __validate_batch_no(self, row, key): - if row.get('batch_no') and row.get('batch_no') not in self.__transferred_items.get(key).get('batch_no'): - link = get_link_to_form('Purchase Order', row.purchase_order) + if row.get("batch_no") and row.get("batch_no") not in self.__transferred_items.get(key).get( + "batch_no" + ): + link = get_link_to_form("Purchase Order", row.purchase_order) msg = f'The Batch No {frappe.bold(row.get("batch_no"))} has not supplied against the Purchase Order {link}' frappe.throw(_(msg), title=_("Incorrect Batch Consumed")) def __validate_serial_no(self, row, key): - if row.get('serial_no'): - serial_nos = get_serial_nos(row.get('serial_no')) - incorrect_sn = set(serial_nos).difference(self.__transferred_items.get(key).get('serial_no')) + if row.get("serial_no"): + serial_nos = get_serial_nos(row.get("serial_no")) + incorrect_sn = set(serial_nos).difference(self.__transferred_items.get(key).get("serial_no")) if incorrect_sn: incorrect_sn = "\n".join(incorrect_sn) - link = get_link_to_form('Purchase Order', row.purchase_order) - msg = f'The Serial Nos {incorrect_sn} has not supplied against the Purchase Order {link}' + link = get_link_to_form("Purchase Order", row.purchase_order) + msg = f"The Serial Nos {incorrect_sn} has not supplied against the Purchase Order {link}" frappe.throw(_(msg), title=_("Incorrect Serial Number Consumed")) diff --git a/erpnext/controllers/taxes_and_totals.py b/erpnext/controllers/taxes_and_totals.py index b9c95508152..66d4cad8037 100644 --- a/erpnext/controllers/taxes_and_totals.py +++ b/erpnext/controllers/taxes_and_totals.py @@ -37,6 +37,14 @@ class calculate_taxes_and_totals(object): self.set_discount_amount() self.apply_discount_amount() + # Update grand total as per cash and non trade discount + if self.doc.apply_discount_on == "Grand Total" and self.doc.get("is_cash_or_non_trade_discount"): + self.doc.grand_total -= self.doc.discount_amount + self.doc.base_grand_total -= self.doc.base_discount_amount + self.set_rounded_total() + + self.calculate_shipping_charges() + if self.doc.doctype in ["Sales Invoice", "Purchase Invoice"]: self.calculate_total_advance() @@ -50,7 +58,6 @@ class calculate_taxes_and_totals(object): self.initialize_taxes() self.determine_exclusive_rate() self.calculate_net_total() - self.calculate_shipping_charges() self.calculate_taxes() self.manipulate_grand_total_for_inclusive_tax() self.calculate_totals() @@ -58,23 +65,23 @@ class calculate_taxes_and_totals(object): self.calculate_total_net_weight() def validate_item_tax_template(self): - for item in self.doc.get('items'): - if item.item_code and item.get('item_tax_template'): + for item in self.doc.get("items"): + if item.item_code and item.get("item_tax_template"): item_doc = frappe.get_cached_doc("Item", item.item_code) args = { - 'net_rate': item.net_rate or item.rate, - 'tax_category': self.doc.get('tax_category'), - 'posting_date': self.doc.get('posting_date'), - 'bill_date': self.doc.get('bill_date'), - 'transaction_date': self.doc.get('transaction_date'), - 'company': self.doc.get('company') + "net_rate": item.net_rate or item.rate, + "tax_category": self.doc.get("tax_category"), + "posting_date": self.doc.get("posting_date"), + "bill_date": self.doc.get("bill_date"), + "transaction_date": self.doc.get("transaction_date"), + "company": self.doc.get("company"), } item_group = item_doc.item_group item_group_taxes = [] while item_group: - item_group_doc = frappe.get_cached_doc('Item Group', item_group) + item_group_doc = frappe.get_cached_doc("Item Group", item_group) item_group_taxes += item_group_doc.taxes or [] item_group = item_group_doc.parent_item_group @@ -89,9 +96,11 @@ class calculate_taxes_and_totals(object): if taxes: if item.item_tax_template not in taxes: item.item_tax_template = taxes[0] - frappe.msgprint(_("Row {0}: Item Tax template updated as per validity and rate applied").format( - item.idx, frappe.bold(item.item_code) - )) + frappe.msgprint( + _("Row {0}: Item Tax template updated as per validity and rate applied").format( + item.idx, frappe.bold(item.item_code) + ) + ) def validate_conversion_rate(self): # validate conversion rate @@ -100,12 +109,19 @@ class calculate_taxes_and_totals(object): self.doc.currency = company_currency self.doc.conversion_rate = 1.0 else: - validate_conversion_rate(self.doc.currency, self.doc.conversion_rate, - self.doc.meta.get_label("conversion_rate"), self.doc.company) + validate_conversion_rate( + self.doc.currency, + self.doc.conversion_rate, + self.doc.meta.get_label("conversion_rate"), + self.doc.company, + ) self.doc.conversion_rate = flt(self.doc.conversion_rate) def calculate_item_values(self): + if self.doc.get("is_consolidated"): + return + if not self.discount_amount_applied: for item in self.doc.get("items"): self.doc.round_floats_in(item) @@ -114,16 +130,30 @@ class calculate_taxes_and_totals(object): item.rate = 0.0 elif item.price_list_rate: if not item.rate or (item.pricing_rules and item.discount_percentage > 0): - item.rate = flt(item.price_list_rate * - (1.0 - (item.discount_percentage / 100.0)), item.precision("rate")) - item.discount_amount = item.price_list_rate * (item.discount_percentage / 100.0) - elif item.discount_amount and item.pricing_rules: - item.rate = item.price_list_rate - item.discount_amount + item.rate = flt( + item.price_list_rate * (1.0 - (item.discount_percentage / 100.0)), item.precision("rate") + ) - if item.doctype in ['Quotation Item', 'Sales Order Item', 'Delivery Note Item', 'Sales Invoice Item', 'POS Invoice Item', 'Purchase Invoice Item', 'Purchase Order Item', 'Purchase Receipt Item']: + item.discount_amount = item.price_list_rate * (item.discount_percentage / 100.0) + + elif item.discount_amount and item.pricing_rules: + item.rate = item.price_list_rate - item.discount_amount + + if item.doctype in [ + "Quotation Item", + "Sales Order Item", + "Delivery Note Item", + "Sales Invoice Item", + "POS Invoice Item", + "Purchase Invoice Item", + "Purchase Order Item", + "Purchase Receipt Item", + ]: item.rate_with_margin, item.base_rate_with_margin = self.calculate_margin(item) if flt(item.rate_with_margin) > 0: - item.rate = flt(item.rate_with_margin * (1.0 - (item.discount_percentage / 100.0)), item.precision("rate")) + item.rate = flt( + item.rate_with_margin * (1.0 - (item.discount_percentage / 100.0)), item.precision("rate") + ) if item.discount_amount and not item.discount_percentage: item.rate = item.rate_with_margin - item.discount_amount @@ -139,19 +169,25 @@ class calculate_taxes_and_totals(object): if not item.qty and self.doc.get("is_return"): item.amount = flt(-1 * item.rate, item.precision("amount")) + elif not item.qty and self.doc.get("is_debit_note"): + item.amount = flt(item.rate, item.precision("amount")) else: - item.amount = flt(item.rate * item.qty, item.precision("amount")) + item.amount = flt(item.rate * item.qty, item.precision("amount")) item.net_amount = item.amount - self._set_in_company_currency(item, ["price_list_rate", "rate", "net_rate", "amount", "net_amount"]) + self._set_in_company_currency( + item, ["price_list_rate", "rate", "net_rate", "amount", "net_amount"] + ) item.item_tax_amount = 0.0 def _set_in_company_currency(self, doc, fields): """set values in base currency""" for f in fields: - val = flt(flt(doc.get(f), doc.precision(f)) * self.doc.conversion_rate, doc.precision("base_" + f)) + val = flt( + flt(doc.get(f), doc.precision(f)) * self.doc.conversion_rate, doc.precision("base_" + f) + ) doc.set("base_" + f, val) def initialize_taxes(self): @@ -160,16 +196,22 @@ class calculate_taxes_and_totals(object): validate_taxes_and_charges(tax) validate_inclusive_tax(tax, self.doc) - if not (self.doc.get('is_consolidated') or tax.get("dont_recompute_tax")): + if not (self.doc.get("is_consolidated") or tax.get("dont_recompute_tax")): tax.item_wise_tax_detail = {} - tax_fields = ["total", "tax_amount_after_discount_amount", - "tax_amount_for_current_item", "grand_total_for_current_item", - "tax_fraction_for_current_item", "grand_total_fraction_for_current_item"] + tax_fields = [ + "total", + "tax_amount_after_discount_amount", + "tax_amount_for_current_item", + "grand_total_for_current_item", + "tax_fraction_for_current_item", + "grand_total_fraction_for_current_item", + ] - if tax.charge_type != "Actual" and \ - not (self.discount_amount_applied and self.doc.apply_discount_on=="Grand Total"): - tax_fields.append("tax_amount") + if tax.charge_type != "Actual" and not ( + self.discount_amount_applied and self.doc.apply_discount_on == "Grand Total" + ): + tax_fields.append("tax_amount") for fieldname in tax_fields: tax.set(fieldname, 0.0) @@ -185,25 +227,32 @@ class calculate_taxes_and_totals(object): cumulated_tax_fraction = 0 total_inclusive_tax_amount_per_qty = 0 for i, tax in enumerate(self.doc.get("taxes")): - tax.tax_fraction_for_current_item, inclusive_tax_amount_per_qty = self.get_current_tax_fraction(tax, item_tax_map) + ( + tax.tax_fraction_for_current_item, + inclusive_tax_amount_per_qty, + ) = self.get_current_tax_fraction(tax, item_tax_map) - if i==0: + if i == 0: tax.grand_total_fraction_for_current_item = 1 + tax.tax_fraction_for_current_item else: - tax.grand_total_fraction_for_current_item = \ - self.doc.get("taxes")[i-1].grand_total_fraction_for_current_item \ + tax.grand_total_fraction_for_current_item = ( + self.doc.get("taxes")[i - 1].grand_total_fraction_for_current_item + tax.tax_fraction_for_current_item + ) cumulated_tax_fraction += tax.tax_fraction_for_current_item total_inclusive_tax_amount_per_qty += inclusive_tax_amount_per_qty * flt(item.qty) - if not self.discount_amount_applied and item.qty and (cumulated_tax_fraction or total_inclusive_tax_amount_per_qty): + if ( + not self.discount_amount_applied + and item.qty + and (cumulated_tax_fraction or total_inclusive_tax_amount_per_qty) + ): amount = flt(item.amount) - total_inclusive_tax_amount_per_qty item.net_amount = flt(amount / (1 + cumulated_tax_fraction)) item.net_rate = flt(item.net_amount / item.qty, item.precision("net_rate")) - item.discount_percentage = flt(item.discount_percentage, - item.precision("discount_percentage")) + item.discount_percentage = flt(item.discount_percentage, item.precision("discount_percentage")) self._set_in_company_currency(item, ["net_rate", "net_amount"]) @@ -212,8 +261,8 @@ class calculate_taxes_and_totals(object): def get_current_tax_fraction(self, tax, item_tax_map): """ - Get tax fraction for calculating tax exclusive amount - from tax inclusive amount + Get tax fraction for calculating tax exclusive amount + from tax inclusive amount """ current_tax_fraction = 0 inclusive_tax_amount_per_qty = 0 @@ -225,12 +274,14 @@ class calculate_taxes_and_totals(object): current_tax_fraction = tax_rate / 100.0 elif tax.charge_type == "On Previous Row Amount": - current_tax_fraction = (tax_rate / 100.0) * \ - self.doc.get("taxes")[cint(tax.row_id) - 1].tax_fraction_for_current_item + current_tax_fraction = (tax_rate / 100.0) * self.doc.get("taxes")[ + cint(tax.row_id) - 1 + ].tax_fraction_for_current_item elif tax.charge_type == "On Previous Row Total": - current_tax_fraction = (tax_rate / 100.0) * \ - self.doc.get("taxes")[cint(tax.row_id) - 1].grand_total_fraction_for_current_item + current_tax_fraction = (tax_rate / 100.0) * self.doc.get("taxes")[ + cint(tax.row_id) - 1 + ].grand_total_fraction_for_current_item elif tax.charge_type == "On Item Quantity": inclusive_tax_amount_per_qty = flt(tax_rate) @@ -248,7 +299,9 @@ class calculate_taxes_and_totals(object): return tax.rate def calculate_net_total(self): - self.doc.total_qty = self.doc.total = self.doc.base_total = self.doc.net_total = self.doc.base_net_total = 0.0 + self.doc.total_qty = ( + self.doc.total + ) = self.doc.base_total = self.doc.net_total = self.doc.base_net_total = 0.0 for item in self.doc.get("items"): self.doc.total += item.amount @@ -260,17 +313,32 @@ class calculate_taxes_and_totals(object): self.doc.round_floats_in(self.doc, ["total", "base_total", "net_total", "base_net_total"]) def calculate_shipping_charges(self): + + # Do not apply shipping rule for POS + if self.doc.get("is_pos"): + return + if hasattr(self.doc, "shipping_rule") and self.doc.shipping_rule: shipping_rule = frappe.get_doc("Shipping Rule", self.doc.shipping_rule) shipping_rule.apply(self.doc) + self._calculate() + def calculate_taxes(self): - if not self.doc.get('is_consolidated'): + rounding_adjustment_computed = self.doc.get("is_consolidated") and self.doc.get( + "rounding_adjustment" + ) + if not rounding_adjustment_computed: self.doc.rounding_adjustment = 0 # maintain actual tax rate based on idx - actual_tax_dict = dict([[tax.idx, flt(tax.tax_amount, tax.precision("tax_amount"))] - for tax in self.doc.get("taxes") if tax.charge_type == "Actual"]) + actual_tax_dict = dict( + [ + [tax.idx, flt(tax.tax_amount, tax.precision("tax_amount"))] + for tax in self.doc.get("taxes") + if tax.charge_type == "Actual" + ] + ) for n, item in enumerate(self.doc.get("items")): item_tax_map = self._load_item_tax_rate(item.item_tax_rate) @@ -285,9 +353,10 @@ class calculate_taxes_and_totals(object): current_tax_amount += actual_tax_dict[tax.idx] # accumulate tax amount into tax.tax_amount - if tax.charge_type != "Actual" and \ - not (self.discount_amount_applied and self.doc.apply_discount_on=="Grand Total"): - tax.tax_amount += current_tax_amount + if tax.charge_type != "Actual" and not ( + self.discount_amount_applied and self.doc.apply_discount_on == "Grand Total" + ): + tax.tax_amount += current_tax_amount # store tax_amount for current item as it will be used for # charge type = 'On Previous Row Amount' @@ -300,17 +369,17 @@ class calculate_taxes_and_totals(object): # note: grand_total_for_current_item contains the contribution of # item's amount, previously applied tax and the current tax on that item - if i==0: + if i == 0: tax.grand_total_for_current_item = flt(item.net_amount + current_tax_amount) else: - tax.grand_total_for_current_item = \ - flt(self.doc.get("taxes")[i-1].grand_total_for_current_item + current_tax_amount) + tax.grand_total_for_current_item = flt( + self.doc.get("taxes")[i - 1].grand_total_for_current_item + current_tax_amount + ) # set precision in the last item iteration if n == len(self.doc.get("items")) - 1: self.round_off_totals(tax) - self._set_in_company_currency(tax, - ["tax_amount", "tax_amount_after_discount_amount"]) + self._set_in_company_currency(tax, ["tax_amount", "tax_amount_after_discount_amount"]) self.round_off_base_values(tax) self.set_cumulative_total(i, tax) @@ -318,20 +387,29 @@ class calculate_taxes_and_totals(object): self._set_in_company_currency(tax, ["total"]) # adjust Discount Amount loss in last tax iteration - if i == (len(self.doc.get("taxes")) - 1) and self.discount_amount_applied \ - and self.doc.discount_amount \ - and self.doc.apply_discount_on == "Grand Total" \ - and not self.doc.get('is_consolidated'): - self.doc.rounding_adjustment = flt(self.doc.grand_total - - flt(self.doc.discount_amount) - tax.total, - self.doc.precision("rounding_adjustment")) + if ( + i == (len(self.doc.get("taxes")) - 1) + and self.discount_amount_applied + and self.doc.discount_amount + and self.doc.apply_discount_on == "Grand Total" + and not rounding_adjustment_computed + ): + self.doc.rounding_adjustment = flt( + self.doc.grand_total - flt(self.doc.discount_amount) - tax.total, + self.doc.precision("rounding_adjustment"), + ) def get_tax_amount_if_for_valuation_or_deduction(self, tax_amount, tax): # if just for valuation, do not add the tax amount in total # if tax/charges is for deduction, multiply by -1 if getattr(tax, "category", None): tax_amount = 0.0 if (tax.category == "Valuation") else tax_amount - if self.doc.doctype in ["Purchase Order", "Purchase Invoice", "Purchase Receipt", "Supplier Quotation"]: + if self.doc.doctype in [ + "Purchase Order", + "Purchase Invoice", + "Purchase Receipt", + "Supplier Quotation", + ]: tax_amount *= -1.0 if (tax.add_deduct_tax == "Deduct") else 1.0 return tax_amount @@ -342,7 +420,7 @@ class calculate_taxes_and_totals(object): if row_idx == 0: tax.total = flt(self.doc.net_total + tax_amount, tax.precision("total")) else: - tax.total = flt(self.doc.get("taxes")[row_idx-1].total + tax_amount, tax.precision("total")) + tax.total = flt(self.doc.get("taxes")[row_idx - 1].total + tax_amount, tax.precision("total")) def get_current_tax_amount(self, item, tax, item_tax_map): tax_rate = self._get_tax_rate(tax, item_tax_map) @@ -351,16 +429,20 @@ class calculate_taxes_and_totals(object): if tax.charge_type == "Actual": # distribute the tax amount proportionally to each item row actual = flt(tax.tax_amount, tax.precision("tax_amount")) - current_tax_amount = item.net_amount*actual / self.doc.net_total if self.doc.net_total else 0.0 + current_tax_amount = ( + item.net_amount * actual / self.doc.net_total if self.doc.net_total else 0.0 + ) elif tax.charge_type == "On Net Total": current_tax_amount = (tax_rate / 100.0) * item.net_amount elif tax.charge_type == "On Previous Row Amount": - current_tax_amount = (tax_rate / 100.0) * \ - self.doc.get("taxes")[cint(tax.row_id) - 1].tax_amount_for_current_item + current_tax_amount = (tax_rate / 100.0) * self.doc.get("taxes")[ + cint(tax.row_id) - 1 + ].tax_amount_for_current_item elif tax.charge_type == "On Previous Row Total": - current_tax_amount = (tax_rate / 100.0) * \ - self.doc.get("taxes")[cint(tax.row_id) - 1].grand_total_for_current_item + current_tax_amount = (tax_rate / 100.0) * self.doc.get("taxes")[ + cint(tax.row_id) - 1 + ].grand_total_for_current_item elif tax.charge_type == "On Item Quantity": current_tax_amount = tax_rate * item.qty @@ -372,11 +454,11 @@ class calculate_taxes_and_totals(object): def set_item_wise_tax(self, item, tax, tax_rate, current_tax_amount): # store tax breakup for each item key = item.item_code or item.item_name - item_wise_tax_amount = current_tax_amount*self.doc.conversion_rate + item_wise_tax_amount = current_tax_amount * self.doc.conversion_rate if tax.item_wise_tax_detail.get(key): item_wise_tax_amount += tax.item_wise_tax_detail[key][1] - tax.item_wise_tax_detail[key] = [tax_rate,flt(item_wise_tax_amount)] + tax.item_wise_tax_detail[key] = [tax_rate, flt(item_wise_tax_amount)] def round_off_totals(self, tax): if tax.account_head in frappe.flags.round_off_applicable_accounts: @@ -384,8 +466,9 @@ class calculate_taxes_and_totals(object): tax.tax_amount_after_discount_amount = round(tax.tax_amount_after_discount_amount, 0) tax.tax_amount = flt(tax.tax_amount, tax.precision("tax_amount")) - tax.tax_amount_after_discount_amount = flt(tax.tax_amount_after_discount_amount, - tax.precision("tax_amount")) + tax.tax_amount_after_discount_amount = flt( + tax.tax_amount_after_discount_amount, tax.precision("tax_amount") + ) def round_off_base_values(self, tax): # Round off to nearest integer based on regional settings @@ -397,11 +480,15 @@ class calculate_taxes_and_totals(object): # if fully inclusive taxes and diff if self.doc.get("taxes") and any(cint(t.included_in_print_rate) for t in self.doc.get("taxes")): last_tax = self.doc.get("taxes")[-1] - non_inclusive_tax_amount = sum(flt(d.tax_amount_after_discount_amount) - for d in self.doc.get("taxes") if not d.included_in_print_rate) + non_inclusive_tax_amount = sum( + flt(d.tax_amount_after_discount_amount) + for d in self.doc.get("taxes") + if not d.included_in_print_rate + ) - diff = self.doc.total + non_inclusive_tax_amount \ - - flt(last_tax.total, last_tax.precision("total")) + diff = ( + self.doc.total + non_inclusive_tax_amount - flt(last_tax.total, last_tax.precision("total")) + ) # If discount amount applied, deduct the discount amount # because self.doc.total is always without discount, but last_tax.total is after discount @@ -410,7 +497,7 @@ class calculate_taxes_and_totals(object): diff = flt(diff, self.doc.precision("rounding_adjustment")) - if diff and abs(diff) <= (5.0 / 10**last_tax.precision("tax_amount")): + if diff and abs(diff) <= (5.0 / 10 ** last_tax.precision("tax_amount")): self.doc.rounding_adjustment = diff def calculate_totals(self): @@ -420,16 +507,27 @@ class calculate_taxes_and_totals(object): self.doc.grand_total = flt(self.doc.net_total) if self.doc.get("taxes"): - self.doc.total_taxes_and_charges = flt(self.doc.grand_total - self.doc.net_total - - flt(self.doc.rounding_adjustment), self.doc.precision("total_taxes_and_charges")) + self.doc.total_taxes_and_charges = flt( + self.doc.grand_total - self.doc.net_total - flt(self.doc.rounding_adjustment), + self.doc.precision("total_taxes_and_charges"), + ) else: self.doc.total_taxes_and_charges = 0.0 self._set_in_company_currency(self.doc, ["total_taxes_and_charges", "rounding_adjustment"]) - if self.doc.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice", "POS Invoice"]: - self.doc.base_grand_total = flt(self.doc.grand_total * self.doc.conversion_rate, self.doc.precision("base_grand_total")) \ - if self.doc.total_taxes_and_charges else self.doc.base_net_total + if self.doc.doctype in [ + "Quotation", + "Sales Order", + "Delivery Note", + "Sales Invoice", + "POS Invoice", + ]: + self.doc.base_grand_total = ( + flt(self.doc.grand_total * self.doc.conversion_rate, self.doc.precision("base_grand_total")) + if self.doc.total_taxes_and_charges + else self.doc.base_net_total + ) else: self.doc.taxes_and_charges_added = self.doc.taxes_and_charges_deducted = 0.0 for tax in self.doc.get("taxes"): @@ -441,58 +539,76 @@ class calculate_taxes_and_totals(object): self.doc.round_floats_in(self.doc, ["taxes_and_charges_added", "taxes_and_charges_deducted"]) - self.doc.base_grand_total = flt(self.doc.grand_total * self.doc.conversion_rate) \ - if (self.doc.taxes_and_charges_added or self.doc.taxes_and_charges_deducted) \ + self.doc.base_grand_total = ( + flt(self.doc.grand_total * self.doc.conversion_rate) + if (self.doc.taxes_and_charges_added or self.doc.taxes_and_charges_deducted) else self.doc.base_net_total + ) - self._set_in_company_currency(self.doc, - ["taxes_and_charges_added", "taxes_and_charges_deducted"]) + self._set_in_company_currency( + self.doc, ["taxes_and_charges_added", "taxes_and_charges_deducted"] + ) self.doc.round_floats_in(self.doc, ["grand_total", "base_grand_total"]) self.set_rounded_total() def calculate_total_net_weight(self): - if self.doc.meta.get_field('total_net_weight'): + if self.doc.meta.get_field("total_net_weight"): self.doc.total_net_weight = 0.0 for d in self.doc.items: if d.total_weight: self.doc.total_net_weight += d.total_weight def set_rounded_total(self): - if not self.doc.get('is_consolidated'): - if self.doc.meta.get_field("rounded_total"): - if self.doc.is_rounded_total_disabled(): - self.doc.rounded_total = self.doc.base_rounded_total = 0 - return + if self.doc.get("is_consolidated") and self.doc.get("rounding_adjustment"): + return - self.doc.rounded_total = round_based_on_smallest_currency_fraction(self.doc.grand_total, - self.doc.currency, self.doc.precision("rounded_total")) + if self.doc.meta.get_field("rounded_total"): + if self.doc.is_rounded_total_disabled(): + self.doc.rounded_total = self.doc.base_rounded_total = 0 + return - #if print_in_rate is set, we would have already calculated rounding adjustment - self.doc.rounding_adjustment += flt(self.doc.rounded_total - self.doc.grand_total, - self.doc.precision("rounding_adjustment")) + self.doc.rounded_total = round_based_on_smallest_currency_fraction( + self.doc.grand_total, self.doc.currency, self.doc.precision("rounded_total") + ) - self._set_in_company_currency(self.doc, ["rounding_adjustment", "rounded_total"]) + # if print_in_rate is set, we would have already calculated rounding adjustment + self.doc.rounding_adjustment += flt( + self.doc.rounded_total - self.doc.grand_total, self.doc.precision("rounding_adjustment") + ) + + self._set_in_company_currency(self.doc, ["rounding_adjustment", "rounded_total"]) def _cleanup(self): - if not self.doc.get('is_consolidated'): + if not self.doc.get("is_consolidated"): for tax in self.doc.get("taxes"): if not tax.get("dont_recompute_tax"): - tax.item_wise_tax_detail = json.dumps(tax.item_wise_tax_detail, separators=(',', ':')) + tax.item_wise_tax_detail = json.dumps(tax.item_wise_tax_detail, separators=(",", ":")) def set_discount_amount(self): if self.doc.additional_discount_percentage: - self.doc.discount_amount = flt(flt(self.doc.get(scrub(self.doc.apply_discount_on))) - * self.doc.additional_discount_percentage / 100, self.doc.precision("discount_amount")) + self.doc.discount_amount = flt( + flt(self.doc.get(scrub(self.doc.apply_discount_on))) + * self.doc.additional_discount_percentage + / 100, + self.doc.precision("discount_amount"), + ) def apply_discount_amount(self): if self.doc.discount_amount: if not self.doc.apply_discount_on: frappe.throw(_("Please select Apply Discount On")) - self.doc.base_discount_amount = flt(self.doc.discount_amount * self.doc.conversion_rate, - self.doc.precision("base_discount_amount")) + self.doc.base_discount_amount = flt( + self.doc.discount_amount * self.doc.conversion_rate, self.doc.precision("base_discount_amount") + ) + + if self.doc.apply_discount_on == "Grand Total" and self.doc.get( + "is_cash_or_non_trade_discount" + ): + self.discount_amount_applied = True + return total_for_discount_amount = self.get_total_for_discount_amount() taxes = self.doc.get("taxes") @@ -501,20 +617,24 @@ class calculate_taxes_and_totals(object): if total_for_discount_amount: # calculate item amount after Discount Amount for i, item in enumerate(self.doc.get("items")): - distributed_amount = flt(self.doc.discount_amount) * \ - item.net_amount / total_for_discount_amount + distributed_amount = ( + flt(self.doc.discount_amount) * item.net_amount / total_for_discount_amount + ) item.net_amount = flt(item.net_amount - distributed_amount, item.precision("net_amount")) net_total += item.net_amount # discount amount rounding loss adjustment if no taxes - if (self.doc.apply_discount_on == "Net Total" or not taxes or total_for_discount_amount==self.doc.net_total) \ - and i == len(self.doc.get("items")) - 1: - discount_amount_loss = flt(self.doc.net_total - net_total - self.doc.discount_amount, - self.doc.precision("net_total")) + if ( + self.doc.apply_discount_on == "Net Total" + or not taxes + or total_for_discount_amount == self.doc.net_total + ) and i == len(self.doc.get("items")) - 1: + discount_amount_loss = flt( + self.doc.net_total - net_total - self.doc.discount_amount, self.doc.precision("net_total") + ) - item.net_amount = flt(item.net_amount + discount_amount_loss, - item.precision("net_amount")) + item.net_amount = flt(item.net_amount + discount_amount_loss, item.precision("net_amount")) item.net_rate = flt(item.net_amount / item.qty, item.precision("net_rate")) if item.qty else 0 @@ -539,42 +659,56 @@ class calculate_taxes_and_totals(object): actual_tax_amount = flt(actual_taxes_dict.get(tax.row_id, 0)) * flt(tax.rate) / 100 actual_taxes_dict.setdefault(tax.idx, actual_tax_amount) - return flt(self.doc.grand_total - sum(actual_taxes_dict.values()), - self.doc.precision("grand_total")) - + return flt( + self.doc.grand_total - sum(actual_taxes_dict.values()), self.doc.precision("grand_total") + ) def calculate_total_advance(self): if self.doc.docstatus < 2: - total_allocated_amount = sum(flt(adv.allocated_amount, adv.precision("allocated_amount")) - for adv in self.doc.get("advances")) + total_allocated_amount = sum( + flt(adv.allocated_amount, adv.precision("allocated_amount")) + for adv in self.doc.get("advances") + ) self.doc.total_advance = flt(total_allocated_amount, self.doc.precision("total_advance")) grand_total = self.doc.rounded_total or self.doc.grand_total if self.doc.party_account_currency == self.doc.currency: - invoice_total = flt(grand_total - flt(self.doc.write_off_amount), - self.doc.precision("grand_total")) + invoice_total = flt( + grand_total - flt(self.doc.write_off_amount), self.doc.precision("grand_total") + ) else: - base_write_off_amount = flt(flt(self.doc.write_off_amount) * self.doc.conversion_rate, - self.doc.precision("base_write_off_amount")) - invoice_total = flt(grand_total * self.doc.conversion_rate, - self.doc.precision("grand_total")) - base_write_off_amount + base_write_off_amount = flt( + flt(self.doc.write_off_amount) * self.doc.conversion_rate, + self.doc.precision("base_write_off_amount"), + ) + invoice_total = ( + flt(grand_total * self.doc.conversion_rate, self.doc.precision("grand_total")) + - base_write_off_amount + ) if invoice_total > 0 and self.doc.total_advance > invoice_total: - frappe.throw(_("Advance amount cannot be greater than {0} {1}") - .format(self.doc.party_account_currency, invoice_total)) + frappe.throw( + _("Advance amount cannot be greater than {0} {1}").format( + self.doc.party_account_currency, invoice_total + ) + ) if self.doc.docstatus == 0: + if self.doc.get("write_off_outstanding_amount_automatically"): + self.doc.write_off_amount = 0 + self.calculate_outstanding_amount() + self.calculate_write_off_amount() def is_internal_invoice(self): """ - Checks if its an internal transfer invoice - and decides if to calculate any out standing amount or not + Checks if its an internal transfer invoice + and decides if to calculate any out standing amount or not """ - if self.doc.doctype in ('Sales Invoice', 'Purchase Invoice') and self.doc.is_internal_transfer(): + if self.doc.doctype in ("Sales Invoice", "Purchase Invoice") and self.doc.is_internal_transfer(): return True return False @@ -586,56 +720,93 @@ class calculate_taxes_and_totals(object): if self.doc.doctype == "Sales Invoice": self.calculate_paid_amount() - if self.doc.is_return and self.doc.return_against and not self.doc.get('is_pos') or \ - self.is_internal_invoice(): return + if ( + self.doc.is_return + and self.doc.return_against + and not self.doc.get("is_pos") + or self.is_internal_invoice() + ): + return self.doc.round_floats_in(self.doc, ["grand_total", "total_advance", "write_off_amount"]) - self._set_in_company_currency(self.doc, ['write_off_amount']) + self._set_in_company_currency(self.doc, ["write_off_amount"]) if self.doc.doctype in ["Sales Invoice", "Purchase Invoice"]: grand_total = self.doc.rounded_total or self.doc.grand_total + base_grand_total = self.doc.base_rounded_total or self.doc.base_grand_total + if self.doc.party_account_currency == self.doc.currency: - total_amount_to_pay = flt(grand_total - self.doc.total_advance - - flt(self.doc.write_off_amount), self.doc.precision("grand_total")) + total_amount_to_pay = flt( + grand_total - self.doc.total_advance - flt(self.doc.write_off_amount), + self.doc.precision("grand_total"), + ) else: - total_amount_to_pay = flt(flt(grand_total * - self.doc.conversion_rate, self.doc.precision("grand_total")) - self.doc.total_advance - - flt(self.doc.base_write_off_amount), self.doc.precision("grand_total")) + total_amount_to_pay = flt( + flt(base_grand_total, self.doc.precision("base_grand_total")) + - self.doc.total_advance + - flt(self.doc.base_write_off_amount), + self.doc.precision("base_grand_total"), + ) self.doc.round_floats_in(self.doc, ["paid_amount"]) change_amount = 0 - if self.doc.doctype == "Sales Invoice" and not self.doc.get('is_return'): - self.calculate_write_off_amount() + if self.doc.doctype == "Sales Invoice" and not self.doc.get("is_return"): self.calculate_change_amount() - change_amount = self.doc.change_amount \ - if self.doc.party_account_currency == self.doc.currency else self.doc.base_change_amount + change_amount = ( + self.doc.change_amount + if self.doc.party_account_currency == self.doc.currency + else self.doc.base_change_amount + ) - paid_amount = self.doc.paid_amount \ - if self.doc.party_account_currency == self.doc.currency else self.doc.base_paid_amount + paid_amount = ( + self.doc.paid_amount + if self.doc.party_account_currency == self.doc.currency + else self.doc.base_paid_amount + ) - self.doc.outstanding_amount = flt(total_amount_to_pay - flt(paid_amount) + flt(change_amount), - self.doc.precision("outstanding_amount")) + self.doc.outstanding_amount = flt( + total_amount_to_pay - flt(paid_amount) + flt(change_amount), + self.doc.precision("outstanding_amount"), + ) - if self.doc.doctype == 'Sales Invoice' and self.doc.get('is_pos') and self.doc.get('is_return'): - self.update_paid_amount_for_return(total_amount_to_pay) + if ( + self.doc.doctype == "Sales Invoice" + and self.doc.get("is_pos") + and self.doc.get("pos_profile") + and self.doc.get("is_consolidated") + ): + write_off_limit = flt( + frappe.db.get_value("POS Profile", self.doc.pos_profile, "write_off_limit") + ) + if write_off_limit and abs(self.doc.outstanding_amount) <= write_off_limit: + self.doc.write_off_outstanding_amount_automatically = 1 + + if ( + self.doc.doctype == "Sales Invoice" + and self.doc.get("is_pos") + and self.doc.get("is_return") + and not self.doc.get("is_consolidated") + ): + self.set_total_amount_to_default_mop(total_amount_to_pay) + self.calculate_paid_amount() def calculate_paid_amount(self): paid_amount = base_paid_amount = 0.0 if self.doc.is_pos: - for payment in self.doc.get('payments'): + for payment in self.doc.get("payments"): payment.amount = flt(payment.amount) payment.base_amount = payment.amount * flt(self.doc.conversion_rate) paid_amount += payment.amount base_paid_amount += payment.base_amount elif not self.doc.is_return: - self.doc.set('payments', []) + self.doc.set("payments", []) if self.doc.redeem_loyalty_points and self.doc.loyalty_amount: base_paid_amount += self.doc.loyalty_amount - paid_amount += (self.doc.loyalty_amount / flt(self.doc.conversion_rate)) + paid_amount += self.doc.loyalty_amount / flt(self.doc.conversion_rate) self.doc.paid_amount = flt(paid_amount, self.doc.precision("paid_amount")) self.doc.base_paid_amount = flt(base_paid_amount, self.doc.precision("base_paid_amount")) @@ -643,25 +814,35 @@ class calculate_taxes_and_totals(object): def calculate_change_amount(self): self.doc.change_amount = 0.0 self.doc.base_change_amount = 0.0 + grand_total = self.doc.rounded_total or self.doc.grand_total + base_grand_total = self.doc.base_rounded_total or self.doc.base_grand_total - if self.doc.doctype == "Sales Invoice" \ - and self.doc.paid_amount > self.doc.grand_total and not self.doc.is_return \ - and any(d.type == "Cash" for d in self.doc.payments): - grand_total = self.doc.rounded_total or self.doc.grand_total - base_grand_total = self.doc.base_rounded_total or self.doc.base_grand_total + if ( + self.doc.doctype == "Sales Invoice" + and self.doc.paid_amount > grand_total + and not self.doc.is_return + and any(d.type == "Cash" for d in self.doc.payments) + ): - self.doc.change_amount = flt(self.doc.paid_amount - grand_total + - self.doc.write_off_amount, self.doc.precision("change_amount")) + self.doc.change_amount = flt( + self.doc.paid_amount - grand_total, self.doc.precision("change_amount") + ) - self.doc.base_change_amount = flt(self.doc.base_paid_amount - base_grand_total + - self.doc.base_write_off_amount, self.doc.precision("base_change_amount")) + self.doc.base_change_amount = flt( + self.doc.base_paid_amount - base_grand_total, self.doc.precision("base_change_amount") + ) def calculate_write_off_amount(self): - if flt(self.doc.change_amount) > 0: - self.doc.write_off_amount = flt(self.doc.grand_total - self.doc.paid_amount - + self.doc.change_amount, self.doc.precision("write_off_amount")) - self.doc.base_write_off_amount = flt(self.doc.write_off_amount * self.doc.conversion_rate, - self.doc.precision("base_write_off_amount")) + if self.doc.get("write_off_outstanding_amount_automatically"): + self.doc.write_off_amount = flt( + self.doc.outstanding_amount, self.doc.precision("write_off_amount") + ) + self.doc.base_write_off_amount = flt( + self.doc.write_off_amount * self.doc.conversion_rate, + self.doc.precision("base_write_off_amount"), + ) + + self.calculate_outstanding_amount() def calculate_margin(self, item): rate_with_margin = 0.0 @@ -670,10 +851,15 @@ class calculate_taxes_and_totals(object): if item.pricing_rules and not self.doc.ignore_pricing_rule: has_margin = False for d in get_applied_pricing_rules(item.pricing_rules): - pricing_rule = frappe.get_cached_doc('Pricing Rule', d) + pricing_rule = frappe.get_cached_doc("Pricing Rule", d) - if pricing_rule.margin_rate_or_amount and ((pricing_rule.currency == self.doc.currency and - pricing_rule.margin_type in ['Amount', 'Percentage']) or pricing_rule.margin_type == 'Percentage'): + if pricing_rule.margin_rate_or_amount and ( + ( + pricing_rule.currency == self.doc.currency + and pricing_rule.margin_type in ["Amount", "Percentage"] + ) + or pricing_rule.margin_type == "Percentage" + ): item.margin_type = pricing_rule.margin_type item.margin_rate_or_amount = pricing_rule.margin_rate_or_amount has_margin = True @@ -684,12 +870,17 @@ class calculate_taxes_and_totals(object): if not item.pricing_rules and flt(item.rate) > flt(item.price_list_rate): item.margin_type = "Amount" - item.margin_rate_or_amount = flt(item.rate - item.price_list_rate, - item.precision("margin_rate_or_amount")) + item.margin_rate_or_amount = flt( + item.rate - item.price_list_rate, item.precision("margin_rate_or_amount") + ) item.rate_with_margin = item.rate elif item.margin_type and item.margin_rate_or_amount: - margin_value = item.margin_rate_or_amount if item.margin_type == 'Amount' else flt(item.price_list_rate) * flt(item.margin_rate_or_amount) / 100 + margin_value = ( + item.margin_rate_or_amount + if item.margin_type == "Amount" + else flt(item.price_list_rate) * flt(item.margin_rate_or_amount) / 100 + ) rate_with_margin = flt(item.price_list_rate) + flt(margin_value) base_rate_with_margin = flt(rate_with_margin) * flt(self.doc.conversion_rate) @@ -698,19 +889,25 @@ class calculate_taxes_and_totals(object): def set_item_wise_tax_breakup(self): self.doc.other_charges_calculation = get_itemised_tax_breakup_html(self.doc) - def update_paid_amount_for_return(self, total_amount_to_pay): - default_mode_of_payment = frappe.db.get_value('POS Payment Method', - {'parent': self.doc.pos_profile, 'default': 1}, ['mode_of_payment'], as_dict=1) + def set_total_amount_to_default_mop(self, total_amount_to_pay): + default_mode_of_payment = frappe.db.get_value( + "POS Payment Method", + {"parent": self.doc.pos_profile, "default": 1}, + ["mode_of_payment"], + as_dict=1, + ) if default_mode_of_payment: self.doc.payments = [] - self.doc.append('payments', { - 'mode_of_payment': default_mode_of_payment.mode_of_payment, - 'amount': total_amount_to_pay, - 'default': 1 - }) + self.doc.append( + "payments", + { + "mode_of_payment": default_mode_of_payment.mode_of_payment, + "amount": total_amount_to_pay, + "default": 1, + }, + ) - self.calculate_paid_amount() def get_itemised_tax_breakup_html(doc): if not doc.taxes: @@ -720,7 +917,7 @@ def get_itemised_tax_breakup_html(doc): # get headers tax_accounts = [] for tax in doc.taxes: - if getattr(tax, "category", None) and tax.category=="Valuation": + if getattr(tax, "category", None) and tax.category == "Valuation": continue if tax.description not in tax_accounts: tax_accounts.append(tax.description) @@ -736,34 +933,40 @@ def get_itemised_tax_breakup_html(doc): frappe.flags.company = None return frappe.render_template( - "templates/includes/itemised_tax_breakup.html", dict( + "templates/includes/itemised_tax_breakup.html", + dict( headers=headers, itemised_tax=itemised_tax, itemised_taxable_amount=itemised_taxable_amount, tax_accounts=tax_accounts, - doc=doc - ) + doc=doc, + ), ) + @frappe.whitelist() def get_round_off_applicable_accounts(company, account_list): account_list = get_regional_round_off_accounts(company, account_list) return account_list + @erpnext.allow_regional def get_regional_round_off_accounts(company, account_list): pass + @erpnext.allow_regional def update_itemised_tax_data(doc): - #Don't delete this method, used for localization + # Don't delete this method, used for localization pass + @erpnext.allow_regional def get_itemised_tax_breakup_header(item_doctype, tax_accounts): return [_("Item"), _("Taxable Amount")] + tax_accounts + @erpnext.allow_regional def get_itemised_tax_breakup_data(doc): itemised_tax = get_itemised_tax(doc.taxes) @@ -772,10 +975,11 @@ def get_itemised_tax_breakup_data(doc): return itemised_tax, itemised_taxable_amount + def get_itemised_tax(taxes, with_tax_account=False): itemised_tax = {} for tax in taxes: - if getattr(tax, "category", None) and tax.category=="Valuation": + if getattr(tax, "category", None) and tax.category == "Valuation": continue item_tax_map = json.loads(tax.item_wise_tax_detail) if tax.item_wise_tax_detail else {} @@ -792,16 +996,16 @@ def get_itemised_tax(taxes, with_tax_account=False): else: tax_rate = flt(tax_data) - itemised_tax[item_code][tax.description] = frappe._dict(dict( - tax_rate = tax_rate, - tax_amount = tax_amount - )) + itemised_tax[item_code][tax.description] = frappe._dict( + dict(tax_rate=tax_rate, tax_amount=tax_amount) + ) if with_tax_account: itemised_tax[item_code][tax.description].tax_account = tax.account_head return itemised_tax + def get_itemised_taxable_amount(items): itemised_taxable_amount = frappe._dict() for item in items: @@ -811,16 +1015,18 @@ def get_itemised_taxable_amount(items): return itemised_taxable_amount + def get_rounded_tax_amount(itemised_tax, precision): # Rounding based on tax_amount precision for taxes in itemised_tax.values(): for tax_account in taxes: taxes[tax_account]["tax_amount"] = flt(taxes[tax_account]["tax_amount"], precision) + class init_landed_taxes_and_totals(object): def __init__(self, doc): self.doc = doc - self.tax_field = 'taxes' if self.doc.doctype == 'Landed Cost Voucher' else 'additional_costs' + self.tax_field = "taxes" if self.doc.doctype == "Landed Cost Voucher" else "additional_costs" self.set_account_currency() self.set_exchange_rate() self.set_amounts_in_company_currency() @@ -829,7 +1035,7 @@ class init_landed_taxes_and_totals(object): company_currency = erpnext.get_company_currency(self.doc.company) for d in self.doc.get(self.tax_field): if not d.account_currency: - account_currency = frappe.db.get_value('Account', d.expense_account, 'account_currency') + account_currency = frappe.db.get_value("Account", d.expense_account, "account_currency") d.account_currency = account_currency or company_currency def set_exchange_rate(self): @@ -838,8 +1044,12 @@ class init_landed_taxes_and_totals(object): if d.account_currency == company_currency: d.exchange_rate = 1 elif not d.exchange_rate: - d.exchange_rate = get_exchange_rate(self.doc.posting_date, account=d.expense_account, - account_currency=d.account_currency, company=self.doc.company) + d.exchange_rate = get_exchange_rate( + self.doc.posting_date, + account=d.expense_account, + account_currency=d.account_currency, + company=self.doc.company, + ) if not d.exchange_rate: frappe.throw(_("Row {0}: Exchange Rate is mandatory").format(d.idx)) diff --git a/erpnext/controllers/tests/test_item_variant.py b/erpnext/controllers/tests/test_item_variant.py index 391b5ec8819..c57e54f7fc8 100644 --- a/erpnext/controllers/tests/test_item_variant.py +++ b/erpnext/controllers/tests/test_item_variant.py @@ -1,4 +1,3 @@ - import json import unittest @@ -14,11 +13,12 @@ from erpnext.stock.doctype.quality_inspection.test_quality_inspection import ( class TestItemVariant(unittest.TestCase): def test_tables_in_template_copied_to_variant(self): - fields = [{'field_name': 'quality_inspection_template'}] + fields = [{"field_name": "quality_inspection_template"}] set_item_variant_settings(fields) variant = make_item_variant() self.assertEqual(variant.get("quality_inspection_template"), "_Test QC Template") + def create_variant_with_tables(item, args): if isinstance(args, string_types): args = json.loads(args) @@ -29,14 +29,11 @@ def create_variant_with_tables(item, args): template.save() variant = frappe.new_doc("Item") - variant.variant_based_on = 'Item Attribute' + variant.variant_based_on = "Item Attribute" variant_attributes = [] for d in template.attributes: - variant_attributes.append({ - "attribute": d.attribute, - "attribute_value": args.get(d.attribute) - }) + variant_attributes.append({"attribute": d.attribute, "attribute_value": args.get(d.attribute)}) variant.set("attributes", variant_attributes) copy_attributes_to_variant(template, variant) @@ -44,6 +41,7 @@ def create_variant_with_tables(item, args): return variant + def make_item_variant(): frappe.delete_doc_if_exists("Item", "_Test Variant Item-XSL", force=1) variant = create_variant_with_tables("_Test Variant Item", '{"Test Size": "Extra Small"}') @@ -52,6 +50,7 @@ def make_item_variant(): variant.save() return variant + def make_quality_inspection_template(): qc_template = "_Test QC Template" if frappe.db.exists("Quality Inspection Template", qc_template): @@ -61,10 +60,13 @@ def make_quality_inspection_template(): qc.quality_inspection_template_name = qc_template create_quality_inspection_parameter("Moisture") - qc.append('item_quality_inspection_parameter', { - "specification": "Moisture", - "value": "< 5%", - }) + qc.append( + "item_quality_inspection_parameter", + { + "specification": "Moisture", + "value": "< 5%", + }, + ) qc.insert() return qc.name diff --git a/erpnext/controllers/tests/test_mapper.py b/erpnext/controllers/tests/test_mapper.py index 0d8789abef6..919bcdab660 100644 --- a/erpnext/controllers/tests/test_mapper.py +++ b/erpnext/controllers/tests/test_mapper.py @@ -1,4 +1,3 @@ - import json import unittest @@ -11,14 +10,14 @@ from frappe.utils import add_months, nowdate class TestMapper(unittest.TestCase): def test_map_docs(self): - '''Test mapping of multiple source docs on a single target doc''' + """Test mapping of multiple source docs on a single target doc""" make_test_records("Item") - items = ['_Test Item', '_Test Item 2', '_Test FG Item'] + items = ["_Test Item", "_Test Item 2", "_Test FG Item"] # Make source docs (quotations) and a target doc (sales order) - qtn1, item_list_1 = self.make_quotation(items, '_Test Customer') - qtn2, item_list_2 = self.make_quotation(items, '_Test Customer') + qtn1, item_list_1 = self.make_quotation(items, "_Test Customer") + qtn2, item_list_2 = self.make_quotation(items, "_Test Customer") so, item_list_3 = self.make_sales_order() # Map source docs to target with corresponding mapper method @@ -27,20 +26,20 @@ class TestMapper(unittest.TestCase): # Assert that all inserted items are present in updated sales order src_items = item_list_1 + item_list_2 + item_list_3 - self.assertEqual(set(d for d in src_items), - set(d.item_code for d in updated_so.items)) - + self.assertEqual(set(d for d in src_items), set(d.item_code for d in updated_so.items)) def make_quotation(self, item_list, customer): - qtn = frappe.get_doc({ - "doctype": "Quotation", - "quotation_to": "Customer", - "party_name": customer, - "order_type": "Sales", - "transaction_date" : nowdate(), - "valid_till" : add_months(nowdate(), 1) - }) + qtn = frappe.get_doc( + { + "doctype": "Quotation", + "quotation_to": "Customer", + "party_name": customer, + "order_type": "Sales", + "transaction_date": nowdate(), + "valid_till": add_months(nowdate(), 1), + } + ) for item in item_list: qtn.append("items", {"qty": "2", "item_code": item}) @@ -48,21 +47,23 @@ class TestMapper(unittest.TestCase): return qtn, item_list def make_sales_order(self): - item = frappe.get_doc({ - "base_amount": 1000.0, - "base_rate": 100.0, - "description": "CPU", - "doctype": "Sales Order Item", - "item_code": "_Test Item", - "item_name": "CPU", - "parentfield": "items", - "qty": 10.0, - "rate": 100.0, - "warehouse": "_Test Warehouse - _TC", - "stock_uom": "_Test UOM", - "conversion_factor": 1.0, - "uom": "_Test UOM" - }) - so = frappe.get_doc(frappe.get_test_records('Sales Order')[0]) + item = frappe.get_doc( + { + "base_amount": 1000.0, + "base_rate": 100.0, + "description": "CPU", + "doctype": "Sales Order Item", + "item_code": "_Test Item", + "item_name": "CPU", + "parentfield": "items", + "qty": 10.0, + "rate": 100.0, + "warehouse": "_Test Warehouse - _TC", + "stock_uom": "_Test UOM", + "conversion_factor": 1.0, + "uom": "_Test UOM", + } + ) + so = frappe.get_doc(frappe.get_test_records("Sales Order")[0]) so.insert(ignore_permissions=True) return so, [item.item_code] diff --git a/erpnext/controllers/tests/test_qty_based_taxes.py b/erpnext/controllers/tests/test_qty_based_taxes.py index 226778db014..2e9dfd2faa0 100644 --- a/erpnext/controllers/tests/test_qty_based_taxes.py +++ b/erpnext/controllers/tests/test_qty_based_taxes.py @@ -1,4 +1,3 @@ - import unittest from uuid import uuid4 as _uuid4 @@ -6,104 +5,131 @@ import frappe def uuid4(): - return str(_uuid4()) + return str(_uuid4()) + class TestTaxes(unittest.TestCase): - def setUp(self): - self.company = frappe.get_doc({ - 'doctype': 'Company', - 'company_name': uuid4(), - 'abbr': ''.join(s[0] for s in uuid4().split('-')), - 'default_currency': 'USD', - 'country': 'United States', - }).insert() - self.account = frappe.get_doc({ - 'doctype': 'Account', - 'account_name': uuid4(), - 'account_type': 'Tax', - 'company': self.company.name, - 'parent_account': 'Duties and Taxes - {self.company.abbr}'.format(self=self) - }).insert() - self.item_group = frappe.get_doc({ - 'doctype': 'Item Group', - 'item_group_name': uuid4(), - 'parent_item_group': 'All Item Groups', - }).insert() - self.item_tax_template = frappe.get_doc({ - 'doctype': 'Item Tax Template', - 'title': uuid4(), - 'company': self.company.name, - 'taxes': [ - { - 'tax_type': self.account.name, - 'tax_rate': 2, - } - ] - }).insert() - self.item = frappe.get_doc({ - 'doctype': 'Item', - 'item_code': uuid4(), - 'item_group': self.item_group.name, - 'is_stock_item': 0, - 'taxes': [ - { - 'item_tax_template': self.item_tax_template.name, - 'tax_category': '', - } - ], - }).insert() - self.customer = frappe.get_doc({ - 'doctype': 'Customer', - 'customer_name': uuid4(), - 'customer_group': 'All Customer Groups', - }).insert() - self.supplier = frappe.get_doc({ - 'doctype': 'Supplier', - 'supplier_name': uuid4(), - 'supplier_group': 'All Supplier Groups', - }).insert() + def setUp(self): + self.company = frappe.get_doc( + { + "doctype": "Company", + "company_name": uuid4(), + "abbr": "".join(s[0] for s in uuid4().split("-")), + "default_currency": "USD", + "country": "United States", + } + ).insert() + self.account = frappe.get_doc( + { + "doctype": "Account", + "account_name": uuid4(), + "account_type": "Tax", + "company": self.company.name, + "parent_account": "Duties and Taxes - {self.company.abbr}".format(self=self), + } + ).insert() + self.item_group = frappe.get_doc( + { + "doctype": "Item Group", + "item_group_name": uuid4(), + "parent_item_group": "All Item Groups", + } + ).insert() + self.item_tax_template = frappe.get_doc( + { + "doctype": "Item Tax Template", + "title": uuid4(), + "company": self.company.name, + "taxes": [ + { + "tax_type": self.account.name, + "tax_rate": 2, + } + ], + } + ).insert() + self.item = frappe.get_doc( + { + "doctype": "Item", + "item_code": uuid4(), + "item_group": self.item_group.name, + "is_stock_item": 0, + "taxes": [ + { + "item_tax_template": self.item_tax_template.name, + "tax_category": "", + } + ], + } + ).insert() + self.customer = frappe.get_doc( + { + "doctype": "Customer", + "customer_name": uuid4(), + "customer_group": "All Customer Groups", + } + ).insert() + self.supplier = frappe.get_doc( + { + "doctype": "Supplier", + "supplier_name": uuid4(), + "supplier_group": "All Supplier Groups", + } + ).insert() - def test_taxes(self): - self.created_docs = [] - for dt in ['Purchase Order', 'Purchase Receipt', 'Purchase Invoice', - 'Quotation', 'Sales Order', 'Delivery Note', 'Sales Invoice']: - doc = frappe.get_doc({ - 'doctype': dt, - 'company': self.company.name, - 'supplier': self.supplier.name, - 'currency': "USD", - 'schedule_date': frappe.utils.nowdate(), - 'delivery_date': frappe.utils.nowdate(), - 'customer': self.customer.name, - 'buying_price_list' if dt.startswith('Purchase') else 'selling_price_list' - : 'Standard Buying' if dt.startswith('Purchase') else 'Standard Selling', - 'items': [ - { - 'item_code': self.item.name, - 'qty': 300, - 'rate': 100, - } - ], - 'taxes': [ - { - 'charge_type': 'On Item Quantity', - 'account_head': self.account.name, - 'description': 'N/A', - 'rate': 0, - }, - ], - }) - doc.run_method('set_missing_values') - doc.run_method('calculate_taxes_and_totals') - doc.insert() - self.assertEqual(doc.taxes[0].tax_amount, 600) - self.created_docs.append(doc) + def test_taxes(self): + self.created_docs = [] + for dt in [ + "Purchase Order", + "Purchase Receipt", + "Purchase Invoice", + "Quotation", + "Sales Order", + "Delivery Note", + "Sales Invoice", + ]: + doc = frappe.get_doc( + { + "doctype": dt, + "company": self.company.name, + "supplier": self.supplier.name, + "currency": "USD", + "schedule_date": frappe.utils.nowdate(), + "delivery_date": frappe.utils.nowdate(), + "customer": self.customer.name, + "buying_price_list" + if dt.startswith("Purchase") + else "selling_price_list": "Standard Buying" + if dt.startswith("Purchase") + else "Standard Selling", + "items": [ + { + "item_code": self.item.name, + "qty": 300, + "rate": 100, + } + ], + "taxes": [ + { + "charge_type": "On Item Quantity", + "account_head": self.account.name, + "description": "N/A", + "rate": 0, + }, + ], + } + ) + doc.run_method("set_missing_values") + doc.run_method("calculate_taxes_and_totals") + doc.insert() + self.assertEqual(doc.taxes[0].tax_amount, 600) + self.created_docs.append(doc) - def tearDown(self): - for doc in self.created_docs: - doc.delete() - self.item.delete() - self.item_group.delete() - self.item_tax_template.delete() - self.account.delete() - self.company.delete() + def tearDown(self): + for doc in self.created_docs: + doc.delete() + self.item.delete() + self.item_group.delete() + self.item_tax_template.delete() + self.account.delete() + self.company.delete() diff --git a/erpnext/controllers/tests/test_queries.py b/erpnext/controllers/tests/test_queries.py index 05541d16887..60d1733021c 100644 --- a/erpnext/controllers/tests/test_queries.py +++ b/erpnext/controllers/tests/test_queries.py @@ -1,6 +1,8 @@ import unittest from functools import partial +import frappe + from erpnext.controllers import queries @@ -54,6 +56,12 @@ class TestQueries(unittest.TestCase): bundled_stock_items = query(txt="_test product bundle item 5", filters={"is_stock_item": 1}) self.assertEqual(len(bundled_stock_items), 0) + # empty customer/supplier should be stripped of instead of failure + query(txt="", filters={"customer": None}) + query(txt="", filters={"customer": ""}) + query(txt="", filters={"supplier": None}) + query(txt="", filters={"supplier": ""}) + def test_bom_qury(self): query = add_default_params(queries.bom, "BOM") @@ -85,3 +93,6 @@ class TestQueries(unittest.TestCase): wh = query(filters=[["Bin", "item_code", "=", "_Test Item"]]) self.assertGreaterEqual(len(wh), 1) + + def test_default_uoms(self): + self.assertGreaterEqual(frappe.db.count("UOM", {"enabled": 1}), 10) diff --git a/erpnext/controllers/tests/test_transaction_base.py b/erpnext/controllers/tests/test_transaction_base.py index 13aa697610e..1471543f1b2 100644 --- a/erpnext/controllers/tests/test_transaction_base.py +++ b/erpnext/controllers/tests/test_transaction_base.py @@ -4,19 +4,88 @@ import frappe class TestUtils(unittest.TestCase): - def test_reset_default_field_value(self): - doc = frappe.get_doc({ - "doctype": "Purchase Receipt", - "set_warehouse": "Warehouse 1", - }) + def test_reset_default_field_value(self): + doc = frappe.get_doc( + { + "doctype": "Purchase Receipt", + "set_warehouse": "Warehouse 1", + } + ) - # Same values - doc.items = [{"warehouse": "Warehouse 1"}, {"warehouse": "Warehouse 1"}, {"warehouse": "Warehouse 1"}] - doc.reset_default_field_value("set_warehouse", "items", "warehouse") - self.assertEqual(doc.set_warehouse, "Warehouse 1") + # Same values + doc.items = [ + {"warehouse": "Warehouse 1"}, + {"warehouse": "Warehouse 1"}, + {"warehouse": "Warehouse 1"}, + ] + doc.reset_default_field_value("set_warehouse", "items", "warehouse") + self.assertEqual(doc.set_warehouse, "Warehouse 1") - # Mixed values - doc.items = [{"warehouse": "Warehouse 1"}, {"warehouse": "Warehouse 2"}, {"warehouse": "Warehouse 1"}] - doc.reset_default_field_value("set_warehouse", "items", "warehouse") - self.assertEqual(doc.set_warehouse, None) + # Mixed values + doc.items = [ + {"warehouse": "Warehouse 1"}, + {"warehouse": "Warehouse 2"}, + {"warehouse": "Warehouse 1"}, + ] + doc.reset_default_field_value("set_warehouse", "items", "warehouse") + self.assertEqual(doc.set_warehouse, None) + def test_reset_default_field_value_in_mfg_stock_entry(self): + # manufacture stock entry with rows having blank source/target wh + se = frappe.get_doc( + doctype="Stock Entry", + purpose="Manufacture", + stock_entry_type="Manufacture", + company="_Test Company", + from_warehouse="_Test Warehouse - _TC", + to_warehouse="_Test Warehouse 1 - _TC", + items=[ + frappe._dict( + item_code="_Test Item", qty=1, basic_rate=200, s_warehouse="_Test Warehouse - _TC" + ), + frappe._dict( + item_code="_Test FG Item", qty=4, t_warehouse="_Test Warehouse 1 - _TC", is_finished_item=1 + ), + ], + ) + se.save() + + # default fields must be untouched + self.assertEqual(se.from_warehouse, "_Test Warehouse - _TC") + self.assertEqual(se.to_warehouse, "_Test Warehouse 1 - _TC") + + se.delete() + + def test_reset_default_field_value_in_transfer_stock_entry(self): + doc = frappe.get_doc( + { + "doctype": "Stock Entry", + "purpose": "Material Receipt", + "from_warehouse": "Warehouse 1", + "to_warehouse": "Warehouse 2", + } + ) + + # Same values + doc.items = [ + {"s_warehouse": "Warehouse 1", "t_warehouse": "Warehouse 2"}, + {"s_warehouse": "Warehouse 1", "t_warehouse": "Warehouse 2"}, + {"s_warehouse": "Warehouse 1", "t_warehouse": "Warehouse 2"}, + ] + + doc.reset_default_field_value("from_warehouse", "items", "s_warehouse") + doc.reset_default_field_value("to_warehouse", "items", "t_warehouse") + self.assertEqual(doc.from_warehouse, "Warehouse 1") + self.assertEqual(doc.to_warehouse, "Warehouse 2") + + # Mixed values in source wh + doc.items = [ + {"s_warehouse": "Warehouse 1", "t_warehouse": "Warehouse 2"}, + {"s_warehouse": "Warehouse 3", "t_warehouse": "Warehouse 2"}, + {"s_warehouse": "Warehouse 1", "t_warehouse": "Warehouse 2"}, + ] + + doc.reset_default_field_value("from_warehouse", "items", "s_warehouse") + doc.reset_default_field_value("to_warehouse", "items", "t_warehouse") + self.assertEqual(doc.from_warehouse, None) + self.assertEqual(doc.to_warehouse, "Warehouse 2") diff --git a/erpnext/controllers/trends.py b/erpnext/controllers/trends.py index 1cb101f214a..1d6c5dc0be0 100644 --- a/erpnext/controllers/trends.py +++ b/erpnext/controllers/trends.py @@ -17,17 +17,33 @@ def get_columns(filters, trans): # get conditions for grouping filter cond group_by_cols = group_wise_column(filters.get("group_by")) - columns = based_on_details["based_on_cols"] + period_cols + [_("Total(Qty)") + ":Float:120", _("Total(Amt)") + ":Currency:120"] + columns = ( + based_on_details["based_on_cols"] + + period_cols + + [_("Total(Qty)") + ":Float:120", _("Total(Amt)") + ":Currency:120"] + ) if group_by_cols: - columns = based_on_details["based_on_cols"] + group_by_cols + period_cols + \ - [_("Total(Qty)") + ":Float:120", _("Total(Amt)") + ":Currency:120"] + columns = ( + based_on_details["based_on_cols"] + + group_by_cols + + period_cols + + [_("Total(Qty)") + ":Float:120", _("Total(Amt)") + ":Currency:120"] + ) - conditions = {"based_on_select": based_on_details["based_on_select"], "period_wise_select": period_select, - "columns": columns, "group_by": based_on_details["based_on_group_by"], "grbc": group_by_cols, "trans": trans, - "addl_tables": based_on_details["addl_tables"], "addl_tables_relational_cond": based_on_details.get("addl_tables_relational_cond", "")} + conditions = { + "based_on_select": based_on_details["based_on_select"], + "period_wise_select": period_select, + "columns": columns, + "group_by": based_on_details["based_on_group_by"], + "grbc": group_by_cols, + "trans": trans, + "addl_tables": based_on_details["addl_tables"], + "addl_tables_relational_cond": based_on_details.get("addl_tables_relational_cond", ""), + } return conditions + def validate_filters(filters): for f in ["Fiscal Year", "Based On", "Period", "Company"]: if not filters.get(f.lower().replace(" ", "_")): @@ -39,153 +55,231 @@ def validate_filters(filters): if filters.get("based_on") == filters.get("group_by"): frappe.throw(_("'Based On' and 'Group By' can not be same")) + def get_data(filters, conditions): data = [] - inc, cond= '','' - query_details = conditions["based_on_select"] + conditions["period_wise_select"] + inc, cond = "", "" + query_details = conditions["based_on_select"] + conditions["period_wise_select"] - posting_date = 't1.transaction_date' - if conditions.get('trans') in ['Sales Invoice', 'Purchase Invoice', 'Purchase Receipt', 'Delivery Note']: - posting_date = 't1.posting_date' + posting_date = "t1.transaction_date" + if conditions.get("trans") in [ + "Sales Invoice", + "Purchase Invoice", + "Purchase Receipt", + "Delivery Note", + ]: + posting_date = "t1.posting_date" if filters.period_based_on: - posting_date = 't1.'+filters.period_based_on + posting_date = "t1." + filters.period_based_on if conditions["based_on_select"] in ["t1.project,", "t2.project,"]: - cond = ' and '+ conditions["based_on_select"][:-1] +' IS Not NULL' - if conditions.get('trans') in ['Sales Order', 'Purchase Order']: + cond = " and " + conditions["based_on_select"][:-1] + " IS Not NULL" + if conditions.get("trans") in ["Sales Order", "Purchase Order"]: cond += " and t1.status != 'Closed'" - if conditions.get('trans') == 'Quotation' and filters.get("group_by") == 'Customer': + if conditions.get("trans") == "Quotation" and filters.get("group_by") == "Customer": cond += " and t1.quotation_to = 'Customer'" - year_start_date, year_end_date = frappe.db.get_value("Fiscal Year", - filters.get('fiscal_year'), ["year_start_date", "year_end_date"]) + year_start_date, year_end_date = frappe.db.get_value( + "Fiscal Year", filters.get("fiscal_year"), ["year_start_date", "year_end_date"] + ) if filters.get("group_by"): - sel_col = '' + sel_col = "" ind = conditions["columns"].index(conditions["grbc"][0]) - if filters.get("group_by") == 'Item': - sel_col = 't2.item_code' - elif filters.get("group_by") == 'Customer': - sel_col = 't1.party_name' if conditions.get('trans') == 'Quotation' else 't1.customer' - elif filters.get("group_by") == 'Supplier': - sel_col = 't1.supplier' + if filters.get("group_by") == "Item": + sel_col = "t2.item_code" + elif filters.get("group_by") == "Customer": + sel_col = "t1.party_name" if conditions.get("trans") == "Quotation" else "t1.customer" + elif filters.get("group_by") == "Supplier": + sel_col = "t1.supplier" - if filters.get('based_on') in ['Item','Customer','Supplier']: + if filters.get("based_on") in ["Item", "Customer", "Supplier"]: inc = 2 - else : + else: inc = 1 - data1 = frappe.db.sql(""" select %s from `tab%s` t1, `tab%s Item` t2 %s + data1 = frappe.db.sql( + """ select %s from `tab%s` t1, `tab%s Item` t2 %s where t2.parent = t1.name and t1.company = %s and %s between %s and %s and t1.docstatus = 1 %s %s group by %s - """ % (query_details, conditions["trans"], conditions["trans"], conditions["addl_tables"], "%s", - posting_date, "%s", "%s", conditions.get("addl_tables_relational_cond"), cond, conditions["group_by"]), (filters.get("company"), - year_start_date, year_end_date),as_list=1) + """ + % ( + query_details, + conditions["trans"], + conditions["trans"], + conditions["addl_tables"], + "%s", + posting_date, + "%s", + "%s", + conditions.get("addl_tables_relational_cond"), + cond, + conditions["group_by"], + ), + (filters.get("company"), year_start_date, year_end_date), + as_list=1, + ) for d in range(len(data1)): - #to add blanck column + # to add blanck column dt = data1[d] - dt.insert(ind,'') + dt.insert(ind, "") data.append(dt) - #to get distinct value of col specified by group_by in filter - row = frappe.db.sql("""select DISTINCT(%s) from `tab%s` t1, `tab%s Item` t2 %s + # to get distinct value of col specified by group_by in filter + row = frappe.db.sql( + """select DISTINCT(%s) from `tab%s` t1, `tab%s Item` t2 %s where t2.parent = t1.name and t1.company = %s and %s between %s and %s and t1.docstatus = 1 and %s = %s %s %s - """ % - (sel_col, conditions["trans"], conditions["trans"], conditions["addl_tables"], - "%s", posting_date, "%s", "%s", conditions["group_by"], "%s", conditions.get("addl_tables_relational_cond"), cond), - (filters.get("company"), year_start_date, year_end_date, data1[d][0]), as_list=1) + """ + % ( + sel_col, + conditions["trans"], + conditions["trans"], + conditions["addl_tables"], + "%s", + posting_date, + "%s", + "%s", + conditions["group_by"], + "%s", + conditions.get("addl_tables_relational_cond"), + cond, + ), + (filters.get("company"), year_start_date, year_end_date, data1[d][0]), + as_list=1, + ) for i in range(len(row)): - des = ['' for q in range(len(conditions["columns"]))] + des = ["" for q in range(len(conditions["columns"]))] - #get data for group_by filter - row1 = frappe.db.sql(""" select %s , %s from `tab%s` t1, `tab%s Item` t2 %s + # get data for group_by filter + row1 = frappe.db.sql( + """ select %s , %s from `tab%s` t1, `tab%s Item` t2 %s where t2.parent = t1.name and t1.company = %s and %s between %s and %s and t1.docstatus = 1 and %s = %s and %s = %s %s %s - """ % - (sel_col, conditions["period_wise_select"], conditions["trans"], - conditions["trans"], conditions["addl_tables"], "%s", posting_date, "%s","%s", sel_col, - "%s", conditions["group_by"], "%s", conditions.get("addl_tables_relational_cond"), cond), - (filters.get("company"), year_start_date, year_end_date, row[i][0], - data1[d][0]), as_list=1) + """ + % ( + sel_col, + conditions["period_wise_select"], + conditions["trans"], + conditions["trans"], + conditions["addl_tables"], + "%s", + posting_date, + "%s", + "%s", + sel_col, + "%s", + conditions["group_by"], + "%s", + conditions.get("addl_tables_relational_cond"), + cond, + ), + (filters.get("company"), year_start_date, year_end_date, row[i][0], data1[d][0]), + as_list=1, + ) des[ind] = row[i][0] - for j in range(1,len(conditions["columns"])-inc): - des[j+inc] = row1[0][j] + for j in range(1, len(conditions["columns"]) - inc): + des[j + inc] = row1[0][j] data.append(des) else: - data = frappe.db.sql(""" select %s from `tab%s` t1, `tab%s Item` t2 %s + data = frappe.db.sql( + """ select %s from `tab%s` t1, `tab%s Item` t2 %s where t2.parent = t1.name and t1.company = %s and %s between %s and %s and t1.docstatus = 1 %s %s group by %s - """ % - (query_details, conditions["trans"], conditions["trans"], conditions["addl_tables"], - "%s", posting_date, "%s", "%s", cond, conditions.get("addl_tables_relational_cond", ""), conditions["group_by"]), - (filters.get("company"), year_start_date, year_end_date), as_list=1) + """ + % ( + query_details, + conditions["trans"], + conditions["trans"], + conditions["addl_tables"], + "%s", + posting_date, + "%s", + "%s", + cond, + conditions.get("addl_tables_relational_cond", ""), + conditions["group_by"], + ), + (filters.get("company"), year_start_date, year_end_date), + as_list=1, + ) return data + def get_mon(dt): return getdate(dt).strftime("%b") + def period_wise_columns_query(filters, trans): - query_details = '' + query_details = "" pwc = [] bet_dates = get_period_date_ranges(filters.get("period"), filters.get("fiscal_year")) - if trans in ['Purchase Receipt', 'Delivery Note', 'Purchase Invoice', 'Sales Invoice']: - trans_date = 'posting_date' + if trans in ["Purchase Receipt", "Delivery Note", "Purchase Invoice", "Sales Invoice"]: + trans_date = "posting_date" if filters.period_based_on: trans_date = filters.period_based_on else: - trans_date = 'transaction_date' + trans_date = "transaction_date" - if filters.get("period") != 'Yearly': + if filters.get("period") != "Yearly": for dt in bet_dates: get_period_wise_columns(dt, filters.get("period"), pwc) query_details = get_period_wise_query(dt, trans_date, query_details) else: - pwc = [_(filters.get("fiscal_year")) + " ("+_("Qty") + "):Float:120", - _(filters.get("fiscal_year")) + " ("+ _("Amt") + "):Currency:120"] + pwc = [ + _(filters.get("fiscal_year")) + " (" + _("Qty") + "):Float:120", + _(filters.get("fiscal_year")) + " (" + _("Amt") + "):Currency:120", + ] query_details = " SUM(t2.stock_qty), SUM(t2.base_net_amount)," - query_details += 'SUM(t2.stock_qty), SUM(t2.base_net_amount)' + query_details += "SUM(t2.stock_qty), SUM(t2.base_net_amount)" return pwc, query_details + def get_period_wise_columns(bet_dates, period, pwc): - if period == 'Monthly': - pwc += [_(get_mon(bet_dates[0])) + " (" + _("Qty") + "):Float:120", - _(get_mon(bet_dates[0])) + " (" + _("Amt") + "):Currency:120"] + if period == "Monthly": + pwc += [ + _(get_mon(bet_dates[0])) + " (" + _("Qty") + "):Float:120", + _(get_mon(bet_dates[0])) + " (" + _("Amt") + "):Currency:120", + ] else: - pwc += [_(get_mon(bet_dates[0])) + "-" + _(get_mon(bet_dates[1])) + " (" + _("Qty") + "):Float:120", - _(get_mon(bet_dates[0])) + "-" + _(get_mon(bet_dates[1])) + " (" + _("Amt") + "):Currency:120"] + pwc += [ + _(get_mon(bet_dates[0])) + "-" + _(get_mon(bet_dates[1])) + " (" + _("Qty") + "):Float:120", + _(get_mon(bet_dates[0])) + "-" + _(get_mon(bet_dates[1])) + " (" + _("Amt") + "):Currency:120", + ] + def get_period_wise_query(bet_dates, trans_date, query_details): query_details += """SUM(IF(t1.%(trans_date)s BETWEEN '%(sd)s' AND '%(ed)s', t2.stock_qty, NULL)), SUM(IF(t1.%(trans_date)s BETWEEN '%(sd)s' AND '%(ed)s', t2.base_net_amount, NULL)), - """ % {"trans_date": trans_date, "sd": bet_dates[0],"ed": bet_dates[1]} + """ % { + "trans_date": trans_date, + "sd": bet_dates[0], + "ed": bet_dates[1], + } return query_details + @frappe.whitelist(allow_guest=True) def get_period_date_ranges(period, fiscal_year=None, year_start_date=None): from dateutil.relativedelta import relativedelta if not year_start_date: - year_start_date, year_end_date = frappe.db.get_value("Fiscal Year", - fiscal_year, ["year_start_date", "year_end_date"]) + year_start_date, year_end_date = frappe.db.get_value( + "Fiscal Year", fiscal_year, ["year_start_date", "year_end_date"] + ) - increment = { - "Monthly": 1, - "Quarterly": 3, - "Half-Yearly": 6, - "Yearly": 12 - }.get(period) + increment = {"Monthly": 1, "Quarterly": 3, "Half-Yearly": 6, "Yearly": 12}.get(period) period_date_ranges = [] for i in range(1, 13, increment): @@ -199,8 +293,10 @@ def get_period_date_ranges(period, fiscal_year=None, year_start_date=None): return period_date_ranges + def get_period_month_ranges(period, fiscal_year): from dateutil.relativedelta import relativedelta + period_month_ranges = [] for start_date, end_date in get_period_date_ranges(period, fiscal_year): @@ -212,6 +308,7 @@ def get_period_month_ranges(period, fiscal_year): return period_month_ranges + def based_wise_columns_query(based_on, trans): based_on_details = {} @@ -219,65 +316,74 @@ def based_wise_columns_query(based_on, trans): if based_on == "Item": based_on_details["based_on_cols"] = ["Item:Link/Item:120", "Item Name:Data:120"] based_on_details["based_on_select"] = "t2.item_code, t2.item_name," - based_on_details["based_on_group_by"] = 't2.item_code' - based_on_details["addl_tables"] = '' + based_on_details["based_on_group_by"] = "t2.item_code" + based_on_details["addl_tables"] = "" elif based_on == "Item Group": based_on_details["based_on_cols"] = ["Item Group:Link/Item Group:120"] based_on_details["based_on_select"] = "t2.item_group," - based_on_details["based_on_group_by"] = 't2.item_group' - based_on_details["addl_tables"] = '' + based_on_details["based_on_group_by"] = "t2.item_group" + based_on_details["addl_tables"] = "" elif based_on == "Customer": - based_on_details["based_on_cols"] = ["Customer:Link/Customer:120", "Territory:Link/Territory:120"] + based_on_details["based_on_cols"] = [ + "Customer:Link/Customer:120", + "Territory:Link/Territory:120", + ] based_on_details["based_on_select"] = "t1.customer_name, t1.territory, " - based_on_details["based_on_group_by"] = 't1.party_name' if trans == 'Quotation' else 't1.customer' - based_on_details["addl_tables"] = '' + based_on_details["based_on_group_by"] = ( + "t1.party_name" if trans == "Quotation" else "t1.customer" + ) + based_on_details["addl_tables"] = "" elif based_on == "Customer Group": based_on_details["based_on_cols"] = ["Customer Group:Link/Customer Group"] based_on_details["based_on_select"] = "t1.customer_group," - based_on_details["based_on_group_by"] = 't1.customer_group' - based_on_details["addl_tables"] = '' + based_on_details["based_on_group_by"] = "t1.customer_group" + based_on_details["addl_tables"] = "" - elif based_on == 'Supplier': - based_on_details["based_on_cols"] = ["Supplier:Link/Supplier:120", "Supplier Group:Link/Supplier Group:140"] + elif based_on == "Supplier": + based_on_details["based_on_cols"] = [ + "Supplier:Link/Supplier:120", + "Supplier Group:Link/Supplier Group:140", + ] based_on_details["based_on_select"] = "t1.supplier, t3.supplier_group," - based_on_details["based_on_group_by"] = 't1.supplier' - based_on_details["addl_tables"] = ',`tabSupplier` t3' + based_on_details["based_on_group_by"] = "t1.supplier" + based_on_details["addl_tables"] = ",`tabSupplier` t3" based_on_details["addl_tables_relational_cond"] = " and t1.supplier = t3.name" - elif based_on == 'Supplier Group': + elif based_on == "Supplier Group": based_on_details["based_on_cols"] = ["Supplier Group:Link/Supplier Group:140"] based_on_details["based_on_select"] = "t3.supplier_group," - based_on_details["based_on_group_by"] = 't3.supplier_group' - based_on_details["addl_tables"] = ',`tabSupplier` t3' + based_on_details["based_on_group_by"] = "t3.supplier_group" + based_on_details["addl_tables"] = ",`tabSupplier` t3" based_on_details["addl_tables_relational_cond"] = " and t1.supplier = t3.name" elif based_on == "Territory": based_on_details["based_on_cols"] = ["Territory:Link/Territory:120"] based_on_details["based_on_select"] = "t1.territory," - based_on_details["based_on_group_by"] = 't1.territory' - based_on_details["addl_tables"] = '' + based_on_details["based_on_group_by"] = "t1.territory" + based_on_details["addl_tables"] = "" elif based_on == "Project": - if trans in ['Sales Invoice', 'Delivery Note', 'Sales Order']: + if trans in ["Sales Invoice", "Delivery Note", "Sales Order"]: based_on_details["based_on_cols"] = ["Project:Link/Project:120"] based_on_details["based_on_select"] = "t1.project," - based_on_details["based_on_group_by"] = 't1.project' - based_on_details["addl_tables"] = '' - elif trans in ['Purchase Order', 'Purchase Invoice', 'Purchase Receipt']: + based_on_details["based_on_group_by"] = "t1.project" + based_on_details["addl_tables"] = "" + elif trans in ["Purchase Order", "Purchase Invoice", "Purchase Receipt"]: based_on_details["based_on_cols"] = ["Project:Link/Project:120"] based_on_details["based_on_select"] = "t2.project," - based_on_details["based_on_group_by"] = 't2.project' - based_on_details["addl_tables"] = '' + based_on_details["based_on_group_by"] = "t2.project" + based_on_details["addl_tables"] = "" else: frappe.throw(_("Project-wise data is not available for Quotation")) return based_on_details + def group_wise_column(group_by): if group_by: - return [group_by+":Link/"+group_by+":120"] + return [group_by + ":Link/" + group_by + ":120"] else: return [] diff --git a/erpnext/controllers/website_list_for_contact.py b/erpnext/controllers/website_list_for_contact.py index 23463abe0ae..467323035ea 100644 --- a/erpnext/controllers/website_list_for_contact.py +++ b/erpnext/controllers/website_list_for_contact.py @@ -15,21 +15,29 @@ def get_list_context(context=None): return { "global_number_format": frappe.db.get_default("number_format") or "#,###.##", "currency": frappe.db.get_default("currency"), - "currency_symbols": json.dumps(dict(frappe.db.sql("""select name, symbol - from tabCurrency where enabled=1"""))), + "currency_symbols": json.dumps( + dict( + frappe.db.sql( + """select name, symbol + from tabCurrency where enabled=1""" + ) + ) + ), "row_template": "templates/includes/transaction_row.html", - "get_list": get_transaction_list + "get_list": get_transaction_list, } + def get_webform_list_context(module): - if get_module_app(module) != 'erpnext': + if get_module_app(module) != "erpnext": return - return { - "get_list": get_webform_transaction_list - } + return {"get_list": get_webform_transaction_list} -def get_webform_transaction_list(doctype, txt=None, filters=None, limit_start=0, limit_page_length=20, order_by="modified"): - """ Get List of transactions for custom doctypes """ + +def get_webform_transaction_list( + doctype, txt=None, filters=None, limit_start=0, limit_page_length=20, order_by="modified" +): + """Get List of transactions for custom doctypes""" from frappe.www.list import get_list if not filters: @@ -38,42 +46,62 @@ def get_webform_transaction_list(doctype, txt=None, filters=None, limit_start=0, meta = frappe.get_meta(doctype) for d in meta.fields: - if d.fieldtype == 'Link' and d.fieldname != 'amended_from': + if d.fieldtype == "Link" and d.fieldname != "amended_from": allowed_docs = [d.name for d in get_transaction_list(doctype=d.options, custom=True)] - allowed_docs.append('') - filters.append((d.fieldname, 'in', allowed_docs)) + allowed_docs.append("") + filters.append((d.fieldname, "in", allowed_docs)) - return get_list(doctype, txt, filters, limit_start, limit_page_length, ignore_permissions=False, - fields=None, order_by="modified") + return get_list( + doctype, + txt, + filters, + limit_start, + limit_page_length, + ignore_permissions=False, + fields=None, + order_by="modified", + ) -def get_transaction_list(doctype, txt=None, filters=None, limit_start=0, limit_page_length=20, order_by="modified", custom=False): + +def get_transaction_list( + doctype, + txt=None, + filters=None, + limit_start=0, + limit_page_length=20, + order_by="modified", + custom=False, +): user = frappe.session.user ignore_permissions = False - if not filters: filters = [] + if not filters: + filters = [] - if doctype in ['Supplier Quotation', 'Purchase Invoice']: - filters.append((doctype, 'docstatus', '<', 2)) + if doctype in ["Supplier Quotation", "Purchase Invoice"]: + filters.append((doctype, "docstatus", "<", 2)) else: - filters.append((doctype, 'docstatus', '=', 1)) + filters.append((doctype, "docstatus", "=", 1)) - if (user != 'Guest' and is_website_user()) or doctype == 'Request for Quotation': - parties_doctype = 'Request for Quotation Supplier' if doctype == 'Request for Quotation' else doctype + if (user != "Guest" and is_website_user()) or doctype == "Request for Quotation": + parties_doctype = ( + "Request for Quotation Supplier" if doctype == "Request for Quotation" else doctype + ) # find party for this contact customers, suppliers = get_customers_suppliers(parties_doctype, user) if customers: - if doctype == 'Quotation': - filters.append(('quotation_to', '=', 'Customer')) - filters.append(('party_name', 'in', customers)) + if doctype == "Quotation": + filters.append(("quotation_to", "=", "Customer")) + filters.append(("party_name", "in", customers)) else: - filters.append(('customer', 'in', customers)) + filters.append(("customer", "in", customers)) elif suppliers: - filters.append(('supplier', 'in', suppliers)) + filters.append(("supplier", "in", suppliers)) elif not custom: return [] - if doctype == 'Request for Quotation': + if doctype == "Request for Quotation": parties = customers or suppliers return rfq_transaction_list(parties_doctype, doctype, parties, limit_start, limit_page_length) @@ -84,49 +112,88 @@ def get_transaction_list(doctype, txt=None, filters=None, limit_start=0, limit_p ignore_permissions = False filters = [] - transactions = get_list_for_transactions(doctype, txt, filters, limit_start, limit_page_length, - fields='name', ignore_permissions=ignore_permissions, order_by='modified desc') + transactions = get_list_for_transactions( + doctype, + txt, + filters, + limit_start, + limit_page_length, + fields="name", + ignore_permissions=ignore_permissions, + order_by="modified desc", + ) if custom: return transactions return post_process(doctype, transactions) -def get_list_for_transactions(doctype, txt, filters, limit_start, limit_page_length=20, - ignore_permissions=False, fields=None, order_by=None): - """ Get List of transactions like Invoices, Orders """ + +def get_list_for_transactions( + doctype, + txt, + filters, + limit_start, + limit_page_length=20, + ignore_permissions=False, + fields=None, + order_by=None, +): + """Get List of transactions like Invoices, Orders""" from frappe.www.list import get_list + meta = frappe.get_meta(doctype) data = [] or_filters = [] - for d in get_list(doctype, txt, filters=filters, fields="name", limit_start=limit_start, - limit_page_length=limit_page_length, ignore_permissions=ignore_permissions, order_by="modified desc"): + for d in get_list( + doctype, + txt, + filters=filters, + fields="name", + limit_start=limit_start, + limit_page_length=limit_page_length, + ignore_permissions=ignore_permissions, + order_by="modified desc", + ): data.append(d) if txt: - if meta.get_field('items'): - if meta.get_field('items').options: - child_doctype = meta.get_field('items').options - for item in frappe.get_all(child_doctype, {"item_name": ['like', "%" + txt + "%"]}): + if meta.get_field("items"): + if meta.get_field("items").options: + child_doctype = meta.get_field("items").options + for item in frappe.get_all(child_doctype, {"item_name": ["like", "%" + txt + "%"]}): child = frappe.get_doc(child_doctype, item.name) or_filters.append([doctype, "name", "=", child.parent]) if or_filters: - for r in frappe.get_list(doctype, fields=fields,filters=filters, or_filters=or_filters, - limit_start=limit_start, limit_page_length=limit_page_length, - ignore_permissions=ignore_permissions, order_by=order_by): + for r in frappe.get_list( + doctype, + fields=fields, + filters=filters, + or_filters=or_filters, + limit_start=limit_start, + limit_page_length=limit_page_length, + ignore_permissions=ignore_permissions, + order_by=order_by, + ): data.append(r) return data + def rfq_transaction_list(parties_doctype, doctype, parties, limit_start, limit_page_length): - data = frappe.db.sql("""select distinct parent as name, supplier from `tab{doctype}` - where supplier = '{supplier}' and docstatus=1 order by modified desc limit {start}, {len}""". - format(doctype=parties_doctype, supplier=parties[0], start=limit_start, len = limit_page_length), as_dict=1) + data = frappe.db.sql( + """select distinct parent as name, supplier from `tab{doctype}` + where supplier = '{supplier}' and docstatus=1 order by modified desc limit {start}, {len}""".format( + doctype=parties_doctype, supplier=parties[0], start=limit_start, len=limit_page_length + ), + as_dict=1, + ) return post_process(doctype, data) + def post_process(doctype, data): result = [] for d in data: @@ -137,11 +204,15 @@ def post_process(doctype, data): if doc.get("per_billed"): doc.status_percent += flt(doc.per_billed) - doc.status_display.append(_("Billed") if doc.per_billed==100 else _("{0}% Billed").format(doc.per_billed)) + doc.status_display.append( + _("Billed") if doc.per_billed == 100 else _("{0}% Billed").format(doc.per_billed) + ) if doc.get("per_delivered"): doc.status_percent += flt(doc.per_delivered) - doc.status_display.append(_("Delivered") if doc.per_delivered==100 else _("{0}% Delivered").format(doc.per_delivered)) + doc.status_display.append( + _("Delivered") if doc.per_delivered == 100 else _("{0}% Delivered").format(doc.per_delivered) + ) if hasattr(doc, "set_indicator"): doc.set_indicator() @@ -152,6 +223,7 @@ def post_process(doctype, data): return result + def get_customers_suppliers(doctype, user): customers = [] suppliers = [] @@ -160,10 +232,11 @@ def get_customers_suppliers(doctype, user): customer_field_name = get_customer_field_name(doctype) has_customer_field = meta.has_field(customer_field_name) - has_supplier_field = meta.has_field('supplier') + has_supplier_field = meta.has_field("supplier") if has_common(["Supplier", "Customer"], frappe.get_roles(user)): - contacts = frappe.db.sql(""" + contacts = frappe.db.sql( + """ select `tabContact`.email_id, `tabDynamic Link`.link_doctype, @@ -172,15 +245,18 @@ def get_customers_suppliers(doctype, user): `tabContact`, `tabDynamic Link` where `tabContact`.name=`tabDynamic Link`.parent and `tabContact`.email_id =%s - """, user, as_dict=1) - customers = [c.link_name for c in contacts if c.link_doctype == 'Customer'] - suppliers = [c.link_name for c in contacts if c.link_doctype == 'Supplier'] - elif frappe.has_permission(doctype, 'read', user=user): + """, + user, + as_dict=1, + ) + customers = [c.link_name for c in contacts if c.link_doctype == "Customer"] + suppliers = [c.link_name for c in contacts if c.link_doctype == "Supplier"] + elif frappe.has_permission(doctype, "read", user=user): customer_list = frappe.get_list("Customer") customers = suppliers = [customer.name for customer in customer_list] - return customers if has_customer_field else None, \ - suppliers if has_supplier_field else None + return customers if has_customer_field else None, suppliers if has_supplier_field else None + def has_website_permission(doc, ptype, user, verbose=False): doctype = doc.doctype @@ -188,25 +264,24 @@ def has_website_permission(doc, ptype, user, verbose=False): if customers: return frappe.db.exists(doctype, get_customer_filter(doc, customers)) elif suppliers: - fieldname = 'suppliers' if doctype == 'Request for Quotation' else 'supplier' - return frappe.db.exists(doctype, { - 'name': doc.name, - fieldname: ["in", suppliers] - }) + fieldname = "suppliers" if doctype == "Request for Quotation" else "supplier" + return frappe.db.exists(doctype, {"name": doc.name, fieldname: ["in", suppliers]}) else: return False + def get_customer_filter(doc, customers): doctype = doc.doctype filters = frappe._dict() filters.name = doc.name - filters[get_customer_field_name(doctype)] = ['in', customers] - if doctype == 'Quotation': - filters.quotation_to = 'Customer' + filters[get_customer_field_name(doctype)] = ["in", customers] + if doctype == "Quotation": + filters.quotation_to = "Customer" return filters + def get_customer_field_name(doctype): - if doctype == 'Quotation': - return 'party_name' + if doctype == "Quotation": + return "party_name" else: - return 'customer' + return "customer" diff --git a/erpnext/crm/doctype/appointment/appointment.py b/erpnext/crm/doctype/appointment/appointment.py index 20fb987c601..69b8c324e00 100644 --- a/erpnext/crm/doctype/appointment/appointment.py +++ b/erpnext/crm/doctype/appointment/appointment.py @@ -12,17 +12,17 @@ from frappe.utils.verified_command import get_signed_params class Appointment(Document): - def find_lead_by_email(self): lead_list = frappe.get_list( - 'Lead', filters={'email_id': self.customer_email}, ignore_permissions=True) + "Lead", filters={"email_id": self.customer_email}, ignore_permissions=True + ) if lead_list: return lead_list[0].name return None def find_customer_by_email(self): customer_list = frappe.get_list( - 'Customer', filters={'email_id': self.customer_email}, ignore_permissions=True + "Customer", filters={"email_id": self.customer_email}, ignore_permissions=True ) if customer_list: return customer_list[0].name @@ -30,11 +30,12 @@ class Appointment(Document): def before_insert(self): number_of_appointments_in_same_slot = frappe.db.count( - 'Appointment', filters={'scheduled_time': self.scheduled_time}) - number_of_agents = frappe.db.get_single_value('Appointment Booking Settings', 'number_of_agents') + "Appointment", filters={"scheduled_time": self.scheduled_time} + ) + number_of_agents = frappe.db.get_single_value("Appointment Booking Settings", "number_of_agents") if not number_of_agents == 0: - if (number_of_appointments_in_same_slot >= number_of_agents): - frappe.throw(_('Time slot is not available')) + if number_of_appointments_in_same_slot >= number_of_agents: + frappe.throw(_("Time slot is not available")) # Link lead if not self.party: lead = self.find_lead_by_email() @@ -53,45 +54,46 @@ class Appointment(Document): self.create_calendar_event() else: # Set status to unverified - self.status = 'Unverified' + self.status = "Unverified" # Send email to confirm self.send_confirmation_email() def send_confirmation_email(self): verify_url = self._get_verify_url() - template = 'confirm_appointment' + template = "confirm_appointment" args = { - "link":verify_url, - "site_url":frappe.utils.get_url(), - "full_name":self.customer_name, + "link": verify_url, + "site_url": frappe.utils.get_url(), + "full_name": self.customer_name, } - frappe.sendmail(recipients=[self.customer_email], - template=template, - args=args, - subject=_('Appointment Confirmation')) + frappe.sendmail( + recipients=[self.customer_email], + template=template, + args=args, + subject=_("Appointment Confirmation"), + ) if frappe.session.user == "Guest": + frappe.msgprint(_("Please check your email to confirm the appointment")) + else: frappe.msgprint( - _('Please check your email to confirm the appointment')) - else : - frappe.msgprint( - _('Appointment was created. But no lead was found. Please check the email to confirm')) + _("Appointment was created. But no lead was found. Please check the email to confirm") + ) def on_change(self): # Sync Calendar if not self.calendar_event: return - cal_event = frappe.get_doc('Event', self.calendar_event) + cal_event = frappe.get_doc("Event", self.calendar_event) cal_event.starts_on = self.scheduled_time cal_event.save(ignore_permissions=True) - def set_verified(self, email): if not email == self.customer_email: - frappe.throw(_('Email verification failed.')) + frappe.throw(_("Email verification failed.")) # Create new lead self.create_lead_and_link() # Remove unverified status - self.status = 'Open' + self.status = "Open" # Create calender event self.auto_assign() self.create_calendar_event() @@ -102,58 +104,53 @@ class Appointment(Document): # Return if already linked if self.party: return - lead = frappe.get_doc({ - 'doctype': 'Lead', - 'lead_name': self.customer_name, - 'email_id': self.customer_email, - 'notes': self.customer_details, - 'phone': self.customer_phone_number, - }) + lead = frappe.get_doc( + { + "doctype": "Lead", + "lead_name": self.customer_name, + "email_id": self.customer_email, + "notes": self.customer_details, + "phone": self.customer_phone_number, + } + ) lead.insert(ignore_permissions=True) # Link lead self.party = lead.name def auto_assign(self): from frappe.desk.form.assign_to import add as add_assignemnt + existing_assignee = self.get_assignee_from_latest_opportunity() if existing_assignee: # If the latest opportunity is assigned to someone # Assign the appointment to the same - add_assignemnt({ - 'doctype': self.doctype, - 'name': self.name, - 'assign_to': [existing_assignee] - }) + add_assignemnt({"doctype": self.doctype, "name": self.name, "assign_to": [existing_assignee]}) return if self._assign: return - available_agents = _get_agents_sorted_by_asc_workload( - getdate(self.scheduled_time)) + available_agents = _get_agents_sorted_by_asc_workload(getdate(self.scheduled_time)) for agent in available_agents: - if(_check_agent_availability(agent, self.scheduled_time)): + if _check_agent_availability(agent, self.scheduled_time): agent = agent[0] - add_assignemnt({ - 'doctype': self.doctype, - 'name': self.name, - 'assign_to': [agent] - }) + add_assignemnt({"doctype": self.doctype, "name": self.name, "assign_to": [agent]}) break def get_assignee_from_latest_opportunity(self): if not self.party: return None - if not frappe.db.exists('Lead', self.party): + if not frappe.db.exists("Lead", self.party): return None opporutnities = frappe.get_list( - 'Opportunity', + "Opportunity", filters={ - 'party_name': self.party, + "party_name": self.party, }, ignore_permissions=True, - order_by='creation desc') + order_by="creation desc", + ) if not opporutnities: return None - latest_opportunity = frappe.get_doc('Opportunity', opporutnities[0].name ) + latest_opportunity = frappe.get_doc("Opportunity", opporutnities[0].name) assignee = latest_opportunity._assign if not assignee: return None @@ -163,35 +160,36 @@ class Appointment(Document): def create_calendar_event(self): if self.calendar_event: return - appointment_event = frappe.get_doc({ - 'doctype': 'Event', - 'subject': ' '.join(['Appointment with', self.customer_name]), - 'starts_on': self.scheduled_time, - 'status': 'Open', - 'type': 'Public', - 'send_reminder': frappe.db.get_single_value('Appointment Booking Settings', 'email_reminders'), - 'event_participants': [dict(reference_doctype=self.appointment_with, reference_docname=self.party)] - }) + appointment_event = frappe.get_doc( + { + "doctype": "Event", + "subject": " ".join(["Appointment with", self.customer_name]), + "starts_on": self.scheduled_time, + "status": "Open", + "type": "Public", + "send_reminder": frappe.db.get_single_value("Appointment Booking Settings", "email_reminders"), + "event_participants": [ + dict(reference_doctype=self.appointment_with, reference_docname=self.party) + ], + } + ) employee = _get_employee_from_user(self._assign) if employee: - appointment_event.append('event_participants', dict( - reference_doctype='Employee', - reference_docname=employee.name)) + appointment_event.append( + "event_participants", dict(reference_doctype="Employee", reference_docname=employee.name) + ) appointment_event.insert(ignore_permissions=True) self.calendar_event = appointment_event.name self.save(ignore_permissions=True) def _get_verify_url(self): - verify_route = '/book_appointment/verify' - params = { - 'email': self.customer_email, - 'appointment': self.name - } - return get_url(verify_route + '?' + get_signed_params(params)) + verify_route = "/book_appointment/verify" + params = {"email": self.customer_email, "appointment": self.name} + return get_url(verify_route + "?" + get_signed_params(params)) def _get_agents_sorted_by_asc_workload(date): - appointments = frappe.db.get_list('Appointment', fields='*') + appointments = frappe.db.get_list("Appointment", fields="*") agent_list = _get_agent_list_as_strings() if not appointments: return agent_list @@ -209,7 +207,7 @@ def _get_agents_sorted_by_asc_workload(date): def _get_agent_list_as_strings(): agent_list_as_strings = [] - agent_list = frappe.get_doc('Appointment Booking Settings').agent_list + agent_list = frappe.get_doc("Appointment Booking Settings").agent_list for agent in agent_list: agent_list_as_strings.append(agent.user) return agent_list_as_strings @@ -217,7 +215,8 @@ def _get_agent_list_as_strings(): def _check_agent_availability(agent_email, scheduled_time): appointemnts_at_scheduled_time = frappe.get_list( - 'Appointment', filters={'scheduled_time': scheduled_time}) + "Appointment", filters={"scheduled_time": scheduled_time} + ) for appointment in appointemnts_at_scheduled_time: if appointment._assign == agent_email: return False @@ -225,9 +224,8 @@ def _check_agent_availability(agent_email, scheduled_time): def _get_employee_from_user(user): - employee_docname = frappe.db.exists( - {'doctype': 'Employee', 'user_id': user}) + employee_docname = frappe.db.exists({"doctype": "Employee", "user_id": user}) if employee_docname: # frappe.db.exists returns a tuple of a tuple - return frappe.get_doc('Employee', employee_docname[0][0]) + return frappe.get_doc("Employee", employee_docname[0][0]) return None diff --git a/erpnext/crm/doctype/appointment/test_appointment.py b/erpnext/crm/doctype/appointment/test_appointment.py index 8335f756ca8..6fca5da9ef2 100644 --- a/erpnext/crm/doctype/appointment/test_appointment.py +++ b/erpnext/crm/doctype/appointment/test_appointment.py @@ -8,50 +8,53 @@ import frappe def create_test_lead(): - test_lead = frappe.db.exists({'doctype': 'Lead', 'lead_name': 'Test Lead'}) - if test_lead: - return frappe.get_doc('Lead', test_lead[0][0]) - test_lead = frappe.get_doc({ - 'doctype': 'Lead', - 'lead_name': 'Test Lead', - 'email_id': 'test@example.com' - }) - test_lead.insert(ignore_permissions=True) - return test_lead + test_lead = frappe.db.exists({"doctype": "Lead", "lead_name": "Test Lead"}) + if test_lead: + return frappe.get_doc("Lead", test_lead[0][0]) + test_lead = frappe.get_doc( + {"doctype": "Lead", "lead_name": "Test Lead", "email_id": "test@example.com"} + ) + test_lead.insert(ignore_permissions=True) + return test_lead def create_test_appointments(): - test_appointment = frappe.db.exists( - {'doctype': 'Appointment', 'scheduled_time':datetime.datetime.now(),'email':'test@example.com'}) - if test_appointment: - return frappe.get_doc('Appointment', test_appointment[0][0]) - test_appointment = frappe.get_doc({ - 'doctype': 'Appointment', - 'email': 'test@example.com', - 'status': 'Open', - 'customer_name': 'Test Lead', - 'customer_phone_number': '666', - 'customer_skype': 'test', - 'customer_email': 'test@example.com', - 'scheduled_time': datetime.datetime.now() - }) - test_appointment.insert() - return test_appointment + test_appointment = frappe.db.exists( + { + "doctype": "Appointment", + "scheduled_time": datetime.datetime.now(), + "email": "test@example.com", + } + ) + if test_appointment: + return frappe.get_doc("Appointment", test_appointment[0][0]) + test_appointment = frappe.get_doc( + { + "doctype": "Appointment", + "email": "test@example.com", + "status": "Open", + "customer_name": "Test Lead", + "customer_phone_number": "666", + "customer_skype": "test", + "customer_email": "test@example.com", + "scheduled_time": datetime.datetime.now(), + } + ) + test_appointment.insert() + return test_appointment class TestAppointment(unittest.TestCase): - test_appointment = test_lead = None + test_appointment = test_lead = None - def setUp(self): - self.test_lead = create_test_lead() - self.test_appointment = create_test_appointments() + def setUp(self): + self.test_lead = create_test_lead() + self.test_appointment = create_test_appointments() - def test_calendar_event_created(self): - cal_event = frappe.get_doc( - 'Event', self.test_appointment.calendar_event) - self.assertEqual(cal_event.starts_on, - self.test_appointment.scheduled_time) + def test_calendar_event_created(self): + cal_event = frappe.get_doc("Event", self.test_appointment.calendar_event) + self.assertEqual(cal_event.starts_on, self.test_appointment.scheduled_time) - def test_lead_linked(self): - lead = frappe.get_doc('Lead', self.test_lead.name) - self.assertIsNotNone(lead) + def test_lead_linked(self): + lead = frappe.get_doc("Lead", self.test_lead.name) + self.assertIsNotNone(lead) diff --git a/erpnext/crm/doctype/appointment_booking_settings/appointment_booking_settings.py b/erpnext/crm/doctype/appointment_booking_settings/appointment_booking_settings.py index 1431b03a2ef..e43f4601e9c 100644 --- a/erpnext/crm/doctype/appointment_booking_settings/appointment_booking_settings.py +++ b/erpnext/crm/doctype/appointment_booking_settings/appointment_booking_settings.py @@ -10,8 +10,8 @@ from frappe.model.document import Document class AppointmentBookingSettings(Document): - agent_list = [] #Hack - min_date = '01/01/1970 ' + agent_list = [] # Hack + min_date = "01/01/1970 " format_string = "%d/%m/%Y %H:%M:%S" def validate(self): @@ -23,21 +23,22 @@ class AppointmentBookingSettings(Document): def validate_availability_of_slots(self): for record in self.availability_of_slots: - from_time = datetime.datetime.strptime( - self.min_date+record.from_time, self.format_string) - to_time = datetime.datetime.strptime( - self.min_date+record.to_time, self.format_string) - timedelta = to_time-from_time + from_time = datetime.datetime.strptime(self.min_date + record.from_time, self.format_string) + to_time = datetime.datetime.strptime(self.min_date + record.to_time, self.format_string) + timedelta = to_time - from_time self.validate_from_and_to_time(from_time, to_time, record) self.duration_is_divisible(from_time, to_time) def validate_from_and_to_time(self, from_time, to_time, record): if from_time > to_time: - err_msg = _('From Time cannot be later than To Time for {0}').format(record.day_of_week) + err_msg = _("From Time cannot be later than To Time for {0}").format( + record.day_of_week + ) frappe.throw(_(err_msg)) def duration_is_divisible(self, from_time, to_time): timedelta = to_time - from_time if timedelta.total_seconds() % (self.appointment_duration * 60): frappe.throw( - _('The difference between from time and To Time must be a multiple of Appointment')) + _("The difference between from time and To Time must be a multiple of Appointment") + ) diff --git a/erpnext/crm/doctype/contract/contract.js b/erpnext/crm/doctype/contract/contract.js index 7848de7a727..8751edbc9b2 100644 --- a/erpnext/crm/doctype/contract/contract.js +++ b/erpnext/crm/doctype/contract/contract.js @@ -2,6 +2,17 @@ // For license information, please see license.txt frappe.ui.form.on("Contract", { + onload: function(frm) { + frappe.db.get_value( + "Selling Settings", + "Selling Settings", + "contract_naming_by", + (r) => { + frm.toggle_display("naming_series", r.contract_naming_by === "Naming Series"); + } + ); + }, + contract_template: function (frm) { if (frm.doc.contract_template) { frappe.call({ diff --git a/erpnext/crm/doctype/contract/contract.json b/erpnext/crm/doctype/contract/contract.json index de3230f0e67..8a65ca5f20d 100755 --- a/erpnext/crm/doctype/contract/contract.json +++ b/erpnext/crm/doctype/contract/contract.json @@ -2,11 +2,13 @@ "actions": [], "allow_import": 1, "allow_rename": 1, + "autoname": "naming_series:", "creation": "2018-04-12 06:32:04.582486", "doctype": "DocType", "editable_grid": 1, "engine": "InnoDB", "field_order": [ + "naming_series", "party_type", "is_signed", "cb_party", @@ -244,11 +246,20 @@ "fieldname": "authorised_by_section", "fieldtype": "Section Break", "label": "Authorised By" + }, + { + "fieldname": "naming_series", + "fieldtype": "Select", + "label": "Naming Series", + "no_copy": 1, + "options": "CRM-CONTR-.YYYY.-", + "reqd": 1, + "set_only_once": 1 } ], "is_submittable": 1, "links": [], - "modified": "2020-12-07 11:15:58.385521", + "modified": "2022-03-28 10:22:11.156658", "modified_by": "Administrator", "module": "CRM", "name": "Contract", diff --git a/erpnext/crm/doctype/contract/contract.py b/erpnext/crm/doctype/contract/contract.py index e21f46a3837..8a2c2e966e9 100644 --- a/erpnext/crm/doctype/contract/contract.py +++ b/erpnext/crm/doctype/contract/contract.py @@ -5,22 +5,32 @@ import frappe from frappe import _ from frappe.model.document import Document +from frappe.model.naming import set_name_by_naming_series from frappe.utils import getdate, nowdate class Contract(Document): def autoname(self): - name = self.party_name + if frappe.db.get_single_value("Selling Settings", "contract_naming_by") == "Naming Series": + set_name_by_naming_series(self) - if self.contract_template: - name += " - {} Agreement".format(self.contract_template) + else: + name = self.party_name - # If identical, append contract name with the next number in the iteration - if frappe.db.exists("Contract", name): - count = len(frappe.get_all("Contract", filters={"name": ["like", "%{}%".format(name)]})) - name = "{} - {}".format(name, count) + if self.contract_template: + name = f"{name} - {self.contract_template} Agreement" - self.name = _(name) + # If identical, append contract name with the next number in the iteration + if frappe.db.exists("Contract", name): + count = frappe.db.count( + "Contract", + filters={ + "name": ("like", f"%{name}%"), + }, + ) + name = f"{name} - {count}" + + self.name = _(name) def validate(self): self.validate_dates() @@ -75,11 +85,11 @@ def get_status(start_date, end_date): Get a Contract's status based on the start, current and end dates Args: - start_date (str): The start date of the contract - end_date (str): The end date of the contract + start_date (str): The start date of the contract + end_date (str): The end date of the contract Returns: - str: 'Active' if within range, otherwise 'Inactive' + str: 'Active' if within range, otherwise 'Inactive' """ if not end_date: @@ -98,13 +108,13 @@ def update_status_for_contracts(): and submitted Contracts """ - contracts = frappe.get_all("Contract", - filters={"is_signed": True, - "docstatus": 1}, - fields=["name", "start_date", "end_date"]) + contracts = frappe.get_all( + "Contract", + filters={"is_signed": True, "docstatus": 1}, + fields=["name", "start_date", "end_date"], + ) for contract in contracts: - status = get_status(contract.get("start_date"), - contract.get("end_date")) + status = get_status(contract.get("start_date"), contract.get("end_date")) frappe.db.set_value("Contract", contract.get("name"), "status", status) diff --git a/erpnext/crm/doctype/contract/test_contract.py b/erpnext/crm/doctype/contract/test_contract.py index e685362a494..13901683de8 100644 --- a/erpnext/crm/doctype/contract/test_contract.py +++ b/erpnext/crm/doctype/contract/test_contract.py @@ -8,7 +8,6 @@ from frappe.utils import add_days, nowdate class TestContract(unittest.TestCase): - def setUp(self): frappe.db.sql("delete from `tabContract`") self.contract_doc = get_contract() @@ -65,10 +64,7 @@ class TestContract(unittest.TestCase): # Mark all the terms as fulfilled self.contract_doc.requires_fulfilment = 1 fulfilment_terms = [] - fulfilment_terms.append({ - "requirement": "This is a test requirement.", - "fulfilled": 0 - }) + fulfilment_terms.append({"requirement": "This is a test requirement.", "fulfilled": 0}) self.contract_doc.set("fulfilment_terms", fulfilment_terms) for term in self.contract_doc.fulfilment_terms: @@ -85,14 +81,8 @@ class TestContract(unittest.TestCase): # Mark only the first term as fulfilled self.contract_doc.save() fulfilment_terms = [] - fulfilment_terms.append({ - "requirement": "This is a test requirement.", - "fulfilled": 0 - }) - fulfilment_terms.append({ - "requirement": "This is another test requirement.", - "fulfilled": 0 - }) + fulfilment_terms.append({"requirement": "This is a test requirement.", "fulfilled": 0}) + fulfilment_terms.append({"requirement": "This is another test requirement.", "fulfilled": 0}) self.contract_doc.set("fulfilment_terms", fulfilment_terms) self.contract_doc.fulfilment_terms[0].fulfilled = 1 @@ -110,6 +100,7 @@ class TestContract(unittest.TestCase): self.assertEqual(self.contract_doc.fulfilment_status, "Lapsed") + def get_contract(): doc = frappe.new_doc("Contract") doc.party_type = "Customer" diff --git a/erpnext/crm/doctype/contract_template/contract_template.py b/erpnext/crm/doctype/contract_template/contract_template.py index 8adbb4e25e4..f417bf0c209 100644 --- a/erpnext/crm/doctype/contract_template/contract_template.py +++ b/erpnext/crm/doctype/contract_template/contract_template.py @@ -15,6 +15,7 @@ class ContractTemplate(Document): if self.contract_terms: validate_template(self.contract_terms) + @frappe.whitelist() def get_contract_template(template_name, doc): if isinstance(doc, string_types): @@ -26,7 +27,4 @@ def get_contract_template(template_name, doc): if contract_template.contract_terms: contract_terms = frappe.render_template(contract_template.contract_terms, doc) - return { - 'contract_template': contract_template, - 'contract_terms': contract_terms - } + return {"contract_template": contract_template, "contract_terms": contract_terms} diff --git a/erpnext/crm/doctype/email_campaign/email_campaign.py b/erpnext/crm/doctype/email_campaign/email_campaign.py index d44443237e8..9ec54ffc1ef 100644 --- a/erpnext/crm/doctype/email_campaign/email_campaign.py +++ b/erpnext/crm/doctype/email_campaign/email_campaign.py @@ -12,7 +12,7 @@ from frappe.utils import add_days, getdate, today class EmailCampaign(Document): def validate(self): self.set_date() - #checking if email is set for lead. Not checking for contact as email is a mandatory field for contact. + # checking if email is set for lead. Not checking for contact as email is a mandatory field for contact. if self.email_campaign_for == "Lead": self.validate_lead() self.validate_email_campaign_already_exists() @@ -21,7 +21,7 @@ class EmailCampaign(Document): def set_date(self): if getdate(self.start_date) < getdate(today()): frappe.throw(_("Start Date cannot be before the current date")) - #set the end date as start date + max(send after days) in campaign schedule + # set the end date as start date + max(send after days) in campaign schedule send_after_days = [] campaign = frappe.get_doc("Campaign", self.campaign_name) for entry in campaign.get("campaign_schedules"): @@ -29,23 +29,32 @@ class EmailCampaign(Document): try: self.end_date = add_days(getdate(self.start_date), max(send_after_days)) except ValueError: - frappe.throw(_("Please set up the Campaign Schedule in the Campaign {0}").format(self.campaign_name)) + frappe.throw( + _("Please set up the Campaign Schedule in the Campaign {0}").format(self.campaign_name) + ) def validate_lead(self): - lead_email_id = frappe.db.get_value("Lead", self.recipient, 'email_id') + lead_email_id = frappe.db.get_value("Lead", self.recipient, "email_id") if not lead_email_id: - lead_name = frappe.db.get_value("Lead", self.recipient, 'lead_name') + lead_name = frappe.db.get_value("Lead", self.recipient, "lead_name") frappe.throw(_("Please set an email id for the Lead {0}").format(lead_name)) def validate_email_campaign_already_exists(self): - email_campaign_exists = frappe.db.exists("Email Campaign", { - "campaign_name": self.campaign_name, - "recipient": self.recipient, - "status": ("in", ["In Progress", "Scheduled"]), - "name": ("!=", self.name) - }) + email_campaign_exists = frappe.db.exists( + "Email Campaign", + { + "campaign_name": self.campaign_name, + "recipient": self.recipient, + "status": ("in", ["In Progress", "Scheduled"]), + "name": ("!=", self.name), + }, + ) if email_campaign_exists: - frappe.throw(_("The Campaign '{0}' already exists for the {1} '{2}'").format(self.campaign_name, self.email_campaign_for, self.recipient)) + frappe.throw( + _("The Campaign '{0}' already exists for the {1} '{2}'").format( + self.campaign_name, self.email_campaign_for, self.recipient + ) + ) def update_status(self): start_date = getdate(self.start_date) @@ -58,51 +67,63 @@ class EmailCampaign(Document): elif end_date < today_date: self.status = "Completed" -#called through hooks to send campaign mails to leads + +# called through hooks to send campaign mails to leads def send_email_to_leads_or_contacts(): - email_campaigns = frappe.get_all("Email Campaign", filters = { 'status': ('not in', ['Unsubscribed', 'Completed', 'Scheduled']) }) + email_campaigns = frappe.get_all( + "Email Campaign", filters={"status": ("not in", ["Unsubscribed", "Completed", "Scheduled"])} + ) for camp in email_campaigns: email_campaign = frappe.get_doc("Email Campaign", camp.name) campaign = frappe.get_cached_doc("Campaign", email_campaign.campaign_name) for entry in campaign.get("campaign_schedules"): - scheduled_date = add_days(email_campaign.get('start_date'), entry.get('send_after_days')) + scheduled_date = add_days(email_campaign.get("start_date"), entry.get("send_after_days")) if scheduled_date == getdate(today()): send_mail(entry, email_campaign) + def send_mail(entry, email_campaign): recipient_list = [] if email_campaign.email_campaign_for == "Email Group": - for member in frappe.db.get_list("Email Group Member", filters={"email_group": email_campaign.get("recipient")}, fields=["email"]): - recipient_list.append(member['email']) + for member in frappe.db.get_list( + "Email Group Member", filters={"email_group": email_campaign.get("recipient")}, fields=["email"] + ): + recipient_list.append(member["email"]) else: - recipient_list.append(frappe.db.get_value(email_campaign.email_campaign_for, email_campaign.get("recipient"), "email_id")) + recipient_list.append( + frappe.db.get_value( + email_campaign.email_campaign_for, email_campaign.get("recipient"), "email_id" + ) + ) email_template = frappe.get_doc("Email Template", entry.get("email_template")) sender = frappe.db.get_value("User", email_campaign.get("sender"), "email") context = {"doc": frappe.get_doc(email_campaign.email_campaign_for, email_campaign.recipient)} # send mail and link communication to document comm = make( - doctype = "Email Campaign", - name = email_campaign.name, - subject = frappe.render_template(email_template.get("subject"), context), - content = frappe.render_template(email_template.get("response"), context), - sender = sender, - recipients = recipient_list, - communication_medium = "Email", - sent_or_received = "Sent", - send_email = True, - email_template = email_template.name + doctype="Email Campaign", + name=email_campaign.name, + subject=frappe.render_template(email_template.get("subject"), context), + content=frappe.render_template(email_template.get("response"), context), + sender=sender, + recipients=recipient_list, + communication_medium="Email", + sent_or_received="Sent", + send_email=True, + email_template=email_template.name, ) return comm -#called from hooks on doc_event Email Unsubscribe + +# called from hooks on doc_event Email Unsubscribe def unsubscribe_recipient(unsubscribe, method): - if unsubscribe.reference_doctype == 'Email Campaign': + if unsubscribe.reference_doctype == "Email Campaign": frappe.db.set_value("Email Campaign", unsubscribe.reference_name, "status", "Unsubscribed") -#called through hooks to update email campaign status daily + +# called through hooks to update email campaign status daily def set_email_campaign_status(): - email_campaigns = frappe.get_all("Email Campaign", filters = { 'status': ('!=', 'Unsubscribed')}) + email_campaigns = frappe.get_all("Email Campaign", filters={"status": ("!=", "Unsubscribed")}) for entry in email_campaigns: email_campaign = frappe.get_doc("Email Campaign", entry.name) email_campaign.update_status() diff --git a/erpnext/crm/doctype/lead/lead.py b/erpnext/crm/doctype/lead/lead.py index 809a9d29138..36ec225ce89 100644 --- a/erpnext/crm/doctype/lead/lead.py +++ b/erpnext/crm/doctype/lead/lead.py @@ -15,7 +15,7 @@ from erpnext.controllers.selling_controller import SellingController class Lead(SellingController): def get_feed(self): - return '{0}: {1}'.format(_(self.status), self.lead_name) + return "{0}: {1}".format(_(self.status), self.lead_name) def onload(self): customer = frappe.db.get_value("Customer", {"lead_name": self.name}) @@ -57,8 +57,7 @@ class Lead(SellingController): if self.contact_date and getdate(self.contact_date) < getdate(nowdate()): frappe.throw(_("Next Contact Date cannot be in the past")) - if (self.ends_on and self.contact_date and - (getdate(self.ends_on) < getdate(self.contact_date))): + if self.ends_on and self.contact_date and (getdate(self.ends_on) < getdate(self.contact_date)): frappe.throw(_("Ends On date cannot be before Next Contact Date.")) def on_update(self): @@ -66,32 +65,38 @@ class Lead(SellingController): def set_prev(self): if self.is_new(): - self._prev = frappe._dict({ - "contact_date": None, - "ends_on": None, - "contact_by": None - }) + self._prev = frappe._dict({"contact_date": None, "ends_on": None, "contact_by": None}) else: - self._prev = frappe.db.get_value("Lead", self.name, ["contact_date", "ends_on", "contact_by"], as_dict=1) + self._prev = frappe.db.get_value( + "Lead", self.name, ["contact_date", "ends_on", "contact_by"], as_dict=1 + ) def add_calendar_event(self, opts=None, force=False): - super(Lead, self).add_calendar_event({ - "owner": self.lead_owner, - "starts_on": self.contact_date, - "ends_on": self.ends_on or "", - "subject": ('Contact ' + cstr(self.lead_name)), - "description": ('Contact ' + cstr(self.lead_name)) + (self.contact_by and ('. By : ' + cstr(self.contact_by)) or '') - }, force) + super(Lead, self).add_calendar_event( + { + "owner": self.lead_owner, + "starts_on": self.contact_date, + "ends_on": self.ends_on or "", + "subject": ("Contact " + cstr(self.lead_name)), + "description": ("Contact " + cstr(self.lead_name)) + + (self.contact_by and (". By : " + cstr(self.contact_by)) or ""), + }, + force, + ) def check_email_id_is_unique(self): if self.email_id: # validate email is unique - duplicate_leads = frappe.get_all("Lead", filters={"email_id": self.email_id, "name": ["!=", self.name]}) + duplicate_leads = frappe.get_all( + "Lead", filters={"email_id": self.email_id, "name": ["!=", self.name]} + ) duplicate_leads = [lead.name for lead in duplicate_leads] if duplicate_leads: - frappe.throw(_("Email Address must be unique, already exists for {0}") - .format(comma_and(duplicate_leads)), frappe.DuplicateEntryError) + frappe.throw( + _("Email Address must be unique, already exists for {0}").format(comma_and(duplicate_leads)), + frappe.DuplicateEntryError, + ) def on_trash(self): frappe.db.sql("""update `tabIssue` set lead='' where lead=%s""", self.name) @@ -105,19 +110,14 @@ class Lead(SellingController): return frappe.db.get_value("Opportunity", {"party_name": self.name, "status": ["!=", "Lost"]}) def has_quotation(self): - return frappe.db.get_value("Quotation", { - "party_name": self.name, - "docstatus": 1, - "status": ["!=", "Lost"] - - }) + return frappe.db.get_value( + "Quotation", {"party_name": self.name, "docstatus": 1, "status": ["!=", "Lost"]} + ) def has_lost_quotation(self): - return frappe.db.get_value("Quotation", { - "party_name": self.name, - "docstatus": 1, - "status": "Lost" - }) + return frappe.db.get_value( + "Quotation", {"party_name": self.name, "docstatus": 1, "status": "Lost"} + ) def set_lead_name(self): if not self.lead_name: @@ -136,8 +136,17 @@ class Lead(SellingController): self.title = self.lead_name def create_address(self): - address_fields = ["address_type", "address_title", "address_line1", "address_line2", - "city", "county", "state", "country", "pincode"] + address_fields = [ + "address_type", + "address_title", + "address_line1", + "address_line2", + "city", + "county", + "state", + "country", + "pincode", + ] info_fields = ["email_id", "phone", "fax"] # do not create an address if no fields are available, @@ -161,56 +170,47 @@ class Lead(SellingController): first_name, last_name = self.lead_name, None contact = frappe.new_doc("Contact") - contact.update({ - "first_name": first_name, - "last_name": last_name, - "salutation": self.salutation, - "gender": self.gender, - "designation": self.designation, - "company_name": self.company_name, - }) + contact.update( + { + "first_name": first_name, + "last_name": last_name, + "salutation": self.salutation, + "gender": self.gender, + "designation": self.designation, + "company_name": self.company_name, + } + ) if self.email_id: - contact.append("email_ids", { - "email_id": self.email_id, - "is_primary": 1 - }) + contact.append("email_ids", {"email_id": self.email_id, "is_primary": 1}) if self.phone: - contact.append("phone_nos", { - "phone": self.phone, - "is_primary_phone": 1 - }) + contact.append("phone_nos", {"phone": self.phone, "is_primary_phone": 1}) if self.mobile_no: - contact.append("phone_nos", { - "phone": self.mobile_no, - "is_primary_mobile_no":1 - }) + contact.append("phone_nos", {"phone": self.mobile_no, "is_primary_mobile_no": 1}) contact.insert(ignore_permissions=True) + contact.reload() # load changes by hooks on contact return contact def update_links(self): # update address links - if hasattr(self, 'address_doc'): - self.address_doc.append("links", { - "link_doctype": "Lead", - "link_name": self.name, - "link_title": self.lead_name - }) + if hasattr(self, "address_doc"): + self.address_doc.append( + "links", {"link_doctype": "Lead", "link_name": self.name, "link_title": self.lead_name} + ) self.address_doc.save() # update contact links if self.contact_doc: - self.contact_doc.append("links", { - "link_doctype": "Lead", - "link_name": self.name, - "link_title": self.lead_name - }) + self.contact_doc.append( + "links", {"link_doctype": "Lead", "link_name": self.name, "link_title": self.lead_name} + ) self.contact_doc.save() + @frappe.whitelist() def make_customer(source_name, target_doc=None): return _make_customer(source_name, target_doc) @@ -227,16 +227,24 @@ def _make_customer(source_name, target_doc=None, ignore_permissions=False): target.customer_group = frappe.db.get_default("Customer Group") - doclist = get_mapped_doc("Lead", source_name, - {"Lead": { - "doctype": "Customer", - "field_map": { - "name": "lead_name", - "company_name": "customer_name", - "contact_no": "phone_1", - "fax": "fax_1" + doclist = get_mapped_doc( + "Lead", + source_name, + { + "Lead": { + "doctype": "Customer", + "field_map": { + "name": "lead_name", + "company_name": "customer_name", + "contact_no": "phone_1", + "fax": "fax_1", + }, } - }}, target_doc, set_missing_values, ignore_permissions=ignore_permissions) + }, + target_doc, + set_missing_values, + ignore_permissions=ignore_permissions, + ) return doclist @@ -246,19 +254,26 @@ def make_opportunity(source_name, target_doc=None): def set_missing_values(source, target): _set_missing_values(source, target) - target_doc = get_mapped_doc("Lead", source_name, - {"Lead": { - "doctype": "Opportunity", - "field_map": { - "campaign_name": "campaign", - "doctype": "opportunity_from", - "name": "party_name", - "lead_name": "contact_display", - "company_name": "customer_name", - "email_id": "contact_email", - "mobile_no": "contact_mobile" + target_doc = get_mapped_doc( + "Lead", + source_name, + { + "Lead": { + "doctype": "Opportunity", + "field_map": { + "campaign_name": "campaign", + "doctype": "opportunity_from", + "name": "party_name", + "lead_name": "contact_display", + "company_name": "customer_name", + "email_id": "contact_email", + "mobile_no": "contact_mobile", + }, } - }}, target_doc, set_missing_values) + }, + target_doc, + set_missing_values, + ) return target_doc @@ -268,13 +283,13 @@ def make_quotation(source_name, target_doc=None): def set_missing_values(source, target): _set_missing_values(source, target) - target_doc = get_mapped_doc("Lead", source_name, - {"Lead": { - "doctype": "Quotation", - "field_map": { - "name": "party_name" - } - }}, target_doc, set_missing_values) + target_doc = get_mapped_doc( + "Lead", + source_name, + {"Lead": {"doctype": "Quotation", "field_map": {"name": "party_name"}}}, + target_doc, + set_missing_values, + ) target_doc.quotation_to = "Lead" target_doc.run_method("set_missing_values") @@ -283,18 +298,29 @@ def make_quotation(source_name, target_doc=None): return target_doc -def _set_missing_values(source, target): - address = frappe.get_all('Dynamic Link', { - 'link_doctype': source.doctype, - 'link_name': source.name, - 'parenttype': 'Address', - }, ['parent'], limit=1) - contact = frappe.get_all('Dynamic Link', { - 'link_doctype': source.doctype, - 'link_name': source.name, - 'parenttype': 'Contact', - }, ['parent'], limit=1) +def _set_missing_values(source, target): + address = frappe.get_all( + "Dynamic Link", + { + "link_doctype": source.doctype, + "link_name": source.name, + "parenttype": "Address", + }, + ["parent"], + limit=1, + ) + + contact = frappe.get_all( + "Dynamic Link", + { + "link_doctype": source.doctype, + "link_name": source.name, + "parenttype": "Contact", + }, + ["parent"], + limit=1, + ) if address: target.customer_address = address[0].parent @@ -302,39 +328,49 @@ def _set_missing_values(source, target): if contact: target.contact_person = contact[0].parent + @frappe.whitelist() def get_lead_details(lead, posting_date=None, company=None): if not lead: return {} from erpnext.accounts.party import set_address_details + out = frappe._dict() lead_doc = frappe.get_doc("Lead", lead) lead = lead_doc - out.update({ - "territory": lead.territory, - "customer_name": lead.company_name or lead.lead_name, - "contact_display": " ".join(filter(None, [lead.salutation, lead.lead_name])), - "contact_email": lead.email_id, - "contact_mobile": lead.mobile_no, - "contact_phone": lead.phone, - }) + out.update( + { + "territory": lead.territory, + "customer_name": lead.company_name or lead.lead_name, + "contact_display": " ".join(filter(None, [lead.salutation, lead.lead_name])), + "contact_email": lead.email_id, + "contact_mobile": lead.mobile_no, + "contact_phone": lead.phone, + } + ) set_address_details(out, lead, "Lead") - taxes_and_charges = set_taxes(None, 'Lead', posting_date, company, - billing_address=out.get('customer_address'), shipping_address=out.get('shipping_address_name')) + taxes_and_charges = set_taxes( + None, + "Lead", + posting_date, + company, + billing_address=out.get("customer_address"), + shipping_address=out.get("shipping_address_name"), + ) if taxes_and_charges: - out['taxes_and_charges'] = taxes_and_charges + out["taxes_and_charges"] = taxes_and_charges return out @frappe.whitelist() def make_lead_from_communication(communication, ignore_communication_links=False): - """ raise a issue from email """ + """raise a issue from email""" doc = frappe.get_doc("Communication", communication) lead_name = None @@ -343,12 +379,14 @@ def make_lead_from_communication(communication, ignore_communication_links=False if not lead_name and doc.phone_no: lead_name = frappe.db.get_value("Lead", {"mobile_no": doc.phone_no}) if not lead_name: - lead = frappe.get_doc({ - "doctype": "Lead", - "lead_name": doc.sender_full_name, - "email_id": doc.sender, - "mobile_no": doc.phone_no - }) + lead = frappe.get_doc( + { + "doctype": "Lead", + "lead_name": doc.sender_full_name, + "email_id": doc.sender, + "mobile_no": doc.phone_no, + } + ) lead.flags.ignore_mandatory = True lead.flags.ignore_permissions = True lead.insert() @@ -358,19 +396,27 @@ def make_lead_from_communication(communication, ignore_communication_links=False link_communication_to_document(doc, "Lead", lead_name, ignore_communication_links) return lead_name -def get_lead_with_phone_number(number): - if not number: return - leads = frappe.get_all('Lead', or_filters={ - 'phone': ['like', '%{}'.format(number)], - 'mobile_no': ['like', '%{}'.format(number)] - }, limit=1, order_by="creation DESC") +def get_lead_with_phone_number(number): + if not number: + return + + leads = frappe.get_all( + "Lead", + or_filters={ + "phone": ["like", "%{}".format(number)], + "mobile_no": ["like", "%{}".format(number)], + }, + limit=1, + order_by="creation DESC", + ) lead = leads[0].name if leads else None return lead + def daily_open_lead(): - leads = frappe.get_all("Lead", filters = [["contact_date", "Between", [nowdate(), nowdate()]]]) + leads = frappe.get_all("Lead", filters=[["contact_date", "Between", [nowdate(), nowdate()]]]) for lead in leads: frappe.db.set_value("Lead", lead.name, "status", "Open") diff --git a/erpnext/crm/doctype/lead/lead_dashboard.py b/erpnext/crm/doctype/lead/lead_dashboard.py index 87a8c51bb84..c9ea88950d4 100644 --- a/erpnext/crm/doctype/lead/lead_dashboard.py +++ b/erpnext/crm/doctype/lead/lead_dashboard.py @@ -1,18 +1,9 @@ - - def get_data(): return { - 'fieldname': 'lead', - 'non_standard_fieldnames': { - 'Quotation': 'party_name', - 'Opportunity': 'party_name' - }, - 'dynamic_links': { - 'party_name': ['Lead', 'quotation_to'] - }, - 'transactions': [ - { - 'items': ['Opportunity', 'Quotation'] - }, - ] + "fieldname": "lead", + "non_standard_fieldnames": {"Quotation": "party_name", "Opportunity": "party_name"}, + "dynamic_links": {"party_name": ["Lead", "quotation_to"]}, + "transactions": [ + {"items": ["Opportunity", "Quotation"]}, + ], } diff --git a/erpnext/crm/doctype/lead/test_lead.py b/erpnext/crm/doctype/lead/test_lead.py index d4157db848d..fc48363c293 100644 --- a/erpnext/crm/doctype/lead/test_lead.py +++ b/erpnext/crm/doctype/lead/test_lead.py @@ -6,7 +6,8 @@ import unittest import frappe -test_records = frappe.get_test_records('Lead') +test_records = frappe.get_test_records("Lead") + class TestLead(unittest.TestCase): def test_make_customer(self): diff --git a/erpnext/crm/doctype/linkedin_settings/linkedin_settings.py b/erpnext/crm/doctype/linkedin_settings/linkedin_settings.py index 8fd4978715f..e50c13dc5e1 100644 --- a/erpnext/crm/doctype/linkedin_settings/linkedin_settings.py +++ b/erpnext/crm/doctype/linkedin_settings/linkedin_settings.py @@ -14,12 +14,16 @@ from six.moves.urllib.parse import urlencode class LinkedInSettings(Document): @frappe.whitelist() def get_authorization_url(self): - params = urlencode({ - "response_type":"code", - "client_id": self.consumer_key, - "redirect_uri": "{0}/api/method/erpnext.crm.doctype.linkedin_settings.linkedin_settings.callback?".format(frappe.utils.get_url()), - "scope": "r_emailaddress w_organization_social r_basicprofile r_liteprofile r_organization_social rw_organization_admin w_member_social" - }) + params = urlencode( + { + "response_type": "code", + "client_id": self.consumer_key, + "redirect_uri": "{0}/api/method/erpnext.crm.doctype.linkedin_settings.linkedin_settings.callback?".format( + frappe.utils.get_url() + ), + "scope": "r_emailaddress w_organization_social r_basicprofile r_liteprofile r_organization_social rw_organization_admin w_member_social", + } + ) url = "https://www.linkedin.com/oauth/v2/authorization?{}".format(params) @@ -32,11 +36,11 @@ class LinkedInSettings(Document): "code": code, "client_id": self.consumer_key, "client_secret": self.get_password(fieldname="consumer_secret"), - "redirect_uri": "{0}/api/method/erpnext.crm.doctype.linkedin_settings.linkedin_settings.callback?".format(frappe.utils.get_url()), - } - headers = { - "Content-Type": "application/x-www-form-urlencoded" + "redirect_uri": "{0}/api/method/erpnext.crm.doctype.linkedin_settings.linkedin_settings.callback?".format( + frappe.utils.get_url() + ), } + headers = {"Content-Type": "application/x-www-form-urlencoded"} response = self.http_post(url=url, data=body, headers=headers) response = frappe.parse_json(response.content.decode()) @@ -46,11 +50,15 @@ class LinkedInSettings(Document): response = requests.get(url="https://api.linkedin.com/v2/me", headers=self.get_headers()) response = frappe.parse_json(response.content.decode()) - frappe.db.set_value(self.doctype, self.name, { - "person_urn": response["id"], - "account_name": response["vanityName"], - "session_status": "Active" - }) + frappe.db.set_value( + self.doctype, + self.name, + { + "person_urn": response["id"], + "account_name": response["vanityName"], + "session_status": "Active", + }, + ) frappe.local.response["type"] = "redirect" frappe.local.response["location"] = get_url_to_form("LinkedIn Settings", "LinkedIn Settings") @@ -63,8 +71,7 @@ class LinkedInSettings(Document): if media_id: return self.post_text(text, title, media_id=media_id) else: - frappe.log_error("Failed to upload media.","LinkedIn Upload Error") - + frappe.log_error("Failed to upload media.", "LinkedIn Upload Error") def upload_image(self, media): media = get_file_path(media) @@ -73,10 +80,9 @@ class LinkedInSettings(Document): "registerUploadRequest": { "recipes": ["urn:li:digitalmediaRecipe:feedshare-image"], "owner": "urn:li:organization:{0}".format(self.company_id), - "serviceRelationships": [{ - "relationshipType": "OWNER", - "identifier": "urn:li:userGeneratedContent" - }] + "serviceRelationships": [ + {"relationshipType": "OWNER", "identifier": "urn:li:userGeneratedContent"} + ], } } headers = self.get_headers() @@ -85,11 +91,16 @@ class LinkedInSettings(Document): if response.status_code == 200: response = response.json() asset = response["value"]["asset"] - upload_url = response["value"]["uploadMechanism"]["com.linkedin.digitalmedia.uploading.MediaUploadHttpRequest"]["uploadUrl"] - headers['Content-Type']='image/jpeg' - response = self.http_post(upload_url, headers=headers, data=open(media,"rb")) + upload_url = response["value"]["uploadMechanism"][ + "com.linkedin.digitalmedia.uploading.MediaUploadHttpRequest" + ]["uploadUrl"] + headers["Content-Type"] = "image/jpeg" + response = self.http_post(upload_url, headers=headers, data=open(media, "rb")) if response.status_code < 200 and response.status_code > 299: - frappe.throw(_("Error While Uploading Image"), title="{0} {1}".format(response.status_code, response.reason)) + frappe.throw( + _("Error While Uploading Image"), + title="{0} {1}".format(response.status_code, response.reason), + ) return None return asset @@ -102,46 +113,26 @@ class LinkedInSettings(Document): headers["Content-Type"] = "application/json; charset=UTF-8" body = { - "distribution": { - "linkedInDistributionTarget": {} - }, - "owner":"urn:li:organization:{0}".format(self.company_id), + "distribution": {"linkedInDistributionTarget": {}}, + "owner": "urn:li:organization:{0}".format(self.company_id), "subject": title, - "text": { - "text": text - } + "text": {"text": text}, } reference_url = self.get_reference_url(text) if reference_url: - body["content"] = { - "contentEntities": [ - { - "entityLocation": reference_url - } - ] - } + body["content"] = {"contentEntities": [{"entityLocation": reference_url}]} if media_id: - body["content"]= { - "contentEntities": [{ - "entity": media_id - }], - "shareMediaCategory": "IMAGE" - } + body["content"] = {"contentEntities": [{"entity": media_id}], "shareMediaCategory": "IMAGE"} response = self.http_post(url=url, headers=headers, body=body) return response def http_post(self, url, headers=None, body=None, data=None): try: - response = requests.post( - url = url, - json = body, - data = data, - headers = headers - ) - if response.status_code not in [201,200]: + response = requests.post(url=url, json=body, data=data, headers=headers) + if response.status_code not in [201, 200]: raise except Exception as e: @@ -150,12 +141,11 @@ class LinkedInSettings(Document): return response def get_headers(self): - return { - "Authorization": "Bearer {}".format(self.access_token) - } + return {"Authorization": "Bearer {}".format(self.access_token)} def get_reference_url(self, text): import re + regex_url = r"http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+" urls = re.findall(regex_url, text) if urls: @@ -163,18 +153,23 @@ class LinkedInSettings(Document): def delete_post(self, post_id): try: - response = requests.delete(url="https://api.linkedin.com/v2/shares/urn:li:share:{0}".format(post_id), headers=self.get_headers()) - if response.status_code !=200: + response = requests.delete( + url="https://api.linkedin.com/v2/shares/urn:li:share:{0}".format(post_id), + headers=self.get_headers(), + ) + if response.status_code != 200: raise except Exception: self.api_error(response) def get_post(self, post_id): - url = "https://api.linkedin.com/v2/organizationalEntityShareStatistics?q=organizationalEntity&organizationalEntity=urn:li:organization:{0}&shares[0]=urn:li:share:{1}".format(self.company_id, post_id) + url = "https://api.linkedin.com/v2/organizationalEntityShareStatistics?q=organizationalEntity&organizationalEntity=urn:li:organization:{0}&shares[0]=urn:li:share:{1}".format( + self.company_id, post_id + ) try: response = requests.get(url=url, headers=self.get_headers()) - if response.status_code !=200: + if response.status_code != 200: raise except Exception: @@ -199,6 +194,7 @@ class LinkedInSettings(Document): else: frappe.throw(response.reason, title=response.status_code) + @frappe.whitelist(allow_guest=True) def callback(code=None, error=None, error_description=None): if not error: @@ -208,4 +204,4 @@ def callback(code=None, error=None, error_description=None): frappe.db.commit() else: frappe.local.response["type"] = "redirect" - frappe.local.response["location"] = get_url_to_form("LinkedIn Settings","LinkedIn Settings") + frappe.local.response["location"] = get_url_to_form("LinkedIn Settings", "LinkedIn Settings") diff --git a/erpnext/crm/doctype/opportunity/opportunity.py b/erpnext/crm/doctype/opportunity/opportunity.py index ca670190c92..676da31a63a 100644 --- a/erpnext/crm/doctype/opportunity/opportunity.py +++ b/erpnext/crm/doctype/opportunity/opportunity.py @@ -8,7 +8,7 @@ import frappe from frappe import _ from frappe.email.inbox import link_communication_to_document from frappe.model.mapper import get_mapped_doc -from frappe.utils import cint, cstr, get_fullname +from frappe.utils import cint, get_fullname from erpnext.accounts.party import get_party_account_currency from erpnext.setup.utils import get_exchange_rate @@ -21,12 +21,16 @@ class Opportunity(TransactionBase): frappe.get_doc("Lead", self.party_name).set_status(update=True) def validate(self): - self._prev = frappe._dict({ - "contact_date": frappe.db.get_value("Opportunity", self.name, "contact_date") if \ - (not cint(self.get("__islocal"))) else None, - "contact_by": frappe.db.get_value("Opportunity", self.name, "contact_by") if \ - (not cint(self.get("__islocal"))) else None, - }) + self._prev = frappe._dict( + { + "contact_date": frappe.db.get_value("Opportunity", self.name, "contact_date") + if (not cint(self.get("__islocal"))) + else None, + "contact_by": frappe.db.get_value("Opportunity", self.name, "contact_by") + if (not cint(self.get("__islocal"))) + else None, + } + ) self.make_new_lead_if_required() @@ -54,7 +58,8 @@ class Opportunity(TransactionBase): """Set lead against new opportunity""" if (not self.get("party_name")) and self.contact_email: # check if customer is already created agains the self.contact_email - customer = frappe.db.sql("""select + customer = frappe.db.sql( + """select distinct `tabDynamic Link`.link_name as customer from `tabContact`, @@ -66,7 +71,11 @@ class Opportunity(TransactionBase): ifnull(`tabDynamic Link`.link_name, '')<>'' and `tabDynamic Link`.link_doctype='Customer' - """.format(self.contact_email), as_dict=True) + """.format( + self.contact_email + ), + as_dict=True, + ) if customer and customer[0].customer: self.party_name = customer[0].customer self.opportunity_from = "Customer" @@ -78,19 +87,17 @@ class Opportunity(TransactionBase): if sender_name == self.contact_email: sender_name = None - if not sender_name and ('@' in self.contact_email): - email_name = self.contact_email.split('@')[0] + if not sender_name and ("@" in self.contact_email): + email_name = self.contact_email.split("@")[0] - email_split = email_name.split('.') - sender_name = '' + email_split = email_name.split(".") + sender_name = "" for s in email_split: - sender_name += s.capitalize() + ' ' + sender_name += s.capitalize() + " " - lead = frappe.get_doc({ - "doctype": "Lead", - "email_id": self.contact_email, - "lead_name": sender_name or 'Unknown' - }) + lead = frappe.get_doc( + {"doctype": "Lead", "email_id": self.contact_email, "lead_name": sender_name or "Unknown"} + ) lead.flags.ignore_email_validation = True lead.insert(ignore_permissions=True) @@ -102,13 +109,13 @@ class Opportunity(TransactionBase): @frappe.whitelist() def declare_enquiry_lost(self, lost_reasons_list, detailed_reason=None): if not self.has_active_quotation(): - frappe.db.set(self, 'status', 'Lost') + frappe.db.set(self, "status", "Lost") if detailed_reason: - frappe.db.set(self, 'order_lost_reason', detailed_reason) + frappe.db.set(self, "order_lost_reason", detailed_reason) for reason in lost_reasons_list: - self.append('lost_reasons', reason) + self.append("lost_reasons", reason) self.save() @@ -120,51 +127,58 @@ class Opportunity(TransactionBase): def has_active_quotation(self): if not self.with_items: - return frappe.get_all('Quotation', - { - 'opportunity': self.name, - 'status': ("not in", ['Lost', 'Closed']), - 'docstatus': 1 - }, 'name') + return frappe.get_all( + "Quotation", + {"opportunity": self.name, "status": ("not in", ["Lost", "Closed"]), "docstatus": 1}, + "name", + ) else: - return frappe.db.sql(""" + return frappe.db.sql( + """ select q.name from `tabQuotation` q, `tabQuotation Item` qi where q.name = qi.parent and q.docstatus=1 and qi.prevdoc_docname =%s - and q.status not in ('Lost', 'Closed')""", self.name) + and q.status not in ('Lost', 'Closed')""", + self.name, + ) def has_ordered_quotation(self): if not self.with_items: - return frappe.get_all('Quotation', - { - 'opportunity': self.name, - 'status': 'Ordered', - 'docstatus': 1 - }, 'name') + return frappe.get_all( + "Quotation", {"opportunity": self.name, "status": "Ordered", "docstatus": 1}, "name" + ) else: - return frappe.db.sql(""" + return frappe.db.sql( + """ select q.name from `tabQuotation` q, `tabQuotation Item` qi where q.name = qi.parent and q.docstatus=1 and qi.prevdoc_docname =%s - and q.status = 'Ordered'""", self.name) + and q.status = 'Ordered'""", + self.name, + ) def has_lost_quotation(self): - lost_quotation = frappe.db.sql(""" + lost_quotation = frappe.db.sql( + """ select name from `tabQuotation` where docstatus=1 and opportunity =%s and status = 'Lost' - """, self.name) + """, + self.name, + ) if lost_quotation: if self.has_active_quotation(): return False return True def validate_cust_name(self): - if self.party_name and self.opportunity_from == 'Customer': + if self.party_name and self.opportunity_from == "Customer": self.customer_name = frappe.db.get_value("Customer", self.party_name, "customer_name") - elif self.party_name and self.opportunity_from == 'Lead': - lead_name, company_name = frappe.db.get_value("Lead", self.party_name, ["lead_name", "company_name"]) + elif self.party_name and self.opportunity_from == "Lead": + lead_name, company_name = frappe.db.get_value( + "Lead", self.party_name, ["lead_name", "company_name"] + ) self.customer_name = company_name or lead_name def on_update(self): @@ -177,27 +191,27 @@ class Opportunity(TransactionBase): opts.description = "" opts.contact_date = self.contact_date - if self.party_name and self.opportunity_from == 'Customer': + if self.party_name and self.opportunity_from == "Customer": if self.contact_person: - opts.description = 'Contact '+cstr(self.contact_person) + opts.description = f"Contact {self.contact_person}" else: - opts.description = 'Contact customer '+cstr(self.party_name) - elif self.party_name and self.opportunity_from == 'Lead': + opts.description = f"Contact customer {self.party_name}" + elif self.party_name and self.opportunity_from == "Lead": if self.contact_display: - opts.description = 'Contact '+cstr(self.contact_display) + opts.description = f"Contact {self.contact_display}" else: - opts.description = 'Contact lead '+cstr(self.party_name) + opts.description = f"Contact lead {self.party_name}" opts.subject = opts.description - opts.description += '. By : ' + cstr(self.contact_by) + opts.description += f". By : {self.contact_by}" if self.to_discuss: - opts.description += ' To Discuss : ' + cstr(self.to_discuss) + opts.description += f" To Discuss : {frappe.render_template(self.to_discuss, {'doc': self})}" super(Opportunity, self).add_calendar_event(opts, force) def validate_item_details(self): - if not self.get('items'): + if not self.get("items"): return # set missing values @@ -209,32 +223,41 @@ class Opportunity(TransactionBase): item = frappe.db.get_value("Item", d.item_code, item_fields, as_dict=True) for key in item_fields: - if not d.get(key): d.set(key, item.get(key)) + if not d.get(key): + d.set(key, item.get(key)) @frappe.whitelist() def get_item_details(item_code): - item = frappe.db.sql("""select item_name, stock_uom, image, description, item_group, brand - from `tabItem` where name = %s""", item_code, as_dict=1) + item = frappe.db.sql( + """select item_name, stock_uom, image, description, item_group, brand + from `tabItem` where name = %s""", + item_code, + as_dict=1, + ) return { - 'item_name': item and item[0]['item_name'] or '', - 'uom': item and item[0]['stock_uom'] or '', - 'description': item and item[0]['description'] or '', - 'image': item and item[0]['image'] or '', - 'item_group': item and item[0]['item_group'] or '', - 'brand': item and item[0]['brand'] or '' + "item_name": item and item[0]["item_name"] or "", + "uom": item and item[0]["stock_uom"] or "", + "description": item and item[0]["description"] or "", + "image": item and item[0]["image"] or "", + "item_group": item and item[0]["item_group"] or "", + "brand": item and item[0]["brand"] or "", } + @frappe.whitelist() def make_quotation(source_name, target_doc=None): def set_missing_values(source, target): from erpnext.controllers.accounts_controller import get_default_taxes_and_charges + quotation = frappe.get_doc(target) - company_currency = frappe.get_cached_value('Company', quotation.company, "default_currency") + company_currency = frappe.get_cached_value("Company", quotation.company, "default_currency") - if quotation.quotation_to == 'Customer' and quotation.party_name: - party_account_currency = get_party_account_currency("Customer", quotation.party_name, quotation.company) + if quotation.quotation_to == "Customer" and quotation.party_name: + party_account_currency = get_party_account_currency( + "Customer", quotation.party_name, quotation.company + ) else: party_account_currency = company_currency @@ -243,14 +266,17 @@ def make_quotation(source_name, target_doc=None): if company_currency == quotation.currency: exchange_rate = 1 else: - exchange_rate = get_exchange_rate(quotation.currency, company_currency, - quotation.transaction_date, args="for_selling") + exchange_rate = get_exchange_rate( + quotation.currency, company_currency, quotation.transaction_date, args="for_selling" + ) quotation.conversion_rate = exchange_rate # get default taxes - taxes = get_default_taxes_and_charges("Sales Taxes and Charges Template", company=quotation.company) - if taxes.get('taxes'): + taxes = get_default_taxes_and_charges( + "Sales Taxes and Charges Template", company=quotation.company + ) + if taxes.get("taxes"): quotation.update(taxes) quotation.run_method("set_missing_values") @@ -258,49 +284,56 @@ def make_quotation(source_name, target_doc=None): if not source.with_items: quotation.opportunity = source.name - doclist = get_mapped_doc("Opportunity", source_name, { - "Opportunity": { - "doctype": "Quotation", - "field_map": { - "opportunity_from": "quotation_to", - "name": "enq_no", - } - }, - "Opportunity Item": { - "doctype": "Quotation Item", - "field_map": { - "parent": "prevdoc_docname", - "parenttype": "prevdoc_doctype", - "uom": "stock_uom" + doclist = get_mapped_doc( + "Opportunity", + source_name, + { + "Opportunity": { + "doctype": "Quotation", + "field_map": { + "opportunity_from": "quotation_to", + "name": "enq_no", + }, }, - "add_if_empty": True - } - }, target_doc, set_missing_values) + "Opportunity Item": { + "doctype": "Quotation Item", + "field_map": { + "parent": "prevdoc_docname", + "parenttype": "prevdoc_doctype", + "uom": "stock_uom", + }, + "add_if_empty": True, + }, + }, + target_doc, + set_missing_values, + ) return doclist + @frappe.whitelist() def make_request_for_quotation(source_name, target_doc=None): def update_item(obj, target, source_parent): target.conversion_factor = 1.0 - doclist = get_mapped_doc("Opportunity", source_name, { - "Opportunity": { - "doctype": "Request for Quotation" + doclist = get_mapped_doc( + "Opportunity", + source_name, + { + "Opportunity": {"doctype": "Request for Quotation"}, + "Opportunity Item": { + "doctype": "Request for Quotation Item", + "field_map": [["name", "opportunity_item"], ["parent", "opportunity"], ["uom", "uom"]], + "postprocess": update_item, + }, }, - "Opportunity Item": { - "doctype": "Request for Quotation Item", - "field_map": [ - ["name", "opportunity_item"], - ["parent", "opportunity"], - ["uom", "uom"] - ], - "postprocess": update_item - } - }, target_doc) + target_doc, + ) return doclist + @frappe.whitelist() def make_customer(source_name, target_doc=None): def set_missing_values(source, target): @@ -309,37 +342,37 @@ def make_customer(source_name, target_doc=None): if source.opportunity_from == "Lead": target.lead_name = source.party_name - doclist = get_mapped_doc("Opportunity", source_name, { - "Opportunity": { - "doctype": "Customer", - "field_map": { - "currency": "default_currency", - "customer_name": "customer_name" + doclist = get_mapped_doc( + "Opportunity", + source_name, + { + "Opportunity": { + "doctype": "Customer", + "field_map": {"currency": "default_currency", "customer_name": "customer_name"}, } - } - }, target_doc, set_missing_values) + }, + target_doc, + set_missing_values, + ) return doclist + @frappe.whitelist() def make_supplier_quotation(source_name, target_doc=None): - doclist = get_mapped_doc("Opportunity", source_name, { - "Opportunity": { - "doctype": "Supplier Quotation", - "field_map": { - "name": "opportunity" - } + doclist = get_mapped_doc( + "Opportunity", + source_name, + { + "Opportunity": {"doctype": "Supplier Quotation", "field_map": {"name": "opportunity"}}, + "Opportunity Item": {"doctype": "Supplier Quotation Item", "field_map": {"uom": "stock_uom"}}, }, - "Opportunity Item": { - "doctype": "Supplier Quotation Item", - "field_map": { - "uom": "stock_uom" - } - } - }, target_doc) + target_doc, + ) return doclist + @frappe.whitelist() def set_multiple_status(names, status): names = json.loads(names) @@ -348,12 +381,19 @@ def set_multiple_status(names, status): opp.status = status opp.save() -def auto_close_opportunity(): - """ auto close the `Replied` Opportunities after 7 days """ - auto_close_after_days = frappe.db.get_single_value("Selling Settings", "close_opportunity_after_days") or 15 - opportunities = frappe.db.sql(""" select name from tabOpportunity where status='Replied' and - modified
${ category.name }
diff --git a/erpnext/e_commerce/redisearch_utils.py b/erpnext/e_commerce/redisearch_utils.py
index 59c7f32fd46..97da02688ef 100644
--- a/erpnext/e_commerce/redisearch_utils.py
+++ b/erpnext/e_commerce/redisearch_utils.py
@@ -1,73 +1,90 @@
-# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors
+# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors
# License: GNU General Public License v3. See license.txt
+import json
+
import frappe
+from frappe import _
from frappe.utils.redis_wrapper import RedisWrapper
+from redis import ResponseError
from redisearch import AutoCompleter, Client, IndexDefinition, Suggestion, TagField, TextField
-WEBSITE_ITEM_INDEX = 'website_items_index'
-WEBSITE_ITEM_KEY_PREFIX = 'website_item:'
-WEBSITE_ITEM_NAME_AUTOCOMPLETE = 'website_items_name_dict'
-WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE = 'website_items_category_dict'
+WEBSITE_ITEM_INDEX = "website_items_index"
+WEBSITE_ITEM_KEY_PREFIX = "website_item:"
+WEBSITE_ITEM_NAME_AUTOCOMPLETE = "website_items_name_dict"
+WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE = "website_items_category_dict"
+
def get_indexable_web_fields():
"Return valid fields from Website Item that can be searched for."
web_item_meta = frappe.get_meta("Website Item", cached=True)
valid_fields = filter(
lambda df: df.fieldtype in ("Link", "Table MultiSelect", "Data", "Small Text", "Text Editor"),
- web_item_meta.fields)
+ web_item_meta.fields,
+ )
return [df.fieldname for df in valid_fields]
+
+def is_redisearch_enabled():
+ "Return True only if redisearch is loaded and enabled."
+ is_redisearch_enabled = frappe.db.get_single_value("E Commerce Settings", "is_redisearch_enabled")
+ return is_search_module_loaded() and is_redisearch_enabled
+
+
def is_search_module_loaded():
try:
cache = frappe.cache()
- out = cache.execute_command('MODULE LIST')
+ out = cache.execute_command("MODULE LIST")
parsed_output = " ".join(
- (" ".join([s.decode() for s in o if not isinstance(s, int)]) for o in out)
+ (" ".join([frappe.as_unicode(s) for s in o if not isinstance(s, int)]) for o in out)
)
return "search" in parsed_output
except Exception:
- return False
+ return False # handling older redis versions
+
+
+def if_redisearch_enabled(function):
+ "Decorator to check if Redisearch is enabled."
-def if_redisearch_loaded(function):
- "Decorator to check if Redisearch is loaded."
def wrapper(*args, **kwargs):
- if is_search_module_loaded():
+ if is_redisearch_enabled():
func = function(*args, **kwargs)
return func
return
return wrapper
-def make_key(key):
- return "{0}|{1}".format(frappe.conf.db_name, key).encode('utf-8')
-@if_redisearch_loaded
+def make_key(key):
+ return "{0}|{1}".format(frappe.conf.db_name, key).encode("utf-8")
+
+
+@if_redisearch_enabled
def create_website_items_index():
"Creates Index Definition."
# CREATE index
client = Client(make_key(WEBSITE_ITEM_INDEX), conn=frappe.cache())
- # DROP if already exists
try:
- client.drop_index()
- except Exception:
+ client.drop_index() # drop if already exists
+ except ResponseError:
+ # will most likely raise a ResponseError if index does not exist
+ # ignore and create index
pass
+ except Exception:
+ raise_redisearch_error()
idx_def = IndexDefinition([make_key(WEBSITE_ITEM_KEY_PREFIX)])
- # Based on e-commerce settings
- idx_fields = frappe.db.get_single_value(
- 'E Commerce Settings',
- 'search_index_fields'
- )
- idx_fields = idx_fields.split(',') if idx_fields else []
+ # Index fields mentioned in e-commerce settings
+ idx_fields = frappe.db.get_single_value("E Commerce Settings", "search_index_fields")
+ idx_fields = idx_fields.split(",") if idx_fields else []
- if 'web_item_name' in idx_fields:
- idx_fields.remove('web_item_name')
+ if "web_item_name" in idx_fields:
+ idx_fields.remove("web_item_name")
idx_fields = list(map(to_search_field, idx_fields))
@@ -79,45 +96,51 @@ def create_website_items_index():
reindex_all_web_items()
define_autocomplete_dictionary()
+
def to_search_field(field):
if field == "tags":
return TagField("tags", separator=",")
return TextField(field)
-@if_redisearch_loaded
+
+@if_redisearch_enabled
def insert_item_to_index(website_item_doc):
# Insert item to index
key = get_cache_key(website_item_doc.name)
cache = frappe.cache()
web_item = create_web_item_map(website_item_doc)
- for k, v in web_item.items():
- super(RedisWrapper, cache).hset(make_key(key), k, v)
+ for field, value in web_item.items():
+ super(RedisWrapper, cache).hset(make_key(key), field, value)
insert_to_name_ac(website_item_doc.web_item_name, website_item_doc.name)
-@if_redisearch_loaded
+
+@if_redisearch_enabled
def insert_to_name_ac(web_name, doc_name):
ac = AutoCompleter(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE), conn=frappe.cache())
ac.add_suggestions(Suggestion(web_name, payload=doc_name))
+
def create_web_item_map(website_item_doc):
fields_to_index = get_fields_indexed()
web_item = {}
- for f in fields_to_index:
- web_item[f] = website_item_doc.get(f) or ''
+ for field in fields_to_index:
+ web_item[field] = website_item_doc.get(field) or ""
return web_item
-@if_redisearch_loaded
+
+@if_redisearch_enabled
def update_index_for_item(website_item_doc):
# Reinsert to Cache
insert_item_to_index(website_item_doc)
define_autocomplete_dictionary()
-@if_redisearch_loaded
+
+@if_redisearch_enabled
def delete_item_from_index(website_item_doc):
cache = frappe.cache()
key = get_cache_key(website_item_doc.name)
@@ -125,86 +148,107 @@ def delete_item_from_index(website_item_doc):
try:
cache.delete(key)
except Exception:
- return False
+ raise_redisearch_error()
delete_from_ac_dict(website_item_doc)
return True
-@if_redisearch_loaded
+
+@if_redisearch_enabled
def delete_from_ac_dict(website_item_doc):
- '''Removes this items's name from autocomplete dictionary'''
+ """Removes this items's name from autocomplete dictionary"""
cache = frappe.cache()
name_ac = AutoCompleter(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE), conn=cache)
name_ac.delete(website_item_doc.web_item_name)
-@if_redisearch_loaded
+
+@if_redisearch_enabled
def define_autocomplete_dictionary():
- """Creates an autocomplete search dictionary for `name`.
- Also creats autocomplete dictionary for `categories` if
- checked in E Commerce Settings"""
+ """
+ Defines/Redefines an autocomplete search dictionary for Website Item Name.
+ Also creats autocomplete dictionary for Published Item Groups.
+ """
cache = frappe.cache()
- name_ac = AutoCompleter(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE), conn=cache)
- cat_ac = AutoCompleter(make_key(WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE), conn=cache)
-
- ac_categories = frappe.db.get_single_value(
- 'E Commerce Settings',
- 'show_categories_in_search_autocomplete'
- )
+ item_ac = AutoCompleter(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE), conn=cache)
+ item_group_ac = AutoCompleter(make_key(WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE), conn=cache)
# Delete both autocomplete dicts
try:
cache.delete(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE))
cache.delete(make_key(WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE))
except Exception:
- return False
+ raise_redisearch_error()
+ create_items_autocomplete_dict(autocompleter=item_ac)
+ create_item_groups_autocomplete_dict(autocompleter=item_group_ac)
+
+
+@if_redisearch_enabled
+def create_items_autocomplete_dict(autocompleter):
+ "Add items as suggestions in Autocompleter."
items = frappe.get_all(
- 'Website Item',
- fields=['web_item_name', 'item_group'],
- filters={"published": 1}
+ "Website Item", fields=["web_item_name", "item_group"], filters={"published": 1}
)
for item in items:
- name_ac.add_suggestions(Suggestion(item.web_item_name))
- if ac_categories and item.item_group:
- cat_ac.add_suggestions(Suggestion(item.item_group))
+ autocompleter.add_suggestions(Suggestion(item.web_item_name))
- return True
-@if_redisearch_loaded
-def reindex_all_web_items():
- items = frappe.get_all(
- 'Website Item',
- fields=get_fields_indexed(),
- filters={"published": True}
+@if_redisearch_enabled
+def create_item_groups_autocomplete_dict(autocompleter):
+ "Add item groups with weightage as suggestions in Autocompleter."
+ published_item_groups = frappe.get_all(
+ "Item Group", fields=["name", "route", "weightage"], filters={"show_in_website": 1}
)
+ if not published_item_groups:
+ return
+
+ for item_group in published_item_groups:
+ payload = json.dumps({"name": item_group.name, "route": item_group.route})
+ autocompleter.add_suggestions(
+ Suggestion(
+ string=item_group.name,
+ score=frappe.utils.flt(item_group.weightage) or 1.0,
+ payload=payload, # additional info that can be retrieved later
+ )
+ )
+
+
+@if_redisearch_enabled
+def reindex_all_web_items():
+ items = frappe.get_all("Website Item", fields=get_fields_indexed(), filters={"published": True})
cache = frappe.cache()
for item in items:
web_item = create_web_item_map(item)
key = make_key(get_cache_key(item.name))
- for k, v in web_item.items():
- super(RedisWrapper, cache).hset(key, k, v)
+ for field, value in web_item.items():
+ super(RedisWrapper, cache).hset(key, field, value)
+
def get_cache_key(name):
name = frappe.scrub(name)
return f"{WEBSITE_ITEM_KEY_PREFIX}{name}"
-def get_fields_indexed():
- fields_to_index = frappe.db.get_single_value(
- 'E Commerce Settings',
- 'search_index_fields'
- )
- fields_to_index = fields_to_index.split(',') if fields_to_index else []
- mandatory_fields = ['name', 'web_item_name', 'route', 'thumbnail', 'ranking']
+def get_fields_indexed():
+ fields_to_index = frappe.db.get_single_value("E Commerce Settings", "search_index_fields")
+ fields_to_index = fields_to_index.split(",") if fields_to_index else []
+
+ mandatory_fields = ["name", "web_item_name", "route", "thumbnail", "ranking"]
fields_to_index = fields_to_index + mandatory_fields
return fields_to_index
-# TODO: Remove later
-# # Figure out a way to run this at startup
-define_autocomplete_dictionary()
-create_website_items_index()
+
+def raise_redisearch_error():
+ "Create an Error Log and raise error."
+ traceback = frappe.get_traceback()
+ log = frappe.log_error(traceback, frappe._("Redisearch Error"))
+ log_link = frappe.utils.get_link_to_form("Error Log", log.name)
+
+ frappe.throw(
+ msg=_("Something went wrong. Check {0}").format(log_link), title=_("Redisearch Error")
+ )
diff --git a/erpnext/e_commerce/shopping_cart/cart.py b/erpnext/e_commerce/shopping_cart/cart.py
index cd6bd03edf7..134933bd369 100644
--- a/erpnext/e_commerce/shopping_cart/cart.py
+++ b/erpnext/e_commerce/shopping_cart/cart.py
@@ -20,15 +20,17 @@ from erpnext.utilities.product import get_web_item_qty_in_stock
class WebsitePriceListMissingError(frappe.ValidationError):
pass
+
def set_cart_count(quotation=None):
if cint(frappe.db.get_singles_value("E Commerce Settings", "enabled")):
if not quotation:
quotation = _get_cart_quotation()
- cart_count = cstr(len(quotation.get("items")))
+ cart_count = cstr(cint(quotation.get("total_qty")))
if hasattr(frappe.local, "cookie_manager"):
frappe.local.cookie_manager.set_cookie("cart_count", cart_count)
+
@frappe.whitelist()
def get_cart_quotation(doc=None):
party = get_party()
@@ -48,38 +50,46 @@ def get_cart_quotation(doc=None):
"shipping_addresses": get_shipping_addresses(party),
"billing_addresses": get_billing_addresses(party),
"shipping_rules": get_applicable_shipping_rules(party),
- "cart_settings": frappe.get_cached_doc("E Commerce Settings")
+ "cart_settings": frappe.get_cached_doc("E Commerce Settings"),
}
+
@frappe.whitelist()
def get_shipping_addresses(party=None):
if not party:
party = get_party()
addresses = get_address_docs(party=party)
- return [{"name": address.name, "title": address.address_title, "display": address.display}
- for address in addresses if address.address_type == "Shipping"
+ return [
+ {"name": address.name, "title": address.address_title, "display": address.display}
+ for address in addresses
+ if address.address_type == "Shipping"
]
+
@frappe.whitelist()
def get_billing_addresses(party=None):
if not party:
party = get_party()
addresses = get_address_docs(party=party)
- return [{"name": address.name, "title": address.address_title, "display": address.display}
- for address in addresses if address.address_type == "Billing"
+ return [
+ {"name": address.name, "title": address.address_title, "display": address.display}
+ for address in addresses
+ if address.address_type == "Billing"
]
+
@frappe.whitelist()
def place_order():
quotation = _get_cart_quotation()
- cart_settings = frappe.db.get_value("E Commerce Settings", None,
- ["company", "allow_items_not_in_stock"], as_dict=1)
+ cart_settings = frappe.db.get_value(
+ "E Commerce Settings", None, ["company", "allow_items_not_in_stock"], as_dict=1
+ )
quotation.company = cart_settings.company
quotation.flags.ignore_permissions = True
quotation.submit()
- if quotation.quotation_to == 'Lead' and quotation.party_name:
+ if quotation.quotation_to == "Lead" and quotation.party_name:
# company used to create customer accounts
frappe.defaults.set_user_default("company", quotation.company)
@@ -87,17 +97,14 @@ def place_order():
frappe.throw(_("Set Shipping Address or Billing Address"))
from erpnext.selling.doctype.quotation.quotation import _make_sales_order
+
sales_order = frappe.get_doc(_make_sales_order(quotation.name, ignore_permissions=True))
sales_order.payment_schedule = []
if not cint(cart_settings.allow_items_not_in_stock):
for item in sales_order.get("items"):
item.warehouse = frappe.db.get_value(
- "Website Item",
- {
- "item_code": item.item_code
- },
- "website_warehouse"
+ "Website Item", {"item_code": item.item_code}, "website_warehouse"
)
is_stock_item = frappe.db.get_value("Item", item.item_code, "is_stock_item")
@@ -117,13 +124,19 @@ def place_order():
return sales_order.name
+
@frappe.whitelist()
def request_for_quotation():
quotation = _get_cart_quotation()
quotation.flags.ignore_permissions = True
- quotation.submit()
+
+ if get_shopping_cart_settings().save_quotations_as_draft:
+ quotation.save()
+ else:
+ quotation.submit()
return quotation.name
+
@frappe.whitelist()
def update_cart(item_code, qty, additional_notes=None, with_items=False):
quotation = _get_cart_quotation()
@@ -140,12 +153,15 @@ def update_cart(item_code, qty, additional_notes=None, with_items=False):
else:
quotation_items = quotation.get("items", {"item_code": item_code})
if not quotation_items:
- quotation.append("items", {
- "doctype": "Quotation Item",
- "item_code": item_code,
- "qty": qty,
- "additional_notes": additional_notes
- })
+ quotation.append(
+ "items",
+ {
+ "doctype": "Quotation Item",
+ "item_code": item_code,
+ "qty": qty,
+ "additional_notes": additional_notes,
+ },
+ )
else:
quotation_items[0].qty = qty
quotation_items[0].additional_notes = additional_notes
@@ -165,73 +181,75 @@ def update_cart(item_code, qty, additional_notes=None, with_items=False):
if cint(with_items):
context = get_cart_quotation(quotation)
return {
- "items": frappe.render_template("templates/includes/cart/cart_items.html",
- context),
- "total": frappe.render_template("templates/includes/cart/cart_items_total.html",
- context),
- "taxes_and_totals": frappe.render_template("templates/includes/cart/cart_payment_summary.html",
- context)
+ "items": frappe.render_template("templates/includes/cart/cart_items.html", context),
+ "total": frappe.render_template("templates/includes/cart/cart_items_total.html", context),
+ "taxes_and_totals": frappe.render_template(
+ "templates/includes/cart/cart_payment_summary.html", context
+ ),
}
else:
- return {
- 'name': quotation.name
- }
+ return {"name": quotation.name}
+
@frappe.whitelist()
def get_shopping_cart_menu(context=None):
if not context:
context = get_cart_quotation()
- return frappe.render_template('templates/includes/cart/cart_dropdown.html', context)
+ return frappe.render_template("templates/includes/cart/cart_dropdown.html", context)
@frappe.whitelist()
def add_new_address(doc):
doc = frappe.parse_json(doc)
- doc.update({
- 'doctype': 'Address'
- })
+ doc.update({"doctype": "Address"})
address = frappe.get_doc(doc)
address.save(ignore_permissions=True)
return address
+
@frappe.whitelist(allow_guest=True)
def create_lead_for_item_inquiry(lead, subject, message):
lead = frappe.parse_json(lead)
- lead_doc = frappe.new_doc('Lead')
+ lead_doc = frappe.new_doc("Lead")
for fieldname in ("lead_name", "company_name", "email_id", "phone"):
lead_doc.set(fieldname, lead.get(fieldname))
- lead_doc.set('lead_owner', '')
+ lead_doc.set("lead_owner", "")
- if not frappe.db.exists('Lead Source', 'Product Inquiry'):
- frappe.get_doc({
- 'doctype': 'Lead Source',
- 'source_name' : 'Product Inquiry'
- }).insert(ignore_permissions=True)
+ if not frappe.db.exists("Lead Source", "Product Inquiry"):
+ frappe.get_doc({"doctype": "Lead Source", "source_name": "Product Inquiry"}).insert(
+ ignore_permissions=True
+ )
- lead_doc.set('source', 'Product Inquiry')
+ lead_doc.set("source", "Product Inquiry")
try:
lead_doc.save(ignore_permissions=True)
except frappe.exceptions.DuplicateEntryError:
frappe.clear_messages()
- lead_doc = frappe.get_doc('Lead', {'email_id': lead['email_id']})
+ lead_doc = frappe.get_doc("Lead", {"email_id": lead["email_id"]})
- lead_doc.add_comment('Comment', text='''
+ lead_doc.add_comment(
+ "Comment",
+ text="""
{subject}
{message}
{% set today = frappe.utils.getdate(frappe.utils.nowdate()) %}
-
+
- """.format(html)
+ """.format(
+ html
+ )
html = ""
col_on += 1
@@ -726,21 +817,31 @@ def render_doc_as_html(doctype, docname, exclude_fields = None):
{0} {1}
- """.format(table_head, table_row)
+ """.format(
+ table_head, table_row
+ )
else:
html += """
{0} {1}
- """.format(table_head, table_row)
+ """.format(
+ table_head, table_row
+ )
continue
# on any other field type add label and value to html
- if not df.hidden and not df.print_hide and doc.get(df.fieldname) and df.fieldname not in exclude_fields:
+ if (
+ not df.hidden
+ and not df.print_hide
+ and doc.get(df.fieldname)
+ and df.fieldname not in exclude_fields
+ ):
formatted_value = format_value(doc.get(df.fieldname), meta.get_field(df.fieldname), doc)
html += "
{0} : {1}".format(df.label or df.fieldname, formatted_value) - if not has_data : has_data = True + if not has_data: + has_data = True if sec_on and col_on and has_data: doc_html += section_html + html + "
"
@@ -751,49 +852,53 @@ def render_doc_as_html(doctype, docname, exclude_fields = None):
{0} {1}
- """.format(section_html, html)
+ """.format(
+ section_html, html
+ )
return {"html": doc_html}
def update_address_links(address, method):
- '''
+ """
Hook validate Address
If Patient is linked in Address, also link the associated Customer
- '''
- if 'Healthcare' not in frappe.get_active_domains():
+ """
+ if "Healthcare" not in frappe.get_active_domains():
return
- patient_links = list(filter(lambda link: link.get('link_doctype') == 'Patient', address.links))
+ patient_links = list(filter(lambda link: link.get("link_doctype") == "Patient", address.links))
for link in patient_links:
- customer = frappe.db.get_value('Patient', link.get('link_name'), 'customer')
- if customer and not address.has_link('Customer', customer):
- address.append('links', dict(link_doctype = 'Customer', link_name = customer))
+ customer = frappe.db.get_value("Patient", link.get("link_name"), "customer")
+ if customer and not address.has_link("Customer", customer):
+ address.append("links", dict(link_doctype="Customer", link_name=customer))
def update_patient_email_and_phone_numbers(contact, method):
- '''
+ """
Hook validate Contact
Update linked Patients' primary mobile and phone numbers
- '''
- if 'Healthcare' not in frappe.get_active_domains() or contact.flags.skip_patient_update:
+ """
+ if "Healthcare" not in frappe.get_active_domains() or contact.flags.skip_patient_update:
return
if contact.is_primary_contact and (contact.email_id or contact.mobile_no or contact.phone):
- patient_links = list(filter(lambda link: link.get('link_doctype') == 'Patient', contact.links))
+ patient_links = list(filter(lambda link: link.get("link_doctype") == "Patient", contact.links))
for link in patient_links:
- contact_details = frappe.db.get_value('Patient', link.get('link_name'), ['email', 'mobile', 'phone'], as_dict=1)
+ contact_details = frappe.db.get_value(
+ "Patient", link.get("link_name"), ["email", "mobile", "phone"], as_dict=1
+ )
new_contact_details = {}
- if contact.email_id and contact.email_id != contact_details.get('email'):
- new_contact_details.update({'email': contact.email_id})
- if contact.mobile_no and contact.mobile_no != contact_details.get('mobile'):
- new_contact_details.update({'mobile': contact.mobile_no})
- if contact.phone and contact.phone != contact_details.get('phone'):
- new_contact_details.update({'phone': contact.phone})
+ if contact.email_id and contact.email_id != contact_details.get("email"):
+ new_contact_details.update({"email": contact.email_id})
+ if contact.mobile_no and contact.mobile_no != contact_details.get("mobile"):
+ new_contact_details.update({"mobile": contact.mobile_no})
+ if contact.phone and contact.phone != contact_details.get("phone"):
+ new_contact_details.update({"phone": contact.phone})
if new_contact_details:
- frappe.db.set_value('Patient', link.get('link_name'), new_contact_details)
+ frappe.db.set_value("Patient", link.get("link_name"), new_contact_details)
diff --git a/erpnext/healthcare/web_form/lab_test/lab_test.py b/erpnext/healthcare/web_form/lab_test/lab_test.py
index 94ffbcfa2f2..1bccbd4f4e7 100644
--- a/erpnext/healthcare/web_form/lab_test/lab_test.py
+++ b/erpnext/healthcare/web_form/lab_test/lab_test.py
@@ -1,22 +1,31 @@
-
import frappe
def get_context(context):
context.read_only = 1
+
def get_list_context(context):
context.row_template = "erpnext/templates/includes/healthcare/lab_test_row_template.html"
context.get_list = get_lab_test_list
-def get_lab_test_list(doctype, txt, filters, limit_start, limit_page_length = 20, order_by='modified desc'):
+
+def get_lab_test_list(
+ doctype, txt, filters, limit_start, limit_page_length=20, order_by="modified desc"
+):
patient = get_patient()
- lab_tests = frappe.db.sql("""select * from `tabLab Test`
- where patient = %s order by result_date""", patient, as_dict = True)
+ lab_tests = frappe.db.sql(
+ """select * from `tabLab Test`
+ where patient = %s order by result_date""",
+ patient,
+ as_dict=True,
+ )
return lab_tests
+
def get_patient():
- return frappe.get_value("Patient",{"email": frappe.session.user}, "name")
+ return frappe.get_value("Patient", {"email": frappe.session.user}, "name")
+
def has_website_permission(doc, ptype, user, verbose=False):
if doc.patient == get_patient():
diff --git a/erpnext/healthcare/web_form/patient_appointments/patient_appointments.py b/erpnext/healthcare/web_form/patient_appointments/patient_appointments.py
index 9f0903cece7..89e8eb168f3 100644
--- a/erpnext/healthcare/web_form/patient_appointments/patient_appointments.py
+++ b/erpnext/healthcare/web_form/patient_appointments/patient_appointments.py
@@ -1,22 +1,31 @@
-
import frappe
def get_context(context):
context.read_only = 1
+
def get_list_context(context):
context.row_template = "erpnext/templates/includes/healthcare/appointment_row_template.html"
context.get_list = get_appointment_list
-def get_appointment_list(doctype, txt, filters, limit_start, limit_page_length = 20, order_by='modified desc'):
+
+def get_appointment_list(
+ doctype, txt, filters, limit_start, limit_page_length=20, order_by="modified desc"
+):
patient = get_patient()
- lab_tests = frappe.db.sql("""select * from `tabPatient Appointment`
- where patient = %s and (status = 'Open' or status = 'Scheduled') order by appointment_date""", patient, as_dict = True)
+ lab_tests = frappe.db.sql(
+ """select * from `tabPatient Appointment`
+ where patient = %s and (status = 'Open' or status = 'Scheduled') order by appointment_date""",
+ patient,
+ as_dict=True,
+ )
return lab_tests
+
def get_patient():
- return frappe.get_value("Patient",{"email": frappe.session.user}, "name")
+ return frappe.get_value("Patient", {"email": frappe.session.user}, "name")
+
def has_website_permission(doc, ptype, user, verbose=False):
if doc.patient == get_patient():
diff --git a/erpnext/healthcare/web_form/patient_registration/patient_registration.py b/erpnext/healthcare/web_form/patient_registration/patient_registration.py
index 19b550feea7..02e3e933330 100644
--- a/erpnext/healthcare/web_form/patient_registration/patient_registration.py
+++ b/erpnext/healthcare/web_form/patient_registration/patient_registration.py
@@ -1,5 +1,3 @@
-
-
def get_context(context):
# do your magic here
pass
diff --git a/erpnext/healthcare/web_form/personal_details/personal_details.py b/erpnext/healthcare/web_form/personal_details/personal_details.py
index fc8e8c0a5b7..dfbd73eeec1 100644
--- a/erpnext/healthcare/web_form/personal_details/personal_details.py
+++ b/erpnext/healthcare/web_form/personal_details/personal_details.py
@@ -1,23 +1,25 @@
-
import frappe
from frappe import _
no_cache = 1
+
def get_context(context):
- if frappe.session.user=='Guest':
+ if frappe.session.user == "Guest":
frappe.throw(_("You need to be logged in to access this page"), frappe.PermissionError)
- context.show_sidebar=True
+ context.show_sidebar = True
- if frappe.db.exists("Patient", {'email': frappe.session.user}):
- patient = frappe.get_doc("Patient", {'email': frappe.session.user})
+ if frappe.db.exists("Patient", {"email": frappe.session.user}):
+ patient = frappe.get_doc("Patient", {"email": frappe.session.user})
context.doc = patient
frappe.form_dict.new = 0
frappe.form_dict.name = patient.name
+
def get_patient():
- return frappe.get_value("Patient",{"email": frappe.session.user}, "name")
+ return frappe.get_value("Patient", {"email": frappe.session.user}, "name")
+
def has_website_permission(doc, ptype, user, verbose=False):
if doc.name == get_patient():
diff --git a/erpnext/healthcare/web_form/prescription/prescription.py b/erpnext/healthcare/web_form/prescription/prescription.py
index 0e1bc3d5dd6..44caeb00b59 100644
--- a/erpnext/healthcare/web_form/prescription/prescription.py
+++ b/erpnext/healthcare/web_form/prescription/prescription.py
@@ -1,22 +1,31 @@
-
import frappe
def get_context(context):
context.read_only = 1
+
def get_list_context(context):
context.row_template = "erpnext/templates/includes/healthcare/prescription_row_template.html"
context.get_list = get_encounter_list
-def get_encounter_list(doctype, txt, filters, limit_start, limit_page_length = 20, order_by='modified desc'):
+
+def get_encounter_list(
+ doctype, txt, filters, limit_start, limit_page_length=20, order_by="modified desc"
+):
patient = get_patient()
- encounters = frappe.db.sql("""select * from `tabPatient Encounter`
- where patient = %s order by creation desc""", patient, as_dict = True)
+ encounters = frappe.db.sql(
+ """select * from `tabPatient Encounter`
+ where patient = %s order by creation desc""",
+ patient,
+ as_dict=True,
+ )
return encounters
+
def get_patient():
- return frappe.get_value("Patient",{"email": frappe.session.user}, "name")
+ return frappe.get_value("Patient", {"email": frappe.session.user}, "name")
+
def has_website_permission(doc, ptype, user, verbose=False):
if doc.patient == get_patient():
diff --git a/erpnext/hooks.py b/erpnext/hooks.py
index 6d57c83e6a5..2f009fd494f 100644
--- a/erpnext/hooks.py
+++ b/erpnext/hooks.py
@@ -1,4 +1,3 @@
-
from frappe import _
app_name = "erpnext"
@@ -13,7 +12,7 @@ source_link = "https://github.com/frappe/erpnext"
app_logo_url = "/assets/erpnext/images/erpnext-logo.svg"
-develop_version = '13.x.x-develop'
+develop_version = "13.x.x-develop"
app_include_js = "/assets/js/erpnext.min.js"
app_include_css = "/assets/css/erpnext.css"
@@ -25,12 +24,10 @@ doctype_js = {
"Communication": "public/js/communication.js",
"Event": "public/js/event.js",
"Newsletter": "public/js/newsletter.js",
- "Contact": "public/js/contact.js"
+ "Contact": "public/js/contact.js",
}
-override_doctype_class = {
- 'Address': 'erpnext.accounts.custom.address.ERPNextAddress'
-}
+override_doctype_class = {"Address": "erpnext.accounts.custom.address.ERPNextAddress"}
welcome_email = "erpnext.setup.utils.welcome_email"
@@ -51,146 +48,266 @@ additional_print_settings = "erpnext.controllers.print_settings.get_print_settin
on_session_creation = [
"erpnext.portal.utils.create_customer_or_supplier",
- "erpnext.e_commerce.shopping_cart.utils.set_cart_count"
+ "erpnext.e_commerce.shopping_cart.utils.set_cart_count",
]
on_logout = "erpnext.e_commerce.shopping_cart.utils.clear_cart_count"
-treeviews = ['Account', 'Cost Center', 'Warehouse', 'Item Group', 'Customer Group', 'Sales Person', 'Territory', 'Assessment Group', 'Department']
+treeviews = [
+ "Account",
+ "Cost Center",
+ "Warehouse",
+ "Item Group",
+ "Customer Group",
+ "Sales Person",
+ "Territory",
+ "Assessment Group",
+ "Department",
+]
# website
-update_website_context = ["erpnext.e_commerce.shopping_cart.utils.update_website_context", "erpnext.education.doctype.education_settings.education_settings.update_website_context"]
+update_website_context = [
+ "erpnext.e_commerce.shopping_cart.utils.update_website_context",
+ "erpnext.education.doctype.education_settings.education_settings.update_website_context",
+]
my_account_context = "erpnext.e_commerce.shopping_cart.utils.update_my_account_context"
webform_list_context = "erpnext.controllers.website_list_for_contact.get_webform_list_context"
-calendars = ["Task", "Work Order", "Leave Application", "Sales Order", "Holiday List", "Course Schedule"]
+calendars = [
+ "Task",
+ "Work Order",
+ "Leave Application",
+ "Sales Order",
+ "Holiday List",
+ "Course Schedule",
+]
domains = {
- 'Agriculture': 'erpnext.domains.agriculture',
- 'Distribution': 'erpnext.domains.distribution',
- 'Education': 'erpnext.domains.education',
- 'Healthcare': 'erpnext.domains.healthcare',
- 'Hospitality': 'erpnext.domains.hospitality',
- 'Manufacturing': 'erpnext.domains.manufacturing',
- 'Non Profit': 'erpnext.domains.non_profit',
- 'Retail': 'erpnext.domains.retail',
- 'Services': 'erpnext.domains.services',
+ "Agriculture": "erpnext.domains.agriculture",
+ "Distribution": "erpnext.domains.distribution",
+ "Education": "erpnext.domains.education",
+ "Healthcare": "erpnext.domains.healthcare",
+ "Hospitality": "erpnext.domains.hospitality",
+ "Manufacturing": "erpnext.domains.manufacturing",
+ "Non Profit": "erpnext.domains.non_profit",
+ "Retail": "erpnext.domains.retail",
+ "Services": "erpnext.domains.services",
}
-website_generators = ["Item Group", "Website Item", "BOM", "Sales Partner",
- "Job Opening", "Student Admission"]
+website_generators = [
+ "Item Group",
+ "Website Item",
+ "BOM",
+ "Sales Partner",
+ "Job Opening",
+ "Student Admission",
+]
website_context = {
- "favicon": "/assets/erpnext/images/erpnext-favicon.svg",
- "splash_image": "/assets/erpnext/images/erpnext-logo.svg"
+ "favicon": "/assets/erpnext/images/erpnext-favicon.svg",
+ "splash_image": "/assets/erpnext/images/erpnext-logo.svg",
}
website_route_rules = [
{"from_route": "/orders", "to_route": "Sales Order"},
- {"from_route": "/orders/
0:
- frappe.throw(_("Not eligible for the admission in this program as per Date Of Birth"))
+ if (
+ student_admission
+ and student_admission.min_age
+ and date_diff(nowdate(), add_years(getdate(self.date_of_birth), student_admission.min_age)) < 0
+ ):
+ frappe.throw(_("Not eligible for the admission in this program as per Date Of Birth"))
+ if (
+ student_admission
+ and student_admission.max_age
+ and date_diff(nowdate(), add_years(getdate(self.date_of_birth), student_admission.max_age)) > 0
+ ):
+ frappe.throw(_("Not eligible for the admission in this program as per Date Of Birth"))
def on_payment_authorized(self, *args, **kwargs):
- self.db_set('paid', 1)
+ self.db_set("paid", 1)
def get_student_admission_data(student_admission, program):
- student_admission = frappe.db.sql("""select sa.admission_start_date, sa.admission_end_date,
+ student_admission = frappe.db.sql(
+ """select sa.admission_start_date, sa.admission_end_date,
sap.program, sap.min_age, sap.max_age, sap.applicant_naming_series
from `tabStudent Admission` sa, `tabStudent Admission Program` sap
- where sa.name = sap.parent and sa.name = %s and sap.program = %s""", (student_admission, program), as_dict=1)
+ where sa.name = sap.parent and sa.name = %s and sap.program = %s""",
+ (student_admission, program),
+ as_dict=1,
+ )
if student_admission:
return student_admission[0]
diff --git a/erpnext/education/doctype/student_applicant/test_student_applicant.py b/erpnext/education/doctype/student_applicant/test_student_applicant.py
index ba2e9c18863..bd0e360db7e 100644
--- a/erpnext/education/doctype/student_applicant/test_student_applicant.py
+++ b/erpnext/education/doctype/student_applicant/test_student_applicant.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Student Applicant')
+
class TestStudentApplicant(unittest.TestCase):
pass
diff --git a/erpnext/education/doctype/student_attendance/student_attendance.py b/erpnext/education/doctype/student_attendance/student_attendance.py
index db0fd3719da..20f8fb7d77a 100644
--- a/erpnext/education/doctype/student_attendance/student_attendance.py
+++ b/erpnext/education/doctype/student_attendance/student_attendance.py
@@ -24,76 +24,109 @@ class StudentAttendance(Document):
def set_date(self):
if self.course_schedule:
- self.date = frappe.db.get_value('Course Schedule', self.course_schedule, 'schedule_date')
+ self.date = frappe.db.get_value("Course Schedule", self.course_schedule, "schedule_date")
def validate_mandatory(self):
if not (self.student_group or self.course_schedule):
- frappe.throw(_('{0} or {1} is mandatory').format(frappe.bold('Student Group'),
- frappe.bold('Course Schedule')), title=_('Mandatory Fields'))
+ frappe.throw(
+ _("{0} or {1} is mandatory").format(
+ frappe.bold("Student Group"), frappe.bold("Course Schedule")
+ ),
+ title=_("Mandatory Fields"),
+ )
def validate_date(self):
if not self.leave_application and getdate(self.date) > getdate():
- frappe.throw(_('Attendance cannot be marked for future dates.'))
+ frappe.throw(_("Attendance cannot be marked for future dates."))
if self.student_group:
- academic_year = frappe.db.get_value('Student Group', self.student_group, 'academic_year')
+ academic_year = frappe.db.get_value("Student Group", self.student_group, "academic_year")
if academic_year:
- year_start_date, year_end_date = frappe.db.get_value('Academic Year', academic_year, ['year_start_date', 'year_end_date'])
+ year_start_date, year_end_date = frappe.db.get_value(
+ "Academic Year", academic_year, ["year_start_date", "year_end_date"]
+ )
if year_start_date and year_end_date:
- if getdate(self.date) < getdate(year_start_date) or getdate(self.date) > getdate(year_end_date):
- frappe.throw(_('Attendance cannot be marked outside of Academic Year {0}').format(academic_year))
+ if getdate(self.date) < getdate(year_start_date) or getdate(self.date) > getdate(
+ year_end_date
+ ):
+ frappe.throw(
+ _("Attendance cannot be marked outside of Academic Year {0}").format(academic_year)
+ )
def set_student_group(self):
if self.course_schedule:
- self.student_group = frappe.db.get_value('Course Schedule', self.course_schedule, 'student_group')
+ self.student_group = frappe.db.get_value(
+ "Course Schedule", self.course_schedule, "student_group"
+ )
def validate_student(self):
if self.course_schedule:
- student_group = frappe.db.get_value('Course Schedule', self.course_schedule, 'student_group')
+ student_group = frappe.db.get_value("Course Schedule", self.course_schedule, "student_group")
else:
student_group = self.student_group
student_group_students = [d.student for d in get_student_group_students(student_group)]
if student_group and self.student not in student_group_students:
- student_group_doc = get_link_to_form('Student Group', student_group)
- frappe.throw(_('Student {0}: {1} does not belong to Student Group {2}').format(
- frappe.bold(self.student), self.student_name, frappe.bold(student_group_doc)))
+ student_group_doc = get_link_to_form("Student Group", student_group)
+ frappe.throw(
+ _("Student {0}: {1} does not belong to Student Group {2}").format(
+ frappe.bold(self.student), self.student_name, frappe.bold(student_group_doc)
+ )
+ )
def validate_duplication(self):
"""Check if the Attendance Record is Unique"""
attendance_record = None
if self.course_schedule:
- attendance_record = frappe.db.exists('Student Attendance', {
- 'student': self.student,
- 'course_schedule': self.course_schedule,
- 'docstatus': ('!=', 2),
- 'name': ('!=', self.name)
- })
+ attendance_record = frappe.db.exists(
+ "Student Attendance",
+ {
+ "student": self.student,
+ "course_schedule": self.course_schedule,
+ "docstatus": ("!=", 2),
+ "name": ("!=", self.name),
+ },
+ )
else:
- attendance_record = frappe.db.exists('Student Attendance', {
- 'student': self.student,
- 'student_group': self.student_group,
- 'date': self.date,
- 'docstatus': ('!=', 2),
- 'name': ('!=', self.name),
- 'course_schedule': ''
- })
+ attendance_record = frappe.db.exists(
+ "Student Attendance",
+ {
+ "student": self.student,
+ "student_group": self.student_group,
+ "date": self.date,
+ "docstatus": ("!=", 2),
+ "name": ("!=", self.name),
+ "course_schedule": "",
+ },
+ )
if attendance_record:
- record = get_link_to_form('Student Attendance', attendance_record)
- frappe.throw(_('Student Attendance record {0} already exists against the Student {1}')
- .format(record, frappe.bold(self.student)), title=_('Duplicate Entry'))
+ record = get_link_to_form("Student Attendance", attendance_record)
+ frappe.throw(
+ _("Student Attendance record {0} already exists against the Student {1}").format(
+ record, frappe.bold(self.student)
+ ),
+ title=_("Duplicate Entry"),
+ )
def validate_is_holiday(self):
holiday_list = get_holiday_list()
if is_holiday(holiday_list, self.date):
- frappe.throw(_('Attendance cannot be marked for {0} as it is a holiday.').format(
- frappe.bold(formatdate(self.date))))
+ frappe.throw(
+ _("Attendance cannot be marked for {0} as it is a holiday.").format(
+ frappe.bold(formatdate(self.date))
+ )
+ )
+
def get_holiday_list(company=None):
if not company:
- company = get_default_company() or frappe.get_all('Company')[0].name
+ company = get_default_company() or frappe.get_all("Company")[0].name
- holiday_list = frappe.get_cached_value('Company', company, 'default_holiday_list')
+ holiday_list = frappe.get_cached_value("Company", company, "default_holiday_list")
if not holiday_list:
- frappe.throw(_('Please set a default Holiday List for Company {0}').format(frappe.bold(get_default_company())))
+ frappe.throw(
+ _("Please set a default Holiday List for Company {0}").format(
+ frappe.bold(get_default_company())
+ )
+ )
return holiday_list
diff --git a/erpnext/education/doctype/student_attendance/student_attendance_dashboard.py b/erpnext/education/doctype/student_attendance/student_attendance_dashboard.py
index 97547992043..34132af69e6 100644
--- a/erpnext/education/doctype/student_attendance/student_attendance_dashboard.py
+++ b/erpnext/education/doctype/student_attendance/student_attendance_dashboard.py
@@ -1,13 +1,12 @@
-
from frappe import _
def get_data():
return {
- 'reports': [
+ "reports": [
{
- 'label': _('Reports'),
- 'items': ['Student Monthly Attendance Sheet', 'Student Batch-Wise Attendance']
+ "label": _("Reports"),
+ "items": ["Student Monthly Attendance Sheet", "Student Batch-Wise Attendance"],
}
]
}
diff --git a/erpnext/education/doctype/student_attendance/test_student_attendance.py b/erpnext/education/doctype/student_attendance/test_student_attendance.py
index 6a43e30a33c..e5b1841e1db 100644
--- a/erpnext/education/doctype/student_attendance/test_student_attendance.py
+++ b/erpnext/education/doctype/student_attendance/test_student_attendance.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Student Attendance')
+
class TestStudentAttendance(unittest.TestCase):
pass
diff --git a/erpnext/education/doctype/student_attendance_tool/student_attendance_tool.py b/erpnext/education/doctype/student_attendance_tool/student_attendance_tool.py
index 7deb6b18da5..92fc25e54e7 100644
--- a/erpnext/education/doctype/student_attendance_tool/student_attendance_tool.py
+++ b/erpnext/education/doctype/student_attendance_tool/student_attendance_tool.py
@@ -9,6 +9,7 @@ from frappe.model.document import Document
class StudentAttendanceTool(Document):
pass
+
@frappe.whitelist()
def get_student_attendance_records(based_on, date=None, student_group=None, course_schedule=None):
student_list = []
@@ -17,33 +18,38 @@ def get_student_attendance_records(based_on, date=None, student_group=None, cour
if based_on == "Course Schedule":
student_group = frappe.db.get_value("Course Schedule", course_schedule, "student_group")
if student_group:
- student_list = frappe.get_all("Student Group Student", fields=["student", "student_name", "group_roll_number"],
- filters={"parent": student_group, "active": 1}, order_by= "group_roll_number")
+ student_list = frappe.get_all(
+ "Student Group Student",
+ fields=["student", "student_name", "group_roll_number"],
+ filters={"parent": student_group, "active": 1},
+ order_by="group_roll_number",
+ )
if not student_list:
- student_list = frappe.get_all("Student Group Student", fields=["student", "student_name", "group_roll_number"],
- filters={"parent": student_group, "active": 1}, order_by= "group_roll_number")
+ student_list = frappe.get_all(
+ "Student Group Student",
+ fields=["student", "student_name", "group_roll_number"],
+ filters={"parent": student_group, "active": 1},
+ order_by="group_roll_number",
+ )
table = frappe.qb.DocType("Student Attendance")
if course_schedule:
student_attendance_list = (
frappe.qb.from_(table)
- .select(table.student, table.status)
- .where(
- (table.course_schedule == course_schedule)
- )
- ).run(as_dict=True)
+ .select(table.student, table.status)
+ .where((table.course_schedule == course_schedule))
+ ).run(as_dict=True)
else:
student_attendance_list = (
frappe.qb.from_(table)
- .select(table.student, table.status)
- .where(
- (table.student_group == student_group)
- & (table.date == date)
- & (table.course_schedule == "") | (table.course_schedule.isnull())
- )
- ).run(as_dict=True)
+ .select(table.student, table.status)
+ .where(
+ (table.student_group == student_group) & (table.date == date) & (table.course_schedule == "")
+ | (table.course_schedule.isnull())
+ )
+ ).run(as_dict=True)
for attendance in student_attendance_list:
for student in student_list:
diff --git a/erpnext/education/doctype/student_batch_name/test_student_batch_name.py b/erpnext/education/doctype/student_batch_name/test_student_batch_name.py
index ad9b545e744..bf9639bf627 100644
--- a/erpnext/education/doctype/student_batch_name/test_student_batch_name.py
+++ b/erpnext/education/doctype/student_batch_name/test_student_batch_name.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Student Batch Name')
+
class TestStudentBatchName(unittest.TestCase):
pass
diff --git a/erpnext/education/doctype/student_category/student_category_dashboard.py b/erpnext/education/doctype/student_category/student_category_dashboard.py
index be1e0054915..d7a332c4d2a 100644
--- a/erpnext/education/doctype/student_category/student_category_dashboard.py
+++ b/erpnext/education/doctype/student_category/student_category_dashboard.py
@@ -1,14 +1,8 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'student_category',
- 'transactions': [
- {
- 'label': _('Fee'),
- 'items': ['Fee Structure', 'Fee Schedule', 'Fees']
- }
- ]
+ "fieldname": "student_category",
+ "transactions": [{"label": _("Fee"), "items": ["Fee Structure", "Fee Schedule", "Fees"]}],
}
diff --git a/erpnext/education/doctype/student_category/test_student_category.py b/erpnext/education/doctype/student_category/test_student_category.py
index 76469fff250..5671e9fa447 100644
--- a/erpnext/education/doctype/student_category/test_student_category.py
+++ b/erpnext/education/doctype/student_category/test_student_category.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Student Category')
+
class TestStudentCategory(unittest.TestCase):
pass
diff --git a/erpnext/education/doctype/student_group/student_group.py b/erpnext/education/doctype/student_group/student_group.py
index ceae036e3ed..a94489ba53b 100644
--- a/erpnext/education/doctype/student_group/student_group.py
+++ b/erpnext/education/doctype/student_group/student_group.py
@@ -30,22 +30,45 @@ class StudentGroup(Document):
if cint(self.max_strength) < 0:
frappe.throw(_("""Max strength cannot be less than zero."""))
if self.max_strength and len(self.students) > self.max_strength:
- frappe.throw(_("""Cannot enroll more than {0} students for this student group.""").format(self.max_strength))
+ frappe.throw(
+ _("""Cannot enroll more than {0} students for this student group.""").format(self.max_strength)
+ )
def validate_students(self):
- program_enrollment = get_program_enrollment(self.academic_year, self.academic_term, self.program, self.batch, self.student_category, self.course)
+ program_enrollment = get_program_enrollment(
+ self.academic_year,
+ self.academic_term,
+ self.program,
+ self.batch,
+ self.student_category,
+ self.course,
+ )
students = [d.student for d in program_enrollment] if program_enrollment else []
for d in self.students:
if not frappe.db.get_value("Student", d.student, "enabled") and d.active and not self.disabled:
frappe.throw(_("{0} - {1} is inactive student").format(d.group_roll_number, d.student_name))
- if (self.group_based_on == "Batch") and cint(frappe.defaults.get_defaults().validate_batch)\
- and d.student not in students:
- frappe.throw(_("{0} - {1} is not enrolled in the Batch {2}").format(d.group_roll_number, d.student_name, self.batch))
+ if (
+ (self.group_based_on == "Batch")
+ and cint(frappe.defaults.get_defaults().validate_batch)
+ and d.student not in students
+ ):
+ frappe.throw(
+ _("{0} - {1} is not enrolled in the Batch {2}").format(
+ d.group_roll_number, d.student_name, self.batch
+ )
+ )
- if (self.group_based_on == "Course") and cint(frappe.defaults.get_defaults().validate_course)\
- and (d.student not in students):
- frappe.throw(_("{0} - {1} is not enrolled in the Course {2}").format(d.group_roll_number, d.student_name, self.course))
+ if (
+ (self.group_based_on == "Course")
+ and cint(frappe.defaults.get_defaults().validate_course)
+ and (d.student not in students)
+ ):
+ frappe.throw(
+ _("{0} - {1} is not enrolled in the Course {2}").format(
+ d.group_roll_number, d.student_name, self.course
+ )
+ )
def validate_and_set_child_table_fields(self):
roll_numbers = [d.group_roll_number for d in self.students if d.group_roll_number]
@@ -62,9 +85,20 @@ class StudentGroup(Document):
else:
roll_no_list.append(d.group_roll_number)
+
@frappe.whitelist()
-def get_students(academic_year, group_based_on, academic_term=None, program=None, batch=None, student_category=None, course=None):
- enrolled_students = get_program_enrollment(academic_year, academic_term, program, batch, student_category, course)
+def get_students(
+ academic_year,
+ group_based_on,
+ academic_term=None,
+ program=None,
+ batch=None,
+ student_category=None,
+ course=None,
+):
+ enrolled_students = get_program_enrollment(
+ academic_year, academic_term, program, batch, student_category, course
+ )
if enrolled_students:
student_list = []
@@ -79,7 +113,10 @@ def get_students(academic_year, group_based_on, academic_term=None, program=None
frappe.msgprint(_("No students found"))
return []
-def get_program_enrollment(academic_year, academic_term=None, program=None, batch=None, student_category=None, course=None):
+
+def get_program_enrollment(
+ academic_year, academic_term=None, program=None, batch=None, student_category=None, course=None
+):
condition1 = " "
condition2 = " "
@@ -95,7 +132,8 @@ def get_program_enrollment(academic_year, academic_term=None, program=None, batc
condition1 += " and pe.name = pec.parent and pec.course = %(course)s"
condition2 = ", `tabProgram Enrollment Course` pec"
- return frappe.db.sql('''
+ return frappe.db.sql(
+ """
select
pe.student, pe.student_name
from
@@ -104,28 +142,59 @@ def get_program_enrollment(academic_year, academic_term=None, program=None, batc
pe.academic_year = %(academic_year)s {condition1}
order by
pe.student_name asc
- '''.format(condition1=condition1, condition2=condition2),
- ({"academic_year": academic_year, "academic_term":academic_term, "program": program, "batch": batch, "student_category": student_category, "course": course}), as_dict=1)
+ """.format(
+ condition1=condition1, condition2=condition2
+ ),
+ (
+ {
+ "academic_year": academic_year,
+ "academic_term": academic_term,
+ "program": program,
+ "batch": batch,
+ "student_category": student_category,
+ "course": course,
+ }
+ ),
+ as_dict=1,
+ )
@frappe.whitelist()
@frappe.validate_and_sanitize_search_inputs
def fetch_students(doctype, txt, searchfield, start, page_len, filters):
if filters.get("group_based_on") != "Activity":
- enrolled_students = get_program_enrollment(filters.get('academic_year'), filters.get('academic_term'),
- filters.get('program'), filters.get('batch'), filters.get('student_category'))
- student_group_student = frappe.db.sql_list('''select student from `tabStudent Group Student` where parent=%s''',
- (filters.get('student_group')))
- students = ([d.student for d in enrolled_students if d.student not in student_group_student]
- if enrolled_students else [""]) or [""]
- return frappe.db.sql("""select name, title from tabStudent
+ enrolled_students = get_program_enrollment(
+ filters.get("academic_year"),
+ filters.get("academic_term"),
+ filters.get("program"),
+ filters.get("batch"),
+ filters.get("student_category"),
+ )
+ student_group_student = frappe.db.sql_list(
+ """select student from `tabStudent Group Student` where parent=%s""",
+ (filters.get("student_group")),
+ )
+ students = (
+ [d.student for d in enrolled_students if d.student not in student_group_student]
+ if enrolled_students
+ else [""]
+ ) or [""]
+ return frappe.db.sql(
+ """select name, title from tabStudent
where name in ({0}) and (`{1}` LIKE %s or title LIKE %s)
order by idx desc, name
- limit %s, %s""".format(", ".join(['%s']*len(students)), searchfield),
- tuple(students + ["%%%s%%" % txt, "%%%s%%" % txt, start, page_len]))
+ limit %s, %s""".format(
+ ", ".join(["%s"] * len(students)), searchfield
+ ),
+ tuple(students + ["%%%s%%" % txt, "%%%s%%" % txt, start, page_len]),
+ )
else:
- return frappe.db.sql("""select name, title from tabStudent
+ return frappe.db.sql(
+ """select name, title from tabStudent
where `{0}` LIKE %s or title LIKE %s
order by idx desc, name
- limit %s, %s""".format(searchfield),
- tuple(["%%%s%%" % txt, "%%%s%%" % txt, start, page_len]))
+ limit %s, %s""".format(
+ searchfield
+ ),
+ tuple(["%%%s%%" % txt, "%%%s%%" % txt, start, page_len]),
+ )
diff --git a/erpnext/education/doctype/student_group/student_group_dashboard.py b/erpnext/education/doctype/student_group/student_group_dashboard.py
index d5b930237f4..094b5a02351 100644
--- a/erpnext/education/doctype/student_group/student_group_dashboard.py
+++ b/erpnext/education/doctype/student_group/student_group_dashboard.py
@@ -6,15 +6,9 @@ from frappe import _
def get_data():
return {
- 'fieldname': 'student_group',
- 'transactions': [
- {
- 'label': _('Assessment'),
- 'items': ['Assessment Plan', 'Assessment Result']
- },
- {
- 'label': _('Course'),
- 'items': ['Course Schedule']
- }
- ]
+ "fieldname": "student_group",
+ "transactions": [
+ {"label": _("Assessment"), "items": ["Assessment Plan", "Assessment Result"]},
+ {"label": _("Course"), "items": ["Course Schedule"]},
+ ],
}
diff --git a/erpnext/education/doctype/student_group/test_student_group.py b/erpnext/education/doctype/student_group/test_student_group.py
index 807c63280f2..84b49309acb 100644
--- a/erpnext/education/doctype/student_group/test_student_group.py
+++ b/erpnext/education/doctype/student_group/test_student_group.py
@@ -9,19 +9,22 @@ import erpnext.education
def get_random_group():
- doc = frappe.get_doc({
- "doctype": "Student Group",
- "student_group_name": "_Test Student Group-" + frappe.generate_hash(length=5),
- "group_based_on": "Activity"
- }).insert()
+ doc = frappe.get_doc(
+ {
+ "doctype": "Student Group",
+ "student_group_name": "_Test Student Group-" + frappe.generate_hash(length=5),
+ "group_based_on": "Activity",
+ }
+ ).insert()
- student_list = frappe.get_all('Student', limit=5)
+ student_list = frappe.get_all("Student", limit=5)
- doc.extend("students", [{"student":d.name, "active": 1} for d in student_list])
+ doc.extend("students", [{"student": d.name, "active": 1} for d in student_list])
doc.save()
return doc
+
class TestStudentGroup(unittest.TestCase):
def test_student_roll_no(self):
doc = get_random_group()
@@ -36,8 +39,12 @@ class TestStudentGroup(unittest.TestCase):
doc.students = doc.students[:-1]
doc.save()
- self.assertRaises(erpnext.education.StudentNotInGroupError,
- erpnext.education.validate_student_belongs_to_group, last_student, doc.name)
+ self.assertRaises(
+ erpnext.education.StudentNotInGroupError,
+ erpnext.education.validate_student_belongs_to_group,
+ last_student,
+ doc.name,
+ )
# safe, don't throw validation
erpnext.education.validate_student_belongs_to_group(doc.students[0].student, doc.name)
diff --git a/erpnext/education/doctype/student_group_creation_tool/student_group_creation_tool.py b/erpnext/education/doctype/student_group_creation_tool/student_group_creation_tool.py
index 8fbfcec3b57..0fb255077f1 100644
--- a/erpnext/education/doctype/student_group_creation_tool/student_group_creation_tool.py
+++ b/erpnext/education/doctype/student_group_creation_tool/student_group_creation_tool.py
@@ -14,32 +14,49 @@ class StudentGroupCreationTool(Document):
def get_courses(self):
group_list = []
- batches = frappe.db.sql('''select name as batch from `tabStudent Batch Name`''', as_dict=1)
+ batches = frappe.db.sql("""select name as batch from `tabStudent Batch Name`""", as_dict=1)
for batch in batches:
- group_list.append({"group_based_on":"Batch", "batch":batch.batch})
+ group_list.append({"group_based_on": "Batch", "batch": batch.batch})
- courses = frappe.db.sql('''select course, course_name from `tabProgram Course` where parent=%s''',
- (self.program), as_dict=1)
+ courses = frappe.db.sql(
+ """select course, course_name from `tabProgram Course` where parent=%s""",
+ (self.program),
+ as_dict=1,
+ )
if self.separate_groups:
from itertools import product
- course_list = product(courses,batches)
+
+ course_list = product(courses, batches)
for course in course_list:
temp_dict = {}
- temp_dict.update({"group_based_on":"Course"})
+ temp_dict.update({"group_based_on": "Course"})
temp_dict.update(course[0])
temp_dict.update(course[1])
group_list.append(temp_dict)
else:
for course in courses:
- course.update({"group_based_on":"Course"})
+ course.update({"group_based_on": "Course"})
group_list.append(course)
for group in group_list:
if group.get("group_based_on") == "Batch":
- student_group_name = self.program + "/" + group.get("batch") + "/" + (self.academic_term if self.academic_term else self.academic_year)
+ student_group_name = (
+ self.program
+ + "/"
+ + group.get("batch")
+ + "/"
+ + (self.academic_term if self.academic_term else self.academic_year)
+ )
group.update({"student_group_name": student_group_name})
elif group.get("group_based_on") == "Course":
- student_group_name = group.get("course") + "/" + self.program + ("/" + group.get("batch") if group.get("batch") else "") + "/" + (self.academic_term if self.academic_term else self.academic_year)
+ student_group_name = (
+ group.get("course")
+ + "/"
+ + self.program
+ + ("/" + group.get("batch") if group.get("batch") else "")
+ + "/"
+ + (self.academic_term if self.academic_term else self.academic_year)
+ )
group.update({"student_group_name": student_group_name})
return group_list
@@ -60,7 +77,9 @@ class StudentGroupCreationTool(Document):
if d.group_based_on == "Batch" and not d.batch:
frappe.throw(_("""Batch is mandatory in row {0}""".format(d.idx)))
- frappe.publish_realtime('student_group_creation_progress', {"progress": [d.idx, l]}, user=frappe.session.user)
+ frappe.publish_realtime(
+ "student_group_creation_progress", {"progress": [d.idx, l]}, user=frappe.session.user
+ )
student_group = frappe.new_doc("Student Group")
student_group.student_group_name = d.student_group_name
@@ -71,10 +90,12 @@ class StudentGroupCreationTool(Document):
student_group.max_strength = d.max_strength
student_group.academic_term = self.academic_term
student_group.academic_year = self.academic_year
- student_list = get_students(self.academic_year, d.group_based_on, self.academic_term, self.program, d.batch, d.course)
+ student_list = get_students(
+ self.academic_year, d.group_based_on, self.academic_term, self.program, d.batch, d.course
+ )
for student in student_list:
- student_group.append('students', student)
+ student_group.append("students", student)
student_group.save()
frappe.msgprint(_("{0} Student Groups created.").format(l))
diff --git a/erpnext/education/doctype/student_language/test_student_language.py b/erpnext/education/doctype/student_language/test_student_language.py
index 718896c6c51..d1a8b6d5266 100644
--- a/erpnext/education/doctype/student_language/test_student_language.py
+++ b/erpnext/education/doctype/student_language/test_student_language.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Student Language')
+
class TestStudentLanguage(unittest.TestCase):
pass
diff --git a/erpnext/education/doctype/student_leave_application/student_leave_application.py b/erpnext/education/doctype/student_leave_application/student_leave_application.py
index b1eda9a3c10..c3645cf4852 100644
--- a/erpnext/education/doctype/student_leave_application/student_leave_application.py
+++ b/erpnext/education/doctype/student_leave_application/student_leave_application.py
@@ -17,7 +17,7 @@ class StudentLeaveApplication(Document):
def validate(self):
self.validate_holiday_list()
self.validate_duplicate()
- self.validate_from_to_dates('from_date', 'to_date')
+ self.validate_from_to_dates("from_date", "to_date")
def on_submit(self):
self.update_attendance()
@@ -26,23 +26,31 @@ class StudentLeaveApplication(Document):
self.cancel_attendance()
def validate_duplicate(self):
- data = frappe.db.sql("""select name from `tabStudent Leave Application`
+ data = frappe.db.sql(
+ """select name from `tabStudent Leave Application`
where
((%(from_date)s > from_date and %(from_date)s < to_date) or
(%(to_date)s > from_date and %(to_date)s < to_date) or
(%(from_date)s <= from_date and %(to_date)s >= to_date)) and
name != %(name)s and student = %(student)s and docstatus < 2
- """, {
- 'from_date': self.from_date,
- 'to_date': self.to_date,
- 'student': self.student,
- 'name': self.name
- }, as_dict=1)
+ """,
+ {
+ "from_date": self.from_date,
+ "to_date": self.to_date,
+ "student": self.student,
+ "name": self.name,
+ },
+ as_dict=1,
+ )
if data:
- link = get_link_to_form('Student Leave Application', data[0].name)
- frappe.throw(_('Leave application {0} already exists against the student {1}')
- .format(link, frappe.bold(self.student)), title=_('Duplicate Entry'))
+ link = get_link_to_form("Student Leave Application", data[0].name)
+ frappe.throw(
+ _("Leave application {0} already exists against the student {1}").format(
+ link, frappe.bold(self.student)
+ ),
+ title=_("Duplicate Entry"),
+ )
def validate_holiday_list(self):
holiday_list = get_holiday_list()
@@ -52,33 +60,31 @@ class StudentLeaveApplication(Document):
holiday_list = get_holiday_list()
for dt in daterange(getdate(self.from_date), getdate(self.to_date)):
- date = dt.strftime('%Y-%m-%d')
+ date = dt.strftime("%Y-%m-%d")
if is_holiday(holiday_list, date):
continue
- attendance = frappe.db.exists('Student Attendance', {
- 'student': self.student,
- 'date': date,
- 'docstatus': ('!=', 2)
- })
+ attendance = frappe.db.exists(
+ "Student Attendance", {"student": self.student, "date": date, "docstatus": ("!=", 2)}
+ )
- status = 'Present' if self.mark_as_present else 'Absent'
+ status = "Present" if self.mark_as_present else "Absent"
if attendance:
# update existing attendance record
values = dict()
- values['status'] = status
- values['leave_application'] = self.name
- frappe.db.set_value('Student Attendance', attendance, values)
+ values["status"] = status
+ values["leave_application"] = self.name
+ frappe.db.set_value("Student Attendance", attendance, values)
else:
# make a new attendance record
- doc = frappe.new_doc('Student Attendance')
+ doc = frappe.new_doc("Student Attendance")
doc.student = self.student
doc.student_name = self.student_name
doc.date = date
doc.leave_application = self.name
doc.status = status
- if self.attendance_based_on == 'Student Group':
+ if self.attendance_based_on == "Student Group":
doc.student_group = self.student_group
else:
doc.course_schedule = self.course_schedule
@@ -87,34 +93,42 @@ class StudentLeaveApplication(Document):
def cancel_attendance(self):
if self.docstatus == 2:
- attendance = frappe.db.sql("""
+ attendance = frappe.db.sql(
+ """
SELECT name
FROM `tabStudent Attendance`
WHERE
student = %s and
(date between %s and %s) and
docstatus < 2
- """, (self.student, self.from_date, self.to_date), as_dict=1)
+ """,
+ (self.student, self.from_date, self.to_date),
+ as_dict=1,
+ )
for name in attendance:
- frappe.db.set_value('Student Attendance', name, 'docstatus', 2)
+ frappe.db.set_value("Student Attendance", name, "docstatus", 2)
def daterange(start_date, end_date):
- for n in range(int ((end_date - start_date).days)+1):
+ for n in range(int((end_date - start_date).days) + 1):
yield start_date + timedelta(n)
+
def get_number_of_leave_days(from_date, to_date, holiday_list):
number_of_days = date_diff(to_date, from_date) + 1
- holidays = frappe.db.sql("""
+ holidays = frappe.db.sql(
+ """
SELECT
COUNT(DISTINCT holiday_date)
FROM `tabHoliday` h1,`tabHoliday List` h2
WHERE
h1.parent = h2.name and
h1.holiday_date between %s and %s and
- h2.name = %s""", (from_date, to_date, holiday_list))[0][0]
+ h2.name = %s""",
+ (from_date, to_date, holiday_list),
+ )[0][0]
number_of_days = flt(number_of_days) - flt(holidays)
diff --git a/erpnext/education/doctype/student_leave_application/student_leave_application_dashboard.py b/erpnext/education/doctype/student_leave_application/student_leave_application_dashboard.py
index fca5ad6ed56..8819c3bf657 100644
--- a/erpnext/education/doctype/student_leave_application/student_leave_application_dashboard.py
+++ b/erpnext/education/doctype/student_leave_application/student_leave_application_dashboard.py
@@ -1,11 +1,2 @@
-
-
def get_data():
- return {
- 'fieldname': 'leave_application',
- 'transactions': [
- {
- 'items': ['Student Attendance']
- }
- ]
- }
+ return {"fieldname": "leave_application", "transactions": [{"items": ["Student Attendance"]}]}
diff --git a/erpnext/education/doctype/student_leave_application/test_student_leave_application.py b/erpnext/education/doctype/student_leave_application/test_student_leave_application.py
index 92e82c5b8a1..7146fc25768 100644
--- a/erpnext/education/doctype/student_leave_application/test_student_leave_application.py
+++ b/erpnext/education/doctype/student_leave_application/test_student_leave_application.py
@@ -18,36 +18,44 @@ class TestStudentLeaveApplication(unittest.TestCase):
def test_attendance_record_creation(self):
leave_application = create_leave_application()
- attendance_record = frappe.db.exists('Student Attendance', {'leave_application': leave_application.name, 'status': 'Absent'})
+ attendance_record = frappe.db.exists(
+ "Student Attendance", {"leave_application": leave_application.name, "status": "Absent"}
+ )
self.assertTrue(attendance_record)
# mark as present
date = add_days(getdate(), -1)
leave_application = create_leave_application(date, date, 1)
- attendance_record = frappe.db.exists('Student Attendance', {'leave_application': leave_application.name, 'status': 'Present'})
+ attendance_record = frappe.db.exists(
+ "Student Attendance", {"leave_application": leave_application.name, "status": "Present"}
+ )
self.assertTrue(attendance_record)
def test_attendance_record_updated(self):
attendance = create_student_attendance()
create_leave_application()
- self.assertEqual(frappe.db.get_value('Student Attendance', attendance.name, 'status'), 'Absent')
+ self.assertEqual(frappe.db.get_value("Student Attendance", attendance.name, "status"), "Absent")
def test_attendance_record_cancellation(self):
leave_application = create_leave_application()
leave_application.cancel()
- attendance_status = frappe.db.get_value('Student Attendance', {'leave_application': leave_application.name}, 'docstatus')
+ attendance_status = frappe.db.get_value(
+ "Student Attendance", {"leave_application": leave_application.name}, "docstatus"
+ )
self.assertTrue(attendance_status, 2)
def test_holiday(self):
today = getdate()
- leave_application = create_leave_application(from_date=today, to_date= add_days(today, 1), submit=0)
+ leave_application = create_leave_application(
+ from_date=today, to_date=add_days(today, 1), submit=0
+ )
# holiday list validation
- company = get_default_company() or frappe.get_all('Company')[0].name
- frappe.db.set_value('Company', company, 'default_holiday_list', '')
+ company = get_default_company() or frappe.get_all("Company")[0].name
+ frappe.db.set_value("Company", company, "default_holiday_list", "")
self.assertRaises(frappe.ValidationError, leave_application.save)
- frappe.db.set_value('Company', company, 'default_holiday_list', 'Test Holiday List for Student')
+ frappe.db.set_value("Company", company, "default_holiday_list", "Test Holiday List for Student")
leave_application.save()
leave_application.reload()
@@ -55,19 +63,23 @@ class TestStudentLeaveApplication(unittest.TestCase):
# check no attendance record created for a holiday
leave_application.submit()
- self.assertIsNone(frappe.db.exists('Student Attendance', {'leave_application': leave_application.name, 'date': add_days(today, 1)}))
+ self.assertIsNone(
+ frappe.db.exists(
+ "Student Attendance", {"leave_application": leave_application.name, "date": add_days(today, 1)}
+ )
+ )
def tearDown(self):
- company = get_default_company() or frappe.get_all('Company')[0].name
- frappe.db.set_value('Company', company, 'default_holiday_list', '_Test Holiday List')
+ company = get_default_company() or frappe.get_all("Company")[0].name
+ frappe.db.set_value("Company", company, "default_holiday_list", "_Test Holiday List")
def create_leave_application(from_date=None, to_date=None, mark_as_present=0, submit=1):
student = get_student()
- leave_application = frappe.new_doc('Student Leave Application')
+ leave_application = frappe.new_doc("Student Leave Application")
leave_application.student = student.name
- leave_application.attendance_based_on = 'Student Group'
+ leave_application.attendance_based_on = "Student Group"
leave_application.student_group = get_random_group().name
leave_application.from_date = from_date if from_date else getdate()
leave_application.to_date = from_date if from_date else getdate()
@@ -79,38 +91,41 @@ def create_leave_application(from_date=None, to_date=None, mark_as_present=0, su
return leave_application
+
def create_student_attendance(date=None, status=None):
student = get_student()
- attendance = frappe.get_doc({
- 'doctype': 'Student Attendance',
- 'student': student.name,
- 'status': status if status else 'Present',
- 'date': date if date else getdate(),
- 'student_group': get_random_group().name
- }).insert()
+ attendance = frappe.get_doc(
+ {
+ "doctype": "Student Attendance",
+ "student": student.name,
+ "status": status if status else "Present",
+ "date": date if date else getdate(),
+ "student_group": get_random_group().name,
+ }
+ ).insert()
return attendance
+
def get_student():
- return create_student(dict(
- email='test_student@gmail.com',
- first_name='Test',
- last_name='Student'
- ))
+ return create_student(
+ dict(email="test_student@gmail.com", first_name="Test", last_name="Student")
+ )
+
def create_holiday_list():
- holiday_list = 'Test Holiday List for Student'
+ holiday_list = "Test Holiday List for Student"
today = getdate()
- if not frappe.db.exists('Holiday List', holiday_list):
- frappe.get_doc(dict(
- doctype = 'Holiday List',
- holiday_list_name = holiday_list,
- from_date = add_months(today, -6),
- to_date = add_months(today, 6),
- holidays = [
- dict(holiday_date=add_days(today, 1), description = 'Test')
- ]
- )).insert()
+ if not frappe.db.exists("Holiday List", holiday_list):
+ frappe.get_doc(
+ dict(
+ doctype="Holiday List",
+ holiday_list_name=holiday_list,
+ from_date=add_months(today, -6),
+ to_date=add_months(today, 6),
+ holidays=[dict(holiday_date=add_days(today, 1), description="Test")],
+ )
+ ).insert()
- company = get_default_company() or frappe.get_all('Company')[0].name
- frappe.db.set_value('Company', company, 'default_holiday_list', holiday_list)
+ company = get_default_company() or frappe.get_all("Company")[0].name
+ frappe.db.set_value("Company", company, "default_holiday_list", holiday_list)
return holiday_list
diff --git a/erpnext/education/doctype/student_log/test_student_log.py b/erpnext/education/doctype/student_log/test_student_log.py
index 91fdb3c8167..fef1ab56ac1 100644
--- a/erpnext/education/doctype/student_log/test_student_log.py
+++ b/erpnext/education/doctype/student_log/test_student_log.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Student Log')
+
class TestStudentLog(unittest.TestCase):
pass
diff --git a/erpnext/education/doctype/student_report_generation_tool/student_report_generation_tool.py b/erpnext/education/doctype/student_report_generation_tool/student_report_generation_tool.py
index 43802abea65..ae3c140a2ef 100644
--- a/erpnext/education/doctype/student_report_generation_tool/student_report_generation_tool.py
+++ b/erpnext/education/doctype/student_report_generation_tool/student_report_generation_tool.py
@@ -24,14 +24,19 @@ def preview_report_card(doc):
doc = frappe._dict(json.loads(doc))
doc.students = [doc.student]
if not (doc.student_name and doc.student_batch):
- program_enrollment = frappe.get_all("Program Enrollment", fields=["student_batch_name", "student_name"],
- filters={"student": doc.student, "docstatus": ('!=', 2), "academic_year": doc.academic_year})
+ program_enrollment = frappe.get_all(
+ "Program Enrollment",
+ fields=["student_batch_name", "student_name"],
+ filters={"student": doc.student, "docstatus": ("!=", 2), "academic_year": doc.academic_year},
+ )
if program_enrollment:
doc.batch = program_enrollment[0].student_batch_name
doc.student_name = program_enrollment[0].student_name
# get the assessment result of the selected student
- values = get_formatted_result(doc, get_course=True, get_all_assessment_groups=doc.include_all_assessment)
+ values = get_formatted_result(
+ doc, get_course=True, get_all_assessment_groups=doc.include_all_assessment
+ )
assessment_result = values.get("assessment_result").get(doc.student)
courses = values.get("course_dict")
course_criteria = get_courses_criteria(courses)
@@ -45,23 +50,32 @@ def preview_report_card(doc):
# get the attendance of the student for that peroid of time.
doc.attendance = get_attendance_count(doc.students[0], doc.academic_year, doc.academic_term)
- template = "erpnext/education/doctype/student_report_generation_tool/student_report_generation_tool.html"
+ template = (
+ "erpnext/education/doctype/student_report_generation_tool/student_report_generation_tool.html"
+ )
base_template_path = "frappe/www/printview.html"
from frappe.www.printview import get_letter_head
- letterhead = get_letter_head(frappe._dict({"letter_head": doc.letterhead}), not doc.add_letterhead)
- html = frappe.render_template(template,
+ letterhead = get_letter_head(
+ frappe._dict({"letter_head": doc.letterhead}), not doc.add_letterhead
+ )
+
+ html = frappe.render_template(
+ template,
{
"doc": doc,
"assessment_result": assessment_result,
"courses": courses,
"assessment_groups": assessment_groups,
"course_criteria": course_criteria,
- "letterhead": letterhead and letterhead.get('content', None),
- "add_letterhead": doc.add_letterhead if doc.add_letterhead else 0
- })
- final_template = frappe.render_template(base_template_path, {"body": html, "title": "Report Card"})
+ "letterhead": letterhead and letterhead.get("content", None),
+ "add_letterhead": doc.add_letterhead if doc.add_letterhead else 0,
+ },
+ )
+ final_template = frappe.render_template(
+ base_template_path, {"body": html, "title": "Report Card"}
+ )
frappe.response.filename = "Report Card " + doc.students[0] + ".pdf"
frappe.response.filecontent = get_pdf(final_template)
@@ -71,21 +85,33 @@ def preview_report_card(doc):
def get_courses_criteria(courses):
course_criteria = frappe._dict()
for course in courses:
- course_criteria[course] = [d.assessment_criteria for d in frappe.get_all("Course Assessment Criteria",
- fields=["assessment_criteria"], filters={"parent": course})]
+ course_criteria[course] = [
+ d.assessment_criteria
+ for d in frappe.get_all(
+ "Course Assessment Criteria", fields=["assessment_criteria"], filters={"parent": course}
+ )
+ ]
return course_criteria
def get_attendance_count(student, academic_year, academic_term=None):
if academic_year:
- from_date, to_date = frappe.db.get_value("Academic Year", academic_year, ["year_start_date", "year_end_date"])
+ from_date, to_date = frappe.db.get_value(
+ "Academic Year", academic_year, ["year_start_date", "year_end_date"]
+ )
elif academic_term:
- from_date, to_date = frappe.db.get_value("Academic Term", academic_term, ["term_start_date", "term_end_date"])
+ from_date, to_date = frappe.db.get_value(
+ "Academic Term", academic_term, ["term_start_date", "term_end_date"]
+ )
if from_date and to_date:
- attendance = dict(frappe.db.sql('''select status, count(student) as no_of_days
+ attendance = dict(
+ frappe.db.sql(
+ """select status, count(student) as no_of_days
from `tabStudent Attendance` where student = %s and docstatus = 1
- and date between %s and %s group by status''',
- (student, from_date, to_date)))
+ and date between %s and %s group by status""",
+ (student, from_date, to_date),
+ )
+ )
if "Absent" not in attendance.keys():
attendance["Absent"] = 0
if "Present" not in attendance.keys():
diff --git a/erpnext/education/doctype/topic/test_topic.py b/erpnext/education/doctype/topic/test_topic.py
index d1d664bb21a..c11204a575c 100644
--- a/erpnext/education/doctype/topic/test_topic.py
+++ b/erpnext/education/doctype/topic/test_topic.py
@@ -8,7 +8,7 @@ import frappe
class TestTopic(unittest.TestCase):
def setUp(self):
- make_topic_and_linked_content("_Test Topic 1", [{"type":"Article", "name": "_Test Article 1"}])
+ make_topic_and_linked_content("_Test Topic 1", [{"type": "Article", "name": "_Test Article 1"}])
def test_get_contents(self):
topic = frappe.get_doc("Topic", "_Test Topic 1")
@@ -17,24 +17,28 @@ class TestTopic(unittest.TestCase):
self.assertEqual(contents[0].name, "_Test Article 1")
frappe.db.rollback()
+
def make_topic(name):
try:
topic = frappe.get_doc("Topic", name)
except frappe.DoesNotExistError:
- topic = frappe.get_doc({
- "doctype": "Topic",
- "topic_name": name,
- "topic_code": name,
- }).insert()
+ topic = frappe.get_doc(
+ {
+ "doctype": "Topic",
+ "topic_name": name,
+ "topic_code": name,
+ }
+ ).insert()
return topic.name
+
def make_topic_and_linked_content(topic_name, content_dict_list):
try:
topic = frappe.get_doc("Topic", topic_name)
except frappe.DoesNotExistError:
make_topic(topic_name)
topic = frappe.get_doc("Topic", topic_name)
- content_list = [make_content(content['type'], content['name']) for content in content_dict_list]
+ content_list = [make_content(content["type"], content["name"]) for content in content_dict_list]
for content in content_list:
topic.append("topic_content", {"content": content.title, "content_type": content.doctype})
topic.save()
diff --git a/erpnext/education/doctype/topic/topic.py b/erpnext/education/doctype/topic/topic.py
index 146f57453ad..6dd965552b1 100644
--- a/erpnext/education/doctype/topic/topic.py
+++ b/erpnext/education/doctype/topic/topic.py
@@ -13,48 +13,64 @@ class Topic(Document):
def get_contents(self):
try:
topic_content_list = self.topic_content
- content_data = [frappe.get_doc(topic_content.content_type, topic_content.content) for topic_content in topic_content_list]
+ content_data = [
+ frappe.get_doc(topic_content.content_type, topic_content.content)
+ for topic_content in topic_content_list
+ ]
except Exception as e:
frappe.log_error(frappe.get_traceback())
return None
return content_data
+
@frappe.whitelist()
def get_courses_without_topic(topic):
data = []
- for entry in frappe.db.get_all('Course'):
- course = frappe.get_doc('Course', entry.name)
+ for entry in frappe.db.get_all("Course"):
+ course = frappe.get_doc("Course", entry.name)
topics = [t.topic for t in course.topics]
if not topics or topic not in topics:
data.append(course.name)
return data
+
@frappe.whitelist()
def add_topic_to_courses(topic, courses, mandatory=False):
courses = json.loads(courses)
for entry in courses:
- course = frappe.get_doc('Course', entry)
- course.append('topics', {
- 'topic': topic,
- 'topic_name': topic
- })
+ course = frappe.get_doc("Course", entry)
+ course.append("topics", {"topic": topic, "topic_name": topic})
course.flags.ignore_mandatory = True
course.save()
frappe.db.commit()
- frappe.msgprint(_('Topic {0} has been added to all the selected courses successfully.').format(frappe.bold(topic)),
- title=_('Courses updated'), indicator='green')
+ frappe.msgprint(
+ _("Topic {0} has been added to all the selected courses successfully.").format(
+ frappe.bold(topic)
+ ),
+ title=_("Courses updated"),
+ indicator="green",
+ )
+
@frappe.whitelist()
def add_content_to_topics(content_type, content, topics):
topics = json.loads(topics)
for entry in topics:
- topic = frappe.get_doc('Topic', entry)
- topic.append('topic_content', {
- 'content_type': content_type,
- 'content': content,
- })
+ topic = frappe.get_doc("Topic", entry)
+ topic.append(
+ "topic_content",
+ {
+ "content_type": content_type,
+ "content": content,
+ },
+ )
topic.flags.ignore_mandatory = True
topic.save()
frappe.db.commit()
- frappe.msgprint(_('{0} {1} has been added to all the selected topics successfully.').format(content_type, frappe.bold(content)),
- title=_('Topics updated'), indicator='green')
+ frappe.msgprint(
+ _("{0} {1} has been added to all the selected topics successfully.").format(
+ content_type, frappe.bold(content)
+ ),
+ title=_("Topics updated"),
+ indicator="green",
+ )
diff --git a/erpnext/education/report/absent_student_report/absent_student_report.py b/erpnext/education/report/absent_student_report/absent_student_report.py
index c274d333492..ac27f715ec9 100644
--- a/erpnext/education/report/absent_student_report/absent_student_report.py
+++ b/erpnext/education/report/absent_student_report/absent_student_report.py
@@ -11,7 +11,8 @@ from erpnext.hr.doctype.holiday_list.holiday_list import is_holiday
def execute(filters=None):
- if not filters: filters = {}
+ if not filters:
+ filters = {}
if not filters.get("date"):
msgprint(_("Please select date"), raise_exception=1)
@@ -21,8 +22,11 @@ def execute(filters=None):
holiday_list = get_holiday_list()
if is_holiday(holiday_list, filters.get("date")):
- msgprint(_("No attendance has been marked for {0} as it is a Holiday").format(frappe.bold(formatdate(filters.get("date")))))
-
+ msgprint(
+ _("No attendance has been marked for {0} as it is a Holiday").format(
+ frappe.bold(formatdate(filters.get("date")))
+ )
+ )
absent_students = get_absent_students(date)
leave_applicants = get_leave_applications(date)
@@ -34,17 +38,19 @@ def execute(filters=None):
for student in absent_students:
if not student.student in leave_applicants:
row = [student.student, student.student_name, student.student_group]
- stud_details = frappe.db.get_value("Student", student.student, ['student_email_id', 'student_mobile_number'], as_dict=True)
+ stud_details = frappe.db.get_value(
+ "Student", student.student, ["student_email_id", "student_mobile_number"], as_dict=True
+ )
if stud_details.student_email_id:
- row+=[stud_details.student_email_id]
+ row += [stud_details.student_email_id]
else:
- row+= [""]
+ row += [""]
if stud_details.student_mobile_number:
- row+=[stud_details.student_mobile_number]
+ row += [stud_details.student_mobile_number]
else:
- row+= [""]
+ row += [""]
if transportation_details.get(student.student):
row += transportation_details.get(student.student)
@@ -52,6 +58,7 @@ def execute(filters=None):
return columns, data
+
def get_columns(filters):
columns = [
_("Student") + ":Link/Student:90",
@@ -64,34 +71,45 @@ def get_columns(filters):
]
return columns
+
def get_absent_students(date):
- absent_students = frappe.db.sql("""
+ absent_students = frappe.db.sql(
+ """
SELECT student, student_name, student_group
FROM `tabStudent Attendance`
WHERE
status='Absent' and docstatus=1 and date = %s
ORDER BY
student_group, student_name""",
- date, as_dict=1)
+ date,
+ as_dict=1,
+ )
return absent_students
+
def get_leave_applications(date):
leave_applicants = []
- leave_applications = frappe.db.sql("""
+ leave_applications = frappe.db.sql(
+ """
SELECT student
FROM
`tabStudent Leave Application`
WHERE
docstatus = 1 and mark_as_present = 1 and
from_date <= %s and to_date >= %s
- """, (date, date))
+ """,
+ (date, date),
+ )
for student in leave_applications:
leave_applicants.append(student[0])
return leave_applicants
+
def get_transportation_details(date, student_list):
- academic_year = frappe.get_all("Academic Year", filters=[["year_start_date", "<=", date],["year_end_date", ">=", date]])
+ academic_year = frappe.get_all(
+ "Academic Year", filters=[["year_start_date", "<=", date], ["year_end_date", ">=", date]]
+ )
if academic_year:
academic_year = academic_year[0].name
elif frappe.defaults.get_defaults().academic_year:
@@ -99,8 +117,15 @@ def get_transportation_details(date, student_list):
else:
return {}
- transportation_details = frappe.get_all("Program Enrollment", fields=["student", "mode_of_transportation", "vehicle_no"],
- filters={"student": ("in", student_list), "academic_year": academic_year, "docstatus": ("not in", ["2"])})
+ transportation_details = frappe.get_all(
+ "Program Enrollment",
+ fields=["student", "mode_of_transportation", "vehicle_no"],
+ filters={
+ "student": ("in", student_list),
+ "academic_year": academic_year,
+ "docstatus": ("not in", ["2"]),
+ },
+ )
transportation_map = {}
for d in transportation_details:
transportation_map[d.student] = [d.mode_of_transportation, d.vehicle_no]
diff --git a/erpnext/education/report/assessment_plan_status/assessment_plan_status.py b/erpnext/education/report/assessment_plan_status/assessment_plan_status.py
index 86f2451cbf0..7cf5b30548a 100644
--- a/erpnext/education/report/assessment_plan_status/assessment_plan_status.py
+++ b/erpnext/education/report/assessment_plan_status/assessment_plan_status.py
@@ -13,6 +13,7 @@ DOCSTATUS = {
1: "submitted",
}
+
def execute(filters=None):
columns, data = [], []
@@ -32,13 +33,14 @@ def get_assessment_data(args=None):
# [total, saved, submitted, remaining]
chart_data = [0, 0, 0, 0]
- condition = ''
+ condition = ""
if args["assessment_group"]:
condition += "and assessment_group = %(assessment_group)s"
if args["schedule_date"]:
condition += "and schedule_date <= %(schedule_date)s"
- assessment_plan = frappe.db.sql('''
+ assessment_plan = frappe.db.sql(
+ """
SELECT
ap.name as assessment_plan,
ap.assessment_name,
@@ -52,24 +54,33 @@ def get_assessment_data(args=None):
ap.docstatus = 1 {condition}
ORDER BY
ap.modified desc
- '''.format(condition=condition), (args), as_dict=1)
+ """.format(
+ condition=condition
+ ),
+ (args),
+ as_dict=1,
+ )
- assessment_plan_list = [d.assessment_plan for d in assessment_plan] if assessment_plan else ['']
+ assessment_plan_list = [d.assessment_plan for d in assessment_plan] if assessment_plan else [""]
assessment_result = get_assessment_result(assessment_plan_list)
for d in assessment_plan:
assessment_plan_details = assessment_result.get(d.assessment_plan)
- assessment_plan_details = frappe._dict() if not assessment_plan_details else \
- frappe._dict(assessment_plan_details)
+ assessment_plan_details = (
+ frappe._dict() if not assessment_plan_details else frappe._dict(assessment_plan_details)
+ )
if "saved" not in assessment_plan_details:
assessment_plan_details.update({"saved": 0})
if "submitted" not in assessment_plan_details:
assessment_plan_details.update({"submitted": 0})
# remaining students whose marks not entered
- remaining_students = cint(d.student_group_strength) - cint(assessment_plan_details.saved) -\
- cint(assessment_plan_details.submitted)
+ remaining_students = (
+ cint(d.student_group_strength)
+ - cint(assessment_plan_details.saved)
+ - cint(assessment_plan_details.submitted)
+ )
assessment_plan_details.update({"remaining": remaining_students})
d.update(assessment_plan_details)
@@ -86,7 +97,8 @@ def get_assessment_data(args=None):
def get_assessment_result(assessment_plan_list):
assessment_result_dict = frappe._dict()
- assessment_result = frappe.db.sql('''
+ assessment_result = frappe.db.sql(
+ """
SELECT
assessment_plan, docstatus, count(*) as count
FROM
@@ -97,13 +109,17 @@ def get_assessment_result(assessment_plan_list):
assessment_plan, docstatus
ORDER BY
assessment_plan
- ''' %', '.join(['%s']*len(assessment_plan_list)), tuple(assessment_plan_list), as_dict=1)
+ """
+ % ", ".join(["%s"] * len(assessment_plan_list)),
+ tuple(assessment_plan_list),
+ as_dict=1,
+ )
for key, group in groupby(assessment_result, lambda ap: ap["assessment_plan"]):
tmp = {}
for d in group:
- if d.docstatus in [0,1]:
- tmp.update({DOCSTATUS[d.docstatus]:d.count})
+ if d.docstatus in [0, 1]:
+ tmp.update({DOCSTATUS[d.docstatus]: d.count})
assessment_result_dict[key] = tmp
return assessment_result_dict
@@ -111,70 +127,61 @@ def get_assessment_result(assessment_plan_list):
def get_chart(chart_data):
return {
- "data": {
- "labels": ["Saved", "Submitted", "Remaining"],
- "datasets": [{
- "values": chart_data
- }]
- },
- "type": 'percentage',
+ "data": {"labels": ["Saved", "Submitted", "Remaining"], "datasets": [{"values": chart_data}]},
+ "type": "percentage",
}
def get_column():
- return [{
- "fieldname": "assessment_plan",
- "label": _("Assessment Plan"),
- "fieldtype": "Link",
- "options": "Assessment Plan",
- "width": 120
- },
- {
- "fieldname": "assessment_name",
- "label": _("Assessment Plan Name"),
- "fieldtype": "Data",
- "options": "",
- "width": 200
- },
- {
- "fieldname": "schedule_date",
- "label": _("Schedule Date"),
- "fieldtype": "Date",
- "options": "",
- "width": 100
- },
- {
- "fieldname": "student_group",
- "label": _("Student Group"),
- "fieldtype": "Link",
- "options": "Student Group",
- "width": 200
- },
- {
- "fieldname": "student_group_strength",
- "label": _("Total Student"),
- "fieldtype": "Data",
- "options": "",
- "width": 100
- },
- {
- "fieldname": "submitted",
- "label": _("Submitted"),
- "fieldtype": "Data",
- "options": "",
- "width": 100
- },
- {
- "fieldname": "saved",
- "label": _("Saved"),
- "fieldtype": "Data",
- "options": "",
- "width": 100
- },
- {
- "fieldname": "remaining",
- "label": _("Remaining"),
- "fieldtype": "Data",
- "options": "",
- "width": 100
- }]
+ return [
+ {
+ "fieldname": "assessment_plan",
+ "label": _("Assessment Plan"),
+ "fieldtype": "Link",
+ "options": "Assessment Plan",
+ "width": 120,
+ },
+ {
+ "fieldname": "assessment_name",
+ "label": _("Assessment Plan Name"),
+ "fieldtype": "Data",
+ "options": "",
+ "width": 200,
+ },
+ {
+ "fieldname": "schedule_date",
+ "label": _("Schedule Date"),
+ "fieldtype": "Date",
+ "options": "",
+ "width": 100,
+ },
+ {
+ "fieldname": "student_group",
+ "label": _("Student Group"),
+ "fieldtype": "Link",
+ "options": "Student Group",
+ "width": 200,
+ },
+ {
+ "fieldname": "student_group_strength",
+ "label": _("Total Student"),
+ "fieldtype": "Data",
+ "options": "",
+ "width": 100,
+ },
+ {
+ "fieldname": "submitted",
+ "label": _("Submitted"),
+ "fieldtype": "Data",
+ "options": "",
+ "width": 100,
+ },
+ {"fieldname": "saved", "label": _("Saved"), "fieldtype": "Data", "options": "", "width": 100},
+ {
+ "fieldname": "remaining",
+ "label": _("Remaining"),
+ "fieldtype": "Data",
+ "options": "",
+ "width": 100,
+ },
+ ]
diff --git a/erpnext/education/report/course_wise_assessment_report/course_wise_assessment_report.py b/erpnext/education/report/course_wise_assessment_report/course_wise_assessment_report.py
index 38eef68d0e7..0930882e403 100644
--- a/erpnext/education/report/course_wise_assessment_report/course_wise_assessment_report.py
+++ b/erpnext/education/report/course_wise_assessment_report/course_wise_assessment_report.py
@@ -37,8 +37,12 @@ def execute(filters=None):
for criteria in assessment_criteria_dict:
scrub_criteria = frappe.scrub(criteria)
if criteria in result_dict[student][args.course][args.assessment_group]:
- student_row[scrub_criteria] = result_dict[student][args.course][args.assessment_group][criteria]["grade"]
- student_row[scrub_criteria + "_score"] = result_dict[student][args.course][args.assessment_group][criteria]["score"]
+ student_row[scrub_criteria] = result_dict[student][args.course][args.assessment_group][
+ criteria
+ ]["grade"]
+ student_row[scrub_criteria + "_score"] = result_dict[student][args.course][
+ args.assessment_group
+ ][criteria]["score"]
# create the list of possible grades
if student_row[scrub_criteria] not in grades:
@@ -51,7 +55,7 @@ def execute(filters=None):
grade_wise_analysis[criteria][student_row[scrub_criteria]] += 1
else:
student_row[frappe.scrub(criteria)] = ""
- student_row[frappe.scrub(criteria)+ "_score"] = ""
+ student_row[frappe.scrub(criteria) + "_score"] = ""
data.append(student_row)
assessment_criteria_list = [d for d in assessment_criteria_dict]
@@ -61,7 +65,9 @@ def execute(filters=None):
return columns, data, None, chart
-def get_formatted_result(args, get_assessment_criteria=False, get_course=False, get_all_assessment_groups=False):
+def get_formatted_result(
+ args, get_assessment_criteria=False, get_course=False, get_all_assessment_groups=False
+):
cond, cond1, cond2, cond3, cond4 = " ", " ", " ", " ", " "
args_list = [args.academic_year]
@@ -80,14 +86,15 @@ def get_formatted_result(args, get_assessment_criteria=False, get_course=False,
create_total_dict = False
assessment_groups = get_child_assessment_groups(args.assessment_group)
- cond3 = " and ar.assessment_group in (%s)"%(', '.join(['%s']*len(assessment_groups)))
+ cond3 = " and ar.assessment_group in (%s)" % (", ".join(["%s"] * len(assessment_groups)))
args_list += assessment_groups
if args.students:
- cond4 = " and ar.student in (%s)"%(', '.join(['%s']*len(args.students)))
+ cond4 = " and ar.student in (%s)" % (", ".join(["%s"] * len(args.students)))
args_list += args.students
- assessment_result = frappe.db.sql('''
+ assessment_result = frappe.db.sql(
+ """
SELECT
ar.student, ar.student_name, ar.academic_year, ar.academic_term, ar.program, ar.course,
ar.assessment_plan, ar.grading_scale, ar.assessment_group, ar.student_group,
@@ -97,8 +104,12 @@ def get_formatted_result(args, get_assessment_criteria=False, get_course=False,
WHERE
ar.name=ard.parent and ar.docstatus=1 and ar.academic_year=%s {0} {1} {2} {3} {4}
ORDER BY
- ard.assessment_criteria'''.format(cond, cond1, cond2, cond3, cond4),
- tuple(args_list), as_dict=1)
+ ard.assessment_criteria""".format(
+ cond, cond1, cond2, cond3, cond4
+ ),
+ tuple(args_list),
+ as_dict=1,
+ )
# create the nested dictionary structure as given below:
# .....
@@ -114,21 +125,48 @@ def get_formatted_result(args, get_assessment_criteria=False, get_course=False,
# add the score for a given score and recalculate the grades
def add_score_and_recalculate_grade(result, assessment_group, assessment_criteria):
- formatted_assessment_result[result.student][result.course][assessment_group]\
- [assessment_criteria]["maximum_score"] += result.maximum_score
- formatted_assessment_result[result.student][result.course][assessment_group]\
- [assessment_criteria]["score"] += result.score
- tmp_grade = get_grade(result.grading_scale, ((formatted_assessment_result[result.student][result.course]
- [assessment_group][assessment_criteria]["score"])/(formatted_assessment_result[result.student]
- [result.course][assessment_group][assessment_criteria]["maximum_score"]))*100)
- formatted_assessment_result[result.student][result.course][assessment_group]\
- [assessment_criteria]["grade"] = tmp_grade
+ formatted_assessment_result[result.student][result.course][assessment_group][
+ assessment_criteria
+ ]["maximum_score"] += result.maximum_score
+ formatted_assessment_result[result.student][result.course][assessment_group][
+ assessment_criteria
+ ]["score"] += result.score
+ tmp_grade = get_grade(
+ result.grading_scale,
+ (
+ (
+ formatted_assessment_result[result.student][result.course][assessment_group][
+ assessment_criteria
+ ]["score"]
+ )
+ / (
+ formatted_assessment_result[result.student][result.course][assessment_group][
+ assessment_criteria
+ ]["maximum_score"]
+ )
+ )
+ * 100,
+ )
+ formatted_assessment_result[result.student][result.course][assessment_group][
+ assessment_criteria
+ ]["grade"] = tmp_grade
# create the assessment criteria "Final Grade" with the sum of all the scores of the assessment criteria in a given assessment group
def add_total_score(result, assessment_group):
- if "Final Grade" not in formatted_assessment_result[result.student][result.course][assessment_group]:
- formatted_assessment_result[result.student][result.course][assessment_group]["Final Grade"] = frappe._dict({
- "assessment_criteria": "Final Grade", "maximum_score": result.maximum_score, "score": result.score, "grade": result.grade})
+ if (
+ "Final Grade"
+ not in formatted_assessment_result[result.student][result.course][assessment_group]
+ ):
+ formatted_assessment_result[result.student][result.course][assessment_group][
+ "Final Grade"
+ ] = frappe._dict(
+ {
+ "assessment_criteria": "Final Grade",
+ "maximum_score": result.maximum_score,
+ "score": result.score,
+ "grade": result.grade,
+ }
+ )
else:
add_score_and_recalculate_grade(result, assessment_group, "Final Grade")
@@ -136,8 +174,14 @@ def get_formatted_result(args, get_assessment_criteria=False, get_course=False,
if result.student not in student_details:
student_details[result.student] = result.student_name
- assessment_criteria_details = frappe._dict({"assessment_criteria": result.assessment_criteria,
- "maximum_score": result.maximum_score, "score": result.score, "grade": result.grade})
+ assessment_criteria_details = frappe._dict(
+ {
+ "assessment_criteria": result.assessment_criteria,
+ "maximum_score": result.maximum_score,
+ "score": result.score,
+ "grade": result.grade,
+ }
+ )
if not formatted_assessment_result[result.student]:
formatted_assessment_result[result.student] = defaultdict(dict)
@@ -145,32 +189,46 @@ def get_formatted_result(args, get_assessment_criteria=False, get_course=False,
formatted_assessment_result[result.student][result.course] = defaultdict(dict)
if not create_total_dict:
- formatted_assessment_result[result.student][result.course][result.assessment_group]\
- [result.assessment_criteria] = assessment_criteria_details
+ formatted_assessment_result[result.student][result.course][result.assessment_group][
+ result.assessment_criteria
+ ] = assessment_criteria_details
add_total_score(result, result.assessment_group)
# create the total of all the assessment groups criteria-wise
elif create_total_dict:
if get_all_assessment_groups:
- formatted_assessment_result[result.student][result.course][result.assessment_group]\
- [result.assessment_criteria] = assessment_criteria_details
+ formatted_assessment_result[result.student][result.course][result.assessment_group][
+ result.assessment_criteria
+ ] = assessment_criteria_details
if not formatted_assessment_result[result.student][result.course][args.assessment_group]:
- formatted_assessment_result[result.student][result.course][args.assessment_group] = defaultdict(dict)
- formatted_assessment_result[result.student][result.course][args.assessment_group]\
- [result.assessment_criteria] = assessment_criteria_details
- elif result.assessment_criteria not in formatted_assessment_result[result.student][result.course][args.assessment_group]:
- formatted_assessment_result[result.student][result.course][args.assessment_group]\
- [result.assessment_criteria] = assessment_criteria_details
- elif result.assessment_criteria in formatted_assessment_result[result.student][result.course][args.assessment_group]:
+ formatted_assessment_result[result.student][result.course][
+ args.assessment_group
+ ] = defaultdict(dict)
+ formatted_assessment_result[result.student][result.course][args.assessment_group][
+ result.assessment_criteria
+ ] = assessment_criteria_details
+ elif (
+ result.assessment_criteria
+ not in formatted_assessment_result[result.student][result.course][args.assessment_group]
+ ):
+ formatted_assessment_result[result.student][result.course][args.assessment_group][
+ result.assessment_criteria
+ ] = assessment_criteria_details
+ elif (
+ result.assessment_criteria
+ in formatted_assessment_result[result.student][result.course][args.assessment_group]
+ ):
add_score_and_recalculate_grade(result, args.assessment_group, result.assessment_criteria)
add_total_score(result, args.assessment_group)
- total_maximum_score = formatted_assessment_result[result.student][result.course][args.assessment_group]\
- ["Final Grade"]["maximum_score"]
+ total_maximum_score = formatted_assessment_result[result.student][result.course][
+ args.assessment_group
+ ]["Final Grade"]["maximum_score"]
if get_assessment_criteria:
- assessment_criteria_dict[result.assessment_criteria] = formatted_assessment_result[result.student][result.course]\
- [args.assessment_group][result.assessment_criteria]["maximum_score"]
+ assessment_criteria_dict[result.assessment_criteria] = formatted_assessment_result[
+ result.student
+ ][result.course][args.assessment_group][result.assessment_criteria]["maximum_score"]
if get_course:
course_dict[result.course] = total_maximum_score
@@ -181,37 +239,31 @@ def get_formatted_result(args, get_assessment_criteria=False, get_course=False,
"student_details": student_details,
"assessment_result": formatted_assessment_result,
"assessment_criteria": assessment_criteria_dict,
- "course_dict": course_dict
+ "course_dict": course_dict,
}
def get_column(assessment_criteria):
- columns = [{
- "fieldname": "student",
- "label": _("Student ID"),
- "fieldtype": "Link",
- "options": "Student",
- "width": 90
- },
- {
- "fieldname": "student_name",
- "label": _("Student Name"),
- "fieldtype": "Data",
- "width": 160
- }]
+ columns = [
+ {
+ "fieldname": "student",
+ "label": _("Student ID"),
+ "fieldtype": "Link",
+ "options": "Student",
+ "width": 90,
+ },
+ {"fieldname": "student_name", "label": _("Student Name"), "fieldtype": "Data", "width": 160},
+ ]
for d in assessment_criteria:
- columns.append({
- "fieldname": frappe.scrub(d),
- "label": d,
- "fieldtype": "Data",
- "width": 110
- })
- columns.append({
- "fieldname": frappe.scrub(d) +"_score",
- "label": "Score(" + str(int(assessment_criteria[d])) + ")",
- "fieldtype": "Float",
- "width": 100
- })
+ columns.append({"fieldname": frappe.scrub(d), "label": d, "fieldtype": "Data", "width": 110})
+ columns.append(
+ {
+ "fieldname": frappe.scrub(d) + "_score",
+ "label": "Score(" + str(int(assessment_criteria[d])) + ")",
+ "fieldtype": "Float",
+ "width": 100,
+ }
+ )
return columns
@@ -221,7 +273,7 @@ def get_chart_data(grades, criteria_list, kounter):
datasets = []
for grade in grades:
- tmp = frappe._dict({"name": grade, "values":[]})
+ tmp = frappe._dict({"name": grade, "values": []})
for criteria in criteria_list:
if grade in kounter[criteria]:
tmp["values"].append(kounter[criteria][grade])
@@ -230,11 +282,8 @@ def get_chart_data(grades, criteria_list, kounter):
datasets.append(tmp)
return {
- "data": {
- "labels": criteria_list,
- "datasets": datasets
- },
- "type": 'bar',
+ "data": {"labels": criteria_list, "datasets": datasets},
+ "type": "bar",
}
@@ -243,8 +292,12 @@ def get_child_assessment_groups(assessment_group):
group_type = frappe.get_value("Assessment Group", assessment_group, "is_group")
if group_type:
from frappe.desk.treeview import get_children
- assessment_groups = [d.get("value") for d in get_children("Assessment Group",
- assessment_group) if d.get("value") and not d.get("expandable")]
+
+ assessment_groups = [
+ d.get("value")
+ for d in get_children("Assessment Group", assessment_group)
+ if d.get("value") and not d.get("expandable")
+ ]
else:
assessment_groups = [assessment_group]
return assessment_groups
diff --git a/erpnext/education/report/final_assessment_grades/final_assessment_grades.py b/erpnext/education/report/final_assessment_grades/final_assessment_grades.py
index b0428678045..8d5acc61f2f 100644
--- a/erpnext/education/report/final_assessment_grades/final_assessment_grades.py
+++ b/erpnext/education/report/final_assessment_grades/final_assessment_grades.py
@@ -22,7 +22,9 @@ def execute(filters=None):
assessment_group = args["assessment_group"] = filters.get("assessment_group")
student_group = filters.get("student_group")
- args.students = frappe.db.sql_list("select student from `tabStudent Group Student` where parent=%s", (student_group))
+ args.students = frappe.db.sql_list(
+ "select student from `tabStudent Group Student` where parent=%s", (student_group)
+ )
values = get_formatted_result(args, get_course=True)
student_details = values.get("student_details")
@@ -37,8 +39,12 @@ def execute(filters=None):
for course in course_dict:
scrub_course = frappe.scrub(course)
if assessment_group in assessment_result[student][course]:
- student_row["grade_" + scrub_course] = assessment_result[student][course][assessment_group]["Total Score"]["grade"]
- student_row["score_" + scrub_course] = assessment_result[student][course][assessment_group]["Total Score"]["score"]
+ student_row["grade_" + scrub_course] = assessment_result[student][course][assessment_group][
+ "Total Score"
+ ]["grade"]
+ student_row["score_" + scrub_course] = assessment_result[student][course][assessment_group][
+ "Total Score"
+ ]["score"]
# create the list of possible grades
if student_row["grade_" + scrub_course] not in grades:
@@ -59,31 +65,32 @@ def execute(filters=None):
def get_column(course_dict):
- columns = [{
- "fieldname": "student",
- "label": _("Student ID"),
- "fieldtype": "Link",
- "options": "Student",
- "width": 90
- },
- {
- "fieldname": "student_name",
- "label": _("Student Name"),
- "fieldtype": "Data",
- "width": 160
- }]
+ columns = [
+ {
+ "fieldname": "student",
+ "label": _("Student ID"),
+ "fieldtype": "Link",
+ "options": "Student",
+ "width": 90,
+ },
+ {"fieldname": "student_name", "label": _("Student Name"), "fieldtype": "Data", "width": 160},
+ ]
for course in course_dict:
- columns.append({
- "fieldname": "grade_" + frappe.scrub(course),
- "label": course,
- "fieldtype": "Data",
- "width": 110
- })
- columns.append({
- "fieldname": "score_" + frappe.scrub(course),
- "label": "Score(" + str(course_dict[course]) + ")",
- "fieldtype": "Float",
- "width": 100
- })
+ columns.append(
+ {
+ "fieldname": "grade_" + frappe.scrub(course),
+ "label": course,
+ "fieldtype": "Data",
+ "width": 110,
+ }
+ )
+ columns.append(
+ {
+ "fieldname": "score_" + frappe.scrub(course),
+ "label": "Score(" + str(course_dict[course]) + ")",
+ "fieldtype": "Float",
+ "width": 100,
+ }
+ )
return columns
diff --git a/erpnext/education/report/program_wise_fee_collection/program_wise_fee_collection.py b/erpnext/education/report/program_wise_fee_collection/program_wise_fee_collection.py
index 0599dadf934..e5591f9b6be 100644
--- a/erpnext/education/report/program_wise_fee_collection/program_wise_fee_collection.py
+++ b/erpnext/education/report/program_wise_fee_collection/program_wise_fee_collection.py
@@ -16,33 +16,29 @@ def execute(filters=None):
return columns, data, None, chart
+
def get_columns(filters=None):
return [
{
- 'label': _('Program'),
- 'fieldname': 'program',
- 'fieldtype': 'Link',
- 'options': 'Program',
- 'width': 300
+ "label": _("Program"),
+ "fieldname": "program",
+ "fieldtype": "Link",
+ "options": "Program",
+ "width": 300,
},
{
- 'label': _('Fees Collected'),
- 'fieldname': 'fees_collected',
- 'fieldtype': 'Currency',
- 'width': 200
+ "label": _("Fees Collected"),
+ "fieldname": "fees_collected",
+ "fieldtype": "Currency",
+ "width": 200,
},
{
- 'label': _('Outstanding Amount'),
- 'fieldname': 'outstanding_amount',
- 'fieldtype': 'Currency',
- 'width': 200
+ "label": _("Outstanding Amount"),
+ "fieldname": "outstanding_amount",
+ "fieldtype": "Currency",
+ "width": 200,
},
- {
- 'label': _('Grand Total'),
- 'fieldname': 'grand_total',
- 'fieldtype': 'Currency',
- 'width': 200
- }
+ {"label": _("Grand Total"), "fieldname": "grand_total", "fieldtype": "Currency", "width": 200},
]
@@ -71,24 +67,32 @@ def get_data(filters=None):
GROUP BY program
) AS FeesCollected
ORDER BY FeesCollected.paid_amount DESC
- """ % (conditions)
- , as_dict=1)
+ """
+ % (conditions),
+ as_dict=1,
+ )
for entry in fee_details:
- data.append({
- 'program': entry.program,
- 'fees_collected': entry.paid_amount,
- 'outstanding_amount': entry.outstanding_amount,
- 'grand_total': entry.grand_total
- })
+ data.append(
+ {
+ "program": entry.program,
+ "fees_collected": entry.paid_amount,
+ "outstanding_amount": entry.outstanding_amount,
+ "grand_total": entry.grand_total,
+ }
+ )
return data
-def get_filter_conditions(filters):
- conditions = ''
- if filters.get('from_date') and filters.get('to_date'):
- conditions += " and posting_date BETWEEN '%s' and '%s'" % (filters.get('from_date'), filters.get('to_date'))
+def get_filter_conditions(filters):
+ conditions = ""
+
+ if filters.get("from_date") and filters.get("to_date"):
+ conditions += " and posting_date BETWEEN '%s' and '%s'" % (
+ filters.get("from_date"),
+ filters.get("to_date"),
+ )
return conditions
@@ -102,23 +106,17 @@ def get_chart_data(data):
outstanding_amount = []
for entry in data:
- labels.append(entry.get('program'))
- fees_collected.append(entry.get('fees_collected'))
- outstanding_amount.append(entry.get('outstanding_amount'))
+ labels.append(entry.get("program"))
+ fees_collected.append(entry.get("fees_collected"))
+ outstanding_amount.append(entry.get("outstanding_amount"))
return {
- 'data': {
- 'labels': labels,
- 'datasets': [
- {
- 'name': _('Fees Collected'),
- 'values': fees_collected
- },
- {
- 'name': _('Outstanding Amt'),
- 'values': outstanding_amount
- }
- ]
+ "data": {
+ "labels": labels,
+ "datasets": [
+ {"name": _("Fees Collected"), "values": fees_collected},
+ {"name": _("Outstanding Amt"), "values": outstanding_amount},
+ ],
},
- 'type': 'bar'
+ "type": "bar",
}
diff --git a/erpnext/education/report/student_and_guardian_contact_details/student_and_guardian_contact_details.py b/erpnext/education/report/student_and_guardian_contact_details/student_and_guardian_contact_details.py
index 7097b8072b2..6f871d7ad7a 100644
--- a/erpnext/education/report/student_and_guardian_contact_details/student_and_guardian_contact_details.py
+++ b/erpnext/education/report/student_and_guardian_contact_details/student_and_guardian_contact_details.py
@@ -15,12 +15,19 @@ def execute(filters=None):
columns = get_columns()
- program_enrollments = frappe.get_list("Program Enrollment", fields=["student", "student_name"],
- filters={"academic_year": academic_year, "program": program, "student_batch_name": student_batch_name})
+ program_enrollments = frappe.get_list(
+ "Program Enrollment",
+ fields=["student", "student_name"],
+ filters={
+ "academic_year": academic_year,
+ "program": program,
+ "student_batch_name": student_batch_name,
+ },
+ )
student_list = [d.student for d in program_enrollments]
if not student_list:
- return columns, []
+ return columns, []
group_roll_no_map = get_student_roll_no(academic_year, program, student_batch_name)
student_map = get_student_details(student_list)
@@ -28,8 +35,14 @@ def execute(filters=None):
for d in program_enrollments:
student_details = student_map.get(d.student)
- row = [group_roll_no_map.get(d.student), d.student, d.student_name, student_details.get("student_mobile_number"),\
- student_details.get("student_email_id"), student_details.get("address")]
+ row = [
+ group_roll_no_map.get(d.student),
+ d.student,
+ d.student_name,
+ student_details.get("student_mobile_number"),
+ student_details.get("student_email_id"),
+ student_details.get("address"),
+ ]
student_guardians = guardian_map.get(d.student)
@@ -63,32 +76,56 @@ def get_columns():
]
return columns
+
def get_student_details(student_list):
student_map = frappe._dict()
- student_details = frappe.db.sql('''
- select name, student_mobile_number, student_email_id, address_line_1, address_line_2, city, state from `tabStudent` where name in (%s)''' %
- ', '.join(['%s']*len(student_list)), tuple(student_list), as_dict=1)
+ student_details = frappe.db.sql(
+ """
+ select name, student_mobile_number, student_email_id, address_line_1, address_line_2, city, state from `tabStudent` where name in (%s)"""
+ % ", ".join(["%s"] * len(student_list)),
+ tuple(student_list),
+ as_dict=1,
+ )
for s in student_details:
student = frappe._dict()
student["student_mobile_number"] = s.student_mobile_number
student["student_email_id"] = s.student_email_id
- student["address"] = ', '.join([d for d in [s.address_line_1, s.address_line_2, s.city, s.state] if d])
+ student["address"] = ", ".join(
+ [d for d in [s.address_line_1, s.address_line_2, s.city, s.state] if d]
+ )
student_map[s.name] = student
return student_map
+
def get_guardian_map(student_list):
guardian_map = frappe._dict()
- guardian_details = frappe.db.sql('''
- select parent, guardian, guardian_name, relation from `tabStudent Guardian` where parent in (%s)''' %
- ', '.join(['%s']*len(student_list)), tuple(student_list), as_dict=1)
+ guardian_details = frappe.db.sql(
+ """
+ select parent, guardian, guardian_name, relation from `tabStudent Guardian` where parent in (%s)"""
+ % ", ".join(["%s"] * len(student_list)),
+ tuple(student_list),
+ as_dict=1,
+ )
- guardian_list = list(set([g.guardian for g in guardian_details])) or ['']
+ guardian_list = list(set([g.guardian for g in guardian_details])) or [""]
- guardian_mobile_no = dict(frappe.db.sql("""select name, mobile_number from `tabGuardian`
- where name in (%s)""" % ", ".join(['%s']*len(guardian_list)), tuple(guardian_list)))
+ guardian_mobile_no = dict(
+ frappe.db.sql(
+ """select name, mobile_number from `tabGuardian`
+ where name in (%s)"""
+ % ", ".join(["%s"] * len(guardian_list)),
+ tuple(guardian_list),
+ )
+ )
- guardian_email_id = dict(frappe.db.sql("""select name, email_address from `tabGuardian`
- where name in (%s)""" % ", ".join(['%s']*len(guardian_list)), tuple(guardian_list)))
+ guardian_email_id = dict(
+ frappe.db.sql(
+ """select name, email_address from `tabGuardian`
+ where name in (%s)"""
+ % ", ".join(["%s"] * len(guardian_list)),
+ tuple(guardian_list),
+ )
+ )
for guardian in guardian_details:
guardian["mobile_number"] = guardian_mobile_no.get(guardian.guardian)
@@ -97,11 +134,18 @@ def get_guardian_map(student_list):
return guardian_map
+
def get_student_roll_no(academic_year, program, batch):
- student_group = frappe.get_all("Student Group",
- filters={"academic_year":academic_year, "program":program, "batch":batch, "disabled": 0})
+ student_group = frappe.get_all(
+ "Student Group",
+ filters={"academic_year": academic_year, "program": program, "batch": batch, "disabled": 0},
+ )
if student_group:
- roll_no_dict = dict(frappe.db.sql('''select student, group_roll_number from `tabStudent Group Student` where parent=%s''',
- (student_group[0].name)))
+ roll_no_dict = dict(
+ frappe.db.sql(
+ """select student, group_roll_number from `tabStudent Group Student` where parent=%s""",
+ (student_group[0].name),
+ )
+ )
return roll_no_dict
return {}
diff --git a/erpnext/education/report/student_batch_wise_attendance/student_batch_wise_attendance.py b/erpnext/education/report/student_batch_wise_attendance/student_batch_wise_attendance.py
index 52055dceb8c..282f5c9aec4 100644
--- a/erpnext/education/report/student_batch_wise_attendance/student_batch_wise_attendance.py
+++ b/erpnext/education/report/student_batch_wise_attendance/student_batch_wise_attendance.py
@@ -11,14 +11,19 @@ from erpnext.hr.doctype.holiday_list.holiday_list import is_holiday
def execute(filters=None):
- if not filters: filters = {}
+ if not filters:
+ filters = {}
if not filters.get("date"):
msgprint(_("Please select date"), raise_exception=1)
holiday_list = get_holiday_list()
if is_holiday(holiday_list, filters.get("date")):
- msgprint(_("No attendance has been marked for {0} as it is a Holiday").format(frappe.bold(formatdate(filters.get("date")))))
+ msgprint(
+ _("No attendance has been marked for {0} as it is a Holiday").format(
+ frappe.bold(formatdate(filters.get("date")))
+ )
+ )
columns = get_columns(filters)
@@ -33,40 +38,54 @@ def execute(filters=None):
student_attendance = get_student_attendance(student_group.name, filters.get("date"))
if student_attendance:
for attendance in student_attendance:
- if attendance.status== "Present":
+ if attendance.status == "Present":
present_students = attendance.count
- elif attendance.status== "Absent":
+ elif attendance.status == "Absent":
absent_students = attendance.count
unmarked_students = student_group_strength - (present_students + absent_students)
- row+= [student_group_strength, present_students, absent_students, unmarked_students]
+ row += [student_group_strength, present_students, absent_students, unmarked_students]
data.append(row)
return columns, data
+
def get_columns(filters):
columns = [
_("Student Group") + ":Link/Student Group:250",
_("Student Group Strength") + "::170",
_("Present") + "::90",
_("Absent") + "::90",
- _("Not Marked") + "::90"
+ _("Not Marked") + "::90",
]
return columns
+
def get_active_student_group():
- active_student_groups = frappe.db.sql("""select name from `tabStudent Group` where group_based_on = "Batch"
- and academic_year=%s order by name""", (frappe.defaults.get_defaults().academic_year), as_dict=1)
+ active_student_groups = frappe.db.sql(
+ """select name from `tabStudent Group` where group_based_on = "Batch"
+ and academic_year=%s order by name""",
+ (frappe.defaults.get_defaults().academic_year),
+ as_dict=1,
+ )
return active_student_groups
+
def get_student_group_strength(student_group):
- student_group_strength = frappe.db.sql("""select count(*) from `tabStudent Group Student`
- where parent = %s and active=1""", student_group)[0][0]
+ student_group_strength = frappe.db.sql(
+ """select count(*) from `tabStudent Group Student`
+ where parent = %s and active=1""",
+ student_group,
+ )[0][0]
return student_group_strength
+
def get_student_attendance(student_group, date):
- student_attendance = frappe.db.sql("""select count(*) as count, status from `tabStudent Attendance` where
+ student_attendance = frappe.db.sql(
+ """select count(*) as count, status from `tabStudent Attendance` where
student_group= %s and date= %s and docstatus = 1 and
(course_schedule is Null or course_schedule='') group by status""",
- (student_group, date), as_dict=1)
+ (student_group, date),
+ as_dict=1,
+ )
return student_attendance
diff --git a/erpnext/education/report/student_monthly_attendance_sheet/student_monthly_attendance_sheet.py b/erpnext/education/report/student_monthly_attendance_sheet/student_monthly_attendance_sheet.py
index 1166a75b2cc..9312e2b0181 100644
--- a/erpnext/education/report/student_monthly_attendance_sheet/student_monthly_attendance_sheet.py
+++ b/erpnext/education/report/student_monthly_attendance_sheet/student_monthly_attendance_sheet.py
@@ -12,13 +12,14 @@ from erpnext.support.doctype.issue.issue import get_holidays
def execute(filters=None):
- if not filters: filters = {}
+ if not filters:
+ filters = {}
- from_date = get_first_day(filters["month"] + '-' + filters["year"])
- to_date = get_last_day(filters["month"] + '-' + filters["year"])
- total_days_in_month = date_diff(to_date, from_date) +1
+ from_date = get_first_day(filters["month"] + "-" + filters["year"])
+ to_date = get_last_day(filters["month"] + "-" + filters["year"])
+ total_days_in_month = date_diff(to_date, from_date) + 1
columns = get_columns(total_days_in_month)
- students = get_student_group_students(filters.get("student_group"),1)
+ students = get_student_group_students(filters.get("student_group"), 1)
students_list = get_students_list(students)
att_map = get_attendance_list(from_date, to_date, filters.get("student_group"), students_list)
data = []
@@ -30,7 +31,7 @@ def execute(filters=None):
total_p = total_a = 0.0
for day in range(total_days_in_month):
- status="None"
+ status = "None"
if att_map.get(stud.student):
status = att_map.get(stud.student).get(date, "None")
@@ -39,7 +40,7 @@ def execute(filters=None):
else:
status = "None"
- status_map = {"Present": "P", "Absent": "A", "None": "", "Inactive":"-", "Holiday":"H"}
+ status_map = {"Present": "P", "Absent": "A", "None": "", "Inactive": "-", "Holiday": "H"}
row.append(status_map[status])
if status == "Present":
@@ -52,33 +53,43 @@ def execute(filters=None):
data.append(row)
return columns, data
+
def get_columns(days_in_month):
- columns = [ _("Student") + ":Link/Student:90", _("Student Name") + "::150"]
+ columns = [_("Student") + ":Link/Student:90", _("Student Name") + "::150"]
for day in range(days_in_month):
- columns.append(cstr(day+1) +"::20")
+ columns.append(cstr(day + 1) + "::20")
columns += [_("Total Present") + ":Int:95", _("Total Absent") + ":Int:90"]
return columns
+
def get_students_list(students):
student_list = []
for stud in students:
student_list.append(stud.student)
return student_list
+
def get_attendance_list(from_date, to_date, student_group, students_list):
- attendance_list = frappe.db.sql('''select student, date, status
+ attendance_list = frappe.db.sql(
+ """select student, date, status
from `tabStudent Attendance` where student_group = %s
and docstatus = 1
and date between %s and %s
- order by student, date''',
- (student_group, from_date, to_date), as_dict=1)
+ order by student, date""",
+ (student_group, from_date, to_date),
+ as_dict=1,
+ )
att_map = {}
- students_with_leave_application = get_students_with_leave_application(from_date, to_date, students_list)
+ students_with_leave_application = get_students_with_leave_application(
+ from_date, to_date, students_list
+ )
for d in attendance_list:
att_map.setdefault(d.student, frappe._dict()).setdefault(d.date, "")
- if students_with_leave_application.get(d.date) and d.student in students_with_leave_application.get(d.date):
+ if students_with_leave_application.get(
+ d.date
+ ) and d.student in students_with_leave_application.get(d.date):
att_map[d.student][d.date] = "Present"
else:
att_map[d.student][d.date] = d.status
@@ -87,9 +98,12 @@ def get_attendance_list(from_date, to_date, student_group, students_list):
return att_map
+
def get_students_with_leave_application(from_date, to_date, students_list):
- if not students_list: return
- leave_applications = frappe.db.sql("""
+ if not students_list:
+ return
+ leave_applications = frappe.db.sql(
+ """
select student, from_date, to_date
from `tabStudent Leave Application`
where
@@ -100,29 +114,34 @@ def get_students_with_leave_application(from_date, to_date, students_list):
or to_date between %(from_date)s and %(to_date)s
or (%(from_date)s between from_date and to_date and %(to_date)s between from_date and to_date)
)
- """, {
- "students": students_list,
- "from_date": from_date,
- "to_date": to_date
- }, as_dict=True)
- students_with_leaves= {}
+ """,
+ {"students": students_list, "from_date": from_date, "to_date": to_date},
+ as_dict=True,
+ )
+ students_with_leaves = {}
for application in leave_applications:
for date in daterange(application.from_date, application.to_date):
students_with_leaves.setdefault(date, []).append(application.student)
return students_with_leaves
+
def daterange(d1, d2):
import datetime
+
return (d1 + datetime.timedelta(days=i) for i in range((d2 - d1).days + 1))
+
@frappe.whitelist()
def get_attendance_years():
- year_list = frappe.db.sql_list('''select distinct YEAR(date) from `tabStudent Attendance` ORDER BY YEAR(date) DESC''')
+ year_list = frappe.db.sql_list(
+ """select distinct YEAR(date) from `tabStudent Attendance` ORDER BY YEAR(date) DESC"""
+ )
if not year_list:
year_list = [getdate().year]
return "\n".join(str(year) for year in year_list)
+
def mark_holidays(att_map, from_date, to_date, students_list):
holiday_list = get_holiday_list()
holidays = get_holidays(holiday_list)
diff --git a/erpnext/education/setup.py b/erpnext/education/setup.py
index 46620088dfd..98b4ddfc323 100644
--- a/erpnext/education/setup.py
+++ b/erpnext/education/setup.py
@@ -14,6 +14,7 @@ def setup_education():
return
create_academic_sessions()
+
def create_academic_sessions():
data = [
{"doctype": "Academic Year", "academic_year_name": "2015-16"},
@@ -23,10 +24,11 @@ def create_academic_sessions():
{"doctype": "Academic Term", "academic_year": "2016-17", "term_name": "Semester 1"},
{"doctype": "Academic Term", "academic_year": "2016-17", "term_name": "Semester 2"},
{"doctype": "Academic Term", "academic_year": "2017-18", "term_name": "Semester 1"},
- {"doctype": "Academic Term", "academic_year": "2017-18", "term_name": "Semester 2"}
+ {"doctype": "Academic Term", "academic_year": "2017-18", "term_name": "Semester 2"},
]
insert_record(data)
+
def disable_desk_access_for_student_role():
try:
student_role = frappe.get_doc("Role", "Student")
@@ -37,11 +39,9 @@ def disable_desk_access_for_student_role():
student_role.desk_access = 0
student_role.save()
+
def create_student_role():
- student_role = frappe.get_doc({
- "doctype": "Role",
- "role_name": "Student",
- "desk_access": 0,
- "restrict_to_domain": "Education"
- })
+ student_role = frappe.get_doc(
+ {"doctype": "Role", "role_name": "Student", "desk_access": 0, "restrict_to_domain": "Education"}
+ )
student_role.insert()
diff --git a/erpnext/education/utils.py b/erpnext/education/utils.py
index a7a15d18ce8..e6eb1c99874 100644
--- a/erpnext/education/utils.py
+++ b/erpnext/education/utils.py
@@ -4,7 +4,9 @@ import frappe
from frappe import _
-class OverlapError(frappe.ValidationError): pass
+class OverlapError(frappe.ValidationError):
+ pass
+
def validate_overlap_for(doc, doctype, fieldname, value=None):
"""Checks overlap for specified field.
@@ -14,8 +16,16 @@ def validate_overlap_for(doc, doctype, fieldname, value=None):
existing = get_overlap_for(doc, doctype, fieldname, value)
if existing:
- frappe.throw(_("This {0} conflicts with {1} for {2} {3}").format(doc.doctype, existing.name,
- doc.meta.get_label(fieldname) if not value else fieldname , value or doc.get(fieldname)), OverlapError)
+ frappe.throw(
+ _("This {0} conflicts with {1} for {2} {3}").format(
+ doc.doctype,
+ existing.name,
+ doc.meta.get_label(fieldname) if not value else fieldname,
+ value or doc.get(fieldname),
+ ),
+ OverlapError,
+ )
+
def get_overlap_for(doc, doctype, fieldname, value=None):
"""Returns overlaping document for specified field.
@@ -23,45 +33,54 @@ def get_overlap_for(doc, doctype, fieldname, value=None):
:param fieldname: Checks Overlap for this field
"""
- existing = frappe.db.sql("""select name, from_time, to_time from `tab{0}`
+ existing = frappe.db.sql(
+ """select name, from_time, to_time from `tab{0}`
where `{1}`=%(val)s and schedule_date = %(schedule_date)s and
(
(from_time > %(from_time)s and from_time < %(to_time)s) or
(to_time > %(from_time)s and to_time < %(to_time)s) or
(%(from_time)s > from_time and %(from_time)s < to_time) or
(%(from_time)s = from_time and %(to_time)s = to_time))
- and name!=%(name)s and docstatus!=2""".format(doctype, fieldname),
+ and name!=%(name)s and docstatus!=2""".format(
+ doctype, fieldname
+ ),
{
"schedule_date": doc.schedule_date,
"val": value or doc.get(fieldname),
"from_time": doc.from_time,
"to_time": doc.to_time,
- "name": doc.name or "No Name"
- }, as_dict=True)
+ "name": doc.name or "No Name",
+ },
+ as_dict=True,
+ )
return existing[0] if existing else None
def validate_duplicate_student(students):
- unique_students= []
+ unique_students = []
for stud in students:
if stud.student in unique_students:
- frappe.throw(_("Student {0} - {1} appears Multiple times in row {2} & {3}")
- .format(stud.student, stud.student_name, unique_students.index(stud.student)+1, stud.idx))
+ frappe.throw(
+ _("Student {0} - {1} appears Multiple times in row {2} & {3}").format(
+ stud.student, stud.student_name, unique_students.index(stud.student) + 1, stud.idx
+ )
+ )
else:
unique_students.append(stud.student)
return None
+
# LMS Utils
def get_current_student():
"""Returns current student from frappe.session.user
Returns:
- object: Student Document
+ object: Student Document
"""
email = frappe.session.user
- if email in ('Administrator', 'Guest'):
+ if email in ("Administrator", "Guest"):
return None
try:
student_id = frappe.get_all("Student", {"student_email_id": email}, ["name"])[0].name
@@ -69,74 +88,86 @@ def get_current_student():
except (IndexError, frappe.DoesNotExistError):
return None
+
def get_portal_programs():
"""Returns a list of all program to be displayed on the portal
Programs are returned based on the following logic
- is_published and (student_is_enrolled or student_can_self_enroll)
+ is_published and (student_is_enrolled or student_can_self_enroll)
Returns:
- list of dictionary: List of all programs and to be displayed on the portal along with access rights
+ list of dictionary: List of all programs and to be displayed on the portal along with access rights
"""
published_programs = frappe.get_all("Program", filters={"is_published": True})
if not published_programs:
return None
program_list = [frappe.get_doc("Program", program) for program in published_programs]
- portal_programs = [{'program': program, 'has_access': allowed_program_access(program.name)} for program in program_list if allowed_program_access(program.name) or program.allow_self_enroll]
+ portal_programs = [
+ {"program": program, "has_access": allowed_program_access(program.name)}
+ for program in program_list
+ if allowed_program_access(program.name) or program.allow_self_enroll
+ ]
return portal_programs
+
def allowed_program_access(program, student=None):
"""Returns enrollment status for current student
Args:
- program (string): Name of the program
- student (object): instance of Student document
+ program (string): Name of the program
+ student (object): instance of Student document
Returns:
- bool: Is current user enrolled or not
+ bool: Is current user enrolled or not
"""
if has_super_access():
return True
if not student:
student = get_current_student()
- if student and get_enrollment('program', program, student.name):
+ if student and get_enrollment("program", program, student.name):
return True
else:
return False
+
def get_enrollment(master, document, student):
"""Gets enrollment for course or program
Args:
- master (string): can either be program or course
- document (string): program or course name
- student (string): Student ID
+ master (string): can either be program or course
+ document (string): program or course name
+ student (string): Student ID
Returns:
- string: Enrollment Name if exists else returns empty string
+ string: Enrollment Name if exists else returns empty string
"""
- if master == 'program':
- enrollments = frappe.get_all("Program Enrollment", filters={'student':student, 'program': document, 'docstatus': 1})
- if master == 'course':
- enrollments = frappe.get_all("Course Enrollment", filters={'student':student, 'course': document})
+ if master == "program":
+ enrollments = frappe.get_all(
+ "Program Enrollment", filters={"student": student, "program": document, "docstatus": 1}
+ )
+ if master == "course":
+ enrollments = frappe.get_all(
+ "Course Enrollment", filters={"student": student, "course": document}
+ )
if enrollments:
return enrollments[0].name
else:
return None
+
@frappe.whitelist()
def enroll_in_program(program_name, student=None):
"""Enroll student in program
Args:
- program_name (string): Name of the program to be enrolled into
- student (string, optional): name of student who has to be enrolled, if not
- provided, a student will be created from the current user
+ program_name (string): Name of the program to be enrolled into
+ student (string, optional): name of student who has to be enrolled, if not
+ provided, a student will be created from the current user
Returns:
- string: name of the program enrollment document
+ string: name of the program enrollment document
"""
if has_super_access():
return
@@ -145,7 +176,7 @@ def enroll_in_program(program_name, student=None):
student = frappe.get_doc("Student", student)
else:
# Check if self enrollment in allowed
- program = frappe.get_doc('Program', program_name)
+ program = frappe.get_doc("Program", program_name)
if not program.allow_self_enroll:
return frappe.throw(_("You are not allowed to enroll for this course"))
@@ -154,12 +185,12 @@ def enroll_in_program(program_name, student=None):
student = create_student_from_current_user()
# Check if student is already enrolled in program
- enrollment = get_enrollment('program', program_name, student.name)
+ enrollment = get_enrollment("program", program_name, student.name)
if enrollment:
return enrollment
# Check if self enrollment in allowed
- program = frappe.get_doc('Program', program_name)
+ program = frappe.get_doc("Program", program_name)
if not program.allow_self_enroll:
return frappe.throw(_("You are not allowed to enroll for this course"))
@@ -167,15 +198,19 @@ def enroll_in_program(program_name, student=None):
program_enrollment = student.enroll_in_program(program_name)
return program_enrollment.name
+
def has_super_access():
"""Check if user has a role that allows full access to LMS
Returns:
- bool: true if user has access to all lms content
+ bool: true if user has access to all lms content
"""
- current_user = frappe.get_doc('User', frappe.session.user)
+ current_user = frappe.get_doc("User", frappe.session.user)
roles = set([role.role for role in current_user.roles])
- return bool(roles & {'Administrator', 'Instructor', 'Education Manager', 'System Manager', 'Academic User'})
+ return bool(
+ roles & {"Administrator", "Instructor", "Education Manager", "System Manager", "Academic User"}
+ )
+
@frappe.whitelist()
def add_activity(course, content_type, content, program):
@@ -184,14 +219,17 @@ def add_activity(course, content_type, content, program):
student = get_current_student()
if not student:
- return frappe.throw(_("Student with email {0} does not exist").format(frappe.session.user), frappe.DoesNotExistError)
+ return frappe.throw(
+ _("Student with email {0} does not exist").format(frappe.session.user), frappe.DoesNotExistError
+ )
enrollment = get_or_create_course_enrollment(course, program)
- if content_type == 'Quiz':
+ if content_type == "Quiz":
return
else:
return enrollment.add_activity(content_type, content)
+
@frappe.whitelist()
def evaluate_quiz(quiz_response, quiz_name, course, program, time_taken):
import json
@@ -203,16 +241,17 @@ def evaluate_quiz(quiz_response, quiz_name, course, program, time_taken):
result, score, status = quiz.evaluate(quiz_response, quiz_name)
if has_super_access():
- return {'result': result, 'score': score, 'status': status}
+ return {"result": result, "score": score, "status": status}
if student:
enrollment = get_or_create_course_enrollment(course, program)
if quiz.allowed_attempt(enrollment, quiz_name):
enrollment.add_quiz_activity(quiz_name, quiz_response, result, score, status, time_taken)
- return {'result': result, 'score': score, 'status': status}
+ return {"result": result, "score": score, "status": status}
else:
return None
+
@frappe.whitelist()
def get_quiz(quiz_name, course):
try:
@@ -222,37 +261,40 @@ def get_quiz(quiz_name, course):
frappe.throw(_("Quiz {0} does not exist").format(quiz_name), frappe.DoesNotExistError)
return None
- questions = [{
- 'name': question.name,
- 'question': question.question,
- 'type': question.question_type,
- 'options': [{'name': option.name, 'option': option.option}
- for option in question.options],
- } for question in questions]
+ questions = [
+ {
+ "name": question.name,
+ "question": question.question,
+ "type": question.question_type,
+ "options": [{"name": option.name, "option": option.option} for option in question.options],
+ }
+ for question in questions
+ ]
if has_super_access():
return {
- 'questions': questions,
- 'activity': None,
- 'is_time_bound': quiz.is_time_bound,
- 'duration': quiz.duration
+ "questions": questions,
+ "activity": None,
+ "is_time_bound": quiz.is_time_bound,
+ "duration": quiz.duration,
}
student = get_current_student()
course_enrollment = get_enrollment("course", course, student.name)
status, score, result, time_taken = check_quiz_completion(quiz, course_enrollment)
return {
- 'questions': questions,
- 'activity': {'is_complete': status, 'score': score, 'result': result, 'time_taken': time_taken},
- 'is_time_bound': quiz.is_time_bound,
- 'duration': quiz.duration
+ "questions": questions,
+ "activity": {"is_complete": status, "score": score, "result": result, "time_taken": time_taken},
+ "is_time_bound": quiz.is_time_bound,
+ "duration": quiz.duration,
}
+
def get_topic_progress(topic, course_name, program):
"""
Return the porgress of a course in a program as well as the content to continue from.
- :param topic_name:
- :param course_name:
+ :param topic_name:
+ :param course_name:
"""
student = get_current_student()
if not student:
@@ -261,19 +303,20 @@ def get_topic_progress(topic, course_name, program):
progress = student.get_topic_progress(course_enrollment.name, topic)
if not progress:
return None
- count = sum([activity['is_complete'] for activity in progress])
+ count = sum([activity["is_complete"] for activity in progress])
if count == 0:
- return {'completed': False, 'started': False}
+ return {"completed": False, "started": False}
elif count == len(progress):
- return {'completed': True, 'started': True}
+ return {"completed": True, "started": True}
elif count < len(progress):
- return {'completed': False, 'started': True}
+ return {"completed": False, "started": True}
+
def get_course_progress(course, program):
"""
Return the porgress of a course in a program as well as the content to continue from.
- :param topic_name:
- :param course_name:
+ :param topic_name:
+ :param course_name:
"""
course_progress = []
for course_topic in course.topics:
@@ -282,19 +325,20 @@ def get_course_progress(course, program):
if progress:
course_progress.append(progress)
if course_progress:
- number_of_completed_topics = sum([activity['completed'] for activity in course_progress])
+ number_of_completed_topics = sum([activity["completed"] for activity in course_progress])
total_topics = len(course_progress)
if total_topics == 1:
return course_progress[0]
if number_of_completed_topics == 0:
- return {'completed': False, 'started': False}
+ return {"completed": False, "started": False}
if number_of_completed_topics == total_topics:
- return {'completed': True, 'started': True}
+ return {"completed": True, "started": True}
if number_of_completed_topics < total_topics:
- return {'completed': False, 'started': True}
+ return {"completed": False, "started": True}
return None
+
def get_program_progress(program):
program_progress = []
if not program.courses:
@@ -303,8 +347,8 @@ def get_program_progress(program):
course = frappe.get_doc("Course", program_course.course)
progress = get_course_progress(course, program.name)
if progress:
- progress['name'] = course.name
- progress['course'] = course.course_name
+ progress["name"] = course.name
+ progress["course"] = course.course_name
program_progress.append(progress)
if program_progress:
@@ -312,81 +356,94 @@ def get_program_progress(program):
return None
+
def get_program_completion(program):
- topics = frappe.db.sql("""select `tabCourse Topic`.topic, `tabCourse Topic`.parent
+ topics = frappe.db.sql(
+ """select `tabCourse Topic`.topic, `tabCourse Topic`.parent
from `tabCourse Topic`,
`tabProgram Course`
where `tabCourse Topic`.parent = `tabProgram Course`.course
- and `tabProgram Course`.parent = %s""", program.name)
+ and `tabProgram Course`.parent = %s""",
+ program.name,
+ )
progress = []
for topic in topics:
- topic_doc = frappe.get_doc('Topic', topic[0])
+ topic_doc = frappe.get_doc("Topic", topic[0])
topic_progress = get_topic_progress(topic_doc, topic[1], program.name)
if topic_progress:
progress.append(topic_progress)
if progress:
- number_of_completed_topics = sum([activity['completed'] for activity in progress if activity])
+ number_of_completed_topics = sum([activity["completed"] for activity in progress if activity])
total_topics = len(progress)
try:
- return int((float(number_of_completed_topics)/total_topics)*100)
+ return int((float(number_of_completed_topics) / total_topics) * 100)
except ZeroDivisionError:
return 0
return 0
+
def create_student_from_current_user():
user = frappe.get_doc("User", frappe.session.user)
- student = frappe.get_doc({
- "doctype": "Student",
- "first_name": user.first_name,
- "last_name": user.last_name,
- "student_email_id": user.email,
- "user": frappe.session.user
- })
+ student = frappe.get_doc(
+ {
+ "doctype": "Student",
+ "first_name": user.first_name,
+ "last_name": user.last_name,
+ "student_email_id": user.email,
+ "user": frappe.session.user,
+ }
+ )
student.save(ignore_permissions=True)
return student
+
def get_or_create_course_enrollment(course, program):
student = get_current_student()
course_enrollment = get_enrollment("course", course, student.name)
if not course_enrollment:
- program_enrollment = get_enrollment('program', program.name, student.name)
+ program_enrollment = get_enrollment("program", program.name, student.name)
if not program_enrollment:
frappe.throw(_("You are not enrolled in program {0}").format(program))
return
- return student.enroll_in_course(course_name=course, program_enrollment=get_enrollment('program', program.name, student.name))
+ return student.enroll_in_course(
+ course_name=course, program_enrollment=get_enrollment("program", program.name, student.name)
+ )
else:
- return frappe.get_doc('Course Enrollment', course_enrollment)
+ return frappe.get_doc("Course Enrollment", course_enrollment)
+
def check_content_completion(content_name, content_type, enrollment_name):
- activity = frappe.get_all("Course Activity", filters={'enrollment': enrollment_name, 'content_type': content_type, 'content': content_name})
+ activity = frappe.get_all(
+ "Course Activity",
+ filters={"enrollment": enrollment_name, "content_type": content_type, "content": content_name},
+ )
if activity:
return True
else:
return False
+
def check_quiz_completion(quiz, enrollment_name):
- attempts = frappe.get_all("Quiz Activity",
- filters={
- 'enrollment': enrollment_name,
- 'quiz': quiz.name
- },
- fields=["name", "activity_date", "score", "status", "time_taken"]
+ attempts = frappe.get_all(
+ "Quiz Activity",
+ filters={"enrollment": enrollment_name, "quiz": quiz.name},
+ fields=["name", "activity_date", "score", "status", "time_taken"],
)
status = False if quiz.max_attempts == 0 else bool(len(attempts) >= quiz.max_attempts)
score = None
result = None
time_taken = None
if attempts:
- if quiz.grading_basis == 'Last Highest Score':
- attempts = sorted(attempts, key = lambda i: int(i.score), reverse=True)
- score = attempts[0]['score']
- result = attempts[0]['status']
- time_taken = attempts[0]['time_taken']
- if result == 'Pass':
+ if quiz.grading_basis == "Last Highest Score":
+ attempts = sorted(attempts, key=lambda i: int(i.score), reverse=True)
+ score = attempts[0]["score"]
+ result = attempts[0]["status"]
+ time_taken = attempts[0]["time_taken"]
+ if result == "Pass":
status = True
return status, score, result, time_taken
diff --git a/erpnext/education/web_form/student_applicant/student_applicant.py b/erpnext/education/web_form/student_applicant/student_applicant.py
index 19b550feea7..02e3e933330 100644
--- a/erpnext/education/web_form/student_applicant/student_applicant.py
+++ b/erpnext/education/web_form/student_applicant/student_applicant.py
@@ -1,5 +1,3 @@
-
-
def get_context(context):
# do your magic here
pass
diff --git a/erpnext/erpnext_integrations/connectors/shopify_connection.py b/erpnext/erpnext_integrations/connectors/shopify_connection.py
index dbf10c8491f..f28afbcd83a 100644
--- a/erpnext/erpnext_integrations/connectors/shopify_connection.py
+++ b/erpnext/erpnext_integrations/connectors/shopify_connection.py
@@ -1,10 +1,10 @@
-
import json
import frappe
from frappe import _
from frappe.utils import cint, cstr, flt, get_datetime, get_request_session, getdate, nowdate
+from erpnext import get_company_currency
from erpnext.erpnext_integrations.doctype.shopify_log.shopify_log import (
dump_request_data,
make_shopify_log,
@@ -22,20 +22,21 @@ from erpnext.selling.doctype.sales_order.sales_order import make_delivery_note,
@frappe.whitelist(allow_guest=True)
-@validate_webhooks_request("Shopify Settings", 'X-Shopify-Hmac-Sha256', secret_key='shared_secret')
+@validate_webhooks_request("Shopify Settings", "X-Shopify-Hmac-Sha256", secret_key="shared_secret")
def store_request_data(order=None, event=None):
if frappe.request:
order = json.loads(frappe.request.data)
- event = frappe.request.headers.get('X-Shopify-Topic')
+ event = frappe.request.headers.get("X-Shopify-Topic")
dump_request_data(order, event)
+
def sync_sales_order(order, request_id=None, old_order_sync=False):
- frappe.set_user('Administrator')
+ frappe.set_user("Administrator")
shopify_settings = frappe.get_doc("Shopify Settings")
frappe.flags.request_id = request_id
- if not frappe.db.get_value("Sales Order", filters={"shopify_order_id": cstr(order['id'])}):
+ if not frappe.db.get_value("Sales Order", filters={"shopify_order_id": cstr(order["id"])}):
try:
validate_customer(order, shopify_settings)
validate_item(order, shopify_settings)
@@ -46,49 +47,57 @@ def sync_sales_order(order, request_id=None, old_order_sync=False):
else:
make_shopify_log(status="Success")
+
def prepare_sales_invoice(order, request_id=None):
- frappe.set_user('Administrator')
+ frappe.set_user("Administrator")
shopify_settings = frappe.get_doc("Shopify Settings")
frappe.flags.request_id = request_id
try:
- sales_order = get_sales_order(cstr(order['id']))
+ sales_order = get_sales_order(cstr(order["id"]))
if sales_order:
create_sales_invoice(order, shopify_settings, sales_order)
make_shopify_log(status="Success")
except Exception as e:
make_shopify_log(status="Error", exception=e, rollback=True)
+
def prepare_delivery_note(order, request_id=None):
- frappe.set_user('Administrator')
+ frappe.set_user("Administrator")
shopify_settings = frappe.get_doc("Shopify Settings")
frappe.flags.request_id = request_id
try:
- sales_order = get_sales_order(cstr(order['id']))
+ sales_order = get_sales_order(cstr(order["id"]))
if sales_order:
create_delivery_note(order, shopify_settings, sales_order)
make_shopify_log(status="Success")
except Exception as e:
make_shopify_log(status="Error", exception=e, rollback=True)
+
def get_sales_order(shopify_order_id):
sales_order = frappe.db.get_value("Sales Order", filters={"shopify_order_id": shopify_order_id})
if sales_order:
so = frappe.get_doc("Sales Order", sales_order)
return so
+
def validate_customer(order, shopify_settings):
customer_id = order.get("customer", {}).get("id")
if customer_id:
if not frappe.db.get_value("Customer", {"shopify_customer_id": customer_id}, "name"):
create_customer(order.get("customer"), shopify_settings)
+
def validate_item(order, shopify_settings):
for item in order.get("line_items"):
- if item.get("product_id") and not frappe.db.get_value("Item", {"shopify_product_id": item.get("product_id")}, "name"):
+ if item.get("product_id") and not frappe.db.get_value(
+ "Item", {"shopify_product_id": item.get("product_id")}, "name"
+ ):
sync_item_from_shopify(shopify_settings, item)
+
def create_order(order, shopify_settings, old_order_sync=False, company=None):
so = create_sales_order(order, shopify_settings, company)
if so:
@@ -98,44 +107,52 @@ def create_order(order, shopify_settings, old_order_sync=False, company=None):
if order.get("fulfillments") and not old_order_sync:
create_delivery_note(order, shopify_settings, so)
+
def create_sales_order(shopify_order, shopify_settings, company=None):
product_not_exists = []
- customer = frappe.db.get_value("Customer", {"shopify_customer_id": shopify_order.get("customer", {}).get("id")}, "name")
+ customer = frappe.db.get_value(
+ "Customer", {"shopify_customer_id": shopify_order.get("customer", {}).get("id")}, "name"
+ )
so = frappe.db.get_value("Sales Order", {"shopify_order_id": shopify_order.get("id")}, "name")
if not so:
- items = get_order_items(shopify_order.get("line_items"), shopify_settings, getdate(shopify_order.get('created_at')))
+ items = get_order_items(
+ shopify_order.get("line_items"), shopify_settings, getdate(shopify_order.get("created_at"))
+ )
if not items:
- message = 'Following items exists in the shopify order but relevant records were not found in the shopify Product master'
+ message = "Following items exists in the shopify order but relevant records were not found in the shopify Product master"
message += "\n" + ", ".join(product_not_exists)
make_shopify_log(status="Error", exception=message, rollback=True)
- return ''
+ return ""
- so = frappe.get_doc({
- "doctype": "Sales Order",
- "naming_series": shopify_settings.sales_order_series or "SO-Shopify-",
- "shopify_order_id": shopify_order.get("id"),
- "shopify_order_number": shopify_order.get("name"),
- "customer": customer or shopify_settings.default_customer,
- "transaction_date": getdate(shopify_order.get("created_at")) or nowdate(),
- "delivery_date": getdate(shopify_order.get("created_at")) or nowdate(),
- "company": shopify_settings.company,
- "selling_price_list": shopify_settings.price_list,
- "ignore_pricing_rule": 1,
- "items": items,
- "taxes": get_order_taxes(shopify_order, shopify_settings),
- "apply_discount_on": "Grand Total",
- "discount_amount": get_discounted_amount(shopify_order),
- })
+ so = frappe.get_doc(
+ {
+ "doctype": "Sales Order",
+ "naming_series": shopify_settings.sales_order_series or "SO-Shopify-",
+ "shopify_order_id": shopify_order.get("id"),
+ "shopify_order_number": shopify_order.get("name"),
+ "customer": customer or shopify_settings.default_customer,
+ "transaction_date": getdate(shopify_order.get("created_at")) or nowdate(),
+ "delivery_date": getdate(shopify_order.get("created_at")) or nowdate(),
+ "company": shopify_settings.company,
+ "selling_price_list": shopify_settings.price_list,
+ "ignore_pricing_rule": 1,
+ "items": items,
+ "taxes": get_order_taxes(shopify_order, shopify_settings),
+ "apply_discount_on": "Grand Total",
+ "discount_amount": get_discounted_amount(shopify_order),
+ "currency": frappe.get_value(
+ "Customer", customer or shopify_settings.default_customer, "default_currency"
+ )
+ or get_company_currency(shopify_settings.company),
+ }
+ )
if company:
- so.update({
- "company": company,
- "status": "Draft"
- })
+ so.update({"company": company, "status": "Draft"})
so.flags.ignore_mandatory = True
so.save(ignore_permissions=True)
so.submit()
@@ -146,12 +163,17 @@ def create_sales_order(shopify_order, shopify_settings, company=None):
frappe.db.commit()
return so
+
def create_sales_invoice(shopify_order, shopify_settings, so, old_order_sync=False):
- if not frappe.db.get_value("Sales Invoice", {"shopify_order_id": shopify_order.get("id")}, "name")\
- and so.docstatus==1 and not so.per_billed and cint(shopify_settings.sync_sales_invoice):
+ if (
+ not frappe.db.get_value("Sales Invoice", {"shopify_order_id": shopify_order.get("id")}, "name")
+ and so.docstatus == 1
+ and not so.per_billed
+ and cint(shopify_settings.sync_sales_invoice)
+ ):
if old_order_sync:
- posting_date = getdate(shopify_order.get('created_at'))
+ posting_date = getdate(shopify_order.get("created_at"))
else:
posting_date = nowdate()
@@ -161,6 +183,7 @@ def create_sales_invoice(shopify_order, shopify_settings, so, old_order_sync=Fal
si.set_posting_time = 1
si.posting_date = posting_date
si.due_date = posting_date
+ si.currency = so.currency
si.naming_series = shopify_settings.sales_invoice_series or "SI-Shopify-"
si.flags.ignore_mandatory = True
set_cost_center(si.items, shopify_settings.cost_center)
@@ -169,13 +192,18 @@ def create_sales_invoice(shopify_order, shopify_settings, so, old_order_sync=Fal
make_payament_entry_against_sales_invoice(si, shopify_settings, posting_date)
frappe.db.commit()
+
def set_cost_center(items, cost_center):
for item in items:
item.cost_center = cost_center
+
def make_payament_entry_against_sales_invoice(doc, shopify_settings, posting_date=None):
from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry
- payment_entry = get_payment_entry(doc.doctype, doc.name, bank_account=shopify_settings.cash_bank_account)
+
+ payment_entry = get_payment_entry(
+ doc.doctype, doc.name, bank_account=shopify_settings.cash_bank_account
+ )
payment_entry.flags.ignore_mandatory = True
payment_entry.reference_no = doc.name
payment_entry.posting_date = posting_date or nowdate()
@@ -183,13 +211,18 @@ def make_payament_entry_against_sales_invoice(doc, shopify_settings, posting_dat
payment_entry.insert(ignore_permissions=True)
payment_entry.submit()
+
def create_delivery_note(shopify_order, shopify_settings, so):
if not cint(shopify_settings.sync_delivery_note):
return
for fulfillment in shopify_order.get("fulfillments"):
- if not frappe.db.get_value("Delivery Note", {"shopify_fulfillment_id": fulfillment.get("id")}, "name")\
- and so.docstatus==1:
+ if (
+ not frappe.db.get_value(
+ "Delivery Note", {"shopify_fulfillment_id": fulfillment.get("id")}, "name"
+ )
+ and so.docstatus == 1
+ ):
dn = make_delivery_note(so.name)
dn.shopify_order_id = fulfillment.get("order_id")
@@ -204,9 +237,15 @@ def create_delivery_note(shopify_order, shopify_settings, so):
dn.submit()
frappe.db.commit()
+
def get_fulfillment_items(dn_items, fulfillment_items, shopify_settings):
- return [dn_item.update({"qty": item.get("quantity")}) for item in fulfillment_items for dn_item in dn_items\
- if get_item_code(item) == dn_item.item_code]
+ return [
+ dn_item.update({"qty": item.get("quantity")})
+ for item in fulfillment_items
+ for dn_item in dn_items
+ if get_item_code(item) == dn_item.item_code
+ ]
+
def get_discounted_amount(order):
discounted_amount = 0.0
@@ -214,98 +253,120 @@ def get_discounted_amount(order):
discounted_amount += flt(discount.get("amount"))
return discounted_amount
+
def get_order_items(order_items, shopify_settings, delivery_date):
items = []
all_product_exists = True
product_not_exists = []
for shopify_item in order_items:
- if not shopify_item.get('product_exists'):
+ if not shopify_item.get("product_exists"):
all_product_exists = False
- product_not_exists.append({'title':shopify_item.get('title'),
- 'shopify_order_id': shopify_item.get('id')})
+ product_not_exists.append(
+ {"title": shopify_item.get("title"), "shopify_order_id": shopify_item.get("id")}
+ )
continue
if all_product_exists:
item_code = get_item_code(shopify_item)
- items.append({
- "item_code": item_code,
- "item_name": shopify_item.get("name"),
- "rate": shopify_item.get("price"),
- "delivery_date": delivery_date,
- "qty": shopify_item.get("quantity"),
- "stock_uom": shopify_item.get("uom") or _("Nos"),
- "warehouse": shopify_settings.warehouse
- })
+ items.append(
+ {
+ "item_code": item_code,
+ "item_name": shopify_item.get("name"),
+ "rate": shopify_item.get("price"),
+ "delivery_date": delivery_date,
+ "qty": shopify_item.get("quantity"),
+ "stock_uom": shopify_item.get("uom") or _("Nos"),
+ "warehouse": shopify_settings.warehouse,
+ }
+ )
else:
items = []
return items
+
def get_item_code(shopify_item):
- item_code = frappe.db.get_value("Item", {"shopify_variant_id": shopify_item.get("variant_id")}, "item_code")
+ item_code = frappe.db.get_value(
+ "Item", {"shopify_variant_id": shopify_item.get("variant_id")}, "item_code"
+ )
if not item_code:
- item_code = frappe.db.get_value("Item", {"shopify_product_id": shopify_item.get("product_id")}, "item_code")
+ item_code = frappe.db.get_value(
+ "Item", {"shopify_product_id": shopify_item.get("product_id")}, "item_code"
+ )
if not item_code:
item_code = frappe.db.get_value("Item", {"item_name": shopify_item.get("title")}, "item_code")
return item_code
+
def get_order_taxes(shopify_order, shopify_settings):
taxes = []
for tax in shopify_order.get("tax_lines"):
- taxes.append({
- "charge_type": _("On Net Total"),
- "account_head": get_tax_account_head(tax),
- "description": "{0} - {1}%".format(tax.get("title"), tax.get("rate") * 100.0),
- "rate": tax.get("rate") * 100.00,
- "included_in_print_rate": 1 if shopify_order.get("taxes_included") else 0,
- "cost_center": shopify_settings.cost_center
- })
+ taxes.append(
+ {
+ "charge_type": _("On Net Total"),
+ "account_head": get_tax_account_head(tax),
+ "description": "{0} - {1}%".format(tax.get("title"), tax.get("rate") * 100.0),
+ "rate": tax.get("rate") * 100.00,
+ "included_in_print_rate": 1 if shopify_order.get("taxes_included") else 0,
+ "cost_center": shopify_settings.cost_center,
+ }
+ )
- taxes = update_taxes_with_shipping_lines(taxes, shopify_order.get("shipping_lines"), shopify_settings)
+ taxes = update_taxes_with_shipping_lines(
+ taxes, shopify_order.get("shipping_lines"), shopify_settings
+ )
return taxes
+
def update_taxes_with_shipping_lines(taxes, shipping_lines, shopify_settings):
"""Shipping lines represents the shipping details,
- each such shipping detail consists of a list of tax_lines"""
+ each such shipping detail consists of a list of tax_lines"""
for shipping_charge in shipping_lines:
if shipping_charge.get("price"):
- taxes.append({
- "charge_type": _("Actual"),
- "account_head": get_tax_account_head(shipping_charge),
- "description": shipping_charge["title"],
- "tax_amount": shipping_charge["price"],
- "cost_center": shopify_settings.cost_center
- })
+ taxes.append(
+ {
+ "charge_type": _("Actual"),
+ "account_head": get_tax_account_head(shipping_charge),
+ "description": shipping_charge["title"],
+ "tax_amount": shipping_charge["price"],
+ "cost_center": shopify_settings.cost_center,
+ }
+ )
for tax in shipping_charge.get("tax_lines"):
- taxes.append({
- "charge_type": _("Actual"),
- "account_head": get_tax_account_head(tax),
- "description": tax["title"],
- "tax_amount": tax["price"],
- "cost_center": shopify_settings.cost_center
- })
+ taxes.append(
+ {
+ "charge_type": _("Actual"),
+ "account_head": get_tax_account_head(tax),
+ "description": tax["title"],
+ "tax_amount": tax["price"],
+ "cost_center": shopify_settings.cost_center,
+ }
+ )
return taxes
+
def get_tax_account_head(tax):
tax_title = tax.get("title").encode("utf-8")
- tax_account = frappe.db.get_value("Shopify Tax Account", \
- {"parent": "Shopify Settings", "shopify_tax": tax_title}, "tax_account")
+ tax_account = frappe.db.get_value(
+ "Shopify Tax Account", {"parent": "Shopify Settings", "shopify_tax": tax_title}, "tax_account"
+ )
if not tax_account:
frappe.throw(_("Tax Account not specified for Shopify Tax {0}").format(tax.get("title")))
return tax_account
+
@frappe.whitelist(allow_guest=True)
def sync_old_orders():
- frappe.set_user('Administrator')
- shopify_settings = frappe.get_doc('Shopify Settings')
+ frappe.set_user("Administrator")
+ shopify_settings = frappe.get_doc("Shopify Settings")
if not shopify_settings.sync_missing_orders:
return
@@ -324,7 +385,7 @@ def sync_old_orders():
return
sync_sales_order(order=order, old_order_sync=True)
- last_order_id = order.get('id')
+ last_order_id = order.get("id")
if last_order_id:
shopify_settings.load_from_db()
@@ -335,29 +396,40 @@ def sync_old_orders():
except Exception as e:
raise e
+
def stop_sync(shopify_settings):
shopify_settings.sync_missing_orders = 0
- shopify_settings.last_order_id = ''
+ shopify_settings.last_order_id = ""
shopify_settings.save()
frappe.db.commit()
+
def get_url(shopify_settings):
last_order_id = shopify_settings.last_order_id
if not last_order_id:
- if shopify_settings.sync_based_on == 'Date':
- url = get_shopify_url("admin/api/2021-04/orders.json?limit=250&created_at_min={0}&since_id=0".format(
- get_datetime(shopify_settings.from_date)), shopify_settings)
+ if shopify_settings.sync_based_on == "Date":
+ url = get_shopify_url(
+ "admin/api/2021-04/orders.json?limit=250&created_at_min={0}&since_id=0".format(
+ get_datetime(shopify_settings.from_date)
+ ),
+ shopify_settings,
+ )
else:
- url = get_shopify_url("admin/api/2021-04/orders.json?limit=250&since_id={0}".format(
- shopify_settings.from_order_id), shopify_settings)
+ url = get_shopify_url(
+ "admin/api/2021-04/orders.json?limit=250&since_id={0}".format(shopify_settings.from_order_id),
+ shopify_settings,
+ )
else:
- url = get_shopify_url("admin/api/2021-04/orders.json?limit=250&since_id={0}".format(last_order_id), shopify_settings)
+ url = get_shopify_url(
+ "admin/api/2021-04/orders.json?limit=250&since_id={0}".format(last_order_id), shopify_settings
+ )
return url
+
def is_sync_complete(shopify_settings, order):
- if shopify_settings.sync_based_on == 'Date':
- return getdate(shopify_settings.to_date) < getdate(order.get('created_at'))
+ if shopify_settings.sync_based_on == "Date":
+ return getdate(shopify_settings.to_date) < getdate(order.get("created_at"))
else:
- return cstr(order.get('id')) == cstr(shopify_settings.to_order_id)
+ return cstr(order.get("id")) == cstr(shopify_settings.to_order_id)
diff --git a/erpnext/erpnext_integrations/connectors/woocommerce_connection.py b/erpnext/erpnext_integrations/connectors/woocommerce_connection.py
index 3e815e9bebf..46a4d3c69e4 100644
--- a/erpnext/erpnext_integrations/connectors/woocommerce_connection.py
+++ b/erpnext/erpnext_integrations/connectors/woocommerce_connection.py
@@ -1,5 +1,3 @@
-
-
import base64
import hashlib
import hmac
@@ -14,26 +12,30 @@ def verify_request():
woocommerce_settings = frappe.get_doc("Woocommerce Settings")
sig = base64.b64encode(
hmac.new(
- woocommerce_settings.secret.encode('utf8'),
- frappe.request.data,
- hashlib.sha256
+ woocommerce_settings.secret.encode("utf8"), frappe.request.data, hashlib.sha256
).digest()
)
- if frappe.request.data and \
- not sig == frappe.get_request_header("X-Wc-Webhook-Signature", "").encode():
- frappe.throw(_("Unverified Webhook Data"))
+ if (
+ frappe.request.data
+ and not sig == frappe.get_request_header("X-Wc-Webhook-Signature", "").encode()
+ ):
+ frappe.throw(_("Unverified Webhook Data"))
frappe.set_user(woocommerce_settings.creation_user)
+
@frappe.whitelist(allow_guest=True)
def order(*args, **kwargs):
try:
_order(*args, **kwargs)
except Exception:
- error_message = frappe.get_traceback()+"\n\n Request Data: \n"+json.loads(frappe.request.data).__str__()
+ error_message = (
+ frappe.get_traceback() + "\n\n Request Data: \n" + json.loads(frappe.request.data).__str__()
+ )
frappe.log_error(error_message, "WooCommerce Error")
raise
+
def _order(*args, **kwargs):
woocommerce_settings = frappe.get_doc("Woocommerce Settings")
if frappe.flags.woocomm_test_order_data:
@@ -45,7 +47,7 @@ def _order(*args, **kwargs):
try:
order = json.loads(frappe.request.data)
except ValueError:
- #woocommerce returns 'webhook_id=value' for the first request which is not JSON
+ # woocommerce returns 'webhook_id=value' for the first request which is not JSON
order = frappe.request.data
event = frappe.get_request_header("X-Wc-Webhook-Event")
@@ -53,7 +55,7 @@ def _order(*args, **kwargs):
return "success"
if event == "created":
- sys_lang = frappe.get_single("System Settings").language or 'en'
+ sys_lang = frappe.get_single("System Settings").language or "en"
raw_billing_data = order.get("billing")
raw_shipping_data = order.get("shipping")
customer_name = raw_billing_data.get("first_name") + " " + raw_billing_data.get("last_name")
@@ -61,6 +63,7 @@ def _order(*args, **kwargs):
link_items(order.get("line_items"), woocommerce_settings, sys_lang)
create_sales_order(order, woocommerce_settings, customer_name, sys_lang)
+
def link_customer_and_address(raw_billing_data, raw_shipping_data, customer_name):
customer_woo_com_email = raw_billing_data.get("email")
customer_exists = frappe.get_value("Customer", {"woocommerce_email": customer_woo_com_email})
@@ -79,9 +82,14 @@ def link_customer_and_address(raw_billing_data, raw_shipping_data, customer_name
if customer_exists:
frappe.rename_doc("Customer", old_name, customer_name)
- for address_type in ("Billing", "Shipping",):
+ for address_type in (
+ "Billing",
+ "Shipping",
+ ):
try:
- address = frappe.get_doc("Address", {"woocommerce_email": customer_woo_com_email, "address_type": address_type})
+ address = frappe.get_doc(
+ "Address", {"woocommerce_email": customer_woo_com_email, "address_type": address_type}
+ )
rename_address(address, customer)
except (
frappe.DoesNotExistError,
@@ -94,6 +102,7 @@ def link_customer_and_address(raw_billing_data, raw_shipping_data, customer_name
create_address(raw_shipping_data, customer, "Shipping")
create_contact(raw_billing_data, customer)
+
def create_contact(data, customer):
email = data.get("email", None)
phone = data.get("phone", None)
@@ -113,14 +122,12 @@ def create_contact(data, customer):
if email:
contact.add_email(email, is_primary=1)
- contact.append("links", {
- "link_doctype": "Customer",
- "link_name": customer.name
- })
+ contact.append("links", {"link_doctype": "Customer", "link_name": customer.name})
contact.flags.ignore_mandatory = True
contact.save()
+
def create_address(raw_data, customer, address_type):
address = frappe.new_doc("Address")
@@ -134,14 +141,12 @@ def create_address(raw_data, customer, address_type):
address.pincode = raw_data.get("postcode")
address.phone = raw_data.get("phone")
address.email_id = customer.woocommerce_email
- address.append("links", {
- "link_doctype": "Customer",
- "link_name": customer.name
- })
+ address.append("links", {"link_doctype": "Customer", "link_name": customer.name})
address.flags.ignore_mandatory = True
address.save()
+
def rename_address(address, customer):
old_address_title = address.name
new_address_title = customer.name + "-" + address.address_type
@@ -150,12 +155,13 @@ def rename_address(address, customer):
frappe.rename_doc("Address", old_address_title, new_address_title)
+
def link_items(items_list, woocommerce_settings, sys_lang):
for item_data in items_list:
item_woo_com_id = cstr(item_data.get("product_id"))
- if not frappe.db.get_value("Item", {"woocommerce_id": item_woo_com_id}, 'name'):
- #Create Item
+ if not frappe.db.get_value("Item", {"woocommerce_id": item_woo_com_id}, "name"):
+ # Create Item
item = frappe.new_doc("Item")
item.item_code = _("woocommerce - {0}", sys_lang).format(item_woo_com_id)
item.stock_uom = woocommerce_settings.uom or _("Nos", sys_lang)
@@ -166,6 +172,7 @@ def link_items(items_list, woocommerce_settings, sys_lang):
item.flags.ignore_mandatory = True
item.save()
+
def create_sales_order(order, woocommerce_settings, customer_name, sys_lang):
new_sales_order = frappe.new_doc("Sales Order")
new_sales_order.customer = customer_name
@@ -187,12 +194,12 @@ def create_sales_order(order, woocommerce_settings, customer_name, sys_lang):
frappe.db.commit()
+
def set_items_in_sales_order(new_sales_order, woocommerce_settings, order, sys_lang):
- company_abbr = frappe.db.get_value('Company', woocommerce_settings.company, 'abbr')
+ company_abbr = frappe.db.get_value("Company", woocommerce_settings.company, "abbr")
default_warehouse = _("Stores - {0}", sys_lang).format(company_abbr)
- if not frappe.db.exists("Warehouse", default_warehouse) \
- and not woocommerce_settings.warehouse:
+ if not frappe.db.exists("Warehouse", default_warehouse) and not woocommerce_settings.warehouse:
frappe.throw(_("Please set Warehouse in Woocommerce Settings"))
for item in order.get("line_items"):
@@ -201,28 +208,44 @@ def set_items_in_sales_order(new_sales_order, woocommerce_settings, order, sys_l
ordered_items_tax = item.get("total_tax")
- new_sales_order.append("items", {
- "item_code": found_item.name,
- "item_name": found_item.item_name,
- "description": found_item.item_name,
- "delivery_date": new_sales_order.delivery_date,
- "uom": woocommerce_settings.uom or _("Nos", sys_lang),
- "qty": item.get("quantity"),
- "rate": item.get("price"),
- "warehouse": woocommerce_settings.warehouse or default_warehouse
- })
+ new_sales_order.append(
+ "items",
+ {
+ "item_code": found_item.name,
+ "item_name": found_item.item_name,
+ "description": found_item.item_name,
+ "delivery_date": new_sales_order.delivery_date,
+ "uom": woocommerce_settings.uom or _("Nos", sys_lang),
+ "qty": item.get("quantity"),
+ "rate": item.get("price"),
+ "warehouse": woocommerce_settings.warehouse or default_warehouse,
+ },
+ )
- add_tax_details(new_sales_order, ordered_items_tax, "Ordered Item tax", woocommerce_settings.tax_account)
+ add_tax_details(
+ new_sales_order, ordered_items_tax, "Ordered Item tax", woocommerce_settings.tax_account
+ )
# shipping_details = order.get("shipping_lines") # used for detailed order
- add_tax_details(new_sales_order, order.get("shipping_tax"), "Shipping Tax", woocommerce_settings.f_n_f_account)
- add_tax_details(new_sales_order, order.get("shipping_total"), "Shipping Total", woocommerce_settings.f_n_f_account)
+ add_tax_details(
+ new_sales_order, order.get("shipping_tax"), "Shipping Tax", woocommerce_settings.f_n_f_account
+ )
+ add_tax_details(
+ new_sales_order,
+ order.get("shipping_total"),
+ "Shipping Total",
+ woocommerce_settings.f_n_f_account,
+ )
+
def add_tax_details(sales_order, price, desc, tax_account_head):
- sales_order.append("taxes", {
- "charge_type":"Actual",
- "account_head": tax_account_head,
- "tax_amount": price,
- "description": desc
- })
+ sales_order.append(
+ "taxes",
+ {
+ "charge_type": "Actual",
+ "account_head": tax_account_head,
+ "tax_amount": price,
+ "description": desc,
+ },
+ )
diff --git a/erpnext/erpnext_integrations/data_migration_mapping/issue_to_task/__init__.py b/erpnext/erpnext_integrations/data_migration_mapping/issue_to_task/__init__.py
index d7ebf59ea8e..616ecfbac68 100644
--- a/erpnext/erpnext_integrations/data_migration_mapping/issue_to_task/__init__.py
+++ b/erpnext/erpnext_integrations/data_migration_mapping/issue_to_task/__init__.py
@@ -1,13 +1,12 @@
-
import frappe
def pre_process(issue):
- project = frappe.db.get_value('Project', filters={'project_name': issue.milestone})
+ project = frappe.db.get_value("Project", filters={"project_name": issue.milestone})
return {
- 'title': issue.title,
- 'body': frappe.utils.md_to_html(issue.body or ''),
- 'state': issue.state.title(),
- 'project': project or ''
+ "title": issue.title,
+ "body": frappe.utils.md_to_html(issue.body or ""),
+ "state": issue.state.title(),
+ "project": project or "",
}
diff --git a/erpnext/erpnext_integrations/data_migration_mapping/milestone_to_project/__init__.py b/erpnext/erpnext_integrations/data_migration_mapping/milestone_to_project/__init__.py
index 7dd0c8658d1..d44fc0454ca 100644
--- a/erpnext/erpnext_integrations/data_migration_mapping/milestone_to_project/__init__.py
+++ b/erpnext/erpnext_integrations/data_migration_mapping/milestone_to_project/__init__.py
@@ -1,8 +1,6 @@
-
-
def pre_process(milestone):
return {
- 'title': milestone.title,
- 'description': milestone.description,
- 'state': milestone.state.title()
+ "title": milestone.title,
+ "description": milestone.description,
+ "state": milestone.state.title(),
}
diff --git a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_methods.py b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_methods.py
index ff51959eab5..7210d5fa745 100644
--- a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_methods.py
+++ b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_methods.py
@@ -14,7 +14,7 @@ from six import StringIO
import erpnext.erpnext_integrations.doctype.amazon_mws_settings.amazon_mws_api as mws
-#Get and Create Products
+# Get and Create Products
def get_products_details():
products = get_products_instance()
reports = get_reports_instance()
@@ -23,84 +23,93 @@ def get_products_details():
market_place_list = return_as_list(mws_settings.market_place_id)
for marketplace in market_place_list:
- report_id = request_and_fetch_report_id("_GET_FLAT_FILE_OPEN_LISTINGS_DATA_", None, None, market_place_list)
+ report_id = request_and_fetch_report_id(
+ "_GET_FLAT_FILE_OPEN_LISTINGS_DATA_", None, None, market_place_list
+ )
if report_id:
listings_response = reports.get_report(report_id=report_id)
- #Get ASIN Codes
+ # Get ASIN Codes
string_io = StringIO(frappe.safe_decode(listings_response.original))
- csv_rows = list(csv.reader(string_io, delimiter=str('\t')))
+ csv_rows = list(csv.reader(string_io, delimiter=str("\t")))
asin_list = list(set([row[1] for row in csv_rows[1:]]))
- #break into chunks of 10
+ # break into chunks of 10
asin_chunked_list = list(chunks(asin_list, 10))
- #Map ASIN Codes to SKUs
- sku_asin = [{"asin":row[1],"sku":row[0]} for row in csv_rows[1:]]
+ # Map ASIN Codes to SKUs
+ sku_asin = [{"asin": row[1], "sku": row[0]} for row in csv_rows[1:]]
- #Fetch Products List from ASIN
+ # Fetch Products List from ASIN
for asin_list in asin_chunked_list:
- products_response = call_mws_method(products.get_matching_product,marketplaceid=marketplace,
- asins=asin_list)
+ products_response = call_mws_method(
+ products.get_matching_product, marketplaceid=marketplace, asins=asin_list
+ )
matching_products_list = products_response.parsed
for product in matching_products_list:
- skus = [row["sku"] for row in sku_asin if row["asin"]==product.ASIN]
+ skus = [row["sku"] for row in sku_asin if row["asin"] == product.ASIN]
for sku in skus:
create_item_code(product, sku)
+
def get_products_instance():
mws_settings = frappe.get_doc("Amazon MWS Settings")
products = mws.Products(
- account_id = mws_settings.seller_id,
- access_key = mws_settings.aws_access_key_id,
- secret_key = mws_settings.secret_key,
- region = mws_settings.region,
- domain = mws_settings.domain
- )
+ account_id=mws_settings.seller_id,
+ access_key=mws_settings.aws_access_key_id,
+ secret_key=mws_settings.secret_key,
+ region=mws_settings.region,
+ domain=mws_settings.domain,
+ )
return products
+
def get_reports_instance():
mws_settings = frappe.get_doc("Amazon MWS Settings")
reports = mws.Reports(
- account_id = mws_settings.seller_id,
- access_key = mws_settings.aws_access_key_id,
- secret_key = mws_settings.secret_key,
- region = mws_settings.region,
- domain = mws_settings.domain
+ account_id=mws_settings.seller_id,
+ access_key=mws_settings.aws_access_key_id,
+ secret_key=mws_settings.secret_key,
+ region=mws_settings.region,
+ domain=mws_settings.domain,
)
return reports
-#returns list as expected by amazon API
+
+# returns list as expected by amazon API
def return_as_list(input_value):
if isinstance(input_value, list):
return input_value
else:
return [input_value]
-#function to chunk product data
+
+# function to chunk product data
def chunks(l, n):
for i in range(0, len(l), n):
- yield l[i:i+n]
+ yield l[i : i + n]
+
def request_and_fetch_report_id(report_type, start_date=None, end_date=None, marketplaceids=None):
reports = get_reports_instance()
- report_response = reports.request_report(report_type=report_type,
- start_date=start_date,
- end_date=end_date,
- marketplaceids=marketplaceids)
+ report_response = reports.request_report(
+ report_type=report_type, start_date=start_date, end_date=end_date, marketplaceids=marketplaceids
+ )
report_request_id = report_response.parsed["ReportRequestInfo"]["ReportRequestId"]["value"]
generated_report_id = None
- #poll to get generated report
- for x in range(1,10):
+ # poll to get generated report
+ for x in range(1, 10):
report_request_list_response = reports.get_report_request_list(requestids=[report_request_id])
- report_status = report_request_list_response.parsed["ReportRequestInfo"]["ReportProcessingStatus"]["value"]
+ report_status = report_request_list_response.parsed["ReportRequestInfo"][
+ "ReportProcessingStatus"
+ ]["value"]
if report_status == "_SUBMITTED_" or report_status == "_IN_PROGRESS_":
- #add time delay to wait for amazon to generate report
+ # add time delay to wait for amazon to generate report
time.sleep(15)
continue
elif report_status == "_CANCELLED_":
@@ -108,10 +117,13 @@ def request_and_fetch_report_id(report_type, start_date=None, end_date=None, mar
elif report_status == "_DONE_NO_DATA_":
break
elif report_status == "_DONE_":
- generated_report_id = report_request_list_response.parsed["ReportRequestInfo"]["GeneratedReportId"]["value"]
+ generated_report_id = report_request_list_response.parsed["ReportRequestInfo"][
+ "GeneratedReportId"
+ ]["value"]
break
return generated_report_id
+
def call_mws_method(mws_method, *args, **kwargs):
mws_settings = frappe.get_doc("Amazon MWS Settings")
@@ -132,6 +144,7 @@ def call_mws_method(mws_method, *args, **kwargs):
frappe.throw(_("Sync has been temporarily disabled because maximum retries have been exceeded"))
+
def create_item_code(amazon_item_json, sku):
if frappe.db.get_value("Item", sku):
return
@@ -154,27 +167,30 @@ def create_item_code(amazon_item_json, sku):
temp_item_group = amazon_item_json.Product.AttributeSets.ItemAttributes.ProductGroup
- item_group = frappe.db.get_value("Item Group",filters={"item_group_name": temp_item_group})
+ item_group = frappe.db.get_value("Item Group", filters={"item_group_name": temp_item_group})
if not item_group:
igroup = frappe.new_doc("Item Group")
igroup.item_group_name = temp_item_group
- igroup.parent_item_group = mws_settings.item_group
+ igroup.parent_item_group = mws_settings.item_group
igroup.insert()
- item.append("item_defaults", {'company':mws_settings.company})
+ item.append("item_defaults", {"company": mws_settings.company})
item.insert(ignore_permissions=True)
create_item_price(amazon_item_json, item.item_code)
return item.name
+
def create_manufacturer(amazon_item_json):
if not amazon_item_json.Product.AttributeSets.ItemAttributes.Manufacturer:
return None
- existing_manufacturer = frappe.db.get_value("Manufacturer",
- filters={"short_name":amazon_item_json.Product.AttributeSets.ItemAttributes.Manufacturer})
+ existing_manufacturer = frappe.db.get_value(
+ "Manufacturer",
+ filters={"short_name": amazon_item_json.Product.AttributeSets.ItemAttributes.Manufacturer},
+ )
if not existing_manufacturer:
manufacturer = frappe.new_doc("Manufacturer")
@@ -184,12 +200,14 @@ def create_manufacturer(amazon_item_json):
else:
return existing_manufacturer
+
def create_brand(amazon_item_json):
if not amazon_item_json.Product.AttributeSets.ItemAttributes.Brand:
return None
- existing_brand = frappe.db.get_value("Brand",
- filters={"brand":amazon_item_json.Product.AttributeSets.ItemAttributes.Brand})
+ existing_brand = frappe.db.get_value(
+ "Brand", filters={"brand": amazon_item_json.Product.AttributeSets.ItemAttributes.Brand}
+ )
if not existing_brand:
brand = frappe.new_doc("Brand")
brand.brand = amazon_item_json.Product.AttributeSets.ItemAttributes.Brand
@@ -198,18 +216,24 @@ def create_brand(amazon_item_json):
else:
return existing_brand
+
def create_item_price(amazon_item_json, item_code):
item_price = frappe.new_doc("Item Price")
- item_price.price_list = frappe.db.get_value("Amazon MWS Settings", "Amazon MWS Settings", "price_list")
- if not("ListPrice" in amazon_item_json.Product.AttributeSets.ItemAttributes):
+ item_price.price_list = frappe.db.get_value(
+ "Amazon MWS Settings", "Amazon MWS Settings", "price_list"
+ )
+ if not ("ListPrice" in amazon_item_json.Product.AttributeSets.ItemAttributes):
item_price.price_list_rate = 0
else:
- item_price.price_list_rate = amazon_item_json.Product.AttributeSets.ItemAttributes.ListPrice.Amount
+ item_price.price_list_rate = (
+ amazon_item_json.Product.AttributeSets.ItemAttributes.ListPrice.Amount
+ )
item_price.item_code = item_code
item_price.insert()
-#Get and create Orders
+
+# Get and create Orders
def get_orders(after_date):
try:
orders = get_orders_instance()
@@ -217,11 +241,14 @@ def get_orders(after_date):
mws_settings = frappe.get_doc("Amazon MWS Settings")
market_place_list = return_as_list(mws_settings.market_place_id)
- orders_response = call_mws_method(orders.list_orders, marketplaceids=market_place_list,
+ orders_response = call_mws_method(
+ orders.list_orders,
+ marketplaceids=market_place_list,
fulfillment_channels=["MFN", "AFN"],
lastupdatedafter=after_date,
orderstatus=statuses,
- max_results='50')
+ max_results="50",
+ )
while True:
orders_list = []
@@ -244,30 +271,34 @@ def get_orders(after_date):
except Exception as e:
frappe.log_error(title="get_orders", message=e)
+
def get_orders_instance():
mws_settings = frappe.get_doc("Amazon MWS Settings")
orders = mws.Orders(
- account_id = mws_settings.seller_id,
- access_key = mws_settings.aws_access_key_id,
- secret_key = mws_settings.secret_key,
- region= mws_settings.region,
- domain= mws_settings.domain,
- version="2013-09-01"
- )
+ account_id=mws_settings.seller_id,
+ access_key=mws_settings.aws_access_key_id,
+ secret_key=mws_settings.secret_key,
+ region=mws_settings.region,
+ domain=mws_settings.domain,
+ version="2013-09-01",
+ )
return orders
-def create_sales_order(order_json,after_date):
+
+def create_sales_order(order_json, after_date):
customer_name = create_customer(order_json)
create_address(order_json, customer_name)
market_place_order_id = order_json.AmazonOrderId
- so = frappe.db.get_value("Sales Order",
- filters={"amazon_order_id": market_place_order_id},
- fieldname="name")
+ so = frappe.db.get_value(
+ "Sales Order", filters={"amazon_order_id": market_place_order_id}, fieldname="name"
+ )
- taxes_and_charges = frappe.db.get_value("Amazon MWS Settings", "Amazon MWS Settings", "taxes_charges")
+ taxes_and_charges = frappe.db.get_value(
+ "Amazon MWS Settings", "Amazon MWS Settings", "taxes_charges"
+ )
if so:
return
@@ -277,7 +308,8 @@ def create_sales_order(order_json,after_date):
delivery_date = dateutil.parser.parse(order_json.LatestShipDate).strftime("%Y-%m-%d")
transaction_date = dateutil.parser.parse(order_json.PurchaseDate).strftime("%Y-%m-%d")
- so = frappe.get_doc({
+ so = frappe.get_doc(
+ {
"doctype": "Sales Order",
"naming_series": "SO-",
"amazon_order_id": market_place_order_id,
@@ -286,42 +318,46 @@ def create_sales_order(order_json,after_date):
"delivery_date": delivery_date,
"transaction_date": transaction_date,
"items": items,
- "company": frappe.db.get_value("Amazon MWS Settings", "Amazon MWS Settings", "company")
- })
+ "company": frappe.db.get_value("Amazon MWS Settings", "Amazon MWS Settings", "company"),
+ }
+ )
try:
if taxes_and_charges:
charges_and_fees = get_charges_and_fees(market_place_order_id)
for charge in charges_and_fees.get("charges"):
- so.append('taxes', charge)
+ so.append("taxes", charge)
for fee in charges_and_fees.get("fees"):
- so.append('taxes', fee)
+ so.append("taxes", fee)
so.insert(ignore_permissions=True)
so.submit()
except Exception as e:
import traceback
+
frappe.log_error(message=traceback.format_exc(), title="Create Sales Order")
+
def create_customer(order_json):
order_customer_name = ""
- if not("BuyerName" in order_json):
+ if not ("BuyerName" in order_json):
order_customer_name = "Buyer - " + order_json.AmazonOrderId
else:
order_customer_name = order_json.BuyerName
- existing_customer_name = frappe.db.get_value("Customer",
- filters={"name": order_customer_name}, fieldname="name")
+ existing_customer_name = frappe.db.get_value(
+ "Customer", filters={"name": order_customer_name}, fieldname="name"
+ )
if existing_customer_name:
filters = [
- ["Dynamic Link", "link_doctype", "=", "Customer"],
- ["Dynamic Link", "link_name", "=", existing_customer_name],
- ["Dynamic Link", "parenttype", "=", "Contact"]
- ]
+ ["Dynamic Link", "link_doctype", "=", "Customer"],
+ ["Dynamic Link", "link_name", "=", existing_customer_name],
+ ["Dynamic Link", "parenttype", "=", "Contact"],
+ ]
existing_contacts = frappe.get_list("Contact", filters)
@@ -330,10 +366,7 @@ def create_customer(order_json):
else:
new_contact = frappe.new_doc("Contact")
new_contact.first_name = order_customer_name
- new_contact.append('links', {
- "link_doctype": "Customer",
- "link_name": existing_customer_name
- })
+ new_contact.append("links", {"link_doctype": "Customer", "link_name": existing_customer_name})
new_contact.insert()
return existing_customer_name
@@ -348,26 +381,24 @@ def create_customer(order_json):
new_contact = frappe.new_doc("Contact")
new_contact.first_name = order_customer_name
- new_contact.append('links', {
- "link_doctype": "Customer",
- "link_name": new_customer.name
- })
+ new_contact.append("links", {"link_doctype": "Customer", "link_name": new_customer.name})
new_contact.insert()
return new_customer.name
+
def create_address(amazon_order_item_json, customer_name):
filters = [
- ["Dynamic Link", "link_doctype", "=", "Customer"],
- ["Dynamic Link", "link_name", "=", customer_name],
- ["Dynamic Link", "parenttype", "=", "Address"]
- ]
+ ["Dynamic Link", "link_doctype", "=", "Customer"],
+ ["Dynamic Link", "link_name", "=", customer_name],
+ ["Dynamic Link", "parenttype", "=", "Address"],
+ ]
existing_address = frappe.get_list("Address", filters)
- if not("ShippingAddress" in amazon_order_item_json):
+ if not ("ShippingAddress" in amazon_order_item_json):
return None
else:
make_address = frappe.new_doc("Address")
@@ -390,21 +421,23 @@ def create_address(amazon_order_item_json, customer_name):
for address in existing_address:
address_doc = frappe.get_doc("Address", address["name"])
- if (address_doc.address_line1 == make_address.address_line1 and
- address_doc.pincode == make_address.pincode):
+ if (
+ address_doc.address_line1 == make_address.address_line1
+ and address_doc.pincode == make_address.pincode
+ ):
return address
- make_address.append("links", {
- "link_doctype": "Customer",
- "link_name": customer_name
- })
+ make_address.append("links", {"link_doctype": "Customer", "link_name": customer_name})
make_address.address_type = "Shipping"
make_address.insert()
+
def get_order_items(market_place_order_id):
mws_orders = get_orders_instance()
- order_items_response = call_mws_method(mws_orders.list_order_items, amazon_order_id=market_place_order_id)
+ order_items_response = call_mws_method(
+ mws_orders.list_order_items, amazon_order_id=market_place_order_id
+ )
final_order_items = []
order_items_list = return_as_list(order_items_response.parsed.OrderItems.OrderItem)
@@ -419,16 +452,18 @@ def get_order_items(market_place_order_id):
else:
price = order_item.ItemPrice.Amount
- final_order_items.append({
- "item_code": get_item_code(order_item),
- "item_name": order_item.SellerSKU,
- "description": order_item.Title,
- "rate": price,
- "qty": order_item.QuantityOrdered,
- "stock_uom": "Nos",
- "warehouse": warehouse,
- "conversion_factor": "1.0"
- })
+ final_order_items.append(
+ {
+ "item_code": get_item_code(order_item),
+ "item_name": order_item.SellerSKU,
+ "description": order_item.Title,
+ "rate": price,
+ "qty": order_item.QuantityOrdered,
+ "stock_uom": "Nos",
+ "warehouse": warehouse,
+ "conversion_factor": "1.0",
+ }
+ )
if not "NextToken" in order_items_response.parsed:
break
@@ -440,16 +475,18 @@ def get_order_items(market_place_order_id):
return final_order_items
+
def get_item_code(order_item):
sku = order_item.SellerSKU
item_code = frappe.db.get_value("Item", {"item_code": sku}, "item_code")
if item_code:
return item_code
+
def get_charges_and_fees(market_place_order_id):
finances = get_finances_instance()
- charges_fees = {"charges":[], "fees":[]}
+ charges_fees = {"charges": [], "fees": []}
response = call_mws_method(finances.list_financial_events, amazon_order_id=market_place_order_id)
@@ -462,49 +499,55 @@ def get_charges_and_fees(market_place_order_id):
for shipment_item in shipment_item_list:
charges, fees = [], []
- if 'ItemChargeList' in shipment_item.keys():
+ if "ItemChargeList" in shipment_item.keys():
charges = return_as_list(shipment_item.ItemChargeList.ChargeComponent)
- if 'ItemFeeList' in shipment_item.keys():
+ if "ItemFeeList" in shipment_item.keys():
fees = return_as_list(shipment_item.ItemFeeList.FeeComponent)
for charge in charges:
- if(charge.ChargeType != "Principal") and float(charge.ChargeAmount.CurrencyAmount) != 0:
+ if (charge.ChargeType != "Principal") and float(charge.ChargeAmount.CurrencyAmount) != 0:
charge_account = get_account(charge.ChargeType)
- charges_fees.get("charges").append({
- "charge_type":"Actual",
- "account_head": charge_account,
- "tax_amount": charge.ChargeAmount.CurrencyAmount,
- "description": charge.ChargeType + " for " + shipment_item.SellerSKU
- })
+ charges_fees.get("charges").append(
+ {
+ "charge_type": "Actual",
+ "account_head": charge_account,
+ "tax_amount": charge.ChargeAmount.CurrencyAmount,
+ "description": charge.ChargeType + " for " + shipment_item.SellerSKU,
+ }
+ )
for fee in fees:
if float(fee.FeeAmount.CurrencyAmount) != 0:
fee_account = get_account(fee.FeeType)
- charges_fees.get("fees").append({
- "charge_type":"Actual",
- "account_head": fee_account,
- "tax_amount": fee.FeeAmount.CurrencyAmount,
- "description": fee.FeeType + " for " + shipment_item.SellerSKU
- })
+ charges_fees.get("fees").append(
+ {
+ "charge_type": "Actual",
+ "account_head": fee_account,
+ "tax_amount": fee.FeeAmount.CurrencyAmount,
+ "description": fee.FeeType + " for " + shipment_item.SellerSKU,
+ }
+ )
return charges_fees
+
def get_finances_instance():
mws_settings = frappe.get_doc("Amazon MWS Settings")
finances = mws.Finances(
- account_id = mws_settings.seller_id,
- access_key = mws_settings.aws_access_key_id,
- secret_key = mws_settings.secret_key,
- region= mws_settings.region,
- domain= mws_settings.domain,
- version="2015-05-01"
- )
+ account_id=mws_settings.seller_id,
+ access_key=mws_settings.aws_access_key_id,
+ secret_key=mws_settings.secret_key,
+ region=mws_settings.region,
+ domain=mws_settings.domain,
+ version="2015-05-01",
+ )
return finances
+
def get_account(name):
existing_account = frappe.db.get_value("Account", {"account_name": "Amazon {0}".format(name)})
account_name = existing_account
diff --git a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_api.py b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_api.py
index 4caf137455a..ff034fb3564 100755
--- a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_api.py
+++ b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_api.py
@@ -23,57 +23,57 @@ from requests import request
from requests.exceptions import HTTPError
__all__ = [
- 'Feeds',
- 'Inventory',
- 'MWSError',
- 'Reports',
- 'Orders',
- 'Products',
- 'Recommendations',
- 'Sellers',
- 'Finances'
+ "Feeds",
+ "Inventory",
+ "MWSError",
+ "Reports",
+ "Orders",
+ "Products",
+ "Recommendations",
+ "Sellers",
+ "Finances",
]
# See https://images-na.ssl-images-amazon.com/images/G/01/mwsportal/doc/en_US/bde/MWSDeveloperGuide._V357736853_.pdf page 8
# for a list of the end points and marketplace IDs
MARKETPLACES = {
- "CA": "https://mws.amazonservices.ca", #A2EUQ1WTGCTBG2
- "US": "https://mws.amazonservices.com", #ATVPDKIKX0DER",
- "DE": "https://mws-eu.amazonservices.com", #A1PA6795UKMFR9
- "ES": "https://mws-eu.amazonservices.com", #A1RKKUPIHCS9HS
- "FR": "https://mws-eu.amazonservices.com", #A13V1IB3VIYZZH
- "IN": "https://mws.amazonservices.in", #A21TJRUUN4KGV
- "IT": "https://mws-eu.amazonservices.com", #APJ6JRA9NG5V4
- "UK": "https://mws-eu.amazonservices.com", #A1F83G8C2ARO7P
- "JP": "https://mws.amazonservices.jp", #A1VC38T7YXB528
- "CN": "https://mws.amazonservices.com.cn", #AAHKV2X7AFYLW
- "AE": " https://mws.amazonservices.ae", #A2VIGQ35RCS4UG
- "MX": "https://mws.amazonservices.com.mx", #A1AM78C64UM0Y8
- "BR": "https://mws.amazonservices.com", #A2Q3Y263D00KWC
+ "CA": "https://mws.amazonservices.ca", # A2EUQ1WTGCTBG2
+ "US": "https://mws.amazonservices.com", # ATVPDKIKX0DER",
+ "DE": "https://mws-eu.amazonservices.com", # A1PA6795UKMFR9
+ "ES": "https://mws-eu.amazonservices.com", # A1RKKUPIHCS9HS
+ "FR": "https://mws-eu.amazonservices.com", # A13V1IB3VIYZZH
+ "IN": "https://mws.amazonservices.in", # A21TJRUUN4KGV
+ "IT": "https://mws-eu.amazonservices.com", # APJ6JRA9NG5V4
+ "UK": "https://mws-eu.amazonservices.com", # A1F83G8C2ARO7P
+ "JP": "https://mws.amazonservices.jp", # A1VC38T7YXB528
+ "CN": "https://mws.amazonservices.com.cn", # AAHKV2X7AFYLW
+ "AE": " https://mws.amazonservices.ae", # A2VIGQ35RCS4UG
+ "MX": "https://mws.amazonservices.com.mx", # A1AM78C64UM0Y8
+ "BR": "https://mws.amazonservices.com", # A2Q3Y263D00KWC
}
class MWSError(Exception):
"""
- Main MWS Exception class
+ Main MWS Exception class
"""
+
# Allows quick access to the response object.
# Do not rely on this attribute, always check if its not None.
response = None
+
def calc_md5(string):
- """Calculates the MD5 encryption for the given string
- """
+ """Calculates the MD5 encryption for the given string"""
md = hashlib.md5()
md.update(string)
return base64.encodebytes(md.digest()).decode().strip()
-
def remove_empty(d):
"""
- Helper function that removes all keys from a dictionary (d),
+ Helper function that removes all keys from a dictionary (d),
that have an empty value.
"""
for key in list(d):
@@ -81,10 +81,12 @@ def remove_empty(d):
del d[key]
return d
+
def remove_namespace(xml):
- xml = xml.decode('utf-8')
+ xml = xml.decode("utf-8")
regex = re.compile(' xmlns(:ns2)?="[^"]+"|(ns2:)|(xml:)')
- return regex.sub('', xml)
+ return regex.sub("", xml)
+
class DictWrapper(object):
def __init__(self, xml, rootkey=None):
@@ -100,23 +102,26 @@ class DictWrapper(object):
else:
return self._response_dict
+
class DataWrapper(object):
"""
- Text wrapper in charge of validating the hash sent by Amazon.
+ Text wrapper in charge of validating the hash sent by Amazon.
"""
+
def __init__(self, data, header):
self.original = data
- if 'content-md5' in header:
+ if "content-md5" in header:
hash_ = calc_md5(self.original)
- if header['content-md5'] != hash_:
+ if header["content-md5"] != hash_:
raise MWSError("Wrong Contentlength, maybe amazon error...")
@property
def parsed(self):
return self.original
+
class MWS(object):
- """ Base Amazon API class """
+ """Base Amazon API class"""
# This is used to post/get to the different uris used by amazon per api
# ie. /Orders/2011-01-01
@@ -130,7 +135,7 @@ class MWS(object):
# is recommended to define its namespace, so that it can be referenced
# like so AmazonAPISubclass.NS.
# For more information see http://stackoverflow.com/a/8719461/389453
- NS = ''
+ NS = ""
# Some APIs are available only to either a "Merchant" or "Seller"
# the type of account needs to be sent in every call to the amazon MWS.
@@ -142,7 +147,9 @@ class MWS(object):
# Which is the name of the parameter for that specific account type.
ACCOUNT_TYPE = "SellerId"
- def __init__(self, access_key, secret_key, account_id, region='US', domain='', uri="", version=""):
+ def __init__(
+ self, access_key, secret_key, account_id, region="US", domain="", uri="", version=""
+ ):
self.access_key = access_key
self.secret_key = secret_key
self.account_id = account_id
@@ -154,41 +161,45 @@ class MWS(object):
elif region in MARKETPLACES:
self.domain = MARKETPLACES[region]
else:
- error_msg = "Incorrect region supplied ('%(region)s'). Must be one of the following: %(marketplaces)s" % {
- "marketplaces" : ', '.join(MARKETPLACES.keys()),
- "region" : region,
- }
+ error_msg = (
+ "Incorrect region supplied ('%(region)s'). Must be one of the following: %(marketplaces)s"
+ % {
+ "marketplaces": ", ".join(MARKETPLACES.keys()),
+ "region": region,
+ }
+ )
raise MWSError(error_msg)
def make_request(self, extra_data, method="GET", **kwargs):
- """Make request to Amazon MWS API with these parameters
- """
+ """Make request to Amazon MWS API with these parameters"""
# Remove all keys with an empty value because
# Amazon's MWS does not allow such a thing.
extra_data = remove_empty(extra_data)
params = {
- 'AWSAccessKeyId': self.access_key,
+ "AWSAccessKeyId": self.access_key,
self.ACCOUNT_TYPE: self.account_id,
- 'SignatureVersion': '2',
- 'Timestamp': self.get_timestamp(),
- 'Version': self.version,
- 'SignatureMethod': 'HmacSHA256',
+ "SignatureVersion": "2",
+ "Timestamp": self.get_timestamp(),
+ "Version": self.version,
+ "SignatureMethod": "HmacSHA256",
}
params.update(extra_data)
- request_description = '&'.join(['%s=%s' % (k, quote(params[k], safe='-_.~')) for k in sorted(params)])
+ request_description = "&".join(
+ ["%s=%s" % (k, quote(params[k], safe="-_.~")) for k in sorted(params)]
+ )
signature = self.calc_signature(method, request_description)
- url = '%s%s?%s&Signature=%s' % (self.domain, self.uri, request_description, quote(signature))
- headers = {'User-Agent': 'python-amazon-mws/0.0.1 (Language=Python)'}
- headers.update(kwargs.get('extra_headers', {}))
+ url = "%s%s?%s&Signature=%s" % (self.domain, self.uri, request_description, quote(signature))
+ headers = {"User-Agent": "python-amazon-mws/0.0.1 (Language=Python)"}
+ headers.update(kwargs.get("extra_headers", {}))
try:
# Some might wonder as to why i don't pass the params dict as the params argument to request.
# My answer is, here i have to get the url parsed string of params in order to sign it, so
# if i pass the params dict as params to request, request will repeat that step because it will need
# to convert the dict to a url parsed string, so why do it twice if i can just pass the full url :).
- response = request(method, url, data=kwargs.get('body', ''), headers=headers)
+ response = request(method, url, data=kwargs.get("body", ""), headers=headers)
response.raise_for_status()
# When retrieving data from the response object,
# be aware that response.content returns the content in bytes while response.text calls
@@ -213,380 +224,417 @@ class MWS(object):
def get_service_status(self):
"""
- Returns a GREEN, GREEN_I, YELLOW or RED status.
- Depending on the status/availability of the API its being called from.
+ Returns a GREEN, GREEN_I, YELLOW or RED status.
+ Depending on the status/availability of the API its being called from.
"""
- return self.make_request(extra_data=dict(Action='GetServiceStatus'))
+ return self.make_request(extra_data=dict(Action="GetServiceStatus"))
def calc_signature(self, method, request_description):
- """Calculate MWS signature to interface with Amazon
- """
- sig_data = method + '\n' + self.domain.replace('https://', '').lower() + '\n' + self.uri + '\n' + request_description
- sig_data = sig_data.encode('utf-8')
- secret_key = self.secret_key.encode('utf-8')
+ """Calculate MWS signature to interface with Amazon"""
+ sig_data = (
+ method
+ + "\n"
+ + self.domain.replace("https://", "").lower()
+ + "\n"
+ + self.uri
+ + "\n"
+ + request_description
+ )
+ sig_data = sig_data.encode("utf-8")
+ secret_key = self.secret_key.encode("utf-8")
digest = hmac.new(secret_key, sig_data, hashlib.sha256).digest()
- return base64.b64encode(digest).decode('utf-8')
+ return base64.b64encode(digest).decode("utf-8")
def get_timestamp(self):
"""
- Returns the current timestamp in proper format.
+ Returns the current timestamp in proper format.
"""
return strftime("%Y-%m-%dT%H:%M:%SZ", gmtime())
def enumerate_param(self, param, values):
"""
- Builds a dictionary of an enumerated parameter.
- Takes any iterable and returns a dictionary.
- ie.
- enumerate_param('MarketplaceIdList.Id', (123, 345, 4343))
- returns
- {
- MarketplaceIdList.Id.1: 123,
- MarketplaceIdList.Id.2: 345,
- MarketplaceIdList.Id.3: 4343
- }
+ Builds a dictionary of an enumerated parameter.
+ Takes any iterable and returns a dictionary.
+ ie.
+ enumerate_param('MarketplaceIdList.Id', (123, 345, 4343))
+ returns
+ {
+ MarketplaceIdList.Id.1: 123,
+ MarketplaceIdList.Id.2: 345,
+ MarketplaceIdList.Id.3: 4343
+ }
"""
params = {}
if values is not None:
- if not param.endswith('.'):
+ if not param.endswith("."):
param = "%s." % param
for num, value in enumerate(values):
- params['%s%d' % (param, (num + 1))] = value
+ params["%s%d" % (param, (num + 1))] = value
return params
class Feeds(MWS):
- """ Amazon MWS Feeds API """
+ """Amazon MWS Feeds API"""
ACCOUNT_TYPE = "Merchant"
- def submit_feed(self, feed, feed_type, marketplaceids=None,
- content_type="text/xml", purge='false'):
+ def submit_feed(
+ self, feed, feed_type, marketplaceids=None, content_type="text/xml", purge="false"
+ ):
"""
Uploads a feed ( xml or .tsv ) to the seller's inventory.
Can be used for creating/updating products on Amazon.
"""
- data = dict(Action='SubmitFeed',
- FeedType=feed_type,
- PurgeAndReplace=purge)
- data.update(self.enumerate_param('MarketplaceIdList.Id.', marketplaceids))
+ data = dict(Action="SubmitFeed", FeedType=feed_type, PurgeAndReplace=purge)
+ data.update(self.enumerate_param("MarketplaceIdList.Id.", marketplaceids))
md = calc_md5(feed)
- return self.make_request(data, method="POST", body=feed,
- extra_headers={'Content-MD5': md, 'Content-Type': content_type})
+ return self.make_request(
+ data, method="POST", body=feed, extra_headers={"Content-MD5": md, "Content-Type": content_type}
+ )
- def get_feed_submission_list(self, feedids=None, max_count=None, feedtypes=None,
- processingstatuses=None, fromdate=None, todate=None):
+ def get_feed_submission_list(
+ self,
+ feedids=None,
+ max_count=None,
+ feedtypes=None,
+ processingstatuses=None,
+ fromdate=None,
+ todate=None,
+ ):
"""
Returns a list of all feed submissions submitted in the previous 90 days.
That match the query parameters.
"""
- data = dict(Action='GetFeedSubmissionList',
- MaxCount=max_count,
- SubmittedFromDate=fromdate,
- SubmittedToDate=todate,)
- data.update(self.enumerate_param('FeedSubmissionIdList.Id', feedids))
- data.update(self.enumerate_param('FeedTypeList.Type.', feedtypes))
- data.update(self.enumerate_param('FeedProcessingStatusList.Status.', processingstatuses))
+ data = dict(
+ Action="GetFeedSubmissionList",
+ MaxCount=max_count,
+ SubmittedFromDate=fromdate,
+ SubmittedToDate=todate,
+ )
+ data.update(self.enumerate_param("FeedSubmissionIdList.Id", feedids))
+ data.update(self.enumerate_param("FeedTypeList.Type.", feedtypes))
+ data.update(self.enumerate_param("FeedProcessingStatusList.Status.", processingstatuses))
return self.make_request(data)
def get_submission_list_by_next_token(self, token):
- data = dict(Action='GetFeedSubmissionListByNextToken', NextToken=token)
+ data = dict(Action="GetFeedSubmissionListByNextToken", NextToken=token)
return self.make_request(data)
- def get_feed_submission_count(self, feedtypes=None, processingstatuses=None, fromdate=None, todate=None):
- data = dict(Action='GetFeedSubmissionCount',
- SubmittedFromDate=fromdate,
- SubmittedToDate=todate)
- data.update(self.enumerate_param('FeedTypeList.Type.', feedtypes))
- data.update(self.enumerate_param('FeedProcessingStatusList.Status.', processingstatuses))
+ def get_feed_submission_count(
+ self, feedtypes=None, processingstatuses=None, fromdate=None, todate=None
+ ):
+ data = dict(Action="GetFeedSubmissionCount", SubmittedFromDate=fromdate, SubmittedToDate=todate)
+ data.update(self.enumerate_param("FeedTypeList.Type.", feedtypes))
+ data.update(self.enumerate_param("FeedProcessingStatusList.Status.", processingstatuses))
return self.make_request(data)
def cancel_feed_submissions(self, feedids=None, feedtypes=None, fromdate=None, todate=None):
- data = dict(Action='CancelFeedSubmissions',
- SubmittedFromDate=fromdate,
- SubmittedToDate=todate)
- data.update(self.enumerate_param('FeedSubmissionIdList.Id.', feedids))
- data.update(self.enumerate_param('FeedTypeList.Type.', feedtypes))
+ data = dict(Action="CancelFeedSubmissions", SubmittedFromDate=fromdate, SubmittedToDate=todate)
+ data.update(self.enumerate_param("FeedSubmissionIdList.Id.", feedids))
+ data.update(self.enumerate_param("FeedTypeList.Type.", feedtypes))
return self.make_request(data)
def get_feed_submission_result(self, feedid):
- data = dict(Action='GetFeedSubmissionResult', FeedSubmissionId=feedid)
+ data = dict(Action="GetFeedSubmissionResult", FeedSubmissionId=feedid)
return self.make_request(data)
+
class Reports(MWS):
- """ Amazon MWS Reports API """
+ """Amazon MWS Reports API"""
ACCOUNT_TYPE = "Merchant"
## REPORTS ###
def get_report(self, report_id):
- data = dict(Action='GetReport', ReportId=report_id)
+ data = dict(Action="GetReport", ReportId=report_id)
return self.make_request(data)
def get_report_count(self, report_types=(), acknowledged=None, fromdate=None, todate=None):
- data = dict(Action='GetReportCount',
- Acknowledged=acknowledged,
- AvailableFromDate=fromdate,
- AvailableToDate=todate)
- data.update(self.enumerate_param('ReportTypeList.Type.', report_types))
+ data = dict(
+ Action="GetReportCount",
+ Acknowledged=acknowledged,
+ AvailableFromDate=fromdate,
+ AvailableToDate=todate,
+ )
+ data.update(self.enumerate_param("ReportTypeList.Type.", report_types))
return self.make_request(data)
- def get_report_list(self, requestids=(), max_count=None, types=(), acknowledged=None,
- fromdate=None, todate=None):
- data = dict(Action='GetReportList',
- Acknowledged=acknowledged,
- AvailableFromDate=fromdate,
- AvailableToDate=todate,
- MaxCount=max_count)
- data.update(self.enumerate_param('ReportRequestIdList.Id.', requestids))
- data.update(self.enumerate_param('ReportTypeList.Type.', types))
+ def get_report_list(
+ self, requestids=(), max_count=None, types=(), acknowledged=None, fromdate=None, todate=None
+ ):
+ data = dict(
+ Action="GetReportList",
+ Acknowledged=acknowledged,
+ AvailableFromDate=fromdate,
+ AvailableToDate=todate,
+ MaxCount=max_count,
+ )
+ data.update(self.enumerate_param("ReportRequestIdList.Id.", requestids))
+ data.update(self.enumerate_param("ReportTypeList.Type.", types))
return self.make_request(data)
def get_report_list_by_next_token(self, token):
- data = dict(Action='GetReportListByNextToken', NextToken=token)
+ data = dict(Action="GetReportListByNextToken", NextToken=token)
return self.make_request(data)
- def get_report_request_count(self, report_types=(), processingstatuses=(), fromdate=None, todate=None):
- data = dict(Action='GetReportRequestCount',
- RequestedFromDate=fromdate,
- RequestedToDate=todate)
- data.update(self.enumerate_param('ReportTypeList.Type.', report_types))
- data.update(self.enumerate_param('ReportProcessingStatusList.Status.', processingstatuses))
+ def get_report_request_count(
+ self, report_types=(), processingstatuses=(), fromdate=None, todate=None
+ ):
+ data = dict(Action="GetReportRequestCount", RequestedFromDate=fromdate, RequestedToDate=todate)
+ data.update(self.enumerate_param("ReportTypeList.Type.", report_types))
+ data.update(self.enumerate_param("ReportProcessingStatusList.Status.", processingstatuses))
return self.make_request(data)
- def get_report_request_list(self, requestids=(), types=(), processingstatuses=(),
- max_count=None, fromdate=None, todate=None):
- data = dict(Action='GetReportRequestList',
- MaxCount=max_count,
- RequestedFromDate=fromdate,
- RequestedToDate=todate)
- data.update(self.enumerate_param('ReportRequestIdList.Id.', requestids))
- data.update(self.enumerate_param('ReportTypeList.Type.', types))
- data.update(self.enumerate_param('ReportProcessingStatusList.Status.', processingstatuses))
+ def get_report_request_list(
+ self, requestids=(), types=(), processingstatuses=(), max_count=None, fromdate=None, todate=None
+ ):
+ data = dict(
+ Action="GetReportRequestList",
+ MaxCount=max_count,
+ RequestedFromDate=fromdate,
+ RequestedToDate=todate,
+ )
+ data.update(self.enumerate_param("ReportRequestIdList.Id.", requestids))
+ data.update(self.enumerate_param("ReportTypeList.Type.", types))
+ data.update(self.enumerate_param("ReportProcessingStatusList.Status.", processingstatuses))
return self.make_request(data)
def get_report_request_list_by_next_token(self, token):
- data = dict(Action='GetReportRequestListByNextToken', NextToken=token)
+ data = dict(Action="GetReportRequestListByNextToken", NextToken=token)
return self.make_request(data)
def request_report(self, report_type, start_date=None, end_date=None, marketplaceids=()):
- data = dict(Action='RequestReport',
- ReportType=report_type,
- StartDate=start_date,
- EndDate=end_date)
- data.update(self.enumerate_param('MarketplaceIdList.Id.', marketplaceids))
+ data = dict(
+ Action="RequestReport", ReportType=report_type, StartDate=start_date, EndDate=end_date
+ )
+ data.update(self.enumerate_param("MarketplaceIdList.Id.", marketplaceids))
return self.make_request(data)
### ReportSchedule ###
def get_report_schedule_list(self, types=()):
- data = dict(Action='GetReportScheduleList')
- data.update(self.enumerate_param('ReportTypeList.Type.', types))
+ data = dict(Action="GetReportScheduleList")
+ data.update(self.enumerate_param("ReportTypeList.Type.", types))
return self.make_request(data)
def get_report_schedule_count(self, types=()):
- data = dict(Action='GetReportScheduleCount')
- data.update(self.enumerate_param('ReportTypeList.Type.', types))
+ data = dict(Action="GetReportScheduleCount")
+ data.update(self.enumerate_param("ReportTypeList.Type.", types))
return self.make_request(data)
class Orders(MWS):
- """ Amazon Orders API """
+ """Amazon Orders API"""
URI = "/Orders/2013-09-01"
VERSION = "2013-09-01"
- NS = '{https://mws.amazonservices.com/Orders/2011-01-01}'
+ NS = "{https://mws.amazonservices.com/Orders/2011-01-01}"
- def list_orders(self, marketplaceids, created_after=None, created_before=None, lastupdatedafter=None,
- lastupdatedbefore=None, orderstatus=(), fulfillment_channels=(),
- payment_methods=(), buyer_email=None, seller_orderid=None, max_results='100'):
+ def list_orders(
+ self,
+ marketplaceids,
+ created_after=None,
+ created_before=None,
+ lastupdatedafter=None,
+ lastupdatedbefore=None,
+ orderstatus=(),
+ fulfillment_channels=(),
+ payment_methods=(),
+ buyer_email=None,
+ seller_orderid=None,
+ max_results="100",
+ ):
- data = dict(Action='ListOrders',
- CreatedAfter=created_after,
- CreatedBefore=created_before,
- LastUpdatedAfter=lastupdatedafter,
- LastUpdatedBefore=lastupdatedbefore,
- BuyerEmail=buyer_email,
- SellerOrderId=seller_orderid,
- MaxResultsPerPage=max_results,
- )
- data.update(self.enumerate_param('OrderStatus.Status.', orderstatus))
- data.update(self.enumerate_param('MarketplaceId.Id.', marketplaceids))
- data.update(self.enumerate_param('FulfillmentChannel.Channel.', fulfillment_channels))
- data.update(self.enumerate_param('PaymentMethod.Method.', payment_methods))
+ data = dict(
+ Action="ListOrders",
+ CreatedAfter=created_after,
+ CreatedBefore=created_before,
+ LastUpdatedAfter=lastupdatedafter,
+ LastUpdatedBefore=lastupdatedbefore,
+ BuyerEmail=buyer_email,
+ SellerOrderId=seller_orderid,
+ MaxResultsPerPage=max_results,
+ )
+ data.update(self.enumerate_param("OrderStatus.Status.", orderstatus))
+ data.update(self.enumerate_param("MarketplaceId.Id.", marketplaceids))
+ data.update(self.enumerate_param("FulfillmentChannel.Channel.", fulfillment_channels))
+ data.update(self.enumerate_param("PaymentMethod.Method.", payment_methods))
return self.make_request(data)
def list_orders_by_next_token(self, token):
- data = dict(Action='ListOrdersByNextToken', NextToken=token)
+ data = dict(Action="ListOrdersByNextToken", NextToken=token)
return self.make_request(data)
def get_order(self, amazon_order_ids):
- data = dict(Action='GetOrder')
- data.update(self.enumerate_param('AmazonOrderId.Id.', amazon_order_ids))
+ data = dict(Action="GetOrder")
+ data.update(self.enumerate_param("AmazonOrderId.Id.", amazon_order_ids))
return self.make_request(data)
def list_order_items(self, amazon_order_id):
- data = dict(Action='ListOrderItems', AmazonOrderId=amazon_order_id)
+ data = dict(Action="ListOrderItems", AmazonOrderId=amazon_order_id)
return self.make_request(data)
def list_order_items_by_next_token(self, token):
- data = dict(Action='ListOrderItemsByNextToken', NextToken=token)
+ data = dict(Action="ListOrderItemsByNextToken", NextToken=token)
return self.make_request(data)
class Products(MWS):
- """ Amazon MWS Products API """
+ """Amazon MWS Products API"""
- URI = '/Products/2011-10-01'
- VERSION = '2011-10-01'
- NS = '{http://mws.amazonservices.com/schema/Products/2011-10-01}'
+ URI = "/Products/2011-10-01"
+ VERSION = "2011-10-01"
+ NS = "{http://mws.amazonservices.com/schema/Products/2011-10-01}"
def list_matching_products(self, marketplaceid, query, contextid=None):
- """ Returns a list of products and their attributes, ordered by
- relevancy, based on a search query that you specify.
- Your search query can be a phrase that describes the product
- or it can be a product identifier such as a UPC, EAN, ISBN, or JAN.
+ """Returns a list of products and their attributes, ordered by
+ relevancy, based on a search query that you specify.
+ Your search query can be a phrase that describes the product
+ or it can be a product identifier such as a UPC, EAN, ISBN, or JAN.
"""
- data = dict(Action='ListMatchingProducts',
- MarketplaceId=marketplaceid,
- Query=query,
- QueryContextId=contextid)
+ data = dict(
+ Action="ListMatchingProducts",
+ MarketplaceId=marketplaceid,
+ Query=query,
+ QueryContextId=contextid,
+ )
return self.make_request(data)
def get_matching_product(self, marketplaceid, asins):
- """ Returns a list of products and their attributes, based on a list of
- ASIN values that you specify.
+ """Returns a list of products and their attributes, based on a list of
+ ASIN values that you specify.
"""
- data = dict(Action='GetMatchingProduct', MarketplaceId=marketplaceid)
- data.update(self.enumerate_param('ASINList.ASIN.', asins))
+ data = dict(Action="GetMatchingProduct", MarketplaceId=marketplaceid)
+ data.update(self.enumerate_param("ASINList.ASIN.", asins))
return self.make_request(data)
def get_matching_product_for_id(self, marketplaceid, type, id):
- """ Returns a list of products and their attributes, based on a list of
- product identifier values (asin, sellersku, upc, ean, isbn and JAN)
- Added in Fourth Release, API version 2011-10-01
+ """Returns a list of products and their attributes, based on a list of
+ product identifier values (asin, sellersku, upc, ean, isbn and JAN)
+ Added in Fourth Release, API version 2011-10-01
"""
- data = dict(Action='GetMatchingProductForId',
- MarketplaceId=marketplaceid,
- IdType=type)
- data.update(self.enumerate_param('IdList.Id', id))
+ data = dict(Action="GetMatchingProductForId", MarketplaceId=marketplaceid, IdType=type)
+ data.update(self.enumerate_param("IdList.Id", id))
return self.make_request(data)
def get_competitive_pricing_for_sku(self, marketplaceid, skus):
- """ Returns the current competitive pricing of a product,
- based on the SellerSKU and MarketplaceId that you specify.
+ """Returns the current competitive pricing of a product,
+ based on the SellerSKU and MarketplaceId that you specify.
"""
- data = dict(Action='GetCompetitivePricingForSKU', MarketplaceId=marketplaceid)
- data.update(self.enumerate_param('SellerSKUList.SellerSKU.', skus))
+ data = dict(Action="GetCompetitivePricingForSKU", MarketplaceId=marketplaceid)
+ data.update(self.enumerate_param("SellerSKUList.SellerSKU.", skus))
return self.make_request(data)
def get_competitive_pricing_for_asin(self, marketplaceid, asins):
- """ Returns the current competitive pricing of a product,
- based on the ASIN and MarketplaceId that you specify.
+ """Returns the current competitive pricing of a product,
+ based on the ASIN and MarketplaceId that you specify.
"""
- data = dict(Action='GetCompetitivePricingForASIN', MarketplaceId=marketplaceid)
- data.update(self.enumerate_param('ASINList.ASIN.', asins))
+ data = dict(Action="GetCompetitivePricingForASIN", MarketplaceId=marketplaceid)
+ data.update(self.enumerate_param("ASINList.ASIN.", asins))
return self.make_request(data)
- def get_lowest_offer_listings_for_sku(self, marketplaceid, skus, condition="Any", excludeme="False"):
- data = dict(Action='GetLowestOfferListingsForSKU',
- MarketplaceId=marketplaceid,
- ItemCondition=condition,
- ExcludeMe=excludeme)
- data.update(self.enumerate_param('SellerSKUList.SellerSKU.', skus))
+ def get_lowest_offer_listings_for_sku(
+ self, marketplaceid, skus, condition="Any", excludeme="False"
+ ):
+ data = dict(
+ Action="GetLowestOfferListingsForSKU",
+ MarketplaceId=marketplaceid,
+ ItemCondition=condition,
+ ExcludeMe=excludeme,
+ )
+ data.update(self.enumerate_param("SellerSKUList.SellerSKU.", skus))
return self.make_request(data)
- def get_lowest_offer_listings_for_asin(self, marketplaceid, asins, condition="Any", excludeme="False"):
- data = dict(Action='GetLowestOfferListingsForASIN',
- MarketplaceId=marketplaceid,
- ItemCondition=condition,
- ExcludeMe=excludeme)
- data.update(self.enumerate_param('ASINList.ASIN.', asins))
+ def get_lowest_offer_listings_for_asin(
+ self, marketplaceid, asins, condition="Any", excludeme="False"
+ ):
+ data = dict(
+ Action="GetLowestOfferListingsForASIN",
+ MarketplaceId=marketplaceid,
+ ItemCondition=condition,
+ ExcludeMe=excludeme,
+ )
+ data.update(self.enumerate_param("ASINList.ASIN.", asins))
return self.make_request(data)
def get_product_categories_for_sku(self, marketplaceid, sku):
- data = dict(Action='GetProductCategoriesForSKU',
- MarketplaceId=marketplaceid,
- SellerSKU=sku)
+ data = dict(Action="GetProductCategoriesForSKU", MarketplaceId=marketplaceid, SellerSKU=sku)
return self.make_request(data)
def get_product_categories_for_asin(self, marketplaceid, asin):
- data = dict(Action='GetProductCategoriesForASIN',
- MarketplaceId=marketplaceid,
- ASIN=asin)
+ data = dict(Action="GetProductCategoriesForASIN", MarketplaceId=marketplaceid, ASIN=asin)
return self.make_request(data)
def get_my_price_for_sku(self, marketplaceid, skus, condition=None):
- data = dict(Action='GetMyPriceForSKU',
- MarketplaceId=marketplaceid,
- ItemCondition=condition)
- data.update(self.enumerate_param('SellerSKUList.SellerSKU.', skus))
+ data = dict(Action="GetMyPriceForSKU", MarketplaceId=marketplaceid, ItemCondition=condition)
+ data.update(self.enumerate_param("SellerSKUList.SellerSKU.", skus))
return self.make_request(data)
def get_my_price_for_asin(self, marketplaceid, asins, condition=None):
- data = dict(Action='GetMyPriceForASIN',
- MarketplaceId=marketplaceid,
- ItemCondition=condition)
- data.update(self.enumerate_param('ASINList.ASIN.', asins))
+ data = dict(Action="GetMyPriceForASIN", MarketplaceId=marketplaceid, ItemCondition=condition)
+ data.update(self.enumerate_param("ASINList.ASIN.", asins))
return self.make_request(data)
class Sellers(MWS):
- """ Amazon MWS Sellers API """
+ """Amazon MWS Sellers API"""
- URI = '/Sellers/2011-07-01'
- VERSION = '2011-07-01'
- NS = '{http://mws.amazonservices.com/schema/Sellers/2011-07-01}'
+ URI = "/Sellers/2011-07-01"
+ VERSION = "2011-07-01"
+ NS = "{http://mws.amazonservices.com/schema/Sellers/2011-07-01}"
def list_marketplace_participations(self):
"""
- Returns a list of marketplaces a seller can participate in and
- a list of participations that include seller-specific information in that marketplace.
- The operation returns only those marketplaces where the seller's account is in an active state.
+ Returns a list of marketplaces a seller can participate in and
+ a list of participations that include seller-specific information in that marketplace.
+ The operation returns only those marketplaces where the seller's account is in an active state.
"""
- data = dict(Action='ListMarketplaceParticipations')
+ data = dict(Action="ListMarketplaceParticipations")
return self.make_request(data)
def list_marketplace_participations_by_next_token(self, token):
"""
- Takes a "NextToken" and returns the same information as "list_marketplace_participations".
- Based on the "NextToken".
+ Takes a "NextToken" and returns the same information as "list_marketplace_participations".
+ Based on the "NextToken".
"""
- data = dict(Action='ListMarketplaceParticipations', NextToken=token)
+ data = dict(Action="ListMarketplaceParticipations", NextToken=token)
return self.make_request(data)
+
#### Fulfillment APIs ####
+
class InboundShipments(MWS):
URI = "/FulfillmentInboundShipment/2010-10-01"
- VERSION = '2010-10-01'
+ VERSION = "2010-10-01"
# To be completed
class Inventory(MWS):
- """ Amazon MWS Inventory Fulfillment API """
+ """Amazon MWS Inventory Fulfillment API"""
- URI = '/FulfillmentInventory/2010-10-01'
- VERSION = '2010-10-01'
+ URI = "/FulfillmentInventory/2010-10-01"
+ VERSION = "2010-10-01"
NS = "{http://mws.amazonaws.com/FulfillmentInventory/2010-10-01}"
- def list_inventory_supply(self, skus=(), datetime=None, response_group='Basic'):
- """ Returns information on available inventory """
+ def list_inventory_supply(self, skus=(), datetime=None, response_group="Basic"):
+ """Returns information on available inventory"""
- data = dict(Action='ListInventorySupply',
- QueryStartDateTime=datetime,
- ResponseGroup=response_group,
- )
- data.update(self.enumerate_param('SellerSkus.member.', skus))
+ data = dict(
+ Action="ListInventorySupply",
+ QueryStartDateTime=datetime,
+ ResponseGroup=response_group,
+ )
+ data.update(self.enumerate_param("SellerSkus.member.", skus))
return self.make_request(data, "POST")
def list_inventory_supply_by_next_token(self, token):
- data = dict(Action='ListInventorySupplyByNextToken', NextToken=token)
+ data = dict(Action="ListInventorySupplyByNextToken", NextToken=token)
return self.make_request(data, "POST")
@@ -598,10 +646,10 @@ class OutboundShipments(MWS):
class Recommendations(MWS):
- """ Amazon MWS Recommendations API """
+ """Amazon MWS Recommendations API"""
- URI = '/Recommendations/2013-04-01'
- VERSION = '2013-04-01'
+ URI = "/Recommendations/2013-04-01"
+ VERSION = "2013-04-01"
NS = "{https://mws.amazonservices.com/Recommendations/2013-04-01}"
def get_last_updated_time_for_recommendations(self, marketplaceid):
@@ -610,8 +658,7 @@ class Recommendations(MWS):
returns the time when recommendations were last updated for each category.
"""
- data = dict(Action='GetLastUpdatedTimeForRecommendations',
- MarketplaceId=marketplaceid)
+ data = dict(Action="GetLastUpdatedTimeForRecommendations", MarketplaceId=marketplaceid)
return self.make_request(data, "POST")
def list_recommendations(self, marketplaceid, recommendationcategory=None):
@@ -619,9 +666,11 @@ class Recommendations(MWS):
Returns your active recommendations for a specific category or for all categories for a specific marketplace.
"""
- data = dict(Action="ListRecommendations",
- MarketplaceId=marketplaceid,
- RecommendationCategory=recommendationcategory)
+ data = dict(
+ Action="ListRecommendations",
+ MarketplaceId=marketplaceid,
+ RecommendationCategory=recommendationcategory,
+ )
return self.make_request(data, "POST")
def list_recommendations_by_next_token(self, token):
@@ -629,23 +678,26 @@ class Recommendations(MWS):
Returns the next page of recommendations using the NextToken parameter.
"""
- data = dict(Action="ListRecommendationsByNextToken",
- NextToken=token)
+ data = dict(Action="ListRecommendationsByNextToken", NextToken=token)
return self.make_request(data, "POST")
+
class Finances(MWS):
- """ Amazon Finances API"""
- URI = '/Finances/2015-05-01'
- VERSION = '2015-05-01'
+ """Amazon Finances API"""
+
+ URI = "/Finances/2015-05-01"
+ VERSION = "2015-05-01"
NS = "{https://mws.amazonservices.com/Finances/2015-05-01}"
- def list_financial_events(self , posted_after=None, posted_before=None,
- amazon_order_id=None, max_results='100'):
+ def list_financial_events(
+ self, posted_after=None, posted_before=None, amazon_order_id=None, max_results="100"
+ ):
- data = dict(Action='ListFinancialEvents',
- PostedAfter=posted_after,
- PostedBefore=posted_before,
- AmazonOrderId=amazon_order_id,
- MaxResultsPerPage=max_results,
- )
+ data = dict(
+ Action="ListFinancialEvents",
+ PostedAfter=posted_after,
+ PostedBefore=posted_before,
+ AmazonOrderId=amazon_order_id,
+ MaxResultsPerPage=max_results,
+ )
return self.make_request(data)
diff --git a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_settings.js b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_settings.js
index f5ea8047c6a..a15558bc2b6 100644
--- a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_settings.js
+++ b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_settings.js
@@ -1,2 +1,10 @@
// Copyright (c) 2018, Frappe Technologies Pvt. Ltd. and contributors
// For license information, please see license.txt
+
+
+frappe.ui.form.on('Amazon MWS Settings', {
+ refresh: function (frm) {
+ let app_link = "Ecommerce Integrations"
+ frm.dashboard.add_comment(__("Amazon MWS Integration will be removed from ERPNext in Version 14. Please install {0} app to continue using it.", [app_link]), "yellow", true);
+ }
+});
diff --git a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_settings.py b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_settings.py
index c1f460f49b6..c6af23d915f 100644
--- a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_settings.py
+++ b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/amazon_mws_settings.py
@@ -21,26 +21,49 @@ class AmazonMWSSettings(Document):
@frappe.whitelist()
def get_products_details(self):
if self.enable_amazon == 1:
- frappe.enqueue('erpnext.erpnext_integrations.doctype.amazon_mws_settings.amazon_methods.get_products_details')
+ frappe.enqueue(
+ "erpnext.erpnext_integrations.doctype.amazon_mws_settings.amazon_methods.get_products_details"
+ )
@frappe.whitelist()
def get_order_details(self):
if self.enable_amazon == 1:
after_date = dateutil.parser.parse(self.after_date).strftime("%Y-%m-%d")
- frappe.enqueue('erpnext.erpnext_integrations.doctype.amazon_mws_settings.amazon_methods.get_orders', after_date=after_date)
+ frappe.enqueue(
+ "erpnext.erpnext_integrations.doctype.amazon_mws_settings.amazon_methods.get_orders",
+ after_date=after_date,
+ )
+
def schedule_get_order_details():
mws_settings = frappe.get_doc("Amazon MWS Settings")
if mws_settings.enable_sync and mws_settings.enable_amazon:
after_date = dateutil.parser.parse(mws_settings.after_date).strftime("%Y-%m-%d")
- get_orders(after_date = after_date)
+ get_orders(after_date=after_date)
+
def setup_custom_fields():
custom_fields = {
- "Item": [dict(fieldname='amazon_item_code', label='Amazon Item Code',
- fieldtype='Data', insert_after='series', read_only=1, print_hide=1)],
- "Sales Order": [dict(fieldname='amazon_order_id', label='Amazon Order ID',
- fieldtype='Data', insert_after='title', read_only=1, print_hide=1)]
+ "Item": [
+ dict(
+ fieldname="amazon_item_code",
+ label="Amazon Item Code",
+ fieldtype="Data",
+ insert_after="series",
+ read_only=1,
+ print_hide=1,
+ )
+ ],
+ "Sales Order": [
+ dict(
+ fieldname="amazon_order_id",
+ label="Amazon Order ID",
+ fieldtype="Data",
+ insert_after="title",
+ read_only=1,
+ print_hide=1,
+ )
+ ],
}
create_custom_fields(custom_fields)
diff --git a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/xml_utils.py b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/xml_utils.py
index d9dfc6f72d4..f44be61f481 100644
--- a/erpnext/erpnext_integrations/doctype/amazon_mws_settings/xml_utils.py
+++ b/erpnext/erpnext_integrations/doctype/amazon_mws_settings/xml_utils.py
@@ -19,11 +19,12 @@ class object_dict(dict):
>>> a['water'] = 'water'
>>> a.water
'water'
- >>> a.test = {'value': 1}
+ >>> a.test = {'value': 1}
>>> a.test2 = object_dict({'name': 'test2', 'value': 2})
>>> a.test, a.test2.name, a.test2.value
(1, 'test2', 2)
"""
+
def __init__(self, initd=None):
if initd is None:
initd = {}
@@ -36,8 +37,8 @@ class object_dict(dict):
except KeyError:
return None
- if isinstance(d, dict) and 'value' in d and len(d) == 1:
- return d['value']
+ if isinstance(d, dict) and "value" in d and len(d) == 1:
+ return d["value"]
else:
return d
@@ -49,11 +50,10 @@ class object_dict(dict):
self.__setitem__(item, value)
def getvalue(self, item, value=None):
- return self.get(item, {}).get('value', value)
+ return self.get(item, {}).get("value", value)
class xml2dict(object):
-
def __init__(self):
pass
@@ -63,12 +63,11 @@ class xml2dict(object):
if node.text:
node_tree.value = node.text
for (k, v) in node.attrib.items():
- k, v = self._namespace_split(k, object_dict({'value':v}))
+ k, v = self._namespace_split(k, object_dict({"value": v}))
node_tree[k] = v
- #Save childrens
+ # Save childrens
for child in node.getchildren():
- tag, tree = self._namespace_split(child.tag,
- self._parse_node(child))
+ tag, tree = self._namespace_split(child.tag, self._parse_node(child))
if tag not in node_tree: # the first time, so store it in dict
node_tree[tag] = tree
continue
@@ -94,7 +93,7 @@ class xml2dict(object):
def parse(self, file):
"""parse a xml file to a dict"""
- f = open(file, 'r')
+ f = open(file, "r")
return self.fromstring(f.read())
def fromstring(self, s):
diff --git a/erpnext/erpnext_integrations/doctype/exotel_settings/exotel_settings.py b/erpnext/erpnext_integrations/doctype/exotel_settings/exotel_settings.py
index e84093cae09..4879cb56239 100644
--- a/erpnext/erpnext_integrations/doctype/exotel_settings/exotel_settings.py
+++ b/erpnext/erpnext_integrations/doctype/exotel_settings/exotel_settings.py
@@ -14,7 +14,9 @@ class ExotelSettings(Document):
def verify_credentials(self):
if self.enabled:
- response = requests.get('https://api.exotel.com/v1/Accounts/{sid}'
- .format(sid = self.account_sid), auth=(self.api_key, self.api_token))
+ response = requests.get(
+ "https://api.exotel.com/v1/Accounts/{sid}".format(sid=self.account_sid),
+ auth=(self.api_key, self.api_token),
+ )
if response.status_code != 200:
frappe.throw(_("Invalid credentials"))
diff --git a/erpnext/erpnext_integrations/doctype/gocardless_settings/__init__.py b/erpnext/erpnext_integrations/doctype/gocardless_settings/__init__.py
index bb62c395a5b..65be5993ffc 100644
--- a/erpnext/erpnext_integrations/doctype/gocardless_settings/__init__.py
+++ b/erpnext/erpnext_integrations/doctype/gocardless_settings/__init__.py
@@ -23,12 +23,15 @@ def webhooks():
set_status(event)
return 200
+
+
def set_status(event):
resource_type = event.get("resource_type", {})
if resource_type == "mandates":
set_mandate_status(event)
+
def set_mandate_status(event):
mandates = []
if isinstance(event["links"], (list,)):
@@ -37,7 +40,12 @@ def set_mandate_status(event):
else:
mandates.append(event["links"]["mandate"])
- if event["action"] == "pending_customer_approval" or event["action"] == "pending_submission" or event["action"] == "submitted" or event["action"] == "active":
+ if (
+ event["action"] == "pending_customer_approval"
+ or event["action"] == "pending_submission"
+ or event["action"] == "submitted"
+ or event["action"] == "active"
+ ):
disabled = 0
else:
disabled = 1
@@ -45,6 +53,7 @@ def set_mandate_status(event):
for mandate in mandates:
frappe.db.set_value("GoCardless Mandate", mandate, "disabled", disabled)
+
def authenticate_signature(r):
"""Returns True if the received signature matches the generated signature"""
received_signature = frappe.get_request_header("Webhook-Signature")
@@ -59,13 +68,22 @@ def authenticate_signature(r):
return False
+
def get_webhook_keys():
def _get_webhook_keys():
- webhook_keys = [d.webhooks_secret for d in frappe.get_all("GoCardless Settings", fields=["webhooks_secret"],) if d.webhooks_secret]
+ webhook_keys = [
+ d.webhooks_secret
+ for d in frappe.get_all(
+ "GoCardless Settings",
+ fields=["webhooks_secret"],
+ )
+ if d.webhooks_secret
+ ]
return webhook_keys
return frappe.cache().get_value("gocardless_webhooks_secret", _get_webhook_keys)
+
def clear_cache():
frappe.cache().delete_value("gocardless_webhooks_secret")
diff --git a/erpnext/erpnext_integrations/doctype/gocardless_settings/gocardless_settings.py b/erpnext/erpnext_integrations/doctype/gocardless_settings/gocardless_settings.py
index e242ace60f7..797534a9bc7 100644
--- a/erpnext/erpnext_integrations/doctype/gocardless_settings/gocardless_settings.py
+++ b/erpnext/erpnext_integrations/doctype/gocardless_settings/gocardless_settings.py
@@ -12,7 +12,7 @@ from six.moves.urllib.parse import urlencode
class GoCardlessSettings(Document):
- supported_currencies = ["EUR", "DKK", "GBP", "SEK"]
+ supported_currencies = ["EUR", "DKK", "GBP", "SEK", "AUD", "NZD", "CAD", "USD"]
def validate(self):
self.initialize_client()
@@ -21,32 +21,35 @@ class GoCardlessSettings(Document):
self.environment = self.get_environment()
try:
self.client = gocardless_pro.Client(
- access_token=self.access_token,
- environment=self.environment
- )
+ access_token=self.access_token, environment=self.environment
+ )
return self.client
except Exception as e:
frappe.throw(e)
def on_update(self):
- create_payment_gateway('GoCardless-' + self.gateway_name, settings='GoCardLess Settings', controller=self.gateway_name)
- call_hook_method('payment_gateway_enabled', gateway='GoCardless-' + self.gateway_name)
+ create_payment_gateway(
+ "GoCardless-" + self.gateway_name, settings="GoCardLess Settings", controller=self.gateway_name
+ )
+ call_hook_method("payment_gateway_enabled", gateway="GoCardless-" + self.gateway_name)
def on_payment_request_submission(self, data):
if data.reference_doctype != "Fees":
- customer_data = frappe.db.get_value(data.reference_doctype, data.reference_name, ["company", "customer_name"], as_dict=1)
+ customer_data = frappe.db.get_value(
+ data.reference_doctype, data.reference_name, ["company", "customer_name"], as_dict=1
+ )
data = {
- "amount": flt(data.grand_total, data.precision("grand_total")),
- "title": customer_data.company.encode("utf-8"),
- "description": data.subject.encode("utf-8"),
- "reference_doctype": data.doctype,
- "reference_docname": data.name,
- "payer_email": data.email_to or frappe.session.user,
- "payer_name": customer_data.customer_name,
- "order_id": data.name,
- "currency": data.currency
- }
+ "amount": flt(data.grand_total, data.precision("grand_total")),
+ "title": customer_data.company.encode("utf-8"),
+ "description": data.subject.encode("utf-8"),
+ "reference_doctype": data.doctype,
+ "reference_docname": data.name,
+ "payer_email": data.email_to or frappe.session.user,
+ "payer_name": customer_data.customer_name,
+ "order_id": data.name,
+ "currency": data.currency,
+ }
valid_mandate = self.check_mandate_validity(data)
if valid_mandate is not None:
@@ -59,12 +62,19 @@ class GoCardlessSettings(Document):
def check_mandate_validity(self, data):
- if frappe.db.exists("GoCardless Mandate", dict(customer=data.get('payer_name'), disabled=0)):
- registered_mandate = frappe.db.get_value("GoCardless Mandate", dict(customer=data.get('payer_name'), disabled=0), 'mandate')
+ if frappe.db.exists("GoCardless Mandate", dict(customer=data.get("payer_name"), disabled=0)):
+ registered_mandate = frappe.db.get_value(
+ "GoCardless Mandate", dict(customer=data.get("payer_name"), disabled=0), "mandate"
+ )
self.initialize_client()
mandate = self.client.mandates.get(registered_mandate)
- if mandate.status=="pending_customer_approval" or mandate.status=="pending_submission" or mandate.status=="submitted" or mandate.status=="active":
+ if (
+ mandate.status == "pending_customer_approval"
+ or mandate.status == "pending_submission"
+ or mandate.status == "submitted"
+ or mandate.status == "active"
+ ):
return {"mandate": registered_mandate}
else:
return None
@@ -73,13 +83,17 @@ class GoCardlessSettings(Document):
def get_environment(self):
if self.use_sandbox:
- return 'sandbox'
+ return "sandbox"
else:
- return 'live'
+ return "live"
def validate_transaction_currency(self, currency):
if currency not in self.supported_currencies:
- frappe.throw(_("Please select another payment method. Stripe does not support transactions in currency '{0}'").format(currency))
+ frappe.throw(
+ _(
+ "Please select another payment method. Go Cardless does not support transactions in currency '{0}'"
+ ).format(currency)
+ )
def get_payment_url(self, **kwargs):
return get_url("./integrations/gocardless_checkout?{0}".format(urlencode(kwargs)))
@@ -93,63 +107,85 @@ class GoCardlessSettings(Document):
except Exception:
frappe.log_error(frappe.get_traceback())
- return{
- "redirect_to": frappe.redirect_to_message(_('Server Error'), _("There seems to be an issue with the server's GoCardless configuration. Don't worry, in case of failure, the amount will get refunded to your account.")),
- "status": 401
+ return {
+ "redirect_to": frappe.redirect_to_message(
+ _("Server Error"),
+ _(
+ "There seems to be an issue with the server's GoCardless configuration. Don't worry, in case of failure, the amount will get refunded to your account."
+ ),
+ ),
+ "status": 401,
}
def create_charge_on_gocardless(self):
- redirect_to = self.data.get('redirect_to') or None
- redirect_message = self.data.get('redirect_message') or None
+ redirect_to = self.data.get("redirect_to") or None
+ redirect_message = self.data.get("redirect_message") or None
- reference_doc = frappe.get_doc(self.data.get('reference_doctype'), self.data.get('reference_docname'))
+ reference_doc = frappe.get_doc(
+ self.data.get("reference_doctype"), self.data.get("reference_docname")
+ )
self.initialize_client()
try:
payment = self.client.payments.create(
params={
- "amount" : cint(reference_doc.grand_total * 100),
- "currency" : reference_doc.currency,
- "links" : {
- "mandate": self.data.get('mandate')
- },
+ "amount": cint(reference_doc.grand_total * 100),
+ "currency": reference_doc.currency,
+ "links": {"mandate": self.data.get("mandate")},
"metadata": {
- "reference_doctype": reference_doc.doctype,
- "reference_document": reference_doc.name
- }
- }, headers={
- 'Idempotency-Key' : self.data.get('reference_docname'),
- })
+ "reference_doctype": reference_doc.doctype,
+ "reference_document": reference_doc.name,
+ },
+ },
+ headers={
+ "Idempotency-Key": self.data.get("reference_docname"),
+ },
+ )
- if payment.status=="pending_submission" or payment.status=="pending_customer_approval" or payment.status=="submitted":
- self.integration_request.db_set('status', 'Authorized', update_modified=False)
+ if (
+ payment.status == "pending_submission"
+ or payment.status == "pending_customer_approval"
+ or payment.status == "submitted"
+ ):
+ self.integration_request.db_set("status", "Authorized", update_modified=False)
self.flags.status_changed_to = "Completed"
- self.integration_request.db_set('output', payment.status, update_modified=False)
+ self.integration_request.db_set("output", payment.status, update_modified=False)
- elif payment.status=="confirmed" or payment.status=="paid_out":
- self.integration_request.db_set('status', 'Completed', update_modified=False)
+ elif payment.status == "confirmed" or payment.status == "paid_out":
+ self.integration_request.db_set("status", "Completed", update_modified=False)
self.flags.status_changed_to = "Completed"
- self.integration_request.db_set('output', payment.status, update_modified=False)
+ self.integration_request.db_set("output", payment.status, update_modified=False)
- elif payment.status=="cancelled" or payment.status=="customer_approval_denied" or payment.status=="charged_back":
- self.integration_request.db_set('status', 'Cancelled', update_modified=False)
- frappe.log_error(_("Payment Cancelled. Please check your GoCardless Account for more details"), "GoCardless Payment Error")
- self.integration_request.db_set('error', payment.status, update_modified=False)
+ elif (
+ payment.status == "cancelled"
+ or payment.status == "customer_approval_denied"
+ or payment.status == "charged_back"
+ ):
+ self.integration_request.db_set("status", "Cancelled", update_modified=False)
+ frappe.log_error(
+ _("Payment Cancelled. Please check your GoCardless Account for more details"),
+ "GoCardless Payment Error",
+ )
+ self.integration_request.db_set("error", payment.status, update_modified=False)
else:
- self.integration_request.db_set('status', 'Failed', update_modified=False)
- frappe.log_error(_("Payment Failed. Please check your GoCardless Account for more details"), "GoCardless Payment Error")
- self.integration_request.db_set('error', payment.status, update_modified=False)
+ self.integration_request.db_set("status", "Failed", update_modified=False)
+ frappe.log_error(
+ _("Payment Failed. Please check your GoCardless Account for more details"),
+ "GoCardless Payment Error",
+ )
+ self.integration_request.db_set("error", payment.status, update_modified=False)
except Exception as e:
frappe.log_error(e, "GoCardless Payment Error")
if self.flags.status_changed_to == "Completed":
- status = 'Completed'
- if 'reference_doctype' in self.data and 'reference_docname' in self.data:
+ status = "Completed"
+ if "reference_doctype" in self.data and "reference_docname" in self.data:
custom_redirect_to = None
try:
- custom_redirect_to = frappe.get_doc(self.data.get('reference_doctype'),
- self.data.get('reference_docname')).run_method("on_payment_authorized", self.flags.status_changed_to)
+ custom_redirect_to = frappe.get_doc(
+ self.data.get("reference_doctype"), self.data.get("reference_docname")
+ ).run_method("on_payment_authorized", self.flags.status_changed_to)
except Exception:
frappe.log_error(frappe.get_traceback())
@@ -158,24 +194,25 @@ class GoCardlessSettings(Document):
redirect_url = redirect_to
else:
- status = 'Error'
- redirect_url = 'payment-failed'
+ status = "Error"
+ redirect_url = "payment-failed"
if redirect_message:
- redirect_url += '&' + urlencode({'redirect_message': redirect_message})
+ redirect_url += "&" + urlencode({"redirect_message": redirect_message})
redirect_url = get_url(redirect_url)
- return {
- "redirect_to": redirect_url,
- "status": status
- }
+ return {"redirect_to": redirect_url, "status": status}
+
def get_gateway_controller(doc):
payment_request = frappe.get_doc("Payment Request", doc)
- gateway_controller = frappe.db.get_value("Payment Gateway", payment_request.payment_gateway, "gateway_controller")
+ gateway_controller = frappe.db.get_value(
+ "Payment Gateway", payment_request.payment_gateway, "gateway_controller"
+ )
return gateway_controller
+
def gocardless_initialization(doc):
gateway_controller = get_gateway_controller(doc)
settings = frappe.get_doc("GoCardless Settings", gateway_controller)
diff --git a/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_connector.py b/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_connector.py
index 6d46a1c884a..a577e7fa692 100644
--- a/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_connector.py
+++ b/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_connector.py
@@ -5,9 +5,15 @@ import requests
from requests.auth import HTTPBasicAuth
-class MpesaConnector():
- def __init__(self, env="sandbox", app_key=None, app_secret=None, sandbox_url="https://sandbox.safaricom.co.ke",
- live_url="https://api.safaricom.co.ke"):
+class MpesaConnector:
+ def __init__(
+ self,
+ env="sandbox",
+ app_key=None,
+ app_secret=None,
+ sandbox_url="https://sandbox.safaricom.co.ke",
+ live_url="https://api.safaricom.co.ke",
+ ):
"""Setup configuration for Mpesa connector and generate new access token."""
self.env = env
self.app_key = app_key
@@ -23,36 +29,41 @@ class MpesaConnector():
This method is used to fetch the access token required by Mpesa.
Returns:
- access_token (str): This token is to be used with the Bearer header for further API calls to Mpesa.
+ access_token (str): This token is to be used with the Bearer header for further API calls to Mpesa.
"""
authenticate_uri = "/oauth/v1/generate?grant_type=client_credentials"
authenticate_url = "{0}{1}".format(self.base_url, authenticate_uri)
- r = requests.get(
- authenticate_url,
- auth=HTTPBasicAuth(self.app_key, self.app_secret)
- )
- self.authentication_token = r.json()['access_token']
- return r.json()['access_token']
+ r = requests.get(authenticate_url, auth=HTTPBasicAuth(self.app_key, self.app_secret))
+ self.authentication_token = r.json()["access_token"]
+ return r.json()["access_token"]
- def get_balance(self, initiator=None, security_credential=None, party_a=None, identifier_type=None,
- remarks=None, queue_timeout_url=None,result_url=None):
+ def get_balance(
+ self,
+ initiator=None,
+ security_credential=None,
+ party_a=None,
+ identifier_type=None,
+ remarks=None,
+ queue_timeout_url=None,
+ result_url=None,
+ ):
"""
This method uses Mpesa's Account Balance API to to enquire the balance on a M-Pesa BuyGoods (Till Number).
Args:
- initiator (str): Username used to authenticate the transaction.
- security_credential (str): Generate from developer portal.
- command_id (str): AccountBalance.
- party_a (int): Till number being queried.
- identifier_type (int): Type of organization receiving the transaction. (MSISDN/Till Number/Organization short code)
- remarks (str): Comments that are sent along with the transaction(maximum 100 characters).
- queue_timeout_url (str): The url that handles information of timed out transactions.
- result_url (str): The url that receives results from M-Pesa api call.
+ initiator (str): Username used to authenticate the transaction.
+ security_credential (str): Generate from developer portal.
+ command_id (str): AccountBalance.
+ party_a (int): Till number being queried.
+ identifier_type (int): Type of organization receiving the transaction. (MSISDN/Till Number/Organization short code)
+ remarks (str): Comments that are sent along with the transaction(maximum 100 characters).
+ queue_timeout_url (str): The url that handles information of timed out transactions.
+ result_url (str): The url that receives results from M-Pesa api call.
Returns:
- OriginatorConverstionID (str): The unique request ID for tracking a transaction.
- ConversationID (str): The unique request ID returned by mpesa for each request made
- ResponseDescription (str): Response Description message
+ OriginatorConverstionID (str): The unique request ID for tracking a transaction.
+ ConversationID (str): The unique request ID returned by mpesa for each request made
+ ResponseDescription (str): Response Description message
"""
payload = {
@@ -63,43 +74,56 @@ class MpesaConnector():
"IdentifierType": identifier_type,
"Remarks": remarks,
"QueueTimeOutURL": queue_timeout_url,
- "ResultURL": result_url
+ "ResultURL": result_url,
+ }
+ headers = {
+ "Authorization": "Bearer {0}".format(self.authentication_token),
+ "Content-Type": "application/json",
}
- headers = {'Authorization': 'Bearer {0}'.format(self.authentication_token), 'Content-Type': "application/json"}
saf_url = "{0}{1}".format(self.base_url, "/mpesa/accountbalance/v1/query")
r = requests.post(saf_url, headers=headers, json=payload)
return r.json()
- def stk_push(self, business_shortcode=None, passcode=None, amount=None, callback_url=None, reference_code=None,
- phone_number=None, description=None):
+ def stk_push(
+ self,
+ business_shortcode=None,
+ passcode=None,
+ amount=None,
+ callback_url=None,
+ reference_code=None,
+ phone_number=None,
+ description=None,
+ ):
"""
This method uses Mpesa's Express API to initiate online payment on behalf of a customer.
Args:
- business_shortcode (int): The short code of the organization.
- passcode (str): Get from developer portal
- amount (int): The amount being transacted
- callback_url (str): A CallBack URL is a valid secure URL that is used to receive notifications from M-Pesa API.
- reference_code(str): Account Reference: This is an Alpha-Numeric parameter that is defined by your system as an Identifier of the transaction for CustomerPayBillOnline transaction type.
- phone_number(int): The Mobile Number to receive the STK Pin Prompt.
- description(str): This is any additional information/comment that can be sent along with the request from your system. MAX 13 characters
+ business_shortcode (int): The short code of the organization.
+ passcode (str): Get from developer portal
+ amount (int): The amount being transacted
+ callback_url (str): A CallBack URL is a valid secure URL that is used to receive notifications from M-Pesa API.
+ reference_code(str): Account Reference: This is an Alpha-Numeric parameter that is defined by your system as an Identifier of the transaction for CustomerPayBillOnline transaction type.
+ phone_number(int): The Mobile Number to receive the STK Pin Prompt.
+ description(str): This is any additional information/comment that can be sent along with the request from your system. MAX 13 characters
Success Response:
- CustomerMessage(str): Messages that customers can understand.
- CheckoutRequestID(str): This is a global unique identifier of the processed checkout transaction request.
- ResponseDescription(str): Describes Success or failure
- MerchantRequestID(str): This is a global unique Identifier for any submitted payment request.
- ResponseCode(int): 0 means success all others are error codes. e.g.404.001.03
+ CustomerMessage(str): Messages that customers can understand.
+ CheckoutRequestID(str): This is a global unique identifier of the processed checkout transaction request.
+ ResponseDescription(str): Describes Success or failure
+ MerchantRequestID(str): This is a global unique Identifier for any submitted payment request.
+ ResponseCode(int): 0 means success all others are error codes. e.g.404.001.03
Error Reponse:
- requestId(str): This is a unique requestID for the payment request
- errorCode(str): This is a predefined code that indicates the reason for request failure.
- errorMessage(str): This is a predefined code that indicates the reason for request failure.
+ requestId(str): This is a unique requestID for the payment request
+ errorCode(str): This is a predefined code that indicates the reason for request failure.
+ errorMessage(str): This is a predefined code that indicates the reason for request failure.
"""
- time = str(datetime.datetime.now()).split(".")[0].replace("-", "").replace(" ", "").replace(":", "")
+ time = (
+ str(datetime.datetime.now()).split(".")[0].replace("-", "").replace(" ", "").replace(":", "")
+ )
password = "{0}{1}{2}".format(str(business_shortcode), str(passcode), time)
- encoded = base64.b64encode(bytes(password, encoding='utf8'))
+ encoded = base64.b64encode(bytes(password, encoding="utf8"))
payload = {
"BusinessShortCode": business_shortcode,
"Password": encoded.decode("utf-8"),
@@ -111,9 +135,14 @@ class MpesaConnector():
"CallBackURL": callback_url,
"AccountReference": reference_code,
"TransactionDesc": description,
- "TransactionType": "CustomerPayBillOnline" if self.env == "sandbox" else "CustomerBuyGoodsOnline"
+ "TransactionType": "CustomerPayBillOnline"
+ if self.env == "sandbox"
+ else "CustomerBuyGoodsOnline",
+ }
+ headers = {
+ "Authorization": "Bearer {0}".format(self.authentication_token),
+ "Content-Type": "application/json",
}
- headers = {'Authorization': 'Bearer {0}'.format(self.authentication_token), 'Content-Type': "application/json"}
saf_url = "{0}{1}".format(self.base_url, "/mpesa/stkpush/v1/processrequest")
r = requests.post(saf_url, headers=headers, json=payload)
diff --git a/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_custom_fields.py b/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_custom_fields.py
index 368139b872f..c92edc5efae 100644
--- a/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_custom_fields.py
+++ b/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_custom_fields.py
@@ -11,21 +11,22 @@ def create_custom_pos_fields():
"label": "Request for Payment",
"fieldtype": "Button",
"hidden": 1,
- "insert_after": "contact_email"
+ "insert_after": "contact_email",
},
{
"fieldname": "mpesa_receipt_number",
"label": "Mpesa Receipt Number",
"fieldtype": "Data",
"read_only": 1,
- "insert_after": "company"
- }
+ "insert_after": "company",
+ },
]
}
if not frappe.get_meta("POS Invoice").has_field("request_for_payment"):
create_custom_fields(pos_field)
- record_dict = [{
+ record_dict = [
+ {
"doctype": "POS Field",
"fieldname": "contact_mobile",
"label": "Mobile No",
@@ -33,7 +34,7 @@ def create_custom_pos_fields():
"options": "Phone",
"parenttype": "POS Settings",
"parent": "POS Settings",
- "parentfield": "invoice_fields"
+ "parentfield": "invoice_fields",
},
{
"doctype": "POS Field",
@@ -42,11 +43,12 @@ def create_custom_pos_fields():
"fieldtype": "Button",
"parenttype": "POS Settings",
"parent": "POS Settings",
- "parentfield": "invoice_fields"
- }
+ "parentfield": "invoice_fields",
+ },
]
create_pos_settings(record_dict)
+
def create_pos_settings(record_dict):
for record in record_dict:
if frappe.db.exists("POS Field", {"fieldname": record.get("fieldname")}):
diff --git a/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_settings.py b/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_settings.py
index e7b4a30e0a5..78a598ce985 100644
--- a/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_settings.py
+++ b/erpnext/erpnext_integrations/doctype/mpesa_settings/mpesa_settings.py
@@ -2,7 +2,6 @@
# For license information, please see license.txt
-
from json import dumps, loads
import frappe
@@ -23,16 +22,26 @@ class MpesaSettings(Document):
def validate_transaction_currency(self, currency):
if currency not in self.supported_currencies:
- frappe.throw(_("Please select another payment method. Mpesa does not support transactions in currency '{0}'").format(currency))
+ frappe.throw(
+ _(
+ "Please select another payment method. Mpesa does not support transactions in currency '{0}'"
+ ).format(currency)
+ )
def on_update(self):
create_custom_pos_fields()
- create_payment_gateway('Mpesa-' + self.payment_gateway_name, settings='Mpesa Settings', controller=self.payment_gateway_name)
- call_hook_method('payment_gateway_enabled', gateway='Mpesa-' + self.payment_gateway_name, payment_channel="Phone")
+ create_payment_gateway(
+ "Mpesa-" + self.payment_gateway_name,
+ settings="Mpesa Settings",
+ controller=self.payment_gateway_name,
+ )
+ call_hook_method(
+ "payment_gateway_enabled", gateway="Mpesa-" + self.payment_gateway_name, payment_channel="Phone"
+ )
# required to fetch the bank account details from the payment gateway account
frappe.db.commit()
- create_mode_of_payment('Mpesa-' + self.payment_gateway_name, payment_type="Phone")
+ create_mode_of_payment("Mpesa-" + self.payment_gateway_name, payment_type="Phone")
def request_for_payment(self, **kwargs):
args = frappe._dict(kwargs)
@@ -44,6 +53,7 @@ class MpesaSettings(Document):
from erpnext.erpnext_integrations.doctype.mpesa_settings.test_mpesa_settings import (
get_payment_request_response_payload,
)
+
response = frappe._dict(get_payment_request_response_payload(amount))
else:
response = frappe._dict(generate_stk_push(**args))
@@ -55,11 +65,15 @@ class MpesaSettings(Document):
if request_amount > self.transaction_limit:
# make multiple requests
request_amounts = []
- requests_to_be_made = frappe.utils.ceil(request_amount / self.transaction_limit) # 480/150 = ceil(3.2) = 4
+ requests_to_be_made = frappe.utils.ceil(
+ request_amount / self.transaction_limit
+ ) # 480/150 = ceil(3.2) = 4
for i in range(requests_to_be_made):
amount = self.transaction_limit
if i == requests_to_be_made - 1:
- amount = request_amount - (self.transaction_limit * i) # for 4th request, 480 - (150 * 3) = 30
+ amount = request_amount - (
+ self.transaction_limit * i
+ ) # for 4th request, 480 - (150 * 3) = 30
request_amounts.append(amount)
else:
request_amounts = [request_amount]
@@ -69,15 +83,14 @@ class MpesaSettings(Document):
@frappe.whitelist()
def get_account_balance_info(self):
payload = dict(
- reference_doctype="Mpesa Settings",
- reference_docname=self.name,
- doc_details=vars(self)
+ reference_doctype="Mpesa Settings", reference_docname=self.name, doc_details=vars(self)
)
if frappe.flags.in_test:
from erpnext.erpnext_integrations.doctype.mpesa_settings.test_mpesa_settings import (
get_test_account_balance_response,
)
+
response = frappe._dict(get_test_account_balance_response())
else:
response = frappe._dict(get_account_balance(payload))
@@ -95,46 +108,62 @@ class MpesaSettings(Document):
req_name = getattr(response, global_id)
error = None
- if not frappe.db.exists('Integration Request', req_name):
+ if not frappe.db.exists("Integration Request", req_name):
create_request_log(request_dict, "Host", "Mpesa", req_name, error)
if error:
frappe.throw(_(getattr(response, "errorMessage")), title=_("Transaction Error"))
+
def generate_stk_push(**kwargs):
"""Generate stk push by making a API call to the stk push API."""
args = frappe._dict(kwargs)
try:
- callback_url = get_request_site_address(True) + "/api/method/erpnext.erpnext_integrations.doctype.mpesa_settings.mpesa_settings.verify_transaction"
+ callback_url = (
+ get_request_site_address(True)
+ + "/api/method/erpnext.erpnext_integrations.doctype.mpesa_settings.mpesa_settings.verify_transaction"
+ )
mpesa_settings = frappe.get_doc("Mpesa Settings", args.payment_gateway[6:])
env = "production" if not mpesa_settings.sandbox else "sandbox"
# for sandbox, business shortcode is same as till number
- business_shortcode = mpesa_settings.business_shortcode if env == "production" else mpesa_settings.till_number
+ business_shortcode = (
+ mpesa_settings.business_shortcode if env == "production" else mpesa_settings.till_number
+ )
- connector = MpesaConnector(env=env,
+ connector = MpesaConnector(
+ env=env,
app_key=mpesa_settings.consumer_key,
- app_secret=mpesa_settings.get_password("consumer_secret"))
+ app_secret=mpesa_settings.get_password("consumer_secret"),
+ )
mobile_number = sanitize_mobile_number(args.sender)
response = connector.stk_push(
- business_shortcode=business_shortcode, amount=args.request_amount,
+ business_shortcode=business_shortcode,
+ amount=args.request_amount,
passcode=mpesa_settings.get_password("online_passkey"),
- callback_url=callback_url, reference_code=mpesa_settings.till_number,
- phone_number=mobile_number, description="POS Payment"
+ callback_url=callback_url,
+ reference_code=mpesa_settings.till_number,
+ phone_number=mobile_number,
+ description="POS Payment",
)
return response
except Exception:
frappe.log_error(title=_("Mpesa Express Transaction Error"))
- frappe.throw(_("Issue detected with Mpesa configuration, check the error logs for more details"), title=_("Mpesa Express Error"))
+ frappe.throw(
+ _("Issue detected with Mpesa configuration, check the error logs for more details"),
+ title=_("Mpesa Express Error"),
+ )
+
def sanitize_mobile_number(number):
"""Add country code and strip leading zeroes from the phone number."""
return "254" + str(number).lstrip("0")
+
@frappe.whitelist(allow_guest=True)
def verify_transaction(**kwargs):
"""Verify the transaction result received via callback from stk."""
@@ -146,28 +175,28 @@ def verify_transaction(**kwargs):
integration_request = frappe.get_doc("Integration Request", checkout_id)
transaction_data = frappe._dict(loads(integration_request.data))
- total_paid = 0 # for multiple integration request made against a pos invoice
- success = False # for reporting successfull callback to point of sale ui
+ total_paid = 0 # for multiple integration request made against a pos invoice
+ success = False # for reporting successfull callback to point of sale ui
- if transaction_response['ResultCode'] == 0:
+ if transaction_response["ResultCode"] == 0:
if integration_request.reference_doctype and integration_request.reference_docname:
try:
item_response = transaction_response["CallbackMetadata"]["Item"]
amount = fetch_param_value(item_response, "Amount", "Name")
mpesa_receipt = fetch_param_value(item_response, "MpesaReceiptNumber", "Name")
- pr = frappe.get_doc(integration_request.reference_doctype, integration_request.reference_docname)
+ pr = frappe.get_doc(
+ integration_request.reference_doctype, integration_request.reference_docname
+ )
mpesa_receipts, completed_payments = get_completed_integration_requests_info(
- integration_request.reference_doctype,
- integration_request.reference_docname,
- checkout_id
+ integration_request.reference_doctype, integration_request.reference_docname, checkout_id
)
total_paid = amount + sum(completed_payments)
- mpesa_receipts = ', '.join(mpesa_receipts + [mpesa_receipt])
+ mpesa_receipts = ", ".join(mpesa_receipts + [mpesa_receipt])
if total_paid >= pr.grand_total:
- pr.run_method("on_payment_authorized", 'Completed')
+ pr.run_method("on_payment_authorized", "Completed")
success = True
frappe.db.set_value("POS Invoice", pr.reference_name, "mpesa_receipt_number", mpesa_receipts)
@@ -180,24 +209,31 @@ def verify_transaction(**kwargs):
integration_request.handle_failure(transaction_response)
frappe.publish_realtime(
- event='process_phone_payment',
+ event="process_phone_payment",
doctype="POS Invoice",
docname=transaction_data.payment_reference,
user=integration_request.owner,
message={
- 'amount': total_paid,
- 'success': success,
- 'failure_message': transaction_response["ResultDesc"] if transaction_response['ResultCode'] != 0 else ''
+ "amount": total_paid,
+ "success": success,
+ "failure_message": transaction_response["ResultDesc"]
+ if transaction_response["ResultCode"] != 0
+ else "",
},
)
+
def get_completed_integration_requests_info(reference_doctype, reference_docname, checkout_id):
- output_of_other_completed_requests = frappe.get_all("Integration Request", filters={
- 'name': ['!=', checkout_id],
- 'reference_doctype': reference_doctype,
- 'reference_docname': reference_docname,
- 'status': 'Completed'
- }, pluck="output")
+ output_of_other_completed_requests = frappe.get_all(
+ "Integration Request",
+ filters={
+ "name": ["!=", checkout_id],
+ "reference_doctype": reference_doctype,
+ "reference_docname": reference_docname,
+ "status": "Completed",
+ },
+ pluck="output",
+ )
mpesa_receipts, completed_payments = [], []
@@ -211,23 +247,38 @@ def get_completed_integration_requests_info(reference_doctype, reference_docname
return mpesa_receipts, completed_payments
+
def get_account_balance(request_payload):
"""Call account balance API to send the request to the Mpesa Servers."""
try:
mpesa_settings = frappe.get_doc("Mpesa Settings", request_payload.get("reference_docname"))
env = "production" if not mpesa_settings.sandbox else "sandbox"
- connector = MpesaConnector(env=env,
+ connector = MpesaConnector(
+ env=env,
app_key=mpesa_settings.consumer_key,
- app_secret=mpesa_settings.get_password("consumer_secret"))
+ app_secret=mpesa_settings.get_password("consumer_secret"),
+ )
- callback_url = get_request_site_address(True) + "/api/method/erpnext.erpnext_integrations.doctype.mpesa_settings.mpesa_settings.process_balance_info"
+ callback_url = (
+ get_request_site_address(True)
+ + "/api/method/erpnext.erpnext_integrations.doctype.mpesa_settings.mpesa_settings.process_balance_info"
+ )
- response = connector.get_balance(mpesa_settings.initiator_name, mpesa_settings.security_credential, mpesa_settings.till_number, 4, mpesa_settings.name, callback_url, callback_url)
+ response = connector.get_balance(
+ mpesa_settings.initiator_name,
+ mpesa_settings.security_credential,
+ mpesa_settings.till_number,
+ 4,
+ mpesa_settings.name,
+ callback_url,
+ callback_url,
+ )
return response
except Exception:
frappe.log_error(title=_("Account Balance Processing Error"))
frappe.throw(_("Please check your configuration and try again"), title=_("Error"))
+
@frappe.whitelist(allow_guest=True)
def process_balance_info(**kwargs):
"""Process and store account balance information received via callback from the account balance API call."""
@@ -255,35 +306,43 @@ def process_balance_info(**kwargs):
ref_doc.db_set("account_balance", balance_info)
request.handle_success(account_balance_response)
- frappe.publish_realtime("refresh_mpesa_dashboard", doctype="Mpesa Settings",
- docname=transaction_data.reference_docname, user=transaction_data.owner)
+ frappe.publish_realtime(
+ "refresh_mpesa_dashboard",
+ doctype="Mpesa Settings",
+ docname=transaction_data.reference_docname,
+ user=transaction_data.owner,
+ )
except Exception:
request.handle_failure(account_balance_response)
- frappe.log_error(title=_("Mpesa Account Balance Processing Error"), message=account_balance_response)
+ frappe.log_error(
+ title=_("Mpesa Account Balance Processing Error"), message=account_balance_response
+ )
else:
request.handle_failure(account_balance_response)
+
def format_string_to_json(balance_info):
"""
Format string to json.
e.g: '''Working Account|KES|481000.00|481000.00|0.00|0.00'''
=> {'Working Account': {'current_balance': '481000.00',
- 'available_balance': '481000.00',
- 'reserved_balance': '0.00',
- 'uncleared_balance': '0.00'}}
+ 'available_balance': '481000.00',
+ 'reserved_balance': '0.00',
+ 'uncleared_balance': '0.00'}}
"""
balance_dict = frappe._dict()
for account_info in balance_info.split("&"):
- account_info = account_info.split('|')
+ account_info = account_info.split("|")
balance_dict[account_info[0]] = dict(
current_balance=fmt_money(account_info[2], currency="KES"),
available_balance=fmt_money(account_info[3], currency="KES"),
reserved_balance=fmt_money(account_info[4], currency="KES"),
- uncleared_balance=fmt_money(account_info[5], currency="KES")
+ uncleared_balance=fmt_money(account_info[5], currency="KES"),
)
return dumps(balance_dict)
+
def fetch_param_value(response, key, key_field):
"""Fetch the specified key from list of dictionary. Key is identified via the key field."""
for param in response:
diff --git a/erpnext/erpnext_integrations/doctype/mpesa_settings/test_mpesa_settings.py b/erpnext/erpnext_integrations/doctype/mpesa_settings/test_mpesa_settings.py
index 3945afab69a..17e332c7df3 100644
--- a/erpnext/erpnext_integrations/doctype/mpesa_settings/test_mpesa_settings.py
+++ b/erpnext/erpnext_integrations/doctype/mpesa_settings/test_mpesa_settings.py
@@ -22,12 +22,12 @@ class TestMpesaSettings(unittest.TestCase):
create_mpesa_settings(payment_gateway_name="Payment")
def tearDown(self):
- frappe.db.sql('delete from `tabMpesa Settings`')
+ frappe.db.sql("delete from `tabMpesa Settings`")
frappe.db.sql('delete from `tabIntegration Request` where integration_request_service = "Mpesa"')
def test_creation_of_payment_gateway(self):
- mode_of_payment = create_mode_of_payment('Mpesa-_Test', payment_type="Phone")
- self.assertTrue(frappe.db.exists("Payment Gateway Account", {'payment_gateway': "Mpesa-_Test"}))
+ mode_of_payment = create_mode_of_payment("Mpesa-_Test", payment_type="Phone")
+ self.assertTrue(frappe.db.exists("Payment Gateway Account", {"payment_gateway": "Mpesa-_Test"}))
self.assertTrue(mode_of_payment.name)
self.assertEqual(mode_of_payment.type, "Phone")
@@ -45,24 +45,33 @@ class TestMpesaSettings(unittest.TestCase):
# test formatting of account balance received as string to json with appropriate currency symbol
mpesa_doc.reload()
- self.assertEqual(mpesa_doc.account_balance, dumps({
- "Working Account": {
- "current_balance": "Sh 481,000.00",
- "available_balance": "Sh 481,000.00",
- "reserved_balance": "Sh 0.00",
- "uncleared_balance": "Sh 0.00"
- }
- }))
+ self.assertEqual(
+ mpesa_doc.account_balance,
+ dumps(
+ {
+ "Working Account": {
+ "current_balance": "Sh 481,000.00",
+ "available_balance": "Sh 481,000.00",
+ "reserved_balance": "Sh 0.00",
+ "uncleared_balance": "Sh 0.00",
+ }
+ }
+ ),
+ )
integration_request.delete()
def test_processing_of_callback_payload(self):
- mpesa_account = frappe.db.get_value("Payment Gateway Account", {"payment_gateway": 'Mpesa-Payment'}, "payment_account")
+ mpesa_account = frappe.db.get_value(
+ "Payment Gateway Account", {"payment_gateway": "Mpesa-Payment"}, "payment_account"
+ )
frappe.db.set_value("Account", mpesa_account, "account_currency", "KES")
frappe.db.set_value("Customer", "_Test Customer", "default_currency", "KES")
pos_invoice = create_pos_invoice(do_not_submit=1)
- pos_invoice.append("payments", {'mode_of_payment': 'Mpesa-Payment', 'account': mpesa_account, 'amount': 500})
+ pos_invoice.append(
+ "payments", {"mode_of_payment": "Mpesa-Payment", "account": mpesa_account, "amount": 500}
+ )
pos_invoice.contact_mobile = "093456543894"
pos_invoice.currency = "KES"
pos_invoice.save()
@@ -72,12 +81,18 @@ class TestMpesaSettings(unittest.TestCase):
self.assertEqual(pr.payment_gateway, "Mpesa-Payment")
# submitting payment request creates integration requests with random id
- integration_req_ids = frappe.get_all("Integration Request", filters={
- 'reference_doctype': pr.doctype,
- 'reference_docname': pr.name,
- }, pluck="name")
+ integration_req_ids = frappe.get_all(
+ "Integration Request",
+ filters={
+ "reference_doctype": pr.doctype,
+ "reference_docname": pr.name,
+ },
+ pluck="name",
+ )
- callback_response = get_payment_callback_payload(Amount=500, CheckoutRequestID=integration_req_ids[0])
+ callback_response = get_payment_callback_payload(
+ Amount=500, CheckoutRequestID=integration_req_ids[0]
+ )
verify_transaction(**callback_response)
# test creation of integration request
integration_request = frappe.get_doc("Integration Request", integration_req_ids[0])
@@ -99,13 +114,17 @@ class TestMpesaSettings(unittest.TestCase):
pos_invoice.delete()
def test_processing_of_multiple_callback_payload(self):
- mpesa_account = frappe.db.get_value("Payment Gateway Account", {"payment_gateway": 'Mpesa-Payment'}, "payment_account")
+ mpesa_account = frappe.db.get_value(
+ "Payment Gateway Account", {"payment_gateway": "Mpesa-Payment"}, "payment_account"
+ )
frappe.db.set_value("Account", mpesa_account, "account_currency", "KES")
frappe.db.set_value("Mpesa Settings", "Payment", "transaction_limit", "500")
frappe.db.set_value("Customer", "_Test Customer", "default_currency", "KES")
pos_invoice = create_pos_invoice(do_not_submit=1)
- pos_invoice.append("payments", {'mode_of_payment': 'Mpesa-Payment', 'account': mpesa_account, 'amount': 1000})
+ pos_invoice.append(
+ "payments", {"mode_of_payment": "Mpesa-Payment", "account": mpesa_account, "amount": 1000}
+ )
pos_invoice.contact_mobile = "093456543894"
pos_invoice.currency = "KES"
pos_invoice.save()
@@ -115,10 +134,14 @@ class TestMpesaSettings(unittest.TestCase):
self.assertEqual(pr.payment_gateway, "Mpesa-Payment")
# submitting payment request creates integration requests with random id
- integration_req_ids = frappe.get_all("Integration Request", filters={
- 'reference_doctype': pr.doctype,
- 'reference_docname': pr.name,
- }, pluck="name")
+ integration_req_ids = frappe.get_all(
+ "Integration Request",
+ filters={
+ "reference_doctype": pr.doctype,
+ "reference_docname": pr.name,
+ },
+ pluck="name",
+ )
# create random receipt nos and send it as response to callback handler
mpesa_receipt_numbers = [frappe.utils.random_string(5) for d in integration_req_ids]
@@ -128,7 +151,7 @@ class TestMpesaSettings(unittest.TestCase):
callback_response = get_payment_callback_payload(
Amount=500,
CheckoutRequestID=integration_req_ids[i],
- MpesaReceiptNumber=mpesa_receipt_numbers[i]
+ MpesaReceiptNumber=mpesa_receipt_numbers[i],
)
# handle response manually
verify_transaction(**callback_response)
@@ -139,7 +162,7 @@ class TestMpesaSettings(unittest.TestCase):
# check receipt number once all the integration requests are completed
pos_invoice.reload()
- self.assertEqual(pos_invoice.mpesa_receipt_number, ', '.join(mpesa_receipt_numbers))
+ self.assertEqual(pos_invoice.mpesa_receipt_number, ", ".join(mpesa_receipt_numbers))
frappe.db.set_value("Customer", "_Test Customer", "default_currency", "")
[d.delete() for d in integration_requests]
@@ -149,13 +172,17 @@ class TestMpesaSettings(unittest.TestCase):
pos_invoice.delete()
def test_processing_of_only_one_succes_callback_payload(self):
- mpesa_account = frappe.db.get_value("Payment Gateway Account", {"payment_gateway": 'Mpesa-Payment'}, "payment_account")
+ mpesa_account = frappe.db.get_value(
+ "Payment Gateway Account", {"payment_gateway": "Mpesa-Payment"}, "payment_account"
+ )
frappe.db.set_value("Account", mpesa_account, "account_currency", "KES")
frappe.db.set_value("Mpesa Settings", "Payment", "transaction_limit", "500")
frappe.db.set_value("Customer", "_Test Customer", "default_currency", "KES")
pos_invoice = create_pos_invoice(do_not_submit=1)
- pos_invoice.append("payments", {'mode_of_payment': 'Mpesa-Payment', 'account': mpesa_account, 'amount': 1000})
+ pos_invoice.append(
+ "payments", {"mode_of_payment": "Mpesa-Payment", "account": mpesa_account, "amount": 1000}
+ )
pos_invoice.contact_mobile = "093456543894"
pos_invoice.currency = "KES"
pos_invoice.save()
@@ -165,10 +192,14 @@ class TestMpesaSettings(unittest.TestCase):
self.assertEqual(pr.payment_gateway, "Mpesa-Payment")
# submitting payment request creates integration requests with random id
- integration_req_ids = frappe.get_all("Integration Request", filters={
- 'reference_doctype': pr.doctype,
- 'reference_docname': pr.name,
- }, pluck="name")
+ integration_req_ids = frappe.get_all(
+ "Integration Request",
+ filters={
+ "reference_doctype": pr.doctype,
+ "reference_docname": pr.name,
+ },
+ pluck="name",
+ )
# create random receipt nos and send it as response to callback handler
mpesa_receipt_numbers = [frappe.utils.random_string(5) for d in integration_req_ids]
@@ -176,7 +207,7 @@ class TestMpesaSettings(unittest.TestCase):
callback_response = get_payment_callback_payload(
Amount=500,
CheckoutRequestID=integration_req_ids[0],
- MpesaReceiptNumber=mpesa_receipt_numbers[0]
+ MpesaReceiptNumber=mpesa_receipt_numbers[0],
)
# handle response manually
verify_transaction(**callback_response)
@@ -188,11 +219,15 @@ class TestMpesaSettings(unittest.TestCase):
# second integration request fails
# now retrying payment request should make only one integration request again
pr = pos_invoice.create_payment_request()
- new_integration_req_ids = frappe.get_all("Integration Request", filters={
- 'reference_doctype': pr.doctype,
- 'reference_docname': pr.name,
- 'name': ['not in', integration_req_ids]
- }, pluck="name")
+ new_integration_req_ids = frappe.get_all(
+ "Integration Request",
+ filters={
+ "reference_doctype": pr.doctype,
+ "reference_docname": pr.name,
+ "name": ["not in", integration_req_ids],
+ },
+ pluck="name",
+ )
self.assertEqual(len(new_integration_req_ids), 1)
@@ -203,94 +238,56 @@ class TestMpesaSettings(unittest.TestCase):
pr.delete()
pos_invoice.delete()
+
def create_mpesa_settings(payment_gateway_name="Express"):
if frappe.db.exists("Mpesa Settings", payment_gateway_name):
return frappe.get_doc("Mpesa Settings", payment_gateway_name)
- doc = frappe.get_doc(dict( #nosec
- doctype="Mpesa Settings",
- sandbox=1,
- payment_gateway_name=payment_gateway_name,
- consumer_key="5sMu9LVI1oS3oBGPJfh3JyvLHwZOdTKn",
- consumer_secret="VI1oS3oBGPJfh3JyvLHw",
- online_passkey="LVI1oS3oBGPJfh3JyvLHwZOd",
- till_number="174379"
- ))
+ doc = frappe.get_doc(
+ dict( # nosec
+ doctype="Mpesa Settings",
+ sandbox=1,
+ payment_gateway_name=payment_gateway_name,
+ consumer_key="5sMu9LVI1oS3oBGPJfh3JyvLHwZOdTKn",
+ consumer_secret="VI1oS3oBGPJfh3JyvLHw",
+ online_passkey="LVI1oS3oBGPJfh3JyvLHwZOd",
+ till_number="174379",
+ )
+ )
doc.insert(ignore_permissions=True)
return doc
+
def get_test_account_balance_response():
"""Response received after calling the account balance API."""
return {
- "ResultType":0,
- "ResultCode":0,
- "ResultDesc":"The service request has been accepted successfully.",
- "OriginatorConversationID":"10816-694520-2",
- "ConversationID":"AG_20200927_00007cdb1f9fb6494315",
- "TransactionID":"LGR0000000",
- "ResultParameters":{
- "ResultParameter":[
- {
- "Key":"ReceiptNo",
- "Value":"LGR919G2AV"
- },
- {
- "Key":"Conversation ID",
- "Value":"AG_20170727_00004492b1b6d0078fbe"
- },
- {
- "Key":"FinalisedTime",
- "Value":20170727101415
- },
- {
- "Key":"Amount",
- "Value":10
- },
- {
- "Key":"TransactionStatus",
- "Value":"Completed"
- },
- {
- "Key":"ReasonType",
- "Value":"Salary Payment via API"
- },
- {
- "Key":"TransactionReason"
- },
- {
- "Key":"DebitPartyCharges",
- "Value":"Fee For B2C Payment|KES|33.00"
- },
- {
- "Key":"DebitAccountType",
- "Value":"Utility Account"
- },
- {
- "Key":"InitiatedTime",
- "Value":20170727101415
- },
- {
- "Key":"Originator Conversation ID",
- "Value":"19455-773836-1"
- },
- {
- "Key":"CreditPartyName",
- "Value":"254708374149 - John Doe"
- },
- {
- "Key":"DebitPartyName",
- "Value":"600134 - Safaricom157"
- }
- ]
- },
- "ReferenceData":{
- "ReferenceItem":{
- "Key":"Occasion",
- "Value":"aaaa"
+ "ResultType": 0,
+ "ResultCode": 0,
+ "ResultDesc": "The service request has been accepted successfully.",
+ "OriginatorConversationID": "10816-694520-2",
+ "ConversationID": "AG_20200927_00007cdb1f9fb6494315",
+ "TransactionID": "LGR0000000",
+ "ResultParameters": {
+ "ResultParameter": [
+ {"Key": "ReceiptNo", "Value": "LGR919G2AV"},
+ {"Key": "Conversation ID", "Value": "AG_20170727_00004492b1b6d0078fbe"},
+ {"Key": "FinalisedTime", "Value": 20170727101415},
+ {"Key": "Amount", "Value": 10},
+ {"Key": "TransactionStatus", "Value": "Completed"},
+ {"Key": "ReasonType", "Value": "Salary Payment via API"},
+ {"Key": "TransactionReason"},
+ {"Key": "DebitPartyCharges", "Value": "Fee For B2C Payment|KES|33.00"},
+ {"Key": "DebitAccountType", "Value": "Utility Account"},
+ {"Key": "InitiatedTime", "Value": 20170727101415},
+ {"Key": "Originator Conversation ID", "Value": "19455-773836-1"},
+ {"Key": "CreditPartyName", "Value": "254708374149 - John Doe"},
+ {"Key": "DebitPartyName", "Value": "600134 - Safaricom157"},
+ ]
+ },
+ "ReferenceData": {"ReferenceItem": {"Key": "Occasion", "Value": "aaaa"}},
}
- }
- }
+
def get_payment_request_response_payload(Amount=500):
"""Response received after successfully calling the stk push process request API."""
@@ -304,40 +301,44 @@ def get_payment_request_response_payload(Amount=500):
"ResultDesc": "The service request is processed successfully.",
"CallbackMetadata": {
"Item": [
- { "Name": "Amount", "Value": Amount },
- { "Name": "MpesaReceiptNumber", "Value": "LGR7OWQX0R" },
- { "Name": "TransactionDate", "Value": 20201006113336 },
- { "Name": "PhoneNumber", "Value": 254723575670 }
+ {"Name": "Amount", "Value": Amount},
+ {"Name": "MpesaReceiptNumber", "Value": "LGR7OWQX0R"},
+ {"Name": "TransactionDate", "Value": 20201006113336},
+ {"Name": "PhoneNumber", "Value": 254723575670},
]
- }
+ },
}
-def get_payment_callback_payload(Amount=500, CheckoutRequestID="ws_CO_061020201133231972", MpesaReceiptNumber="LGR7OWQX0R"):
+
+def get_payment_callback_payload(
+ Amount=500, CheckoutRequestID="ws_CO_061020201133231972", MpesaReceiptNumber="LGR7OWQX0R"
+):
"""Response received from the server as callback after calling the stkpush process request API."""
return {
- "Body":{
- "stkCallback":{
- "MerchantRequestID":"19465-780693-1",
- "CheckoutRequestID":CheckoutRequestID,
- "ResultCode":0,
- "ResultDesc":"The service request is processed successfully.",
- "CallbackMetadata":{
- "Item":[
- { "Name":"Amount", "Value":Amount },
- { "Name":"MpesaReceiptNumber", "Value":MpesaReceiptNumber },
- { "Name":"Balance" },
- { "Name":"TransactionDate", "Value":20170727154800 },
- { "Name":"PhoneNumber", "Value":254721566839 }
+ "Body": {
+ "stkCallback": {
+ "MerchantRequestID": "19465-780693-1",
+ "CheckoutRequestID": CheckoutRequestID,
+ "ResultCode": 0,
+ "ResultDesc": "The service request is processed successfully.",
+ "CallbackMetadata": {
+ "Item": [
+ {"Name": "Amount", "Value": Amount},
+ {"Name": "MpesaReceiptNumber", "Value": MpesaReceiptNumber},
+ {"Name": "Balance"},
+ {"Name": "TransactionDate", "Value": 20170727154800},
+ {"Name": "PhoneNumber", "Value": 254721566839},
]
- }
+ },
}
}
}
+
def get_account_balance_callback_payload():
"""Response received from the server as callback after calling the account balance API."""
return {
- "Result":{
+ "Result": {
"ResultType": 0,
"ResultCode": 0,
"ResultDesc": "The service request is processed successfully.",
@@ -346,18 +347,15 @@ def get_account_balance_callback_payload():
"TransactionID": "OIR0000000",
"ResultParameters": {
"ResultParameter": [
- {
- "Key": "AccountBalance",
- "Value": "Working Account|KES|481000.00|481000.00|0.00|0.00"
- },
- { "Key": "BOCompletedTime", "Value": 20200927234123 }
+ {"Key": "AccountBalance", "Value": "Working Account|KES|481000.00|481000.00|0.00|0.00"},
+ {"Key": "BOCompletedTime", "Value": 20200927234123},
]
},
"ReferenceData": {
"ReferenceItem": {
"Key": "QueueTimeoutURL",
- "Value": "https://internalsandbox.safaricom.co.ke/mpesa/abresults/v1/submit"
+ "Value": "https://internalsandbox.safaricom.co.ke/mpesa/abresults/v1/submit",
}
- }
+ },
}
}
diff --git a/erpnext/erpnext_integrations/doctype/plaid_settings/plaid_connector.py b/erpnext/erpnext_integrations/doctype/plaid_settings/plaid_connector.py
index 0b552f9bbf4..625dd3110ea 100644
--- a/erpnext/erpnext_integrations/doctype/plaid_settings/plaid_connector.py
+++ b/erpnext/erpnext_integrations/doctype/plaid_settings/plaid_connector.py
@@ -8,7 +8,7 @@ from frappe import _
from plaid.errors import APIError, InvalidRequestError, ItemError
-class PlaidConnector():
+class PlaidConnector:
def __init__(self, access_token=None):
self.access_token = access_token
self.settings = frappe.get_single("Plaid Settings")
@@ -18,7 +18,7 @@ class PlaidConnector():
client_id=self.settings.plaid_client_id,
secret=self.settings.get_password("plaid_secret"),
environment=self.settings.plaid_env,
- api_version="2020-09-14"
+ api_version="2020-09-14",
)
def get_access_token(self, public_token):
@@ -29,25 +29,29 @@ class PlaidConnector():
return access_token
def get_token_request(self, update_mode=False):
- country_codes = ["US", "CA", "FR", "IE", "NL", "ES", "GB"] if self.settings.enable_european_access else ["US", "CA"]
+ country_codes = (
+ ["US", "CA", "FR", "IE", "NL", "ES", "GB"]
+ if self.settings.enable_european_access
+ else ["US", "CA"]
+ )
args = {
"client_name": self.client_name,
# only allow Plaid-supported languages and countries (LAST: Sep-19-2020)
"language": frappe.local.lang if frappe.local.lang in ["en", "fr", "es", "nl"] else "en",
"country_codes": country_codes,
- "user": {
- "client_user_id": frappe.generate_hash(frappe.session.user, length=32)
- }
+ "user": {"client_user_id": frappe.generate_hash(frappe.session.user, length=32)},
}
if update_mode:
args["access_token"] = self.access_token
else:
- args.update({
- "client_id": self.settings.plaid_client_id,
- "secret": self.settings.plaid_secret,
- "products": self.products,
- })
+ args.update(
+ {
+ "client_id": self.settings.plaid_client_id,
+ "secret": self.settings.plaid_secret,
+ "products": self.products,
+ }
+ )
return args
@@ -82,11 +86,7 @@ class PlaidConnector():
def get_transactions(self, start_date, end_date, account_id=None):
self.auth()
- kwargs = dict(
- access_token=self.access_token,
- start_date=start_date,
- end_date=end_date
- )
+ kwargs = dict(access_token=self.access_token, start_date=start_date, end_date=end_date)
if account_id:
kwargs.update(dict(account_ids=[account_id]))
@@ -94,7 +94,9 @@ class PlaidConnector():
response = self.client.Transactions.get(**kwargs)
transactions = response["transactions"]
while len(transactions) < response["total_transactions"]:
- response = self.client.Transactions.get(self.access_token, start_date=start_date, end_date=end_date, offset=len(transactions))
+ response = self.client.Transactions.get(
+ self.access_token, start_date=start_date, end_date=end_date, offset=len(transactions)
+ )
transactions.extend(response["transactions"])
return transactions
except ItemError as e:
diff --git a/erpnext/erpnext_integrations/doctype/plaid_settings/plaid_settings.py b/erpnext/erpnext_integrations/doctype/plaid_settings/plaid_settings.py
index 7e6f146ce3f..ce65f6c0ff7 100644
--- a/erpnext/erpnext_integrations/doctype/plaid_settings/plaid_settings.py
+++ b/erpnext/erpnext_integrations/doctype/plaid_settings/plaid_settings.py
@@ -29,7 +29,7 @@ def get_plaid_configuration():
return {
"plaid_env": plaid_settings.plaid_env,
"link_token": plaid_settings.get_link_token(),
- "client_name": frappe.local.site
+ "client_name": frappe.local.site,
}
return "disabled"
@@ -45,14 +45,16 @@ def add_institution(token, response):
if not frappe.db.exists("Bank", response["institution"]["name"]):
try:
- bank = frappe.get_doc({
- "doctype": "Bank",
- "bank_name": response["institution"]["name"],
- "plaid_access_token": access_token
- })
+ bank = frappe.get_doc(
+ {
+ "doctype": "Bank",
+ "bank_name": response["institution"]["name"],
+ "plaid_access_token": access_token,
+ }
+ )
bank.insert()
except Exception:
- frappe.log_error(frappe.get_traceback(), title=_('Plaid Link Error'))
+ frappe.log_error(frappe.get_traceback(), title=_("Plaid Link Error"))
else:
bank = frappe.get_doc("Bank", response["institution"]["name"])
bank.plaid_access_token = access_token
@@ -89,65 +91,71 @@ def add_bank_accounts(response, bank, company):
if not existing_bank_account:
try:
- new_account = frappe.get_doc({
- "doctype": "Bank Account",
- "bank": bank["bank_name"],
- "account": default_gl_account.account,
- "account_name": account["name"],
- "account_type": account.get("type", ""),
- "account_subtype": account.get("subtype", ""),
- "mask": account.get("mask", ""),
- "integration_id": account["id"],
- "is_company_account": 1,
- "company": company
- })
+ new_account = frappe.get_doc(
+ {
+ "doctype": "Bank Account",
+ "bank": bank["bank_name"],
+ "account": default_gl_account.account,
+ "account_name": account["name"],
+ "account_type": account.get("type", ""),
+ "account_subtype": account.get("subtype", ""),
+ "mask": account.get("mask", ""),
+ "integration_id": account["id"],
+ "is_company_account": 1,
+ "company": company,
+ }
+ )
new_account.insert()
result.append(new_account.name)
except frappe.UniqueValidationError:
- frappe.msgprint(_("Bank account {0} already exists and could not be created again").format(account["name"]))
+ frappe.msgprint(
+ _("Bank account {0} already exists and could not be created again").format(account["name"])
+ )
except Exception:
frappe.log_error(frappe.get_traceback(), title=_("Plaid Link Error"))
- frappe.throw(_("There was an error creating Bank Account while linking with Plaid."),
- title=_("Plaid Link Failed"))
+ frappe.throw(
+ _("There was an error creating Bank Account while linking with Plaid."),
+ title=_("Plaid Link Failed"),
+ )
else:
try:
- existing_account = frappe.get_doc('Bank Account', existing_bank_account)
- existing_account.update({
- "bank": bank["bank_name"],
- "account_name": account["name"],
- "account_type": account.get("type", ""),
- "account_subtype": account.get("subtype", ""),
- "mask": account.get("mask", ""),
- "integration_id": account["id"]
- })
+ existing_account = frappe.get_doc("Bank Account", existing_bank_account)
+ existing_account.update(
+ {
+ "bank": bank["bank_name"],
+ "account_name": account["name"],
+ "account_type": account.get("type", ""),
+ "account_subtype": account.get("subtype", ""),
+ "mask": account.get("mask", ""),
+ "integration_id": account["id"],
+ }
+ )
existing_account.save()
result.append(existing_bank_account)
except Exception:
frappe.log_error(frappe.get_traceback(), title=_("Plaid Link Error"))
- frappe.throw(_("There was an error updating Bank Account {} while linking with Plaid.").format(
- existing_bank_account), title=_("Plaid Link Failed"))
+ frappe.throw(
+ _("There was an error updating Bank Account {} while linking with Plaid.").format(
+ existing_bank_account
+ ),
+ title=_("Plaid Link Failed"),
+ )
return result
def add_account_type(account_type):
try:
- frappe.get_doc({
- "doctype": "Bank Account Type",
- "account_type": account_type
- }).insert()
+ frappe.get_doc({"doctype": "Bank Account Type", "account_type": account_type}).insert()
except Exception:
frappe.throw(frappe.get_traceback())
def add_account_subtype(account_subtype):
try:
- frappe.get_doc({
- "doctype": "Bank Account Subtype",
- "account_subtype": account_subtype
- }).insert()
+ frappe.get_doc({"doctype": "Bank Account Subtype", "account_subtype": account_subtype}).insert()
except Exception:
frappe.throw(frappe.get_traceback())
@@ -164,19 +172,26 @@ def sync_transactions(bank, bank_account):
end_date = formatdate(today(), "YYYY-MM-dd")
try:
- transactions = get_transactions(bank=bank, bank_account=bank_account, start_date=start_date, end_date=end_date)
+ transactions = get_transactions(
+ bank=bank, bank_account=bank_account, start_date=start_date, end_date=end_date
+ )
result = []
for transaction in reversed(transactions):
result += new_bank_transaction(transaction)
if result:
- last_transaction_date = frappe.db.get_value('Bank Transaction', result.pop(), 'date')
+ last_transaction_date = frappe.db.get_value("Bank Transaction", result.pop(), "date")
- frappe.logger().info("Plaid added {} new Bank Transactions from '{}' between {} and {}".format(
- len(result), bank_account, start_date, end_date))
+ frappe.logger().info(
+ "Plaid added {} new Bank Transactions from '{}' between {} and {}".format(
+ len(result), bank_account, start_date, end_date
+ )
+ )
- frappe.db.set_value("Bank Account", bank_account, "last_integration_date", last_transaction_date)
+ frappe.db.set_value(
+ "Bank Account", bank_account, "last_integration_date", last_transaction_date
+ )
except Exception:
frappe.log_error(frappe.get_traceback(), _("Plaid transactions sync error"))
@@ -185,7 +200,9 @@ def get_transactions(bank, bank_account=None, start_date=None, end_date=None):
access_token = None
if bank_account:
- related_bank = frappe.db.get_values("Bank Account", bank_account, ["bank", "integration_id"], as_dict=True)
+ related_bank = frappe.db.get_values(
+ "Bank Account", bank_account, ["bank", "integration_id"], as_dict=True
+ )
access_token = frappe.db.get_value("Bank", related_bank[0].bank, "plaid_access_token")
account_id = related_bank[0].integration_id
else:
@@ -196,7 +213,9 @@ def get_transactions(bank, bank_account=None, start_date=None, end_date=None):
transactions = []
try:
- transactions = plaid.get_transactions(start_date=start_date, end_date=end_date, account_id=account_id)
+ transactions = plaid.get_transactions(
+ start_date=start_date, end_date=end_date, account_id=account_id
+ )
except ItemError as e:
if e.code == "ITEM_LOGIN_REQUIRED":
msg = _("There was an error syncing transactions.") + " "
@@ -229,18 +248,20 @@ def new_bank_transaction(transaction):
if not frappe.db.exists("Bank Transaction", dict(transaction_id=transaction["transaction_id"])):
try:
- new_transaction = frappe.get_doc({
- "doctype": "Bank Transaction",
- "date": getdate(transaction["date"]),
- "status": status,
- "bank_account": bank_account,
- "deposit": debit,
- "withdrawal": credit,
- "currency": transaction["iso_currency_code"],
- "transaction_id": transaction["transaction_id"],
- "reference_number": transaction["payment_meta"]["reference_number"],
- "description": transaction["name"]
- })
+ new_transaction = frappe.get_doc(
+ {
+ "doctype": "Bank Transaction",
+ "date": getdate(transaction["date"]),
+ "status": status,
+ "bank_account": bank_account,
+ "deposit": debit,
+ "withdrawal": credit,
+ "currency": transaction["iso_currency_code"],
+ "transaction_id": transaction["transaction_id"],
+ "reference_number": transaction["payment_meta"]["reference_number"],
+ "description": transaction["name"],
+ }
+ )
new_transaction.insert()
new_transaction.submit()
@@ -250,7 +271,7 @@ def new_bank_transaction(transaction):
result.append(new_transaction.name)
except Exception:
- frappe.throw(title=_('Bank transaction creation error'))
+ frappe.throw(title=_("Bank transaction creation error"))
return result
@@ -260,19 +281,21 @@ def automatic_synchronization():
if settings.enabled == 1 and settings.automatic_sync == 1:
enqueue_synchronization()
+
@frappe.whitelist()
def enqueue_synchronization():
- plaid_accounts = frappe.get_all("Bank Account",
- filters={"integration_id": ["!=", ""]},
- fields=["name", "bank"])
+ plaid_accounts = frappe.get_all(
+ "Bank Account", filters={"integration_id": ["!=", ""]}, fields=["name", "bank"]
+ )
for plaid_account in plaid_accounts:
frappe.enqueue(
"erpnext.erpnext_integrations.doctype.plaid_settings.plaid_settings.sync_transactions",
bank=plaid_account.bank,
- bank_account=plaid_account.name
+ bank_account=plaid_account.name,
)
+
@frappe.whitelist()
def get_link_token_for_update(access_token):
plaid = PlaidConnector(access_token)
diff --git a/erpnext/erpnext_integrations/doctype/plaid_settings/test_plaid_settings.py b/erpnext/erpnext_integrations/doctype/plaid_settings/test_plaid_settings.py
index 535d7fa7997..e8dc3e258f6 100644
--- a/erpnext/erpnext_integrations/doctype/plaid_settings/test_plaid_settings.py
+++ b/erpnext/erpnext_integrations/doctype/plaid_settings/test_plaid_settings.py
@@ -45,111 +45,110 @@ class TestPlaidSettings(unittest.TestCase):
def test_default_bank_account(self):
if not frappe.db.exists("Bank", "Citi"):
- frappe.get_doc({
- "doctype": "Bank",
- "bank_name": "Citi"
- }).insert()
+ frappe.get_doc({"doctype": "Bank", "bank_name": "Citi"}).insert()
bank_accounts = {
- 'account': {
- 'subtype': 'checking',
- 'mask': '0000',
- 'type': 'depository',
- 'id': '6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK',
- 'name': 'Plaid Checking'
+ "account": {
+ "subtype": "checking",
+ "mask": "0000",
+ "type": "depository",
+ "id": "6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK",
+ "name": "Plaid Checking",
},
- 'account_id': '6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK',
- 'link_session_id': 'db673d75-61aa-442a-864f-9b3f174f3725',
- 'accounts': [{
- 'type': 'depository',
- 'subtype': 'checking',
- 'mask': '0000',
- 'id': '6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK',
- 'name': 'Plaid Checking'
- }],
- 'institution': {
- 'institution_id': 'ins_6',
- 'name': 'Citi'
- }
+ "account_id": "6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK",
+ "link_session_id": "db673d75-61aa-442a-864f-9b3f174f3725",
+ "accounts": [
+ {
+ "type": "depository",
+ "subtype": "checking",
+ "mask": "0000",
+ "id": "6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK",
+ "name": "Plaid Checking",
+ }
+ ],
+ "institution": {"institution_id": "ins_6", "name": "Citi"},
}
bank = json.dumps(frappe.get_doc("Bank", "Citi").as_dict(), default=json_handler)
- company = frappe.db.get_single_value('Global Defaults', 'default_company')
+ company = frappe.db.get_single_value("Global Defaults", "default_company")
frappe.db.set_value("Company", company, "default_bank_account", None)
- self.assertRaises(frappe.ValidationError, add_bank_accounts, response=bank_accounts, bank=bank, company=company)
+ self.assertRaises(
+ frappe.ValidationError, add_bank_accounts, response=bank_accounts, bank=bank, company=company
+ )
def test_new_transaction(self):
if not frappe.db.exists("Bank", "Citi"):
- frappe.get_doc({
- "doctype": "Bank",
- "bank_name": "Citi"
- }).insert()
+ frappe.get_doc({"doctype": "Bank", "bank_name": "Citi"}).insert()
bank_accounts = {
- 'account': {
- 'subtype': 'checking',
- 'mask': '0000',
- 'type': 'depository',
- 'id': '6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK',
- 'name': 'Plaid Checking'
+ "account": {
+ "subtype": "checking",
+ "mask": "0000",
+ "type": "depository",
+ "id": "6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK",
+ "name": "Plaid Checking",
},
- 'account_id': '6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK',
- 'link_session_id': 'db673d75-61aa-442a-864f-9b3f174f3725',
- 'accounts': [{
- 'type': 'depository',
- 'subtype': 'checking',
- 'mask': '0000',
- 'id': '6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK',
- 'name': 'Plaid Checking'
- }],
- 'institution': {
- 'institution_id': 'ins_6',
- 'name': 'Citi'
- }
+ "account_id": "6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK",
+ "link_session_id": "db673d75-61aa-442a-864f-9b3f174f3725",
+ "accounts": [
+ {
+ "type": "depository",
+ "subtype": "checking",
+ "mask": "0000",
+ "id": "6GbM6RRQgdfy3lAqGz4JUnpmR948WZFg8DjQK",
+ "name": "Plaid Checking",
+ }
+ ],
+ "institution": {"institution_id": "ins_6", "name": "Citi"},
}
bank = json.dumps(frappe.get_doc("Bank", "Citi").as_dict(), default=json_handler)
- company = frappe.db.get_single_value('Global Defaults', 'default_company')
+ company = frappe.db.get_single_value("Global Defaults", "default_company")
if frappe.db.get_value("Company", company, "default_bank_account") is None:
- frappe.db.set_value("Company", company, "default_bank_account", get_default_bank_cash_account(company, "Cash").get("account"))
+ frappe.db.set_value(
+ "Company",
+ company,
+ "default_bank_account",
+ get_default_bank_cash_account(company, "Cash").get("account"),
+ )
add_bank_accounts(bank_accounts, bank, company)
transactions = {
- 'account_owner': None,
- 'category': ['Food and Drink', 'Restaurants'],
- 'account_id': 'b4Jkp1LJDZiPgojpr1ansXJrj5Q6w9fVmv6ov',
- 'pending_transaction_id': None,
- 'transaction_id': 'x374xPa7DvUewqlR5mjNIeGK8r8rl3Sn647LM',
- 'unofficial_currency_code': None,
- 'name': 'INTRST PYMNT',
- 'transaction_type': 'place',
- 'amount': -4.22,
- 'location': {
- 'city': None,
- 'zip': None,
- 'store_number': None,
- 'lon': None,
- 'state': None,
- 'address': None,
- 'lat': None
+ "account_owner": None,
+ "category": ["Food and Drink", "Restaurants"],
+ "account_id": "b4Jkp1LJDZiPgojpr1ansXJrj5Q6w9fVmv6ov",
+ "pending_transaction_id": None,
+ "transaction_id": "x374xPa7DvUewqlR5mjNIeGK8r8rl3Sn647LM",
+ "unofficial_currency_code": None,
+ "name": "INTRST PYMNT",
+ "transaction_type": "place",
+ "amount": -4.22,
+ "location": {
+ "city": None,
+ "zip": None,
+ "store_number": None,
+ "lon": None,
+ "state": None,
+ "address": None,
+ "lat": None,
},
- 'payment_meta': {
- 'reference_number': None,
- 'payer': None,
- 'payment_method': None,
- 'reason': None,
- 'payee': None,
- 'ppd_id': None,
- 'payment_processor': None,
- 'by_order_of': None
+ "payment_meta": {
+ "reference_number": None,
+ "payer": None,
+ "payment_method": None,
+ "reason": None,
+ "payee": None,
+ "ppd_id": None,
+ "payment_processor": None,
+ "by_order_of": None,
},
- 'date': '2017-12-22',
- 'category_id': '13005000',
- 'pending': False,
- 'iso_currency_code': 'USD'
+ "date": "2017-12-22",
+ "category_id": "13005000",
+ "pending": False,
+ "iso_currency_code": "USD",
}
new_bank_transaction(transactions)
diff --git a/erpnext/erpnext_integrations/doctype/quickbooks_migrator/quickbooks_migrator.py b/erpnext/erpnext_integrations/doctype/quickbooks_migrator/quickbooks_migrator.py
index 5de568272a0..b93c5c4d38c 100644
--- a/erpnext/erpnext_integrations/doctype/quickbooks_migrator/quickbooks_migrator.py
+++ b/erpnext/erpnext_integrations/doctype/quickbooks_migrator/quickbooks_migrator.py
@@ -37,30 +37,27 @@ class QuickBooksMigrator(Document):
def __init__(self, *args, **kwargs):
super(QuickBooksMigrator, self).__init__(*args, **kwargs)
self.oauth = OAuth2Session(
- client_id=self.client_id,
- redirect_uri=self.redirect_url,
- scope=self.scope
+ client_id=self.client_id, redirect_uri=self.redirect_url, scope=self.scope
)
if not self.authorization_url and self.authorization_endpoint:
self.authorization_url = self.oauth.authorization_url(self.authorization_endpoint)[0]
-
def on_update(self):
if self.company:
# We need a Cost Center corresponding to the selected erpnext Company
- self.default_cost_center = frappe.db.get_value('Company', self.company, 'cost_center')
- company_warehouses = frappe.get_all('Warehouse', filters={"company": self.company, "is_group": 0})
+ self.default_cost_center = frappe.db.get_value("Company", self.company, "cost_center")
+ company_warehouses = frappe.get_all(
+ "Warehouse", filters={"company": self.company, "is_group": 0}
+ )
if company_warehouses:
self.default_warehouse = company_warehouses[0].name
if self.authorization_endpoint:
self.authorization_url = self.oauth.authorization_url(self.authorization_endpoint)[0]
-
@frappe.whitelist()
def migrate(self):
frappe.enqueue_doc("QuickBooks Migrator", "QuickBooks Migrator", "_migrate", queue="long")
-
def _migrate(self):
try:
self.set_indicator("In Progress")
@@ -86,18 +83,33 @@ class QuickBooksMigrator(Document):
# Following entities are directly available from API
# Invoice can be an exception sometimes though (as explained above).
entities_for_normal_transform = [
- "Customer", "Item", "Vendor",
+ "Customer",
+ "Item",
+ "Vendor",
"Preferences",
- "JournalEntry", "Purchase", "Deposit",
- "Invoice", "CreditMemo", "SalesReceipt", "RefundReceipt",
- "Bill", "VendorCredit",
- "Payment", "BillPayment",
+ "JournalEntry",
+ "Purchase",
+ "Deposit",
+ "Invoice",
+ "CreditMemo",
+ "SalesReceipt",
+ "RefundReceipt",
+ "Bill",
+ "VendorCredit",
+ "Payment",
+ "BillPayment",
]
for entity in entities_for_normal_transform:
self._migrate_entries(entity)
# Following entries are not available directly from API, Need to be regenrated from GeneralLedger Report
- entities_for_gl_transform = ["Advance Payment", "Tax Payment", "Sales Tax Payment", "Purchase Tax Payment", "Inventory Qty Adjust"]
+ entities_for_gl_transform = [
+ "Advance Payment",
+ "Tax Payment",
+ "Sales Tax Payment",
+ "Purchase Tax Payment",
+ "Inventory Qty Adjust",
+ ]
for entity in entities_for_gl_transform:
self._migrate_entries_from_gl(entity)
self.set_indicator("Complete")
@@ -107,33 +119,37 @@ class QuickBooksMigrator(Document):
frappe.db.commit()
-
def get_tokens(self):
token = self.oauth.fetch_token(
- token_url=self.token_endpoint,
- client_secret=self.client_secret,
- code=self.code
+ token_url=self.token_endpoint, client_secret=self.client_secret, code=self.code
)
self.access_token = token["access_token"]
self.refresh_token = token["refresh_token"]
self.save()
-
def _refresh_tokens(self):
token = self.oauth.refresh_token(
token_url=self.token_endpoint,
client_id=self.client_id,
refresh_token=self.refresh_token,
client_secret=self.client_secret,
- code=self.code
+ code=self.code,
)
self.access_token = token["access_token"]
self.refresh_token = token["refresh_token"]
self.save()
-
def _make_custom_fields(self):
- doctypes_for_quickbooks_id_field = ["Account", "Customer", "Address", "Item", "Supplier", "Sales Invoice", "Journal Entry", "Purchase Invoice"]
+ doctypes_for_quickbooks_id_field = [
+ "Account",
+ "Customer",
+ "Address",
+ "Item",
+ "Supplier",
+ "Sales Invoice",
+ "Journal Entry",
+ "Purchase Invoice",
+ ]
for doctype in doctypes_for_quickbooks_id_field:
self._make_custom_quickbooks_id_field(doctype)
@@ -143,53 +159,60 @@ class QuickBooksMigrator(Document):
frappe.db.commit()
-
def _make_custom_quickbooks_id_field(self, doctype):
if not frappe.get_meta(doctype).has_field("quickbooks_id"):
- frappe.get_doc({
- "doctype": "Custom Field",
- "label": "QuickBooks ID",
- "dt": doctype,
- "fieldname": "quickbooks_id",
- "fieldtype": "Data",
- }).insert()
-
+ frappe.get_doc(
+ {
+ "doctype": "Custom Field",
+ "label": "QuickBooks ID",
+ "dt": doctype,
+ "fieldname": "quickbooks_id",
+ "fieldtype": "Data",
+ }
+ ).insert()
def _make_custom_company_field(self, doctype):
if not frappe.get_meta(doctype).has_field("company"):
- frappe.get_doc({
- "doctype": "Custom Field",
- "label": "Company",
- "dt": doctype,
- "fieldname": "company",
- "fieldtype": "Link",
- "options": "Company",
- }).insert()
-
+ frappe.get_doc(
+ {
+ "doctype": "Custom Field",
+ "label": "Company",
+ "dt": doctype,
+ "fieldname": "company",
+ "fieldtype": "Link",
+ "options": "Company",
+ }
+ ).insert()
def _migrate_accounts(self):
self._make_root_accounts()
for entity in ["Account", "TaxRate", "TaxCode"]:
self._migrate_entries(entity)
-
def _make_root_accounts(self):
roots = ["Asset", "Equity", "Expense", "Liability", "Income"]
for root in roots:
try:
- if not frappe.db.exists({"doctype": "Account", "name": encode_company_abbr("{} - QB".format(root), self.company), "company": self.company}):
- frappe.get_doc({
+ if not frappe.db.exists(
+ {
"doctype": "Account",
- "account_name": "{} - QB".format(root),
- "root_type": root,
- "is_group": "1",
+ "name": encode_company_abbr("{} - QB".format(root), self.company),
"company": self.company,
- }).insert(ignore_mandatory=True)
+ }
+ ):
+ frappe.get_doc(
+ {
+ "doctype": "Account",
+ "account_name": "{} - QB".format(root),
+ "root_type": root,
+ "is_group": "1",
+ "company": self.company,
+ }
+ ).insert(ignore_mandatory=True)
except Exception as e:
self._log_error(e, root)
frappe.db.commit()
-
def _migrate_entries(self, entity):
try:
query_uri = "{}/company/{}/query".format(
@@ -198,22 +221,19 @@ class QuickBooksMigrator(Document):
)
max_result_count = 1000
# Count number of entries
- response = self._get(query_uri,
- params={
- "query": """SELECT COUNT(*) FROM {}""".format(entity)
- }
- )
+ response = self._get(query_uri, params={"query": """SELECT COUNT(*) FROM {}""".format(entity)})
entry_count = response.json()["QueryResponse"]["totalCount"]
# fetch pages and accumulate
entries = []
for start_position in range(1, entry_count + 1, max_result_count):
- response = self._get(query_uri,
+ response = self._get(
+ query_uri,
params={
"query": """SELECT * FROM {} STARTPOSITION {} MAXRESULTS {}""".format(
entity, start_position, max_result_count
)
- }
+ },
)
entries.extend(response.json()["QueryResponse"][entity])
entries = self._preprocess_entries(entity, entries)
@@ -221,16 +241,18 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, response.text)
-
def _fetch_general_ledger(self):
try:
- query_uri = "{}/company/{}/reports/GeneralLedger".format(self.api_endpoint, self.quickbooks_company_id)
- response = self._get(query_uri,
+ query_uri = "{}/company/{}/reports/GeneralLedger".format(
+ self.api_endpoint, self.quickbooks_company_id
+ )
+ response = self._get(
+ query_uri,
params={
"columns": ",".join(["tx_date", "txn_type", "credit_amt", "debt_amt"]),
"date_macro": "All",
"minorversion": 3,
- }
+ },
)
self.gl_entries = {}
for section in response.json()["Rows"]["Row"]:
@@ -250,7 +272,6 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, response.text)
-
def _create_fiscal_years(self):
try:
# Assumes that exactly one fiscal year has been created so far
@@ -258,10 +279,12 @@ class QuickBooksMigrator(Document):
from itertools import chain
from frappe.utils.data import add_years, getdate
- smallest_ledger_entry_date = getdate(min(entry["date"] for entry in chain(*self.gl_entries.values()) if entry["date"]))
- oldest_fiscal_year = frappe.get_all("Fiscal Year",
- fields=["year_start_date", "year_end_date"],
- order_by="year_start_date"
+
+ smallest_ledger_entry_date = getdate(
+ min(entry["date"] for entry in chain(*self.gl_entries.values()) if entry["date"])
+ )
+ oldest_fiscal_year = frappe.get_all(
+ "Fiscal Year", fields=["year_start_date", "year_end_date"], order_by="year_start_date"
)[0]
# Keep on creating fiscal years
# until smallest_ledger_entry_date is no longer smaller than the oldest fiscal year's start date
@@ -272,7 +295,9 @@ class QuickBooksMigrator(Document):
if new_fiscal_year.year_start_date.year == new_fiscal_year.year_end_date.year:
new_fiscal_year.year = new_fiscal_year.year_start_date.year
else:
- new_fiscal_year.year = "{}-{}".format(new_fiscal_year.year_start_date.year, new_fiscal_year.year_end_date.year)
+ new_fiscal_year.year = "{}-{}".format(
+ new_fiscal_year.year_start_date.year, new_fiscal_year.year_end_date.year
+ )
new_fiscal_year.save()
oldest_fiscal_year = new_fiscal_year
@@ -280,40 +305,30 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e)
-
def _migrate_entries_from_gl(self, entity):
if entity in self.general_ledger:
self._save_entries(entity, self.general_ledger[entity].values())
-
def _save_entries(self, entity, entries):
entity_method_map = {
"Account": self._save_account,
"TaxRate": self._save_tax_rate,
"TaxCode": self._save_tax_code,
-
"Preferences": self._save_preference,
-
"Customer": self._save_customer,
"Item": self._save_item,
"Vendor": self._save_vendor,
-
"Invoice": self._save_invoice,
"CreditMemo": self._save_credit_memo,
"SalesReceipt": self._save_sales_receipt,
"RefundReceipt": self._save_refund_receipt,
-
"JournalEntry": self._save_journal_entry,
-
"Bill": self._save_bill,
"VendorCredit": self._save_vendor_credit,
-
"Payment": self._save_payment,
"BillPayment": self._save_bill_payment,
-
"Purchase": self._save_purchase,
"Deposit": self._save_deposit,
-
"Advance Payment": self._save_advance_payment,
"Tax Payment": self._save_tax_payment,
"Sales Tax Payment": self._save_tax_payment,
@@ -322,11 +337,17 @@ class QuickBooksMigrator(Document):
}
total = len(entries)
for index, entry in enumerate(entries, start=1):
- self._publish({"event": "progress", "message": _("Saving {0}").format(entity), "count": index, "total": total})
+ self._publish(
+ {
+ "event": "progress",
+ "message": _("Saving {0}").format(entity),
+ "count": index,
+ "total": total,
+ }
+ )
entity_method_map[entity](entry)
frappe.db.commit()
-
def _preprocess_entries(self, entity, entries):
entity_method_map = {
"Account": self._preprocess_accounts,
@@ -338,7 +359,6 @@ class QuickBooksMigrator(Document):
entries = preprocessor(entries)
return entries
-
def _get_gl_entries_from_section(self, section, account=None):
if "Header" in section:
if "id" in section["Header"]["ColData"][0]:
@@ -359,19 +379,20 @@ class QuickBooksMigrator(Document):
for row in section["Rows"]["Row"]:
if row["type"] == "Data":
data = row["ColData"]
- entries.append({
- "account": account,
- "date": data[0]["value"],
- "type": data[1]["value"],
- "id": data[1].get("id"),
- "credit": frappe.utils.flt(data[2]["value"]),
- "debit": frappe.utils.flt(data[3]["value"]),
- })
+ entries.append(
+ {
+ "account": account,
+ "date": data[0]["value"],
+ "type": data[1]["value"],
+ "id": data[1].get("id"),
+ "credit": frappe.utils.flt(data[2]["value"]),
+ "debit": frappe.utils.flt(data[3]["value"]),
+ }
+ )
if row["type"] == "Section":
self._get_gl_entries_from_section(row, account)
self.gl_entries.setdefault(account, []).extend(entries)
-
def _preprocess_accounts(self, accounts):
self.accounts = {account["Name"]: account for account in accounts}
for account in accounts:
@@ -381,7 +402,6 @@ class QuickBooksMigrator(Document):
account["is_group"] = 0
return sorted(accounts, key=lambda account: int(account["Id"]))
-
def _save_account(self, account):
mapping = {
"Bank": "Asset",
@@ -389,24 +409,22 @@ class QuickBooksMigrator(Document):
"Fixed Asset": "Asset",
"Other Asset": "Asset",
"Accounts Receivable": "Asset",
-
"Equity": "Equity",
-
"Expense": "Expense",
"Other Expense": "Expense",
"Cost of Goods Sold": "Expense",
-
"Accounts Payable": "Liability",
"Credit Card": "Liability",
"Long Term Liability": "Liability",
"Other Current Liability": "Liability",
-
"Income": "Income",
"Other Income": "Income",
}
# Map Quickbooks Account Types to ERPNext root_accunts and and root_type
try:
- if not frappe.db.exists({"doctype": "Account", "quickbooks_id": account["Id"], "company": self.company}):
+ if not frappe.db.exists(
+ {"doctype": "Account", "quickbooks_id": account["Id"], "company": self.company}
+ ):
is_child = account["SubAccount"]
is_group = account["is_group"]
# Create Two Accounts for every Group Account
@@ -416,103 +434,125 @@ class QuickBooksMigrator(Document):
account_id = account["Id"]
if is_child:
- parent_account = self._get_account_name_by_id("Group - {}".format(account["ParentRef"]["value"]))
+ parent_account = self._get_account_name_by_id(
+ "Group - {}".format(account["ParentRef"]["value"])
+ )
else:
- parent_account = encode_company_abbr("{} - QB".format(mapping[account["AccountType"]]), self.company)
+ parent_account = encode_company_abbr(
+ "{} - QB".format(mapping[account["AccountType"]]), self.company
+ )
- frappe.get_doc({
- "doctype": "Account",
- "quickbooks_id": account_id,
- "account_name": self._get_unique_account_name(account["Name"]),
- "root_type": mapping[account["AccountType"]],
- "account_type": self._get_account_type(account),
- "account_currency": account["CurrencyRef"]["value"],
- "parent_account": parent_account,
- "is_group": is_group,
- "company": self.company,
- }).insert()
-
- if is_group:
- # Create a Leaf account corresponding to the group account
- frappe.get_doc({
+ frappe.get_doc(
+ {
"doctype": "Account",
- "quickbooks_id": account["Id"],
+ "quickbooks_id": account_id,
"account_name": self._get_unique_account_name(account["Name"]),
"root_type": mapping[account["AccountType"]],
"account_type": self._get_account_type(account),
"account_currency": account["CurrencyRef"]["value"],
- "parent_account": self._get_account_name_by_id(account_id),
- "is_group": 0,
+ "parent_account": parent_account,
+ "is_group": is_group,
"company": self.company,
- }).insert()
+ }
+ ).insert()
+
+ if is_group:
+ # Create a Leaf account corresponding to the group account
+ frappe.get_doc(
+ {
+ "doctype": "Account",
+ "quickbooks_id": account["Id"],
+ "account_name": self._get_unique_account_name(account["Name"]),
+ "root_type": mapping[account["AccountType"]],
+ "account_type": self._get_account_type(account),
+ "account_currency": account["CurrencyRef"]["value"],
+ "parent_account": self._get_account_name_by_id(account_id),
+ "is_group": 0,
+ "company": self.company,
+ }
+ ).insert()
if account.get("AccountSubType") == "UndepositedFunds":
self.undeposited_funds_account = self._get_account_name_by_id(account["Id"])
self.save()
except Exception as e:
self._log_error(e, account)
-
def _get_account_type(self, account):
account_subtype_mapping = {"UndepositedFunds": "Cash"}
account_type = account_subtype_mapping.get(account.get("AccountSubType"))
if account_type is None:
- account_type_mapping = {"Accounts Payable": "Payable", "Accounts Receivable": "Receivable", "Bank": "Bank", "Credit Card": "Bank"}
+ account_type_mapping = {
+ "Accounts Payable": "Payable",
+ "Accounts Receivable": "Receivable",
+ "Bank": "Bank",
+ "Credit Card": "Bank",
+ }
account_type = account_type_mapping.get(account["AccountType"])
return account_type
-
def _preprocess_tax_rates(self, tax_rates):
self.tax_rates = {tax_rate["Id"]: tax_rate for tax_rate in tax_rates}
return tax_rates
-
def _save_tax_rate(self, tax_rate):
try:
- if not frappe.db.exists({"doctype": "Account", "quickbooks_id": "TaxRate - {}".format(tax_rate["Id"]), "company": self.company}):
- frappe.get_doc({
+ if not frappe.db.exists(
+ {
"doctype": "Account",
"quickbooks_id": "TaxRate - {}".format(tax_rate["Id"]),
- "account_name": "{} - QB".format(tax_rate["Name"]),
- "root_type": "Liability",
- "parent_account": encode_company_abbr("{} - QB".format("Liability"), self.company),
- "is_group": "0",
"company": self.company,
- }).insert()
+ }
+ ):
+ frappe.get_doc(
+ {
+ "doctype": "Account",
+ "quickbooks_id": "TaxRate - {}".format(tax_rate["Id"]),
+ "account_name": "{} - QB".format(tax_rate["Name"]),
+ "root_type": "Liability",
+ "parent_account": encode_company_abbr("{} - QB".format("Liability"), self.company),
+ "is_group": "0",
+ "company": self.company,
+ }
+ ).insert()
except Exception as e:
self._log_error(e, tax_rate)
-
def _preprocess_tax_codes(self, tax_codes):
self.tax_codes = {tax_code["Id"]: tax_code for tax_code in tax_codes}
return tax_codes
-
def _save_tax_code(self, tax_code):
pass
-
def _save_customer(self, customer):
try:
- if not frappe.db.exists({"doctype": "Customer", "quickbooks_id": customer["Id"], "company": self.company}):
+ if not frappe.db.exists(
+ {"doctype": "Customer", "quickbooks_id": customer["Id"], "company": self.company}
+ ):
try:
- receivable_account = frappe.get_all("Account", filters={
- "account_type": "Receivable",
- "account_currency": customer["CurrencyRef"]["value"],
- "company": self.company,
- })[0]["name"]
+ receivable_account = frappe.get_all(
+ "Account",
+ filters={
+ "account_type": "Receivable",
+ "account_currency": customer["CurrencyRef"]["value"],
+ "company": self.company,
+ },
+ )[0]["name"]
except Exception:
receivable_account = None
- erpcustomer = frappe.get_doc({
- "doctype": "Customer",
- "quickbooks_id": customer["Id"],
- "customer_name": encode_company_abbr(customer["DisplayName"], self.company),
- "customer_type": "Individual",
- "customer_group": "Commercial",
- "default_currency": customer["CurrencyRef"]["value"],
- "accounts": [{"company": self.company, "account": receivable_account}],
- "territory": "All Territories",
- "company": self.company,
- }).insert()
+ erpcustomer = frappe.get_doc(
+ {
+ "doctype": "Customer",
+ "quickbooks_id": customer["Id"],
+ "customer_name": encode_company_abbr(customer["DisplayName"], self.company),
+ "customer_type": "Individual",
+ "customer_group": "Commercial",
+ "default_currency": customer["CurrencyRef"]["value"],
+ "accounts": [{"company": self.company, "account": receivable_account}],
+ "territory": "All Territories",
+ "company": self.company,
+ }
+ ).insert()
if "BillAddr" in customer:
self._create_address(erpcustomer, "Customer", customer["BillAddr"], "Billing")
if "ShipAddr" in customer:
@@ -520,10 +560,11 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, customer)
-
def _save_item(self, item):
try:
- if not frappe.db.exists({"doctype": "Item", "quickbooks_id": item["Id"], "company": self.company}):
+ if not frappe.db.exists(
+ {"doctype": "Item", "quickbooks_id": item["Id"], "company": self.company}
+ ):
if item["Type"] in ("Service", "Inventory"):
item_dict = {
"doctype": "Item",
@@ -533,7 +574,7 @@ class QuickBooksMigrator(Document):
"is_stock_item": 0,
"item_group": "All Item Groups",
"company": self.company,
- "item_defaults": [{"company": self.company, "default_warehouse": self.default_warehouse}]
+ "item_defaults": [{"company": self.company, "default_warehouse": self.default_warehouse}],
}
if "ExpenseAccountRef" in item:
expense_account = self._get_account_name_by_id(item["ExpenseAccountRef"]["value"])
@@ -545,21 +586,23 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, item)
-
def _allow_fraction_in_unit(self):
frappe.db.set_value("UOM", "Unit", "must_be_whole_number", 0)
-
def _save_vendor(self, vendor):
try:
- if not frappe.db.exists({"doctype": "Supplier", "quickbooks_id": vendor["Id"], "company": self.company}):
- erpsupplier = frappe.get_doc({
- "doctype": "Supplier",
- "quickbooks_id": vendor["Id"],
- "supplier_name": encode_company_abbr(vendor["DisplayName"], self.company),
- "supplier_group": "All Supplier Groups",
- "company": self.company,
- }).insert()
+ if not frappe.db.exists(
+ {"doctype": "Supplier", "quickbooks_id": vendor["Id"], "company": self.company}
+ ):
+ erpsupplier = frappe.get_doc(
+ {
+ "doctype": "Supplier",
+ "quickbooks_id": vendor["Id"],
+ "supplier_name": encode_company_abbr(vendor["DisplayName"], self.company),
+ "supplier_group": "All Supplier Groups",
+ "company": self.company,
+ }
+ ).insert()
if "BillAddr" in vendor:
self._create_address(erpsupplier, "Supplier", vendor["BillAddr"], "Billing")
if "ShipAddr" in vendor:
@@ -567,7 +610,6 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e)
-
def _save_preference(self, preference):
try:
if preference["SalesFormsPrefs"]["AllowShipping"]:
@@ -577,7 +619,6 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, preference)
-
def _save_invoice(self, invoice):
# Invoice can be Linked with Another Transactions
# If any of these transactions is a "StatementCharge" or "ReimburseCharge" then in the UI
@@ -585,59 +626,56 @@ class QuickBooksMigrator(Document):
# Also as of now there is no way of fetching the corresponding transaction from api
# We in order to correctly reflect account balance make an equivalent Journal Entry
quickbooks_id = "Invoice - {}".format(invoice["Id"])
- if any(linked["TxnType"] in ("StatementCharge", "ReimburseCharge") for linked in invoice["LinkedTxn"]):
+ if any(
+ linked["TxnType"] in ("StatementCharge", "ReimburseCharge") for linked in invoice["LinkedTxn"]
+ ):
self._save_invoice_as_journal_entry(invoice, quickbooks_id)
else:
self._save_sales_invoice(invoice, quickbooks_id)
-
def _save_credit_memo(self, credit_memo):
# Credit Memo is equivalent to a return Sales Invoice
quickbooks_id = "Credit Memo - {}".format(credit_memo["Id"])
self._save_sales_invoice(credit_memo, quickbooks_id, is_return=True)
-
def _save_sales_receipt(self, sales_receipt):
# Sales Receipt is equivalent to a POS Sales Invoice
quickbooks_id = "Sales Receipt - {}".format(sales_receipt["Id"])
self._save_sales_invoice(sales_receipt, quickbooks_id, is_pos=True)
-
def _save_refund_receipt(self, refund_receipt):
# Refund Receipt is equivalent to a return POS Sales Invoice
quickbooks_id = "Refund Receipt - {}".format(refund_receipt["Id"])
self._save_sales_invoice(refund_receipt, quickbooks_id, is_return=True, is_pos=True)
-
def _save_sales_invoice(self, invoice, quickbooks_id, is_return=False, is_pos=False):
try:
- if not frappe.db.exists({"doctype": "Sales Invoice", "quickbooks_id": quickbooks_id, "company": self.company}):
+ if not frappe.db.exists(
+ {"doctype": "Sales Invoice", "quickbooks_id": quickbooks_id, "company": self.company}
+ ):
invoice_dict = {
"doctype": "Sales Invoice",
"quickbooks_id": quickbooks_id,
-
# Quickbooks uses ISO 4217 Code
# of course this gonna come back to bite me
"currency": invoice["CurrencyRef"]["value"],
-
# Exchange Rate is provided if multicurrency is enabled
# It is not provided if multicurrency is not enabled
"conversion_rate": invoice.get("ExchangeRate", 1),
"posting_date": invoice["TxnDate"],
-
# QuickBooks doesn't make Due Date a mandatory field this is a hack
"due_date": invoice.get("DueDate", invoice["TxnDate"]),
- "customer": frappe.get_all("Customer",
+ "customer": frappe.get_all(
+ "Customer",
filters={
"quickbooks_id": invoice["CustomerRef"]["value"],
"company": self.company,
- })[0]["name"],
+ },
+ )[0]["name"],
"items": self._get_si_items(invoice, is_return=is_return),
"taxes": self._get_taxes(invoice),
-
# Do not change posting_date upon submission
"set_posting_time": 1,
-
# QuickBooks doesn't round total
"disable_rounded_total": 1,
"is_return": is_return,
@@ -659,7 +697,6 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, [invoice, invoice_dict, json.loads(invoice_doc.as_json())])
-
def _get_si_items(self, invoice, is_return=False):
items = []
for line in invoice["Line"]:
@@ -672,48 +709,56 @@ class QuickBooksMigrator(Document):
else:
tax_code = "NON"
if line["SalesItemLineDetail"]["ItemRef"]["value"] != "SHIPPING_ITEM_ID":
- item = frappe.db.get_all("Item",
+ item = frappe.db.get_all(
+ "Item",
filters={
"quickbooks_id": line["SalesItemLineDetail"]["ItemRef"]["value"],
"company": self.company,
},
- fields=["name", "stock_uom"]
+ fields=["name", "stock_uom"],
)[0]
- items.append({
- "item_code": item["name"],
- "conversion_factor": 1,
- "uom": item["stock_uom"],
- "description": line.get("Description", line["SalesItemLineDetail"]["ItemRef"]["name"]),
- "qty": line["SalesItemLineDetail"]["Qty"],
- "price_list_rate": line["SalesItemLineDetail"]["UnitPrice"],
- "cost_center": self.default_cost_center,
- "warehouse": self.default_warehouse,
- "item_tax_rate": json.dumps(self._get_item_taxes(tax_code))
- })
+ items.append(
+ {
+ "item_code": item["name"],
+ "conversion_factor": 1,
+ "uom": item["stock_uom"],
+ "description": line.get("Description", line["SalesItemLineDetail"]["ItemRef"]["name"]),
+ "qty": line["SalesItemLineDetail"]["Qty"],
+ "price_list_rate": line["SalesItemLineDetail"]["UnitPrice"],
+ "cost_center": self.default_cost_center,
+ "warehouse": self.default_warehouse,
+ "item_tax_rate": json.dumps(self._get_item_taxes(tax_code)),
+ }
+ )
else:
- items.append({
- "item_name": "Shipping",
- "conversion_factor": 1,
- "expense_account": self._get_account_name_by_id("TaxRate - {}".format(line["SalesItemLineDetail"]["TaxCodeRef"]["value"])),
- "uom": "Unit",
- "description": "Shipping",
- "income_account": self.default_shipping_account,
- "qty": 1,
- "price_list_rate": line["Amount"],
- "cost_center": self.default_cost_center,
- "warehouse": self.default_warehouse,
- "item_tax_rate": json.dumps(self._get_item_taxes(tax_code))
- })
+ items.append(
+ {
+ "item_name": "Shipping",
+ "conversion_factor": 1,
+ "expense_account": self._get_account_name_by_id(
+ "TaxRate - {}".format(line["SalesItemLineDetail"]["TaxCodeRef"]["value"])
+ ),
+ "uom": "Unit",
+ "description": "Shipping",
+ "income_account": self.default_shipping_account,
+ "qty": 1,
+ "price_list_rate": line["Amount"],
+ "cost_center": self.default_cost_center,
+ "warehouse": self.default_warehouse,
+ "item_tax_rate": json.dumps(self._get_item_taxes(tax_code)),
+ }
+ )
if is_return:
items[-1]["qty"] *= -1
elif line["DetailType"] == "DescriptionOnly":
- items[-1].update({
- "margin_type": "Percentage",
- "margin_rate_or_amount": int(line["Description"].split("%")[0]),
- })
+ items[-1].update(
+ {
+ "margin_type": "Percentage",
+ "margin_rate_or_amount": int(line["Description"].split("%")[0]),
+ }
+ )
return items
-
def _get_item_taxes(self, tax_code):
tax_rates = self.tax_rates
item_taxes = {}
@@ -723,30 +768,31 @@ class QuickBooksMigrator(Document):
if rate_list_type in tax_code:
for tax_rate_detail in tax_code[rate_list_type]["TaxRateDetail"]:
if tax_rate_detail["TaxTypeApplicable"] == "TaxOnAmount":
- tax_head = self._get_account_name_by_id("TaxRate - {}".format(tax_rate_detail["TaxRateRef"]["value"]))
+ tax_head = self._get_account_name_by_id(
+ "TaxRate - {}".format(tax_rate_detail["TaxRateRef"]["value"])
+ )
tax_rate = tax_rates[tax_rate_detail["TaxRateRef"]["value"]]
item_taxes[tax_head] = tax_rate["RateValue"]
return item_taxes
-
def _get_invoice_payments(self, invoice, is_return=False, is_pos=False):
if is_pos:
amount = invoice["TotalAmt"]
if is_return:
amount = -amount
- return [{
- "mode_of_payment": "Cash",
- "account": self._get_account_name_by_id(invoice["DepositToAccountRef"]["value"]),
- "amount": amount,
- }]
-
+ return [
+ {
+ "mode_of_payment": "Cash",
+ "account": self._get_account_name_by_id(invoice["DepositToAccountRef"]["value"]),
+ "amount": amount,
+ }
+ ]
def _get_discount(self, lines):
for line in lines:
if line["DetailType"] == "DiscountLineDetail" and "Amount" in line["DiscountLineDetail"]:
return line
-
def _save_invoice_as_journal_entry(self, invoice, quickbooks_id):
try:
accounts = []
@@ -758,8 +804,9 @@ class QuickBooksMigrator(Document):
account_line["credit_in_account_currency"] = line["credit"]
if frappe.db.get_value("Account", line["account"], "account_type") == "Receivable":
account_line["party_type"] = "Customer"
- account_line["party"] = frappe.get_all("Customer",
- filters={"quickbooks_id": invoice["CustomerRef"]["value"], "company": self.company}
+ account_line["party"] = frappe.get_all(
+ "Customer",
+ filters={"quickbooks_id": invoice["CustomerRef"]["value"], "company": self.company},
)[0]["name"]
accounts.append(account_line)
@@ -769,7 +816,6 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, [invoice, accounts])
-
def _save_journal_entry(self, journal_entry):
# JournalEntry is equivalent to a Journal Entry
@@ -782,13 +828,17 @@ class QuickBooksMigrator(Document):
accounts = []
for line in lines:
if line["DetailType"] == "JournalEntryLineDetail":
- account_name = self._get_account_name_by_id(line["JournalEntryLineDetail"]["AccountRef"]["value"])
+ account_name = self._get_account_name_by_id(
+ line["JournalEntryLineDetail"]["AccountRef"]["value"]
+ )
posting_type = line["JournalEntryLineDetail"]["PostingType"]
- accounts.append({
- "account": account_name,
- posting_type_field_mapping[posting_type]: line["Amount"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "account": account_name,
+ posting_type_field_mapping[posting_type]: line["Amount"],
+ "cost_center": self.default_cost_center,
+ }
+ )
return accounts
quickbooks_id = "Journal Entry - {}".format(journal_entry["Id"])
@@ -796,39 +846,41 @@ class QuickBooksMigrator(Document):
posting_date = journal_entry["TxnDate"]
self.__save_journal_entry(quickbooks_id, accounts, posting_date)
-
def __save_journal_entry(self, quickbooks_id, accounts, posting_date):
try:
- if not frappe.db.exists({"doctype": "Journal Entry", "quickbooks_id": quickbooks_id, "company": self.company}):
- je = frappe.get_doc({
- "doctype": "Journal Entry",
- "quickbooks_id": quickbooks_id,
- "company": self.company,
- "posting_date": posting_date,
- "accounts": accounts,
- "multi_currency": 1,
- })
+ if not frappe.db.exists(
+ {"doctype": "Journal Entry", "quickbooks_id": quickbooks_id, "company": self.company}
+ ):
+ je = frappe.get_doc(
+ {
+ "doctype": "Journal Entry",
+ "quickbooks_id": quickbooks_id,
+ "company": self.company,
+ "posting_date": posting_date,
+ "accounts": accounts,
+ "multi_currency": 1,
+ }
+ )
je.insert()
je.submit()
except Exception as e:
self._log_error(e, [accounts, json.loads(je.as_json())])
-
def _save_bill(self, bill):
# Bill is equivalent to a Purchase Invoice
quickbooks_id = "Bill - {}".format(bill["Id"])
self.__save_purchase_invoice(bill, quickbooks_id)
-
def _save_vendor_credit(self, vendor_credit):
# Vendor Credit is equivalent to a return Purchase Invoice
quickbooks_id = "Vendor Credit - {}".format(vendor_credit["Id"])
self.__save_purchase_invoice(vendor_credit, quickbooks_id, is_return=True)
-
def __save_purchase_invoice(self, invoice, quickbooks_id, is_return=False):
try:
- if not frappe.db.exists({"doctype": "Purchase Invoice", "quickbooks_id": quickbooks_id, "company": self.company}):
+ if not frappe.db.exists(
+ {"doctype": "Purchase Invoice", "quickbooks_id": quickbooks_id, "company": self.company}
+ ):
credit_to_account = self._get_account_name_by_id(invoice["APAccountRef"]["value"])
invoice_dict = {
"doctype": "Purchase Invoice",
@@ -838,11 +890,13 @@ class QuickBooksMigrator(Document):
"posting_date": invoice["TxnDate"],
"due_date": invoice.get("DueDate", invoice["TxnDate"]),
"credit_to": credit_to_account,
- "supplier": frappe.get_all("Supplier",
+ "supplier": frappe.get_all(
+ "Supplier",
filters={
"quickbooks_id": invoice["VendorRef"]["value"],
"company": self.company,
- })[0]["name"],
+ },
+ )[0]["name"],
"items": self._get_pi_items(invoice, is_return=is_return),
"taxes": self._get_taxes(invoice),
"set_posting_time": 1,
@@ -857,7 +911,6 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, [invoice, invoice_dict, json.loads(invoice_doc.as_json())])
-
def _get_pi_items(self, purchase_invoice, is_return=False):
items = []
for line in purchase_invoice["Line"]:
@@ -869,24 +922,29 @@ class QuickBooksMigrator(Document):
tax_code = purchase_invoice["TxnTaxDetail"]["TxnTaxCodeRef"]["value"]
else:
tax_code = "NON"
- item = frappe.db.get_all("Item",
+ item = frappe.db.get_all(
+ "Item",
filters={
"quickbooks_id": line["ItemBasedExpenseLineDetail"]["ItemRef"]["value"],
- "company": self.company
+ "company": self.company,
},
- fields=["name", "stock_uom"]
+ fields=["name", "stock_uom"],
)[0]
- items.append({
- "item_code": item["name"],
- "conversion_factor": 1,
- "uom": item["stock_uom"],
- "description": line.get("Description", line["ItemBasedExpenseLineDetail"]["ItemRef"]["name"]),
- "qty": line["ItemBasedExpenseLineDetail"]["Qty"],
- "price_list_rate": line["ItemBasedExpenseLineDetail"]["UnitPrice"],
- "warehouse": self.default_warehouse,
- "cost_center": self.default_cost_center,
- "item_tax_rate": json.dumps(self._get_item_taxes(tax_code)),
- })
+ items.append(
+ {
+ "item_code": item["name"],
+ "conversion_factor": 1,
+ "uom": item["stock_uom"],
+ "description": line.get(
+ "Description", line["ItemBasedExpenseLineDetail"]["ItemRef"]["name"]
+ ),
+ "qty": line["ItemBasedExpenseLineDetail"]["Qty"],
+ "price_list_rate": line["ItemBasedExpenseLineDetail"]["UnitPrice"],
+ "warehouse": self.default_warehouse,
+ "cost_center": self.default_cost_center,
+ "item_tax_rate": json.dumps(self._get_item_taxes(tax_code)),
+ }
+ )
elif line["DetailType"] == "AccountBasedExpenseLineDetail":
if line["AccountBasedExpenseLineDetail"]["TaxCodeRef"]["value"] != "TAX":
tax_code = line["AccountBasedExpenseLineDetail"]["TaxCodeRef"]["value"]
@@ -895,23 +953,30 @@ class QuickBooksMigrator(Document):
tax_code = purchase_invoice["TxnTaxDetail"]["TxnTaxCodeRef"]["value"]
else:
tax_code = "NON"
- items.append({
- "item_name": line.get("Description", line["AccountBasedExpenseLineDetail"]["AccountRef"]["name"]),
- "conversion_factor": 1,
- "expense_account": self._get_account_name_by_id(line["AccountBasedExpenseLineDetail"]["AccountRef"]["value"]),
- "uom": "Unit",
- "description": line.get("Description", line["AccountBasedExpenseLineDetail"]["AccountRef"]["name"]),
- "qty": 1,
- "price_list_rate": line["Amount"],
- "warehouse": self.default_warehouse,
- "cost_center": self.default_cost_center,
- "item_tax_rate": json.dumps(self._get_item_taxes(tax_code)),
- })
+ items.append(
+ {
+ "item_name": line.get(
+ "Description", line["AccountBasedExpenseLineDetail"]["AccountRef"]["name"]
+ ),
+ "conversion_factor": 1,
+ "expense_account": self._get_account_name_by_id(
+ line["AccountBasedExpenseLineDetail"]["AccountRef"]["value"]
+ ),
+ "uom": "Unit",
+ "description": line.get(
+ "Description", line["AccountBasedExpenseLineDetail"]["AccountRef"]["name"]
+ ),
+ "qty": 1,
+ "price_list_rate": line["Amount"],
+ "warehouse": self.default_warehouse,
+ "cost_center": self.default_cost_center,
+ "item_tax_rate": json.dumps(self._get_item_taxes(tax_code)),
+ }
+ )
if is_return:
items[-1]["qty"] *= -1
return items
-
def _save_payment(self, payment):
try:
quickbooks_id = "Payment - {}".format(payment["Id"])
@@ -928,8 +993,11 @@ class QuickBooksMigrator(Document):
if linked_transaction["TxnType"] == "Invoice":
si_quickbooks_id = "Invoice - {}".format(linked_transaction["TxnId"])
# Invoice could have been saved as a Sales Invoice or a Journal Entry
- if frappe.db.exists({"doctype": "Sales Invoice", "quickbooks_id": si_quickbooks_id, "company": self.company}):
- sales_invoice = frappe.get_all("Sales Invoice",
+ if frappe.db.exists(
+ {"doctype": "Sales Invoice", "quickbooks_id": si_quickbooks_id, "company": self.company}
+ ):
+ sales_invoice = frappe.get_all(
+ "Sales Invoice",
filters={
"quickbooks_id": si_quickbooks_id,
"company": self.company,
@@ -941,43 +1009,51 @@ class QuickBooksMigrator(Document):
party = sales_invoice["customer"]
party_account = sales_invoice["debit_to"]
- if frappe.db.exists({"doctype": "Journal Entry", "quickbooks_id": si_quickbooks_id, "company": self.company}):
- journal_entry = frappe.get_doc("Journal Entry",
+ if frappe.db.exists(
+ {"doctype": "Journal Entry", "quickbooks_id": si_quickbooks_id, "company": self.company}
+ ):
+ journal_entry = frappe.get_doc(
+ "Journal Entry",
{
"quickbooks_id": si_quickbooks_id,
"company": self.company,
- }
+ },
)
# Invoice saved as a Journal Entry must have party and party_type set on line containing Receivable Account
- customer_account_line = list(filter(lambda acc: acc.party_type == "Customer", journal_entry.accounts))[0]
+ customer_account_line = list(
+ filter(lambda acc: acc.party_type == "Customer", journal_entry.accounts)
+ )[0]
reference_type = "Journal Entry"
reference_name = journal_entry.name
party = customer_account_line.party
party_account = customer_account_line.account
- accounts.append({
- "party_type": "Customer",
- "party": party,
- "reference_type": reference_type,
- "reference_name": reference_name,
- "account": party_account,
- "credit_in_account_currency": line["Amount"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "party_type": "Customer",
+ "party": party,
+ "reference_type": reference_type,
+ "reference_name": reference_name,
+ "account": party_account,
+ "credit_in_account_currency": line["Amount"],
+ "cost_center": self.default_cost_center,
+ }
+ )
deposit_account = self._get_account_name_by_id(payment["DepositToAccountRef"]["value"])
- accounts.append({
- "account": deposit_account,
- "debit_in_account_currency": payment["TotalAmt"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "account": deposit_account,
+ "debit_in_account_currency": payment["TotalAmt"],
+ "cost_center": self.default_cost_center,
+ }
+ )
posting_date = payment["TxnDate"]
self.__save_journal_entry(quickbooks_id, accounts, posting_date)
except Exception as e:
self._log_error(e, [payment, accounts])
-
def _save_bill_payment(self, bill_payment):
try:
quickbooks_id = "BillPayment - {}".format(bill_payment["Id"])
@@ -987,8 +1063,11 @@ class QuickBooksMigrator(Document):
linked_transaction = line["LinkedTxn"][0]
if linked_transaction["TxnType"] == "Bill":
pi_quickbooks_id = "Bill - {}".format(linked_transaction["TxnId"])
- if frappe.db.exists({"doctype": "Purchase Invoice", "quickbooks_id": pi_quickbooks_id, "company": self.company}):
- purchase_invoice = frappe.get_all("Purchase Invoice",
+ if frappe.db.exists(
+ {"doctype": "Purchase Invoice", "quickbooks_id": pi_quickbooks_id, "company": self.company}
+ ):
+ purchase_invoice = frappe.get_all(
+ "Purchase Invoice",
filters={
"quickbooks_id": pi_quickbooks_id,
"company": self.company,
@@ -999,15 +1078,17 @@ class QuickBooksMigrator(Document):
reference_name = purchase_invoice["name"]
party = purchase_invoice["supplier"]
party_account = purchase_invoice["credit_to"]
- accounts.append({
- "party_type": "Supplier",
- "party": party,
- "reference_type": reference_type,
- "reference_name": reference_name,
- "account": party_account,
- "debit_in_account_currency": line["Amount"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "party_type": "Supplier",
+ "party": party,
+ "reference_type": reference_type,
+ "reference_name": reference_name,
+ "account": party_account,
+ "debit_in_account_currency": line["Amount"],
+ "cost_center": self.default_cost_center,
+ }
+ )
if bill_payment["PayType"] == "Check":
bank_account_id = bill_payment["CheckPayment"]["BankAccountRef"]["value"]
@@ -1015,49 +1096,68 @@ class QuickBooksMigrator(Document):
bank_account_id = bill_payment["CreditCardPayment"]["CCAccountRef"]["value"]
bank_account = self._get_account_name_by_id(bank_account_id)
- accounts.append({
- "account": bank_account,
- "credit_in_account_currency": bill_payment["TotalAmt"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "account": bank_account,
+ "credit_in_account_currency": bill_payment["TotalAmt"],
+ "cost_center": self.default_cost_center,
+ }
+ )
posting_date = bill_payment["TxnDate"]
self.__save_journal_entry(quickbooks_id, accounts, posting_date)
except Exception as e:
self._log_error(e, [bill_payment, accounts])
-
def _save_purchase(self, purchase):
try:
quickbooks_id = "Purchase - {}".format(purchase["Id"])
# Credit Bank Account
- accounts = [{
- "account": self._get_account_name_by_id(purchase["AccountRef"]["value"]),
- "credit_in_account_currency": purchase["TotalAmt"],
- "cost_center": self.default_cost_center,
- }]
+ accounts = [
+ {
+ "account": self._get_account_name_by_id(purchase["AccountRef"]["value"]),
+ "credit_in_account_currency": purchase["TotalAmt"],
+ "cost_center": self.default_cost_center,
+ }
+ ]
# Debit Mentioned Accounts
for line in purchase["Line"]:
if line["DetailType"] == "AccountBasedExpenseLineDetail":
- account = self._get_account_name_by_id(line["AccountBasedExpenseLineDetail"]["AccountRef"]["value"])
+ account = self._get_account_name_by_id(
+ line["AccountBasedExpenseLineDetail"]["AccountRef"]["value"]
+ )
elif line["DetailType"] == "ItemBasedExpenseLineDetail":
- account = frappe.get_doc("Item",
- {"quickbooks_id": line["ItemBasedExpenseLineDetail"]["ItemRef"]["value"], "company": self.company}
- ).item_defaults[0].expense_account
- accounts.append({
- "account": account,
- "debit_in_account_currency": line["Amount"],
- "cost_center": self.default_cost_center,
- })
+ account = (
+ frappe.get_doc(
+ "Item",
+ {
+ "quickbooks_id": line["ItemBasedExpenseLineDetail"]["ItemRef"]["value"],
+ "company": self.company,
+ },
+ )
+ .item_defaults[0]
+ .expense_account
+ )
+ accounts.append(
+ {
+ "account": account,
+ "debit_in_account_currency": line["Amount"],
+ "cost_center": self.default_cost_center,
+ }
+ )
# Debit Tax Accounts
if "TxnTaxDetail" in purchase:
for line in purchase["TxnTaxDetail"]["TaxLine"]:
- accounts.append({
- "account": self._get_account_name_by_id("TaxRate - {}".format(line["TaxLineDetail"]["TaxRateRef"]["value"])),
- "debit_in_account_currency": line["Amount"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "account": self._get_account_name_by_id(
+ "TaxRate - {}".format(line["TaxLineDetail"]["TaxRateRef"]["value"])
+ ),
+ "debit_in_account_currency": line["Amount"],
+ "cost_center": self.default_cost_center,
+ }
+ )
# If purchase["Credit"] is set to be True then it represents a refund
if purchase.get("Credit"):
@@ -1074,61 +1174,64 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, [purchase, accounts])
-
def _save_deposit(self, deposit):
try:
quickbooks_id = "Deposit - {}".format(deposit["Id"])
# Debit Bank Account
- accounts = [{
- "account": self._get_account_name_by_id(deposit["DepositToAccountRef"]["value"]),
- "debit_in_account_currency": deposit["TotalAmt"],
- "cost_center": self.default_cost_center,
- }]
+ accounts = [
+ {
+ "account": self._get_account_name_by_id(deposit["DepositToAccountRef"]["value"]),
+ "debit_in_account_currency": deposit["TotalAmt"],
+ "cost_center": self.default_cost_center,
+ }
+ ]
# Credit Mentioned Accounts
for line in deposit["Line"]:
if "LinkedTxn" in line:
- accounts.append({
- "account": self.undeposited_funds_account,
- "credit_in_account_currency": line["Amount"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "account": self.undeposited_funds_account,
+ "credit_in_account_currency": line["Amount"],
+ "cost_center": self.default_cost_center,
+ }
+ )
else:
- accounts.append({
- "account": self._get_account_name_by_id(line["DepositLineDetail"]["AccountRef"]["value"]),
- "credit_in_account_currency": line["Amount"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "account": self._get_account_name_by_id(line["DepositLineDetail"]["AccountRef"]["value"]),
+ "credit_in_account_currency": line["Amount"],
+ "cost_center": self.default_cost_center,
+ }
+ )
# Debit Cashback if mentioned
if "CashBack" in deposit:
- accounts.append({
- "account": self._get_account_name_by_id(deposit["CashBack"]["AccountRef"]["value"]),
- "debit_in_account_currency": deposit["CashBack"]["Amount"],
- "cost_center": self.default_cost_center,
- })
+ accounts.append(
+ {
+ "account": self._get_account_name_by_id(deposit["CashBack"]["AccountRef"]["value"]),
+ "debit_in_account_currency": deposit["CashBack"]["Amount"],
+ "cost_center": self.default_cost_center,
+ }
+ )
posting_date = deposit["TxnDate"]
self.__save_journal_entry(quickbooks_id, accounts, posting_date)
except Exception as e:
self._log_error(e, [deposit, accounts])
-
def _save_advance_payment(self, advance_payment):
quickbooks_id = "Advance Payment - {}".format(advance_payment["id"])
self.__save_ledger_entry_as_je(advance_payment, quickbooks_id)
-
def _save_tax_payment(self, tax_payment):
quickbooks_id = "Tax Payment - {}".format(tax_payment["id"])
self.__save_ledger_entry_as_je(tax_payment, quickbooks_id)
-
def _save_inventory_qty_adjust(self, inventory_qty_adjust):
quickbooks_id = "Inventory Qty Adjust - {}".format(inventory_qty_adjust["id"])
self.__save_ledger_entry_as_je(inventory_qty_adjust, quickbooks_id)
-
def __save_ledger_entry_as_je(self, ledger_entry, quickbooks_id):
try:
accounts = []
@@ -1145,7 +1248,6 @@ class QuickBooksMigrator(Document):
except Exception as e:
self._log_error(e, ledger_entry)
-
def _get_taxes(self, entry):
taxes = []
if "TxnTaxDetail" not in entry or "TaxLine" not in entry["TxnTaxDetail"]:
@@ -1155,27 +1257,30 @@ class QuickBooksMigrator(Document):
account_head = self._get_account_name_by_id("TaxRate - {}".format(tax_rate))
tax_type_applicable = self._get_tax_type(tax_rate)
if tax_type_applicable == "TaxOnAmount":
- taxes.append({
- "charge_type": "On Net Total",
- "account_head": account_head,
- "description": account_head,
- "cost_center": self.default_cost_center,
- "rate": 0,
- })
+ taxes.append(
+ {
+ "charge_type": "On Net Total",
+ "account_head": account_head,
+ "description": account_head,
+ "cost_center": self.default_cost_center,
+ "rate": 0,
+ }
+ )
else:
parent_tax_rate = self._get_parent_tax_rate(tax_rate)
parent_row_id = self._get_parent_row_id(parent_tax_rate, taxes)
- taxes.append({
- "charge_type": "On Previous Row Amount",
- "row_id": parent_row_id,
- "account_head": account_head,
- "description": account_head,
- "cost_center": self.default_cost_center,
- "rate": line["TaxLineDetail"]["TaxPercent"],
- })
+ taxes.append(
+ {
+ "charge_type": "On Previous Row Amount",
+ "row_id": parent_row_id,
+ "account_head": account_head,
+ "description": account_head,
+ "cost_center": self.default_cost_center,
+ "rate": line["TaxLineDetail"]["TaxPercent"],
+ }
+ )
return taxes
-
def _get_tax_type(self, tax_rate):
for tax_code in self.tax_codes.values():
for rate_list_type in ("SalesTaxRateList", "PurchaseTaxRateList"):
@@ -1184,7 +1289,6 @@ class QuickBooksMigrator(Document):
if tax_rate_detail["TaxRateRef"]["value"] == tax_rate:
return tax_rate_detail["TaxTypeApplicable"]
-
def _get_parent_tax_rate(self, tax_rate):
parent = None
for tax_code in self.tax_codes.values():
@@ -1198,34 +1302,33 @@ class QuickBooksMigrator(Document):
if tax_rate_detail["TaxOrder"] == parent:
return tax_rate_detail["TaxRateRef"]["value"]
-
def _get_parent_row_id(self, tax_rate, taxes):
tax_account = self._get_account_name_by_id("TaxRate - {}".format(tax_rate))
for index, tax in enumerate(taxes):
if tax["account_head"] == tax_account:
return index + 1
-
def _create_address(self, entity, doctype, address, address_type):
try:
if not frappe.db.exists({"doctype": "Address", "quickbooks_id": address["Id"]}):
- frappe.get_doc({
- "doctype": "Address",
- "quickbooks_address_id": address["Id"],
- "address_title": entity.name,
- "address_type": address_type,
- "address_line1": address["Line1"],
- "city": address["City"],
- "links": [{"link_doctype": doctype, "link_name": entity.name}]
- }).insert()
+ frappe.get_doc(
+ {
+ "doctype": "Address",
+ "quickbooks_address_id": address["Id"],
+ "address_title": entity.name,
+ "address_type": address_type,
+ "address_line1": address["Line1"],
+ "city": address["City"],
+ "links": [{"link_doctype": doctype, "link_name": entity.name}],
+ }
+ ).insert()
except Exception as e:
self._log_error(e, address)
-
def _get(self, *args, **kwargs):
kwargs["headers"] = {
"Accept": "application/json",
- "Authorization": "Bearer {}".format(self.access_token)
+ "Authorization": "Bearer {}".format(self.access_token),
}
response = requests.get(*args, **kwargs)
# HTTP Status code 401 here means that the access_token is expired
@@ -1236,43 +1339,41 @@ class QuickBooksMigrator(Document):
response = self._get(*args, **kwargs)
return response
-
def _get_account_name_by_id(self, quickbooks_id):
- return frappe.get_all("Account", filters={"quickbooks_id": quickbooks_id, "company": self.company})[0]["name"]
-
+ return frappe.get_all(
+ "Account", filters={"quickbooks_id": quickbooks_id, "company": self.company}
+ )[0]["name"]
def _publish(self, *args, **kwargs):
frappe.publish_realtime("quickbooks_progress_update", *args, **kwargs)
-
def _get_unique_account_name(self, quickbooks_name, number=0):
if number:
quickbooks_account_name = "{} - {} - QB".format(quickbooks_name, number)
else:
quickbooks_account_name = "{} - QB".format(quickbooks_name)
company_encoded_account_name = encode_company_abbr(quickbooks_account_name, self.company)
- if frappe.db.exists({"doctype": "Account", "name": company_encoded_account_name, "company": self.company}):
+ if frappe.db.exists(
+ {"doctype": "Account", "name": company_encoded_account_name, "company": self.company}
+ ):
unique_account_name = self._get_unique_account_name(quickbooks_name, number + 1)
else:
unique_account_name = quickbooks_account_name
return unique_account_name
-
def _log_error(self, execption, data=""):
- frappe.log_error(title="QuickBooks Migration Error",
- message="\n".join([
- "Data",
- json.dumps(data,
- sort_keys=True,
- indent=4,
- separators=(',', ': ')
- ),
- "Exception",
- traceback.format_exc()
- ])
+ frappe.log_error(
+ title="QuickBooks Migration Error",
+ message="\n".join(
+ [
+ "Data",
+ json.dumps(data, sort_keys=True, indent=4, separators=(",", ": ")),
+ "Exception",
+ traceback.format_exc(),
+ ]
+ ),
)
-
def set_indicator(self, status):
self.status = status
self.save()
diff --git a/erpnext/erpnext_integrations/doctype/shopify_log/shopify_log.py b/erpnext/erpnext_integrations/doctype/shopify_log/shopify_log.py
index 5d17ccfb8c4..181afb3f5fb 100644
--- a/erpnext/erpnext_integrations/doctype/shopify_log/shopify_log.py
+++ b/erpnext/erpnext_integrations/doctype/shopify_log/shopify_log.py
@@ -25,7 +25,7 @@ def make_shopify_log(status="Queued", exception=None, rollback=False):
frappe.db.rollback()
if make_new:
- log = frappe.get_doc({"doctype":"Shopify Log"}).insert(ignore_permissions=True)
+ log = frappe.get_doc({"doctype": "Shopify Log"}).insert(ignore_permissions=True)
else:
log = log = frappe.get_doc("Shopify Log", frappe.flags.request_id)
@@ -35,33 +35,49 @@ def make_shopify_log(status="Queued", exception=None, rollback=False):
log.save(ignore_permissions=True)
frappe.db.commit()
+
def get_message(exception):
message = None
- if hasattr(exception, 'message'):
+ if hasattr(exception, "message"):
message = exception.message
- elif hasattr(exception, '__str__'):
+ elif hasattr(exception, "__str__"):
message = exception.__str__()
else:
message = "Something went wrong while syncing"
return message
+
def dump_request_data(data, event="create/order"):
event_mapper = {
- "orders/create": get_webhook_address(connector_name='shopify_connection', method="sync_sales_order", exclude_uri=True),
- "orders/paid" : get_webhook_address(connector_name='shopify_connection', method="prepare_sales_invoice", exclude_uri=True),
- "orders/fulfilled": get_webhook_address(connector_name='shopify_connection', method="prepare_delivery_note", exclude_uri=True)
+ "orders/create": get_webhook_address(
+ connector_name="shopify_connection", method="sync_sales_order", exclude_uri=True
+ ),
+ "orders/paid": get_webhook_address(
+ connector_name="shopify_connection", method="prepare_sales_invoice", exclude_uri=True
+ ),
+ "orders/fulfilled": get_webhook_address(
+ connector_name="shopify_connection", method="prepare_delivery_note", exclude_uri=True
+ ),
}
- log = frappe.get_doc({
- "doctype": "Shopify Log",
- "request_data": json.dumps(data, indent=1),
- "method": event_mapper[event]
- }).insert(ignore_permissions=True)
+ log = frappe.get_doc(
+ {
+ "doctype": "Shopify Log",
+ "request_data": json.dumps(data, indent=1),
+ "method": event_mapper[event],
+ }
+ ).insert(ignore_permissions=True)
frappe.db.commit()
- frappe.enqueue(method=event_mapper[event], queue='short', timeout=300, is_async=True,
- **{"order": data, "request_id": log.name})
+ frappe.enqueue(
+ method=event_mapper[event],
+ queue="short",
+ timeout=300,
+ is_async=True,
+ **{"order": data, "request_id": log.name}
+ )
+
@frappe.whitelist()
def resync(method, name, request_data):
@@ -69,5 +85,10 @@ def resync(method, name, request_data):
if not method.startswith("erpnext.erpnext_integrations.connectors.shopify_connection"):
return
- frappe.enqueue(method=method, queue='short', timeout=300, is_async=True,
- **{"order": json.loads(request_data), "request_id": name})
+ frappe.enqueue(
+ method=method,
+ queue="short",
+ timeout=300,
+ is_async=True,
+ **{"order": json.loads(request_data), "request_id": name}
+ )
diff --git a/erpnext/erpnext_integrations/doctype/shopify_log/test_shopify_log.py b/erpnext/erpnext_integrations/doctype/shopify_log/test_shopify_log.py
index 18adeb83aef..8d4506a421f 100644
--- a/erpnext/erpnext_integrations/doctype/shopify_log/test_shopify_log.py
+++ b/erpnext/erpnext_integrations/doctype/shopify_log/test_shopify_log.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Shopify Log')
+
class TestShopifyLog(unittest.TestCase):
pass
diff --git a/erpnext/erpnext_integrations/doctype/shopify_settings/shopify_settings.js b/erpnext/erpnext_integrations/doctype/shopify_settings/shopify_settings.js
index a926a7e52a5..a5b676e2e39 100644
--- a/erpnext/erpnext_integrations/doctype/shopify_settings/shopify_settings.js
+++ b/erpnext/erpnext_integrations/doctype/shopify_settings/shopify_settings.js
@@ -37,7 +37,7 @@ frappe.ui.form.on("Shopify Settings", "refresh", function(frm){
}
- let app_link = "Ecommerce Integrations"
+ let app_link = "Ecommerce Integrations"
frm.dashboard.add_comment(__("Shopify Integration will be removed from ERPNext in Version 14. Please install {0} app to continue using it.", [app_link]), "yellow", true);
})
diff --git a/erpnext/erpnext_integrations/doctype/shopify_settings/shopify_settings.py b/erpnext/erpnext_integrations/doctype/shopify_settings/shopify_settings.py
index c8ce7d32f70..9628b4d4351 100644
--- a/erpnext/erpnext_integrations/doctype/shopify_settings/shopify_settings.py
+++ b/erpnext/erpnext_integrations/doctype/shopify_settings/shopify_settings.py
@@ -26,28 +26,38 @@ class ShopifySettings(Document):
def validate_access_credentials(self):
if not (self.get_password(raise_exception=False) and self.api_key and self.shopify_url):
- frappe.msgprint(_("Missing value for Password, API Key or Shopify URL"), raise_exception=frappe.ValidationError)
+ frappe.msgprint(
+ _("Missing value for Password, API Key or Shopify URL"), raise_exception=frappe.ValidationError
+ )
def register_webhooks(self):
webhooks = ["orders/create", "orders/paid", "orders/fulfilled"]
# url = get_shopify_url('admin/webhooks.json', self)
created_webhooks = [d.method for d in self.webhooks]
- url = get_shopify_url('admin/api/2021-04/webhooks.json', self)
+ url = get_shopify_url("admin/api/2021-04/webhooks.json", self)
for method in webhooks:
session = get_request_session()
try:
- res = session.post(url, data=json.dumps({
- "webhook": {
- "topic": method,
- "address": get_webhook_address(connector_name='shopify_connection', method='store_request_data', force_https=True),
- "format": "json"
+ res = session.post(
+ url,
+ data=json.dumps(
+ {
+ "webhook": {
+ "topic": method,
+ "address": get_webhook_address(
+ connector_name="shopify_connection", method="store_request_data", force_https=True
+ ),
+ "format": "json",
+ }
}
- }), headers=get_header(self))
+ ),
+ headers=get_header(self),
+ )
res.raise_for_status()
self.update_webhook_table(method, res.json())
except HTTPError as e:
- error_message = res.json().get('errors', e)
+ error_message = res.json().get("errors", e)
make_shopify_log(status="Warning", exception=error_message, rollback=True)
except Exception as e:
@@ -58,89 +68,173 @@ class ShopifySettings(Document):
deleted_webhooks = []
for d in self.webhooks:
- url = get_shopify_url('admin/api/2021-04/webhooks/{0}.json'.format(d.webhook_id), self)
+ url = get_shopify_url("admin/api/2021-04/webhooks/{0}.json".format(d.webhook_id), self)
try:
res = session.delete(url, headers=get_header(self))
res.raise_for_status()
deleted_webhooks.append(d)
except HTTPError as e:
- error_message = res.json().get('errors', e)
+ error_message = res.json().get("errors", e)
make_shopify_log(status="Warning", exception=error_message, rollback=True)
except Exception as e:
- frappe.log_error(message=e, title='Shopify Webhooks Issue')
+ frappe.log_error(message=e, title="Shopify Webhooks Issue")
for d in deleted_webhooks:
self.remove(d)
def update_webhook_table(self, method, res):
- self.append("webhooks", {
- "webhook_id": res['webhook']['id'],
- "method": method
- })
+ self.append("webhooks", {"webhook_id": res["webhook"]["id"], "method": method})
+
def get_shopify_url(path, settings):
if settings.app_type == "Private":
- return 'https://{}:{}@{}/{}'.format(settings.api_key, settings.get_password('password'), settings.shopify_url, path)
+ return "https://{}:{}@{}/{}".format(
+ settings.api_key, settings.get_password("password"), settings.shopify_url, path
+ )
else:
- return 'https://{}/{}'.format(settings.shopify_url, path)
+ return "https://{}/{}".format(settings.shopify_url, path)
+
def get_header(settings):
- header = {'Content-Type': 'application/json'}
+ header = {"Content-Type": "application/json"}
return header
+
@frappe.whitelist()
def get_series():
return {
- "sales_order_series" : frappe.get_meta("Sales Order").get_options("naming_series") or "SO-Shopify-",
- "sales_invoice_series" : frappe.get_meta("Sales Invoice").get_options("naming_series") or "SI-Shopify-",
- "delivery_note_series" : frappe.get_meta("Delivery Note").get_options("naming_series") or "DN-Shopify-"
+ "sales_order_series": frappe.get_meta("Sales Order").get_options("naming_series")
+ or "SO-Shopify-",
+ "sales_invoice_series": frappe.get_meta("Sales Invoice").get_options("naming_series")
+ or "SI-Shopify-",
+ "delivery_note_series": frappe.get_meta("Delivery Note").get_options("naming_series")
+ or "DN-Shopify-",
}
+
def setup_custom_fields():
custom_fields = {
"Customer": [
- dict(fieldname='shopify_customer_id', label='Shopify Customer Id',
- fieldtype='Data', insert_after='series', read_only=1, print_hide=1)
+ dict(
+ fieldname="shopify_customer_id",
+ label="Shopify Customer Id",
+ fieldtype="Data",
+ insert_after="series",
+ read_only=1,
+ print_hide=1,
+ )
],
"Supplier": [
- dict(fieldname='shopify_supplier_id', label='Shopify Supplier Id',
- fieldtype='Data', insert_after='supplier_name', read_only=1, print_hide=1)
+ dict(
+ fieldname="shopify_supplier_id",
+ label="Shopify Supplier Id",
+ fieldtype="Data",
+ insert_after="supplier_name",
+ read_only=1,
+ print_hide=1,
+ )
],
"Address": [
- dict(fieldname='shopify_address_id', label='Shopify Address Id',
- fieldtype='Data', insert_after='fax', read_only=1, print_hide=1)
+ dict(
+ fieldname="shopify_address_id",
+ label="Shopify Address Id",
+ fieldtype="Data",
+ insert_after="fax",
+ read_only=1,
+ print_hide=1,
+ )
],
"Item": [
- dict(fieldname='shopify_variant_id', label='Shopify Variant Id',
- fieldtype='Data', insert_after='item_code', read_only=1, print_hide=1),
- dict(fieldname='shopify_product_id', label='Shopify Product Id',
- fieldtype='Data', insert_after='item_code', read_only=1, print_hide=1),
- dict(fieldname='shopify_description', label='Shopify Description',
- fieldtype='Text Editor', insert_after='description', read_only=1, print_hide=1)
+ dict(
+ fieldname="shopify_variant_id",
+ label="Shopify Variant Id",
+ fieldtype="Data",
+ insert_after="item_code",
+ read_only=1,
+ print_hide=1,
+ ),
+ dict(
+ fieldname="shopify_product_id",
+ label="Shopify Product Id",
+ fieldtype="Data",
+ insert_after="item_code",
+ read_only=1,
+ print_hide=1,
+ ),
+ dict(
+ fieldname="shopify_description",
+ label="Shopify Description",
+ fieldtype="Text Editor",
+ insert_after="description",
+ read_only=1,
+ print_hide=1,
+ ),
],
"Sales Order": [
- dict(fieldname='shopify_order_id', label='Shopify Order Id',
- fieldtype='Data', insert_after='title', read_only=1, print_hide=1),
- dict(fieldname='shopify_order_number', label='Shopify Order Number',
- fieldtype='Data', insert_after='shopify_order_id', read_only=1, print_hide=1)
+ dict(
+ fieldname="shopify_order_id",
+ label="Shopify Order Id",
+ fieldtype="Data",
+ insert_after="title",
+ read_only=1,
+ print_hide=1,
+ ),
+ dict(
+ fieldname="shopify_order_number",
+ label="Shopify Order Number",
+ fieldtype="Data",
+ insert_after="shopify_order_id",
+ read_only=1,
+ print_hide=1,
+ ),
],
- "Delivery Note":[
- dict(fieldname='shopify_order_id', label='Shopify Order Id',
- fieldtype='Data', insert_after='title', read_only=1, print_hide=1),
- dict(fieldname='shopify_order_number', label='Shopify Order Number',
- fieldtype='Data', insert_after='shopify_order_id', read_only=1, print_hide=1),
- dict(fieldname='shopify_fulfillment_id', label='Shopify Fulfillment Id',
- fieldtype='Data', insert_after='title', read_only=1, print_hide=1)
+ "Delivery Note": [
+ dict(
+ fieldname="shopify_order_id",
+ label="Shopify Order Id",
+ fieldtype="Data",
+ insert_after="title",
+ read_only=1,
+ print_hide=1,
+ ),
+ dict(
+ fieldname="shopify_order_number",
+ label="Shopify Order Number",
+ fieldtype="Data",
+ insert_after="shopify_order_id",
+ read_only=1,
+ print_hide=1,
+ ),
+ dict(
+ fieldname="shopify_fulfillment_id",
+ label="Shopify Fulfillment Id",
+ fieldtype="Data",
+ insert_after="title",
+ read_only=1,
+ print_hide=1,
+ ),
],
"Sales Invoice": [
- dict(fieldname='shopify_order_id', label='Shopify Order Id',
- fieldtype='Data', insert_after='title', read_only=1, print_hide=1),
- dict(fieldname='shopify_order_number', label='Shopify Order Number',
- fieldtype='Data', insert_after='shopify_order_id', read_only=1, print_hide=1)
- ]
+ dict(
+ fieldname="shopify_order_id",
+ label="Shopify Order Id",
+ fieldtype="Data",
+ insert_after="title",
+ read_only=1,
+ print_hide=1,
+ ),
+ dict(
+ fieldname="shopify_order_number",
+ label="Shopify Order Number",
+ fieldtype="Data",
+ insert_after="shopify_order_id",
+ read_only=1,
+ print_hide=1,
+ ),
+ ],
}
create_custom_fields(custom_fields)
diff --git a/erpnext/erpnext_integrations/doctype/shopify_settings/sync_customer.py b/erpnext/erpnext_integrations/doctype/shopify_settings/sync_customer.py
index 945862ddbc8..6f76d8a89e7 100644
--- a/erpnext/erpnext_integrations/doctype/shopify_settings/sync_customer.py
+++ b/erpnext/erpnext_integrations/doctype/shopify_settings/sync_customer.py
@@ -1,4 +1,3 @@
-
import frappe
from frappe import _
@@ -6,21 +5,29 @@ from frappe import _
def create_customer(shopify_customer, shopify_settings):
import frappe.utils.nestedset
- cust_name = (shopify_customer.get("first_name") + " " + (shopify_customer.get("last_name") \
- and shopify_customer.get("last_name") or "")) if shopify_customer.get("first_name")\
+ cust_name = (
+ (
+ shopify_customer.get("first_name")
+ + " "
+ + (shopify_customer.get("last_name") and shopify_customer.get("last_name") or "")
+ )
+ if shopify_customer.get("first_name")
else shopify_customer.get("email")
+ )
try:
- customer = frappe.get_doc({
- "doctype": "Customer",
- "name": shopify_customer.get("id"),
- "customer_name" : cust_name,
- "shopify_customer_id": shopify_customer.get("id"),
- "sync_with_shopify": 1,
- "customer_group": shopify_settings.customer_group,
- "territory": frappe.utils.nestedset.get_root_of("Territory"),
- "customer_type": _("Individual")
- })
+ customer = frappe.get_doc(
+ {
+ "doctype": "Customer",
+ "name": shopify_customer.get("id"),
+ "customer_name": cust_name,
+ "shopify_customer_id": shopify_customer.get("id"),
+ "sync_with_shopify": 1,
+ "customer_group": shopify_settings.customer_group,
+ "territory": frappe.utils.nestedset.get_root_of("Territory"),
+ "customer_type": _("Individual"),
+ }
+ )
customer.flags.ignore_mandatory = True
customer.insert(ignore_permissions=True)
@@ -32,6 +39,7 @@ def create_customer(shopify_customer, shopify_settings):
except Exception as e:
raise e
+
def create_customer_address(customer, shopify_customer):
addresses = shopify_customer.get("addresses", [])
@@ -40,29 +48,29 @@ def create_customer_address(customer, shopify_customer):
for i, address in enumerate(addresses):
address_title, address_type = get_address_title_and_type(customer.customer_name, i)
- try :
- frappe.get_doc({
- "doctype": "Address",
- "shopify_address_id": address.get("id"),
- "address_title": address_title,
- "address_type": address_type,
- "address_line1": address.get("address1") or "Address 1",
- "address_line2": address.get("address2"),
- "city": address.get("city") or "City",
- "state": address.get("province"),
- "pincode": address.get("zip"),
- "country": address.get("country"),
- "phone": address.get("phone"),
- "email_id": shopify_customer.get("email"),
- "links": [{
- "link_doctype": "Customer",
- "link_name": customer.name
- }]
- }).insert(ignore_mandatory=True)
+ try:
+ frappe.get_doc(
+ {
+ "doctype": "Address",
+ "shopify_address_id": address.get("id"),
+ "address_title": address_title,
+ "address_type": address_type,
+ "address_line1": address.get("address1") or "Address 1",
+ "address_line2": address.get("address2"),
+ "city": address.get("city") or "City",
+ "state": address.get("province"),
+ "pincode": address.get("zip"),
+ "country": address.get("country"),
+ "phone": address.get("phone"),
+ "email_id": shopify_customer.get("email"),
+ "links": [{"link_doctype": "Customer", "link_name": customer.name}],
+ }
+ ).insert(ignore_mandatory=True)
except Exception as e:
raise e
+
def get_address_title_and_type(customer_name, index):
address_type = _("Billing")
address_title = customer_name
diff --git a/erpnext/erpnext_integrations/doctype/shopify_settings/sync_product.py b/erpnext/erpnext_integrations/doctype/shopify_settings/sync_product.py
index 0fcf20c596e..6b0f59774a5 100644
--- a/erpnext/erpnext_integrations/doctype/shopify_settings/sync_product.py
+++ b/erpnext/erpnext_integrations/doctype/shopify_settings/sync_product.py
@@ -1,4 +1,3 @@
-
import frappe
from frappe import _
from frappe.utils import cint, cstr, get_request_session
@@ -11,8 +10,11 @@ from erpnext.erpnext_integrations.doctype.shopify_settings.shopify_settings impo
shopify_variants_attr_list = ["option1", "option2", "option3"]
+
def sync_item_from_shopify(shopify_settings, item):
- url = get_shopify_url("admin/api/2021-04/products/{0}.json".format(item.get("product_id")), shopify_settings)
+ url = get_shopify_url(
+ "admin/api/2021-04/products/{0}.json".format(item.get("product_id")), shopify_settings
+ )
session = get_request_session()
try:
@@ -24,6 +26,7 @@ def sync_item_from_shopify(shopify_settings, item):
except Exception as e:
raise e
+
def make_item(warehouse, shopify_item):
add_item_weight(shopify_item)
@@ -33,34 +36,38 @@ def make_item(warehouse, shopify_item):
create_item_variants(shopify_item, warehouse, attributes, shopify_variants_attr_list)
else:
- shopify_item["variant_id"] = shopify_item['variants'][0]["id"]
+ shopify_item["variant_id"] = shopify_item["variants"][0]["id"]
create_item(shopify_item, warehouse)
+
def add_item_weight(shopify_item):
- shopify_item["weight"] = shopify_item['variants'][0]["weight"]
- shopify_item["weight_unit"] = shopify_item['variants'][0]["weight_unit"]
+ shopify_item["weight"] = shopify_item["variants"][0]["weight"]
+ shopify_item["weight_unit"] = shopify_item["variants"][0]["weight_unit"]
+
def has_variants(shopify_item):
- if len(shopify_item.get("options")) >= 1 and "Default Title" not in shopify_item.get("options")[0]["values"]:
+ if (
+ len(shopify_item.get("options")) >= 1
+ and "Default Title" not in shopify_item.get("options")[0]["values"]
+ ):
return True
return False
+
def create_attribute(shopify_item):
attribute = []
# shopify item dict
- for attr in shopify_item.get('options'):
+ for attr in shopify_item.get("options"):
if not frappe.db.get_value("Item Attribute", attr.get("name"), "name"):
- frappe.get_doc({
- "doctype": "Item Attribute",
- "attribute_name": attr.get("name"),
- "item_attribute_values": [
- {
- "attribute_value": attr_value,
- "abbr":attr_value
- }
- for attr_value in attr.get("values")
- ]
- }).insert()
+ frappe.get_doc(
+ {
+ "doctype": "Item Attribute",
+ "attribute_name": attr.get("name"),
+ "item_attribute_values": [
+ {"attribute_value": attr_value, "abbr": attr_value} for attr_value in attr.get("values")
+ ],
+ }
+ ).insert()
attribute.append({"attribute": attr.get("name")})
else:
@@ -72,26 +79,29 @@ def create_attribute(shopify_item):
attribute.append({"attribute": attr.get("name")})
else:
- attribute.append({
- "attribute": attr.get("name"),
- "from_range": item_attr.get("from_range"),
- "to_range": item_attr.get("to_range"),
- "increment": item_attr.get("increment"),
- "numeric_values": item_attr.get("numeric_values")
- })
+ attribute.append(
+ {
+ "attribute": attr.get("name"),
+ "from_range": item_attr.get("from_range"),
+ "to_range": item_attr.get("to_range"),
+ "increment": item_attr.get("increment"),
+ "numeric_values": item_attr.get("numeric_values"),
+ }
+ )
return attribute
+
def set_new_attribute_values(item_attr, values):
for attr_value in values:
- if not any((d.abbr.lower() == attr_value.lower() or d.attribute_value.lower() == attr_value.lower())\
- for d in item_attr.item_attribute_values):
- item_attr.append("item_attribute_values", {
- "attribute_value": attr_value,
- "abbr": attr_value
- })
+ if not any(
+ (d.abbr.lower() == attr_value.lower() or d.attribute_value.lower() == attr_value.lower())
+ for d in item_attr.item_attribute_values
+ ):
+ item_attr.append("item_attribute_values", {"attribute_value": attr_value, "abbr": attr_value})
-def create_item(shopify_item, warehouse, has_variant=0, attributes=None,variant_of=None):
+
+def create_item(shopify_item, warehouse, has_variant=0, attributes=None, variant_of=None):
item_dict = {
"doctype": "Item",
"shopify_product_id": shopify_item.get("id"),
@@ -100,12 +110,12 @@ def create_item(shopify_item, warehouse, has_variant=0, attributes=None,variant_
"sync_with_shopify": 1,
"is_stock_item": 1,
"item_code": cstr(shopify_item.get("item_code")) or cstr(shopify_item.get("id")),
- "item_name": shopify_item.get("title", '').strip(),
+ "item_name": shopify_item.get("title", "").strip(),
"description": shopify_item.get("body_html") or shopify_item.get("title"),
"shopify_description": shopify_item.get("body_html") or shopify_item.get("title"),
"item_group": get_item_group(shopify_item.get("product_type")),
"has_variants": has_variant,
- "attributes":attributes or [],
+ "attributes": attributes or [],
"stock_uom": shopify_item.get("uom") or _("Nos"),
"stock_keeping_unit": shopify_item.get("sku") or get_sku(shopify_item),
"default_warehouse": warehouse,
@@ -113,16 +123,12 @@ def create_item(shopify_item, warehouse, has_variant=0, attributes=None,variant_
"weight_uom": shopify_item.get("weight_unit"),
"weight_per_unit": shopify_item.get("weight"),
"default_supplier": get_supplier(shopify_item),
- "item_defaults": [
- {
- "company": get_default_company()
- }
- ]
+ "item_defaults": [{"company": get_default_company()}],
}
if not is_item_exists(item_dict, attributes, variant_of=variant_of):
item_details = get_item_details(shopify_item)
- name = ''
+ name = ""
if not item_details:
new_item = frappe.get_doc(item_dict)
@@ -137,14 +143,19 @@ def create_item(shopify_item, warehouse, has_variant=0, attributes=None,variant_
frappe.db.commit()
+
def create_item_variants(shopify_item, warehouse, attributes, shopify_variants_attr_list):
- template_item = frappe.db.get_value("Item", filters={"shopify_product_id": shopify_item.get("id")},
- fieldname=["name", "stock_uom"], as_dict=True)
+ template_item = frappe.db.get_value(
+ "Item",
+ filters={"shopify_product_id": shopify_item.get("id")},
+ fieldname=["name", "stock_uom"],
+ as_dict=True,
+ )
if template_item:
for variant in shopify_item.get("variants"):
shopify_item_variant = {
- "id" : variant.get("id"),
+ "id": variant.get("id"),
"item_code": variant.get("id"),
"title": variant.get("title"),
"product_type": shopify_item.get("product_type"),
@@ -153,32 +164,42 @@ def create_item_variants(shopify_item, warehouse, attributes, shopify_variants_a
"item_price": variant.get("price"),
"variant_id": variant.get("id"),
"weight_unit": variant.get("weight_unit"),
- "weight": variant.get("weight")
+ "weight": variant.get("weight"),
}
for i, variant_attr in enumerate(shopify_variants_attr_list):
if variant.get(variant_attr):
- attributes[i].update({"attribute_value": get_attribute_value(variant.get(variant_attr), attributes[i])})
+ attributes[i].update(
+ {"attribute_value": get_attribute_value(variant.get(variant_attr), attributes[i])}
+ )
create_item(shopify_item_variant, warehouse, 0, attributes, template_item.name)
+
def get_attribute_value(variant_attr_val, attribute):
- attribute_value = frappe.db.sql("""select attribute_value from `tabItem Attribute Value`
- where parent = %s and (abbr = %s or attribute_value = %s)""", (attribute["attribute"], variant_attr_val,
- variant_attr_val), as_list=1)
- return attribute_value[0][0] if len(attribute_value)>0 else cint(variant_attr_val)
+ attribute_value = frappe.db.sql(
+ """select attribute_value from `tabItem Attribute Value`
+ where parent = %s and (abbr = %s or attribute_value = %s)""",
+ (attribute["attribute"], variant_attr_val, variant_attr_val),
+ as_list=1,
+ )
+ return attribute_value[0][0] if len(attribute_value) > 0 else cint(variant_attr_val)
+
def get_item_group(product_type=None):
import frappe.utils.nestedset
+
parent_item_group = frappe.utils.nestedset.get_root_of("Item Group")
if product_type:
if not frappe.db.get_value("Item Group", product_type, "name"):
- item_group = frappe.get_doc({
- "doctype": "Item Group",
- "item_group_name": product_type,
- "parent_item_group": parent_item_group,
- "is_group": "No"
- }).insert()
+ item_group = frappe.get_doc(
+ {
+ "doctype": "Item Group",
+ "item_group_name": product_type,
+ "parent_item_group": parent_item_group,
+ "is_group": "No",
+ }
+ ).insert()
return item_group.name
else:
return product_type
@@ -191,74 +212,97 @@ def get_sku(item):
return item.get("variants")[0].get("sku")
return ""
+
def add_to_price_list(item, name):
- shopify_settings = frappe.db.get_value("Shopify Settings", None, ["price_list", "update_price_in_erpnext_price_list"], as_dict=1)
+ shopify_settings = frappe.db.get_value(
+ "Shopify Settings", None, ["price_list", "update_price_in_erpnext_price_list"], as_dict=1
+ )
if not shopify_settings.update_price_in_erpnext_price_list:
return
- item_price_name = frappe.db.get_value("Item Price",
- {"item_code": name, "price_list": shopify_settings.price_list}, "name")
+ item_price_name = frappe.db.get_value(
+ "Item Price", {"item_code": name, "price_list": shopify_settings.price_list}, "name"
+ )
if not item_price_name:
- frappe.get_doc({
- "doctype": "Item Price",
- "price_list": shopify_settings.price_list,
- "item_code": name,
- "price_list_rate": item.get("item_price") or item.get("variants")[0].get("price")
- }).insert()
+ frappe.get_doc(
+ {
+ "doctype": "Item Price",
+ "price_list": shopify_settings.price_list,
+ "item_code": name,
+ "price_list_rate": item.get("item_price") or item.get("variants")[0].get("price"),
+ }
+ ).insert()
else:
item_rate = frappe.get_doc("Item Price", item_price_name)
item_rate.price_list_rate = item.get("item_price") or item.get("variants")[0].get("price")
item_rate.save()
+
def get_item_image(shopify_item):
if shopify_item.get("image"):
return shopify_item.get("image").get("src")
return None
+
def get_supplier(shopify_item):
if shopify_item.get("vendor"):
- supplier = frappe.db.sql("""select name from tabSupplier
- where name = %s or shopify_supplier_id = %s """, (shopify_item.get("vendor"),
- shopify_item.get("vendor").lower()), as_list=1)
+ supplier = frappe.db.sql(
+ """select name from tabSupplier
+ where name = %s or shopify_supplier_id = %s """,
+ (shopify_item.get("vendor"), shopify_item.get("vendor").lower()),
+ as_list=1,
+ )
if not supplier:
- supplier = frappe.get_doc({
- "doctype": "Supplier",
- "supplier_name": shopify_item.get("vendor"),
- "shopify_supplier_id": shopify_item.get("vendor").lower(),
- "supplier_group": get_supplier_group()
- }).insert()
+ supplier = frappe.get_doc(
+ {
+ "doctype": "Supplier",
+ "supplier_name": shopify_item.get("vendor"),
+ "shopify_supplier_id": shopify_item.get("vendor").lower(),
+ "supplier_group": get_supplier_group(),
+ }
+ ).insert()
return supplier.name
else:
return shopify_item.get("vendor")
else:
return ""
+
def get_supplier_group():
supplier_group = frappe.db.get_value("Supplier Group", _("Shopify Supplier"))
if not supplier_group:
- supplier_group = frappe.get_doc({
- "doctype": "Supplier Group",
- "supplier_group_name": _("Shopify Supplier")
- }).insert()
+ supplier_group = frappe.get_doc(
+ {"doctype": "Supplier Group", "supplier_group_name": _("Shopify Supplier")}
+ ).insert()
return supplier_group.name
return supplier_group
+
def get_item_details(shopify_item):
item_details = {}
- item_details = frappe.db.get_value("Item", {"shopify_product_id": shopify_item.get("id")},
- ["name", "stock_uom", "item_name"], as_dict=1)
+ item_details = frappe.db.get_value(
+ "Item",
+ {"shopify_product_id": shopify_item.get("id")},
+ ["name", "stock_uom", "item_name"],
+ as_dict=1,
+ )
if item_details:
return item_details
else:
- item_details = frappe.db.get_value("Item", {"shopify_variant_id": shopify_item.get("id")},
- ["name", "stock_uom", "item_name"], as_dict=1)
+ item_details = frappe.db.get_value(
+ "Item",
+ {"shopify_variant_id": shopify_item.get("id")},
+ ["name", "stock_uom", "item_name"],
+ as_dict=1,
+ )
return item_details
+
def is_item_exists(shopify_item, attributes=None, variant_of=None):
if variant_of:
name = variant_of
@@ -267,7 +311,7 @@ def is_item_exists(shopify_item, attributes=None, variant_of=None):
if name:
item = frappe.get_doc("Item", name)
- item.flags.ignore_mandatory=True
+ item.flags.ignore_mandatory = True
if not variant_of and not item.shopify_product_id:
item.shopify_product_id = shopify_item.get("shopify_product_id")
@@ -277,23 +321,35 @@ def is_item_exists(shopify_item, attributes=None, variant_of=None):
if item.shopify_product_id and attributes and attributes[0].get("attribute_value"):
if not variant_of:
- variant_of = frappe.db.get_value("Item",
- {"shopify_product_id": item.shopify_product_id}, "variant_of")
+ variant_of = frappe.db.get_value(
+ "Item", {"shopify_product_id": item.shopify_product_id}, "variant_of"
+ )
# create conditions for all item attributes,
# as we are putting condition basis on OR it will fetch all items matching either of conditions
# thus comparing matching conditions with len(attributes)
# which will give exact matching variant item.
- conditions = ["(iv.attribute='{0}' and iv.attribute_value = '{1}')"\
- .format(attr.get("attribute"), attr.get("attribute_value")) for attr in attributes]
+ conditions = [
+ "(iv.attribute='{0}' and iv.attribute_value = '{1}')".format(
+ attr.get("attribute"), attr.get("attribute_value")
+ )
+ for attr in attributes
+ ]
- conditions = "( {0} ) and iv.parent = it.name ) = {1}".format(" or ".join(conditions), len(attributes))
+ conditions = "( {0} ) and iv.parent = it.name ) = {1}".format(
+ " or ".join(conditions), len(attributes)
+ )
- parent = frappe.db.sql(""" select * from tabItem it where
+ parent = frappe.db.sql(
+ """ select * from tabItem it where
( select count(*) from `tabItem Variant Attribute` iv
- where {conditions} and it.variant_of = %s """.format(conditions=conditions) ,
- variant_of, as_list=1)
+ where {conditions} and it.variant_of = %s """.format(
+ conditions=conditions
+ ),
+ variant_of,
+ as_list=1,
+ )
if parent:
variant = frappe.get_doc("Item", parent[0][0])
diff --git a/erpnext/erpnext_integrations/doctype/shopify_settings/test_shopify_settings.py b/erpnext/erpnext_integrations/doctype/shopify_settings/test_shopify_settings.py
index 41e26f3067f..47d6d438b06 100644
--- a/erpnext/erpnext_integrations/doctype/shopify_settings/test_shopify_settings.py
+++ b/erpnext/erpnext_integrations/doctype/shopify_settings/test_shopify_settings.py
@@ -22,9 +22,11 @@ class ShopifySettings(unittest.TestCase):
def setUpClass(cls):
frappe.set_user("Administrator")
- cls.allow_negative_stock = cint(frappe.db.get_value('Stock Settings', None, 'allow_negative_stock'))
+ cls.allow_negative_stock = cint(
+ frappe.db.get_value("Stock Settings", None, "allow_negative_stock")
+ )
if not cls.allow_negative_stock:
- frappe.db.set_value('Stock Settings', None, 'allow_negative_stock', 1)
+ frappe.db.set_value("Stock Settings", None, "allow_negative_stock", 1)
setup_custom_fields()
@@ -38,74 +40,87 @@ class ShopifySettings(unittest.TestCase):
@classmethod
def tearDownClass(cls):
if not cls.allow_negative_stock:
- frappe.db.set_value('Stock Settings', None, 'allow_negative_stock', 0)
+ frappe.db.set_value("Stock Settings", None, "allow_negative_stock", 0)
@classmethod
def setup_shopify(cls):
shopify_settings = frappe.get_doc("Shopify Settings")
shopify_settings.taxes = []
- shopify_settings.update({
- "app_type": "Private",
- "shopify_url": "test.myshopify.com",
- "api_key": "17702c7c4452b9c5d235240b6e7a39da",
- "password": "17702c7c4452b9c5d235240b6e7a39da",
- "shared_secret": "17702c7c4452b9c5d235240b6e7a39da",
- "price_list": "_Test Price List",
- "warehouse": "_Test Warehouse - _TC",
- "cash_bank_account": "Cash - _TC",
- "account": "Cash - _TC",
- "customer_group": "_Test Customer Group",
- "cost_center": "Main - _TC",
- "taxes": [
- {
- "shopify_tax": "International Shipping",
- "tax_account":"Legal Expenses - _TC"
- }
- ],
- "enable_shopify": 0,
- "sales_order_series": "SO-",
- "sync_sales_invoice": 1,
- "sales_invoice_series": "SINV-",
- "sync_delivery_note": 1,
- "delivery_note_series": "DN-"
- }).save(ignore_permissions=True)
+ shopify_settings.update(
+ {
+ "app_type": "Private",
+ "shopify_url": "test.myshopify.com",
+ "api_key": "17702c7c4452b9c5d235240b6e7a39da",
+ "password": "17702c7c4452b9c5d235240b6e7a39da",
+ "shared_secret": "17702c7c4452b9c5d235240b6e7a39da",
+ "price_list": "_Test Price List",
+ "warehouse": "_Test Warehouse - _TC",
+ "cash_bank_account": "Cash - _TC",
+ "account": "Cash - _TC",
+ "company": "_Test Company",
+ "customer_group": "_Test Customer Group",
+ "cost_center": "Main - _TC",
+ "taxes": [{"shopify_tax": "International Shipping", "tax_account": "Legal Expenses - _TC"}],
+ "enable_shopify": 0,
+ "sales_order_series": "SO-",
+ "sync_sales_invoice": 1,
+ "sales_invoice_series": "SINV-",
+ "sync_delivery_note": 1,
+ "delivery_note_series": "DN-",
+ }
+ ).save(ignore_permissions=True)
cls.shopify_settings = shopify_settings
def test_order(self):
# Create Customer
- with open (os.path.join(os.path.dirname(__file__), "test_data", "shopify_customer.json")) as shopify_customer:
+ with open(
+ os.path.join(os.path.dirname(__file__), "test_data", "shopify_customer.json")
+ ) as shopify_customer:
shopify_customer = json.load(shopify_customer)
create_customer(shopify_customer.get("customer"), self.shopify_settings)
# Create Item
- with open (os.path.join(os.path.dirname(__file__), "test_data", "shopify_item.json")) as shopify_item:
+ with open(
+ os.path.join(os.path.dirname(__file__), "test_data", "shopify_item.json")
+ ) as shopify_item:
shopify_item = json.load(shopify_item)
make_item("_Test Warehouse - _TC", shopify_item.get("product"))
# Create Order
- with open (os.path.join(os.path.dirname(__file__), "test_data", "shopify_order.json")) as shopify_order:
+ with open(
+ os.path.join(os.path.dirname(__file__), "test_data", "shopify_order.json")
+ ) as shopify_order:
shopify_order = json.load(shopify_order)
create_order(shopify_order.get("order"), self.shopify_settings, False, company="_Test Company")
- sales_order = frappe.get_doc("Sales Order", {"shopify_order_id": cstr(shopify_order.get("order").get("id"))})
+ sales_order = frappe.get_doc(
+ "Sales Order", {"shopify_order_id": cstr(shopify_order.get("order").get("id"))}
+ )
self.assertEqual(cstr(shopify_order.get("order").get("id")), sales_order.shopify_order_id)
# Check for customer
shopify_order_customer_id = cstr(shopify_order.get("order").get("customer").get("id"))
- sales_order_customer_id = frappe.get_value("Customer", sales_order.customer, "shopify_customer_id")
+ sales_order_customer_id = frappe.get_value(
+ "Customer", sales_order.customer, "shopify_customer_id"
+ )
self.assertEqual(shopify_order_customer_id, sales_order_customer_id)
# Check sales invoice
- sales_invoice = frappe.get_doc("Sales Invoice", {"shopify_order_id": sales_order.shopify_order_id})
+ sales_invoice = frappe.get_doc(
+ "Sales Invoice", {"shopify_order_id": sales_order.shopify_order_id}
+ )
self.assertEqual(sales_invoice.rounded_total, sales_order.rounded_total)
# Check delivery note
- delivery_note_count = frappe.db.sql("""select count(*) from `tabDelivery Note`
- where shopify_order_id = %s""", sales_order.shopify_order_id)[0][0]
+ delivery_note_count = frappe.db.sql(
+ """select count(*) from `tabDelivery Note`
+ where shopify_order_id = %s""",
+ sales_order.shopify_order_id,
+ )[0][0]
self.assertEqual(delivery_note_count, len(shopify_order.get("order").get("fulfillments")))
diff --git a/erpnext/erpnext_integrations/doctype/tally_migration/tally_migration.py b/erpnext/erpnext_integrations/doctype/tally_migration/tally_migration.py
index 54ed6f7d115..833bbdfa3f3 100644
--- a/erpnext/erpnext_integrations/doctype/tally_migration/tally_migration.py
+++ b/erpnext/erpnext_integrations/doctype/tally_migration/tally_migration.py
@@ -36,6 +36,7 @@ def new_doc(document):
return doc
+
class TallyMigration(Document):
def validate(self):
failed_import_log = json.loads(self.failed_import_log)
@@ -73,14 +74,16 @@ class TallyMigration(Document):
def dump_processed_data(self, data):
for key, value in data.items():
- f = frappe.get_doc({
- "doctype": "File",
- "file_name": key + ".json",
- "attached_to_doctype": self.doctype,
- "attached_to_name": self.name,
- "content": json.dumps(value),
- "is_private": True
- })
+ f = frappe.get_doc(
+ {
+ "doctype": "File",
+ "file_name": key + ".json",
+ "attached_to_doctype": self.doctype,
+ "attached_to_name": self.name,
+ "content": json.dumps(value),
+ "is_private": True,
+ }
+ )
try:
f.insert()
except frappe.DuplicateEntryError:
@@ -88,8 +91,12 @@ class TallyMigration(Document):
setattr(self, key, f.file_url)
def set_account_defaults(self):
- self.default_cost_center, self.default_round_off_account = frappe.db.get_value("Company", self.erpnext_company, ["cost_center", "round_off_account"])
- self.default_warehouse = frappe.db.get_value("Stock Settings", "Stock Settings", "default_warehouse")
+ self.default_cost_center, self.default_round_off_account = frappe.db.get_value(
+ "Company", self.erpnext_company, ["cost_center", "round_off_account"]
+ )
+ self.default_warehouse = frappe.db.get_value(
+ "Stock Settings", "Stock Settings", "default_warehouse"
+ )
def _process_master_data(self):
def get_company_name(collection):
@@ -100,18 +107,24 @@ class TallyMigration(Document):
"Application of Funds (Assets)": "Asset",
"Expenses": "Expense",
"Income": "Income",
- "Source of Funds (Liabilities)": "Liability"
+ "Source of Funds (Liabilities)": "Liability",
}
roots = set(root_type_map.keys())
- accounts = list(get_groups(collection.find_all("GROUP"))) + list(get_ledgers(collection.find_all("LEDGER")))
+ accounts = list(get_groups(collection.find_all("GROUP"))) + list(
+ get_ledgers(collection.find_all("LEDGER"))
+ )
children, parents = get_children_and_parent_dict(accounts)
- group_set = [acc[1] for acc in accounts if acc[2]]
+ group_set = [acc[1] for acc in accounts if acc[2]]
children, customers, suppliers = remove_parties(parents, children, group_set)
try:
coa = traverse({}, children, roots, roots, group_set)
except RecursionError:
- self.log(_("Error occured while parsing Chart of Accounts: Please make sure that no two accounts have the same name"))
+ self.log(
+ _(
+ "Error occured while parsing Chart of Accounts: Please make sure that no two accounts have the same name"
+ )
+ )
for account in coa:
coa[account]["root_type"] = root_type_map[account]
@@ -185,42 +198,48 @@ class TallyMigration(Document):
links = []
if account.NAME.string.strip() in customers:
party_type = "Customer"
- parties.append({
- "doctype": party_type,
- "customer_name": account.NAME.string.strip(),
- "tax_id": account.INCOMETAXNUMBER.string.strip() if account.INCOMETAXNUMBER else None,
- "customer_group": "All Customer Groups",
- "territory": "All Territories",
- "customer_type": "Individual",
- })
+ parties.append(
+ {
+ "doctype": party_type,
+ "customer_name": account.NAME.string.strip(),
+ "tax_id": account.INCOMETAXNUMBER.string.strip() if account.INCOMETAXNUMBER else None,
+ "customer_group": "All Customer Groups",
+ "territory": "All Territories",
+ "customer_type": "Individual",
+ }
+ )
links.append({"link_doctype": party_type, "link_name": account["NAME"]})
if account.NAME.string.strip() in suppliers:
party_type = "Supplier"
- parties.append({
- "doctype": party_type,
- "supplier_name": account.NAME.string.strip(),
- "pan": account.INCOMETAXNUMBER.string.strip() if account.INCOMETAXNUMBER else None,
- "supplier_group": "All Supplier Groups",
- "supplier_type": "Individual",
- })
+ parties.append(
+ {
+ "doctype": party_type,
+ "supplier_name": account.NAME.string.strip(),
+ "pan": account.INCOMETAXNUMBER.string.strip() if account.INCOMETAXNUMBER else None,
+ "supplier_group": "All Supplier Groups",
+ "supplier_type": "Individual",
+ }
+ )
links.append({"link_doctype": party_type, "link_name": account["NAME"]})
if party_type:
address = "\n".join([a.string.strip() for a in account.find_all("ADDRESS")])
- addresses.append({
- "doctype": "Address",
- "address_line1": address[:140].strip(),
- "address_line2": address[140:].strip(),
- "country": account.COUNTRYNAME.string.strip() if account.COUNTRYNAME else None,
- "state": account.LEDSTATENAME.string.strip() if account.LEDSTATENAME else None,
- "gst_state": account.LEDSTATENAME.string.strip() if account.LEDSTATENAME else None,
- "pin_code": account.PINCODE.string.strip() if account.PINCODE else None,
- "mobile": account.LEDGERPHONE.string.strip() if account.LEDGERPHONE else None,
- "phone": account.LEDGERPHONE.string.strip() if account.LEDGERPHONE else None,
- "gstin": account.PARTYGSTIN.string.strip() if account.PARTYGSTIN else None,
- "links": links
- })
+ addresses.append(
+ {
+ "doctype": "Address",
+ "address_line1": address[:140].strip(),
+ "address_line2": address[140:].strip(),
+ "country": account.COUNTRYNAME.string.strip() if account.COUNTRYNAME else None,
+ "state": account.LEDSTATENAME.string.strip() if account.LEDSTATENAME else None,
+ "gst_state": account.LEDSTATENAME.string.strip() if account.LEDSTATENAME else None,
+ "pin_code": account.PINCODE.string.strip() if account.PINCODE else None,
+ "mobile": account.LEDGERPHONE.string.strip() if account.LEDGERPHONE else None,
+ "phone": account.LEDGERPHONE.string.strip() if account.LEDGERPHONE else None,
+ "gstin": account.PARTYGSTIN.string.strip() if account.PARTYGSTIN else None,
+ "links": links,
+ }
+ )
return parties, addresses
def get_stock_items_uoms(collection):
@@ -231,14 +250,16 @@ class TallyMigration(Document):
items = []
for item in collection.find_all("STOCKITEM"):
stock_uom = item.BASEUNITS.string.strip() if item.BASEUNITS else self.default_uom
- items.append({
- "doctype": "Item",
- "item_code" : item.NAME.string.strip(),
- "stock_uom": stock_uom.strip(),
- "is_stock_item": 0,
- "item_group": "All Item Groups",
- "item_defaults": [{"company": self.erpnext_company}]
- })
+ items.append(
+ {
+ "doctype": "Item",
+ "item_code": item.NAME.string.strip(),
+ "stock_uom": stock_uom.strip(),
+ "is_stock_item": 0,
+ "item_group": "All Item Groups",
+ "item_defaults": [{"company": self.erpnext_company}],
+ }
+ )
return items, uoms
@@ -257,7 +278,13 @@ class TallyMigration(Document):
self.publish("Process Master Data", _("Processing Items and UOMs"), 4, 5)
items, uoms = get_stock_items_uoms(collection)
- data = {"chart_of_accounts": chart_of_accounts, "parties": parties, "addresses": addresses, "items": items, "uoms": uoms}
+ data = {
+ "chart_of_accounts": chart_of_accounts,
+ "parties": parties,
+ "addresses": addresses,
+ "items": items,
+ "uoms": uoms,
+ }
self.publish("Process Master Data", _("Done"), 5, 5)
self.dump_processed_data(data)
@@ -272,7 +299,10 @@ class TallyMigration(Document):
self.set_status()
def publish(self, title, message, count, total):
- frappe.publish_realtime("tally_migration_progress_update", {"title": title, "message": message, "count": count, "total": total})
+ frappe.publish_realtime(
+ "tally_migration_progress_update",
+ {"title": title, "message": message, "count": count, "total": total},
+ )
def _import_master_data(self):
def create_company_and_coa(coa_file_url):
@@ -280,12 +310,14 @@ class TallyMigration(Document):
frappe.local.flags.ignore_chart_of_accounts = True
try:
- company = frappe.get_doc({
- "doctype": "Company",
- "company_name": self.erpnext_company,
- "default_currency": "INR",
- "enable_perpetual_inventory": 0,
- }).insert()
+ company = frappe.get_doc(
+ {
+ "doctype": "Company",
+ "company_name": self.erpnext_company,
+ "default_currency": "INR",
+ "enable_perpetual_inventory": 0,
+ }
+ ).insert()
except frappe.DuplicateEntryError:
company = frappe.get_doc("Company", self.erpnext_company)
unset_existing_data(self.erpnext_company)
@@ -358,8 +390,16 @@ class TallyMigration(Document):
for voucher in collection.find_all("VOUCHER"):
if voucher.ISCANCELLED.string.strip() == "Yes":
continue
- inventory_entries = voucher.find_all("INVENTORYENTRIES.LIST") + voucher.find_all("ALLINVENTORYENTRIES.LIST") + voucher.find_all("INVENTORYENTRIESIN.LIST") + voucher.find_all("INVENTORYENTRIESOUT.LIST")
- if voucher.VOUCHERTYPENAME.string.strip() not in ["Journal", "Receipt", "Payment", "Contra"] and inventory_entries:
+ inventory_entries = (
+ voucher.find_all("INVENTORYENTRIES.LIST")
+ + voucher.find_all("ALLINVENTORYENTRIES.LIST")
+ + voucher.find_all("INVENTORYENTRIESIN.LIST")
+ + voucher.find_all("INVENTORYENTRIESOUT.LIST")
+ )
+ if (
+ voucher.VOUCHERTYPENAME.string.strip() not in ["Journal", "Receipt", "Payment", "Contra"]
+ and inventory_entries
+ ):
function = voucher_to_invoice
else:
function = voucher_to_journal_entry
@@ -375,9 +415,14 @@ class TallyMigration(Document):
def voucher_to_journal_entry(voucher):
accounts = []
- ledger_entries = voucher.find_all("ALLLEDGERENTRIES.LIST") + voucher.find_all("LEDGERENTRIES.LIST")
+ ledger_entries = voucher.find_all("ALLLEDGERENTRIES.LIST") + voucher.find_all(
+ "LEDGERENTRIES.LIST"
+ )
for entry in ledger_entries:
- account = {"account": encode_company_abbr(entry.LEDGERNAME.string.strip(), self.erpnext_company), "cost_center": self.default_cost_center}
+ account = {
+ "account": encode_company_abbr(entry.LEDGERNAME.string.strip(), self.erpnext_company),
+ "cost_center": self.default_cost_center,
+ }
if entry.ISPARTYLEDGER.string.strip() == "Yes":
party_details = get_party(entry.LEDGERNAME.string.strip())
if party_details:
@@ -438,7 +483,12 @@ class TallyMigration(Document):
return invoice
def get_voucher_items(voucher, doctype):
- inventory_entries = voucher.find_all("INVENTORYENTRIES.LIST") + voucher.find_all("ALLINVENTORYENTRIES.LIST") + voucher.find_all("INVENTORYENTRIESIN.LIST") + voucher.find_all("INVENTORYENTRIESOUT.LIST")
+ inventory_entries = (
+ voucher.find_all("INVENTORYENTRIES.LIST")
+ + voucher.find_all("ALLINVENTORYENTRIES.LIST")
+ + voucher.find_all("INVENTORYENTRIESIN.LIST")
+ + voucher.find_all("INVENTORYENTRIESOUT.LIST")
+ )
if doctype == "Sales Invoice":
account_field = "income_account"
elif doctype == "Purchase Invoice":
@@ -446,32 +496,41 @@ class TallyMigration(Document):
items = []
for entry in inventory_entries:
qty, uom = entry.ACTUALQTY.string.strip().split()
- items.append({
- "item_code": entry.STOCKITEMNAME.string.strip(),
- "description": entry.STOCKITEMNAME.string.strip(),
- "qty": qty.strip(),
- "uom": uom.strip(),
- "conversion_factor": 1,
- "price_list_rate": entry.RATE.string.strip().split("/")[0],
- "cost_center": self.default_cost_center,
- "warehouse": self.default_warehouse,
- account_field: encode_company_abbr(entry.find_all("ACCOUNTINGALLOCATIONS.LIST")[0].LEDGERNAME.string.strip(), self.erpnext_company),
- })
+ items.append(
+ {
+ "item_code": entry.STOCKITEMNAME.string.strip(),
+ "description": entry.STOCKITEMNAME.string.strip(),
+ "qty": qty.strip(),
+ "uom": uom.strip(),
+ "conversion_factor": 1,
+ "price_list_rate": entry.RATE.string.strip().split("/")[0],
+ "cost_center": self.default_cost_center,
+ "warehouse": self.default_warehouse,
+ account_field: encode_company_abbr(
+ entry.find_all("ACCOUNTINGALLOCATIONS.LIST")[0].LEDGERNAME.string.strip(),
+ self.erpnext_company,
+ ),
+ }
+ )
return items
def get_voucher_taxes(voucher):
- ledger_entries = voucher.find_all("ALLLEDGERENTRIES.LIST") + voucher.find_all("LEDGERENTRIES.LIST")
+ ledger_entries = voucher.find_all("ALLLEDGERENTRIES.LIST") + voucher.find_all(
+ "LEDGERENTRIES.LIST"
+ )
taxes = []
for entry in ledger_entries:
if entry.ISPARTYLEDGER.string.strip() == "No":
tax_account = encode_company_abbr(entry.LEDGERNAME.string.strip(), self.erpnext_company)
- taxes.append({
- "charge_type": "Actual",
- "account_head": tax_account,
- "description": tax_account,
- "tax_amount": entry.AMOUNT.string.strip(),
- "cost_center": self.default_cost_center,
- })
+ taxes.append(
+ {
+ "charge_type": "Actual",
+ "account_head": tax_account,
+ "description": tax_account,
+ "tax_amount": entry.AMOUNT.string.strip(),
+ "cost_center": self.default_cost_center,
+ }
+ )
return taxes
def get_party(party):
@@ -502,8 +561,11 @@ class TallyMigration(Document):
def _import_day_book_data(self):
def create_fiscal_years(vouchers):
from frappe.utils.data import add_years, getdate
+
earliest_date = getdate(min(voucher["posting_date"] for voucher in vouchers))
- oldest_year = frappe.get_all("Fiscal Year", fields=["year_start_date", "year_end_date"], order_by="year_start_date")[0]
+ oldest_year = frappe.get_all(
+ "Fiscal Year", fields=["year_start_date", "year_end_date"], order_by="year_start_date"
+ )[0]
while earliest_date < oldest_year.year_start_date:
new_year = frappe.get_doc({"doctype": "Fiscal Year"})
new_year.year_start_date = add_years(oldest_year.year_start_date, -1)
@@ -520,32 +582,46 @@ class TallyMigration(Document):
"fieldtype": "Data",
"fieldname": "tally_guid",
"read_only": 1,
- "label": "Tally GUID"
+ "label": "Tally GUID",
}
tally_voucher_no_df = {
"fieldtype": "Data",
"fieldname": "tally_voucher_no",
"read_only": 1,
- "label": "Tally Voucher Number"
+ "label": "Tally Voucher Number",
}
for df in [tally_guid_df, tally_voucher_no_df]:
for doctype in doctypes:
create_custom_field(doctype, df)
def create_price_list():
- frappe.get_doc({
- "doctype": "Price List",
- "price_list_name": "Tally Price List",
- "selling": 1,
- "buying": 1,
- "enabled": 1,
- "currency": "INR"
- }).insert()
+ frappe.get_doc(
+ {
+ "doctype": "Price List",
+ "price_list_name": "Tally Price List",
+ "selling": 1,
+ "buying": 1,
+ "enabled": 1,
+ "currency": "INR",
+ }
+ ).insert()
try:
- frappe.db.set_value("Account", encode_company_abbr(self.tally_creditors_account, self.erpnext_company), "account_type", "Payable")
- frappe.db.set_value("Account", encode_company_abbr(self.tally_debtors_account, self.erpnext_company), "account_type", "Receivable")
- frappe.db.set_value("Company", self.erpnext_company, "round_off_account", self.default_round_off_account)
+ frappe.db.set_value(
+ "Account",
+ encode_company_abbr(self.tally_creditors_account, self.erpnext_company),
+ "account_type",
+ "Payable",
+ )
+ frappe.db.set_value(
+ "Account",
+ encode_company_abbr(self.tally_debtors_account, self.erpnext_company),
+ "account_type",
+ "Receivable",
+ )
+ frappe.db.set_value(
+ "Company", self.erpnext_company, "round_off_account", self.default_round_off_account
+ )
vouchers_file = frappe.get_doc("File", {"file_url": self.vouchers})
vouchers = json.loads(vouchers_file.get_content())
@@ -560,7 +636,16 @@ class TallyMigration(Document):
for index in range(0, total, VOUCHER_CHUNK_SIZE):
if index + VOUCHER_CHUNK_SIZE >= total:
is_last = True
- frappe.enqueue_doc(self.doctype, self.name, "_import_vouchers", queue="long", timeout=3600, start=index+1, total=total, is_last=is_last)
+ frappe.enqueue_doc(
+ self.doctype,
+ self.name,
+ "_import_vouchers",
+ queue="long",
+ timeout=3600,
+ start=index + 1,
+ total=total,
+ is_last=is_last,
+ )
except Exception:
self.log()
@@ -572,7 +657,7 @@ class TallyMigration(Document):
frappe.flags.in_migrate = True
vouchers_file = frappe.get_doc("File", {"file_url": self.vouchers})
vouchers = json.loads(vouchers_file.get_content())
- chunk = vouchers[start: start + VOUCHER_CHUNK_SIZE]
+ chunk = vouchers[start : start + VOUCHER_CHUNK_SIZE]
for index, voucher in enumerate(chunk, start=start):
try:
@@ -617,17 +702,22 @@ class TallyMigration(Document):
if sys.exc_info()[1].__class__ != frappe.DuplicateEntryError:
failed_import_log = json.loads(self.failed_import_log)
doc = data.as_dict()
- failed_import_log.append({
- "doc": doc,
- "exc": traceback.format_exc()
- })
- self.failed_import_log = json.dumps(failed_import_log, separators=(',', ':'))
+ failed_import_log.append({"doc": doc, "exc": traceback.format_exc()})
+ self.failed_import_log = json.dumps(failed_import_log, separators=(",", ":"))
self.save()
frappe.db.commit()
else:
data = data or self.status
- message = "\n".join(["Data:", json.dumps(data, default=str, indent=4), "--" * 50, "\nException:", traceback.format_exc()])
+ message = "\n".join(
+ [
+ "Data:",
+ json.dumps(data, default=str, indent=4),
+ "--" * 50,
+ "\nException:",
+ traceback.format_exc(),
+ ]
+ )
return frappe.log_error(title="Tally Migration Error", message=message)
def set_status(self, status=""):
diff --git a/erpnext/erpnext_integrations/doctype/taxjar_settings/taxjar_settings.py b/erpnext/erpnext_integrations/doctype/taxjar_settings/taxjar_settings.py
index d4bbe881d0c..2148863c556 100644
--- a/erpnext/erpnext_integrations/doctype/taxjar_settings/taxjar_settings.py
+++ b/erpnext/erpnext_integrations/doctype/taxjar_settings/taxjar_settings.py
@@ -14,27 +14,31 @@ from erpnext.erpnext_integrations.taxjar_integration import get_client
class TaxJarSettings(Document):
-
def on_update(self):
TAXJAR_CREATE_TRANSACTIONS = self.taxjar_create_transactions
TAXJAR_CALCULATE_TAX = self.taxjar_calculate_tax
TAXJAR_SANDBOX_MODE = self.is_sandbox
- fields_already_exist = frappe.db.exists('Custom Field', {'dt': ('in', ['Item','Sales Invoice Item']), 'fieldname':'product_tax_category'})
- fields_hidden = frappe.get_value('Custom Field', {'dt': ('in', ['Sales Invoice Item'])}, 'hidden')
+ fields_already_exist = frappe.db.exists(
+ "Custom Field",
+ {"dt": ("in", ["Item", "Sales Invoice Item"]), "fieldname": "product_tax_category"},
+ )
+ fields_hidden = frappe.get_value(
+ "Custom Field", {"dt": ("in", ["Sales Invoice Item"])}, "hidden"
+ )
- if (TAXJAR_CREATE_TRANSACTIONS or TAXJAR_CALCULATE_TAX or TAXJAR_SANDBOX_MODE):
+ if TAXJAR_CREATE_TRANSACTIONS or TAXJAR_CALCULATE_TAX or TAXJAR_SANDBOX_MODE:
if not fields_already_exist:
add_product_tax_categories()
make_custom_fields()
add_permissions()
- frappe.enqueue('erpnext.regional.united_states.setup.add_product_tax_categories', now=False)
+ frappe.enqueue("erpnext.regional.united_states.setup.add_product_tax_categories", now=False)
elif fields_already_exist and fields_hidden:
- toggle_tax_category_fields(hidden='0')
+ toggle_tax_category_fields(hidden="0")
elif fields_already_exist:
- toggle_tax_category_fields(hidden='1')
+ toggle_tax_category_fields(hidden="1")
def validate(self):
self.calculate_taxes_validation_for_create_transactions()
@@ -46,54 +50,97 @@ class TaxJarSettings(Document):
new_nexus_list = [frappe._dict(address) for address in nexus]
- self.set('nexus', [])
- self.set('nexus', new_nexus_list)
+ self.set("nexus", [])
+ self.set("nexus", new_nexus_list)
self.save()
def calculate_taxes_validation_for_create_transactions(self):
if not self.taxjar_calculate_tax and (self.taxjar_create_transactions or self.is_sandbox):
- frappe.throw(frappe._('Before enabling Create Transaction or Sandbox Mode, you need to check the Enable Tax Calculation box'))
+ frappe.throw(
+ frappe._(
+ "Before enabling Create Transaction or Sandbox Mode, you need to check the Enable Tax Calculation box"
+ )
+ )
def toggle_tax_category_fields(hidden):
- frappe.set_value('Custom Field', {'dt':'Sales Invoice Item', 'fieldname':'product_tax_category'}, 'hidden', hidden)
- frappe.set_value('Custom Field', {'dt':'Item', 'fieldname':'product_tax_category'}, 'hidden', hidden)
+ frappe.set_value(
+ "Custom Field",
+ {"dt": "Sales Invoice Item", "fieldname": "product_tax_category"},
+ "hidden",
+ hidden,
+ )
+ frappe.set_value(
+ "Custom Field", {"dt": "Item", "fieldname": "product_tax_category"}, "hidden", hidden
+ )
def add_product_tax_categories():
- with open(os.path.join(os.path.dirname(__file__), 'product_tax_category_data.json'), 'r') as f:
+ with open(os.path.join(os.path.dirname(__file__), "product_tax_category_data.json"), "r") as f:
tax_categories = json.loads(f.read())
- create_tax_categories(tax_categories['categories'])
+ create_tax_categories(tax_categories["categories"])
+
def create_tax_categories(data):
for d in data:
- if not frappe.db.exists('Product Tax Category',{'product_tax_code':d.get('product_tax_code')}):
- tax_category = frappe.new_doc('Product Tax Category')
+ if not frappe.db.exists("Product Tax Category", {"product_tax_code": d.get("product_tax_code")}):
+ tax_category = frappe.new_doc("Product Tax Category")
tax_category.description = d.get("description")
tax_category.product_tax_code = d.get("product_tax_code")
tax_category.category_name = d.get("name")
tax_category.db_insert()
+
def make_custom_fields(update=True):
custom_fields = {
- 'Sales Invoice Item': [
- dict(fieldname='product_tax_category', fieldtype='Link', insert_after='description', options='Product Tax Category',
- label='Product Tax Category', fetch_from='item_code.product_tax_category'),
- dict(fieldname='tax_collectable', fieldtype='Currency', insert_after='net_amount',
- label='Tax Collectable', read_only=1, options='currency'),
- dict(fieldname='taxable_amount', fieldtype='Currency', insert_after='tax_collectable',
- label='Taxable Amount', read_only=1, options='currency')
+ "Sales Invoice Item": [
+ dict(
+ fieldname="product_tax_category",
+ fieldtype="Link",
+ insert_after="description",
+ options="Product Tax Category",
+ label="Product Tax Category",
+ fetch_from="item_code.product_tax_category",
+ ),
+ dict(
+ fieldname="tax_collectable",
+ fieldtype="Currency",
+ insert_after="net_amount",
+ label="Tax Collectable",
+ read_only=1,
+ options="currency",
+ ),
+ dict(
+ fieldname="taxable_amount",
+ fieldtype="Currency",
+ insert_after="tax_collectable",
+ label="Taxable Amount",
+ read_only=1,
+ options="currency",
+ ),
+ ],
+ "Item": [
+ dict(
+ fieldname="product_tax_category",
+ fieldtype="Link",
+ insert_after="item_group",
+ options="Product Tax Category",
+ label="Product Tax Category",
+ )
],
- 'Item': [
- dict(fieldname='product_tax_category', fieldtype='Link', insert_after='item_group', options='Product Tax Category',
- label='Product Tax Category')
- ]
}
create_custom_fields(custom_fields, update=update)
+
def add_permissions():
doctype = "Product Tax Category"
- for role in ('Accounts Manager', 'Accounts User', 'System Manager','Item Manager', 'Stock Manager'):
+ for role in (
+ "Accounts Manager",
+ "Accounts User",
+ "System Manager",
+ "Item Manager",
+ "Stock Manager",
+ ):
add_permission(doctype, role, 0)
- update_permission_property(doctype, role, 0, 'write', 1)
- update_permission_property(doctype, role, 0, 'create', 1)
+ update_permission_property(doctype, role, 0, "write", 1)
+ update_permission_property(doctype, role, 0, "create", 1)
diff --git a/erpnext/erpnext_integrations/doctype/woocommerce_settings/woocommerce_settings.py b/erpnext/erpnext_integrations/doctype/woocommerce_settings/woocommerce_settings.py
index 8da52f49f1c..ab95b0cda9d 100644
--- a/erpnext/erpnext_integrations/doctype/woocommerce_settings/woocommerce_settings.py
+++ b/erpnext/erpnext_integrations/doctype/woocommerce_settings/woocommerce_settings.py
@@ -21,11 +21,23 @@ class WoocommerceSettings(Document):
custom_fields = {}
# create
for doctype in ["Customer", "Sales Order", "Item", "Address"]:
- df = dict(fieldname='woocommerce_id', label='Woocommerce ID', fieldtype='Data', read_only=1, print_hide=1)
+ df = dict(
+ fieldname="woocommerce_id",
+ label="Woocommerce ID",
+ fieldtype="Data",
+ read_only=1,
+ print_hide=1,
+ )
create_custom_field(doctype, df)
for doctype in ["Customer", "Address"]:
- df = dict(fieldname='woocommerce_email', label='Woocommerce Email', fieldtype='Data', read_only=1, print_hide=1)
+ df = dict(
+ fieldname="woocommerce_email",
+ label="Woocommerce Email",
+ fieldtype="Data",
+ read_only=1,
+ print_hide=1,
+ )
create_custom_field(doctype, df)
if not frappe.get_value("Item Group", {"name": _("WooCommerce Products")}):
@@ -57,21 +69,21 @@ class WoocommerceSettings(Document):
# for CI Test to work
url = "http://localhost:8000"
- server_url = '{uri.scheme}://{uri.netloc}'.format(
- uri=urlparse(url)
- )
+ server_url = "{uri.scheme}://{uri.netloc}".format(uri=urlparse(url))
delivery_url = server_url + endpoint
self.endpoint = delivery_url
+
@frappe.whitelist()
def generate_secret():
woocommerce_settings = frappe.get_doc("Woocommerce Settings")
woocommerce_settings.secret = frappe.generate_hash()
woocommerce_settings.save()
+
@frappe.whitelist()
def get_series():
return {
- "sales_order_series" : frappe.get_meta("Sales Order").get_options("naming_series") or "SO-WOO-",
+ "sales_order_series": frappe.get_meta("Sales Order").get_options("naming_series") or "SO-WOO-",
}
diff --git a/erpnext/erpnext_integrations/exotel_integration.py b/erpnext/erpnext_integrations/exotel_integration.py
index 167fcb71652..522de9ead83 100644
--- a/erpnext/erpnext_integrations/exotel_integration.py
+++ b/erpnext/erpnext_integrations/exotel_integration.py
@@ -6,15 +6,17 @@ from frappe import _
# api/method/erpnext.erpnext_integrations.exotel_integration.handle_end_call
# api/method/erpnext.erpnext_integrations.exotel_integration.handle_missed_call
+
@frappe.whitelist(allow_guest=True)
def handle_incoming_call(**kwargs):
try:
exotel_settings = get_exotel_settings()
- if not exotel_settings.enabled: return
+ if not exotel_settings.enabled:
+ return
call_payload = kwargs
- status = call_payload.get('Status')
- if status == 'free':
+ status = call_payload.get("Status")
+ if status == "free":
return
call_log = get_call_log(call_payload)
@@ -24,87 +26,108 @@ def handle_incoming_call(**kwargs):
update_call_log(call_payload, call_log=call_log)
except Exception as e:
frappe.db.rollback()
- frappe.log_error(title=_('Error in Exotel incoming call'))
+ frappe.log_error(title=_("Error in Exotel incoming call"))
frappe.db.commit()
+
@frappe.whitelist(allow_guest=True)
def handle_end_call(**kwargs):
- update_call_log(kwargs, 'Completed')
+ update_call_log(kwargs, "Completed")
+
@frappe.whitelist(allow_guest=True)
def handle_missed_call(**kwargs):
- update_call_log(kwargs, 'Missed')
+ status = ""
+ call_type = kwargs.get("CallType")
+ dial_call_status = kwargs.get("DialCallStatus")
-def update_call_log(call_payload, status='Ringing', call_log=None):
+ if call_type == "incomplete" and dial_call_status == "no-answer":
+ status = "No Answer"
+ elif call_type == "client-hangup" and dial_call_status == "canceled":
+ status = "Canceled"
+ elif call_type == "incomplete" and dial_call_status == "failed":
+ status = "Failed"
+
+ update_call_log(kwargs, status)
+
+
+def update_call_log(call_payload, status="Ringing", call_log=None):
call_log = call_log or get_call_log(call_payload)
+
+ # for a new sid, call_log and get_call_log will be empty so create a new log
+ if not call_log:
+ call_log = create_call_log(call_payload)
if call_log:
call_log.status = status
- call_log.to = call_payload.get('DialWhomNumber')
- call_log.duration = call_payload.get('DialCallDuration') or 0
- call_log.recording_url = call_payload.get('RecordingUrl')
+ call_log.to = call_payload.get("DialWhomNumber")
+ call_log.duration = call_payload.get("DialCallDuration") or 0
+ call_log.recording_url = call_payload.get("RecordingUrl")
call_log.save(ignore_permissions=True)
frappe.db.commit()
return call_log
-def get_call_log(call_payload):
- call_log = frappe.get_all('Call Log', {
- 'id': call_payload.get('CallSid'),
- }, limit=1)
- if call_log:
- return frappe.get_doc('Call Log', call_log[0].name)
+def get_call_log(call_payload):
+ call_log_id = call_payload.get("CallSid")
+ if frappe.db.exists("Call Log", call_log_id):
+ return frappe.get_doc("Call Log", call_log_id)
+
def create_call_log(call_payload):
- call_log = frappe.new_doc('Call Log')
- call_log.id = call_payload.get('CallSid')
- call_log.to = call_payload.get('DialWhomNumber')
- call_log.medium = call_payload.get('To')
- call_log.status = 'Ringing'
- setattr(call_log, 'from', call_payload.get('CallFrom'))
+ call_log = frappe.new_doc("Call Log")
+ call_log.id = call_payload.get("CallSid")
+ call_log.to = call_payload.get("DialWhomNumber")
+ call_log.medium = call_payload.get("To")
+ call_log.status = "Ringing"
+ setattr(call_log, "from", call_payload.get("CallFrom"))
call_log.save(ignore_permissions=True)
frappe.db.commit()
return call_log
+
@frappe.whitelist()
def get_call_status(call_id):
- endpoint = get_exotel_endpoint('Calls/{call_id}.json'.format(call_id=call_id))
+ endpoint = get_exotel_endpoint("Calls/{call_id}.json".format(call_id=call_id))
response = requests.get(endpoint)
- status = response.json().get('Call', {}).get('Status')
+ status = response.json().get("Call", {}).get("Status")
return status
+
@frappe.whitelist()
def make_a_call(from_number, to_number, caller_id):
- endpoint = get_exotel_endpoint('Calls/connect.json?details=true')
- response = requests.post(endpoint, data={
- 'From': from_number,
- 'To': to_number,
- 'CallerId': caller_id
- })
+ endpoint = get_exotel_endpoint("Calls/connect.json?details=true")
+ response = requests.post(
+ endpoint, data={"From": from_number, "To": to_number, "CallerId": caller_id}
+ )
return response.json()
+
def get_exotel_settings():
- return frappe.get_single('Exotel Settings')
+ return frappe.get_single("Exotel Settings")
+
def whitelist_numbers(numbers, caller_id):
- endpoint = get_exotel_endpoint('CustomerWhitelist')
- response = requests.post(endpoint, data={
- 'VirtualNumber': caller_id,
- 'Number': numbers,
- })
+ endpoint = get_exotel_endpoint("CustomerWhitelist")
+ response = requests.post(
+ endpoint,
+ data={
+ "VirtualNumber": caller_id,
+ "Number": numbers,
+ },
+ )
return response
+
def get_all_exophones():
- endpoint = get_exotel_endpoint('IncomingPhoneNumbers')
+ endpoint = get_exotel_endpoint("IncomingPhoneNumbers")
response = requests.post(endpoint)
return response
+
def get_exotel_endpoint(action):
settings = get_exotel_settings()
- return 'https://{api_key}:{api_token}@api.exotel.com/v1/Accounts/{sid}/{action}'.format(
- api_key=settings.api_key,
- api_token=settings.api_token,
- sid=settings.account_sid,
- action=action
+ return "https://{api_key}:{api_token}@api.exotel.com/v1/Accounts/{sid}/{action}".format(
+ api_key=settings.api_key, api_token=settings.api_token, sid=settings.account_sid, action=action
)
diff --git a/erpnext/erpnext_integrations/stripe_integration.py b/erpnext/erpnext_integrations/stripe_integration.py
index 502cb5f00a4..b12adc1d3df 100644
--- a/erpnext/erpnext_integrations/stripe_integration.py
+++ b/erpnext/erpnext_integrations/stripe_integration.py
@@ -16,17 +16,21 @@ def create_stripe_subscription(gateway_controller, data):
try:
stripe_settings.integration_request = create_request_log(stripe_settings.data, "Host", "Stripe")
- stripe_settings.payment_plans = frappe.get_doc("Payment Request", stripe_settings.data.reference_docname).subscription_plans
+ stripe_settings.payment_plans = frappe.get_doc(
+ "Payment Request", stripe_settings.data.reference_docname
+ ).subscription_plans
return create_subscription_on_stripe(stripe_settings)
except Exception:
frappe.log_error(frappe.get_traceback())
- return{
+ return {
"redirect_to": frappe.redirect_to_message(
- _('Server Error'),
- _("It seems that there is an issue with the server's stripe configuration. In case of failure, the amount will get refunded to your account.")
+ _("Server Error"),
+ _(
+ "It seems that there is an issue with the server's stripe configuration. In case of failure, the amount will get refunded to your account."
+ ),
),
- "status": 401
+ "status": 401,
}
@@ -40,20 +44,20 @@ def create_subscription_on_stripe(stripe_settings):
customer = stripe.Customer.create(
source=stripe_settings.data.stripe_token_id,
description=stripe_settings.data.payer_name,
- email=stripe_settings.data.payer_email
+ email=stripe_settings.data.payer_email,
)
subscription = stripe.Subscription.create(customer=customer, items=items)
if subscription.status == "active":
- stripe_settings.integration_request.db_set('status', 'Completed', update_modified=False)
+ stripe_settings.integration_request.db_set("status", "Completed", update_modified=False)
stripe_settings.flags.status_changed_to = "Completed"
else:
- stripe_settings.integration_request.db_set('status', 'Failed', update_modified=False)
- frappe.log_error('Subscription N°: ' + subscription.id, 'Stripe Payment not completed')
+ stripe_settings.integration_request.db_set("status", "Failed", update_modified=False)
+ frappe.log_error("Subscription N°: " + subscription.id, "Stripe Payment not completed")
except Exception:
- stripe_settings.integration_request.db_set('status', 'Failed', update_modified=False)
+ stripe_settings.integration_request.db_set("status", "Failed", update_modified=False)
frappe.log_error(frappe.get_traceback())
return stripe_settings.finalize_request()
diff --git a/erpnext/erpnext_integrations/taxjar_integration.py b/erpnext/erpnext_integrations/taxjar_integration.py
index a4e21579e32..b8893aa7732 100644
--- a/erpnext/erpnext_integrations/taxjar_integration.py
+++ b/erpnext/erpnext_integrations/taxjar_integration.py
@@ -8,18 +8,92 @@ from frappe.utils import cint, flt
from erpnext import get_default_company, get_region
-TAX_ACCOUNT_HEAD = frappe.db.get_single_value("TaxJar Settings", "tax_account_head")
-SHIP_ACCOUNT_HEAD = frappe.db.get_single_value("TaxJar Settings", "shipping_account_head")
-TAXJAR_CREATE_TRANSACTIONS = frappe.db.get_single_value("TaxJar Settings", "taxjar_create_transactions")
-TAXJAR_CALCULATE_TAX = frappe.db.get_single_value("TaxJar Settings", "taxjar_calculate_tax")
-SUPPORTED_COUNTRY_CODES = ["AT", "AU", "BE", "BG", "CA", "CY", "CZ", "DE", "DK", "EE", "ES", "FI",
- "FR", "GB", "GR", "HR", "HU", "IE", "IT", "LT", "LU", "LV", "MT", "NL", "PL", "PT", "RO",
- "SE", "SI", "SK", "US"]
-SUPPORTED_STATE_CODES = ['AL', 'AK', 'AZ', 'AR', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'HI', 'ID', 'IL',
- 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE',
- 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'OH', 'OK', 'OR', 'PA', 'RI', 'SC', 'SD',
- 'TN', 'TX', 'UT', 'VT', 'VA', 'WA', 'WV', 'WI', 'WY']
-
+SUPPORTED_COUNTRY_CODES = [
+ "AT",
+ "AU",
+ "BE",
+ "BG",
+ "CA",
+ "CY",
+ "CZ",
+ "DE",
+ "DK",
+ "EE",
+ "ES",
+ "FI",
+ "FR",
+ "GB",
+ "GR",
+ "HR",
+ "HU",
+ "IE",
+ "IT",
+ "LT",
+ "LU",
+ "LV",
+ "MT",
+ "NL",
+ "PL",
+ "PT",
+ "RO",
+ "SE",
+ "SI",
+ "SK",
+ "US",
+]
+SUPPORTED_STATE_CODES = [
+ "AL",
+ "AK",
+ "AZ",
+ "AR",
+ "CA",
+ "CO",
+ "CT",
+ "DE",
+ "DC",
+ "FL",
+ "GA",
+ "HI",
+ "ID",
+ "IL",
+ "IN",
+ "IA",
+ "KS",
+ "KY",
+ "LA",
+ "ME",
+ "MD",
+ "MA",
+ "MI",
+ "MN",
+ "MS",
+ "MO",
+ "MT",
+ "NE",
+ "NV",
+ "NH",
+ "NJ",
+ "NM",
+ "NY",
+ "NC",
+ "ND",
+ "OH",
+ "OK",
+ "OR",
+ "PA",
+ "RI",
+ "SC",
+ "SD",
+ "TN",
+ "TX",
+ "UT",
+ "VT",
+ "VA",
+ "WA",
+ "WV",
+ "WI",
+ "WY",
+]
def get_client():
@@ -34,13 +108,15 @@ def get_client():
if api_key and api_url:
client = taxjar.Client(api_key=api_key, api_url=api_url)
- client.set_api_config('headers', {
- 'x-api-version': '2020-08-07'
- })
+ client.set_api_config("headers", {"x-api-version": "2022-01-24"})
return client
def create_transaction(doc, method):
+ TAXJAR_CREATE_TRANSACTIONS = frappe.db.get_single_value(
+ "TaxJar Settings", "taxjar_create_transactions"
+ )
+
"""Create an order transaction in TaxJar"""
if not TAXJAR_CREATE_TRANSACTIONS:
@@ -51,6 +127,7 @@ def create_transaction(doc, method):
if not client:
return
+ TAX_ACCOUNT_HEAD = frappe.db.get_single_value("TaxJar Settings", "tax_account_head")
sales_tax = sum([tax.tax_amount for tax in doc.taxes if tax.account_head == TAX_ACCOUNT_HEAD])
if not sales_tax:
@@ -61,10 +138,10 @@ def create_transaction(doc, method):
if not tax_dict:
return
- tax_dict['transaction_id'] = doc.name
- tax_dict['transaction_date'] = frappe.utils.today()
- tax_dict['sales_tax'] = sales_tax
- tax_dict['amount'] = doc.total + tax_dict['shipping']
+ tax_dict["transaction_id"] = doc.name
+ tax_dict["transaction_date"] = frappe.utils.today()
+ tax_dict["sales_tax"] = sales_tax
+ tax_dict["amount"] = doc.total + tax_dict["shipping"]
try:
if doc.is_return:
@@ -79,6 +156,9 @@ def create_transaction(doc, method):
def delete_transaction(doc, method):
"""Delete an existing TaxJar order transaction"""
+ TAXJAR_CREATE_TRANSACTIONS = frappe.db.get_single_value(
+ "TaxJar Settings", "taxjar_create_transactions"
+ )
if not TAXJAR_CREATE_TRANSACTIONS:
return
@@ -92,6 +172,8 @@ def delete_transaction(doc, method):
def get_tax_data(doc):
+ SHIP_ACCOUNT_HEAD = frappe.db.get_single_value("TaxJar Settings", "shipping_account_head")
+
from_address = get_company_address_details(doc)
from_shipping_state = from_address.get("state")
from_country_code = frappe.db.get_value("Country", from_address.country, "code")
@@ -107,29 +189,30 @@ def get_tax_data(doc):
line_items = [get_line_item_dict(item, doc.docstatus) for item in doc.items]
if from_shipping_state not in SUPPORTED_STATE_CODES:
- from_shipping_state = get_state_code(from_address, 'Company')
+ from_shipping_state = get_state_code(from_address, "Company")
if to_shipping_state not in SUPPORTED_STATE_CODES:
- to_shipping_state = get_state_code(to_address, 'Shipping')
+ to_shipping_state = get_state_code(to_address, "Shipping")
tax_dict = {
- 'from_country': from_country_code,
- 'from_zip': from_address.pincode,
- 'from_state': from_shipping_state,
- 'from_city': from_address.city,
- 'from_street': from_address.address_line1,
- 'to_country': to_country_code,
- 'to_zip': to_address.pincode,
- 'to_city': to_address.city,
- 'to_street': to_address.address_line1,
- 'to_state': to_shipping_state,
- 'shipping': shipping,
- 'amount': doc.net_total,
- 'plugin': 'erpnext',
- 'line_items': line_items
+ "from_country": from_country_code,
+ "from_zip": from_address.pincode,
+ "from_state": from_shipping_state,
+ "from_city": from_address.city,
+ "from_street": from_address.address_line1,
+ "to_country": to_country_code,
+ "to_zip": to_address.pincode,
+ "to_city": to_address.city,
+ "to_street": to_address.address_line1,
+ "to_state": to_shipping_state,
+ "shipping": shipping,
+ "amount": doc.net_total,
+ "plugin": "erpnext",
+ "line_items": line_items,
}
return tax_dict
+
def get_state_code(address, location):
if address is not None:
state_code = get_iso_3166_2_state_code(address)
@@ -140,26 +223,29 @@ def get_state_code(address, location):
return state_code
+
def get_line_item_dict(item, docstatus):
tax_dict = dict(
- id = item.get('idx'),
- quantity = item.get('qty'),
- unit_price = item.get('rate'),
- product_tax_code = item.get('product_tax_category')
+ id=item.get("idx"),
+ quantity=item.get("qty"),
+ unit_price=item.get("rate"),
+ product_tax_code=item.get("product_tax_category"),
)
if docstatus == 1:
- tax_dict.update({
- 'sales_tax':item.get('tax_collectable')
- })
+ tax_dict.update({"sales_tax": item.get("tax_collectable")})
return tax_dict
+
def set_sales_tax(doc, method):
+ TAX_ACCOUNT_HEAD = frappe.db.get_single_value("TaxJar Settings", "tax_account_head")
+ TAXJAR_CALCULATE_TAX = frappe.db.get_single_value("TaxJar Settings", "taxjar_calculate_tax")
+
if not TAXJAR_CALCULATE_TAX:
return
- if get_region(doc.company) != 'United States':
+ if get_region(doc.company) != "United States":
return
if not doc.items:
@@ -192,21 +278,26 @@ def set_sales_tax(doc, method):
doc.run_method("calculate_taxes_and_totals")
break
else:
- doc.append("taxes", {
- "charge_type": "Actual",
- "description": "Sales Tax",
- "account_head": TAX_ACCOUNT_HEAD,
- "tax_amount": tax_data.amount_to_collect
- })
+ doc.append(
+ "taxes",
+ {
+ "charge_type": "Actual",
+ "description": "Sales Tax",
+ "account_head": TAX_ACCOUNT_HEAD,
+ "tax_amount": tax_data.amount_to_collect,
+ },
+ )
# Assigning values to tax_collectable and taxable_amount fields in sales item table
for item in tax_data.breakdown.line_items:
- doc.get('items')[cint(item.id)-1].tax_collectable = item.tax_collectable
- doc.get('items')[cint(item.id)-1].taxable_amount = item.taxable_amount
+ doc.get("items")[cint(item.id) - 1].tax_collectable = item.tax_collectable
+ doc.get("items")[cint(item.id) - 1].taxable_amount = item.taxable_amount
doc.run_method("calculate_taxes_and_totals")
+
def check_for_nexus(doc, tax_dict):
- if not frappe.db.get_value('TaxJar Nexus', {'region_code': tax_dict["to_state"]}):
+ TAX_ACCOUNT_HEAD = frappe.db.get_single_value("TaxJar Settings", "tax_account_head")
+ if not frappe.db.get_value("TaxJar Nexus", {"region_code": tax_dict["to_state"]}):
for item in doc.get("items"):
item.tax_collectable = flt(0)
item.taxable_amount = flt(0)
@@ -216,11 +307,17 @@ def check_for_nexus(doc, tax_dict):
doc.taxes.remove(tax)
return
+
def check_sales_tax_exemption(doc):
# if the party is exempt from sales tax, then set all tax account heads to zero
- sales_tax_exempted = hasattr(doc, "exempt_from_sales_tax") and doc.exempt_from_sales_tax \
- or frappe.db.has_column("Customer", "exempt_from_sales_tax") \
+ TAX_ACCOUNT_HEAD = frappe.db.get_single_value("TaxJar Settings", "tax_account_head")
+
+ sales_tax_exempted = (
+ hasattr(doc, "exempt_from_sales_tax")
+ and doc.exempt_from_sales_tax
+ or frappe.db.has_column("Customer", "exempt_from_sales_tax")
and frappe.db.get_value("Customer", doc.customer, "exempt_from_sales_tax")
+ )
if sales_tax_exempted:
for tax in doc.taxes:
@@ -232,6 +329,7 @@ def check_sales_tax_exemption(doc):
else:
return False
+
def validate_tax_request(tax_dict):
"""Return the sales tax that should be collected for a given order."""
@@ -275,9 +373,12 @@ def get_shipping_address_details(doc):
def get_iso_3166_2_state_code(address):
import pycountry
+
country_code = frappe.db.get_value("Country", address.get("country"), "code")
- error_message = _("""{0} is not a valid state! Check for typos or enter the ISO code for your state.""").format(address.get("state"))
+ error_message = _(
+ """{0} is not a valid state! Check for typos or enter the ISO code for your state."""
+ ).format(address.get("state"))
state = address.get("state").upper().strip()
# The max length for ISO state codes is 3, excluding the country code
@@ -298,7 +399,7 @@ def get_iso_3166_2_state_code(address):
except LookupError:
frappe.throw(_(error_message))
else:
- return lookup_state.code.split('-')[1]
+ return lookup_state.code.split("-")[1]
def sanitize_error_response(response):
@@ -309,7 +410,7 @@ def sanitize_error_response(response):
"to zip": "Zipcode",
"to city": "City",
"to state": "State",
- "to country": "Country"
+ "to country": "Country",
}
for k, v in sanitized_responses.items():
diff --git a/erpnext/erpnext_integrations/utils.py b/erpnext/erpnext_integrations/utils.py
index 44039933405..406751f1a62 100644
--- a/erpnext/erpnext_integrations/utils.py
+++ b/erpnext/erpnext_integrations/utils.py
@@ -1,4 +1,3 @@
-
import base64
import hashlib
import hmac
@@ -10,28 +9,24 @@ from six.moves.urllib.parse import urlparse
from erpnext import get_default_company
-def validate_webhooks_request(doctype, hmac_key, secret_key='secret'):
+def validate_webhooks_request(doctype, hmac_key, secret_key="secret"):
def innerfn(fn):
settings = frappe.get_doc(doctype)
if frappe.request and settings and settings.get(secret_key) and not frappe.flags.in_test:
sig = base64.b64encode(
- hmac.new(
- settings.get(secret_key).encode('utf8'),
- frappe.request.data,
- hashlib.sha256
- ).digest()
+ hmac.new(settings.get(secret_key).encode("utf8"), frappe.request.data, hashlib.sha256).digest()
)
- if frappe.request.data and \
- not sig == bytes(frappe.get_request_header(hmac_key).encode()):
- frappe.throw(_("Unverified Webhook Data"))
+ if frappe.request.data and not sig == bytes(frappe.get_request_header(hmac_key).encode()):
+ frappe.throw(_("Unverified Webhook Data"))
frappe.set_user(settings.modified_by)
return fn
return innerfn
+
def get_webhook_address(connector_name, method, exclude_uri=False, force_https=False):
endpoint = "erpnext.erpnext_integrations.connectors.{0}.{1}".format(connector_name, method)
@@ -51,34 +46,40 @@ def get_webhook_address(connector_name, method, exclude_uri=False, force_https=F
return server_url
+
def create_mode_of_payment(gateway, payment_type="General"):
- payment_gateway_account = frappe.db.get_value("Payment Gateway Account", {
- "payment_gateway": gateway
- }, ['payment_account'])
+ payment_gateway_account = frappe.db.get_value(
+ "Payment Gateway Account", {"payment_gateway": gateway}, ["payment_account"]
+ )
mode_of_payment = frappe.db.exists("Mode of Payment", gateway)
if not mode_of_payment and payment_gateway_account:
- mode_of_payment = frappe.get_doc({
- "doctype": "Mode of Payment",
- "mode_of_payment": gateway,
- "enabled": 1,
- "type": payment_type,
- "accounts": [{
- "doctype": "Mode of Payment Account",
- "company": get_default_company(),
- "default_account": payment_gateway_account
- }]
- })
+ mode_of_payment = frappe.get_doc(
+ {
+ "doctype": "Mode of Payment",
+ "mode_of_payment": gateway,
+ "enabled": 1,
+ "type": payment_type,
+ "accounts": [
+ {
+ "doctype": "Mode of Payment Account",
+ "company": get_default_company(),
+ "default_account": payment_gateway_account,
+ }
+ ],
+ }
+ )
mode_of_payment.insert(ignore_permissions=True)
return mode_of_payment
elif mode_of_payment:
return frappe.get_doc("Mode of Payment", mode_of_payment)
+
def get_tracking_url(carrier, tracking_number):
# Return the formatted Tracking URL.
- tracking_url = ''
- url_reference = frappe.get_value('Parcel Service', carrier, 'url_reference')
+ tracking_url = ""
+ url_reference = frappe.get_value("Parcel Service", carrier, "url_reference")
if url_reference:
- tracking_url = frappe.render_template(url_reference, {'tracking_number': tracking_number})
+ tracking_url = frappe.render_template(url_reference, {"tracking_number": tracking_number})
return tracking_url
diff --git a/erpnext/exceptions.py b/erpnext/exceptions.py
index cfd2a7ce049..86c29d476b2 100644
--- a/erpnext/exceptions.py
+++ b/erpnext/exceptions.py
@@ -1,11 +1,26 @@
-
import frappe
# accounts
-class PartyFrozen(frappe.ValidationError): pass
-class InvalidAccountCurrency(frappe.ValidationError): pass
-class InvalidCurrency(frappe.ValidationError): pass
-class PartyDisabled(frappe.ValidationError):pass
-class InvalidAccountDimensionError(frappe.ValidationError): pass
-class MandatoryAccountDimensionError(frappe.ValidationError): pass
+class PartyFrozen(frappe.ValidationError):
+ pass
+
+
+class InvalidAccountCurrency(frappe.ValidationError):
+ pass
+
+
+class InvalidCurrency(frappe.ValidationError):
+ pass
+
+
+class PartyDisabled(frappe.ValidationError):
+ pass
+
+
+class InvalidAccountDimensionError(frappe.ValidationError):
+ pass
+
+
+class MandatoryAccountDimensionError(frappe.ValidationError):
+ pass
diff --git a/erpnext/healthcare/dashboard_chart_source/department_wise_patient_appointments/department_wise_patient_appointments.py b/erpnext/healthcare/dashboard_chart_source/department_wise_patient_appointments/department_wise_patient_appointments.py
index ed6951dacbc..9ffe1979597 100644
--- a/erpnext/healthcare/dashboard_chart_source/department_wise_patient_appointments/department_wise_patient_appointments.py
+++ b/erpnext/healthcare/dashboard_chart_source/department_wise_patient_appointments/department_wise_patient_appointments.py
@@ -8,30 +8,39 @@ from frappe.utils.dashboard import cache_source
@frappe.whitelist()
@cache_source
-def get(chart_name = None, chart = None, no_cache = None, filters = None, from_date = None,
- to_date = None, timespan = None, time_interval = None, heatmap_year = None):
+def get(
+ chart_name=None,
+ chart=None,
+ no_cache=None,
+ filters=None,
+ from_date=None,
+ to_date=None,
+ timespan=None,
+ time_interval=None,
+ heatmap_year=None,
+):
if chart_name:
- chart = frappe.get_doc('Dashboard Chart', chart_name)
+ chart = frappe.get_doc("Dashboard Chart", chart_name)
else:
chart = frappe._dict(frappe.parse_json(chart))
filters = frappe.parse_json(filters)
- data = frappe.db.get_list('Medical Department', fields=['name'])
+ data = frappe.db.get_list("Medical Department", fields=["name"])
if not filters:
filters = {}
- status = ['Open', 'Scheduled', 'Closed', 'Cancelled']
+ status = ["Open", "Scheduled", "Closed", "Cancelled"]
for department in data:
- filters['department'] = department.name
- department['total_appointments'] = frappe.db.count('Patient Appointment', filters=filters)
+ filters["department"] = department.name
+ department["total_appointments"] = frappe.db.count("Patient Appointment", filters=filters)
for entry in status:
- filters['status'] = entry
- department[frappe.scrub(entry)] = frappe.db.count('Patient Appointment', filters=filters)
- filters.pop('status')
+ filters["status"] = entry
+ department[frappe.scrub(entry)] = frappe.db.count("Patient Appointment", filters=filters)
+ filters.pop("status")
- sorted_department_map = sorted(data, key = lambda i: i['total_appointments'], reverse=True)
+ sorted_department_map = sorted(data, key=lambda i: i["total_appointments"], reverse=True)
if len(sorted_department_map) > 10:
sorted_department_map = sorted_department_map[:10]
@@ -50,24 +59,12 @@ def get(chart_name = None, chart = None, no_cache = None, filters = None, from_d
cancelled.append(department.cancelled)
return {
- 'labels': labels,
- 'datasets': [
- {
- 'name': 'Open',
- 'values': open_appointments
- },
- {
- 'name': 'Scheduled',
- 'values': scheduled
- },
- {
- 'name': 'Closed',
- 'values': closed
- },
- {
- 'name': 'Cancelled',
- 'values': cancelled
- }
+ "labels": labels,
+ "datasets": [
+ {"name": "Open", "values": open_appointments},
+ {"name": "Scheduled", "values": scheduled},
+ {"name": "Closed", "values": closed},
+ {"name": "Cancelled", "values": cancelled},
],
- 'type': 'bar'
+ "type": "bar",
}
diff --git a/erpnext/healthcare/doctype/appointment_type/appointment_type.py b/erpnext/healthcare/doctype/appointment_type/appointment_type.py
index f77511328f8..db4a19e32d6 100644
--- a/erpnext/healthcare/doctype/appointment_type/appointment_type.py
+++ b/erpnext/healthcare/doctype/appointment_type/appointment_type.py
@@ -10,47 +10,65 @@ class AppointmentType(Document):
def validate(self):
if self.items and self.price_list:
for item in self.items:
- existing_op_item_price = frappe.db.exists('Item Price', {
- 'item_code': item.op_consulting_charge_item,
- 'price_list': self.price_list
- })
+ existing_op_item_price = frappe.db.exists(
+ "Item Price", {"item_code": item.op_consulting_charge_item, "price_list": self.price_list}
+ )
if not existing_op_item_price and item.op_consulting_charge_item and item.op_consulting_charge:
make_item_price(self.price_list, item.op_consulting_charge_item, item.op_consulting_charge)
- existing_ip_item_price = frappe.db.exists('Item Price', {
- 'item_code': item.inpatient_visit_charge_item,
- 'price_list': self.price_list
- })
+ existing_ip_item_price = frappe.db.exists(
+ "Item Price", {"item_code": item.inpatient_visit_charge_item, "price_list": self.price_list}
+ )
+
+ if (
+ not existing_ip_item_price
+ and item.inpatient_visit_charge_item
+ and item.inpatient_visit_charge
+ ):
+ make_item_price(
+ self.price_list, item.inpatient_visit_charge_item, item.inpatient_visit_charge
+ )
- if not existing_ip_item_price and item.inpatient_visit_charge_item and item.inpatient_visit_charge:
- make_item_price(self.price_list, item.inpatient_visit_charge_item, item.inpatient_visit_charge)
@frappe.whitelist()
def get_service_item_based_on_department(appointment_type, department):
- item_list = frappe.db.get_value('Appointment Type Service Item',
- filters = {'medical_department': department, 'parent': appointment_type},
- fieldname = ['op_consulting_charge_item',
- 'inpatient_visit_charge_item', 'op_consulting_charge', 'inpatient_visit_charge'],
- as_dict = 1
+ item_list = frappe.db.get_value(
+ "Appointment Type Service Item",
+ filters={"medical_department": department, "parent": appointment_type},
+ fieldname=[
+ "op_consulting_charge_item",
+ "inpatient_visit_charge_item",
+ "op_consulting_charge",
+ "inpatient_visit_charge",
+ ],
+ as_dict=1,
)
# if department wise items are not set up
# use the generic items
if not item_list:
- item_list = frappe.db.get_value('Appointment Type Service Item',
- filters = {'parent': appointment_type},
- fieldname = ['op_consulting_charge_item',
- 'inpatient_visit_charge_item', 'op_consulting_charge', 'inpatient_visit_charge'],
- as_dict = 1
+ item_list = frappe.db.get_value(
+ "Appointment Type Service Item",
+ filters={"parent": appointment_type},
+ fieldname=[
+ "op_consulting_charge_item",
+ "inpatient_visit_charge_item",
+ "op_consulting_charge",
+ "inpatient_visit_charge",
+ ],
+ as_dict=1,
)
return item_list
+
def make_item_price(price_list, item, item_price):
- frappe.get_doc({
- 'doctype': 'Item Price',
- 'price_list': price_list,
- 'item_code': item,
- 'price_list_rate': item_price
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ frappe.get_doc(
+ {
+ "doctype": "Item Price",
+ "price_list": price_list,
+ "item_code": item,
+ "price_list_rate": item_price,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
diff --git a/erpnext/healthcare/doctype/appointment_type/appointment_type_dashboard.py b/erpnext/healthcare/doctype/appointment_type/appointment_type_dashboard.py
index de5b9af2242..04bc04acb3c 100644
--- a/erpnext/healthcare/doctype/appointment_type/appointment_type_dashboard.py
+++ b/erpnext/healthcare/doctype/appointment_type/appointment_type_dashboard.py
@@ -1,14 +1,10 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'appointment_type',
- 'transactions': [
- {
- 'label': _('Patient Appointments'),
- 'items': ['Patient Appointment']
- },
- ]
+ "fieldname": "appointment_type",
+ "transactions": [
+ {"label": _("Patient Appointments"), "items": ["Patient Appointment"]},
+ ],
}
diff --git a/erpnext/healthcare/doctype/appointment_type/test_appointment_type.py b/erpnext/healthcare/doctype/appointment_type/test_appointment_type.py
index b98575c376a..e5d1a1162ac 100644
--- a/erpnext/healthcare/doctype/appointment_type/test_appointment_type.py
+++ b/erpnext/healthcare/doctype/appointment_type/test_appointment_type.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Appointment Type')
+
class TestAppointmentType(unittest.TestCase):
pass
diff --git a/erpnext/healthcare/doctype/clinical_procedure/clinical_procedure.py b/erpnext/healthcare/doctype/clinical_procedure/clinical_procedure.py
index a53f72a35d3..421db118399 100644
--- a/erpnext/healthcare/doctype/clinical_procedure/clinical_procedure.py
+++ b/erpnext/healthcare/doctype/clinical_procedure/clinical_procedure.py
@@ -33,27 +33,29 @@ class ClinicalProcedure(Document):
def after_insert(self):
if self.prescription:
- frappe.db.set_value('Procedure Prescription', self.prescription, 'procedure_created', 1)
+ frappe.db.set_value("Procedure Prescription", self.prescription, "procedure_created", 1)
if self.appointment:
- frappe.db.set_value('Patient Appointment', self.appointment, 'status', 'Closed')
- template = frappe.get_doc('Clinical Procedure Template', self.procedure_template)
+ frappe.db.set_value("Patient Appointment", self.appointment, "status", "Closed")
+ template = frappe.get_doc("Clinical Procedure Template", self.procedure_template)
if template.sample:
- patient = frappe.get_doc('Patient', self.patient)
+ patient = frappe.get_doc("Patient", self.patient)
sample_collection = create_sample_doc(template, patient, None, self.company)
- frappe.db.set_value('Clinical Procedure', self.name, 'sample', sample_collection.name)
+ frappe.db.set_value("Clinical Procedure", self.name, "sample", sample_collection.name)
self.reload()
def set_status(self):
if self.docstatus == 0:
- self.status = 'Draft'
+ self.status = "Draft"
elif self.docstatus == 1:
- if self.status not in ['In Progress', 'Completed']:
- self.status = 'Pending'
+ if self.status not in ["In Progress", "Completed"]:
+ self.status = "Pending"
elif self.docstatus == 2:
- self.status = 'Cancelled'
+ self.status = "Cancelled"
def set_title(self):
- self.title = _('{0} - {1}').format(self.patient_name or self.patient, self.procedure_template)[:100]
+ self.title = _("{0} - {1}").format(self.patient_name or self.patient, self.procedure_template)[
+ :100
+ ]
@frappe.whitelist()
def complete_procedure(self):
@@ -63,37 +65,48 @@ class ClinicalProcedure(Document):
if self.items:
consumable_total_amount = 0
consumption_details = False
- customer = frappe.db.get_value('Patient', self.patient, 'customer')
+ customer = frappe.db.get_value("Patient", self.patient, "customer")
if customer:
for item in self.items:
if item.invoice_separately_as_consumables:
- price_list, price_list_currency = frappe.db.get_values('Price List', {'selling': 1}, ['name', 'currency'])[0]
+ price_list, price_list_currency = frappe.db.get_values(
+ "Price List", {"selling": 1}, ["name", "currency"]
+ )[0]
args = {
- 'doctype': 'Sales Invoice',
- 'item_code': item.item_code,
- 'company': self.company,
- 'warehouse': self.warehouse,
- 'customer': customer,
- 'selling_price_list': price_list,
- 'price_list_currency': price_list_currency,
- 'plc_conversion_rate': 1.0,
- 'conversion_rate': 1.0
+ "doctype": "Sales Invoice",
+ "item_code": item.item_code,
+ "company": self.company,
+ "warehouse": self.warehouse,
+ "customer": customer,
+ "selling_price_list": price_list,
+ "price_list_currency": price_list_currency,
+ "plc_conversion_rate": 1.0,
+ "conversion_rate": 1.0,
}
item_details = get_item_details(args)
item_price = item_details.price_list_rate * item.qty
- item_consumption_details = item_details.item_name + ' ' + str(item.qty) + ' ' + item.uom + ' ' + str(item_price)
+ item_consumption_details = (
+ item_details.item_name + " " + str(item.qty) + " " + item.uom + " " + str(item_price)
+ )
consumable_total_amount += item_price
if not consumption_details:
- consumption_details = _('Clinical Procedure ({0}):').format(self.name)
- consumption_details += '\n\t' + item_consumption_details
+ consumption_details = _("Clinical Procedure ({0}):").format(self.name)
+ consumption_details += "\n\t" + item_consumption_details
if consumable_total_amount > 0:
- frappe.db.set_value('Clinical Procedure', self.name, 'consumable_total_amount', consumable_total_amount)
- frappe.db.set_value('Clinical Procedure', self.name, 'consumption_details', consumption_details)
+ frappe.db.set_value(
+ "Clinical Procedure", self.name, "consumable_total_amount", consumable_total_amount
+ )
+ frappe.db.set_value(
+ "Clinical Procedure", self.name, "consumption_details", consumption_details
+ )
else:
- frappe.throw(_('Please set Customer in Patient {0}').format(frappe.bold(self.patient)), title=_('Customer Not Found'))
+ frappe.throw(
+ _("Please set Customer in Patient {0}").format(frappe.bold(self.patient)),
+ title=_("Customer Not Found"),
+ )
- self.db_set('status', 'Completed')
+ self.db_set("status", "Completed")
if self.consume_stock and self.items:
return stock_entry
@@ -102,15 +115,15 @@ class ClinicalProcedure(Document):
def start_procedure(self):
allow_start = self.set_actual_qty()
if allow_start:
- self.db_set('status', 'In Progress')
- return 'success'
- return 'insufficient stock'
+ self.db_set("status", "In Progress")
+ return "success"
+ return "insufficient stock"
def set_actual_qty(self):
- allow_negative_stock = frappe.db.get_single_value('Stock Settings', 'allow_negative_stock')
+ allow_negative_stock = frappe.db.get_single_value("Stock Settings", "allow_negative_stock")
allow_start = True
- for d in self.get('items'):
+ for d in self.get("items"):
d.actual_qty = get_stock_qty(d.item_code, self.warehouse)
# validate qty
if not allow_negative_stock and d.actual_qty < d.qty:
@@ -121,15 +134,15 @@ class ClinicalProcedure(Document):
@frappe.whitelist()
def make_material_receipt(self, submit=False):
- stock_entry = frappe.new_doc('Stock Entry')
+ stock_entry = frappe.new_doc("Stock Entry")
- stock_entry.stock_entry_type = 'Material Receipt'
+ stock_entry.stock_entry_type = "Material Receipt"
stock_entry.to_warehouse = self.warehouse
stock_entry.company = self.company
- expense_account = get_account(None, 'expense_account', 'Healthcare Settings', self.company)
+ expense_account = get_account(None, "expense_account", "Healthcare Settings", self.company)
for item in self.items:
if item.qty > item.actual_qty:
- se_child = stock_entry.append('items')
+ se_child = stock_entry.append("items")
se_child.item_code = item.item_code
se_child.item_name = item.item_name
se_child.uom = item.uom
@@ -139,7 +152,7 @@ class ClinicalProcedure(Document):
# in stock uom
se_child.transfer_qty = flt(item.transfer_qty)
se_child.conversion_factor = flt(item.conversion_factor)
- cost_center = frappe.get_cached_value('Company', self.company, 'cost_center')
+ cost_center = frappe.get_cached_value("Company", self.company, "cost_center")
se_child.cost_center = cost_center
se_child.expense_account = expense_account
if submit:
@@ -149,25 +162,30 @@ class ClinicalProcedure(Document):
def get_stock_qty(item_code, warehouse):
- return get_previous_sle({
- 'item_code': item_code,
- 'warehouse': warehouse,
- 'posting_date': nowdate(),
- 'posting_time': nowtime()
- }).get('qty_after_transaction') or 0
+ return (
+ get_previous_sle(
+ {
+ "item_code": item_code,
+ "warehouse": warehouse,
+ "posting_date": nowdate(),
+ "posting_time": nowtime(),
+ }
+ ).get("qty_after_transaction")
+ or 0
+ )
@frappe.whitelist()
def get_procedure_consumables(procedure_template):
- return get_items('Clinical Procedure Item', procedure_template, 'Clinical Procedure Template')
+ return get_items("Clinical Procedure Item", procedure_template, "Clinical Procedure Template")
@frappe.whitelist()
def set_stock_items(doc, stock_detail_parent, parenttype):
- items = get_items('Clinical Procedure Item', stock_detail_parent, parenttype)
+ items = get_items("Clinical Procedure Item", stock_detail_parent, parenttype)
for item in items:
- se_child = doc.append('items')
+ se_child = doc.append("items")
se_child.item_code = item.item_code
se_child.item_name = item.item_name
se_child.uom = item.uom
@@ -178,32 +196,31 @@ def set_stock_items(doc, stock_detail_parent, parenttype):
se_child.conversion_factor = flt(item.conversion_factor)
if item.batch_no:
se_child.batch_no = item.batch_no
- if parenttype == 'Clinical Procedure Template':
+ if parenttype == "Clinical Procedure Template":
se_child.invoice_separately_as_consumables = item.invoice_separately_as_consumables
return doc
def get_items(table, parent, parenttype):
- items = frappe.db.get_all(table, filters={
- 'parent': parent,
- 'parenttype': parenttype
- }, fields=['*'])
+ items = frappe.db.get_all(
+ table, filters={"parent": parent, "parenttype": parenttype}, fields=["*"]
+ )
return items
@frappe.whitelist()
def make_stock_entry(doc):
- stock_entry = frappe.new_doc('Stock Entry')
- stock_entry = set_stock_items(stock_entry, doc.name, 'Clinical Procedure')
- stock_entry.stock_entry_type = 'Material Issue'
+ stock_entry = frappe.new_doc("Stock Entry")
+ stock_entry = set_stock_items(stock_entry, doc.name, "Clinical Procedure")
+ stock_entry.stock_entry_type = "Material Issue"
stock_entry.from_warehouse = doc.warehouse
stock_entry.company = doc.company
- expense_account = get_account(None, 'expense_account', 'Healthcare Settings', doc.company)
+ expense_account = get_account(None, "expense_account", "Healthcare Settings", doc.company)
for item_line in stock_entry.items:
- cost_center = frappe.get_cached_value('Company', doc.company, 'cost_center')
+ cost_center = frappe.get_cached_value("Company", doc.company, "cost_center")
item_line.cost_center = cost_center
item_line.expense_account = expense_account
@@ -215,39 +232,47 @@ def make_stock_entry(doc):
@frappe.whitelist()
def make_procedure(source_name, target_doc=None):
def set_missing_values(source, target):
- consume_stock = frappe.db.get_value('Clinical Procedure Template', source.procedure_template, 'consume_stock')
+ consume_stock = frappe.db.get_value(
+ "Clinical Procedure Template", source.procedure_template, "consume_stock"
+ )
if consume_stock:
target.consume_stock = 1
warehouse = None
if source.service_unit:
- warehouse = frappe.db.get_value('Healthcare Service Unit', source.service_unit, 'warehouse')
+ warehouse = frappe.db.get_value("Healthcare Service Unit", source.service_unit, "warehouse")
if not warehouse:
- warehouse = frappe.db.get_value('Stock Settings', None, 'default_warehouse')
+ warehouse = frappe.db.get_value("Stock Settings", None, "default_warehouse")
if warehouse:
target.warehouse = warehouse
- set_stock_items(target, source.procedure_template, 'Clinical Procedure Template')
+ set_stock_items(target, source.procedure_template, "Clinical Procedure Template")
- doc = get_mapped_doc('Patient Appointment', source_name, {
- 'Patient Appointment': {
- 'doctype': 'Clinical Procedure',
- 'field_map': [
- ['appointment', 'name'],
- ['patient', 'patient'],
- ['patient_age', 'patient_age'],
- ['patient_sex', 'patient_sex'],
- ['procedure_template', 'procedure_template'],
- ['prescription', 'procedure_prescription'],
- ['practitioner', 'practitioner'],
- ['medical_department', 'department'],
- ['start_date', 'appointment_date'],
- ['start_time', 'appointment_time'],
- ['notes', 'notes'],
- ['service_unit', 'service_unit'],
- ['company', 'company'],
- ['invoiced', 'invoiced']
- ]
+ doc = get_mapped_doc(
+ "Patient Appointment",
+ source_name,
+ {
+ "Patient Appointment": {
+ "doctype": "Clinical Procedure",
+ "field_map": [
+ ["appointment", "name"],
+ ["patient", "patient"],
+ ["patient_age", "patient_age"],
+ ["patient_sex", "patient_sex"],
+ ["procedure_template", "procedure_template"],
+ ["prescription", "procedure_prescription"],
+ ["practitioner", "practitioner"],
+ ["medical_department", "department"],
+ ["start_date", "appointment_date"],
+ ["start_time", "appointment_time"],
+ ["notes", "notes"],
+ ["service_unit", "service_unit"],
+ ["company", "company"],
+ ["invoiced", "invoiced"],
+ ],
}
- }, target_doc, set_missing_values)
+ },
+ target_doc,
+ set_missing_values,
+ )
return doc
diff --git a/erpnext/healthcare/doctype/clinical_procedure/test_clinical_procedure.py b/erpnext/healthcare/doctype/clinical_procedure/test_clinical_procedure.py
index 76a958ecc3a..a241ba7a401 100644
--- a/erpnext/healthcare/doctype/clinical_procedure/test_clinical_procedure.py
+++ b/erpnext/healthcare/doctype/clinical_procedure/test_clinical_procedure.py
@@ -1,4 +1,4 @@
- # -*- coding: utf-8 -*-
+# -*- coding: utf-8 -*-
# Copyright (c) 2017, ESS LLP and Contributors
# See license.txt
@@ -11,54 +11,59 @@ from erpnext.healthcare.doctype.patient_appointment.test_patient_appointment imp
create_healthcare_docs,
)
-test_dependencies = ['Item']
+test_dependencies = ["Item"]
+
class TestClinicalProcedure(unittest.TestCase):
def test_procedure_template_item(self):
patient, practitioner = create_healthcare_docs()
procedure_template = create_clinical_procedure_template()
- self.assertTrue(frappe.db.exists('Item', procedure_template.item))
+ self.assertTrue(frappe.db.exists("Item", procedure_template.item))
procedure_template.disabled = 1
procedure_template.save()
- self.assertEqual(frappe.db.get_value('Item', procedure_template.item, 'disabled'), 1)
+ self.assertEqual(frappe.db.get_value("Item", procedure_template.item, "disabled"), 1)
def test_consumables(self):
patient, practitioner = create_healthcare_docs()
procedure_template = create_clinical_procedure_template()
procedure_template.allow_stock_consumption = 1
consumable = create_consumable()
- procedure_template.append('items', {
- 'item_code': consumable.item_code,
- 'qty': 1,
- 'uom': consumable.stock_uom,
- 'stock_uom': consumable.stock_uom
- })
+ procedure_template.append(
+ "items",
+ {
+ "item_code": consumable.item_code,
+ "qty": 1,
+ "uom": consumable.stock_uom,
+ "stock_uom": consumable.stock_uom,
+ },
+ )
procedure_template.save()
procedure = create_procedure(procedure_template, patient, practitioner)
result = procedure.start_procedure()
- if result == 'insufficient stock':
+ if result == "insufficient stock":
procedure.make_material_receipt(submit=True)
result = procedure.start_procedure()
- self.assertEqual(procedure.status, 'In Progress')
+ self.assertEqual(procedure.status, "In Progress")
result = procedure.complete_procedure()
# check consumption
- self.assertTrue(frappe.db.exists('Stock Entry', result))
+ self.assertTrue(frappe.db.exists("Stock Entry", result))
def create_consumable():
- if frappe.db.exists('Item', 'Syringe'):
- return frappe.get_doc('Item', 'Syringe')
- consumable = frappe.new_doc('Item')
- consumable.item_code = 'Syringe'
- consumable.item_group = '_Test Item Group'
- consumable.stock_uom = 'Nos'
+ if frappe.db.exists("Item", "Syringe"):
+ return frappe.get_doc("Item", "Syringe")
+ consumable = frappe.new_doc("Item")
+ consumable.item_code = "Syringe"
+ consumable.item_group = "_Test Item Group"
+ consumable.stock_uom = "Nos"
consumable.valuation_rate = 5.00
consumable.save()
return consumable
+
def create_procedure(procedure_template, patient, practitioner):
- procedure = frappe.new_doc('Clinical Procedure')
+ procedure = frappe.new_doc("Clinical Procedure")
procedure.procedure_template = procedure_template.name
procedure.patient = patient
procedure.practitioner = practitioner
diff --git a/erpnext/healthcare/doctype/clinical_procedure_template/clinical_procedure_template.py b/erpnext/healthcare/doctype/clinical_procedure_template/clinical_procedure_template.py
index 5104eaacb23..bfe4e75d4c9 100644
--- a/erpnext/healthcare/doctype/clinical_procedure_template/clinical_procedure_template.py
+++ b/erpnext/healthcare/doctype/clinical_procedure_template/clinical_procedure_template.py
@@ -24,13 +24,13 @@ class ClinicalProcedureTemplate(Document):
def enable_disable_item(self):
if self.is_billable:
if self.disabled:
- frappe.db.set_value('Item', self.item, 'disabled', 1)
+ frappe.db.set_value("Item", self.item, "disabled", 1)
else:
- frappe.db.set_value('Item', self.item, 'disabled', 0)
+ frappe.db.set_value("Item", self.item, "disabled", 0)
def update_item_and_item_price(self):
if self.is_billable and self.item:
- item_doc = frappe.get_doc('Item', {'item_code': self.item})
+ item_doc = frappe.get_doc("Item", {"item_code": self.item})
item_doc.item_name = self.template
item_doc.item_group = self.item_group
item_doc.description = self.description
@@ -38,15 +38,15 @@ class ClinicalProcedureTemplate(Document):
item_doc.save(ignore_permissions=True)
if self.rate:
- item_price = frappe.get_doc('Item Price', {'item_code': self.item})
+ item_price = frappe.get_doc("Item Price", {"item_code": self.item})
item_price.item_name = self.template
item_price.price_list_rate = self.rate
item_price.save()
elif not self.is_billable and self.item:
- frappe.db.set_value('Item', self.item, 'disabled', 1)
+ frappe.db.set_value("Item", self.item, "disabled", 1)
- self.db_set('change_in_item', 0)
+ self.db_set("change_in_item", 0)
@frappe.whitelist()
@@ -54,69 +54,72 @@ def get_item_details(args=None):
if not isinstance(args, dict):
args = json.loads(args)
- item = frappe.db.get_all('Item',
- filters={
- 'disabled': 0,
- 'name': args.get('item_code')
- },
- fields=['stock_uom', 'item_name']
+ item = frappe.db.get_all(
+ "Item", filters={"disabled": 0, "name": args.get("item_code")}, fields=["stock_uom", "item_name"]
)
if not item:
- frappe.throw(_('Item {0} is not active').format(args.get('item_code')))
+ frappe.throw(_("Item {0} is not active").format(args.get("item_code")))
item = item[0]
ret = {
- 'uom': item.stock_uom,
- 'stock_uom': item.stock_uom,
- 'item_name': item.item_name,
- 'qty': 1,
- 'transfer_qty': 0,
- 'conversion_factor': 1
+ "uom": item.stock_uom,
+ "stock_uom": item.stock_uom,
+ "item_name": item.item_name,
+ "qty": 1,
+ "transfer_qty": 0,
+ "conversion_factor": 1,
}
return ret
+
def create_item_from_template(doc):
disabled = doc.disabled
if doc.is_billable and not doc.disabled:
disabled = 0
- uom = frappe.db.exists('UOM', 'Unit') or frappe.db.get_single_value('Stock Settings', 'stock_uom')
- item = frappe.get_doc({
- 'doctype': 'Item',
- 'item_code': doc.template,
- 'item_name':doc.template,
- 'item_group': doc.item_group,
- 'description':doc.description,
- 'is_sales_item': 1,
- 'is_service_item': 1,
- 'is_purchase_item': 0,
- 'is_stock_item': 0,
- 'show_in_website': 0,
- 'is_pro_applicable': 0,
- 'disabled': disabled,
- 'stock_uom': uom
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ uom = frappe.db.exists("UOM", "Unit") or frappe.db.get_single_value("Stock Settings", "stock_uom")
+ item = frappe.get_doc(
+ {
+ "doctype": "Item",
+ "item_code": doc.template,
+ "item_name": doc.template,
+ "item_group": doc.item_group,
+ "description": doc.description,
+ "is_sales_item": 1,
+ "is_service_item": 1,
+ "is_purchase_item": 0,
+ "is_stock_item": 0,
+ "show_in_website": 0,
+ "is_pro_applicable": 0,
+ "disabled": disabled,
+ "stock_uom": uom,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
make_item_price(item.name, doc.rate)
- doc.db_set('item', item.name)
+ doc.db_set("item", item.name)
+
def make_item_price(item, item_price):
- price_list_name = frappe.db.get_value('Price List', {'selling': 1})
- frappe.get_doc({
- 'doctype': 'Item Price',
- 'price_list': price_list_name,
- 'item_code': item,
- 'price_list_rate': item_price
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ price_list_name = frappe.db.get_value("Price List", {"selling": 1})
+ frappe.get_doc(
+ {
+ "doctype": "Item Price",
+ "price_list": price_list_name,
+ "item_code": item,
+ "price_list_rate": item_price,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
+
@frappe.whitelist()
def change_item_code_from_template(item_code, doc):
doc = frappe._dict(json.loads(doc))
- if frappe.db.exists('Item', {'item_code': item_code}):
- frappe.throw(_('Item with Item Code {0} already exists').format(item_code))
+ if frappe.db.exists("Item", {"item_code": item_code}):
+ frappe.throw(_("Item with Item Code {0} already exists").format(item_code))
else:
- rename_doc('Item', doc.item_code, item_code, ignore_permissions=True)
- frappe.db.set_value('Clinical Procedure Template', doc.name, 'item_code', item_code)
+ rename_doc("Item", doc.item_code, item_code, ignore_permissions=True)
+ frappe.db.set_value("Clinical Procedure Template", doc.name, "item_code", item_code)
return
diff --git a/erpnext/healthcare/doctype/clinical_procedure_template/clinical_procedure_template_dashboard.py b/erpnext/healthcare/doctype/clinical_procedure_template/clinical_procedure_template_dashboard.py
index e82855201ad..bc16756695a 100644
--- a/erpnext/healthcare/doctype/clinical_procedure_template/clinical_procedure_template_dashboard.py
+++ b/erpnext/healthcare/doctype/clinical_procedure_template/clinical_procedure_template_dashboard.py
@@ -1,14 +1,8 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'procedure_template',
- 'transactions': [
- {
- 'label': _('Consultations'),
- 'items': ['Clinical Procedure']
- }
- ]
+ "fieldname": "procedure_template",
+ "transactions": [{"label": _("Consultations"), "items": ["Clinical Procedure"]}],
}
diff --git a/erpnext/healthcare/doctype/diagnosis/test_diagnosis.py b/erpnext/healthcare/doctype/diagnosis/test_diagnosis.py
index ff9fdba76ab..3a6a3af313d 100644
--- a/erpnext/healthcare/doctype/diagnosis/test_diagnosis.py
+++ b/erpnext/healthcare/doctype/diagnosis/test_diagnosis.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Diagnosis')
+
class TestDiagnosis(unittest.TestCase):
pass
diff --git a/erpnext/healthcare/doctype/drug_prescription/drug_prescription.py b/erpnext/healthcare/doctype/drug_prescription/drug_prescription.py
index 7ae5b2322db..de3b34b1d57 100755
--- a/erpnext/healthcare/doctype/drug_prescription/drug_prescription.py
+++ b/erpnext/healthcare/doctype/drug_prescription/drug_prescription.py
@@ -13,21 +13,21 @@ class DrugPrescription(Document):
period = None
if self.dosage:
- dosage = frappe.get_doc('Prescription Dosage', self.dosage)
+ dosage = frappe.get_doc("Prescription Dosage", self.dosage)
for item in dosage.dosage_strength:
quantity += item.strength
if self.period and self.interval:
- period = frappe.get_doc('Prescription Duration', self.period)
+ period = frappe.get_doc("Prescription Duration", self.period)
if self.interval < period.get_days():
- quantity = quantity * (period.get_days()/self.interval)
+ quantity = quantity * (period.get_days() / self.interval)
elif self.interval and self.interval_uom and self.period:
- period = frappe.get_doc('Prescription Duration', self.period)
+ period = frappe.get_doc("Prescription Duration", self.period)
interval_in = self.interval_uom
- if interval_in == 'Day' and self.interval < period.get_days():
- quantity = period.get_days()/self.interval
- elif interval_in == 'Hour' and self.interval < period.get_hours():
- quantity = period.get_hours()/self.interval
+ if interval_in == "Day" and self.interval < period.get_days():
+ quantity = period.get_days() / self.interval
+ elif interval_in == "Hour" and self.interval < period.get_hours():
+ quantity = period.get_hours() / self.interval
if quantity > 0:
return quantity
else:
diff --git a/erpnext/healthcare/doctype/exercise_type/exercise_type.py b/erpnext/healthcare/doctype/exercise_type/exercise_type.py
index b76a3ca37a9..e789d042ebd 100644
--- a/erpnext/healthcare/doctype/exercise_type/exercise_type.py
+++ b/erpnext/healthcare/doctype/exercise_type/exercise_type.py
@@ -9,6 +9,6 @@ from frappe.model.document import Document
class ExerciseType(Document):
def autoname(self):
if self.difficulty_level:
- self.name = ' - '.join(filter(None, [self.exercise_name, self.difficulty_level]))
+ self.name = " - ".join(filter(None, [self.exercise_name, self.difficulty_level]))
else:
self.name = self.exercise_name
diff --git a/erpnext/healthcare/doctype/fee_validity/fee_validity.py b/erpnext/healthcare/doctype/fee_validity/fee_validity.py
index 0274e6ac4f9..1b66266fac0 100644
--- a/erpnext/healthcare/doctype/fee_validity/fee_validity.py
+++ b/erpnext/healthcare/doctype/fee_validity/fee_validity.py
@@ -15,40 +15,45 @@ class FeeValidity(Document):
def update_status(self):
if self.visited >= self.max_visits:
- self.status = 'Completed'
+ self.status = "Completed"
else:
- self.status = 'Pending'
+ self.status = "Pending"
def create_fee_validity(appointment):
if not check_is_new_patient(appointment):
return
- fee_validity = frappe.new_doc('Fee Validity')
+ fee_validity = frappe.new_doc("Fee Validity")
fee_validity.practitioner = appointment.practitioner
fee_validity.patient = appointment.patient
- fee_validity.max_visits = frappe.db.get_single_value('Healthcare Settings', 'max_visits') or 1
- valid_days = frappe.db.get_single_value('Healthcare Settings', 'valid_days') or 1
+ fee_validity.max_visits = frappe.db.get_single_value("Healthcare Settings", "max_visits") or 1
+ valid_days = frappe.db.get_single_value("Healthcare Settings", "valid_days") or 1
fee_validity.visited = 0
fee_validity.start_date = getdate(appointment.appointment_date)
- fee_validity.valid_till = getdate(appointment.appointment_date) + datetime.timedelta(days=int(valid_days))
+ fee_validity.valid_till = getdate(appointment.appointment_date) + datetime.timedelta(
+ days=int(valid_days)
+ )
fee_validity.save(ignore_permissions=True)
return fee_validity
+
def check_is_new_patient(appointment):
- validity_exists = frappe.db.exists('Fee Validity', {
- 'practitioner': appointment.practitioner,
- 'patient': appointment.patient
- })
+ validity_exists = frappe.db.exists(
+ "Fee Validity", {"practitioner": appointment.practitioner, "patient": appointment.patient}
+ )
if validity_exists:
return False
- appointment_exists = frappe.db.get_all('Patient Appointment', {
- 'name': ('!=', appointment.name),
- 'status': ('!=', 'Cancelled'),
- 'patient': appointment.patient,
- 'practitioner': appointment.practitioner
- })
+ appointment_exists = frappe.db.get_all(
+ "Patient Appointment",
+ {
+ "name": ("!=", appointment.name),
+ "status": ("!=", "Cancelled"),
+ "patient": appointment.patient,
+ "practitioner": appointment.practitioner,
+ },
+ )
if len(appointment_exists) and appointment_exists[0]:
return False
return True
diff --git a/erpnext/healthcare/doctype/fee_validity/test_fee_validity.py b/erpnext/healthcare/doctype/fee_validity/test_fee_validity.py
index 7eafc8dfe79..c720139c474 100644
--- a/erpnext/healthcare/doctype/fee_validity/test_fee_validity.py
+++ b/erpnext/healthcare/doctype/fee_validity/test_fee_validity.py
@@ -15,6 +15,7 @@ from erpnext.healthcare.doctype.patient_appointment.test_patient_appointment imp
test_dependencies = ["Company"]
+
class TestFeeValidity(unittest.TestCase):
def setUp(self):
frappe.db.sql("""delete from `tabPatient Appointment`""")
diff --git a/erpnext/healthcare/doctype/healthcare.py b/erpnext/healthcare/doctype/healthcare.py
index 87e208289c9..5ff63b9a581 100644
--- a/erpnext/healthcare/doctype/healthcare.py
+++ b/erpnext/healthcare/doctype/healthcare.py
@@ -1,5 +1,3 @@
-
-
def get_data():
return []
diff --git a/erpnext/healthcare/doctype/healthcare_practitioner/healthcare_practitioner.py b/erpnext/healthcare/doctype/healthcare_practitioner/healthcare_practitioner.py
index ba1c557f14e..52e12725818 100644
--- a/erpnext/healthcare/doctype/healthcare_practitioner/healthcare_practitioner.py
+++ b/erpnext/healthcare/doctype/healthcare_practitioner/healthcare_practitioner.py
@@ -22,71 +22,87 @@ class HealthcarePractitioner(Document):
# concat first and last name
self.name = self.practitioner_name
- if frappe.db.exists('Healthcare Practitioner', self.name):
- self.name = append_number_if_name_exists('Contact', self.name)
+ if frappe.db.exists("Healthcare Practitioner", self.name):
+ self.name = append_number_if_name_exists("Contact", self.name)
def validate(self):
self.set_full_name()
validate_party_accounts(self)
if self.inpatient_visit_charge_item:
- validate_service_item(self.inpatient_visit_charge_item, 'Configure a service Item for Inpatient Consulting Charge Item')
+ validate_service_item(
+ self.inpatient_visit_charge_item,
+ "Configure a service Item for Inpatient Consulting Charge Item",
+ )
if self.op_consulting_charge_item:
- validate_service_item(self.op_consulting_charge_item, 'Configure a service Item for Out Patient Consulting Charge Item')
+ validate_service_item(
+ self.op_consulting_charge_item,
+ "Configure a service Item for Out Patient Consulting Charge Item",
+ )
if self.user_id:
self.validate_user_id()
else:
- existing_user_id = frappe.db.get_value('Healthcare Practitioner', self.name, 'user_id')
+ existing_user_id = frappe.db.get_value("Healthcare Practitioner", self.name, "user_id")
if existing_user_id:
frappe.permissions.remove_user_permission(
- 'Healthcare Practitioner', self.name, existing_user_id)
+ "Healthcare Practitioner", self.name, existing_user_id
+ )
def on_update(self):
if self.user_id:
- frappe.permissions.add_user_permission('Healthcare Practitioner', self.name, self.user_id)
+ frappe.permissions.add_user_permission("Healthcare Practitioner", self.name, self.user_id)
def set_full_name(self):
if self.last_name:
- self.practitioner_name = ' '.join(filter(None, [self.first_name, self.last_name]))
+ self.practitioner_name = " ".join(filter(None, [self.first_name, self.last_name]))
else:
self.practitioner_name = self.first_name
def validate_user_id(self):
- if not frappe.db.exists('User', self.user_id):
- frappe.throw(_('User {0} does not exist').format(self.user_id))
- elif not frappe.db.exists('User', self.user_id, 'enabled'):
- frappe.throw(_('User {0} is disabled').format(self.user_id))
+ if not frappe.db.exists("User", self.user_id):
+ frappe.throw(_("User {0} does not exist").format(self.user_id))
+ elif not frappe.db.exists("User", self.user_id, "enabled"):
+ frappe.throw(_("User {0} is disabled").format(self.user_id))
# check duplicate
- practitioner = frappe.db.exists('Healthcare Practitioner', {
- 'user_id': self.user_id,
- 'name': ('!=', self.name)
- })
+ practitioner = frappe.db.exists(
+ "Healthcare Practitioner", {"user_id": self.user_id, "name": ("!=", self.name)}
+ )
if practitioner:
- frappe.throw(_('User {0} is already assigned to Healthcare Practitioner {1}').format(
- self.user_id, practitioner))
+ frappe.throw(
+ _("User {0} is already assigned to Healthcare Practitioner {1}").format(
+ self.user_id, practitioner
+ )
+ )
def on_trash(self):
- delete_contact_and_address('Healthcare Practitioner', self.name)
+ delete_contact_and_address("Healthcare Practitioner", self.name)
+
def validate_service_item(item, msg):
- if frappe.db.get_value('Item', item, 'is_stock_item'):
+ if frappe.db.get_value("Item", item, "is_stock_item"):
frappe.throw(_(msg))
+
@frappe.whitelist()
@frappe.validate_and_sanitize_search_inputs
def get_practitioner_list(doctype, txt, searchfield, start, page_len, filters=None):
- active_filter = {'status': 'Active'}
+ active_filter = {"status": "Active"}
filters = {**active_filter, **filters} if filters else active_filter
- fields = ['name', 'practitioner_name', 'mobile_phone']
+ fields = ["name", "practitioner_name", "mobile_phone"]
- text_in = {
- 'name': ('like', '%%%s%%' % txt),
- 'practitioner_name': ('like', '%%%s%%' % txt)
- }
+ text_in = {"name": ("like", "%%%s%%" % txt), "practitioner_name": ("like", "%%%s%%" % txt)}
- return frappe.get_all('Healthcare Practitioner', fields = fields,
- filters = filters, or_filters = text_in, start=start, page_length=page_len, order_by='name, practitioner_name', as_list=1)
+ return frappe.get_all(
+ "Healthcare Practitioner",
+ fields=fields,
+ filters=filters,
+ or_filters=text_in,
+ start=start,
+ page_length=page_len,
+ order_by="name, practitioner_name",
+ as_list=1,
+ )
diff --git a/erpnext/healthcare/doctype/healthcare_practitioner/healthcare_practitioner_dashboard.py b/erpnext/healthcare/doctype/healthcare_practitioner/healthcare_practitioner_dashboard.py
index e41284b4727..ba6b86bb892 100644
--- a/erpnext/healthcare/doctype/healthcare_practitioner/healthcare_practitioner_dashboard.py
+++ b/erpnext/healthcare/doctype/healthcare_practitioner/healthcare_practitioner_dashboard.py
@@ -1,20 +1,16 @@
-
from frappe import _
def get_data():
return {
- 'heatmap': True,
- 'heatmap_message': _('This is based on transactions against this Healthcare Practitioner.'),
- 'fieldname': 'practitioner',
- 'transactions': [
+ "heatmap": True,
+ "heatmap_message": _("This is based on transactions against this Healthcare Practitioner."),
+ "fieldname": "practitioner",
+ "transactions": [
{
- 'label': _('Appointments and Patient Encounters'),
- 'items': ['Patient Appointment', 'Patient Encounter', 'Fee Validity']
+ "label": _("Appointments and Patient Encounters"),
+ "items": ["Patient Appointment", "Patient Encounter", "Fee Validity"],
},
- {
- 'label': _('Consultation'),
- 'items': ['Clinical Procedure', 'Lab Test']
- }
- ]
+ {"label": _("Consultation"), "items": ["Clinical Procedure", "Lab Test"]},
+ ],
}
diff --git a/erpnext/healthcare/doctype/healthcare_service_unit/healthcare_service_unit.json b/erpnext/healthcare/doctype/healthcare_service_unit/healthcare_service_unit.json
index 8935ec7d3c9..9366b09d27e 100644
--- a/erpnext/healthcare/doctype/healthcare_service_unit/healthcare_service_unit.json
+++ b/erpnext/healthcare/doctype/healthcare_service_unit/healthcare_service_unit.json
@@ -2,7 +2,6 @@
"actions": [],
"allow_import": 1,
"allow_rename": 1,
- "autoname": "field:healthcare_service_unit_name",
"beta": 1,
"creation": "2016-09-21 13:48:14.731437",
"description": "Healthcare Service Unit",
@@ -207,7 +206,7 @@
],
"is_tree": 1,
"links": [],
- "modified": "2021-08-19 14:09:11.643464",
+ "modified": "2022-04-07 03:11:36.023277",
"modified_by": "Administrator",
"module": "Healthcare",
"name": "Healthcare Service Unit",
diff --git a/erpnext/healthcare/doctype/healthcare_service_unit/healthcare_service_unit.py b/erpnext/healthcare/doctype/healthcare_service_unit/healthcare_service_unit.py
index 6eeceacbc9e..1a6aed46730 100644
--- a/erpnext/healthcare/doctype/healthcare_service_unit/healthcare_service_unit.py
+++ b/erpnext/healthcare/doctype/healthcare_service_unit/healthcare_service_unit.py
@@ -11,14 +11,14 @@ from frappe.utils.nestedset import NestedSet
class HealthcareServiceUnit(NestedSet):
- nsm_parent_field = 'parent_healthcare_service_unit'
+ nsm_parent_field = "parent_healthcare_service_unit"
def validate(self):
self.set_service_unit_properties()
def autoname(self):
if self.company:
- suffix = " - " + frappe.get_cached_value('Company', self.company, 'abbr')
+ suffix = " - " + frappe.get_cached_value("Company", self.company, "abbr")
if not self.healthcare_service_unit_name.endswith(suffix):
self.name = self.healthcare_service_unit_name + suffix
else:
@@ -34,15 +34,15 @@ class HealthcareServiceUnit(NestedSet):
self.overlap_appointments = False
self.inpatient_occupancy = False
self.service_unit_capacity = 0
- self.occupancy_status = ''
- self.service_unit_type = ''
- elif self.service_unit_type != '':
- service_unit_type = frappe.get_doc('Healthcare Service Unit Type', self.service_unit_type)
+ self.occupancy_status = ""
+ self.service_unit_type = ""
+ elif self.service_unit_type != "":
+ service_unit_type = frappe.get_doc("Healthcare Service Unit Type", self.service_unit_type)
self.allow_appointments = service_unit_type.allow_appointments
self.inpatient_occupancy = service_unit_type.inpatient_occupancy
- if self.inpatient_occupancy and self.occupancy_status != '':
- self.occupancy_status = 'Vacant'
+ if self.inpatient_occupancy and self.occupancy_status != "":
+ self.occupancy_status = "Vacant"
if service_unit_type.overlap_appointments:
self.overlap_appointments = True
@@ -52,62 +52,78 @@ class HealthcareServiceUnit(NestedSet):
if self.overlap_appointments:
if not self.service_unit_capacity:
- frappe.throw(_('Please set a valid Service Unit Capacity to enable Overlapping Appointments'),
- title=_('Mandatory'))
+ frappe.throw(
+ _("Please set a valid Service Unit Capacity to enable Overlapping Appointments"),
+ title=_("Mandatory"),
+ )
@frappe.whitelist()
def add_multiple_service_units(parent, data):
- '''
+ """
parent - parent service unit under which the service units are to be created
data (dict) - company, healthcare_service_unit_name, count, service_unit_type, warehouse, service_unit_capacity
- '''
+ """
if not parent or not data:
return
data = json.loads(data)
- company = data.get('company') or \
- frappe.defaults.get_defaults().get('company') or \
- frappe.db.get_single_value('Global Defaults', 'default_company')
+ company = (
+ data.get("company")
+ or frappe.defaults.get_defaults().get("company")
+ or frappe.db.get_single_value("Global Defaults", "default_company")
+ )
- if not data.get('healthcare_service_unit_name') or not company:
- frappe.throw(_('Service Unit Name and Company are mandatory to create Healthcare Service Units'),
- title=_('Missing Required Fields'))
+ if not data.get("healthcare_service_unit_name") or not company:
+ frappe.throw(
+ _("Service Unit Name and Company are mandatory to create Healthcare Service Units"),
+ title=_("Missing Required Fields"),
+ )
- count = cint(data.get('count') or 0)
+ count = cint(data.get("count") or 0)
if count <= 0:
- frappe.throw(_('Number of Service Units to be created should at least be 1'),
- title=_('Invalid Number of Service Units'))
+ frappe.throw(
+ _("Number of Service Units to be created should at least be 1"),
+ title=_("Invalid Number of Service Units"),
+ )
- capacity = cint(data.get('service_unit_capacity') or 1)
+ capacity = cint(data.get("service_unit_capacity") or 1)
service_unit = {
- 'doctype': 'Healthcare Service Unit',
- 'parent_healthcare_service_unit': parent,
- 'service_unit_type': data.get('service_unit_type') or None,
- 'service_unit_capacity': capacity if capacity > 0 else 1,
- 'warehouse': data.get('warehouse') or None,
- 'company': company
+ "doctype": "Healthcare Service Unit",
+ "parent_healthcare_service_unit": parent,
+ "service_unit_type": data.get("service_unit_type") or None,
+ "service_unit_capacity": capacity if capacity > 0 else 1,
+ "warehouse": data.get("warehouse") or None,
+ "company": company,
}
- service_unit_name = '{}'.format(data.get('healthcare_service_unit_name').strip(' -'))
+ service_unit_name = "{}".format(data.get("healthcare_service_unit_name").strip(" -"))
- last_suffix = frappe.db.sql("""SELECT
+ last_suffix = frappe.db.sql(
+ """SELECT
IFNULL(MAX(CAST(SUBSTRING(name FROM %(start)s FOR 4) AS UNSIGNED)), 0)
FROM `tabHealthcare Service Unit`
WHERE name like %(prefix)s AND company=%(company)s""",
- {'start': len(service_unit_name)+2, 'prefix': '{}-%'.format(service_unit_name), 'company': company},
- as_list=1)[0][0]
+ {
+ "start": len(service_unit_name) + 2,
+ "prefix": "{}-%".format(service_unit_name),
+ "company": company,
+ },
+ as_list=1,
+ )[0][0]
start_suffix = cint(last_suffix) + 1
failed_list = []
for i in range(start_suffix, count + start_suffix):
# name to be in the form WARD-####
- service_unit['healthcare_service_unit_name'] = '{}-{}'.format(service_unit_name, cstr('%0*d' % (4, i)))
+ service_unit["healthcare_service_unit_name"] = "{}-{}".format(
+ service_unit_name, cstr("%0*d" % (4, i))
+ )
service_unit_doc = frappe.get_doc(service_unit)
try:
service_unit_doc.insert()
except Exception:
- failed_list.append(service_unit['healthcare_service_unit_name'])
+ failed_list.append(service_unit["healthcare_service_unit_name"])
return failed_list
diff --git a/erpnext/healthcare/doctype/healthcare_service_unit_type/healthcare_service_unit_type.py b/erpnext/healthcare/doctype/healthcare_service_unit_type/healthcare_service_unit_type.py
index 1db6b66c44b..f95036d82f8 100644
--- a/erpnext/healthcare/doctype/healthcare_service_unit_type/healthcare_service_unit_type.py
+++ b/erpnext/healthcare/doctype/healthcare_service_unit_type/healthcare_service_unit_type.py
@@ -12,15 +12,21 @@ class HealthcareServiceUnitType(Document):
def validate(self):
if self.allow_appointments and self.inpatient_occupancy:
frappe.msgprint(
- _('Healthcare Service Unit Type cannot have both {0} and {1}').format(
- frappe.bold('Allow Appointments'), frappe.bold('Inpatient Occupancy')),
- raise_exception=1, title=_('Validation Error'), indicator='red'
+ _("Healthcare Service Unit Type cannot have both {0} and {1}").format(
+ frappe.bold("Allow Appointments"), frappe.bold("Inpatient Occupancy")
+ ),
+ raise_exception=1,
+ title=_("Validation Error"),
+ indicator="red",
)
elif not self.allow_appointments and not self.inpatient_occupancy:
frappe.msgprint(
- _('Healthcare Service Unit Type must allow atleast one among {0} and {1}').format(
- frappe.bold('Allow Appointments'), frappe.bold('Inpatient Occupancy')),
- raise_exception=1, title=_('Validation Error'), indicator='red'
+ _("Healthcare Service Unit Type must allow atleast one among {0} and {1}").format(
+ frappe.bold("Allow Appointments"), frappe.bold("Inpatient Occupancy")
+ ),
+ raise_exception=1,
+ title=_("Validation Error"),
+ indicator="red",
)
if not self.allow_appointments:
@@ -28,9 +34,9 @@ class HealthcareServiceUnitType(Document):
if self.is_billable:
if self.disabled:
- frappe.db.set_value('Item', self.item, 'disabled', 1)
+ frappe.db.set_value("Item", self.item, "disabled", 1)
else:
- frappe.db.set_value('Item', self.item, 'disabled', 0)
+ frappe.db.set_value("Item", self.item, "disabled", 0)
def after_insert(self):
if self.inpatient_occupancy and self.is_billable:
@@ -40,10 +46,10 @@ class HealthcareServiceUnitType(Document):
if self.item:
try:
item = self.item
- self.db_set('item', '')
- frappe.delete_doc('Item', item)
+ self.db_set("item", "")
+ frappe.delete_doc("Item", item)
except Exception:
- frappe.throw(_('Not permitted. Please disable the Service Unit Type'))
+ frappe.throw(_("Not permitted. Please disable the Service Unit Type"))
def on_update(self):
if self.change_in_item and self.is_billable and self.item:
@@ -52,47 +58,50 @@ class HealthcareServiceUnitType(Document):
item_price = item_price_exists(self)
if not item_price:
- price_list_name = frappe.db.get_value('Price List', {'selling': 1})
+ price_list_name = frappe.db.get_value("Price List", {"selling": 1})
if self.rate:
make_item_price(self.item_code, price_list_name, self.rate)
else:
make_item_price(self.item_code, price_list_name, 0.0)
else:
- frappe.db.set_value('Item Price', item_price, 'price_list_rate', self.rate)
+ frappe.db.set_value("Item Price", item_price, "price_list_rate", self.rate)
- frappe.db.set_value(self.doctype, self.name, 'change_in_item',0)
+ frappe.db.set_value(self.doctype, self.name, "change_in_item", 0)
elif not self.is_billable and self.item:
- frappe.db.set_value('Item', self.item, 'disabled', 1)
+ frappe.db.set_value("Item", self.item, "disabled", 1)
self.reload()
def item_price_exists(doc):
- item_price = frappe.db.exists({'doctype': 'Item Price', 'item_code': doc.item_code})
+ item_price = frappe.db.exists({"doctype": "Item Price", "item_code": doc.item_code})
if len(item_price):
return item_price[0][0]
return False
+
def create_item(doc):
# insert item
- item = frappe.get_doc({
- 'doctype': 'Item',
- 'item_code': doc.item_code,
- 'item_name': doc.service_unit_type,
- 'item_group': doc.item_group,
- 'description': doc.description or doc.item_code,
- 'is_sales_item': 1,
- 'is_service_item': 1,
- 'is_purchase_item': 0,
- 'is_stock_item': 0,
- 'show_in_website': 0,
- 'is_pro_applicable': 0,
- 'disabled': 0,
- 'stock_uom': doc.uom
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ item = frappe.get_doc(
+ {
+ "doctype": "Item",
+ "item_code": doc.item_code,
+ "item_name": doc.service_unit_type,
+ "item_group": doc.item_group,
+ "description": doc.description or doc.item_code,
+ "is_sales_item": 1,
+ "is_service_item": 1,
+ "is_purchase_item": 0,
+ "is_stock_item": 0,
+ "show_in_website": 0,
+ "is_pro_applicable": 0,
+ "disabled": 0,
+ "stock_uom": doc.uom,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
# insert item price
# get item price list to insert item price
- price_list_name = frappe.db.get_value('Price List', {'selling': 1})
+ price_list_name = frappe.db.get_value("Price List", {"selling": 1})
if doc.rate:
make_item_price(item.name, price_list_name, doc.rate)
item.standard_rate = doc.rate
@@ -103,32 +112,39 @@ def create_item(doc):
item.save(ignore_permissions=True)
# Set item in the doc
- doc.db_set('item', item.name)
+ doc.db_set("item", item.name)
+
def make_item_price(item, price_list_name, item_price):
- frappe.get_doc({
- 'doctype': 'Item Price',
- 'price_list': price_list_name,
- 'item_code': item,
- 'price_list_rate': item_price
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ frappe.get_doc(
+ {
+ "doctype": "Item Price",
+ "price_list": price_list_name,
+ "item_code": item,
+ "price_list_rate": item_price,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
+
def update_item(doc):
item = frappe.get_doc("Item", doc.item)
if item:
- item.update({
- "item_name": doc.service_unit_type,
- "item_group": doc.item_group,
- "disabled": 0,
- "standard_rate": doc.rate,
- "description": doc.description
- })
+ item.update(
+ {
+ "item_name": doc.service_unit_type,
+ "item_group": doc.item_group,
+ "disabled": 0,
+ "standard_rate": doc.rate,
+ "description": doc.description,
+ }
+ )
item.db_update()
+
@frappe.whitelist()
def change_item_code(item, item_code, doc_name):
- if frappe.db.exists({'doctype': 'Item', 'item_code': item_code}):
- frappe.throw(_('Item with Item Code {0} already exists').format(item_code))
+ if frappe.db.exists({"doctype": "Item", "item_code": item_code}):
+ frappe.throw(_("Item with Item Code {0} already exists").format(item_code))
else:
- rename_doc('Item', item, item_code, ignore_permissions=True)
- frappe.db.set_value('Healthcare Service Unit Type', doc_name, 'item_code', item_code)
+ rename_doc("Item", item, item_code, ignore_permissions=True)
+ frappe.db.set_value("Healthcare Service Unit Type", doc_name, "item_code", item_code)
diff --git a/erpnext/healthcare/doctype/healthcare_service_unit_type/healthcare_service_unit_type_dashboard.py b/erpnext/healthcare/doctype/healthcare_service_unit_type/healthcare_service_unit_type_dashboard.py
index a72bb6e6bc7..c14efb72121 100644
--- a/erpnext/healthcare/doctype/healthcare_service_unit_type/healthcare_service_unit_type_dashboard.py
+++ b/erpnext/healthcare/doctype/healthcare_service_unit_type/healthcare_service_unit_type_dashboard.py
@@ -1,14 +1,10 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'service_unit_type',
- 'transactions': [
- {
- 'label': _('Healthcare Service Units'),
- 'items': ['Healthcare Service Unit']
- },
- ]
+ "fieldname": "service_unit_type",
+ "transactions": [
+ {"label": _("Healthcare Service Units"), "items": ["Healthcare Service Unit"]},
+ ],
}
diff --git a/erpnext/healthcare/doctype/healthcare_service_unit_type/test_healthcare_service_unit_type.py b/erpnext/healthcare/doctype/healthcare_service_unit_type/test_healthcare_service_unit_type.py
index 2acd8a1c391..73f54d235f7 100644
--- a/erpnext/healthcare/doctype/healthcare_service_unit_type/test_healthcare_service_unit_type.py
+++ b/erpnext/healthcare/doctype/healthcare_service_unit_type/test_healthcare_service_unit_type.py
@@ -9,25 +9,25 @@ import frappe
class TestHealthcareServiceUnitType(unittest.TestCase):
def test_item_creation(self):
unit_type = get_unit_type()
- self.assertTrue(frappe.db.exists('Item', unit_type.item))
+ self.assertTrue(frappe.db.exists("Item", unit_type.item))
# check item disabled
unit_type.disabled = 1
unit_type.save()
- self.assertEqual(frappe.db.get_value('Item', unit_type.item, 'disabled'), 1)
+ self.assertEqual(frappe.db.get_value("Item", unit_type.item, "disabled"), 1)
def get_unit_type():
- if frappe.db.exists('Healthcare Service Unit Type', 'Inpatient Rooms'):
- return frappe.get_doc('Healthcare Service Unit Type', 'Inpatient Rooms')
+ if frappe.db.exists("Healthcare Service Unit Type", "Inpatient Rooms"):
+ return frappe.get_doc("Healthcare Service Unit Type", "Inpatient Rooms")
- unit_type = frappe.new_doc('Healthcare Service Unit Type')
- unit_type.service_unit_type = 'Inpatient Rooms'
+ unit_type = frappe.new_doc("Healthcare Service Unit Type")
+ unit_type.service_unit_type = "Inpatient Rooms"
unit_type.inpatient_occupancy = 1
unit_type.is_billable = 1
- unit_type.item_code = 'Inpatient Rooms'
- unit_type.item_group = 'Services'
- unit_type.uom = 'Hour'
+ unit_type.item_code = "Inpatient Rooms"
+ unit_type.item_group = "Services"
+ unit_type.uom = "Hour"
unit_type.no_of_hours = 1
unit_type.rate = 4000
unit_type.save()
diff --git a/erpnext/healthcare/doctype/healthcare_settings/healthcare_settings.py b/erpnext/healthcare/doctype/healthcare_settings/healthcare_settings.py
index 2a9792e874e..f8061e9dd15 100644
--- a/erpnext/healthcare/doctype/healthcare_settings/healthcare_settings.py
+++ b/erpnext/healthcare/doctype/healthcare_settings/healthcare_settings.py
@@ -12,13 +12,19 @@ from frappe.model.document import Document
class HealthcareSettings(Document):
def validate(self):
- for key in ['collect_registration_fee', 'link_customer_to_patient', 'patient_name_by',
- 'lab_test_approval_required', 'create_sample_collection_for_lab_test', 'default_medical_code_standard']:
+ for key in [
+ "collect_registration_fee",
+ "link_customer_to_patient",
+ "patient_name_by",
+ "lab_test_approval_required",
+ "create_sample_collection_for_lab_test",
+ "default_medical_code_standard",
+ ]:
frappe.db.set_default(key, self.get(key, ""))
if self.collect_registration_fee:
if self.registration_fee <= 0:
- frappe.throw(_('Registration Fee cannot be negative or zero'))
+ frappe.throw(_("Registration Fee cannot be negative or zero"))
if self.inpatient_visit_charge_item:
validate_service_item(self.inpatient_visit_charge_item)
@@ -29,63 +35,70 @@ class HealthcareSettings(Document):
def validate_service_item(item):
- if frappe.db.get_value('Item', item, 'is_stock_item'):
- frappe.throw(_('Configure a service Item for {0}').format(item))
+ if frappe.db.get_value("Item", item, "is_stock_item"):
+ frappe.throw(_("Configure a service Item for {0}").format(item))
+
@frappe.whitelist()
def get_sms_text(doc):
sms_text = {}
- doc = frappe.get_doc('Lab Test', doc)
- context = {'doc': doc, 'alert': doc, 'comments': None}
+ doc = frappe.get_doc("Lab Test", doc)
+ context = {"doc": doc, "alert": doc, "comments": None}
- emailed = frappe.db.get_value('Healthcare Settings', None, 'sms_emailed')
- sms_text['emailed'] = frappe.render_template(emailed, context)
+ emailed = frappe.db.get_value("Healthcare Settings", None, "sms_emailed")
+ sms_text["emailed"] = frappe.render_template(emailed, context)
- printed = frappe.db.get_value('Healthcare Settings', None, 'sms_printed')
- sms_text['printed'] = frappe.render_template(printed, context)
+ printed = frappe.db.get_value("Healthcare Settings", None, "sms_printed")
+ sms_text["printed"] = frappe.render_template(printed, context)
return sms_text
+
def send_registration_sms(doc):
- if frappe.db.get_single_value('Healthcare Settings', 'send_registration_msg'):
+ if frappe.db.get_single_value("Healthcare Settings", "send_registration_msg"):
if doc.mobile:
- context = {'doc': doc, 'alert': doc, 'comments': None}
- if doc.get('_comments'):
- context['comments'] = json.loads(doc.get('_comments'))
- messages = frappe.db.get_single_value('Healthcare Settings', 'registration_msg')
+ context = {"doc": doc, "alert": doc, "comments": None}
+ if doc.get("_comments"):
+ context["comments"] = json.loads(doc.get("_comments"))
+ messages = frappe.db.get_single_value("Healthcare Settings", "registration_msg")
messages = frappe.render_template(messages, context)
number = [doc.mobile]
- send_sms(number,messages)
+ send_sms(number, messages)
else:
- frappe.msgprint(doc.name + ' has no mobile number to send registration SMS', alert=True)
+ frappe.msgprint(doc.name + " has no mobile number to send registration SMS", alert=True)
+
def get_receivable_account(company):
- receivable_account = get_account(None, 'receivable_account', 'Healthcare Settings', company)
+ receivable_account = get_account(None, "receivable_account", "Healthcare Settings", company)
if receivable_account:
return receivable_account
- return frappe.get_cached_value('Company', company, 'default_receivable_account')
+ return frappe.get_cached_value("Company", company, "default_receivable_account")
+
def get_income_account(practitioner, company):
# check income account in Healthcare Practitioner
if practitioner:
- income_account = get_account('Healthcare Practitioner', None, practitioner, company)
+ income_account = get_account("Healthcare Practitioner", None, practitioner, company)
if income_account:
return income_account
# else check income account in Healthcare Settings
- income_account = get_account(None, 'income_account', 'Healthcare Settings', company)
+ income_account = get_account(None, "income_account", "Healthcare Settings", company)
if income_account:
return income_account
# else return default income account of company
- return frappe.get_cached_value('Company', company, 'default_income_account')
+ return frappe.get_cached_value("Company", company, "default_income_account")
+
def get_account(parent_type, parent_field, parent, company):
if parent_type:
- return frappe.db.get_value('Party Account',
- {'parenttype': parent_type, 'parent': parent, 'company': company}, 'account')
+ return frappe.db.get_value(
+ "Party Account", {"parenttype": parent_type, "parent": parent, "company": company}, "account"
+ )
if parent_field:
- return frappe.db.get_value('Party Account',
- {'parentfield': parent_field, 'parent': parent, 'company': company}, 'account')
+ return frappe.db.get_value(
+ "Party Account", {"parentfield": parent_field, "parent": parent, "company": company}, "account"
+ )
diff --git a/erpnext/healthcare/doctype/inpatient_medication_entry/inpatient_medication_entry.py b/erpnext/healthcare/doctype/inpatient_medication_entry/inpatient_medication_entry.py
index 3cd8cb42a77..d78a6d82155 100644
--- a/erpnext/healthcare/doctype/inpatient_medication_entry/inpatient_medication_entry.py
+++ b/erpnext/healthcare/doctype/inpatient_medication_entry/inpatient_medication_entry.py
@@ -24,59 +24,68 @@ class InpatientMedicationEntry(Document):
self.add_mo_to_table(orders)
return self
else:
- self.set('medication_orders', [])
- frappe.msgprint(_('No pending medication orders found for selected criteria'))
+ self.set("medication_orders", [])
+ frappe.msgprint(_("No pending medication orders found for selected criteria"))
def add_mo_to_table(self, orders):
# Add medication orders in the child table
- self.set('medication_orders', [])
+ self.set("medication_orders", [])
for data in orders:
- self.append('medication_orders', {
- 'patient': data.patient,
- 'patient_name': data.patient_name,
- 'inpatient_record': data.inpatient_record,
- 'service_unit': data.service_unit,
- 'datetime': "%s %s" % (data.date, data.time or "00:00:00"),
- 'drug_code': data.drug,
- 'drug_name': data.drug_name,
- 'dosage': data.dosage,
- 'dosage_form': data.dosage_form,
- 'against_imo': data.parent,
- 'against_imoe': data.name
- })
+ self.append(
+ "medication_orders",
+ {
+ "patient": data.patient,
+ "patient_name": data.patient_name,
+ "inpatient_record": data.inpatient_record,
+ "service_unit": data.service_unit,
+ "datetime": "%s %s" % (data.date, data.time or "00:00:00"),
+ "drug_code": data.drug,
+ "drug_name": data.drug_name,
+ "dosage": data.dosage,
+ "dosage_form": data.dosage_form,
+ "against_imo": data.parent,
+ "against_imoe": data.name,
+ },
+ )
def on_submit(self):
self.validate_medication_orders()
success_msg = ""
if self.update_stock:
stock_entry = self.process_stock()
- success_msg += _('Stock Entry {0} created and ').format(
- frappe.bold(get_link_to_form('Stock Entry', stock_entry)))
+ success_msg += _("Stock Entry {0} created and ").format(
+ frappe.bold(get_link_to_form("Stock Entry", stock_entry))
+ )
self.update_medication_orders()
- success_msg += _('Inpatient Medication Orders updated successfully')
- frappe.msgprint(success_msg, title=_('Success'), indicator='green')
+ success_msg += _("Inpatient Medication Orders updated successfully")
+ frappe.msgprint(success_msg, title=_("Success"), indicator="green")
def validate_medication_orders(self):
for entry in self.medication_orders:
- docstatus, is_completed = frappe.db.get_value('Inpatient Medication Order Entry', entry.against_imoe,
- ['docstatus', 'is_completed'])
+ docstatus, is_completed = frappe.db.get_value(
+ "Inpatient Medication Order Entry", entry.against_imoe, ["docstatus", "is_completed"]
+ )
if docstatus == 2:
- frappe.throw(_('Row {0}: Cannot create Inpatient Medication Entry against cancelled Inpatient Medication Order {1}').format(
- entry.idx, get_link_to_form(entry.against_imo)))
+ frappe.throw(
+ _(
+ "Row {0}: Cannot create Inpatient Medication Entry against cancelled Inpatient Medication Order {1}"
+ ).format(entry.idx, get_link_to_form(entry.against_imo))
+ )
if is_completed:
- frappe.throw(_('Row {0}: This Medication Order is already marked as completed').format(
- entry.idx))
+ frappe.throw(
+ _("Row {0}: This Medication Order is already marked as completed").format(entry.idx)
+ )
def on_cancel(self):
self.cancel_stock_entries()
self.update_medication_orders(on_cancel=True)
def process_stock(self):
- allow_negative_stock = frappe.db.get_single_value('Stock Settings', 'allow_negative_stock')
+ allow_negative_stock = frappe.db.get_single_value("Stock Settings", "allow_negative_stock")
if not allow_negative_stock:
self.check_stock_qty()
@@ -89,24 +98,27 @@ class InpatientMedicationEntry(Document):
if on_cancel:
is_completed = 0
- frappe.db.sql("""
+ frappe.db.sql(
+ """
UPDATE `tabInpatient Medication Order Entry`
SET is_completed = %(is_completed)s
WHERE name IN %(orders)s
- """, {'orders': orders, 'is_completed': is_completed})
+ """,
+ {"orders": orders, "is_completed": is_completed},
+ )
# update status and completed orders count
for order, count in order_entry_map.items():
- medication_order = frappe.get_doc('Inpatient Medication Order', order)
+ medication_order = frappe.get_doc("Inpatient Medication Order", order)
completed_orders = flt(count)
- current_value = frappe.db.get_value('Inpatient Medication Order', order, 'completed_orders')
+ current_value = frappe.db.get_value("Inpatient Medication Order", order, "completed_orders")
if on_cancel:
completed_orders = flt(current_value) - flt(count)
else:
completed_orders = flt(current_value) + flt(count)
- medication_order.db_set('completed_orders', completed_orders)
+ medication_order.db_set("completed_orders", completed_orders)
medication_order.set_status()
def get_order_entry_map(self):
@@ -129,17 +141,23 @@ class InpatientMedicationEntry(Document):
drug_shortage = get_drug_shortage_map(self.medication_orders, self.warehouse)
if drug_shortage:
- message = _('Quantity not available for the following items in warehouse {0}. ').format(frappe.bold(self.warehouse))
- message += _('Please enable Allow Negative Stock in Stock Settings or create Stock Entry to proceed.')
+ message = _("Quantity not available for the following items in warehouse {0}. ").format(
+ frappe.bold(self.warehouse)
+ )
+ message += _(
+ "Please enable Allow Negative Stock in Stock Settings or create Stock Entry to proceed."
+ )
- formatted_item_rows = ''
+ formatted_item_rows = ""
for drug, shortage_qty in drug_shortage.items():
- item_link = get_link_to_form('Item', drug)
+ item_link = get_link_to_form("Item", drug)
formatted_item_rows += """
{0}
{1}
- """.format(item_link, frappe.bold(shortage_qty))
+ """.format(
+ item_link, frappe.bold(shortage_qty)
+ )
message += """
@@ -149,25 +167,27 @@ class InpatientMedicationEntry(Document):
{2}
- """.format(_('Drug Code'), _('Shortage Qty'), formatted_item_rows)
+ """.format(
+ _("Drug Code"), _("Shortage Qty"), formatted_item_rows
+ )
- frappe.throw(message, title=_('Insufficient Stock'), is_minimizable=True, wide=True)
+ frappe.throw(message, title=_("Insufficient Stock"), is_minimizable=True, wide=True)
def make_stock_entry(self):
- stock_entry = frappe.new_doc('Stock Entry')
- stock_entry.purpose = 'Material Issue'
+ stock_entry = frappe.new_doc("Stock Entry")
+ stock_entry.purpose = "Material Issue"
stock_entry.set_stock_entry_type()
stock_entry.from_warehouse = self.warehouse
stock_entry.company = self.company
stock_entry.inpatient_medication_entry = self.name
- cost_center = frappe.get_cached_value('Company', self.company, 'cost_center')
- expense_account = get_account(None, 'expense_account', 'Healthcare Settings', self.company)
+ cost_center = frappe.get_cached_value("Company", self.company, "cost_center")
+ expense_account = get_account(None, "expense_account", "Healthcare Settings", self.company)
for entry in self.medication_orders:
- se_child = stock_entry.append('items')
+ se_child = stock_entry.append("items")
se_child.item_code = entry.drug_code
se_child.item_name = entry.drug_name
- se_child.uom = frappe.db.get_value('Item', entry.drug_code, 'stock_uom')
+ se_child.uom = frappe.db.get_value("Item", entry.drug_code, "stock_uom")
se_child.stock_uom = se_child.uom
se_child.qty = flt(entry.dosage)
# in stock uom
@@ -182,9 +202,9 @@ class InpatientMedicationEntry(Document):
return stock_entry.name
def cancel_stock_entries(self):
- stock_entries = frappe.get_all('Stock Entry', {'inpatient_medication_entry': self.name})
+ stock_entries = frappe.get_all("Stock Entry", {"inpatient_medication_entry": self.name})
for entry in stock_entries:
- doc = frappe.get_doc('Stock Entry', entry.name)
+ doc = frappe.get_doc("Stock Entry", entry.name)
doc.cancel()
@@ -192,7 +212,8 @@ def get_pending_medication_orders(entry):
filters, values = get_filters(entry)
to_remove = []
- data = frappe.db.sql("""
+ data = frappe.db.sql(
+ """
SELECT
ip.inpatient_record, ip.patient, ip.patient_name,
entry.name, entry.parent, entry.drug, entry.drug_name,
@@ -210,12 +231,17 @@ def get_pending_medication_orders(entry):
{0}
ORDER BY
entry.date, entry.time
- """.format(filters), values, as_dict=1)
+ """.format(
+ filters
+ ),
+ values,
+ as_dict=1,
+ )
for doc in data:
inpatient_record = doc.inpatient_record
if inpatient_record:
- doc['service_unit'] = get_current_healthcare_service_unit(inpatient_record)
+ doc["service_unit"] = get_current_healthcare_service_unit(inpatient_record)
if entry.service_unit and doc.service_unit != entry.service_unit:
to_remove.append(doc)
@@ -227,53 +253,53 @@ def get_pending_medication_orders(entry):
def get_filters(entry):
- filters = ''
+ filters = ""
values = dict(company=entry.company)
if entry.from_date:
- filters += ' and entry.date >= %(from_date)s'
- values['from_date'] = entry.from_date
+ filters += " and entry.date >= %(from_date)s"
+ values["from_date"] = entry.from_date
if entry.to_date:
- filters += ' and entry.date <= %(to_date)s'
- values['to_date'] = entry.to_date
+ filters += " and entry.date <= %(to_date)s"
+ values["to_date"] = entry.to_date
if entry.from_time:
- filters += ' and entry.time >= %(from_time)s'
- values['from_time'] = entry.from_time
+ filters += " and entry.time >= %(from_time)s"
+ values["from_time"] = entry.from_time
if entry.to_time:
- filters += ' and entry.time <= %(to_time)s'
- values['to_time'] = entry.to_time
+ filters += " and entry.time <= %(to_time)s"
+ values["to_time"] = entry.to_time
if entry.patient:
- filters += ' and ip.patient = %(patient)s'
- values['patient'] = entry.patient
+ filters += " and ip.patient = %(patient)s"
+ values["patient"] = entry.patient
if entry.practitioner:
- filters += ' and ip.practitioner = %(practitioner)s'
- values['practitioner'] = entry.practitioner
+ filters += " and ip.practitioner = %(practitioner)s"
+ values["practitioner"] = entry.practitioner
if entry.item_code:
- filters += ' and entry.drug = %(item_code)s'
- values['item_code'] = entry.item_code
+ filters += " and entry.drug = %(item_code)s"
+ values["item_code"] = entry.item_code
if entry.assigned_to_practitioner:
- filters += ' and ip._assign LIKE %(assigned_to)s'
- values['assigned_to'] = '%' + entry.assigned_to_practitioner + '%'
+ filters += " and ip._assign LIKE %(assigned_to)s"
+ values["assigned_to"] = "%" + entry.assigned_to_practitioner + "%"
return filters, values
def get_current_healthcare_service_unit(inpatient_record):
- ip_record = frappe.get_doc('Inpatient Record', inpatient_record)
- if ip_record.status in ['Admitted', 'Discharge Scheduled'] and ip_record.inpatient_occupancies:
+ ip_record = frappe.get_doc("Inpatient Record", inpatient_record)
+ if ip_record.status in ["Admitted", "Discharge Scheduled"] and ip_record.inpatient_occupancies:
return ip_record.inpatient_occupancies[-1].service_unit
return
def get_drug_shortage_map(medication_orders, warehouse):
"""
- Returns a dict like { drug_code: shortage_qty }
+ Returns a dict like { drug_code: shortage_qty }
"""
drug_requirement = dict()
for d in medication_orders:
@@ -292,25 +318,25 @@ def get_drug_shortage_map(medication_orders, warehouse):
@frappe.whitelist()
def make_difference_stock_entry(docname):
- doc = frappe.get_doc('Inpatient Medication Entry', docname)
+ doc = frappe.get_doc("Inpatient Medication Entry", docname)
drug_shortage = get_drug_shortage_map(doc.medication_orders, doc.warehouse)
if not drug_shortage:
return None
- stock_entry = frappe.new_doc('Stock Entry')
- stock_entry.purpose = 'Material Transfer'
+ stock_entry = frappe.new_doc("Stock Entry")
+ stock_entry.purpose = "Material Transfer"
stock_entry.set_stock_entry_type()
stock_entry.to_warehouse = doc.warehouse
stock_entry.company = doc.company
- cost_center = frappe.get_cached_value('Company', doc.company, 'cost_center')
- expense_account = get_account(None, 'expense_account', 'Healthcare Settings', doc.company)
+ cost_center = frappe.get_cached_value("Company", doc.company, "cost_center")
+ expense_account = get_account(None, "expense_account", "Healthcare Settings", doc.company)
for drug, shortage_qty in drug_shortage.items():
- se_child = stock_entry.append('items')
+ se_child = stock_entry.append("items")
se_child.item_code = drug
- se_child.item_name = frappe.db.get_value('Item', drug, 'stock_uom')
- se_child.uom = frappe.db.get_value('Item', drug, 'stock_uom')
+ se_child.item_name = frappe.db.get_value("Item", drug, "stock_uom")
+ se_child.uom = frappe.db.get_value("Item", drug, "stock_uom")
se_child.stock_uom = se_child.uom
se_child.qty = flt(shortage_qty)
se_child.t_warehouse = doc.warehouse
diff --git a/erpnext/healthcare/doctype/inpatient_medication_entry/inpatient_medication_entry_dashboard.py b/erpnext/healthcare/doctype/inpatient_medication_entry/inpatient_medication_entry_dashboard.py
index 23e899a8d9a..07d634e9dd4 100644
--- a/erpnext/healthcare/doctype/inpatient_medication_entry/inpatient_medication_entry_dashboard.py
+++ b/erpnext/healthcare/doctype/inpatient_medication_entry/inpatient_medication_entry_dashboard.py
@@ -1,17 +1,9 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'against_imoe',
- 'internal_links': {
- 'Inpatient Medication Order': ['medication_orders', 'against_imo']
- },
- 'transactions': [
- {
- 'label': _('Reference'),
- 'items': ['Inpatient Medication Order']
- }
- ]
+ "fieldname": "against_imoe",
+ "internal_links": {"Inpatient Medication Order": ["medication_orders", "against_imo"]},
+ "transactions": [{"label": _("Reference"), "items": ["Inpatient Medication Order"]}],
}
diff --git a/erpnext/healthcare/doctype/inpatient_medication_entry/test_inpatient_medication_entry.py b/erpnext/healthcare/doctype/inpatient_medication_entry/test_inpatient_medication_entry.py
index 6da116447b9..ee21f2bd0c0 100644
--- a/erpnext/healthcare/doctype/inpatient_medication_entry/test_inpatient_medication_entry.py
+++ b/erpnext/healthcare/doctype/inpatient_medication_entry/test_inpatient_medication_entry.py
@@ -53,10 +53,10 @@ class TestInpatientMedicationEntry(unittest.TestCase):
filters = frappe._dict(
from_date=date,
to_date=date,
- from_time='',
- to_time='',
- item_code='Dextromethorphan',
- patient=self.patient
+ from_time="",
+ to_time="",
+ item_code="Dextromethorphan",
+ patient=self.patient,
)
ipme = create_ipme(filters, update_stock=0)
@@ -74,10 +74,10 @@ class TestInpatientMedicationEntry(unittest.TestCase):
filters = frappe._dict(
from_date=date,
to_date=date,
- from_time='',
- to_time='',
- item_code='Dextromethorphan',
- patient=self.patient
+ from_time="",
+ to_time="",
+ item_code="Dextromethorphan",
+ patient=self.patient,
)
make_stock_entry()
@@ -86,18 +86,21 @@ class TestInpatientMedicationEntry(unittest.TestCase):
ipme.reload()
# test order completed
- is_order_completed = frappe.db.get_value('Inpatient Medication Order Entry',
- ipme.medication_orders[0].against_imoe, 'is_completed')
+ is_order_completed = frappe.db.get_value(
+ "Inpatient Medication Order Entry", ipme.medication_orders[0].against_imoe, "is_completed"
+ )
self.assertEqual(is_order_completed, 1)
# test stock entry
- stock_entry = frappe.db.exists('Stock Entry', {'inpatient_medication_entry': ipme.name})
+ stock_entry = frappe.db.exists("Stock Entry", {"inpatient_medication_entry": ipme.name})
self.assertTrue(stock_entry)
# check references
- stock_entry = frappe.get_doc('Stock Entry', stock_entry)
+ stock_entry = frappe.get_doc("Stock Entry", stock_entry)
self.assertEqual(stock_entry.items[0].patient, self.patient)
- self.assertEqual(stock_entry.items[0].inpatient_medication_entry_child, ipme.medication_orders[0].name)
+ self.assertEqual(
+ stock_entry.items[0].inpatient_medication_entry_child, ipme.medication_orders[0].name
+ )
def test_drug_shortage_stock_entry(self):
ipmo = create_ipmo(self.patient)
@@ -108,25 +111,25 @@ class TestInpatientMedicationEntry(unittest.TestCase):
filters = frappe._dict(
from_date=date,
to_date=date,
- from_time='',
- to_time='',
- item_code='Dextromethorphan',
- patient=self.patient
+ from_time="",
+ to_time="",
+ item_code="Dextromethorphan",
+ patient=self.patient,
)
# check drug shortage
ipme = create_ipme(filters, update_stock=1)
- ipme.warehouse = 'Finished Goods - _TC'
+ ipme.warehouse = "Finished Goods - _TC"
ipme.save()
drug_shortage = get_drug_shortage_map(ipme.medication_orders, ipme.warehouse)
- self.assertEqual(drug_shortage.get('Dextromethorphan'), 3)
+ self.assertEqual(drug_shortage.get("Dextromethorphan"), 3)
# check material transfer for drug shortage
make_stock_entry()
stock_entry = make_difference_stock_entry(ipme.name)
- self.assertEqual(stock_entry.items[0].item_code, 'Dextromethorphan')
+ self.assertEqual(stock_entry.items[0].item_code, "Dextromethorphan")
self.assertEqual(stock_entry.items[0].qty, 3)
- stock_entry.from_warehouse = 'Stores - _TC'
+ stock_entry.from_warehouse = "Stores - _TC"
stock_entry.submit()
ipme.reload()
@@ -134,38 +137,45 @@ class TestInpatientMedicationEntry(unittest.TestCase):
def tearDown(self):
# cleanup - Discharge
- schedule_discharge(frappe.as_json({'patient': self.patient, 'discharge_ordered_datetime': now_datetime()}))
+ schedule_discharge(
+ frappe.as_json({"patient": self.patient, "discharge_ordered_datetime": now_datetime()})
+ )
self.ip_record.reload()
mark_invoiced_inpatient_occupancy(self.ip_record)
self.ip_record.reload()
discharge_patient(self.ip_record, now_datetime())
- for entry in frappe.get_all('Inpatient Medication Entry'):
- doc = frappe.get_doc('Inpatient Medication Entry', entry.name)
+ for entry in frappe.get_all("Inpatient Medication Entry"):
+ doc = frappe.get_doc("Inpatient Medication Entry", entry.name)
doc.cancel()
- for entry in frappe.get_all('Inpatient Medication Order'):
- doc = frappe.get_doc('Inpatient Medication Order', entry.name)
+ for entry in frappe.get_all("Inpatient Medication Order"):
+ doc = frappe.get_doc("Inpatient Medication Order", entry.name)
doc.cancel()
+
def make_stock_entry(warehouse=None):
- frappe.db.set_value('Company', '_Test Company', {
- 'stock_adjustment_account': 'Stock Adjustment - _TC',
- 'default_inventory_account': 'Stock In Hand - _TC'
- })
- stock_entry = frappe.new_doc('Stock Entry')
- stock_entry.stock_entry_type = 'Material Receipt'
- stock_entry.company = '_Test Company'
- stock_entry.to_warehouse = warehouse or 'Stores - _TC'
- expense_account = get_account(None, 'expense_account', 'Healthcare Settings', '_Test Company')
- se_child = stock_entry.append('items')
- se_child.item_code = 'Dextromethorphan'
- se_child.item_name = 'Dextromethorphan'
- se_child.uom = 'Nos'
- se_child.stock_uom = 'Nos'
+ frappe.db.set_value(
+ "Company",
+ "_Test Company",
+ {
+ "stock_adjustment_account": "Stock Adjustment - _TC",
+ "default_inventory_account": "Stock In Hand - _TC",
+ },
+ )
+ stock_entry = frappe.new_doc("Stock Entry")
+ stock_entry.stock_entry_type = "Material Receipt"
+ stock_entry.company = "_Test Company"
+ stock_entry.to_warehouse = warehouse or "Stores - _TC"
+ expense_account = get_account(None, "expense_account", "Healthcare Settings", "_Test Company")
+ se_child = stock_entry.append("items")
+ se_child.item_code = "Dextromethorphan"
+ se_child.item_name = "Dextromethorphan"
+ se_child.uom = "Nos"
+ se_child.stock_uom = "Nos"
se_child.qty = 6
- se_child.t_warehouse = 'Stores - _TC'
+ se_child.t_warehouse = "Stores - _TC"
# in stock uom
se_child.conversion_factor = 1.0
se_child.expense_account = expense_account
diff --git a/erpnext/healthcare/doctype/inpatient_medication_order/inpatient_medication_order.py b/erpnext/healthcare/doctype/inpatient_medication_order/inpatient_medication_order.py
index 60c57f9c45d..8360132e3e9 100644
--- a/erpnext/healthcare/doctype/inpatient_medication_order/inpatient_medication_order.py
+++ b/erpnext/healthcare/doctype/inpatient_medication_order/inpatient_medication_order.py
@@ -26,50 +26,53 @@ class InpatientMedicationOrder(Document):
def validate_inpatient(self):
if not self.inpatient_record:
- frappe.throw(_('No Inpatient Record found against patient {0}').format(self.patient))
+ frappe.throw(_("No Inpatient Record found against patient {0}").format(self.patient))
def validate_duplicate(self):
- existing_mo = frappe.db.exists('Inpatient Medication Order', {
- 'patient_encounter': self.patient_encounter,
- 'docstatus': ('!=', 2),
- 'name': ('!=', self.name)
- })
+ existing_mo = frappe.db.exists(
+ "Inpatient Medication Order",
+ {
+ "patient_encounter": self.patient_encounter,
+ "docstatus": ("!=", 2),
+ "name": ("!=", self.name),
+ },
+ )
if existing_mo:
- frappe.throw(_('An Inpatient Medication Order {0} against Patient Encounter {1} already exists.').format(
- existing_mo, self.patient_encounter), frappe.DuplicateEntryError)
+ frappe.throw(
+ _("An Inpatient Medication Order {0} against Patient Encounter {1} already exists.").format(
+ existing_mo, self.patient_encounter
+ ),
+ frappe.DuplicateEntryError,
+ )
def set_total_orders(self):
- self.db_set('total_orders', len(self.medication_orders))
+ self.db_set("total_orders", len(self.medication_orders))
def set_status(self):
- status = {
- "0": "Draft",
- "1": "Submitted",
- "2": "Cancelled"
- }[cstr(self.docstatus or 0)]
+ status = {"0": "Draft", "1": "Submitted", "2": "Cancelled"}[cstr(self.docstatus or 0)]
if self.docstatus == 1:
if not self.completed_orders:
- status = 'Pending'
+ status = "Pending"
elif self.completed_orders < self.total_orders:
- status = 'In Process'
+ status = "In Process"
else:
- status = 'Completed'
+ status = "Completed"
- self.db_set('status', status)
+ self.db_set("status", status)
@frappe.whitelist()
def add_order_entries(self, order):
- if order.get('drug_code'):
- dosage = frappe.get_doc('Prescription Dosage', order.get('dosage'))
- dates = get_prescription_dates(order.get('period'), self.start_date)
+ if order.get("drug_code"):
+ dosage = frappe.get_doc("Prescription Dosage", order.get("dosage"))
+ dates = get_prescription_dates(order.get("period"), self.start_date)
for date in dates:
for dose in dosage.dosage_strength:
- entry = self.append('medication_orders')
- entry.drug = order.get('drug_code')
- entry.drug_name = frappe.db.get_value('Item', order.get('drug_code'), 'item_name')
+ entry = self.append("medication_orders")
+ entry.drug = order.get("drug_code")
+ entry.drug_name = frappe.db.get_value("Item", order.get("drug_code"), "item_name")
entry.dosage = dose.strength
- entry.dosage_form = order.get('dosage_form')
+ entry.dosage_form = order.get("dosage_form")
entry.date = date
entry.time = dose.strength_time
self.end_date = dates[-1]
diff --git a/erpnext/healthcare/doctype/inpatient_medication_order/test_inpatient_medication_order.py b/erpnext/healthcare/doctype/inpatient_medication_order/test_inpatient_medication_order.py
index 5ebe6fa594b..8f777b5008b 100644
--- a/erpnext/healthcare/doctype/inpatient_medication_order/test_inpatient_medication_order.py
+++ b/erpnext/healthcare/doctype/inpatient_medication_order/test_inpatient_medication_order.py
@@ -42,15 +42,19 @@ class TestInpatientMedicationOrder(unittest.TestCase):
self.assertEqual(len(ipmo.medication_orders), 6)
self.assertEqual(ipmo.medication_orders[0].date, add_days(getdate(), -1))
- prescription_dosage = frappe.get_doc('Prescription Dosage', '1-1-1')
+ prescription_dosage = frappe.get_doc("Prescription Dosage", "1-1-1")
for i in range(len(prescription_dosage.dosage_strength)):
- self.assertEqual(ipmo.medication_orders[i].time, prescription_dosage.dosage_strength[i].strength_time)
+ self.assertEqual(
+ ipmo.medication_orders[i].time, prescription_dosage.dosage_strength[i].strength_time
+ )
self.assertEqual(ipmo.medication_orders[3].date, getdate())
def test_inpatient_validation(self):
# Discharge
- schedule_discharge(frappe.as_json({'patient': self.patient, 'discharge_ordered_datetime': now_datetime()}))
+ schedule_discharge(
+ frappe.as_json({"patient": self.patient, "discharge_ordered_datetime": now_datetime()})
+ )
self.ip_record.reload()
mark_invoiced_inpatient_occupancy(self.ip_record)
@@ -67,24 +71,28 @@ class TestInpatientMedicationOrder(unittest.TestCase):
ipmo.submit()
ipmo.reload()
- self.assertEqual(ipmo.status, 'Pending')
+ self.assertEqual(ipmo.status, "Pending")
- filters = frappe._dict(from_date=add_days(getdate(), -1), to_date=add_days(getdate(), -1), from_time='', to_time='')
+ filters = frappe._dict(
+ from_date=add_days(getdate(), -1), to_date=add_days(getdate(), -1), from_time="", to_time=""
+ )
ipme = create_ipme(filters)
ipme.submit()
ipmo.reload()
- self.assertEqual(ipmo.status, 'In Process')
+ self.assertEqual(ipmo.status, "In Process")
- filters = frappe._dict(from_date=getdate(), to_date=getdate(), from_time='', to_time='')
+ filters = frappe._dict(from_date=getdate(), to_date=getdate(), from_time="", to_time="")
ipme = create_ipme(filters)
ipme.submit()
ipmo.reload()
- self.assertEqual(ipmo.status, 'Completed')
+ self.assertEqual(ipmo.status, "Completed")
def tearDown(self):
- if frappe.db.get_value('Patient', self.patient, 'inpatient_record'):
+ if frappe.db.get_value("Patient", self.patient, "inpatient_record"):
# cleanup - Discharge
- schedule_discharge(frappe.as_json({'patient': self.patient, 'discharge_ordered_datetime': now_datetime()}))
+ schedule_discharge(
+ frappe.as_json({"patient": self.patient, "discharge_ordered_datetime": now_datetime()})
+ )
self.ip_record.reload()
mark_invoiced_inpatient_occupancy(self.ip_record)
@@ -94,57 +102,61 @@ class TestInpatientMedicationOrder(unittest.TestCase):
for doctype in ["Inpatient Medication Entry", "Inpatient Medication Order"]:
frappe.db.sql("delete from `tab{doctype}`".format(doctype=doctype))
+
def create_dosage_form():
- if not frappe.db.exists('Dosage Form', 'Tablet'):
- frappe.get_doc({
- 'doctype': 'Dosage Form',
- 'dosage_form': 'Tablet'
- }).insert()
+ if not frappe.db.exists("Dosage Form", "Tablet"):
+ frappe.get_doc({"doctype": "Dosage Form", "dosage_form": "Tablet"}).insert()
+
def create_drug(item=None):
if not item:
- item = 'Dextromethorphan'
- drug = frappe.db.exists('Item', {'item_code': 'Dextromethorphan'})
+ item = "Dextromethorphan"
+ drug = frappe.db.exists("Item", {"item_code": "Dextromethorphan"})
if not drug:
- drug = frappe.get_doc({
- 'doctype': 'Item',
- 'item_code': 'Dextromethorphan',
- 'item_name': 'Dextromethorphan',
- 'item_group': 'Products',
- 'stock_uom': 'Nos',
- 'is_stock_item': 1,
- 'valuation_rate': 50,
- 'opening_stock': 20
- }).insert()
+ drug = frappe.get_doc(
+ {
+ "doctype": "Item",
+ "item_code": "Dextromethorphan",
+ "item_name": "Dextromethorphan",
+ "item_group": "Products",
+ "stock_uom": "Nos",
+ "is_stock_item": 1,
+ "valuation_rate": 50,
+ "opening_stock": 20,
+ }
+ ).insert()
+
def get_orders():
create_dosage_form()
create_drug()
return {
- 'drug_code': 'Dextromethorphan',
- 'drug_name': 'Dextromethorphan',
- 'dosage': '1-1-1',
- 'dosage_form': 'Tablet',
- 'period': '2 Day'
+ "drug_code": "Dextromethorphan",
+ "drug_name": "Dextromethorphan",
+ "dosage": "1-1-1",
+ "dosage_form": "Tablet",
+ "period": "2 Day",
}
+
def create_ipmo(patient):
orders = get_orders()
- ipmo = frappe.new_doc('Inpatient Medication Order')
+ ipmo = frappe.new_doc("Inpatient Medication Order")
ipmo.patient = patient
- ipmo.company = '_Test Company'
+ ipmo.company = "_Test Company"
ipmo.start_date = add_days(getdate(), -1)
ipmo.add_order_entries(orders)
return ipmo
+
def create_ipme(filters, update_stock=0):
- ipme = frappe.new_doc('Inpatient Medication Entry')
- ipme.company = '_Test Company'
+ ipme = frappe.new_doc("Inpatient Medication Entry")
+ ipme.company = "_Test Company"
ipme.posting_date = getdate()
ipme.update_stock = update_stock
if update_stock:
- ipme.warehouse = 'Stores - _TC'
+ ipme.warehouse = "Stores - _TC"
for key, value in filters.items():
ipme.set(key, value)
ipme = ipme.get_medication_orders()
diff --git a/erpnext/healthcare/doctype/inpatient_record/inpatient_record.json b/erpnext/healthcare/doctype/inpatient_record/inpatient_record.json
index 03ecf4fb018..e826ecf80bb 100644
--- a/erpnext/healthcare/doctype/inpatient_record/inpatient_record.json
+++ b/erpnext/healthcare/doctype/inpatient_record/inpatient_record.json
@@ -24,13 +24,12 @@
"expected_discharge",
"references",
"admission_encounter",
- "admission_practitioner",
+ "primary_practitioner",
"medical_department",
"admission_ordered_for",
"expected_length_of_stay",
"admission_service_unit_type",
"cb_admission",
- "primary_practitioner",
"secondary_practitioner",
"admission_instruction",
"encounter_details_section",
@@ -134,11 +133,11 @@
"read_only": 1
},
{
+ "fetch_from": "primary_practitioner.department",
"fieldname": "medical_department",
"fieldtype": "Link",
"label": "Medical Department",
- "options": "Medical Department",
- "set_only_once": 1
+ "options": "Medical Department"
},
{
"fieldname": "primary_practitioner",
@@ -211,13 +210,6 @@
"fieldname": "cb_admission",
"fieldtype": "Column Break"
},
- {
- "fieldname": "admission_practitioner",
- "fieldtype": "Link",
- "label": "Healthcare Practitioner",
- "options": "Healthcare Practitioner",
- "read_only": 1
- },
{
"fieldname": "admission_encounter",
"fieldtype": "Link",
@@ -412,7 +404,7 @@
],
"index_web_pages_for_search": 1,
"links": [],
- "modified": "2021-08-09 22:49:07.419692",
+ "modified": "2022-02-22 12:15:02.843426",
"modified_by": "Administrator",
"module": "Healthcare",
"name": "Inpatient Record",
diff --git a/erpnext/healthcare/doctype/inpatient_record/inpatient_record.py b/erpnext/healthcare/doctype/inpatient_record/inpatient_record.py
index 322ad0e4f26..fc7ce5fd4b8 100644
--- a/erpnext/healthcare/doctype/inpatient_record/inpatient_record.py
+++ b/erpnext/healthcare/doctype/inpatient_record/inpatient_record.py
@@ -13,12 +13,16 @@ from frappe.utils import get_datetime, get_link_to_form, getdate, now_datetime,
class InpatientRecord(Document):
def after_insert(self):
- frappe.db.set_value('Patient', self.patient, 'inpatient_record', self.name)
- frappe.db.set_value('Patient', self.patient, 'inpatient_status', self.status)
+ frappe.db.set_value("Patient", self.patient, "inpatient_record", self.name)
+ frappe.db.set_value("Patient", self.patient, "inpatient_status", self.status)
- if self.admission_encounter: # Update encounter
- frappe.db.set_value('Patient Encounter', self.admission_encounter, 'inpatient_record', self.name)
- frappe.db.set_value('Patient Encounter', self.admission_encounter, 'inpatient_status', self.status)
+ if self.admission_encounter: # Update encounter
+ frappe.db.set_value(
+ "Patient Encounter", self.admission_encounter, "inpatient_record", self.name
+ )
+ frappe.db.set_value(
+ "Patient Encounter", self.admission_encounter, "inpatient_status", self.status
+ )
def validate(self):
self.validate_dates()
@@ -28,14 +32,20 @@ class InpatientRecord(Document):
frappe.db.set_value("Patient", self.patient, "inpatient_record", None)
def validate_dates(self):
- if (getdate(self.expected_discharge) < getdate(self.scheduled_date)) or \
- (getdate(self.discharge_ordered_datetime) < getdate(self.scheduled_date)):
- frappe.throw(_('Expected and Discharge dates cannot be less than Admission Schedule date'))
+ if (getdate(self.expected_discharge) < getdate(self.scheduled_date)) or (
+ getdate(self.discharge_ordered_datetime) < getdate(self.scheduled_date)
+ ):
+ frappe.throw(_("Expected and Discharge dates cannot be less than Admission Schedule date"))
for entry in self.inpatient_occupancies:
- if entry.check_in and entry.check_out and \
- get_datetime(entry.check_in) > get_datetime(entry.check_out):
- frappe.throw(_('Row #{0}: Check Out datetime cannot be less than Check In datetime').format(entry.idx))
+ if (
+ entry.check_in
+ and entry.check_out
+ and get_datetime(entry.check_in) > get_datetime(entry.check_out)
+ ):
+ frappe.throw(
+ _("Row #{0}: Check Out datetime cannot be less than Check In datetime").format(entry.idx)
+ )
def validate_already_scheduled_or_admitted(self):
query = """
@@ -45,14 +55,13 @@ class InpatientRecord(Document):
and name != %(name)s and patient = %(patient)s
"""
- ip_record = frappe.db.sql(query,{
- "name": self.name,
- "patient": self.patient
- }, as_dict = 1)
+ ip_record = frappe.db.sql(query, {"name": self.name, "patient": self.patient}, as_dict=1)
if ip_record:
- msg = _(("Already {0} Patient {1} with Inpatient Record ").format(ip_record[0].status, self.patient) \
- + """ {0}""".format(ip_record[0].name))
+ msg = _(
+ ("Already {0} Patient {1} with Inpatient Record ").format(ip_record[0].status, self.patient)
+ + """ {0}""".format(ip_record[0].name)
+ )
frappe.throw(msg)
@frappe.whitelist()
@@ -63,8 +72,8 @@ class InpatientRecord(Document):
def discharge(self, check_out=None):
if not check_out:
check_out = now_datetime()
- if (getdate(check_out) < getdate(self.admitted_datetime)):
- frappe.throw(_('Discharge date cannot be less than Admission date'))
+ if getdate(check_out) < getdate(self.admitted_datetime):
+ frappe.throw(_("Discharge date cannot be less than Admission date"))
discharge_patient(self, check_out)
@frappe.whitelist()
@@ -77,17 +86,21 @@ class InpatientRecord(Document):
@frappe.whitelist()
def schedule_inpatient(args):
- admission_order = json.loads(args) # admission order via Encounter
- if not admission_order or not admission_order['patient'] or not admission_order['admission_encounter']:
- frappe.throw(_('Missing required details, did not create Inpatient Record'))
+ admission_order = json.loads(args) # admission order via Encounter
+ if (
+ not admission_order
+ or not admission_order["patient"]
+ or not admission_order["admission_encounter"]
+ ):
+ frappe.throw(_("Missing required details, did not create Inpatient Record"))
- inpatient_record = frappe.new_doc('Inpatient Record')
+ inpatient_record = frappe.new_doc("Inpatient Record")
# Admission order details
set_details_from_ip_order(inpatient_record, admission_order)
# Patient details
- patient = frappe.get_doc('Patient', admission_order['patient'])
+ patient = frappe.get_doc("Patient", admission_order["patient"])
inpatient_record.patient = patient.name
inpatient_record.patient_name = patient.patient_name
inpatient_record.gender = patient.sex
@@ -99,45 +112,60 @@ def schedule_inpatient(args):
inpatient_record.scheduled_date = today()
# Set encounter detials
- encounter = frappe.get_doc('Patient Encounter', admission_order['admission_encounter'])
- if encounter and encounter.symptoms: # Symptoms
- set_ip_child_records(inpatient_record, 'chief_complaint', encounter.symptoms)
+ encounter = frappe.get_doc("Patient Encounter", admission_order["admission_encounter"])
+ if encounter and encounter.symptoms: # Symptoms
+ set_ip_child_records(inpatient_record, "chief_complaint", encounter.symptoms)
- if encounter and encounter.diagnosis: # Diagnosis
- set_ip_child_records(inpatient_record, 'diagnosis', encounter.diagnosis)
+ if encounter and encounter.diagnosis: # Diagnosis
+ set_ip_child_records(inpatient_record, "diagnosis", encounter.diagnosis)
- if encounter and encounter.drug_prescription: # Medication
- set_ip_child_records(inpatient_record, 'drug_prescription', encounter.drug_prescription)
+ if encounter and encounter.drug_prescription: # Medication
+ set_ip_child_records(inpatient_record, "drug_prescription", encounter.drug_prescription)
- if encounter and encounter.lab_test_prescription: # Lab Tests
- set_ip_child_records(inpatient_record, 'lab_test_prescription', encounter.lab_test_prescription)
+ if encounter and encounter.lab_test_prescription: # Lab Tests
+ set_ip_child_records(inpatient_record, "lab_test_prescription", encounter.lab_test_prescription)
- if encounter and encounter.procedure_prescription: # Procedure Prescription
- set_ip_child_records(inpatient_record, 'procedure_prescription', encounter.procedure_prescription)
+ if encounter and encounter.procedure_prescription: # Procedure Prescription
+ set_ip_child_records(
+ inpatient_record, "procedure_prescription", encounter.procedure_prescription
+ )
- if encounter and encounter.therapies: # Therapies
+ if encounter and encounter.therapies: # Therapies
inpatient_record.therapy_plan = encounter.therapy_plan
- set_ip_child_records(inpatient_record, 'therapies', encounter.therapies)
+ set_ip_child_records(inpatient_record, "therapies", encounter.therapies)
- inpatient_record.status = 'Admission Scheduled'
- inpatient_record.save(ignore_permissions = True)
+ inpatient_record.status = "Admission Scheduled"
+ inpatient_record.save(ignore_permissions=True)
@frappe.whitelist()
def schedule_discharge(args):
discharge_order = json.loads(args)
- if not discharge_order or not discharge_order['patient'] or not discharge_order['discharge_ordered_datetime']:
- frappe.throw(_('Missing required details, did not create schedule discharge'))
+ if (
+ not discharge_order
+ or not discharge_order["patient"]
+ or not discharge_order["discharge_ordered_datetime"]
+ ):
+ frappe.throw(_("Missing required details, did not create schedule discharge"))
- inpatient_record_id = frappe.db.get_value('Patient', discharge_order['patient'], 'inpatient_record')
+ inpatient_record_id = frappe.db.get_value(
+ "Patient", discharge_order["patient"], "inpatient_record"
+ )
if inpatient_record_id:
- inpatient_record = frappe.get_doc('Inpatient Record', inpatient_record_id)
- check_out_inpatient(inpatient_record, discharge_order['discharge_ordered_datetime'])
+ inpatient_record = frappe.get_doc("Inpatient Record", inpatient_record_id)
+ check_out_inpatient(inpatient_record, discharge_order["discharge_ordered_datetime"])
set_details_from_ip_order(inpatient_record, discharge_order)
- inpatient_record.status = 'Discharge Scheduled'
- inpatient_record.save(ignore_permissions = True)
- frappe.db.set_value('Patient', discharge_order['patient'], 'inpatient_status', inpatient_record.status)
- frappe.db.set_value('Patient Encounter', inpatient_record.discharge_encounter, 'inpatient_status', inpatient_record.status)
+ inpatient_record.status = "Discharge Scheduled"
+ inpatient_record.save(ignore_permissions=True)
+ frappe.db.set_value(
+ "Patient", discharge_order["patient"], "inpatient_status", inpatient_record.status
+ )
+ frappe.db.set_value(
+ "Patient Encounter",
+ inpatient_record.discharge_encounter,
+ "inpatient_status",
+ inpatient_record.status,
+ )
def set_details_from_ip_order(inpatient_record, ip_order):
@@ -148,7 +176,7 @@ def set_details_from_ip_order(inpatient_record, ip_order):
def set_ip_child_records(inpatient_record, inpatient_record_child, encounter_child):
for item in encounter_child:
table = inpatient_record.append(inpatient_record_child)
- for df in table.meta.get('fields'):
+ for df in table.meta.get("fields"):
table.set(df.fieldname, item.get(df.fieldname))
@@ -158,7 +186,9 @@ def check_out_inpatient(inpatient_record, discharge_ordered_datetime):
if inpatient_occupancy.left != 1:
inpatient_occupancy.left = True
inpatient_occupancy.check_out = discharge_ordered_datetime
- frappe.db.set_value("Healthcare Service Unit", inpatient_occupancy.service_unit, "occupancy_status", "Vacant")
+ frappe.db.set_value(
+ "Healthcare Service Unit", inpatient_occupancy.service_unit, "occupancy_status", "Vacant"
+ )
def discharge_patient(inpatient_record, check_out):
@@ -166,7 +196,7 @@ def discharge_patient(inpatient_record, check_out):
inpatient_record.discharge_datetime = check_out
inpatient_record.status = "Discharged"
- inpatient_record.save(ignore_permissions = True)
+ inpatient_record.save(ignore_permissions=True)
def validate_inpatient_invoicing(inpatient_record):
@@ -178,13 +208,15 @@ def validate_inpatient_invoicing(inpatient_record):
if pending_invoices:
message = _("Cannot mark Inpatient Record as Discharged since there are unbilled services. ")
- formatted_doc_rows = ''
+ formatted_doc_rows = ""
for doctype, docnames in pending_invoices.items():
formatted_doc_rows += """
{0}
{1}
- """.format(doctype, docnames)
+ """.format(
+ doctype, docnames
+ )
message += """
@@ -194,7 +226,9 @@ def validate_inpatient_invoicing(inpatient_record):
{2}
- """.format(_("Healthcare Service"), _("Documents"), formatted_doc_rows)
+ """.format(
+ _("Healthcare Service"), _("Documents"), formatted_doc_rows
+ )
frappe.throw(message, title=_("Unbilled Services"), is_minimizable=True, wide=True)
@@ -232,34 +266,43 @@ def get_pending_doc(doc, doc_name_list, pending_invoices):
else:
doc_ids = doc_link
if doc_ids:
- pending_invoices[doc] = doc_ids
+ pending_invoices[doc] = doc_ids
return pending_invoices
def get_unbilled_inpatient_docs(doc, inpatient_record):
- return frappe.db.get_list(doc, filters = {'patient': inpatient_record.patient,
- 'inpatient_record': inpatient_record.name, 'docstatus': 1, 'invoiced': 0})
+ return frappe.db.get_list(
+ doc,
+ filters={
+ "patient": inpatient_record.patient,
+ "inpatient_record": inpatient_record.name,
+ "docstatus": 1,
+ "invoiced": 0,
+ },
+ )
def admit_patient(inpatient_record, service_unit, check_in, expected_discharge=None):
inpatient_record.admitted_datetime = check_in
- inpatient_record.status = 'Admitted'
+ inpatient_record.status = "Admitted"
inpatient_record.expected_discharge = expected_discharge
- inpatient_record.set('inpatient_occupancies', [])
+ inpatient_record.set("inpatient_occupancies", [])
transfer_patient(inpatient_record, service_unit, check_in)
- frappe.db.set_value('Patient', inpatient_record.patient, 'inpatient_status', 'Admitted')
- frappe.db.set_value('Patient', inpatient_record.patient, 'inpatient_record', inpatient_record.name)
+ frappe.db.set_value("Patient", inpatient_record.patient, "inpatient_status", "Admitted")
+ frappe.db.set_value(
+ "Patient", inpatient_record.patient, "inpatient_record", inpatient_record.name
+ )
def transfer_patient(inpatient_record, service_unit, check_in):
- item_line = inpatient_record.append('inpatient_occupancies', {})
+ item_line = inpatient_record.append("inpatient_occupancies", {})
item_line.service_unit = service_unit
item_line.check_in = check_in
- inpatient_record.save(ignore_permissions = True)
+ inpatient_record.save(ignore_permissions=True)
frappe.db.set_value("Healthcare Service Unit", service_unit, "occupancy_status", "Occupied")
@@ -270,27 +313,25 @@ def patient_leave_service_unit(inpatient_record, check_out, leave_from):
if inpatient_occupancy.left != 1 and inpatient_occupancy.service_unit == leave_from:
inpatient_occupancy.left = True
inpatient_occupancy.check_out = check_out
- frappe.db.set_value("Healthcare Service Unit", inpatient_occupancy.service_unit, "occupancy_status", "Vacant")
- inpatient_record.save(ignore_permissions = True)
+ frappe.db.set_value(
+ "Healthcare Service Unit", inpatient_occupancy.service_unit, "occupancy_status", "Vacant"
+ )
+ inpatient_record.save(ignore_permissions=True)
@frappe.whitelist()
@frappe.validate_and_sanitize_search_inputs
def get_leave_from(doctype, txt, searchfield, start, page_len, filters):
- docname = filters['docname']
+ docname = filters["docname"]
- query = '''select io.service_unit
+ query = """select io.service_unit
from `tabInpatient Occupancy` io, `tabInpatient Record` ir
where io.parent = '{docname}' and io.parentfield = 'inpatient_occupancies'
- and io.left!=1 and io.parent = ir.name'''
+ and io.left!=1 and io.parent = ir.name"""
- return frappe.db.sql(query.format(**{
- "docname": docname,
- "searchfield": searchfield,
- "mcond": get_match_cond(doctype)
- }), {
- 'txt': "%%%s%%" % txt,
- '_txt': txt.replace("%", ""),
- 'start': start,
- 'page_len': page_len
- })
+ return frappe.db.sql(
+ query.format(
+ **{"docname": docname, "searchfield": searchfield, "mcond": get_match_cond(doctype)}
+ ),
+ {"txt": "%%%s%%" % txt, "_txt": txt.replace("%", ""), "start": start, "page_len": page_len},
+ )
diff --git a/erpnext/healthcare/doctype/inpatient_record/inpatient_record_dashboard.py b/erpnext/healthcare/doctype/inpatient_record/inpatient_record_dashboard.py
index 979f18be408..0d4b850172f 100644
--- a/erpnext/healthcare/doctype/inpatient_record/inpatient_record_dashboard.py
+++ b/erpnext/healthcare/doctype/inpatient_record/inpatient_record_dashboard.py
@@ -1,18 +1,17 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'inpatient_record',
- 'transactions': [
+ "fieldname": "inpatient_record",
+ "transactions": [
{
- 'label': _('Appointments and Encounters'),
- 'items': ['Patient Appointment', 'Patient Encounter']
+ "label": _("Appointments and Encounters"),
+ "items": ["Patient Appointment", "Patient Encounter"],
},
{
- 'label': _('Lab Tests and Vital Signs'),
- 'items': ['Lab Test', 'Clinical Procedure', 'Sample Collection', 'Vital Signs']
- }
- ]
+ "label": _("Lab Tests and Vital Signs"),
+ "items": ["Lab Test", "Clinical Procedure", "Sample Collection", "Vital Signs"],
+ },
+ ],
}
diff --git a/erpnext/healthcare/doctype/inpatient_record/test_inpatient_record.py b/erpnext/healthcare/doctype/inpatient_record/test_inpatient_record.py
index bab778be630..571a77cd186 100644
--- a/erpnext/healthcare/doctype/inpatient_record/test_inpatient_record.py
+++ b/erpnext/healthcare/doctype/inpatient_record/test_inpatient_record.py
@@ -23,7 +23,7 @@ class TestInpatientRecord(unittest.TestCase):
# Schedule Admission
ip_record = create_inpatient(patient)
ip_record.expected_length_of_stay = 0
- ip_record.save(ignore_permissions = True)
+ ip_record.save(ignore_permissions=True)
self.assertEqual(ip_record.name, frappe.db.get_value("Patient", patient, "inpatient_record"))
self.assertEqual(ip_record.status, frappe.db.get_value("Patient", patient, "inpatient_status"))
@@ -31,11 +31,17 @@ class TestInpatientRecord(unittest.TestCase):
service_unit = get_healthcare_service_unit()
admit_patient(ip_record, service_unit, now_datetime())
self.assertEqual("Admitted", frappe.db.get_value("Patient", patient, "inpatient_status"))
- self.assertEqual("Occupied", frappe.db.get_value("Healthcare Service Unit", service_unit, "occupancy_status"))
+ self.assertEqual(
+ "Occupied", frappe.db.get_value("Healthcare Service Unit", service_unit, "occupancy_status")
+ )
# Discharge
- schedule_discharge(frappe.as_json({'patient': patient, 'discharge_ordered_datetime': now_datetime()}))
- self.assertEqual("Vacant", frappe.db.get_value("Healthcare Service Unit", service_unit, "occupancy_status"))
+ schedule_discharge(
+ frappe.as_json({"patient": patient, "discharge_ordered_datetime": now_datetime()})
+ )
+ self.assertEqual(
+ "Vacant", frappe.db.get_value("Healthcare Service Unit", service_unit, "occupancy_status")
+ )
ip_record1 = frappe.get_doc("Inpatient Record", ip_record.name)
# Validate Pending Invoices
@@ -54,15 +60,19 @@ class TestInpatientRecord(unittest.TestCase):
# Schedule Admission
ip_record = create_inpatient(patient)
ip_record.expected_length_of_stay = 0
- ip_record.save(ignore_permissions = True)
+ ip_record.save(ignore_permissions=True)
# Admit
service_unit = get_healthcare_service_unit()
admit_patient(ip_record, service_unit, now_datetime())
# Discharge
- schedule_discharge(frappe.as_json({"patient": patient, 'discharge_ordered_datetime': now_datetime()}))
- self.assertEqual("Vacant", frappe.db.get_value("Healthcare Service Unit", service_unit, "occupancy_status"))
+ schedule_discharge(
+ frappe.as_json({"patient": patient, "discharge_ordered_datetime": now_datetime()})
+ )
+ self.assertEqual(
+ "Vacant", frappe.db.get_value("Healthcare Service Unit", service_unit, "occupancy_status")
+ )
ip_record = frappe.get_doc("Inpatient Record", ip_record.name)
# Should not validate Pending Invoices
@@ -80,7 +90,7 @@ class TestInpatientRecord(unittest.TestCase):
# Schedule Admission
ip_record = create_inpatient(patient)
ip_record.expected_length_of_stay = 0
- ip_record.save(ignore_permissions = True)
+ ip_record.save(ignore_permissions=True)
# Admit
service_unit = get_healthcare_service_unit()
@@ -93,8 +103,12 @@ class TestInpatientRecord(unittest.TestCase):
self.assertFalse(patient_encounter.name in encounter_ids)
# Discharge
- schedule_discharge(frappe.as_json({"patient": patient, 'discharge_ordered_datetime': now_datetime()}))
- self.assertEqual("Vacant", frappe.db.get_value("Healthcare Service Unit", service_unit, "occupancy_status"))
+ schedule_discharge(
+ frappe.as_json({"patient": patient, "discharge_ordered_datetime": now_datetime()})
+ )
+ self.assertEqual(
+ "Vacant", frappe.db.get_value("Healthcare Service Unit", service_unit, "occupancy_status")
+ )
ip_record = frappe.get_doc("Inpatient Record", ip_record.name)
mark_invoiced_inpatient_occupancy(ip_record)
@@ -107,7 +121,7 @@ class TestInpatientRecord(unittest.TestCase):
ip_record = create_inpatient(patient)
ip_record.expected_length_of_stay = 0
- ip_record.save(ignore_permissions = True)
+ ip_record.save(ignore_permissions=True)
ip_record_new = create_inpatient(patient)
ip_record_new.expected_length_of_stay = 0
self.assertRaises(frappe.ValidationError, ip_record_new.save)
@@ -118,11 +132,12 @@ class TestInpatientRecord(unittest.TestCase):
self.assertRaises(frappe.ValidationError, ip_record_new.save)
frappe.db.sql("""delete from `tabInpatient Record`""")
+
def mark_invoiced_inpatient_occupancy(ip_record):
if ip_record.inpatient_occupancies:
for inpatient_occupancy in ip_record.inpatient_occupancies:
inpatient_occupancy.invoiced = 1
- ip_record.save(ignore_permissions = True)
+ ip_record.save(ignore_permissions=True)
def setup_inpatient_settings(key, value):
@@ -132,8 +147,8 @@ def setup_inpatient_settings(key, value):
def create_inpatient(patient):
- patient_obj = frappe.get_doc('Patient', patient)
- inpatient_record = frappe.new_doc('Inpatient Record')
+ patient_obj = frappe.get_doc("Patient", patient)
+ inpatient_record = frappe.new_doc("Inpatient Record")
inpatient_record.patient = patient
inpatient_record.patient_name = patient_obj.patient_name
inpatient_record.gender = patient_obj.sex
@@ -150,9 +165,13 @@ def create_inpatient(patient):
def get_healthcare_service_unit(unit_name=None):
if not unit_name:
- service_unit = get_random("Healthcare Service Unit", filters={"inpatient_occupancy": 1, "company": "_Test Company"})
+ service_unit = get_random(
+ "Healthcare Service Unit", filters={"inpatient_occupancy": 1, "company": "_Test Company"}
+ )
else:
- service_unit = frappe.db.exists("Healthcare Service Unit", {"healthcare_service_unit_name": unit_name})
+ service_unit = frappe.db.exists(
+ "Healthcare Service Unit", {"healthcare_service_unit_name": unit_name}
+ )
if not service_unit:
service_unit = frappe.new_doc("Healthcare Service Unit")
@@ -162,20 +181,22 @@ def get_healthcare_service_unit(unit_name=None):
service_unit.inpatient_occupancy = 1
service_unit.occupancy_status = "Vacant"
service_unit.is_group = 0
- service_unit_parent_name = frappe.db.exists({
+ service_unit_parent_name = frappe.db.exists(
+ {
"doctype": "Healthcare Service Unit",
"healthcare_service_unit_name": "_Test All Healthcare Service Units",
- "is_group": 1
- })
+ "is_group": 1,
+ }
+ )
if not service_unit_parent_name:
parent_service_unit = frappe.new_doc("Healthcare Service Unit")
parent_service_unit.healthcare_service_unit_name = "_Test All Healthcare Service Units"
parent_service_unit.is_group = 1
- parent_service_unit.save(ignore_permissions = True)
+ parent_service_unit.save(ignore_permissions=True)
service_unit.parent_healthcare_service_unit = parent_service_unit.name
else:
service_unit.parent_healthcare_service_unit = service_unit_parent_name[0][0]
- service_unit.save(ignore_permissions = True)
+ service_unit.save(ignore_permissions=True)
return service_unit.name
return service_unit
@@ -187,17 +208,17 @@ def get_service_unit_type():
service_unit_type = frappe.new_doc("Healthcare Service Unit Type")
service_unit_type.service_unit_type = "_Test Service Unit Type Ip Occupancy"
service_unit_type.inpatient_occupancy = 1
- service_unit_type.save(ignore_permissions = True)
+ service_unit_type.save(ignore_permissions=True)
return service_unit_type.name
return service_unit_type
def create_patient():
- patient = frappe.db.exists('Patient', '_Test IPD Patient')
+ patient = frappe.db.exists("Patient", "_Test IPD Patient")
if not patient:
- patient = frappe.new_doc('Patient')
- patient.first_name = '_Test IPD Patient'
- patient.sex = 'Female'
+ patient = frappe.new_doc("Patient")
+ patient.first_name = "_Test IPD Patient"
+ patient.sex = "Female"
patient.save(ignore_permissions=True)
patient = patient.name
return patient
diff --git a/erpnext/healthcare/doctype/lab_test/lab_test.json b/erpnext/healthcare/doctype/lab_test/lab_test.json
index ac61fea3ad7..cdf27aa06b3 100644
--- a/erpnext/healthcare/doctype/lab_test/lab_test.json
+++ b/erpnext/healthcare/doctype/lab_test/lab_test.json
@@ -99,7 +99,6 @@
"search_index": 1
},
{
- "fetch_from": "inpatient_record.patient",
"fieldname": "patient",
"fieldtype": "Link",
"ignore_user_permissions": 1,
@@ -559,7 +558,7 @@
],
"is_submittable": 1,
"links": [],
- "modified": "2020-11-30 11:04:17.195848",
+ "modified": "2022-01-20 12:37:07.943153",
"modified_by": "Administrator",
"module": "Healthcare",
"name": "Lab Test",
diff --git a/erpnext/healthcare/doctype/lab_test/lab_test.py b/erpnext/healthcare/doctype/lab_test/lab_test.py
index e322a74f488..9a8ad9382d8 100644
--- a/erpnext/healthcare/doctype/lab_test/lab_test.py
+++ b/erpnext/healthcare/doctype/lab_test/lab_test.py
@@ -15,11 +15,11 @@ class LabTest(Document):
def on_submit(self):
self.validate_result_values()
- self.db_set('submitted_date', getdate())
- self.db_set('status', 'Completed')
+ self.db_set("submitted_date", getdate())
+ self.db_set("status", "Completed")
def on_cancel(self):
- self.db_set('status', 'Cancelled')
+ self.db_set("status", "Cancelled")
self.reload()
def on_update(self):
@@ -31,8 +31,8 @@ class LabTest(Document):
def after_insert(self):
if self.prescription:
- frappe.db.set_value('Lab Prescription', self.prescription, 'lab_test_created', 1)
- if frappe.db.get_value('Lab Prescription', self.prescription, 'invoiced'):
+ frappe.db.set_value("Lab Prescription", self.prescription, "lab_test_created", 1)
+ if frappe.db.get_value("Lab Prescription", self.prescription, "invoiced"):
self.invoiced = True
if self.template:
self.load_test_from_template()
@@ -49,26 +49,36 @@ class LabTest(Document):
try:
item.secondary_uom_result = float(item.result_value) * float(item.conversion_factor)
except Exception:
- item.secondary_uom_result = ''
- frappe.msgprint(_('Row #{0}: Result for Secondary UOM not calculated').format(item.idx), title = _('Warning'))
+ item.secondary_uom_result = ""
+ frappe.msgprint(
+ _("Row #{0}: Result for Secondary UOM not calculated").format(item.idx), title=_("Warning")
+ )
def validate_result_values(self):
if self.normal_test_items:
for item in self.normal_test_items:
if not item.result_value and not item.allow_blank and item.require_result_value:
- frappe.throw(_('Row #{0}: Please enter the result value for {1}').format(
- item.idx, frappe.bold(item.lab_test_name)), title=_('Mandatory Results'))
+ frappe.throw(
+ _("Row #{0}: Please enter the result value for {1}").format(
+ item.idx, frappe.bold(item.lab_test_name)
+ ),
+ title=_("Mandatory Results"),
+ )
if self.descriptive_test_items:
for item in self.descriptive_test_items:
if not item.result_value and not item.allow_blank and item.require_result_value:
- frappe.throw(_('Row #{0}: Please enter the result value for {1}').format(
- item.idx, frappe.bold(item.lab_test_particulars)), title=_('Mandatory Results'))
+ frappe.throw(
+ _("Row #{0}: Please enter the result value for {1}").format(
+ item.idx, frappe.bold(item.lab_test_particulars)
+ ),
+ title=_("Mandatory Results"),
+ )
def create_test_from_template(lab_test):
- template = frappe.get_doc('Lab Test Template', lab_test.template)
- patient = frappe.get_doc('Patient', lab_test.patient)
+ template = frappe.get_doc("Lab Test Template", lab_test.template)
+ patient = frappe.get_doc("Patient", lab_test.patient)
lab_test.lab_test_name = template.lab_test_name
lab_test.result_date = getdate()
@@ -81,85 +91,98 @@ def create_test_from_template(lab_test):
lab_test = create_sample_collection(lab_test, template, patient, None)
lab_test = load_result_format(lab_test, template, None, None)
+
@frappe.whitelist()
def update_status(status, name):
if name and status:
- frappe.db.set_value('Lab Test', name, {
- 'status': status,
- 'approved_date': getdate()
- })
+ frappe.db.set_value("Lab Test", name, {"status": status, "approved_date": getdate()})
+
@frappe.whitelist()
def create_multiple(doctype, docname):
if not doctype or not docname:
- frappe.throw(_('Sales Invoice or Patient Encounter is required to create Lab Tests'), title=_('Insufficient Data'))
+ frappe.throw(
+ _("Sales Invoice or Patient Encounter is required to create Lab Tests"),
+ title=_("Insufficient Data"),
+ )
lab_test_created = False
- if doctype == 'Sales Invoice':
+ if doctype == "Sales Invoice":
lab_test_created = create_lab_test_from_invoice(docname)
- elif doctype == 'Patient Encounter':
+ elif doctype == "Patient Encounter":
lab_test_created = create_lab_test_from_encounter(docname)
if lab_test_created:
- frappe.msgprint(_('Lab Test(s) {0} created successfully').format(lab_test_created), indicator='green')
+ frappe.msgprint(
+ _("Lab Test(s) {0} created successfully").format(lab_test_created), indicator="green"
+ )
else:
- frappe.msgprint(_('No Lab Tests created'))
+ frappe.msgprint(_("No Lab Tests created"))
+
def create_lab_test_from_encounter(encounter):
lab_test_created = False
- encounter = frappe.get_doc('Patient Encounter', encounter)
+ encounter = frappe.get_doc("Patient Encounter", encounter)
if encounter and encounter.lab_test_prescription:
- patient = frappe.get_doc('Patient', encounter.patient)
+ patient = frappe.get_doc("Patient", encounter.patient)
for item in encounter.lab_test_prescription:
if not item.lab_test_created:
template = get_lab_test_template(item.lab_test_code)
if template:
- lab_test = create_lab_test_doc(item.invoiced, encounter.practitioner, patient, template, encounter.company)
- lab_test.save(ignore_permissions = True)
- frappe.db.set_value('Lab Prescription', item.name, 'lab_test_created', 1)
+ lab_test = create_lab_test_doc(
+ item.invoiced, encounter.practitioner, patient, template, encounter.company
+ )
+ lab_test.save(ignore_permissions=True)
+ frappe.db.set_value("Lab Prescription", item.name, "lab_test_created", 1)
if not lab_test_created:
lab_test_created = lab_test.name
else:
- lab_test_created += ', ' + lab_test.name
+ lab_test_created += ", " + lab_test.name
return lab_test_created
def create_lab_test_from_invoice(sales_invoice):
lab_tests_created = False
- invoice = frappe.get_doc('Sales Invoice', sales_invoice)
+ invoice = frappe.get_doc("Sales Invoice", sales_invoice)
if invoice and invoice.patient:
- patient = frappe.get_doc('Patient', invoice.patient)
+ patient = frappe.get_doc("Patient", invoice.patient)
for item in invoice.items:
lab_test_created = 0
- if item.reference_dt == 'Lab Prescription':
- lab_test_created = frappe.db.get_value('Lab Prescription', item.reference_dn, 'lab_test_created')
- elif item.reference_dt == 'Lab Test':
+ if item.reference_dt == "Lab Prescription":
+ lab_test_created = frappe.db.get_value(
+ "Lab Prescription", item.reference_dn, "lab_test_created"
+ )
+ elif item.reference_dt == "Lab Test":
lab_test_created = 1
if lab_test_created != 1:
template = get_lab_test_template(item.item_code)
if template:
- lab_test = create_lab_test_doc(True, invoice.ref_practitioner, patient, template, invoice.company)
- if item.reference_dt == 'Lab Prescription':
+ lab_test = create_lab_test_doc(
+ True, invoice.ref_practitioner, patient, template, invoice.company
+ )
+ if item.reference_dt == "Lab Prescription":
lab_test.prescription = item.reference_dn
- lab_test.save(ignore_permissions = True)
- if item.reference_dt != 'Lab Prescription':
- frappe.db.set_value('Sales Invoice Item', item.name, 'reference_dt', 'Lab Test')
- frappe.db.set_value('Sales Invoice Item', item.name, 'reference_dn', lab_test.name)
+ lab_test.save(ignore_permissions=True)
+ if item.reference_dt != "Lab Prescription":
+ frappe.db.set_value("Sales Invoice Item", item.name, "reference_dt", "Lab Test")
+ frappe.db.set_value("Sales Invoice Item", item.name, "reference_dn", lab_test.name)
if not lab_tests_created:
lab_tests_created = lab_test.name
else:
- lab_tests_created += ', ' + lab_test.name
+ lab_tests_created += ", " + lab_test.name
return lab_tests_created
+
def get_lab_test_template(item):
- template_id = frappe.db.exists('Lab Test Template', {'item': item})
+ template_id = frappe.db.exists("Lab Test Template", {"item": item})
if template_id:
- return frappe.get_doc('Lab Test Template', template_id)
+ return frappe.get_doc("Lab Test Template", template_id)
return False
+
def create_lab_test_doc(invoiced, practitioner, patient, template, company):
- lab_test = frappe.new_doc('Lab Test')
+ lab_test = frappe.new_doc("Lab Test")
lab_test.invoiced = invoiced
lab_test.practitioner = practitioner
lab_test.patient = patient.name
@@ -175,9 +198,10 @@ def create_lab_test_doc(invoiced, practitioner, patient, template, company):
lab_test.company = company
return lab_test
+
def create_normals(template, lab_test):
lab_test.normal_toggle = 1
- normal = lab_test.append('normal_test_items')
+ normal = lab_test.append("normal_test_items")
normal.lab_test_name = template.lab_test_name
normal.lab_test_uom = template.lab_test_uom
normal.secondary_uom = template.secondary_uom
@@ -187,10 +211,11 @@ def create_normals(template, lab_test):
normal.allow_blank = 0
normal.template = template.name
+
def create_compounds(template, lab_test, is_group):
lab_test.normal_toggle = 1
for normal_test_template in template.normal_test_templates:
- normal = lab_test.append('normal_test_items')
+ normal = lab_test.append("normal_test_items")
if is_group:
normal.lab_test_event = normal_test_template.lab_test_event
else:
@@ -204,41 +229,47 @@ def create_compounds(template, lab_test, is_group):
normal.allow_blank = normal_test_template.allow_blank
normal.template = template.name
+
def create_descriptives(template, lab_test):
lab_test.descriptive_toggle = 1
if template.sensitivity:
lab_test.sensitivity_toggle = 1
for descriptive_test_template in template.descriptive_test_templates:
- descriptive = lab_test.append('descriptive_test_items')
+ descriptive = lab_test.append("descriptive_test_items")
descriptive.lab_test_particulars = descriptive_test_template.particulars
descriptive.require_result_value = 1
descriptive.allow_blank = descriptive_test_template.allow_blank
descriptive.template = template.name
-def create_sample_doc(template, patient, invoice, company = None):
+
+def create_sample_doc(template, patient, invoice, company=None):
if template.sample:
- sample_exists = frappe.db.exists({
- 'doctype': 'Sample Collection',
- 'patient': patient.name,
- 'docstatus': 0,
- 'sample': template.sample
- })
+ sample_exists = frappe.db.exists(
+ {
+ "doctype": "Sample Collection",
+ "patient": patient.name,
+ "docstatus": 0,
+ "sample": template.sample,
+ }
+ )
if sample_exists:
# update sample collection by adding quantity
- sample_collection = frappe.get_doc('Sample Collection', sample_exists[0][0])
+ sample_collection = frappe.get_doc("Sample Collection", sample_exists[0][0])
quantity = int(sample_collection.sample_qty) + int(template.sample_qty)
if template.sample_details:
- sample_details = sample_collection.sample_details + '\n-\n' + _('Test :')
- sample_details += (template.get('lab_test_name') or template.get('template')) + '\n'
- sample_details += _('Collection Details:') + '\n\t' + template.sample_details
- frappe.db.set_value('Sample Collection', sample_collection.name, 'sample_details', sample_details)
+ sample_details = sample_collection.sample_details + "\n-\n" + _("Test :")
+ sample_details += (template.get("lab_test_name") or template.get("template")) + "\n"
+ sample_details += _("Collection Details:") + "\n\t" + template.sample_details
+ frappe.db.set_value(
+ "Sample Collection", sample_collection.name, "sample_details", sample_details
+ )
- frappe.db.set_value('Sample Collection', sample_collection.name, 'sample_qty', quantity)
+ frappe.db.set_value("Sample Collection", sample_collection.name, "sample_qty", quantity)
else:
# Create Sample Collection for template, copy vals from Invoice
- sample_collection = frappe.new_doc('Sample Collection')
+ sample_collection = frappe.new_doc("Sample Collection")
if invoice:
sample_collection.invoiced = True
@@ -251,59 +282,70 @@ def create_sample_doc(template, patient, invoice, company = None):
sample_collection.company = company
if template.sample_details:
- sample_collection.sample_details = _('Test :') + (template.get('lab_test_name') or template.get('template')) + '\n' + 'Collection Detials:\n\t' + template.sample_details
+ sample_collection.sample_details = (
+ _("Test :")
+ + (template.get("lab_test_name") or template.get("template"))
+ + "\n"
+ + "Collection Detials:\n\t"
+ + template.sample_details
+ )
sample_collection.save(ignore_permissions=True)
return sample_collection
+
def create_sample_collection(lab_test, template, patient, invoice):
- if frappe.get_cached_value('Healthcare Settings', None, 'create_sample_collection_for_lab_test'):
+ if frappe.get_cached_value("Healthcare Settings", None, "create_sample_collection_for_lab_test"):
sample_collection = create_sample_doc(template, patient, invoice, lab_test.company)
if sample_collection:
lab_test.sample = sample_collection.name
- sample_collection_doc = get_link_to_form('Sample Collection', sample_collection.name)
- frappe.msgprint(_('Sample Collection {0} has been created').format(sample_collection_doc),
- title=_('Sample Collection'), indicator='green')
+ sample_collection_doc = get_link_to_form("Sample Collection", sample_collection.name)
+ frappe.msgprint(
+ _("Sample Collection {0} has been created").format(sample_collection_doc),
+ title=_("Sample Collection"),
+ indicator="green",
+ )
return lab_test
+
def load_result_format(lab_test, template, prescription, invoice):
- if template.lab_test_template_type == 'Single':
+ if template.lab_test_template_type == "Single":
create_normals(template, lab_test)
- elif template.lab_test_template_type == 'Compound':
+ elif template.lab_test_template_type == "Compound":
create_compounds(template, lab_test, False)
- elif template.lab_test_template_type == 'Descriptive':
+ elif template.lab_test_template_type == "Descriptive":
create_descriptives(template, lab_test)
- elif template.lab_test_template_type == 'Grouped':
+ elif template.lab_test_template_type == "Grouped":
# Iterate for each template in the group and create one result for all.
for lab_test_group in template.lab_test_groups:
# Template_in_group = None
if lab_test_group.lab_test_template:
- template_in_group = frappe.get_doc('Lab Test Template', lab_test_group.lab_test_template)
+ template_in_group = frappe.get_doc("Lab Test Template", lab_test_group.lab_test_template)
if template_in_group:
- if template_in_group.lab_test_template_type == 'Single':
+ if template_in_group.lab_test_template_type == "Single":
create_normals(template_in_group, lab_test)
- elif template_in_group.lab_test_template_type == 'Compound':
- normal_heading = lab_test.append('normal_test_items')
+ elif template_in_group.lab_test_template_type == "Compound":
+ normal_heading = lab_test.append("normal_test_items")
normal_heading.lab_test_name = template_in_group.lab_test_name
normal_heading.require_result_value = 0
normal_heading.allow_blank = 1
normal_heading.template = template_in_group.name
create_compounds(template_in_group, lab_test, True)
- elif template_in_group.lab_test_template_type == 'Descriptive':
- descriptive_heading = lab_test.append('descriptive_test_items')
+ elif template_in_group.lab_test_template_type == "Descriptive":
+ descriptive_heading = lab_test.append("descriptive_test_items")
descriptive_heading.lab_test_name = template_in_group.lab_test_name
descriptive_heading.require_result_value = 0
descriptive_heading.allow_blank = 1
descriptive_heading.template = template_in_group.name
create_descriptives(template_in_group, lab_test)
- else: # Lab Test Group - Add New Line
- normal = lab_test.append('normal_test_items')
+ else: # Lab Test Group - Add New Line
+ normal = lab_test.append("normal_test_items")
normal.lab_test_name = lab_test_group.group_event
normal.lab_test_uom = lab_test_group.group_test_uom
normal.secondary_uom = lab_test_group.secondary_uom
@@ -313,26 +355,27 @@ def load_result_format(lab_test, template, prescription, invoice):
normal.require_result_value = 1
normal.template = template.name
- if template.lab_test_template_type != 'No Result':
+ if template.lab_test_template_type != "No Result":
if prescription:
lab_test.prescription = prescription
if invoice:
- frappe.db.set_value('Lab Prescription', prescription, 'invoiced', True)
- lab_test.save(ignore_permissions=True) # Insert the result
+ frappe.db.set_value("Lab Prescription", prescription, "invoiced", True)
+ lab_test.save(ignore_permissions=True) # Insert the result
return lab_test
+
@frappe.whitelist()
def get_employee_by_user_id(user_id):
- emp_id = frappe.db.exists('Employee', { 'user_id': user_id })
+ emp_id = frappe.db.exists("Employee", {"user_id": user_id})
if emp_id:
- return frappe.get_doc('Employee', emp_id)
+ return frappe.get_doc("Employee", emp_id)
return None
@frappe.whitelist()
def get_lab_test_prescribed(patient):
return frappe.db.sql(
- '''
+ """
select
lp.name,
lp.lab_test_code,
@@ -347,4 +390,6 @@ def get_lab_test_prescribed(patient):
pe.patient=%s
and lp.parent=pe.name
and lp.lab_test_created=0
- ''', (patient))
+ """,
+ (patient),
+ )
diff --git a/erpnext/healthcare/doctype/lab_test/test_lab_test.py b/erpnext/healthcare/doctype/lab_test/test_lab_test.py
index 3ec4412ab0c..c08820f36be 100644
--- a/erpnext/healthcare/doctype/lab_test/test_lab_test.py
+++ b/erpnext/healthcare/doctype/lab_test/test_lab_test.py
@@ -20,12 +20,15 @@ from erpnext.healthcare.doctype.patient_medical_record.test_patient_medical_reco
class TestLabTest(unittest.TestCase):
def test_lab_test_item(self):
lab_template = create_lab_test_template()
- self.assertTrue(frappe.db.exists('Item', lab_template.item))
- self.assertEqual(frappe.db.get_value('Item Price', {'item_code':lab_template.item}, 'price_list_rate'), lab_template.lab_test_rate)
+ self.assertTrue(frappe.db.exists("Item", lab_template.item))
+ self.assertEqual(
+ frappe.db.get_value("Item Price", {"item_code": lab_template.item}, "price_list_rate"),
+ lab_template.lab_test_rate,
+ )
lab_template.disabled = 1
lab_template.save()
- self.assertEqual(frappe.db.get_value('Item', lab_template.item, 'disabled'), 1)
+ self.assertEqual(frappe.db.get_value("Item", lab_template.item, "disabled"), 1)
lab_template.reload()
@@ -43,7 +46,9 @@ class TestLabTest(unittest.TestCase):
self.assertRaises(frappe.ValidationError, lab_test.submit)
def test_sample_collection(self):
- frappe.db.set_value('Healthcare Settings', 'Healthcare Settings', 'create_sample_collection_for_lab_test', 1)
+ frappe.db.set_value(
+ "Healthcare Settings", "Healthcare Settings", "create_sample_collection_for_lab_test", 1
+ )
lab_template = create_lab_test_template()
lab_test = create_lab_test(lab_template)
@@ -53,9 +58,11 @@ class TestLabTest(unittest.TestCase):
lab_test.save()
# check sample collection created
- self.assertTrue(frappe.db.exists('Sample Collection', {'sample': lab_template.sample}))
+ self.assertTrue(frappe.db.exists("Sample Collection", {"sample": lab_template.sample}))
- frappe.db.set_value('Healthcare Settings', 'Healthcare Settings', 'create_sample_collection_for_lab_test', 0)
+ frappe.db.set_value(
+ "Healthcare Settings", "Healthcare Settings", "create_sample_collection_for_lab_test", 0
+ )
lab_test = create_lab_test(lab_template)
lab_test.descriptive_test_items[0].result_value = 12
lab_test.descriptive_test_items[1].result_value = 1
@@ -68,14 +75,14 @@ class TestLabTest(unittest.TestCase):
def test_create_lab_tests_from_sales_invoice(self):
sales_invoice = create_sales_invoice()
- create_multiple('Sales Invoice', sales_invoice.name)
+ create_multiple("Sales Invoice", sales_invoice.name)
sales_invoice.reload()
self.assertIsNotNone(sales_invoice.items[0].reference_dn)
self.assertIsNotNone(sales_invoice.items[1].reference_dn)
def test_create_lab_tests_from_patient_encounter(self):
patient_encounter = create_patient_encounter()
- create_multiple('Patient Encounter', patient_encounter.name)
+ create_multiple("Patient Encounter", patient_encounter.name)
patient_encounter.reload()
self.assertTrue(patient_encounter.lab_test_prescription[0].lab_test_created)
self.assertTrue(patient_encounter.lab_test_prescription[0].lab_test_created)
@@ -83,23 +90,22 @@ class TestLabTest(unittest.TestCase):
def create_lab_test_template(test_sensitivity=0, sample_collection=1):
medical_department = create_medical_department()
- if frappe.db.exists('Lab Test Template', 'Insulin Resistance'):
- return frappe.get_doc('Lab Test Template', 'Insulin Resistance')
- template = frappe.new_doc('Lab Test Template')
- template.lab_test_name = 'Insulin Resistance'
- template.lab_test_template_type = 'Descriptive'
- template.lab_test_code = 'Insulin Resistance'
- template.lab_test_group = 'Services'
+ if frappe.db.exists("Lab Test Template", "Insulin Resistance"):
+ return frappe.get_doc("Lab Test Template", "Insulin Resistance")
+ template = frappe.new_doc("Lab Test Template")
+ template.lab_test_name = "Insulin Resistance"
+ template.lab_test_template_type = "Descriptive"
+ template.lab_test_code = "Insulin Resistance"
+ template.lab_test_group = "Services"
template.department = medical_department
template.is_billable = 1
- template.lab_test_description = 'Insulin Resistance'
+ template.lab_test_description = "Insulin Resistance"
template.lab_test_rate = 2000
- for entry in ['FBS', 'Insulin', 'IR']:
- template.append('descriptive_test_templates', {
- 'particulars': entry,
- 'allow_blank': 1 if entry=='IR' else 0
- })
+ for entry in ["FBS", "Insulin", "IR"]:
+ template.append(
+ "descriptive_test_templates", {"particulars": entry, "allow_blank": 1 if entry == "IR" else 0}
+ )
if test_sensitivity:
template.sensitivity = 1
@@ -111,77 +117,86 @@ def create_lab_test_template(test_sensitivity=0, sample_collection=1):
template.save()
return template
+
def create_medical_department():
- medical_department = frappe.db.exists('Medical Department', '_Test Medical Department')
+ medical_department = frappe.db.exists("Medical Department", "_Test Medical Department")
if not medical_department:
- medical_department = frappe.new_doc('Medical Department')
- medical_department.department = '_Test Medical Department'
+ medical_department = frappe.new_doc("Medical Department")
+ medical_department.department = "_Test Medical Department"
medical_department.save()
medical_department = medical_department.name
return medical_department
+
def create_lab_test(lab_template):
patient = create_patient()
- lab_test = frappe.new_doc('Lab Test')
+ lab_test = frappe.new_doc("Lab Test")
lab_test.template = lab_template.name
lab_test.patient = patient
- lab_test.patient_sex = 'Female'
+ lab_test.patient_sex = "Female"
lab_test.save()
return lab_test
+
def create_lab_test_sample():
- blood_sample = frappe.db.exists('Lab Test Sample', 'Blood Sample')
+ blood_sample = frappe.db.exists("Lab Test Sample", "Blood Sample")
if blood_sample:
return blood_sample
- sample = frappe.new_doc('Lab Test Sample')
- sample.sample = 'Blood Sample'
- sample.sample_uom = 'U/ml'
+ sample = frappe.new_doc("Lab Test Sample")
+ sample.sample = "Blood Sample"
+ sample.sample_uom = "U/ml"
sample.save()
return sample.name
+
def create_sales_invoice():
patient = create_patient()
medical_department = create_medical_department()
insulin_resistance_template = create_lab_test_template()
blood_test_template = create_blood_test_template(medical_department)
- sales_invoice = frappe.new_doc('Sales Invoice')
+ sales_invoice = frappe.new_doc("Sales Invoice")
sales_invoice.patient = patient
- sales_invoice.customer = frappe.db.get_value('Patient', patient, 'customer')
+ sales_invoice.customer = frappe.db.get_value("Patient", patient, "customer")
sales_invoice.due_date = getdate()
- sales_invoice.company = '_Test Company'
- sales_invoice.debit_to = get_receivable_account('_Test Company')
+ sales_invoice.company = "_Test Company"
+ sales_invoice.currency = "INR"
+ sales_invoice.debit_to = get_receivable_account("_Test Company")
tests = [insulin_resistance_template, blood_test_template]
for entry in tests:
- sales_invoice.append('items', {
- 'item_code': entry.item,
- 'item_name': entry.lab_test_name,
- 'description': entry.lab_test_description,
- 'qty': 1,
- 'uom': 'Nos',
- 'conversion_factor': 1,
- 'income_account': get_income_account(None, '_Test Company'),
- 'rate': entry.lab_test_rate,
- 'amount': entry.lab_test_rate
- })
+ sales_invoice.append(
+ "items",
+ {
+ "item_code": entry.item,
+ "item_name": entry.lab_test_name,
+ "description": entry.lab_test_description,
+ "qty": 1,
+ "uom": "Nos",
+ "conversion_factor": 1,
+ "income_account": get_income_account(None, "_Test Company"),
+ "rate": entry.lab_test_rate,
+ "amount": entry.lab_test_rate,
+ },
+ )
sales_invoice.set_missing_values()
sales_invoice.submit()
return sales_invoice
+
def create_patient_encounter():
patient = create_patient()
medical_department = create_medical_department()
insulin_resistance_template = create_lab_test_template()
blood_test_template = create_blood_test_template(medical_department)
- patient_encounter = frappe.new_doc('Patient Encounter')
+ patient_encounter = frappe.new_doc("Patient Encounter")
patient_encounter.patient = patient
patient_encounter.practitioner = create_practitioner()
patient_encounter.encounter_date = getdate()
@@ -189,22 +204,21 @@ def create_patient_encounter():
tests = [insulin_resistance_template, blood_test_template]
for entry in tests:
- patient_encounter.append('lab_test_prescription', {
- 'lab_test_code': entry.item,
- 'lab_test_name': entry.lab_test_name
- })
+ patient_encounter.append(
+ "lab_test_prescription", {"lab_test_code": entry.item, "lab_test_name": entry.lab_test_name}
+ )
patient_encounter.submit()
return patient_encounter
def create_practitioner():
- practitioner = frappe.db.exists('Healthcare Practitioner', '_Test Healthcare Practitioner')
+ practitioner = frappe.db.exists("Healthcare Practitioner", "_Test Healthcare Practitioner")
if not practitioner:
- practitioner = frappe.new_doc('Healthcare Practitioner')
- practitioner.first_name = '_Test Healthcare Practitioner'
- practitioner.gender = 'Female'
+ practitioner = frappe.new_doc("Healthcare Practitioner")
+ practitioner.first_name = "_Test Healthcare Practitioner"
+ practitioner.gender = "Female"
practitioner.op_consulting_charge = 500
practitioner.inpatient_visit_charge = 500
practitioner.save(ignore_permissions=True)
diff --git a/erpnext/healthcare/doctype/lab_test_template/lab_test_template.py b/erpnext/healthcare/doctype/lab_test_template/lab_test_template.py
index 2cd3a4d20fa..0f3561f6f9f 100644
--- a/erpnext/healthcare/doctype/lab_test_template/lab_test_template.py
+++ b/erpnext/healthcare/doctype/lab_test_template/lab_test_template.py
@@ -17,7 +17,7 @@ class LabTestTemplate(Document):
def validate(self):
if self.is_billable and (not self.lab_test_rate or self.lab_test_rate <= 0.0):
- frappe.throw(_('Standard Selling Rate should be greater than zero.'))
+ frappe.throw(_("Standard Selling Rate should be greater than zero."))
self.validate_conversion_factor()
self.enable_disable_item()
@@ -29,15 +29,17 @@ class LabTestTemplate(Document):
item_price = self.item_price_exists()
if not item_price:
if self.lab_test_rate and self.lab_test_rate > 0.0:
- price_list_name = frappe.db.get_value('Selling Settings', None, 'selling_price_list') or frappe.db.get_value('Price List', {'selling': 1})
+ price_list_name = frappe.db.get_value(
+ "Selling Settings", None, "selling_price_list"
+ ) or frappe.db.get_value("Price List", {"selling": 1})
make_item_price(self.lab_test_code, price_list_name, self.lab_test_rate)
else:
- frappe.db.set_value('Item Price', item_price, 'price_list_rate', self.lab_test_rate)
+ frappe.db.set_value("Item Price", item_price, "price_list_rate", self.lab_test_rate)
- self.db_set('change_in_item', 0)
+ self.db_set("change_in_item", 0)
elif not self.is_billable and self.item:
- frappe.db.set_value('Item', self.item, 'disabled', 1)
+ frappe.db.set_value("Item", self.item, "disabled", 1)
self.reload()
@@ -46,99 +48,113 @@ class LabTestTemplate(Document):
if self.item:
try:
item = self.item
- self.db_set('item', '')
- frappe.delete_doc('Item', item)
+ self.db_set("item", "")
+ frappe.delete_doc("Item", item)
except Exception:
- frappe.throw(_('Not permitted. Please disable the Lab Test Template'))
+ frappe.throw(_("Not permitted. Please disable the Lab Test Template"))
def enable_disable_item(self):
if self.is_billable:
if self.disabled:
- frappe.db.set_value('Item', self.item, 'disabled', 1)
+ frappe.db.set_value("Item", self.item, "disabled", 1)
else:
- frappe.db.set_value('Item', self.item, 'disabled', 0)
+ frappe.db.set_value("Item", self.item, "disabled", 0)
def update_item(self):
- item = frappe.get_doc('Item', self.item)
+ item = frappe.get_doc("Item", self.item)
if item:
- item.update({
- 'item_name': self.lab_test_name,
- 'item_group': self.lab_test_group,
- 'disabled': 0,
- 'standard_rate': self.lab_test_rate,
- 'description': self.lab_test_description
- })
+ item.update(
+ {
+ "item_name": self.lab_test_name,
+ "item_group": self.lab_test_group,
+ "disabled": 0,
+ "standard_rate": self.lab_test_rate,
+ "description": self.lab_test_description,
+ }
+ )
item.flags.ignore_mandatory = True
item.save(ignore_permissions=True)
def item_price_exists(self):
- item_price = frappe.db.exists({'doctype': 'Item Price', 'item_code': self.lab_test_code})
+ item_price = frappe.db.exists({"doctype": "Item Price", "item_code": self.lab_test_code})
if item_price:
return item_price[0][0]
return False
def validate_conversion_factor(self):
- if self.lab_test_template_type == 'Single' and self.secondary_uom and not self.conversion_factor:
- frappe.throw(_('Conversion Factor is mandatory'))
- if self.lab_test_template_type == 'Compound':
+ if self.lab_test_template_type == "Single" and self.secondary_uom and not self.conversion_factor:
+ frappe.throw(_("Conversion Factor is mandatory"))
+ if self.lab_test_template_type == "Compound":
for item in self.normal_test_templates:
if item.secondary_uom and not item.conversion_factor:
- frappe.throw(_('Row #{0}: Conversion Factor is mandatory').format(item.idx))
- if self.lab_test_template_type == 'Grouped':
+ frappe.throw(_("Row #{0}: Conversion Factor is mandatory").format(item.idx))
+ if self.lab_test_template_type == "Grouped":
for group in self.lab_test_groups:
- if group.template_or_new_line == 'Add New Line' and group.secondary_uom and not group.conversion_factor:
- frappe.throw(_('Row #{0}: Conversion Factor is mandatory').format(group.idx))
+ if (
+ group.template_or_new_line == "Add New Line"
+ and group.secondary_uom
+ and not group.conversion_factor
+ ):
+ frappe.throw(_("Row #{0}: Conversion Factor is mandatory").format(group.idx))
def create_item_from_template(doc):
- uom = frappe.db.exists('UOM', 'Unit') or frappe.db.get_single_value('Stock Settings', 'stock_uom')
+ uom = frappe.db.exists("UOM", "Unit") or frappe.db.get_single_value("Stock Settings", "stock_uom")
# Insert item
- item = frappe.get_doc({
- 'doctype': 'Item',
- 'item_code': doc.lab_test_code,
- 'item_name':doc.lab_test_name,
- 'item_group': doc.lab_test_group,
- 'description':doc.lab_test_description,
- 'is_sales_item': 1,
- 'is_service_item': 1,
- 'is_purchase_item': 0,
- 'is_stock_item': 0,
- 'include_item_in_manufacturing': 0,
- 'show_in_website': 0,
- 'is_pro_applicable': 0,
- 'disabled': 0 if doc.is_billable and not doc.disabled else doc.disabled,
- 'stock_uom': uom
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ item = frappe.get_doc(
+ {
+ "doctype": "Item",
+ "item_code": doc.lab_test_code,
+ "item_name": doc.lab_test_name,
+ "item_group": doc.lab_test_group,
+ "description": doc.lab_test_description,
+ "is_sales_item": 1,
+ "is_service_item": 1,
+ "is_purchase_item": 0,
+ "is_stock_item": 0,
+ "include_item_in_manufacturing": 0,
+ "show_in_website": 0,
+ "is_pro_applicable": 0,
+ "disabled": 0 if doc.is_billable and not doc.disabled else doc.disabled,
+ "stock_uom": uom,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
# Insert item price
if doc.is_billable and doc.lab_test_rate != 0.0:
- price_list_name = frappe.db.get_value('Selling Settings', None, 'selling_price_list') or frappe.db.get_value('Price List', {'selling': 1})
+ price_list_name = frappe.db.get_value(
+ "Selling Settings", None, "selling_price_list"
+ ) or frappe.db.get_value("Price List", {"selling": 1})
if doc.lab_test_rate:
make_item_price(item.name, price_list_name, doc.lab_test_rate)
else:
make_item_price(item.name, price_list_name, 0.0)
# Set item in the template
- frappe.db.set_value('Lab Test Template', doc.name, 'item', item.name)
+ frappe.db.set_value("Lab Test Template", doc.name, "item", item.name)
doc.reload()
+
def make_item_price(item, price_list_name, item_price):
- frappe.get_doc({
- 'doctype': 'Item Price',
- 'price_list': price_list_name,
- 'item_code': item,
- 'price_list_rate': item_price
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ frappe.get_doc(
+ {
+ "doctype": "Item Price",
+ "price_list": price_list_name,
+ "item_code": item,
+ "price_list_rate": item_price,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
+
@frappe.whitelist()
def change_test_code_from_template(lab_test_code, doc):
doc = frappe._dict(json.loads(doc))
- if frappe.db.exists({'doctype': 'Item', 'item_code': lab_test_code}):
- frappe.throw(_('Lab Test Item {0} already exist').format(lab_test_code))
+ if frappe.db.exists({"doctype": "Item", "item_code": lab_test_code}):
+ frappe.throw(_("Lab Test Item {0} already exist").format(lab_test_code))
else:
- rename_doc('Item', doc.name, lab_test_code, ignore_permissions=True)
- frappe.db.set_value('Lab Test Template', doc.name, 'lab_test_code', lab_test_code)
- frappe.db.set_value('Lab Test Template', doc.name, 'lab_test_name', lab_test_code)
- rename_doc('Lab Test Template', doc.name, lab_test_code, ignore_permissions=True)
+ rename_doc("Item", doc.name, lab_test_code, ignore_permissions=True)
+ frappe.db.set_value("Lab Test Template", doc.name, "lab_test_code", lab_test_code)
+ frappe.db.set_value("Lab Test Template", doc.name, "lab_test_name", lab_test_code)
+ rename_doc("Lab Test Template", doc.name, lab_test_code, ignore_permissions=True)
return lab_test_code
diff --git a/erpnext/healthcare/doctype/lab_test_template/lab_test_template_dashboard.py b/erpnext/healthcare/doctype/lab_test_template/lab_test_template_dashboard.py
index 8be84ff1ab1..fef381af0e6 100644
--- a/erpnext/healthcare/doctype/lab_test_template/lab_test_template_dashboard.py
+++ b/erpnext/healthcare/doctype/lab_test_template/lab_test_template_dashboard.py
@@ -1,14 +1,8 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'template',
- 'transactions': [
- {
- 'label': _('Lab Tests'),
- 'items': ['Lab Test']
- }
- ]
+ "fieldname": "template",
+ "transactions": [{"label": _("Lab Tests"), "items": ["Lab Test"]}],
}
diff --git a/erpnext/healthcare/doctype/lab_test_template/test_lab_test_template.py b/erpnext/healthcare/doctype/lab_test_template/test_lab_test_template.py
index c3b4d59e431..3848466339d 100644
--- a/erpnext/healthcare/doctype/lab_test_template/test_lab_test_template.py
+++ b/erpnext/healthcare/doctype/lab_test_template/test_lab_test_template.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Lab Test Template')
+
class TestLabTestTemplate(unittest.TestCase):
pass
diff --git a/erpnext/healthcare/doctype/lab_test_uom/test_lab_test_uom.py b/erpnext/healthcare/doctype/lab_test_uom/test_lab_test_uom.py
index b9381713ada..747304bfc10 100644
--- a/erpnext/healthcare/doctype/lab_test_uom/test_lab_test_uom.py
+++ b/erpnext/healthcare/doctype/lab_test_uom/test_lab_test_uom.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Lab Test UOM')
+
class TestLabTestUOM(unittest.TestCase):
pass
diff --git a/erpnext/healthcare/doctype/medical_code/medical_code.py b/erpnext/healthcare/doctype/medical_code/medical_code.py
index 702bbd7e7e5..5909c7d44b7 100644
--- a/erpnext/healthcare/doctype/medical_code/medical_code.py
+++ b/erpnext/healthcare/doctype/medical_code/medical_code.py
@@ -7,4 +7,4 @@ from frappe.model.document import Document
class MedicalCode(Document):
def autoname(self):
- self.name = self.medical_code_standard+" "+self.code
+ self.name = self.medical_code_standard + " " + self.code
diff --git a/erpnext/healthcare/doctype/medical_department/test_medical_department.py b/erpnext/healthcare/doctype/medical_department/test_medical_department.py
index 5091ba61b9e..3035bfd5ffb 100644
--- a/erpnext/healthcare/doctype/medical_department/test_medical_department.py
+++ b/erpnext/healthcare/doctype/medical_department/test_medical_department.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Medical Department')
+
class TestMedicalDepartment(unittest.TestCase):
pass
diff --git a/erpnext/healthcare/doctype/patient/patient.py b/erpnext/healthcare/doctype/patient/patient.py
index 89f146576bb..c5ed42656a1 100644
--- a/erpnext/healthcare/doctype/patient/patient.py
+++ b/erpnext/healthcare/doctype/patient/patient.py
@@ -23,7 +23,7 @@ from erpnext.healthcare.doctype.healthcare_settings.healthcare_settings import (
class Patient(Document):
def onload(self):
- '''Load address and contacts in `__onload`'''
+ """Load address and contacts in `__onload`"""
load_address_and_contact(self)
self.load_dashboard_info()
@@ -34,16 +34,16 @@ class Patient(Document):
self.set_missing_customer_details()
def after_insert(self):
- if frappe.db.get_single_value('Healthcare Settings', 'collect_registration_fee'):
- frappe.db.set_value('Patient', self.name, 'status', 'Disabled')
+ if frappe.db.get_single_value("Healthcare Settings", "collect_registration_fee"):
+ frappe.db.set_value("Patient", self.name, "status", "Disabled")
else:
send_registration_sms(self)
self.reload()
def on_update(self):
- if frappe.db.get_single_value('Healthcare Settings', 'link_customer_to_patient'):
+ if frappe.db.get_single_value("Healthcare Settings", "link_customer_to_patient"):
if self.customer:
- customer = frappe.get_doc('Customer', self.customer)
+ customer = frappe.get_doc("Customer", self.customer)
if self.customer_group:
customer.customer_group = self.customer_group
if self.territory:
@@ -58,64 +58,83 @@ class Patient(Document):
else:
create_customer(self)
- self.set_contact() # add or update contact
+ self.set_contact() # add or update contact
if not self.user_id and self.email and self.invite_user:
self.create_website_user()
def load_dashboard_info(self):
if self.customer:
- info = get_dashboard_info('Customer', self.customer, None)
- self.set_onload('dashboard_info', info)
+ info = get_dashboard_info("Customer", self.customer, None)
+ self.set_onload("dashboard_info", info)
def set_full_name(self):
if self.last_name:
- self.patient_name = ' '.join(filter(None, [self.first_name, self.last_name]))
+ self.patient_name = " ".join(filter(None, [self.first_name, self.last_name]))
else:
self.patient_name = self.first_name
def set_missing_customer_details(self):
if not self.customer_group:
- self.customer_group = frappe.db.get_single_value('Selling Settings', 'customer_group') or get_root_of('Customer Group')
+ self.customer_group = frappe.db.get_single_value(
+ "Selling Settings", "customer_group"
+ ) or get_root_of("Customer Group")
if not self.territory:
- self.territory = frappe.db.get_single_value('Selling Settings', 'territory') or get_root_of('Territory')
+ self.territory = frappe.db.get_single_value("Selling Settings", "territory") or get_root_of(
+ "Territory"
+ )
if not self.default_price_list:
- self.default_price_list = frappe.db.get_single_value('Selling Settings', 'selling_price_list')
+ self.default_price_list = frappe.db.get_single_value("Selling Settings", "selling_price_list")
if not self.customer_group or not self.territory or not self.default_price_list:
- frappe.msgprint(_('Please set defaults for Customer Group, Territory and Selling Price List in Selling Settings'), alert=True)
+ frappe.msgprint(
+ _(
+ "Please set defaults for Customer Group, Territory and Selling Price List in Selling Settings"
+ ),
+ alert=True,
+ )
if not self.default_currency:
self.default_currency = get_default_currency()
if not self.language:
- self.language = frappe.db.get_single_value('System Settings', 'language')
+ self.language = frappe.db.get_single_value("System Settings", "language")
def create_website_user(self):
- users = frappe.db.get_all('User', fields=['email', 'mobile_no'], or_filters={'email': self.email, 'mobile_no': self.mobile})
+ users = frappe.db.get_all(
+ "User",
+ fields=["email", "mobile_no"],
+ or_filters={"email": self.email, "mobile_no": self.mobile},
+ )
if users and users[0]:
- frappe.throw(_("User exists with Email {}, Mobile {}
Please check email / mobile or disable 'Invite as User' to skip creating User") - .format(frappe.bold(users[0].email), frappe.bold(users[0].mobile_no)), frappe.DuplicateEntryError) + frappe.throw( + _( + "User exists with Email {}, Mobile {}
Please check email / mobile or disable 'Invite as User' to skip creating User" + ).format(frappe.bold(users[0].email), frappe.bold(users[0].mobile_no)), + frappe.DuplicateEntryError, + ) - user = frappe.get_doc({ - 'doctype': 'User', - 'first_name': self.first_name, - 'last_name': self.last_name, - 'email': self.email, - 'user_type': 'Website User', - 'gender': self.sex, - 'phone': self.phone, - 'mobile_no': self.mobile, - 'birth_date': self.dob - }) + user = frappe.get_doc( + { + "doctype": "User", + "first_name": self.first_name, + "last_name": self.last_name, + "email": self.email, + "user_type": "Website User", + "gender": self.sex, + "phone": self.phone, + "mobile_no": self.mobile, + "birth_date": self.dob, + } + ) user.flags.ignore_permissions = True user.enabled = True user.send_welcome_email = True - user.add_roles('Patient') - self.db_set('user_id', user.name) + user.add_roles("Patient") + self.db_set("user_id", user.name) def autoname(self): - patient_name_by = frappe.db.get_single_value('Healthcare Settings', 'patient_name_by') - if patient_name_by == 'Patient Name': + patient_name_by = frappe.db.get_single_value("Healthcare Settings", "patient_name_by") + if patient_name_by == "Patient Name": self.name = self.get_patient_name() else: set_name_by_naming_series(self) @@ -123,9 +142,13 @@ class Patient(Document): def get_patient_name(self): self.set_full_name() name = self.patient_name - if frappe.db.get_value('Patient', name): - count = frappe.db.sql("""select ifnull(MAX(CAST(SUBSTRING_INDEX(name, ' ', -1) AS UNSIGNED)), 0) from tabPatient - where name like %s""", "%{0} - %".format(name), as_list=1)[0][0] + if frappe.db.get_value("Patient", name): + count = frappe.db.sql( + """select ifnull(MAX(CAST(SUBSTRING_INDEX(name, ' ', -1) AS UNSIGNED)), 0) from tabPatient + where name like %s""", + "%{0} - %".format(name), + as_list=1, + )[0][0] count = cint(count) + 1 return "{0} - {1}".format(name, cstr(count)) @@ -143,22 +166,34 @@ class Patient(Document): age = self.age if not age: return - age_str = str(age.years) + ' ' + _("Years(s)") + ' ' + str(age.months) + ' ' + _("Month(s)") + ' ' + str(age.days) + ' ' + _("Day(s)") + age_str = ( + str(age.years) + + " " + + _("Year(s)") + + " " + + str(age.months) + + " " + + _("Month(s)") + + " " + + str(age.days) + + " " + + _("Day(s)") + ) return age_str @frappe.whitelist() def invoice_patient_registration(self): - if frappe.db.get_single_value('Healthcare Settings', 'registration_fee'): - company = frappe.defaults.get_user_default('company') + if frappe.db.get_single_value("Healthcare Settings", "registration_fee"): + company = frappe.defaults.get_user_default("company") if not company: - company = frappe.db.get_single_value('Global Defaults', 'default_company') + company = frappe.db.get_single_value("Global Defaults", "default_company") sales_invoice = make_invoice(self.name, company) sales_invoice.save(ignore_permissions=True) - frappe.db.set_value('Patient', self.name, 'status', 'Active') + frappe.db.set_value("Patient", self.name, "status", "Active") send_registration_sms(self) - return {'invoice': sales_invoice.name} + return {"invoice": sales_invoice.name} def set_contact(self): contact = get_default_contact(self.doctype, self.name) @@ -173,33 +208,35 @@ class Patient(Document): else: if self.customer: # customer contact exists, link patient - contact = get_default_contact('Customer', self.customer) + contact = get_default_contact("Customer", self.customer) if contact: self.update_contact(contact) else: self.reload() if self.email or self.mobile or self.phone: - contact = frappe.get_doc({ - 'doctype': 'Contact', - 'first_name': self.first_name, - 'middle_name': self.middle_name, - 'last_name': self.last_name, - 'gender': self.sex, - 'is_primary_contact': 1 - }) - contact.append('links', dict(link_doctype='Patient', link_name=self.name)) + contact = frappe.get_doc( + { + "doctype": "Contact", + "first_name": self.first_name, + "middle_name": self.middle_name, + "last_name": self.last_name, + "gender": self.sex, + "is_primary_contact": 1, + } + ) + contact.append("links", dict(link_doctype="Patient", link_name=self.name)) if self.customer: - contact.append('links', dict(link_doctype='Customer', link_name=self.customer)) + contact.append("links", dict(link_doctype="Customer", link_name=self.customer)) contact.insert(ignore_permissions=True) self.update_contact(contact.name) def update_contact(self, contact): - contact = frappe.get_doc('Contact', contact) + contact = frappe.get_doc("Contact", contact) if not contact.has_link(self.doctype, self.name): - contact.append('links', dict(link_doctype=self.doctype, link_name=self.name)) + contact.append("links", dict(link_doctype=self.doctype, link_name=self.name)) if self.email and self.email != contact.email_id: for email in contact.email_ids: @@ -211,73 +248,85 @@ class Patient(Document): for mobile in contact.phone_nos: mobile.is_primary_mobile_no = True if mobile.phone == self.mobile else False contact.add_phone(self.mobile, is_primary_mobile_no=True) - contact.set_primary('mobile_no') + contact.set_primary("mobile_no") if self.phone and self.phone != contact.phone: for phone in contact.phone_nos: phone.is_primary_phone = True if phone.phone == self.phone else False contact.add_phone(self.phone, is_primary_phone=True) - contact.set_primary('phone') + contact.set_primary("phone") contact.flags.skip_patient_update = True contact.save(ignore_permissions=True) def create_customer(doc): - customer = frappe.get_doc({ - 'doctype': 'Customer', - 'customer_name': doc.patient_name, - 'customer_group': doc.customer_group or frappe.db.get_single_value('Selling Settings', 'customer_group'), - 'territory' : doc.territory or frappe.db.get_single_value('Selling Settings', 'territory'), - 'customer_type': 'Individual', - 'default_currency': doc.default_currency, - 'default_price_list': doc.default_price_list, - 'language': doc.language - }).insert(ignore_permissions=True, ignore_mandatory=True) + customer = frappe.get_doc( + { + "doctype": "Customer", + "customer_name": doc.patient_name, + "customer_group": doc.customer_group + or frappe.db.get_single_value("Selling Settings", "customer_group"), + "territory": doc.territory or frappe.db.get_single_value("Selling Settings", "territory"), + "customer_type": "Individual", + "default_currency": doc.default_currency, + "default_price_list": doc.default_price_list, + "language": doc.language, + } + ).insert(ignore_permissions=True, ignore_mandatory=True) + + frappe.db.set_value("Patient", doc.name, "customer", customer.name) + frappe.msgprint(_("Customer {0} is created.").format(customer.name), alert=True) - frappe.db.set_value('Patient', doc.name, 'customer', customer.name) - frappe.msgprint(_('Customer {0} is created.').format(customer.name), alert=True) def make_invoice(patient, company): - uom = frappe.db.exists('UOM', 'Nos') or frappe.db.get_single_value('Stock Settings', 'stock_uom') - sales_invoice = frappe.new_doc('Sales Invoice') - sales_invoice.customer = frappe.db.get_value('Patient', patient, 'customer') + uom = frappe.db.exists("UOM", "Nos") or frappe.db.get_single_value("Stock Settings", "stock_uom") + sales_invoice = frappe.new_doc("Sales Invoice") + sales_invoice.customer = frappe.db.get_value("Patient", patient, "customer") sales_invoice.due_date = getdate() sales_invoice.company = company sales_invoice.is_pos = 0 sales_invoice.debit_to = get_receivable_account(company) - item_line = sales_invoice.append('items') - item_line.item_name = 'Registration Fee' - item_line.description = 'Registration Fee' + item_line = sales_invoice.append("items") + item_line.item_name = "Registration Fee" + item_line.description = "Registration Fee" item_line.qty = 1 item_line.uom = uom item_line.conversion_factor = 1 item_line.income_account = get_income_account(None, company) - item_line.rate = frappe.db.get_single_value('Healthcare Settings', 'registration_fee') + item_line.rate = frappe.db.get_single_value("Healthcare Settings", "registration_fee") item_line.amount = item_line.rate sales_invoice.set_missing_values() return sales_invoice + @frappe.whitelist() def get_patient_detail(patient): patient_dict = frappe.db.sql("""select * from tabPatient where name=%s""", (patient), as_dict=1) if not patient_dict: - frappe.throw(_('Patient not found')) - vital_sign = frappe.db.sql("""select * from `tabVital Signs` where patient=%s - order by signs_date desc limit 1""", (patient), as_dict=1) + frappe.throw(_("Patient not found")) + vital_sign = frappe.db.sql( + """select * from `tabVital Signs` where patient=%s + order by signs_date desc limit 1""", + (patient), + as_dict=1, + ) details = patient_dict[0] if vital_sign: details.update(vital_sign[0]) return details + def get_timeline_data(doctype, name): - ''' + """ Return Patient's timeline data from medical records Also include the associated Customer timeline data - ''' - patient_timeline_data = dict(frappe.db.sql(''' + """ + patient_timeline_data = dict( + frappe.db.sql( + """ SELECT unix_timestamp(communication_date), count(*) FROM @@ -285,12 +334,16 @@ def get_timeline_data(doctype, name): WHERE patient=%s and `communication_date` > date_sub(curdate(), interval 1 year) - GROUP BY communication_date''', name)) + GROUP BY communication_date""", + name, + ) + ) - customer = frappe.db.get_value(doctype, name, 'customer') + customer = frappe.db.get_value(doctype, name, "customer") if customer: from erpnext.accounts.party import get_timeline_data - customer_timeline_data = get_timeline_data('Customer', customer) + + customer_timeline_data = get_timeline_data("Customer", customer) patient_timeline_data.update(customer_timeline_data) return patient_timeline_data diff --git a/erpnext/healthcare/doctype/patient/patient_dashboard.py b/erpnext/healthcare/doctype/patient/patient_dashboard.py index 532d3e55370..198c279cd7d 100644 --- a/erpnext/healthcare/doctype/patient/patient_dashboard.py +++ b/erpnext/healthcare/doctype/patient/patient_dashboard.py @@ -1,39 +1,26 @@ - from frappe import _ def get_data(): return { - 'heatmap': True, - 'heatmap_message': _('This is based on transactions against this Patient. See timeline below for details'), - 'fieldname': 'patient', - 'non_standard_fieldnames': { - 'Payment Entry': 'party' - }, - 'transactions': [ + "heatmap": True, + "heatmap_message": _( + "This is based on transactions against this Patient. See timeline below for details" + ), + "fieldname": "patient", + "non_standard_fieldnames": {"Payment Entry": "party"}, + "transactions": [ { - 'label': _('Appointments and Encounters'), - 'items': ['Patient Appointment', 'Vital Signs', 'Patient Encounter'] + "label": _("Appointments and Encounters"), + "items": ["Patient Appointment", "Vital Signs", "Patient Encounter"], }, + {"label": _("Lab Tests and Vital Signs"), "items": ["Lab Test", "Sample Collection"]}, { - 'label': _('Lab Tests and Vital Signs'), - 'items': ['Lab Test', 'Sample Collection'] + "label": _("Rehab and Physiotherapy"), + "items": ["Patient Assessment", "Therapy Session", "Therapy Plan"], }, - { - 'label': _('Rehab and Physiotherapy'), - 'items': ['Patient Assessment', 'Therapy Session', 'Therapy Plan'] - }, - { - 'label': _('Surgery'), - 'items': ['Clinical Procedure'] - }, - { - 'label': _('Admissions'), - 'items': ['Inpatient Record', 'Inpatient Medication Order'] - }, - { - 'label': _('Billing and Payments'), - 'items': ['Sales Invoice', 'Payment Entry'] - } - ] + {"label": _("Surgery"), "items": ["Clinical Procedure"]}, + {"label": _("Admissions"), "items": ["Inpatient Record", "Inpatient Medication Order"]}, + {"label": _("Billing and Payments"), "items": ["Sales Invoice", "Payment Entry"]}, + ], } diff --git a/erpnext/healthcare/doctype/patient/test_patient.py b/erpnext/healthcare/doctype/patient/test_patient.py index e9bfff7116c..664fa9dea21 100644 --- a/erpnext/healthcare/doctype/patient/test_patient.py +++ b/erpnext/healthcare/doctype/patient/test_patient.py @@ -11,25 +11,25 @@ from erpnext.healthcare.doctype.patient_appointment.test_patient_appointment imp class TestPatient(unittest.TestCase): def test_customer_created(self): frappe.db.sql("""delete from `tabPatient`""") - frappe.db.set_value('Healthcare Settings', None, 'link_customer_to_patient', 1) + frappe.db.set_value("Healthcare Settings", None, "link_customer_to_patient", 1) patient = create_patient() - self.assertTrue(frappe.db.get_value('Patient', patient, 'customer')) + self.assertTrue(frappe.db.get_value("Patient", patient, "customer")) def test_patient_registration(self): frappe.db.sql("""delete from `tabPatient`""") - settings = frappe.get_single('Healthcare Settings') + settings = frappe.get_single("Healthcare Settings") settings.collect_registration_fee = 1 settings.registration_fee = 500 settings.save() patient = create_patient() - patient = frappe.get_doc('Patient', patient) - self.assertEqual(patient.status, 'Disabled') + patient = frappe.get_doc("Patient", patient) + self.assertEqual(patient.status, "Disabled") # check sales invoice and patient status result = patient.invoice_patient_registration() - self.assertTrue(frappe.db.exists('Sales Invoice', result.get('invoice'))) - self.assertTrue(patient.status, 'Active') + self.assertTrue(frappe.db.exists("Sales Invoice", result.get("invoice"))) + self.assertTrue(patient.status, "Active") settings.collect_registration_fee = 0 settings.save() @@ -40,33 +40,60 @@ class TestPatient(unittest.TestCase): frappe.db.sql("""delete from `tabContact` where name like'_Test Patient%'""") frappe.db.sql("""delete from `tabDynamic Link` where parent like '_Test Patient%'""") - patient = create_patient(patient_name='_Test Patient Contact', email='test-patient@example.com', mobile='+91 0000000001') - customer = frappe.db.get_value('Patient', patient, 'customer') + patient = create_patient( + patient_name="_Test Patient Contact", email="test-patient@example.com", mobile="+91 0000000001" + ) + customer = frappe.db.get_value("Patient", patient, "customer") self.assertTrue(customer) - self.assertTrue(frappe.db.exists('Dynamic Link', {'parenttype': 'Contact', 'link_doctype': 'Patient', 'link_name': patient})) - self.assertTrue(frappe.db.exists('Dynamic Link', {'parenttype': 'Contact', 'link_doctype': 'Customer', 'link_name': customer})) + self.assertTrue( + frappe.db.exists( + "Dynamic Link", {"parenttype": "Contact", "link_doctype": "Patient", "link_name": patient} + ) + ) + self.assertTrue( + frappe.db.exists( + "Dynamic Link", {"parenttype": "Contact", "link_doctype": "Customer", "link_name": customer} + ) + ) # a second patient linking with same customer - new_patient = create_patient(email='test-patient@example.com', mobile='+91 0000000009', customer=customer) - self.assertTrue(frappe.db.exists('Dynamic Link', {'parenttype': 'Contact', 'link_doctype': 'Patient', 'link_name': new_patient})) - self.assertTrue(frappe.db.exists('Dynamic Link', {'parenttype': 'Contact', 'link_doctype': 'Customer', 'link_name': customer})) + new_patient = create_patient( + email="test-patient@example.com", mobile="+91 0000000009", customer=customer + ) + self.assertTrue( + frappe.db.exists( + "Dynamic Link", {"parenttype": "Contact", "link_doctype": "Patient", "link_name": new_patient} + ) + ) + self.assertTrue( + frappe.db.exists( + "Dynamic Link", {"parenttype": "Contact", "link_doctype": "Customer", "link_name": customer} + ) + ) def test_patient_user(self): frappe.db.sql("""delete from `tabUser` where email='test-patient-user@example.com'""") frappe.db.sql("""delete from `tabDynamic Link` where parent like '_Test Patient%'""") frappe.db.sql("""delete from `tabPatient` where name like '_Test Patient%'""") - patient = create_patient(patient_name='_Test Patient User', email='test-patient-user@example.com', mobile='+91 0000000009', create_user=True) - user = frappe.db.get_value('Patient', patient, 'user_id') - self.assertTrue(frappe.db.exists('User', user)) + patient = create_patient( + patient_name="_Test Patient User", + email="test-patient-user@example.com", + mobile="+91 0000000009", + create_user=True, + ) + user = frappe.db.get_value("Patient", patient, "user_id") + self.assertTrue(frappe.db.exists("User", user)) - new_patient = frappe.get_doc({ - 'doctype': 'Patient', - 'first_name': '_Test Patient Duplicate User', - 'sex': 'Male', - 'email': 'test-patient-user@example.com', - 'mobile': '+91 0000000009', - 'invite_user': 1 - }) + new_patient = frappe.get_doc( + { + "doctype": "Patient", + "first_name": "_Test Patient Duplicate User", + "sex": "Male", + "email": "test-patient-user@example.com", + "mobile": "+91 0000000009", + "invite_user": 1, + } + ) self.assertRaises(frappe.exceptions.DuplicateEntryError, new_patient.insert) diff --git a/erpnext/healthcare/doctype/patient_appointment/patient_appointment.js b/erpnext/healthcare/doctype/patient_appointment/patient_appointment.js index bba001c9c0e..ba862783caa 100644 --- a/erpnext/healthcare/doctype/patient_appointment/patient_appointment.js +++ b/erpnext/healthcare/doctype/patient_appointment/patient_appointment.js @@ -337,9 +337,13 @@ let check_and_set_availability = function(frm) { }); d.fields_dict['department'].df.onchange = () => { - d.set_values({ - 'practitioner': '' - }); + if (d.get_value('department') == frm.doc.department) { + d.set_value('practitioner', frm.doc.practitioner); + } else { + d.set_value('practitioner', ''); + d.fields_dict.available_slots.html(''); + d.get_primary_btn().attr('disabled', true); + } let department = d.get_value('department'); if (department) { d.fields_dict.practitioner.get_query = function() { @@ -426,7 +430,8 @@ let check_and_set_availability = function(frm) { slot_details.forEach((slot_info) => { slot_html += `
Please check email / mobile or disable 'Invite as User' to skip creating User") - .format(frappe.bold(users[0].email), frappe.bold(users[0].mobile_no)), frappe.DuplicateEntryError) + frappe.throw( + _( + "User exists with Email {}, Mobile {}
Please check email / mobile or disable 'Invite as User' to skip creating User" + ).format(frappe.bold(users[0].email), frappe.bold(users[0].mobile_no)), + frappe.DuplicateEntryError, + ) - user = frappe.get_doc({ - 'doctype': 'User', - 'first_name': self.first_name, - 'last_name': self.last_name, - 'email': self.email, - 'user_type': 'Website User', - 'gender': self.sex, - 'phone': self.phone, - 'mobile_no': self.mobile, - 'birth_date': self.dob - }) + user = frappe.get_doc( + { + "doctype": "User", + "first_name": self.first_name, + "last_name": self.last_name, + "email": self.email, + "user_type": "Website User", + "gender": self.sex, + "phone": self.phone, + "mobile_no": self.mobile, + "birth_date": self.dob, + } + ) user.flags.ignore_permissions = True user.enabled = True user.send_welcome_email = True - user.add_roles('Patient') - self.db_set('user_id', user.name) + user.add_roles("Patient") + self.db_set("user_id", user.name) def autoname(self): - patient_name_by = frappe.db.get_single_value('Healthcare Settings', 'patient_name_by') - if patient_name_by == 'Patient Name': + patient_name_by = frappe.db.get_single_value("Healthcare Settings", "patient_name_by") + if patient_name_by == "Patient Name": self.name = self.get_patient_name() else: set_name_by_naming_series(self) @@ -123,9 +142,13 @@ class Patient(Document): def get_patient_name(self): self.set_full_name() name = self.patient_name - if frappe.db.get_value('Patient', name): - count = frappe.db.sql("""select ifnull(MAX(CAST(SUBSTRING_INDEX(name, ' ', -1) AS UNSIGNED)), 0) from tabPatient - where name like %s""", "%{0} - %".format(name), as_list=1)[0][0] + if frappe.db.get_value("Patient", name): + count = frappe.db.sql( + """select ifnull(MAX(CAST(SUBSTRING_INDEX(name, ' ', -1) AS UNSIGNED)), 0) from tabPatient + where name like %s""", + "%{0} - %".format(name), + as_list=1, + )[0][0] count = cint(count) + 1 return "{0} - {1}".format(name, cstr(count)) @@ -143,22 +166,34 @@ class Patient(Document): age = self.age if not age: return - age_str = str(age.years) + ' ' + _("Years(s)") + ' ' + str(age.months) + ' ' + _("Month(s)") + ' ' + str(age.days) + ' ' + _("Day(s)") + age_str = ( + str(age.years) + + " " + + _("Year(s)") + + " " + + str(age.months) + + " " + + _("Month(s)") + + " " + + str(age.days) + + " " + + _("Day(s)") + ) return age_str @frappe.whitelist() def invoice_patient_registration(self): - if frappe.db.get_single_value('Healthcare Settings', 'registration_fee'): - company = frappe.defaults.get_user_default('company') + if frappe.db.get_single_value("Healthcare Settings", "registration_fee"): + company = frappe.defaults.get_user_default("company") if not company: - company = frappe.db.get_single_value('Global Defaults', 'default_company') + company = frappe.db.get_single_value("Global Defaults", "default_company") sales_invoice = make_invoice(self.name, company) sales_invoice.save(ignore_permissions=True) - frappe.db.set_value('Patient', self.name, 'status', 'Active') + frappe.db.set_value("Patient", self.name, "status", "Active") send_registration_sms(self) - return {'invoice': sales_invoice.name} + return {"invoice": sales_invoice.name} def set_contact(self): contact = get_default_contact(self.doctype, self.name) @@ -173,33 +208,35 @@ class Patient(Document): else: if self.customer: # customer contact exists, link patient - contact = get_default_contact('Customer', self.customer) + contact = get_default_contact("Customer", self.customer) if contact: self.update_contact(contact) else: self.reload() if self.email or self.mobile or self.phone: - contact = frappe.get_doc({ - 'doctype': 'Contact', - 'first_name': self.first_name, - 'middle_name': self.middle_name, - 'last_name': self.last_name, - 'gender': self.sex, - 'is_primary_contact': 1 - }) - contact.append('links', dict(link_doctype='Patient', link_name=self.name)) + contact = frappe.get_doc( + { + "doctype": "Contact", + "first_name": self.first_name, + "middle_name": self.middle_name, + "last_name": self.last_name, + "gender": self.sex, + "is_primary_contact": 1, + } + ) + contact.append("links", dict(link_doctype="Patient", link_name=self.name)) if self.customer: - contact.append('links', dict(link_doctype='Customer', link_name=self.customer)) + contact.append("links", dict(link_doctype="Customer", link_name=self.customer)) contact.insert(ignore_permissions=True) self.update_contact(contact.name) def update_contact(self, contact): - contact = frappe.get_doc('Contact', contact) + contact = frappe.get_doc("Contact", contact) if not contact.has_link(self.doctype, self.name): - contact.append('links', dict(link_doctype=self.doctype, link_name=self.name)) + contact.append("links", dict(link_doctype=self.doctype, link_name=self.name)) if self.email and self.email != contact.email_id: for email in contact.email_ids: @@ -211,73 +248,85 @@ class Patient(Document): for mobile in contact.phone_nos: mobile.is_primary_mobile_no = True if mobile.phone == self.mobile else False contact.add_phone(self.mobile, is_primary_mobile_no=True) - contact.set_primary('mobile_no') + contact.set_primary("mobile_no") if self.phone and self.phone != contact.phone: for phone in contact.phone_nos: phone.is_primary_phone = True if phone.phone == self.phone else False contact.add_phone(self.phone, is_primary_phone=True) - contact.set_primary('phone') + contact.set_primary("phone") contact.flags.skip_patient_update = True contact.save(ignore_permissions=True) def create_customer(doc): - customer = frappe.get_doc({ - 'doctype': 'Customer', - 'customer_name': doc.patient_name, - 'customer_group': doc.customer_group or frappe.db.get_single_value('Selling Settings', 'customer_group'), - 'territory' : doc.territory or frappe.db.get_single_value('Selling Settings', 'territory'), - 'customer_type': 'Individual', - 'default_currency': doc.default_currency, - 'default_price_list': doc.default_price_list, - 'language': doc.language - }).insert(ignore_permissions=True, ignore_mandatory=True) + customer = frappe.get_doc( + { + "doctype": "Customer", + "customer_name": doc.patient_name, + "customer_group": doc.customer_group + or frappe.db.get_single_value("Selling Settings", "customer_group"), + "territory": doc.territory or frappe.db.get_single_value("Selling Settings", "territory"), + "customer_type": "Individual", + "default_currency": doc.default_currency, + "default_price_list": doc.default_price_list, + "language": doc.language, + } + ).insert(ignore_permissions=True, ignore_mandatory=True) + + frappe.db.set_value("Patient", doc.name, "customer", customer.name) + frappe.msgprint(_("Customer {0} is created.").format(customer.name), alert=True) - frappe.db.set_value('Patient', doc.name, 'customer', customer.name) - frappe.msgprint(_('Customer {0} is created.').format(customer.name), alert=True) def make_invoice(patient, company): - uom = frappe.db.exists('UOM', 'Nos') or frappe.db.get_single_value('Stock Settings', 'stock_uom') - sales_invoice = frappe.new_doc('Sales Invoice') - sales_invoice.customer = frappe.db.get_value('Patient', patient, 'customer') + uom = frappe.db.exists("UOM", "Nos") or frappe.db.get_single_value("Stock Settings", "stock_uom") + sales_invoice = frappe.new_doc("Sales Invoice") + sales_invoice.customer = frappe.db.get_value("Patient", patient, "customer") sales_invoice.due_date = getdate() sales_invoice.company = company sales_invoice.is_pos = 0 sales_invoice.debit_to = get_receivable_account(company) - item_line = sales_invoice.append('items') - item_line.item_name = 'Registration Fee' - item_line.description = 'Registration Fee' + item_line = sales_invoice.append("items") + item_line.item_name = "Registration Fee" + item_line.description = "Registration Fee" item_line.qty = 1 item_line.uom = uom item_line.conversion_factor = 1 item_line.income_account = get_income_account(None, company) - item_line.rate = frappe.db.get_single_value('Healthcare Settings', 'registration_fee') + item_line.rate = frappe.db.get_single_value("Healthcare Settings", "registration_fee") item_line.amount = item_line.rate sales_invoice.set_missing_values() return sales_invoice + @frappe.whitelist() def get_patient_detail(patient): patient_dict = frappe.db.sql("""select * from tabPatient where name=%s""", (patient), as_dict=1) if not patient_dict: - frappe.throw(_('Patient not found')) - vital_sign = frappe.db.sql("""select * from `tabVital Signs` where patient=%s - order by signs_date desc limit 1""", (patient), as_dict=1) + frappe.throw(_("Patient not found")) + vital_sign = frappe.db.sql( + """select * from `tabVital Signs` where patient=%s + order by signs_date desc limit 1""", + (patient), + as_dict=1, + ) details = patient_dict[0] if vital_sign: details.update(vital_sign[0]) return details + def get_timeline_data(doctype, name): - ''' + """ Return Patient's timeline data from medical records Also include the associated Customer timeline data - ''' - patient_timeline_data = dict(frappe.db.sql(''' + """ + patient_timeline_data = dict( + frappe.db.sql( + """ SELECT unix_timestamp(communication_date), count(*) FROM @@ -285,12 +334,16 @@ def get_timeline_data(doctype, name): WHERE patient=%s and `communication_date` > date_sub(curdate(), interval 1 year) - GROUP BY communication_date''', name)) + GROUP BY communication_date""", + name, + ) + ) - customer = frappe.db.get_value(doctype, name, 'customer') + customer = frappe.db.get_value(doctype, name, "customer") if customer: from erpnext.accounts.party import get_timeline_data - customer_timeline_data = get_timeline_data('Customer', customer) + + customer_timeline_data = get_timeline_data("Customer", customer) patient_timeline_data.update(customer_timeline_data) return patient_timeline_data diff --git a/erpnext/healthcare/doctype/patient/patient_dashboard.py b/erpnext/healthcare/doctype/patient/patient_dashboard.py index 532d3e55370..198c279cd7d 100644 --- a/erpnext/healthcare/doctype/patient/patient_dashboard.py +++ b/erpnext/healthcare/doctype/patient/patient_dashboard.py @@ -1,39 +1,26 @@ - from frappe import _ def get_data(): return { - 'heatmap': True, - 'heatmap_message': _('This is based on transactions against this Patient. See timeline below for details'), - 'fieldname': 'patient', - 'non_standard_fieldnames': { - 'Payment Entry': 'party' - }, - 'transactions': [ + "heatmap": True, + "heatmap_message": _( + "This is based on transactions against this Patient. See timeline below for details" + ), + "fieldname": "patient", + "non_standard_fieldnames": {"Payment Entry": "party"}, + "transactions": [ { - 'label': _('Appointments and Encounters'), - 'items': ['Patient Appointment', 'Vital Signs', 'Patient Encounter'] + "label": _("Appointments and Encounters"), + "items": ["Patient Appointment", "Vital Signs", "Patient Encounter"], }, + {"label": _("Lab Tests and Vital Signs"), "items": ["Lab Test", "Sample Collection"]}, { - 'label': _('Lab Tests and Vital Signs'), - 'items': ['Lab Test', 'Sample Collection'] + "label": _("Rehab and Physiotherapy"), + "items": ["Patient Assessment", "Therapy Session", "Therapy Plan"], }, - { - 'label': _('Rehab and Physiotherapy'), - 'items': ['Patient Assessment', 'Therapy Session', 'Therapy Plan'] - }, - { - 'label': _('Surgery'), - 'items': ['Clinical Procedure'] - }, - { - 'label': _('Admissions'), - 'items': ['Inpatient Record', 'Inpatient Medication Order'] - }, - { - 'label': _('Billing and Payments'), - 'items': ['Sales Invoice', 'Payment Entry'] - } - ] + {"label": _("Surgery"), "items": ["Clinical Procedure"]}, + {"label": _("Admissions"), "items": ["Inpatient Record", "Inpatient Medication Order"]}, + {"label": _("Billing and Payments"), "items": ["Sales Invoice", "Payment Entry"]}, + ], } diff --git a/erpnext/healthcare/doctype/patient/test_patient.py b/erpnext/healthcare/doctype/patient/test_patient.py index e9bfff7116c..664fa9dea21 100644 --- a/erpnext/healthcare/doctype/patient/test_patient.py +++ b/erpnext/healthcare/doctype/patient/test_patient.py @@ -11,25 +11,25 @@ from erpnext.healthcare.doctype.patient_appointment.test_patient_appointment imp class TestPatient(unittest.TestCase): def test_customer_created(self): frappe.db.sql("""delete from `tabPatient`""") - frappe.db.set_value('Healthcare Settings', None, 'link_customer_to_patient', 1) + frappe.db.set_value("Healthcare Settings", None, "link_customer_to_patient", 1) patient = create_patient() - self.assertTrue(frappe.db.get_value('Patient', patient, 'customer')) + self.assertTrue(frappe.db.get_value("Patient", patient, "customer")) def test_patient_registration(self): frappe.db.sql("""delete from `tabPatient`""") - settings = frappe.get_single('Healthcare Settings') + settings = frappe.get_single("Healthcare Settings") settings.collect_registration_fee = 1 settings.registration_fee = 500 settings.save() patient = create_patient() - patient = frappe.get_doc('Patient', patient) - self.assertEqual(patient.status, 'Disabled') + patient = frappe.get_doc("Patient", patient) + self.assertEqual(patient.status, "Disabled") # check sales invoice and patient status result = patient.invoice_patient_registration() - self.assertTrue(frappe.db.exists('Sales Invoice', result.get('invoice'))) - self.assertTrue(patient.status, 'Active') + self.assertTrue(frappe.db.exists("Sales Invoice", result.get("invoice"))) + self.assertTrue(patient.status, "Active") settings.collect_registration_fee = 0 settings.save() @@ -40,33 +40,60 @@ class TestPatient(unittest.TestCase): frappe.db.sql("""delete from `tabContact` where name like'_Test Patient%'""") frappe.db.sql("""delete from `tabDynamic Link` where parent like '_Test Patient%'""") - patient = create_patient(patient_name='_Test Patient Contact', email='test-patient@example.com', mobile='+91 0000000001') - customer = frappe.db.get_value('Patient', patient, 'customer') + patient = create_patient( + patient_name="_Test Patient Contact", email="test-patient@example.com", mobile="+91 0000000001" + ) + customer = frappe.db.get_value("Patient", patient, "customer") self.assertTrue(customer) - self.assertTrue(frappe.db.exists('Dynamic Link', {'parenttype': 'Contact', 'link_doctype': 'Patient', 'link_name': patient})) - self.assertTrue(frappe.db.exists('Dynamic Link', {'parenttype': 'Contact', 'link_doctype': 'Customer', 'link_name': customer})) + self.assertTrue( + frappe.db.exists( + "Dynamic Link", {"parenttype": "Contact", "link_doctype": "Patient", "link_name": patient} + ) + ) + self.assertTrue( + frappe.db.exists( + "Dynamic Link", {"parenttype": "Contact", "link_doctype": "Customer", "link_name": customer} + ) + ) # a second patient linking with same customer - new_patient = create_patient(email='test-patient@example.com', mobile='+91 0000000009', customer=customer) - self.assertTrue(frappe.db.exists('Dynamic Link', {'parenttype': 'Contact', 'link_doctype': 'Patient', 'link_name': new_patient})) - self.assertTrue(frappe.db.exists('Dynamic Link', {'parenttype': 'Contact', 'link_doctype': 'Customer', 'link_name': customer})) + new_patient = create_patient( + email="test-patient@example.com", mobile="+91 0000000009", customer=customer + ) + self.assertTrue( + frappe.db.exists( + "Dynamic Link", {"parenttype": "Contact", "link_doctype": "Patient", "link_name": new_patient} + ) + ) + self.assertTrue( + frappe.db.exists( + "Dynamic Link", {"parenttype": "Contact", "link_doctype": "Customer", "link_name": customer} + ) + ) def test_patient_user(self): frappe.db.sql("""delete from `tabUser` where email='test-patient-user@example.com'""") frappe.db.sql("""delete from `tabDynamic Link` where parent like '_Test Patient%'""") frappe.db.sql("""delete from `tabPatient` where name like '_Test Patient%'""") - patient = create_patient(patient_name='_Test Patient User', email='test-patient-user@example.com', mobile='+91 0000000009', create_user=True) - user = frappe.db.get_value('Patient', patient, 'user_id') - self.assertTrue(frappe.db.exists('User', user)) + patient = create_patient( + patient_name="_Test Patient User", + email="test-patient-user@example.com", + mobile="+91 0000000009", + create_user=True, + ) + user = frappe.db.get_value("Patient", patient, "user_id") + self.assertTrue(frappe.db.exists("User", user)) - new_patient = frappe.get_doc({ - 'doctype': 'Patient', - 'first_name': '_Test Patient Duplicate User', - 'sex': 'Male', - 'email': 'test-patient-user@example.com', - 'mobile': '+91 0000000009', - 'invite_user': 1 - }) + new_patient = frappe.get_doc( + { + "doctype": "Patient", + "first_name": "_Test Patient Duplicate User", + "sex": "Male", + "email": "test-patient-user@example.com", + "mobile": "+91 0000000009", + "invite_user": 1, + } + ) self.assertRaises(frappe.exceptions.DuplicateEntryError, new_patient.insert) diff --git a/erpnext/healthcare/doctype/patient_appointment/patient_appointment.js b/erpnext/healthcare/doctype/patient_appointment/patient_appointment.js index bba001c9c0e..ba862783caa 100644 --- a/erpnext/healthcare/doctype/patient_appointment/patient_appointment.js +++ b/erpnext/healthcare/doctype/patient_appointment/patient_appointment.js @@ -337,9 +337,13 @@ let check_and_set_availability = function(frm) { }); d.fields_dict['department'].df.onchange = () => { - d.set_values({ - 'practitioner': '' - }); + if (d.get_value('department') == frm.doc.department) { + d.set_value('practitioner', frm.doc.practitioner); + } else { + d.set_value('practitioner', ''); + d.fields_dict.available_slots.html(''); + d.get_primary_btn().attr('disabled', true); + } let department = d.get_value('department'); if (department) { d.fields_dict.practitioner.get_query = function() { @@ -426,7 +430,8 @@ let check_and_set_availability = function(frm) { slot_details.forEach((slot_info) => { slot_html += `
- ${__('Practitioner Schedule:')} ${slot_info.slot_name}
+ ${slot_info.practitioner_name}
+ ${__('Schedule:')} ${slot_info.slot_name}
${__('Service Unit:')} ${slot_info.service_unit} `; if (slot_info.service_unit_capacity) { diff --git a/erpnext/healthcare/doctype/patient_appointment/patient_appointment.py b/erpnext/healthcare/doctype/patient_appointment/patient_appointment.py index 1e4608f84e0..0d98fff04ff 100755 --- a/erpnext/healthcare/doctype/patient_appointment/patient_appointment.py +++ b/erpnext/healthcare/doctype/patient_appointment/patient_appointment.py @@ -12,6 +12,7 @@ from frappe.model.document import Document from frappe.model.mapper import get_mapped_doc from frappe.utils import flt, get_link_to_form, get_time, getdate +from erpnext import get_company_currency from erpnext.healthcare.doctype.healthcare_settings.healthcare_settings import ( get_income_account, get_receivable_account, @@ -26,9 +27,12 @@ from erpnext.hr.doctype.employee.employee import is_holiday class MaximumCapacityError(frappe.ValidationError): pass + + class OverlapError(frappe.ValidationError): pass + class PatientAppointment(Document): def validate(self): self.validate_overlaps() @@ -46,8 +50,9 @@ class PatientAppointment(Document): send_confirmation_msg(self) def set_title(self): - self.title = _('{0} with {1}').format(self.patient_name or self.patient, - self.practitioner_name or self.practitioner) + self.title = _("{0} with {1}").format( + self.patient_name or self.patient, self.practitioner_name or self.practitioner + ) def set_status(self): today = getdate() @@ -55,16 +60,18 @@ class PatientAppointment(Document): # If appointment is created for today set status as Open else Scheduled if appointment_date == today: - self.status = 'Open' + self.status = "Open" elif appointment_date > today: - self.status = 'Scheduled' + self.status = "Scheduled" def validate_overlaps(self): - end_time = datetime.datetime.combine(getdate(self.appointment_date), get_time(self.appointment_time)) \ - + datetime.timedelta(minutes=flt(self.duration)) + end_time = datetime.datetime.combine( + getdate(self.appointment_date), get_time(self.appointment_time) + ) + datetime.timedelta(minutes=flt(self.duration)) # all appointments for both patient and practitioner overlapping the duration of this appointment - overlapping_appointments = frappe.db.sql(""" + overlapping_appointments = frappe.db.sql( + """ SELECT name, practitioner, patient, appointment_time, duration, service_unit FROM @@ -77,35 +84,52 @@ class PatientAppointment(Document): (appointment_time=%(appointment_time)s)) """, { - 'appointment_date': self.appointment_date, - 'name': self.name, - 'practitioner': self.practitioner, - 'patient': self.patient, - 'appointment_time': self.appointment_time, - 'end_time':end_time.time() + "appointment_date": self.appointment_date, + "name": self.name, + "practitioner": self.practitioner, + "patient": self.patient, + "appointment_time": self.appointment_time, + "end_time": end_time.time(), }, - as_dict = True + as_dict=True, ) if not overlapping_appointments: - return # No overlaps, nothing to validate! + return # No overlaps, nothing to validate! - if self.service_unit: # validate service unit capacity if overlap enabled - allow_overlap, service_unit_capacity = frappe.get_value('Healthcare Service Unit', self.service_unit, - ['overlap_appointments', 'service_unit_capacity']) + if self.service_unit: # validate service unit capacity if overlap enabled + allow_overlap, service_unit_capacity = frappe.get_value( + "Healthcare Service Unit", self.service_unit, ["overlap_appointments", "service_unit_capacity"] + ) if allow_overlap: - service_unit_appointments = list(filter(lambda appointment: appointment['service_unit'] == self.service_unit and - appointment['patient'] != self.patient, overlapping_appointments)) # if same patient already booked, it should be an overlap + service_unit_appointments = list( + filter( + lambda appointment: appointment["service_unit"] == self.service_unit + and appointment["patient"] != self.patient, + overlapping_appointments, + ) + ) # if same patient already booked, it should be an overlap if len(service_unit_appointments) >= (service_unit_capacity or 1): - frappe.throw(_("Not allowed, {} cannot exceed maximum capacity {}") - .format(frappe.bold(self.service_unit), frappe.bold(service_unit_capacity or 1)), MaximumCapacityError) - else: # service_unit_appointments within capacity, remove from overlapping_appointments - overlapping_appointments = [appointment for appointment in overlapping_appointments if appointment not in service_unit_appointments] + frappe.throw( + _("Not allowed, {} cannot exceed maximum capacity {}").format( + frappe.bold(self.service_unit), frappe.bold(service_unit_capacity or 1) + ), + MaximumCapacityError, + ) + else: # service_unit_appointments within capacity, remove from overlapping_appointments + overlapping_appointments = [ + appointment + for appointment in overlapping_appointments + if appointment not in service_unit_appointments + ] if overlapping_appointments: - frappe.throw(_("Not allowed, cannot overlap appointment {}") - .format(frappe.bold(', '.join([appointment['name'] for appointment in overlapping_appointments]))), OverlapError) - + frappe.throw( + _("Not allowed, cannot overlap appointment {}").format( + frappe.bold(", ".join([appointment["name"] for appointment in overlapping_appointments])) + ), + OverlapError, + ) def validate_service_unit(self): if self.inpatient_record and self.service_unit: @@ -113,48 +137,65 @@ class PatientAppointment(Document): get_current_healthcare_service_unit, ) - is_inpatient_occupancy_unit = frappe.db.get_value('Healthcare Service Unit', self.service_unit, - 'inpatient_occupancy') + is_inpatient_occupancy_unit = frappe.db.get_value( + "Healthcare Service Unit", self.service_unit, "inpatient_occupancy" + ) service_unit = get_current_healthcare_service_unit(self.inpatient_record) if is_inpatient_occupancy_unit and service_unit != self.service_unit: - msg = _('Patient {0} is not admitted in the service unit {1}').format(frappe.bold(self.patient), frappe.bold(self.service_unit)) + '
' - msg += _('Appointment for service units with Inpatient Occupancy can only be created against the unit where patient has been admitted.') - frappe.throw(msg, title=_('Invalid Healthcare Service Unit')) - + msg = ( + _("Patient {0} is not admitted in the service unit {1}").format( + frappe.bold(self.patient), frappe.bold(self.service_unit) + ) + + "
" + ) + msg += _( + "Appointment for service units with Inpatient Occupancy can only be created against the unit where patient has been admitted." + ) + frappe.throw(msg, title=_("Invalid Healthcare Service Unit")) def set_appointment_datetime(self): - self.appointment_datetime = "%s %s" % (self.appointment_date, self.appointment_time or "00:00:00") + self.appointment_datetime = "%s %s" % ( + self.appointment_date, + self.appointment_time or "00:00:00", + ) def set_payment_details(self): - if frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing'): + if frappe.db.get_single_value("Healthcare Settings", "automate_appointment_invoicing"): details = get_service_item_and_practitioner_charge(self) - self.db_set('billing_item', details.get('service_item')) + self.db_set("billing_item", details.get("service_item")) if not self.paid_amount: - self.db_set('paid_amount', details.get('practitioner_charge')) + self.db_set("paid_amount", details.get("practitioner_charge")) def validate_customer_created(self): - if frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing'): - if not frappe.db.get_value('Patient', self.patient, 'customer'): + if frappe.db.get_single_value("Healthcare Settings", "automate_appointment_invoicing"): + if not frappe.db.get_value("Patient", self.patient, "customer"): msg = _("Please set a Customer linked to the Patient") - msg += " {0}".format(self.patient) - frappe.throw(msg, title=_('Customer Not Found')) + msg += " {0}".format(self.patient) + frappe.throw(msg, title=_("Customer Not Found")) def update_prescription_details(self): if self.procedure_prescription: - frappe.db.set_value('Procedure Prescription', self.procedure_prescription, 'appointment_booked', 1) + frappe.db.set_value( + "Procedure Prescription", self.procedure_prescription, "appointment_booked", 1 + ) if self.procedure_template: - comments = frappe.db.get_value('Procedure Prescription', self.procedure_prescription, 'comments') + comments = frappe.db.get_value( + "Procedure Prescription", self.procedure_prescription, "comments" + ) if comments: - frappe.db.set_value('Patient Appointment', self.name, 'notes', comments) + frappe.db.set_value("Patient Appointment", self.name, "notes", comments) def update_fee_validity(self): - if not frappe.db.get_single_value('Healthcare Settings', 'enable_free_follow_ups'): + if not frappe.db.get_single_value("Healthcare Settings", "enable_free_follow_ups"): return fee_validity = manage_fee_validity(self) if fee_validity: - frappe.msgprint(_('{0}: {1} has fee validity till {2}').format(self.patient, - frappe.bold(self.patient_name), fee_validity.valid_till)) + frappe.msgprint( + _("{0}: {1} has fee validity till {2}").format( + self.patient, frappe.bold(self.patient_name), fee_validity.valid_till + ) + ) @frappe.whitelist() def get_therapy_types(self): @@ -162,7 +203,7 @@ class PatientAppointment(Document): return therapy_types = [] - doc = frappe.get_doc('Therapy Plan', self.therapy_plan) + doc = frappe.get_doc("Therapy Plan", self.therapy_plan) for entry in doc.therapy_plan_details: therapy_types.append(entry.therapy_type) @@ -171,26 +212,35 @@ class PatientAppointment(Document): @frappe.whitelist() def check_payment_fields_reqd(patient): - automate_invoicing = frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing') - free_follow_ups = frappe.db.get_single_value('Healthcare Settings', 'enable_free_follow_ups') + automate_invoicing = frappe.db.get_single_value( + "Healthcare Settings", "automate_appointment_invoicing" + ) + free_follow_ups = frappe.db.get_single_value("Healthcare Settings", "enable_free_follow_ups") if automate_invoicing: if free_follow_ups: - fee_validity = frappe.db.exists('Fee Validity', {'patient': patient, 'status': 'Pending'}) + fee_validity = frappe.db.exists("Fee Validity", {"patient": patient, "status": "Pending"}) if fee_validity: - return {'fee_validity': fee_validity} + return {"fee_validity": fee_validity} return True return False + def invoice_appointment(appointment_doc): - automate_invoicing = frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing') - appointment_invoiced = frappe.db.get_value('Patient Appointment', appointment_doc.name, 'invoiced') - enable_free_follow_ups = frappe.db.get_single_value('Healthcare Settings', 'enable_free_follow_ups') + automate_invoicing = frappe.db.get_single_value( + "Healthcare Settings", "automate_appointment_invoicing" + ) + appointment_invoiced = frappe.db.get_value( + "Patient Appointment", appointment_doc.name, "invoiced" + ) + enable_free_follow_ups = frappe.db.get_single_value( + "Healthcare Settings", "enable_free_follow_ups" + ) if enable_free_follow_ups: fee_validity = check_fee_validity(appointment_doc) - if fee_validity and fee_validity.status == 'Completed': + if fee_validity and fee_validity.status == "Completed": fee_validity = None elif not fee_validity: - if frappe.db.exists('Fee Validity Reference', {'appointment': appointment_doc.name}): + if frappe.db.exists("Fee Validity Reference", {"appointment": appointment_doc.name}): return else: fee_validity = None @@ -200,21 +250,25 @@ def invoice_appointment(appointment_doc): def create_sales_invoice(appointment_doc): - sales_invoice = frappe.new_doc('Sales Invoice') + sales_invoice = frappe.new_doc("Sales Invoice") sales_invoice.patient = appointment_doc.patient - sales_invoice.customer = frappe.get_value('Patient', appointment_doc.patient, 'customer') + sales_invoice.customer = frappe.get_value("Patient", appointment_doc.patient, "customer") + sales_invoice.currency = frappe.get_value( + "Customer", sales_invoice.customer, "default_currency" + ) or get_company_currency(appointment_doc.company) + sales_invoice.appointment = appointment_doc.name sales_invoice.due_date = getdate() sales_invoice.company = appointment_doc.company sales_invoice.debit_to = get_receivable_account(appointment_doc.company) - item = sales_invoice.append('items', {}) + item = sales_invoice.append("items", {}) item = get_appointment_item(appointment_doc, item) # Add payments if payment details are supplied else proceed to create invoice as Unpaid if appointment_doc.mode_of_payment and appointment_doc.paid_amount: sales_invoice.is_pos = 1 - payment = sales_invoice.append('payments', {}) + payment = sales_invoice.append("payments", {}) payment.mode_of_payment = appointment_doc.mode_of_payment payment.amount = appointment_doc.paid_amount @@ -222,56 +276,61 @@ def create_sales_invoice(appointment_doc): sales_invoice.flags.ignore_mandatory = True sales_invoice.save(ignore_permissions=True) sales_invoice.submit() - frappe.msgprint(_('Sales Invoice {0} created').format(sales_invoice.name), alert=True) - frappe.db.set_value('Patient Appointment', appointment_doc.name, { - 'invoiced': 1, - 'ref_sales_invoice': sales_invoice.name - }) + frappe.msgprint(_("Sales Invoice {0} created").format(sales_invoice.name), alert=True) + frappe.db.set_value( + "Patient Appointment", + appointment_doc.name, + {"invoiced": 1, "ref_sales_invoice": sales_invoice.name}, + ) def check_is_new_patient(patient, name=None): - filters = {'patient': patient, 'status': ('!=','Cancelled')} + filters = {"patient": patient, "status": ("!=", "Cancelled")} if name: - filters['name'] = ('!=', name) + filters["name"] = ("!=", name) - has_previous_appointment = frappe.db.exists('Patient Appointment', filters) + has_previous_appointment = frappe.db.exists("Patient Appointment", filters) return not has_previous_appointment def get_appointment_item(appointment_doc, item): details = get_service_item_and_practitioner_charge(appointment_doc) - charge = appointment_doc.paid_amount or details.get('practitioner_charge') - item.item_code = details.get('service_item') - item.description = _('Consulting Charges: {0}').format(appointment_doc.practitioner) + charge = appointment_doc.paid_amount or details.get("practitioner_charge") + item.item_code = details.get("service_item") + item.description = _("Consulting Charges: {0}").format(appointment_doc.practitioner) item.income_account = get_income_account(appointment_doc.practitioner, appointment_doc.company) - item.cost_center = frappe.get_cached_value('Company', appointment_doc.company, 'cost_center') + item.cost_center = frappe.get_cached_value("Company", appointment_doc.company, "cost_center") item.rate = charge item.amount = charge item.qty = 1 - item.reference_dt = 'Patient Appointment' + item.reference_dt = "Patient Appointment" item.reference_dn = appointment_doc.name return item def cancel_appointment(appointment_id): - appointment = frappe.get_doc('Patient Appointment', appointment_id) + appointment = frappe.get_doc("Patient Appointment", appointment_id) if appointment.invoiced: sales_invoice = check_sales_invoice_exists(appointment) if sales_invoice and cancel_sales_invoice(sales_invoice): - msg = _('Appointment {0} and Sales Invoice {1} cancelled').format(appointment.name, sales_invoice.name) + msg = _("Appointment {0} and Sales Invoice {1} cancelled").format( + appointment.name, sales_invoice.name + ) else: - msg = _('Appointment Cancelled. Please review and cancel the invoice {0}').format(sales_invoice.name) + msg = _("Appointment Cancelled. Please review and cancel the invoice {0}").format( + sales_invoice.name + ) else: fee_validity = manage_fee_validity(appointment) - msg = _('Appointment Cancelled.') + msg = _("Appointment Cancelled.") if fee_validity: - msg += _('Fee Validity {0} updated.').format(fee_validity.name) + msg += _("Fee Validity {0} updated.").format(fee_validity.name) frappe.msgprint(msg) def cancel_sales_invoice(sales_invoice): - if frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing'): + if frappe.db.get_single_value("Healthcare Settings", "automate_appointment_invoicing"): if len(sales_invoice.items) == 1: sales_invoice.cancel() return True @@ -279,13 +338,14 @@ def cancel_sales_invoice(sales_invoice): def check_sales_invoice_exists(appointment): - sales_invoice = frappe.db.get_value('Sales Invoice Item', { - 'reference_dt': 'Patient Appointment', - 'reference_dn': appointment.name - }, 'parent') + sales_invoice = frappe.db.get_value( + "Sales Invoice Item", + {"reference_dt": "Patient Appointment", "reference_dn": appointment.name}, + "parent", + ) if sales_invoice: - sales_invoice = frappe.get_doc('Sales Invoice', sales_invoice) + sales_invoice = frappe.get_doc("Sales Invoice", sales_invoice) return sales_invoice return False @@ -300,24 +360,29 @@ def get_availability_data(date, practitioner): """ date = getdate(date) - weekday = date.strftime('%A') + weekday = date.strftime("%A") - practitioner_doc = frappe.get_doc('Healthcare Practitioner', practitioner) + practitioner_doc = frappe.get_doc("Healthcare Practitioner", practitioner) check_employee_wise_availability(date, practitioner_doc) if practitioner_doc.practitioner_schedules: slot_details = get_available_slots(practitioner_doc, date) else: - frappe.throw(_('{0} does not have a Healthcare Practitioner Schedule. Add it in Healthcare Practitioner master').format( - practitioner), title=_('Practitioner Schedule Not Found')) - + frappe.throw( + _( + "{0} does not have a Healthcare Practitioner Schedule. Add it in Healthcare Practitioner master" + ).format(practitioner), + title=_("Practitioner Schedule Not Found"), + ) if not slot_details: # TODO: return available slots in nearby dates - frappe.throw(_('Healthcare Practitioner not available on {0}').format(weekday), title=_('Not Available')) + frappe.throw( + _("Healthcare Practitioner not available on {0}").format(weekday), title=_("Not Available") + ) - return {'slot_details': slot_details} + return {"slot_details": slot_details} def check_employee_wise_availability(date, practitioner_doc): @@ -325,32 +390,41 @@ def check_employee_wise_availability(date, practitioner_doc): if practitioner_doc.employee: employee = practitioner_doc.employee elif practitioner_doc.user_id: - employee = frappe.db.get_value('Employee', {'user_id': practitioner_doc.user_id}, 'name') + employee = frappe.db.get_value("Employee", {"user_id": practitioner_doc.user_id}, "name") if employee: # check holiday if is_holiday(employee, date): - frappe.throw(_('{0} is a holiday'.format(date)), title=_('Not Available')) + frappe.throw(_("{0} is a holiday".format(date)), title=_("Not Available")) # check leave status - leave_record = frappe.db.sql("""select half_day from `tabLeave Application` + leave_record = frappe.db.sql( + """select half_day from `tabLeave Application` where employee = %s and %s between from_date and to_date - and docstatus = 1""", (employee, date), as_dict=True) + and docstatus = 1""", + (employee, date), + as_dict=True, + ) if leave_record: if leave_record[0].half_day: - frappe.throw(_('{0} is on a Half day Leave on {1}').format(practitioner_doc.name, date), title=_('Not Available')) + frappe.throw( + _("{0} is on a Half day Leave on {1}").format(practitioner_doc.name, date), + title=_("Not Available"), + ) else: - frappe.throw(_('{0} is on Leave on {1}').format(practitioner_doc.name, date), title=_('Not Available')) + frappe.throw( + _("{0} is on Leave on {1}").format(practitioner_doc.name, date), title=_("Not Available") + ) def get_available_slots(practitioner_doc, date): available_slots = slot_details = [] - weekday = date.strftime('%A') + weekday = date.strftime("%A") practitioner = practitioner_doc.name for schedule_entry in practitioner_doc.practitioner_schedules: validate_practitioner_schedules(schedule_entry, practitioner) - practitioner_schedule = frappe.get_doc('Practitioner Schedule', schedule_entry.schedule) + practitioner_schedule = frappe.get_doc("Practitioner Schedule", schedule_entry.schedule) if practitioner_schedule and not practitioner_schedule.disabled: available_slots = [] @@ -364,31 +438,45 @@ def get_available_slots(practitioner_doc, date): service_unit_capacity = 0 # fetch all appointments to practitioner by service unit filters = { - 'practitioner': practitioner, - 'service_unit': schedule_entry.service_unit, - 'appointment_date': date, - 'status': ['not in',['Cancelled']] + "practitioner": practitioner, + "service_unit": schedule_entry.service_unit, + "appointment_date": date, + "status": ["not in", ["Cancelled"]], } if schedule_entry.service_unit: - slot_name = f'{schedule_entry.schedule}' - allow_overlap, service_unit_capacity = frappe.get_value('Healthcare Service Unit', schedule_entry.service_unit, ['overlap_appointments', 'service_unit_capacity']) + slot_name = f"{schedule_entry.schedule}" + allow_overlap, service_unit_capacity = frappe.get_value( + "Healthcare Service Unit", + schedule_entry.service_unit, + ["overlap_appointments", "service_unit_capacity"], + ) if not allow_overlap: # fetch all appointments to service unit - filters.pop('practitioner') + filters.pop("practitioner") else: slot_name = schedule_entry.schedule # fetch all appointments to practitioner without service unit - filters['practitioner'] = practitioner - filters.pop('service_unit') + filters["practitioner"] = practitioner + filters.pop("service_unit") appointments = frappe.get_all( - 'Patient Appointment', + "Patient Appointment", filters=filters, - fields=['name', 'appointment_time', 'duration', 'status']) + fields=["name", "appointment_time", "duration", "status"], + ) - slot_details.append({'slot_name': slot_name, 'service_unit': schedule_entry.service_unit, 'avail_slot': available_slots, - 'appointments': appointments, 'allow_overlap': allow_overlap, 'service_unit_capacity': service_unit_capacity}) + slot_details.append( + { + "slot_name": slot_name, + "service_unit": schedule_entry.service_unit, + "avail_slot": available_slots, + "appointments": appointments, + "allow_overlap": allow_overlap, + "service_unit_capacity": service_unit_capacity, + "practitioner_name": practitioner_doc.practitioner_name, + } + ) return slot_details @@ -396,82 +484,107 @@ def get_available_slots(practitioner_doc, date): def validate_practitioner_schedules(schedule_entry, practitioner): if schedule_entry.schedule: if not schedule_entry.service_unit: - frappe.throw(_('Practitioner {0} does not have a Service Unit set against the Practitioner Schedule {1}.').format( - get_link_to_form('Healthcare Practitioner', practitioner), frappe.bold(schedule_entry.schedule)), - title=_('Service Unit Not Found')) + frappe.throw( + _( + "Practitioner {0} does not have a Service Unit set against the Practitioner Schedule {1}." + ).format( + get_link_to_form("Healthcare Practitioner", practitioner), + frappe.bold(schedule_entry.schedule), + ), + title=_("Service Unit Not Found"), + ) else: - frappe.throw(_('Practitioner {0} does not have a Practitioner Schedule assigned.').format( - get_link_to_form('Healthcare Practitioner', practitioner)), - title=_('Practitioner Schedule Not Found')) + frappe.throw( + _("Practitioner {0} does not have a Practitioner Schedule assigned.").format( + get_link_to_form("Healthcare Practitioner", practitioner) + ), + title=_("Practitioner Schedule Not Found"), + ) @frappe.whitelist() def update_status(appointment_id, status): - frappe.db.set_value('Patient Appointment', appointment_id, 'status', status) + frappe.db.set_value("Patient Appointment", appointment_id, "status", status) appointment_booked = True - if status == 'Cancelled': + if status == "Cancelled": appointment_booked = False cancel_appointment(appointment_id) - procedure_prescription = frappe.db.get_value('Patient Appointment', appointment_id, 'procedure_prescription') + procedure_prescription = frappe.db.get_value( + "Patient Appointment", appointment_id, "procedure_prescription" + ) if procedure_prescription: - frappe.db.set_value('Procedure Prescription', procedure_prescription, 'appointment_booked', appointment_booked) + frappe.db.set_value( + "Procedure Prescription", procedure_prescription, "appointment_booked", appointment_booked + ) def send_confirmation_msg(doc): - if frappe.db.get_single_value('Healthcare Settings', 'send_appointment_confirmation'): - message = frappe.db.get_single_value('Healthcare Settings', 'appointment_confirmation_msg') + if frappe.db.get_single_value("Healthcare Settings", "send_appointment_confirmation"): + message = frappe.db.get_single_value("Healthcare Settings", "appointment_confirmation_msg") try: send_message(doc, message) except Exception: - frappe.log_error(frappe.get_traceback(), _('Appointment Confirmation Message Not Sent')) - frappe.msgprint(_('Appointment Confirmation Message Not Sent'), indicator='orange') + frappe.log_error(frappe.get_traceback(), _("Appointment Confirmation Message Not Sent")) + frappe.msgprint(_("Appointment Confirmation Message Not Sent"), indicator="orange") @frappe.whitelist() def make_encounter(source_name, target_doc=None): - doc = get_mapped_doc('Patient Appointment', source_name, { - 'Patient Appointment': { - 'doctype': 'Patient Encounter', - 'field_map': [ - ['appointment', 'name'], - ['patient', 'patient'], - ['practitioner', 'practitioner'], - ['medical_department', 'department'], - ['patient_sex', 'patient_sex'], - ['invoiced', 'invoiced'], - ['company', 'company'] - ] - } - }, target_doc) + doc = get_mapped_doc( + "Patient Appointment", + source_name, + { + "Patient Appointment": { + "doctype": "Patient Encounter", + "field_map": [ + ["appointment", "name"], + ["patient", "patient"], + ["practitioner", "practitioner"], + ["medical_department", "department"], + ["patient_sex", "patient_sex"], + ["invoiced", "invoiced"], + ["company", "company"], + ], + } + }, + target_doc, + ) return doc def send_appointment_reminder(): - if frappe.db.get_single_value('Healthcare Settings', 'send_appointment_reminder'): - remind_before = datetime.datetime.strptime(frappe.db.get_single_value('Healthcare Settings', 'remind_before'), '%H:%M:%S') + if frappe.db.get_single_value("Healthcare Settings", "send_appointment_reminder"): + remind_before = datetime.datetime.strptime( + frappe.db.get_single_value("Healthcare Settings", "remind_before"), "%H:%M:%S" + ) reminder_dt = datetime.datetime.now() + datetime.timedelta( - hours=remind_before.hour, minutes=remind_before.minute, seconds=remind_before.second) + hours=remind_before.hour, minutes=remind_before.minute, seconds=remind_before.second + ) - appointment_list = frappe.db.get_all('Patient Appointment', { - 'appointment_datetime': ['between', (datetime.datetime.now(), reminder_dt)], - 'reminded': 0, - 'status': ['!=', 'Cancelled'] - }) + appointment_list = frappe.db.get_all( + "Patient Appointment", + { + "appointment_datetime": ["between", (datetime.datetime.now(), reminder_dt)], + "reminded": 0, + "status": ["!=", "Cancelled"], + }, + ) for appointment in appointment_list: - doc = frappe.get_doc('Patient Appointment', appointment.name) - message = frappe.db.get_single_value('Healthcare Settings', 'appointment_reminder_msg') + doc = frappe.get_doc("Patient Appointment", appointment.name) + message = frappe.db.get_single_value("Healthcare Settings", "appointment_reminder_msg") send_message(doc, message) - frappe.db.set_value('Patient Appointment', doc.name, 'reminded', 1) + frappe.db.set_value("Patient Appointment", doc.name, "reminded", 1) + def send_message(doc, message): - patient_mobile = frappe.db.get_value('Patient', doc.patient, 'mobile') + patient_mobile = frappe.db.get_value("Patient", doc.patient, "mobile") if patient_mobile: - context = {'doc': doc, 'alert': doc, 'comments': None} - if doc.get('_comments'): - context['comments'] = json.loads(doc.get('_comments')) + context = {"doc": doc, "alert": doc, "comments": None} + if doc.get("_comments"): + context["comments"] = json.loads(doc.get("_comments")) # jinja to string convertion happens here message = frappe.render_template(message, context) @@ -479,7 +592,8 @@ def send_message(doc, message): try: send_sms(number, message) except Exception as e: - frappe.msgprint(_('SMS not sent, please check SMS Settings'), alert=True) + frappe.msgprint(_("SMS not sent, please check SMS Settings"), alert=True) + @frappe.whitelist() def get_events(start, end, filters=None): @@ -490,9 +604,11 @@ def get_events(start, end, filters=None): :param filters: Filters (JSON). """ from frappe.desk.calendar import get_event_conditions - conditions = get_event_conditions('Patient Appointment', filters) - data = frappe.db.sql(""" + conditions = get_event_conditions("Patient Appointment", filters) + + data = frappe.db.sql( + """ select `tabPatient Appointment`.name, `tabPatient Appointment`.patient, `tabPatient Appointment`.practitioner, `tabPatient Appointment`.status, @@ -504,11 +620,16 @@ def get_events(start, end, filters=None): left join `tabAppointment Type` on `tabPatient Appointment`.appointment_type=`tabAppointment Type`.name where (`tabPatient Appointment`.appointment_date between %(start)s and %(end)s) - and `tabPatient Appointment`.status != 'Cancelled' and `tabPatient Appointment`.docstatus < 2 {conditions}""".format(conditions=conditions), - {"start": start, "end": end}, as_dict=True, update={"allDay": 0}) + and `tabPatient Appointment`.status != 'Cancelled' and `tabPatient Appointment`.docstatus < 2 {conditions}""".format( + conditions=conditions + ), + {"start": start, "end": end}, + as_dict=True, + update={"allDay": 0}, + ) for item in data: - item.end = item.start + datetime.timedelta(minutes = item.duration) + item.end = item.start + datetime.timedelta(minutes=item.duration) return data @@ -526,7 +647,8 @@ def get_procedure_prescribed(patient): ct.patient=%(patient)s and pp.parent=ct.name and pp.appointment_booked=0 ORDER BY ct.creation desc - """, {'patient': patient} + """, + {"patient": patient}, ) @@ -543,15 +665,16 @@ def get_prescribed_therapies(patient): e.patient=%(patient)s and t.parent=e.name ORDER BY e.creation desc - """, {'patient': patient} + """, + {"patient": patient}, ) def update_appointment_status(): # update the status of appointments daily - appointments = frappe.get_all('Patient Appointment', { - 'status': ('not in', ['Closed', 'Cancelled']) - }, as_dict=1) + appointments = frappe.get_all( + "Patient Appointment", {"status": ("not in", ["Closed", "Cancelled"])}, as_dict=1 + ) for appointment in appointments: - frappe.get_doc('Patient Appointment', appointment.name).set_status() + frappe.get_doc("Patient Appointment", appointment.name).set_status() diff --git a/erpnext/healthcare/doctype/patient_appointment/patient_appointment_dashboard.py b/erpnext/healthcare/doctype/patient_appointment/patient_appointment_dashboard.py index 89349ee60f6..3eeb153055b 100644 --- a/erpnext/healthcare/doctype/patient_appointment/patient_appointment_dashboard.py +++ b/erpnext/healthcare/doctype/patient_appointment/patient_appointment_dashboard.py @@ -1,17 +1,14 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'appointment', - 'non_standard_fieldnames': { - 'Patient Medical Record': 'reference_name' - }, - 'transactions': [ + "fieldname": "appointment", + "non_standard_fieldnames": {"Patient Medical Record": "reference_name"}, + "transactions": [ { - 'label': _('Consultations'), - 'items': ['Patient Encounter', 'Vital Signs', 'Patient Medical Record'] + "label": _("Consultations"), + "items": ["Patient Encounter", "Vital Signs", "Patient Medical Record"], } - ] + ], } diff --git a/erpnext/healthcare/doctype/patient_appointment/test_patient_appointment.py b/erpnext/healthcare/doctype/patient_appointment/test_patient_appointment.py index 7afdba69eaa..05e6b9cfe0d 100644 --- a/erpnext/healthcare/doctype/patient_appointment/test_patient_appointment.py +++ b/erpnext/healthcare/doctype/patient_appointment/test_patient_appointment.py @@ -22,24 +22,28 @@ class TestPatientAppointment(unittest.TestCase): frappe.db.sql("""delete from `tabPatient Encounter`""") make_pos_profile() frappe.db.sql("""delete from `tabHealthcare Service Unit` where name like '_Test %'""") - frappe.db.sql("""delete from `tabHealthcare Service Unit` where name like '_Test Service Unit Type%'""") + frappe.db.sql( + """delete from `tabHealthcare Service Unit` where name like '_Test Service Unit Type%'""" + ) def test_status(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 0) appointment = create_appointment(patient, practitioner, nowdate()) - self.assertEqual(appointment.status, 'Open') + self.assertEqual(appointment.status, "Open") appointment = create_appointment(patient, practitioner, add_days(nowdate(), 2)) - self.assertEqual(appointment.status, 'Scheduled') + self.assertEqual(appointment.status, "Scheduled") encounter = create_encounter(appointment) - self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'status'), 'Closed') + self.assertEqual( + frappe.db.get_value("Patient Appointment", appointment.name, "status"), "Closed" + ) encounter.cancel() - self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'status'), 'Open') + self.assertEqual(frappe.db.get_value("Patient Appointment", appointment.name, "status"), "Open") def test_start_encounter(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) - appointment = create_appointment(patient, practitioner, add_days(nowdate(), 4), invoice = 1) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) + appointment = create_appointment(patient, practitioner, add_days(nowdate(), 4), invoice=1) appointment.reload() self.assertEqual(appointment.invoiced, 1) encounter = make_encounter(appointment.name) @@ -48,92 +52,115 @@ class TestPatientAppointment(unittest.TestCase): self.assertEqual(encounter.practitioner, appointment.practitioner) self.assertEqual(encounter.patient, appointment.patient) # invoiced flag mapped from appointment - self.assertEqual(encounter.invoiced, frappe.db.get_value('Patient Appointment', appointment.name, 'invoiced')) + self.assertEqual( + encounter.invoiced, frappe.db.get_value("Patient Appointment", appointment.name, "invoiced") + ) def test_auto_invoicing(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 0) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 0) appointment = create_appointment(patient, practitioner, nowdate()) - self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'invoiced'), 0) + self.assertEqual(frappe.db.get_value("Patient Appointment", appointment.name, "invoiced"), 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) appointment = create_appointment(patient, practitioner, add_days(nowdate(), 2), invoice=1) - self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'invoiced'), 1) - sales_invoice_name = frappe.db.get_value('Sales Invoice Item', {'reference_dn': appointment.name}, 'parent') + self.assertEqual(frappe.db.get_value("Patient Appointment", appointment.name, "invoiced"), 1) + sales_invoice_name = frappe.db.get_value( + "Sales Invoice Item", {"reference_dn": appointment.name}, "parent" + ) self.assertTrue(sales_invoice_name) - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'company'), appointment.company) - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'patient'), appointment.patient) - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'paid_amount'), appointment.paid_amount) + self.assertEqual( + frappe.db.get_value("Sales Invoice", sales_invoice_name, "company"), appointment.company + ) + self.assertEqual( + frappe.db.get_value("Sales Invoice", sales_invoice_name, "patient"), appointment.patient + ) + self.assertEqual( + frappe.db.get_value("Sales Invoice", sales_invoice_name, "paid_amount"), appointment.paid_amount + ) def test_auto_invoicing_based_on_department(self): patient, practitioner = create_healthcare_docs() medical_department = create_medical_department() - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) - appointment_type = create_appointment_type({'medical_department': medical_department}) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) + appointment_type = create_appointment_type({"medical_department": medical_department}) - appointment = create_appointment(patient, practitioner, add_days(nowdate(), 2), - invoice=1, appointment_type=appointment_type.name, department=medical_department) + appointment = create_appointment( + patient, + practitioner, + add_days(nowdate(), 2), + invoice=1, + appointment_type=appointment_type.name, + department=medical_department, + ) appointment.reload() self.assertEqual(appointment.invoiced, 1) - self.assertEqual(appointment.billing_item, 'HLC-SI-001') + self.assertEqual(appointment.billing_item, "HLC-SI-001") self.assertEqual(appointment.paid_amount, 200) - sales_invoice_name = frappe.db.get_value('Sales Invoice Item', {'reference_dn': appointment.name}, 'parent') + sales_invoice_name = frappe.db.get_value( + "Sales Invoice Item", {"reference_dn": appointment.name}, "parent" + ) self.assertTrue(sales_invoice_name) - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'paid_amount'), appointment.paid_amount) + self.assertEqual( + frappe.db.get_value("Sales Invoice", sales_invoice_name, "paid_amount"), appointment.paid_amount + ) def test_auto_invoicing_according_to_appointment_type_charge(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) item = create_healthcare_service_items() - items = [{ - 'op_consulting_charge_item': item, - 'op_consulting_charge': 300 - }] - appointment_type = create_appointment_type(args={ - 'name': 'Generic Appointment Type charge', - 'items': items - }) + items = [{"op_consulting_charge_item": item, "op_consulting_charge": 300}] + appointment_type = create_appointment_type( + args={"name": "Generic Appointment Type charge", "items": items} + ) - appointment = create_appointment(patient, practitioner, add_days(nowdate(), 2), - invoice=1, appointment_type=appointment_type.name) + appointment = create_appointment( + patient, practitioner, add_days(nowdate(), 2), invoice=1, appointment_type=appointment_type.name + ) appointment.reload() self.assertEqual(appointment.invoiced, 1) self.assertEqual(appointment.billing_item, item) self.assertEqual(appointment.paid_amount, 300) - sales_invoice_name = frappe.db.get_value('Sales Invoice Item', {'reference_dn': appointment.name}, 'parent') + sales_invoice_name = frappe.db.get_value( + "Sales Invoice Item", {"reference_dn": appointment.name}, "parent" + ) self.assertTrue(sales_invoice_name) def test_appointment_cancel(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 1) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 1) appointment = create_appointment(patient, practitioner, nowdate()) - fee_validity = frappe.db.get_value('Fee Validity', {'patient': patient, 'practitioner': practitioner}) + fee_validity = frappe.db.get_value( + "Fee Validity", {"patient": patient, "practitioner": practitioner} + ) # fee validity created self.assertTrue(fee_validity) # first follow up appointment appointment = create_appointment(patient, practitioner, add_days(nowdate(), 1)) - self.assertEqual(frappe.db.get_value('Fee Validity', fee_validity, 'visited'), 1) + self.assertEqual(frappe.db.get_value("Fee Validity", fee_validity, "visited"), 1) - update_status(appointment.name, 'Cancelled') + update_status(appointment.name, "Cancelled") # check fee validity updated - self.assertEqual(frappe.db.get_value('Fee Validity', fee_validity, 'visited'), 0) + self.assertEqual(frappe.db.get_value("Fee Validity", fee_validity, "visited"), 0) - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) appointment = create_appointment(patient, practitioner, add_days(nowdate(), 1), invoice=1) - update_status(appointment.name, 'Cancelled') + update_status(appointment.name, "Cancelled") # check invoice cancelled - sales_invoice_name = frappe.db.get_value('Sales Invoice Item', {'reference_dn': appointment.name}, 'parent') - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'status'), 'Cancelled') + sales_invoice_name = frappe.db.get_value( + "Sales Invoice Item", {"reference_dn": appointment.name}, "parent" + ) + self.assertEqual(frappe.db.get_value("Sales Invoice", sales_invoice_name, "status"), "Cancelled") def test_appointment_booking_for_admission_service_unit(self): from erpnext.healthcare.doctype.inpatient_record.inpatient_record import ( @@ -153,17 +180,19 @@ class TestPatientAppointment(unittest.TestCase): # Schedule Admission ip_record = create_inpatient(patient) ip_record.expected_length_of_stay = 0 - ip_record.save(ignore_permissions = True) + ip_record.save(ignore_permissions=True) # Admit - service_unit = get_healthcare_service_unit('_Test Service Unit Ip Occupancy') + service_unit = get_healthcare_service_unit("_Test Service Unit Ip Occupancy") admit_patient(ip_record, service_unit, now_datetime()) appointment = create_appointment(patient, practitioner, nowdate(), service_unit=service_unit) self.assertEqual(appointment.service_unit, service_unit) # Discharge - schedule_discharge(frappe.as_json({'patient': patient, 'discharge_ordered_datetime': now_datetime()})) + schedule_discharge( + frappe.as_json({"patient": patient, "discharge_ordered_datetime": now_datetime()}) + ) ip_record1 = frappe.get_doc("Inpatient Record", ip_record.name) mark_invoiced_inpatient_occupancy(ip_record1) discharge_patient(ip_record1, now_datetime()) @@ -186,27 +215,33 @@ class TestPatientAppointment(unittest.TestCase): # Schedule Admission ip_record = create_inpatient(patient) ip_record.expected_length_of_stay = 0 - ip_record.save(ignore_permissions = True) + ip_record.save(ignore_permissions=True) # Admit - service_unit = get_healthcare_service_unit('_Test Service Unit Ip Occupancy') + service_unit = get_healthcare_service_unit("_Test Service Unit Ip Occupancy") admit_patient(ip_record, service_unit, now_datetime()) - appointment_service_unit = get_healthcare_service_unit('_Test Service Unit Ip Occupancy for Appointment') - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=appointment_service_unit, save=0) + appointment_service_unit = get_healthcare_service_unit( + "_Test Service Unit Ip Occupancy for Appointment" + ) + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=appointment_service_unit, save=0 + ) self.assertRaises(frappe.exceptions.ValidationError, appointment.save) # Discharge - schedule_discharge(frappe.as_json({'patient': patient, 'discharge_ordered_datetime': now_datetime()})) + schedule_discharge( + frappe.as_json({"patient": patient, "discharge_ordered_datetime": now_datetime()}) + ) ip_record1 = frappe.get_doc("Inpatient Record", ip_record.name) mark_invoiced_inpatient_occupancy(ip_record1) discharge_patient(ip_record1, now_datetime()) def test_payment_should_be_mandatory_for_new_patient_appointment(self): - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 1) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) - frappe.db.set_value('Healthcare Settings', None, 'max_visits', 3) - frappe.db.set_value('Healthcare Settings', None, 'valid_days', 30) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 1) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) + frappe.db.set_value("Healthcare Settings", None, "max_visits", 3) + frappe.db.set_value("Healthcare Settings", None, "valid_days", 30) patient = create_patient() assert check_is_new_patient(patient) @@ -215,43 +250,60 @@ class TestPatientAppointment(unittest.TestCase): def test_sales_invoice_should_be_generated_for_new_patient_appointment(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) - invoice_count = frappe.db.count('Sales Invoice') + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) + invoice_count = frappe.db.count("Sales Invoice") assert check_is_new_patient(patient) create_appointment(patient, practitioner, nowdate()) - new_invoice_count = frappe.db.count('Sales Invoice') + new_invoice_count = frappe.db.count("Sales Invoice") assert new_invoice_count == invoice_count + 1 def test_overlap_appointment(self): from erpnext.healthcare.doctype.patient_appointment.patient_appointment import OverlapError + patient, practitioner = create_healthcare_docs(id=1) patient_1, practitioner_1 = create_healthcare_docs(id=2) service_unit = create_service_unit(id=0) service_unit_1 = create_service_unit(id=1) - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=service_unit) # valid + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=service_unit + ) # valid # patient and practitioner cannot have overlapping appointments - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=service_unit, save=0) + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=service_unit, save=0 + ) self.assertRaises(OverlapError, appointment.save) - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=service_unit_1, save=0) # diff service unit + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=service_unit_1, save=0 + ) # diff service unit self.assertRaises(OverlapError, appointment.save) - appointment = create_appointment(patient, practitioner, nowdate(), save=0) # with no service unit link + appointment = create_appointment( + patient, practitioner, nowdate(), save=0 + ) # with no service unit link self.assertRaises(OverlapError, appointment.save) # patient cannot have overlapping appointments with other practitioners - appointment = create_appointment(patient, practitioner_1, nowdate(), service_unit=service_unit, save=0) + appointment = create_appointment( + patient, practitioner_1, nowdate(), service_unit=service_unit, save=0 + ) self.assertRaises(OverlapError, appointment.save) - appointment = create_appointment(patient, practitioner_1, nowdate(), service_unit=service_unit_1, save=0) + appointment = create_appointment( + patient, practitioner_1, nowdate(), service_unit=service_unit_1, save=0 + ) self.assertRaises(OverlapError, appointment.save) appointment = create_appointment(patient, practitioner_1, nowdate(), save=0) self.assertRaises(OverlapError, appointment.save) # practitioner cannot have overlapping appointments with other patients - appointment = create_appointment(patient_1, practitioner, nowdate(), service_unit=service_unit, save=0) + appointment = create_appointment( + patient_1, practitioner, nowdate(), service_unit=service_unit, save=0 + ) self.assertRaises(OverlapError, appointment.save) - appointment = create_appointment(patient_1, practitioner, nowdate(), service_unit=service_unit_1, save=0) + appointment = create_appointment( + patient_1, practitioner, nowdate(), service_unit=service_unit_1, save=0 + ) self.assertRaises(OverlapError, appointment.save) appointment = create_appointment(patient_1, practitioner, nowdate(), save=0) self.assertRaises(OverlapError, appointment.save) @@ -261,19 +313,28 @@ class TestPatientAppointment(unittest.TestCase): MaximumCapacityError, OverlapError, ) + practitioner = create_practitioner() capacity = 3 - overlap_service_unit_type = create_service_unit_type(id=10, allow_appointments=1, overlap_appointments=1) - overlap_service_unit = create_service_unit(id=100, service_unit_type=overlap_service_unit_type, service_unit_capacity=capacity) + overlap_service_unit_type = create_service_unit_type( + id=10, allow_appointments=1, overlap_appointments=1 + ) + overlap_service_unit = create_service_unit( + id=100, service_unit_type=overlap_service_unit_type, service_unit_capacity=capacity + ) for i in range(0, capacity): patient = create_patient(id=i) - create_appointment(patient, practitioner, nowdate(), service_unit=overlap_service_unit) # valid - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=overlap_service_unit, save=0) # overlap + create_appointment(patient, practitioner, nowdate(), service_unit=overlap_service_unit) # valid + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=overlap_service_unit, save=0 + ) # overlap self.assertRaises(OverlapError, appointment.save) patient = create_patient(id=capacity) - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=overlap_service_unit, save=0) + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=overlap_service_unit, save=0 + ) self.assertRaises(MaximumCapacityError, appointment.save) def test_patient_appointment_should_consider_permissions_while_fetching_appointments(self): @@ -285,16 +346,16 @@ class TestPatientAppointment(unittest.TestCase): roles = [{"doctype": "Has Role", "role": "Physician"}] user = create_user(roles=roles) - new_practitioner = frappe.get_doc('Healthcare Practitioner', new_practitioner) + new_practitioner = frappe.get_doc("Healthcare Practitioner", new_practitioner) new_practitioner.user_id = user.email new_practitioner.save() frappe.set_user(user.name) - appointments = frappe.get_list('Patient Appointment') + appointments = frappe.get_list("Patient Appointment") assert len(appointments) == 1 frappe.set_user("Administrator") - appointments = frappe.get_list('Patient Appointment') + appointments = frappe.get_list("Patient Appointment") assert len(appointments) == 2 @@ -305,17 +366,20 @@ def create_healthcare_docs(id=0): return patient, practitioner -def create_patient(id=0, patient_name=None, email=None, mobile=None, customer=None, create_user=False): - if frappe.db.exists('Patient', {'firstname':f'_Test Patient {str(id)}'}): - patient = frappe.db.get_value('Patient', {'first_name': f'_Test Patient {str(id)}'}, ['name']) +def create_patient( + id=0, patient_name=None, email=None, mobile=None, customer=None, create_user=False +): + if frappe.db.exists("Patient", {"firstname": f"_Test Patient {str(id)}"}): + patient = frappe.db.get_value("Patient", {"first_name": f"_Test Patient {str(id)}"}, ["name"]) return patient - patient = frappe.new_doc('Patient') - patient.first_name = patient_name if patient_name else f'_Test Patient {str(id)}' - patient.sex = 'Female' + patient = frappe.new_doc("Patient") + patient.first_name = patient_name if patient_name else f"_Test Patient {str(id)}" + patient.sex = "Female" patient.mobile = mobile patient.email = email patient.customer = customer + patient.default_currency = "INR" patient.invite_user = create_user patient.save(ignore_permissions=True) @@ -323,24 +387,28 @@ def create_patient(id=0, patient_name=None, email=None, mobile=None, customer=No def create_medical_department(id=0): - if frappe.db.exists('Medical Department', f'_Test Medical Department {str(id)}'): - return f'_Test Medical Department {str(id)}' + if frappe.db.exists("Medical Department", f"_Test Medical Department {str(id)}"): + return f"_Test Medical Department {str(id)}" - medical_department = frappe.new_doc('Medical Department') - medical_department.department = f'_Test Medical Department {str(id)}' + medical_department = frappe.new_doc("Medical Department") + medical_department.department = f"_Test Medical Department {str(id)}" medical_department.save(ignore_permissions=True) return medical_department.name def create_practitioner(id=0, medical_department=None): - if frappe.db.exists('Healthcare Practitioner', {'firstname':f'_Test Healthcare Practitioner {str(id)}'}): - practitioner = frappe.db.get_value('Healthcare Practitioner', {'firstname':f'_Test Healthcare Practitioner {str(id)}'}, ['name']) + if frappe.db.exists( + "Healthcare Practitioner", {"firstname": f"_Test Healthcare Practitioner {str(id)}"} + ): + practitioner = frappe.db.get_value( + "Healthcare Practitioner", {"firstname": f"_Test Healthcare Practitioner {str(id)}"}, ["name"] + ) return practitioner - practitioner = frappe.new_doc('Healthcare Practitioner') - practitioner.first_name = f'_Test Healthcare Practitioner {str(id)}' - practitioner.gender = 'Female' + practitioner = frappe.new_doc("Healthcare Practitioner") + practitioner.first_name = f"_Test Healthcare Practitioner {str(id)}" + practitioner.gender = "Female" practitioner.department = medical_department or create_medical_department(id) practitioner.op_consulting_charge = 500 practitioner.inpatient_visit_charge = 500 @@ -348,9 +416,10 @@ def create_practitioner(id=0, medical_department=None): return practitioner.name + def create_encounter(appointment): if appointment: - encounter = frappe.new_doc('Patient Encounter') + encounter = frappe.new_doc("Patient Encounter") encounter.appointment = appointment.name encounter.patient = appointment.patient encounter.practitioner = appointment.practitioner @@ -362,27 +431,37 @@ def create_encounter(appointment): return encounter -def create_appointment(patient, practitioner, appointment_date, invoice=0, procedure_template=0, - service_unit=None, appointment_type=None, save=1, department=None): + +def create_appointment( + patient, + practitioner, + appointment_date, + invoice=0, + procedure_template=0, + service_unit=None, + appointment_type=None, + save=1, + department=None, +): item = create_healthcare_service_items() - frappe.db.set_value('Healthcare Settings', None, 'inpatient_visit_charge_item', item) - frappe.db.set_value('Healthcare Settings', None, 'op_consulting_charge_item', item) - appointment = frappe.new_doc('Patient Appointment') + frappe.db.set_value("Healthcare Settings", None, "inpatient_visit_charge_item", item) + frappe.db.set_value("Healthcare Settings", None, "op_consulting_charge_item", item) + appointment = frappe.new_doc("Patient Appointment") appointment.patient = patient appointment.practitioner = practitioner - appointment.department = department or '_Test Medical Department' + appointment.department = department or "_Test Medical Department" appointment.appointment_date = appointment_date - appointment.company = '_Test Company' + appointment.company = "_Test Company" appointment.duration = 15 if service_unit: appointment.service_unit = service_unit if invoice: - appointment.mode_of_payment = 'Cash' + appointment.mode_of_payment = "Cash" if appointment_type: appointment.appointment_type = appointment_type if procedure_template: - appointment.procedure_template = create_clinical_procedure_template().get('name') + appointment.procedure_template = create_clinical_procedure_template().get("name") if save: appointment.save(ignore_permissions=True) @@ -390,30 +469,30 @@ def create_appointment(patient, practitioner, appointment_date, invoice=0, proce def create_healthcare_service_items(): - if frappe.db.exists('Item', 'HLC-SI-001'): - return 'HLC-SI-001' + if frappe.db.exists("Item", "HLC-SI-001"): + return "HLC-SI-001" - item = frappe.new_doc('Item') - item.item_code = 'HLC-SI-001' - item.item_name = 'Consulting Charges' - item.item_group = 'Services' + item = frappe.new_doc("Item") + item.item_code = "HLC-SI-001" + item.item_name = "Consulting Charges" + item.item_group = "Services" item.is_stock_item = 0 - item.stock_uom = 'Nos' + item.stock_uom = "Nos" item.save() return item.name def create_clinical_procedure_template(): - if frappe.db.exists('Clinical Procedure Template', 'Knee Surgery and Rehab'): - return frappe.get_doc('Clinical Procedure Template', 'Knee Surgery and Rehab') + if frappe.db.exists("Clinical Procedure Template", "Knee Surgery and Rehab"): + return frappe.get_doc("Clinical Procedure Template", "Knee Surgery and Rehab") - template = frappe.new_doc('Clinical Procedure Template') - template.template = 'Knee Surgery and Rehab' - template.item_code = 'Knee Surgery and Rehab' - template.item_group = 'Services' + template = frappe.new_doc("Clinical Procedure Template") + template.template = "Knee Surgery and Rehab" + template.item_code = "Knee Surgery and Rehab" + template.item_group = "Services" template.is_billable = 1 - template.description = 'Knee Surgery and Rehab' + template.description = "Knee Surgery and Rehab" template.rate = 50000 template.save() @@ -422,36 +501,40 @@ def create_clinical_procedure_template(): def create_appointment_type(args=None): if not args: - args = frappe.local.form_dict + args = frappe.local.form_dict - name = args.get('name') or 'Test Appointment Type wise Charge' + name = args.get("name") or "Test Appointment Type wise Charge" - if frappe.db.exists('Appointment Type', name): - return frappe.get_doc('Appointment Type', name) + if frappe.db.exists("Appointment Type", name): + return frappe.get_doc("Appointment Type", name) else: item = create_healthcare_service_items() - items = [{ - 'medical_department': args.get('medical_department') or '_Test Medical Department', - 'op_consulting_charge_item': item, - 'op_consulting_charge': 200 - }] - return frappe.get_doc({ - 'doctype': 'Appointment Type', - 'appointment_type': args.get('name') or 'Test Appointment Type wise Charge', - 'default_duration': args.get('default_duration') or 20, - 'color': args.get('color') or '#7575ff', - 'price_list': args.get('price_list') or frappe.db.get_value("Price List", {"selling": 1}), - 'items': args.get('items') or items - }).insert() + items = [ + { + "medical_department": args.get("medical_department") or "_Test Medical Department", + "op_consulting_charge_item": item, + "op_consulting_charge": 200, + } + ] + return frappe.get_doc( + { + "doctype": "Appointment Type", + "appointment_type": args.get("name") or "Test Appointment Type wise Charge", + "default_duration": args.get("default_duration") or 20, + "color": args.get("color") or "#7575ff", + "price_list": args.get("price_list") or frappe.db.get_value("Price List", {"selling": 1}), + "items": args.get("items") or items, + } + ).insert() def create_service_unit_type(id=0, allow_appointments=1, overlap_appointments=0): - if frappe.db.exists('Healthcare Service Unit Type', f'_Test Service Unit Type {str(id)}'): - return f'_Test Service Unit Type {str(id)}' + if frappe.db.exists("Healthcare Service Unit Type", f"_Test Service Unit Type {str(id)}"): + return f"_Test Service Unit Type {str(id)}" - service_unit_type = frappe.new_doc('Healthcare Service Unit Type') - service_unit_type.service_unit_type = f'_Test Service Unit Type {str(id)}' + service_unit_type = frappe.new_doc("Healthcare Service Unit Type") + service_unit_type.service_unit_type = f"_Test Service Unit Type {str(id)}" service_unit_type.allow_appointments = allow_appointments service_unit_type.overlap_appointments = overlap_appointments service_unit_type.save(ignore_permissions=True) @@ -460,28 +543,31 @@ def create_service_unit_type(id=0, allow_appointments=1, overlap_appointments=0) def create_service_unit(id=0, service_unit_type=None, service_unit_capacity=0): - if frappe.db.exists('Healthcare Service Unit', f'_Test Service Unit {str(id)}'): - return f'_Test service_unit {str(id)}' + if frappe.db.exists("Healthcare Service Unit", f"_Test Service Unit {str(id)}"): + return f"_Test service_unit {str(id)}" - service_unit = frappe.new_doc('Healthcare Service Unit') + service_unit = frappe.new_doc("Healthcare Service Unit") service_unit.is_group = 0 - service_unit.healthcare_service_unit_name= f'_Test Service Unit {str(id)}' + service_unit.healthcare_service_unit_name = f"_Test Service Unit {str(id)}" service_unit.service_unit_type = service_unit_type or create_service_unit_type(id) service_unit.service_unit_capacity = service_unit_capacity service_unit.save(ignore_permissions=True) return service_unit.name + def create_user(email=None, roles=None): if not email: - email = '{}@frappe.com'.format(frappe.utils.random_string(10)) - user = frappe.db.exists('User', email) + email = "{}@frappe.com".format(frappe.utils.random_string(10)) + user = frappe.db.exists("User", email) if not user: - user = frappe.get_doc({ - "doctype": "User", - "email": email, - "first_name": "test_user", - "password": "password", - "roles": roles, - }).insert() + user = frappe.get_doc( + { + "doctype": "User", + "email": email, + "first_name": "test_user", + "password": "password", + "roles": roles, + } + ).insert() return user diff --git a/erpnext/healthcare/doctype/patient_assessment/patient_assessment.py b/erpnext/healthcare/doctype/patient_assessment/patient_assessment.py index fd6aac5e374..1d821a1e42e 100644 --- a/erpnext/healthcare/doctype/patient_assessment/patient_assessment.py +++ b/erpnext/healthcare/doctype/patient_assessment/patient_assessment.py @@ -17,17 +17,23 @@ class PatientAssessment(Document): total_score += int(entry.score) self.total_score_obtained = total_score + @frappe.whitelist() def create_patient_assessment(source_name, target_doc=None): - doc = get_mapped_doc('Therapy Session', source_name, { - 'Therapy Session': { - 'doctype': 'Patient Assessment', - 'field_map': [ - ['therapy_session', 'name'], - ['patient', 'patient'], - ['practitioner', 'practitioner'] - ] + doc = get_mapped_doc( + "Therapy Session", + source_name, + { + "Therapy Session": { + "doctype": "Patient Assessment", + "field_map": [ + ["therapy_session", "name"], + ["patient", "patient"], + ["practitioner", "practitioner"], + ], } - }, target_doc) + }, + target_doc, + ) return doc diff --git a/erpnext/healthcare/doctype/patient_encounter/patient_encounter.py b/erpnext/healthcare/doctype/patient_encounter/patient_encounter.py index b2fe2d5a589..ff804ead540 100644 --- a/erpnext/healthcare/doctype/patient_encounter/patient_encounter.py +++ b/erpnext/healthcare/doctype/patient_encounter/patient_encounter.py @@ -15,7 +15,7 @@ class PatientEncounter(Document): def on_update(self): if self.appointment: - frappe.db.set_value('Patient Appointment', self.appointment, 'status', 'Closed') + frappe.db.set_value("Patient Appointment", self.appointment, "status", "Closed") def on_submit(self): if self.therapies: @@ -23,58 +23,59 @@ class PatientEncounter(Document): def on_cancel(self): if self.appointment: - frappe.db.set_value('Patient Appointment', self.appointment, 'status', 'Open') + frappe.db.set_value("Patient Appointment", self.appointment, "status", "Open") if self.inpatient_record and self.drug_prescription: delete_ip_medication_order(self) def set_title(self): - self.title = _('{0} with {1}').format(self.patient_name or self.patient, - self.practitioner_name or self.practitioner)[:100] + self.title = _("{0} with {1}").format( + self.patient_name or self.patient, self.practitioner_name or self.practitioner + )[:100] @frappe.whitelist() @staticmethod def get_applicable_treatment_plans(encounter): - patient = frappe.get_doc('Patient', encounter['patient']) + patient = frappe.get_doc("Patient", encounter["patient"]) plan_filters = {} - plan_filters['name'] = ['in', []] + plan_filters["name"] = ["in", []] age = patient.age if age: - plan_filters['patient_age_from'] = ['<=', age.years] - plan_filters['patient_age_to'] = ['>=', age.years] + plan_filters["patient_age_from"] = ["<=", age.years] + plan_filters["patient_age_to"] = [">=", age.years] gender = patient.sex if gender: - plan_filters['gender'] = ['in', [gender, None]] + plan_filters["gender"] = ["in", [gender, None]] - diagnosis = encounter.get('diagnosis') + diagnosis = encounter.get("diagnosis") if diagnosis: - diagnosis = [_diagnosis['diagnosis'] for _diagnosis in encounter['diagnosis']] + diagnosis = [_diagnosis["diagnosis"] for _diagnosis in encounter["diagnosis"]] filters = [ - ['diagnosis', 'in', diagnosis], - ['parenttype', '=', 'Treatment Plan Template'], + ["diagnosis", "in", diagnosis], + ["parenttype", "=", "Treatment Plan Template"], ] - diagnosis = frappe.get_list('Patient Encounter Diagnosis', filters=filters, fields='*') - plan_names = [_diagnosis['parent'] for _diagnosis in diagnosis] - plan_filters['name'][1].extend(plan_names) + diagnosis = frappe.get_list("Patient Encounter Diagnosis", filters=filters, fields="*") + plan_names = [_diagnosis["parent"] for _diagnosis in diagnosis] + plan_filters["name"][1].extend(plan_names) - symptoms = encounter.get('symptoms') + symptoms = encounter.get("symptoms") if symptoms: - symptoms = [symptom['complaint'] for symptom in encounter['symptoms']] + symptoms = [symptom["complaint"] for symptom in encounter["symptoms"]] filters = [ - ['complaint', 'in', symptoms], - ['parenttype', '=', 'Treatment Plan Template'], + ["complaint", "in", symptoms], + ["parenttype", "=", "Treatment Plan Template"], ] - symptoms = frappe.get_list('Patient Encounter Symptom', filters=filters, fields='*') - plan_names = [symptom['parent'] for symptom in symptoms] - plan_filters['name'][1].extend(plan_names) + symptoms = frappe.get_list("Patient Encounter Symptom", filters=filters, fields="*") + plan_names = [symptom["parent"] for symptom in symptoms] + plan_filters["name"][1].extend(plan_names) - if not plan_filters['name'][1]: - plan_filters.pop('name') + if not plan_filters["name"][1]: + plan_filters.pop("name") - plans = frappe.get_list('Treatment Plan Template', fields='*', filters=plan_filters) + plans = frappe.get_list("Treatment Plan Template", fields="*", filters=plan_filters) return plans @@ -84,31 +85,27 @@ class PatientEncounter(Document): self.set_treatment_plan(treatment_plan) def set_treatment_plan(self, plan): - plan_items = frappe.get_list('Treatment Plan Template Item', filters={'parent': plan}, fields='*') + plan_items = frappe.get_list( + "Treatment Plan Template Item", filters={"parent": plan}, fields="*" + ) for plan_item in plan_items: self.set_treatment_plan_item(plan_item) - drugs = frappe.get_list('Drug Prescription', filters={'parent': plan}, fields='*') + drugs = frappe.get_list("Drug Prescription", filters={"parent": plan}, fields="*") for drug in drugs: - self.append('drug_prescription', drug) + self.append("drug_prescription", drug) self.save() def set_treatment_plan_item(self, plan_item): - if plan_item.type == 'Clinical Procedure Template': - self.append('procedure_prescription', { - 'procedure': plan_item.template - }) + if plan_item.type == "Clinical Procedure Template": + self.append("procedure_prescription", {"procedure": plan_item.template}) - if plan_item.type == 'Lab Test Template': - self.append('lab_test_prescription', { - 'lab_test_code': plan_item.template - }) + if plan_item.type == "Lab Test Template": + self.append("lab_test_prescription", {"lab_test_code": plan_item.template}) - if plan_item.type == 'Therapy Type': - self.append('therapies', { - 'therapy_type': plan_item.template - }) + if plan_item.type == "Therapy Type": + self.append("therapies", {"therapy_type": plan_item.template}) @frappe.whitelist() @@ -117,11 +114,11 @@ def make_ip_medication_order(source_name, target_doc=None): target.start_date = source.encounter_date for entry in source.drug_prescription: if entry.drug_code: - dosage = frappe.get_doc('Prescription Dosage', entry.dosage) + dosage = frappe.get_doc("Prescription Dosage", entry.dosage) dates = get_prescription_dates(entry.period, target.start_date) for date in dates: for dose in dosage.dosage_strength: - order = target.append('medication_orders') + order = target.append("medication_orders") order.drug = entry.drug_code order.drug_name = entry.drug_name order.dosage = dose.strength @@ -131,26 +128,32 @@ def make_ip_medication_order(source_name, target_doc=None): order.time = dose.strength_time target.end_date = dates[-1] - doc = get_mapped_doc('Patient Encounter', source_name, { - 'Patient Encounter': { - 'doctype': 'Inpatient Medication Order', - 'field_map': { - 'name': 'patient_encounter', - 'patient': 'patient', - 'patient_name': 'patient_name', - 'patient_age': 'patient_age', - 'inpatient_record': 'inpatient_record', - 'practitioner': 'practitioner', - 'start_date': 'encounter_date' + doc = get_mapped_doc( + "Patient Encounter", + source_name, + { + "Patient Encounter": { + "doctype": "Inpatient Medication Order", + "field_map": { + "name": "patient_encounter", + "patient": "patient", + "patient_name": "patient_name", + "patient_age": "patient_age", + "inpatient_record": "inpatient_record", + "practitioner": "practitioner", + "start_date": "encounter_date", }, } - }, target_doc, set_missing_values) + }, + target_doc, + set_missing_values, + ) return doc def get_prescription_dates(period, start_date): - prescription_duration = frappe.get_doc('Prescription Duration', period) + prescription_duration = frappe.get_doc("Prescription Duration", period) days = prescription_duration.get_days() dates = [start_date] for i in range(1, days): @@ -160,21 +163,23 @@ def get_prescription_dates(period, start_date): def create_therapy_plan(encounter): if len(encounter.therapies): - doc = frappe.new_doc('Therapy Plan') + doc = frappe.new_doc("Therapy Plan") doc.patient = encounter.patient doc.start_date = encounter.encounter_date for entry in encounter.therapies: - doc.append('therapy_plan_details', { - 'therapy_type': entry.therapy_type, - 'no_of_sessions': entry.no_of_sessions - }) + doc.append( + "therapy_plan_details", + {"therapy_type": entry.therapy_type, "no_of_sessions": entry.no_of_sessions}, + ) doc.save(ignore_permissions=True) - if doc.get('name'): - encounter.db_set('therapy_plan', doc.name) - frappe.msgprint(_('Therapy Plan {0} created successfully.').format(frappe.bold(doc.name)), alert=True) + if doc.get("name"): + encounter.db_set("therapy_plan", doc.name) + frappe.msgprint( + _("Therapy Plan {0} created successfully.").format(frappe.bold(doc.name)), alert=True + ) def delete_ip_medication_order(encounter): - record = frappe.db.exists('Inpatient Medication Order', {'patient_encounter': encounter.name}) + record = frappe.db.exists("Inpatient Medication Order", {"patient_encounter": encounter.name}) if record: - frappe.delete_doc('Inpatient Medication Order', record, force=1) + frappe.delete_doc("Inpatient Medication Order", record, force=1) diff --git a/erpnext/healthcare/doctype/patient_encounter/patient_encounter_dashboard.py b/erpnext/healthcare/doctype/patient_encounter/patient_encounter_dashboard.py index 3db13be6b7d..f796e23f420 100644 --- a/erpnext/healthcare/doctype/patient_encounter/patient_encounter_dashboard.py +++ b/erpnext/healthcare/doctype/patient_encounter/patient_encounter_dashboard.py @@ -1,23 +1,16 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'encounter', - 'non_standard_fieldnames': { - 'Patient Medical Record': 'reference_name', - 'Inpatient Medication Order': 'patient_encounter' + "fieldname": "encounter", + "non_standard_fieldnames": { + "Patient Medical Record": "reference_name", + "Inpatient Medication Order": "patient_encounter", }, - 'transactions': [ - { - 'label': _('Records'), - 'items': ['Vital Signs', 'Patient Medical Record'] - }, - { - 'label': _('Orders'), - 'items': ['Inpatient Medication Order'] - } + "transactions": [ + {"label": _("Records"), "items": ["Vital Signs", "Patient Medical Record"]}, + {"label": _("Orders"), "items": ["Inpatient Medication Order"]}, ], - 'disable_create_buttons': ['Inpatient Medication Order'] + "disable_create_buttons": ["Inpatient Medication Order"], } diff --git a/erpnext/healthcare/doctype/patient_encounter/test_patient_encounter.py b/erpnext/healthcare/doctype/patient_encounter/test_patient_encounter.py index 8260918c0d2..88f34d82dc0 100644 --- a/erpnext/healthcare/doctype/patient_encounter/test_patient_encounter.py +++ b/erpnext/healthcare/doctype/patient_encounter/test_patient_encounter.py @@ -11,75 +11,81 @@ from erpnext.healthcare.doctype.patient_encounter.patient_encounter import Patie class TestPatientEncounter(unittest.TestCase): def setUp(self): try: - gender_m = frappe.get_doc({ - 'doctype': 'Gender', - 'gender': 'MALE' - }).insert() - gender_f = frappe.get_doc({ - 'doctype': 'Gender', - 'gender': 'FEMALE' - }).insert() + gender_m = frappe.get_doc({"doctype": "Gender", "gender": "MALE"}).insert() + gender_f = frappe.get_doc({"doctype": "Gender", "gender": "FEMALE"}).insert() except frappe.exceptions.DuplicateEntryError: - gender_m = frappe.get_doc({ - 'doctype': 'Gender', - 'gender': 'MALE' - }) - gender_f = frappe.get_doc({ - 'doctype': 'Gender', - 'gender': 'FEMALE' - }) + gender_m = frappe.get_doc({"doctype": "Gender", "gender": "MALE"}) + gender_f = frappe.get_doc({"doctype": "Gender", "gender": "FEMALE"}) - self.patient_male = frappe.get_doc({ - 'doctype': 'Patient', - 'first_name': 'John', - 'sex': gender_m.gender, - }).insert() - self.patient_female = frappe.get_doc({ - 'doctype': 'Patient', - 'first_name': 'Curie', - 'sex': gender_f.gender, - }).insert() - self.practitioner = frappe.get_doc({ - 'doctype': 'Healthcare Practitioner', - 'first_name': 'Doc', - 'sex': 'MALE', - }).insert() + self.patient_male = frappe.get_doc( + { + "doctype": "Patient", + "first_name": "John", + "sex": gender_m.gender, + } + ).insert() + self.patient_female = frappe.get_doc( + { + "doctype": "Patient", + "first_name": "Curie", + "sex": gender_f.gender, + } + ).insert() + self.practitioner = frappe.get_doc( + { + "doctype": "Healthcare Practitioner", + "first_name": "Doc", + "sex": "MALE", + } + ).insert() try: - self.care_plan_male = frappe.get_doc({ - 'doctype': 'Treatment Plan Template', - 'template_name': 'test plan - m', - 'gender': gender_m.gender, - }).insert() - self.care_plan_female = frappe.get_doc({ - 'doctype': 'Treatment Plan Template', - 'template_name': 'test plan - f', - 'gender': gender_f.gender, - }).insert() + self.care_plan_male = frappe.get_doc( + { + "doctype": "Treatment Plan Template", + "template_name": "test plan - m", + "gender": gender_m.gender, + } + ).insert() + self.care_plan_female = frappe.get_doc( + { + "doctype": "Treatment Plan Template", + "template_name": "test plan - f", + "gender": gender_f.gender, + } + ).insert() except frappe.exceptions.DuplicateEntryError: - self.care_plan_male = frappe.get_doc({ - 'doctype': 'Treatment Plan Template', - 'template_name': 'test plan - m', - 'gender': gender_m.gender, - }) - self.care_plan_female = frappe.get_doc({ - 'doctype': 'Treatment Plan Template', - 'template_name': 'test plan - f', - 'gender': gender_f.gender, - }) + self.care_plan_male = frappe.get_doc( + { + "doctype": "Treatment Plan Template", + "template_name": "test plan - m", + "gender": gender_m.gender, + } + ) + self.care_plan_female = frappe.get_doc( + { + "doctype": "Treatment Plan Template", + "template_name": "test plan - f", + "gender": gender_f.gender, + } + ) def test_treatment_plan_template_filter(self): - encounter = frappe.get_doc({ - 'doctype': 'Patient Encounter', - 'patient': self.patient_male.name, - 'practitioner': self.practitioner.name, - }).insert() + encounter = frappe.get_doc( + { + "doctype": "Patient Encounter", + "patient": self.patient_male.name, + "practitioner": self.practitioner.name, + } + ).insert() plans = PatientEncounter.get_applicable_treatment_plans(encounter.as_dict()) - self.assertEqual(plans[0]['name'], self.care_plan_male.template_name) + self.assertEqual(plans[0]["name"], self.care_plan_male.template_name) - encounter = frappe.get_doc({ - 'doctype': 'Patient Encounter', - 'patient': self.patient_female.name, - 'practitioner': self.practitioner.name, - }).insert() + encounter = frappe.get_doc( + { + "doctype": "Patient Encounter", + "patient": self.patient_female.name, + "practitioner": self.practitioner.name, + } + ).insert() plans = PatientEncounter.get_applicable_treatment_plans(encounter.as_dict()) - self.assertEqual(plans[0]['name'], self.care_plan_female.template_name) + self.assertEqual(plans[0]["name"], self.care_plan_female.template_name) diff --git a/erpnext/healthcare/doctype/patient_history_settings/patient_history_settings.py b/erpnext/healthcare/doctype/patient_history_settings/patient_history_settings.py index 4c5d39f0335..4161f1dcaea 100644 --- a/erpnext/healthcare/doctype/patient_history_settings/patient_history_settings.py +++ b/erpnext/healthcare/doctype/patient_history_settings/patient_history_settings.py @@ -19,22 +19,29 @@ class PatientHistorySettings(Document): def validate_submittable_doctypes(self): for entry in self.custom_doctypes: - if not cint(frappe.db.get_value('DocType', entry.document_type, 'is_submittable')): - msg = _('Row #{0}: Document Type {1} is not submittable.').format( - entry.idx, frappe.bold(entry.document_type)) - msg += _('Patient Medical Record can only be created for submittable document types.') + if not cint(frappe.db.get_value("DocType", entry.document_type, "is_submittable")): + msg = _("Row #{0}: Document Type {1} is not submittable.").format( + entry.idx, frappe.bold(entry.document_type) + ) + msg += _("Patient Medical Record can only be created for submittable document types.") frappe.throw(msg) def validate_date_fieldnames(self): for entry in self.custom_doctypes: field = frappe.get_meta(entry.document_type).get_field(entry.date_fieldname) if not field: - frappe.throw(_('Row #{0}: No such Field named {1} found in the Document Type {2}.').format( - entry.idx, frappe.bold(entry.date_fieldname), frappe.bold(entry.document_type))) + frappe.throw( + _("Row #{0}: No such Field named {1} found in the Document Type {2}.").format( + entry.idx, frappe.bold(entry.date_fieldname), frappe.bold(entry.document_type) + ) + ) - if field.fieldtype not in ['Date', 'Datetime']: - frappe.throw(_('Row #{0}: Field {1} in Document Type {2} is not a Date / Datetime field.').format( - entry.idx, frappe.bold(entry.date_fieldname), frappe.bold(entry.document_type))) + if field.fieldtype not in ["Date", "Datetime"]: + frappe.throw( + _("Row #{0}: Field {1} in Document Type {2} is not a Date / Datetime field.").format( + entry.idx, frappe.bold(entry.date_fieldname), frappe.bold(entry.document_type) + ) + ) @frappe.whitelist() def get_doctype_fields(self, document_type, fields): @@ -42,40 +49,44 @@ class PatientHistorySettings(Document): doc_fields = frappe.get_meta(document_type).fields for field in doc_fields: - if field.fieldtype not in frappe.model.no_value_fields or \ - field.fieldtype in frappe.model.table_fields and not field.hidden: - multicheck_fields.append({ - 'label': field.label, - 'value': field.fieldname, - 'checked': 1 if field.fieldname in fields else 0 - }) + if ( + field.fieldtype not in frappe.model.no_value_fields + or field.fieldtype in frappe.model.table_fields + and not field.hidden + ): + multicheck_fields.append( + { + "label": field.label, + "value": field.fieldname, + "checked": 1 if field.fieldname in fields else 0, + } + ) return multicheck_fields @frappe.whitelist() def get_date_field_for_dt(self, document_type): meta = frappe.get_meta(document_type) - date_fields = meta.get('fields', { - 'fieldtype': ['in', ['Date', 'Datetime']] - }) + date_fields = meta.get("fields", {"fieldtype": ["in", ["Date", "Datetime"]]}) if date_fields: - return date_fields[0].get('fieldname') + return date_fields[0].get("fieldname") + def create_medical_record(doc, method=None): medical_record_required = validate_medical_record_required(doc) if not medical_record_required: return - if frappe.db.exists('Patient Medical Record', { 'reference_name': doc.name }): + if frappe.db.exists("Patient Medical Record", {"reference_name": doc.name}): return subject = set_subject_field(doc) date_field = get_date_field(doc.doctype) - medical_record = frappe.new_doc('Patient Medical Record') + medical_record = frappe.new_doc("Patient Medical Record") medical_record.patient = doc.patient medical_record.subject = subject - medical_record.status = 'Open' + medical_record.status = "Open" medical_record.communication_date = doc.get(date_field) medical_record.reference_doctype = doc.doctype medical_record.reference_name = doc.name @@ -88,11 +99,11 @@ def update_medical_record(doc, method=None): if not medical_record_required: return - medical_record_id = frappe.db.exists('Patient Medical Record', { 'reference_name': doc.name }) + medical_record_id = frappe.db.exists("Patient Medical Record", {"reference_name": doc.name}) if medical_record_id: subject = set_subject_field(doc) - frappe.db.set_value('Patient Medical Record', medical_record_id[0][0], 'subject', subject) + frappe.db.set_value("Patient Medical Record", medical_record_id[0][0], "subject", subject) else: create_medical_record(doc) @@ -102,28 +113,30 @@ def delete_medical_record(doc, method=None): if not medical_record_required: return - record = frappe.db.exists('Patient Medical Record', { 'reference_name': doc.name }) + record = frappe.db.exists("Patient Medical Record", {"reference_name": doc.name}) if record: - frappe.delete_doc('Patient Medical Record', record, force=1) + frappe.delete_doc("Patient Medical Record", record, force=1) def set_subject_field(doc): from frappe.utils.formatters import format_value meta = frappe.get_meta(doc.doctype) - subject = '' + subject = "" patient_history_fields = get_patient_history_fields(doc) for entry in patient_history_fields: - fieldname = entry.get('fieldname') - if entry.get('fieldtype') == 'Table' and doc.get(fieldname): - formatted_value = get_formatted_value_for_table_field(doc.get(fieldname), meta.get_field(fieldname)) - subject += frappe.bold(_(entry.get('label')) + ':') + '
' + cstr(formatted_value) + '
' + fieldname = entry.get("fieldname") + if entry.get("fieldtype") == "Table" and doc.get(fieldname): + formatted_value = get_formatted_value_for_table_field( + doc.get(fieldname), meta.get_field(fieldname) + ) + subject += frappe.bold(_(entry.get("label")) + ":") + "
" + cstr(formatted_value) + "
" else: if doc.get(fieldname): formatted_value = format_value(doc.get(fieldname), meta.get_field(fieldname), doc) - subject += frappe.bold(_(entry.get('label')) + ':') + cstr(formatted_value) + '
' + subject += frappe.bold(_(entry.get("label")) + ":") + cstr(formatted_value) + "
" return subject @@ -131,12 +144,14 @@ def set_subject_field(doc): def get_date_field(doctype): dt = get_patient_history_config_dt(doctype) - return frappe.db.get_value(dt, { 'document_type': doctype }, 'date_fieldname') + return frappe.db.get_value(dt, {"document_type": doctype}, "date_fieldname") def get_patient_history_fields(doc): dt = get_patient_history_config_dt(doc.doctype) - patient_history_fields = frappe.db.get_value(dt, { 'document_type': doc.doctype }, 'selected_fields') + patient_history_fields = frappe.db.get_value( + dt, {"document_type": doc.doctype}, "selected_fields" + ) if patient_history_fields: return json.loads(patient_history_fields) @@ -145,38 +160,44 @@ def get_patient_history_fields(doc): def get_formatted_value_for_table_field(items, df): child_meta = frappe.get_meta(df.options) - table_head = '' - table_row = '' - html = '' + table_head = "" + table_row = "" + html = "" create_head = True for item in items: - table_row += ''
+ table_row += " "
for cdf in child_meta.fields:
if cdf.in_list_view:
if create_head:
- table_head += '' + cdf.label + ' '
+ table_head += "" + cdf.label + " "
if item.get(cdf.fieldname):
- table_row += '' + str(item.get(cdf.fieldname)) + ' '
+ table_row += "" + str(item.get(cdf.fieldname)) + " "
else:
- table_row += ' '
+ table_row += ""
- html += "" + table_head + table_row + "
"
+ html += (
+ "" + table_head + table_row + "
"
+ )
return html
def get_patient_history_config_dt(doctype):
- if frappe.db.get_value('DocType', doctype, 'custom'):
- return 'Patient History Custom Document Type'
+ if frappe.db.get_value("DocType", doctype, "custom"):
+ return "Patient History Custom Document Type"
else:
- return 'Patient History Standard Document Type'
+ return "Patient History Standard Document Type"
def validate_medical_record_required(doc):
- if frappe.flags.in_patch or frappe.flags.in_install or frappe.flags.in_setup_wizard \
- or get_module(doc) != 'Healthcare':
+ if (
+ frappe.flags.in_patch
+ or frappe.flags.in_install
+ or frappe.flags.in_setup_wizard
+ or get_module(doc) != "Healthcare"
+ ):
return False
if doc.doctype not in get_patient_history_doctypes():
@@ -184,9 +205,10 @@ def validate_medical_record_required(doc):
return True
+
def get_module(doc):
module = doc.meta.module
if not module:
- module = frappe.db.get_value('DocType', doc.doctype, 'module')
+ module = frappe.db.get_value("DocType", doc.doctype, "module")
return module
diff --git a/erpnext/healthcare/doctype/patient_history_settings/test_patient_history_settings.py b/erpnext/healthcare/doctype/patient_history_settings/test_patient_history_settings.py
index 484955a7008..8248f5fc7ea 100644
--- a/erpnext/healthcare/doctype/patient_history_settings/test_patient_history_settings.py
+++ b/erpnext/healthcare/doctype/patient_history_settings/test_patient_history_settings.py
@@ -14,25 +14,20 @@ class TestPatientHistorySettings(unittest.TestCase):
def setUp(self):
dt = create_custom_doctype()
settings = frappe.get_single("Patient History Settings")
- settings.append("custom_doctypes", {
- "document_type": dt.name,
- "date_fieldname": "date",
- "selected_fields": json.dumps([{
- "label": "Date",
- "fieldname": "date",
- "fieldtype": "Date"
- },
+ settings.append(
+ "custom_doctypes",
{
- "label": "Rating",
- "fieldname": "rating",
- "fieldtype": "Rating"
+ "document_type": dt.name,
+ "date_fieldname": "date",
+ "selected_fields": json.dumps(
+ [
+ {"label": "Date", "fieldname": "date", "fieldtype": "Date"},
+ {"label": "Rating", "fieldname": "rating", "fieldtype": "Rating"},
+ {"label": "Feedback", "fieldname": "feedback", "fieldtype": "Small Text"},
+ ]
+ ),
},
- {
- "label": "Feedback",
- "fieldname": "feedback",
- "fieldtype": "Small Text"
- }])
- })
+ )
settings.save()
def test_custom_doctype_medical_record(self):
@@ -40,12 +35,15 @@ class TestPatientHistorySettings(unittest.TestCase):
patient = create_patient()
doc = create_doc(patient)
# check for medical record
- medical_rec = frappe.db.exists("Patient Medical Record", {"status": "Open", "reference_name": doc.name})
+ medical_rec = frappe.db.exists(
+ "Patient Medical Record", {"status": "Open", "reference_name": doc.name}
+ )
self.assertTrue(medical_rec)
medical_rec = frappe.get_doc("Patient Medical Record", medical_rec)
expected_subject = "Date:{0}Rating:3Feedback:Test Patient History Settings".format(
- frappe.utils.format_date(getdate()))
+ frappe.utils.format_date(getdate())
+ )
self.assertEqual(strip_html(medical_rec.subject), expected_subject)
self.assertEqual(medical_rec.patient, patient)
self.assertEqual(medical_rec.communication_date, getdate())
@@ -53,38 +51,22 @@ class TestPatientHistorySettings(unittest.TestCase):
def create_custom_doctype():
if not frappe.db.exists("DocType", "Test Patient Feedback"):
- doc = frappe.get_doc({
+ doc = frappe.get_doc(
+ {
"doctype": "DocType",
"module": "Healthcare",
"custom": 1,
"is_submittable": 1,
- "fields": [{
- "label": "Date",
- "fieldname": "date",
- "fieldtype": "Date"
- },
- {
- "label": "Patient",
- "fieldname": "patient",
- "fieldtype": "Link",
- "options": "Patient"
- },
- {
- "label": "Rating",
- "fieldname": "rating",
- "fieldtype": "Rating"
- },
- {
- "label": "Feedback",
- "fieldname": "feedback",
- "fieldtype": "Small Text"
- }],
- "permissions": [{
- "role": "System Manager",
- "read": 1
- }],
+ "fields": [
+ {"label": "Date", "fieldname": "date", "fieldtype": "Date"},
+ {"label": "Patient", "fieldname": "patient", "fieldtype": "Link", "options": "Patient"},
+ {"label": "Rating", "fieldname": "rating", "fieldtype": "Rating"},
+ {"label": "Feedback", "fieldname": "feedback", "fieldtype": "Small Text"},
+ ],
+ "permissions": [{"role": "System Manager", "read": 1}],
"name": "Test Patient Feedback",
- })
+ }
+ )
doc.insert()
return doc
else:
@@ -92,13 +74,15 @@ def create_custom_doctype():
def create_doc(patient):
- doc = frappe.get_doc({
- "doctype": "Test Patient Feedback",
- "patient": patient,
- "date": getdate(),
- "rating": 3,
- "feedback": "Test Patient History Settings"
- }).insert()
+ doc = frappe.get_doc(
+ {
+ "doctype": "Test Patient Feedback",
+ "patient": patient,
+ "date": getdate(),
+ "rating": 3,
+ "feedback": "Test Patient History Settings",
+ }
+ ).insert()
doc.submit()
return doc
diff --git a/erpnext/healthcare/doctype/patient_medical_record/patient_medical_record.py b/erpnext/healthcare/doctype/patient_medical_record/patient_medical_record.py
index c243d16e575..45e4c02115e 100644
--- a/erpnext/healthcare/doctype/patient_medical_record/patient_medical_record.py
+++ b/erpnext/healthcare/doctype/patient_medical_record/patient_medical_record.py
@@ -8,5 +8,5 @@ from frappe.model.document import Document
class PatientMedicalRecord(Document):
def after_insert(self):
- if self.reference_doctype == "Patient Medical Record" :
+ if self.reference_doctype == "Patient Medical Record":
frappe.db.set_value("Patient Medical Record", self.name, "reference_name", self.name)
diff --git a/erpnext/healthcare/doctype/patient_medical_record/test_patient_medical_record.py b/erpnext/healthcare/doctype/patient_medical_record/test_patient_medical_record.py
index 230011a890b..299a873e976 100644
--- a/erpnext/healthcare/doctype/patient_medical_record/test_patient_medical_record.py
+++ b/erpnext/healthcare/doctype/patient_medical_record/test_patient_medical_record.py
@@ -17,9 +17,9 @@ from erpnext.healthcare.doctype.patient_appointment.test_patient_appointment imp
class TestPatientMedicalRecord(unittest.TestCase):
def setUp(self):
- frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0)
- frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1)
- frappe.db.sql('delete from `tabPatient Appointment`')
+ frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0)
+ frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1)
+ frappe.db.sql("delete from `tabPatient Appointment`")
make_pos_profile()
def test_medical_record(self):
@@ -29,32 +29,42 @@ class TestPatientMedicalRecord(unittest.TestCase):
encounter = create_encounter(appointment)
# check for encounter
- medical_rec = frappe.db.exists('Patient Medical Record', {'status': 'Open', 'reference_name': encounter.name})
+ medical_rec = frappe.db.exists(
+ "Patient Medical Record", {"status": "Open", "reference_name": encounter.name}
+ )
self.assertTrue(medical_rec)
vital_signs = create_vital_signs(appointment)
# check for vital signs
- medical_rec = frappe.db.exists('Patient Medical Record', {'status': 'Open', 'reference_name': vital_signs.name})
+ medical_rec = frappe.db.exists(
+ "Patient Medical Record", {"status": "Open", "reference_name": vital_signs.name}
+ )
self.assertTrue(medical_rec)
- appointment = create_appointment(patient, practitioner, add_days(nowdate(), 1), invoice=1, procedure_template=1)
+ appointment = create_appointment(
+ patient, practitioner, add_days(nowdate(), 1), invoice=1, procedure_template=1
+ )
procedure = create_procedure(appointment)
procedure.start_procedure()
procedure.complete_procedure()
# check for clinical procedure
- medical_rec = frappe.db.exists('Patient Medical Record', {'status': 'Open', 'reference_name': procedure.name})
+ medical_rec = frappe.db.exists(
+ "Patient Medical Record", {"status": "Open", "reference_name": procedure.name}
+ )
self.assertTrue(medical_rec)
template = create_lab_test_template(medical_department)
lab_test = create_lab_test(template.name, patient)
# check for lab test
- medical_rec = frappe.db.exists('Patient Medical Record', {'status': 'Open', 'reference_name': lab_test.name})
+ medical_rec = frappe.db.exists(
+ "Patient Medical Record", {"status": "Open", "reference_name": lab_test.name}
+ )
self.assertTrue(medical_rec)
def create_procedure(appointment):
if appointment:
- procedure = frappe.new_doc('Clinical Procedure')
+ procedure = frappe.new_doc("Clinical Procedure")
procedure.procedure_template = appointment.procedure_template
procedure.appointment = appointment.name
procedure.patient = appointment.patient
@@ -66,8 +76,9 @@ def create_procedure(appointment):
procedure.submit()
return procedure
+
def create_vital_signs(appointment):
- vital_signs = frappe.new_doc('Vital Signs')
+ vital_signs = frappe.new_doc("Vital Signs")
vital_signs.patient = appointment.patient
vital_signs.signs_date = appointment.appointment_date
vital_signs.signs_time = appointment.appointment_time
@@ -76,24 +87,26 @@ def create_vital_signs(appointment):
vital_signs.submit()
return vital_signs
-def create_lab_test_template(medical_department):
- if frappe.db.exists('Lab Test Template', 'Blood Test'):
- return frappe.get_doc('Lab Test Template', 'Blood Test')
- template = frappe.new_doc('Lab Test Template')
- template.lab_test_name = 'Blood Test'
- template.lab_test_code = 'Blood Test'
- template.lab_test_group = 'Services'
+def create_lab_test_template(medical_department):
+ if frappe.db.exists("Lab Test Template", "Blood Test"):
+ return frappe.get_doc("Lab Test Template", "Blood Test")
+
+ template = frappe.new_doc("Lab Test Template")
+ template.lab_test_name = "Blood Test"
+ template.lab_test_code = "Blood Test"
+ template.lab_test_group = "Services"
template.department = medical_department
template.is_billable = 1
template.lab_test_rate = 2000
template.save()
return template
+
def create_lab_test(template, patient):
- lab_test = frappe.new_doc('Lab Test')
+ lab_test = frappe.new_doc("Lab Test")
lab_test.patient = patient
- lab_test.patient_sex = frappe.db.get_value('Patient', patient, 'sex')
+ lab_test.patient_sex = frappe.db.get_value("Patient", patient, "sex")
lab_test.template = template
lab_test.save()
lab_test.submit()
diff --git a/erpnext/healthcare/doctype/prescription_duration/prescription_duration.py b/erpnext/healthcare/doctype/prescription_duration/prescription_duration.py
index 4ca3b48cf07..ae464c23a79 100644
--- a/erpnext/healthcare/doctype/prescription_duration/prescription_duration.py
+++ b/erpnext/healthcare/doctype/prescription_duration/prescription_duration.py
@@ -8,65 +8,69 @@ from frappe.utils import cstr
class PrescriptionDuration(Document):
def autoname(self):
- self.name = " ".join(filter(None,
- [cstr(self.get(f)).strip() for f in ["number", "period"]]))
+ self.name = " ".join(filter(None, [cstr(self.get(f)).strip() for f in ["number", "period"]]))
+
def get_days(self):
days = 0
duration = self
- if(duration.period == 'Day'):
+ if duration.period == "Day":
days = duration.number
- if(duration.period == 'Hour'):
- days = (duration.number)/24
- if(duration.period == 'Week'):
- days = (duration.number*7)
- if(duration.period == 'Month'):
- days = (duration.number*30)
+ if duration.period == "Hour":
+ days = (duration.number) / 24
+ if duration.period == "Week":
+ days = duration.number * 7
+ if duration.period == "Month":
+ days = duration.number * 30
return days
+
def get_weeks(self):
weeks = 0
duration = self
- if(duration.period == 'Day'):
- weeks = (duration.number)/7
- #if(duration.period == 'Hour'):
- # weeks = (duration.number)/x
- if(duration.period == 'Week'):
+ if duration.period == "Day":
+ weeks = (duration.number) / 7
+ # if(duration.period == 'Hour'):
+ # weeks = (duration.number)/x
+ if duration.period == "Week":
weeks = duration.number
- if(duration.period == 'Month'):
- weeks = duration.number*4
+ if duration.period == "Month":
+ weeks = duration.number * 4
return weeks
+
def get_months(self):
months = 0
duration = self
- if(duration.period == 'Day'):
- months = (duration.number)/30
- #if(duration.period == 'Hour'):
- # months = (duration.number)/x
- if(duration.period == 'Week'):
- months = (duration.number)/4
- if(duration.period == 'Month'):
+ if duration.period == "Day":
+ months = (duration.number) / 30
+ # if(duration.period == 'Hour'):
+ # months = (duration.number)/x
+ if duration.period == "Week":
+ months = (duration.number) / 4
+ if duration.period == "Month":
months = duration.number
return months
+
def get_hours(self):
hours = 0
duration = self
- if(duration.period == 'Day'):
- hours = (duration.number*24)
- if(duration.period == 'Hour'):
+ if duration.period == "Day":
+ hours = duration.number * 24
+ if duration.period == "Hour":
hours = duration.number
- if(duration.period == 'Week'):
- hours = (duration.number*24)*7
- if(duration.period == 'Month'):
- hours = (duration.number*24)*30
+ if duration.period == "Week":
+ hours = (duration.number * 24) * 7
+ if duration.period == "Month":
+ hours = (duration.number * 24) * 30
return hours
+
def get_minutes(self):
minutes = 0
duration = self
- if(duration.period == 'Day'):
- minutes = (duration.number*1440)
- if(duration.period == 'Hour'):
- minutes = (duration.number*60)
- if(duration.period == 'Week'):
- minutes = (duration.number*10080)
- if(duration.period == 'Month'):
- minutes = (duration.number*43800)
+ if duration.period == "Day":
+ minutes = duration.number * 1440
+ if duration.period == "Hour":
+ minutes = duration.number * 60
+ if duration.period == "Week":
+ minutes = duration.number * 10080
+ if duration.period == "Month":
+ minutes = duration.number * 43800
return minutes
diff --git a/erpnext/healthcare/doctype/sample_collection/sample_collection.json b/erpnext/healthcare/doctype/sample_collection/sample_collection.json
index 83383e34457..f8525f7e14b 100644
--- a/erpnext/healthcare/doctype/sample_collection/sample_collection.json
+++ b/erpnext/healthcare/doctype/sample_collection/sample_collection.json
@@ -66,7 +66,6 @@
"search_index": 1
},
{
- "fetch_from": "inpatient_record.patient",
"fieldname": "patient",
"fieldtype": "Link",
"hide_days": 1,
@@ -224,7 +223,7 @@
],
"is_submittable": 1,
"links": [],
- "modified": "2020-07-30 16:53:13.076104",
+ "modified": "2022-01-20 12:38:55.382621",
"modified_by": "Administrator",
"module": "Healthcare",
"name": "Sample Collection",
diff --git a/erpnext/healthcare/doctype/sample_collection/sample_collection.py b/erpnext/healthcare/doctype/sample_collection/sample_collection.py
index ba4ff81fdfe..b6ebc702653 100644
--- a/erpnext/healthcare/doctype/sample_collection/sample_collection.py
+++ b/erpnext/healthcare/doctype/sample_collection/sample_collection.py
@@ -11,4 +11,4 @@ from frappe.utils import flt
class SampleCollection(Document):
def validate(self):
if flt(self.sample_qty) <= 0:
- frappe.throw(_('Sample Quantity cannot be negative or 0'), title=_('Invalid Quantity'))
+ frappe.throw(_("Sample Quantity cannot be negative or 0"), title=_("Invalid Quantity"))
diff --git a/erpnext/healthcare/doctype/sample_collection/test_sample_collection.py b/erpnext/healthcare/doctype/sample_collection/test_sample_collection.py
index 09bd0a5b677..61a0d009bb0 100644
--- a/erpnext/healthcare/doctype/sample_collection/test_sample_collection.py
+++ b/erpnext/healthcare/doctype/sample_collection/test_sample_collection.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Sample Collection')
+
class TestSampleCollection(unittest.TestCase):
pass
diff --git a/erpnext/healthcare/doctype/sensitivity/test_sensitivity.py b/erpnext/healthcare/doctype/sensitivity/test_sensitivity.py
index abf8e33f76b..726e304b7b0 100644
--- a/erpnext/healthcare/doctype/sensitivity/test_sensitivity.py
+++ b/erpnext/healthcare/doctype/sensitivity/test_sensitivity.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Sensitivity')
+
class TestSensitivity(unittest.TestCase):
pass
diff --git a/erpnext/healthcare/doctype/therapy_plan/test_therapy_plan.py b/erpnext/healthcare/doctype/therapy_plan/test_therapy_plan.py
index 27fad0c7c56..098441bb0e2 100644
--- a/erpnext/healthcare/doctype/therapy_plan/test_therapy_plan.py
+++ b/erpnext/healthcare/doctype/therapy_plan/test_therapy_plan.py
@@ -24,52 +24,58 @@ class TestTherapyPlan(unittest.TestCase):
patient, practitioner = create_healthcare_docs()
medical_department = create_medical_department()
encounter = create_encounter(patient, medical_department, practitioner)
- self.assertTrue(frappe.db.exists('Therapy Plan', encounter.therapy_plan))
+ self.assertTrue(frappe.db.exists("Therapy Plan", encounter.therapy_plan))
def test_status(self):
plan = create_therapy_plan()
- self.assertEqual(plan.status, 'Not Started')
+ self.assertEqual(plan.status, "Not Started")
- session = make_therapy_session(plan.name, plan.patient, 'Basic Rehab', '_Test Company')
+ session = make_therapy_session(plan.name, plan.patient, "Basic Rehab", "_Test Company")
session.start_date = getdate()
frappe.get_doc(session).submit()
- self.assertEqual(frappe.db.get_value('Therapy Plan', plan.name, 'status'), 'In Progress')
+ self.assertEqual(frappe.db.get_value("Therapy Plan", plan.name, "status"), "In Progress")
- session = make_therapy_session(plan.name, plan.patient, 'Basic Rehab', '_Test Company')
+ session = make_therapy_session(plan.name, plan.patient, "Basic Rehab", "_Test Company")
session.start_date = add_days(getdate(), 1)
frappe.get_doc(session).submit()
- self.assertEqual(frappe.db.get_value('Therapy Plan', plan.name, 'status'), 'Completed')
+ self.assertEqual(frappe.db.get_value("Therapy Plan", plan.name, "status"), "Completed")
patient, practitioner = create_healthcare_docs()
appointment = create_appointment(patient, practitioner, nowdate())
- session = make_therapy_session(plan.name, plan.patient, 'Basic Rehab', '_Test Company', appointment.name)
+ session = make_therapy_session(
+ plan.name, plan.patient, "Basic Rehab", "_Test Company", appointment.name
+ )
session.start_date = add_days(getdate(), 2)
session = frappe.get_doc(session)
session.submit()
- self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'status'), 'Closed')
+ self.assertEqual(
+ frappe.db.get_value("Patient Appointment", appointment.name, "status"), "Closed"
+ )
session.cancel()
- self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'status'), 'Open')
+ self.assertEqual(frappe.db.get_value("Patient Appointment", appointment.name, "status"), "Open")
def test_therapy_plan_from_template(self):
patient = create_patient()
template = create_therapy_plan_template()
# check linked item
- self.assertTrue(frappe.db.exists('Therapy Plan Template', {'linked_item': 'Complete Rehab'}))
+ self.assertTrue(frappe.db.exists("Therapy Plan Template", {"linked_item": "Complete Rehab"}))
plan = create_therapy_plan(template)
# invoice
- si = make_sales_invoice(plan.name, patient, '_Test Company', template)
+ si = make_sales_invoice(plan.name, patient, "_Test Company", template)
si.save()
- therapy_plan_template_amt = frappe.db.get_value('Therapy Plan Template', template, 'total_amount')
+ therapy_plan_template_amt = frappe.db.get_value(
+ "Therapy Plan Template", template, "total_amount"
+ )
self.assertEqual(si.items[0].amount, therapy_plan_template_amt)
def create_therapy_plan(template=None):
patient = create_patient()
therapy_type = create_therapy_type()
- plan = frappe.new_doc('Therapy Plan')
+ plan = frappe.new_doc("Therapy Plan")
plan.patient = patient
plan.start_date = getdate()
@@ -77,42 +83,36 @@ def create_therapy_plan(template=None):
plan.therapy_plan_template = template
plan = plan.set_therapy_details_from_template()
else:
- plan.append('therapy_plan_details', {
- 'therapy_type': therapy_type.name,
- 'no_of_sessions': 2
- })
+ plan.append("therapy_plan_details", {"therapy_type": therapy_type.name, "no_of_sessions": 2})
plan.save()
return plan
+
def create_encounter(patient, medical_department, practitioner):
- encounter = frappe.new_doc('Patient Encounter')
+ encounter = frappe.new_doc("Patient Encounter")
encounter.patient = patient
encounter.practitioner = practitioner
encounter.medical_department = medical_department
therapy_type = create_therapy_type()
- encounter.append('therapies', {
- 'therapy_type': therapy_type.name,
- 'no_of_sessions': 2
- })
+ encounter.append("therapies", {"therapy_type": therapy_type.name, "no_of_sessions": 2})
encounter.save()
encounter.submit()
return encounter
+
def create_therapy_plan_template():
- template_name = frappe.db.exists('Therapy Plan Template', 'Complete Rehab')
+ template_name = frappe.db.exists("Therapy Plan Template", "Complete Rehab")
if not template_name:
therapy_type = create_therapy_type()
- template = frappe.new_doc('Therapy Plan Template')
- template.plan_name = template.item_code = template.item_name = 'Complete Rehab'
- template.item_group = 'Services'
- rate = frappe.db.get_value('Therapy Type', therapy_type.name, 'rate')
- template.append('therapy_types', {
- 'therapy_type': therapy_type.name,
- 'no_of_sessions': 2,
- 'rate': rate,
- 'amount': 2 * flt(rate)
- })
+ template = frappe.new_doc("Therapy Plan Template")
+ template.plan_name = template.item_code = template.item_name = "Complete Rehab"
+ template.item_group = "Services"
+ rate = frappe.db.get_value("Therapy Type", therapy_type.name, "rate")
+ template.append(
+ "therapy_types",
+ {"therapy_type": therapy_type.name, "no_of_sessions": 2, "rate": rate, "amount": 2 * flt(rate)},
+ )
template.save()
template_name = template.name
diff --git a/erpnext/healthcare/doctype/therapy_plan/therapy_plan.py b/erpnext/healthcare/doctype/therapy_plan/therapy_plan.py
index a7bc9e90d51..6cb2a24e6af 100644
--- a/erpnext/healthcare/doctype/therapy_plan/therapy_plan.py
+++ b/erpnext/healthcare/doctype/therapy_plan/therapy_plan.py
@@ -6,6 +6,8 @@ import frappe
from frappe.model.document import Document
from frappe.utils import flt
+from erpnext import get_company_currency
+
class TherapyPlan(Document):
def validate(self):
@@ -14,12 +16,12 @@ class TherapyPlan(Document):
def set_status(self):
if not self.total_sessions_completed:
- self.status = 'Not Started'
+ self.status = "Not Started"
else:
if self.total_sessions_completed < self.total_sessions:
- self.status = 'In Progress'
+ self.status = "In Progress"
elif self.total_sessions_completed == self.total_sessions:
- self.status = 'Completed'
+ self.status = "Completed"
def set_totals(self):
total_sessions = 0
@@ -30,28 +32,28 @@ class TherapyPlan(Document):
if entry.sessions_completed:
total_sessions_completed += entry.sessions_completed
- self.db_set('total_sessions', total_sessions)
- self.db_set('total_sessions_completed', total_sessions_completed)
+ self.db_set("total_sessions", total_sessions)
+ self.db_set("total_sessions_completed", total_sessions_completed)
@frappe.whitelist()
def set_therapy_details_from_template(self):
# Add therapy types in the child table
- self.set('therapy_plan_details', [])
- therapy_plan_template = frappe.get_doc('Therapy Plan Template', self.therapy_plan_template)
+ self.set("therapy_plan_details", [])
+ therapy_plan_template = frappe.get_doc("Therapy Plan Template", self.therapy_plan_template)
for data in therapy_plan_template.therapy_types:
- self.append('therapy_plan_details', {
- 'therapy_type': data.therapy_type,
- 'no_of_sessions': data.no_of_sessions
- })
+ self.append(
+ "therapy_plan_details",
+ {"therapy_type": data.therapy_type, "no_of_sessions": data.no_of_sessions},
+ )
return self
@frappe.whitelist()
def make_therapy_session(therapy_plan, patient, therapy_type, company, appointment=None):
- therapy_type = frappe.get_doc('Therapy Type', therapy_type)
+ therapy_type = frappe.get_doc("Therapy Type", therapy_type)
- therapy_session = frappe.new_doc('Therapy Session')
+ therapy_session = frappe.new_doc("Therapy Session")
therapy_session.therapy_plan = therapy_plan
therapy_session.company = company
therapy_session.patient = patient
@@ -67,33 +69,39 @@ def make_therapy_session(therapy_plan, patient, therapy_type, company, appointme
@frappe.whitelist()
def make_sales_invoice(reference_name, patient, company, therapy_plan_template):
from erpnext.stock.get_item_details import get_item_details
- si = frappe.new_doc('Sales Invoice')
+
+ si = frappe.new_doc("Sales Invoice")
si.company = company
si.patient = patient
- si.customer = frappe.db.get_value('Patient', patient, 'customer')
+ si.customer = frappe.db.get_value("Patient", patient, "customer")
+ si.currency = frappe.get_value(
+ "Customer", si.customer, "default_currency"
+ ) or get_company_currency(si.company)
- item = frappe.db.get_value('Therapy Plan Template', therapy_plan_template, 'linked_item')
- price_list, price_list_currency = frappe.db.get_values('Price List', {'selling': 1}, ['name', 'currency'])[0]
+ item = frappe.db.get_value("Therapy Plan Template", therapy_plan_template, "linked_item")
+ price_list, price_list_currency = frappe.db.get_values(
+ "Price List", {"selling": 1}, ["name", "currency"]
+ )[0]
args = {
- 'doctype': 'Sales Invoice',
- 'item_code': item,
- 'company': company,
- 'customer': si.customer,
- 'selling_price_list': price_list,
- 'price_list_currency': price_list_currency,
- 'plc_conversion_rate': 1.0,
- 'conversion_rate': 1.0
+ "doctype": "Sales Invoice",
+ "item_code": item,
+ "company": company,
+ "customer": si.customer,
+ "selling_price_list": price_list,
+ "price_list_currency": price_list_currency,
+ "plc_conversion_rate": 1.0,
+ "conversion_rate": 1.0,
}
- item_line = si.append('items', {})
+ item_line = si.append("items", {})
item_details = get_item_details(args)
item_line.item_code = item
item_line.qty = 1
item_line.rate = item_details.price_list_rate
item_line.amount = flt(item_line.rate) * flt(item_line.qty)
- item_line.reference_dt = 'Therapy Plan'
+ item_line.reference_dt = "Therapy Plan"
item_line.reference_dn = reference_name
item_line.description = item_details.description
- si.set_missing_values(for_validate = True)
+ si.set_missing_values(for_validate=True)
return si
diff --git a/erpnext/healthcare/doctype/therapy_plan/therapy_plan_dashboard.py b/erpnext/healthcare/doctype/therapy_plan/therapy_plan_dashboard.py
index b52a23b625a..65eb787a147 100644
--- a/erpnext/healthcare/doctype/therapy_plan/therapy_plan_dashboard.py
+++ b/erpnext/healthcare/doctype/therapy_plan/therapy_plan_dashboard.py
@@ -1,22 +1,13 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'therapy_plan',
- 'non_standard_fieldnames': {
- 'Sales Invoice': 'reference_dn'
- },
- 'transactions': [
- {
- 'label': _('Therapy Sessions'),
- 'items': ['Therapy Session']
- },
- {
- 'label': _('Billing'),
- 'items': ['Sales Invoice']
- }
+ "fieldname": "therapy_plan",
+ "non_standard_fieldnames": {"Sales Invoice": "reference_dn"},
+ "transactions": [
+ {"label": _("Therapy Sessions"), "items": ["Therapy Session"]},
+ {"label": _("Billing"), "items": ["Sales Invoice"]},
],
- 'disable_create_buttons': ['Sales Invoice']
+ "disable_create_buttons": ["Sales Invoice"],
}
diff --git a/erpnext/healthcare/doctype/therapy_plan_template/therapy_plan_template.py b/erpnext/healthcare/doctype/therapy_plan_template/therapy_plan_template.py
index 96ce86252b8..d1c64685565 100644
--- a/erpnext/healthcare/doctype/therapy_plan_template/therapy_plan_template.py
+++ b/erpnext/healthcare/doctype/therapy_plan_template/therapy_plan_template.py
@@ -18,9 +18,13 @@ class TherapyPlanTemplate(Document):
def on_update(self):
doc_before_save = self.get_doc_before_save()
- if not doc_before_save: return
- if doc_before_save.item_name != self.item_name or doc_before_save.item_group != self.item_group \
- or doc_before_save.description != self.description:
+ if not doc_before_save:
+ return
+ if (
+ doc_before_save.item_name != self.item_name
+ or doc_before_save.item_group != self.item_group
+ or doc_before_save.description != self.description
+ ):
self.update_item()
if doc_before_save.therapy_types != self.therapy_types:
@@ -38,28 +42,30 @@ class TherapyPlanTemplate(Document):
self.total_amount = total_amount
def create_item_from_template(self):
- uom = frappe.db.exists('UOM', 'Nos') or frappe.db.get_single_value('Stock Settings', 'stock_uom')
+ uom = frappe.db.exists("UOM", "Nos") or frappe.db.get_single_value("Stock Settings", "stock_uom")
- item = frappe.get_doc({
- 'doctype': 'Item',
- 'item_code': self.item_code,
- 'item_name': self.item_name,
- 'item_group': self.item_group,
- 'description': self.description,
- 'is_sales_item': 1,
- 'is_service_item': 1,
- 'is_purchase_item': 0,
- 'is_stock_item': 0,
- 'show_in_website': 0,
- 'is_pro_applicable': 0,
- 'stock_uom': uom
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ item = frappe.get_doc(
+ {
+ "doctype": "Item",
+ "item_code": self.item_code,
+ "item_name": self.item_name,
+ "item_group": self.item_group,
+ "description": self.description,
+ "is_sales_item": 1,
+ "is_service_item": 1,
+ "is_purchase_item": 0,
+ "is_stock_item": 0,
+ "show_in_website": 0,
+ "is_pro_applicable": 0,
+ "stock_uom": uom,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
make_item_price(item.name, self.total_amount)
- self.db_set('linked_item', item.name)
+ self.db_set("linked_item", item.name)
def update_item(self):
- item_doc = frappe.get_doc('Item', {'item_code': self.linked_item})
+ item_doc = frappe.get_doc("Item", {"item_code": self.linked_item})
item_doc.item_name = self.item_name
item_doc.item_group = self.item_group
item_doc.description = self.description
@@ -67,7 +73,7 @@ class TherapyPlanTemplate(Document):
item_doc.save(ignore_permissions=True)
def update_item_price(self):
- item_price = frappe.get_doc('Item Price', {'item_code': self.linked_item})
+ item_price = frappe.get_doc("Item Price", {"item_code": self.linked_item})
item_price.item_name = self.item_name
item_price.price_list_rate = self.total_amount
item_price.ignore_mandatory = True
diff --git a/erpnext/healthcare/doctype/therapy_plan_template/therapy_plan_template_dashboard.py b/erpnext/healthcare/doctype/therapy_plan_template/therapy_plan_template_dashboard.py
index b186598d3cc..7c23ae845d3 100644
--- a/erpnext/healthcare/doctype/therapy_plan_template/therapy_plan_template_dashboard.py
+++ b/erpnext/healthcare/doctype/therapy_plan_template/therapy_plan_template_dashboard.py
@@ -1,14 +1,8 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'therapy_plan_template',
- 'transactions': [
- {
- 'label': _('Therapy Plans'),
- 'items': ['Therapy Plan']
- }
- ]
+ "fieldname": "therapy_plan_template",
+ "transactions": [{"label": _("Therapy Plans"), "items": ["Therapy Plan"]}],
}
diff --git a/erpnext/healthcare/doctype/therapy_session/therapy_session.py b/erpnext/healthcare/doctype/therapy_session/therapy_session.py
index 71eb4ced837..6cbcdcb2d82 100644
--- a/erpnext/healthcare/doctype/therapy_session/therapy_session.py
+++ b/erpnext/healthcare/doctype/therapy_session/therapy_session.py
@@ -22,10 +22,12 @@ class TherapySession(Document):
self.set_total_counts()
def validate_duplicate(self):
- end_time = datetime.datetime.combine(getdate(self.start_date), get_time(self.start_time)) \
- + datetime.timedelta(minutes=flt(self.duration))
+ end_time = datetime.datetime.combine(
+ getdate(self.start_date), get_time(self.start_time)
+ ) + datetime.timedelta(minutes=flt(self.duration))
- overlaps = frappe.db.sql("""
+ overlaps = frappe.db.sql(
+ """
select
name
from
@@ -36,28 +38,41 @@ class TherapySession(Document):
((start_time<%s and start_time + INTERVAL duration MINUTE>%s) or
(start_time>%s and start_time<%s) or
(start_time=%s))
- """, (self.start_date, self.name, self.practitioner, self.patient,
- self.start_time, end_time.time(), self.start_time, end_time.time(), self.start_time))
+ """,
+ (
+ self.start_date,
+ self.name,
+ self.practitioner,
+ self.patient,
+ self.start_time,
+ end_time.time(),
+ self.start_time,
+ end_time.time(),
+ self.start_time,
+ ),
+ )
if overlaps:
- overlapping_details = _('Therapy Session overlaps with {0}').format(get_link_to_form('Therapy Session', overlaps[0][0]))
- frappe.throw(overlapping_details, title=_('Therapy Sessions Overlapping'))
+ overlapping_details = _("Therapy Session overlaps with {0}").format(
+ get_link_to_form("Therapy Session", overlaps[0][0])
+ )
+ frappe.throw(overlapping_details, title=_("Therapy Sessions Overlapping"))
def on_submit(self):
self.update_sessions_count_in_therapy_plan()
def on_update(self):
if self.appointment:
- frappe.db.set_value('Patient Appointment', self.appointment, 'status', 'Closed')
+ frappe.db.set_value("Patient Appointment", self.appointment, "status", "Closed")
def on_cancel(self):
if self.appointment:
- frappe.db.set_value('Patient Appointment', self.appointment, 'status', 'Open')
+ frappe.db.set_value("Patient Appointment", self.appointment, "status", "Open")
self.update_sessions_count_in_therapy_plan(on_cancel=True)
def update_sessions_count_in_therapy_plan(self, on_cancel=False):
- therapy_plan = frappe.get_doc('Therapy Plan', self.therapy_plan)
+ therapy_plan = frappe.get_doc("Therapy Plan", self.therapy_plan)
for entry in therapy_plan.therapy_plan_details:
if entry.therapy_type == self.therapy_type:
if on_cancel:
@@ -75,36 +90,42 @@ class TherapySession(Document):
if entry.counts_completed:
counts_completed += entry.counts_completed
- self.db_set('total_counts_targeted', target_total)
- self.db_set('total_counts_completed', counts_completed)
+ self.db_set("total_counts_targeted", target_total)
+ self.db_set("total_counts_completed", counts_completed)
@frappe.whitelist()
def create_therapy_session(source_name, target_doc=None):
def set_missing_values(source, target):
- therapy_type = frappe.get_doc('Therapy Type', source.therapy_type)
+ therapy_type = frappe.get_doc("Therapy Type", source.therapy_type)
target.exercises = therapy_type.exercises
- doc = get_mapped_doc('Patient Appointment', source_name, {
- 'Patient Appointment': {
- 'doctype': 'Therapy Session',
- 'field_map': [
- ['appointment', 'name'],
- ['patient', 'patient'],
- ['patient_age', 'patient_age'],
- ['gender', 'patient_sex'],
- ['therapy_type', 'therapy_type'],
- ['therapy_plan', 'therapy_plan'],
- ['practitioner', 'practitioner'],
- ['department', 'department'],
- ['start_date', 'appointment_date'],
- ['start_time', 'appointment_time'],
- ['service_unit', 'service_unit'],
- ['company', 'company'],
- ['invoiced', 'invoiced']
- ]
+ doc = get_mapped_doc(
+ "Patient Appointment",
+ source_name,
+ {
+ "Patient Appointment": {
+ "doctype": "Therapy Session",
+ "field_map": [
+ ["appointment", "name"],
+ ["patient", "patient"],
+ ["patient_age", "patient_age"],
+ ["gender", "patient_sex"],
+ ["therapy_type", "therapy_type"],
+ ["therapy_plan", "therapy_plan"],
+ ["practitioner", "practitioner"],
+ ["department", "department"],
+ ["start_date", "appointment_date"],
+ ["start_time", "appointment_time"],
+ ["service_unit", "service_unit"],
+ ["company", "company"],
+ ["invoiced", "invoiced"],
+ ],
}
- }, target_doc, set_missing_values)
+ },
+ target_doc,
+ set_missing_values,
+ )
return doc
@@ -112,36 +133,42 @@ def create_therapy_session(source_name, target_doc=None):
@frappe.whitelist()
def invoice_therapy_session(source_name, target_doc=None):
def set_missing_values(source, target):
- target.customer = frappe.db.get_value('Patient', source.patient, 'customer')
+ target.customer = frappe.db.get_value("Patient", source.patient, "customer")
target.due_date = getdate()
target.debit_to = get_receivable_account(source.company)
- item = target.append('items', {})
+ item = target.append("items", {})
item = get_therapy_item(source, item)
target.set_missing_values(for_validate=True)
- doc = get_mapped_doc('Therapy Session', source_name, {
- 'Therapy Session': {
- 'doctype': 'Sales Invoice',
- 'field_map': [
- ['patient', 'patient'],
- ['referring_practitioner', 'practitioner'],
- ['company', 'company'],
- ['due_date', 'start_date']
- ]
+ doc = get_mapped_doc(
+ "Therapy Session",
+ source_name,
+ {
+ "Therapy Session": {
+ "doctype": "Sales Invoice",
+ "field_map": [
+ ["patient", "patient"],
+ ["referring_practitioner", "practitioner"],
+ ["company", "company"],
+ ["due_date", "start_date"],
+ ],
}
- }, target_doc, set_missing_values)
+ },
+ target_doc,
+ set_missing_values,
+ )
return doc
def get_therapy_item(therapy, item):
- item.item_code = frappe.db.get_value('Therapy Type', therapy.therapy_type, 'item')
- item.description = _('Therapy Session Charges: {0}').format(therapy.practitioner)
+ item.item_code = frappe.db.get_value("Therapy Type", therapy.therapy_type, "item")
+ item.description = _("Therapy Session Charges: {0}").format(therapy.practitioner)
item.income_account = get_income_account(therapy.practitioner, therapy.company)
- item.cost_center = frappe.get_cached_value('Company', therapy.company, 'cost_center')
+ item.cost_center = frappe.get_cached_value("Company", therapy.company, "cost_center")
item.rate = therapy.rate
item.amount = therapy.rate
item.qty = 1
- item.reference_dt = 'Therapy Session'
+ item.reference_dt = "Therapy Session"
item.reference_dn = therapy.name
return item
diff --git a/erpnext/healthcare/doctype/therapy_session/therapy_session_dashboard.py b/erpnext/healthcare/doctype/therapy_session/therapy_session_dashboard.py
index 4a37ec44a47..9ceb0d7207e 100644
--- a/erpnext/healthcare/doctype/therapy_session/therapy_session_dashboard.py
+++ b/erpnext/healthcare/doctype/therapy_session/therapy_session_dashboard.py
@@ -1,14 +1,8 @@
-
from frappe import _
def get_data():
return {
- 'fieldname': 'therapy_session',
- 'transactions': [
- {
- 'label': _('Assessments'),
- 'items': ['Patient Assessment']
- }
- ]
+ "fieldname": "therapy_session",
+ "transactions": [{"label": _("Assessments"), "items": ["Patient Assessment"]}],
}
diff --git a/erpnext/healthcare/doctype/therapy_type/test_therapy_type.py b/erpnext/healthcare/doctype/therapy_type/test_therapy_type.py
index 468b424c933..e350be6493a 100644
--- a/erpnext/healthcare/doctype/therapy_type/test_therapy_type.py
+++ b/erpnext/healthcare/doctype/therapy_type/test_therapy_type.py
@@ -9,46 +9,44 @@ import frappe
class TestTherapyType(unittest.TestCase):
def test_therapy_type_item(self):
therapy_type = create_therapy_type()
- self.assertTrue(frappe.db.exists('Item', therapy_type.item))
+ self.assertTrue(frappe.db.exists("Item", therapy_type.item))
therapy_type.disabled = 1
therapy_type.save()
- self.assertEqual(frappe.db.get_value('Item', therapy_type.item, 'disabled'), 1)
+ self.assertEqual(frappe.db.get_value("Item", therapy_type.item, "disabled"), 1)
+
def create_therapy_type():
exercise = create_exercise_type()
- therapy_type = frappe.db.exists('Therapy Type', 'Basic Rehab')
+ therapy_type = frappe.db.exists("Therapy Type", "Basic Rehab")
if not therapy_type:
- therapy_type = frappe.new_doc('Therapy Type')
- therapy_type.therapy_type = 'Basic Rehab'
+ therapy_type = frappe.new_doc("Therapy Type")
+ therapy_type.therapy_type = "Basic Rehab"
therapy_type.default_duration = 30
therapy_type.is_billable = 1
therapy_type.rate = 5000
- therapy_type.item_code = 'Basic Rehab'
- therapy_type.item_name = 'Basic Rehab'
- therapy_type.item_group = 'Services'
- therapy_type.append('exercises', {
- 'exercise_type': exercise.name,
- 'counts_target': 10,
- 'assistance_level': 'Passive'
- })
+ therapy_type.item_code = "Basic Rehab"
+ therapy_type.item_name = "Basic Rehab"
+ therapy_type.item_group = "Services"
+ therapy_type.append(
+ "exercises",
+ {"exercise_type": exercise.name, "counts_target": 10, "assistance_level": "Passive"},
+ )
therapy_type.save()
else:
- therapy_type = frappe.get_doc('Therapy Type', therapy_type)
+ therapy_type = frappe.get_doc("Therapy Type", therapy_type)
return therapy_type
+
def create_exercise_type():
- exercise_type = frappe.db.exists('Exercise Type', 'Sit to Stand')
+ exercise_type = frappe.db.exists("Exercise Type", "Sit to Stand")
if not exercise_type:
- exercise_type = frappe.new_doc('Exercise Type')
- exercise_type.exercise_name = 'Sit to Stand'
- exercise_type.append('steps_table', {
- 'title': 'Step 1',
- 'description': 'Squat and Rise'
- })
+ exercise_type = frappe.new_doc("Exercise Type")
+ exercise_type.exercise_name = "Sit to Stand"
+ exercise_type.append("steps_table", {"title": "Step 1", "description": "Squat and Rise"})
exercise_type.save()
else:
- exercise_type = frappe.get_doc('Exercise Type', exercise_type)
+ exercise_type = frappe.get_doc("Exercise Type", exercise_type)
return exercise_type
diff --git a/erpnext/healthcare/doctype/therapy_type/therapy_type.py b/erpnext/healthcare/doctype/therapy_type/therapy_type.py
index 3f65352d5cd..64e51960072 100644
--- a/erpnext/healthcare/doctype/therapy_type/therapy_type.py
+++ b/erpnext/healthcare/doctype/therapy_type/therapy_type.py
@@ -25,13 +25,13 @@ class TherapyType(Document):
def enable_disable_item(self):
if self.is_billable:
if self.disabled:
- frappe.db.set_value('Item', self.item, 'disabled', 1)
+ frappe.db.set_value("Item", self.item, "disabled", 1)
else:
- frappe.db.set_value('Item', self.item, 'disabled', 0)
+ frappe.db.set_value("Item", self.item, "disabled", 0)
def update_item_and_item_price(self):
if self.is_billable and self.item:
- item_doc = frappe.get_doc('Item', {'item_code': self.item})
+ item_doc = frappe.get_doc("Item", {"item_code": self.item})
item_doc.item_name = self.item_name
item_doc.item_group = self.item_group
item_doc.description = self.description
@@ -40,23 +40,28 @@ class TherapyType(Document):
item_doc.save(ignore_permissions=True)
if self.rate:
- item_price = frappe.get_doc('Item Price', {'item_code': self.item})
+ item_price = frappe.get_doc("Item Price", {"item_code": self.item})
item_price.item_name = self.item_name
item_price.price_list_rate = self.rate
item_price.ignore_mandatory = True
item_price.save()
elif not self.is_billable and self.item:
- frappe.db.set_value('Item', self.item, 'disabled', 1)
+ frappe.db.set_value("Item", self.item, "disabled", 1)
- self.db_set('change_in_item', 0)
+ self.db_set("change_in_item", 0)
@frappe.whitelist()
def add_exercises(self):
exercises = self.get_exercises_for_body_parts()
- last_idx = max([cint(d.idx) for d in self.get('exercises')] or [0,])
+ last_idx = max(
+ [cint(d.idx) for d in self.get("exercises")]
+ or [
+ 0,
+ ]
+ )
for i, d in enumerate(exercises):
- ch = self.append('exercises', {})
+ ch = self.append("exercises", {})
ch.exercise_type = d.parent
ch.idx = last_idx + i + 1
@@ -71,7 +76,10 @@ class TherapyType(Document):
`tabExercise Type` e, `tabBody Part Link` b
WHERE
b.body_part IN %(body_parts)s AND b.parent=e.name
- """, {'body_parts': body_parts}, as_dict=1)
+ """,
+ {"body_parts": body_parts},
+ as_dict=1,
+ )
return exercises
@@ -81,44 +89,49 @@ def create_item_from_therapy(doc):
if doc.is_billable and not doc.disabled:
disabled = 0
- uom = frappe.db.exists('UOM', 'Unit') or frappe.db.get_single_value('Stock Settings', 'stock_uom')
+ uom = frappe.db.exists("UOM", "Unit") or frappe.db.get_single_value("Stock Settings", "stock_uom")
- item = frappe.get_doc({
- 'doctype': 'Item',
- 'item_code': doc.item_code,
- 'item_name': doc.item_name,
- 'item_group': doc.item_group,
- 'description': doc.description,
- 'is_sales_item': 1,
- 'is_service_item': 1,
- 'is_purchase_item': 0,
- 'is_stock_item': 0,
- 'show_in_website': 0,
- 'is_pro_applicable': 0,
- 'disabled': disabled,
- 'stock_uom': uom
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ item = frappe.get_doc(
+ {
+ "doctype": "Item",
+ "item_code": doc.item_code,
+ "item_name": doc.item_name,
+ "item_group": doc.item_group,
+ "description": doc.description,
+ "is_sales_item": 1,
+ "is_service_item": 1,
+ "is_purchase_item": 0,
+ "is_stock_item": 0,
+ "show_in_website": 0,
+ "is_pro_applicable": 0,
+ "disabled": disabled,
+ "stock_uom": uom,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
make_item_price(item.name, doc.rate)
- doc.db_set('item', item.name)
+ doc.db_set("item", item.name)
def make_item_price(item, item_price):
- price_list_name = frappe.db.get_value('Price List', {'selling': 1})
- frappe.get_doc({
- 'doctype': 'Item Price',
- 'price_list': price_list_name,
- 'item_code': item,
- 'price_list_rate': item_price
- }).insert(ignore_permissions=True, ignore_mandatory=True)
+ price_list_name = frappe.db.get_value("Price List", {"selling": 1})
+ frappe.get_doc(
+ {
+ "doctype": "Item Price",
+ "price_list": price_list_name,
+ "item_code": item,
+ "price_list_rate": item_price,
+ }
+ ).insert(ignore_permissions=True, ignore_mandatory=True)
+
@frappe.whitelist()
def change_item_code_from_therapy(item_code, doc):
doc = frappe._dict(json.loads(doc))
- if frappe.db.exists('Item', {'item_code': item_code}):
- frappe.throw(_('Item with Item Code {0} already exists').format(item_code))
+ if frappe.db.exists("Item", {"item_code": item_code}):
+ frappe.throw(_("Item with Item Code {0} already exists").format(item_code))
else:
- rename_doc('Item', doc.item, item_code, ignore_permissions=True)
- frappe.db.set_value('Therapy Type', doc.name, 'item_code', item_code)
+ rename_doc("Item", doc.item, item_code, ignore_permissions=True)
+ frappe.db.set_value("Therapy Type", doc.name, "item_code", item_code)
return
diff --git a/erpnext/healthcare/doctype/treatment_plan_template/treatment_plan_template.py b/erpnext/healthcare/doctype/treatment_plan_template/treatment_plan_template.py
index dbe0e9ae5f4..3283178a597 100644
--- a/erpnext/healthcare/doctype/treatment_plan_template/treatment_plan_template.py
+++ b/erpnext/healthcare/doctype/treatment_plan_template/treatment_plan_template.py
@@ -12,9 +12,8 @@ class TreatmentPlanTemplate(Document):
def validate_age(self):
if self.patient_age_from and self.patient_age_from < 0:
- frappe.throw(_('Patient Age From cannot be less than 0'))
+ frappe.throw(_("Patient Age From cannot be less than 0"))
if self.patient_age_to and self.patient_age_to < 0:
- frappe.throw(_('Patient Age To cannot be less than 0'))
- if self.patient_age_to and self.patient_age_from and \
- self.patient_age_to < self.patient_age_from:
- frappe.throw(_('Patient Age To cannot be less than Patient Age From'))
+ frappe.throw(_("Patient Age To cannot be less than 0"))
+ if self.patient_age_to and self.patient_age_from and self.patient_age_to < self.patient_age_from:
+ frappe.throw(_("Patient Age To cannot be less than Patient Age From"))
diff --git a/erpnext/healthcare/doctype/vital_signs/test_vital_signs.py b/erpnext/healthcare/doctype/vital_signs/test_vital_signs.py
index f2f58c2b58f..bd79fb6e5a7 100644
--- a/erpnext/healthcare/doctype/vital_signs/test_vital_signs.py
+++ b/erpnext/healthcare/doctype/vital_signs/test_vital_signs.py
@@ -5,5 +5,6 @@ import unittest
# test_records = frappe.get_test_records('Vital Signs')
+
class TestVitalSigns(unittest.TestCase):
pass
diff --git a/erpnext/healthcare/doctype/vital_signs/vital_signs.json b/erpnext/healthcare/doctype/vital_signs/vital_signs.json
index 15ab5047bc4..6d6c351ec35 100644
--- a/erpnext/healthcare/doctype/vital_signs/vital_signs.json
+++ b/erpnext/healthcare/doctype/vital_signs/vital_signs.json
@@ -51,7 +51,6 @@
"read_only": 1
},
{
- "fetch_from": "inpatient_record.patient",
"fieldname": "patient",
"fieldtype": "Link",
"ignore_user_permissions": 1,
@@ -73,7 +72,6 @@
"fieldtype": "Link",
"in_filter": 1,
"label": "Patient Appointment",
- "no_copy": 1,
"options": "Patient Appointment",
"print_hide": 1,
"read_only": 1
@@ -83,7 +81,6 @@
"fieldtype": "Link",
"in_filter": 1,
"label": "Patient Encounter",
- "no_copy": 1,
"options": "Patient Encounter",
"print_hide": 1,
"read_only": 1
@@ -259,7 +256,7 @@
],
"is_submittable": 1,
"links": [],
- "modified": "2020-05-17 22:23:24.632286",
+ "modified": "2022-02-19 11:48:16.347334",
"modified_by": "Administrator",
"module": "Healthcare",
"name": "Vital Signs",
diff --git a/erpnext/healthcare/doctype/vital_signs/vital_signs.py b/erpnext/healthcare/doctype/vital_signs/vital_signs.py
index ba54427f7b4..d3a3cb57334 100644
--- a/erpnext/healthcare/doctype/vital_signs/vital_signs.py
+++ b/erpnext/healthcare/doctype/vital_signs/vital_signs.py
@@ -12,5 +12,6 @@ class VitalSigns(Document):
self.set_title()
def set_title(self):
- self.title = _('{0} on {1}').format(self.patient_name or self.patient,
- frappe.utils.format_date(self.signs_date))[:100]
+ self.title = _("{0} on {1}").format(
+ self.patient_name or self.patient, frappe.utils.format_date(self.signs_date)
+ )[:100]
diff --git a/erpnext/healthcare/page/patient_history/patient_history.py b/erpnext/healthcare/page/patient_history/patient_history.py
index f5cf736495e..8829daed4e7 100644
--- a/erpnext/healthcare/page/patient_history/patient_history.py
+++ b/erpnext/healthcare/page/patient_history/patient_history.py
@@ -13,30 +13,30 @@ def get_feed(name, document_types=None, date_range=None, start=0, page_length=20
"""get feed"""
filters = get_filters(name, document_types, date_range)
- result = frappe.db.get_all('Patient Medical Record',
- fields=['name', 'owner', 'communication_date',
- 'reference_doctype', 'reference_name', 'subject'],
+ result = frappe.db.get_all(
+ "Patient Medical Record",
+ fields=["name", "owner", "communication_date", "reference_doctype", "reference_name", "subject"],
filters=filters,
- order_by='communication_date DESC',
+ order_by="communication_date DESC",
limit=cint(page_length),
- start=cint(start)
+ start=cint(start),
)
return result
def get_filters(name, document_types=None, date_range=None):
- filters = {'patient': name}
+ filters = {"patient": name}
if document_types:
document_types = json.loads(document_types)
if len(document_types):
- filters['reference_doctype'] = ['IN', document_types]
+ filters["reference_doctype"] = ["IN", document_types]
if date_range:
try:
date_range = json.loads(date_range)
if date_range:
- filters['communication_date'] = ['between', [date_range[0], date_range[1]]]
+ filters["communication_date"] = ["between", [date_range[0], date_range[1]]]
except json.decoder.JSONDecodeError:
pass
@@ -46,14 +46,11 @@ def get_filters(name, document_types=None, date_range=None):
@frappe.whitelist()
def get_feed_for_dt(doctype, docname):
"""get feed"""
- result = frappe.db.get_all('Patient Medical Record',
- fields=['name', 'owner', 'communication_date',
- 'reference_doctype', 'reference_name', 'subject'],
- filters={
- 'reference_doctype': doctype,
- 'reference_name': docname
- },
- order_by='communication_date DESC'
+ result = frappe.db.get_all(
+ "Patient Medical Record",
+ fields=["name", "owner", "communication_date", "reference_doctype", "reference_name", "subject"],
+ filters={"reference_doctype": doctype, "reference_name": docname},
+ order_by="communication_date DESC",
)
return result
diff --git a/erpnext/healthcare/page/patient_progress/patient_progress.py b/erpnext/healthcare/page/patient_progress/patient_progress.py
index c17f10574a9..8d27c86a060 100644
--- a/erpnext/healthcare/page/patient_progress/patient_progress.py
+++ b/erpnext/healthcare/page/patient_progress/patient_progress.py
@@ -8,27 +8,21 @@ from frappe.utils import get_timespan_date_range, getdate
@frappe.whitelist()
def get_therapy_sessions_count(patient):
- total = frappe.db.count('Therapy Session', filters={
- 'docstatus': 1,
- 'patient': patient
- })
+ total = frappe.db.count("Therapy Session", filters={"docstatus": 1, "patient": patient})
month_start = datetime.today().replace(day=1)
- this_month = frappe.db.count('Therapy Session', filters={
- 'creation': ['>', month_start],
- 'docstatus': 1,
- 'patient': patient
- })
+ this_month = frappe.db.count(
+ "Therapy Session", filters={"creation": [">", month_start], "docstatus": 1, "patient": patient}
+ )
- return {
- 'total_therapy_sessions': total,
- 'therapy_sessions_this_month': this_month
- }
+ return {"total_therapy_sessions": total, "therapy_sessions_this_month": this_month}
@frappe.whitelist()
def get_patient_heatmap_data(patient, date):
- return dict(frappe.db.sql("""
+ return dict(
+ frappe.db.sql(
+ """
SELECT
unix_timestamp(communication_date), count(*)
FROM
@@ -38,50 +32,56 @@ def get_patient_heatmap_data(patient, date):
communication_date < subdate(%(date)s, interval -1 year) and
patient = %(patient)s
GROUP BY communication_date
- ORDER BY communication_date asc""", {'date': date, 'patient': patient}))
+ ORDER BY communication_date asc""",
+ {"date": date, "patient": patient},
+ )
+ )
@frappe.whitelist()
def get_therapy_sessions_distribution_data(patient, field):
- if field == 'therapy_type':
- result = frappe.db.get_all('Therapy Session',
- filters = {'patient': patient, 'docstatus': 1},
- group_by = field,
- order_by = field,
- fields = [field, 'count(*)'],
- as_list = True)
+ if field == "therapy_type":
+ result = frappe.db.get_all(
+ "Therapy Session",
+ filters={"patient": patient, "docstatus": 1},
+ group_by=field,
+ order_by=field,
+ fields=[field, "count(*)"],
+ as_list=True,
+ )
- elif field == 'exercise_type':
- data = frappe.db.get_all('Therapy Session', filters={
- 'docstatus': 1,
- 'patient': patient
- }, as_list=True)
+ elif field == "exercise_type":
+ data = frappe.db.get_all(
+ "Therapy Session", filters={"docstatus": 1, "patient": patient}, as_list=True
+ )
therapy_sessions = [entry[0] for entry in data]
- result = frappe.db.get_all('Exercise',
- filters = {
- 'parenttype': 'Therapy Session',
- 'parent': ['in', therapy_sessions],
- 'docstatus': 1
- },
- group_by = field,
- order_by = field,
- fields = [field, 'count(*)'],
- as_list = True)
+ result = frappe.db.get_all(
+ "Exercise",
+ filters={"parenttype": "Therapy Session", "parent": ["in", therapy_sessions], "docstatus": 1},
+ group_by=field,
+ order_by=field,
+ fields=[field, "count(*)"],
+ as_list=True,
+ )
return {
- 'labels': [r[0] for r in result if r[0] != None],
- 'datasets': [{
- 'values': [r[1] for r in result]
- }]
+ "labels": [r[0] for r in result if r[0] != None],
+ "datasets": [{"values": [r[1] for r in result]}],
}
@frappe.whitelist()
def get_therapy_progress_data(patient, therapy_type, time_span):
date_range = get_date_range(time_span)
- query_values = {'from_date': date_range[0], 'to_date': date_range[1], 'therapy_type': therapy_type, 'patient': patient}
- result = frappe.db.sql("""
+ query_values = {
+ "from_date": date_range[0],
+ "to_date": date_range[1],
+ "therapy_type": therapy_type,
+ "patient": patient,
+ }
+ result = frappe.db.sql(
+ """
SELECT
start_date, total_counts_targeted, total_counts_completed
FROM
@@ -91,21 +91,31 @@ def get_therapy_progress_data(patient, therapy_type, time_span):
docstatus = 1 and
therapy_type = %(therapy_type)s and
patient = %(patient)s
- ORDER BY start_date""", query_values, as_list=1)
+ ORDER BY start_date""",
+ query_values,
+ as_list=1,
+ )
return {
- 'labels': [r[0] for r in result if r[0] != None],
- 'datasets': [
- { 'name': _('Targetted'), 'values': [r[1] for r in result if r[0] != None] },
- { 'name': _('Completed'), 'values': [r[2] for r in result if r[0] != None] }
- ]
+ "labels": [r[0] for r in result if r[0] != None],
+ "datasets": [
+ {"name": _("Targetted"), "values": [r[1] for r in result if r[0] != None]},
+ {"name": _("Completed"), "values": [r[2] for r in result if r[0] != None]},
+ ],
}
+
@frappe.whitelist()
def get_patient_assessment_data(patient, assessment_template, time_span):
date_range = get_date_range(time_span)
- query_values = {'from_date': date_range[0], 'to_date': date_range[1], 'assessment_template': assessment_template, 'patient': patient}
- result = frappe.db.sql("""
+ query_values = {
+ "from_date": date_range[0],
+ "to_date": date_range[1],
+ "assessment_template": assessment_template,
+ "patient": patient,
+ }
+ result = frappe.db.sql(
+ """
SELECT
assessment_datetime, total_score, total_score_obtained
FROM
@@ -115,21 +125,29 @@ def get_patient_assessment_data(patient, assessment_template, time_span):
docstatus = 1 and
assessment_template = %(assessment_template)s and
patient = %(patient)s
- ORDER BY assessment_datetime""", query_values, as_list=1)
+ ORDER BY assessment_datetime""",
+ query_values,
+ as_list=1,
+ )
return {
- 'labels': [getdate(r[0]) for r in result if r[0] != None],
- 'datasets': [
- { 'name': _('Score Obtained'), 'values': [r[2] for r in result if r[0] != None] }
- ],
- 'max_score': result[0][1] if result else None
+ "labels": [getdate(r[0]) for r in result if r[0] != None],
+ "datasets": [{"name": _("Score Obtained"), "values": [r[2] for r in result if r[0] != None]}],
+ "max_score": result[0][1] if result else None,
}
+
@frappe.whitelist()
def get_therapy_assessment_correlation_data(patient, assessment_template, time_span):
date_range = get_date_range(time_span)
- query_values = {'from_date': date_range[0], 'to_date': date_range[1], 'assessment': assessment_template, 'patient': patient}
- result = frappe.db.sql("""
+ query_values = {
+ "from_date": date_range[0],
+ "to_date": date_range[1],
+ "assessment": assessment_template,
+ "patient": patient,
+ }
+ result = frappe.db.sql(
+ """
SELECT
therapy.therapy_type, count(*), avg(assessment.total_score_obtained), total_score
FROM
@@ -142,22 +160,36 @@ def get_therapy_assessment_correlation_data(patient, assessment_template, time_s
assessment.patient = %(patient)s and
assessment.assessment_template = %(assessment)s
GROUP BY therapy.therapy_type
- """, query_values, as_list=1)
+ """,
+ query_values,
+ as_list=1,
+ )
return {
- 'labels': [r[0] for r in result if r[0] != None],
- 'datasets': [
- { 'name': _('Sessions'), 'chartType': 'bar', 'values': [r[1] for r in result if r[0] != None] },
- { 'name': _('Average Score'), 'chartType': 'line', 'values': [round(r[2], 2) for r in result if r[0] != None] }
+ "labels": [r[0] for r in result if r[0] != None],
+ "datasets": [
+ {"name": _("Sessions"), "chartType": "bar", "values": [r[1] for r in result if r[0] != None]},
+ {
+ "name": _("Average Score"),
+ "chartType": "line",
+ "values": [round(r[2], 2) for r in result if r[0] != None],
+ },
],
- 'max_score': result[0][1] if result else None
+ "max_score": result[0][1] if result else None,
}
+
@frappe.whitelist()
def get_assessment_parameter_data(patient, parameter, time_span):
date_range = get_date_range(time_span)
- query_values = {'from_date': date_range[0], 'to_date': date_range[1], 'parameter': parameter, 'patient': patient}
- results = frappe.db.sql("""
+ query_values = {
+ "from_date": date_range[0],
+ "to_date": date_range[1],
+ "parameter": parameter,
+ "patient": patient,
+ }
+ results = frappe.db.sql(
+ """
SELECT
assessment.assessment_datetime,
sheet.score,
@@ -175,7 +207,10 @@ def get_assessment_parameter_data(patient, parameter, time_span):
assessment.patient = %(patient)s
ORDER BY
assessment.assessment_datetime asc
- """, query_values, as_list=1)
+ """,
+ query_values,
+ as_list=1,
+ )
score_percentages = []
for r in results:
@@ -184,12 +219,11 @@ def get_assessment_parameter_data(patient, parameter, time_span):
score_percentages.append(score)
return {
- 'labels': [getdate(r[0]) for r in results if r[0] != None],
- 'datasets': [
- { 'name': _('Score'), 'values': score_percentages }
- ]
+ "labels": [getdate(r[0]) for r in results if r[0] != None],
+ "datasets": [{"name": _("Score"), "values": score_percentages}],
}
+
def get_date_range(time_span):
try:
time_span = json.loads(time_span)
diff --git a/erpnext/healthcare/report/inpatient_medication_orders/inpatient_medication_orders.py b/erpnext/healthcare/report/inpatient_medication_orders/inpatient_medication_orders.py
index 99941997e98..20cc606e9c7 100644
--- a/erpnext/healthcare/report/inpatient_medication_orders/inpatient_medication_orders.py
+++ b/erpnext/healthcare/report/inpatient_medication_orders/inpatient_medication_orders.py
@@ -16,6 +16,7 @@ def execute(filters=None):
return columns, data, None, chart
+
def get_columns():
return [
{
@@ -23,87 +24,69 @@ def get_columns():
"fieldtype": "Link",
"label": "Patient",
"options": "Patient",
- "width": 200
+ "width": 200,
},
{
"fieldname": "healthcare_service_unit",
"fieldtype": "Link",
"label": "Healthcare Service Unit",
"options": "Healthcare Service Unit",
- "width": 150
+ "width": 150,
},
{
"fieldname": "drug",
"fieldtype": "Link",
"label": "Drug Code",
"options": "Item",
- "width": 150
- },
- {
- "fieldname": "drug_name",
- "fieldtype": "Data",
- "label": "Drug Name",
- "width": 150
+ "width": 150,
},
+ {"fieldname": "drug_name", "fieldtype": "Data", "label": "Drug Name", "width": 150},
{
"fieldname": "dosage",
"fieldtype": "Link",
"label": "Dosage",
"options": "Prescription Dosage",
- "width": 80
+ "width": 80,
},
{
"fieldname": "dosage_form",
"fieldtype": "Link",
"label": "Dosage Form",
"options": "Dosage Form",
- "width": 100
- },
- {
- "fieldname": "date",
- "fieldtype": "Date",
- "label": "Date",
- "width": 100
- },
- {
- "fieldname": "time",
- "fieldtype": "Time",
- "label": "Time",
- "width": 100
- },
- {
- "fieldname": "is_completed",
- "fieldtype": "Check",
- "label": "Is Order Completed",
- "width": 100
+ "width": 100,
},
+ {"fieldname": "date", "fieldtype": "Date", "label": "Date", "width": 100},
+ {"fieldname": "time", "fieldtype": "Time", "label": "Time", "width": 100},
+ {"fieldname": "is_completed", "fieldtype": "Check", "label": "Is Order Completed", "width": 100},
{
"fieldname": "healthcare_practitioner",
"fieldtype": "Link",
"label": "Healthcare Practitioner",
"options": "Healthcare Practitioner",
- "width": 200
+ "width": 200,
},
{
"fieldname": "inpatient_medication_entry",
"fieldtype": "Link",
"label": "Inpatient Medication Entry",
"options": "Inpatient Medication Entry",
- "width": 200
+ "width": 200,
},
{
"fieldname": "inpatient_record",
"fieldtype": "Link",
"label": "Inpatient Record",
"options": "Inpatient Record",
- "width": 200
- }
+ "width": 200,
+ },
]
+
def get_data(filters):
conditions, values = get_conditions(filters)
- data = frappe.db.sql("""
+ data = frappe.db.sql(
+ """
SELECT
parent.patient, parent.inpatient_record, parent.practitioner,
child.drug, child.drug_name, child.dosage, child.dosage_form,
@@ -115,12 +98,18 @@ def get_data(filters):
parent.docstatus = 1
{conditions}
ORDER BY date, time
- """.format(conditions=conditions), values, as_dict=1)
+ """.format(
+ conditions=conditions
+ ),
+ values,
+ as_dict=1,
+ )
data = get_inpatient_details(data, filters.get("service_unit"))
return data
+
def get_conditions(filters):
conditions = ""
values = dict()
@@ -152,7 +141,9 @@ def get_inpatient_details(data, service_unit):
if entry.is_completed:
entry["inpatient_medication_entry"] = get_inpatient_medication_entry(entry.name)
- if service_unit and entry.healthcare_service_unit and service_unit != entry.healthcare_service_unit:
+ if (
+ service_unit and entry.healthcare_service_unit and service_unit != entry.healthcare_service_unit
+ ):
service_unit_filtered_data.append(entry)
entry.pop("name", None)
@@ -162,8 +153,12 @@ def get_inpatient_details(data, service_unit):
return data
+
def get_inpatient_medication_entry(order_entry):
- return frappe.db.get_value("Inpatient Medication Entry Detail", {"against_imoe": order_entry}, "parent")
+ return frappe.db.get_value(
+ "Inpatient Medication Entry Detail", {"against_imoe": order_entry}, "parent"
+ )
+
def get_chart_data(data):
if not data:
@@ -172,10 +167,7 @@ def get_chart_data(data):
labels = ["Pending", "Completed"]
datasets = []
- status_wise_data = {
- "Pending": 0,
- "Completed": 0
- }
+ status_wise_data = {"Pending": 0, "Completed": 0}
for d in data:
if d.is_completed:
@@ -183,19 +175,14 @@ def get_chart_data(data):
else:
status_wise_data["Pending"] += 1
- datasets.append({
- "name": "Inpatient Medication Order Status",
- "values": [status_wise_data.get("Pending"), status_wise_data.get("Completed")]
- })
+ datasets.append(
+ {
+ "name": "Inpatient Medication Order Status",
+ "values": [status_wise_data.get("Pending"), status_wise_data.get("Completed")],
+ }
+ )
- chart = {
- "data": {
- "labels": labels,
- "datasets": datasets
- },
- "type": "donut",
- "height": 300
- }
+ chart = {"data": {"labels": labels, "datasets": datasets}, "type": "donut", "height": 300}
chart["fieldtype"] = "Data"
diff --git a/erpnext/healthcare/report/inpatient_medication_orders/test_inpatient_medication_orders.py b/erpnext/healthcare/report/inpatient_medication_orders/test_inpatient_medication_orders.py
index 86eb7f7f852..12d81bb6659 100644
--- a/erpnext/healthcare/report/inpatient_medication_orders/test_inpatient_medication_orders.py
+++ b/erpnext/healthcare/report/inpatient_medication_orders/test_inpatient_medication_orders.py
@@ -38,92 +38,94 @@ class TestInpatientMedicationOrders(unittest.TestCase):
def test_inpatient_medication_orders_report(self):
filters = {
- 'company': '_Test Company',
- 'from_date': getdate(),
- 'to_date': getdate(),
- 'patient': '_Test IPD Patient',
- 'service_unit': '_Test Service Unit Ip Occupancy - _TC'
+ "company": "_Test Company",
+ "from_date": getdate(),
+ "to_date": getdate(),
+ "patient": "_Test IPD Patient",
+ "service_unit": "_Test Service Unit Ip Occupancy - _TC",
}
report = execute(filters)
expected_data = [
{
- 'patient': '_Test IPD Patient',
- 'inpatient_record': self.ip_record.name,
- 'practitioner': None,
- 'drug': 'Dextromethorphan',
- 'drug_name': 'Dextromethorphan',
- 'dosage': 1.0,
- 'dosage_form': 'Tablet',
- 'date': getdate(),
- 'time': datetime.timedelta(seconds=32400),
- 'is_completed': 0,
- 'healthcare_service_unit': '_Test Service Unit Ip Occupancy - _TC'
+ "patient": "_Test IPD Patient",
+ "inpatient_record": self.ip_record.name,
+ "practitioner": None,
+ "drug": "Dextromethorphan",
+ "drug_name": "Dextromethorphan",
+ "dosage": 1.0,
+ "dosage_form": "Tablet",
+ "date": getdate(),
+ "time": datetime.timedelta(seconds=32400),
+ "is_completed": 0,
+ "healthcare_service_unit": "_Test Service Unit Ip Occupancy - _TC",
},
{
- 'patient': '_Test IPD Patient',
- 'inpatient_record': self.ip_record.name,
- 'practitioner': None,
- 'drug': 'Dextromethorphan',
- 'drug_name': 'Dextromethorphan',
- 'dosage': 1.0,
- 'dosage_form': 'Tablet',
- 'date': getdate(),
- 'time': datetime.timedelta(seconds=50400),
- 'is_completed': 0,
- 'healthcare_service_unit': '_Test Service Unit Ip Occupancy - _TC'
+ "patient": "_Test IPD Patient",
+ "inpatient_record": self.ip_record.name,
+ "practitioner": None,
+ "drug": "Dextromethorphan",
+ "drug_name": "Dextromethorphan",
+ "dosage": 1.0,
+ "dosage_form": "Tablet",
+ "date": getdate(),
+ "time": datetime.timedelta(seconds=50400),
+ "is_completed": 0,
+ "healthcare_service_unit": "_Test Service Unit Ip Occupancy - _TC",
},
{
- 'patient': '_Test IPD Patient',
- 'inpatient_record': self.ip_record.name,
- 'practitioner': None,
- 'drug': 'Dextromethorphan',
- 'drug_name': 'Dextromethorphan',
- 'dosage': 1.0,
- 'dosage_form': 'Tablet',
- 'date': getdate(),
- 'time': datetime.timedelta(seconds=75600),
- 'is_completed': 0,
- 'healthcare_service_unit': '_Test Service Unit Ip Occupancy - _TC'
- }
+ "patient": "_Test IPD Patient",
+ "inpatient_record": self.ip_record.name,
+ "practitioner": None,
+ "drug": "Dextromethorphan",
+ "drug_name": "Dextromethorphan",
+ "dosage": 1.0,
+ "dosage_form": "Tablet",
+ "date": getdate(),
+ "time": datetime.timedelta(seconds=75600),
+ "is_completed": 0,
+ "healthcare_service_unit": "_Test Service Unit Ip Occupancy - _TC",
+ },
]
self.assertEqual(expected_data, report[1])
- filters = frappe._dict(from_date=getdate(), to_date=getdate(), from_time='', to_time='')
+ filters = frappe._dict(from_date=getdate(), to_date=getdate(), from_time="", to_time="")
ipme = create_ipme(filters)
ipme.submit()
filters = {
- 'company': '_Test Company',
- 'from_date': getdate(),
- 'to_date': getdate(),
- 'patient': '_Test IPD Patient',
- 'service_unit': '_Test Service Unit Ip Occupancy - _TC',
- 'show_completed_orders': 0
+ "company": "_Test Company",
+ "from_date": getdate(),
+ "to_date": getdate(),
+ "patient": "_Test IPD Patient",
+ "service_unit": "_Test Service Unit Ip Occupancy - _TC",
+ "show_completed_orders": 0,
}
report = execute(filters)
self.assertEqual(len(report[1]), 0)
def tearDown(self):
- if frappe.db.get_value('Patient', self.patient, 'inpatient_record'):
+ if frappe.db.get_value("Patient", self.patient, "inpatient_record"):
# cleanup - Discharge
- schedule_discharge(frappe.as_json({'patient': self.patient, 'discharge_ordered_datetime': now_datetime()}))
+ schedule_discharge(
+ frappe.as_json({"patient": self.patient, "discharge_ordered_datetime": now_datetime()})
+ )
self.ip_record.reload()
mark_invoiced_inpatient_occupancy(self.ip_record)
self.ip_record.reload()
discharge_patient(self.ip_record, now_datetime())
- for entry in frappe.get_all('Inpatient Medication Entry'):
- doc = frappe.get_doc('Inpatient Medication Entry', entry.name)
+ for entry in frappe.get_all("Inpatient Medication Entry"):
+ doc = frappe.get_doc("Inpatient Medication Entry", entry.name)
doc.cancel()
doc.delete()
- for entry in frappe.get_all('Inpatient Medication Order'):
- doc = frappe.get_doc('Inpatient Medication Order', entry.name)
+ for entry in frappe.get_all("Inpatient Medication Order"):
+ doc = frappe.get_doc("Inpatient Medication Order", entry.name)
doc.cancel()
doc.delete()
@@ -136,7 +138,7 @@ def create_records(patient):
ip_record.expected_length_of_stay = 0
ip_record.save()
ip_record.reload()
- service_unit = get_healthcare_service_unit('_Test Service Unit Ip Occupancy')
+ service_unit = get_healthcare_service_unit("_Test Service Unit Ip Occupancy")
admit_patient(ip_record, service_unit, now_datetime())
ipmo = create_ipmo(patient)
diff --git a/erpnext/healthcare/report/lab_test_report/lab_test_report.py b/erpnext/healthcare/report/lab_test_report/lab_test_report.py
index f51c713aeba..0d149201fa2 100644
--- a/erpnext/healthcare/report/lab_test_report/lab_test_report.py
+++ b/erpnext/healthcare/report/lab_test_report/lab_test_report.py
@@ -7,7 +7,8 @@ from frappe import _, msgprint
def execute(filters=None):
- if not filters: filters = {}
+ if not filters:
+ filters = {}
data, columns = [], []
@@ -15,24 +16,26 @@ def execute(filters=None):
lab_test_list = get_lab_tests(filters)
if not lab_test_list:
- msgprint(_('No records found'))
+ msgprint(_("No records found"))
return columns, lab_test_list
data = []
for lab_test in lab_test_list:
- row = frappe._dict({
- 'test': lab_test.name,
- 'template': lab_test.template,
- 'company': lab_test.company,
- 'patient': lab_test.patient,
- 'patient_name': lab_test.patient_name,
- 'practitioner': lab_test.practitioner,
- 'employee': lab_test.employee,
- 'status': lab_test.status,
- 'invoiced': lab_test.invoiced,
- 'result_date': lab_test.result_date,
- 'department': lab_test.department
- })
+ row = frappe._dict(
+ {
+ "test": lab_test.name,
+ "template": lab_test.template,
+ "company": lab_test.company,
+ "patient": lab_test.patient,
+ "patient_name": lab_test.patient_name,
+ "practitioner": lab_test.practitioner,
+ "employee": lab_test.employee,
+ "status": lab_test.status,
+ "invoiced": lab_test.invoiced,
+ "result_date": lab_test.result_date,
+ "department": lab_test.department,
+ }
+ )
data.append(row)
chart = get_chart_data(data)
@@ -43,99 +46,91 @@ def execute(filters=None):
def get_columns():
return [
{
- 'fieldname': 'test',
- 'label': _('Lab Test'),
- 'fieldtype': 'Link',
- 'options': 'Lab Test',
- 'width': '120'
+ "fieldname": "test",
+ "label": _("Lab Test"),
+ "fieldtype": "Link",
+ "options": "Lab Test",
+ "width": "120",
},
{
- 'fieldname': 'template',
- 'label': _('Lab Test Template'),
- 'fieldtype': 'Link',
- 'options': 'Lab Test Template',
- 'width': '120'
+ "fieldname": "template",
+ "label": _("Lab Test Template"),
+ "fieldtype": "Link",
+ "options": "Lab Test Template",
+ "width": "120",
},
{
- 'fieldname': 'company',
- 'label': _('Company'),
- 'fieldtype': 'Link',
- 'options': 'Company',
- 'width': '120'
+ "fieldname": "company",
+ "label": _("Company"),
+ "fieldtype": "Link",
+ "options": "Company",
+ "width": "120",
},
{
- 'fieldname': 'patient',
- 'label': _('Patient'),
- 'fieldtype': 'Link',
- 'options': 'Patient',
- 'width': '120'
+ "fieldname": "patient",
+ "label": _("Patient"),
+ "fieldtype": "Link",
+ "options": "Patient",
+ "width": "120",
+ },
+ {"fieldname": "patient_name", "label": _("Patient Name"), "fieldtype": "Data", "width": "120"},
+ {
+ "fieldname": "employee",
+ "label": _("Lab Technician"),
+ "fieldtype": "Link",
+ "options": "Employee",
+ "width": "120",
+ },
+ {"fieldname": "status", "label": _("Status"), "fieldtype": "Data", "width": "100"},
+ {"fieldname": "invoiced", "label": _("Invoiced"), "fieldtype": "Check", "width": "100"},
+ {"fieldname": "result_date", "label": _("Result Date"), "fieldtype": "Date", "width": "100"},
+ {
+ "fieldname": "practitioner",
+ "label": _("Requesting Practitioner"),
+ "fieldtype": "Link",
+ "options": "Healthcare Practitioner",
+ "width": "120",
},
{
- 'fieldname': 'patient_name',
- 'label': _('Patient Name'),
- 'fieldtype': 'Data',
- 'width': '120'
+ "fieldname": "department",
+ "label": _("Medical Department"),
+ "fieldtype": "Link",
+ "options": "Medical Department",
+ "width": "100",
},
- {
- 'fieldname': 'employee',
- 'label': _('Lab Technician'),
- 'fieldtype': 'Link',
- 'options': 'Employee',
- 'width': '120'
- },
- {
- 'fieldname': 'status',
- 'label': _('Status'),
- 'fieldtype': 'Data',
- 'width': '100'
- },
- {
- 'fieldname': 'invoiced',
- 'label': _('Invoiced'),
- 'fieldtype': 'Check',
- 'width': '100'
- },
- {
- 'fieldname': 'result_date',
- 'label': _('Result Date'),
- 'fieldtype': 'Date',
- 'width': '100'
- },
- {
- 'fieldname': 'practitioner',
- 'label': _('Requesting Practitioner'),
- 'fieldtype': 'Link',
- 'options': 'Healthcare Practitioner',
- 'width': '120'
- },
- {
- 'fieldname': 'department',
- 'label': _('Medical Department'),
- 'fieldtype': 'Link',
- 'options': 'Medical Department',
- 'width': '100'
- }
]
+
def get_lab_tests(filters):
conditions = get_conditions(filters)
data = frappe.get_all(
- doctype='Lab Test',
- fields=['name', 'template', 'company', 'patient', 'patient_name', 'practitioner', 'employee', 'status', 'invoiced', 'result_date', 'department'],
+ doctype="Lab Test",
+ fields=[
+ "name",
+ "template",
+ "company",
+ "patient",
+ "patient_name",
+ "practitioner",
+ "employee",
+ "status",
+ "invoiced",
+ "result_date",
+ "department",
+ ],
filters=conditions,
- order_by='submitted_date desc'
+ order_by="submitted_date desc",
)
return data
-def get_conditions(filters):
- conditions = {
- 'docstatus': ('=', 1)
- }
- if filters.get('from_date') and filters.get('to_date'):
- conditions['result_date'] = ('between', (filters.get('from_date'), filters.get('to_date')))
- filters.pop('from_date')
- filters.pop('to_date')
+def get_conditions(filters):
+ conditions = {"docstatus": ("=", 1)}
+
+ if filters.get("from_date") and filters.get("to_date"):
+ conditions["result_date"] = ("between", (filters.get("from_date"), filters.get("to_date")))
+ filters.pop("from_date")
+ filters.pop("to_date")
for key, value in filters.items():
if filters.get(key):
@@ -143,35 +138,35 @@ def get_conditions(filters):
return conditions
+
def get_chart_data(data):
if not data:
return None
- labels = ['Completed', 'Approved', 'Rejected']
+ labels = ["Completed", "Approved", "Rejected"]
- status_wise_data = {
- 'Completed': 0,
- 'Approved': 0,
- 'Rejected': 0
- }
+ status_wise_data = {"Completed": 0, "Approved": 0, "Rejected": 0}
datasets = []
for entry in data:
status_wise_data[entry.status] += 1
- datasets.append({
- 'name': 'Lab Test Status',
- 'values': [status_wise_data.get('Completed'), status_wise_data.get('Approved'), status_wise_data.get('Rejected')]
- })
+ datasets.append(
+ {
+ "name": "Lab Test Status",
+ "values": [
+ status_wise_data.get("Completed"),
+ status_wise_data.get("Approved"),
+ status_wise_data.get("Rejected"),
+ ],
+ }
+ )
chart = {
- 'data': {
- 'labels': labels,
- 'datasets': datasets
- },
- 'type': 'bar',
- 'height': 300,
+ "data": {"labels": labels, "datasets": datasets},
+ "type": "bar",
+ "height": 300,
}
return chart
@@ -192,21 +187,21 @@ def get_report_summary(data):
return [
{
- 'value': total_lab_tests,
- 'indicator': 'Blue',
- 'label': 'Total Lab Tests',
- 'datatype': 'Int',
+ "value": total_lab_tests,
+ "indicator": "Blue",
+ "label": "Total Lab Tests",
+ "datatype": "Int",
},
{
- 'value': invoiced_lab_tests,
- 'indicator': 'Green',
- 'label': 'Invoiced Lab Tests',
- 'datatype': 'Int',
+ "value": invoiced_lab_tests,
+ "indicator": "Green",
+ "label": "Invoiced Lab Tests",
+ "datatype": "Int",
},
{
- 'value': unbilled_lab_tests,
- 'indicator': 'Red',
- 'label': 'Unbilled Lab Tests',
- 'datatype': 'Int',
- }
+ "value": unbilled_lab_tests,
+ "indicator": "Red",
+ "label": "Unbilled Lab Tests",
+ "datatype": "Int",
+ },
]
diff --git a/erpnext/healthcare/report/patient_appointment_analytics/patient_appointment_analytics.py b/erpnext/healthcare/report/patient_appointment_analytics/patient_appointment_analytics.py
index b128a1ed487..a4eede39feb 100644
--- a/erpnext/healthcare/report/patient_appointment_analytics/patient_appointment_analytics.py
+++ b/erpnext/healthcare/report/patient_appointment_analytics/patient_appointment_analytics.py
@@ -13,11 +13,25 @@ from erpnext.accounts.utils import get_fiscal_year
def execute(filters=None):
return Analytics(filters).run()
+
class Analytics(object):
def __init__(self, filters=None):
"""Patient Appointment Analytics Report."""
self.filters = frappe._dict(filters or {})
- self.months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ self.months = [
+ "Jan",
+ "Feb",
+ "Mar",
+ "Apr",
+ "May",
+ "Jun",
+ "Jul",
+ "Aug",
+ "Sep",
+ "Oct",
+ "Nov",
+ "Dec",
+ ]
self.get_period_date_ranges()
def run(self):
@@ -29,25 +43,23 @@ class Analytics(object):
def get_period_date_ranges(self):
from dateutil.relativedelta import MO, relativedelta
+
from_date, to_date = getdate(self.filters.from_date), getdate(self.filters.to_date)
- increment = {
- 'Monthly': 1,
- 'Quarterly': 3,
- 'Half-Yearly': 6,
- 'Yearly': 12
- }.get(self.filters.range, 1)
+ increment = {"Monthly": 1, "Quarterly": 3, "Half-Yearly": 6, "Yearly": 12}.get(
+ self.filters.range, 1
+ )
- if self.filters.range in ['Monthly', 'Quarterly']:
+ if self.filters.range in ["Monthly", "Quarterly"]:
from_date = from_date.replace(day=1)
- elif self.filters.range == 'Yearly':
+ elif self.filters.range == "Yearly":
from_date = get_fiscal_year(from_date)[1]
else:
from_date = from_date + relativedelta(from_date, weekday=MO(-1))
self.periodic_daterange = []
for dummy in range(1, 53):
- if self.filters.range == 'Weekly':
+ if self.filters.range == "Weekly":
period_end_date = add_days(from_date, 6)
else:
period_end_date = add_to_date(from_date, months=increment, days=-1)
@@ -64,87 +76,87 @@ class Analytics(object):
def get_columns(self):
self.columns = []
- if self.filters.tree_type == 'Healthcare Practitioner':
- self.columns.append({
- 'label': _('Healthcare Practitioner'),
- 'options': 'Healthcare Practitioner',
- 'fieldname': 'practitioner',
- 'fieldtype': 'Link',
- 'width': 200
- })
+ if self.filters.tree_type == "Healthcare Practitioner":
+ self.columns.append(
+ {
+ "label": _("Healthcare Practitioner"),
+ "options": "Healthcare Practitioner",
+ "fieldname": "practitioner",
+ "fieldtype": "Link",
+ "width": 200,
+ }
+ )
- elif self.filters.tree_type == 'Medical Department':
- self.columns.append({
- 'label': _('Medical Department'),
- 'fieldname': 'department',
- 'fieldtype': 'Link',
- 'options': 'Medical Department',
- 'width': 150
- })
+ elif self.filters.tree_type == "Medical Department":
+ self.columns.append(
+ {
+ "label": _("Medical Department"),
+ "fieldname": "department",
+ "fieldtype": "Link",
+ "options": "Medical Department",
+ "width": 150,
+ }
+ )
for end_date in self.periodic_daterange:
period = self.get_period(end_date)
- self.columns.append({
- 'label': _(period),
- 'fieldname': scrub(period),
- 'fieldtype': 'Int',
- 'width': 120
- })
+ self.columns.append(
+ {"label": _(period), "fieldname": scrub(period), "fieldtype": "Int", "width": 120}
+ )
- self.columns.append({
- 'label': _('Total'),
- 'fieldname': 'total',
- 'fieldtype': 'Int',
- 'width': 120
- })
+ self.columns.append(
+ {"label": _("Total"), "fieldname": "total", "fieldtype": "Int", "width": 120}
+ )
def get_data(self):
- if self.filters.tree_type == 'Healthcare Practitioner':
+ if self.filters.tree_type == "Healthcare Practitioner":
self.get_appointments_based_on_healthcare_practitioner()
self.get_rows()
- elif self.filters.tree_type == 'Medical Department':
+ elif self.filters.tree_type == "Medical Department":
self.get_appointments_based_on_medical_department()
self.get_rows()
def get_period(self, appointment_date):
- if self.filters.range == 'Weekly':
- period = 'Week ' + str(appointment_date.isocalendar()[1])
- elif self.filters.range == 'Monthly':
+ if self.filters.range == "Weekly":
+ period = "Week " + str(appointment_date.isocalendar()[1])
+ elif self.filters.range == "Monthly":
period = str(self.months[appointment_date.month - 1])
- elif self.filters.range == 'Quarterly':
- period = 'Quarter ' + str(((appointment_date.month - 1) // 3) + 1)
+ elif self.filters.range == "Quarterly":
+ period = "Quarter " + str(((appointment_date.month - 1) // 3) + 1)
else:
year = get_fiscal_year(appointment_date, company=self.filters.company)
period = str(year[0])
if getdate(self.filters.from_date).year != getdate(self.filters.to_date).year:
- period += ' ' + str(appointment_date.year)
+ period += " " + str(appointment_date.year)
return period
def get_appointments_based_on_healthcare_practitioner(self):
filters = self.get_common_filters()
- self.entries = frappe.db.get_all('Patient Appointment',
- fields=['appointment_date', 'name', 'patient', 'practitioner'],
- filters=filters
+ self.entries = frappe.db.get_all(
+ "Patient Appointment",
+ fields=["appointment_date", "name", "patient", "practitioner"],
+ filters=filters,
)
def get_appointments_based_on_medical_department(self):
filters = self.get_common_filters()
- if not filters.get('department'):
- filters['department'] = ('!=', '')
+ if not filters.get("department"):
+ filters["department"] = ("!=", "")
- self.entries = frappe.db.get_all('Patient Appointment',
- fields=['appointment_date', 'name', 'patient', 'practitioner', 'department'],
- filters=filters
+ self.entries = frappe.db.get_all(
+ "Patient Appointment",
+ fields=["appointment_date", "name", "patient", "practitioner", "department"],
+ filters=filters,
)
def get_common_filters(self):
filters = {}
- filters['appointment_date'] = ('between', [self.filters.from_date, self.filters.to_date])
- for entry in ['appointment_type', 'practitioner', 'department', 'status']:
+ filters["appointment_date"] = ("between", [self.filters.from_date, self.filters.to_date])
+ for entry in ["appointment_type", "practitioner", "department", "status"]:
if self.filters.get(entry):
filters[entry] = self.filters.get(entry)
@@ -155,10 +167,10 @@ class Analytics(object):
self.get_periodic_data()
for entity, period_data in iteritems(self.appointment_periodic_data):
- if self.filters.tree_type == 'Healthcare Practitioner':
- row = {'practitioner': entity}
- elif self.filters.tree_type == 'Medical Department':
- row = {'department': entity}
+ if self.filters.tree_type == "Healthcare Practitioner":
+ row = {"practitioner": entity}
+ elif self.filters.tree_type == "Medical Department":
+ row = {"department": entity}
total = 0
for end_date in self.periodic_daterange:
@@ -167,7 +179,7 @@ class Analytics(object):
row[scrub(period)] = amount
total += amount
- row['total'] = total
+ row["total"] = total
self.data.append(row)
@@ -175,22 +187,18 @@ class Analytics(object):
self.appointment_periodic_data = frappe._dict()
for d in self.entries:
- period = self.get_period(d.get('appointment_date'))
- if self.filters.tree_type == 'Healthcare Practitioner':
- self.appointment_periodic_data.setdefault(d.practitioner, frappe._dict()).setdefault(period, 0.0)
+ period = self.get_period(d.get("appointment_date"))
+ if self.filters.tree_type == "Healthcare Practitioner":
+ self.appointment_periodic_data.setdefault(d.practitioner, frappe._dict()).setdefault(
+ period, 0.0
+ )
self.appointment_periodic_data[d.practitioner][period] += 1
- elif self.filters.tree_type == 'Medical Department':
+ elif self.filters.tree_type == "Medical Department":
self.appointment_periodic_data.setdefault(d.department, frappe._dict()).setdefault(period, 0.0)
self.appointment_periodic_data[d.department][period] += 1
def get_chart_data(self):
length = len(self.columns)
- labels = [d.get("label") for d in self.columns[1:length - 1]]
- self.chart = {
- "data": {
- 'labels': labels,
- 'datasets': []
- },
- "type": "line"
- }
+ labels = [d.get("label") for d in self.columns[1 : length - 1]]
+ self.chart = {"data": {"labels": labels, "datasets": []}, "type": "line"}
diff --git a/erpnext/healthcare/setup.py b/erpnext/healthcare/setup.py
index 02295bb5858..b537ba39de3 100644
--- a/erpnext/healthcare/setup.py
+++ b/erpnext/healthcare/setup.py
@@ -1,4 +1,3 @@
-
import frappe
from frappe import _
@@ -6,7 +5,7 @@ from erpnext.setup.utils import insert_record
def setup_healthcare():
- if frappe.db.exists('Medical Department', 'Cardiology'):
+ if frappe.db.exists("Medical Department", "Cardiology"):
# already setup
return
create_medical_departments()
@@ -19,12 +18,31 @@ def setup_healthcare():
add_healthcare_service_unit_tree_root()
setup_patient_history_settings()
+
def create_medical_departments():
departments = [
- "Accident And Emergency Care" ,"Anaesthetics", "Biochemistry", "Cardiology", "Dermatology",
- "Diagnostic Imaging", "ENT", "Gastroenterology", "General Surgery", "Gynaecology",
- "Haematology", "Maternity", "Microbiology", "Nephrology", "Neurology", "Oncology",
- "Orthopaedics", "Pathology", "Physiotherapy", "Rheumatology", "Serology", "Urology"
+ "Accident And Emergency Care",
+ "Anaesthetics",
+ "Biochemistry",
+ "Cardiology",
+ "Dermatology",
+ "Diagnostic Imaging",
+ "ENT",
+ "Gastroenterology",
+ "General Surgery",
+ "Gynaecology",
+ "Haematology",
+ "Maternity",
+ "Microbiology",
+ "Nephrology",
+ "Neurology",
+ "Oncology",
+ "Orthopaedics",
+ "Pathology",
+ "Physiotherapy",
+ "Rheumatology",
+ "Serology",
+ "Urology",
]
for department in departments:
mediacal_department = frappe.new_doc("Medical Department")
@@ -34,37 +52,175 @@ def create_medical_departments():
except frappe.DuplicateEntryError:
pass
+
def create_antibiotics():
abt = [
- "Amoxicillin", "Ampicillin", "Bacampicillin", "Carbenicillin", "Cloxacillin", "Dicloxacillin",
- "Flucloxacillin", "Mezlocillin", "Nafcillin", "Oxacillin", "Penicillin G", "Penicillin V",
- "Piperacillin", "Pivampicillin", "Pivmecillinam", "Ticarcillin", "Cefacetrile (cephacetrile)",
- "Cefadroxil (cefadroxyl)", "Cefalexin (cephalexin)", "Cefaloglycin (cephaloglycin)",
- "Cefalonium (cephalonium)", "Cefaloridine (cephaloradine)", "Cefalotin (cephalothin)",
- "Cefapirin (cephapirin)", "Cefatrizine", "Cefazaflur", "Cefazedone", "Cefazolin (cephazolin)",
- "Cefradine (cephradine)", "Cefroxadine", "Ceftezole", "Cefaclor", "Cefamandole", "Cefmetazole",
- "Cefonicid", "Cefotetan", "Cefoxitin", "Cefprozil (cefproxil)", "Cefuroxime", "Cefuzonam",
- "Cefcapene", "Cefdaloxime", "Cefdinir", "Cefditoren", "Cefetamet", "Cefixime", "Cefmenoxime",
- "Cefodizime", "Cefotaxime", "Cefpimizole", "Cefpodoxime", "Cefteram", "Ceftibuten", "Ceftiofur",
- "Ceftiolene", "Ceftizoxime", "Ceftriaxone", "Cefoperazone", "Ceftazidime", "Cefclidine", "Cefepime",
- "Cefluprenam", "Cefoselis", "Cefozopran", "Cefpirome", "Cefquinome", "Ceftobiprole", "Ceftaroline",
- "Cefaclomezine","Cefaloram", "Cefaparole", "Cefcanel", "Cefedrolor", "Cefempidone", "Cefetrizole",
- "Cefivitril", "Cefmatilen", "Cefmepidium", "Cefovecin", "Cefoxazole", "Cefrotil", "Cefsumide",
- "Cefuracetime", "Ceftioxide", "Ceftazidime/Avibactam", "Ceftolozane/Tazobactam", "Aztreonam",
- "Imipenem", "Imipenem/cilastatin", "Doripenem", "Meropenem", "Ertapenem", "Azithromycin",
- "Erythromycin", "Clarithromycin", "Dirithromycin", "Roxithromycin", "Telithromycin", "Clindamycin",
- "Lincomycin", "Pristinamycin", "Quinupristin/dalfopristin", "Amikacin", "Gentamicin", "Kanamycin",
- "Neomycin", "Netilmicin", "Paromomycin", "Streptomycin", "Tobramycin", "Flumequine", "Nalidixic acid",
- "Oxolinic acid", "Piromidic acid", "Pipemidic acid", "Rosoxacin", "Ciprofloxacin", "Enoxacin",
- "Lomefloxacin", "Nadifloxacin", "Norfloxacin", "Ofloxacin", "Pefloxacin", "Rufloxacin", "Balofloxacin",
- "Gatifloxacin", "Grepafloxacin", "Levofloxacin", "Moxifloxacin", "Pazufloxacin", "Sparfloxacin",
- "Temafloxacin", "Tosufloxacin", "Besifloxacin", "Clinafloxacin", "Gemifloxacin",
- "Sitafloxacin", "Trovafloxacin", "Prulifloxacin", "Sulfamethizole", "Sulfamethoxazole",
- "Sulfisoxazole", "Trimethoprim-Sulfamethoxazole", "Demeclocycline", "Doxycycline", "Minocycline",
- "Oxytetracycline", "Tetracycline", "Tigecycline", "Chloramphenicol", "Metronidazole",
- "Tinidazole", "Nitrofurantoin", "Vancomycin", "Teicoplanin", "Telavancin", "Linezolid",
- "Cycloserine 2", "Rifampin", "Rifabutin", "Rifapentine", "Rifalazil", "Bacitracin", "Polymyxin B",
- "Viomycin", "Capreomycin"
+ "Amoxicillin",
+ "Ampicillin",
+ "Bacampicillin",
+ "Carbenicillin",
+ "Cloxacillin",
+ "Dicloxacillin",
+ "Flucloxacillin",
+ "Mezlocillin",
+ "Nafcillin",
+ "Oxacillin",
+ "Penicillin G",
+ "Penicillin V",
+ "Piperacillin",
+ "Pivampicillin",
+ "Pivmecillinam",
+ "Ticarcillin",
+ "Cefacetrile (cephacetrile)",
+ "Cefadroxil (cefadroxyl)",
+ "Cefalexin (cephalexin)",
+ "Cefaloglycin (cephaloglycin)",
+ "Cefalonium (cephalonium)",
+ "Cefaloridine (cephaloradine)",
+ "Cefalotin (cephalothin)",
+ "Cefapirin (cephapirin)",
+ "Cefatrizine",
+ "Cefazaflur",
+ "Cefazedone",
+ "Cefazolin (cephazolin)",
+ "Cefradine (cephradine)",
+ "Cefroxadine",
+ "Ceftezole",
+ "Cefaclor",
+ "Cefamandole",
+ "Cefmetazole",
+ "Cefonicid",
+ "Cefotetan",
+ "Cefoxitin",
+ "Cefprozil (cefproxil)",
+ "Cefuroxime",
+ "Cefuzonam",
+ "Cefcapene",
+ "Cefdaloxime",
+ "Cefdinir",
+ "Cefditoren",
+ "Cefetamet",
+ "Cefixime",
+ "Cefmenoxime",
+ "Cefodizime",
+ "Cefotaxime",
+ "Cefpimizole",
+ "Cefpodoxime",
+ "Cefteram",
+ "Ceftibuten",
+ "Ceftiofur",
+ "Ceftiolene",
+ "Ceftizoxime",
+ "Ceftriaxone",
+ "Cefoperazone",
+ "Ceftazidime",
+ "Cefclidine",
+ "Cefepime",
+ "Cefluprenam",
+ "Cefoselis",
+ "Cefozopran",
+ "Cefpirome",
+ "Cefquinome",
+ "Ceftobiprole",
+ "Ceftaroline",
+ "Cefaclomezine",
+ "Cefaloram",
+ "Cefaparole",
+ "Cefcanel",
+ "Cefedrolor",
+ "Cefempidone",
+ "Cefetrizole",
+ "Cefivitril",
+ "Cefmatilen",
+ "Cefmepidium",
+ "Cefovecin",
+ "Cefoxazole",
+ "Cefrotil",
+ "Cefsumide",
+ "Cefuracetime",
+ "Ceftioxide",
+ "Ceftazidime/Avibactam",
+ "Ceftolozane/Tazobactam",
+ "Aztreonam",
+ "Imipenem",
+ "Imipenem/cilastatin",
+ "Doripenem",
+ "Meropenem",
+ "Ertapenem",
+ "Azithromycin",
+ "Erythromycin",
+ "Clarithromycin",
+ "Dirithromycin",
+ "Roxithromycin",
+ "Telithromycin",
+ "Clindamycin",
+ "Lincomycin",
+ "Pristinamycin",
+ "Quinupristin/dalfopristin",
+ "Amikacin",
+ "Gentamicin",
+ "Kanamycin",
+ "Neomycin",
+ "Netilmicin",
+ "Paromomycin",
+ "Streptomycin",
+ "Tobramycin",
+ "Flumequine",
+ "Nalidixic acid",
+ "Oxolinic acid",
+ "Piromidic acid",
+ "Pipemidic acid",
+ "Rosoxacin",
+ "Ciprofloxacin",
+ "Enoxacin",
+ "Lomefloxacin",
+ "Nadifloxacin",
+ "Norfloxacin",
+ "Ofloxacin",
+ "Pefloxacin",
+ "Rufloxacin",
+ "Balofloxacin",
+ "Gatifloxacin",
+ "Grepafloxacin",
+ "Levofloxacin",
+ "Moxifloxacin",
+ "Pazufloxacin",
+ "Sparfloxacin",
+ "Temafloxacin",
+ "Tosufloxacin",
+ "Besifloxacin",
+ "Clinafloxacin",
+ "Gemifloxacin",
+ "Sitafloxacin",
+ "Trovafloxacin",
+ "Prulifloxacin",
+ "Sulfamethizole",
+ "Sulfamethoxazole",
+ "Sulfisoxazole",
+ "Trimethoprim-Sulfamethoxazole",
+ "Demeclocycline",
+ "Doxycycline",
+ "Minocycline",
+ "Oxytetracycline",
+ "Tetracycline",
+ "Tigecycline",
+ "Chloramphenicol",
+ "Metronidazole",
+ "Tinidazole",
+ "Nitrofurantoin",
+ "Vancomycin",
+ "Teicoplanin",
+ "Telavancin",
+ "Linezolid",
+ "Cycloserine 2",
+ "Rifampin",
+ "Rifabutin",
+ "Rifapentine",
+ "Rifalazil",
+ "Bacitracin",
+ "Polymyxin B",
+ "Viomycin",
+ "Capreomycin",
]
for a in abt:
@@ -75,115 +231,259 @@ def create_antibiotics():
except frappe.DuplicateEntryError:
pass
+
def create_lab_test_uom():
records = [
- {"doctype": "Lab Test UOM", "name": "umol/L", "lab_test_uom": "umol/L", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "mg/L", "lab_test_uom": "mg/L", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "mg / dl", "lab_test_uom": "mg / dl", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "pg / ml", "lab_test_uom": "pg / ml", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "U/ml", "lab_test_uom": "U/ml", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "/HPF", "lab_test_uom": "/HPF", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "Million Cells / cumm", "lab_test_uom": "Million Cells / cumm", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "Lakhs Cells / cumm", "lab_test_uom": "Lakhs Cells / cumm", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "U / L", "lab_test_uom": "U / L", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "g / L", "lab_test_uom": "g / L", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "IU / ml", "lab_test_uom": "IU / ml", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "gm %", "lab_test_uom": "gm %", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "Microgram", "lab_test_uom": "Microgram", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "Micron", "lab_test_uom": "Micron", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "Cells / cumm", "lab_test_uom": "Cells / cumm", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "%", "lab_test_uom": "%", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "mm / dl", "lab_test_uom": "mm / dl", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "mm / hr", "lab_test_uom": "mm / hr", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "ulU / ml", "lab_test_uom": "ulU / ml", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "ng / ml", "lab_test_uom": "ng / ml", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "ng / dl", "lab_test_uom": "ng / dl", "uom_description": None },
- {"doctype": "Lab Test UOM", "name": "ug / dl", "lab_test_uom": "ug / dl", "uom_description": None }
+ {"doctype": "Lab Test UOM", "name": "umol/L", "lab_test_uom": "umol/L", "uom_description": None},
+ {"doctype": "Lab Test UOM", "name": "mg/L", "lab_test_uom": "mg/L", "uom_description": None},
+ {
+ "doctype": "Lab Test UOM",
+ "name": "mg / dl",
+ "lab_test_uom": "mg / dl",
+ "uom_description": None,
+ },
+ {
+ "doctype": "Lab Test UOM",
+ "name": "pg / ml",
+ "lab_test_uom": "pg / ml",
+ "uom_description": None,
+ },
+ {"doctype": "Lab Test UOM", "name": "U/ml", "lab_test_uom": "U/ml", "uom_description": None},
+ {"doctype": "Lab Test UOM", "name": "/HPF", "lab_test_uom": "/HPF", "uom_description": None},
+ {
+ "doctype": "Lab Test UOM",
+ "name": "Million Cells / cumm",
+ "lab_test_uom": "Million Cells / cumm",
+ "uom_description": None,
+ },
+ {
+ "doctype": "Lab Test UOM",
+ "name": "Lakhs Cells / cumm",
+ "lab_test_uom": "Lakhs Cells / cumm",
+ "uom_description": None,
+ },
+ {"doctype": "Lab Test UOM", "name": "U / L", "lab_test_uom": "U / L", "uom_description": None},
+ {"doctype": "Lab Test UOM", "name": "g / L", "lab_test_uom": "g / L", "uom_description": None},
+ {
+ "doctype": "Lab Test UOM",
+ "name": "IU / ml",
+ "lab_test_uom": "IU / ml",
+ "uom_description": None,
+ },
+ {"doctype": "Lab Test UOM", "name": "gm %", "lab_test_uom": "gm %", "uom_description": None},
+ {
+ "doctype": "Lab Test UOM",
+ "name": "Microgram",
+ "lab_test_uom": "Microgram",
+ "uom_description": None,
+ },
+ {"doctype": "Lab Test UOM", "name": "Micron", "lab_test_uom": "Micron", "uom_description": None},
+ {
+ "doctype": "Lab Test UOM",
+ "name": "Cells / cumm",
+ "lab_test_uom": "Cells / cumm",
+ "uom_description": None,
+ },
+ {"doctype": "Lab Test UOM", "name": "%", "lab_test_uom": "%", "uom_description": None},
+ {
+ "doctype": "Lab Test UOM",
+ "name": "mm / dl",
+ "lab_test_uom": "mm / dl",
+ "uom_description": None,
+ },
+ {
+ "doctype": "Lab Test UOM",
+ "name": "mm / hr",
+ "lab_test_uom": "mm / hr",
+ "uom_description": None,
+ },
+ {
+ "doctype": "Lab Test UOM",
+ "name": "ulU / ml",
+ "lab_test_uom": "ulU / ml",
+ "uom_description": None,
+ },
+ {
+ "doctype": "Lab Test UOM",
+ "name": "ng / ml",
+ "lab_test_uom": "ng / ml",
+ "uom_description": None,
+ },
+ {
+ "doctype": "Lab Test UOM",
+ "name": "ng / dl",
+ "lab_test_uom": "ng / dl",
+ "uom_description": None,
+ },
+ {
+ "doctype": "Lab Test UOM",
+ "name": "ug / dl",
+ "lab_test_uom": "ug / dl",
+ "uom_description": None,
+ },
]
insert_record(records)
+
def create_duration():
records = [
- {"doctype": "Prescription Duration", "name": "3 Month", "number": "3", "period": "Month" },
- {"doctype": "Prescription Duration", "name": "2 Month", "number": "2", "period": "Month" },
- {"doctype": "Prescription Duration", "name": "1 Month", "number": "1", "period": "Month" },
- {"doctype": "Prescription Duration", "name": "12 Hour", "number": "12", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "11 Hour", "number": "11", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "10 Hour", "number": "10", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "9 Hour", "number": "9", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "8 Hour", "number": "8", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "7 Hour", "number": "7", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "6 Hour", "number": "6", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "5 Hour", "number": "5", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "4 Hour", "number": "4", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "3 Hour", "number": "3", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "2 Hour", "number": "2", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "1 Hour", "number": "1", "period": "Hour" },
- {"doctype": "Prescription Duration", "name": "5 Week", "number": "5", "period": "Week" },
- {"doctype": "Prescription Duration", "name": "4 Week", "number": "4", "period": "Week" },
- {"doctype": "Prescription Duration", "name": "3 Week", "number": "3", "period": "Week" },
- {"doctype": "Prescription Duration", "name": "2 Week", "number": "2", "period": "Week" },
- {"doctype": "Prescription Duration", "name": "1 Week", "number": "1", "period": "Week" },
- {"doctype": "Prescription Duration", "name": "6 Day", "number": "6", "period": "Day" },
- {"doctype": "Prescription Duration", "name": "5 Day", "number": "5", "period": "Day" },
- {"doctype": "Prescription Duration", "name": "4 Day", "number": "4", "period": "Day" },
- {"doctype": "Prescription Duration", "name": "3 Day", "number": "3", "period": "Day" },
- {"doctype": "Prescription Duration", "name": "2 Day", "number": "2", "period": "Day" },
- {"doctype": "Prescription Duration", "name": "1 Day", "number": "1", "period": "Day" }
+ {"doctype": "Prescription Duration", "name": "3 Month", "number": "3", "period": "Month"},
+ {"doctype": "Prescription Duration", "name": "2 Month", "number": "2", "period": "Month"},
+ {"doctype": "Prescription Duration", "name": "1 Month", "number": "1", "period": "Month"},
+ {"doctype": "Prescription Duration", "name": "12 Hour", "number": "12", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "11 Hour", "number": "11", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "10 Hour", "number": "10", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "9 Hour", "number": "9", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "8 Hour", "number": "8", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "7 Hour", "number": "7", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "6 Hour", "number": "6", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "5 Hour", "number": "5", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "4 Hour", "number": "4", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "3 Hour", "number": "3", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "2 Hour", "number": "2", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "1 Hour", "number": "1", "period": "Hour"},
+ {"doctype": "Prescription Duration", "name": "5 Week", "number": "5", "period": "Week"},
+ {"doctype": "Prescription Duration", "name": "4 Week", "number": "4", "period": "Week"},
+ {"doctype": "Prescription Duration", "name": "3 Week", "number": "3", "period": "Week"},
+ {"doctype": "Prescription Duration", "name": "2 Week", "number": "2", "period": "Week"},
+ {"doctype": "Prescription Duration", "name": "1 Week", "number": "1", "period": "Week"},
+ {"doctype": "Prescription Duration", "name": "6 Day", "number": "6", "period": "Day"},
+ {"doctype": "Prescription Duration", "name": "5 Day", "number": "5", "period": "Day"},
+ {"doctype": "Prescription Duration", "name": "4 Day", "number": "4", "period": "Day"},
+ {"doctype": "Prescription Duration", "name": "3 Day", "number": "3", "period": "Day"},
+ {"doctype": "Prescription Duration", "name": "2 Day", "number": "2", "period": "Day"},
+ {"doctype": "Prescription Duration", "name": "1 Day", "number": "1", "period": "Day"},
]
insert_record(records)
+
def create_dosage():
records = [
- {"doctype": "Prescription Dosage", "name": "1-1-1-1", "dosage": "1-1-1-1","dosage_strength":
- [{"strength": "1.0","strength_time": "9:00:00"}, {"strength": "1.0","strength_time": "13:00:00"},{"strength": "1.0","strength_time": "17:00:00"},{"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "1-1-1-1",
+ "dosage": "1-1-1-1",
+ "dosage_strength": [
+ {"strength": "1.0", "strength_time": "9:00:00"},
+ {"strength": "1.0", "strength_time": "13:00:00"},
+ {"strength": "1.0", "strength_time": "17:00:00"},
+ {"strength": "1.0", "strength_time": "21:00:00"},
+ ],
},
- {"doctype": "Prescription Dosage", "name": "0-0-1", "dosage": "0-0-1","dosage_strength":
- [{"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "0-0-1",
+ "dosage": "0-0-1",
+ "dosage_strength": [{"strength": "1.0", "strength_time": "21:00:00"}],
},
- {"doctype": "Prescription Dosage", "name": "1-0-0", "dosage": "1-0-0","dosage_strength":
- [{"strength": "1.0","strength_time": "9:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "1-0-0",
+ "dosage": "1-0-0",
+ "dosage_strength": [{"strength": "1.0", "strength_time": "9:00:00"}],
},
- {"doctype": "Prescription Dosage", "name": "0-1-0", "dosage": "0-1-0","dosage_strength":
- [{"strength": "1.0","strength_time": "14:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "0-1-0",
+ "dosage": "0-1-0",
+ "dosage_strength": [{"strength": "1.0", "strength_time": "14:00:00"}],
},
- {"doctype": "Prescription Dosage", "name": "1-1-1", "dosage": "1-1-1","dosage_strength":
- [{"strength": "1.0","strength_time": "9:00:00"}, {"strength": "1.0","strength_time": "14:00:00"},{"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "1-1-1",
+ "dosage": "1-1-1",
+ "dosage_strength": [
+ {"strength": "1.0", "strength_time": "9:00:00"},
+ {"strength": "1.0", "strength_time": "14:00:00"},
+ {"strength": "1.0", "strength_time": "21:00:00"},
+ ],
},
- {"doctype": "Prescription Dosage", "name": "1-0-1", "dosage": "1-0-1","dosage_strength":
- [{"strength": "1.0","strength_time": "9:00:00"}, {"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "1-0-1",
+ "dosage": "1-0-1",
+ "dosage_strength": [
+ {"strength": "1.0", "strength_time": "9:00:00"},
+ {"strength": "1.0", "strength_time": "21:00:00"},
+ ],
},
- {"doctype": "Prescription Dosage", "name": "Once Bedtime", "dosage": "Once Bedtime","dosage_strength":
- [{"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "Once Bedtime",
+ "dosage": "Once Bedtime",
+ "dosage_strength": [{"strength": "1.0", "strength_time": "21:00:00"}],
},
- {"doctype": "Prescription Dosage", "name": "5 times a day", "dosage": "5 times a day","dosage_strength":
- [{"strength": "1.0","strength_time": "5:00:00"}, {"strength": "1.0","strength_time": "9:00:00"}, {"strength": "1.0","strength_time": "13:00:00"},{"strength": "1.0","strength_time": "17:00:00"},{"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "5 times a day",
+ "dosage": "5 times a day",
+ "dosage_strength": [
+ {"strength": "1.0", "strength_time": "5:00:00"},
+ {"strength": "1.0", "strength_time": "9:00:00"},
+ {"strength": "1.0", "strength_time": "13:00:00"},
+ {"strength": "1.0", "strength_time": "17:00:00"},
+ {"strength": "1.0", "strength_time": "21:00:00"},
+ ],
},
- {"doctype": "Prescription Dosage", "name": "QID", "dosage": "QID","dosage_strength":
- [{"strength": "1.0","strength_time": "9:00:00"}, {"strength": "1.0","strength_time": "13:00:00"},{"strength": "1.0","strength_time": "17:00:00"},{"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "QID",
+ "dosage": "QID",
+ "dosage_strength": [
+ {"strength": "1.0", "strength_time": "9:00:00"},
+ {"strength": "1.0", "strength_time": "13:00:00"},
+ {"strength": "1.0", "strength_time": "17:00:00"},
+ {"strength": "1.0", "strength_time": "21:00:00"},
+ ],
},
- {"doctype": "Prescription Dosage", "name": "TID", "dosage": "TID","dosage_strength":
- [{"strength": "1.0","strength_time": "9:00:00"}, {"strength": "1.0","strength_time": "14:00:00"},{"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "TID",
+ "dosage": "TID",
+ "dosage_strength": [
+ {"strength": "1.0", "strength_time": "9:00:00"},
+ {"strength": "1.0", "strength_time": "14:00:00"},
+ {"strength": "1.0", "strength_time": "21:00:00"},
+ ],
},
- {"doctype": "Prescription Dosage", "name": "BID", "dosage": "BID","dosage_strength":
- [{"strength": "1.0","strength_time": "9:00:00"}, {"strength": "1.0","strength_time": "21:00:00"}]
+ {
+ "doctype": "Prescription Dosage",
+ "name": "BID",
+ "dosage": "BID",
+ "dosage_strength": [
+ {"strength": "1.0", "strength_time": "9:00:00"},
+ {"strength": "1.0", "strength_time": "21:00:00"},
+ ],
+ },
+ {
+ "doctype": "Prescription Dosage",
+ "name": "Once Daily",
+ "dosage": "Once Daily",
+ "dosage_strength": [{"strength": "1.0", "strength_time": "9:00:00"}],
},
- {"doctype": "Prescription Dosage", "name": "Once Daily", "dosage": "Once Daily","dosage_strength":
- [{"strength": "1.0","strength_time": "9:00:00"}]
- }
]
insert_record(records)
+
def create_healthcare_item_groups():
records = [
- {'doctype': 'Item Group', 'item_group_name': _('Laboratory'),
- 'is_group': 0, 'parent_item_group': _('All Item Groups') },
- {'doctype': 'Item Group', 'item_group_name': _('Drug'),
- 'is_group': 0, 'parent_item_group': _('All Item Groups') }
+ {
+ "doctype": "Item Group",
+ "item_group_name": _("Laboratory"),
+ "is_group": 0,
+ "parent_item_group": _("All Item Groups"),
+ },
+ {
+ "doctype": "Item Group",
+ "item_group_name": _("Drug"),
+ "is_group": 0,
+ "parent_item_group": _("All Item Groups"),
+ },
]
insert_record(records)
+
def create_sensitivity():
records = [
{"doctype": "Sensitivity", "sensitivity": _("Low Sensitivity")},
@@ -191,21 +491,23 @@ def create_sensitivity():
{"doctype": "Sensitivity", "sensitivity": _("Moderate Sensitivity")},
{"doctype": "Sensitivity", "sensitivity": _("Susceptible")},
{"doctype": "Sensitivity", "sensitivity": _("Resistant")},
- {"doctype": "Sensitivity", "sensitivity": _("Intermediate")}
+ {"doctype": "Sensitivity", "sensitivity": _("Intermediate")},
]
insert_record(records)
+
def add_healthcare_service_unit_tree_root():
record = [
{
"doctype": "Healthcare Service Unit",
"healthcare_service_unit_name": "All Healthcare Service Units",
"is_group": 1,
- "company": get_company()
- }
+ "company": get_company(),
+ }
]
insert_record(record)
+
def get_company():
company = frappe.defaults.get_defaults().company
if company:
@@ -216,81 +518,108 @@ def get_company():
return company[0].name
return None
+
def setup_patient_history_settings():
import json
- settings = frappe.get_single('Patient History Settings')
+ settings = frappe.get_single("Patient History Settings")
configuration = get_patient_history_config()
for dt, config in configuration.items():
- settings.append("standard_doctypes", {
- "document_type": dt,
- "date_fieldname": config[0],
- "selected_fields": json.dumps(config[1])
- })
+ settings.append(
+ "standard_doctypes",
+ {"document_type": dt, "date_fieldname": config[0], "selected_fields": json.dumps(config[1])},
+ )
settings.save()
+
def get_patient_history_config():
return {
- "Patient Encounter": ("encounter_date", [
- {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
- {"label": "Symptoms", "fieldname": "symptoms", "fieldtype": "Table Multiselect"},
- {"label": "Diagnosis", "fieldname": "diagnosis", "fieldtype": "Table Multiselect"},
- {"label": "Drug Prescription", "fieldname": "drug_prescription", "fieldtype": "Table"},
- {"label": "Lab Tests", "fieldname": "lab_test_prescription", "fieldtype": "Table"},
- {"label": "Clinical Procedures", "fieldname": "procedure_prescription", "fieldtype": "Table"},
- {"label": "Therapies", "fieldname": "therapies", "fieldtype": "Table"},
- {"label": "Review Details", "fieldname": "encounter_comment", "fieldtype": "Small Text"}
- ]),
- "Clinical Procedure": ("start_date", [
- {"label": "Procedure Template", "fieldname": "procedure_template", "fieldtype": "Link"},
- {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
- {"label": "Notes", "fieldname": "notes", "fieldtype": "Small Text"},
- {"label": "Service Unit", "fieldname": "service_unit", "fieldtype": "Healthcare Service Unit"},
- {"label": "Start Time", "fieldname": "start_time", "fieldtype": "Time"},
- {"label": "Sample", "fieldname": "sample", "fieldtype": "Link"}
- ]),
- "Lab Test": ("result_date", [
- {"label": "Test Template", "fieldname": "template", "fieldtype": "Link"},
- {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
- {"label": "Test Name", "fieldname": "lab_test_name", "fieldtype": "Data"},
- {"label": "Lab Technician Name", "fieldname": "employee_name", "fieldtype": "Data"},
- {"label": "Sample ID", "fieldname": "sample", "fieldtype": "Link"},
- {"label": "Normal Test Result", "fieldname": "normal_test_items", "fieldtype": "Table"},
- {"label": "Descriptive Test Result", "fieldname": "descriptive_test_items", "fieldtype": "Table"},
- {"label": "Organism Test Result", "fieldname": "organism_test_items", "fieldtype": "Table"},
- {"label": "Sensitivity Test Result", "fieldname": "sensitivity_test_items", "fieldtype": "Table"},
- {"label": "Comments", "fieldname": "lab_test_comment", "fieldtype": "Table"}
- ]),
- "Therapy Session": ("start_date", [
- {"label": "Therapy Type", "fieldname": "therapy_type", "fieldtype": "Link"},
- {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
- {"label": "Therapy Plan", "fieldname": "therapy_plan", "fieldtype": "Link"},
- {"label": "Duration", "fieldname": "duration", "fieldtype": "Int"},
- {"label": "Location", "fieldname": "location", "fieldtype": "Link"},
- {"label": "Healthcare Service Unit", "fieldname": "service_unit", "fieldtype": "Link"},
- {"label": "Start Time", "fieldname": "start_time", "fieldtype": "Time"},
- {"label": "Exercises", "fieldname": "exercises", "fieldtype": "Table"},
- {"label": "Total Counts Targeted", "fieldname": "total_counts_targeted", "fieldtype": "Int"},
- {"label": "Total Counts Completed", "fieldname": "total_counts_completed", "fieldtype": "Int"}
- ]),
- "Vital Signs": ("signs_date", [
- {"label": "Body Temperature", "fieldname": "temperature", "fieldtype": "Data"},
- {"label": "Heart Rate / Pulse", "fieldname": "pulse", "fieldtype": "Data"},
- {"label": "Respiratory rate", "fieldname": "respiratory_rate", "fieldtype": "Data"},
- {"label": "Tongue", "fieldname": "tongue", "fieldtype": "Select"},
- {"label": "Abdomen", "fieldname": "abdomen", "fieldtype": "Select"},
- {"label": "Reflexes", "fieldname": "reflexes", "fieldtype": "Select"},
- {"label": "Blood Pressure", "fieldname": "bp", "fieldtype": "Data"},
- {"label": "Notes", "fieldname": "vital_signs_note", "fieldtype": "Small Text"},
- {"label": "Height (In Meter)", "fieldname": "height", "fieldtype": "Float"},
- {"label": "Weight (In Kilogram)", "fieldname": "weight", "fieldtype": "Float"},
- {"label": "BMI", "fieldname": "bmi", "fieldtype": "Float"}
- ]),
- "Inpatient Medication Order": ("start_date", [
- {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
- {"label": "Start Date", "fieldname": "start_date", "fieldtype": "Date"},
- {"label": "End Date", "fieldname": "end_date", "fieldtype": "Date"},
- {"label": "Medication Orders", "fieldname": "medication_orders", "fieldtype": "Table"},
- {"label": "Total Orders", "fieldname": "total_orders", "fieldtype": "Float"}
- ])
+ "Patient Encounter": (
+ "encounter_date",
+ [
+ {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
+ {"label": "Symptoms", "fieldname": "symptoms", "fieldtype": "Table Multiselect"},
+ {"label": "Diagnosis", "fieldname": "diagnosis", "fieldtype": "Table Multiselect"},
+ {"label": "Drug Prescription", "fieldname": "drug_prescription", "fieldtype": "Table"},
+ {"label": "Lab Tests", "fieldname": "lab_test_prescription", "fieldtype": "Table"},
+ {"label": "Clinical Procedures", "fieldname": "procedure_prescription", "fieldtype": "Table"},
+ {"label": "Therapies", "fieldname": "therapies", "fieldtype": "Table"},
+ {"label": "Review Details", "fieldname": "encounter_comment", "fieldtype": "Small Text"},
+ ],
+ ),
+ "Clinical Procedure": (
+ "start_date",
+ [
+ {"label": "Procedure Template", "fieldname": "procedure_template", "fieldtype": "Link"},
+ {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
+ {"label": "Notes", "fieldname": "notes", "fieldtype": "Small Text"},
+ {"label": "Service Unit", "fieldname": "service_unit", "fieldtype": "Healthcare Service Unit"},
+ {"label": "Start Time", "fieldname": "start_time", "fieldtype": "Time"},
+ {"label": "Sample", "fieldname": "sample", "fieldtype": "Link"},
+ ],
+ ),
+ "Lab Test": (
+ "result_date",
+ [
+ {"label": "Test Template", "fieldname": "template", "fieldtype": "Link"},
+ {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
+ {"label": "Test Name", "fieldname": "lab_test_name", "fieldtype": "Data"},
+ {"label": "Lab Technician Name", "fieldname": "employee_name", "fieldtype": "Data"},
+ {"label": "Sample ID", "fieldname": "sample", "fieldtype": "Link"},
+ {"label": "Normal Test Result", "fieldname": "normal_test_items", "fieldtype": "Table"},
+ {
+ "label": "Descriptive Test Result",
+ "fieldname": "descriptive_test_items",
+ "fieldtype": "Table",
+ },
+ {"label": "Organism Test Result", "fieldname": "organism_test_items", "fieldtype": "Table"},
+ {
+ "label": "Sensitivity Test Result",
+ "fieldname": "sensitivity_test_items",
+ "fieldtype": "Table",
+ },
+ {"label": "Comments", "fieldname": "lab_test_comment", "fieldtype": "Table"},
+ ],
+ ),
+ "Therapy Session": (
+ "start_date",
+ [
+ {"label": "Therapy Type", "fieldname": "therapy_type", "fieldtype": "Link"},
+ {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
+ {"label": "Therapy Plan", "fieldname": "therapy_plan", "fieldtype": "Link"},
+ {"label": "Duration", "fieldname": "duration", "fieldtype": "Int"},
+ {"label": "Location", "fieldname": "location", "fieldtype": "Link"},
+ {"label": "Healthcare Service Unit", "fieldname": "service_unit", "fieldtype": "Link"},
+ {"label": "Start Time", "fieldname": "start_time", "fieldtype": "Time"},
+ {"label": "Exercises", "fieldname": "exercises", "fieldtype": "Table"},
+ {"label": "Total Counts Targeted", "fieldname": "total_counts_targeted", "fieldtype": "Int"},
+ {"label": "Total Counts Completed", "fieldname": "total_counts_completed", "fieldtype": "Int"},
+ ],
+ ),
+ "Vital Signs": (
+ "signs_date",
+ [
+ {"label": "Body Temperature", "fieldname": "temperature", "fieldtype": "Data"},
+ {"label": "Heart Rate / Pulse", "fieldname": "pulse", "fieldtype": "Data"},
+ {"label": "Respiratory rate", "fieldname": "respiratory_rate", "fieldtype": "Data"},
+ {"label": "Tongue", "fieldname": "tongue", "fieldtype": "Select"},
+ {"label": "Abdomen", "fieldname": "abdomen", "fieldtype": "Select"},
+ {"label": "Reflexes", "fieldname": "reflexes", "fieldtype": "Select"},
+ {"label": "Blood Pressure", "fieldname": "bp", "fieldtype": "Data"},
+ {"label": "Notes", "fieldname": "vital_signs_note", "fieldtype": "Small Text"},
+ {"label": "Height (In Meter)", "fieldname": "height", "fieldtype": "Float"},
+ {"label": "Weight (In Kilogram)", "fieldname": "weight", "fieldtype": "Float"},
+ {"label": "BMI", "fieldname": "bmi", "fieldtype": "Float"},
+ ],
+ ),
+ "Inpatient Medication Order": (
+ "start_date",
+ [
+ {"label": "Healthcare Practitioner", "fieldname": "practitioner", "fieldtype": "Link"},
+ {"label": "Start Date", "fieldname": "start_date", "fieldtype": "Date"},
+ {"label": "End Date", "fieldname": "end_date", "fieldtype": "Date"},
+ {"label": "Medication Orders", "fieldname": "medication_orders", "fieldtype": "Table"},
+ {"label": "Total Orders", "fieldname": "total_orders", "fieldtype": "Float"},
+ ],
+ ),
}
diff --git a/erpnext/healthcare/utils.py b/erpnext/healthcare/utils.py
index 99f06bf6c81..52f31cddb0b 100644
--- a/erpnext/healthcare/utils.py
+++ b/erpnext/healthcare/utils.py
@@ -17,7 +17,7 @@ from erpnext.healthcare.doctype.lab_test.lab_test import create_multiple
@frappe.whitelist()
def get_healthcare_services_to_invoice(patient, company):
- patient = frappe.get_doc('Patient', patient)
+ patient = frappe.get_doc("Patient", patient)
items_to_invoice = []
if patient:
validate_customer_created(patient)
@@ -34,50 +34,62 @@ def get_healthcare_services_to_invoice(patient, company):
def validate_customer_created(patient):
- if not frappe.db.get_value('Patient', patient.name, 'customer'):
+ if not frappe.db.get_value("Patient", patient.name, "customer"):
msg = _("Please set a Customer linked to the Patient")
- msg += " {0}".format(patient.name)
- frappe.throw(msg, title=_('Customer Not Found'))
+ msg += " {0}".format(patient.name)
+ frappe.throw(msg, title=_("Customer Not Found"))
def get_appointments_to_invoice(patient, company):
appointments_to_invoice = []
patient_appointments = frappe.get_list(
- 'Patient Appointment',
- fields = '*',
- filters = {'patient': patient.name, 'company': company, 'invoiced': 0, 'status': ['not in', 'Cancelled']},
- order_by = 'appointment_date'
- )
+ "Patient Appointment",
+ fields="*",
+ filters={
+ "patient": patient.name,
+ "company": company,
+ "invoiced": 0,
+ "status": ["not in", "Cancelled"],
+ },
+ order_by="appointment_date",
+ )
for appointment in patient_appointments:
# Procedure Appointments
if appointment.procedure_template:
- if frappe.db.get_value('Clinical Procedure Template', appointment.procedure_template, 'is_billable'):
- appointments_to_invoice.append({
- 'reference_type': 'Patient Appointment',
- 'reference_name': appointment.name,
- 'service': appointment.procedure_template
- })
+ if frappe.db.get_value(
+ "Clinical Procedure Template", appointment.procedure_template, "is_billable"
+ ):
+ appointments_to_invoice.append(
+ {
+ "reference_type": "Patient Appointment",
+ "reference_name": appointment.name,
+ "service": appointment.procedure_template,
+ }
+ )
# Consultation Appointments, should check fee validity
else:
- if frappe.db.get_single_value('Healthcare Settings', 'enable_free_follow_ups') and \
- frappe.db.exists('Fee Validity Reference', {'appointment': appointment.name}):
- continue # Skip invoicing, fee validty present
+ if frappe.db.get_single_value(
+ "Healthcare Settings", "enable_free_follow_ups"
+ ) and frappe.db.exists("Fee Validity Reference", {"appointment": appointment.name}):
+ continue # Skip invoicing, fee validty present
practitioner_charge = 0
income_account = None
service_item = None
if appointment.practitioner:
details = get_service_item_and_practitioner_charge(appointment)
- service_item = details.get('service_item')
- practitioner_charge = details.get('practitioner_charge')
+ service_item = details.get("service_item")
+ practitioner_charge = details.get("practitioner_charge")
income_account = get_income_account(appointment.practitioner, appointment.company)
- appointments_to_invoice.append({
- 'reference_type': 'Patient Appointment',
- 'reference_name': appointment.name,
- 'service': service_item,
- 'rate': practitioner_charge,
- 'income_account': income_account
- })
+ appointments_to_invoice.append(
+ {
+ "reference_type": "Patient Appointment",
+ "reference_name": appointment.name,
+ "service": service_item,
+ "rate": practitioner_charge,
+ "income_account": income_account,
+ }
+ )
return appointments_to_invoice
@@ -87,9 +99,9 @@ def get_encounters_to_invoice(patient, company):
patient = patient.name
encounters_to_invoice = []
encounters = frappe.get_list(
- 'Patient Encounter',
- fields=['*'],
- filters={'patient': patient, 'company': company, 'invoiced': False, 'docstatus': 1}
+ "Patient Encounter",
+ fields=["*"],
+ filters={"patient": patient, "company": company, "invoiced": False, "docstatus": 1},
)
if encounters:
for encounter in encounters:
@@ -98,22 +110,25 @@ def get_encounters_to_invoice(patient, company):
income_account = None
service_item = None
if encounter.practitioner:
- if encounter.inpatient_record and \
- frappe.db.get_single_value('Healthcare Settings', 'do_not_bill_inpatient_encounters'):
+ if encounter.inpatient_record and frappe.db.get_single_value(
+ "Healthcare Settings", "do_not_bill_inpatient_encounters"
+ ):
continue
details = get_service_item_and_practitioner_charge(encounter)
- service_item = details.get('service_item')
- practitioner_charge = details.get('practitioner_charge')
+ service_item = details.get("service_item")
+ practitioner_charge = details.get("practitioner_charge")
income_account = get_income_account(encounter.practitioner, encounter.company)
- encounters_to_invoice.append({
- 'reference_type': 'Patient Encounter',
- 'reference_name': encounter.name,
- 'service': service_item,
- 'rate': practitioner_charge,
- 'income_account': income_account
- })
+ encounters_to_invoice.append(
+ {
+ "reference_type": "Patient Encounter",
+ "reference_name": encounter.name,
+ "service": service_item,
+ "rate": practitioner_charge,
+ "income_account": income_account,
+ }
+ )
return encounters_to_invoice
@@ -121,21 +136,21 @@ def get_encounters_to_invoice(patient, company):
def get_lab_tests_to_invoice(patient, company):
lab_tests_to_invoice = []
lab_tests = frappe.get_list(
- 'Lab Test',
- fields=['name', 'template'],
- filters={'patient': patient.name, 'company': company, 'invoiced': False, 'docstatus': 1}
+ "Lab Test",
+ fields=["name", "template"],
+ filters={"patient": patient.name, "company": company, "invoiced": False, "docstatus": 1},
)
for lab_test in lab_tests:
- item, is_billable = frappe.get_cached_value('Lab Test Template', lab_test.template, ['item', 'is_billable'])
+ item, is_billable = frappe.get_cached_value(
+ "Lab Test Template", lab_test.template, ["item", "is_billable"]
+ )
if is_billable:
- lab_tests_to_invoice.append({
- 'reference_type': 'Lab Test',
- 'reference_name': lab_test.name,
- 'service': item
- })
+ lab_tests_to_invoice.append(
+ {"reference_type": "Lab Test", "reference_name": lab_test.name, "service": item}
+ )
lab_prescriptions = frappe.db.sql(
- '''
+ """
SELECT
lp.name, lp.lab_test_code
FROM
@@ -145,16 +160,19 @@ def get_lab_tests_to_invoice(patient, company):
and lp.parent=et.name
and lp.lab_test_created=0
and lp.invoiced=0
- ''', (patient.name), as_dict=1)
+ """,
+ (patient.name),
+ as_dict=1,
+ )
for prescription in lab_prescriptions:
- item, is_billable = frappe.get_cached_value('Lab Test Template', prescription.lab_test_code, ['item', 'is_billable'])
+ item, is_billable = frappe.get_cached_value(
+ "Lab Test Template", prescription.lab_test_code, ["item", "is_billable"]
+ )
if prescription.lab_test_code and is_billable:
- lab_tests_to_invoice.append({
- 'reference_type': 'Lab Prescription',
- 'reference_name': prescription.name,
- 'service': item
- })
+ lab_tests_to_invoice.append(
+ {"reference_type": "Lab Prescription", "reference_name": prescription.name, "service": item}
+ )
return lab_tests_to_invoice
@@ -162,40 +180,51 @@ def get_lab_tests_to_invoice(patient, company):
def get_clinical_procedures_to_invoice(patient, company):
clinical_procedures_to_invoice = []
procedures = frappe.get_list(
- 'Clinical Procedure',
- fields='*',
- filters={'patient': patient.name, 'company': company, 'invoiced': False}
+ "Clinical Procedure",
+ fields="*",
+ filters={"patient": patient.name, "company": company, "invoiced": False},
)
for procedure in procedures:
if not procedure.appointment:
- item, is_billable = frappe.get_cached_value('Clinical Procedure Template', procedure.procedure_template, ['item', 'is_billable'])
+ item, is_billable = frappe.get_cached_value(
+ "Clinical Procedure Template", procedure.procedure_template, ["item", "is_billable"]
+ )
if procedure.procedure_template and is_billable:
- clinical_procedures_to_invoice.append({
- 'reference_type': 'Clinical Procedure',
- 'reference_name': procedure.name,
- 'service': item
- })
+ clinical_procedures_to_invoice.append(
+ {"reference_type": "Clinical Procedure", "reference_name": procedure.name, "service": item}
+ )
# consumables
- if procedure.invoice_separately_as_consumables and procedure.consume_stock \
- and procedure.status == 'Completed' and not procedure.consumption_invoiced:
+ if (
+ procedure.invoice_separately_as_consumables
+ and procedure.consume_stock
+ and procedure.status == "Completed"
+ and not procedure.consumption_invoiced
+ ):
- service_item = frappe.db.get_single_value('Healthcare Settings', 'clinical_procedure_consumable_item')
+ service_item = frappe.db.get_single_value(
+ "Healthcare Settings", "clinical_procedure_consumable_item"
+ )
if not service_item:
- frappe.throw(_('Please configure Clinical Procedure Consumable Item in {0}').format(
- frappe.utils.get_link_to_form('Healthcare Settings', 'Healthcare Settings')),
- title=_('Missing Configuration'))
+ frappe.throw(
+ _("Please configure Clinical Procedure Consumable Item in {0}").format(
+ frappe.utils.get_link_to_form("Healthcare Settings", "Healthcare Settings")
+ ),
+ title=_("Missing Configuration"),
+ )
- clinical_procedures_to_invoice.append({
- 'reference_type': 'Clinical Procedure',
- 'reference_name': procedure.name,
- 'service': service_item,
- 'rate': procedure.consumable_total_amount,
- 'description': procedure.consumption_details
- })
+ clinical_procedures_to_invoice.append(
+ {
+ "reference_type": "Clinical Procedure",
+ "reference_name": procedure.name,
+ "service": service_item,
+ "rate": procedure.consumable_total_amount,
+ "description": procedure.consumption_details,
+ }
+ )
procedure_prescriptions = frappe.db.sql(
- '''
+ """
SELECT
pp.name, pp.procedure
FROM
@@ -206,16 +235,23 @@ def get_clinical_procedures_to_invoice(patient, company):
and pp.procedure_created=0
and pp.invoiced=0
and pp.appointment_booked=0
- ''', (patient.name), as_dict=1)
+ """,
+ (patient.name),
+ as_dict=1,
+ )
for prescription in procedure_prescriptions:
- item, is_billable = frappe.get_cached_value('Clinical Procedure Template', prescription.procedure, ['item', 'is_billable'])
+ item, is_billable = frappe.get_cached_value(
+ "Clinical Procedure Template", prescription.procedure, ["item", "is_billable"]
+ )
if is_billable:
- clinical_procedures_to_invoice.append({
- 'reference_type': 'Procedure Prescription',
- 'reference_name': prescription.name,
- 'service': item
- })
+ clinical_procedures_to_invoice.append(
+ {
+ "reference_type": "Procedure Prescription",
+ "reference_name": prescription.name,
+ "service": item,
+ }
+ )
return clinical_procedures_to_invoice
@@ -223,7 +259,7 @@ def get_clinical_procedures_to_invoice(patient, company):
def get_inpatient_services_to_invoice(patient, company):
services_to_invoice = []
inpatient_services = frappe.db.sql(
- '''
+ """
SELECT
io.*
FROM
@@ -234,11 +270,16 @@ def get_inpatient_services_to_invoice(patient, company):
and io.parent=ip.name
and io.left=1
and io.invoiced=0
- ''', (patient.name, company), as_dict=1)
+ """,
+ (patient.name, company),
+ as_dict=1,
+ )
for inpatient_occupancy in inpatient_services:
- service_unit_type = frappe.db.get_value('Healthcare Service Unit', inpatient_occupancy.service_unit, 'service_unit_type')
- service_unit_type = frappe.get_cached_doc('Healthcare Service Unit Type', service_unit_type)
+ service_unit_type = frappe.db.get_value(
+ "Healthcare Service Unit", inpatient_occupancy.service_unit, "service_unit_type"
+ )
+ service_unit_type = frappe.get_cached_doc("Healthcare Service Unit Type", service_unit_type)
if service_unit_type and service_unit_type.is_billable:
hours_occupied = time_diff_in_hours(inpatient_occupancy.check_out, inpatient_occupancy.check_in)
qty = 0.5
@@ -252,11 +293,14 @@ def get_inpatient_services_to_invoice(patient, company):
qty = rounded(floor + 0.5, 1)
if qty <= 0:
qty = 0.5
- services_to_invoice.append({
- 'reference_type': 'Inpatient Occupancy',
- 'reference_name': inpatient_occupancy.name,
- 'service': service_unit_type.item, 'qty': qty
- })
+ services_to_invoice.append(
+ {
+ "reference_type": "Inpatient Occupancy",
+ "reference_name": inpatient_occupancy.name,
+ "service": service_unit_type.item,
+ "qty": qty,
+ }
+ )
return services_to_invoice
@@ -264,53 +308,62 @@ def get_inpatient_services_to_invoice(patient, company):
def get_therapy_plans_to_invoice(patient, company):
therapy_plans_to_invoice = []
therapy_plans = frappe.get_list(
- 'Therapy Plan',
- fields=['therapy_plan_template', 'name'],
+ "Therapy Plan",
+ fields=["therapy_plan_template", "name"],
filters={
- 'patient': patient.name,
- 'invoiced': 0,
- 'company': company,
- 'therapy_plan_template': ('!=', '')
- }
+ "patient": patient.name,
+ "invoiced": 0,
+ "company": company,
+ "therapy_plan_template": ("!=", ""),
+ },
)
for plan in therapy_plans:
- therapy_plans_to_invoice.append({
- 'reference_type': 'Therapy Plan',
- 'reference_name': plan.name,
- 'service': frappe.db.get_value('Therapy Plan Template', plan.therapy_plan_template, 'linked_item')
- })
+ therapy_plans_to_invoice.append(
+ {
+ "reference_type": "Therapy Plan",
+ "reference_name": plan.name,
+ "service": frappe.db.get_value(
+ "Therapy Plan Template", plan.therapy_plan_template, "linked_item"
+ ),
+ }
+ )
return therapy_plans_to_invoice
def get_therapy_sessions_to_invoice(patient, company):
therapy_sessions_to_invoice = []
- therapy_plans = frappe.db.get_all('Therapy Plan', {'therapy_plan_template': ('!=', '')})
+ therapy_plans = frappe.db.get_all("Therapy Plan", {"therapy_plan_template": ("!=", "")})
therapy_plans_created_from_template = []
for entry in therapy_plans:
therapy_plans_created_from_template.append(entry.name)
therapy_sessions = frappe.get_list(
- 'Therapy Session',
- fields='*',
+ "Therapy Session",
+ fields="*",
filters={
- 'patient': patient.name,
- 'invoiced': 0,
- 'company': company,
- 'therapy_plan': ('not in', therapy_plans_created_from_template)
- }
+ "patient": patient.name,
+ "invoiced": 0,
+ "company": company,
+ "therapy_plan": ("not in", therapy_plans_created_from_template),
+ },
)
for therapy in therapy_sessions:
if not therapy.appointment:
- if therapy.therapy_type and frappe.db.get_value('Therapy Type', therapy.therapy_type, 'is_billable'):
- therapy_sessions_to_invoice.append({
- 'reference_type': 'Therapy Session',
- 'reference_name': therapy.name,
- 'service': frappe.db.get_value('Therapy Type', therapy.therapy_type, 'item')
- })
+ if therapy.therapy_type and frappe.db.get_value(
+ "Therapy Type", therapy.therapy_type, "is_billable"
+ ):
+ therapy_sessions_to_invoice.append(
+ {
+ "reference_type": "Therapy Session",
+ "reference_name": therapy.name,
+ "service": frappe.db.get_value("Therapy Type", therapy.therapy_type, "item"),
+ }
+ )
return therapy_sessions_to_invoice
+
@frappe.whitelist()
def get_service_item_and_practitioner_charge(doc):
if isinstance(doc, str):
@@ -319,12 +372,14 @@ def get_service_item_and_practitioner_charge(doc):
service_item = None
practitioner_charge = None
- department = doc.medical_department if doc.doctype == 'Patient Encounter' else doc.department
+ department = doc.medical_department if doc.doctype == "Patient Encounter" else doc.department
is_inpatient = doc.inpatient_record
- if doc.get('appointment_type'):
- service_item, practitioner_charge = get_appointment_type_service_item(doc.appointment_type, department, is_inpatient)
+ if doc.get("appointment_type"):
+ service_item, practitioner_charge = get_appointment_type_service_item(
+ doc.appointment_type, department, is_inpatient
+ )
if not service_item and not practitioner_charge:
service_item, practitioner_charge = get_practitioner_service_item(doc.practitioner, is_inpatient)
@@ -337,7 +392,7 @@ def get_service_item_and_practitioner_charge(doc):
if not practitioner_charge:
throw_config_practitioner_charge(is_inpatient, doc.practitioner)
- return {'service_item': service_item, 'practitioner_charge': practitioner_charge}
+ return {"service_item": service_item, "practitioner_charge": practitioner_charge}
def get_appointment_type_service_item(appointment_type, department, is_inpatient):
@@ -351,33 +406,37 @@ def get_appointment_type_service_item(appointment_type, department, is_inpatient
if item_list:
if is_inpatient:
- service_item = item_list.get('inpatient_visit_charge_item')
- practitioner_charge = item_list.get('inpatient_visit_charge')
+ service_item = item_list.get("inpatient_visit_charge_item")
+ practitioner_charge = item_list.get("inpatient_visit_charge")
else:
- service_item = item_list.get('op_consulting_charge_item')
- practitioner_charge = item_list.get('op_consulting_charge')
+ service_item = item_list.get("op_consulting_charge_item")
+ practitioner_charge = item_list.get("op_consulting_charge")
return service_item, practitioner_charge
def throw_config_service_item(is_inpatient):
- service_item_label = _('Out Patient Consulting Charge Item')
+ service_item_label = _("Out Patient Consulting Charge Item")
if is_inpatient:
- service_item_label = _('Inpatient Visit Charge Item')
+ service_item_label = _("Inpatient Visit Charge Item")
- msg = _(('Please Configure {0} in ').format(service_item_label) \
- + '''Healthcare Settings''')
- frappe.throw(msg, title=_('Missing Configuration'))
+ msg = _(
+ ("Please Configure {0} in ").format(service_item_label)
+ + """Healthcare Settings"""
+ )
+ frappe.throw(msg, title=_("Missing Configuration"))
def throw_config_practitioner_charge(is_inpatient, practitioner):
- charge_name = _('OP Consulting Charge')
+ charge_name = _("OP Consulting Charge")
if is_inpatient:
- charge_name = _('Inpatient Visit Charge')
+ charge_name = _("Inpatient Visit Charge")
- msg = _(('Please Configure {0} for Healthcare Practitioner').format(charge_name) \
- + ''' {0}'''.format(practitioner))
- frappe.throw(msg, title=_('Missing Configuration'))
+ msg = _(
+ ("Please Configure {0} for Healthcare Practitioner").format(charge_name)
+ + """ {0}""".format(practitioner)
+ )
+ frappe.throw(msg, title=_("Missing Configuration"))
def get_practitioner_service_item(practitioner, is_inpatient):
@@ -385,9 +444,15 @@ def get_practitioner_service_item(practitioner, is_inpatient):
practitioner_charge = None
if is_inpatient:
- service_item, practitioner_charge = frappe.db.get_value('Healthcare Practitioner', practitioner, ['inpatient_visit_charge_item', 'inpatient_visit_charge'])
+ service_item, practitioner_charge = frappe.db.get_value(
+ "Healthcare Practitioner",
+ practitioner,
+ ["inpatient_visit_charge_item", "inpatient_visit_charge"],
+ )
else:
- service_item, practitioner_charge = frappe.db.get_value('Healthcare Practitioner', practitioner, ['op_consulting_charge_item', 'op_consulting_charge'])
+ service_item, practitioner_charge = frappe.db.get_value(
+ "Healthcare Practitioner", practitioner, ["op_consulting_charge_item", "op_consulting_charge"]
+ )
return service_item, practitioner_charge
@@ -396,18 +461,22 @@ def get_healthcare_service_item(is_inpatient):
service_item = None
if is_inpatient:
- service_item = frappe.db.get_single_value('Healthcare Settings', 'inpatient_visit_charge_item')
+ service_item = frappe.db.get_single_value("Healthcare Settings", "inpatient_visit_charge_item")
else:
- service_item = frappe.db.get_single_value('Healthcare Settings', 'op_consulting_charge_item')
+ service_item = frappe.db.get_single_value("Healthcare Settings", "op_consulting_charge_item")
return service_item
def get_practitioner_charge(practitioner, is_inpatient):
if is_inpatient:
- practitioner_charge = frappe.db.get_value('Healthcare Practitioner', practitioner, 'inpatient_visit_charge')
+ practitioner_charge = frappe.db.get_value(
+ "Healthcare Practitioner", practitioner, "inpatient_visit_charge"
+ )
else:
- practitioner_charge = frappe.db.get_value('Healthcare Practitioner', practitioner, 'op_consulting_charge')
+ practitioner_charge = frappe.db.get_value(
+ "Healthcare Practitioner", practitioner, "op_consulting_charge"
+ )
if practitioner_charge:
return practitioner_charge
return False
@@ -416,75 +485,92 @@ def get_practitioner_charge(practitioner, is_inpatient):
def manage_invoice_submit_cancel(doc, method):
if doc.items:
for item in doc.items:
- if item.get('reference_dt') and item.get('reference_dn'):
- if frappe.get_meta(item.reference_dt).has_field('invoiced'):
+ if item.get("reference_dt") and item.get("reference_dn"):
+ if frappe.get_meta(item.reference_dt).has_field("invoiced"):
set_invoiced(item, method, doc.name)
- if method=='on_submit' and frappe.db.get_single_value('Healthcare Settings', 'create_lab_test_on_si_submit'):
- create_multiple('Sales Invoice', doc.name)
+ if method == "on_submit" and frappe.db.get_single_value(
+ "Healthcare Settings", "create_lab_test_on_si_submit"
+ ):
+ create_multiple("Sales Invoice", doc.name)
def set_invoiced(item, method, ref_invoice=None):
invoiced = False
- if method=='on_submit':
+ if method == "on_submit":
validate_invoiced_on_submit(item)
invoiced = True
- if item.reference_dt == 'Clinical Procedure':
- service_item = frappe.db.get_single_value('Healthcare Settings', 'clinical_procedure_consumable_item')
+ if item.reference_dt == "Clinical Procedure":
+ service_item = frappe.db.get_single_value(
+ "Healthcare Settings", "clinical_procedure_consumable_item"
+ )
if service_item == item.item_code:
- frappe.db.set_value(item.reference_dt, item.reference_dn, 'consumption_invoiced', invoiced)
+ frappe.db.set_value(item.reference_dt, item.reference_dn, "consumption_invoiced", invoiced)
else:
- frappe.db.set_value(item.reference_dt, item.reference_dn, 'invoiced', invoiced)
+ frappe.db.set_value(item.reference_dt, item.reference_dn, "invoiced", invoiced)
else:
- frappe.db.set_value(item.reference_dt, item.reference_dn, 'invoiced', invoiced)
+ frappe.db.set_value(item.reference_dt, item.reference_dn, "invoiced", invoiced)
- if item.reference_dt == 'Patient Appointment':
- if frappe.db.get_value('Patient Appointment', item.reference_dn, 'procedure_template'):
- dt_from_appointment = 'Clinical Procedure'
+ if item.reference_dt == "Patient Appointment":
+ if frappe.db.get_value("Patient Appointment", item.reference_dn, "procedure_template"):
+ dt_from_appointment = "Clinical Procedure"
else:
- dt_from_appointment = 'Patient Encounter'
+ dt_from_appointment = "Patient Encounter"
manage_doc_for_appointment(dt_from_appointment, item.reference_dn, invoiced)
- elif item.reference_dt == 'Lab Prescription':
- manage_prescriptions(invoiced, item.reference_dt, item.reference_dn, 'Lab Test', 'lab_test_created')
+ elif item.reference_dt == "Lab Prescription":
+ manage_prescriptions(
+ invoiced, item.reference_dt, item.reference_dn, "Lab Test", "lab_test_created"
+ )
- elif item.reference_dt == 'Procedure Prescription':
- manage_prescriptions(invoiced, item.reference_dt, item.reference_dn, 'Clinical Procedure', 'procedure_created')
+ elif item.reference_dt == "Procedure Prescription":
+ manage_prescriptions(
+ invoiced, item.reference_dt, item.reference_dn, "Clinical Procedure", "procedure_created"
+ )
def validate_invoiced_on_submit(item):
- if item.reference_dt == 'Clinical Procedure' and \
- frappe.db.get_single_value('Healthcare Settings', 'clinical_procedure_consumable_item') == item.item_code:
- is_invoiced = frappe.db.get_value(item.reference_dt, item.reference_dn, 'consumption_invoiced')
+ if (
+ item.reference_dt == "Clinical Procedure"
+ and frappe.db.get_single_value("Healthcare Settings", "clinical_procedure_consumable_item")
+ == item.item_code
+ ):
+ is_invoiced = frappe.db.get_value(item.reference_dt, item.reference_dn, "consumption_invoiced")
else:
- is_invoiced = frappe.db.get_value(item.reference_dt, item.reference_dn, 'invoiced')
+ is_invoiced = frappe.db.get_value(item.reference_dt, item.reference_dn, "invoiced")
if is_invoiced:
- frappe.throw(_('The item referenced by {0} - {1} is already invoiced').format(
- item.reference_dt, item.reference_dn))
+ frappe.throw(
+ _("The item referenced by {0} - {1} is already invoiced").format(
+ item.reference_dt, item.reference_dn
+ )
+ )
def manage_prescriptions(invoiced, ref_dt, ref_dn, dt, created_check_field):
created = frappe.db.get_value(ref_dt, ref_dn, created_check_field)
if created:
# Fetch the doc created for the prescription
- doc_created = frappe.db.get_value(dt, {'prescription': ref_dn})
- frappe.db.set_value(dt, doc_created, 'invoiced', invoiced)
+ doc_created = frappe.db.get_value(dt, {"prescription": ref_dn})
+ frappe.db.set_value(dt, doc_created, "invoiced", invoiced)
def check_fee_validity(appointment):
- if not frappe.db.get_single_value('Healthcare Settings', 'enable_free_follow_ups'):
+ if not frappe.db.get_single_value("Healthcare Settings", "enable_free_follow_ups"):
return
- validity = frappe.db.exists('Fee Validity', {
- 'practitioner': appointment.practitioner,
- 'patient': appointment.patient,
- 'valid_till': ('>=', appointment.appointment_date)
- })
+ validity = frappe.db.exists(
+ "Fee Validity",
+ {
+ "practitioner": appointment.practitioner,
+ "patient": appointment.patient,
+ "valid_till": (">=", appointment.appointment_date),
+ },
+ )
if not validity:
return
- validity = frappe.get_doc('Fee Validity', validity)
+ validity = frappe.get_doc("Fee Validity", validity)
return validity
@@ -492,16 +578,14 @@ def manage_fee_validity(appointment):
fee_validity = check_fee_validity(appointment)
if fee_validity:
- if appointment.status == 'Cancelled' and fee_validity.visited > 0:
+ if appointment.status == "Cancelled" and fee_validity.visited > 0:
fee_validity.visited -= 1
- frappe.db.delete('Fee Validity Reference', {'appointment': appointment.name})
- elif fee_validity.status == 'Completed':
+ frappe.db.delete("Fee Validity Reference", {"appointment": appointment.name})
+ elif fee_validity.status == "Completed":
return
else:
fee_validity.visited += 1
- fee_validity.append('ref_appointments', {
- 'appointment': appointment.name
- })
+ fee_validity.append("ref_appointments", {"appointment": appointment.name})
fee_validity.save(ignore_permissions=True)
else:
fee_validity = create_fee_validity(appointment)
@@ -510,36 +594,33 @@ def manage_fee_validity(appointment):
def manage_doc_for_appointment(dt_from_appointment, appointment, invoiced):
dn_from_appointment = frappe.db.get_value(
- dt_from_appointment,
- filters={'appointment': appointment}
+ dt_from_appointment, filters={"appointment": appointment}
)
if dn_from_appointment:
- frappe.db.set_value(dt_from_appointment, dn_from_appointment, 'invoiced', invoiced)
+ frappe.db.set_value(dt_from_appointment, dn_from_appointment, "invoiced", invoiced)
@frappe.whitelist()
def get_drugs_to_invoice(encounter):
- encounter = frappe.get_doc('Patient Encounter', encounter)
+ encounter = frappe.get_doc("Patient Encounter", encounter)
if encounter:
- patient = frappe.get_doc('Patient', encounter.patient)
+ patient = frappe.get_doc("Patient", encounter.patient)
if patient:
if patient.customer:
items_to_invoice = []
for drug_line in encounter.drug_prescription:
if drug_line.drug_code:
qty = 1
- if frappe.db.get_value('Item', drug_line.drug_code, 'stock_uom') == 'Nos':
+ if frappe.db.get_value("Item", drug_line.drug_code, "stock_uom") == "Nos":
qty = drug_line.get_quantity()
- description = ''
+ description = ""
if drug_line.dosage and drug_line.period:
- description = _('{0} for {1}').format(drug_line.dosage, drug_line.period)
+ description = _("{0} for {1}").format(drug_line.dosage, drug_line.period)
- items_to_invoice.append({
- 'drug_code': drug_line.drug_code,
- 'quantity': qty,
- 'description': description
- })
+ items_to_invoice.append(
+ {"drug_code": drug_line.drug_code, "quantity": qty, "description": description}
+ )
return items_to_invoice
else:
validate_customer_created(patient)
@@ -547,52 +628,56 @@ def get_drugs_to_invoice(encounter):
@frappe.whitelist()
def get_children(doctype, parent=None, company=None, is_root=False):
- parent_fieldname = 'parent_' + doctype.lower().replace(' ', '_')
- fields = [
- 'name as value',
- 'is_group as expandable',
- 'lft',
- 'rgt'
- ]
+ parent_fieldname = "parent_" + doctype.lower().replace(" ", "_")
+ fields = ["name as value", "is_group as expandable", "lft", "rgt"]
- filters = [["ifnull(`{0}`,'')".format(parent_fieldname),
- '=', '' if is_root else parent]]
+ filters = [["ifnull(`{0}`,'')".format(parent_fieldname), "=", "" if is_root else parent]]
if is_root:
- fields += ['service_unit_type'] if doctype == 'Healthcare Service Unit' else []
- filters.append(['company', '=', company])
+ fields += ["service_unit_type"] if doctype == "Healthcare Service Unit" else []
+ filters.append(["company", "=", company])
else:
- fields += ['service_unit_type', 'allow_appointments', 'inpatient_occupancy',
- 'occupancy_status'] if doctype == 'Healthcare Service Unit' else []
- fields += [parent_fieldname + ' as parent']
+ fields += (
+ ["service_unit_type", "allow_appointments", "inpatient_occupancy", "occupancy_status"]
+ if doctype == "Healthcare Service Unit"
+ else []
+ )
+ fields += [parent_fieldname + " as parent"]
service_units = frappe.get_list(doctype, fields=fields, filters=filters)
for each in service_units:
- if each['expandable'] == 1: # group node
- available_count = frappe.db.count('Healthcare Service Unit', filters={
- 'parent_healthcare_service_unit': each['value'],
- 'inpatient_occupancy': 1})
+ if each["expandable"] == 1: # group node
+ available_count = frappe.db.count(
+ "Healthcare Service Unit",
+ filters={"parent_healthcare_service_unit": each["value"], "inpatient_occupancy": 1},
+ )
if available_count > 0:
- occupied_count = frappe.db.count('Healthcare Service Unit', {
- 'parent_healthcare_service_unit': each['value'],
- 'inpatient_occupancy': 1,
- 'occupancy_status': 'Occupied'})
+ occupied_count = frappe.db.count(
+ "Healthcare Service Unit",
+ {
+ "parent_healthcare_service_unit": each["value"],
+ "inpatient_occupancy": 1,
+ "occupancy_status": "Occupied",
+ },
+ )
# set occupancy status of group node
- each['occupied_of_available'] = str(
- occupied_count) + ' Occupied of ' + str(available_count)
+ each["occupied_of_available"] = str(occupied_count) + " Occupied of " + str(available_count)
return service_units
@frappe.whitelist()
def get_patient_vitals(patient, from_date=None, to_date=None):
- if not patient: return
+ if not patient:
+ return
- vitals = frappe.db.get_all('Vital Signs', filters={
- 'docstatus': 1,
- 'patient': patient
- }, order_by='signs_date, signs_time', fields=['*'])
+ vitals = frappe.db.get_all(
+ "Vital Signs",
+ filters={"docstatus": 1, "patient": patient},
+ order_by="signs_date, signs_time",
+ fields=["*"],
+ )
if len(vitals):
return vitals
@@ -604,14 +689,14 @@ def render_docs_as_html(docs):
# docs key value pair {doctype: docname}
docs_html = "
- """.format(section_label, section_html, html)
+ """.format(
+ section_label, section_html, html
+ )
# close divs for columns
while col_on:
@@ -672,7 +759,9 @@ def render_doc_as_html(doctype, docname, exclude_fields = None):
+ ${slot_info.practitioner_name}
+ ${__('Schedule:')} ${slot_info.slot_name}
${__('Service Unit:')} ${slot_info.service_unit} `; if (slot_info.service_unit_capacity) { diff --git a/erpnext/healthcare/doctype/patient_appointment/patient_appointment.py b/erpnext/healthcare/doctype/patient_appointment/patient_appointment.py index 1e4608f84e0..0d98fff04ff 100755 --- a/erpnext/healthcare/doctype/patient_appointment/patient_appointment.py +++ b/erpnext/healthcare/doctype/patient_appointment/patient_appointment.py @@ -12,6 +12,7 @@ from frappe.model.document import Document from frappe.model.mapper import get_mapped_doc from frappe.utils import flt, get_link_to_form, get_time, getdate +from erpnext import get_company_currency from erpnext.healthcare.doctype.healthcare_settings.healthcare_settings import ( get_income_account, get_receivable_account, @@ -26,9 +27,12 @@ from erpnext.hr.doctype.employee.employee import is_holiday class MaximumCapacityError(frappe.ValidationError): pass + + class OverlapError(frappe.ValidationError): pass + class PatientAppointment(Document): def validate(self): self.validate_overlaps() @@ -46,8 +50,9 @@ class PatientAppointment(Document): send_confirmation_msg(self) def set_title(self): - self.title = _('{0} with {1}').format(self.patient_name or self.patient, - self.practitioner_name or self.practitioner) + self.title = _("{0} with {1}").format( + self.patient_name or self.patient, self.practitioner_name or self.practitioner + ) def set_status(self): today = getdate() @@ -55,16 +60,18 @@ class PatientAppointment(Document): # If appointment is created for today set status as Open else Scheduled if appointment_date == today: - self.status = 'Open' + self.status = "Open" elif appointment_date > today: - self.status = 'Scheduled' + self.status = "Scheduled" def validate_overlaps(self): - end_time = datetime.datetime.combine(getdate(self.appointment_date), get_time(self.appointment_time)) \ - + datetime.timedelta(minutes=flt(self.duration)) + end_time = datetime.datetime.combine( + getdate(self.appointment_date), get_time(self.appointment_time) + ) + datetime.timedelta(minutes=flt(self.duration)) # all appointments for both patient and practitioner overlapping the duration of this appointment - overlapping_appointments = frappe.db.sql(""" + overlapping_appointments = frappe.db.sql( + """ SELECT name, practitioner, patient, appointment_time, duration, service_unit FROM @@ -77,35 +84,52 @@ class PatientAppointment(Document): (appointment_time=%(appointment_time)s)) """, { - 'appointment_date': self.appointment_date, - 'name': self.name, - 'practitioner': self.practitioner, - 'patient': self.patient, - 'appointment_time': self.appointment_time, - 'end_time':end_time.time() + "appointment_date": self.appointment_date, + "name": self.name, + "practitioner": self.practitioner, + "patient": self.patient, + "appointment_time": self.appointment_time, + "end_time": end_time.time(), }, - as_dict = True + as_dict=True, ) if not overlapping_appointments: - return # No overlaps, nothing to validate! + return # No overlaps, nothing to validate! - if self.service_unit: # validate service unit capacity if overlap enabled - allow_overlap, service_unit_capacity = frappe.get_value('Healthcare Service Unit', self.service_unit, - ['overlap_appointments', 'service_unit_capacity']) + if self.service_unit: # validate service unit capacity if overlap enabled + allow_overlap, service_unit_capacity = frappe.get_value( + "Healthcare Service Unit", self.service_unit, ["overlap_appointments", "service_unit_capacity"] + ) if allow_overlap: - service_unit_appointments = list(filter(lambda appointment: appointment['service_unit'] == self.service_unit and - appointment['patient'] != self.patient, overlapping_appointments)) # if same patient already booked, it should be an overlap + service_unit_appointments = list( + filter( + lambda appointment: appointment["service_unit"] == self.service_unit + and appointment["patient"] != self.patient, + overlapping_appointments, + ) + ) # if same patient already booked, it should be an overlap if len(service_unit_appointments) >= (service_unit_capacity or 1): - frappe.throw(_("Not allowed, {} cannot exceed maximum capacity {}") - .format(frappe.bold(self.service_unit), frappe.bold(service_unit_capacity or 1)), MaximumCapacityError) - else: # service_unit_appointments within capacity, remove from overlapping_appointments - overlapping_appointments = [appointment for appointment in overlapping_appointments if appointment not in service_unit_appointments] + frappe.throw( + _("Not allowed, {} cannot exceed maximum capacity {}").format( + frappe.bold(self.service_unit), frappe.bold(service_unit_capacity or 1) + ), + MaximumCapacityError, + ) + else: # service_unit_appointments within capacity, remove from overlapping_appointments + overlapping_appointments = [ + appointment + for appointment in overlapping_appointments + if appointment not in service_unit_appointments + ] if overlapping_appointments: - frappe.throw(_("Not allowed, cannot overlap appointment {}") - .format(frappe.bold(', '.join([appointment['name'] for appointment in overlapping_appointments]))), OverlapError) - + frappe.throw( + _("Not allowed, cannot overlap appointment {}").format( + frappe.bold(", ".join([appointment["name"] for appointment in overlapping_appointments])) + ), + OverlapError, + ) def validate_service_unit(self): if self.inpatient_record and self.service_unit: @@ -113,48 +137,65 @@ class PatientAppointment(Document): get_current_healthcare_service_unit, ) - is_inpatient_occupancy_unit = frappe.db.get_value('Healthcare Service Unit', self.service_unit, - 'inpatient_occupancy') + is_inpatient_occupancy_unit = frappe.db.get_value( + "Healthcare Service Unit", self.service_unit, "inpatient_occupancy" + ) service_unit = get_current_healthcare_service_unit(self.inpatient_record) if is_inpatient_occupancy_unit and service_unit != self.service_unit: - msg = _('Patient {0} is not admitted in the service unit {1}').format(frappe.bold(self.patient), frappe.bold(self.service_unit)) + '
' - msg += _('Appointment for service units with Inpatient Occupancy can only be created against the unit where patient has been admitted.') - frappe.throw(msg, title=_('Invalid Healthcare Service Unit')) - + msg = ( + _("Patient {0} is not admitted in the service unit {1}").format( + frappe.bold(self.patient), frappe.bold(self.service_unit) + ) + + "
" + ) + msg += _( + "Appointment for service units with Inpatient Occupancy can only be created against the unit where patient has been admitted." + ) + frappe.throw(msg, title=_("Invalid Healthcare Service Unit")) def set_appointment_datetime(self): - self.appointment_datetime = "%s %s" % (self.appointment_date, self.appointment_time or "00:00:00") + self.appointment_datetime = "%s %s" % ( + self.appointment_date, + self.appointment_time or "00:00:00", + ) def set_payment_details(self): - if frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing'): + if frappe.db.get_single_value("Healthcare Settings", "automate_appointment_invoicing"): details = get_service_item_and_practitioner_charge(self) - self.db_set('billing_item', details.get('service_item')) + self.db_set("billing_item", details.get("service_item")) if not self.paid_amount: - self.db_set('paid_amount', details.get('practitioner_charge')) + self.db_set("paid_amount", details.get("practitioner_charge")) def validate_customer_created(self): - if frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing'): - if not frappe.db.get_value('Patient', self.patient, 'customer'): + if frappe.db.get_single_value("Healthcare Settings", "automate_appointment_invoicing"): + if not frappe.db.get_value("Patient", self.patient, "customer"): msg = _("Please set a Customer linked to the Patient") - msg += " {0}".format(self.patient) - frappe.throw(msg, title=_('Customer Not Found')) + msg += " {0}".format(self.patient) + frappe.throw(msg, title=_("Customer Not Found")) def update_prescription_details(self): if self.procedure_prescription: - frappe.db.set_value('Procedure Prescription', self.procedure_prescription, 'appointment_booked', 1) + frappe.db.set_value( + "Procedure Prescription", self.procedure_prescription, "appointment_booked", 1 + ) if self.procedure_template: - comments = frappe.db.get_value('Procedure Prescription', self.procedure_prescription, 'comments') + comments = frappe.db.get_value( + "Procedure Prescription", self.procedure_prescription, "comments" + ) if comments: - frappe.db.set_value('Patient Appointment', self.name, 'notes', comments) + frappe.db.set_value("Patient Appointment", self.name, "notes", comments) def update_fee_validity(self): - if not frappe.db.get_single_value('Healthcare Settings', 'enable_free_follow_ups'): + if not frappe.db.get_single_value("Healthcare Settings", "enable_free_follow_ups"): return fee_validity = manage_fee_validity(self) if fee_validity: - frappe.msgprint(_('{0}: {1} has fee validity till {2}').format(self.patient, - frappe.bold(self.patient_name), fee_validity.valid_till)) + frappe.msgprint( + _("{0}: {1} has fee validity till {2}").format( + self.patient, frappe.bold(self.patient_name), fee_validity.valid_till + ) + ) @frappe.whitelist() def get_therapy_types(self): @@ -162,7 +203,7 @@ class PatientAppointment(Document): return therapy_types = [] - doc = frappe.get_doc('Therapy Plan', self.therapy_plan) + doc = frappe.get_doc("Therapy Plan", self.therapy_plan) for entry in doc.therapy_plan_details: therapy_types.append(entry.therapy_type) @@ -171,26 +212,35 @@ class PatientAppointment(Document): @frappe.whitelist() def check_payment_fields_reqd(patient): - automate_invoicing = frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing') - free_follow_ups = frappe.db.get_single_value('Healthcare Settings', 'enable_free_follow_ups') + automate_invoicing = frappe.db.get_single_value( + "Healthcare Settings", "automate_appointment_invoicing" + ) + free_follow_ups = frappe.db.get_single_value("Healthcare Settings", "enable_free_follow_ups") if automate_invoicing: if free_follow_ups: - fee_validity = frappe.db.exists('Fee Validity', {'patient': patient, 'status': 'Pending'}) + fee_validity = frappe.db.exists("Fee Validity", {"patient": patient, "status": "Pending"}) if fee_validity: - return {'fee_validity': fee_validity} + return {"fee_validity": fee_validity} return True return False + def invoice_appointment(appointment_doc): - automate_invoicing = frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing') - appointment_invoiced = frappe.db.get_value('Patient Appointment', appointment_doc.name, 'invoiced') - enable_free_follow_ups = frappe.db.get_single_value('Healthcare Settings', 'enable_free_follow_ups') + automate_invoicing = frappe.db.get_single_value( + "Healthcare Settings", "automate_appointment_invoicing" + ) + appointment_invoiced = frappe.db.get_value( + "Patient Appointment", appointment_doc.name, "invoiced" + ) + enable_free_follow_ups = frappe.db.get_single_value( + "Healthcare Settings", "enable_free_follow_ups" + ) if enable_free_follow_ups: fee_validity = check_fee_validity(appointment_doc) - if fee_validity and fee_validity.status == 'Completed': + if fee_validity and fee_validity.status == "Completed": fee_validity = None elif not fee_validity: - if frappe.db.exists('Fee Validity Reference', {'appointment': appointment_doc.name}): + if frappe.db.exists("Fee Validity Reference", {"appointment": appointment_doc.name}): return else: fee_validity = None @@ -200,21 +250,25 @@ def invoice_appointment(appointment_doc): def create_sales_invoice(appointment_doc): - sales_invoice = frappe.new_doc('Sales Invoice') + sales_invoice = frappe.new_doc("Sales Invoice") sales_invoice.patient = appointment_doc.patient - sales_invoice.customer = frappe.get_value('Patient', appointment_doc.patient, 'customer') + sales_invoice.customer = frappe.get_value("Patient", appointment_doc.patient, "customer") + sales_invoice.currency = frappe.get_value( + "Customer", sales_invoice.customer, "default_currency" + ) or get_company_currency(appointment_doc.company) + sales_invoice.appointment = appointment_doc.name sales_invoice.due_date = getdate() sales_invoice.company = appointment_doc.company sales_invoice.debit_to = get_receivable_account(appointment_doc.company) - item = sales_invoice.append('items', {}) + item = sales_invoice.append("items", {}) item = get_appointment_item(appointment_doc, item) # Add payments if payment details are supplied else proceed to create invoice as Unpaid if appointment_doc.mode_of_payment and appointment_doc.paid_amount: sales_invoice.is_pos = 1 - payment = sales_invoice.append('payments', {}) + payment = sales_invoice.append("payments", {}) payment.mode_of_payment = appointment_doc.mode_of_payment payment.amount = appointment_doc.paid_amount @@ -222,56 +276,61 @@ def create_sales_invoice(appointment_doc): sales_invoice.flags.ignore_mandatory = True sales_invoice.save(ignore_permissions=True) sales_invoice.submit() - frappe.msgprint(_('Sales Invoice {0} created').format(sales_invoice.name), alert=True) - frappe.db.set_value('Patient Appointment', appointment_doc.name, { - 'invoiced': 1, - 'ref_sales_invoice': sales_invoice.name - }) + frappe.msgprint(_("Sales Invoice {0} created").format(sales_invoice.name), alert=True) + frappe.db.set_value( + "Patient Appointment", + appointment_doc.name, + {"invoiced": 1, "ref_sales_invoice": sales_invoice.name}, + ) def check_is_new_patient(patient, name=None): - filters = {'patient': patient, 'status': ('!=','Cancelled')} + filters = {"patient": patient, "status": ("!=", "Cancelled")} if name: - filters['name'] = ('!=', name) + filters["name"] = ("!=", name) - has_previous_appointment = frappe.db.exists('Patient Appointment', filters) + has_previous_appointment = frappe.db.exists("Patient Appointment", filters) return not has_previous_appointment def get_appointment_item(appointment_doc, item): details = get_service_item_and_practitioner_charge(appointment_doc) - charge = appointment_doc.paid_amount or details.get('practitioner_charge') - item.item_code = details.get('service_item') - item.description = _('Consulting Charges: {0}').format(appointment_doc.practitioner) + charge = appointment_doc.paid_amount or details.get("practitioner_charge") + item.item_code = details.get("service_item") + item.description = _("Consulting Charges: {0}").format(appointment_doc.practitioner) item.income_account = get_income_account(appointment_doc.practitioner, appointment_doc.company) - item.cost_center = frappe.get_cached_value('Company', appointment_doc.company, 'cost_center') + item.cost_center = frappe.get_cached_value("Company", appointment_doc.company, "cost_center") item.rate = charge item.amount = charge item.qty = 1 - item.reference_dt = 'Patient Appointment' + item.reference_dt = "Patient Appointment" item.reference_dn = appointment_doc.name return item def cancel_appointment(appointment_id): - appointment = frappe.get_doc('Patient Appointment', appointment_id) + appointment = frappe.get_doc("Patient Appointment", appointment_id) if appointment.invoiced: sales_invoice = check_sales_invoice_exists(appointment) if sales_invoice and cancel_sales_invoice(sales_invoice): - msg = _('Appointment {0} and Sales Invoice {1} cancelled').format(appointment.name, sales_invoice.name) + msg = _("Appointment {0} and Sales Invoice {1} cancelled").format( + appointment.name, sales_invoice.name + ) else: - msg = _('Appointment Cancelled. Please review and cancel the invoice {0}').format(sales_invoice.name) + msg = _("Appointment Cancelled. Please review and cancel the invoice {0}").format( + sales_invoice.name + ) else: fee_validity = manage_fee_validity(appointment) - msg = _('Appointment Cancelled.') + msg = _("Appointment Cancelled.") if fee_validity: - msg += _('Fee Validity {0} updated.').format(fee_validity.name) + msg += _("Fee Validity {0} updated.").format(fee_validity.name) frappe.msgprint(msg) def cancel_sales_invoice(sales_invoice): - if frappe.db.get_single_value('Healthcare Settings', 'automate_appointment_invoicing'): + if frappe.db.get_single_value("Healthcare Settings", "automate_appointment_invoicing"): if len(sales_invoice.items) == 1: sales_invoice.cancel() return True @@ -279,13 +338,14 @@ def cancel_sales_invoice(sales_invoice): def check_sales_invoice_exists(appointment): - sales_invoice = frappe.db.get_value('Sales Invoice Item', { - 'reference_dt': 'Patient Appointment', - 'reference_dn': appointment.name - }, 'parent') + sales_invoice = frappe.db.get_value( + "Sales Invoice Item", + {"reference_dt": "Patient Appointment", "reference_dn": appointment.name}, + "parent", + ) if sales_invoice: - sales_invoice = frappe.get_doc('Sales Invoice', sales_invoice) + sales_invoice = frappe.get_doc("Sales Invoice", sales_invoice) return sales_invoice return False @@ -300,24 +360,29 @@ def get_availability_data(date, practitioner): """ date = getdate(date) - weekday = date.strftime('%A') + weekday = date.strftime("%A") - practitioner_doc = frappe.get_doc('Healthcare Practitioner', practitioner) + practitioner_doc = frappe.get_doc("Healthcare Practitioner", practitioner) check_employee_wise_availability(date, practitioner_doc) if practitioner_doc.practitioner_schedules: slot_details = get_available_slots(practitioner_doc, date) else: - frappe.throw(_('{0} does not have a Healthcare Practitioner Schedule. Add it in Healthcare Practitioner master').format( - practitioner), title=_('Practitioner Schedule Not Found')) - + frappe.throw( + _( + "{0} does not have a Healthcare Practitioner Schedule. Add it in Healthcare Practitioner master" + ).format(practitioner), + title=_("Practitioner Schedule Not Found"), + ) if not slot_details: # TODO: return available slots in nearby dates - frappe.throw(_('Healthcare Practitioner not available on {0}').format(weekday), title=_('Not Available')) + frappe.throw( + _("Healthcare Practitioner not available on {0}").format(weekday), title=_("Not Available") + ) - return {'slot_details': slot_details} + return {"slot_details": slot_details} def check_employee_wise_availability(date, practitioner_doc): @@ -325,32 +390,41 @@ def check_employee_wise_availability(date, practitioner_doc): if practitioner_doc.employee: employee = practitioner_doc.employee elif practitioner_doc.user_id: - employee = frappe.db.get_value('Employee', {'user_id': practitioner_doc.user_id}, 'name') + employee = frappe.db.get_value("Employee", {"user_id": practitioner_doc.user_id}, "name") if employee: # check holiday if is_holiday(employee, date): - frappe.throw(_('{0} is a holiday'.format(date)), title=_('Not Available')) + frappe.throw(_("{0} is a holiday".format(date)), title=_("Not Available")) # check leave status - leave_record = frappe.db.sql("""select half_day from `tabLeave Application` + leave_record = frappe.db.sql( + """select half_day from `tabLeave Application` where employee = %s and %s between from_date and to_date - and docstatus = 1""", (employee, date), as_dict=True) + and docstatus = 1""", + (employee, date), + as_dict=True, + ) if leave_record: if leave_record[0].half_day: - frappe.throw(_('{0} is on a Half day Leave on {1}').format(practitioner_doc.name, date), title=_('Not Available')) + frappe.throw( + _("{0} is on a Half day Leave on {1}").format(practitioner_doc.name, date), + title=_("Not Available"), + ) else: - frappe.throw(_('{0} is on Leave on {1}').format(practitioner_doc.name, date), title=_('Not Available')) + frappe.throw( + _("{0} is on Leave on {1}").format(practitioner_doc.name, date), title=_("Not Available") + ) def get_available_slots(practitioner_doc, date): available_slots = slot_details = [] - weekday = date.strftime('%A') + weekday = date.strftime("%A") practitioner = practitioner_doc.name for schedule_entry in practitioner_doc.practitioner_schedules: validate_practitioner_schedules(schedule_entry, practitioner) - practitioner_schedule = frappe.get_doc('Practitioner Schedule', schedule_entry.schedule) + practitioner_schedule = frappe.get_doc("Practitioner Schedule", schedule_entry.schedule) if practitioner_schedule and not practitioner_schedule.disabled: available_slots = [] @@ -364,31 +438,45 @@ def get_available_slots(practitioner_doc, date): service_unit_capacity = 0 # fetch all appointments to practitioner by service unit filters = { - 'practitioner': practitioner, - 'service_unit': schedule_entry.service_unit, - 'appointment_date': date, - 'status': ['not in',['Cancelled']] + "practitioner": practitioner, + "service_unit": schedule_entry.service_unit, + "appointment_date": date, + "status": ["not in", ["Cancelled"]], } if schedule_entry.service_unit: - slot_name = f'{schedule_entry.schedule}' - allow_overlap, service_unit_capacity = frappe.get_value('Healthcare Service Unit', schedule_entry.service_unit, ['overlap_appointments', 'service_unit_capacity']) + slot_name = f"{schedule_entry.schedule}" + allow_overlap, service_unit_capacity = frappe.get_value( + "Healthcare Service Unit", + schedule_entry.service_unit, + ["overlap_appointments", "service_unit_capacity"], + ) if not allow_overlap: # fetch all appointments to service unit - filters.pop('practitioner') + filters.pop("practitioner") else: slot_name = schedule_entry.schedule # fetch all appointments to practitioner without service unit - filters['practitioner'] = practitioner - filters.pop('service_unit') + filters["practitioner"] = practitioner + filters.pop("service_unit") appointments = frappe.get_all( - 'Patient Appointment', + "Patient Appointment", filters=filters, - fields=['name', 'appointment_time', 'duration', 'status']) + fields=["name", "appointment_time", "duration", "status"], + ) - slot_details.append({'slot_name': slot_name, 'service_unit': schedule_entry.service_unit, 'avail_slot': available_slots, - 'appointments': appointments, 'allow_overlap': allow_overlap, 'service_unit_capacity': service_unit_capacity}) + slot_details.append( + { + "slot_name": slot_name, + "service_unit": schedule_entry.service_unit, + "avail_slot": available_slots, + "appointments": appointments, + "allow_overlap": allow_overlap, + "service_unit_capacity": service_unit_capacity, + "practitioner_name": practitioner_doc.practitioner_name, + } + ) return slot_details @@ -396,82 +484,107 @@ def get_available_slots(practitioner_doc, date): def validate_practitioner_schedules(schedule_entry, practitioner): if schedule_entry.schedule: if not schedule_entry.service_unit: - frappe.throw(_('Practitioner {0} does not have a Service Unit set against the Practitioner Schedule {1}.').format( - get_link_to_form('Healthcare Practitioner', practitioner), frappe.bold(schedule_entry.schedule)), - title=_('Service Unit Not Found')) + frappe.throw( + _( + "Practitioner {0} does not have a Service Unit set against the Practitioner Schedule {1}." + ).format( + get_link_to_form("Healthcare Practitioner", practitioner), + frappe.bold(schedule_entry.schedule), + ), + title=_("Service Unit Not Found"), + ) else: - frappe.throw(_('Practitioner {0} does not have a Practitioner Schedule assigned.').format( - get_link_to_form('Healthcare Practitioner', practitioner)), - title=_('Practitioner Schedule Not Found')) + frappe.throw( + _("Practitioner {0} does not have a Practitioner Schedule assigned.").format( + get_link_to_form("Healthcare Practitioner", practitioner) + ), + title=_("Practitioner Schedule Not Found"), + ) @frappe.whitelist() def update_status(appointment_id, status): - frappe.db.set_value('Patient Appointment', appointment_id, 'status', status) + frappe.db.set_value("Patient Appointment", appointment_id, "status", status) appointment_booked = True - if status == 'Cancelled': + if status == "Cancelled": appointment_booked = False cancel_appointment(appointment_id) - procedure_prescription = frappe.db.get_value('Patient Appointment', appointment_id, 'procedure_prescription') + procedure_prescription = frappe.db.get_value( + "Patient Appointment", appointment_id, "procedure_prescription" + ) if procedure_prescription: - frappe.db.set_value('Procedure Prescription', procedure_prescription, 'appointment_booked', appointment_booked) + frappe.db.set_value( + "Procedure Prescription", procedure_prescription, "appointment_booked", appointment_booked + ) def send_confirmation_msg(doc): - if frappe.db.get_single_value('Healthcare Settings', 'send_appointment_confirmation'): - message = frappe.db.get_single_value('Healthcare Settings', 'appointment_confirmation_msg') + if frappe.db.get_single_value("Healthcare Settings", "send_appointment_confirmation"): + message = frappe.db.get_single_value("Healthcare Settings", "appointment_confirmation_msg") try: send_message(doc, message) except Exception: - frappe.log_error(frappe.get_traceback(), _('Appointment Confirmation Message Not Sent')) - frappe.msgprint(_('Appointment Confirmation Message Not Sent'), indicator='orange') + frappe.log_error(frappe.get_traceback(), _("Appointment Confirmation Message Not Sent")) + frappe.msgprint(_("Appointment Confirmation Message Not Sent"), indicator="orange") @frappe.whitelist() def make_encounter(source_name, target_doc=None): - doc = get_mapped_doc('Patient Appointment', source_name, { - 'Patient Appointment': { - 'doctype': 'Patient Encounter', - 'field_map': [ - ['appointment', 'name'], - ['patient', 'patient'], - ['practitioner', 'practitioner'], - ['medical_department', 'department'], - ['patient_sex', 'patient_sex'], - ['invoiced', 'invoiced'], - ['company', 'company'] - ] - } - }, target_doc) + doc = get_mapped_doc( + "Patient Appointment", + source_name, + { + "Patient Appointment": { + "doctype": "Patient Encounter", + "field_map": [ + ["appointment", "name"], + ["patient", "patient"], + ["practitioner", "practitioner"], + ["medical_department", "department"], + ["patient_sex", "patient_sex"], + ["invoiced", "invoiced"], + ["company", "company"], + ], + } + }, + target_doc, + ) return doc def send_appointment_reminder(): - if frappe.db.get_single_value('Healthcare Settings', 'send_appointment_reminder'): - remind_before = datetime.datetime.strptime(frappe.db.get_single_value('Healthcare Settings', 'remind_before'), '%H:%M:%S') + if frappe.db.get_single_value("Healthcare Settings", "send_appointment_reminder"): + remind_before = datetime.datetime.strptime( + frappe.db.get_single_value("Healthcare Settings", "remind_before"), "%H:%M:%S" + ) reminder_dt = datetime.datetime.now() + datetime.timedelta( - hours=remind_before.hour, minutes=remind_before.minute, seconds=remind_before.second) + hours=remind_before.hour, minutes=remind_before.minute, seconds=remind_before.second + ) - appointment_list = frappe.db.get_all('Patient Appointment', { - 'appointment_datetime': ['between', (datetime.datetime.now(), reminder_dt)], - 'reminded': 0, - 'status': ['!=', 'Cancelled'] - }) + appointment_list = frappe.db.get_all( + "Patient Appointment", + { + "appointment_datetime": ["between", (datetime.datetime.now(), reminder_dt)], + "reminded": 0, + "status": ["!=", "Cancelled"], + }, + ) for appointment in appointment_list: - doc = frappe.get_doc('Patient Appointment', appointment.name) - message = frappe.db.get_single_value('Healthcare Settings', 'appointment_reminder_msg') + doc = frappe.get_doc("Patient Appointment", appointment.name) + message = frappe.db.get_single_value("Healthcare Settings", "appointment_reminder_msg") send_message(doc, message) - frappe.db.set_value('Patient Appointment', doc.name, 'reminded', 1) + frappe.db.set_value("Patient Appointment", doc.name, "reminded", 1) + def send_message(doc, message): - patient_mobile = frappe.db.get_value('Patient', doc.patient, 'mobile') + patient_mobile = frappe.db.get_value("Patient", doc.patient, "mobile") if patient_mobile: - context = {'doc': doc, 'alert': doc, 'comments': None} - if doc.get('_comments'): - context['comments'] = json.loads(doc.get('_comments')) + context = {"doc": doc, "alert": doc, "comments": None} + if doc.get("_comments"): + context["comments"] = json.loads(doc.get("_comments")) # jinja to string convertion happens here message = frappe.render_template(message, context) @@ -479,7 +592,8 @@ def send_message(doc, message): try: send_sms(number, message) except Exception as e: - frappe.msgprint(_('SMS not sent, please check SMS Settings'), alert=True) + frappe.msgprint(_("SMS not sent, please check SMS Settings"), alert=True) + @frappe.whitelist() def get_events(start, end, filters=None): @@ -490,9 +604,11 @@ def get_events(start, end, filters=None): :param filters: Filters (JSON). """ from frappe.desk.calendar import get_event_conditions - conditions = get_event_conditions('Patient Appointment', filters) - data = frappe.db.sql(""" + conditions = get_event_conditions("Patient Appointment", filters) + + data = frappe.db.sql( + """ select `tabPatient Appointment`.name, `tabPatient Appointment`.patient, `tabPatient Appointment`.practitioner, `tabPatient Appointment`.status, @@ -504,11 +620,16 @@ def get_events(start, end, filters=None): left join `tabAppointment Type` on `tabPatient Appointment`.appointment_type=`tabAppointment Type`.name where (`tabPatient Appointment`.appointment_date between %(start)s and %(end)s) - and `tabPatient Appointment`.status != 'Cancelled' and `tabPatient Appointment`.docstatus < 2 {conditions}""".format(conditions=conditions), - {"start": start, "end": end}, as_dict=True, update={"allDay": 0}) + and `tabPatient Appointment`.status != 'Cancelled' and `tabPatient Appointment`.docstatus < 2 {conditions}""".format( + conditions=conditions + ), + {"start": start, "end": end}, + as_dict=True, + update={"allDay": 0}, + ) for item in data: - item.end = item.start + datetime.timedelta(minutes = item.duration) + item.end = item.start + datetime.timedelta(minutes=item.duration) return data @@ -526,7 +647,8 @@ def get_procedure_prescribed(patient): ct.patient=%(patient)s and pp.parent=ct.name and pp.appointment_booked=0 ORDER BY ct.creation desc - """, {'patient': patient} + """, + {"patient": patient}, ) @@ -543,15 +665,16 @@ def get_prescribed_therapies(patient): e.patient=%(patient)s and t.parent=e.name ORDER BY e.creation desc - """, {'patient': patient} + """, + {"patient": patient}, ) def update_appointment_status(): # update the status of appointments daily - appointments = frappe.get_all('Patient Appointment', { - 'status': ('not in', ['Closed', 'Cancelled']) - }, as_dict=1) + appointments = frappe.get_all( + "Patient Appointment", {"status": ("not in", ["Closed", "Cancelled"])}, as_dict=1 + ) for appointment in appointments: - frappe.get_doc('Patient Appointment', appointment.name).set_status() + frappe.get_doc("Patient Appointment", appointment.name).set_status() diff --git a/erpnext/healthcare/doctype/patient_appointment/patient_appointment_dashboard.py b/erpnext/healthcare/doctype/patient_appointment/patient_appointment_dashboard.py index 89349ee60f6..3eeb153055b 100644 --- a/erpnext/healthcare/doctype/patient_appointment/patient_appointment_dashboard.py +++ b/erpnext/healthcare/doctype/patient_appointment/patient_appointment_dashboard.py @@ -1,17 +1,14 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'appointment', - 'non_standard_fieldnames': { - 'Patient Medical Record': 'reference_name' - }, - 'transactions': [ + "fieldname": "appointment", + "non_standard_fieldnames": {"Patient Medical Record": "reference_name"}, + "transactions": [ { - 'label': _('Consultations'), - 'items': ['Patient Encounter', 'Vital Signs', 'Patient Medical Record'] + "label": _("Consultations"), + "items": ["Patient Encounter", "Vital Signs", "Patient Medical Record"], } - ] + ], } diff --git a/erpnext/healthcare/doctype/patient_appointment/test_patient_appointment.py b/erpnext/healthcare/doctype/patient_appointment/test_patient_appointment.py index 7afdba69eaa..05e6b9cfe0d 100644 --- a/erpnext/healthcare/doctype/patient_appointment/test_patient_appointment.py +++ b/erpnext/healthcare/doctype/patient_appointment/test_patient_appointment.py @@ -22,24 +22,28 @@ class TestPatientAppointment(unittest.TestCase): frappe.db.sql("""delete from `tabPatient Encounter`""") make_pos_profile() frappe.db.sql("""delete from `tabHealthcare Service Unit` where name like '_Test %'""") - frappe.db.sql("""delete from `tabHealthcare Service Unit` where name like '_Test Service Unit Type%'""") + frappe.db.sql( + """delete from `tabHealthcare Service Unit` where name like '_Test Service Unit Type%'""" + ) def test_status(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 0) appointment = create_appointment(patient, practitioner, nowdate()) - self.assertEqual(appointment.status, 'Open') + self.assertEqual(appointment.status, "Open") appointment = create_appointment(patient, practitioner, add_days(nowdate(), 2)) - self.assertEqual(appointment.status, 'Scheduled') + self.assertEqual(appointment.status, "Scheduled") encounter = create_encounter(appointment) - self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'status'), 'Closed') + self.assertEqual( + frappe.db.get_value("Patient Appointment", appointment.name, "status"), "Closed" + ) encounter.cancel() - self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'status'), 'Open') + self.assertEqual(frappe.db.get_value("Patient Appointment", appointment.name, "status"), "Open") def test_start_encounter(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) - appointment = create_appointment(patient, practitioner, add_days(nowdate(), 4), invoice = 1) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) + appointment = create_appointment(patient, practitioner, add_days(nowdate(), 4), invoice=1) appointment.reload() self.assertEqual(appointment.invoiced, 1) encounter = make_encounter(appointment.name) @@ -48,92 +52,115 @@ class TestPatientAppointment(unittest.TestCase): self.assertEqual(encounter.practitioner, appointment.practitioner) self.assertEqual(encounter.patient, appointment.patient) # invoiced flag mapped from appointment - self.assertEqual(encounter.invoiced, frappe.db.get_value('Patient Appointment', appointment.name, 'invoiced')) + self.assertEqual( + encounter.invoiced, frappe.db.get_value("Patient Appointment", appointment.name, "invoiced") + ) def test_auto_invoicing(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 0) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 0) appointment = create_appointment(patient, practitioner, nowdate()) - self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'invoiced'), 0) + self.assertEqual(frappe.db.get_value("Patient Appointment", appointment.name, "invoiced"), 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) appointment = create_appointment(patient, practitioner, add_days(nowdate(), 2), invoice=1) - self.assertEqual(frappe.db.get_value('Patient Appointment', appointment.name, 'invoiced'), 1) - sales_invoice_name = frappe.db.get_value('Sales Invoice Item', {'reference_dn': appointment.name}, 'parent') + self.assertEqual(frappe.db.get_value("Patient Appointment", appointment.name, "invoiced"), 1) + sales_invoice_name = frappe.db.get_value( + "Sales Invoice Item", {"reference_dn": appointment.name}, "parent" + ) self.assertTrue(sales_invoice_name) - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'company'), appointment.company) - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'patient'), appointment.patient) - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'paid_amount'), appointment.paid_amount) + self.assertEqual( + frappe.db.get_value("Sales Invoice", sales_invoice_name, "company"), appointment.company + ) + self.assertEqual( + frappe.db.get_value("Sales Invoice", sales_invoice_name, "patient"), appointment.patient + ) + self.assertEqual( + frappe.db.get_value("Sales Invoice", sales_invoice_name, "paid_amount"), appointment.paid_amount + ) def test_auto_invoicing_based_on_department(self): patient, practitioner = create_healthcare_docs() medical_department = create_medical_department() - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) - appointment_type = create_appointment_type({'medical_department': medical_department}) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) + appointment_type = create_appointment_type({"medical_department": medical_department}) - appointment = create_appointment(patient, practitioner, add_days(nowdate(), 2), - invoice=1, appointment_type=appointment_type.name, department=medical_department) + appointment = create_appointment( + patient, + practitioner, + add_days(nowdate(), 2), + invoice=1, + appointment_type=appointment_type.name, + department=medical_department, + ) appointment.reload() self.assertEqual(appointment.invoiced, 1) - self.assertEqual(appointment.billing_item, 'HLC-SI-001') + self.assertEqual(appointment.billing_item, "HLC-SI-001") self.assertEqual(appointment.paid_amount, 200) - sales_invoice_name = frappe.db.get_value('Sales Invoice Item', {'reference_dn': appointment.name}, 'parent') + sales_invoice_name = frappe.db.get_value( + "Sales Invoice Item", {"reference_dn": appointment.name}, "parent" + ) self.assertTrue(sales_invoice_name) - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'paid_amount'), appointment.paid_amount) + self.assertEqual( + frappe.db.get_value("Sales Invoice", sales_invoice_name, "paid_amount"), appointment.paid_amount + ) def test_auto_invoicing_according_to_appointment_type_charge(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) item = create_healthcare_service_items() - items = [{ - 'op_consulting_charge_item': item, - 'op_consulting_charge': 300 - }] - appointment_type = create_appointment_type(args={ - 'name': 'Generic Appointment Type charge', - 'items': items - }) + items = [{"op_consulting_charge_item": item, "op_consulting_charge": 300}] + appointment_type = create_appointment_type( + args={"name": "Generic Appointment Type charge", "items": items} + ) - appointment = create_appointment(patient, practitioner, add_days(nowdate(), 2), - invoice=1, appointment_type=appointment_type.name) + appointment = create_appointment( + patient, practitioner, add_days(nowdate(), 2), invoice=1, appointment_type=appointment_type.name + ) appointment.reload() self.assertEqual(appointment.invoiced, 1) self.assertEqual(appointment.billing_item, item) self.assertEqual(appointment.paid_amount, 300) - sales_invoice_name = frappe.db.get_value('Sales Invoice Item', {'reference_dn': appointment.name}, 'parent') + sales_invoice_name = frappe.db.get_value( + "Sales Invoice Item", {"reference_dn": appointment.name}, "parent" + ) self.assertTrue(sales_invoice_name) def test_appointment_cancel(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 1) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 1) appointment = create_appointment(patient, practitioner, nowdate()) - fee_validity = frappe.db.get_value('Fee Validity', {'patient': patient, 'practitioner': practitioner}) + fee_validity = frappe.db.get_value( + "Fee Validity", {"patient": patient, "practitioner": practitioner} + ) # fee validity created self.assertTrue(fee_validity) # first follow up appointment appointment = create_appointment(patient, practitioner, add_days(nowdate(), 1)) - self.assertEqual(frappe.db.get_value('Fee Validity', fee_validity, 'visited'), 1) + self.assertEqual(frappe.db.get_value("Fee Validity", fee_validity, "visited"), 1) - update_status(appointment.name, 'Cancelled') + update_status(appointment.name, "Cancelled") # check fee validity updated - self.assertEqual(frappe.db.get_value('Fee Validity', fee_validity, 'visited'), 0) + self.assertEqual(frappe.db.get_value("Fee Validity", fee_validity, "visited"), 0) - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 0) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 0) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) appointment = create_appointment(patient, practitioner, add_days(nowdate(), 1), invoice=1) - update_status(appointment.name, 'Cancelled') + update_status(appointment.name, "Cancelled") # check invoice cancelled - sales_invoice_name = frappe.db.get_value('Sales Invoice Item', {'reference_dn': appointment.name}, 'parent') - self.assertEqual(frappe.db.get_value('Sales Invoice', sales_invoice_name, 'status'), 'Cancelled') + sales_invoice_name = frappe.db.get_value( + "Sales Invoice Item", {"reference_dn": appointment.name}, "parent" + ) + self.assertEqual(frappe.db.get_value("Sales Invoice", sales_invoice_name, "status"), "Cancelled") def test_appointment_booking_for_admission_service_unit(self): from erpnext.healthcare.doctype.inpatient_record.inpatient_record import ( @@ -153,17 +180,19 @@ class TestPatientAppointment(unittest.TestCase): # Schedule Admission ip_record = create_inpatient(patient) ip_record.expected_length_of_stay = 0 - ip_record.save(ignore_permissions = True) + ip_record.save(ignore_permissions=True) # Admit - service_unit = get_healthcare_service_unit('_Test Service Unit Ip Occupancy') + service_unit = get_healthcare_service_unit("_Test Service Unit Ip Occupancy") admit_patient(ip_record, service_unit, now_datetime()) appointment = create_appointment(patient, practitioner, nowdate(), service_unit=service_unit) self.assertEqual(appointment.service_unit, service_unit) # Discharge - schedule_discharge(frappe.as_json({'patient': patient, 'discharge_ordered_datetime': now_datetime()})) + schedule_discharge( + frappe.as_json({"patient": patient, "discharge_ordered_datetime": now_datetime()}) + ) ip_record1 = frappe.get_doc("Inpatient Record", ip_record.name) mark_invoiced_inpatient_occupancy(ip_record1) discharge_patient(ip_record1, now_datetime()) @@ -186,27 +215,33 @@ class TestPatientAppointment(unittest.TestCase): # Schedule Admission ip_record = create_inpatient(patient) ip_record.expected_length_of_stay = 0 - ip_record.save(ignore_permissions = True) + ip_record.save(ignore_permissions=True) # Admit - service_unit = get_healthcare_service_unit('_Test Service Unit Ip Occupancy') + service_unit = get_healthcare_service_unit("_Test Service Unit Ip Occupancy") admit_patient(ip_record, service_unit, now_datetime()) - appointment_service_unit = get_healthcare_service_unit('_Test Service Unit Ip Occupancy for Appointment') - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=appointment_service_unit, save=0) + appointment_service_unit = get_healthcare_service_unit( + "_Test Service Unit Ip Occupancy for Appointment" + ) + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=appointment_service_unit, save=0 + ) self.assertRaises(frappe.exceptions.ValidationError, appointment.save) # Discharge - schedule_discharge(frappe.as_json({'patient': patient, 'discharge_ordered_datetime': now_datetime()})) + schedule_discharge( + frappe.as_json({"patient": patient, "discharge_ordered_datetime": now_datetime()}) + ) ip_record1 = frappe.get_doc("Inpatient Record", ip_record.name) mark_invoiced_inpatient_occupancy(ip_record1) discharge_patient(ip_record1, now_datetime()) def test_payment_should_be_mandatory_for_new_patient_appointment(self): - frappe.db.set_value('Healthcare Settings', None, 'enable_free_follow_ups', 1) - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) - frappe.db.set_value('Healthcare Settings', None, 'max_visits', 3) - frappe.db.set_value('Healthcare Settings', None, 'valid_days', 30) + frappe.db.set_value("Healthcare Settings", None, "enable_free_follow_ups", 1) + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) + frappe.db.set_value("Healthcare Settings", None, "max_visits", 3) + frappe.db.set_value("Healthcare Settings", None, "valid_days", 30) patient = create_patient() assert check_is_new_patient(patient) @@ -215,43 +250,60 @@ class TestPatientAppointment(unittest.TestCase): def test_sales_invoice_should_be_generated_for_new_patient_appointment(self): patient, practitioner = create_healthcare_docs() - frappe.db.set_value('Healthcare Settings', None, 'automate_appointment_invoicing', 1) - invoice_count = frappe.db.count('Sales Invoice') + frappe.db.set_value("Healthcare Settings", None, "automate_appointment_invoicing", 1) + invoice_count = frappe.db.count("Sales Invoice") assert check_is_new_patient(patient) create_appointment(patient, practitioner, nowdate()) - new_invoice_count = frappe.db.count('Sales Invoice') + new_invoice_count = frappe.db.count("Sales Invoice") assert new_invoice_count == invoice_count + 1 def test_overlap_appointment(self): from erpnext.healthcare.doctype.patient_appointment.patient_appointment import OverlapError + patient, practitioner = create_healthcare_docs(id=1) patient_1, practitioner_1 = create_healthcare_docs(id=2) service_unit = create_service_unit(id=0) service_unit_1 = create_service_unit(id=1) - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=service_unit) # valid + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=service_unit + ) # valid # patient and practitioner cannot have overlapping appointments - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=service_unit, save=0) + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=service_unit, save=0 + ) self.assertRaises(OverlapError, appointment.save) - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=service_unit_1, save=0) # diff service unit + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=service_unit_1, save=0 + ) # diff service unit self.assertRaises(OverlapError, appointment.save) - appointment = create_appointment(patient, practitioner, nowdate(), save=0) # with no service unit link + appointment = create_appointment( + patient, practitioner, nowdate(), save=0 + ) # with no service unit link self.assertRaises(OverlapError, appointment.save) # patient cannot have overlapping appointments with other practitioners - appointment = create_appointment(patient, practitioner_1, nowdate(), service_unit=service_unit, save=0) + appointment = create_appointment( + patient, practitioner_1, nowdate(), service_unit=service_unit, save=0 + ) self.assertRaises(OverlapError, appointment.save) - appointment = create_appointment(patient, practitioner_1, nowdate(), service_unit=service_unit_1, save=0) + appointment = create_appointment( + patient, practitioner_1, nowdate(), service_unit=service_unit_1, save=0 + ) self.assertRaises(OverlapError, appointment.save) appointment = create_appointment(patient, practitioner_1, nowdate(), save=0) self.assertRaises(OverlapError, appointment.save) # practitioner cannot have overlapping appointments with other patients - appointment = create_appointment(patient_1, practitioner, nowdate(), service_unit=service_unit, save=0) + appointment = create_appointment( + patient_1, practitioner, nowdate(), service_unit=service_unit, save=0 + ) self.assertRaises(OverlapError, appointment.save) - appointment = create_appointment(patient_1, practitioner, nowdate(), service_unit=service_unit_1, save=0) + appointment = create_appointment( + patient_1, practitioner, nowdate(), service_unit=service_unit_1, save=0 + ) self.assertRaises(OverlapError, appointment.save) appointment = create_appointment(patient_1, practitioner, nowdate(), save=0) self.assertRaises(OverlapError, appointment.save) @@ -261,19 +313,28 @@ class TestPatientAppointment(unittest.TestCase): MaximumCapacityError, OverlapError, ) + practitioner = create_practitioner() capacity = 3 - overlap_service_unit_type = create_service_unit_type(id=10, allow_appointments=1, overlap_appointments=1) - overlap_service_unit = create_service_unit(id=100, service_unit_type=overlap_service_unit_type, service_unit_capacity=capacity) + overlap_service_unit_type = create_service_unit_type( + id=10, allow_appointments=1, overlap_appointments=1 + ) + overlap_service_unit = create_service_unit( + id=100, service_unit_type=overlap_service_unit_type, service_unit_capacity=capacity + ) for i in range(0, capacity): patient = create_patient(id=i) - create_appointment(patient, practitioner, nowdate(), service_unit=overlap_service_unit) # valid - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=overlap_service_unit, save=0) # overlap + create_appointment(patient, practitioner, nowdate(), service_unit=overlap_service_unit) # valid + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=overlap_service_unit, save=0 + ) # overlap self.assertRaises(OverlapError, appointment.save) patient = create_patient(id=capacity) - appointment = create_appointment(patient, practitioner, nowdate(), service_unit=overlap_service_unit, save=0) + appointment = create_appointment( + patient, practitioner, nowdate(), service_unit=overlap_service_unit, save=0 + ) self.assertRaises(MaximumCapacityError, appointment.save) def test_patient_appointment_should_consider_permissions_while_fetching_appointments(self): @@ -285,16 +346,16 @@ class TestPatientAppointment(unittest.TestCase): roles = [{"doctype": "Has Role", "role": "Physician"}] user = create_user(roles=roles) - new_practitioner = frappe.get_doc('Healthcare Practitioner', new_practitioner) + new_practitioner = frappe.get_doc("Healthcare Practitioner", new_practitioner) new_practitioner.user_id = user.email new_practitioner.save() frappe.set_user(user.name) - appointments = frappe.get_list('Patient Appointment') + appointments = frappe.get_list("Patient Appointment") assert len(appointments) == 1 frappe.set_user("Administrator") - appointments = frappe.get_list('Patient Appointment') + appointments = frappe.get_list("Patient Appointment") assert len(appointments) == 2 @@ -305,17 +366,20 @@ def create_healthcare_docs(id=0): return patient, practitioner -def create_patient(id=0, patient_name=None, email=None, mobile=None, customer=None, create_user=False): - if frappe.db.exists('Patient', {'firstname':f'_Test Patient {str(id)}'}): - patient = frappe.db.get_value('Patient', {'first_name': f'_Test Patient {str(id)}'}, ['name']) +def create_patient( + id=0, patient_name=None, email=None, mobile=None, customer=None, create_user=False +): + if frappe.db.exists("Patient", {"firstname": f"_Test Patient {str(id)}"}): + patient = frappe.db.get_value("Patient", {"first_name": f"_Test Patient {str(id)}"}, ["name"]) return patient - patient = frappe.new_doc('Patient') - patient.first_name = patient_name if patient_name else f'_Test Patient {str(id)}' - patient.sex = 'Female' + patient = frappe.new_doc("Patient") + patient.first_name = patient_name if patient_name else f"_Test Patient {str(id)}" + patient.sex = "Female" patient.mobile = mobile patient.email = email patient.customer = customer + patient.default_currency = "INR" patient.invite_user = create_user patient.save(ignore_permissions=True) @@ -323,24 +387,28 @@ def create_patient(id=0, patient_name=None, email=None, mobile=None, customer=No def create_medical_department(id=0): - if frappe.db.exists('Medical Department', f'_Test Medical Department {str(id)}'): - return f'_Test Medical Department {str(id)}' + if frappe.db.exists("Medical Department", f"_Test Medical Department {str(id)}"): + return f"_Test Medical Department {str(id)}" - medical_department = frappe.new_doc('Medical Department') - medical_department.department = f'_Test Medical Department {str(id)}' + medical_department = frappe.new_doc("Medical Department") + medical_department.department = f"_Test Medical Department {str(id)}" medical_department.save(ignore_permissions=True) return medical_department.name def create_practitioner(id=0, medical_department=None): - if frappe.db.exists('Healthcare Practitioner', {'firstname':f'_Test Healthcare Practitioner {str(id)}'}): - practitioner = frappe.db.get_value('Healthcare Practitioner', {'firstname':f'_Test Healthcare Practitioner {str(id)}'}, ['name']) + if frappe.db.exists( + "Healthcare Practitioner", {"firstname": f"_Test Healthcare Practitioner {str(id)}"} + ): + practitioner = frappe.db.get_value( + "Healthcare Practitioner", {"firstname": f"_Test Healthcare Practitioner {str(id)}"}, ["name"] + ) return practitioner - practitioner = frappe.new_doc('Healthcare Practitioner') - practitioner.first_name = f'_Test Healthcare Practitioner {str(id)}' - practitioner.gender = 'Female' + practitioner = frappe.new_doc("Healthcare Practitioner") + practitioner.first_name = f"_Test Healthcare Practitioner {str(id)}" + practitioner.gender = "Female" practitioner.department = medical_department or create_medical_department(id) practitioner.op_consulting_charge = 500 practitioner.inpatient_visit_charge = 500 @@ -348,9 +416,10 @@ def create_practitioner(id=0, medical_department=None): return practitioner.name + def create_encounter(appointment): if appointment: - encounter = frappe.new_doc('Patient Encounter') + encounter = frappe.new_doc("Patient Encounter") encounter.appointment = appointment.name encounter.patient = appointment.patient encounter.practitioner = appointment.practitioner @@ -362,27 +431,37 @@ def create_encounter(appointment): return encounter -def create_appointment(patient, practitioner, appointment_date, invoice=0, procedure_template=0, - service_unit=None, appointment_type=None, save=1, department=None): + +def create_appointment( + patient, + practitioner, + appointment_date, + invoice=0, + procedure_template=0, + service_unit=None, + appointment_type=None, + save=1, + department=None, +): item = create_healthcare_service_items() - frappe.db.set_value('Healthcare Settings', None, 'inpatient_visit_charge_item', item) - frappe.db.set_value('Healthcare Settings', None, 'op_consulting_charge_item', item) - appointment = frappe.new_doc('Patient Appointment') + frappe.db.set_value("Healthcare Settings", None, "inpatient_visit_charge_item", item) + frappe.db.set_value("Healthcare Settings", None, "op_consulting_charge_item", item) + appointment = frappe.new_doc("Patient Appointment") appointment.patient = patient appointment.practitioner = practitioner - appointment.department = department or '_Test Medical Department' + appointment.department = department or "_Test Medical Department" appointment.appointment_date = appointment_date - appointment.company = '_Test Company' + appointment.company = "_Test Company" appointment.duration = 15 if service_unit: appointment.service_unit = service_unit if invoice: - appointment.mode_of_payment = 'Cash' + appointment.mode_of_payment = "Cash" if appointment_type: appointment.appointment_type = appointment_type if procedure_template: - appointment.procedure_template = create_clinical_procedure_template().get('name') + appointment.procedure_template = create_clinical_procedure_template().get("name") if save: appointment.save(ignore_permissions=True) @@ -390,30 +469,30 @@ def create_appointment(patient, practitioner, appointment_date, invoice=0, proce def create_healthcare_service_items(): - if frappe.db.exists('Item', 'HLC-SI-001'): - return 'HLC-SI-001' + if frappe.db.exists("Item", "HLC-SI-001"): + return "HLC-SI-001" - item = frappe.new_doc('Item') - item.item_code = 'HLC-SI-001' - item.item_name = 'Consulting Charges' - item.item_group = 'Services' + item = frappe.new_doc("Item") + item.item_code = "HLC-SI-001" + item.item_name = "Consulting Charges" + item.item_group = "Services" item.is_stock_item = 0 - item.stock_uom = 'Nos' + item.stock_uom = "Nos" item.save() return item.name def create_clinical_procedure_template(): - if frappe.db.exists('Clinical Procedure Template', 'Knee Surgery and Rehab'): - return frappe.get_doc('Clinical Procedure Template', 'Knee Surgery and Rehab') + if frappe.db.exists("Clinical Procedure Template", "Knee Surgery and Rehab"): + return frappe.get_doc("Clinical Procedure Template", "Knee Surgery and Rehab") - template = frappe.new_doc('Clinical Procedure Template') - template.template = 'Knee Surgery and Rehab' - template.item_code = 'Knee Surgery and Rehab' - template.item_group = 'Services' + template = frappe.new_doc("Clinical Procedure Template") + template.template = "Knee Surgery and Rehab" + template.item_code = "Knee Surgery and Rehab" + template.item_group = "Services" template.is_billable = 1 - template.description = 'Knee Surgery and Rehab' + template.description = "Knee Surgery and Rehab" template.rate = 50000 template.save() @@ -422,36 +501,40 @@ def create_clinical_procedure_template(): def create_appointment_type(args=None): if not args: - args = frappe.local.form_dict + args = frappe.local.form_dict - name = args.get('name') or 'Test Appointment Type wise Charge' + name = args.get("name") or "Test Appointment Type wise Charge" - if frappe.db.exists('Appointment Type', name): - return frappe.get_doc('Appointment Type', name) + if frappe.db.exists("Appointment Type", name): + return frappe.get_doc("Appointment Type", name) else: item = create_healthcare_service_items() - items = [{ - 'medical_department': args.get('medical_department') or '_Test Medical Department', - 'op_consulting_charge_item': item, - 'op_consulting_charge': 200 - }] - return frappe.get_doc({ - 'doctype': 'Appointment Type', - 'appointment_type': args.get('name') or 'Test Appointment Type wise Charge', - 'default_duration': args.get('default_duration') or 20, - 'color': args.get('color') or '#7575ff', - 'price_list': args.get('price_list') or frappe.db.get_value("Price List", {"selling": 1}), - 'items': args.get('items') or items - }).insert() + items = [ + { + "medical_department": args.get("medical_department") or "_Test Medical Department", + "op_consulting_charge_item": item, + "op_consulting_charge": 200, + } + ] + return frappe.get_doc( + { + "doctype": "Appointment Type", + "appointment_type": args.get("name") or "Test Appointment Type wise Charge", + "default_duration": args.get("default_duration") or 20, + "color": args.get("color") or "#7575ff", + "price_list": args.get("price_list") or frappe.db.get_value("Price List", {"selling": 1}), + "items": args.get("items") or items, + } + ).insert() def create_service_unit_type(id=0, allow_appointments=1, overlap_appointments=0): - if frappe.db.exists('Healthcare Service Unit Type', f'_Test Service Unit Type {str(id)}'): - return f'_Test Service Unit Type {str(id)}' + if frappe.db.exists("Healthcare Service Unit Type", f"_Test Service Unit Type {str(id)}"): + return f"_Test Service Unit Type {str(id)}" - service_unit_type = frappe.new_doc('Healthcare Service Unit Type') - service_unit_type.service_unit_type = f'_Test Service Unit Type {str(id)}' + service_unit_type = frappe.new_doc("Healthcare Service Unit Type") + service_unit_type.service_unit_type = f"_Test Service Unit Type {str(id)}" service_unit_type.allow_appointments = allow_appointments service_unit_type.overlap_appointments = overlap_appointments service_unit_type.save(ignore_permissions=True) @@ -460,28 +543,31 @@ def create_service_unit_type(id=0, allow_appointments=1, overlap_appointments=0) def create_service_unit(id=0, service_unit_type=None, service_unit_capacity=0): - if frappe.db.exists('Healthcare Service Unit', f'_Test Service Unit {str(id)}'): - return f'_Test service_unit {str(id)}' + if frappe.db.exists("Healthcare Service Unit", f"_Test Service Unit {str(id)}"): + return f"_Test service_unit {str(id)}" - service_unit = frappe.new_doc('Healthcare Service Unit') + service_unit = frappe.new_doc("Healthcare Service Unit") service_unit.is_group = 0 - service_unit.healthcare_service_unit_name= f'_Test Service Unit {str(id)}' + service_unit.healthcare_service_unit_name = f"_Test Service Unit {str(id)}" service_unit.service_unit_type = service_unit_type or create_service_unit_type(id) service_unit.service_unit_capacity = service_unit_capacity service_unit.save(ignore_permissions=True) return service_unit.name + def create_user(email=None, roles=None): if not email: - email = '{}@frappe.com'.format(frappe.utils.random_string(10)) - user = frappe.db.exists('User', email) + email = "{}@frappe.com".format(frappe.utils.random_string(10)) + user = frappe.db.exists("User", email) if not user: - user = frappe.get_doc({ - "doctype": "User", - "email": email, - "first_name": "test_user", - "password": "password", - "roles": roles, - }).insert() + user = frappe.get_doc( + { + "doctype": "User", + "email": email, + "first_name": "test_user", + "password": "password", + "roles": roles, + } + ).insert() return user diff --git a/erpnext/healthcare/doctype/patient_assessment/patient_assessment.py b/erpnext/healthcare/doctype/patient_assessment/patient_assessment.py index fd6aac5e374..1d821a1e42e 100644 --- a/erpnext/healthcare/doctype/patient_assessment/patient_assessment.py +++ b/erpnext/healthcare/doctype/patient_assessment/patient_assessment.py @@ -17,17 +17,23 @@ class PatientAssessment(Document): total_score += int(entry.score) self.total_score_obtained = total_score + @frappe.whitelist() def create_patient_assessment(source_name, target_doc=None): - doc = get_mapped_doc('Therapy Session', source_name, { - 'Therapy Session': { - 'doctype': 'Patient Assessment', - 'field_map': [ - ['therapy_session', 'name'], - ['patient', 'patient'], - ['practitioner', 'practitioner'] - ] + doc = get_mapped_doc( + "Therapy Session", + source_name, + { + "Therapy Session": { + "doctype": "Patient Assessment", + "field_map": [ + ["therapy_session", "name"], + ["patient", "patient"], + ["practitioner", "practitioner"], + ], } - }, target_doc) + }, + target_doc, + ) return doc diff --git a/erpnext/healthcare/doctype/patient_encounter/patient_encounter.py b/erpnext/healthcare/doctype/patient_encounter/patient_encounter.py index b2fe2d5a589..ff804ead540 100644 --- a/erpnext/healthcare/doctype/patient_encounter/patient_encounter.py +++ b/erpnext/healthcare/doctype/patient_encounter/patient_encounter.py @@ -15,7 +15,7 @@ class PatientEncounter(Document): def on_update(self): if self.appointment: - frappe.db.set_value('Patient Appointment', self.appointment, 'status', 'Closed') + frappe.db.set_value("Patient Appointment", self.appointment, "status", "Closed") def on_submit(self): if self.therapies: @@ -23,58 +23,59 @@ class PatientEncounter(Document): def on_cancel(self): if self.appointment: - frappe.db.set_value('Patient Appointment', self.appointment, 'status', 'Open') + frappe.db.set_value("Patient Appointment", self.appointment, "status", "Open") if self.inpatient_record and self.drug_prescription: delete_ip_medication_order(self) def set_title(self): - self.title = _('{0} with {1}').format(self.patient_name or self.patient, - self.practitioner_name or self.practitioner)[:100] + self.title = _("{0} with {1}").format( + self.patient_name or self.patient, self.practitioner_name or self.practitioner + )[:100] @frappe.whitelist() @staticmethod def get_applicable_treatment_plans(encounter): - patient = frappe.get_doc('Patient', encounter['patient']) + patient = frappe.get_doc("Patient", encounter["patient"]) plan_filters = {} - plan_filters['name'] = ['in', []] + plan_filters["name"] = ["in", []] age = patient.age if age: - plan_filters['patient_age_from'] = ['<=', age.years] - plan_filters['patient_age_to'] = ['>=', age.years] + plan_filters["patient_age_from"] = ["<=", age.years] + plan_filters["patient_age_to"] = [">=", age.years] gender = patient.sex if gender: - plan_filters['gender'] = ['in', [gender, None]] + plan_filters["gender"] = ["in", [gender, None]] - diagnosis = encounter.get('diagnosis') + diagnosis = encounter.get("diagnosis") if diagnosis: - diagnosis = [_diagnosis['diagnosis'] for _diagnosis in encounter['diagnosis']] + diagnosis = [_diagnosis["diagnosis"] for _diagnosis in encounter["diagnosis"]] filters = [ - ['diagnosis', 'in', diagnosis], - ['parenttype', '=', 'Treatment Plan Template'], + ["diagnosis", "in", diagnosis], + ["parenttype", "=", "Treatment Plan Template"], ] - diagnosis = frappe.get_list('Patient Encounter Diagnosis', filters=filters, fields='*') - plan_names = [_diagnosis['parent'] for _diagnosis in diagnosis] - plan_filters['name'][1].extend(plan_names) + diagnosis = frappe.get_list("Patient Encounter Diagnosis", filters=filters, fields="*") + plan_names = [_diagnosis["parent"] for _diagnosis in diagnosis] + plan_filters["name"][1].extend(plan_names) - symptoms = encounter.get('symptoms') + symptoms = encounter.get("symptoms") if symptoms: - symptoms = [symptom['complaint'] for symptom in encounter['symptoms']] + symptoms = [symptom["complaint"] for symptom in encounter["symptoms"]] filters = [ - ['complaint', 'in', symptoms], - ['parenttype', '=', 'Treatment Plan Template'], + ["complaint", "in", symptoms], + ["parenttype", "=", "Treatment Plan Template"], ] - symptoms = frappe.get_list('Patient Encounter Symptom', filters=filters, fields='*') - plan_names = [symptom['parent'] for symptom in symptoms] - plan_filters['name'][1].extend(plan_names) + symptoms = frappe.get_list("Patient Encounter Symptom", filters=filters, fields="*") + plan_names = [symptom["parent"] for symptom in symptoms] + plan_filters["name"][1].extend(plan_names) - if not plan_filters['name'][1]: - plan_filters.pop('name') + if not plan_filters["name"][1]: + plan_filters.pop("name") - plans = frappe.get_list('Treatment Plan Template', fields='*', filters=plan_filters) + plans = frappe.get_list("Treatment Plan Template", fields="*", filters=plan_filters) return plans @@ -84,31 +85,27 @@ class PatientEncounter(Document): self.set_treatment_plan(treatment_plan) def set_treatment_plan(self, plan): - plan_items = frappe.get_list('Treatment Plan Template Item', filters={'parent': plan}, fields='*') + plan_items = frappe.get_list( + "Treatment Plan Template Item", filters={"parent": plan}, fields="*" + ) for plan_item in plan_items: self.set_treatment_plan_item(plan_item) - drugs = frappe.get_list('Drug Prescription', filters={'parent': plan}, fields='*') + drugs = frappe.get_list("Drug Prescription", filters={"parent": plan}, fields="*") for drug in drugs: - self.append('drug_prescription', drug) + self.append("drug_prescription", drug) self.save() def set_treatment_plan_item(self, plan_item): - if plan_item.type == 'Clinical Procedure Template': - self.append('procedure_prescription', { - 'procedure': plan_item.template - }) + if plan_item.type == "Clinical Procedure Template": + self.append("procedure_prescription", {"procedure": plan_item.template}) - if plan_item.type == 'Lab Test Template': - self.append('lab_test_prescription', { - 'lab_test_code': plan_item.template - }) + if plan_item.type == "Lab Test Template": + self.append("lab_test_prescription", {"lab_test_code": plan_item.template}) - if plan_item.type == 'Therapy Type': - self.append('therapies', { - 'therapy_type': plan_item.template - }) + if plan_item.type == "Therapy Type": + self.append("therapies", {"therapy_type": plan_item.template}) @frappe.whitelist() @@ -117,11 +114,11 @@ def make_ip_medication_order(source_name, target_doc=None): target.start_date = source.encounter_date for entry in source.drug_prescription: if entry.drug_code: - dosage = frappe.get_doc('Prescription Dosage', entry.dosage) + dosage = frappe.get_doc("Prescription Dosage", entry.dosage) dates = get_prescription_dates(entry.period, target.start_date) for date in dates: for dose in dosage.dosage_strength: - order = target.append('medication_orders') + order = target.append("medication_orders") order.drug = entry.drug_code order.drug_name = entry.drug_name order.dosage = dose.strength @@ -131,26 +128,32 @@ def make_ip_medication_order(source_name, target_doc=None): order.time = dose.strength_time target.end_date = dates[-1] - doc = get_mapped_doc('Patient Encounter', source_name, { - 'Patient Encounter': { - 'doctype': 'Inpatient Medication Order', - 'field_map': { - 'name': 'patient_encounter', - 'patient': 'patient', - 'patient_name': 'patient_name', - 'patient_age': 'patient_age', - 'inpatient_record': 'inpatient_record', - 'practitioner': 'practitioner', - 'start_date': 'encounter_date' + doc = get_mapped_doc( + "Patient Encounter", + source_name, + { + "Patient Encounter": { + "doctype": "Inpatient Medication Order", + "field_map": { + "name": "patient_encounter", + "patient": "patient", + "patient_name": "patient_name", + "patient_age": "patient_age", + "inpatient_record": "inpatient_record", + "practitioner": "practitioner", + "start_date": "encounter_date", }, } - }, target_doc, set_missing_values) + }, + target_doc, + set_missing_values, + ) return doc def get_prescription_dates(period, start_date): - prescription_duration = frappe.get_doc('Prescription Duration', period) + prescription_duration = frappe.get_doc("Prescription Duration", period) days = prescription_duration.get_days() dates = [start_date] for i in range(1, days): @@ -160,21 +163,23 @@ def get_prescription_dates(period, start_date): def create_therapy_plan(encounter): if len(encounter.therapies): - doc = frappe.new_doc('Therapy Plan') + doc = frappe.new_doc("Therapy Plan") doc.patient = encounter.patient doc.start_date = encounter.encounter_date for entry in encounter.therapies: - doc.append('therapy_plan_details', { - 'therapy_type': entry.therapy_type, - 'no_of_sessions': entry.no_of_sessions - }) + doc.append( + "therapy_plan_details", + {"therapy_type": entry.therapy_type, "no_of_sessions": entry.no_of_sessions}, + ) doc.save(ignore_permissions=True) - if doc.get('name'): - encounter.db_set('therapy_plan', doc.name) - frappe.msgprint(_('Therapy Plan {0} created successfully.').format(frappe.bold(doc.name)), alert=True) + if doc.get("name"): + encounter.db_set("therapy_plan", doc.name) + frappe.msgprint( + _("Therapy Plan {0} created successfully.").format(frappe.bold(doc.name)), alert=True + ) def delete_ip_medication_order(encounter): - record = frappe.db.exists('Inpatient Medication Order', {'patient_encounter': encounter.name}) + record = frappe.db.exists("Inpatient Medication Order", {"patient_encounter": encounter.name}) if record: - frappe.delete_doc('Inpatient Medication Order', record, force=1) + frappe.delete_doc("Inpatient Medication Order", record, force=1) diff --git a/erpnext/healthcare/doctype/patient_encounter/patient_encounter_dashboard.py b/erpnext/healthcare/doctype/patient_encounter/patient_encounter_dashboard.py index 3db13be6b7d..f796e23f420 100644 --- a/erpnext/healthcare/doctype/patient_encounter/patient_encounter_dashboard.py +++ b/erpnext/healthcare/doctype/patient_encounter/patient_encounter_dashboard.py @@ -1,23 +1,16 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'encounter', - 'non_standard_fieldnames': { - 'Patient Medical Record': 'reference_name', - 'Inpatient Medication Order': 'patient_encounter' + "fieldname": "encounter", + "non_standard_fieldnames": { + "Patient Medical Record": "reference_name", + "Inpatient Medication Order": "patient_encounter", }, - 'transactions': [ - { - 'label': _('Records'), - 'items': ['Vital Signs', 'Patient Medical Record'] - }, - { - 'label': _('Orders'), - 'items': ['Inpatient Medication Order'] - } + "transactions": [ + {"label": _("Records"), "items": ["Vital Signs", "Patient Medical Record"]}, + {"label": _("Orders"), "items": ["Inpatient Medication Order"]}, ], - 'disable_create_buttons': ['Inpatient Medication Order'] + "disable_create_buttons": ["Inpatient Medication Order"], } diff --git a/erpnext/healthcare/doctype/patient_encounter/test_patient_encounter.py b/erpnext/healthcare/doctype/patient_encounter/test_patient_encounter.py index 8260918c0d2..88f34d82dc0 100644 --- a/erpnext/healthcare/doctype/patient_encounter/test_patient_encounter.py +++ b/erpnext/healthcare/doctype/patient_encounter/test_patient_encounter.py @@ -11,75 +11,81 @@ from erpnext.healthcare.doctype.patient_encounter.patient_encounter import Patie class TestPatientEncounter(unittest.TestCase): def setUp(self): try: - gender_m = frappe.get_doc({ - 'doctype': 'Gender', - 'gender': 'MALE' - }).insert() - gender_f = frappe.get_doc({ - 'doctype': 'Gender', - 'gender': 'FEMALE' - }).insert() + gender_m = frappe.get_doc({"doctype": "Gender", "gender": "MALE"}).insert() + gender_f = frappe.get_doc({"doctype": "Gender", "gender": "FEMALE"}).insert() except frappe.exceptions.DuplicateEntryError: - gender_m = frappe.get_doc({ - 'doctype': 'Gender', - 'gender': 'MALE' - }) - gender_f = frappe.get_doc({ - 'doctype': 'Gender', - 'gender': 'FEMALE' - }) + gender_m = frappe.get_doc({"doctype": "Gender", "gender": "MALE"}) + gender_f = frappe.get_doc({"doctype": "Gender", "gender": "FEMALE"}) - self.patient_male = frappe.get_doc({ - 'doctype': 'Patient', - 'first_name': 'John', - 'sex': gender_m.gender, - }).insert() - self.patient_female = frappe.get_doc({ - 'doctype': 'Patient', - 'first_name': 'Curie', - 'sex': gender_f.gender, - }).insert() - self.practitioner = frappe.get_doc({ - 'doctype': 'Healthcare Practitioner', - 'first_name': 'Doc', - 'sex': 'MALE', - }).insert() + self.patient_male = frappe.get_doc( + { + "doctype": "Patient", + "first_name": "John", + "sex": gender_m.gender, + } + ).insert() + self.patient_female = frappe.get_doc( + { + "doctype": "Patient", + "first_name": "Curie", + "sex": gender_f.gender, + } + ).insert() + self.practitioner = frappe.get_doc( + { + "doctype": "Healthcare Practitioner", + "first_name": "Doc", + "sex": "MALE", + } + ).insert() try: - self.care_plan_male = frappe.get_doc({ - 'doctype': 'Treatment Plan Template', - 'template_name': 'test plan - m', - 'gender': gender_m.gender, - }).insert() - self.care_plan_female = frappe.get_doc({ - 'doctype': 'Treatment Plan Template', - 'template_name': 'test plan - f', - 'gender': gender_f.gender, - }).insert() + self.care_plan_male = frappe.get_doc( + { + "doctype": "Treatment Plan Template", + "template_name": "test plan - m", + "gender": gender_m.gender, + } + ).insert() + self.care_plan_female = frappe.get_doc( + { + "doctype": "Treatment Plan Template", + "template_name": "test plan - f", + "gender": gender_f.gender, + } + ).insert() except frappe.exceptions.DuplicateEntryError: - self.care_plan_male = frappe.get_doc({ - 'doctype': 'Treatment Plan Template', - 'template_name': 'test plan - m', - 'gender': gender_m.gender, - }) - self.care_plan_female = frappe.get_doc({ - 'doctype': 'Treatment Plan Template', - 'template_name': 'test plan - f', - 'gender': gender_f.gender, - }) + self.care_plan_male = frappe.get_doc( + { + "doctype": "Treatment Plan Template", + "template_name": "test plan - m", + "gender": gender_m.gender, + } + ) + self.care_plan_female = frappe.get_doc( + { + "doctype": "Treatment Plan Template", + "template_name": "test plan - f", + "gender": gender_f.gender, + } + ) def test_treatment_plan_template_filter(self): - encounter = frappe.get_doc({ - 'doctype': 'Patient Encounter', - 'patient': self.patient_male.name, - 'practitioner': self.practitioner.name, - }).insert() + encounter = frappe.get_doc( + { + "doctype": "Patient Encounter", + "patient": self.patient_male.name, + "practitioner": self.practitioner.name, + } + ).insert() plans = PatientEncounter.get_applicable_treatment_plans(encounter.as_dict()) - self.assertEqual(plans[0]['name'], self.care_plan_male.template_name) + self.assertEqual(plans[0]["name"], self.care_plan_male.template_name) - encounter = frappe.get_doc({ - 'doctype': 'Patient Encounter', - 'patient': self.patient_female.name, - 'practitioner': self.practitioner.name, - }).insert() + encounter = frappe.get_doc( + { + "doctype": "Patient Encounter", + "patient": self.patient_female.name, + "practitioner": self.practitioner.name, + } + ).insert() plans = PatientEncounter.get_applicable_treatment_plans(encounter.as_dict()) - self.assertEqual(plans[0]['name'], self.care_plan_female.template_name) + self.assertEqual(plans[0]["name"], self.care_plan_female.template_name) diff --git a/erpnext/healthcare/doctype/patient_history_settings/patient_history_settings.py b/erpnext/healthcare/doctype/patient_history_settings/patient_history_settings.py index 4c5d39f0335..4161f1dcaea 100644 --- a/erpnext/healthcare/doctype/patient_history_settings/patient_history_settings.py +++ b/erpnext/healthcare/doctype/patient_history_settings/patient_history_settings.py @@ -19,22 +19,29 @@ class PatientHistorySettings(Document): def validate_submittable_doctypes(self): for entry in self.custom_doctypes: - if not cint(frappe.db.get_value('DocType', entry.document_type, 'is_submittable')): - msg = _('Row #{0}: Document Type {1} is not submittable.').format( - entry.idx, frappe.bold(entry.document_type)) - msg += _('Patient Medical Record can only be created for submittable document types.') + if not cint(frappe.db.get_value("DocType", entry.document_type, "is_submittable")): + msg = _("Row #{0}: Document Type {1} is not submittable.").format( + entry.idx, frappe.bold(entry.document_type) + ) + msg += _("Patient Medical Record can only be created for submittable document types.") frappe.throw(msg) def validate_date_fieldnames(self): for entry in self.custom_doctypes: field = frappe.get_meta(entry.document_type).get_field(entry.date_fieldname) if not field: - frappe.throw(_('Row #{0}: No such Field named {1} found in the Document Type {2}.').format( - entry.idx, frappe.bold(entry.date_fieldname), frappe.bold(entry.document_type))) + frappe.throw( + _("Row #{0}: No such Field named {1} found in the Document Type {2}.").format( + entry.idx, frappe.bold(entry.date_fieldname), frappe.bold(entry.document_type) + ) + ) - if field.fieldtype not in ['Date', 'Datetime']: - frappe.throw(_('Row #{0}: Field {1} in Document Type {2} is not a Date / Datetime field.').format( - entry.idx, frappe.bold(entry.date_fieldname), frappe.bold(entry.document_type))) + if field.fieldtype not in ["Date", "Datetime"]: + frappe.throw( + _("Row #{0}: Field {1} in Document Type {2} is not a Date / Datetime field.").format( + entry.idx, frappe.bold(entry.date_fieldname), frappe.bold(entry.document_type) + ) + ) @frappe.whitelist() def get_doctype_fields(self, document_type, fields): @@ -42,40 +49,44 @@ class PatientHistorySettings(Document): doc_fields = frappe.get_meta(document_type).fields for field in doc_fields: - if field.fieldtype not in frappe.model.no_value_fields or \ - field.fieldtype in frappe.model.table_fields and not field.hidden: - multicheck_fields.append({ - 'label': field.label, - 'value': field.fieldname, - 'checked': 1 if field.fieldname in fields else 0 - }) + if ( + field.fieldtype not in frappe.model.no_value_fields + or field.fieldtype in frappe.model.table_fields + and not field.hidden + ): + multicheck_fields.append( + { + "label": field.label, + "value": field.fieldname, + "checked": 1 if field.fieldname in fields else 0, + } + ) return multicheck_fields @frappe.whitelist() def get_date_field_for_dt(self, document_type): meta = frappe.get_meta(document_type) - date_fields = meta.get('fields', { - 'fieldtype': ['in', ['Date', 'Datetime']] - }) + date_fields = meta.get("fields", {"fieldtype": ["in", ["Date", "Datetime"]]}) if date_fields: - return date_fields[0].get('fieldname') + return date_fields[0].get("fieldname") + def create_medical_record(doc, method=None): medical_record_required = validate_medical_record_required(doc) if not medical_record_required: return - if frappe.db.exists('Patient Medical Record', { 'reference_name': doc.name }): + if frappe.db.exists("Patient Medical Record", {"reference_name": doc.name}): return subject = set_subject_field(doc) date_field = get_date_field(doc.doctype) - medical_record = frappe.new_doc('Patient Medical Record') + medical_record = frappe.new_doc("Patient Medical Record") medical_record.patient = doc.patient medical_record.subject = subject - medical_record.status = 'Open' + medical_record.status = "Open" medical_record.communication_date = doc.get(date_field) medical_record.reference_doctype = doc.doctype medical_record.reference_name = doc.name @@ -88,11 +99,11 @@ def update_medical_record(doc, method=None): if not medical_record_required: return - medical_record_id = frappe.db.exists('Patient Medical Record', { 'reference_name': doc.name }) + medical_record_id = frappe.db.exists("Patient Medical Record", {"reference_name": doc.name}) if medical_record_id: subject = set_subject_field(doc) - frappe.db.set_value('Patient Medical Record', medical_record_id[0][0], 'subject', subject) + frappe.db.set_value("Patient Medical Record", medical_record_id[0][0], "subject", subject) else: create_medical_record(doc) @@ -102,28 +113,30 @@ def delete_medical_record(doc, method=None): if not medical_record_required: return - record = frappe.db.exists('Patient Medical Record', { 'reference_name': doc.name }) + record = frappe.db.exists("Patient Medical Record", {"reference_name": doc.name}) if record: - frappe.delete_doc('Patient Medical Record', record, force=1) + frappe.delete_doc("Patient Medical Record", record, force=1) def set_subject_field(doc): from frappe.utils.formatters import format_value meta = frappe.get_meta(doc.doctype) - subject = '' + subject = "" patient_history_fields = get_patient_history_fields(doc) for entry in patient_history_fields: - fieldname = entry.get('fieldname') - if entry.get('fieldtype') == 'Table' and doc.get(fieldname): - formatted_value = get_formatted_value_for_table_field(doc.get(fieldname), meta.get_field(fieldname)) - subject += frappe.bold(_(entry.get('label')) + ':') + '
' + cstr(formatted_value) + '
' + fieldname = entry.get("fieldname") + if entry.get("fieldtype") == "Table" and doc.get(fieldname): + formatted_value = get_formatted_value_for_table_field( + doc.get(fieldname), meta.get_field(fieldname) + ) + subject += frappe.bold(_(entry.get("label")) + ":") + "
" + cstr(formatted_value) + "
" else: if doc.get(fieldname): formatted_value = format_value(doc.get(fieldname), meta.get_field(fieldname), doc) - subject += frappe.bold(_(entry.get('label')) + ':') + cstr(formatted_value) + '
' + subject += frappe.bold(_(entry.get("label")) + ":") + cstr(formatted_value) + "
" return subject @@ -131,12 +144,14 @@ def set_subject_field(doc): def get_date_field(doctype): dt = get_patient_history_config_dt(doctype) - return frappe.db.get_value(dt, { 'document_type': doctype }, 'date_fieldname') + return frappe.db.get_value(dt, {"document_type": doctype}, "date_fieldname") def get_patient_history_fields(doc): dt = get_patient_history_config_dt(doc.doctype) - patient_history_fields = frappe.db.get_value(dt, { 'document_type': doc.doctype }, 'selected_fields') + patient_history_fields = frappe.db.get_value( + dt, {"document_type": doc.doctype}, "selected_fields" + ) if patient_history_fields: return json.loads(patient_history_fields) @@ -145,38 +160,44 @@ def get_patient_history_fields(doc): def get_formatted_value_for_table_field(items, df): child_meta = frappe.get_meta(df.options) - table_head = '' - table_row = '' - html = '' + table_head = "" + table_row = "" + html = "" create_head = True for item in items: - table_row += '
"
for doc in docs:
- docs_html += render_doc_as_html(doc['doctype'], doc['docname'])['html'] + '
' - return {'html': docs_html} + docs_html += render_doc_as_html(doc["doctype"], doc["docname"])["html"] + "
" + return {"html": docs_html} @frappe.whitelist() -def render_doc_as_html(doctype, docname, exclude_fields = None): +def render_doc_as_html(doctype, docname, exclude_fields=None): """ - Render document as HTML + Render document as HTML """ doc = frappe.get_doc(doctype, docname) @@ -642,7 +727,9 @@ def render_doc_as_html(doctype, docname, exclude_fields = None): {1} {2}
' - return {'html': docs_html} + docs_html += render_doc_as_html(doc["doctype"], doc["docname"])["html"] + "
" + return {"html": docs_html} @frappe.whitelist() -def render_doc_as_html(doctype, docname, exclude_fields = None): +def render_doc_as_html(doctype, docname, exclude_fields=None): """ - Render document as HTML + Render document as HTML """ doc = frappe.get_doc(doctype, docname) @@ -642,7 +727,9 @@ def render_doc_as_html(doctype, docname, exclude_fields = None): {1} {2}
{1}
- """.format(section_label, html)
+ """.format(
+ section_label, html
+ )
elif col_on == 1 and has_data:
section_html += "" + html + "
"
elif col_on > 1 and has_data:
@@ -684,7 +773,9 @@ def render_doc_as_html(doctype, docname, exclude_fields = None):
{0}
{0} : {1}".format(df.label or df.fieldname, formatted_value) - if not has_data : has_data = True + if not has_data: + has_data = True if sec_on and col_on and has_data: doc_html += section_html + html + "
It is {0}").format(str(total_w) + "%")) + frappe.throw( + _("Total weightage assigned should be 100%.
It is {0}").format(str(total_w) + "%") + ) - if frappe.db.get_value("Employee", self.employee, "user_id") != \ - frappe.session.user and total == 0: + if ( + frappe.db.get_value("Employee", self.employee, "user_id") != frappe.session.user and total == 0 + ): frappe.throw(_("Total cannot be zero")) self.total_score = total def on_submit(self): - frappe.db.set(self, 'status', 'Submitted') + frappe.db.set(self, "status", "Submitted") def on_cancel(self): - frappe.db.set(self, 'status', 'Cancelled') + frappe.db.set(self, "status", "Cancelled") + @frappe.whitelist() def fetch_appraisal_template(source_name, target_doc=None): - target_doc = get_mapped_doc("Appraisal Template", source_name, { - "Appraisal Template": { - "doctype": "Appraisal", + target_doc = get_mapped_doc( + "Appraisal Template", + source_name, + { + "Appraisal Template": { + "doctype": "Appraisal", + }, + "Appraisal Template Goal": { + "doctype": "Appraisal Goal", + }, }, - "Appraisal Template Goal": { - "doctype": "Appraisal Goal", - } - }, target_doc) + target_doc, + ) return target_doc diff --git a/erpnext/hr/doctype/appraisal/test_appraisal.py b/erpnext/hr/doctype/appraisal/test_appraisal.py index 90c30ef3475..13a39f38200 100644 --- a/erpnext/hr/doctype/appraisal/test_appraisal.py +++ b/erpnext/hr/doctype/appraisal/test_appraisal.py @@ -5,5 +5,6 @@ import unittest # test_records = frappe.get_test_records('Appraisal') + class TestAppraisal(unittest.TestCase): pass diff --git a/erpnext/hr/doctype/appraisal_template/appraisal_template_dashboard.py b/erpnext/hr/doctype/appraisal_template/appraisal_template_dashboard.py index f52e2b027ca..476de4f51b4 100644 --- a/erpnext/hr/doctype/appraisal_template/appraisal_template_dashboard.py +++ b/erpnext/hr/doctype/appraisal_template/appraisal_template_dashboard.py @@ -1,11 +1,7 @@ - - def get_data(): - return { - 'fieldname': 'kra_template', - 'transactions': [ - { - 'items': ['Appraisal'] - }, - ], - } + return { + "fieldname": "kra_template", + "transactions": [ + {"items": ["Appraisal"]}, + ], + } diff --git a/erpnext/hr/doctype/appraisal_template/test_appraisal_template.py b/erpnext/hr/doctype/appraisal_template/test_appraisal_template.py index d0e81a7dc5b..560e992e8a1 100644 --- a/erpnext/hr/doctype/appraisal_template/test_appraisal_template.py +++ b/erpnext/hr/doctype/appraisal_template/test_appraisal_template.py @@ -5,5 +5,6 @@ import unittest # test_records = frappe.get_test_records('Appraisal Template') + class TestAppraisalTemplate(unittest.TestCase): pass diff --git a/erpnext/hr/doctype/attendance/attendance.py b/erpnext/hr/doctype/attendance/attendance.py index 7dcfac249f4..7e51db2978b 100644 --- a/erpnext/hr/doctype/attendance/attendance.py +++ b/erpnext/hr/doctype/attendance/attendance.py @@ -5,14 +5,15 @@ import frappe from frappe import _ from frappe.model.document import Document -from frappe.utils import cstr, formatdate, get_datetime, getdate, nowdate +from frappe.utils import cint, cstr, formatdate, get_datetime, getdate, nowdate -from erpnext.hr.utils import validate_active_employee +from erpnext.hr.utils import get_holiday_dates_for_employee, validate_active_employee class Attendance(Document): def validate(self): from erpnext.controllers.status_updater import validate_status + validate_status(self.status, ["Present", "Absent", "On Leave", "Half Day", "Work From Home"]) validate_active_employee(self.employee) self.validate_attendance_date() @@ -20,66 +21,120 @@ class Attendance(Document): self.validate_employee_status() self.check_leave_record() + def on_cancel(self): + self.unlink_attendance_from_checkins() + def validate_attendance_date(self): date_of_joining = frappe.db.get_value("Employee", self.employee, "date_of_joining") # leaves can be marked for future dates - if self.status != 'On Leave' and not self.leave_application and getdate(self.attendance_date) > getdate(nowdate()): + if ( + self.status != "On Leave" + and not self.leave_application + and getdate(self.attendance_date) > getdate(nowdate()) + ): frappe.throw(_("Attendance can not be marked for future dates")) elif date_of_joining and getdate(self.attendance_date) < getdate(date_of_joining): frappe.throw(_("Attendance date can not be less than employee's joining date")) def validate_duplicate_record(self): - res = frappe.db.sql(""" + res = frappe.db.sql( + """ select name from `tabAttendance` where employee = %s and attendance_date = %s and name != %s and docstatus != 2 - """, (self.employee, getdate(self.attendance_date), self.name)) + """, + (self.employee, getdate(self.attendance_date), self.name), + ) if res: - frappe.throw(_("Attendance for employee {0} is already marked for the date {1}").format( - frappe.bold(self.employee), frappe.bold(self.attendance_date))) + frappe.throw( + _("Attendance for employee {0} is already marked for the date {1}").format( + frappe.bold(self.employee), frappe.bold(self.attendance_date) + ) + ) def validate_employee_status(self): if frappe.db.get_value("Employee", self.employee, "status") == "Inactive": frappe.throw(_("Cannot mark attendance for an Inactive employee {0}").format(self.employee)) def check_leave_record(self): - leave_record = frappe.db.sql(""" + leave_record = frappe.db.sql( + """ select leave_type, half_day, half_day_date from `tabLeave Application` where employee = %s and %s between from_date and to_date and status = 'Approved' and docstatus = 1 - """, (self.employee, self.attendance_date), as_dict=True) + """, + (self.employee, self.attendance_date), + as_dict=True, + ) if leave_record: for d in leave_record: self.leave_type = d.leave_type if d.half_day_date == getdate(self.attendance_date): - self.status = 'Half Day' - frappe.msgprint(_("Employee {0} on Half day on {1}") - .format(self.employee, formatdate(self.attendance_date))) + self.status = "Half Day" + frappe.msgprint( + _("Employee {0} on Half day on {1}").format(self.employee, formatdate(self.attendance_date)) + ) else: - self.status = 'On Leave' - frappe.msgprint(_("Employee {0} is on Leave on {1}") - .format(self.employee, formatdate(self.attendance_date))) + self.status = "On Leave" + frappe.msgprint( + _("Employee {0} is on Leave on {1}").format(self.employee, formatdate(self.attendance_date)) + ) if self.status in ("On Leave", "Half Day"): if not leave_record: - frappe.msgprint(_("No leave record found for employee {0} on {1}") - .format(self.employee, formatdate(self.attendance_date)), alert=1) + frappe.msgprint( + _("No leave record found for employee {0} on {1}").format( + self.employee, formatdate(self.attendance_date) + ), + alert=1, + ) elif self.leave_type: self.leave_type = None self.leave_application = None def validate_employee(self): - emp = frappe.db.sql("select name from `tabEmployee` where name = %s and status = 'Active'", - self.employee) + emp = frappe.db.sql( + "select name from `tabEmployee` where name = %s and status = 'Active'", self.employee + ) if not emp: frappe.throw(_("Employee {0} is not active or does not exist").format(self.employee)) + def unlink_attendance_from_checkins(self): + from frappe.utils import get_link_to_form + + EmployeeCheckin = frappe.qb.DocType("Employee Checkin") + linked_logs = ( + frappe.qb.from_(EmployeeCheckin) + .select(EmployeeCheckin.name) + .where(EmployeeCheckin.attendance == self.name) + .for_update() + .run(as_dict=True) + ) + + if linked_logs: + ( + frappe.qb.update(EmployeeCheckin) + .set("attendance", "") + .where(EmployeeCheckin.attendance == self.name) + ).run() + + frappe.msgprint( + msg=_("Unlinked Attendance record from Employee Checkins: {}").format( + ", ".join(get_link_to_form("Employee Checkin", log.name) for log in linked_logs) + ), + title=_("Unlinked logs"), + indicator="blue", + is_minimizable=True, + wide=True, + ) + + @frappe.whitelist() def get_events(start, end, filters=None): events = [] @@ -90,10 +145,12 @@ def get_events(start, end, filters=None): return events from frappe.desk.reportview import get_filters_cond + conditions = get_filters_cond("Attendance", filters, []) add_attendance(events, start, end, conditions=conditions) return events + def add_attendance(events, start, end, conditions=None): query = """select name, attendance_date, status from `tabAttendance` where @@ -102,100 +159,133 @@ def add_attendance(events, start, end, conditions=None): if conditions: query += conditions - for d in frappe.db.sql(query, {"from_date":start, "to_date":end}, as_dict=True): + for d in frappe.db.sql(query, {"from_date": start, "to_date": end}, as_dict=True): e = { "name": d.name, "doctype": "Attendance", "start": d.attendance_date, "end": d.attendance_date, "title": cstr(d.status), - "docstatus": d.docstatus + "docstatus": d.docstatus, } if e not in events: events.append(e) -def mark_attendance(employee, attendance_date, status, shift=None, leave_type=None, ignore_validate=False): - if not frappe.db.exists('Attendance', {'employee':employee, 'attendance_date':attendance_date, 'docstatus':('!=', '2')}): - company = frappe.db.get_value('Employee', employee, 'company') - attendance = frappe.get_doc({ - 'doctype': 'Attendance', - 'employee': employee, - 'attendance_date': attendance_date, - 'status': status, - 'company': company, - 'shift': shift, - 'leave_type': leave_type - }) + +def mark_attendance( + employee, attendance_date, status, shift=None, leave_type=None, ignore_validate=False +): + if not frappe.db.exists( + "Attendance", + {"employee": employee, "attendance_date": attendance_date, "docstatus": ("!=", "2")}, + ): + company = frappe.db.get_value("Employee", employee, "company") + attendance = frappe.get_doc( + { + "doctype": "Attendance", + "employee": employee, + "attendance_date": attendance_date, + "status": status, + "company": company, + "shift": shift, + "leave_type": leave_type, + } + ) attendance.flags.ignore_validate = ignore_validate attendance.insert() attendance.submit() return attendance.name + @frappe.whitelist() def mark_bulk_attendance(data): import json + if isinstance(data, str): data = json.loads(data) data = frappe._dict(data) - company = frappe.get_value('Employee', data.employee, 'company') + company = frappe.get_value("Employee", data.employee, "company") if not data.unmarked_days: frappe.throw(_("Please select a date.")) return for date in data.unmarked_days: doc_dict = { - 'doctype': 'Attendance', - 'employee': data.employee, - 'attendance_date': get_datetime(date), - 'status': data.status, - 'company': company, + "doctype": "Attendance", + "employee": data.employee, + "attendance_date": get_datetime(date), + "status": data.status, + "company": company, } attendance = frappe.get_doc(doc_dict).insert() attendance.submit() def get_month_map(): - return frappe._dict({ - "January": 1, - "February": 2, - "March": 3, - "April": 4, - "May": 5, - "June": 6, - "July": 7, - "August": 8, - "September": 9, - "October": 10, - "November": 11, - "December": 12 - }) + return frappe._dict( + { + "January": 1, + "February": 2, + "March": 3, + "April": 4, + "May": 5, + "June": 6, + "July": 7, + "August": 8, + "September": 9, + "October": 10, + "November": 11, + "December": 12, + } + ) + @frappe.whitelist() -def get_unmarked_days(employee, month): +def get_unmarked_days(employee, month, exclude_holidays=0): import calendar - month_map = get_month_map() + month_map = get_month_map() today = get_datetime() - dates_of_month = ['{}-{}-{}'.format(today.year, month_map[month], r) for r in range(1, calendar.monthrange(today.year, month_map[month])[1] + 1)] + joining_date, relieving_date = frappe.get_cached_value( + "Employee", employee, ["date_of_joining", "relieving_date"] + ) + start_day = 1 + end_day = calendar.monthrange(today.year, month_map[month])[1] + 1 - length = len(dates_of_month) - month_start, month_end = dates_of_month[0], dates_of_month[length-1] + if joining_date and joining_date.month == month_map[month]: + start_day = joining_date.day + if relieving_date and relieving_date.month == month_map[month]: + end_day = relieving_date.day + 1 - records = frappe.get_all("Attendance", fields = ['attendance_date', 'employee'] , filters = [ - ["attendance_date", ">=", month_start], - ["attendance_date", "<=", month_end], - ["employee", "=", employee], - ["docstatus", "!=", 2] - ]) + dates_of_month = [ + "{}-{}-{}".format(today.year, month_map[month], r) for r in range(start_day, end_day) + ] + month_start, month_end = dates_of_month[0], dates_of_month[-1] + + records = frappe.get_all( + "Attendance", + fields=["attendance_date", "employee"], + filters=[ + ["attendance_date", ">=", month_start], + ["attendance_date", "<=", month_end], + ["employee", "=", employee], + ["docstatus", "!=", 2], + ], + ) marked_days = [get_datetime(record.attendance_date) for record in records] + if cint(exclude_holidays): + holiday_dates = get_holiday_dates_for_employee(employee, month_start, month_end) + holidays = [get_datetime(record) for record in holiday_dates] + marked_days.extend(holidays) + unmarked_days = [] for date in dates_of_month: date_time = get_datetime(date) - if today.day == date_time.day and today.month == date_time.month: + if today.day <= date_time.day and today.month <= date_time.month: break if date_time not in marked_days: unmarked_days.append(date) diff --git a/erpnext/hr/doctype/attendance/attendance_dashboard.py b/erpnext/hr/doctype/attendance/attendance_dashboard.py index f466534d2c7..abed78fbbbe 100644 --- a/erpnext/hr/doctype/attendance/attendance_dashboard.py +++ b/erpnext/hr/doctype/attendance/attendance_dashboard.py @@ -1,12 +1,2 @@ - - def get_data(): - return { - 'fieldname': 'attendance', - 'transactions': [ - { - 'label': '', - 'items': ['Employee Checkin'] - } - ] - } + return {"fieldname": "attendance", "transactions": [{"label": "", "items": ["Employee Checkin"]}]} diff --git a/erpnext/hr/doctype/attendance/attendance_list.js b/erpnext/hr/doctype/attendance/attendance_list.js index 6b3c29a76b4..3a5c5915396 100644 --- a/erpnext/hr/doctype/attendance/attendance_list.js +++ b/erpnext/hr/doctype/attendance/attendance_list.js @@ -28,6 +28,7 @@ frappe.listview_settings['Attendance'] = { onchange: function() { dialog.set_df_property("unmarked_days", "hidden", 1); dialog.set_df_property("status", "hidden", 1); + dialog.set_df_property("exclude_holidays", "hidden", 1); dialog.set_df_property("month", "value", ''); dialog.set_df_property("unmarked_days", "options", []); dialog.no_unmarked_days_left = false; @@ -42,9 +43,14 @@ frappe.listview_settings['Attendance'] = { onchange: function() { if (dialog.fields_dict.employee.value && dialog.fields_dict.month.value) { dialog.set_df_property("status", "hidden", 0); + dialog.set_df_property("exclude_holidays", "hidden", 0); dialog.set_df_property("unmarked_days", "options", []); dialog.no_unmarked_days_left = false; - me.get_multi_select_options(dialog.fields_dict.employee.value, dialog.fields_dict.month.value).then(options => { + me.get_multi_select_options( + dialog.fields_dict.employee.value, + dialog.fields_dict.month.value, + dialog.fields_dict.exclude_holidays.get_value() + ).then(options => { if (options.length > 0) { dialog.set_df_property("unmarked_days", "hidden", 0); dialog.set_df_property("unmarked_days", "options", options); @@ -64,6 +70,31 @@ frappe.listview_settings['Attendance'] = { reqd: 1, }, + { + label: __("Exclude Holidays"), + fieldtype: "Check", + fieldname: "exclude_holidays", + hidden: 1, + onchange: function() { + if (dialog.fields_dict.employee.value && dialog.fields_dict.month.value) { + dialog.set_df_property("status", "hidden", 0); + dialog.set_df_property("unmarked_days", "options", []); + dialog.no_unmarked_days_left = false; + me.get_multi_select_options( + dialog.fields_dict.employee.value, + dialog.fields_dict.month.value, + dialog.fields_dict.exclude_holidays.get_value() + ).then(options => { + if (options.length > 0) { + dialog.set_df_property("unmarked_days", "hidden", 0); + dialog.set_df_property("unmarked_days", "options", options); + } else { + dialog.no_unmarked_days_left = true; + } + }); + } + } + }, { label: __("Unmarked Attendance for days"), fieldname: "unmarked_days", @@ -105,7 +136,7 @@ frappe.listview_settings['Attendance'] = { }); }, - get_multi_select_options: function(employee, month) { + get_multi_select_options: function(employee, month, exclude_holidays) { return new Promise(resolve => { frappe.call({ method: 'erpnext.hr.doctype.attendance.attendance.get_unmarked_days', @@ -113,6 +144,7 @@ frappe.listview_settings['Attendance'] = { args: { employee: employee, month: month, + exclude_holidays: exclude_holidays } }).then(r => { var options = []; diff --git a/erpnext/hr/doctype/attendance/test_attendance.py b/erpnext/hr/doctype/attendance/test_attendance.py index a770d70ffa9..b78f5c06206 100644 --- a/erpnext/hr/doctype/attendance/test_attendance.py +++ b/erpnext/hr/doctype/attendance/test_attendance.py @@ -1,20 +1,133 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors and Contributors # See license.txt -import unittest - import frappe -from frappe.utils import nowdate +from frappe.tests.utils import FrappeTestCase +from frappe.utils import ( + add_days, + add_months, + get_last_day, + get_year_ending, + get_year_start, + getdate, + nowdate, +) -test_records = frappe.get_test_records('Attendance') +from erpnext.hr.doctype.attendance.attendance import ( + get_month_map, + get_unmarked_days, + mark_attendance, +) +from erpnext.hr.doctype.employee.test_employee import make_employee +from erpnext.hr.tests.test_utils import get_first_sunday + +test_records = frappe.get_test_records("Attendance") + + +class TestAttendance(FrappeTestCase): + def setUp(self): + from erpnext.payroll.doctype.salary_slip.test_salary_slip import make_holiday_list + + from_date = get_year_start(getdate()) + to_date = get_year_ending(getdate()) + self.holiday_list = make_holiday_list(from_date=from_date, to_date=to_date) -class TestAttendance(unittest.TestCase): def test_mark_absent(self): - from erpnext.hr.doctype.employee.test_employee import make_employee employee = make_employee("test_mark_absent@example.com") date = nowdate() - frappe.db.delete('Attendance', {'employee':employee, 'attendance_date':date}) - from erpnext.hr.doctype.attendance.attendance import mark_attendance - attendance = mark_attendance(employee, date, 'Absent') - fetch_attendance = frappe.get_value('Attendance', {'employee':employee, 'attendance_date':date, 'status':'Absent'}) + frappe.db.delete("Attendance", {"employee": employee, "attendance_date": date}) + attendance = mark_attendance(employee, date, "Absent") + fetch_attendance = frappe.get_value( + "Attendance", {"employee": employee, "attendance_date": date, "status": "Absent"} + ) self.assertEqual(attendance, fetch_attendance) + + def test_unmarked_days(self): + first_sunday = get_first_sunday( + self.holiday_list, for_date=get_last_day(add_months(getdate(), -1)) + ) + attendance_date = add_days(first_sunday, 1) + + employee = make_employee( + "test_unmarked_days@example.com", date_of_joining=add_days(attendance_date, -1) + ) + frappe.db.delete("Attendance", {"employee": employee}) + frappe.db.set_value("Employee", employee, "holiday_list", self.holiday_list) + + mark_attendance(employee, attendance_date, "Present") + month_name = get_month_name(attendance_date) + + unmarked_days = get_unmarked_days(employee, month_name) + unmarked_days = [getdate(date) for date in unmarked_days] + + # attendance already marked for the day + self.assertNotIn(attendance_date, unmarked_days) + # attendance unmarked + self.assertIn(getdate(add_days(attendance_date, 1)), unmarked_days) + # holiday considered in unmarked days + self.assertIn(first_sunday, unmarked_days) + + def test_unmarked_days_excluding_holidays(self): + first_sunday = get_first_sunday( + self.holiday_list, for_date=get_last_day(add_months(getdate(), -1)) + ) + attendance_date = add_days(first_sunday, 1) + + employee = make_employee( + "test_unmarked_days@example.com", date_of_joining=add_days(attendance_date, -1) + ) + frappe.db.delete("Attendance", {"employee": employee}) + + frappe.db.set_value("Employee", employee, "holiday_list", self.holiday_list) + + mark_attendance(employee, attendance_date, "Present") + month_name = get_month_name(attendance_date) + + unmarked_days = get_unmarked_days(employee, month_name, exclude_holidays=True) + unmarked_days = [getdate(date) for date in unmarked_days] + + # attendance already marked for the day + self.assertNotIn(attendance_date, unmarked_days) + # attendance unmarked + self.assertIn(getdate(add_days(attendance_date, 1)), unmarked_days) + # holidays not considered in unmarked days + self.assertNotIn(first_sunday, unmarked_days) + + def test_unmarked_days_as_per_joining_and_relieving_dates(self): + first_sunday = get_first_sunday( + self.holiday_list, for_date=get_last_day(add_months(getdate(), -1)) + ) + date = add_days(first_sunday, 1) + + doj = add_days(date, 1) + relieving_date = add_days(date, 5) + employee = make_employee( + "test_unmarked_days_as_per_doj@example.com", date_of_joining=doj, relieving_date=relieving_date + ) + frappe.db.delete("Attendance", {"employee": employee}) + + frappe.db.set_value("Employee", employee, "holiday_list", self.holiday_list) + + attendance_date = add_days(date, 2) + mark_attendance(employee, attendance_date, "Present") + month_name = get_month_name(attendance_date) + + unmarked_days = get_unmarked_days(employee, month_name) + unmarked_days = [getdate(date) for date in unmarked_days] + + # attendance already marked for the day + self.assertNotIn(attendance_date, unmarked_days) + # date before doj not in unmarked days + self.assertNotIn(add_days(doj, -1), unmarked_days) + # date after relieving not in unmarked days + self.assertNotIn(add_days(relieving_date, 1), unmarked_days) + + def tearDown(self): + frappe.db.rollback() + + +def get_month_name(date): + month_number = date.month + for month, number in get_month_map().items(): + if number == month_number: + return month diff --git a/erpnext/hr/doctype/attendance_request/attendance_request.py b/erpnext/hr/doctype/attendance_request/attendance_request.py index 8fbe7c7a9ad..78652f669d7 100644 --- a/erpnext/hr/doctype/attendance_request/attendance_request.py +++ b/erpnext/hr/doctype/attendance_request/attendance_request.py @@ -16,17 +16,19 @@ class AttendanceRequest(Document): validate_active_employee(self.employee) validate_dates(self, self.from_date, self.to_date) if self.half_day: - if not getdate(self.from_date)<=getdate(self.half_day_date)<=getdate(self.to_date): + if not getdate(self.from_date) <= getdate(self.half_day_date) <= getdate(self.to_date): frappe.throw(_("Half day date should be in between from date and to date")) def on_submit(self): self.create_attendance() def on_cancel(self): - attendance_list = frappe.get_list("Attendance", {'employee': self.employee, 'attendance_request': self.name}) + attendance_list = frappe.get_list( + "Attendance", {"employee": self.employee, "attendance_request": self.name} + ) if attendance_list: for attendance in attendance_list: - attendance_obj = frappe.get_doc("Attendance", attendance['name']) + attendance_obj = frappe.get_doc("Attendance", attendance["name"]) attendance_obj.cancel() def create_attendance(self): @@ -53,15 +55,24 @@ class AttendanceRequest(Document): def validate_if_attendance_not_applicable(self, attendance_date): # Check if attendance_date is a Holiday if is_holiday(self.employee, attendance_date): - frappe.msgprint(_("Attendance not submitted for {0} as it is a Holiday.").format(attendance_date), alert=1) + frappe.msgprint( + _("Attendance not submitted for {0} as it is a Holiday.").format(attendance_date), alert=1 + ) return True # Check if employee on Leave - leave_record = frappe.db.sql("""select half_day from `tabLeave Application` + leave_record = frappe.db.sql( + """select half_day from `tabLeave Application` where employee = %s and %s between from_date and to_date - and docstatus = 1""", (self.employee, attendance_date), as_dict=True) + and docstatus = 1""", + (self.employee, attendance_date), + as_dict=True, + ) if leave_record: - frappe.msgprint(_("Attendance not submitted for {0} as {1} on leave.").format(attendance_date, self.employee), alert=1) + frappe.msgprint( + _("Attendance not submitted for {0} as {1} on leave.").format(attendance_date, self.employee), + alert=1, + ) return True return False diff --git a/erpnext/hr/doctype/attendance_request/attendance_request_dashboard.py b/erpnext/hr/doctype/attendance_request/attendance_request_dashboard.py index b23e0fd93a2..059725cb44a 100644 --- a/erpnext/hr/doctype/attendance_request/attendance_request_dashboard.py +++ b/erpnext/hr/doctype/attendance_request/attendance_request_dashboard.py @@ -1,11 +1,2 @@ - - def get_data(): - return { - 'fieldname': 'attendance_request', - 'transactions': [ - { - 'items': ['Attendance'] - } - ] - } + return {"fieldname": "attendance_request", "transactions": [{"items": ["Attendance"]}]} diff --git a/erpnext/hr/doctype/attendance_request/test_attendance_request.py b/erpnext/hr/doctype/attendance_request/test_attendance_request.py index 3f0442c7d69..ee436f50687 100644 --- a/erpnext/hr/doctype/attendance_request/test_attendance_request.py +++ b/erpnext/hr/doctype/attendance_request/test_attendance_request.py @@ -9,6 +9,7 @@ from frappe.utils import nowdate test_dependencies = ["Employee"] + class TestAttendanceRequest(unittest.TestCase): def setUp(self): for doctype in ["Attendance Request", "Attendance"]: @@ -34,10 +35,10 @@ class TestAttendanceRequest(unittest.TestCase): "Attendance", filters={ "attendance_request": attendance_request.name, - "attendance_date": date(date.today().year, 1, 1) + "attendance_date": date(date.today().year, 1, 1), }, fieldname=["status", "docstatus"], - as_dict=True + as_dict=True, ) self.assertEqual(attendance.status, "Present") self.assertEqual(attendance.docstatus, 1) @@ -51,9 +52,9 @@ class TestAttendanceRequest(unittest.TestCase): "Attendance", filters={ "attendance_request": attendance_request.name, - "attendance_date": date(date.today().year, 1, 1) + "attendance_date": date(date.today().year, 1, 1), }, - fieldname="docstatus" + fieldname="docstatus", ) self.assertEqual(attendance_docstatus, 2) @@ -74,11 +75,11 @@ class TestAttendanceRequest(unittest.TestCase): "Attendance", filters={ "attendance_request": attendance_request.name, - "attendance_date": date(date.today().year, 1, 1) + "attendance_date": date(date.today().year, 1, 1), }, - fieldname="status" + fieldname="status", ) - self.assertEqual(attendance_status, 'Work From Home') + self.assertEqual(attendance_status, "Work From Home") attendance_request.cancel() @@ -88,11 +89,12 @@ class TestAttendanceRequest(unittest.TestCase): "Attendance", filters={ "attendance_request": attendance_request.name, - "attendance_date": date(date.today().year, 1, 1) + "attendance_date": date(date.today().year, 1, 1), }, - fieldname="docstatus" + fieldname="docstatus", ) self.assertEqual(attendance_docstatus, 2) + def get_employee(): return frappe.get_doc("Employee", "_T-Employee-00001") diff --git a/erpnext/hr/doctype/branch/test_branch.py b/erpnext/hr/doctype/branch/test_branch.py index e84c6e4c60e..c14d4aad690 100644 --- a/erpnext/hr/doctype/branch/test_branch.py +++ b/erpnext/hr/doctype/branch/test_branch.py @@ -3,4 +3,4 @@ import frappe -test_records = frappe.get_test_records('Branch') +test_records = frappe.get_test_records("Branch") diff --git a/erpnext/hr/doctype/compensatory_leave_request/compensatory_leave_request.py b/erpnext/hr/doctype/compensatory_leave_request/compensatory_leave_request.py index 7d6051508ad..d233226e663 100644 --- a/erpnext/hr/doctype/compensatory_leave_request/compensatory_leave_request.py +++ b/erpnext/hr/doctype/compensatory_leave_request/compensatory_leave_request.py @@ -18,14 +18,15 @@ from erpnext.hr.utils import ( class CompensatoryLeaveRequest(Document): - def validate(self): validate_active_employee(self.employee) validate_dates(self, self.work_from_date, self.work_end_date) if self.half_day: if not self.half_day_date: frappe.throw(_("Half Day Date is mandatory")) - if not getdate(self.work_from_date)<=getdate(self.half_day_date)<=getdate(self.work_end_date): + if ( + not getdate(self.work_from_date) <= getdate(self.half_day_date) <= getdate(self.work_end_date) + ): frappe.throw(_("Half Day Date should be in between Work From Date and Work End Date")) validate_overlap(self, self.work_from_date, self.work_end_date) self.validate_holidays() @@ -34,13 +35,16 @@ class CompensatoryLeaveRequest(Document): frappe.throw(_("Leave Type is madatory")) def validate_attendance(self): - attendance = frappe.get_all('Attendance', + attendance = frappe.get_all( + "Attendance", filters={ - 'attendance_date': ['between', (self.work_from_date, self.work_end_date)], - 'status': 'Present', - 'docstatus': 1, - 'employee': self.employee - }, fields=['attendance_date', 'status']) + "attendance_date": ["between", (self.work_from_date, self.work_end_date)], + "status": "Present", + "docstatus": 1, + "employee": self.employee, + }, + fields=["attendance_date", "status"], + ) if len(attendance) < date_diff(self.work_end_date, self.work_from_date) + 1: frappe.throw(_("You are not present all day(s) between compensatory leave request days")) @@ -49,7 +53,9 @@ class CompensatoryLeaveRequest(Document): holidays = get_holiday_dates_for_employee(self.employee, self.work_from_date, self.work_end_date) if len(holidays) < date_diff(self.work_end_date, self.work_from_date) + 1: if date_diff(self.work_end_date, self.work_from_date): - msg = _("The days between {0} to {1} are not valid holidays.").format(frappe.bold(format_date(self.work_from_date)), frappe.bold(format_date(self.work_end_date))) + msg = _("The days between {0} to {1} are not valid holidays.").format( + frappe.bold(format_date(self.work_from_date)), frappe.bold(format_date(self.work_end_date)) + ) else: msg = _("{0} is not a holiday.").format(frappe.bold(format_date(self.work_from_date))) @@ -70,13 +76,19 @@ class CompensatoryLeaveRequest(Document): leave_allocation.db_set("total_leaves_allocated", leave_allocation.total_leaves_allocated) # generate additional ledger entry for the new compensatory leaves off - create_additional_leave_ledger_entry(leave_allocation, date_difference, add_days(self.work_end_date, 1)) + create_additional_leave_ledger_entry( + leave_allocation, date_difference, add_days(self.work_end_date, 1) + ) else: leave_allocation = self.create_leave_allocation(leave_period, date_difference) self.db_set("leave_allocation", leave_allocation.name) else: - frappe.throw(_("There is no leave period in between {0} and {1}").format(format_date(self.work_from_date), format_date(self.work_end_date))) + frappe.throw( + _("There is no leave period in between {0} and {1}").format( + format_date(self.work_from_date), format_date(self.work_end_date) + ) + ) def on_cancel(self): if self.leave_allocation: @@ -93,10 +105,13 @@ class CompensatoryLeaveRequest(Document): leave_allocation.db_set("total_leaves_allocated", leave_allocation.total_leaves_allocated) # create reverse entry on cancelation - create_additional_leave_ledger_entry(leave_allocation, date_difference * -1, add_days(self.work_end_date, 1)) + create_additional_leave_ledger_entry( + leave_allocation, date_difference * -1, add_days(self.work_end_date, 1) + ) def get_existing_allocation_for_period(self, leave_period): - leave_allocation = frappe.db.sql(""" + leave_allocation = frappe.db.sql( + """ select name from `tabLeave Allocation` where employee=%(employee)s and leave_type=%(leave_type)s @@ -104,12 +119,15 @@ class CompensatoryLeaveRequest(Document): and (from_date between %(from_date)s and %(to_date)s or to_date between %(from_date)s and %(to_date)s or (from_date < %(from_date)s and to_date > %(to_date)s)) - """, { - "from_date": leave_period[0].from_date, - "to_date": leave_period[0].to_date, - "employee": self.employee, - "leave_type": self.leave_type - }, as_dict=1) + """, + { + "from_date": leave_period[0].from_date, + "to_date": leave_period[0].to_date, + "employee": self.employee, + "leave_type": self.leave_type, + }, + as_dict=1, + ) if leave_allocation: return frappe.get_doc("Leave Allocation", leave_allocation[0].name) @@ -118,18 +136,20 @@ class CompensatoryLeaveRequest(Document): def create_leave_allocation(self, leave_period, date_difference): is_carry_forward = frappe.db.get_value("Leave Type", self.leave_type, "is_carry_forward") - allocation = frappe.get_doc(dict( - doctype="Leave Allocation", - employee=self.employee, - employee_name=self.employee_name, - leave_type=self.leave_type, - from_date=add_days(self.work_end_date, 1), - to_date=leave_period[0].to_date, - carry_forward=cint(is_carry_forward), - new_leaves_allocated=date_difference, - total_leaves_allocated=date_difference, - description=self.reason - )) + allocation = frappe.get_doc( + dict( + doctype="Leave Allocation", + employee=self.employee, + employee_name=self.employee_name, + leave_type=self.leave_type, + from_date=add_days(self.work_end_date, 1), + to_date=leave_period[0].to_date, + carry_forward=cint(is_carry_forward), + new_leaves_allocated=date_difference, + total_leaves_allocated=date_difference, + description=self.reason, + ) + ) allocation.insert(ignore_permissions=True) allocation.submit() return allocation diff --git a/erpnext/hr/doctype/compensatory_leave_request/test_compensatory_leave_request.py b/erpnext/hr/doctype/compensatory_leave_request/test_compensatory_leave_request.py index 5e51879328b..7bbec293f41 100644 --- a/erpnext/hr/doctype/compensatory_leave_request/test_compensatory_leave_request.py +++ b/erpnext/hr/doctype/compensatory_leave_request/test_compensatory_leave_request.py @@ -12,12 +12,17 @@ from erpnext.hr.doctype.leave_period.test_leave_period import create_leave_perio test_dependencies = ["Employee"] + class TestCompensatoryLeaveRequest(unittest.TestCase): def setUp(self): - frappe.db.sql(''' delete from `tabCompensatory Leave Request`''') - frappe.db.sql(''' delete from `tabLeave Ledger Entry`''') - frappe.db.sql(''' delete from `tabLeave Allocation`''') - frappe.db.sql(''' delete from `tabAttendance` where attendance_date in {0} '''.format((today(), add_days(today(), -1)))) #nosec + frappe.db.sql(""" delete from `tabCompensatory Leave Request`""") + frappe.db.sql(""" delete from `tabLeave Ledger Entry`""") + frappe.db.sql(""" delete from `tabLeave Allocation`""") + frappe.db.sql( + """ delete from `tabAttendance` where attendance_date in {0} """.format( + (today(), add_days(today(), -1)) + ) + ) # nosec create_leave_period(add_months(today(), -3), add_months(today(), 3), "_Test Company") create_holiday_list() @@ -26,7 +31,7 @@ class TestCompensatoryLeaveRequest(unittest.TestCase): employee.save() def test_leave_balance_on_submit(self): - ''' check creation of leave allocation on submission of compensatory leave request ''' + """check creation of leave allocation on submission of compensatory leave request""" employee = get_employee() mark_attendance(employee) compensatory_leave_request = get_compensatory_leave_request(employee.name) @@ -34,18 +39,27 @@ class TestCompensatoryLeaveRequest(unittest.TestCase): before = get_leave_balance_on(employee.name, compensatory_leave_request.leave_type, today()) compensatory_leave_request.submit() - self.assertEqual(get_leave_balance_on(employee.name, compensatory_leave_request.leave_type, add_days(today(), 1)), before + 1) + self.assertEqual( + get_leave_balance_on( + employee.name, compensatory_leave_request.leave_type, add_days(today(), 1) + ), + before + 1, + ) def test_leave_allocation_update_on_submit(self): employee = get_employee() mark_attendance(employee, date=add_days(today(), -1)) - compensatory_leave_request = get_compensatory_leave_request(employee.name, leave_date=add_days(today(), -1)) + compensatory_leave_request = get_compensatory_leave_request( + employee.name, leave_date=add_days(today(), -1) + ) compensatory_leave_request.submit() # leave allocation creation on submit - leaves_allocated = frappe.db.get_value('Leave Allocation', { - 'name': compensatory_leave_request.leave_allocation - }, ['total_leaves_allocated']) + leaves_allocated = frappe.db.get_value( + "Leave Allocation", + {"name": compensatory_leave_request.leave_allocation}, + ["total_leaves_allocated"], + ) self.assertEqual(leaves_allocated, 1) mark_attendance(employee) @@ -53,20 +67,22 @@ class TestCompensatoryLeaveRequest(unittest.TestCase): compensatory_leave_request.submit() # leave allocation updates on submission of second compensatory leave request - leaves_allocated = frappe.db.get_value('Leave Allocation', { - 'name': compensatory_leave_request.leave_allocation - }, ['total_leaves_allocated']) + leaves_allocated = frappe.db.get_value( + "Leave Allocation", + {"name": compensatory_leave_request.leave_allocation}, + ["total_leaves_allocated"], + ) self.assertEqual(leaves_allocated, 2) def test_creation_of_leave_ledger_entry_on_submit(self): - ''' check creation of leave ledger entry on submission of leave request ''' + """check creation of leave ledger entry on submission of leave request""" employee = get_employee() mark_attendance(employee) compensatory_leave_request = get_compensatory_leave_request(employee.name) compensatory_leave_request.submit() filters = dict(transaction_name=compensatory_leave_request.leave_allocation) - leave_ledger_entry = frappe.get_all('Leave Ledger Entry', fields='*', filters=filters) + leave_ledger_entry = frappe.get_all("Leave Ledger Entry", fields="*", filters=filters) self.assertEqual(len(leave_ledger_entry), 1) self.assertEqual(leave_ledger_entry[0].employee, compensatory_leave_request.employee) @@ -75,60 +91,67 @@ class TestCompensatoryLeaveRequest(unittest.TestCase): # check reverse leave ledger entry on cancellation compensatory_leave_request.cancel() - leave_ledger_entry = frappe.get_all('Leave Ledger Entry', fields='*', filters=filters, order_by = 'creation desc') + leave_ledger_entry = frappe.get_all( + "Leave Ledger Entry", fields="*", filters=filters, order_by="creation desc" + ) self.assertEqual(len(leave_ledger_entry), 2) self.assertEqual(leave_ledger_entry[0].employee, compensatory_leave_request.employee) self.assertEqual(leave_ledger_entry[0].leave_type, compensatory_leave_request.leave_type) self.assertEqual(leave_ledger_entry[0].leaves, -1) + def get_compensatory_leave_request(employee, leave_date=today()): - prev_comp_leave_req = frappe.db.get_value('Compensatory Leave Request', - dict(leave_type='Compensatory Off', + prev_comp_leave_req = frappe.db.get_value( + "Compensatory Leave Request", + dict( + leave_type="Compensatory Off", work_from_date=leave_date, work_end_date=leave_date, - employee=employee), 'name') - if prev_comp_leave_req: - return frappe.get_doc('Compensatory Leave Request', prev_comp_leave_req) - - return frappe.get_doc(dict( - doctype='Compensatory Leave Request', employee=employee, - leave_type='Compensatory Off', + ), + "name", + ) + if prev_comp_leave_req: + return frappe.get_doc("Compensatory Leave Request", prev_comp_leave_req) + + return frappe.get_doc( + dict( + doctype="Compensatory Leave Request", + employee=employee, + leave_type="Compensatory Off", work_from_date=leave_date, work_end_date=leave_date, - reason='test' - )).insert() + reason="test", + ) + ).insert() -def mark_attendance(employee, date=today(), status='Present'): - if not frappe.db.exists(dict(doctype='Attendance', employee=employee.name, attendance_date=date, status='Present')): - attendance = frappe.get_doc({ - "doctype": "Attendance", - "employee": employee.name, - "attendance_date": date, - "status": status - }) + +def mark_attendance(employee, date=today(), status="Present"): + if not frappe.db.exists( + dict(doctype="Attendance", employee=employee.name, attendance_date=date, status="Present") + ): + attendance = frappe.get_doc( + {"doctype": "Attendance", "employee": employee.name, "attendance_date": date, "status": status} + ) attendance.save() attendance.submit() + def create_holiday_list(): if frappe.db.exists("Holiday List", "_Test Compensatory Leave"): return - holiday_list = frappe.get_doc({ - "doctype": "Holiday List", - "from_date": add_months(today(), -3), - "to_date": add_months(today(), 3), - "holidays": [ - { - "description": "Test Holiday", - "holiday_date": today() - }, - { - "description": "Test Holiday 1", - "holiday_date": add_days(today(), -1) - } - ], - "holiday_list_name": "_Test Compensatory Leave" - }) + holiday_list = frappe.get_doc( + { + "doctype": "Holiday List", + "from_date": add_months(today(), -3), + "to_date": add_months(today(), 3), + "holidays": [ + {"description": "Test Holiday", "holiday_date": today()}, + {"description": "Test Holiday 1", "holiday_date": add_days(today(), -1)}, + ], + "holiday_list_name": "_Test Compensatory Leave", + } + ) holiday_list.save() diff --git a/erpnext/hr/doctype/daily_work_summary/daily_work_summary.py b/erpnext/hr/doctype/daily_work_summary/daily_work_summary.py index 38e1f54ba96..d311188090d 100644 --- a/erpnext/hr/doctype/daily_work_summary/daily_work_summary.py +++ b/erpnext/hr/doctype/daily_work_summary/daily_work_summary.py @@ -12,53 +12,59 @@ from six import string_types class DailyWorkSummary(Document): def send_mails(self, dws_group, emails): - '''Send emails to get daily work summary to all users \ - in selected daily work summary group''' - incoming_email_account = frappe.db.get_value('Email Account', - dict(enable_incoming=1, default_incoming=1), - 'email_id') + """Send emails to get daily work summary to all users \ + in selected daily work summary group""" + incoming_email_account = frappe.db.get_value( + "Email Account", dict(enable_incoming=1, default_incoming=1), "email_id" + ) - self.db_set('email_sent_to', '\n'.join(emails)) - frappe.sendmail(recipients=emails, + self.db_set("email_sent_to", "\n".join(emails)) + frappe.sendmail( + recipients=emails, message=dws_group.message, subject=dws_group.subject, reference_doctype=self.doctype, reference_name=self.name, - reply_to=incoming_email_account) + reply_to=incoming_email_account, + ) def send_summary(self): - '''Send summary of all replies. Called at midnight''' + """Send summary of all replies. Called at midnight""" args = self.get_message_details() emails = get_user_emails_from_group(self.daily_work_summary_group) - frappe.sendmail(recipients=emails, - template='daily_work_summary', + frappe.sendmail( + recipients=emails, + template="daily_work_summary", args=args, subject=_(self.daily_work_summary_group), reference_doctype=self.doctype, - reference_name=self.name) + reference_name=self.name, + ) - self.db_set('status', 'Sent') + self.db_set("status", "Sent") def get_message_details(self): - '''Return args for template''' - dws_group = frappe.get_doc('Daily Work Summary Group', - self.daily_work_summary_group) + """Return args for template""" + dws_group = frappe.get_doc("Daily Work Summary Group", self.daily_work_summary_group) - replies = frappe.get_all('Communication', - fields=['content', 'text_content', 'sender'], - filters=dict(reference_doctype=self.doctype, + replies = frappe.get_all( + "Communication", + fields=["content", "text_content", "sender"], + filters=dict( + reference_doctype=self.doctype, reference_name=self.name, - communication_type='Communication', - sent_or_received='Received'), - order_by='creation asc') + communication_type="Communication", + sent_or_received="Received", + ), + order_by="creation asc", + ) did_not_reply = self.email_sent_to.split() for d in replies: - user = frappe.db.get_values("User", - {"email": d.sender}, - ["full_name", "user_image"], - as_dict=True) + user = frappe.db.get_values( + "User", {"email": d.sender}, ["full_name", "user_image"], as_dict=True + ) d.sender_name = user[0].full_name if user else d.sender d.image = user[0].image if user and user[0].image else None @@ -67,17 +73,13 @@ class DailyWorkSummary(Document): # make thumbnail image try: if original_image: - file_name = frappe.get_list('File', - {'file_url': original_image}) + file_name = frappe.get_list("File", {"file_url": original_image}) if file_name: file_name = file_name[0].name - file_doc = frappe.get_doc('File', file_name) + file_doc = frappe.get_doc("File", file_name) thumbnail_image = file_doc.make_thumbnail( - set_as_thumbnail=False, - width=100, - height=100, - crop=True + set_as_thumbnail=False, width=100, height=100, crop=True ) d.image = thumbnail_image except Exception: @@ -86,34 +88,33 @@ class DailyWorkSummary(Document): if d.sender in did_not_reply: did_not_reply.remove(d.sender) if d.text_content: - d.content = frappe.utils.md_to_html( - EmailReplyParser.parse_reply(d.text_content) - ) + d.content = frappe.utils.md_to_html(EmailReplyParser.parse_reply(d.text_content)) - did_not_reply = [(frappe.db.get_value("User", {"email": email}, "full_name") or email) - for email in did_not_reply] + did_not_reply = [ + (frappe.db.get_value("User", {"email": email}, "full_name") or email) for email in did_not_reply + ] - return dict(replies=replies, + return dict( + replies=replies, original_message=dws_group.message, - title=_('Work Summary for {0}').format( - global_date_format(self.creation) - ), - did_not_reply=', '.join(did_not_reply) or '', - did_not_reply_title=_('No replies from')) + title=_("Work Summary for {0}").format(global_date_format(self.creation)), + did_not_reply=", ".join(did_not_reply) or "", + did_not_reply_title=_("No replies from"), + ) def get_user_emails_from_group(group): - '''Returns list of email of enabled users from the given group + """Returns list of email of enabled users from the given group - :param group: Daily Work Summary Group `name`''' + :param group: Daily Work Summary Group `name`""" group_doc = group if isinstance(group_doc, string_types): - group_doc = frappe.get_doc('Daily Work Summary Group', group) + group_doc = frappe.get_doc("Daily Work Summary Group", group) emails = get_users_email(group_doc) return emails + def get_users_email(doc): - return [d.email for d in doc.users - if frappe.db.get_value("User", d.user, "enabled")] + return [d.email for d in doc.users if frappe.db.get_value("User", d.user, "enabled")] diff --git a/erpnext/hr/doctype/daily_work_summary/test_daily_work_summary.py b/erpnext/hr/doctype/daily_work_summary/test_daily_work_summary.py index 5edfb315564..703436529d0 100644 --- a/erpnext/hr/doctype/daily_work_summary/test_daily_work_summary.py +++ b/erpnext/hr/doctype/daily_work_summary/test_daily_work_summary.py @@ -9,82 +9,96 @@ import frappe.utils # test_records = frappe.get_test_records('Daily Work Summary') + class TestDailyWorkSummary(unittest.TestCase): def test_email_trigger(self): self.setup_and_prepare_test() for d in self.users: # check that email is sent to users if d.message: - self.assertTrue(d.email in [d.recipient for d in self.emails - if self.groups.subject in d.message]) + self.assertTrue( + d.email in [d.recipient for d in self.emails if self.groups.subject in d.message] + ) def test_email_trigger_failed(self): - hour = '00:00' - if frappe.utils.nowtime().split(':')[0] == '00': - hour = '01:00' + hour = "00:00" + if frappe.utils.nowtime().split(":")[0] == "00": + hour = "01:00" self.setup_and_prepare_test(hour) for d in self.users: # check that email is not sent to users - self.assertFalse(d.email in [d.recipient for d in self.emails - if self.groups.subject in d.message]) + self.assertFalse( + d.email in [d.recipient for d in self.emails if self.groups.subject in d.message] + ) def test_incoming(self): # get test mail with message-id as in-reply-to self.setup_and_prepare_test() with open(os.path.join(os.path.dirname(__file__), "test_data", "test-reply.raw"), "r") as f: - if not self.emails: return - test_mails = [f.read().replace('{{ sender }}', - self.users[-1].email).replace('{{ message_id }}', - self.emails[-1].message_id)] + if not self.emails: + return + test_mails = [ + f.read() + .replace("{{ sender }}", self.users[-1].email) + .replace("{{ message_id }}", self.emails[-1].message_id) + ] # pull the mail email_account = frappe.get_doc("Email Account", "_Test Email Account 1") - email_account.db_set('enable_incoming', 1) + email_account.db_set("enable_incoming", 1) email_account.receive(test_mails=test_mails) - daily_work_summary = frappe.get_doc('Daily Work Summary', - frappe.get_all('Daily Work Summary')[0].name) + daily_work_summary = frappe.get_doc( + "Daily Work Summary", frappe.get_all("Daily Work Summary")[0].name + ) args = daily_work_summary.get_message_details() - self.assertTrue('I built Daily Work Summary!' in args.get('replies')[0].content) + self.assertTrue("I built Daily Work Summary!" in args.get("replies")[0].content) def setup_and_prepare_test(self, hour=None): - frappe.db.sql('delete from `tabDaily Work Summary`') - frappe.db.sql('delete from `tabEmail Queue`') - frappe.db.sql('delete from `tabEmail Queue Recipient`') - frappe.db.sql('delete from `tabCommunication`') - frappe.db.sql('delete from `tabDaily Work Summary Group`') + frappe.db.sql("delete from `tabDaily Work Summary`") + frappe.db.sql("delete from `tabEmail Queue`") + frappe.db.sql("delete from `tabEmail Queue Recipient`") + frappe.db.sql("delete from `tabCommunication`") + frappe.db.sql("delete from `tabDaily Work Summary Group`") - self.users = frappe.get_all('User', - fields=['email'], - filters=dict(email=('!=', 'test@example.com'))) + self.users = frappe.get_all( + "User", fields=["email"], filters=dict(email=("!=", "test@example.com")) + ) self.setup_groups(hour) from erpnext.hr.doctype.daily_work_summary_group.daily_work_summary_group import trigger_emails + trigger_emails() # check if emails are created - self.emails = frappe.db.sql("""select r.recipient, q.message, q.message_id \ + self.emails = frappe.db.sql( + """select r.recipient, q.message, q.message_id \ from `tabEmail Queue` as q, `tabEmail Queue Recipient` as r \ - where q.name = r.parent""", as_dict=1) - + where q.name = r.parent""", + as_dict=1, + ) def setup_groups(self, hour=None): # setup email to trigger at this hour if not hour: - hour = frappe.utils.nowtime().split(':')[0] - hour = hour+':00' + hour = frappe.utils.nowtime().split(":")[0] + hour = hour + ":00" - groups = frappe.get_doc(dict(doctype="Daily Work Summary Group", - name="Daily Work Summary", - users=self.users, - send_emails_at=hour, - subject="this is a subject for testing summary emails", - message='this is a message for testing summary emails')) + groups = frappe.get_doc( + dict( + doctype="Daily Work Summary Group", + name="Daily Work Summary", + users=self.users, + send_emails_at=hour, + subject="this is a subject for testing summary emails", + message="this is a message for testing summary emails", + ) + ) groups.insert() self.groups = groups diff --git a/erpnext/hr/doctype/daily_work_summary_group/daily_work_summary_group.py b/erpnext/hr/doctype/daily_work_summary_group/daily_work_summary_group.py index 306f43a418f..e8ec265464e 100644 --- a/erpnext/hr/doctype/daily_work_summary_group/daily_work_summary_group.py +++ b/erpnext/hr/doctype/daily_work_summary_group/daily_work_summary_group.py @@ -16,37 +16,41 @@ class DailyWorkSummaryGroup(Document): def validate(self): if self.users: if not frappe.flags.in_test and not is_incoming_account_enabled(): - frappe.throw(_('Please enable default incoming account before creating Daily Work Summary Group')) + frappe.throw( + _("Please enable default incoming account before creating Daily Work Summary Group") + ) def trigger_emails(): - '''Send emails to Employees at the given hour asking - them what did they work on today''' + """Send emails to Employees at the given hour asking + them what did they work on today""" groups = frappe.get_all("Daily Work Summary Group") for d in groups: group_doc = frappe.get_doc("Daily Work Summary Group", d) - if (is_current_hour(group_doc.send_emails_at) + if ( + is_current_hour(group_doc.send_emails_at) and not is_holiday(group_doc.holiday_list) - and group_doc.enabled): + and group_doc.enabled + ): emails = get_user_emails_from_group(group_doc) # find emails relating to a company if emails: daily_work_summary = frappe.get_doc( - dict(doctype='Daily Work Summary', daily_work_summary_group=group_doc.name) + dict(doctype="Daily Work Summary", daily_work_summary_group=group_doc.name) ).insert() daily_work_summary.send_mails(group_doc, emails) def is_current_hour(hour): - return frappe.utils.nowtime().split(':')[0] == hour.split(':')[0] + return frappe.utils.nowtime().split(":")[0] == hour.split(":")[0] def send_summary(): - '''Send summary to everyone''' - for d in frappe.get_all('Daily Work Summary', dict(status='Open')): - daily_work_summary = frappe.get_doc('Daily Work Summary', d.name) + """Send summary to everyone""" + for d in frappe.get_all("Daily Work Summary", dict(status="Open")): + daily_work_summary = frappe.get_doc("Daily Work Summary", d.name) daily_work_summary.send_summary() def is_incoming_account_enabled(): - return frappe.db.get_value('Email Account', dict(enable_incoming=1, default_incoming=1)) + return frappe.db.get_value("Email Account", dict(enable_incoming=1, default_incoming=1)) diff --git a/erpnext/hr/doctype/department/department.py b/erpnext/hr/doctype/department/department.py index ed0bfcf0d5a..a9806c529f6 100644 --- a/erpnext/hr/doctype/department/department.py +++ b/erpnext/hr/doctype/department/department.py @@ -9,7 +9,7 @@ from erpnext.utilities.transaction_base import delete_events class Department(NestedSet): - nsm_parent_field = 'parent_department' + nsm_parent_field = "parent_department" def autoname(self): root = get_root_of("Department") @@ -26,7 +26,7 @@ class Department(NestedSet): def before_rename(self, old, new, merge=False): # renaming consistency with abbreviation - if not frappe.get_cached_value('Company', self.company, 'abbr') in new: + if not frappe.get_cached_value("Company", self.company, "abbr") in new: new = get_abbreviated_name(new, self.company) return new @@ -39,17 +39,20 @@ class Department(NestedSet): super(Department, self).on_trash() delete_events(self.doctype, self.name) + def on_doctype_update(): frappe.db.add_index("Department", ["lft", "rgt"]) + def get_abbreviated_name(name, company): - abbr = frappe.get_cached_value('Company', company, 'abbr') - new_name = '{0} - {1}'.format(name, abbr) + abbr = frappe.get_cached_value("Company", company, "abbr") + new_name = "{0} - {1}".format(name, abbr) return new_name + @frappe.whitelist() def get_children(doctype, parent=None, company=None, is_root=False): - condition = '' + condition = "" var_dict = { "name": get_root_of("Department"), "parent": parent, @@ -62,18 +65,26 @@ def get_children(doctype, parent=None, company=None, is_root=False): else: condition = "parent_department = %(parent)s" - return frappe.db.sql(""" + return frappe.db.sql( + """ select name as value, is_group as expandable from `tab{doctype}` where {condition} - order by name""".format(doctype=doctype, condition=condition), var_dict, as_dict=1) + order by name""".format( + doctype=doctype, condition=condition + ), + var_dict, + as_dict=1, + ) + @frappe.whitelist() def add_node(): from frappe.desk.treeview import make_tree_args + args = frappe.form_dict args = make_tree_args(**args) diff --git a/erpnext/hr/doctype/department/test_department.py b/erpnext/hr/doctype/department/test_department.py index 95bf6635011..b8c043f0b2d 100644 --- a/erpnext/hr/doctype/department/test_department.py +++ b/erpnext/hr/doctype/department/test_department.py @@ -6,20 +6,26 @@ import unittest import frappe test_ignore = ["Leave Block List"] + + class TestDepartment(unittest.TestCase): - def test_remove_department_data(self): - doc = create_department("Test Department") - frappe.delete_doc('Department', doc.name) + def test_remove_department_data(self): + doc = create_department("Test Department") + frappe.delete_doc("Department", doc.name) + def create_department(department_name, parent_department=None): - doc = frappe.get_doc({ - 'doctype': 'Department', - 'is_group': 0, - 'parent_department': parent_department, - 'department_name': department_name, - 'company': frappe.defaults.get_defaults().company - }).insert() + doc = frappe.get_doc( + { + "doctype": "Department", + "is_group": 0, + "parent_department": parent_department, + "department_name": department_name, + "company": frappe.defaults.get_defaults().company, + } + ).insert() - return doc + return doc -test_records = frappe.get_test_records('Department') + +test_records = frappe.get_test_records("Department") diff --git a/erpnext/hr/doctype/department_approver/department_approver.py b/erpnext/hr/doctype/department_approver/department_approver.py index 375ae7c70ae..d849900ef2d 100644 --- a/erpnext/hr/doctype/department_approver/department_approver.py +++ b/erpnext/hr/doctype/department_approver/department_approver.py @@ -10,6 +10,7 @@ from frappe.model.document import Document class DepartmentApprover(Document): pass + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_approvers(doctype, txt, searchfield, start, page_len, filters): @@ -20,25 +21,44 @@ def get_approvers(doctype, txt, searchfield, start, page_len, filters): approvers = [] department_details = {} department_list = [] - employee = frappe.get_value("Employee", filters.get("employee"), ["employee_name","department", "leave_approver", "expense_approver", "shift_request_approver"], as_dict=True) + employee = frappe.get_value( + "Employee", + filters.get("employee"), + ["employee_name", "department", "leave_approver", "expense_approver", "shift_request_approver"], + as_dict=True, + ) employee_department = filters.get("department") or employee.department if employee_department: - department_details = frappe.db.get_value("Department", {"name": employee_department}, ["lft", "rgt"], as_dict=True) + department_details = frappe.db.get_value( + "Department", {"name": employee_department}, ["lft", "rgt"], as_dict=True + ) if department_details: - department_list = frappe.db.sql("""select name from `tabDepartment` where lft <= %s + department_list = frappe.db.sql( + """select name from `tabDepartment` where lft <= %s and rgt >= %s and disabled=0 - order by lft desc""", (department_details.lft, department_details.rgt), as_list=True) + order by lft desc""", + (department_details.lft, department_details.rgt), + as_list=True, + ) if filters.get("doctype") == "Leave Application" and employee.leave_approver: - approvers.append(frappe.db.get_value("User", employee.leave_approver, ['name', 'first_name', 'last_name'])) + approvers.append( + frappe.db.get_value("User", employee.leave_approver, ["name", "first_name", "last_name"]) + ) if filters.get("doctype") == "Expense Claim" and employee.expense_approver: - approvers.append(frappe.db.get_value("User", employee.expense_approver, ['name', 'first_name', 'last_name'])) + approvers.append( + frappe.db.get_value("User", employee.expense_approver, ["name", "first_name", "last_name"]) + ) if filters.get("doctype") == "Shift Request" and employee.shift_request_approver: - approvers.append(frappe.db.get_value("User", employee.shift_request_approver, ['name', 'first_name', 'last_name'])) + approvers.append( + frappe.db.get_value( + "User", employee.shift_request_approver, ["name", "first_name", "last_name"] + ) + ) if filters.get("doctype") == "Leave Application": parentfield = "leave_approvers" @@ -51,15 +71,21 @@ def get_approvers(doctype, txt, searchfield, start, page_len, filters): field_name = "Shift Request Approver" if department_list: for d in department_list: - approvers += frappe.db.sql("""select user.name, user.first_name, user.last_name from + approvers += frappe.db.sql( + """select user.name, user.first_name, user.last_name from tabUser user, `tabDepartment Approver` approver where approver.parent = %s and user.name like %s and approver.parentfield = %s - and approver.approver=user.name""",(d, "%" + txt + "%", parentfield), as_list=True) + and approver.approver=user.name""", + (d, "%" + txt + "%", parentfield), + as_list=True, + ) if len(approvers) == 0: - error_msg = _("Please set {0} for the Employee: {1}").format(field_name, frappe.bold(employee.employee_name)) + error_msg = _("Please set {0} for the Employee: {1}").format( + field_name, frappe.bold(employee.employee_name) + ) if department_list: error_msg += _(" or for Department: {0}").format(frappe.bold(employee_department)) frappe.throw(error_msg, title=_(field_name + " Missing")) diff --git a/erpnext/hr/doctype/designation/test_designation.py b/erpnext/hr/doctype/designation/test_designation.py index f2d6d36ff88..0840d13d1f3 100644 --- a/erpnext/hr/doctype/designation/test_designation.py +++ b/erpnext/hr/doctype/designation/test_designation.py @@ -5,15 +5,18 @@ import frappe # test_records = frappe.get_test_records('Designation') -def create_designation(**args): - args = frappe._dict(args) - if frappe.db.exists("Designation", args.designation_name or "_Test designation"): - return frappe.get_doc("Designation", args.designation_name or "_Test designation") - designation = frappe.get_doc({ - "doctype": "Designation", - "designation_name": args.designation_name or "_Test designation", - "description": args.description or "_Test description" - }) - designation.save() - return designation +def create_designation(**args): + args = frappe._dict(args) + if frappe.db.exists("Designation", args.designation_name or "_Test designation"): + return frappe.get_doc("Designation", args.designation_name or "_Test designation") + + designation = frappe.get_doc( + { + "doctype": "Designation", + "designation_name": args.designation_name or "_Test designation", + "description": args.description or "_Test description", + } + ) + designation.save() + return designation diff --git a/erpnext/hr/doctype/employee/employee.json b/erpnext/hr/doctype/employee/employee.json index d592a9c79e2..0b49e98c8a7 100644 --- a/erpnext/hr/doctype/employee/employee.json +++ b/erpnext/hr/doctype/employee/employee.json @@ -4,7 +4,7 @@ "allow_import": 1, "allow_rename": 1, "autoname": "naming_series:", - "creation": "2013-03-07 09:04:18", + "creation": "2022-02-21 11:54:09.632218", "doctype": "DocType", "document_type": "Setup", "editable_grid": 1, @@ -813,11 +813,12 @@ "idx": 24, "image_field": "image", "links": [], - "modified": "2021-06-17 11:31:37.730760", + "modified": "2022-08-20 13:44:37.088519", "modified_by": "Administrator", "module": "HR", "name": "Employee", "name_case": "Title Case", + "naming_rule": "By \"Naming Series\" field", "owner": "Administrator", "permissions": [ { diff --git a/erpnext/hr/doctype/employee/employee.py b/erpnext/hr/doctype/employee/employee.py index 88e5ca9d4c5..9c55af067f0 100755 --- a/erpnext/hr/doctype/employee/employee.py +++ b/erpnext/hr/doctype/employee/employee.py @@ -10,7 +10,7 @@ from frappe.permissions import ( remove_user_permission, set_user_permission_if_allowed, ) -from frappe.utils import add_years, cstr, getdate, today, validate_email_address +from frappe.utils import add_days, add_years, cstr, getdate, today, validate_email_address from frappe.utils.nestedset import NestedSet from erpnext.utilities.transaction_base import delete_events @@ -18,22 +18,25 @@ from erpnext.utilities.transaction_base import delete_events class EmployeeUserDisabledError(frappe.ValidationError): pass + + class InactiveEmployeeStatusError(frappe.ValidationError): pass + class Employee(NestedSet): - nsm_parent_field = 'reports_to' + nsm_parent_field = "reports_to" def autoname(self): naming_method = frappe.db.get_value("HR Settings", None, "emp_created_by") if not naming_method: throw(_("Please setup Employee Naming System in Human Resource > HR Settings")) else: - if naming_method == 'Naming Series': + if naming_method == "Naming Series": set_name_by_naming_series(self) - elif naming_method == 'Employee Number': + elif naming_method == "Employee Number": self.name = self.employee_number - elif naming_method == 'Full Name': + elif naming_method == "Full Name": self.set_employee_name() self.name = self.employee_name @@ -41,6 +44,7 @@ class Employee(NestedSet): def validate(self): from erpnext.controllers.status_updater import validate_status + validate_status(self.status, ["Active", "Inactive", "Suspended", "Left"]) self.employee = self.name @@ -58,22 +62,30 @@ class Employee(NestedSet): else: existing_user_id = frappe.db.get_value("Employee", self.name, "user_id") if existing_user_id: - remove_user_permission( - "Employee", self.name, existing_user_id) + remove_user_permission("Employee", self.name, existing_user_id) + + self.update_to_date_in_work_history() def after_rename(self, old, new, merge): self.db_set("employee", new) def set_employee_name(self): - self.employee_name = ' '.join(filter(lambda x: x, [self.first_name, self.middle_name, self.last_name])) + self.employee_name = " ".join( + filter(lambda x: x, [self.first_name, self.middle_name, self.last_name]) + ) def validate_user_details(self): - data = frappe.db.get_value('User', - self.user_id, ['enabled', 'user_image'], as_dict=1) - if data.get("user_image") and self.image == '': - self.image = data.get("user_image") - self.validate_for_enabled_user_id(data.get("enabled", 0)) - self.validate_duplicate_user_id() + if self.user_id: + data = frappe.db.get_value("User", self.user_id, ["enabled", "user_image"], as_dict=1) + + if not data: + self.user_id = None + return + + if data.get("user_image") and self.image == "": + self.image = data.get("user_image") + self.validate_for_enabled_user_id(data.get("enabled", 0)) + self.validate_duplicate_user_id() def update_nsm_model(self): frappe.utils.nestedset.update_nsm(self) @@ -87,14 +99,14 @@ class Employee(NestedSet): self.update_approver_role() def update_user_permissions(self): - if not self.create_user_permission: return - if not has_permission('User Permission', ptype='write', raise_exception=False): return + if not self.create_user_permission: + return + if not has_permission("User Permission", ptype="write", raise_exception=False): + return - employee_user_permission_exists = frappe.db.exists('User Permission', { - 'allow': 'Employee', - 'for_value': self.name, - 'user': self.user_id - }) + employee_user_permission_exists = frappe.db.exists( + "User Permission", {"allow": "Employee", "for_value": self.name, "user": self.user_id} + ) if employee_user_permission_exists: return @@ -131,12 +143,14 @@ class Employee(NestedSet): if not user.user_image: user.user_image = self.image try: - frappe.get_doc({ - "doctype": "File", - "file_url": self.image, - "attached_to_doctype": "User", - "attached_to_name": self.user_id - }).insert() + frappe.get_doc( + { + "doctype": "File", + "file_url": self.image, + "attached_to_doctype": "User", + "attached_to_name": self.user_id, + } + ).insert() except frappe.DuplicateEntryError: # already exists pass @@ -154,20 +168,48 @@ class Employee(NestedSet): user.flags.ignore_permissions = True user.add_roles("Expense Approver") + def update_to_date_in_work_history(self): + if not self.internal_work_history: + return + + for idx, row in enumerate(self.internal_work_history): + if not row.from_date or idx == 0: + continue + + self.internal_work_history[idx - 1].to_date = add_days(row.from_date, -1) + + self.internal_work_history[-1].to_date = None + def validate_date(self): if self.date_of_birth and getdate(self.date_of_birth) > getdate(today()): throw(_("Date of Birth cannot be greater than today.")) - if self.date_of_birth and self.date_of_joining and getdate(self.date_of_birth) >= getdate(self.date_of_joining): + if ( + self.date_of_birth + and self.date_of_joining + and getdate(self.date_of_birth) >= getdate(self.date_of_joining) + ): throw(_("Date of Joining must be greater than Date of Birth")) - elif self.date_of_retirement and self.date_of_joining and (getdate(self.date_of_retirement) <= getdate(self.date_of_joining)): + elif ( + self.date_of_retirement + and self.date_of_joining + and (getdate(self.date_of_retirement) <= getdate(self.date_of_joining)) + ): throw(_("Date Of Retirement must be greater than Date of Joining")) - elif self.relieving_date and self.date_of_joining and (getdate(self.relieving_date) < getdate(self.date_of_joining)): + elif ( + self.relieving_date + and self.date_of_joining + and (getdate(self.relieving_date) < getdate(self.date_of_joining)) + ): throw(_("Relieving Date must be greater than or equal to Date of Joining")) - elif self.contract_end_date and self.date_of_joining and (getdate(self.contract_end_date) <= getdate(self.date_of_joining)): + elif ( + self.contract_end_date + and self.date_of_joining + and (getdate(self.contract_end_date) <= getdate(self.date_of_joining)) + ): throw(_("Contract End Date must be greater than Date of Joining")) def validate_email(self): @@ -183,14 +225,20 @@ class Employee(NestedSet): self.prefered_email = preferred_email def validate_status(self): - if self.status == 'Left': - reports_to = frappe.db.get_all('Employee', - filters={'reports_to': self.name, 'status': "Active"}, - fields=['name','employee_name'] + if self.status == "Left": + reports_to = frappe.db.get_all( + "Employee", + filters={"reports_to": self.name, "status": "Active"}, + fields=["name", "employee_name"], ) if reports_to: - link_to_employees = [frappe.utils.get_link_to_form('Employee', employee.name, label=employee.employee_name) for employee in reports_to] - message = _("The following employees are currently still reporting to {0}:").format(frappe.bold(self.employee_name)) + link_to_employees = [ + frappe.utils.get_link_to_form("Employee", employee.name, label=employee.employee_name) + for employee in reports_to + ] + message = _("The following employees are currently still reporting to {0}:").format( + frappe.bold(self.employee_name) + ) message += "
- " + "
- ".join(link_to_employees) message += "
" message += _("Please make sure the employees above report to another Active employee.") @@ -199,7 +247,7 @@ class Employee(NestedSet): throw(_("Please enter relieving date.")) def validate_for_enabled_user_id(self, enabled): - if not self.status == 'Active': + if not self.status == "Active": return if enabled is None: @@ -208,11 +256,16 @@ class Employee(NestedSet): frappe.throw(_("User {0} is disabled").format(self.user_id), EmployeeUserDisabledError) def validate_duplicate_user_id(self): - employee = frappe.db.sql_list("""select name from `tabEmployee` where - user_id=%s and status='Active' and name!=%s""", (self.user_id, self.name)) + employee = frappe.db.sql_list( + """select name from `tabEmployee` where + user_id=%s and status='Active' and name!=%s""", + (self.user_id, self.name), + ) if employee: - throw(_("User {0} is already assigned to Employee {1}").format( - self.user_id, employee[0]), frappe.DuplicateEntryError) + throw( + _("User {0} is already assigned to Employee {1}").format(self.user_id, employee[0]), + frappe.DuplicateEntryError, + ) def validate_reports_to(self): if self.reports_to == self.name: @@ -221,17 +274,25 @@ class Employee(NestedSet): def on_trash(self): self.update_nsm_model() delete_events(self.doctype, self.name) - if frappe.db.exists("Employee Transfer", {'new_employee_id': self.name, 'docstatus': 1}): - emp_transfer = frappe.get_doc("Employee Transfer", {'new_employee_id': self.name, 'docstatus': 1}) - emp_transfer.db_set("new_employee_id", '') + if frappe.db.exists("Employee Transfer", {"new_employee_id": self.name, "docstatus": 1}): + emp_transfer = frappe.get_doc( + "Employee Transfer", {"new_employee_id": self.name, "docstatus": 1} + ) + emp_transfer.db_set("new_employee_id", "") def validate_preferred_email(self): if self.prefered_contact_email and not self.get(scrub(self.prefered_contact_email)): frappe.msgprint(_("Please enter {0}").format(self.prefered_contact_email)) def validate_onboarding_process(self): - employee_onboarding = frappe.get_all("Employee Onboarding", - filters={"job_applicant": self.job_applicant, "docstatus": 1, "boarding_status": ("!=", "Completed")}) + employee_onboarding = frappe.get_all( + "Employee Onboarding", + filters={ + "job_applicant": self.job_applicant, + "docstatus": 1, + "boarding_status": ("!=", "Completed"), + }, + ) if employee_onboarding: doc = frappe.get_doc("Employee Onboarding", employee_onboarding[0].name) doc.validate_employee_creation() @@ -239,20 +300,26 @@ class Employee(NestedSet): def reset_employee_emails_cache(self): prev_doc = self.get_doc_before_save() or {} - cell_number = cstr(self.get('cell_number')) - prev_number = cstr(prev_doc.get('cell_number')) - if (cell_number != prev_number or - self.get('user_id') != prev_doc.get('user_id')): - frappe.cache().hdel('employees_with_number', cell_number) - frappe.cache().hdel('employees_with_number', prev_number) + cell_number = cstr(self.get("cell_number")) + prev_number = cstr(prev_doc.get("cell_number")) + if cell_number != prev_number or self.get("user_id") != prev_doc.get("user_id"): + frappe.cache().hdel("employees_with_number", cell_number) + frappe.cache().hdel("employees_with_number", prev_number) + def get_timeline_data(doctype, name): - '''Return timeline for attendance''' - return dict(frappe.db.sql('''select unix_timestamp(attendance_date), count(*) + """Return timeline for attendance""" + return dict( + frappe.db.sql( + """select unix_timestamp(attendance_date), count(*) from `tabAttendance` where employee=%s and attendance_date > date_sub(curdate(), interval 1 year) and status in ('Present', 'Half Day') - group by attendance_date''', name)) + group by attendance_date""", + name, + ) + ) + @frappe.whitelist() def get_retirement_date(date_of_birth=None): @@ -260,14 +327,15 @@ def get_retirement_date(date_of_birth=None): if date_of_birth: try: retirement_age = int(frappe.db.get_single_value("HR Settings", "retirement_age") or 60) - dt = add_years(getdate(date_of_birth),retirement_age) - ret = {'date_of_retirement': dt.strftime('%Y-%m-%d')} + dt = add_years(getdate(date_of_birth), retirement_age) + ret = {"date_of_retirement": dt.strftime("%Y-%m-%d")} except ValueError: # invalid date ret = {} return ret + def validate_employee_role(doc, method): # called via User hook if "Employee" in [d.role for d in doc.get("roles")]: @@ -275,39 +343,54 @@ def validate_employee_role(doc, method): frappe.msgprint(_("Please set User ID field in an Employee record to set Employee Role")) doc.get("roles").remove(doc.get("roles", {"role": "Employee"})[0]) + def update_user_permissions(doc, method): # called via User hook if "Employee" in [d.role for d in doc.get("roles")]: - if not has_permission('User Permission', ptype='write', raise_exception=False): return + if not has_permission("User Permission", ptype="write", raise_exception=False): + return employee = frappe.get_doc("Employee", {"user_id": doc.name}) employee.update_user_permissions() + def get_employee_email(employee_doc): - return employee_doc.get("user_id") or employee_doc.get("personal_email") or employee_doc.get("company_email") + return ( + employee_doc.get("user_id") + or employee_doc.get("personal_email") + or employee_doc.get("company_email") + ) + def get_holiday_list_for_employee(employee, raise_exception=True): if employee: - holiday_list, company = frappe.db.get_value("Employee", employee, ["holiday_list", "company"]) + holiday_list, company = frappe.get_cached_value( + "Employee", employee, ["holiday_list", "company"] + ) else: - holiday_list='' - company=frappe.db.get_value("Global Defaults", None, "default_company") + holiday_list = "" + company = frappe.db.get_value("Global Defaults", None, "default_company") if not holiday_list: - holiday_list = frappe.get_cached_value('Company', company, "default_holiday_list") + holiday_list = frappe.get_cached_value("Company", company, "default_holiday_list") if not holiday_list and raise_exception: - frappe.throw(_('Please set a default Holiday List for Employee {0} or Company {1}').format(employee, company)) + frappe.throw( + _("Please set a default Holiday List for Employee {0} or Company {1}").format(employee, company) + ) return holiday_list -def is_holiday(employee, date=None, raise_exception=True, only_non_weekly=False, with_description=False): - ''' + +def is_holiday( + employee, date=None, raise_exception=True, only_non_weekly=False, with_description=False +): + """ Returns True if given Employee has an holiday on the given date - :param employee: Employee `name` - :param date: Date to check. Will check for today if None - :param raise_exception: Raise an exception if no holiday list found, default is True - :param only_non_weekly: Check only non-weekly holidays, default is False - ''' + :param employee: Employee `name` + :param date: Date to check. Will check for today if None + :param raise_exception: Raise an exception if no holiday list found, default is True + :param only_non_weekly: Check only non-weekly holidays, default is False + """ holiday_list = get_holiday_list_for_employee(employee, raise_exception) if not date: @@ -316,34 +399,28 @@ def is_holiday(employee, date=None, raise_exception=True, only_non_weekly=False, if not holiday_list: return False - filters = { - 'parent': holiday_list, - 'holiday_date': date - } + filters = {"parent": holiday_list, "holiday_date": date} if only_non_weekly: - filters['weekly_off'] = False + filters["weekly_off"] = False - holidays = frappe.get_all( - 'Holiday', - fields=['description'], - filters=filters, - pluck='description' - ) + holidays = frappe.get_all("Holiday", fields=["description"], filters=filters, pluck="description") if with_description: return len(holidays) > 0, holidays return len(holidays) > 0 + @frappe.whitelist() -def deactivate_sales_person(status = None, employee = None): +def deactivate_sales_person(status=None, employee=None): if status == "Left": sales_person = frappe.db.get_value("Sales Person", {"Employee": employee}) if sales_person: frappe.db.set_value("Sales Person", sales_person, "enabled", 0) + @frappe.whitelist() -def create_user(employee, user = None, email=None): +def create_user(employee, user=None, email=None): emp = frappe.get_doc("Employee", employee) employee_name = emp.employee_name.split(" ") @@ -361,93 +438,98 @@ def create_user(employee, user = None, email=None): emp.prefered_email = email user = frappe.new_doc("User") - user.update({ - "name": emp.employee_name, - "email": emp.prefered_email, - "enabled": 1, - "first_name": first_name, - "middle_name": middle_name, - "last_name": last_name, - "gender": emp.gender, - "birth_date": emp.date_of_birth, - "phone": emp.cell_number, - "bio": emp.bio - }) + user.update( + { + "name": emp.employee_name, + "email": emp.prefered_email, + "enabled": 1, + "first_name": first_name, + "middle_name": middle_name, + "last_name": last_name, + "gender": emp.gender, + "birth_date": emp.date_of_birth, + "phone": emp.cell_number, + "bio": emp.bio, + } + ) user.insert() return user.name + def get_all_employee_emails(company): - '''Returns list of employee emails either based on user_id or company_email''' - employee_list = frappe.get_all('Employee', - fields=['name','employee_name'], - filters={ - 'status': 'Active', - 'company': company - } + """Returns list of employee emails either based on user_id or company_email""" + employee_list = frappe.get_all( + "Employee", fields=["name", "employee_name"], filters={"status": "Active", "company": company} ) employee_emails = [] for employee in employee_list: if not employee: continue - user, company_email, personal_email = frappe.db.get_value('Employee', - employee, ['user_id', 'company_email', 'personal_email']) + user, company_email, personal_email = frappe.db.get_value( + "Employee", employee, ["user_id", "company_email", "personal_email"] + ) email = user or company_email or personal_email if email: employee_emails.append(email) return employee_emails + def get_employee_emails(employee_list): - '''Returns list of employee emails either based on user_id or company_email''' + """Returns list of employee emails either based on user_id or company_email""" employee_emails = [] for employee in employee_list: if not employee: continue - user, company_email, personal_email = frappe.db.get_value('Employee', employee, - ['user_id', 'company_email', 'personal_email']) + user, company_email, personal_email = frappe.db.get_value( + "Employee", employee, ["user_id", "company_email", "personal_email"] + ) email = user or company_email or personal_email if email: employee_emails.append(email) return employee_emails + @frappe.whitelist() def get_children(doctype, parent=None, company=None, is_root=False, is_tree=False): - filters = [['status', '=', 'Active']] - if company and company != 'All Companies': - filters.append(['company', '=', company]) + filters = [["status", "=", "Active"]] + if company and company != "All Companies": + filters.append(["company", "=", company]) - fields = ['name as value', 'employee_name as title'] + fields = ["name as value", "employee_name as title"] if is_root: - parent = '' - if parent and company and parent!=company: - filters.append(['reports_to', '=', parent]) + parent = "" + if parent and company and parent != company: + filters.append(["reports_to", "=", parent]) else: - filters.append(['reports_to', '=', '']) + filters.append(["reports_to", "=", ""]) - employees = frappe.get_list(doctype, fields=fields, - filters=filters, order_by='name') + employees = frappe.get_list(doctype, fields=fields, filters=filters, order_by="name") for employee in employees: - is_expandable = frappe.get_all(doctype, filters=[ - ['reports_to', '=', employee.get('value')] - ]) + is_expandable = frappe.get_all(doctype, filters=[["reports_to", "=", employee.get("value")]]) employee.expandable = 1 if is_expandable else 0 return employees + def on_doctype_update(): frappe.db.add_index("Employee", ["lft", "rgt"]) -def has_user_permission_for_employee(user_name, employee_name): - return frappe.db.exists({ - 'doctype': 'User Permission', - 'user': user_name, - 'allow': 'Employee', - 'for_value': employee_name - }) -def has_upload_permission(doc, ptype='read', user=None): +def has_user_permission_for_employee(user_name, employee_name): + return frappe.db.exists( + { + "doctype": "User Permission", + "user": user_name, + "allow": "Employee", + "for_value": employee_name, + } + ) + + +def has_upload_permission(doc, ptype="read", user=None): if not user: user = frappe.session.user if get_doc_permissions(doc, user=user, ptype=ptype).get(ptype): diff --git a/erpnext/hr/doctype/employee/employee_dashboard.py b/erpnext/hr/doctype/employee/employee_dashboard.py index 0aaff52ee28..d7235418a23 100644 --- a/erpnext/hr/doctype/employee/employee_dashboard.py +++ b/erpnext/hr/doctype/employee/employee_dashboard.py @@ -1,52 +1,46 @@ - from frappe import _ def get_data(): return { - 'heatmap': True, - 'heatmap_message': _('This is based on the attendance of this Employee'), - 'fieldname': 'employee', - 'non_standard_fieldnames': { - 'Bank Account': 'party', - 'Employee Grievance': 'raised_by' - }, - 'transactions': [ + "heatmap": True, + "heatmap_message": _("This is based on the attendance of this Employee"), + "fieldname": "employee", + "non_standard_fieldnames": {"Bank Account": "party", "Employee Grievance": "raised_by"}, + "transactions": [ + {"label": _("Attendance"), "items": ["Attendance", "Attendance Request", "Employee Checkin"]}, { - 'label': _('Attendance'), - 'items': ['Attendance', 'Attendance Request', 'Employee Checkin'] + "label": _("Leave"), + "items": ["Leave Application", "Leave Allocation", "Leave Policy Assignment"], }, { - 'label': _('Leave'), - 'items': ['Leave Application', 'Leave Allocation', 'Leave Policy Assignment'] + "label": _("Lifecycle"), + "items": [ + "Employee Transfer", + "Employee Promotion", + "Employee Separation", + "Employee Grievance", + ], + }, + {"label": _("Shift"), "items": ["Shift Request", "Shift Assignment"]}, + {"label": _("Expense"), "items": ["Expense Claim", "Travel Request", "Employee Advance"]}, + {"label": _("Benefit"), "items": ["Employee Benefit Application", "Employee Benefit Claim"]}, + { + "label": _("Payroll"), + "items": [ + "Salary Structure Assignment", + "Salary Slip", + "Additional Salary", + "Timesheet", + "Employee Incentive", + "Retention Bonus", + "Bank Account", + ], }, { - 'label': _('Lifecycle'), - 'items': ['Employee Transfer', 'Employee Promotion', 'Employee Separation', 'Employee Grievance'] + "label": _("Training"), + "items": ["Training Event", "Training Result", "Training Feedback", "Employee Skill Map"], }, - { - 'label': _('Shift'), - 'items': ['Shift Request', 'Shift Assignment'] - }, - { - 'label': _('Expense'), - 'items': ['Expense Claim', 'Travel Request', 'Employee Advance'] - }, - { - 'label': _('Benefit'), - 'items': ['Employee Benefit Application', 'Employee Benefit Claim'] - }, - { - 'label': _('Payroll'), - 'items': ['Salary Structure Assignment', 'Salary Slip', 'Additional Salary', 'Timesheet','Employee Incentive', 'Retention Bonus', 'Bank Account'] - }, - { - 'label': _('Training'), - 'items': ['Training Event', 'Training Result', 'Training Feedback', 'Employee Skill Map'] - }, - { - 'label': _('Evaluation'), - 'items': ['Appraisal'] - }, - ] + {"label": _("Evaluation"), "items": ["Appraisal"]}, + ], } diff --git a/erpnext/hr/doctype/employee/employee_reminders.py b/erpnext/hr/doctype/employee/employee_reminders.py index 559bd393e62..f09d7ff75a7 100644 --- a/erpnext/hr/doctype/employee/employee_reminders.py +++ b/erpnext/hr/doctype/employee/employee_reminders.py @@ -20,6 +20,7 @@ def send_reminders_in_advance_weekly(): send_advance_holiday_reminders("Weekly") + def send_reminders_in_advance_monthly(): to_send_in_advance = int(frappe.db.get_single_value("HR Settings", "send_holiday_reminders")) frequency = frappe.db.get_single_value("HR Settings", "frequency") @@ -28,6 +29,7 @@ def send_reminders_in_advance_monthly(): send_advance_holiday_reminders("Monthly") + def send_advance_holiday_reminders(frequency): """Send Holiday Reminders in Advance to Employees `frequency` (str): 'Weekly' or 'Monthly' @@ -42,20 +44,20 @@ def send_advance_holiday_reminders(frequency): else: return - employees = frappe.db.get_all('Employee', pluck='name') + employees = frappe.db.get_all("Employee", filters={"status": "Active"}, pluck="name") for employee in employees: holidays = get_holidays_for_employee( - employee, - start_date, end_date, - only_non_weekly=True, - raise_exception=False + employee, start_date, end_date, only_non_weekly=True, raise_exception=False ) - if not (holidays is None): - send_holidays_reminder_in_advance(employee, holidays) + send_holidays_reminder_in_advance(employee, holidays) + def send_holidays_reminder_in_advance(employee, holidays): - employee_doc = frappe.get_doc('Employee', employee) + if not holidays: + return + + employee_doc = frappe.get_doc("Employee", employee) employee_email = get_employee_email(employee_doc) frequency = frappe.db.get_single_value("HR Settings", "frequency") @@ -65,15 +67,18 @@ def send_holidays_reminder_in_advance(employee, holidays): subject=_("Upcoming Holidays Reminder"), template="holiday_reminder", args=dict( - reminder_text=_("Hey {}! This email is to remind you about the upcoming holidays.").format(employee_doc.get('first_name')), + reminder_text=_("Hey {}! This email is to remind you about the upcoming holidays.").format( + employee_doc.get("first_name") + ), message=_("Below is the list of upcoming holidays for you:"), advance_holiday_reminder=True, holidays=holidays, - frequency=frequency[:-2] + frequency=frequency[:-2], ), - header=email_header + header=email_header, ) + # ------------------ # BIRTHDAY REMINDERS # ------------------ @@ -101,12 +106,13 @@ def send_birthday_reminders(): reminder_text, message = get_birthday_reminder_text_and_message(others) send_birthday_reminder(person_email, reminder_text, others, message) + def get_birthday_reminder_text_and_message(birthday_persons): if len(birthday_persons) == 1: - birthday_person_text = birthday_persons[0]['name'] + birthday_person_text = birthday_persons[0]["name"] else: # converts ["Jim", "Rim", "Dim"] to Jim, Rim & Dim - person_names = [d['name'] for d in birthday_persons] + person_names = [d["name"] for d in birthday_persons] birthday_person_text = comma_sep(person_names, frappe._("{0} & {1}"), False) reminder_text = _("Today is {0}'s birthday 🎉").format(birthday_person_text) @@ -116,6 +122,7 @@ def get_birthday_reminder_text_and_message(birthday_persons): return reminder_text, message + def send_birthday_reminder(recipients, reminder_text, birthday_persons, message): frappe.sendmail( recipients=recipients, @@ -126,13 +133,15 @@ def send_birthday_reminder(recipients, reminder_text, birthday_persons, message) birthday_persons=birthday_persons, message=message, ), - header=_("Birthday Reminder 🎂") + header=_("Birthday Reminder 🎂"), ) + def get_employees_who_are_born_today(): """Get all employee born today & group them based on their company""" return get_employees_having_an_event_today("birthday") + def get_employees_having_an_event_today(event_type): """Get all employee who have `event_type` today & group them based on their company. `event_type` @@ -141,15 +150,16 @@ def get_employees_having_an_event_today(event_type): from collections import defaultdict # Set column based on event type - if event_type == 'birthday': - condition_column = 'date_of_birth' - elif event_type == 'work_anniversary': - condition_column = 'date_of_joining' + if event_type == "birthday": + condition_column = "date_of_birth" + elif event_type == "work_anniversary": + condition_column = "date_of_joining" else: return - employees_born_today = frappe.db.multisql({ - "mariadb": f""" + employees_born_today = frappe.db.multisql( + { + "mariadb": f""" SELECT `personal_email`, `company`, `company_email`, `user_id`, `employee_name` AS 'name', `image`, `date_of_joining` FROM `tabEmployee` WHERE @@ -161,7 +171,7 @@ def get_employees_having_an_event_today(event_type): AND `status` = 'Active' """, - "postgres": f""" + "postgres": f""" SELECT "personal_email", "company", "company_email", "user_id", "employee_name" AS 'name', "image" FROM "tabEmployee" WHERE @@ -173,12 +183,15 @@ def get_employees_having_an_event_today(event_type): AND "status" = 'Active' """, - }, dict(today=today(), condition_column=condition_column), as_dict=1) + }, + dict(today=today(), condition_column=condition_column), + as_dict=1, + ) grouped_employees = defaultdict(lambda: []) for employee_doc in employees_born_today: - grouped_employees[employee_doc.get('company')].append(employee_doc) + grouped_employees[employee_doc.get("company")].append(employee_doc) return grouped_employees @@ -210,22 +223,23 @@ def send_work_anniversary_reminders(): reminder_text, message = get_work_anniversary_reminder_text_and_message(others) send_work_anniversary_reminder(person_email, reminder_text, others, message) + def get_work_anniversary_reminder_text_and_message(anniversary_persons): if len(anniversary_persons) == 1: - anniversary_person = anniversary_persons[0]['name'] + anniversary_person = anniversary_persons[0]["name"] persons_name = anniversary_person # Number of years completed at the company - completed_years = getdate().year - anniversary_persons[0]['date_of_joining'].year - anniversary_person += f" completed {completed_years} years" + completed_years = getdate().year - anniversary_persons[0]["date_of_joining"].year + anniversary_person += f" completed {get_pluralized_years(completed_years)}" else: person_names_with_years = [] names = [] for person in anniversary_persons: - person_text = person['name'] + person_text = person["name"] names.append(person_text) # Number of years completed at the company - completed_years = getdate().year - person['date_of_joining'].year - person_text += f" completed {completed_years} years" + completed_years = getdate().year - person["date_of_joining"].year + person_text += f" completed {get_pluralized_years(completed_years)}" person_names_with_years.append(person_text) # converts ["Jim", "Rim", "Dim"] to Jim, Rim & Dim @@ -239,6 +253,13 @@ def get_work_anniversary_reminder_text_and_message(anniversary_persons): return reminder_text, message + +def get_pluralized_years(years): + if years == 1: + return "1 year" + return f"{years} years" + + def send_work_anniversary_reminder(recipients, reminder_text, anniversary_persons, message): frappe.sendmail( recipients=recipients, @@ -249,5 +270,5 @@ def send_work_anniversary_reminder(recipients, reminder_text, anniversary_person anniversary_persons=anniversary_persons, message=message, ), - header=_("🎊️🎊️ Work Anniversary Reminder 🎊️🎊️") + header=_("Work Anniversary Reminder"), ) diff --git a/erpnext/hr/doctype/employee/test_employee.py b/erpnext/hr/doctype/employee/test_employee.py index 8a2da0866e9..50894b61716 100644 --- a/erpnext/hr/doctype/employee/test_employee.py +++ b/erpnext/hr/doctype/employee/test_employee.py @@ -9,7 +9,8 @@ import frappe.utils import erpnext from erpnext.hr.doctype.employee.employee import InactiveEmployeeStatusError -test_records = frappe.get_test_records('Employee') +test_records = frappe.get_test_records("Employee") + class TestEmployee(unittest.TestCase): def test_employee_status_left(self): @@ -21,7 +22,7 @@ class TestEmployee(unittest.TestCase): employee2_doc.reports_to = employee1_doc.name employee2_doc.save() employee1_doc.reload() - employee1_doc.status = 'Left' + employee1_doc.status = "Left" self.assertRaises(InactiveEmployeeStatusError, employee1_doc.save) def test_employee_status_inactive(self): @@ -36,11 +37,19 @@ class TestEmployee(unittest.TestCase): employee_doc.reload() make_holiday_list() - frappe.db.set_value("Company", erpnext.get_default_company(), "default_holiday_list", "Salary Slip Test Holiday List") + frappe.db.set_value( + "Company", employee_doc.company, "default_holiday_list", "Salary Slip Test Holiday List" + ) - frappe.db.sql("""delete from `tabSalary Structure` where name='Test Inactive Employee Salary Slip'""") - salary_structure = make_salary_structure("Test Inactive Employee Salary Slip", "Monthly", - employee=employee_doc.name, company=employee_doc.company) + frappe.db.sql( + """delete from `tabSalary Structure` where name='Test Inactive Employee Salary Slip'""" + ) + salary_structure = make_salary_structure( + "Test Inactive Employee Salary Slip", + "Monthly", + employee=employee_doc.name, + company=employee_doc.company, + ) salary_slip = make_salary_slip(salary_structure.name, employee=employee_doc.name) self.assertRaises(InactiveEmployeeStatusError, salary_slip.save) @@ -48,38 +57,43 @@ class TestEmployee(unittest.TestCase): def tearDown(self): frappe.db.rollback() + def make_employee(user, company=None, **kwargs): if not frappe.db.get_value("User", user): - frappe.get_doc({ - "doctype": "User", - "email": user, - "first_name": user, - "new_password": "password", - "send_welcome_email": 0, - "roles": [{"doctype": "Has Role", "role": "Employee"}] - }).insert() + frappe.get_doc( + { + "doctype": "User", + "email": user, + "first_name": user, + "new_password": "password", + "send_welcome_email": 0, + "roles": [{"doctype": "Has Role", "role": "Employee"}], + } + ).insert() if not frappe.db.get_value("Employee", {"user_id": user}): - employee = frappe.get_doc({ - "doctype": "Employee", - "naming_series": "EMP-", - "first_name": user, - "company": company or erpnext.get_default_company(), - "user_id": user, - "date_of_birth": "1990-05-08", - "date_of_joining": "2013-01-01", - "department": frappe.get_all("Department", fields="name")[0].name, - "gender": "Female", - "company_email": user, - "prefered_contact_email": "Company Email", - "prefered_email": user, - "status": "Active", - "employment_type": "Intern" - }) + employee = frappe.get_doc( + { + "doctype": "Employee", + "naming_series": "EMP-", + "first_name": user, + "company": company or erpnext.get_default_company(), + "user_id": user, + "date_of_birth": "1990-05-08", + "date_of_joining": "2013-01-01", + "department": frappe.get_all("Department", fields="name")[0].name, + "gender": "Female", + "company_email": user, + "prefered_contact_email": "Company Email", + "prefered_email": user, + "status": "Active", + "employment_type": "Intern", + } + ) if kwargs: employee.update(kwargs) employee.insert() return employee.name else: - frappe.db.set_value("Employee", {"employee_name":user}, "status", "Active") - return frappe.get_value("Employee", {"employee_name":user}, "name") + frappe.db.set_value("Employee", {"employee_name": user}, "status", "Active") + return frappe.get_value("Employee", {"employee_name": user}, "name") diff --git a/erpnext/hr/doctype/employee/test_employee_reminders.py b/erpnext/hr/doctype/employee/test_employee_reminders.py index 52c00982443..9bde77c9569 100644 --- a/erpnext/hr/doctype/employee/test_employee_reminders.py +++ b/erpnext/hr/doctype/employee/test_employee_reminders.py @@ -5,10 +5,12 @@ import unittest from datetime import timedelta import frappe -from frappe.utils import getdate +from frappe.utils import add_months, getdate +from erpnext.hr.doctype.employee.employee_reminders import send_holidays_reminder_in_advance from erpnext.hr.doctype.employee.test_employee import make_employee from erpnext.hr.doctype.hr_settings.hr_settings import set_proceed_with_frequency_change +from erpnext.hr.utils import get_holidays_for_employee class TestEmployeeReminders(unittest.TestCase): @@ -19,23 +21,22 @@ class TestEmployeeReminders(unittest.TestCase): # Create a test holiday list test_holiday_dates = cls.get_test_holiday_dates() test_holiday_list = make_holiday_list( - 'TestHolidayRemindersList', + "TestHolidayRemindersList", holiday_dates=[ - {'holiday_date': test_holiday_dates[0], 'description': 'test holiday1'}, - {'holiday_date': test_holiday_dates[1], 'description': 'test holiday2'}, - {'holiday_date': test_holiday_dates[2], 'description': 'test holiday3', 'weekly_off': 1}, - {'holiday_date': test_holiday_dates[3], 'description': 'test holiday4'}, - {'holiday_date': test_holiday_dates[4], 'description': 'test holiday5'}, - {'holiday_date': test_holiday_dates[5], 'description': 'test holiday6'}, + {"holiday_date": test_holiday_dates[0], "description": "test holiday1"}, + {"holiday_date": test_holiday_dates[1], "description": "test holiday2"}, + {"holiday_date": test_holiday_dates[2], "description": "test holiday3", "weekly_off": 1}, + {"holiday_date": test_holiday_dates[3], "description": "test holiday4"}, + {"holiday_date": test_holiday_dates[4], "description": "test holiday5"}, + {"holiday_date": test_holiday_dates[5], "description": "test holiday6"}, ], - from_date=getdate()-timedelta(days=10), - to_date=getdate()+timedelta(weeks=5) + from_date=getdate() - timedelta(days=10), + to_date=getdate() + timedelta(weeks=5), ) # Create a test employee test_employee = frappe.get_doc( - 'Employee', - make_employee('test@gopher.io', company="_Test Company") + "Employee", make_employee("test@gopher.io", company="_Test Company") ) # Attach the holiday list to employee @@ -46,40 +47,63 @@ class TestEmployeeReminders(unittest.TestCase): cls.test_employee = test_employee cls.test_holiday_dates = test_holiday_dates + # Employee without holidays in this month/week + test_employee_2 = make_employee("test@empwithoutholiday.io", company="_Test Company") + test_employee_2 = frappe.get_doc("Employee", test_employee_2) + + test_holiday_list = make_holiday_list( + "TestHolidayRemindersList2", + holiday_dates=[ + {"holiday_date": add_months(getdate(), 1), "description": "test holiday1"}, + ], + from_date=add_months(getdate(), -2), + to_date=add_months(getdate(), 2), + ) + test_employee_2.holiday_list = test_holiday_list.name + test_employee_2.save() + + cls.test_employee_2 = test_employee_2 + cls.holiday_list_2 = test_holiday_list + @classmethod def get_test_holiday_dates(cls): today_date = getdate() return [ today_date, - today_date-timedelta(days=4), - today_date-timedelta(days=3), - today_date+timedelta(days=1), - today_date+timedelta(days=3), - today_date+timedelta(weeks=3) + today_date - timedelta(days=4), + today_date - timedelta(days=3), + today_date + timedelta(days=1), + today_date + timedelta(days=3), + today_date + timedelta(weeks=3), ] def setUp(self): # Clear Email Queue frappe.db.sql("delete from `tabEmail Queue`") + frappe.db.sql("delete from `tabEmail Queue Recipient`") def test_is_holiday(self): from erpnext.hr.doctype.employee.employee import is_holiday self.assertTrue(is_holiday(self.test_employee.name)) self.assertTrue(is_holiday(self.test_employee.name, date=self.test_holiday_dates[1])) - self.assertFalse(is_holiday(self.test_employee.name, date=getdate()-timedelta(days=1))) + self.assertFalse(is_holiday(self.test_employee.name, date=getdate() - timedelta(days=1))) # Test weekly_off holidays self.assertTrue(is_holiday(self.test_employee.name, date=self.test_holiday_dates[2])) - self.assertFalse(is_holiday(self.test_employee.name, date=self.test_holiday_dates[2], only_non_weekly=True)) + self.assertFalse( + is_holiday(self.test_employee.name, date=self.test_holiday_dates[2], only_non_weekly=True) + ) # Test with descriptions has_holiday, descriptions = is_holiday(self.test_employee.name, with_description=True) self.assertTrue(has_holiday) - self.assertTrue('test holiday1' in descriptions) + self.assertTrue("test holiday1" in descriptions) def test_birthday_reminders(self): - employee = frappe.get_doc("Employee", frappe.db.sql_list("select name from tabEmployee limit 1")[0]) + employee = frappe.get_doc( + "Employee", frappe.db.sql_list("select name from tabEmployee limit 1")[0] + ) employee.date_of_birth = "1992" + frappe.utils.nowdate()[4:] employee.company_email = "test@example.com" employee.company = "_Test Company" @@ -103,19 +127,24 @@ class TestEmployeeReminders(unittest.TestCase): self.assertTrue("Subject: Birthday Reminder" in email_queue[0].message) def test_work_anniversary_reminders(self): - employee = frappe.get_doc("Employee", frappe.db.sql_list("select name from tabEmployee limit 1")[0]) - employee.date_of_joining = "1998" + frappe.utils.nowdate()[4:] - employee.company_email = "test@example.com" - employee.company = "_Test Company" - employee.save() + make_employee( + "test_work_anniversary@gmail.com", + date_of_joining="1998" + frappe.utils.nowdate()[4:], + company="_Test Company", + ) from erpnext.hr.doctype.employee.employee_reminders import ( get_employees_having_an_event_today, send_work_anniversary_reminders, ) - employees_having_work_anniversary = get_employees_having_an_event_today('work_anniversary') - self.assertTrue(employees_having_work_anniversary.get("_Test Company")) + employees_having_work_anniversary = get_employees_having_an_event_today("work_anniversary") + employees = employees_having_work_anniversary.get("_Test Company") or [] + user_ids = [] + for entry in employees: + user_ids.append(entry.user_id) + + self.assertTrue("test_work_anniversary@gmail.com" in user_ids) hr_settings = frappe.get_doc("HR Settings", "HR Settings") hr_settings.send_work_anniversary_reminders = 1 @@ -126,57 +155,114 @@ class TestEmployeeReminders(unittest.TestCase): email_queue = frappe.db.sql("""select * from `tabEmail Queue`""", as_dict=True) self.assertTrue("Subject: Work Anniversary Reminder" in email_queue[0].message) - def test_send_holidays_reminder_in_advance(self): - from erpnext.hr.doctype.employee.employee_reminders import send_holidays_reminder_in_advance - from erpnext.hr.utils import get_holidays_for_employee + def test_work_anniversary_reminder_not_sent_for_0_years(self): + make_employee( + "test_work_anniversary_2@gmail.com", + date_of_joining=getdate(), + company="_Test Company", + ) - # Get HR settings and enable advance holiday reminders - hr_settings = frappe.get_doc("HR Settings", "HR Settings") - hr_settings.send_holiday_reminders = 1 - set_proceed_with_frequency_change() - hr_settings.frequency = 'Weekly' - hr_settings.save() + from erpnext.hr.doctype.employee.employee_reminders import get_employees_having_an_event_today + + employees_having_work_anniversary = get_employees_having_an_event_today("work_anniversary") + employees = employees_having_work_anniversary.get("_Test Company") or [] + user_ids = [] + for entry in employees: + user_ids.append(entry.user_id) + + self.assertTrue("test_work_anniversary_2@gmail.com" not in user_ids) + + def test_send_holidays_reminder_in_advance(self): + setup_hr_settings("Weekly") holidays = get_holidays_for_employee( - self.test_employee.get('name'), - getdate(), getdate() + timedelta(days=3), - only_non_weekly=True, - raise_exception=False - ) - - send_holidays_reminder_in_advance( - self.test_employee.get('name'), - holidays + self.test_employee.get("name"), + getdate(), + getdate() + timedelta(days=3), + only_non_weekly=True, + raise_exception=False, ) + send_holidays_reminder_in_advance(self.test_employee.get("name"), holidays) + email_queue = frappe.db.sql("""select * from `tabEmail Queue`""", as_dict=True) self.assertEqual(len(email_queue), 1) + self.assertTrue("Holidays this Week." in email_queue[0].message) def test_advance_holiday_reminders_monthly(self): from erpnext.hr.doctype.employee.employee_reminders import send_reminders_in_advance_monthly - # Get HR settings and enable advance holiday reminders - hr_settings = frappe.get_doc("HR Settings", "HR Settings") - hr_settings.send_holiday_reminders = 1 - set_proceed_with_frequency_change() - hr_settings.frequency = 'Monthly' - hr_settings.save() + setup_hr_settings("Monthly") + + # disable emp 2, set same holiday list + frappe.db.set_value( + "Employee", + self.test_employee_2.name, + {"status": "Left", "holiday_list": self.test_employee.holiday_list}, + ) send_reminders_in_advance_monthly() - email_queue = frappe.db.sql("""select * from `tabEmail Queue`""", as_dict=True) self.assertTrue(len(email_queue) > 0) + # even though emp 2 has holiday, non-active employees should not be recipients + recipients = frappe.db.get_all("Email Queue Recipient", pluck="recipient") + self.assertTrue(self.test_employee_2.user_id not in recipients) + + # teardown: enable emp 2 + frappe.db.set_value( + "Employee", + self.test_employee_2.name, + {"status": "Active", "holiday_list": self.holiday_list_2.name}, + ) + def test_advance_holiday_reminders_weekly(self): from erpnext.hr.doctype.employee.employee_reminders import send_reminders_in_advance_weekly - # Get HR settings and enable advance holiday reminders - hr_settings = frappe.get_doc("HR Settings", "HR Settings") - hr_settings.send_holiday_reminders = 1 - hr_settings.frequency = 'Weekly' - hr_settings.save() + setup_hr_settings("Weekly") + + # disable emp 2, set same holiday list + frappe.db.set_value( + "Employee", + self.test_employee_2.name, + {"status": "Left", "holiday_list": self.test_employee.holiday_list}, + ) send_reminders_in_advance_weekly() - email_queue = frappe.db.sql("""select * from `tabEmail Queue`""", as_dict=True) self.assertTrue(len(email_queue) > 0) + + # even though emp 2 has holiday, non-active employees should not be recipients + recipients = frappe.db.get_all("Email Queue Recipient", pluck="recipient") + self.assertTrue(self.test_employee_2.user_id not in recipients) + + # teardown: enable emp 2 + frappe.db.set_value( + "Employee", + self.test_employee_2.name, + {"status": "Active", "holiday_list": self.holiday_list_2.name}, + ) + + def test_reminder_not_sent_if_no_holdays(self): + setup_hr_settings("Monthly") + + # reminder not sent if there are no holidays + holidays = get_holidays_for_employee( + self.test_employee_2.get("name"), + getdate(), + getdate() + timedelta(days=3), + only_non_weekly=True, + raise_exception=False, + ) + send_holidays_reminder_in_advance(self.test_employee_2.get("name"), holidays) + email_queue = frappe.db.sql("""select * from `tabEmail Queue`""", as_dict=True) + self.assertEqual(len(email_queue), 0) + + +def setup_hr_settings(frequency=None): + # Get HR settings and enable advance holiday reminders + hr_settings = frappe.get_doc("HR Settings", "HR Settings") + hr_settings.send_holiday_reminders = 1 + set_proceed_with_frequency_change() + hr_settings.frequency = frequency or "Weekly" + hr_settings.save() diff --git a/erpnext/hr/doctype/employee_advance/employee_advance.js b/erpnext/hr/doctype/employee_advance/employee_advance.js index 7d1c7cbf4a8..37ae75aeb6c 100644 --- a/erpnext/hr/doctype/employee_advance/employee_advance.js +++ b/erpnext/hr/doctype/employee_advance/employee_advance.js @@ -65,9 +65,10 @@ frappe.ui.form.on('Employee Advance', { ); } - if (frm.doc.docstatus === 1 && - (flt(frm.doc.claimed_amount) < flt(frm.doc.paid_amount) && flt(frm.doc.paid_amount) != flt(frm.doc.return_amount))) { - + if ( + frm.doc.docstatus === 1 + && (flt(frm.doc.claimed_amount) < flt(frm.doc.paid_amount) - flt(frm.doc.return_amount)) + ) { if (frm.doc.repay_unclaimed_amount_from_salary == 0 && frappe.model.can_create("Journal Entry")) { frm.add_custom_button(__("Return"), function() { frm.trigger('make_return_entry'); diff --git a/erpnext/hr/doctype/employee_advance/employee_advance.json b/erpnext/hr/doctype/employee_advance/employee_advance.json index 3a561216cca..8b2eea11337 100644 --- a/erpnext/hr/doctype/employee_advance/employee_advance.json +++ b/erpnext/hr/doctype/employee_advance/employee_advance.json @@ -2,7 +2,7 @@ "actions": [], "allow_import": 1, "autoname": "naming_series:", - "creation": "2017-10-09 14:26:29.612365", + "creation": "2022-01-17 18:36:51.450395", "doctype": "DocType", "editable_grid": 1, "engine": "InnoDB", @@ -121,7 +121,7 @@ "fieldtype": "Select", "label": "Status", "no_copy": 1, - "options": "Draft\nPaid\nUnpaid\nClaimed\nCancelled", + "options": "Draft\nPaid\nUnpaid\nClaimed\nReturned\nPartly Claimed and Returned\nCancelled", "read_only": 1 }, { @@ -200,7 +200,7 @@ ], "is_submittable": 1, "links": [], - "modified": "2021-09-11 18:38:38.617478", + "modified": "2022-05-23 19:33:52.345823", "modified_by": "Administrator", "module": "HR", "name": "Employee Advance", @@ -236,5 +236,6 @@ "search_fields": "employee,employee_name", "sort_field": "modified", "sort_order": "DESC", + "title_field": "employee_name", "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/hr/doctype/employee_advance/employee_advance.py b/erpnext/hr/doctype/employee_advance/employee_advance.py index 7aac2b63ed3..c1876b11757 100644 --- a/erpnext/hr/doctype/employee_advance/employee_advance.py +++ b/erpnext/hr/doctype/employee_advance/employee_advance.py @@ -16,60 +16,86 @@ from erpnext.hr.utils import validate_active_employee class EmployeeAdvanceOverPayment(frappe.ValidationError): pass + class EmployeeAdvance(Document): def onload(self): - self.get("__onload").make_payment_via_journal_entry = frappe.db.get_single_value('Accounts Settings', - 'make_payment_via_journal_entry') + self.get("__onload").make_payment_via_journal_entry = frappe.db.get_single_value( + "Accounts Settings", "make_payment_via_journal_entry" + ) def validate(self): validate_active_employee(self.employee) self.set_status() def on_cancel(self): - self.ignore_linked_doctypes = ('GL Entry') + self.ignore_linked_doctypes = "GL Entry" + self.set_status(update=True) + + def set_status(self, update=False): + precision = self.precision("paid_amount") + total_amount = flt(flt(self.claimed_amount) + flt(self.return_amount), precision) + status = None - def set_status(self): if self.docstatus == 0: - self.status = "Draft" - if self.docstatus == 1: - if self.claimed_amount and flt(self.claimed_amount) == flt(self.paid_amount): - self.status = "Claimed" - elif self.paid_amount and self.advance_amount == flt(self.paid_amount): - self.status = "Paid" + status = "Draft" + elif self.docstatus == 1: + if flt(self.claimed_amount) > 0 and flt(self.claimed_amount, precision) == flt( + self.paid_amount, precision + ): + status = "Claimed" + elif flt(self.return_amount) > 0 and flt(self.return_amount, precision) == flt( + self.paid_amount, precision + ): + status = "Returned" + elif ( + flt(self.claimed_amount) > 0 + and (flt(self.return_amount) > 0) + and total_amount == flt(self.paid_amount, precision) + ): + status = "Partly Claimed and Returned" + elif flt(self.paid_amount) > 0 and flt(self.advance_amount, precision) == flt( + self.paid_amount, precision + ): + status = "Paid" else: - self.status = "Unpaid" + status = "Unpaid" elif self.docstatus == 2: - self.status = "Cancelled" + status = "Cancelled" + + if update: + self.db_set("status", status) + else: + self.status = status def set_total_advance_paid(self): gle = frappe.qb.DocType("GL Entry") paid_amount = ( frappe.qb.from_(gle) - .select(Sum(gle.debit).as_("paid_amount")) - .where( - (gle.against_voucher_type == 'Employee Advance') - & (gle.against_voucher == self.name) - & (gle.party_type == 'Employee') - & (gle.party == self.employee) - & (gle.docstatus == 1) - & (gle.is_cancelled == 0) - ) - ).run(as_dict=True)[0].paid_amount or 0 + .select(Sum(gle.debit).as_("paid_amount")) + .where( + (gle.against_voucher_type == "Employee Advance") + & (gle.against_voucher == self.name) + & (gle.party_type == "Employee") + & (gle.party == self.employee) + & (gle.docstatus == 1) + & (gle.is_cancelled == 0) + ) + ).run(as_dict=True)[0].paid_amount or 0 return_amount = ( frappe.qb.from_(gle) - .select(Sum(gle.credit).as_("return_amount")) - .where( - (gle.against_voucher_type == 'Employee Advance') - & (gle.voucher_type != 'Expense Claim') - & (gle.against_voucher == self.name) - & (gle.party_type == 'Employee') - & (gle.party == self.employee) - & (gle.docstatus == 1) - & (gle.is_cancelled == 0) - ) - ).run(as_dict=True)[0].return_amount or 0 + .select(Sum(gle.credit).as_("return_amount")) + .where( + (gle.against_voucher_type == "Employee Advance") + & (gle.voucher_type != "Expense Claim") + & (gle.against_voucher == self.name) + & (gle.party_type == "Employee") + & (gle.party == self.employee) + & (gle.docstatus == 1) + & (gle.is_cancelled == 0) + ) + ).run(as_dict=True)[0].return_amount or 0 if paid_amount != 0: paid_amount = flt(paid_amount) / flt(self.exchange_rate) @@ -77,20 +103,22 @@ class EmployeeAdvance(Document): return_amount = flt(return_amount) / flt(self.exchange_rate) if flt(paid_amount) > self.advance_amount: - frappe.throw(_("Row {0}# Paid Amount cannot be greater than requested advance amount"), - EmployeeAdvanceOverPayment) + frappe.throw( + _("Row {0}# Paid Amount cannot be greater than requested advance amount"), + EmployeeAdvanceOverPayment, + ) if flt(return_amount) > self.paid_amount - self.claimed_amount: frappe.throw(_("Return amount cannot be greater unclaimed amount")) self.db_set("paid_amount", paid_amount) self.db_set("return_amount", return_amount) - self.set_status() - frappe.db.set_value("Employee Advance", self.name , "status", self.status) - + self.set_status(update=True) def update_claimed_amount(self): - claimed_amount = frappe.db.sql(""" + claimed_amount = ( + frappe.db.sql( + """ SELECT sum(ifnull(allocated_amount, 0)) FROM `tabExpense Claim Advance` eca, `tabExpense Claim` ec WHERE @@ -99,65 +127,82 @@ class EmployeeAdvance(Document): AND ec.name = eca.parent AND ec.docstatus=1 AND eca.allocated_amount > 0 - """, self.name)[0][0] or 0 + """, + self.name, + )[0][0] + or 0 + ) frappe.db.set_value("Employee Advance", self.name, "claimed_amount", flt(claimed_amount)) self.reload() - self.set_status() - frappe.db.set_value("Employee Advance", self.name, "status", self.status) + self.set_status(update=True) + @frappe.whitelist() def get_pending_amount(employee, posting_date): - employee_due_amount = frappe.get_all("Employee Advance", \ - filters = {"employee":employee, "docstatus":1, "posting_date":("<=", posting_date)}, \ - fields = ["advance_amount", "paid_amount"]) + employee_due_amount = frappe.get_all( + "Employee Advance", + filters={"employee": employee, "docstatus": 1, "posting_date": ("<=", posting_date)}, + fields=["advance_amount", "paid_amount"], + ) return sum([(emp.advance_amount - emp.paid_amount) for emp in employee_due_amount]) + @frappe.whitelist() def make_bank_entry(dt, dn): doc = frappe.get_doc(dt, dn) - payment_account = get_default_bank_cash_account(doc.company, account_type="Cash", - mode_of_payment=doc.mode_of_payment) + payment_account = get_default_bank_cash_account( + doc.company, account_type="Cash", mode_of_payment=doc.mode_of_payment + ) if not payment_account: frappe.throw(_("Please set a Default Cash Account in Company defaults")) - advance_account_currency = frappe.db.get_value('Account', doc.advance_account, 'account_currency') + advance_account_currency = frappe.db.get_value("Account", doc.advance_account, "account_currency") - advance_amount, advance_exchange_rate = get_advance_amount_advance_exchange_rate(advance_account_currency,doc ) + advance_amount, advance_exchange_rate = get_advance_amount_advance_exchange_rate( + advance_account_currency, doc + ) paying_amount, paying_exchange_rate = get_paying_amount_paying_exchange_rate(payment_account, doc) je = frappe.new_doc("Journal Entry") je.posting_date = nowdate() - je.voucher_type = 'Bank Entry' + je.voucher_type = "Bank Entry" je.company = doc.company - je.remark = 'Payment against Employee Advance: ' + dn + '\n' + doc.purpose + je.remark = "Payment against Employee Advance: " + dn + "\n" + doc.purpose je.multi_currency = 1 if advance_account_currency != payment_account.account_currency else 0 - je.append("accounts", { - "account": doc.advance_account, - "account_currency": advance_account_currency, - "exchange_rate": flt(advance_exchange_rate), - "debit_in_account_currency": flt(advance_amount), - "reference_type": "Employee Advance", - "reference_name": doc.name, - "party_type": "Employee", - "cost_center": erpnext.get_default_cost_center(doc.company), - "party": doc.employee, - "is_advance": "Yes" - }) + je.append( + "accounts", + { + "account": doc.advance_account, + "account_currency": advance_account_currency, + "exchange_rate": flt(advance_exchange_rate), + "debit_in_account_currency": flt(advance_amount), + "reference_type": "Employee Advance", + "reference_name": doc.name, + "party_type": "Employee", + "cost_center": erpnext.get_default_cost_center(doc.company), + "party": doc.employee, + "is_advance": "Yes", + }, + ) - je.append("accounts", { - "account": payment_account.account, - "cost_center": erpnext.get_default_cost_center(doc.company), - "credit_in_account_currency": flt(paying_amount), - "account_currency": payment_account.account_currency, - "account_type": payment_account.account_type, - "exchange_rate": flt(paying_exchange_rate) - }) + je.append( + "accounts", + { + "account": payment_account.account, + "cost_center": erpnext.get_default_cost_center(doc.company), + "credit_in_account_currency": flt(paying_amount), + "account_currency": payment_account.account_currency, + "account_type": payment_account.account_type, + "exchange_rate": flt(paying_exchange_rate), + }, + ) return je.as_dict() + def get_advance_amount_advance_exchange_rate(advance_account_currency, doc): if advance_account_currency != doc.currency: advance_amount = flt(doc.advance_amount) * flt(doc.exchange_rate) @@ -168,6 +213,7 @@ def get_advance_amount_advance_exchange_rate(advance_account_currency, doc): return advance_amount, advance_exchange_rate + def get_paying_amount_paying_exchange_rate(payment_account, doc): if payment_account.account_currency != doc.currency: paying_amount = flt(doc.advance_amount) * flt(doc.exchange_rate) @@ -178,6 +224,7 @@ def get_paying_amount_paying_exchange_rate(payment_account, doc): return paying_amount, paying_exchange_rate + @frappe.whitelist() def create_return_through_additional_salary(doc): import json @@ -185,7 +232,7 @@ def create_return_through_additional_salary(doc): if isinstance(doc, str): doc = frappe._dict(json.loads(doc)) - additional_salary = frappe.new_doc('Additional Salary') + additional_salary = frappe.new_doc("Additional Salary") additional_salary.employee = doc.employee additional_salary.currency = doc.currency additional_salary.amount = doc.paid_amount - doc.claimed_amount @@ -195,54 +242,81 @@ def create_return_through_additional_salary(doc): return additional_salary + @frappe.whitelist() -def make_return_entry(employee, company, employee_advance_name, return_amount, advance_account, currency, exchange_rate, mode_of_payment=None): - bank_cash_account = get_default_bank_cash_account(company, account_type='Cash', mode_of_payment = mode_of_payment) +def make_return_entry( + employee, + company, + employee_advance_name, + return_amount, + advance_account, + currency, + exchange_rate, + mode_of_payment=None, +): + bank_cash_account = get_default_bank_cash_account( + company, account_type="Cash", mode_of_payment=mode_of_payment + ) if not bank_cash_account: frappe.throw(_("Please set a Default Cash Account in Company defaults")) - advance_account_currency = frappe.db.get_value('Account', advance_account, 'account_currency') + advance_account_currency = frappe.db.get_value("Account", advance_account, "account_currency") - je = frappe.new_doc('Journal Entry') + je = frappe.new_doc("Journal Entry") je.posting_date = nowdate() je.voucher_type = get_voucher_type(mode_of_payment) je.company = company - je.remark = 'Return against Employee Advance: ' + employee_advance_name + je.remark = "Return against Employee Advance: " + employee_advance_name je.multi_currency = 1 if advance_account_currency != bank_cash_account.account_currency else 0 - advance_account_amount = flt(return_amount) if advance_account_currency==currency \ + advance_account_amount = ( + flt(return_amount) + if advance_account_currency == currency else flt(return_amount) * flt(exchange_rate) + ) - je.append('accounts', { - 'account': advance_account, - 'credit_in_account_currency': advance_account_amount, - 'account_currency': advance_account_currency, - 'exchange_rate': flt(exchange_rate) if advance_account_currency == currency else 1, - 'reference_type': 'Employee Advance', - 'reference_name': employee_advance_name, - 'party_type': 'Employee', - 'party': employee, - 'is_advance': 'Yes' - }) + je.append( + "accounts", + { + "account": advance_account, + "credit_in_account_currency": advance_account_amount, + "account_currency": advance_account_currency, + "exchange_rate": flt(exchange_rate) if advance_account_currency == currency else 1, + "reference_type": "Employee Advance", + "reference_name": employee_advance_name, + "party_type": "Employee", + "party": employee, + "is_advance": "Yes", + "cost_center": erpnext.get_default_cost_center(company), + }, + ) - bank_amount = flt(return_amount) if bank_cash_account.account_currency==currency \ + bank_amount = ( + flt(return_amount) + if bank_cash_account.account_currency == currency else flt(return_amount) * flt(exchange_rate) + ) - je.append("accounts", { - "account": bank_cash_account.account, - "debit_in_account_currency": bank_amount, - "account_currency": bank_cash_account.account_currency, - "account_type": bank_cash_account.account_type, - "exchange_rate": flt(exchange_rate) if bank_cash_account.account_currency == currency else 1 - }) + je.append( + "accounts", + { + "account": bank_cash_account.account, + "debit_in_account_currency": bank_amount, + "account_currency": bank_cash_account.account_currency, + "account_type": bank_cash_account.account_type, + "exchange_rate": flt(exchange_rate) if bank_cash_account.account_currency == currency else 1, + "cost_center": erpnext.get_default_cost_center(company), + }, + ) return je.as_dict() + def get_voucher_type(mode_of_payment=None): voucher_type = "Cash Entry" if mode_of_payment: - mode_of_payment_type = frappe.get_cached_value('Mode of Payment', mode_of_payment, 'type') + mode_of_payment_type = frappe.get_cached_value("Mode of Payment", mode_of_payment, "type") if mode_of_payment_type == "Bank": voucher_type = "Bank Entry" diff --git a/erpnext/hr/doctype/employee_advance/employee_advance_dashboard.py b/erpnext/hr/doctype/employee_advance/employee_advance_dashboard.py index 089bd2c1b5c..73fac5131ea 100644 --- a/erpnext/hr/doctype/employee_advance/employee_advance_dashboard.py +++ b/erpnext/hr/doctype/employee_advance/employee_advance_dashboard.py @@ -1,18 +1,9 @@ - - def get_data(): return { - 'fieldname': 'employee_advance', - 'non_standard_fieldnames': { - 'Payment Entry': 'reference_name', - 'Journal Entry': 'reference_name' + "fieldname": "employee_advance", + "non_standard_fieldnames": { + "Payment Entry": "reference_name", + "Journal Entry": "reference_name", }, - 'transactions': [ - { - 'items': ['Expense Claim'] - }, - { - 'items': ['Payment Entry', 'Journal Entry'] - } - ] + "transactions": [{"items": ["Expense Claim"]}, {"items": ["Payment Entry", "Journal Entry"]}], } diff --git a/erpnext/hr/doctype/employee_advance/employee_advance_list.js b/erpnext/hr/doctype/employee_advance/employee_advance_list.js new file mode 100644 index 00000000000..433669a71f3 --- /dev/null +++ b/erpnext/hr/doctype/employee_advance/employee_advance_list.js @@ -0,0 +1,15 @@ +frappe.listview_settings["Employee Advance"] = { + get_indicator: function(doc) { + let status_color = { + "Draft": "red", + "Submitted": "blue", + "Cancelled": "red", + "Paid": "green", + "Unpaid": "orange", + "Claimed": "blue", + "Returned": "gray", + "Partly Claimed and Returned": "yellow" + }; + return [__(doc.status), status_color[doc.status], "status,=,"+doc.status]; + } +}; \ No newline at end of file diff --git a/erpnext/hr/doctype/employee_advance/test_employee_advance.py b/erpnext/hr/doctype/employee_advance/test_employee_advance.py index 5f2e720eb46..44d68c94833 100644 --- a/erpnext/hr/doctype/employee_advance/test_employee_advance.py +++ b/erpnext/hr/doctype/employee_advance/test_employee_advance.py @@ -4,7 +4,7 @@ import unittest import frappe -from frappe.utils import nowdate +from frappe.utils import flt, nowdate import erpnext from erpnext.hr.doctype.employee.test_employee import make_employee @@ -12,12 +12,21 @@ from erpnext.hr.doctype.employee_advance.employee_advance import ( EmployeeAdvanceOverPayment, create_return_through_additional_salary, make_bank_entry, + make_return_entry, +) +from erpnext.hr.doctype.expense_claim.expense_claim import get_advances +from erpnext.hr.doctype.expense_claim.test_expense_claim import ( + get_payable_account, + make_expense_claim, ) from erpnext.payroll.doctype.salary_component.test_salary_component import create_salary_component from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure class TestEmployeeAdvance(unittest.TestCase): + def setUp(self): + frappe.db.delete("Employee Advance") + def test_paid_amount_and_status(self): employee_name = make_employee("_T@employe.advance") advance = make_employee_advance(employee_name) @@ -52,13 +61,114 @@ class TestEmployeeAdvance(unittest.TestCase): self.assertEqual(advance.paid_amount, 0) self.assertEqual(advance.status, "Unpaid") + advance.cancel() + advance.reload() + self.assertEqual(advance.status, "Cancelled") + + def test_claimed_status(self): + # CLAIMED Status check, full amount claimed + payable_account = get_payable_account("_Test Company") + claim = make_expense_claim( + payable_account, 1000, 1000, "_Test Company", "Travel Expenses - _TC", do_not_submit=True + ) + + advance = make_employee_advance(claim.employee) + pe = make_payment_entry(advance) + pe.submit() + + claim = get_advances_for_claim(claim, advance.name) + claim.save() + claim.submit() + + advance.reload() + self.assertEqual(advance.claimed_amount, 1000) + self.assertEqual(advance.status, "Claimed") + + # advance should not be shown in claims + advances = get_advances(claim.employee) + advances = [entry.name for entry in advances] + self.assertTrue(advance.name not in advances) + + # cancel claim; status should be Paid + claim.cancel() + advance.reload() + self.assertEqual(advance.claimed_amount, 0) + self.assertEqual(advance.status, "Paid") + + def test_partly_claimed_and_returned_status(self): + payable_account = get_payable_account("_Test Company") + claim = make_expense_claim( + payable_account, 1000, 1000, "_Test Company", "Travel Expenses - _TC", do_not_submit=True + ) + + advance = make_employee_advance(claim.employee) + pe = make_payment_entry(advance) + pe.submit() + + # PARTLY CLAIMED AND RETURNED status check + # 500 Claimed, 500 Returned + claim = make_expense_claim( + payable_account, 500, 500, "_Test Company", "Travel Expenses - _TC", do_not_submit=True + ) + + advance = make_employee_advance(claim.employee) + pe = make_payment_entry(advance) + pe.submit() + + claim = get_advances_for_claim(claim, advance.name, amount=500) + claim.save() + claim.submit() + + advance.reload() + self.assertEqual(advance.claimed_amount, 500) + self.assertEqual(advance.status, "Paid") + + entry = make_return_entry( + employee=advance.employee, + company=advance.company, + employee_advance_name=advance.name, + return_amount=flt(advance.paid_amount - advance.claimed_amount), + advance_account=advance.advance_account, + mode_of_payment=advance.mode_of_payment, + currency=advance.currency, + exchange_rate=advance.exchange_rate, + ) + + entry = frappe.get_doc(entry) + entry.insert() + entry.submit() + + advance.reload() + self.assertEqual(advance.return_amount, 500) + self.assertEqual(advance.status, "Partly Claimed and Returned") + + # advance should not be shown in claims + advances = get_advances(claim.employee) + advances = [entry.name for entry in advances] + self.assertTrue(advance.name not in advances) + + # Cancel return entry; status should change to PAID + entry.cancel() + advance.reload() + self.assertEqual(advance.return_amount, 0) + self.assertEqual(advance.status, "Paid") + + # advance should be shown in claims + advances = get_advances(claim.employee) + advances = [entry.name for entry in advances] + self.assertTrue(advance.name in advances) + def test_repay_unclaimed_amount_from_salary(self): employee_name = make_employee("_T@employe.advance") advance = make_employee_advance(employee_name, {"repay_unclaimed_amount_from_salary": 1}) + pe = make_payment_entry(advance) + pe.submit() args = {"type": "Deduction"} create_salary_component("Advance Salary - Deduction", **args) - make_salary_structure("Test Additional Salary for Advance Return", "Monthly", employee=employee_name) + make_salary_structure( + "Test Additional Salary for Advance Return", "Monthly", employee=employee_name + ) # additional salary for 700 first advance.reload() @@ -82,11 +192,13 @@ class TestEmployeeAdvance(unittest.TestCase): advance.reload() self.assertEqual(advance.return_amount, 1000) + self.assertEqual(advance.status, "Returned") # update advance return amount on additional salary cancellation additional_salary.cancel() advance.reload() self.assertEqual(advance.return_amount, 700) + self.assertEqual(advance.status, "Paid") def tearDown(self): frappe.db.rollback() @@ -100,10 +212,11 @@ def make_payment_entry(advance): return journal_entry + def make_employee_advance(employee_name, args=None): doc = frappe.new_doc("Employee Advance") doc.employee = employee_name - doc.company = "_Test company" + doc.company = "_Test company" doc.purpose = "For site visit" doc.currency = erpnext.get_company_currency("_Test company") doc.exchange_rate = 1 @@ -118,3 +231,27 @@ def make_employee_advance(employee_name, args=None): doc.submit() return doc + + +def get_advances_for_claim(claim, advance_name, amount=None): + advances = get_advances(claim.employee, advance_name) + + for entry in advances: + if amount: + allocated_amount = amount + else: + allocated_amount = flt(entry.paid_amount) - flt(entry.claimed_amount) + + claim.append( + "advances", + { + "employee_advance": entry.name, + "posting_date": entry.posting_date, + "advance_account": entry.advance_account, + "advance_paid": entry.paid_amount, + "unclaimed_amount": allocated_amount, + "allocated_amount": allocated_amount, + }, + ) + + return claim diff --git a/erpnext/hr/doctype/employee_attendance_tool/employee_attendance_tool.py b/erpnext/hr/doctype/employee_attendance_tool/employee_attendance_tool.py index af2ca50b78a..43665cc8b22 100644 --- a/erpnext/hr/doctype/employee_attendance_tool/employee_attendance_tool.py +++ b/erpnext/hr/doctype/employee_attendance_tool/employee_attendance_tool.py @@ -14,32 +14,31 @@ class EmployeeAttendanceTool(Document): @frappe.whitelist() -def get_employees(date, department = None, branch = None, company = None): +def get_employees(date, department=None, branch=None, company=None): attendance_not_marked = [] attendance_marked = [] filters = {"status": "Active", "date_of_joining": ["<=", date]} - for field, value in {'department': department, - 'branch': branch, 'company': company}.items(): + for field, value in {"department": department, "branch": branch, "company": company}.items(): if value: filters[field] = value - employee_list = frappe.get_list("Employee", fields=["employee", "employee_name"], filters=filters, order_by="employee_name") + employee_list = frappe.get_list( + "Employee", fields=["employee", "employee_name"], filters=filters, order_by="employee_name" + ) marked_employee = {} - for emp in frappe.get_list("Attendance", fields=["employee", "status"], - filters={"attendance_date": date}): - marked_employee[emp['employee']] = emp['status'] + for emp in frappe.get_list( + "Attendance", fields=["employee", "status"], filters={"attendance_date": date} + ): + marked_employee[emp["employee"]] = emp["status"] for employee in employee_list: - employee['status'] = marked_employee.get(employee['employee']) - if employee['employee'] not in marked_employee: + employee["status"] = marked_employee.get(employee["employee"]) + if employee["employee"] not in marked_employee: attendance_not_marked.append(employee) else: attendance_marked.append(employee) - return { - "marked": attendance_marked, - "unmarked": attendance_not_marked - } + return {"marked": attendance_marked, "unmarked": attendance_not_marked} @frappe.whitelist() @@ -53,16 +52,18 @@ def mark_employee_attendance(employee_list, status, date, leave_type=None, compa else: leave_type = None - company = frappe.db.get_value("Employee", employee['employee'], "Company", cache=True) + company = frappe.db.get_value("Employee", employee["employee"], "Company", cache=True) - attendance=frappe.get_doc(dict( - doctype='Attendance', - employee=employee.get('employee'), - employee_name=employee.get('employee_name'), - attendance_date=getdate(date), - status=status, - leave_type=leave_type, - company=company - )) + attendance = frappe.get_doc( + dict( + doctype="Attendance", + employee=employee.get("employee"), + employee_name=employee.get("employee_name"), + attendance_date=getdate(date), + status=status, + leave_type=leave_type, + company=company, + ) + ) attendance.insert() - attendance.submit() \ No newline at end of file + attendance.submit() diff --git a/erpnext/hr/doctype/employee_checkin/employee_checkin.json b/erpnext/hr/doctype/employee_checkin/employee_checkin.json index d34316dc0f3..19ef1b3c0ea 100644 --- a/erpnext/hr/doctype/employee_checkin/employee_checkin.json +++ b/erpnext/hr/doctype/employee_checkin/employee_checkin.json @@ -26,7 +26,8 @@ "fieldtype": "Link", "label": "Employee", "options": "Employee", - "reqd": 1 + "reqd": 1, + "search_index": 1 }, { "fetch_from": "employee.employee_name", @@ -48,7 +49,8 @@ "fieldtype": "Link", "label": "Shift", "options": "Shift Type", - "read_only": 1 + "read_only": 1, + "search_index": 1 }, { "fieldname": "column_break_4", @@ -107,7 +109,7 @@ } ], "links": [], - "modified": "2020-07-08 11:02:32.660986", + "modified": "2022-07-19 15:38:41.767539", "modified_by": "Administrator", "module": "HR", "name": "Employee Checkin", diff --git a/erpnext/hr/doctype/employee_checkin/employee_checkin.py b/erpnext/hr/doctype/employee_checkin/employee_checkin.py index c1d4ac7fded..8b0a60e20e9 100644 --- a/erpnext/hr/doctype/employee_checkin/employee_checkin.py +++ b/erpnext/hr/doctype/employee_checkin/employee_checkin.py @@ -5,7 +5,7 @@ import frappe from frappe import _ from frappe.model.document import Document -from frappe.utils import cint, get_datetime +from frappe.utils import cint, get_datetime, get_link_to_form from erpnext.hr.doctype.shift_assignment.shift_assignment import ( get_actual_start_end_datetime_of_shift, @@ -20,20 +20,31 @@ class EmployeeCheckin(Document): self.fetch_shift() def validate_duplicate_log(self): - doc = frappe.db.exists('Employee Checkin', { - 'employee': self.employee, - 'time': self.time, - 'name': ['!=', self.name]}) + doc = frappe.db.exists( + "Employee Checkin", {"employee": self.employee, "time": self.time, "name": ["!=", self.name]} + ) if doc: - doc_link = frappe.get_desk_link('Employee Checkin', doc) - frappe.throw(_('This employee already has a log with the same timestamp.{0}') - .format("
" + doc_link)) + doc_link = frappe.get_desk_link("Employee Checkin", doc) + frappe.throw( + _("This employee already has a log with the same timestamp.{0}").format("
" + doc_link) + ) def fetch_shift(self): - shift_actual_timings = get_actual_start_end_datetime_of_shift(self.employee, get_datetime(self.time), True) + shift_actual_timings = get_actual_start_end_datetime_of_shift( + self.employee, get_datetime(self.time), True + ) if shift_actual_timings[0] and shift_actual_timings[1]: - if shift_actual_timings[2].shift_type.determine_check_in_and_check_out == 'Strictly based on Log Type in Employee Checkin' and not self.log_type and not self.skip_auto_attendance: - frappe.throw(_('Log Type is required for check-ins falling in the shift: {0}.').format(shift_actual_timings[2].shift_type.name)) + if ( + shift_actual_timings[2].shift_type.determine_check_in_and_check_out + == "Strictly based on Log Type in Employee Checkin" + and not self.log_type + and not self.skip_auto_attendance + ): + frappe.throw( + _("Log Type is required for check-ins falling in the shift: {0}.").format( + shift_actual_timings[2].shift_type.name + ) + ) if not self.attendance: self.shift = shift_actual_timings[2].shift_type.name self.shift_actual_start = shift_actual_timings[0] @@ -43,8 +54,16 @@ class EmployeeCheckin(Document): else: self.shift = None + @frappe.whitelist() -def add_log_based_on_employee_field(employee_field_value, timestamp, device_id=None, log_type=None, skip_auto_attendance=0, employee_fieldname='attendance_device_id'): +def add_log_based_on_employee_field( + employee_field_value, + timestamp, + device_id=None, + log_type=None, + skip_auto_attendance=0, + employee_fieldname="attendance_device_id", +): """Finds the relevant Employee using the employee field value and creates a Employee Checkin. :param employee_field_value: The value to look for in employee field. @@ -58,11 +77,20 @@ def add_log_based_on_employee_field(employee_field_value, timestamp, device_id=N if not employee_field_value or not timestamp: frappe.throw(_("'employee_field_value' and 'timestamp' are required.")) - employee = frappe.db.get_values("Employee", {employee_fieldname: employee_field_value}, ["name", "employee_name", employee_fieldname], as_dict=True) + employee = frappe.db.get_values( + "Employee", + {employee_fieldname: employee_field_value}, + ["name", "employee_name", employee_fieldname], + as_dict=True, + ) if employee: employee = employee[0] else: - frappe.throw(_("No Employee found for the given employee field value. '{}': {}").format(employee_fieldname,employee_field_value)) + frappe.throw( + _("No Employee found for the given employee field value. '{}': {}").format( + employee_fieldname, employee_field_value + ) + ) doc = frappe.new_doc("Employee Checkin") doc.employee = employee.name @@ -70,13 +98,24 @@ def add_log_based_on_employee_field(employee_field_value, timestamp, device_id=N doc.time = timestamp doc.device_id = device_id doc.log_type = log_type - if cint(skip_auto_attendance) == 1: doc.skip_auto_attendance = '1' + if cint(skip_auto_attendance) == 1: + doc.skip_auto_attendance = "1" doc.insert() return doc -def mark_attendance_and_link_log(logs, attendance_status, attendance_date, working_hours=None, late_entry=False, early_exit=False, in_time=None, out_time=None, shift=None): +def mark_attendance_and_link_log( + logs, + attendance_status, + attendance_date, + working_hours=None, + late_entry=False, + early_exit=False, + in_time=None, + out_time=None, + shift=None, +): """Creates an attendance and links the attendance to the Employee Checkin. Note: If attendance is already present for the given date, the logs are marked as skipped and no exception is thrown. @@ -87,40 +126,54 @@ def mark_attendance_and_link_log(logs, attendance_status, attendance_date, worki """ log_names = [x.name for x in logs] employee = logs[0].employee - if attendance_status == 'Skip': - frappe.db.sql("""update `tabEmployee Checkin` - set skip_auto_attendance = %s - where name in %s""", ('1', log_names)) + if attendance_status == "Skip": + skip_attendance_in_checkins(log_names) return None - elif attendance_status in ('Present', 'Absent', 'Half Day'): - employee_doc = frappe.get_doc('Employee', employee) - if not frappe.db.exists('Attendance', {'employee':employee, 'attendance_date':attendance_date, 'docstatus':('!=', '2')}): + + elif attendance_status in ("Present", "Absent", "Half Day"): + company = frappe.get_cached_value("Employee", employee, "company") + duplicate = frappe.db.exists( + "Attendance", + {"employee": employee, "attendance_date": attendance_date, "docstatus": ("!=", "2")}, + ) + + if not duplicate: doc_dict = { - 'doctype': 'Attendance', - 'employee': employee, - 'attendance_date': attendance_date, - 'status': attendance_status, - 'working_hours': working_hours, - 'company': employee_doc.company, - 'shift': shift, - 'late_entry': late_entry, - 'early_exit': early_exit, - 'in_time': in_time, - 'out_time': out_time + "doctype": "Attendance", + "employee": employee, + "attendance_date": attendance_date, + "status": attendance_status, + "working_hours": working_hours, + "company": company, + "shift": shift, + "late_entry": late_entry, + "early_exit": early_exit, + "in_time": in_time, + "out_time": out_time, } attendance = frappe.get_doc(doc_dict).insert() attendance.submit() - frappe.db.sql("""update `tabEmployee Checkin` + + if attendance_status == "Absent": + attendance.add_comment( + text=_("Employee was marked Absent for not meeting the working hours threshold.") + ) + + frappe.db.sql( + """update `tabEmployee Checkin` set attendance = %s - where name in %s""", (attendance.name, log_names)) + where name in %s""", + (attendance.name, log_names), + ) return attendance else: - frappe.db.sql("""update `tabEmployee Checkin` - set skip_auto_attendance = %s - where name in %s""", ('1', log_names)) + skip_attendance_in_checkins(log_names) + if duplicate: + add_comment_in_checkins(log_names, duplicate) + return None else: - frappe.throw(_('{} is an invalid Attendance Status.').format(attendance_status)) + frappe.throw(_("{} is an invalid Attendance Status.").format(attendance_status)) def calculate_working_hours(logs, check_in_out_type, working_hours_calc_type): @@ -133,29 +186,35 @@ def calculate_working_hours(logs, check_in_out_type, working_hours_calc_type): """ total_hours = 0 in_time = out_time = None - if check_in_out_type == 'Alternating entries as IN and OUT during the same shift': + if check_in_out_type == "Alternating entries as IN and OUT during the same shift": in_time = logs[0].time if len(logs) >= 2: out_time = logs[-1].time - if working_hours_calc_type == 'First Check-in and Last Check-out': + if working_hours_calc_type == "First Check-in and Last Check-out": # assumption in this case: First log always taken as IN, Last log always taken as OUT total_hours = time_diff_in_hours(in_time, logs[-1].time) - elif working_hours_calc_type == 'Every Valid Check-in and Check-out': + elif working_hours_calc_type == "Every Valid Check-in and Check-out": logs = logs[:] while len(logs) >= 2: total_hours += time_diff_in_hours(logs[0].time, logs[1].time) del logs[:2] - elif check_in_out_type == 'Strictly based on Log Type in Employee Checkin': - if working_hours_calc_type == 'First Check-in and Last Check-out': - first_in_log_index = find_index_in_dict(logs, 'log_type', 'IN') - first_in_log = logs[first_in_log_index] if first_in_log_index or first_in_log_index == 0 else None - last_out_log_index = find_index_in_dict(reversed(logs), 'log_type', 'OUT') - last_out_log = logs[len(logs)-1-last_out_log_index] if last_out_log_index or last_out_log_index == 0 else None + elif check_in_out_type == "Strictly based on Log Type in Employee Checkin": + if working_hours_calc_type == "First Check-in and Last Check-out": + first_in_log_index = find_index_in_dict(logs, "log_type", "IN") + first_in_log = ( + logs[first_in_log_index] if first_in_log_index or first_in_log_index == 0 else None + ) + last_out_log_index = find_index_in_dict(reversed(logs), "log_type", "OUT") + last_out_log = ( + logs[len(logs) - 1 - last_out_log_index] + if last_out_log_index or last_out_log_index == 0 + else None + ) if first_in_log and last_out_log: in_time, out_time = first_in_log.time, last_out_log.time total_hours = time_diff_in_hours(in_time, out_time) - elif working_hours_calc_type == 'Every Valid Check-in and Check-out': + elif working_hours_calc_type == "Every Valid Check-in and Check-out": in_log = out_log = None for log in logs: if in_log and out_log: @@ -165,16 +224,48 @@ def calculate_working_hours(logs, check_in_out_type, working_hours_calc_type): total_hours += time_diff_in_hours(in_log.time, out_log.time) in_log = out_log = None if not in_log: - in_log = log if log.log_type == 'IN' else None + in_log = log if log.log_type == "IN" else None + if in_log and not in_time: + in_time = in_log.time elif not out_log: - out_log = log if log.log_type == 'OUT' else None + out_log = log if log.log_type == "OUT" else None + if in_log and out_log: out_time = out_log.time total_hours += time_diff_in_hours(in_log.time, out_log.time) + return total_hours, in_time, out_time + def time_diff_in_hours(start, end): - return round((end-start).total_seconds() / 3600, 1) + return round((end - start).total_seconds() / 3600, 1) + def find_index_in_dict(dict_list, key, value): return next((index for (index, d) in enumerate(dict_list) if d[key] == value), None) + + +def add_comment_in_checkins(log_names, duplicate): + text = _("Auto Attendance skipped due to duplicate attendance record: {}").format( + get_link_to_form("Attendance", duplicate) + ) + + for name in log_names: + frappe.get_doc( + { + "doctype": "Comment", + "comment_type": "Comment", + "reference_doctype": "Employee Checkin", + "reference_name": name, + "content": text, + } + ).insert(ignore_permissions=True) + + +def skip_attendance_in_checkins(log_names): + EmployeeCheckin = frappe.qb.DocType("Employee Checkin") + ( + frappe.qb.update(EmployeeCheckin) + .set("skip_auto_attendance", 1) + .where(EmployeeCheckin.name.isin(log_names)) + ).run() diff --git a/erpnext/hr/doctype/employee_checkin/test_employee_checkin.py b/erpnext/hr/doctype/employee_checkin/test_employee_checkin.py index 254bf9e2569..4e65098dc53 100644 --- a/erpnext/hr/doctype/employee_checkin/test_employee_checkin.py +++ b/erpnext/hr/doctype/employee_checkin/test_employee_checkin.py @@ -19,85 +19,124 @@ class TestEmployeeCheckin(unittest.TestCase): def test_add_log_based_on_employee_field(self): employee = make_employee("test_add_log_based_on_employee_field@example.com") employee = frappe.get_doc("Employee", employee) - employee.attendance_device_id = '3344' + employee.attendance_device_id = "3344" employee.save() time_now = now_datetime().__str__()[:-7] - employee_checkin = add_log_based_on_employee_field('3344', time_now, 'mumbai_first_floor', 'IN') + employee_checkin = add_log_based_on_employee_field("3344", time_now, "mumbai_first_floor", "IN") self.assertEqual(employee_checkin.employee, employee.name) self.assertEqual(employee_checkin.time, time_now) - self.assertEqual(employee_checkin.device_id, 'mumbai_first_floor') - self.assertEqual(employee_checkin.log_type, 'IN') + self.assertEqual(employee_checkin.device_id, "mumbai_first_floor") + self.assertEqual(employee_checkin.log_type, "IN") def test_mark_attendance_and_link_log(self): employee = make_employee("test_mark_attendance_and_link_log@example.com") logs = make_n_checkins(employee, 3) - mark_attendance_and_link_log(logs, 'Skip', nowdate()) + mark_attendance_and_link_log(logs, "Skip", nowdate()) log_names = [log.name for log in logs] - logs_count = frappe.db.count('Employee Checkin', {'name':['in', log_names], 'skip_auto_attendance':1}) + logs_count = frappe.db.count( + "Employee Checkin", {"name": ["in", log_names], "skip_auto_attendance": 1} + ) self.assertEqual(logs_count, 3) logs = make_n_checkins(employee, 4, 2) now_date = nowdate() - frappe.db.delete('Attendance', {'employee':employee}) - attendance = mark_attendance_and_link_log(logs, 'Present', now_date, 8.2) + frappe.db.delete("Attendance", {"employee": employee}) + attendance = mark_attendance_and_link_log(logs, "Present", now_date, 8.2) log_names = [log.name for log in logs] - logs_count = frappe.db.count('Employee Checkin', {'name':['in', log_names], 'attendance':attendance.name}) + logs_count = frappe.db.count( + "Employee Checkin", {"name": ["in", log_names], "attendance": attendance.name} + ) self.assertEqual(logs_count, 4) - attendance_count = frappe.db.count('Attendance', {'status':'Present', 'working_hours':8.2, - 'employee':employee, 'attendance_date':now_date}) + attendance_count = frappe.db.count( + "Attendance", + {"status": "Present", "working_hours": 8.2, "employee": employee, "attendance_date": now_date}, + ) self.assertEqual(attendance_count, 1) + def test_unlink_attendance_on_cancellation(self): + employee = make_employee("test_mark_attendance_and_link_log@example.com") + logs = make_n_checkins(employee, 3) + + frappe.db.delete("Attendance", {"employee": employee}) + attendance = mark_attendance_and_link_log(logs, "Present", nowdate(), 8.2) + attendance.cancel() + + linked_logs = frappe.db.get_all("Employee Checkin", {"attendance": attendance.name}) + self.assertEquals(len(linked_logs), 0) + def test_calculate_working_hours(self): - check_in_out_type = ['Alternating entries as IN and OUT during the same shift', - 'Strictly based on Log Type in Employee Checkin'] - working_hours_calc_type = ['First Check-in and Last Check-out', - 'Every Valid Check-in and Check-out'] + check_in_out_type = [ + "Alternating entries as IN and OUT during the same shift", + "Strictly based on Log Type in Employee Checkin", + ] + working_hours_calc_type = [ + "First Check-in and Last Check-out", + "Every Valid Check-in and Check-out", + ] logs_type_1 = [ - {'time':now_datetime()-timedelta(minutes=390)}, - {'time':now_datetime()-timedelta(minutes=300)}, - {'time':now_datetime()-timedelta(minutes=270)}, - {'time':now_datetime()-timedelta(minutes=90)}, - {'time':now_datetime()-timedelta(minutes=0)} - ] + {"time": now_datetime() - timedelta(minutes=390)}, + {"time": now_datetime() - timedelta(minutes=300)}, + {"time": now_datetime() - timedelta(minutes=270)}, + {"time": now_datetime() - timedelta(minutes=90)}, + {"time": now_datetime() - timedelta(minutes=0)}, + ] logs_type_2 = [ - {'time':now_datetime()-timedelta(minutes=390),'log_type':'OUT'}, - {'time':now_datetime()-timedelta(minutes=360),'log_type':'IN'}, - {'time':now_datetime()-timedelta(minutes=300),'log_type':'OUT'}, - {'time':now_datetime()-timedelta(minutes=290),'log_type':'IN'}, - {'time':now_datetime()-timedelta(minutes=260),'log_type':'OUT'}, - {'time':now_datetime()-timedelta(minutes=240),'log_type':'IN'}, - {'time':now_datetime()-timedelta(minutes=150),'log_type':'IN'}, - {'time':now_datetime()-timedelta(minutes=60),'log_type':'OUT'} - ] + {"time": now_datetime() - timedelta(minutes=390), "log_type": "OUT"}, + {"time": now_datetime() - timedelta(minutes=360), "log_type": "IN"}, + {"time": now_datetime() - timedelta(minutes=300), "log_type": "OUT"}, + {"time": now_datetime() - timedelta(minutes=290), "log_type": "IN"}, + {"time": now_datetime() - timedelta(minutes=260), "log_type": "OUT"}, + {"time": now_datetime() - timedelta(minutes=240), "log_type": "IN"}, + {"time": now_datetime() - timedelta(minutes=150), "log_type": "IN"}, + {"time": now_datetime() - timedelta(minutes=60), "log_type": "OUT"}, + ] logs_type_1 = [frappe._dict(x) for x in logs_type_1] logs_type_2 = [frappe._dict(x) for x in logs_type_2] - working_hours = calculate_working_hours(logs_type_1,check_in_out_type[0],working_hours_calc_type[0]) + working_hours = calculate_working_hours( + logs_type_1, check_in_out_type[0], working_hours_calc_type[0] + ) self.assertEqual(working_hours, (6.5, logs_type_1[0].time, logs_type_1[-1].time)) - working_hours = calculate_working_hours(logs_type_1,check_in_out_type[0],working_hours_calc_type[1]) + working_hours = calculate_working_hours( + logs_type_1, check_in_out_type[0], working_hours_calc_type[1] + ) self.assertEqual(working_hours, (4.5, logs_type_1[0].time, logs_type_1[-1].time)) - working_hours = calculate_working_hours(logs_type_2,check_in_out_type[1],working_hours_calc_type[0]) + working_hours = calculate_working_hours( + logs_type_2, check_in_out_type[1], working_hours_calc_type[0] + ) self.assertEqual(working_hours, (5, logs_type_2[1].time, logs_type_2[-1].time)) - working_hours = calculate_working_hours(logs_type_2,check_in_out_type[1],working_hours_calc_type[1]) + working_hours = calculate_working_hours( + logs_type_2, check_in_out_type[1], working_hours_calc_type[1] + ) self.assertEqual(working_hours, (4.5, logs_type_2[1].time, logs_type_2[-1].time)) + working_hours = calculate_working_hours( + [logs_type_2[1], logs_type_2[-1]], check_in_out_type[1], working_hours_calc_type[1] + ) + self.assertEqual(working_hours, (5.0, logs_type_2[1].time, logs_type_2[-1].time)) + + def make_n_checkins(employee, n, hours_to_reverse=1): - logs = [make_checkin(employee, now_datetime() - timedelta(hours=hours_to_reverse, minutes=n+1))] - for i in range(n-1): - logs.append(make_checkin(employee, now_datetime() - timedelta(hours=hours_to_reverse, minutes=n-i))) + logs = [make_checkin(employee, now_datetime() - timedelta(hours=hours_to_reverse, minutes=n + 1))] + for i in range(n - 1): + logs.append( + make_checkin(employee, now_datetime() - timedelta(hours=hours_to_reverse, minutes=n - i)) + ) return logs def make_checkin(employee, time=now_datetime()): - log = frappe.get_doc({ - "doctype": "Employee Checkin", - "employee" : employee, - "time" : time, - "device_id" : "device1", - "log_type" : "IN" - }).insert() + log = frappe.get_doc( + { + "doctype": "Employee Checkin", + "employee": employee, + "time": time, + "device_id": "device1", + "log_type": "IN", + } + ).insert() return log diff --git a/erpnext/hr/doctype/employee_grade/employee_grade_dashboard.py b/erpnext/hr/doctype/employee_grade/employee_grade_dashboard.py index 1dd6ad3b15a..efc68ce87a3 100644 --- a/erpnext/hr/doctype/employee_grade/employee_grade_dashboard.py +++ b/erpnext/hr/doctype/employee_grade/employee_grade_dashboard.py @@ -1,13 +1,9 @@ - - def get_data(): return { - 'transactions': [ + "transactions": [ { - 'items': ['Employee', 'Leave Period'], + "items": ["Employee", "Leave Period"], }, - { - 'items': ['Employee Onboarding Template', 'Employee Separation Template'] - } + {"items": ["Employee Onboarding Template", "Employee Separation Template"]}, ] } diff --git a/erpnext/hr/doctype/employee_grievance/employee_grievance.py b/erpnext/hr/doctype/employee_grievance/employee_grievance.py index fd9a33b3771..45de79f4f5e 100644 --- a/erpnext/hr/doctype/employee_grievance/employee_grievance.py +++ b/erpnext/hr/doctype/employee_grievance/employee_grievance.py @@ -9,7 +9,8 @@ from frappe.model.document import Document class EmployeeGrievance(Document): def on_submit(self): if self.status not in ["Invalid", "Resolved"]: - frappe.throw(_("Only Employee Grievance with status {0} or {1} can be submitted").format( - bold("Invalid"), - bold("Resolved")) + frappe.throw( + _("Only Employee Grievance with status {0} or {1} can be submitted").format( + bold("Invalid"), bold("Resolved") + ) ) diff --git a/erpnext/hr/doctype/employee_grievance/test_employee_grievance.py b/erpnext/hr/doctype/employee_grievance/test_employee_grievance.py index e2d0002aa62..910d8828603 100644 --- a/erpnext/hr/doctype/employee_grievance/test_employee_grievance.py +++ b/erpnext/hr/doctype/employee_grievance/test_employee_grievance.py @@ -13,6 +13,7 @@ class TestEmployeeGrievance(unittest.TestCase): def test_create_employee_grievance(self): create_employee_grievance() + def create_employee_grievance(): grievance_type = create_grievance_type() emp_1 = make_employee("test_emp_grievance_@example.com", company="_Test Company") @@ -27,10 +28,10 @@ def create_employee_grievance(): grievance.grievance_against = emp_2 grievance.description = "test descrip" - #set cause + # set cause grievance.cause_of_grievance = "test cause" - #resolution details + # resolution details grievance.resolution_date = today() grievance.resolution_detail = "test resolution detail" grievance.resolved_by = "test_emp_grievance_@example.com" diff --git a/erpnext/hr/doctype/employee_group/test_employee_group.py b/erpnext/hr/doctype/employee_group/test_employee_group.py index a87f4007bd8..3922f54f331 100644 --- a/erpnext/hr/doctype/employee_group/test_employee_group.py +++ b/erpnext/hr/doctype/employee_group/test_employee_group.py @@ -11,17 +11,16 @@ from erpnext.hr.doctype.employee.test_employee import make_employee class TestEmployeeGroup(unittest.TestCase): pass + def make_employee_group(): employee = make_employee("testemployee@example.com") - employee_group = frappe.get_doc({ - "doctype": "Employee Group", - "employee_group_name": "_Test Employee Group", - "employee_list": [ - { - "employee": employee - } - ] - }) + employee_group = frappe.get_doc( + { + "doctype": "Employee Group", + "employee_group_name": "_Test Employee Group", + "employee_list": [{"employee": employee}], + } + ) employee_group_exist = frappe.db.exists("Employee Group", "_Test Employee Group") if not employee_group_exist: employee_group.insert() @@ -29,6 +28,7 @@ def make_employee_group(): else: return employee_group_exist + def get_employee_group(): employee_group = frappe.db.exists("Employee Group", "_Test Employee Group") return employee_group diff --git a/erpnext/hr/doctype/employee_group_table/employee_group_table.json b/erpnext/hr/doctype/employee_group_table/employee_group_table.json index 4e0045cdeb8..54eb8c6da91 100644 --- a/erpnext/hr/doctype/employee_group_table/employee_group_table.json +++ b/erpnext/hr/doctype/employee_group_table/employee_group_table.json @@ -27,12 +27,13 @@ "fetch_from": "employee.user_id", "fieldname": "user_id", "fieldtype": "Data", + "in_list_view": 1, "label": "ERPNext User ID", "read_only": 1 } ], "istable": 1, - "modified": "2019-06-06 10:41:20.313756", + "modified": "2022-02-13 19:44:21.302938", "modified_by": "Administrator", "module": "HR", "name": "Employee Group Table", @@ -42,4 +43,4 @@ "sort_field": "modified", "sort_order": "DESC", "track_changes": 1 -} \ No newline at end of file +} diff --git a/erpnext/hr/doctype/employee_onboarding/employee_onboarding.py b/erpnext/hr/doctype/employee_onboarding/employee_onboarding.py index 01a9fe29a98..14b75bef569 100644 --- a/erpnext/hr/doctype/employee_onboarding/employee_onboarding.py +++ b/erpnext/hr/doctype/employee_onboarding/employee_onboarding.py @@ -9,7 +9,9 @@ from frappe.model.mapper import get_mapped_doc from erpnext.hr.utils import EmployeeBoardingController -class IncompleteTaskError(frappe.ValidationError): pass +class IncompleteTaskError(frappe.ValidationError): + pass + class EmployeeOnboarding(EmployeeBoardingController): def validate(self): @@ -17,9 +19,13 @@ class EmployeeOnboarding(EmployeeBoardingController): self.validate_duplicate_employee_onboarding() def validate_duplicate_employee_onboarding(self): - emp_onboarding = frappe.db.exists("Employee Onboarding",{"job_applicant": self.job_applicant}) + emp_onboarding = frappe.db.exists("Employee Onboarding", {"job_applicant": self.job_applicant}) if emp_onboarding and emp_onboarding != self.name: - frappe.throw(_("Employee Onboarding: {0} is already for Job Applicant: {1}").format(frappe.bold(emp_onboarding), frappe.bold(self.job_applicant))) + frappe.throw( + _("Employee Onboarding: {0} is already for Job Applicant: {1}").format( + frappe.bold(emp_onboarding), frappe.bold(self.job_applicant) + ) + ) def validate_employee_creation(self): if self.docstatus != 1: @@ -31,7 +37,9 @@ class EmployeeOnboarding(EmployeeBoardingController): else: task_status = frappe.db.get_value("Task", activity.task, "status") if task_status not in ["Completed", "Cancelled"]: - frappe.throw(_("All the mandatory Task for employee creation hasn't been done yet."), IncompleteTaskError) + frappe.throw( + _("All the mandatory Task for employee creation hasn't been done yet."), IncompleteTaskError + ) def on_submit(self): super(EmployeeOnboarding, self).on_submit() @@ -42,19 +50,29 @@ class EmployeeOnboarding(EmployeeBoardingController): def on_cancel(self): super(EmployeeOnboarding, self).on_cancel() + @frappe.whitelist() def make_employee(source_name, target_doc=None): doc = frappe.get_doc("Employee Onboarding", source_name) doc.validate_employee_creation() + def set_missing_values(source, target): target.personal_email = frappe.db.get_value("Job Applicant", source.job_applicant, "email_id") target.status = "Active" - doc = get_mapped_doc("Employee Onboarding", source_name, { + + doc = get_mapped_doc( + "Employee Onboarding", + source_name, + { "Employee Onboarding": { "doctype": "Employee", "field_map": { "first_name": "employee_name", "employee_grade": "grade", - }} - }, target_doc, set_missing_values) + }, + } + }, + target_doc, + set_missing_values, + ) return doc diff --git a/erpnext/hr/doctype/employee_onboarding/test_employee_onboarding.py b/erpnext/hr/doctype/employee_onboarding/test_employee_onboarding.py index df6e9bde006..21d00ce2de7 100644 --- a/erpnext/hr/doctype/employee_onboarding/test_employee_onboarding.py +++ b/erpnext/hr/doctype/employee_onboarding/test_employee_onboarding.py @@ -15,43 +15,42 @@ from erpnext.hr.doctype.job_offer.test_job_offer import create_job_offer class TestEmployeeOnboarding(unittest.TestCase): def test_employee_onboarding_incomplete_task(self): - if frappe.db.exists('Employee Onboarding', {'employee_name': 'Test Researcher'}): - frappe.delete_doc('Employee Onboarding', {'employee_name': 'Test Researcher'}) - _set_up() + if frappe.db.exists("Employee Onboarding", {"employee_name": "Test Researcher"}): + frappe.delete_doc("Employee Onboarding", {"employee_name": "Test Researcher"}) + frappe.db.sql("delete from `tabEmployee Onboarding`") + project = "Employee Onboarding : test@researcher.com" + frappe.db.sql("delete from tabProject where name=%s", project) + frappe.db.sql("delete from tabTask where project=%s", project) applicant = get_job_applicant() job_offer = create_job_offer(job_applicant=applicant.name) job_offer.submit() - onboarding = frappe.new_doc('Employee Onboarding') + onboarding = frappe.new_doc("Employee Onboarding") onboarding.job_applicant = applicant.name onboarding.job_offer = job_offer.name - onboarding.company = '_Test Company' - onboarding.designation = 'Researcher' - onboarding.append('activities', { - 'activity_name': 'Assign ID Card', - 'role': 'HR User', - 'required_for_employee_creation': 1 - }) - onboarding.append('activities', { - 'activity_name': 'Assign a laptop', - 'role': 'HR User' - }) - onboarding.status = 'Pending' + onboarding.company = "_Test Company" + onboarding.designation = "Researcher" + onboarding.append( + "activities", + {"activity_name": "Assign ID Card", "role": "HR User", "required_for_employee_creation": 1}, + ) + onboarding.append("activities", {"activity_name": "Assign a laptop", "role": "HR User"}) + onboarding.status = "Pending" onboarding.insert() onboarding.submit() project_name = frappe.db.get_value("Project", onboarding.project, "project_name") - self.assertEqual(project_name, 'Employee Onboarding : Test Researcher - test@researcher.com') + self.assertEqual(project_name, "Employee Onboarding : test@researcher.com") # don't allow making employee if onboarding is not complete self.assertRaises(IncompleteTaskError, make_employee, onboarding.name) # complete the task - project = frappe.get_doc('Project', onboarding.project) - for task in frappe.get_all('Task', dict(project=project.name)): - task = frappe.get_doc('Task', task.name) - task.status = 'Completed' + project = frappe.get_doc("Project", onboarding.project) + for task in frappe.get_all("Task", dict(project=project.name)): + task = frappe.get_doc("Task", task.name) + task.status = "Completed" task.save() # make employee @@ -59,23 +58,25 @@ class TestEmployeeOnboarding(unittest.TestCase): employee = make_employee(onboarding.name) employee.first_name = employee.employee_name employee.date_of_joining = nowdate() - employee.date_of_birth = '1990-05-08' - employee.gender = 'Female' + employee.date_of_birth = "1990-05-08" + employee.gender = "Female" employee.insert() - self.assertEqual(employee.employee_name, 'Test Researcher') + self.assertEqual(employee.employee_name, "Test Researcher") + def get_job_applicant(): - if frappe.db.exists('Job Applicant', 'Test Researcher - test@researcher.com'): - return frappe.get_doc('Job Applicant', 'Test Researcher - test@researcher.com') - applicant = frappe.new_doc('Job Applicant') - applicant.applicant_name = 'Test Researcher' - applicant.email_id = 'test@researcher.com' - applicant.designation = 'Researcher' - applicant.status = 'Open' - applicant.cover_letter = 'I am a great Researcher.' + if frappe.db.exists("Job Applicant", "test@researcher.com"): + return frappe.get_doc("Job Applicant", "test@researcher.com") + applicant = frappe.new_doc("Job Applicant") + applicant.applicant_name = "Test Researcher" + applicant.email_id = "test@researcher.com" + applicant.designation = "Researcher" + applicant.status = "Open" + applicant.cover_letter = "I am a great Researcher." applicant.insert() return applicant + def _set_up(): for doctype in ["Employee Onboarding"]: frappe.db.sql("delete from `tab{doctype}`".format(doctype=doctype)) diff --git a/erpnext/hr/doctype/employee_onboarding_template/employee_onboarding_template_dashboard.py b/erpnext/hr/doctype/employee_onboarding_template/employee_onboarding_template_dashboard.py index 48f2c1d2709..93237ee3797 100644 --- a/erpnext/hr/doctype/employee_onboarding_template/employee_onboarding_template_dashboard.py +++ b/erpnext/hr/doctype/employee_onboarding_template/employee_onboarding_template_dashboard.py @@ -1,11 +1,7 @@ - - def get_data(): - return { - 'fieldname': 'employee_onboarding_template', - 'transactions': [ - { - 'items': ['Employee Onboarding'] - }, - ], - } + return { + "fieldname": "employee_onboarding_template", + "transactions": [ + {"items": ["Employee Onboarding"]}, + ], + } diff --git a/erpnext/hr/doctype/employee_promotion/employee_promotion.py b/erpnext/hr/doctype/employee_promotion/employee_promotion.py index cf6156e3264..d77c1dddfd0 100644 --- a/erpnext/hr/doctype/employee_promotion/employee_promotion.py +++ b/erpnext/hr/doctype/employee_promotion/employee_promotion.py @@ -16,12 +16,16 @@ class EmployeePromotion(Document): def before_submit(self): if getdate(self.promotion_date) > getdate(): - frappe.throw(_("Employee Promotion cannot be submitted before Promotion Date"), - frappe.DocstatusTransitionError) + frappe.throw( + _("Employee Promotion cannot be submitted before Promotion Date"), + frappe.DocstatusTransitionError, + ) def on_submit(self): employee = frappe.get_doc("Employee", self.employee) - employee = update_employee_work_history(employee, self.promotion_details, date=self.promotion_date) + employee = update_employee_work_history( + employee, self.promotion_details, date=self.promotion_date + ) employee.save() def on_cancel(self): diff --git a/erpnext/hr/doctype/employee_promotion/test_employee_promotion.py b/erpnext/hr/doctype/employee_promotion/test_employee_promotion.py index fc9d195a3f3..06825ece910 100644 --- a/erpnext/hr/doctype/employee_promotion/test_employee_promotion.py +++ b/erpnext/hr/doctype/employee_promotion/test_employee_promotion.py @@ -15,18 +15,20 @@ class TestEmployeePromotion(unittest.TestCase): frappe.db.sql("""delete from `tabEmployee Promotion`""") def test_submit_before_promotion_date(self): - promotion_obj = frappe.get_doc({ - "doctype": "Employee Promotion", - "employee": self.employee, - "promotion_details" :[ - { - "property": "Designation", - "current": "Software Developer", - "new": "Project Manager", - "fieldname": "designation" - } - ] - }) + promotion_obj = frappe.get_doc( + { + "doctype": "Employee Promotion", + "employee": self.employee, + "promotion_details": [ + { + "property": "Designation", + "current": "Software Developer", + "new": "Project Manager", + "fieldname": "designation", + } + ], + } + ) promotion_obj.promotion_date = add_days(getdate(), 1) promotion_obj.save() self.assertRaises(frappe.DocstatusTransitionError, promotion_obj.submit) diff --git a/erpnext/hr/doctype/employee_referral/employee_referral.py b/erpnext/hr/doctype/employee_referral/employee_referral.py index 4e1780b9978..e349c674d8b 100644 --- a/erpnext/hr/doctype/employee_referral/employee_referral.py +++ b/erpnext/hr/doctype/employee_referral/employee_referral.py @@ -30,7 +30,7 @@ class EmployeeReferral(Document): @frappe.whitelist() def create_job_applicant(source_name, target_doc=None): emp_ref = frappe.get_doc("Employee Referral", source_name) - #just for Api call if some set status apart from default Status + # just for Api call if some set status apart from default Status status = emp_ref.status if emp_ref.status in ["Pending", "In process"]: status = "Open" @@ -47,9 +47,13 @@ def create_job_applicant(source_name, target_doc=None): job_applicant.resume_link = emp_ref.resume_link job_applicant.save() - frappe.msgprint(_("Job Applicant {0} created successfully.").format( - get_link_to_form("Job Applicant", job_applicant.name)), - title=_("Success"), indicator="green") + frappe.msgprint( + _("Job Applicant {0} created successfully.").format( + get_link_to_form("Job Applicant", job_applicant.name) + ), + title=_("Success"), + indicator="green", + ) emp_ref.db_set("status", "In Process") diff --git a/erpnext/hr/doctype/employee_referral/employee_referral_dashboard.py b/erpnext/hr/doctype/employee_referral/employee_referral_dashboard.py index 1733ac9726e..4d683fbfcf3 100644 --- a/erpnext/hr/doctype/employee_referral/employee_referral_dashboard.py +++ b/erpnext/hr/doctype/employee_referral/employee_referral_dashboard.py @@ -1,15 +1,8 @@ - - def get_data(): return { - 'fieldname': 'employee_referral', - 'non_standard_fieldnames': { - 'Additional Salary': 'ref_docname' - }, - 'transactions': [ - { - 'items': ['Job Applicant', 'Additional Salary'] - }, - - ] + "fieldname": "employee_referral", + "non_standard_fieldnames": {"Additional Salary": "ref_docname"}, + "transactions": [ + {"items": ["Job Applicant", "Additional Salary"]}, + ], } diff --git a/erpnext/hr/doctype/employee_referral/test_employee_referral.py b/erpnext/hr/doctype/employee_referral/test_employee_referral.py index 529e3551454..475a935e864 100644 --- a/erpnext/hr/doctype/employee_referral/test_employee_referral.py +++ b/erpnext/hr/doctype/employee_referral/test_employee_referral.py @@ -15,7 +15,6 @@ from erpnext.hr.doctype.employee_referral.employee_referral import ( class TestEmployeeReferral(unittest.TestCase): - def setUp(self): frappe.db.sql("DELETE FROM `tabJob Applicant`") frappe.db.sql("DELETE FROM `tabEmployee Referral`") @@ -23,13 +22,12 @@ class TestEmployeeReferral(unittest.TestCase): def test_workflow_and_status_sync(self): emp_ref = create_employee_referral() - #Check Initial status + # Check Initial status self.assertTrue(emp_ref.status, "Pending") job_applicant = create_job_applicant(emp_ref.name) - - #Check status sync + # Check status sync emp_ref.reload() self.assertTrue(emp_ref.status, "In Process") @@ -47,7 +45,6 @@ class TestEmployeeReferral(unittest.TestCase): emp_ref.reload() self.assertTrue(emp_ref.status, "Accepted") - # Check for Referral reference in additional salary add_sal = create_additional_salary(emp_ref) diff --git a/erpnext/hr/doctype/employee_separation/test_employee_separation.py b/erpnext/hr/doctype/employee_separation/test_employee_separation.py index 0007b9e1f38..5ba57bad899 100644 --- a/erpnext/hr/doctype/employee_separation/test_employee_separation.py +++ b/erpnext/hr/doctype/employee_separation/test_employee_separation.py @@ -7,17 +7,15 @@ import frappe test_dependencies = ["Employee Onboarding"] + class TestEmployeeSeparation(unittest.TestCase): def test_employee_separation(self): employee = frappe.db.get_value("Employee", {"status": "Active"}) - separation = frappe.new_doc('Employee Separation') + separation = frappe.new_doc("Employee Separation") separation.employee = employee - separation.company = '_Test Company' - separation.append('activities', { - 'activity_name': 'Deactivate Employee', - 'role': 'HR User' - }) - separation.boarding_status = 'Pending' + separation.company = "_Test Company" + separation.append("activities", {"activity_name": "Deactivate Employee", "role": "HR User"}) + separation.boarding_status = "Pending" separation.insert() separation.submit() self.assertEqual(separation.docstatus, 1) diff --git a/erpnext/hr/doctype/employee_separation_template/employee_separation_template_dashboard.py b/erpnext/hr/doctype/employee_separation_template/employee_separation_template_dashboard.py index f165d0a0eb4..3ffd8dd6e2c 100644 --- a/erpnext/hr/doctype/employee_separation_template/employee_separation_template_dashboard.py +++ b/erpnext/hr/doctype/employee_separation_template/employee_separation_template_dashboard.py @@ -1,11 +1,7 @@ - - def get_data(): - return { - 'fieldname': 'employee_separation_template', - 'transactions': [ - { - 'items': ['Employee Separation'] - }, - ], - } + return { + "fieldname": "employee_separation_template", + "transactions": [ + {"items": ["Employee Separation"]}, + ], + } diff --git a/erpnext/hr/doctype/employee_transfer/employee_transfer.py b/erpnext/hr/doctype/employee_transfer/employee_transfer.py index f927d413ae3..6dbefe59da5 100644 --- a/erpnext/hr/doctype/employee_transfer/employee_transfer.py +++ b/erpnext/hr/doctype/employee_transfer/employee_transfer.py @@ -13,8 +13,10 @@ from erpnext.hr.utils import update_employee_work_history class EmployeeTransfer(Document): def before_submit(self): if getdate(self.transfer_date) > getdate(): - frappe.throw(_("Employee Transfer cannot be submitted before Transfer Date"), - frappe.DocstatusTransitionError) + frappe.throw( + _("Employee Transfer cannot be submitted before Transfer Date"), + frappe.DocstatusTransitionError, + ) def on_submit(self): employee = frappe.get_doc("Employee", self.employee) @@ -22,22 +24,26 @@ class EmployeeTransfer(Document): new_employee = frappe.copy_doc(employee) new_employee.name = None new_employee.employee_number = None - new_employee = update_employee_work_history(new_employee, self.transfer_details, date=self.transfer_date) + new_employee = update_employee_work_history( + new_employee, self.transfer_details, date=self.transfer_date + ) if self.new_company and self.company != self.new_company: new_employee.internal_work_history = [] new_employee.date_of_joining = self.transfer_date new_employee.company = self.new_company - #move user_id to new employee before insert + # move user_id to new employee before insert if employee.user_id and not self.validate_user_in_details(): new_employee.user_id = employee.user_id employee.db_set("user_id", "") new_employee.insert() self.db_set("new_employee_id", new_employee.name) - #relieve the old employee + # relieve the old employee employee.db_set("relieving_date", self.transfer_date) employee.db_set("status", "Left") else: - employee = update_employee_work_history(employee, self.transfer_details, date=self.transfer_date) + employee = update_employee_work_history( + employee, self.transfer_details, date=self.transfer_date + ) if self.new_company and self.company != self.new_company: employee.company = self.new_company employee.date_of_joining = self.transfer_date @@ -47,14 +53,18 @@ class EmployeeTransfer(Document): employee = frappe.get_doc("Employee", self.employee) if self.create_new_employee_id: if self.new_employee_id: - frappe.throw(_("Please delete the Employee {0} to cancel this document").format( - "{0}".format(self.new_employee_id) - )) - #mark the employee as active + frappe.throw( + _("Please delete the Employee {0} to cancel this document").format( + "{0}".format(self.new_employee_id) + ) + ) + # mark the employee as active employee.status = "Active" - employee.relieving_date = '' + employee.relieving_date = "" else: - employee = update_employee_work_history(employee, self.transfer_details, date=self.transfer_date, cancel=True) + employee = update_employee_work_history( + employee, self.transfer_details, date=self.transfer_date, cancel=True + ) if self.new_company != self.company: employee.company = self.company employee.save() diff --git a/erpnext/hr/doctype/employee_transfer/test_employee_transfer.py b/erpnext/hr/doctype/employee_transfer/test_employee_transfer.py index 64eee402fec..c6bd7d23a76 100644 --- a/erpnext/hr/doctype/employee_transfer/test_employee_transfer.py +++ b/erpnext/hr/doctype/employee_transfer/test_employee_transfer.py @@ -19,18 +19,20 @@ class TestEmployeeTransfer(unittest.TestCase): def test_submit_before_transfer_date(self): make_employee("employee2@transfers.com") - transfer_obj = frappe.get_doc({ - "doctype": "Employee Transfer", - "employee": frappe.get_value("Employee", {"user_id":"employee2@transfers.com"}, "name"), - "transfer_details" :[ - { - "property": "Designation", - "current": "Software Developer", - "new": "Project Manager", - "fieldname": "designation" - } - ] - }) + transfer_obj = frappe.get_doc( + { + "doctype": "Employee Transfer", + "employee": frappe.get_value("Employee", {"user_id": "employee2@transfers.com"}, "name"), + "transfer_details": [ + { + "property": "Designation", + "current": "Software Developer", + "new": "Project Manager", + "fieldname": "designation", + } + ], + } + ) transfer_obj.transfer_date = add_days(getdate(), 1) transfer_obj.save() self.assertRaises(frappe.DocstatusTransitionError, transfer_obj.submit) @@ -42,32 +44,35 @@ class TestEmployeeTransfer(unittest.TestCase): def test_new_employee_creation(self): make_employee("employee3@transfers.com") - transfer = frappe.get_doc({ - "doctype": "Employee Transfer", - "employee": frappe.get_value("Employee", {"user_id":"employee3@transfers.com"}, "name"), - "create_new_employee_id": 1, - "transfer_date": getdate(), - "transfer_details" :[ - { - "property": "Designation", - "current": "Software Developer", - "new": "Project Manager", - "fieldname": "designation" - } - ] - }).insert() + transfer = frappe.get_doc( + { + "doctype": "Employee Transfer", + "employee": frappe.get_value("Employee", {"user_id": "employee3@transfers.com"}, "name"), + "create_new_employee_id": 1, + "transfer_date": getdate(), + "transfer_details": [ + { + "property": "Designation", + "current": "Software Developer", + "new": "Project Manager", + "fieldname": "designation", + } + ], + } + ).insert() transfer.submit() self.assertTrue(transfer.new_employee_id) self.assertEqual(frappe.get_value("Employee", transfer.new_employee_id, "status"), "Active") self.assertEqual(frappe.get_value("Employee", transfer.employee, "status"), "Left") def test_employee_history(self): - employee = make_employee("employee4@transfers.com", + employee = make_employee( + "employee4@transfers.com", company="Test Company", date_of_birth=getdate("30-09-1980"), date_of_joining=getdate("01-10-2021"), department="Accounts - TC", - designation="Accountant" + designation="Accountant", ) transfer = create_employee_transfer(employee) @@ -75,12 +80,14 @@ class TestEmployeeTransfer(unittest.TestCase): department = ["Accounts - TC", "Management - TC"] designation = ["Accountant", "Manager"] dt = [getdate("01-10-2021"), getdate()] + to_date = [add_days(dt[1], -1), None] employee = frappe.get_doc("Employee", employee) for data in employee.internal_work_history: self.assertEqual(data.department, department[count]) self.assertEqual(data.designation, designation[count]) self.assertEqual(data.from_date, dt[count]) + self.assertEqual(data.to_date, to_date[count]) count = count + 1 transfer.cancel() @@ -90,40 +97,45 @@ class TestEmployeeTransfer(unittest.TestCase): self.assertEqual(data.designation, designation[0]) self.assertEqual(data.department, department[0]) self.assertEqual(data.from_date, dt[0]) + self.assertEqual(data.to_date, None) def create_company(): if not frappe.db.exists("Company", "Test Company"): - frappe.get_doc({ - "doctype": "Company", - "company_name": "Test Company", - "default_currency": "INR", - "country": "India" - }).insert() + frappe.get_doc( + { + "doctype": "Company", + "company_name": "Test Company", + "default_currency": "INR", + "country": "India", + } + ).insert() def create_employee_transfer(employee): - doc = frappe.get_doc({ - "doctype": "Employee Transfer", - "employee": employee, - "transfer_date": getdate(), - "transfer_details": [ - { - "property": "Designation", - "current": "Accountant", - "new": "Manager", - "fieldname": "designation" - }, - { - "property": "Department", - "current": "Accounts - TC", - "new": "Management - TC", - "fieldname": "department" - } - ] - }) + doc = frappe.get_doc( + { + "doctype": "Employee Transfer", + "employee": employee, + "transfer_date": getdate(), + "transfer_details": [ + { + "property": "Designation", + "current": "Accountant", + "new": "Manager", + "fieldname": "designation", + }, + { + "property": "Department", + "current": "Accounts - TC", + "new": "Management - TC", + "fieldname": "department", + }, + ], + } + ) doc.save() doc.submit() - return doc \ No newline at end of file + return doc diff --git a/erpnext/hr/doctype/employment_type/test_employment_type.py b/erpnext/hr/doctype/employment_type/test_employment_type.py index c43f9636c70..fdf6965e48a 100644 --- a/erpnext/hr/doctype/employment_type/test_employment_type.py +++ b/erpnext/hr/doctype/employment_type/test_employment_type.py @@ -3,4 +3,4 @@ import frappe -test_records = frappe.get_test_records('Employment Type') +test_records = frappe.get_test_records("Employment Type") diff --git a/erpnext/hr/doctype/expense_claim/expense_claim.js b/erpnext/hr/doctype/expense_claim/expense_claim.js index 665556301bb..f44611368ad 100644 --- a/erpnext/hr/doctype/expense_claim/expense_claim.js +++ b/erpnext/hr/doctype/expense_claim/expense_claim.js @@ -171,7 +171,7 @@ frappe.ui.form.on("Expense Claim", { ['docstatus', '=', 1], ['employee', '=', frm.doc.employee], ['paid_amount', '>', 0], - ['paid_amount', '>', 'claimed_amount'] + ['status', 'not in', ['Claimed', 'Returned', 'Partly Claimed and Returned']] ] }; }); @@ -254,9 +254,11 @@ frappe.ui.form.on("Expense Claim", { }, __("View")); } - if (frm.doc.docstatus===1 && !cint(frm.doc.is_paid) && cint(frm.doc.grand_total) > 0 - && (cint(frm.doc.total_amount_reimbursed) < cint(frm.doc.total_sanctioned_amount)) - && frappe.model.can_create("Payment Entry")) { + if ( + frm.doc.docstatus === 1 + && frm.doc.status !== "Paid" + && frappe.model.can_create("Payment Entry") + ) { frm.add_custom_button(__('Payment'), function() { frm.events.make_payment_entry(frm); }, __('Create')); } diff --git a/erpnext/hr/doctype/expense_claim/expense_claim.py b/erpnext/hr/doctype/expense_claim/expense_claim.py index 7e3898b7d51..43bbede6804 100644 --- a/erpnext/hr/doctype/expense_claim/expense_claim.py +++ b/erpnext/hr/doctype/expense_claim/expense_claim.py @@ -13,20 +13,26 @@ from erpnext.controllers.accounts_controller import AccountsController from erpnext.hr.utils import set_employee_name, share_doc_with_approver, validate_active_employee -class InvalidExpenseApproverError(frappe.ValidationError): pass -class ExpenseApproverIdentityError(frappe.ValidationError): pass +class InvalidExpenseApproverError(frappe.ValidationError): + pass + + +class ExpenseApproverIdentityError(frappe.ValidationError): + pass + class ExpenseClaim(AccountsController): def onload(self): - self.get("__onload").make_payment_via_journal_entry = frappe.db.get_single_value('Accounts Settings', - 'make_payment_via_journal_entry') + self.get("__onload").make_payment_via_journal_entry = frappe.db.get_single_value( + "Accounts Settings", "make_payment_via_journal_entry" + ) def validate(self): validate_active_employee(self.employee) - self.validate_advances() + set_employee_name(self) self.validate_sanctioned_amount() self.calculate_total_amount() - set_employee_name(self) + self.validate_advances() self.set_expense_account(validate=True) self.set_payable_account() self.set_cost_center() @@ -36,21 +42,35 @@ class ExpenseClaim(AccountsController): self.project = frappe.db.get_value("Task", self.task, "project") def set_status(self, update=False): - status = { - "0": "Draft", - "1": "Submitted", - "2": "Cancelled" - }[cstr(self.docstatus or 0)] + status = {"0": "Draft", "1": "Submitted", "2": "Cancelled"}[cstr(self.docstatus or 0)] - paid_amount = flt(self.total_amount_reimbursed) + flt(self.total_advance_amount) precision = self.precision("grand_total") - if (self.is_paid or (flt(self.total_sanctioned_amount) > 0 and self.docstatus == 1 - and flt(self.grand_total, precision) == flt(paid_amount, precision))) and self.approval_status == 'Approved': + + if ( + # set as paid + self.is_paid + or ( + flt(self.total_sanctioned_amount > 0) + and ( + # grand total is reimbursed + ( + self.docstatus == 1 + and flt(self.grand_total, precision) == flt(self.total_amount_reimbursed, precision) + ) + # grand total (to be paid) is 0 since linked advances already cover the claimed amount + or (flt(self.grand_total, precision) == 0) + ) + ) + ) and self.approval_status == "Approved": status = "Paid" - elif flt(self.total_sanctioned_amount) > 0 and self.docstatus == 1 and self.approval_status == 'Approved': + elif ( + flt(self.total_sanctioned_amount) > 0 + and self.docstatus == 1 + and self.approval_status == "Approved" + ): status = "Unpaid" - elif self.docstatus == 1 and self.approval_status == 'Rejected': - status = 'Rejected' + elif self.docstatus == 1 and self.approval_status == "Rejected": + status = "Rejected" if update: self.db_set("status", status) @@ -62,14 +82,16 @@ class ExpenseClaim(AccountsController): def set_payable_account(self): if not self.payable_account and not self.is_paid: - self.payable_account = frappe.get_cached_value('Company', self.company, 'default_expense_claim_payable_account') + self.payable_account = frappe.get_cached_value( + "Company", self.company, "default_expense_claim_payable_account" + ) def set_cost_center(self): if not self.cost_center: - self.cost_center = frappe.get_cached_value('Company', self.company, 'cost_center') + self.cost_center = frappe.get_cached_value("Company", self.company, "cost_center") def on_submit(self): - if self.approval_status=="Draft": + if self.approval_status == "Draft": frappe.throw(_("""Approval Status must be 'Approved' or 'Rejected'""")) self.update_task_and_project() @@ -83,7 +105,7 @@ class ExpenseClaim(AccountsController): def on_cancel(self): self.update_task_and_project() - self.ignore_linked_doctypes = ('GL Entry', 'Stock Ledger Entry') + self.ignore_linked_doctypes = ("GL Entry", "Stock Ledger Entry") if self.payable_account: self.make_gl_entries(cancel=True) @@ -114,43 +136,51 @@ class ExpenseClaim(AccountsController): # payable entry if self.grand_total: gl_entry.append( - self.get_gl_dict({ - "account": self.payable_account, - "credit": self.grand_total, - "credit_in_account_currency": self.grand_total, - "against": ",".join([d.default_account for d in self.expenses]), - "party_type": "Employee", - "party": self.employee, - "against_voucher_type": self.doctype, - "against_voucher": self.name, - "cost_center": self.cost_center - }, item=self) + self.get_gl_dict( + { + "account": self.payable_account, + "credit": self.grand_total, + "credit_in_account_currency": self.grand_total, + "against": ",".join([d.default_account for d in self.expenses]), + "party_type": "Employee", + "party": self.employee, + "against_voucher_type": self.doctype, + "against_voucher": self.name, + "cost_center": self.cost_center, + }, + item=self, + ) ) # expense entries for data in self.expenses: gl_entry.append( - self.get_gl_dict({ - "account": data.default_account, - "debit": data.sanctioned_amount, - "debit_in_account_currency": data.sanctioned_amount, - "against": self.employee, - "cost_center": data.cost_center or self.cost_center - }, item=data) + self.get_gl_dict( + { + "account": data.default_account, + "debit": data.sanctioned_amount, + "debit_in_account_currency": data.sanctioned_amount, + "against": self.employee, + "cost_center": data.cost_center or self.cost_center, + }, + item=data, + ) ) for data in self.advances: gl_entry.append( - self.get_gl_dict({ - "account": data.advance_account, - "credit": data.allocated_amount, - "credit_in_account_currency": data.allocated_amount, - "against": ",".join([d.default_account for d in self.expenses]), - "party_type": "Employee", - "party": self.employee, - "against_voucher_type": "Employee Advance", - "against_voucher": data.employee_advance - }) + self.get_gl_dict( + { + "account": data.advance_account, + "credit": data.allocated_amount, + "credit_in_account_currency": data.allocated_amount, + "against": ",".join([d.default_account for d in self.expenses]), + "party_type": "Employee", + "party": self.employee, + "against_voucher_type": "Employee Advance", + "against_voucher": data.employee_advance, + } + ) ) self.add_tax_gl_entries(gl_entry) @@ -159,25 +189,31 @@ class ExpenseClaim(AccountsController): # payment entry payment_account = get_bank_cash_account(self.mode_of_payment, self.company).get("account") gl_entry.append( - self.get_gl_dict({ - "account": payment_account, - "credit": self.grand_total, - "credit_in_account_currency": self.grand_total, - "against": self.employee - }, item=self) + self.get_gl_dict( + { + "account": payment_account, + "credit": self.grand_total, + "credit_in_account_currency": self.grand_total, + "against": self.employee, + }, + item=self, + ) ) gl_entry.append( - self.get_gl_dict({ - "account": self.payable_account, - "party_type": "Employee", - "party": self.employee, - "against": payment_account, - "debit": self.grand_total, - "debit_in_account_currency": self.grand_total, - "against_voucher": self.name, - "against_voucher_type": self.doctype, - }, item=self) + self.get_gl_dict( + { + "account": self.payable_account, + "party_type": "Employee", + "party": self.employee, + "against": payment_account, + "debit": self.grand_total, + "debit_in_account_currency": self.grand_total, + "against_voucher": self.name, + "against_voucher_type": self.doctype, + }, + item=self, + ) ) return gl_entry @@ -186,22 +222,28 @@ class ExpenseClaim(AccountsController): # tax table gl entries for tax in self.get("taxes"): gl_entries.append( - self.get_gl_dict({ - "account": tax.account_head, - "debit": tax.tax_amount, - "debit_in_account_currency": tax.tax_amount, - "against": self.employee, - "cost_center": self.cost_center, - "against_voucher_type": self.doctype, - "against_voucher": self.name - }, item=tax) + self.get_gl_dict( + { + "account": tax.account_head, + "debit": tax.tax_amount, + "debit_in_account_currency": tax.tax_amount, + "against": self.employee, + "cost_center": self.cost_center, + "against_voucher_type": self.doctype, + "against_voucher": self.name, + }, + item=tax, + ) ) def validate_account_details(self): for data in self.expenses: if not data.cost_center: - frappe.throw(_("Row {0}: {1} is required in the expenses table to book an expense claim.") - .format(data.idx, frappe.bold("Cost Center"))) + frappe.throw( + _("Row {0}: {1} is required in the expenses table to book an expense claim.").format( + data.idx, frappe.bold("Cost Center") + ) + ) if self.is_paid: if not self.mode_of_payment: @@ -210,8 +252,8 @@ class ExpenseClaim(AccountsController): def calculate_total_amount(self): self.total_claimed_amount = 0 self.total_sanctioned_amount = 0 - for d in self.get('expenses'): - if self.approval_status == 'Rejected': + for d in self.get("expenses"): + if self.approval_status == "Rejected": d.sanctioned_amount = 0.0 self.total_claimed_amount += flt(d.amount) @@ -222,12 +264,16 @@ class ExpenseClaim(AccountsController): self.total_taxes_and_charges = 0 for tax in self.taxes: if tax.rate: - tax.tax_amount = flt(self.total_sanctioned_amount) * flt(tax.rate/100) + tax.tax_amount = flt(self.total_sanctioned_amount) * flt(tax.rate / 100) tax.total = flt(tax.tax_amount) + flt(self.total_sanctioned_amount) self.total_taxes_and_charges += flt(tax.tax_amount) - self.grand_total = flt(self.total_sanctioned_amount) + flt(self.total_taxes_and_charges) - flt(self.total_advance_amount) + self.grand_total = ( + flt(self.total_sanctioned_amount) + + flt(self.total_taxes_and_charges) + - flt(self.total_advance_amount) + ) def update_task(self): task = frappe.get_doc("Task", self.task) @@ -237,45 +283,85 @@ class ExpenseClaim(AccountsController): def validate_advances(self): self.total_advance_amount = 0 for d in self.get("advances"): - ref_doc = frappe.db.get_value("Employee Advance", d.employee_advance, - ["posting_date", "paid_amount", "claimed_amount", "advance_account"], as_dict=1) + ref_doc = frappe.db.get_value( + "Employee Advance", + d.employee_advance, + ["posting_date", "paid_amount", "claimed_amount", "advance_account"], + as_dict=1, + ) d.posting_date = ref_doc.posting_date d.advance_account = ref_doc.advance_account d.advance_paid = ref_doc.paid_amount d.unclaimed_amount = flt(ref_doc.paid_amount) - flt(ref_doc.claimed_amount) if d.allocated_amount and flt(d.allocated_amount) > flt(d.unclaimed_amount): - frappe.throw(_("Row {0}# Allocated amount {1} cannot be greater than unclaimed amount {2}") - .format(d.idx, d.allocated_amount, d.unclaimed_amount)) + frappe.throw( + _("Row {0}# Allocated amount {1} cannot be greater than unclaimed amount {2}").format( + d.idx, d.allocated_amount, d.unclaimed_amount + ) + ) self.total_advance_amount += flt(d.allocated_amount) if self.total_advance_amount: precision = self.precision("total_advance_amount") - if flt(self.total_advance_amount, precision) > flt(self.total_claimed_amount, precision): - frappe.throw(_("Total advance amount cannot be greater than total claimed amount")) + amount_with_taxes = flt( + (flt(self.total_sanctioned_amount, precision) + flt(self.total_taxes_and_charges, precision)), + precision, + ) - if self.total_sanctioned_amount \ - and flt(self.total_advance_amount, precision) > flt(self.total_sanctioned_amount, precision): + if flt(self.total_advance_amount, precision) > amount_with_taxes: frappe.throw(_("Total advance amount cannot be greater than total sanctioned amount")) def validate_sanctioned_amount(self): - for d in self.get('expenses'): + for d in self.get("expenses"): if flt(d.sanctioned_amount) > flt(d.amount): - frappe.throw(_("Sanctioned Amount cannot be greater than Claim Amount in Row {0}.").format(d.idx)) + frappe.throw( + _("Sanctioned Amount cannot be greater than Claim Amount in Row {0}.").format(d.idx) + ) def set_expense_account(self, validate=False): for expense in self.expenses: if not expense.default_account or not validate: - expense.default_account = get_expense_claim_account(expense.expense_type, self.company)["account"] + expense.default_account = get_expense_claim_account(expense.expense_type, self.company)[ + "account" + ] + def update_reimbursed_amount(doc, amount): doc.total_amount_reimbursed += amount - frappe.db.set_value("Expense Claim", doc.name , "total_amount_reimbursed", doc.total_amount_reimbursed) + frappe.db.set_value( + "Expense Claim", doc.name, "total_amount_reimbursed", doc.total_amount_reimbursed + ) doc.set_status() - frappe.db.set_value("Expense Claim", doc.name , "status", doc.status) + frappe.db.set_value("Expense Claim", doc.name, "status", doc.status) + + +def get_outstanding_amount_for_claim(claim): + if isinstance(claim, str): + claim = frappe.db.get_value( + "Expense Claim", + claim, + ( + "total_sanctioned_amount", + "total_taxes_and_charges", + "total_amount_reimbursed", + "total_advance_amount", + ), + as_dict=True, + ) + + outstanding_amt = ( + flt(claim.total_sanctioned_amount) + + flt(claim.total_taxes_and_charges) + - flt(claim.total_amount_reimbursed) + - flt(claim.total_advance_amount) + ) + + return outstanding_amt + @frappe.whitelist() def make_bank_entry(dt, dn): @@ -286,96 +372,113 @@ def make_bank_entry(dt, dn): if not default_bank_cash_account: default_bank_cash_account = get_default_bank_cash_account(expense_claim.company, "Cash") - payable_amount = flt(expense_claim.total_sanctioned_amount) \ - - flt(expense_claim.total_amount_reimbursed) - flt(expense_claim.total_advance_amount) + payable_amount = get_outstanding_amount_for_claim(expense_claim) je = frappe.new_doc("Journal Entry") - je.voucher_type = 'Bank Entry' + je.voucher_type = "Bank Entry" je.company = expense_claim.company - je.remark = 'Payment against Expense Claim: ' + dn + je.remark = "Payment against Expense Claim: " + dn - je.append("accounts", { - "account": expense_claim.payable_account, - "debit_in_account_currency": payable_amount, - "reference_type": "Expense Claim", - "party_type": "Employee", - "party": expense_claim.employee, - "cost_center": erpnext.get_default_cost_center(expense_claim.company), - "reference_name": expense_claim.name - }) + je.append( + "accounts", + { + "account": expense_claim.payable_account, + "debit_in_account_currency": payable_amount, + "reference_type": "Expense Claim", + "party_type": "Employee", + "party": expense_claim.employee, + "cost_center": erpnext.get_default_cost_center(expense_claim.company), + "reference_name": expense_claim.name, + }, + ) - je.append("accounts", { - "account": default_bank_cash_account.account, - "credit_in_account_currency": payable_amount, - "reference_type": "Expense Claim", - "reference_name": expense_claim.name, - "balance": default_bank_cash_account.balance, - "account_currency": default_bank_cash_account.account_currency, - "cost_center": erpnext.get_default_cost_center(expense_claim.company), - "account_type": default_bank_cash_account.account_type - }) + je.append( + "accounts", + { + "account": default_bank_cash_account.account, + "credit_in_account_currency": payable_amount, + "reference_type": "Expense Claim", + "reference_name": expense_claim.name, + "balance": default_bank_cash_account.balance, + "account_currency": default_bank_cash_account.account_currency, + "cost_center": erpnext.get_default_cost_center(expense_claim.company), + "account_type": default_bank_cash_account.account_type, + }, + ) return je.as_dict() + @frappe.whitelist() def get_expense_claim_account_and_cost_center(expense_claim_type, company): data = get_expense_claim_account(expense_claim_type, company) cost_center = erpnext.get_default_cost_center(company) - return { - "account": data.get("account"), - "cost_center": cost_center - } + return {"account": data.get("account"), "cost_center": cost_center} + @frappe.whitelist() def get_expense_claim_account(expense_claim_type, company): - account = frappe.db.get_value("Expense Claim Account", - {"parent": expense_claim_type, "company": company}, "default_account") + account = frappe.db.get_value( + "Expense Claim Account", {"parent": expense_claim_type, "company": company}, "default_account" + ) if not account: - frappe.throw(_("Set the default account for the {0} {1}") - .format(frappe.bold("Expense Claim Type"), get_link_to_form("Expense Claim Type", expense_claim_type))) + frappe.throw( + _("Set the default account for the {0} {1}").format( + frappe.bold("Expense Claim Type"), get_link_to_form("Expense Claim Type", expense_claim_type) + ) + ) + + return {"account": account} - return { - "account": account - } @frappe.whitelist() def get_advances(employee, advance_id=None): - if not advance_id: - condition = 'docstatus=1 and employee={0} and paid_amount > 0 and paid_amount > claimed_amount + return_amount'.format(frappe.db.escape(employee)) - else: - condition = 'name={0}'.format(frappe.db.escape(advance_id)) + advance = frappe.qb.DocType("Employee Advance") - return frappe.db.sql(""" - select - name, posting_date, paid_amount, claimed_amount, advance_account - from - `tabEmployee Advance` - where {0} - """.format(condition), as_dict=1) + query = frappe.qb.from_(advance).select( + advance.name, + advance.posting_date, + advance.paid_amount, + advance.claimed_amount, + advance.advance_account, + ) + + if not advance_id: + query = query.where( + (advance.docstatus == 1) + & (advance.employee == employee) + & (advance.paid_amount > 0) + & (advance.status.notin(["Claimed", "Returned", "Partly Claimed and Returned"])) + ) + else: + query = query.where(advance.name == advance_id) + + return query.run(as_dict=True) @frappe.whitelist() def get_expense_claim( - employee_name, company, employee_advance_name, posting_date, paid_amount, claimed_amount): - default_payable_account = frappe.get_cached_value('Company', company, "default_payable_account") - default_cost_center = frappe.get_cached_value('Company', company, 'cost_center') + employee_name, company, employee_advance_name, posting_date, paid_amount, claimed_amount +): + default_payable_account = frappe.get_cached_value("Company", company, "default_payable_account") + default_cost_center = frappe.get_cached_value("Company", company, "cost_center") - expense_claim = frappe.new_doc('Expense Claim') + expense_claim = frappe.new_doc("Expense Claim") expense_claim.company = company expense_claim.employee = employee_name expense_claim.payable_account = default_payable_account expense_claim.cost_center = default_cost_center expense_claim.is_paid = 1 if flt(paid_amount) else 0 expense_claim.append( - 'advances', + "advances", { - 'employee_advance': employee_advance_name, - 'posting_date': posting_date, - 'advance_paid': flt(paid_amount), - 'unclaimed_amount': flt(paid_amount) - flt(claimed_amount), - 'allocated_amount': flt(paid_amount) - flt(claimed_amount) - } + "employee_advance": employee_advance_name, + "posting_date": posting_date, + "advance_paid": flt(paid_amount), + "unclaimed_amount": flt(paid_amount) - flt(claimed_amount), + "allocated_amount": flt(paid_amount) - flt(claimed_amount), + }, ) return expense_claim diff --git a/erpnext/hr/doctype/expense_claim/expense_claim_dashboard.py b/erpnext/hr/doctype/expense_claim/expense_claim_dashboard.py index 44052cc8e6b..8b1acc619ee 100644 --- a/erpnext/hr/doctype/expense_claim/expense_claim_dashboard.py +++ b/erpnext/hr/doctype/expense_claim/expense_claim_dashboard.py @@ -1,21 +1,12 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'reference_name', - 'internal_links': { - 'Employee Advance': ['advances', 'employee_advance'] - }, - 'transactions': [ - { - 'label': _('Payment'), - 'items': ['Payment Entry', 'Journal Entry'] - }, - { - 'label': _('Reference'), - 'items': ['Employee Advance'] - }, - ] + "fieldname": "reference_name", + "internal_links": {"Employee Advance": ["advances", "employee_advance"]}, + "transactions": [ + {"label": _("Payment"), "items": ["Payment Entry", "Journal Entry"]}, + {"label": _("Reference"), "items": ["Employee Advance"]}, + ], } diff --git a/erpnext/hr/doctype/expense_claim/test_expense_claim.py b/erpnext/hr/doctype/expense_claim/test_expense_claim.py index 548cc667ba8..7cc9892707d 100644 --- a/erpnext/hr/doctype/expense_claim/test_expense_claim.py +++ b/erpnext/hr/doctype/expense_claim/test_expense_claim.py @@ -4,45 +4,55 @@ import unittest import frappe +from frappe.tests.utils import FrappeTestCase from frappe.utils import flt, nowdate, random_string from erpnext.accounts.doctype.account.test_account import create_account from erpnext.hr.doctype.employee.test_employee import make_employee from erpnext.hr.doctype.expense_claim.expense_claim import make_bank_entry -test_records = frappe.get_test_records('Expense Claim') -test_dependencies = ['Employee'] -company_name = '_Test Company 4' +test_dependencies = ["Employee"] +company_name = "_Test Company 3" -class TestExpenseClaim(unittest.TestCase): +class TestExpenseClaim(FrappeTestCase): + def setUp(self): + if not frappe.db.get_value("Cost Center", {"company": company_name}): + frappe.get_doc( + { + "doctype": "Cost Center", + "cost_center_name": "_Test Cost Center 3", + "parent_cost_center": "_Test Company 3 - _TC3", + "is_group": 0, + "company": company_name, + } + ).insert() + def test_total_expense_claim_for_project(self): - frappe.db.sql("""delete from `tabTask` where project = "_Test Project 1" """) - frappe.db.sql("""delete from `tabProject` where name = "_Test Project 1" """) + frappe.db.sql("""delete from `tabTask`""") + frappe.db.sql("""delete from `tabProject`""") frappe.db.sql("update `tabExpense Claim` set project = '', task = ''") - project = frappe.get_doc({ - "project_name": "_Test Project 1", - "doctype": "Project" - }) + project = frappe.get_doc({"project_name": "_Test Project 1", "doctype": "Project"}) project.save() - task = frappe.get_doc(dict( - doctype = 'Task', - subject = '_Test Project Task 1', - status = 'Open', - project = project.name - )).insert() + task = frappe.get_doc( + dict(doctype="Task", subject="_Test Project Task 1", status="Open", project=project.name) + ).insert() task_name = task.name payable_account = get_payable_account(company_name) - make_expense_claim(payable_account, 300, 200, company_name, "Travel Expenses - _TC4", project.name, task_name) + make_expense_claim( + payable_account, 300, 200, company_name, "Travel Expenses - _TC3", project.name, task_name + ) self.assertEqual(frappe.db.get_value("Task", task_name, "total_expense_claim"), 200) self.assertEqual(frappe.db.get_value("Project", project.name, "total_expense_claim"), 200) - expense_claim2 = make_expense_claim(payable_account, 600, 500, company_name, "Travel Expenses - _TC4", project.name, task_name) + expense_claim2 = make_expense_claim( + payable_account, 600, 500, company_name, "Travel Expenses - _TC3", project.name, task_name + ) self.assertEqual(frappe.db.get_value("Task", task_name, "total_expense_claim"), 700) self.assertEqual(frappe.db.get_value("Project", project.name, "total_expense_claim"), 700) @@ -54,14 +64,11 @@ class TestExpenseClaim(unittest.TestCase): def test_expense_claim_status(self): payable_account = get_payable_account(company_name) - expense_claim = make_expense_claim(payable_account, 300, 200, company_name, "Travel Expenses - _TC4") + expense_claim = make_expense_claim( + payable_account, 300, 200, company_name, "Travel Expenses - _TC3" + ) - je_dict = make_bank_entry("Expense Claim", expense_claim.name) - je = frappe.get_doc(je_dict) - je.posting_date = nowdate() - je.cheque_no = random_string(5) - je.cheque_date = nowdate() - je.submit() + je = make_journal_entry(expense_claim) expense_claim = frappe.get_doc("Expense Claim", expense_claim.name) self.assertEqual(expense_claim.status, "Paid") @@ -70,24 +77,144 @@ class TestExpenseClaim(unittest.TestCase): expense_claim = frappe.get_doc("Expense Claim", expense_claim.name) self.assertEqual(expense_claim.status, "Unpaid") + # expense claim without any sanctioned amount should not have status as Paid + claim = make_expense_claim(payable_account, 1000, 0, "_Test Company", "Travel Expenses - _TC") + self.assertEqual(claim.total_sanctioned_amount, 0) + self.assertEqual(claim.status, "Submitted") + + # no gl entries created + gl_entry = frappe.get_all( + "GL Entry", {"voucher_type": "Expense Claim", "voucher_no": claim.name} + ) + self.assertEqual(len(gl_entry), 0) + + def test_expense_claim_against_fully_paid_advances(self): + from erpnext.hr.doctype.employee_advance.test_employee_advance import ( + get_advances_for_claim, + make_employee_advance, + make_payment_entry, + ) + + frappe.db.delete("Employee Advance") + + payable_account = get_payable_account("_Test Company") + claim = make_expense_claim( + payable_account, 1000, 1000, "_Test Company", "Travel Expenses - _TC", do_not_submit=True + ) + + advance = make_employee_advance(claim.employee) + pe = make_payment_entry(advance) + pe.submit() + + # claim for already paid out advances + claim = get_advances_for_claim(claim, advance.name) + claim.save() + claim.submit() + + self.assertEqual(claim.grand_total, 0) + self.assertEqual(claim.status, "Paid") + + def test_advance_amount_allocation_against_claim_with_taxes(self): + from erpnext.hr.doctype.employee_advance.test_employee_advance import ( + get_advances_for_claim, + make_employee_advance, + make_payment_entry, + ) + + frappe.db.delete("Employee Advance") + + payable_account = get_payable_account("_Test Company") + taxes = generate_taxes("_Test Company") + claim = make_expense_claim( + payable_account, + 700, + 700, + "_Test Company", + "Travel Expenses - _TC", + do_not_submit=True, + taxes=taxes, + ) + claim.save() + + advance = make_employee_advance(claim.employee) + pe = make_payment_entry(advance) + pe.submit() + + # claim for already paid out advances + claim = get_advances_for_claim(claim, advance.name, 763) + claim.save() + claim.submit() + + self.assertEqual(claim.grand_total, 0) + self.assertEqual(claim.status, "Paid") + + def test_expense_claim_partially_paid_via_advance(self): + from erpnext.hr.doctype.employee_advance.test_employee_advance import ( + get_advances_for_claim, + make_employee_advance, + ) + from erpnext.hr.doctype.employee_advance.test_employee_advance import ( + make_payment_entry as make_advance_payment, + ) + + frappe.db.delete("Employee Advance") + + payable_account = get_payable_account("_Test Company") + claim = make_expense_claim( + payable_account, 1000, 1000, "_Test Company", "Travel Expenses - _TC", do_not_submit=True + ) + + # link advance for partial amount + advance = make_employee_advance(claim.employee, {"advance_amount": 500}) + pe = make_advance_payment(advance) + pe.submit() + + claim = get_advances_for_claim(claim, advance.name) + claim.save() + claim.submit() + + self.assertEqual(claim.grand_total, 500) + self.assertEqual(claim.status, "Unpaid") + + # reimburse remaning amount + make_payment_entry(claim, payable_account, 500) + claim.reload() + + self.assertEqual(claim.total_amount_reimbursed, 500) + self.assertEqual(claim.status, "Paid") + def test_expense_claim_gl_entry(self): payable_account = get_payable_account(company_name) taxes = generate_taxes() - expense_claim = make_expense_claim(payable_account, 300, 200, company_name, "Travel Expenses - _TC4", - do_not_submit=True, taxes=taxes) + expense_claim = make_expense_claim( + payable_account, + 300, + 200, + company_name, + "Travel Expenses - _TC3", + do_not_submit=True, + taxes=taxes, + ) expense_claim.submit() - gl_entries = frappe.db.sql("""select account, debit, credit + gl_entries = frappe.db.sql( + """select account, debit, credit from `tabGL Entry` where voucher_type='Expense Claim' and voucher_no=%s - order by account asc""", expense_claim.name, as_dict=1) + order by account asc""", + expense_claim.name, + as_dict=1, + ) self.assertTrue(gl_entries) - expected_values = dict((d[0], d) for d in [ - ['Output Tax CGST - _TC4',18.0, 0.0], - [payable_account, 0.0, 218.0], - ["Travel Expenses - _TC4", 200.0, 0.0] - ]) + expected_values = dict( + (d[0], d) + for d in [ + ["Output Tax CGST - _TC3", 18.0, 0.0], + [payable_account, 0.0, 218.0], + ["Travel Expenses - _TC3", 200.0, 0.0], + ] + ) for gle in gl_entries: self.assertEqual(expected_values[gle.account][0], gle.account) @@ -96,20 +223,30 @@ class TestExpenseClaim(unittest.TestCase): def test_rejected_expense_claim(self): payable_account = get_payable_account(company_name) - expense_claim = frappe.get_doc({ - "doctype": "Expense Claim", - "employee": "_T-Employee-00001", - "payable_account": payable_account, - "approval_status": "Rejected", - "expenses": - [{ "expense_type": "Travel", "default_account": "Travel Expenses - _TC4", "amount": 300, "sanctioned_amount": 200 }] - }) + expense_claim = frappe.get_doc( + { + "doctype": "Expense Claim", + "employee": "_T-Employee-00001", + "payable_account": payable_account, + "approval_status": "Rejected", + "expenses": [ + { + "expense_type": "Travel", + "default_account": "Travel Expenses - _TC3", + "amount": 300, + "sanctioned_amount": 200, + } + ], + } + ) expense_claim.submit() - self.assertEqual(expense_claim.status, 'Rejected') + self.assertEqual(expense_claim.status, "Rejected") self.assertEqual(expense_claim.total_sanctioned_amount, 0.0) - gl_entry = frappe.get_all('GL Entry', {'voucher_type': 'Expense Claim', 'voucher_no': expense_claim.name}) + gl_entry = frappe.get_all( + "GL Entry", {"voucher_type": "Expense Claim", "voucher_no": expense_claim.name} + ) self.assertEqual(len(gl_entry), 0) def test_expense_approver_perms(self): @@ -118,7 +255,9 @@ class TestExpenseClaim(unittest.TestCase): # check doc shared payable_account = get_payable_account("_Test Company") - expense_claim = make_expense_claim(payable_account, 300, 200, "_Test Company", "Travel Expenses - _TC", do_not_submit=True) + expense_claim = make_expense_claim( + payable_account, 300, 200, "_Test Company", "Travel Expenses - _TC", do_not_submit=True + ) expense_claim.expense_approver = user expense_claim.save() self.assertTrue(expense_claim.name in frappe.share.get_shared("Expense Claim", user)) @@ -142,51 +281,95 @@ class TestExpenseClaim(unittest.TestCase): def test_multiple_payment_entries_against_expense(self): # Creating expense claim payable_account = get_payable_account("_Test Company") - expense_claim = make_expense_claim(payable_account, 5500, 5500, "_Test Company", "Travel Expenses - _TC") + expense_claim = make_expense_claim( + payable_account, 5500, 5500, "_Test Company", "Travel Expenses - _TC" + ) expense_claim.save() expense_claim.submit() # Payment entry 1: paying 500 - make_payment_entry(expense_claim, payable_account,500) - outstanding_amount, total_amount_reimbursed = get_outstanding_and_total_reimbursed_amounts(expense_claim) + make_payment_entry(expense_claim, payable_account, 500) + outstanding_amount, total_amount_reimbursed = get_outstanding_and_total_reimbursed_amounts( + expense_claim + ) self.assertEqual(outstanding_amount, 5000) self.assertEqual(total_amount_reimbursed, 500) # Payment entry 1: paying 2000 - make_payment_entry(expense_claim, payable_account,2000) - outstanding_amount, total_amount_reimbursed = get_outstanding_and_total_reimbursed_amounts(expense_claim) + make_payment_entry(expense_claim, payable_account, 2000) + outstanding_amount, total_amount_reimbursed = get_outstanding_and_total_reimbursed_amounts( + expense_claim + ) self.assertEqual(outstanding_amount, 3000) self.assertEqual(total_amount_reimbursed, 2500) # Payment entry 1: paying 3000 - make_payment_entry(expense_claim, payable_account,3000) - outstanding_amount, total_amount_reimbursed = get_outstanding_and_total_reimbursed_amounts(expense_claim) + make_payment_entry(expense_claim, payable_account, 3000) + outstanding_amount, total_amount_reimbursed = get_outstanding_and_total_reimbursed_amounts( + expense_claim + ) self.assertEqual(outstanding_amount, 0) self.assertEqual(total_amount_reimbursed, 5500) + def test_journal_entry_against_expense_claim(self): + payable_account = get_payable_account(company_name) + taxes = generate_taxes() + expense_claim = make_expense_claim( + payable_account, + 300, + 200, + company_name, + "Travel Expenses - _TC3", + do_not_submit=True, + taxes=taxes, + ) + expense_claim.submit() + + je = make_journal_entry(expense_claim) + + self.assertEqual(je.accounts[0].debit_in_account_currency, expense_claim.grand_total) + def get_payable_account(company): - return frappe.get_cached_value('Company', company, 'default_payable_account') + return frappe.get_cached_value("Company", company, "default_payable_account") -def generate_taxes(): - parent_account = frappe.db.get_value('Account', - {'company': company_name, 'is_group':1, 'account_type': 'Tax'}, - 'name') - account = create_account(company=company_name, account_name="Output Tax CGST", account_type="Tax", parent_account=parent_account) - return {'taxes':[{ - "account_head": account, - "rate": 9, - "description": "CGST", - "tax_amount": 10, - "total": 210 - }]} -def make_expense_claim(payable_account, amount, sanctioned_amount, company, account, project=None, task_name=None, do_not_submit=False, taxes=None): +def generate_taxes(company=None): + company = company or company_name + parent_account = frappe.db.get_value( + "Account", filters={"account_name": "Duties and Taxes", "company": company} + ) + account = create_account( + company=company, + account_name="Output Tax CGST", + account_type="Tax", + parent_account=parent_account, + ) + return { + "taxes": [ + {"account_head": account, "rate": 9, "description": "CGST", "tax_amount": 10, "total": 210} + ] + } + + +def make_expense_claim( + payable_account, + amount, + sanctioned_amount, + company, + account, + project=None, + task_name=None, + do_not_submit=False, + taxes=None, +): employee = frappe.db.get_value("Employee", {"status": "Active"}) if not employee: employee = make_employee("test_employee@expense_claim.com", company=company) - currency, cost_center = frappe.db.get_value('Company', company, ['default_currency', 'cost_center']) + currency, cost_center = frappe.db.get_value( + "Company", company, ["default_currency", "cost_center"] + ) expense_claim = { "doctype": "Expense Claim", "employee": employee, @@ -194,14 +377,16 @@ def make_expense_claim(payable_account, amount, sanctioned_amount, company, acco "approval_status": "Approved", "company": company, "currency": currency, - "expenses": [{ - "expense_type": "Travel", - "default_account": account, - "currency": currency, - "amount": amount, - "sanctioned_amount": sanctioned_amount, - "cost_center": cost_center - }] + "expenses": [ + { + "expense_type": "Travel", + "default_account": account, + "currency": currency, + "amount": amount, + "sanctioned_amount": sanctioned_amount, + "cost_center": cost_center, + } + ], } if taxes: expense_claim.update(taxes) @@ -218,17 +403,24 @@ def make_expense_claim(payable_account, amount, sanctioned_amount, company, acco expense_claim.submit() return expense_claim -def get_outstanding_and_total_reimbursed_amounts(expense_claim): - outstanding_amount = flt(frappe.db.get_value("Expense Claim", expense_claim.name, "total_sanctioned_amount")) - \ - flt(frappe.db.get_value("Expense Claim", expense_claim.name, "total_amount_reimbursed")) - total_amount_reimbursed = flt(frappe.db.get_value("Expense Claim", expense_claim.name, "total_amount_reimbursed")) - return outstanding_amount,total_amount_reimbursed +def get_outstanding_and_total_reimbursed_amounts(expense_claim): + outstanding_amount = flt( + frappe.db.get_value("Expense Claim", expense_claim.name, "total_sanctioned_amount") + ) - flt(frappe.db.get_value("Expense Claim", expense_claim.name, "total_amount_reimbursed")) + total_amount_reimbursed = flt( + frappe.db.get_value("Expense Claim", expense_claim.name, "total_amount_reimbursed") + ) + + return outstanding_amount, total_amount_reimbursed + def make_payment_entry(expense_claim, payable_account, amt): from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry - pe = get_payment_entry("Expense Claim", expense_claim.name, bank_account="_Test Bank USD - _TC", bank_amount=amt) + pe = get_payment_entry( + "Expense Claim", expense_claim.name, bank_account="_Test Bank USD - _TC", bank_amount=amt + ) pe.reference_no = "1" pe.reference_date = nowdate() pe.source_exchange_rate = 1 @@ -237,3 +429,13 @@ def make_payment_entry(expense_claim, payable_account, amt): pe.insert() pe.submit() + +def make_journal_entry(expense_claim): + je_dict = make_bank_entry("Expense Claim", expense_claim.name) + je = frappe.get_doc(je_dict) + je.posting_date = nowdate() + je.cheque_no = random_string(5) + je.cheque_date = nowdate() + je.submit() + + return je diff --git a/erpnext/hr/doctype/expense_claim/test_records.json b/erpnext/hr/doctype/expense_claim/test_records.json deleted file mode 100644 index fe51488c706..00000000000 --- a/erpnext/hr/doctype/expense_claim/test_records.json +++ /dev/null @@ -1 +0,0 @@ -[] diff --git a/erpnext/hr/doctype/expense_claim_type/expense_claim_type.py b/erpnext/hr/doctype/expense_claim_type/expense_claim_type.py index 570b2c115fa..6d29f7d8e71 100644 --- a/erpnext/hr/doctype/expense_claim_type/expense_claim_type.py +++ b/erpnext/hr/doctype/expense_claim_type/expense_claim_type.py @@ -18,12 +18,13 @@ class ExpenseClaimType(Document): for entry in self.accounts: accounts_list.append(entry.company) - if len(accounts_list)!= len(set(accounts_list)): + if len(accounts_list) != len(set(accounts_list)): frappe.throw(_("Same Company is entered more than once")) def validate_accounts(self): for entry in self.accounts: """Error when Company of Ledger account doesn't match with Company Selected""" if frappe.db.get_value("Account", entry.default_account, "company") != entry.company: - frappe.throw(_("Account {0} does not match with Company {1}" - ).format(entry.default_account, entry.company)) + frappe.throw( + _("Account {0} does not match with Company {1}").format(entry.default_account, entry.company) + ) diff --git a/erpnext/hr/doctype/expense_claim_type/test_expense_claim_type.py b/erpnext/hr/doctype/expense_claim_type/test_expense_claim_type.py index a2403b6eb8f..62348e28255 100644 --- a/erpnext/hr/doctype/expense_claim_type/test_expense_claim_type.py +++ b/erpnext/hr/doctype/expense_claim_type/test_expense_claim_type.py @@ -5,5 +5,6 @@ import unittest # test_records = frappe.get_test_records('Expense Claim Type') + class TestExpenseClaimType(unittest.TestCase): pass diff --git a/erpnext/hr/doctype/holiday_list/holiday_list.py b/erpnext/hr/doctype/holiday_list/holiday_list.py index 35775ab816c..1cf44536b59 100644 --- a/erpnext/hr/doctype/holiday_list/holiday_list.py +++ b/erpnext/hr/doctype/holiday_list/holiday_list.py @@ -10,7 +10,9 @@ from frappe.model.document import Document from frappe.utils import cint, formatdate, getdate, today -class OverlapError(frappe.ValidationError): pass +class OverlapError(frappe.ValidationError): + pass + class HolidayList(Document): def validate(self): @@ -21,9 +23,14 @@ class HolidayList(Document): def get_weekly_off_dates(self): self.validate_values() date_list = self.get_weekly_off_date_list(self.from_date, self.to_date) - last_idx = max([cint(d.idx) for d in self.get("holidays")] or [0,]) + last_idx = max( + [cint(d.idx) for d in self.get("holidays")] + or [ + 0, + ] + ) for i, d in enumerate(date_list): - ch = self.append('holidays', {}) + ch = self.append("holidays", {}) ch.description = self.weekly_off ch.holiday_date = d ch.weekly_off = 1 @@ -33,14 +40,17 @@ class HolidayList(Document): if not self.weekly_off: throw(_("Please select weekly off day")) - def validate_days(self): if getdate(self.from_date) > getdate(self.to_date): throw(_("To Date cannot be before From Date")) for day in self.get("holidays"): if not (getdate(self.from_date) <= getdate(day.holiday_date) <= getdate(self.to_date)): - frappe.throw(_("The holiday on {0} is not between From Date and To Date").format(formatdate(day.holiday_date))) + frappe.throw( + _("The holiday on {0} is not between From Date and To Date").format( + formatdate(day.holiday_date) + ) + ) def get_weekly_off_date_list(self, start_date, end_date): start_date, end_date = getdate(start_date), getdate(end_date) @@ -66,7 +76,8 @@ class HolidayList(Document): @frappe.whitelist() def clear_table(self): - self.set('holidays', []) + self.set("holidays", []) + @frappe.whitelist() def get_events(start, end, filters=None): @@ -82,23 +93,30 @@ def get_events(start, end, filters=None): filters = [] if start: - filters.append(['Holiday', 'holiday_date', '>', getdate(start)]) + filters.append(["Holiday", "holiday_date", ">", getdate(start)]) if end: - filters.append(['Holiday', 'holiday_date', '<', getdate(end)]) + filters.append(["Holiday", "holiday_date", "<", getdate(end)]) - return frappe.get_list('Holiday List', - fields=['name', '`tabHoliday`.holiday_date', '`tabHoliday`.description', '`tabHoliday List`.color'], - filters = filters, - update={"allDay": 1}) + return frappe.get_list( + "Holiday List", + fields=[ + "name", + "`tabHoliday`.holiday_date", + "`tabHoliday`.description", + "`tabHoliday List`.color", + ], + filters=filters, + update={"allDay": 1}, + ) def is_holiday(holiday_list, date=None): - """Returns true if the given date is a holiday in the given holiday list - """ + """Returns true if the given date is a holiday in the given holiday list""" if date is None: date = today() if holiday_list: - return bool(frappe.get_all('Holiday List', - dict(name=holiday_list, holiday_date=date))) + return bool( + frappe.db.exists("Holiday", {"parent": holiday_list, "holiday_date": date}, cache=True) + ) else: return False diff --git a/erpnext/hr/doctype/holiday_list/holiday_list_dashboard.py b/erpnext/hr/doctype/holiday_list/holiday_list_dashboard.py index e074e266b87..0cbf09461b5 100644 --- a/erpnext/hr/doctype/holiday_list/holiday_list_dashboard.py +++ b/erpnext/hr/doctype/holiday_list/holiday_list_dashboard.py @@ -1,21 +1,15 @@ - - def get_data(): return { - 'fieldname': 'holiday_list', - 'non_standard_fieldnames': { - 'Company': 'default_holiday_list', - 'Leave Period': 'optional_holiday_list' + "fieldname": "holiday_list", + "non_standard_fieldnames": { + "Company": "default_holiday_list", + "Leave Period": "optional_holiday_list", }, - 'transactions': [ + "transactions": [ { - 'items': ['Company', 'Employee', 'Workstation'], + "items": ["Company", "Employee", "Workstation"], }, - { - 'items': ['Leave Period', 'Shift Type'] - }, - { - 'items': ['Service Level', 'Service Level Agreement'] - } - ] + {"items": ["Leave Period", "Shift Type"]}, + {"items": ["Service Level", "Service Level Agreement"]}, + ], } diff --git a/erpnext/hr/doctype/holiday_list/test_holiday_list.py b/erpnext/hr/doctype/holiday_list/test_holiday_list.py index c9239edb720..d32cfe82650 100644 --- a/erpnext/hr/doctype/holiday_list/test_holiday_list.py +++ b/erpnext/hr/doctype/holiday_list/test_holiday_list.py @@ -2,6 +2,7 @@ # License: GNU General Public License v3. See license.txt import unittest +from contextlib import contextmanager from datetime import timedelta import frappe @@ -11,22 +12,50 @@ from frappe.utils import getdate class TestHolidayList(unittest.TestCase): def test_holiday_list(self): today_date = getdate() - test_holiday_dates = [today_date-timedelta(days=5), today_date-timedelta(days=4)] - holiday_list = make_holiday_list("test_holiday_list", + test_holiday_dates = [today_date - timedelta(days=5), today_date - timedelta(days=4)] + holiday_list = make_holiday_list( + "test_holiday_list", holiday_dates=[ - {'holiday_date': test_holiday_dates[0], 'description': 'test holiday'}, - {'holiday_date': test_holiday_dates[1], 'description': 'test holiday2'} - ]) - fetched_holiday_list = frappe.get_value('Holiday List', holiday_list.name) + {"holiday_date": test_holiday_dates[0], "description": "test holiday"}, + {"holiday_date": test_holiday_dates[1], "description": "test holiday2"}, + ], + ) + fetched_holiday_list = frappe.get_value("Holiday List", holiday_list.name) self.assertEqual(holiday_list.name, fetched_holiday_list) -def make_holiday_list(name, from_date=getdate()-timedelta(days=10), to_date=getdate(), holiday_dates=None): + +def make_holiday_list( + name, from_date=getdate() - timedelta(days=10), to_date=getdate(), holiday_dates=None +): frappe.delete_doc_if_exists("Holiday List", name, force=1) - doc = frappe.get_doc({ - "doctype": "Holiday List", - "holiday_list_name": name, - "from_date" : from_date, - "to_date" : to_date, - "holidays" : holiday_dates - }).insert() + doc = frappe.get_doc( + { + "doctype": "Holiday List", + "holiday_list_name": name, + "from_date": from_date, + "to_date": to_date, + "holidays": holiday_dates, + } + ).insert() return doc + + +@contextmanager +def set_holiday_list(holiday_list, company_name): + """ + Context manager for setting holiday list in tests + """ + try: + company = frappe.get_doc("Company", company_name) + previous_holiday_list = company.default_holiday_list + + company.default_holiday_list = holiday_list + company.save() + + yield + + finally: + # restore holiday list setup + company = frappe.get_doc("Company", company_name) + company.default_holiday_list = previous_holiday_list + company.save() diff --git a/erpnext/hr/doctype/hr_settings/hr_settings.py b/erpnext/hr/doctype/hr_settings/hr_settings.py index c295bcbc0d9..72a49e285a0 100644 --- a/erpnext/hr/doctype/hr_settings/hr_settings.py +++ b/erpnext/hr/doctype/hr_settings/hr_settings.py @@ -10,6 +10,7 @@ from frappe.utils import format_date # Wether to proceed with frequency change PROCEED_WITH_FREQUENCY_CHANGE = False + class HRSettings(Document): def validate(self): self.set_naming_series() @@ -22,21 +23,24 @@ class HRSettings(Document): def set_naming_series(self): from erpnext.setup.doctype.naming_series.naming_series import set_by_naming_series - set_by_naming_series("Employee", "employee_number", - self.get("emp_created_by")=="Naming Series", hide_name_field=True) + + set_by_naming_series( + "Employee", + "employee_number", + self.get("emp_created_by") == "Naming Series", + hide_name_field=True, + ) def validate_frequency_change(self): weekly_job, monthly_job = None, None try: weekly_job = frappe.get_doc( - 'Scheduled Job Type', - 'employee_reminders.send_reminders_in_advance_weekly' + "Scheduled Job Type", "employee_reminders.send_reminders_in_advance_weekly" ) monthly_job = frappe.get_doc( - 'Scheduled Job Type', - 'employee_reminders.send_reminders_in_advance_monthly' + "Scheduled Job Type", "employee_reminders.send_reminders_in_advance_monthly" ) except frappe.DoesNotExistError: return @@ -62,17 +66,20 @@ class HRSettings(Document): from_date = frappe.bold(format_date(from_date)) to_date = frappe.bold(format_date(to_date)) frappe.msgprint( - msg=frappe._('Employees will miss holiday reminders from {} until {}.
Do you want to proceed with this change?').format(from_date, to_date), - title='Confirm change in Frequency', + msg=frappe._( + "Employees will miss holiday reminders from {} until {}.
Do you want to proceed with this change?" + ).format(from_date, to_date), + title="Confirm change in Frequency", primary_action={ - 'label': frappe._('Yes, Proceed'), - 'client_action': 'erpnext.proceed_save_with_reminders_frequency_change' + "label": frappe._("Yes, Proceed"), + "client_action": "erpnext.proceed_save_with_reminders_frequency_change", }, - raise_exception=frappe.ValidationError + raise_exception=frappe.ValidationError, ) + @frappe.whitelist() def set_proceed_with_frequency_change(): - '''Enables proceed with frequency change''' + """Enables proceed with frequency change""" global PROCEED_WITH_FREQUENCY_CHANGE PROCEED_WITH_FREQUENCY_CHANGE = True diff --git a/erpnext/hr/doctype/interest/test_interest.py b/erpnext/hr/doctype/interest/test_interest.py index d4ecd9b841e..eacb57f7587 100644 --- a/erpnext/hr/doctype/interest/test_interest.py +++ b/erpnext/hr/doctype/interest/test_interest.py @@ -5,5 +5,6 @@ import unittest # test_records = frappe.get_test_records('Interest') + class TestInterest(unittest.TestCase): pass diff --git a/erpnext/hr/doctype/interview/interview.py b/erpnext/hr/doctype/interview/interview.py index f5312476a28..a1d5c0249ba 100644 --- a/erpnext/hr/doctype/interview/interview.py +++ b/erpnext/hr/doctype/interview/interview.py @@ -13,6 +13,7 @@ from frappe.utils import cstr, get_datetime, get_link_to_form class DuplicateInterviewRoundError(frappe.ValidationError): pass + class Interview(Document): def validate(self): self.validate_duplicate_interview() @@ -20,37 +21,47 @@ class Interview(Document): self.validate_overlap() def on_submit(self): - if self.status not in ['Cleared', 'Rejected']: - frappe.throw(_('Only Interviews with Cleared or Rejected status can be submitted.'), title=_('Not Allowed')) + if self.status not in ["Cleared", "Rejected"]: + frappe.throw( + _("Only Interviews with Cleared or Rejected status can be submitted."), title=_("Not Allowed") + ) def validate_duplicate_interview(self): - duplicate_interview = frappe.db.exists('Interview', { - 'job_applicant': self.job_applicant, - 'interview_round': self.interview_round, - 'docstatus': 1 - } + duplicate_interview = frappe.db.exists( + "Interview", + {"job_applicant": self.job_applicant, "interview_round": self.interview_round, "docstatus": 1}, ) if duplicate_interview: - frappe.throw(_('Job Applicants are not allowed to appear twice for the same Interview round. Interview {0} already scheduled for Job Applicant {1}').format( - frappe.bold(get_link_to_form('Interview', duplicate_interview)), - frappe.bold(self.job_applicant) - )) + frappe.throw( + _( + "Job Applicants are not allowed to appear twice for the same Interview round. Interview {0} already scheduled for Job Applicant {1}" + ).format( + frappe.bold(get_link_to_form("Interview", duplicate_interview)), + frappe.bold(self.job_applicant), + ) + ) def validate_designation(self): - applicant_designation = frappe.db.get_value('Job Applicant', self.job_applicant, 'designation') - if self.designation : + applicant_designation = frappe.db.get_value("Job Applicant", self.job_applicant, "designation") + if self.designation: if self.designation != applicant_designation: - frappe.throw(_('Interview Round {0} is only for Designation {1}. Job Applicant has applied for the role {2}').format( - self.interview_round, frappe.bold(self.designation), applicant_designation), - exc=DuplicateInterviewRoundError) + frappe.throw( + _( + "Interview Round {0} is only for Designation {1}. Job Applicant has applied for the role {2}" + ).format( + self.interview_round, frappe.bold(self.designation), applicant_designation + ), + exc=DuplicateInterviewRoundError, + ) else: self.designation = applicant_designation def validate_overlap(self): - interviewers = [entry.interviewer for entry in self.interview_details] or [''] + interviewers = [entry.interviewer for entry in self.interview_details] or [""] - overlaps = frappe.db.sql(""" + overlaps = frappe.db.sql( + """ SELECT interview.name FROM `tabInterview` as interview INNER JOIN `tabInterview Detail` as detail @@ -60,130 +71,166 @@ class Interview(Document): ((from_time < %s and to_time > %s) or (from_time > %s and to_time < %s) or (from_time = %s)) - """, (self.scheduled_on, self.name, self.job_applicant, interviewers, - self.from_time, self.to_time, self.from_time, self.to_time, self.from_time)) + """, + ( + self.scheduled_on, + self.name, + self.job_applicant, + interviewers, + self.from_time, + self.to_time, + self.from_time, + self.to_time, + self.from_time, + ), + ) if overlaps: - overlapping_details = _('Interview overlaps with {0}').format(get_link_to_form('Interview', overlaps[0][0])) - frappe.throw(overlapping_details, title=_('Overlap')) - + overlapping_details = _("Interview overlaps with {0}").format( + get_link_to_form("Interview", overlaps[0][0]) + ) + frappe.throw(overlapping_details, title=_("Overlap")) @frappe.whitelist() def reschedule_interview(self, scheduled_on, from_time, to_time): original_date = self.scheduled_on - from_time = self.from_time - to_time = self.to_time + original_from_time = self.from_time + original_to_time = self.to_time - self.db_set({ - 'scheduled_on': scheduled_on, - 'from_time': from_time, - 'to_time': to_time - }) + self.db_set({"scheduled_on": scheduled_on, "from_time": from_time, "to_time": to_time}) self.notify_update() recipients = get_recipients(self.name) try: frappe.sendmail( - recipients= recipients, - subject=_('Interview: {0} Rescheduled').format(self.name), - message=_('Your Interview session is rescheduled from {0} {1} - {2} to {3} {4} - {5}').format( - original_date, from_time, to_time, self.scheduled_on, self.from_time, self.to_time), + recipients=recipients, + subject=_("Interview: {0} Rescheduled").format(self.name), + message=_("Your Interview session is rescheduled from {0} {1} - {2} to {3} {4} - {5}").format( + original_date, + original_from_time, + original_to_time, + self.scheduled_on, + self.from_time, + self.to_time, + ), reference_doctype=self.doctype, - reference_name=self.name + reference_name=self.name, ) except Exception: - frappe.msgprint(_('Failed to send the Interview Reschedule notification. Please configure your email account.')) + frappe.msgprint( + _("Failed to send the Interview Reschedule notification. Please configure your email account.") + ) - frappe.msgprint(_('Interview Rescheduled successfully'), indicator='green') + frappe.msgprint(_("Interview Rescheduled successfully"), indicator="green") def get_recipients(name, for_feedback=0): - interview = frappe.get_doc('Interview', name) + interview = frappe.get_doc("Interview", name) if for_feedback: recipients = [d.interviewer for d in interview.interview_details if not d.interview_feedback] else: recipients = [d.interviewer for d in interview.interview_details] - recipients.append(frappe.db.get_value('Job Applicant', interview.job_applicant, 'email_id')) + recipients.append(frappe.db.get_value("Job Applicant", interview.job_applicant, "email_id")) return recipients @frappe.whitelist() def get_interviewers(interview_round): - return frappe.get_all('Interviewer', filters={'parent': interview_round}, fields=['user as interviewer']) + return frappe.get_all( + "Interviewer", filters={"parent": interview_round}, fields=["user as interviewer"] + ) def send_interview_reminder(): - reminder_settings = frappe.db.get_value('HR Settings', 'HR Settings', - ['send_interview_reminder', 'interview_reminder_template'], as_dict=True) + reminder_settings = frappe.db.get_value( + "HR Settings", + "HR Settings", + ["send_interview_reminder", "interview_reminder_template"], + as_dict=True, + ) if not reminder_settings.send_interview_reminder: return - remind_before = cstr(frappe.db.get_single_value('HR Settings', 'remind_before')) or '01:00:00' - remind_before = datetime.datetime.strptime(remind_before, '%H:%M:%S') + remind_before = cstr(frappe.db.get_single_value("HR Settings", "remind_before")) or "01:00:00" + remind_before = datetime.datetime.strptime(remind_before, "%H:%M:%S") reminder_date_time = datetime.datetime.now() + datetime.timedelta( - hours=remind_before.hour, minutes=remind_before.minute, seconds=remind_before.second) + hours=remind_before.hour, minutes=remind_before.minute, seconds=remind_before.second + ) - interviews = frappe.get_all('Interview', filters={ - 'scheduled_on': ['between', (datetime.datetime.now(), reminder_date_time)], - 'status': 'Pending', - 'reminded': 0, - 'docstatus': ['!=', 2] - }) + interviews = frappe.get_all( + "Interview", + filters={ + "scheduled_on": ["between", (datetime.datetime.now(), reminder_date_time)], + "status": "Pending", + "reminded": 0, + "docstatus": ["!=", 2], + }, + ) - interview_template = frappe.get_doc('Email Template', reminder_settings.interview_reminder_template) + interview_template = frappe.get_doc( + "Email Template", reminder_settings.interview_reminder_template + ) for d in interviews: - doc = frappe.get_doc('Interview', d.name) + doc = frappe.get_doc("Interview", d.name) context = doc.as_dict() message = frappe.render_template(interview_template.response, context) recipients = get_recipients(doc.name) frappe.sendmail( - recipients= recipients, + recipients=recipients, subject=interview_template.subject, message=message, reference_doctype=doc.doctype, - reference_name=doc.name + reference_name=doc.name, ) - doc.db_set('reminded', 1) + doc.db_set("reminded", 1) def send_daily_feedback_reminder(): - reminder_settings = frappe.db.get_value('HR Settings', 'HR Settings', - ['send_interview_feedback_reminder', 'feedback_reminder_notification_template'], as_dict=True) + reminder_settings = frappe.db.get_value( + "HR Settings", + "HR Settings", + ["send_interview_feedback_reminder", "feedback_reminder_notification_template"], + as_dict=True, + ) if not reminder_settings.send_interview_feedback_reminder: return - interview_feedback_template = frappe.get_doc('Email Template', reminder_settings.feedback_reminder_notification_template) - interviews = frappe.get_all('Interview', filters={'status': ['in', ['Under Review', 'Pending']], 'docstatus': ['!=', 2]}) + interview_feedback_template = frappe.get_doc( + "Email Template", reminder_settings.feedback_reminder_notification_template + ) + interviews = frappe.get_all( + "Interview", filters={"status": ["in", ["Under Review", "Pending"]], "docstatus": ["!=", 2]} + ) for entry in interviews: recipients = get_recipients(entry.name, for_feedback=1) - doc = frappe.get_doc('Interview', entry.name) + doc = frappe.get_doc("Interview", entry.name) context = doc.as_dict() message = frappe.render_template(interview_feedback_template.response, context) if len(recipients): frappe.sendmail( - recipients= recipients, + recipients=recipients, subject=interview_feedback_template.subject, message=message, - reference_doctype='Interview', - reference_name=entry.name + reference_doctype="Interview", + reference_name=entry.name, ) @frappe.whitelist() def get_expected_skill_set(interview_round): - return frappe.get_all('Expected Skill Set', filters ={'parent': interview_round}, fields=['skill']) + return frappe.get_all("Expected Skill Set", filters={"parent": interview_round}, fields=["skill"]) @frappe.whitelist() @@ -196,16 +243,16 @@ def create_interview_feedback(data, interview_name, interviewer, job_applicant): data = frappe._dict(json.loads(data)) if frappe.session.user != interviewer: - frappe.throw(_('Only Interviewer Are allowed to submit Interview Feedback')) + frappe.throw(_("Only Interviewer Are allowed to submit Interview Feedback")) - interview_feedback = frappe.new_doc('Interview Feedback') + interview_feedback = frappe.new_doc("Interview Feedback") interview_feedback.interview = interview_name interview_feedback.interviewer = interviewer interview_feedback.job_applicant = job_applicant for d in data.skill_set: d = frappe._dict(d) - interview_feedback.append('skill_assessment', {'skill': d.skill, 'rating': d.rating}) + interview_feedback.append("skill_assessment", {"skill": d.skill, "rating": d.rating}) interview_feedback.feedback = data.feedback interview_feedback.result = data.result @@ -213,24 +260,33 @@ def create_interview_feedback(data, interview_name, interviewer, job_applicant): interview_feedback.save() interview_feedback.submit() - frappe.msgprint(_('Interview Feedback {0} submitted successfully').format( - get_link_to_form('Interview Feedback', interview_feedback.name))) + frappe.msgprint( + _("Interview Feedback {0} submitted successfully").format( + get_link_to_form("Interview Feedback", interview_feedback.name) + ) + ) @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_interviewer_list(doctype, txt, searchfield, start, page_len, filters): filters = [ - ['Has Role', 'parent', 'like', '%{}%'.format(txt)], - ['Has Role', 'role', '=', 'interviewer'], - ['Has Role', 'parenttype', '=', 'User'] + ["Has Role", "parent", "like", "%{}%".format(txt)], + ["Has Role", "role", "=", "interviewer"], + ["Has Role", "parenttype", "=", "User"], ] if filters and isinstance(filters, list): filters.extend(filters) - return frappe.get_all('Has Role', limit_start=start, limit_page_length=page_len, - filters=filters, fields = ['parent'], as_list=1) + return frappe.get_all( + "Has Role", + limit_start=start, + limit_page_length=page_len, + filters=filters, + fields=["parent"], + as_list=1, + ) @frappe.whitelist() @@ -249,12 +305,13 @@ def get_events(start, end, filters=None): "Pending": "#fff4f0", "Under Review": "#d3e8fc", "Cleared": "#eaf5ed", - "Rejected": "#fce7e7" + "Rejected": "#fce7e7", } - conditions = get_event_conditions('Interview', filters) + conditions = get_event_conditions("Interview", filters) - interviews = frappe.db.sql(""" + interviews = frappe.db.sql( + """ SELECT DISTINCT `tabInterview`.name, `tabInterview`.job_applicant, `tabInterview`.interview_round, `tabInterview`.scheduled_on, `tabInterview`.status, `tabInterview`.from_time as from_time, @@ -265,10 +322,13 @@ def get_events(start, end, filters=None): (`tabInterview`.scheduled_on between %(start)s and %(end)s) and docstatus != 2 {conditions} - """.format(conditions=conditions), { - "start": start, - "end": end - }, as_dict=True, update={"allDay": 0}) + """.format( + conditions=conditions + ), + {"start": start, "end": end}, + as_dict=True, + update={"allDay": 0}, + ) for d in interviews: subject_data = [] @@ -279,13 +339,13 @@ def get_events(start, end, filters=None): color = event_color.get(d.status) interview_data = { - 'from': get_datetime('%s %s' % (d.scheduled_on, d.from_time or '00:00:00')), - 'to': get_datetime('%s %s' % (d.scheduled_on, d.to_time or '00:00:00')), - 'name': d.name, - 'subject': '\n'.join(subject_data), - 'color': color if color else "#89bcde" + "from": get_datetime("%s %s" % (d.scheduled_on, d.from_time or "00:00:00")), + "to": get_datetime("%s %s" % (d.scheduled_on, d.to_time or "00:00:00")), + "name": d.name, + "subject": "\n".join(subject_data), + "color": color if color else "#89bcde", } events.append(interview_data) - return events \ No newline at end of file + return events diff --git a/erpnext/hr/doctype/interview/test_interview.py b/erpnext/hr/doctype/interview/test_interview.py index 1a2257a6d90..1062003dd8c 100644 --- a/erpnext/hr/doctype/interview/test_interview.py +++ b/erpnext/hr/doctype/interview/test_interview.py @@ -8,7 +8,7 @@ import unittest import frappe from frappe import _ from frappe.core.doctype.user_permission.test_user_permission import create_user -from frappe.utils import add_days, getdate, nowtime +from frappe.utils import add_days, get_time, getdate, nowtime from erpnext.hr.doctype.designation.test_designation import create_designation from erpnext.hr.doctype.interview.interview import DuplicateInterviewRoundError @@ -18,23 +18,35 @@ from erpnext.hr.doctype.job_applicant.test_job_applicant import create_job_appli class TestInterview(unittest.TestCase): def test_validations_for_designation(self): job_applicant = create_job_applicant() - interview = create_interview_and_dependencies(job_applicant.name, designation='_Test_Sales_manager', save=0) + interview = create_interview_and_dependencies( + job_applicant.name, designation="_Test_Sales_manager", save=0 + ) self.assertRaises(DuplicateInterviewRoundError, interview.save) def test_notification_on_rescheduling(self): job_applicant = create_job_applicant() - interview = create_interview_and_dependencies(job_applicant.name, scheduled_on=add_days(getdate(), -4)) + interview = create_interview_and_dependencies( + job_applicant.name, + scheduled_on=add_days(getdate(), -4), + from_time="10:00:00", + to_time="11:00:00", + ) previous_scheduled_date = interview.scheduled_on frappe.db.sql("DELETE FROM `tabEmail Queue`") - interview.reschedule_interview(add_days(getdate(previous_scheduled_date), 2), - from_time=nowtime(), to_time=nowtime()) + interview.reschedule_interview( + add_days(getdate(previous_scheduled_date), 2), from_time="11:00:00", to_time="12:00:00" + ) interview.reload() self.assertEqual(interview.scheduled_on, add_days(getdate(previous_scheduled_date), 2)) + self.assertEqual(get_time(interview.from_time), get_time("11:00:00")) + self.assertEqual(get_time(interview.to_time), get_time("12:00:00")) - notification = frappe.get_all("Email Queue", filters={"message": ("like", "%Your Interview session is rescheduled from%")}) + notification = frappe.get_all( + "Email Queue", filters={"message": ("like", "%Your Interview session is rescheduled from%")} + ) self.assertIsNotNone(notification) def test_notification_for_scheduling(self): @@ -74,16 +86,17 @@ class TestInterview(unittest.TestCase): frappe.db.rollback() -def create_interview_and_dependencies(job_applicant, scheduled_on=None, from_time=None, to_time=None, designation=None, save=1): +def create_interview_and_dependencies( + job_applicant, scheduled_on=None, from_time=None, to_time=None, designation=None, save=1 +): if designation: - designation=create_designation(designation_name = "_Test_Sales_manager").name + designation = create_designation(designation_name="_Test_Sales_manager").name interviewer_1 = create_user("test_interviewer1@example.com", "Interviewer") interviewer_2 = create_user("test_interviewer2@example.com", "Interviewer") interview_round = create_interview_round( - "Technical Round", ["Python", "JS"], - designation=designation, save=True + "Technical Round", ["Python", "JS"], designation=designation, save=True ) interview = frappe.new_doc("Interview") @@ -101,6 +114,7 @@ def create_interview_and_dependencies(job_applicant, scheduled_on=None, from_tim return interview + def create_interview_round(name, skill_set, interviewers=[], designation=None, save=True): create_skill_set(skill_set) interview_round = frappe.new_doc("Interview Round") @@ -114,15 +128,14 @@ def create_interview_round(name, skill_set, interviewers=[], designation=None, s interview_round.append("expected_skill_set", {"skill": skill}) for interviewer in interviewers: - interview_round.append("interviewer", { - "user": interviewer - }) + interview_round.append("interviewer", {"user": interviewer}) if save: interview_round.save() return interview_round + def create_skill_set(skill_set): for skill in skill_set: if not frappe.db.exists("Skill", skill): @@ -130,6 +143,7 @@ def create_skill_set(skill_set): doc.skill_name = skill doc.save() + def create_interview_type(name="test_interview_type"): if frappe.db.exists("Interview Type", name): return frappe.get_doc("Interview Type", name).name @@ -141,32 +155,41 @@ def create_interview_type(name="test_interview_type"): return doc.name + def setup_reminder_settings(): - if not frappe.db.exists('Email Template', _('Interview Reminder')): - base_path = frappe.get_app_path('erpnext', 'hr', 'doctype') - response = frappe.read_file(os.path.join(base_path, 'interview/interview_reminder_notification_template.html')) + if not frappe.db.exists("Email Template", _("Interview Reminder")): + base_path = frappe.get_app_path("erpnext", "hr", "doctype") + response = frappe.read_file( + os.path.join(base_path, "interview/interview_reminder_notification_template.html") + ) - frappe.get_doc({ - 'doctype': 'Email Template', - 'name': _('Interview Reminder'), - 'response': response, - 'subject': _('Interview Reminder'), - 'owner': frappe.session.user, - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Email Template", + "name": _("Interview Reminder"), + "response": response, + "subject": _("Interview Reminder"), + "owner": frappe.session.user, + } + ).insert(ignore_permissions=True) - if not frappe.db.exists('Email Template', _('Interview Feedback Reminder')): - base_path = frappe.get_app_path('erpnext', 'hr', 'doctype') - response = frappe.read_file(os.path.join(base_path, 'interview/interview_feedback_reminder_template.html')) + if not frappe.db.exists("Email Template", _("Interview Feedback Reminder")): + base_path = frappe.get_app_path("erpnext", "hr", "doctype") + response = frappe.read_file( + os.path.join(base_path, "interview/interview_feedback_reminder_template.html") + ) - frappe.get_doc({ - 'doctype': 'Email Template', - 'name': _('Interview Feedback Reminder'), - 'response': response, - 'subject': _('Interview Feedback Reminder'), - 'owner': frappe.session.user, - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Email Template", + "name": _("Interview Feedback Reminder"), + "response": response, + "subject": _("Interview Feedback Reminder"), + "owner": frappe.session.user, + } + ).insert(ignore_permissions=True) - hr_settings = frappe.get_doc('HR Settings') - hr_settings.interview_reminder_template = _('Interview Reminder') - hr_settings.feedback_reminder_notification_template = _('Interview Feedback Reminder') + hr_settings = frappe.get_doc("HR Settings") + hr_settings.interview_reminder_template = _("Interview Reminder") + hr_settings.feedback_reminder_notification_template = _("Interview Feedback Reminder") hr_settings.save() diff --git a/erpnext/hr/doctype/interview_feedback/interview_feedback.py b/erpnext/hr/doctype/interview_feedback/interview_feedback.py index d046458f196..b8f8aee524d 100644 --- a/erpnext/hr/doctype/interview_feedback/interview_feedback.py +++ b/erpnext/hr/doctype/interview_feedback/interview_feedback.py @@ -24,28 +24,36 @@ class InterviewFeedback(Document): def validate_interviewer(self): applicable_interviewers = get_applicable_interviewers(self.interview) if self.interviewer not in applicable_interviewers: - frappe.throw(_('{0} is not allowed to submit Interview Feedback for the Interview: {1}').format( - frappe.bold(self.interviewer), frappe.bold(self.interview))) + frappe.throw( + _("{0} is not allowed to submit Interview Feedback for the Interview: {1}").format( + frappe.bold(self.interviewer), frappe.bold(self.interview) + ) + ) def validate_interview_date(self): - scheduled_date = frappe.db.get_value('Interview', self.interview, 'scheduled_on') + scheduled_date = frappe.db.get_value("Interview", self.interview, "scheduled_on") if getdate() < getdate(scheduled_date) and self.docstatus == 1: - frappe.throw(_('{0} submission before {1} is not allowed').format( - frappe.bold('Interview Feedback'), - frappe.bold('Interview Scheduled Date') - )) + frappe.throw( + _("{0} submission before {1} is not allowed").format( + frappe.bold("Interview Feedback"), frappe.bold("Interview Scheduled Date") + ) + ) def validate_duplicate(self): - duplicate_feedback = frappe.db.exists('Interview Feedback', { - 'interviewer': self.interviewer, - 'interview': self.interview, - 'docstatus': 1 - }) + duplicate_feedback = frappe.db.exists( + "Interview Feedback", + {"interviewer": self.interviewer, "interview": self.interview, "docstatus": 1}, + ) if duplicate_feedback: - frappe.throw(_('Feedback already submitted for the Interview {0}. Please cancel the previous Interview Feedback {1} to continue.').format( - self.interview, get_link_to_form('Interview Feedback', duplicate_feedback))) + frappe.throw( + _( + "Feedback already submitted for the Interview {0}. Please cancel the previous Interview Feedback {1} to continue." + ).format( + self.interview, get_link_to_form("Interview Feedback", duplicate_feedback) + ) + ) def calculate_average_rating(self): total_rating = 0 @@ -53,10 +61,12 @@ class InterviewFeedback(Document): if d.rating: total_rating += d.rating - self.average_rating = flt(total_rating / len(self.skill_assessment) if len(self.skill_assessment) else 0) + self.average_rating = flt( + total_rating / len(self.skill_assessment) if len(self.skill_assessment) else 0 + ) def update_interview_details(self): - doc = frappe.get_doc('Interview', self.interview) + doc = frappe.get_doc("Interview", self.interview) total_rating = 0 if self.docstatus == 2: @@ -75,12 +85,14 @@ class InterviewFeedback(Document): if entry.average_rating: total_rating += entry.average_rating - doc.average_rating = flt(total_rating / len(doc.interview_details) if len(doc.interview_details) else 0) + doc.average_rating = flt( + total_rating / len(doc.interview_details) if len(doc.interview_details) else 0 + ) doc.save() doc.notify_update() @frappe.whitelist() def get_applicable_interviewers(interview): - data = frappe.get_all('Interview Detail', filters={'parent': interview}, fields=['interviewer']) + data = frappe.get_all("Interview Detail", filters={"parent": interview}, fields=["interviewer"]) return [d.interviewer for d in data] diff --git a/erpnext/hr/doctype/interview_feedback/test_interview_feedback.py b/erpnext/hr/doctype/interview_feedback/test_interview_feedback.py index 4185f2827a5..0c408b4d35d 100644 --- a/erpnext/hr/doctype/interview_feedback/test_interview_feedback.py +++ b/erpnext/hr/doctype/interview_feedback/test_interview_feedback.py @@ -17,14 +17,16 @@ class TestInterviewFeedback(unittest.TestCase): def test_validation_for_skill_set(self): frappe.set_user("Administrator") job_applicant = create_job_applicant() - interview = create_interview_and_dependencies(job_applicant.name, scheduled_on=add_days(getdate(), -1)) + interview = create_interview_and_dependencies( + job_applicant.name, scheduled_on=add_days(getdate(), -1) + ) skill_ratings = get_skills_rating(interview.interview_round) interviewer = interview.interview_details[0].interviewer - create_skill_set(['Leadership']) + create_skill_set(["Leadership"]) interview_feedback = create_interview_feedback(interview.name, interviewer, skill_ratings) - interview_feedback.append("skill_assessment", {"skill": 'Leadership', 'rating': 4}) + interview_feedback.append("skill_assessment", {"skill": "Leadership", "rating": 4}) frappe.set_user(interviewer) self.assertRaises(frappe.ValidationError, interview_feedback.save) @@ -33,7 +35,9 @@ class TestInterviewFeedback(unittest.TestCase): def test_average_ratings_on_feedback_submission_and_cancellation(self): job_applicant = create_job_applicant() - interview = create_interview_and_dependencies(job_applicant.name, scheduled_on=add_days(getdate(), -1)) + interview = create_interview_and_dependencies( + job_applicant.name, scheduled_on=add_days(getdate(), -1) + ) skill_ratings = get_skills_rating(interview.interview_round) # For First Interviewer Feedback @@ -48,20 +52,26 @@ class TestInterviewFeedback(unittest.TestCase): if d.rating: total_rating += d.rating - avg_rating = flt(total_rating / len(feedback_1.skill_assessment) if len(feedback_1.skill_assessment) else 0) + avg_rating = flt( + total_rating / len(feedback_1.skill_assessment) if len(feedback_1.skill_assessment) else 0 + ) self.assertEqual(flt(avg_rating, 3), feedback_1.average_rating) - avg_on_interview_detail = frappe.db.get_value('Interview Detail', { - 'parent': feedback_1.interview, - 'interviewer': feedback_1.interviewer, - 'interview_feedback': feedback_1.name - }, 'average_rating') + avg_on_interview_detail = frappe.db.get_value( + "Interview Detail", + { + "parent": feedback_1.interview, + "interviewer": feedback_1.interviewer, + "interview_feedback": feedback_1.name, + }, + "average_rating", + ) # 1. average should be reflected in Interview Detail. self.assertEqual(avg_on_interview_detail, round(feedback_1.average_rating)) - '''For Second Interviewer Feedback''' + """For Second Interviewer Feedback""" interviewer = interview.interview_details[1].interviewer frappe.set_user(interviewer) @@ -95,7 +105,9 @@ def create_interview_feedback(interview, interviewer, skills_ratings): def get_skills_rating(interview_round): import random - skills = frappe.get_all("Expected Skill Set", filters={"parent": interview_round}, fields = ["skill"]) + skills = frappe.get_all( + "Expected Skill Set", filters={"parent": interview_round}, fields=["skill"] + ) for d in skills: d["rating"] = random.randint(1, 5) return skills diff --git a/erpnext/hr/doctype/interview_round/interview_round.py b/erpnext/hr/doctype/interview_round/interview_round.py index 0f442c320ad..83dbf0ea98e 100644 --- a/erpnext/hr/doctype/interview_round/interview_round.py +++ b/erpnext/hr/doctype/interview_round/interview_round.py @@ -11,6 +11,7 @@ from frappe.model.document import Document class InterviewRound(Document): pass + @frappe.whitelist() def create_interview(doc): if isinstance(doc, str): @@ -24,10 +25,5 @@ def create_interview(doc): if doc.interviewers: interview.interview_details = [] for data in doc.interviewers: - interview.append("interview_details", { - "interviewer": data.user - }) + interview.append("interview_details", {"interviewer": data.user}) return interview - - - diff --git a/erpnext/hr/doctype/interview_round/test_interview_round.py b/erpnext/hr/doctype/interview_round/test_interview_round.py index dcec9419c07..95681653743 100644 --- a/erpnext/hr/doctype/interview_round/test_interview_round.py +++ b/erpnext/hr/doctype/interview_round/test_interview_round.py @@ -8,4 +8,3 @@ import unittest class TestInterviewRound(unittest.TestCase): pass - diff --git a/erpnext/hr/doctype/job_applicant/job_applicant.json b/erpnext/hr/doctype/job_applicant/job_applicant.json index 200f675221b..66b609cf990 100644 --- a/erpnext/hr/doctype/job_applicant/job_applicant.json +++ b/erpnext/hr/doctype/job_applicant/job_applicant.json @@ -192,10 +192,11 @@ "idx": 1, "index_web_pages_for_search": 1, "links": [], - "modified": "2021-09-29 23:06:10.904260", + "modified": "2022-01-12 16:28:53.196881", "modified_by": "Administrator", "module": "HR", "name": "Job Applicant", + "naming_rule": "Expression (old style)", "owner": "Administrator", "permissions": [ { @@ -210,10 +211,11 @@ "write": 1 } ], - "search_fields": "applicant_name", + "search_fields": "applicant_name, email_id, job_title, phone_number", "sender_field": "email_id", "sort_field": "modified", "sort_order": "ASC", + "states": [], "subject_field": "notes", "title_field": "applicant_name" } \ No newline at end of file diff --git a/erpnext/hr/doctype/job_applicant/job_applicant.py b/erpnext/hr/doctype/job_applicant/job_applicant.py index f0b470b35e8..14ebca432e5 100644 --- a/erpnext/hr/doctype/job_applicant/job_applicant.py +++ b/erpnext/hr/doctype/job_applicant/job_applicant.py @@ -7,12 +7,15 @@ import frappe from frappe import _ from frappe.model.document import Document +from frappe.model.naming import append_number_if_name_exists from frappe.utils import validate_email_address from erpnext.hr.doctype.interview.interview import get_interviewers -class DuplicationError(frappe.ValidationError): pass +class DuplicationError(frappe.ValidationError): + pass + class JobApplicant(Document): def onload(self): @@ -21,10 +24,11 @@ class JobApplicant(Document): self.get("__onload").job_offer = job_offer[0].name def autoname(self): - keys = filter(None, (self.applicant_name, self.email_id, self.job_title)) - if not keys: - frappe.throw(_("Name or Email is mandatory"), frappe.NameError) - self.name = " - ".join(keys) + self.name = self.email_id + + # applicant can apply more than once for a different job title or reapply + if frappe.db.exists("Job Applicant", self.name): + self.name = append_number_if_name_exists("Job Applicant", self.name) def validate(self): if self.email_id: @@ -34,8 +38,8 @@ class JobApplicant(Document): self.set_status_for_employee_referral() if not self.applicant_name and self.email_id: - guess = self.email_id.split('@')[0] - self.applicant_name = ' '.join([p.capitalize() for p in guess.split('.')]) + guess = self.email_id.split("@")[0] + self.applicant_name = " ".join([p.capitalize() for p in guess.split(".")]) def set_status_for_employee_referral(self): emp_ref = frappe.get_doc("Employee Referral", self.employee_referral) @@ -44,6 +48,7 @@ class JobApplicant(Document): elif self.status in ["Accepted", "Rejected"]: emp_ref.db_set("status", self.status) + @frappe.whitelist() def create_interview(doc, interview_round): import json @@ -57,7 +62,11 @@ def create_interview(doc, interview_round): round_designation = frappe.db.get_value("Interview Round", interview_round, "designation") if round_designation and doc.designation and round_designation != doc.designation: - frappe.throw(_("Interview Round {0} is only applicable for the Designation {1}").format(interview_round, round_designation)) + frappe.throw( + _("Interview Round {0} is only applicable for the Designation {1}").format( + interview_round, round_designation + ) + ) interview = frappe.new_doc("Interview") interview.interview_round = interview_round @@ -68,16 +77,16 @@ def create_interview(doc, interview_round): interviewer_detail = get_interviewers(interview_round) for d in interviewer_detail: - interview.append("interview_details", { - "interviewer": d.interviewer - }) + interview.append("interview_details", {"interviewer": d.interviewer}) return interview + @frappe.whitelist() def get_interview_details(job_applicant): - interview_details = frappe.db.get_all("Interview", - filters={"job_applicant":job_applicant, "docstatus": ["!=", 2]}, - fields=["name", "interview_round", "expected_average_rating", "average_rating", "status"] + interview_details = frappe.db.get_all( + "Interview", + filters={"job_applicant": job_applicant, "docstatus": ["!=", 2]}, + fields=["name", "interview_round", "expected_average_rating", "average_rating", "status"], ) interview_detail_map = {} diff --git a/erpnext/hr/doctype/job_applicant/job_applicant_dashboard.py b/erpnext/hr/doctype/job_applicant/job_applicant_dashboard.py index 9406fc54855..14b944ac614 100644 --- a/erpnext/hr/doctype/job_applicant/job_applicant_dashboard.py +++ b/erpnext/hr/doctype/job_applicant/job_applicant_dashboard.py @@ -1,17 +1,9 @@ - - def get_data(): return { - 'fieldname': 'job_applicant', - 'transactions': [ - { - 'items': ['Employee', 'Employee Onboarding'] - }, - { - 'items': ['Job Offer', 'Appointment Letter'] - }, - { - 'items': ['Interview'] - } + "fieldname": "job_applicant", + "transactions": [ + {"items": ["Employee", "Employee Onboarding"]}, + {"items": ["Job Offer", "Appointment Letter"]}, + {"items": ["Interview"]}, ], } diff --git a/erpnext/hr/doctype/job_applicant/test_job_applicant.py b/erpnext/hr/doctype/job_applicant/test_job_applicant.py index 36dcf6b0740..99d11619781 100644 --- a/erpnext/hr/doctype/job_applicant/test_job_applicant.py +++ b/erpnext/hr/doctype/job_applicant/test_job_applicant.py @@ -9,7 +9,30 @@ from erpnext.hr.doctype.designation.test_designation import create_designation class TestJobApplicant(unittest.TestCase): - pass + def test_job_applicant_naming(self): + applicant = frappe.get_doc( + { + "doctype": "Job Applicant", + "status": "Open", + "applicant_name": "_Test Applicant", + "email_id": "job_applicant_naming@example.com", + } + ).insert() + self.assertEqual(applicant.name, "job_applicant_naming@example.com") + + applicant = frappe.get_doc( + { + "doctype": "Job Applicant", + "status": "Open", + "applicant_name": "_Test Applicant", + "email_id": "job_applicant_naming@example.com", + } + ).insert() + self.assertEqual(applicant.name, "job_applicant_naming@example.com-1") + + def tearDown(self): + frappe.db.rollback() + def create_job_applicant(**args): args = frappe._dict(args) @@ -22,11 +45,13 @@ def create_job_applicant(**args): if frappe.db.exists("Job Applicant", filters): return frappe.get_doc("Job Applicant", filters) - job_applicant = frappe.get_doc({ - "doctype": "Job Applicant", - "status": args.status or "Open", - "designation": create_designation().name - }) + job_applicant = frappe.get_doc( + { + "doctype": "Job Applicant", + "status": args.status or "Open", + "designation": create_designation().name, + } + ) job_applicant.update(filters) job_applicant.save() diff --git a/erpnext/hr/doctype/job_offer/job_offer.py b/erpnext/hr/doctype/job_offer/job_offer.py index 39f471929b4..dc76a2d0038 100644 --- a/erpnext/hr/doctype/job_offer/job_offer.py +++ b/erpnext/hr/doctype/job_offer/job_offer.py @@ -17,9 +17,15 @@ class JobOffer(Document): def validate(self): self.validate_vacancies() - job_offer = frappe.db.exists("Job Offer",{"job_applicant": self.job_applicant, "docstatus": ["!=", 2]}) + job_offer = frappe.db.exists( + "Job Offer", {"job_applicant": self.job_applicant, "docstatus": ["!=", 2]} + ) if job_offer and job_offer != self.name: - frappe.throw(_("Job Offer: {0} is already for Job Applicant: {1}").format(frappe.bold(job_offer), frappe.bold(self.job_applicant))) + frappe.throw( + _("Job Offer: {0} is already for Job Applicant: {1}").format( + frappe.bold(job_offer), frappe.bold(self.job_applicant) + ) + ) def validate_vacancies(self): staffing_plan = get_staffing_plan_detail(self.designation, self.company, self.offer_date) @@ -27,7 +33,7 @@ class JobOffer(Document): if staffing_plan and check_vacancies: job_offers = self.get_job_offer(staffing_plan.from_date, staffing_plan.to_date) if not staffing_plan.get("vacancies") or cint(staffing_plan.vacancies) - len(job_offers) <= 0: - error_variable = 'for ' + frappe.bold(self.designation) + error_variable = "for " + frappe.bold(self.designation) if staffing_plan.get("parent"): error_variable = frappe.bold(get_link_to_form("Staffing Plan", staffing_plan.parent)) @@ -37,20 +43,27 @@ class JobOffer(Document): update_job_applicant(self.status, self.job_applicant) def get_job_offer(self, from_date, to_date): - ''' Returns job offer created during a time period ''' - return frappe.get_all("Job Offer", filters={ - "offer_date": ['between', (from_date, to_date)], + """Returns job offer created during a time period""" + return frappe.get_all( + "Job Offer", + filters={ + "offer_date": ["between", (from_date, to_date)], "designation": self.designation, "company": self.company, - "docstatus": 1 - }, fields=['name']) + "docstatus": 1, + }, + fields=["name"], + ) + def update_job_applicant(status, job_applicant): if status in ("Accepted", "Rejected"): frappe.set_value("Job Applicant", job_applicant, "status", status) + def get_staffing_plan_detail(designation, company, offer_date): - detail = frappe.db.sql(""" + detail = frappe.db.sql( + """ SELECT DISTINCT spd.parent, sp.from_date as from_date, sp.to_date as to_date, @@ -64,20 +77,33 @@ def get_staffing_plan_detail(designation, company, offer_date): AND sp.company=%s AND spd.parent = sp.name AND %s between sp.from_date and sp.to_date - """, (designation, company, offer_date), as_dict=1) + """, + (designation, company, offer_date), + as_dict=1, + ) return frappe._dict(detail[0]) if (detail and detail[0].parent) else None + @frappe.whitelist() def make_employee(source_name, target_doc=None): def set_missing_values(source, target): - target.personal_email, target.first_name = frappe.db.get_value("Job Applicant", \ - source.job_applicant, ["email_id", "applicant_name"]) - doc = get_mapped_doc("Job Offer", source_name, { + target.personal_email, target.first_name = frappe.db.get_value( + "Job Applicant", source.job_applicant, ["email_id", "applicant_name"] + ) + + doc = get_mapped_doc( + "Job Offer", + source_name, + { "Job Offer": { "doctype": "Employee", "field_map": { "applicant_name": "employee_name", - }} - }, target_doc, set_missing_values) + }, + } + }, + target_doc, + set_missing_values, + ) return doc diff --git a/erpnext/hr/doctype/job_offer/test_job_offer.py b/erpnext/hr/doctype/job_offer/test_job_offer.py index d94e03ca63f..7d8ef115d16 100644 --- a/erpnext/hr/doctype/job_offer/test_job_offer.py +++ b/erpnext/hr/doctype/job_offer/test_job_offer.py @@ -12,17 +12,19 @@ from erpnext.hr.doctype.staffing_plan.test_staffing_plan import make_company # test_records = frappe.get_test_records('Job Offer') + class TestJobOffer(unittest.TestCase): def test_job_offer_creation_against_vacancies(self): frappe.db.set_value("HR Settings", None, "check_vacancies", 1) job_applicant = create_job_applicant(email_id="test_job_offer@example.com") job_offer = create_job_offer(job_applicant=job_applicant.name, designation="UX Designer") - create_staffing_plan(name='Test No Vacancies', staffing_details=[{ - "designation": "UX Designer", - "vacancies": 0, - "estimated_cost_per_position": 5000 - }]) + create_staffing_plan( + name="Test No Vacancies", + staffing_details=[ + {"designation": "UX Designer", "vacancies": 0, "estimated_cost_per_position": 5000} + ], + ) self.assertRaises(frappe.ValidationError, job_offer.submit) # test creation of job offer when vacancies are not present @@ -49,6 +51,7 @@ class TestJobOffer(unittest.TestCase): def tearDown(self): frappe.db.sql("DELETE FROM `tabJob Offer` WHERE 1") + def create_job_offer(**args): args = frappe._dict(args) if not args.job_applicant: @@ -57,32 +60,34 @@ def create_job_offer(**args): if not frappe.db.exists("Designation", args.designation): designation = create_designation(designation_name=args.designation) - job_offer = frappe.get_doc({ - "doctype": "Job Offer", - "job_applicant": args.job_applicant or job_applicant.name, - "offer_date": args.offer_date or nowdate(), - "designation": args.designation or "Researcher", - "status": args.status or "Accepted" - }) + job_offer = frappe.get_doc( + { + "doctype": "Job Offer", + "job_applicant": args.job_applicant or job_applicant.name, + "offer_date": args.offer_date or nowdate(), + "designation": args.designation or "Researcher", + "status": args.status or "Accepted", + } + ) return job_offer + def create_staffing_plan(**args): args = frappe._dict(args) make_company() frappe.db.set_value("Company", "_Test Company", "is_group", 1) if frappe.db.exists("Staffing Plan", args.name or "Test"): return - staffing_plan = frappe.get_doc({ - "doctype": "Staffing Plan", - "name": args.name or "Test", - "from_date": args.from_date or nowdate(), - "to_date": args.to_date or add_days(nowdate(), 10), - "staffing_details": args.staffing_details or [{ - "designation": "Researcher", - "vacancies": 1, - "estimated_cost_per_position": 50000 - }] - }) + staffing_plan = frappe.get_doc( + { + "doctype": "Staffing Plan", + "name": args.name or "Test", + "from_date": args.from_date or nowdate(), + "to_date": args.to_date or add_days(nowdate(), 10), + "staffing_details": args.staffing_details + or [{"designation": "Researcher", "vacancies": 1, "estimated_cost_per_position": 50000}], + } + ) staffing_plan.insert() staffing_plan.submit() return staffing_plan diff --git a/erpnext/hr/doctype/job_opening/job_opening.py b/erpnext/hr/doctype/job_opening/job_opening.py index d53daf17d87..ce7caa33c68 100644 --- a/erpnext/hr/doctype/job_opening/job_opening.py +++ b/erpnext/hr/doctype/job_opening/job_opening.py @@ -6,6 +6,7 @@ import frappe from frappe import _ +from frappe.utils import get_link_to_form from frappe.website.website_generator import WebsiteGenerator from erpnext.hr.doctype.staffing_plan.staffing_plan import ( @@ -16,67 +17,84 @@ from erpnext.hr.doctype.staffing_plan.staffing_plan import ( class JobOpening(WebsiteGenerator): website = frappe._dict( - template = "templates/generators/job_opening.html", - condition_field = "publish", - page_title_field = "job_title", + template="templates/generators/job_opening.html", + condition_field="publish", + page_title_field="job_title", ) def validate(self): if not self.route: - self.route = frappe.scrub(self.job_title).replace('_', '-') + self.route = frappe.scrub(self.job_title).replace("_", "-") self.validate_current_vacancies() def validate_current_vacancies(self): if not self.staffing_plan: - staffing_plan = get_active_staffing_plan_details(self.company, - self.designation) + staffing_plan = get_active_staffing_plan_details(self.company, self.designation) if staffing_plan: self.staffing_plan = staffing_plan[0].name self.planned_vacancies = staffing_plan[0].vacancies elif not self.planned_vacancies: - planned_vacancies = frappe.db.sql(""" - select vacancies from `tabStaffing Plan Detail` - where parent=%s and designation=%s""", (self.staffing_plan, self.designation)) - self.planned_vacancies = planned_vacancies[0][0] if planned_vacancies else None + self.planned_vacancies = frappe.db.get_value( + "Staffing Plan Detail", + {"parent": self.staffing_plan, "designation": self.designation}, + "vacancies", + ) if self.staffing_plan and self.planned_vacancies: staffing_plan_company = frappe.db.get_value("Staffing Plan", self.staffing_plan, "company") - lft, rgt = frappe.get_cached_value('Company', staffing_plan_company, ["lft", "rgt"]) - designation_counts = get_designation_counts(self.designation, self.company) - current_count = designation_counts['employee_count'] + designation_counts['job_openings'] + designation_counts = get_designation_counts(self.designation, self.company, self.name) + current_count = designation_counts["employee_count"] + designation_counts["job_openings"] - if self.planned_vacancies <= current_count: - frappe.throw(_("Job Openings for designation {0} already open or hiring completed as per Staffing Plan {1}").format( - self.designation, self.staffing_plan)) + number_of_positions = frappe.db.get_value( + "Staffing Plan Detail", + {"parent": self.staffing_plan, "designation": self.designation}, + "number_of_positions", + ) + + if number_of_positions <= current_count: + frappe.throw( + _( + "Job Openings for the designation {0} are already open or the hiring is complete as per the Staffing Plan {1}" + ).format( + frappe.bold(self.designation), get_link_to_form("Staffing Plan", self.staffing_plan) + ), + title=_("Vacancies fulfilled"), + ) def get_context(self, context): - context.parents = [{'route': 'jobs', 'title': _('All Jobs') }] + context.parents = [{"route": "jobs", "title": _("All Jobs")}] + def get_list_context(context): context.title = _("Jobs") - context.introduction = _('Current Job Openings') + context.introduction = _("Current Job Openings") context.get_list = get_job_openings -def get_job_openings(doctype, txt=None, filters=None, limit_start=0, limit_page_length=20, order_by=None): - fields = ['name', 'status', 'job_title', 'description', 'publish_salary_range', - 'lower_range', 'upper_range', 'currency', 'job_application_route'] + +def get_job_openings( + doctype, txt=None, filters=None, limit_start=0, limit_page_length=20, order_by=None +): + fields = [ + "name", + "status", + "job_title", + "description", + "publish_salary_range", + "lower_range", + "upper_range", + "currency", + "job_application_route", + ] filters = filters or {} - filters.update({ - 'status': 'Open' - }) + filters.update({"status": "Open"}) if txt: - filters.update({ - 'job_title': ['like', '%{0}%'.format(txt)], - 'description': ['like', '%{0}%'.format(txt)] - }) + filters.update( + {"job_title": ["like", "%{0}%".format(txt)], "description": ["like", "%{0}%".format(txt)]} + ) - return frappe.get_all(doctype, - filters, - fields, - start=limit_start, - page_length=limit_page_length, - order_by=order_by + return frappe.get_all( + doctype, filters, fields, start=limit_start, page_length=limit_page_length, order_by=order_by ) diff --git a/erpnext/hr/doctype/job_opening/job_opening_dashboard.py b/erpnext/hr/doctype/job_opening/job_opening_dashboard.py index 817969004f9..a30932870d0 100644 --- a/erpnext/hr/doctype/job_opening/job_opening_dashboard.py +++ b/erpnext/hr/doctype/job_opening/job_opening_dashboard.py @@ -1,11 +1,5 @@ - - def get_data(): - return { - 'fieldname': 'job_title', - 'transactions': [ - { - 'items': ['Job Applicant'] - } - ], - } + return { + "fieldname": "job_title", + "transactions": [{"items": ["Job Applicant"]}], + } diff --git a/erpnext/hr/doctype/job_opening/test_job_opening.py b/erpnext/hr/doctype/job_opening/test_job_opening.py index a1c3a1d49e3..e991054f62d 100644 --- a/erpnext/hr/doctype/job_opening/test_job_opening.py +++ b/erpnext/hr/doctype/job_opening/test_job_opening.py @@ -3,7 +3,77 @@ import unittest -# test_records = frappe.get_test_records('Job Opening') +import frappe +from frappe.tests.utils import FrappeTestCase +from frappe.utils import add_days, getdate -class TestJobOpening(unittest.TestCase): - pass +from erpnext.hr.doctype.employee.test_employee import make_employee +from erpnext.hr.doctype.staffing_plan.test_staffing_plan import make_company + + +class TestJobOpening(FrappeTestCase): + def setUp(self): + frappe.db.delete("Staffing Plan") + frappe.db.delete("Staffing Plan Detail") + frappe.db.delete("Job Opening") + + make_company("_Test Opening Company", "_TOC") + frappe.db.delete("Employee", {"company": "_Test Opening Company"}) + + def test_vacancies_fulfilled(self): + make_employee( + "test_job_opening@example.com", company="_Test Opening Company", designation="Designer" + ) + + staffing_plan = frappe.get_doc( + { + "doctype": "Staffing Plan", + "company": "_Test Opening Company", + "name": "Test", + "from_date": getdate(), + "to_date": add_days(getdate(), 10), + } + ) + + staffing_plan.append( + "staffing_details", + {"designation": "Designer", "vacancies": 1, "estimated_cost_per_position": 50000}, + ) + staffing_plan.insert() + staffing_plan.submit() + + self.assertEqual(staffing_plan.staffing_details[0].number_of_positions, 2) + + # allows creating 1 job opening as per vacancy + opening_1 = get_job_opening() + opening_1.insert() + + # vacancies as per staffing plan already fulfilled via job opening and existing employee count + opening_2 = get_job_opening(job_title="Designer New") + self.assertRaises(frappe.ValidationError, opening_2.insert) + + # allows updating existing job opening + opening_1.status = "Closed" + opening_1.save() + + +def get_job_opening(**args): + args = frappe._dict(args) + + opening = frappe.db.exists("Job Opening", {"job_title": args.job_title or "Designer"}) + if opening: + return frappe.get_doc("Job Opening", opening) + + opening = frappe.get_doc( + { + "doctype": "Job Opening", + "job_title": "Designer", + "designation": "Designer", + "company": "_Test Opening Company", + "status": "Open", + } + ) + + opening.update(args) + + return opening diff --git a/erpnext/hr/doctype/leave_allocation/leave_allocation.json b/erpnext/hr/doctype/leave_allocation/leave_allocation.json index 52ee463db02..4a9b54034af 100644 --- a/erpnext/hr/doctype/leave_allocation/leave_allocation.json +++ b/erpnext/hr/doctype/leave_allocation/leave_allocation.json @@ -237,7 +237,7 @@ "index_web_pages_for_search": 1, "is_submittable": 1, "links": [], - "modified": "2021-10-01 15:28:26.335104", + "modified": "2022-04-07 09:50:33.145825", "modified_by": "Administrator", "module": "HR", "name": "Leave Allocation", @@ -278,5 +278,7 @@ "show_name_in_global_search": 1, "sort_field": "modified", "sort_order": "DESC", - "timeline_field": "employee" + "timeline_field": "employee", + "title_field": "employee_name", + "track_changes": 1 } diff --git a/erpnext/hr/doctype/leave_allocation/leave_allocation.py b/erpnext/hr/doctype/leave_allocation/leave_allocation.py index 232118fd67c..8fae2a9a888 100755 --- a/erpnext/hr/doctype/leave_allocation/leave_allocation.py +++ b/erpnext/hr/doctype/leave_allocation/leave_allocation.py @@ -15,36 +15,65 @@ from erpnext.hr.doctype.leave_ledger_entry.leave_ledger_entry import ( from erpnext.hr.utils import get_leave_period, set_employee_name -class OverlapError(frappe.ValidationError): pass -class BackDatedAllocationError(frappe.ValidationError): pass -class OverAllocationError(frappe.ValidationError): pass -class LessAllocationError(frappe.ValidationError): pass -class ValueMultiplierError(frappe.ValidationError): pass +class OverlapError(frappe.ValidationError): + pass + + +class BackDatedAllocationError(frappe.ValidationError): + pass + + +class OverAllocationError(frappe.ValidationError): + pass + + +class LessAllocationError(frappe.ValidationError): + pass + + +class ValueMultiplierError(frappe.ValidationError): + pass + class LeaveAllocation(Document): def validate(self): self.validate_period() self.validate_allocation_overlap() - self.validate_back_dated_allocation() - self.set_total_leaves_allocated() - self.validate_total_leaves_allocated() self.validate_lwp() set_employee_name(self) + self.set_total_leaves_allocated() + self.validate_leave_days_and_dates() + + def validate_leave_days_and_dates(self): + # all validations that should run on save as well as on update after submit + self.validate_back_dated_allocation() + self.validate_total_leaves_allocated() self.validate_leave_allocation_days() def validate_leave_allocation_days(self): company = frappe.db.get_value("Employee", self.employee, "company") leave_period = get_leave_period(self.from_date, self.to_date, company) - max_leaves_allowed = flt(frappe.db.get_value("Leave Type", self.leave_type, "max_leaves_allowed")) + max_leaves_allowed = flt( + frappe.db.get_value("Leave Type", self.leave_type, "max_leaves_allowed") + ) if max_leaves_allowed > 0: leave_allocated = 0 if leave_period: - leave_allocated = get_leave_allocation_for_period(self.employee, self.leave_type, - leave_period[0].from_date, leave_period[0].to_date) + leave_allocated = get_leave_allocation_for_period( + self.employee, + self.leave_type, + leave_period[0].from_date, + leave_period[0].to_date, + exclude_allocation=self.name, + ) leave_allocated += flt(self.new_leaves_allocated) if leave_allocated > max_leaves_allowed: - frappe.throw(_("Total allocated leaves are more days than maximum allocation of {0} leave type for employee {1} in the period") - .format(self.leave_type, self.employee)) + frappe.throw( + _( + "Total allocated leaves are more than maximum allocation allowed for {0} leave type for employee {1} in the period" + ).format(self.leave_type, self.employee), + OverAllocationError, + ) def on_submit(self): self.create_leave_ledger_entry() @@ -64,25 +93,34 @@ class LeaveAllocation(Document): def on_update_after_submit(self): if self.has_value_changed("new_leaves_allocated"): self.validate_against_leave_applications() + + # recalculate total leaves allocated + self.total_leaves_allocated = flt(self.unused_leaves) + flt(self.new_leaves_allocated) + # run required validations again since total leaves are being updated + self.validate_leave_days_and_dates() + leaves_to_be_added = self.new_leaves_allocated - self.get_existing_leave_count() args = { "leaves": leaves_to_be_added, "from_date": self.from_date, "to_date": self.to_date, - "is_carry_forward": 0 + "is_carry_forward": 0, } create_leave_ledger_entry(self, args, True) + self.db_update() def get_existing_leave_count(self): - ledger_entries = frappe.get_all("Leave Ledger Entry", - filters={ - "transaction_type": "Leave Allocation", - "transaction_name": self.name, - "employee": self.employee, - "company": self.company, - "leave_type": self.leave_type - }, - pluck="leaves") + ledger_entries = frappe.get_all( + "Leave Ledger Entry", + filters={ + "transaction_type": "Leave Allocation", + "transaction_name": self.name, + "employee": self.employee, + "company": self.company, + "leave_type": self.leave_type, + }, + pluck="leaves", + ) total_existing_leaves = 0 for entry in ledger_entries: total_existing_leaves += entry @@ -90,21 +128,33 @@ class LeaveAllocation(Document): return total_existing_leaves def validate_against_leave_applications(self): - leaves_taken = get_approved_leaves_for_period(self.employee, self.leave_type, - self.from_date, self.to_date) + leaves_taken = get_approved_leaves_for_period( + self.employee, self.leave_type, self.from_date, self.to_date + ) if flt(leaves_taken) > flt(self.total_leaves_allocated): if frappe.db.get_value("Leave Type", self.leave_type, "allow_negative"): - frappe.msgprint(_("Note: Total allocated leaves {0} shouldn't be less than already approved leaves {1} for the period").format(self.total_leaves_allocated, leaves_taken)) + frappe.msgprint( + _( + "Note: Total allocated leaves {0} shouldn't be less than already approved leaves {1} for the period" + ).format(self.total_leaves_allocated, leaves_taken) + ) else: - frappe.throw(_("Total allocated leaves {0} cannot be less than already approved leaves {1} for the period").format(self.total_leaves_allocated, leaves_taken), LessAllocationError) + frappe.throw( + _( + "Total allocated leaves {0} cannot be less than already approved leaves {1} for the period" + ).format(self.total_leaves_allocated, leaves_taken), + LessAllocationError, + ) def update_leave_policy_assignments_when_no_allocations_left(self): - allocations = frappe.db.get_list("Leave Allocation", filters = { - "docstatus": 1, - "leave_policy_assignment": self.leave_policy_assignment - }) + allocations = frappe.db.get_list( + "Leave Allocation", + filters={"docstatus": 1, "leave_policy_assignment": self.leave_policy_assignment}, + ) if len(allocations) == 0: - frappe.db.set_value("Leave Policy Assignment", self.leave_policy_assignment ,"leaves_allocated", 0) + frappe.db.set_value( + "Leave Policy Assignment", self.leave_policy_assignment, "leaves_allocated", 0 + ) def validate_period(self): if date_diff(self.to_date, self.from_date) <= 0: @@ -112,10 +162,13 @@ class LeaveAllocation(Document): def validate_lwp(self): if frappe.db.get_value("Leave Type", self.leave_type, "is_lwp"): - frappe.throw(_("Leave Type {0} cannot be allocated since it is leave without pay").format(self.leave_type)) + frappe.throw( + _("Leave Type {0} cannot be allocated since it is leave without pay").format(self.leave_type) + ) def validate_allocation_overlap(self): - leave_allocation = frappe.db.sql(""" + leave_allocation = frappe.db.sql( + """ SELECT name FROM `tabLeave Allocation` @@ -123,29 +176,44 @@ class LeaveAllocation(Document): employee=%s AND leave_type=%s AND name <> %s AND docstatus=1 AND to_date >= %s AND from_date <= %s""", - (self.employee, self.leave_type, self.name, self.from_date, self.to_date)) + (self.employee, self.leave_type, self.name, self.from_date, self.to_date), + ) if leave_allocation: - frappe.msgprint(_("{0} already allocated for Employee {1} for period {2} to {3}") - .format(self.leave_type, self.employee, formatdate(self.from_date), formatdate(self.to_date))) + frappe.msgprint( + _("{0} already allocated for Employee {1} for period {2} to {3}").format( + self.leave_type, self.employee, formatdate(self.from_date), formatdate(self.to_date) + ) + ) - frappe.throw(_('Reference') + ': {0}' - .format(leave_allocation[0][0]), OverlapError) + frappe.throw( + _("Reference") + + ': {0}'.format(leave_allocation[0][0]), + OverlapError, + ) def validate_back_dated_allocation(self): - future_allocation = frappe.db.sql("""select name, from_date from `tabLeave Allocation` + future_allocation = frappe.db.sql( + """select name, from_date from `tabLeave Allocation` where employee=%s and leave_type=%s and docstatus=1 and from_date > %s - and carry_forward=1""", (self.employee, self.leave_type, self.to_date), as_dict=1) + and carry_forward=1""", + (self.employee, self.leave_type, self.to_date), + as_dict=1, + ) if future_allocation: - frappe.throw(_("Leave cannot be allocated before {0}, as leave balance has already been carry-forwarded in the future leave allocation record {1}") - .format(formatdate(future_allocation[0].from_date), future_allocation[0].name), - BackDatedAllocationError) + frappe.throw( + _( + "Leave cannot be allocated before {0}, as leave balance has already been carry-forwarded in the future leave allocation record {1}" + ).format(formatdate(future_allocation[0].from_date), future_allocation[0].name), + BackDatedAllocationError, + ) @frappe.whitelist() def set_total_leaves_allocated(self): - self.unused_leaves = get_carry_forwarded_leaves(self.employee, - self.leave_type, self.from_date, self.carry_forward) + self.unused_leaves = get_carry_forwarded_leaves( + self.employee, self.leave_type, self.from_date, self.carry_forward + ) self.total_leaves_allocated = flt(self.unused_leaves) + flt(self.new_leaves_allocated) @@ -154,11 +222,14 @@ class LeaveAllocation(Document): if self.carry_forward: self.set_carry_forwarded_leaves_in_previous_allocation() - if not self.total_leaves_allocated \ - and not frappe.db.get_value("Leave Type", self.leave_type, "is_earned_leave") \ - and not frappe.db.get_value("Leave Type", self.leave_type, "is_compensatory"): - frappe.throw(_("Total leaves allocated is mandatory for Leave Type {0}") - .format(self.leave_type)) + if ( + not self.total_leaves_allocated + and not frappe.db.get_value("Leave Type", self.leave_type, "is_earned_leave") + and not frappe.db.get_value("Leave Type", self.leave_type, "is_compensatory") + ): + frappe.throw( + _("Total leaves allocated is mandatory for Leave Type {0}").format(self.leave_type) + ) def limit_carry_forward_based_on_max_allowed_leaves(self): max_leaves_allowed = frappe.db.get_value("Leave Type", self.leave_type, "max_leaves_allowed") @@ -167,29 +238,46 @@ class LeaveAllocation(Document): self.unused_leaves = max_leaves_allowed - flt(self.new_leaves_allocated) def set_carry_forwarded_leaves_in_previous_allocation(self, on_cancel=False): - ''' Set carry forwarded leaves in previous allocation ''' + """Set carry forwarded leaves in previous allocation""" previous_allocation = get_previous_allocation(self.from_date, self.leave_type, self.employee) if on_cancel: self.unused_leaves = 0.0 if previous_allocation: - frappe.db.set_value("Leave Allocation", previous_allocation.name, - 'carry_forwarded_leaves_count', self.unused_leaves) + frappe.db.set_value( + "Leave Allocation", + previous_allocation.name, + "carry_forwarded_leaves_count", + self.unused_leaves, + ) def validate_total_leaves_allocated(self): # Adding a day to include To Date in the difference date_difference = date_diff(self.to_date, self.from_date) + 1 if date_difference < self.total_leaves_allocated: - frappe.throw(_("Total allocated leaves are more than days in the period"), OverAllocationError) + if frappe.db.get_value("Leave Type", self.leave_type, "allow_over_allocation"): + frappe.msgprint( + _("Total Leaves Allocated are more than the number of days in the allocation period"), + indicator="orange", + alert=True, + ) + else: + frappe.throw( + _("Total Leaves Allocated are more than the number of days in the allocation period"), + exc=OverAllocationError, + title=_("Over Allocation"), + ) def create_leave_ledger_entry(self, submit=True): if self.unused_leaves: - expiry_days = frappe.db.get_value("Leave Type", self.leave_type, "expire_carry_forwarded_leaves_after_days") + expiry_days = frappe.db.get_value( + "Leave Type", self.leave_type, "expire_carry_forwarded_leaves_after_days" + ) end_date = add_days(self.from_date, expiry_days - 1) if expiry_days else self.to_date args = dict( leaves=self.unused_leaves, from_date=self.from_date, - to_date= min(getdate(end_date), getdate(self.to_date)), - is_carry_forward=1 + to_date=min(getdate(end_date), getdate(self.to_date)), + is_carry_forward=1, ) create_leave_ledger_entry(self, args, submit) @@ -197,74 +285,85 @@ class LeaveAllocation(Document): leaves=self.new_leaves_allocated, from_date=self.from_date, to_date=self.to_date, - is_carry_forward=0 + is_carry_forward=0, ) create_leave_ledger_entry(self, args, submit) + def get_previous_allocation(from_date, leave_type, employee): - ''' Returns document properties of previous allocation ''' - return frappe.db.get_value("Leave Allocation", + """Returns document properties of previous allocation""" + return frappe.db.get_value( + "Leave Allocation", filters={ - 'to_date': ("<", from_date), - 'leave_type': leave_type, - 'employee': employee, - 'docstatus': 1 + "to_date": ("<", from_date), + "leave_type": leave_type, + "employee": employee, + "docstatus": 1, }, - order_by='to_date DESC', - fieldname=['name', 'from_date', 'to_date', 'employee', 'leave_type'], as_dict=1) + order_by="to_date DESC", + fieldname=["name", "from_date", "to_date", "employee", "leave_type"], + as_dict=1, + ) -def get_leave_allocation_for_period(employee, leave_type, from_date, to_date): - leave_allocated = 0 - leave_allocations = frappe.db.sql(""" - select employee, leave_type, from_date, to_date, total_leaves_allocated - from `tabLeave Allocation` - where employee=%(employee)s and leave_type=%(leave_type)s - and docstatus=1 - and (from_date between %(from_date)s and %(to_date)s - or to_date between %(from_date)s and %(to_date)s - or (from_date < %(from_date)s and to_date > %(to_date)s)) - """, { - "from_date": from_date, - "to_date": to_date, - "employee": employee, - "leave_type": leave_type - }, as_dict=1) - if leave_allocations: - for leave_alloc in leave_allocations: - leave_allocated += leave_alloc.total_leaves_allocated +def get_leave_allocation_for_period( + employee, leave_type, from_date, to_date, exclude_allocation=None +): + from frappe.query_builder.functions import Sum + + Allocation = frappe.qb.DocType("Leave Allocation") + return ( + frappe.qb.from_(Allocation) + .select(Sum(Allocation.total_leaves_allocated).as_("total_allocated_leaves")) + .where( + (Allocation.employee == employee) + & (Allocation.leave_type == leave_type) + & (Allocation.docstatus == 1) + & (Allocation.name != exclude_allocation) + & ( + (Allocation.from_date.between(from_date, to_date)) + | (Allocation.to_date.between(from_date, to_date)) + | ((Allocation.from_date < from_date) & (Allocation.to_date > to_date)) + ) + ) + ).run()[0][0] or 0.0 - return leave_allocated @frappe.whitelist() def get_carry_forwarded_leaves(employee, leave_type, date, carry_forward=None): - ''' Returns carry forwarded leaves for the given employee ''' + """Returns carry forwarded leaves for the given employee""" unused_leaves = 0.0 previous_allocation = get_previous_allocation(date, leave_type, employee) if carry_forward and previous_allocation: validate_carry_forward(leave_type) - unused_leaves = get_unused_leaves(employee, leave_type, - previous_allocation.from_date, previous_allocation.to_date) + unused_leaves = get_unused_leaves( + employee, leave_type, previous_allocation.from_date, previous_allocation.to_date + ) if unused_leaves: - max_carry_forwarded_leaves = frappe.db.get_value("Leave Type", - leave_type, "maximum_carry_forwarded_leaves") + max_carry_forwarded_leaves = frappe.db.get_value( + "Leave Type", leave_type, "maximum_carry_forwarded_leaves" + ) if max_carry_forwarded_leaves and unused_leaves > flt(max_carry_forwarded_leaves): unused_leaves = flt(max_carry_forwarded_leaves) return unused_leaves + def get_unused_leaves(employee, leave_type, from_date, to_date): - ''' Returns unused leaves between the given period while skipping leave allocation expiry ''' - leaves = frappe.get_all("Leave Ledger Entry", filters={ - 'employee': employee, - 'leave_type': leave_type, - 'from_date': ('>=', from_date), - 'to_date': ('<=', to_date) - }, or_filters={ - 'is_expired': 0, - 'is_carry_forward': 1 - }, fields=['sum(leaves) as leaves']) - return flt(leaves[0]['leaves']) + """Returns unused leaves between the given period while skipping leave allocation expiry""" + leaves = frappe.get_all( + "Leave Ledger Entry", + filters={ + "employee": employee, + "leave_type": leave_type, + "from_date": (">=", from_date), + "to_date": ("<=", to_date), + }, + or_filters={"is_expired": 0, "is_carry_forward": 1}, + fields=["sum(leaves) as leaves"], + ) + return flt(leaves[0]["leaves"]) + def validate_carry_forward(leave_type): if not frappe.db.get_value("Leave Type", leave_type, "is_carry_forward"): diff --git a/erpnext/hr/doctype/leave_allocation/leave_allocation_dashboard.py b/erpnext/hr/doctype/leave_allocation/leave_allocation_dashboard.py index 08861b8bce3..96e81db617c 100644 --- a/erpnext/hr/doctype/leave_allocation/leave_allocation_dashboard.py +++ b/erpnext/hr/doctype/leave_allocation/leave_allocation_dashboard.py @@ -1,19 +1,6 @@ - - def get_data(): - return { - 'fieldname': 'leave_allocation', - 'transactions': [ - { - 'items': ['Compensatory Leave Request'] - }, - { - 'items': ['Leave Encashment'] - } - ], - 'reports': [ - { - 'items': ['Employee Leave Balance'] - } - ] - } + return { + "fieldname": "leave_allocation", + "transactions": [{"items": ["Compensatory Leave Request"]}, {"items": ["Leave Encashment"]}], + "reports": [{"items": ["Employee Leave Balance"]}], + } diff --git a/erpnext/hr/doctype/leave_allocation/test_leave_allocation.py b/erpnext/hr/doctype/leave_allocation/test_leave_allocation.py index f6165b3a6f1..48953003000 100644 --- a/erpnext/hr/doctype/leave_allocation/test_leave_allocation.py +++ b/erpnext/hr/doctype/leave_allocation/test_leave_allocation.py @@ -1,85 +1,240 @@ - import unittest import frappe +from frappe.tests.utils import FrappeTestCase from frappe.utils import add_days, add_months, getdate, nowdate import erpnext +from erpnext.hr.doctype.employee.test_employee import make_employee +from erpnext.hr.doctype.leave_allocation.leave_allocation import ( + BackDatedAllocationError, + OverAllocationError, +) from erpnext.hr.doctype.leave_ledger_entry.leave_ledger_entry import process_expired_allocation from erpnext.hr.doctype.leave_type.test_leave_type import create_leave_type -class TestLeaveAllocation(unittest.TestCase): - @classmethod - def setUpClass(cls): - frappe.db.sql("delete from `tabLeave Period`") +class TestLeaveAllocation(FrappeTestCase): + def setUp(self): + frappe.db.delete("Leave Period") + frappe.db.delete("Leave Allocation") + + emp_id = make_employee("test_emp_leave_allocation@salary.com", company="_Test Company") + self.employee = frappe.get_doc("Employee", emp_id) def test_overlapping_allocation(self): - frappe.db.sql("delete from `tabLeave Allocation`") - - employee = frappe.get_doc("Employee", frappe.db.sql_list("select name from tabEmployee limit 1")[0]) leaves = [ { "doctype": "Leave Allocation", "__islocal": 1, - "employee": employee.name, - "employee_name": employee.employee_name, + "employee": self.employee.name, + "employee_name": self.employee.employee_name, "leave_type": "_Test Leave Type", "from_date": getdate("2015-10-01"), "to_date": getdate("2015-10-31"), "new_leaves_allocated": 5, - "docstatus": 1 + "docstatus": 1, }, { "doctype": "Leave Allocation", "__islocal": 1, - "employee": employee.name, - "employee_name": employee.employee_name, + "employee": self.employee.name, + "employee_name": self.employee.employee_name, "leave_type": "_Test Leave Type", "from_date": getdate("2015-09-01"), "to_date": getdate("2015-11-30"), - "new_leaves_allocated": 5 - } + "new_leaves_allocated": 5, + }, ] frappe.get_doc(leaves[0]).save() self.assertRaises(frappe.ValidationError, frappe.get_doc(leaves[1]).save) def test_invalid_period(self): - employee = frappe.get_doc("Employee", frappe.db.sql_list("select name from tabEmployee limit 1")[0]) + doc = frappe.get_doc( + { + "doctype": "Leave Allocation", + "__islocal": 1, + "employee": self.employee.name, + "employee_name": self.employee.employee_name, + "leave_type": "_Test Leave Type", + "from_date": getdate("2015-09-30"), + "to_date": getdate("2015-09-1"), + "new_leaves_allocated": 5, + } + ) - doc = frappe.get_doc({ - "doctype": "Leave Allocation", - "__islocal": 1, - "employee": employee.name, - "employee_name": employee.employee_name, - "leave_type": "_Test Leave Type", - "from_date": getdate("2015-09-30"), - "to_date": getdate("2015-09-1"), - "new_leaves_allocated": 5 - }) - - #invalid period + # invalid period self.assertRaises(frappe.ValidationError, doc.save) - def test_allocated_leave_days_over_period(self): - employee = frappe.get_doc("Employee", frappe.db.sql_list("select name from tabEmployee limit 1")[0]) - doc = frappe.get_doc({ - "doctype": "Leave Allocation", - "__islocal": 1, - "employee": employee.name, - "employee_name": employee.employee_name, - "leave_type": "_Test Leave Type", - "from_date": getdate("2015-09-1"), - "to_date": getdate("2015-09-30"), - "new_leaves_allocated": 35 - }) - #allocated leave more than period - self.assertRaises(frappe.ValidationError, doc.save) + def test_validation_for_over_allocation(self): + leave_type = create_leave_type(leave_type_name="Test Over Allocation", is_carry_forward=1) + leave_type.save() + + doc = frappe.get_doc( + { + "doctype": "Leave Allocation", + "__islocal": 1, + "employee": self.employee.name, + "employee_name": self.employee.employee_name, + "leave_type": leave_type.name, + "from_date": getdate("2015-09-1"), + "to_date": getdate("2015-09-30"), + "new_leaves_allocated": 35, + "carry_forward": 1, + } + ) + + # allocated leave more than period + self.assertRaises(OverAllocationError, doc.save) + + leave_type.allow_over_allocation = 1 + leave_type.save() + + # allows creating a leave allocation with more leave days than period days + doc = frappe.get_doc( + { + "doctype": "Leave Allocation", + "__islocal": 1, + "employee": self.employee.name, + "employee_name": self.employee.employee_name, + "leave_type": leave_type.name, + "from_date": getdate("2015-09-1"), + "to_date": getdate("2015-09-30"), + "new_leaves_allocated": 35, + "carry_forward": 1, + } + ).insert() + + def test_validation_for_over_allocation_post_submission(self): + allocation = frappe.get_doc( + { + "doctype": "Leave Allocation", + "__islocal": 1, + "employee": self.employee.name, + "employee_name": self.employee.employee_name, + "leave_type": "_Test Leave Type", + "from_date": getdate("2015-09-1"), + "to_date": getdate("2015-09-30"), + "new_leaves_allocated": 15, + } + ).submit() + allocation.reload() + # allocated leaves more than period after submission + allocation.new_leaves_allocated = 35 + self.assertRaises(OverAllocationError, allocation.save) + + def test_validation_for_over_allocation_based_on_leave_setup(self): + frappe.delete_doc_if_exists("Leave Period", "Test Allocation Period") + leave_period = frappe.get_doc( + dict( + name="Test Allocation Period", + doctype="Leave Period", + from_date=add_months(nowdate(), -6), + to_date=add_months(nowdate(), 6), + company="_Test Company", + is_active=1, + ) + ).insert() + + leave_type = create_leave_type(leave_type_name="_Test Allocation Validation", is_carry_forward=1) + leave_type.max_leaves_allowed = 25 + leave_type.save() + + # 15 leaves allocated in this period + allocation = create_leave_allocation( + leave_type=leave_type.name, + employee=self.employee.name, + employee_name=self.employee.employee_name, + from_date=leave_period.from_date, + to_date=nowdate(), + ) + allocation.submit() + + # trying to allocate additional 15 leaves + allocation = create_leave_allocation( + leave_type=leave_type.name, + employee=self.employee.name, + employee_name=self.employee.employee_name, + from_date=add_days(nowdate(), 1), + to_date=leave_period.to_date, + ) + self.assertRaises(OverAllocationError, allocation.save) + + def test_validation_for_over_allocation_based_on_leave_setup_post_submission(self): + frappe.delete_doc_if_exists("Leave Period", "Test Allocation Period") + leave_period = frappe.get_doc( + dict( + name="Test Allocation Period", + doctype="Leave Period", + from_date=add_months(nowdate(), -6), + to_date=add_months(nowdate(), 6), + company="_Test Company", + is_active=1, + ) + ).insert() + + leave_type = create_leave_type(leave_type_name="_Test Allocation Validation", is_carry_forward=1) + leave_type.max_leaves_allowed = 30 + leave_type.save() + + # 15 leaves allocated + allocation = create_leave_allocation( + leave_type=leave_type.name, + employee=self.employee.name, + employee_name=self.employee.employee_name, + from_date=leave_period.from_date, + to_date=nowdate(), + ) + allocation.submit() + allocation.reload() + + # allocate additional 15 leaves + allocation = create_leave_allocation( + leave_type=leave_type.name, + employee=self.employee.name, + employee_name=self.employee.employee_name, + from_date=add_days(nowdate(), 1), + to_date=leave_period.to_date, + ) + allocation.submit() + allocation.reload() + + # trying to allocate 25 leaves in 2nd alloc within leave period + # total leaves = 40 which is more than `max_leaves_allowed` setting i.e. 30 + allocation.new_leaves_allocated = 25 + self.assertRaises(OverAllocationError, allocation.save) + + def test_validate_back_dated_allocation_update(self): + leave_type = create_leave_type(leave_type_name="_Test_CF_leave", is_carry_forward=1) + leave_type.save() + + # initial leave allocation = 15 + leave_allocation = create_leave_allocation( + employee=self.employee.name, + employee_name=self.employee.employee_name, + leave_type="_Test_CF_leave", + from_date=add_months(nowdate(), -12), + to_date=add_months(nowdate(), -1), + carry_forward=0, + ) + leave_allocation.submit() + + # new_leaves = 15, carry_forwarded = 10 + leave_allocation_1 = create_leave_allocation( + employee=self.employee.name, + employee_name=self.employee.employee_name, + leave_type="_Test_CF_leave", + carry_forward=1, + ) + leave_allocation_1.submit() + + # try updating initial leave allocation + leave_allocation.reload() + leave_allocation.new_leaves_allocated = 20 + self.assertRaises(BackDatedAllocationError, leave_allocation.save) def test_carry_forward_calculation(self): - frappe.db.sql("delete from `tabLeave Allocation`") - frappe.db.sql("delete from `tabLeave Ledger Entry`") leave_type = create_leave_type(leave_type_name="_Test_CF_leave", is_carry_forward=1) leave_type.maximum_carry_forwarded_leaves = 10 leave_type.max_leaves_allowed = 30 @@ -87,55 +242,71 @@ class TestLeaveAllocation(unittest.TestCase): # initial leave allocation = 15 leave_allocation = create_leave_allocation( + employee=self.employee.name, + employee_name=self.employee.employee_name, leave_type="_Test_CF_leave", from_date=add_months(nowdate(), -12), to_date=add_months(nowdate(), -1), - carry_forward=0) + carry_forward=0, + ) leave_allocation.submit() # carry forwarded leaves considering maximum_carry_forwarded_leaves # new_leaves = 15, carry_forwarded = 10 leave_allocation_1 = create_leave_allocation( + employee=self.employee.name, + employee_name=self.employee.employee_name, leave_type="_Test_CF_leave", - carry_forward=1) + carry_forward=1, + ) leave_allocation_1.submit() + leave_allocation_1.reload() self.assertEqual(leave_allocation_1.unused_leaves, 10) + self.assertEqual(leave_allocation_1.total_leaves_allocated, 25) leave_allocation_1.cancel() # carry forwarded leaves considering max_leave_allowed # max_leave_allowed = 30, new_leaves = 25, carry_forwarded = 5 leave_allocation_2 = create_leave_allocation( + employee=self.employee.name, + employee_name=self.employee.employee_name, leave_type="_Test_CF_leave", carry_forward=1, - new_leaves_allocated=25) + new_leaves_allocated=25, + ) leave_allocation_2.submit() self.assertEqual(leave_allocation_2.unused_leaves, 5) def test_carry_forward_leaves_expiry(self): - frappe.db.sql("delete from `tabLeave Allocation`") - frappe.db.sql("delete from `tabLeave Ledger Entry`") leave_type = create_leave_type( leave_type_name="_Test_CF_leave_expiry", is_carry_forward=1, - expire_carry_forwarded_leaves_after_days=90) + expire_carry_forwarded_leaves_after_days=90, + ) leave_type.save() # initial leave allocation leave_allocation = create_leave_allocation( + employee=self.employee.name, + employee_name=self.employee.employee_name, leave_type="_Test_CF_leave_expiry", from_date=add_months(nowdate(), -24), to_date=add_months(nowdate(), -12), - carry_forward=0) + carry_forward=0, + ) leave_allocation.submit() leave_allocation = create_leave_allocation( + employee=self.employee.name, + employee_name=self.employee.employee_name, leave_type="_Test_CF_leave_expiry", from_date=add_days(nowdate(), -90), to_date=add_days(nowdate(), 100), - carry_forward=1) + carry_forward=1, + ) leave_allocation.submit() # expires all the carry forwarded leaves after 90 days @@ -143,21 +314,26 @@ class TestLeaveAllocation(unittest.TestCase): # leave allocation with carry forward of only new leaves allocated leave_allocation_1 = create_leave_allocation( + employee=self.employee.name, + employee_name=self.employee.employee_name, leave_type="_Test_CF_leave_expiry", carry_forward=1, from_date=add_months(nowdate(), 6), - to_date=add_months(nowdate(), 12)) + to_date=add_months(nowdate(), 12), + ) leave_allocation_1.submit() self.assertEqual(leave_allocation_1.unused_leaves, leave_allocation.new_leaves_allocated) def test_creation_of_leave_ledger_entry_on_submit(self): - frappe.db.sql("delete from `tabLeave Allocation`") - - leave_allocation = create_leave_allocation() + leave_allocation = create_leave_allocation( + employee=self.employee.name, employee_name=self.employee.employee_name + ) leave_allocation.submit() - leave_ledger_entry = frappe.get_all('Leave Ledger Entry', fields='*', filters=dict(transaction_name=leave_allocation.name)) + leave_ledger_entry = frappe.get_all( + "Leave Ledger Entry", fields="*", filters=dict(transaction_name=leave_allocation.name) + ) self.assertEqual(len(leave_ledger_entry), 1) self.assertEqual(leave_ledger_entry[0].employee, leave_allocation.employee) @@ -166,68 +342,91 @@ class TestLeaveAllocation(unittest.TestCase): # check if leave ledger entry is deleted on cancellation leave_allocation.cancel() - self.assertFalse(frappe.db.exists("Leave Ledger Entry", {'transaction_name':leave_allocation.name})) + self.assertFalse( + frappe.db.exists("Leave Ledger Entry", {"transaction_name": leave_allocation.name}) + ) def test_leave_addition_after_submit(self): - frappe.db.sql("delete from `tabLeave Allocation`") - frappe.db.sql("delete from `tabLeave Ledger Entry`") - - leave_allocation = create_leave_allocation() + leave_allocation = create_leave_allocation( + employee=self.employee.name, employee_name=self.employee.employee_name + ) leave_allocation.submit() + leave_allocation.reload() self.assertTrue(leave_allocation.total_leaves_allocated, 15) + leave_allocation.new_leaves_allocated = 40 leave_allocation.submit() + leave_allocation.reload() self.assertTrue(leave_allocation.total_leaves_allocated, 40) def test_leave_subtraction_after_submit(self): - frappe.db.sql("delete from `tabLeave Allocation`") - frappe.db.sql("delete from `tabLeave Ledger Entry`") - leave_allocation = create_leave_allocation() + leave_allocation = create_leave_allocation( + employee=self.employee.name, employee_name=self.employee.employee_name + ) leave_allocation.submit() + leave_allocation.reload() self.assertTrue(leave_allocation.total_leaves_allocated, 15) + leave_allocation.new_leaves_allocated = 10 leave_allocation.submit() + leave_allocation.reload() self.assertTrue(leave_allocation.total_leaves_allocated, 10) - def test_against_leave_application_validation_after_submit(self): - frappe.db.sql("delete from `tabLeave Allocation`") - frappe.db.sql("delete from `tabLeave Ledger Entry`") + def test_validation_against_leave_application_after_submit(self): + from erpnext.payroll.doctype.salary_slip.test_salary_slip import make_holiday_list - leave_allocation = create_leave_allocation() + make_holiday_list() + frappe.db.set_value( + "Company", self.employee.company, "default_holiday_list", "Salary Slip Test Holiday List" + ) + + leave_allocation = create_leave_allocation( + employee=self.employee.name, employee_name=self.employee.employee_name + ) leave_allocation.submit() self.assertTrue(leave_allocation.total_leaves_allocated, 15) - employee = frappe.get_doc("Employee", frappe.db.sql_list("select name from tabEmployee limit 1")[0]) - leave_application = frappe.get_doc({ - "doctype": 'Leave Application', - "employee": employee.name, - "leave_type": "_Test Leave Type", - "from_date": add_months(nowdate(), 2), - "to_date": add_months(add_days(nowdate(), 10), 2), - "company": erpnext.get_default_company() or "_Test Company", - "docstatus": 1, - "status": "Approved", - "leave_approver": 'test@example.com' - }) + + leave_application = frappe.get_doc( + { + "doctype": "Leave Application", + "employee": self.employee.name, + "leave_type": "_Test Leave Type", + "from_date": add_months(nowdate(), 2), + "to_date": add_months(add_days(nowdate(), 10), 2), + "company": self.employee.company, + "docstatus": 1, + "status": "Approved", + "leave_approver": "test@example.com", + } + ) leave_application.submit() - leave_allocation.new_leaves_allocated = 8 - leave_allocation.total_leaves_allocated = 8 + leave_application.reload() + + # allocate less leaves than the ones which are already approved + leave_allocation.new_leaves_allocated = leave_application.total_leave_days - 1 + leave_allocation.total_leaves_allocated = leave_application.total_leave_days - 1 self.assertRaises(frappe.ValidationError, leave_allocation.submit) + def create_leave_allocation(**args): args = frappe._dict(args) - employee = frappe.get_doc("Employee", frappe.db.sql_list("select name from tabEmployee limit 1")[0]) - leave_allocation = frappe.get_doc({ - "doctype": "Leave Allocation", - "__islocal": 1, - "employee": args.employee or employee.name, - "employee_name": args.employee_name or employee.employee_name, - "leave_type": args.leave_type or "_Test Leave Type", - "from_date": args.from_date or nowdate(), - "new_leaves_allocated": args.new_leaves_allocated or 15, - "carry_forward": args.carry_forward or 0, - "to_date": args.to_date or add_months(nowdate(), 12) - }) - return leave_allocation + emp_id = make_employee("test_emp_leave_allocation@salary.com") + employee = frappe.get_doc("Employee", emp_id) + + return frappe.get_doc( + { + "doctype": "Leave Allocation", + "__islocal": 1, + "employee": args.employee or employee.name, + "employee_name": args.employee_name or employee.employee_name, + "leave_type": args.leave_type or "_Test Leave Type", + "from_date": args.from_date or nowdate(), + "new_leaves_allocated": args.new_leaves_allocated or 15, + "carry_forward": args.carry_forward or 0, + "to_date": args.to_date or add_months(nowdate(), 12), + } + ) + test_dependencies = ["Employee", "Leave Type"] diff --git a/erpnext/hr/doctype/leave_application/leave_application.js b/erpnext/hr/doctype/leave_application/leave_application.js index 9e8cb5516f3..dbadbc48916 100755 --- a/erpnext/hr/doctype/leave_application/leave_application.js +++ b/erpnext/hr/doctype/leave_application/leave_application.js @@ -146,6 +146,7 @@ frappe.ui.form.on("Leave Application", { }, to_date: function(frm) { + frm.trigger("make_dashboard"); frm.trigger("half_day_datepicker"); frm.trigger("calculate_total_days"); }, @@ -172,7 +173,7 @@ frappe.ui.form.on("Leave Application", { date: frm.doc.from_date, to_date: frm.doc.to_date, leave_type: frm.doc.leave_type, - consider_all_leaves_in_the_allocation_period: true + consider_all_leaves_in_the_allocation_period: 1 }, callback: function (r) { if (!r.exc && r.message) { diff --git a/erpnext/hr/doctype/leave_application/leave_application.py b/erpnext/hr/doctype/leave_application/leave_application.py index 1dc5b31461e..7edcd516fcb 100755 --- a/erpnext/hr/doctype/leave_application/leave_application.py +++ b/erpnext/hr/doctype/leave_application/leave_application.py @@ -1,9 +1,11 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt +from typing import Dict, Optional, Tuple import frappe from frappe import _ +from frappe.query_builder.functions import Max, Min, Sum from frappe.utils import ( add_days, cint, @@ -22,6 +24,7 @@ from erpnext.hr.doctype.employee.employee import get_holiday_list_for_employee from erpnext.hr.doctype.leave_block_list.leave_block_list import get_applicable_block_dates from erpnext.hr.doctype.leave_ledger_entry.leave_ledger_entry import create_leave_ledger_entry from erpnext.hr.utils import ( + get_holiday_dates_for_employee, get_leave_period, set_employee_name, share_doc_with_approver, @@ -29,10 +32,29 @@ from erpnext.hr.utils import ( ) -class LeaveDayBlockedError(frappe.ValidationError): pass -class OverlapError(frappe.ValidationError): pass -class AttendanceAlreadyMarkedError(frappe.ValidationError): pass -class NotAnOptionalHoliday(frappe.ValidationError): pass +class LeaveDayBlockedError(frappe.ValidationError): + pass + + +class OverlapError(frappe.ValidationError): + pass + + +class AttendanceAlreadyMarkedError(frappe.ValidationError): + pass + + +class NotAnOptionalHoliday(frappe.ValidationError): + pass + + +class InsufficientLeaveBalanceError(frappe.ValidationError): + pass + + +class LeaveAcrossAllocationsError(frappe.ValidationError): + pass + from frappe.model.document import Document @@ -53,7 +75,7 @@ class LeaveApplication(Document): self.validate_salary_processed_days() self.validate_attendance() self.set_half_day_date() - if frappe.db.get_value("Leave Type", self.leave_type, 'is_optional_leave'): + if frappe.db.get_value("Leave Type", self.leave_type, "is_optional_leave"): self.validate_optional_leave() self.validate_applicable_after() @@ -66,8 +88,10 @@ class LeaveApplication(Document): share_doc_with_approver(self, self.leave_approver) def on_submit(self): - if self.status == "Open": - frappe.throw(_("Only Leave Applications with status 'Approved' and 'Rejected' can be submitted")) + if self.status in ["Open", "Cancelled"]: + frappe.throw( + _("Only Leave Applications with status 'Approved' and 'Rejected' can be submitted") + ) self.validate_back_dated_application() self.update_attendance() @@ -94,7 +118,9 @@ class LeaveApplication(Document): leave_type = frappe.get_doc("Leave Type", self.leave_type) if leave_type.applicable_after > 0: date_of_joining = frappe.db.get_value("Employee", self.employee, "date_of_joining") - leave_days = get_approved_leaves_for_period(self.employee, False, date_of_joining, self.from_date) + leave_days = get_approved_leaves_for_period( + self.employee, False, date_of_joining, self.from_date + ) number_of_days = date_diff(getdate(self.from_date), date_of_joining) if number_of_days >= 0: holidays = 0 @@ -102,29 +128,48 @@ class LeaveApplication(Document): holidays = get_holidays(self.employee, date_of_joining, self.from_date) number_of_days = number_of_days - leave_days - holidays if number_of_days < leave_type.applicable_after: - frappe.throw(_("{0} applicable after {1} working days").format(self.leave_type, leave_type.applicable_after)) + frappe.throw( + _("{0} applicable after {1} working days").format( + self.leave_type, leave_type.applicable_after + ) + ) def validate_dates(self): if frappe.db.get_single_value("HR Settings", "restrict_backdated_leave_application"): if self.from_date and getdate(self.from_date) < getdate(): - allowed_role = frappe.db.get_single_value("HR Settings", "role_allowed_to_create_backdated_leave_application") + allowed_role = frappe.db.get_single_value( + "HR Settings", "role_allowed_to_create_backdated_leave_application" + ) user = frappe.get_doc("User", frappe.session.user) user_roles = [d.role for d in user.roles] if not allowed_role: - frappe.throw(_("Backdated Leave Application is restricted. Please set the {} in {}").format( - frappe.bold("Role Allowed to Create Backdated Leave Application"), get_link_to_form("HR Settings", "HR Settings"))) + frappe.throw( + _("Backdated Leave Application is restricted. Please set the {} in {}").format( + frappe.bold("Role Allowed to Create Backdated Leave Application"), + get_link_to_form("HR Settings", "HR Settings"), + ) + ) - if (allowed_role and allowed_role not in user_roles): - frappe.throw(_("Only users with the {0} role can create backdated leave applications").format(allowed_role)) + if allowed_role and allowed_role not in user_roles: + frappe.throw( + _("Only users with the {0} role can create backdated leave applications").format( + allowed_role + ) + ) if self.from_date and self.to_date and (getdate(self.to_date) < getdate(self.from_date)): frappe.throw(_("To date cannot be before from date")) - if self.half_day and self.half_day_date \ - and (getdate(self.half_day_date) < getdate(self.from_date) - or getdate(self.half_day_date) > getdate(self.to_date)): + if ( + self.half_day + and self.half_day_date + and ( + getdate(self.half_day_date) < getdate(self.from_date) + or getdate(self.half_day_date) > getdate(self.to_date) + ) + ): - frappe.throw(_("Half Day Date should be between From Date and To Date")) + frappe.throw(_("Half Day Date should be between From Date and To Date")) if not is_lwp(self.leave_type): self.validate_dates_across_allocation() @@ -133,64 +178,118 @@ class LeaveApplication(Document): def validate_dates_across_allocation(self): if frappe.db.get_value("Leave Type", self.leave_type, "allow_negative"): return - def _get_leave_allocation_record(date): - allocation = frappe.db.sql("""select name from `tabLeave Allocation` - where employee=%s and leave_type=%s and docstatus=1 - and %s between from_date and to_date""", (self.employee, self.leave_type, date)) - return allocation and allocation[0][0] + alloc_on_from_date, alloc_on_to_date = self.get_allocation_based_on_application_dates() + + if not (alloc_on_from_date or alloc_on_to_date): + frappe.throw(_("Application period cannot be outside leave allocation period")) + elif self.is_separate_ledger_entry_required(alloc_on_from_date, alloc_on_to_date): + frappe.throw( + _("Application period cannot be across two allocation records"), + exc=LeaveAcrossAllocationsError, + ) + + def get_allocation_based_on_application_dates(self) -> Tuple[Dict, Dict]: + """Returns allocation name, from and to dates for application dates""" + + def _get_leave_allocation_record(date): + LeaveAllocation = frappe.qb.DocType("Leave Allocation") + allocation = ( + frappe.qb.from_(LeaveAllocation) + .select(LeaveAllocation.name, LeaveAllocation.from_date, LeaveAllocation.to_date) + .where( + (LeaveAllocation.employee == self.employee) + & (LeaveAllocation.leave_type == self.leave_type) + & (LeaveAllocation.docstatus == 1) + & ((date >= LeaveAllocation.from_date) & (date <= LeaveAllocation.to_date)) + ) + ).run(as_dict=True) + + return allocation and allocation[0] allocation_based_on_from_date = _get_leave_allocation_record(self.from_date) allocation_based_on_to_date = _get_leave_allocation_record(self.to_date) - if not (allocation_based_on_from_date or allocation_based_on_to_date): - frappe.throw(_("Application period cannot be outside leave allocation period")) - - elif allocation_based_on_from_date != allocation_based_on_to_date: - frappe.throw(_("Application period cannot be across two allocation records")) + return allocation_based_on_from_date, allocation_based_on_to_date def validate_back_dated_application(self): - future_allocation = frappe.db.sql("""select name, from_date from `tabLeave Allocation` + future_allocation = frappe.db.sql( + """select name, from_date from `tabLeave Allocation` where employee=%s and leave_type=%s and docstatus=1 and from_date > %s - and carry_forward=1""", (self.employee, self.leave_type, self.to_date), as_dict=1) + and carry_forward=1""", + (self.employee, self.leave_type, self.to_date), + as_dict=1, + ) if future_allocation: - frappe.throw(_("Leave cannot be applied/cancelled before {0}, as leave balance has already been carry-forwarded in the future leave allocation record {1}") - .format(formatdate(future_allocation[0].from_date), future_allocation[0].name)) + frappe.throw( + _( + "Leave cannot be applied/cancelled before {0}, as leave balance has already been carry-forwarded in the future leave allocation record {1}" + ).format(formatdate(future_allocation[0].from_date), future_allocation[0].name) + ) def update_attendance(self): - if self.status == "Approved": - for dt in daterange(getdate(self.from_date), getdate(self.to_date)): - date = dt.strftime("%Y-%m-%d") - status = "Half Day" if self.half_day_date and getdate(date) == getdate(self.half_day_date) else "On Leave" - attendance_name = frappe.db.exists('Attendance', dict(employee = self.employee, - attendance_date = date, docstatus = ('!=', 2))) + if self.status != "Approved": + return + holiday_dates = [] + if not frappe.db.get_value("Leave Type", self.leave_type, "include_holiday"): + holiday_dates = get_holiday_dates_for_employee(self.employee, self.from_date, self.to_date) + + for dt in daterange(getdate(self.from_date), getdate(self.to_date)): + date = dt.strftime("%Y-%m-%d") + attendance_name = frappe.db.exists( + "Attendance", dict(employee=self.employee, attendance_date=date, docstatus=("!=", 2)) + ) + + # don't mark attendance for holidays + # if leave type does not include holidays within leaves as leaves + if date in holiday_dates: if attendance_name: - # update existing attendance, change absent to on leave - doc = frappe.get_doc('Attendance', attendance_name) - if doc.status != status: - doc.db_set('status', status) - doc.db_set('leave_type', self.leave_type) - doc.db_set('leave_application', self.name) - else: - # make new attendance and submit it - doc = frappe.new_doc("Attendance") - doc.employee = self.employee - doc.employee_name = self.employee_name - doc.attendance_date = date - doc.company = self.company - doc.leave_type = self.leave_type - doc.leave_application = self.name - doc.status = status - doc.flags.ignore_validate = True - doc.insert(ignore_permissions=True) - doc.submit() + # cancel and delete existing attendance for holidays + attendance = frappe.get_doc("Attendance", attendance_name) + attendance.flags.ignore_permissions = True + if attendance.docstatus == 1: + attendance.cancel() + frappe.delete_doc("Attendance", attendance_name, force=1) + continue + + self.create_or_update_attendance(attendance_name, date) + + def create_or_update_attendance(self, attendance_name, date): + status = ( + "Half Day" + if self.half_day_date and getdate(date) == getdate(self.half_day_date) + else "On Leave" + ) + + if attendance_name: + # update existing attendance, change absent to on leave + doc = frappe.get_doc("Attendance", attendance_name) + if doc.status != status: + doc.db_set({"status": status, "leave_type": self.leave_type, "leave_application": self.name}) + else: + # make new attendance and submit it + doc = frappe.new_doc("Attendance") + doc.employee = self.employee + doc.employee_name = self.employee_name + doc.attendance_date = date + doc.company = self.company + doc.leave_type = self.leave_type + doc.leave_application = self.name + doc.status = status + doc.flags.ignore_validate = True + doc.insert(ignore_permissions=True) + doc.submit() def cancel_attendance(self): if self.docstatus == 2: - attendance = frappe.db.sql("""select name from `tabAttendance` where employee = %s\ - and (attendance_date between %s and %s) and docstatus < 2 and status in ('On Leave', 'Half Day')""",(self.employee, self.from_date, self.to_date), as_dict=1) + attendance = frappe.db.sql( + """select name from `tabAttendance` where employee = %s\ + and (attendance_date between %s and %s) and docstatus < 2 and status in ('On Leave', 'Half Day')""", + (self.employee, self.from_date, self.to_date), + as_dict=1, + ) for name in attendance: frappe.db.set_value("Attendance", name, "docstatus", 2) @@ -198,21 +297,29 @@ class LeaveApplication(Document): if not frappe.db.get_value("Leave Type", self.leave_type, "is_lwp"): return - last_processed_pay_slip = frappe.db.sql(""" + last_processed_pay_slip = frappe.db.sql( + """ select start_date, end_date from `tabSalary Slip` where docstatus = 1 and employee = %s and ((%s between start_date and end_date) or (%s between start_date and end_date)) order by modified desc limit 1 - """,(self.employee, self.to_date, self.from_date)) + """, + (self.employee, self.to_date, self.from_date), + ) if last_processed_pay_slip: - frappe.throw(_("Salary already processed for period between {0} and {1}, Leave application period cannot be between this date range.").format(formatdate(last_processed_pay_slip[0][0]), - formatdate(last_processed_pay_slip[0][1]))) - + frappe.throw( + _( + "Salary already processed for period between {0} and {1}, Leave application period cannot be between this date range." + ).format( + formatdate(last_processed_pay_slip[0][0]), formatdate(last_processed_pay_slip[0][1]) + ) + ) def show_block_day_warning(self): - block_dates = get_applicable_block_dates(self.from_date, self.to_date, - self.employee, self.company, all_lists=True) + block_dates = get_applicable_block_dates( + self.from_date, self.to_date, self.employee, self.company, all_lists=True + ) if block_dates: frappe.msgprint(_("Warning: Leave application contains following block dates") + ":") @@ -220,53 +327,99 @@ class LeaveApplication(Document): frappe.msgprint(formatdate(d.block_date) + ": " + d.reason) def validate_block_days(self): - block_dates = get_applicable_block_dates(self.from_date, self.to_date, - self.employee, self.company) + block_dates = get_applicable_block_dates( + self.from_date, self.to_date, self.employee, self.company + ) if block_dates and self.status == "Approved": frappe.throw(_("You are not authorized to approve leaves on Block Dates"), LeaveDayBlockedError) def validate_balance_leaves(self): if self.from_date and self.to_date: - self.total_leave_days = get_number_of_leave_days(self.employee, self.leave_type, - self.from_date, self.to_date, self.half_day, self.half_day_date) + self.total_leave_days = get_number_of_leave_days( + self.employee, self.leave_type, self.from_date, self.to_date, self.half_day, self.half_day_date + ) if self.total_leave_days <= 0: - frappe.throw(_("The day(s) on which you are applying for leave are holidays. You need not apply for leave.")) + frappe.throw( + _( + "The day(s) on which you are applying for leave are holidays. You need not apply for leave." + ) + ) if not is_lwp(self.leave_type): - self.leave_balance = get_leave_balance_on(self.employee, self.leave_type, self.from_date, self.to_date, - consider_all_leaves_in_the_allocation_period=True) - if self.status != "Rejected" and (self.leave_balance < self.total_leave_days or not self.leave_balance): - if frappe.db.get_value("Leave Type", self.leave_type, "allow_negative"): - frappe.msgprint(_("Note: There is not enough leave balance for Leave Type {0}") - .format(self.leave_type)) - else: - frappe.throw(_("There is not enough leave balance for Leave Type {0}") - .format(self.leave_type)) + leave_balance = get_leave_balance_on( + self.employee, + self.leave_type, + self.from_date, + self.to_date, + consider_all_leaves_in_the_allocation_period=True, + for_consumption=True, + ) + self.leave_balance = leave_balance.get("leave_balance") + leave_balance_for_consumption = leave_balance.get("leave_balance_for_consumption") + + if self.status != "Rejected" and ( + leave_balance_for_consumption < self.total_leave_days or not leave_balance_for_consumption + ): + self.show_insufficient_balance_message(leave_balance_for_consumption) + + def show_insufficient_balance_message(self, leave_balance_for_consumption: float) -> None: + alloc_on_from_date, alloc_on_to_date = self.get_allocation_based_on_application_dates() + + if frappe.db.get_value("Leave Type", self.leave_type, "allow_negative"): + if leave_balance_for_consumption != self.leave_balance: + msg = _("Warning: Insufficient leave balance for Leave Type {0} in this allocation.").format( + frappe.bold(self.leave_type) + ) + msg += "
" + msg += _( + "Actual balances aren't available because the leave application spans over different leave allocations. You can still apply for leaves which would be compensated during the next allocation." + ) + else: + msg = _("Warning: Insufficient leave balance for Leave Type {0}.").format( + frappe.bold(self.leave_type) + ) + + frappe.msgprint(msg, title=_("Warning"), indicator="orange") + else: + frappe.throw( + _("Insufficient leave balance for Leave Type {0}").format(frappe.bold(self.leave_type)), + exc=InsufficientLeaveBalanceError, + title=_("Insufficient Balance"), + ) def validate_leave_overlap(self): if not self.name: # hack! if name is null, it could cause problems with != self.name = "New Leave Application" - for d in frappe.db.sql(""" + for d in frappe.db.sql( + """ select name, leave_type, posting_date, from_date, to_date, total_leave_days, half_day_date from `tabLeave Application` where employee = %(employee)s and docstatus < 2 and status in ("Open", "Approved") and to_date >= %(from_date)s and from_date <= %(to_date)s - and name != %(name)s""", { + and name != %(name)s""", + { "employee": self.employee, "from_date": self.from_date, "to_date": self.to_date, - "name": self.name - }, as_dict = 1): + "name": self.name, + }, + as_dict=1, + ): - if cint(self.half_day)==1 and getdate(self.half_day_date) == getdate(d.half_day_date) and ( - flt(self.total_leave_days)==0.5 - or getdate(self.from_date) == getdate(d.to_date) - or getdate(self.to_date) == getdate(d.from_date)): + if ( + cint(self.half_day) == 1 + and getdate(self.half_day_date) == getdate(d.half_day_date) + and ( + flt(self.total_leave_days) == 0.5 + or getdate(self.from_date) == getdate(d.to_date) + or getdate(self.to_date) == getdate(d.from_date) + ) + ): total_leaves_on_half_day = self.get_total_leaves_on_half_day() if total_leaves_on_half_day >= 1: @@ -276,22 +429,22 @@ class LeaveApplication(Document): def throw_overlap_error(self, d): form_link = get_link_to_form("Leave Application", d.name) - msg = _("Employee {0} has already applied for {1} between {2} and {3} : {4}").format(self.employee, - d['leave_type'], formatdate(d['from_date']), formatdate(d['to_date']), form_link) + msg = _("Employee {0} has already applied for {1} between {2} and {3} : {4}").format( + self.employee, d["leave_type"], formatdate(d["from_date"]), formatdate(d["to_date"]), form_link + ) frappe.throw(msg, OverlapError) def get_total_leaves_on_half_day(self): - leave_count_on_half_day_date = frappe.db.sql("""select count(name) from `tabLeave Application` + leave_count_on_half_day_date = frappe.db.sql( + """select count(name) from `tabLeave Application` where employee = %(employee)s and docstatus < 2 and status in ("Open", "Approved") and half_day = 1 and half_day_date = %(half_day_date)s - and name != %(name)s""", { - "employee": self.employee, - "half_day_date": self.half_day_date, - "name": self.name - })[0][0] + and name != %(name)s""", + {"employee": self.employee, "half_day_date": self.half_day_date, "name": self.name}, + )[0][0] return leave_count_on_half_day_date * 0.5 @@ -301,24 +454,36 @@ class LeaveApplication(Document): frappe.throw(_("Leave of type {0} cannot be longer than {1}").format(self.leave_type, max_days)) def validate_attendance(self): - attendance = frappe.db.sql("""select name from `tabAttendance` where employee = %s and (attendance_date between %s and %s) + attendance = frappe.db.sql( + """select name from `tabAttendance` where employee = %s and (attendance_date between %s and %s) and status = "Present" and docstatus = 1""", - (self.employee, self.from_date, self.to_date)) + (self.employee, self.from_date, self.to_date), + ) if attendance: - frappe.throw(_("Attendance for employee {0} is already marked for this day").format(self.employee), - AttendanceAlreadyMarkedError) + frappe.throw( + _("Attendance for employee {0} is already marked for this day").format(self.employee), + AttendanceAlreadyMarkedError, + ) def validate_optional_leave(self): leave_period = get_leave_period(self.from_date, self.to_date, self.company) if not leave_period: frappe.throw(_("Cannot find active Leave Period")) - optional_holiday_list = frappe.db.get_value("Leave Period", leave_period[0]["name"], "optional_holiday_list") + optional_holiday_list = frappe.db.get_value( + "Leave Period", leave_period[0]["name"], "optional_holiday_list" + ) if not optional_holiday_list: - frappe.throw(_("Optional Holiday List not set for leave period {0}").format(leave_period[0]["name"])) + frappe.throw( + _("Optional Holiday List not set for leave period {0}").format(leave_period[0]["name"]) + ) day = getdate(self.from_date) while day <= getdate(self.to_date): - if not frappe.db.exists({"doctype": "Holiday", "parent": optional_holiday_list, "holiday_date": day}): - frappe.throw(_("{0} is not in Optional Holiday List").format(formatdate(day)), NotAnOptionalHoliday) + if not frappe.db.exists( + {"doctype": "Holiday", "parent": optional_holiday_list, "holiday_date": day} + ): + frappe.throw( + _("{0} is not in Optional Holiday List").format(formatdate(day)), NotAnOptionalHoliday + ) day = add_days(day, 1) def set_half_day_date(self): @@ -333,44 +498,50 @@ class LeaveApplication(Document): if not employee.user_id: return - parent_doc = frappe.get_doc('Leave Application', self.name) + parent_doc = frappe.get_doc("Leave Application", self.name) args = parent_doc.as_dict() - template = frappe.db.get_single_value('HR Settings', 'leave_status_notification_template') + template = frappe.db.get_single_value("HR Settings", "leave_status_notification_template") if not template: frappe.msgprint(_("Please set default template for Leave Status Notification in HR Settings.")) return email_template = frappe.get_doc("Email Template", template) message = frappe.render_template(email_template.response, args) - self.notify({ - # for post in messages - "message": message, - "message_to": employee.user_id, - # for email - "subject": email_template.subject, - "notify": "employee" - }) + self.notify( + { + # for post in messages + "message": message, + "message_to": employee.user_id, + # for email + "subject": email_template.subject, + "notify": "employee", + } + ) def notify_leave_approver(self): if self.leave_approver: - parent_doc = frappe.get_doc('Leave Application', self.name) + parent_doc = frappe.get_doc("Leave Application", self.name) args = parent_doc.as_dict() - template = frappe.db.get_single_value('HR Settings', 'leave_approval_notification_template') + template = frappe.db.get_single_value("HR Settings", "leave_approval_notification_template") if not template: - frappe.msgprint(_("Please set default template for Leave Approval Notification in HR Settings.")) + frappe.msgprint( + _("Please set default template for Leave Approval Notification in HR Settings.") + ) return email_template = frappe.get_doc("Email Template", template) message = frappe.render_template(email_template.response, args) - self.notify({ - # for post in messages - "message": message, - "message_to": self.leave_approver, - # for email - "subject": email_template.subject - }) + self.notify( + { + # for post in messages + "message": message, + "message_to": self.leave_approver, + # for email + "subject": email_template.subject, + } + ) def notify(self, args): args = frappe._dict(args) @@ -379,94 +550,195 @@ class LeaveApplication(Document): contact = args.message_to if not isinstance(contact, list): if not args.notify == "employee": - contact = frappe.get_doc('User', contact).email or contact + contact = frappe.get_doc("User", contact).email or contact - sender = dict() - sender['email'] = frappe.get_doc('User', frappe.session.user).email - sender['full_name'] = get_fullname(sender['email']) + sender = dict() + sender["email"] = frappe.get_doc("User", frappe.session.user).email + sender["full_name"] = get_fullname(sender["email"]) try: frappe.sendmail( - recipients = contact, - sender = sender['email'], - subject = args.subject, - message = args.message, + recipients=contact, + sender=sender["email"], + subject=args.subject, + message=args.message, ) frappe.msgprint(_("Email sent to {0}").format(contact)) except frappe.OutgoingEmailError: pass def create_leave_ledger_entry(self, submit=True): - if self.status != 'Approved' and submit: + if self.status != "Approved" and submit: return - expiry_date = get_allocation_expiry(self.employee, self.leave_type, - self.to_date, self.from_date) - + expiry_date = get_allocation_expiry_for_cf_leaves( + self.employee, self.leave_type, self.to_date, self.from_date + ) lwp = frappe.db.get_value("Leave Type", self.leave_type, "is_lwp") if expiry_date: self.create_ledger_entry_for_intermediate_allocation_expiry(expiry_date, submit, lwp) else: - raise_exception = True - if frappe.flags.in_patch: - raise_exception=False + alloc_on_from_date, alloc_on_to_date = self.get_allocation_based_on_application_dates() + if self.is_separate_ledger_entry_required(alloc_on_from_date, alloc_on_to_date): + # required only if negative balance is allowed for leave type + # else will be stopped in validation itself + self.create_separate_ledger_entries(alloc_on_from_date, alloc_on_to_date, submit, lwp) + else: + raise_exception = False if frappe.flags.in_patch else True + args = dict( + leaves=self.total_leave_days * -1, + from_date=self.from_date, + to_date=self.to_date, + is_lwp=lwp, + holiday_list=get_holiday_list_for_employee(self.employee, raise_exception=raise_exception) + or "", + ) + create_leave_ledger_entry(self, args, submit) - args = dict( - leaves=self.total_leave_days * -1, - from_date=self.from_date, - to_date=self.to_date, - is_lwp=lwp, - holiday_list=get_holiday_list_for_employee(self.employee, raise_exception=raise_exception) or '' + def is_separate_ledger_entry_required( + self, alloc_on_from_date: Optional[Dict] = None, alloc_on_to_date: Optional[Dict] = None + ) -> bool: + """Checks if application dates fall in separate allocations""" + if ( + (alloc_on_from_date and not alloc_on_to_date) + or (not alloc_on_from_date and alloc_on_to_date) + or ( + alloc_on_from_date and alloc_on_to_date and alloc_on_from_date.name != alloc_on_to_date.name + ) + ): + return True + return False + + def create_separate_ledger_entries(self, alloc_on_from_date, alloc_on_to_date, submit, lwp): + """Creates separate ledger entries for application period falling into separate allocations""" + # for creating separate ledger entries existing allocation periods should be consecutive + if ( + submit + and alloc_on_from_date + and alloc_on_to_date + and add_days(alloc_on_from_date.to_date, 1) != alloc_on_to_date.from_date + ): + frappe.throw( + _( + "Leave Application period cannot be across two non-consecutive leave allocations {0} and {1}." + ).format( + get_link_to_form("Leave Allocation", alloc_on_from_date.name), + get_link_to_form("Leave Allocation", alloc_on_to_date), + ) + ) + + raise_exception = False if frappe.flags.in_patch else True + + if alloc_on_from_date: + first_alloc_end = alloc_on_from_date.to_date + second_alloc_start = add_days(alloc_on_from_date.to_date, 1) + else: + first_alloc_end = add_days(alloc_on_to_date.from_date, -1) + second_alloc_start = alloc_on_to_date.from_date + + leaves_in_first_alloc = get_number_of_leave_days( + self.employee, + self.leave_type, + self.from_date, + first_alloc_end, + self.half_day, + self.half_day_date, + ) + leaves_in_second_alloc = get_number_of_leave_days( + self.employee, + self.leave_type, + second_alloc_start, + self.to_date, + self.half_day, + self.half_day_date, + ) + + args = dict( + is_lwp=lwp, + holiday_list=get_holiday_list_for_employee(self.employee, raise_exception=raise_exception) + or "", + ) + + if leaves_in_first_alloc: + args.update( + dict(from_date=self.from_date, to_date=first_alloc_end, leaves=leaves_in_first_alloc * -1) + ) + create_leave_ledger_entry(self, args, submit) + + if leaves_in_second_alloc: + args.update( + dict(from_date=second_alloc_start, to_date=self.to_date, leaves=leaves_in_second_alloc * -1) ) create_leave_ledger_entry(self, args, submit) def create_ledger_entry_for_intermediate_allocation_expiry(self, expiry_date, submit, lwp): - ''' splits leave application into two ledger entries to consider expiry of allocation ''' + """Splits leave application into two ledger entries to consider expiry of allocation""" + raise_exception = False if frappe.flags.in_patch else True - raise_exception = True - if frappe.flags.in_patch: - raise_exception=False - - args = dict( - from_date=self.from_date, - to_date=expiry_date, - leaves=(date_diff(expiry_date, self.from_date) + 1) * -1, - is_lwp=lwp, - holiday_list=get_holiday_list_for_employee(self.employee, raise_exception=raise_exception) or '' + leaves = get_number_of_leave_days( + self.employee, self.leave_type, self.from_date, expiry_date, self.half_day, self.half_day_date ) - create_leave_ledger_entry(self, args, submit) + + if leaves: + args = dict( + from_date=self.from_date, + to_date=expiry_date, + leaves=leaves * -1, + is_lwp=lwp, + holiday_list=get_holiday_list_for_employee(self.employee, raise_exception=raise_exception) + or "", + ) + create_leave_ledger_entry(self, args, submit) if getdate(expiry_date) != getdate(self.to_date): start_date = add_days(expiry_date, 1) - args.update(dict( - from_date=start_date, - to_date=self.to_date, - leaves=date_diff(self.to_date, expiry_date) * -1 - )) - create_leave_ledger_entry(self, args, submit) + leaves = get_number_of_leave_days( + self.employee, self.leave_type, start_date, self.to_date, self.half_day, self.half_day_date + ) + + if leaves: + args.update(dict(from_date=start_date, to_date=self.to_date, leaves=leaves * -1)) + create_leave_ledger_entry(self, args, submit) -def get_allocation_expiry(employee, leave_type, to_date, from_date): - ''' Returns expiry of carry forward allocation in leave ledger entry ''' - expiry = frappe.get_all("Leave Ledger Entry", +def get_allocation_expiry_for_cf_leaves( + employee: str, leave_type: str, to_date: str, from_date: str +) -> str: + """Returns expiry of carry forward allocation in leave ledger entry""" + expiry = frappe.get_all( + "Leave Ledger Entry", filters={ - 'employee': employee, - 'leave_type': leave_type, - 'is_carry_forward': 1, - 'transaction_type': 'Leave Allocation', - 'to_date': ['between', (from_date, to_date)] - },fields=['to_date']) - return expiry[0]['to_date'] if expiry else None + "employee": employee, + "leave_type": leave_type, + "is_carry_forward": 1, + "transaction_type": "Leave Allocation", + "to_date": ["between", (from_date, to_date)], + "docstatus": 1, + }, + fields=["to_date"], + ) + return expiry[0]["to_date"] if expiry else "" + @frappe.whitelist() -def get_number_of_leave_days(employee, leave_type, from_date, to_date, half_day = None, half_day_date = None, holiday_list = None): +def get_number_of_leave_days( + employee: str, + leave_type: str, + from_date: str, + to_date: str, + half_day: Optional[int] = None, + half_day_date: Optional[str] = None, + holiday_list: Optional[str] = None, +) -> float: + """Returns number of leave days between 2 dates after considering half day and holidays + (Based on the include_holiday setting in Leave Type)""" number_of_days = 0 if cint(half_day) == 1: - if from_date == to_date: + if getdate(from_date) == getdate(to_date): number_of_days = 0.5 - elif half_day_date and half_day_date <= to_date: - number_of_days = date_diff(to_date, from_date) + .5 + elif half_day_date and getdate(from_date) <= getdate(half_day_date) <= getdate(to_date): + number_of_days = date_diff(to_date, from_date) + 0.5 else: number_of_days = date_diff(to_date, from_date) + 1 @@ -474,59 +746,69 @@ def get_number_of_leave_days(employee, leave_type, from_date, to_date, half_day number_of_days = date_diff(to_date, from_date) + 1 if not frappe.db.get_value("Leave Type", leave_type, "include_holiday"): - number_of_days = flt(number_of_days) - flt(get_holidays(employee, from_date, to_date, holiday_list=holiday_list)) + number_of_days = flt(number_of_days) - flt( + get_holidays(employee, from_date, to_date, holiday_list=holiday_list) + ) return number_of_days + @frappe.whitelist() def get_leave_details(employee, date): allocation_records = get_leave_allocation_records(employee, date) leave_allocation = {} for d in allocation_records: allocation = allocation_records.get(d, frappe._dict()) - - total_allocated_leaves = frappe.db.get_value('Leave Allocation', { - 'from_date': ('<=', date), - 'to_date': ('>=', date), - 'employee': employee, - 'leave_type': allocation.leave_type, - }, 'SUM(total_leaves_allocated)') or 0 - - remaining_leaves = get_leave_balance_on(employee, d, date, to_date = allocation.to_date, - consider_all_leaves_in_the_allocation_period=True) + remaining_leaves = get_leave_balance_on( + employee, d, date, to_date=allocation.to_date, consider_all_leaves_in_the_allocation_period=True + ) end_date = allocation.to_date leaves_taken = get_leaves_for_period(employee, d, allocation.from_date, end_date) * -1 - leaves_pending = get_pending_leaves_for_period(employee, d, allocation.from_date, end_date) + leaves_pending = get_leaves_pending_approval_for_period( + employee, d, allocation.from_date, end_date + ) + expired_leaves = allocation.total_leaves_allocated - (remaining_leaves + leaves_taken) leave_allocation[d] = { - "total_leaves": total_allocated_leaves, - "expired_leaves": total_allocated_leaves - (remaining_leaves + leaves_taken), + "total_leaves": allocation.total_leaves_allocated, + "expired_leaves": expired_leaves if expired_leaves > 0 else 0, "leaves_taken": leaves_taken, - "pending_leaves": leaves_pending, - "remaining_leaves": remaining_leaves} + "leaves_pending_approval": leaves_pending, + "remaining_leaves": remaining_leaves, + } - #is used in set query - lwps = frappe.get_list("Leave Type", filters = {"is_lwp": 1}) - lwps = [lwp.name for lwp in lwps] + # is used in set query + lwp = frappe.get_list("Leave Type", filters={"is_lwp": 1}, pluck="name") - ret = { - 'leave_allocation': leave_allocation, - 'leave_approver': get_leave_approver(employee), - 'lwps': lwps + return { + "leave_allocation": leave_allocation, + "leave_approver": get_leave_approver(employee), + "lwps": lwp, } - return ret @frappe.whitelist() -def get_leave_balance_on(employee, leave_type, date, to_date=None, consider_all_leaves_in_the_allocation_period=False): - ''' - Returns leave balance till date - :param employee: employee name - :param leave_type: leave type - :param date: date to check balance on - :param to_date: future date to check for allocation expiry - :param consider_all_leaves_in_the_allocation_period: consider all leaves taken till the allocation end date - ''' +def get_leave_balance_on( + employee: str, + leave_type: str, + date: str, + to_date: str = None, + consider_all_leaves_in_the_allocation_period: bool = False, + for_consumption: bool = False, +): + """ + Returns leave balance till date + :param employee: employee name + :param leave_type: leave type + :param date: date to check balance on + :param to_date: future date to check for allocation expiry + :param consider_all_leaves_in_the_allocation_period: consider all leaves taken till the allocation end date + :param for_consumption: flag to check if leave balance is required for consumption or display + eg: employee has leave balance = 10 but allocation is expiring in 1 day so employee can only consume 1 leave + in this case leave_balance = 10 but leave_balance_for_consumption = 1 + if True, returns a dict eg: {'leave_balance': 10, 'leave_balance_for_consumption': 1} + else, returns leave_balance (in this case 10) + """ if not to_date: to_date = nowdate() @@ -534,98 +816,148 @@ def get_leave_balance_on(employee, leave_type, date, to_date=None, consider_all_ allocation_records = get_leave_allocation_records(employee, date, leave_type) allocation = allocation_records.get(leave_type, frappe._dict()) - end_date = allocation.to_date if consider_all_leaves_in_the_allocation_period else date - expiry = get_allocation_expiry(employee, leave_type, to_date, date) + end_date = allocation.to_date if cint(consider_all_leaves_in_the_allocation_period) else date + cf_expiry = get_allocation_expiry_for_cf_leaves(employee, leave_type, to_date, date) leaves_taken = get_leaves_for_period(employee, leave_type, allocation.from_date, end_date) - return get_remaining_leaves(allocation, leaves_taken, date, expiry) + remaining_leaves = get_remaining_leaves(allocation, leaves_taken, date, cf_expiry) + + if for_consumption: + return remaining_leaves + else: + return remaining_leaves.get("leave_balance") + def get_leave_allocation_records(employee, date, leave_type=None): - ''' returns the total allocated leaves and carry forwarded leaves based on ledger entries ''' + """Returns the total allocated leaves and carry forwarded leaves based on ledger entries""" + Ledger = frappe.qb.DocType("Leave Ledger Entry") - conditions = ("and leave_type='%s'" % leave_type) if leave_type else "" - allocation_details = frappe.db.sql(""" - SELECT - SUM(CASE WHEN is_carry_forward = 1 THEN leaves ELSE 0 END) as cf_leaves, - SUM(CASE WHEN is_carry_forward = 0 THEN leaves ELSE 0 END) as new_leaves, - MIN(from_date) as from_date, - MAX(to_date) as to_date, - leave_type - FROM `tabLeave Ledger Entry` - WHERE - from_date <= %(date)s - AND to_date >= %(date)s - AND docstatus=1 - AND transaction_type="Leave Allocation" - AND employee=%(employee)s - AND is_expired=0 - AND is_lwp=0 - {0} - GROUP BY employee, leave_type - """.format(conditions), dict(date=date, employee=employee), as_dict=1) #nosec + cf_leave_case = ( + frappe.qb.terms.Case().when(Ledger.is_carry_forward == "1", Ledger.leaves).else_(0) + ) + sum_cf_leaves = Sum(cf_leave_case).as_("cf_leaves") + + new_leaves_case = ( + frappe.qb.terms.Case().when(Ledger.is_carry_forward == "0", Ledger.leaves).else_(0) + ) + sum_new_leaves = Sum(new_leaves_case).as_("new_leaves") + + query = ( + frappe.qb.from_(Ledger) + .select( + sum_cf_leaves, + sum_new_leaves, + Min(Ledger.from_date).as_("from_date"), + Max(Ledger.to_date).as_("to_date"), + Ledger.leave_type, + ) + .where( + (Ledger.from_date <= date) + & (Ledger.to_date >= date) + & (Ledger.docstatus == 1) + & (Ledger.transaction_type == "Leave Allocation") + & (Ledger.employee == employee) + & (Ledger.is_expired == 0) + & (Ledger.is_lwp == 0) + ) + ) + + if leave_type: + query = query.where((Ledger.leave_type == leave_type)) + query = query.groupby(Ledger.employee, Ledger.leave_type) + + allocation_details = query.run(as_dict=True) allocated_leaves = frappe._dict() for d in allocation_details: - allocated_leaves.setdefault(d.leave_type, frappe._dict({ - "from_date": d.from_date, - "to_date": d.to_date, - "total_leaves_allocated": flt(d.cf_leaves) + flt(d.new_leaves), - "unused_leaves": d.cf_leaves, - "new_leaves_allocated": d.new_leaves, - "leave_type": d.leave_type - })) + allocated_leaves.setdefault( + d.leave_type, + frappe._dict( + { + "from_date": d.from_date, + "to_date": d.to_date, + "total_leaves_allocated": flt(d.cf_leaves) + flt(d.new_leaves), + "unused_leaves": d.cf_leaves, + "new_leaves_allocated": d.new_leaves, + "leave_type": d.leave_type, + } + ), + ) return allocated_leaves -def get_pending_leaves_for_period(employee, leave_type, from_date, to_date): - ''' Returns leaves that are pending approval ''' - leaves = frappe.get_all("Leave Application", - filters={ - "employee": employee, - "leave_type": leave_type, - "status": "Open" - }, + +def get_leaves_pending_approval_for_period( + employee: str, leave_type: str, from_date: str, to_date: str +) -> float: + """Returns leaves that are pending for approval""" + leaves = frappe.get_all( + "Leave Application", + filters={"employee": employee, "leave_type": leave_type, "status": "Open"}, or_filters={ "from_date": ["between", (from_date, to_date)], - "to_date": ["between", (from_date, to_date)] - }, fields=['SUM(total_leave_days) as leaves'])[0] - return leaves['leaves'] if leaves['leaves'] else 0.0 + "to_date": ["between", (from_date, to_date)], + }, + fields=["SUM(total_leave_days) as leaves"], + )[0] + return leaves["leaves"] if leaves["leaves"] else 0.0 + + +def get_remaining_leaves( + allocation: Dict, leaves_taken: float, date: str, cf_expiry: str +) -> Dict[str, float]: + """Returns a dict of leave_balance and leave_balance_for_consumption + leave_balance returns the available leave balance + leave_balance_for_consumption returns the minimum leaves remaining after comparing with remaining days for allocation expiry + """ -def get_remaining_leaves(allocation, leaves_taken, date, expiry): - ''' Returns minimum leaves remaining after comparing with remaining days for allocation expiry ''' def _get_remaining_leaves(remaining_leaves, end_date): - + """Returns minimum leaves remaining after comparing with remaining days for allocation expiry""" if remaining_leaves > 0: remaining_days = date_diff(end_date, date) + 1 remaining_leaves = min(remaining_days, remaining_leaves) return remaining_leaves - total_leaves = flt(allocation.total_leaves_allocated) + flt(leaves_taken) + leave_balance = leave_balance_for_consumption = flt(allocation.total_leaves_allocated) + flt( + leaves_taken + ) - if expiry and allocation.unused_leaves: - remaining_leaves = flt(allocation.unused_leaves) + flt(leaves_taken) - remaining_leaves = _get_remaining_leaves(remaining_leaves, expiry) + # balance for carry forwarded leaves + if cf_expiry and allocation.unused_leaves: + cf_leaves = flt(allocation.unused_leaves) + flt(leaves_taken) + remaining_cf_leaves = _get_remaining_leaves(cf_leaves, cf_expiry) - total_leaves = flt(allocation.new_leaves_allocated) + flt(remaining_leaves) + leave_balance = flt(allocation.new_leaves_allocated) + flt(cf_leaves) + leave_balance_for_consumption = flt(allocation.new_leaves_allocated) + flt(remaining_cf_leaves) - return _get_remaining_leaves(total_leaves, allocation.to_date) + remaining_leaves = _get_remaining_leaves(leave_balance_for_consumption, allocation.to_date) + return frappe._dict(leave_balance=leave_balance, leave_balance_for_consumption=remaining_leaves) -def get_leaves_for_period(employee, leave_type, from_date, to_date, do_not_skip_expired_leaves=False): + +def get_leaves_for_period( + employee: str, leave_type: str, from_date: str, to_date: str, skip_expired_leaves: bool = True +) -> float: leave_entries = get_leave_entries(employee, leave_type, from_date, to_date) leave_days = 0 for leave_entry in leave_entries: - inclusive_period = leave_entry.from_date >= getdate(from_date) and leave_entry.to_date <= getdate(to_date) + inclusive_period = leave_entry.from_date >= getdate( + from_date + ) and leave_entry.to_date <= getdate(to_date) - if inclusive_period and leave_entry.transaction_type == 'Leave Encashment': + if inclusive_period and leave_entry.transaction_type == "Leave Encashment": leave_days += leave_entry.leaves - elif inclusive_period and leave_entry.transaction_type == 'Leave Allocation' and leave_entry.is_expired \ - and (do_not_skip_expired_leaves or not skip_expiry_leaves(leave_entry, to_date)): + elif ( + inclusive_period + and leave_entry.transaction_type == "Leave Allocation" + and leave_entry.is_expired + and not skip_expired_leaves + ): leave_days += leave_entry.leaves - elif leave_entry.transaction_type == 'Leave Application': + elif leave_entry.transaction_type == "Leave Application": if leave_entry.from_date < getdate(from_date): leave_entry.from_date = from_date if leave_entry.to_date > getdate(to_date): @@ -636,23 +968,30 @@ def get_leaves_for_period(employee, leave_type, from_date, to_date, do_not_skip_ # fetch half day date for leaves with half days if leave_entry.leaves % 1: half_day = 1 - half_day_date = frappe.db.get_value('Leave Application', - {'name': leave_entry.transaction_name}, ['half_day_date']) + half_day_date = frappe.db.get_value( + "Leave Application", {"name": leave_entry.transaction_name}, ["half_day_date"] + ) - leave_days += get_number_of_leave_days(employee, leave_type, - leave_entry.from_date, leave_entry.to_date, half_day, half_day_date, holiday_list=leave_entry.holiday_list) * -1 + leave_days += ( + get_number_of_leave_days( + employee, + leave_type, + leave_entry.from_date, + leave_entry.to_date, + half_day, + half_day_date, + holiday_list=leave_entry.holiday_list, + ) + * -1 + ) return leave_days -def skip_expiry_leaves(leave_entry, date): - ''' Checks whether the expired leaves coincide with the to_date of leave balance check. - This allows backdated leave entry creation for non carry forwarded allocation ''' - end_date = frappe.db.get_value("Leave Allocation", {'name': leave_entry.transaction_name}, ['to_date']) - return True if end_date == date and not leave_entry.is_carry_forward else False def get_leave_entries(employee, leave_type, from_date, to_date): - ''' Returns leave entries between from_date and to_date. ''' - return frappe.db.sql(""" + """Returns leave entries between from_date and to_date.""" + return frappe.db.sql( + """ SELECT employee, leave_type, from_date, to_date, leaves, transaction_name, transaction_type, holiday_list, is_carry_forward, is_expired @@ -664,44 +1003,47 @@ def get_leave_entries(employee, leave_type, from_date, to_date): AND (from_date between %(from_date)s AND %(to_date)s OR to_date between %(from_date)s AND %(to_date)s OR (from_date < %(from_date)s AND to_date > %(to_date)s)) - """, { - "from_date": from_date, - "to_date": to_date, - "employee": employee, - "leave_type": leave_type - }, as_dict=1) + """, + {"from_date": from_date, "to_date": to_date, "employee": employee, "leave_type": leave_type}, + as_dict=1, + ) + @frappe.whitelist() -def get_holidays(employee, from_date, to_date, holiday_list = None): - '''get holidays between two dates for the given employee''' +def get_holidays(employee, from_date, to_date, holiday_list=None): + """get holidays between two dates for the given employee""" if not holiday_list: holiday_list = get_holiday_list_for_employee(employee) - holidays = frappe.db.sql("""select count(distinct holiday_date) from `tabHoliday` h1, `tabHoliday List` h2 + holidays = frappe.db.sql( + """select count(distinct holiday_date) from `tabHoliday` h1, `tabHoliday List` h2 where h1.parent = h2.name and h1.holiday_date between %s and %s - and h2.name = %s""", (from_date, to_date, holiday_list))[0][0] + and h2.name = %s""", + (from_date, to_date, holiday_list), + )[0][0] return holidays + def is_lwp(leave_type): lwp = frappe.db.sql("select is_lwp from `tabLeave Type` where name = %s", leave_type) return lwp and cint(lwp[0][0]) or 0 + @frappe.whitelist() def get_events(start, end, filters=None): from frappe.desk.reportview import get_filters_cond + events = [] - employee = frappe.db.get_value("Employee", - filters={"user_id": frappe.session.user}, - fieldname=["name", "company"], - as_dict=True + employee = frappe.db.get_value( + "Employee", filters={"user_id": frappe.session.user}, fieldname=["name", "company"], as_dict=True ) if employee: employee, company = employee.name, employee.company else: - employee = '' + employee = "" company = frappe.db.get_value("Global Defaults", None, "default_company") conditions = get_filters_cond("Leave Application", filters, []) @@ -715,6 +1057,7 @@ def get_events(start, end, filters=None): return events + def add_department_leaves(events, start, end, employee, company): department = frappe.db.get_value("Employee", employee, "department") @@ -722,18 +1065,24 @@ def add_department_leaves(events, start, end, employee, company): return # department leaves - department_employees = frappe.db.sql_list("""select name from tabEmployee where department=%s - and company=%s""", (department, company)) + department_employees = frappe.db.sql_list( + """select name from tabEmployee where department=%s + and company=%s""", + (department, company), + ) - filter_conditions = " and employee in (\"%s\")" % '", "'.join(department_employees) + filter_conditions = ' and employee in ("%s")' % '", "'.join(department_employees) add_leaves(events, start, end, filter_conditions=filter_conditions) def add_leaves(events, start, end, filter_conditions=None): from frappe.desk.reportview import build_match_conditions + conditions = [] - if not cint(frappe.db.get_value("HR Settings", None, "show_leaves_of_all_department_members_in_calendar")): + if not cint( + frappe.db.get_value("HR Settings", None, "show_leaves_of_all_department_members_in_calendar") + ): match_conditions = build_match_conditions("Leave Application") if match_conditions: @@ -754,16 +1103,16 @@ def add_leaves(events, start, end, filter_conditions=None): WHERE from_date <= %(end)s AND to_date >= %(start)s <= to_date AND docstatus < 2 - AND status != 'Rejected' + AND status in ('Approved', 'Open') """ if conditions: - query += ' AND ' + ' AND '.join(conditions) + query += " AND " + " AND ".join(conditions) if filter_conditions: query += filter_conditions - for d in frappe.db.sql(query, {"start":start, "end": end}, as_dict=True): + for d in frappe.db.sql(query, {"start": start, "end": end}, as_dict=True): e = { "name": d.name, "doctype": "Leave Application", @@ -772,7 +1121,9 @@ def add_leaves(events, start, end, filter_conditions=None): "docstatus": d.docstatus, "color": d.color, "all_day": int(not d.half_day), - "title": cstr(d.employee_name) + f' ({cstr(d.leave_type)})' + (' ' + _('(Half Day)') if d.half_day else ''), + "title": cstr(d.employee_name) + + f" ({cstr(d.leave_type)})" + + (" " + _("(Half Day)") if d.half_day else ""), } if e not in events: events.append(e) @@ -786,62 +1137,81 @@ def add_block_dates(events, start, end, employee, company): block_dates = get_applicable_block_dates(start, end, employee, company, all_lists=True) for block_date in block_dates: - events.append({ - "doctype": "Leave Block List Date", - "from_date": block_date.block_date, - "to_date": block_date.block_date, - "title": _("Leave Blocked") + ": " + block_date.reason, - "name": "_" + str(cnt), - }) - cnt+=1 + events.append( + { + "doctype": "Leave Block List Date", + "from_date": block_date.block_date, + "to_date": block_date.block_date, + "title": _("Leave Blocked") + ": " + block_date.reason, + "name": "_" + str(cnt), + } + ) + cnt += 1 + def add_holidays(events, start, end, employee, company): applicable_holiday_list = get_holiday_list_for_employee(employee, company) if not applicable_holiday_list: return - for holiday in frappe.db.sql("""select name, holiday_date, description + for holiday in frappe.db.sql( + """select name, holiday_date, description from `tabHoliday` where parent=%s and holiday_date between %s and %s""", - (applicable_holiday_list, start, end), as_dict=True): - events.append({ + (applicable_holiday_list, start, end), + as_dict=True, + ): + events.append( + { "doctype": "Holiday", "from_date": holiday.holiday_date, - "to_date": holiday.holiday_date, + "to_date": holiday.holiday_date, "title": _("Holiday") + ": " + cstr(holiday.description), - "name": holiday.name - }) + "name": holiday.name, + } + ) + @frappe.whitelist() def get_mandatory_approval(doctype): mandatory = "" if doctype == "Leave Application": - mandatory = frappe.db.get_single_value('HR Settings', - 'leave_approver_mandatory_in_leave_application') + mandatory = frappe.db.get_single_value( + "HR Settings", "leave_approver_mandatory_in_leave_application" + ) else: - mandatory = frappe.db.get_single_value('HR Settings', - 'expense_approver_mandatory_in_expense_claim') + mandatory = frappe.db.get_single_value( + "HR Settings", "expense_approver_mandatory_in_expense_claim" + ) return mandatory -def get_approved_leaves_for_period(employee, leave_type, from_date, to_date): - query = """ - select employee, leave_type, from_date, to_date, total_leave_days - from `tabLeave Application` - where employee=%(employee)s - and docstatus=1 - and (from_date between %(from_date)s and %(to_date)s - or to_date between %(from_date)s and %(to_date)s - or (from_date < %(from_date)s and to_date > %(to_date)s)) - """ - if leave_type: - query += "and leave_type=%(leave_type)s" - leave_applications = frappe.db.sql(query,{ - "from_date": from_date, - "to_date": to_date, - "employee": employee, - "leave_type": leave_type - }, as_dict=1) +def get_approved_leaves_for_period(employee, leave_type, from_date, to_date): + LeaveApplication = frappe.qb.DocType("Leave Application") + query = ( + frappe.qb.from_(LeaveApplication) + .select( + LeaveApplication.employee, + LeaveApplication.leave_type, + LeaveApplication.from_date, + LeaveApplication.to_date, + LeaveApplication.total_leave_days, + ) + .where( + (LeaveApplication.employee == employee) + & (LeaveApplication.docstatus == 1) + & (LeaveApplication.status == "Approved") + & ( + (LeaveApplication.from_date.between(from_date, to_date)) + | (LeaveApplication.to_date.between(from_date, to_date)) + | ((LeaveApplication.from_date < from_date) & (LeaveApplication.to_date > to_date)) + ) + ) + ) + + if leave_type: + query = query.where(LeaveApplication.leave_type == leave_type) + leave_applications = query.run(as_dict=True) leave_days = 0 for leave_app in leave_applications: @@ -853,18 +1223,24 @@ def get_approved_leaves_for_period(employee, leave_type, from_date, to_date): if leave_app.to_date > getdate(to_date): leave_app.to_date = to_date - leave_days += get_number_of_leave_days(employee, leave_type, - leave_app.from_date, leave_app.to_date) + leave_days += get_number_of_leave_days( + employee, leave_type, leave_app.from_date, leave_app.to_date + ) return leave_days + @frappe.whitelist() def get_leave_approver(employee): - leave_approver, department = frappe.db.get_value("Employee", - employee, ["leave_approver", "department"]) + leave_approver, department = frappe.db.get_value( + "Employee", employee, ["leave_approver", "department"] + ) if not leave_approver and department: - leave_approver = frappe.db.get_value('Department Approver', {'parent': department, - 'parentfield': 'leave_approvers', 'idx': 1}, 'approver') + leave_approver = frappe.db.get_value( + "Department Approver", + {"parent": department, "parentfield": "leave_approvers", "idx": 1}, + "approver", + ) return leave_approver diff --git a/erpnext/hr/doctype/leave_application/leave_application_dashboard.html b/erpnext/hr/doctype/leave_application/leave_application_dashboard.html index 9f667a68356..e755322efda 100644 --- a/erpnext/hr/doctype/leave_application/leave_application_dashboard.html +++ b/erpnext/hr/doctype/leave_application/leave_application_dashboard.html @@ -4,11 +4,11 @@
Repayment against loan {1}".format( + self.shortfall_amount, self.against_loan + ) elif self.shortfall_amount: - remarks = _("Shortfall Repayment of {0}").format(self.shortfall_amount) + remarks = "Shortfall repayment of {0} against loan {1}".format( + self.shortfall_amount, self.against_loan + ) else: - remarks = _("Repayment against Loan: ") + self.against_loan + remarks = "Repayment against loan " + self.against_loan - if not loan_details.repay_from_salary: - if self.total_penalty_paid: - gle_map.append( - self.get_gl_dict({ - "account": loan_details.loan_account, - "against": loan_details.payment_account, + if self.reference_number: + remarks += " with reference no. {}".format(self.reference_number) + + if self.repay_from_salary: + payment_account = self.payroll_payable_account + else: + payment_account = self.payment_account + + if self.total_penalty_paid: + gle_map.append( + self.get_gl_dict( + { + "account": self.loan_account, + "against": payment_account, "debit": self.total_penalty_paid, "debit_in_account_currency": self.total_penalty_paid, "against_voucher_type": "Loan", @@ -256,81 +423,105 @@ class LoanRepayment(AccountsController): "cost_center": self.cost_center, "party_type": self.applicant_type, "party": self.applicant, - "posting_date": getdate(self.posting_date) - }) + "posting_date": getdate(self.posting_date), + } ) + ) - gle_map.append( - self.get_gl_dict({ - "account": loan_details.penalty_income_account, - "against": loan_details.payment_account, + gle_map.append( + self.get_gl_dict( + { + "account": self.penalty_income_account, + "against": self.loan_account, "credit": self.total_penalty_paid, "credit_in_account_currency": self.total_penalty_paid, "against_voucher_type": "Loan", "against_voucher": self.against_loan, "remarks": _("Penalty against loan:") + self.against_loan, "cost_center": self.cost_center, - "posting_date": getdate(self.posting_date) - }) + "posting_date": getdate(self.posting_date), + } ) + ) - gle_map.append( - self.get_gl_dict({ - "account": loan_details.payment_account, - "against": loan_details.loan_account + ", " + loan_details.interest_income_account - + ", " + loan_details.penalty_income_account, + gle_map.append( + self.get_gl_dict( + { + "account": payment_account, + "against": self.loan_account + ", " + self.penalty_income_account, "debit": self.amount_paid, "debit_in_account_currency": self.amount_paid, "against_voucher_type": "Loan", "against_voucher": self.against_loan, - "remarks": remarks, + "remarks": _(remarks), "cost_center": self.cost_center, - "posting_date": getdate(self.posting_date) - }) + "posting_date": getdate(self.posting_date), + } ) + ) - gle_map.append( - self.get_gl_dict({ - "account": loan_details.loan_account, - "party_type": loan_details.applicant_type, - "party": loan_details.applicant, - "against": loan_details.payment_account, + gle_map.append( + self.get_gl_dict( + { + "account": self.loan_account, + "party_type": self.applicant_type, + "party": self.applicant, + "against": payment_account, "credit": self.amount_paid, "credit_in_account_currency": self.amount_paid, "against_voucher_type": "Loan", "against_voucher": self.against_loan, - "remarks": remarks, + "remarks": _(remarks), "cost_center": self.cost_center, - "posting_date": getdate(self.posting_date) - }) + "posting_date": getdate(self.posting_date), + } ) + ) - if gle_map: - make_gl_entries(gle_map, cancel=cancel, adv_adj=adv_adj, merge_entries=False) + if gle_map: + make_gl_entries(gle_map, cancel=cancel, adv_adj=adv_adj, merge_entries=False) -def create_repayment_entry(loan, applicant, company, posting_date, loan_type, - payment_type, interest_payable, payable_principal_amount, amount_paid, penalty_amount=None): - lr = frappe.get_doc({ - "doctype": "Loan Repayment", - "against_loan": loan, - "payment_type": payment_type, - "company": company, - "posting_date": posting_date, - "applicant": applicant, - "penalty_amount": penalty_amount, - "interest_payable": interest_payable, - "payable_principal_amount": payable_principal_amount, - "amount_paid": amount_paid, - "loan_type": loan_type - }).insert() +def create_repayment_entry( + loan, + applicant, + company, + posting_date, + loan_type, + payment_type, + interest_payable, + payable_principal_amount, + amount_paid, + penalty_amount=None, + payroll_payable_account=None, +): + + lr = frappe.get_doc( + { + "doctype": "Loan Repayment", + "against_loan": loan, + "payment_type": payment_type, + "company": company, + "posting_date": posting_date, + "applicant": applicant, + "penalty_amount": penalty_amount, + "interest_payable": interest_payable, + "payable_principal_amount": payable_principal_amount, + "amount_paid": amount_paid, + "loan_type": loan_type, + "payroll_payable_account": payroll_payable_account, + } + ).insert() return lr + def get_accrued_interest_entries(against_loan, posting_date=None): if not posting_date: posting_date = getdate() + precision = cint(frappe.db.get_default("currency_precision")) or 2 + unpaid_accrued_entries = frappe.db.sql( """ SELECT name, posting_date, interest_amount - paid_interest_amount as interest_amount, @@ -346,25 +537,134 @@ def get_accrued_interest_entries(against_loan, posting_date=None): AND docstatus = 1 ORDER BY posting_date - """, (against_loan, posting_date), as_dict=1) + """, + (against_loan, posting_date), + as_dict=1, + ) + + # Skip entries with zero interest amount & payable principal amount + unpaid_accrued_entries = [ + d + for d in unpaid_accrued_entries + if flt(d.interest_amount, precision) > 0 or flt(d.payable_principal_amount, precision) > 0 + ] return unpaid_accrued_entries + def get_penalty_details(against_loan): - penalty_details = frappe.db.sql(""" + penalty_details = frappe.db.sql( + """ SELECT posting_date, (penalty_amount - total_penalty_paid) as pending_penalty_amount FROM `tabLoan Repayment` where posting_date >= (SELECT MAX(posting_date) from `tabLoan Repayment` where against_loan = %s) and docstatus = 1 and against_loan = %s - """, (against_loan, against_loan)) + """, + (against_loan, against_loan), + ) if penalty_details: return penalty_details[0][0], flt(penalty_details[0][1]) else: return None, 0 + +def regenerate_repayment_schedule(loan, cancel=0): + from erpnext.loan_management.doctype.loan.loan import ( + add_single_month, + get_monthly_repayment_amount, + ) + + loan_doc = frappe.get_doc("Loan", loan) + next_accrual_date = None + accrued_entries = 0 + last_repayment_amount = 0 + last_balance_amount = 0 + + for term in reversed(loan_doc.get("repayment_schedule")): + if not term.is_accrued: + next_accrual_date = term.payment_date + loan_doc.remove(term) + else: + accrued_entries += 1 + if not last_repayment_amount: + last_repayment_amount = term.total_payment + if not last_balance_amount: + last_balance_amount = term.balance_loan_amount + + loan_doc.save() + + balance_amount = get_pending_principal_amount(loan_doc) + + if loan_doc.repayment_method == "Repay Fixed Amount per Period": + monthly_repayment_amount = flt( + balance_amount / len(loan_doc.get("repayment_schedule")) - accrued_entries + ) + else: + repayment_period = loan_doc.repayment_periods - accrued_entries + if not cancel and repayment_period > 0: + monthly_repayment_amount = get_monthly_repayment_amount( + balance_amount, loan_doc.rate_of_interest, repayment_period + ) + else: + monthly_repayment_amount = last_repayment_amount + balance_amount = last_balance_amount + + payment_date = next_accrual_date + + while balance_amount > 0: + interest_amount = flt(balance_amount * flt(loan_doc.rate_of_interest) / (12 * 100)) + principal_amount = monthly_repayment_amount - interest_amount + balance_amount = flt(balance_amount + interest_amount - monthly_repayment_amount) + if balance_amount < 0: + principal_amount += balance_amount + balance_amount = 0.0 + + total_payment = principal_amount + interest_amount + loan_doc.append( + "repayment_schedule", + { + "payment_date": payment_date, + "principal_amount": principal_amount, + "interest_amount": interest_amount, + "total_payment": total_payment, + "balance_loan_amount": balance_amount, + }, + ) + next_payment_date = add_single_month(payment_date) + payment_date = next_payment_date + + loan_doc.save() + + +def get_pending_principal_amount(loan): + if loan.status in ("Disbursed", "Closed") or loan.disbursed_amount >= loan.loan_amount: + pending_principal_amount = ( + flt(loan.total_payment) + + flt(loan.debit_adjustment_amount) + - flt(loan.credit_adjustment_amount) + - flt(loan.total_principal_paid) + - flt(loan.total_interest_payable) + - flt(loan.written_off_amount) + + flt(loan.refund_amount) + ) + else: + pending_principal_amount = ( + flt(loan.disbursed_amount) + + flt(loan.debit_adjustment_amount) + - flt(loan.credit_adjustment_amount) + - flt(loan.total_principal_paid) + - flt(loan.total_interest_payable) + - flt(loan.written_off_amount) + + flt(loan.refund_amount) + ) + + return pending_principal_amount + + # This function returns the amounts that are payable at the time of loan repayment based on posting date # So it pulls all the unpaid Loan Interest Accrual Entries and calculates the penalty if applicable + def get_amounts(amounts, against_loan, posting_date): precision = cint(frappe.db.get_default("currency_precision")) or 2 @@ -378,8 +678,8 @@ def get_amounts(amounts, against_loan, posting_date): total_pending_interest = 0 penalty_amount = 0 payable_principal_amount = 0 - final_due_date = '' - due_date = '' + final_due_date = "" + due_date = "" for entry in accrued_interest_entries: # Loan repayment due date is one day after the loan interest is accrued @@ -395,26 +695,30 @@ def get_amounts(amounts, against_loan, posting_date): no_of_late_days = date_diff(posting_date, due_date_after_grace_period) + 1 - if no_of_late_days > 0 and (not against_loan_doc.repay_from_salary) and entry.accrual_type == 'Regular': - penalty_amount += (entry.interest_amount * (loan_type_details.penalty_interest_rate / 100) * no_of_late_days) + if ( + no_of_late_days > 0 + and (not against_loan_doc.repay_from_salary) + and entry.accrual_type == "Regular" + ): + penalty_amount += ( + entry.interest_amount * (loan_type_details.penalty_interest_rate / 100) * no_of_late_days + ) total_pending_interest += entry.interest_amount payable_principal_amount += entry.payable_principal_amount - pending_accrual_entries.setdefault(entry.name, { - 'interest_amount': flt(entry.interest_amount, precision), - 'payable_principal_amount': flt(entry.payable_principal_amount, precision) - }) + pending_accrual_entries.setdefault( + entry.name, + { + "interest_amount": flt(entry.interest_amount, precision), + "payable_principal_amount": flt(entry.payable_principal_amount, precision), + }, + ) if due_date and not final_due_date: final_due_date = add_days(due_date, loan_type_details.grace_period_in_days) - if against_loan_doc.status in ('Disbursed', 'Closed') or against_loan_doc.disbursed_amount >= against_loan_doc.loan_amount: - pending_principal_amount = against_loan_doc.total_payment - against_loan_doc.total_principal_paid \ - - against_loan_doc.total_interest_payable - against_loan_doc.written_off_amount - else: - pending_principal_amount = against_loan_doc.disbursed_amount - against_loan_doc.total_principal_paid \ - - against_loan_doc.total_interest_payable - against_loan_doc.written_off_amount + pending_principal_amount = get_pending_principal_amount(against_loan_doc) unaccrued_interest = 0 if due_date: @@ -425,40 +729,49 @@ def get_amounts(amounts, against_loan, posting_date): if pending_days > 0: principal_amount = flt(pending_principal_amount, precision) - per_day_interest = get_per_day_interest(principal_amount, loan_type_details.rate_of_interest, posting_date) - unaccrued_interest += (pending_days * per_day_interest) + per_day_interest = get_per_day_interest( + principal_amount, loan_type_details.rate_of_interest, posting_date + ) + unaccrued_interest += pending_days * per_day_interest amounts["pending_principal_amount"] = flt(pending_principal_amount, precision) amounts["payable_principal_amount"] = flt(payable_principal_amount, precision) amounts["interest_amount"] = flt(total_pending_interest, precision) amounts["penalty_amount"] = flt(penalty_amount + pending_penalty_amount, precision) - amounts["payable_amount"] = flt(payable_principal_amount + total_pending_interest + penalty_amount, precision) + amounts["payable_amount"] = flt( + payable_principal_amount + total_pending_interest + penalty_amount, precision + ) amounts["pending_accrual_entries"] = pending_accrual_entries amounts["unaccrued_interest"] = flt(unaccrued_interest, precision) + amounts["written_off_amount"] = flt(against_loan_doc.written_off_amount, precision) if final_due_date: amounts["due_date"] = final_due_date return amounts + @frappe.whitelist() -def calculate_amounts(against_loan, posting_date, payment_type=''): +def calculate_amounts(against_loan, posting_date, payment_type=""): amounts = { - 'penalty_amount': 0.0, - 'interest_amount': 0.0, - 'pending_principal_amount': 0.0, - 'payable_principal_amount': 0.0, - 'payable_amount': 0.0, - 'unaccrued_interest': 0.0, - 'due_date': '' + "penalty_amount": 0.0, + "interest_amount": 0.0, + "pending_principal_amount": 0.0, + "payable_principal_amount": 0.0, + "payable_amount": 0.0, + "unaccrued_interest": 0.0, + "due_date": "", } amounts = get_amounts(amounts, against_loan, posting_date) # update values for closure - if payment_type == 'Loan Closure': - amounts['payable_principal_amount'] = amounts['pending_principal_amount'] - amounts['interest_amount'] += amounts['unaccrued_interest'] - amounts['payable_amount'] = amounts['payable_principal_amount'] + amounts['interest_amount'] + if payment_type == "Loan Closure": + amounts["payable_principal_amount"] = amounts["pending_principal_amount"] + amounts["interest_amount"] += amounts["unaccrued_interest"] + amounts["payable_amount"] = amounts["payable_principal_amount"] + amounts["interest_amount"] + amounts["payable_amount"] = ( + amounts["payable_principal_amount"] + amounts["interest_amount"] + amounts["penalty_amount"] + ) return amounts diff --git a/erpnext/loan_management/doctype/loan_security/loan_security_dashboard.py b/erpnext/loan_management/doctype/loan_security/loan_security_dashboard.py index 8d5c525ac31..1d96885e155 100644 --- a/erpnext/loan_management/doctype/loan_security/loan_security_dashboard.py +++ b/erpnext/loan_management/doctype/loan_security/loan_security_dashboard.py @@ -1,14 +1,8 @@ - - def get_data(): return { - 'fieldname': 'loan_security', - 'transactions': [ - { - 'items': ['Loan Application', 'Loan Security Price'] - }, - { - 'items': ['Loan Security Pledge', 'Loan Security Unpledge'] - } - ] + "fieldname": "loan_security", + "transactions": [ + {"items": ["Loan Application", "Loan Security Price"]}, + {"items": ["Loan Security Pledge", "Loan Security Unpledge"]}, + ], } diff --git a/erpnext/loan_management/doctype/loan_security_pledge/loan_security_pledge.py b/erpnext/loan_management/doctype/loan_security_pledge/loan_security_pledge.py index 7d02645609b..f0d59542753 100644 --- a/erpnext/loan_management/doctype/loan_security_pledge/loan_security_pledge.py +++ b/erpnext/loan_management/doctype/loan_security_pledge/loan_security_pledge.py @@ -40,22 +40,28 @@ class LoanSecurityPledge(Document): if security.loan_security not in security_list: security_list.append(security.loan_security) else: - frappe.throw(_('Loan Security {0} added multiple times').format(frappe.bold( - security.loan_security))) + frappe.throw( + _("Loan Security {0} added multiple times").format(frappe.bold(security.loan_security)) + ) def validate_loan_security_type(self): - existing_pledge = '' + existing_pledge = "" if self.loan: - existing_pledge = frappe.db.get_value('Loan Security Pledge', {'loan': self.loan, 'docstatus': 1}, ['name']) + existing_pledge = frappe.db.get_value( + "Loan Security Pledge", {"loan": self.loan, "docstatus": 1}, ["name"] + ) if existing_pledge: - loan_security_type = frappe.db.get_value('Pledge', {'parent': existing_pledge}, ['loan_security_type']) + loan_security_type = frappe.db.get_value( + "Pledge", {"parent": existing_pledge}, ["loan_security_type"] + ) else: loan_security_type = self.securities[0].loan_security_type - ltv_ratio_map = frappe._dict(frappe.get_all("Loan Security Type", - fields=["name", "loan_to_value_ratio"], as_list=1)) + ltv_ratio_map = frappe._dict( + frappe.get_all("Loan Security Type", fields=["name", "loan_to_value_ratio"], as_list=1) + ) ltv_ratio = ltv_ratio_map.get(loan_security_type) @@ -63,7 +69,6 @@ class LoanSecurityPledge(Document): if ltv_ratio_map.get(security.loan_security_type) != ltv_ratio: frappe.throw(_("Loan Securities with different LTV ratio cannot be pledged against one loan")) - def set_pledge_amount(self): total_security_value = 0 maximum_loan_value = 0 @@ -77,10 +82,10 @@ class LoanSecurityPledge(Document): pledge.loan_security_price = get_loan_security_price(pledge.loan_security) if not pledge.qty: - pledge.qty = cint(pledge.amount/pledge.loan_security_price) + pledge.qty = cint(pledge.amount / pledge.loan_security_price) pledge.amount = pledge.qty * pledge.loan_security_price - pledge.post_haircut_amount = cint(pledge.amount - (pledge.amount * pledge.haircut/100)) + pledge.post_haircut_amount = cint(pledge.amount - (pledge.amount * pledge.haircut / 100)) total_security_value += pledge.amount maximum_loan_value += pledge.post_haircut_amount @@ -88,12 +93,19 @@ class LoanSecurityPledge(Document): self.total_security_value = total_security_value self.maximum_loan_value = maximum_loan_value + def update_loan(loan, maximum_value_against_pledge, cancel=0): - maximum_loan_value = frappe.db.get_value('Loan', {'name': loan}, ['maximum_loan_amount']) + maximum_loan_value = frappe.db.get_value("Loan", {"name": loan}, ["maximum_loan_amount"]) if cancel: - frappe.db.sql(""" UPDATE `tabLoan` SET maximum_loan_amount=%s - WHERE name=%s""", (maximum_loan_value - maximum_value_against_pledge, loan)) + frappe.db.sql( + """ UPDATE `tabLoan` SET maximum_loan_amount=%s + WHERE name=%s""", + (maximum_loan_value - maximum_value_against_pledge, loan), + ) else: - frappe.db.sql(""" UPDATE `tabLoan` SET maximum_loan_amount=%s, is_secured_loan=1 - WHERE name=%s""", (maximum_loan_value + maximum_value_against_pledge, loan)) + frappe.db.sql( + """ UPDATE `tabLoan` SET maximum_loan_amount=%s, is_secured_loan=1 + WHERE name=%s""", + (maximum_loan_value + maximum_value_against_pledge, loan), + ) diff --git a/erpnext/loan_management/doctype/loan_security_price/loan_security_price.py b/erpnext/loan_management/doctype/loan_security_price/loan_security_price.py index fca9dd6bcb9..45c4459ac3f 100644 --- a/erpnext/loan_management/doctype/loan_security_price/loan_security_price.py +++ b/erpnext/loan_management/doctype/loan_security_price/loan_security_price.py @@ -17,23 +17,37 @@ class LoanSecurityPrice(Document): if self.valid_from > self.valid_upto: frappe.throw(_("Valid From Time must be lesser than Valid Upto Time.")) - existing_loan_security = frappe.db.sql(""" SELECT name from `tabLoan Security Price` + existing_loan_security = frappe.db.sql( + """ SELECT name from `tabLoan Security Price` WHERE loan_security = %s AND name != %s AND (valid_from BETWEEN %s and %s OR valid_upto BETWEEN %s and %s) """, - (self.loan_security, self.name, self.valid_from, self.valid_upto, self.valid_from, self.valid_upto)) + ( + self.loan_security, + self.name, + self.valid_from, + self.valid_upto, + self.valid_from, + self.valid_upto, + ), + ) if existing_loan_security: frappe.throw(_("Loan Security Price overlapping with {0}").format(existing_loan_security[0][0])) + @frappe.whitelist() def get_loan_security_price(loan_security, valid_time=None): if not valid_time: valid_time = get_datetime() - loan_security_price = frappe.db.get_value("Loan Security Price", { - 'loan_security': loan_security, - 'valid_from': ("<=",valid_time), - 'valid_upto': (">=", valid_time) - }, 'loan_security_price') + loan_security_price = frappe.db.get_value( + "Loan Security Price", + { + "loan_security": loan_security, + "valid_from": ("<=", valid_time), + "valid_upto": (">=", valid_time), + }, + "loan_security_price", + ) if not loan_security_price: frappe.throw(_("No valid Loan Security Price found for {0}").format(frappe.bold(loan_security))) diff --git a/erpnext/loan_management/doctype/loan_security_shortfall/loan_security_shortfall.json b/erpnext/loan_management/doctype/loan_security_shortfall/loan_security_shortfall.json index 99b5c72b2db..d4007cb62dd 100644 --- a/erpnext/loan_management/doctype/loan_security_shortfall/loan_security_shortfall.json +++ b/erpnext/loan_management/doctype/loan_security_shortfall/loan_security_shortfall.json @@ -7,6 +7,8 @@ "engine": "InnoDB", "field_order": [ "loan", + "applicant_type", + "applicant", "status", "column_break_3", "shortfall_time", @@ -23,6 +25,8 @@ { "fieldname": "loan", "fieldtype": "Link", + "in_list_view": 1, + "in_standard_filter": 1, "label": "Loan ", "options": "Loan", "read_only": 1 @@ -91,17 +95,35 @@ { "fieldname": "shortfall_percentage", "fieldtype": "Percent", + "in_list_view": 1, "label": "Shortfall Percentage", "read_only": 1 + }, + { + "fetch_from": "loan.applicant_type", + "fieldname": "applicant_type", + "fieldtype": "Select", + "label": "Applicant Type", + "options": "Employee\nMember\nCustomer" + }, + { + "fetch_from": "loan.applicant", + "fieldname": "applicant", + "fieldtype": "Dynamic Link", + "in_list_view": 1, + "in_standard_filter": 1, + "label": "Applicant", + "options": "applicant_type" } ], "in_create": 1, "index_web_pages_for_search": 1, "links": [], - "modified": "2021-04-01 08:13:43.263772", + "modified": "2022-06-30 11:57:09.378089", "modified_by": "Administrator", "module": "Loan Management", "name": "Loan Security Shortfall", + "naming_rule": "Expression (old style)", "owner": "Administrator", "permissions": [ { @@ -132,5 +154,6 @@ "quick_entry": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/loan_management/doctype/loan_security_shortfall/loan_security_shortfall.py b/erpnext/loan_management/doctype/loan_security_shortfall/loan_security_shortfall.py index 20e451b81ea..b901e626b43 100644 --- a/erpnext/loan_management/doctype/loan_security_shortfall/loan_security_shortfall.py +++ b/erpnext/loan_management/doctype/loan_security_shortfall/loan_security_shortfall.py @@ -14,27 +14,42 @@ from erpnext.loan_management.doctype.loan_security_unpledge.loan_security_unpled class LoanSecurityShortfall(Document): pass + def update_shortfall_status(loan, security_value, on_cancel=0): - loan_security_shortfall = frappe.db.get_value("Loan Security Shortfall", - {"loan": loan, "status": "Pending"}, ['name', 'shortfall_amount'], as_dict=1) + loan_security_shortfall = frappe.db.get_value( + "Loan Security Shortfall", + {"loan": loan, "status": "Pending"}, + ["name", "shortfall_amount"], + as_dict=1, + ) if not loan_security_shortfall: return if security_value >= loan_security_shortfall.shortfall_amount: - frappe.db.set_value("Loan Security Shortfall", loan_security_shortfall.name, { - "status": "Completed", - "shortfall_amount": loan_security_shortfall.shortfall_amount, - "shortfall_percentage": 0 - }) + frappe.db.set_value( + "Loan Security Shortfall", + loan_security_shortfall.name, + { + "status": "Completed", + "shortfall_amount": loan_security_shortfall.shortfall_amount, + "shortfall_percentage": 0, + }, + ) else: - frappe.db.set_value("Loan Security Shortfall", loan_security_shortfall.name, - "shortfall_amount", loan_security_shortfall.shortfall_amount - security_value) + frappe.db.set_value( + "Loan Security Shortfall", + loan_security_shortfall.name, + "shortfall_amount", + loan_security_shortfall.shortfall_amount - security_value, + ) @frappe.whitelist() def add_security(loan): - loan_details = frappe.db.get_value("Loan", loan, ['applicant', 'company', 'applicant_type'], as_dict=1) + loan_details = frappe.db.get_value( + "Loan", loan, ["applicant", "company", "applicant_type"], as_dict=1 + ) loan_security_pledge = frappe.new_doc("Loan Security Pledge") loan_security_pledge.loan = loan @@ -44,33 +59,51 @@ def add_security(loan): return loan_security_pledge.as_dict() + def check_for_ltv_shortfall(process_loan_security_shortfall): update_time = get_datetime() - loan_security_price_map = frappe._dict(frappe.get_all("Loan Security Price", - fields=["loan_security", "loan_security_price"], - filters = { - "valid_from": ("<=", update_time), - "valid_upto": (">=", update_time) - }, as_list=1)) + loan_security_price_map = frappe._dict( + frappe.get_all( + "Loan Security Price", + fields=["loan_security", "loan_security_price"], + filters={"valid_from": ("<=", update_time), "valid_upto": (">=", update_time)}, + as_list=1, + ) + ) - loans = frappe.get_all('Loan', fields=['name', 'loan_amount', 'total_principal_paid', 'total_payment', - 'total_interest_payable', 'disbursed_amount', 'status'], - filters={'status': ('in',['Disbursed','Partially Disbursed']), 'is_secured_loan': 1}) + loans = frappe.get_all( + "Loan", + fields=[ + "name", + "loan_amount", + "total_principal_paid", + "total_payment", + "total_interest_payable", + "disbursed_amount", + "status", + ], + filters={"status": ("in", ["Disbursed", "Partially Disbursed"]), "is_secured_loan": 1}, + ) - loan_shortfall_map = frappe._dict(frappe.get_all("Loan Security Shortfall", - fields=["loan", "name"], filters={"status": "Pending"}, as_list=1)) + loan_shortfall_map = frappe._dict( + frappe.get_all( + "Loan Security Shortfall", fields=["loan", "name"], filters={"status": "Pending"}, as_list=1 + ) + ) loan_security_map = {} for loan in loans: - if loan.status == 'Disbursed': - outstanding_amount = flt(loan.total_payment) - flt(loan.total_interest_payable) \ - - flt(loan.total_principal_paid) + if loan.status == "Disbursed": + outstanding_amount = ( + flt(loan.total_payment) - flt(loan.total_interest_payable) - flt(loan.total_principal_paid) + ) else: - outstanding_amount = flt(loan.disbursed_amount) - flt(loan.total_interest_payable) \ - - flt(loan.total_principal_paid) + outstanding_amount = ( + flt(loan.disbursed_amount) - flt(loan.total_interest_payable) - flt(loan.total_principal_paid) + ) pledged_securities = get_pledged_security_qty(loan.name) ltv_ratio = 0.0 @@ -81,21 +114,36 @@ def check_for_ltv_shortfall(process_loan_security_shortfall): ltv_ratio = get_ltv_ratio(security) security_value += flt(loan_security_price_map.get(security)) * flt(qty) - current_ratio = (outstanding_amount/security_value) * 100 if security_value else 0 + current_ratio = (outstanding_amount / security_value) * 100 if security_value else 0 if current_ratio > ltv_ratio: shortfall_amount = outstanding_amount - ((security_value * ltv_ratio) / 100) - create_loan_security_shortfall(loan.name, outstanding_amount, security_value, shortfall_amount, - current_ratio, process_loan_security_shortfall) + create_loan_security_shortfall( + loan.name, + outstanding_amount, + security_value, + shortfall_amount, + current_ratio, + process_loan_security_shortfall, + ) elif loan_shortfall_map.get(loan.name): shortfall_amount = outstanding_amount - ((security_value * ltv_ratio) / 100) if shortfall_amount <= 0: shortfall = loan_shortfall_map.get(loan.name) update_pending_shortfall(shortfall) -def create_loan_security_shortfall(loan, loan_amount, security_value, shortfall_amount, shortfall_ratio, - process_loan_security_shortfall): - existing_shortfall = frappe.db.get_value("Loan Security Shortfall", {"loan": loan, "status": "Pending"}, "name") + +def create_loan_security_shortfall( + loan, + loan_amount, + security_value, + shortfall_amount, + shortfall_ratio, + process_loan_security_shortfall, +): + existing_shortfall = frappe.db.get_value( + "Loan Security Shortfall", {"loan": loan, "status": "Pending"}, "name" + ) if existing_shortfall: ltv_shortfall = frappe.get_doc("Loan Security Shortfall", existing_shortfall) @@ -111,16 +159,17 @@ def create_loan_security_shortfall(loan, loan_amount, security_value, shortfall_ ltv_shortfall.process_loan_security_shortfall = process_loan_security_shortfall ltv_shortfall.save() + def get_ltv_ratio(loan_security): - loan_security_type = frappe.db.get_value('Loan Security', loan_security, 'loan_security_type') - ltv_ratio = frappe.db.get_value('Loan Security Type', loan_security_type, 'loan_to_value_ratio') + loan_security_type = frappe.db.get_value("Loan Security", loan_security, "loan_security_type") + ltv_ratio = frappe.db.get_value("Loan Security Type", loan_security_type, "loan_to_value_ratio") return ltv_ratio + def update_pending_shortfall(shortfall): # Get all pending loan security shortfall - frappe.db.set_value("Loan Security Shortfall", shortfall, - { - "status": "Completed", - "shortfall_amount": 0, - "shortfall_percentage": 0 - }) + frappe.db.set_value( + "Loan Security Shortfall", + shortfall, + {"status": "Completed", "shortfall_amount": 0, "shortfall_percentage": 0}, + ) diff --git a/erpnext/loan_management/doctype/loan_security_type/loan_security_type_dashboard.py b/erpnext/loan_management/doctype/loan_security_type/loan_security_type_dashboard.py index daa9958808f..8fc4520ccd2 100644 --- a/erpnext/loan_management/doctype/loan_security_type/loan_security_type_dashboard.py +++ b/erpnext/loan_management/doctype/loan_security_type/loan_security_type_dashboard.py @@ -1,14 +1,8 @@ - - def get_data(): return { - 'fieldname': 'loan_security_type', - 'transactions': [ - { - 'items': ['Loan Security', 'Loan Security Price'] - }, - { - 'items': ['Loan Security Pledge', 'Loan Security Unpledge'] - } - ] + "fieldname": "loan_security_type", + "transactions": [ + {"items": ["Loan Security", "Loan Security Price"]}, + {"items": ["Loan Security Pledge", "Loan Security Unpledge"]}, + ], } diff --git a/erpnext/loan_management/doctype/loan_security_unpledge/loan_security_unpledge.py b/erpnext/loan_management/doctype/loan_security_unpledge/loan_security_unpledge.py index 8fce09ce0ab..3f773011b29 100644 --- a/erpnext/loan_management/doctype/loan_security_unpledge/loan_security_unpledge.py +++ b/erpnext/loan_management/doctype/loan_security_unpledge/loan_security_unpledge.py @@ -16,7 +16,7 @@ class LoanSecurityUnpledge(Document): def on_cancel(self): self.update_loan_status(cancel=1) - self.db_set('status', 'Requested') + self.db_set("status", "Requested") def validate_duplicate_securities(self): security_list = [] @@ -24,35 +24,54 @@ class LoanSecurityUnpledge(Document): if d.loan_security not in security_list: security_list.append(d.loan_security) else: - frappe.throw(_("Row {0}: Loan Security {1} added multiple times").format( - d.idx, frappe.bold(d.loan_security))) + frappe.throw( + _("Row {0}: Loan Security {1} added multiple times").format( + d.idx, frappe.bold(d.loan_security) + ) + ) def validate_unpledge_qty(self): + from erpnext.loan_management.doctype.loan_repayment.loan_repayment import ( + get_pending_principal_amount, + ) from erpnext.loan_management.doctype.loan_security_shortfall.loan_security_shortfall import ( get_ltv_ratio, ) pledge_qty_map = get_pledged_security_qty(self.loan) - ltv_ratio_map = frappe._dict(frappe.get_all("Loan Security Type", - fields=["name", "loan_to_value_ratio"], as_list=1)) + ltv_ratio_map = frappe._dict( + frappe.get_all("Loan Security Type", fields=["name", "loan_to_value_ratio"], as_list=1) + ) - loan_security_price_map = frappe._dict(frappe.get_all("Loan Security Price", - fields=["loan_security", "loan_security_price"], - filters = { - "valid_from": ("<=", get_datetime()), - "valid_upto": (">=", get_datetime()) - }, as_list=1)) + loan_security_price_map = frappe._dict( + frappe.get_all( + "Loan Security Price", + fields=["loan_security", "loan_security_price"], + filters={"valid_from": ("<=", get_datetime()), "valid_upto": (">=", get_datetime())}, + as_list=1, + ) + ) - loan_details = frappe.get_value("Loan", self.loan, ['total_payment', 'total_principal_paid', - 'total_interest_payable', 'written_off_amount', 'disbursed_amount', 'status'], as_dict=1) + loan_details = frappe.get_value( + "Loan", + self.loan, + [ + "total_payment", + "debit_adjustment_amount", + "credit_adjustment_amount", + "refund_amount", + "total_principal_paid", + "loan_amount", + "total_interest_payable", + "written_off_amount", + "disbursed_amount", + "status", + ], + as_dict=1, + ) - if loan_details.status == 'Disbursed': - pending_principal_amount = flt(loan_details.total_payment) - flt(loan_details.total_interest_payable) \ - - flt(loan_details.total_principal_paid) - flt(loan_details.written_off_amount) - else: - pending_principal_amount = flt(loan_details.disbursed_amount) - flt(loan_details.total_interest_payable) \ - - flt(loan_details.total_principal_paid) - flt(loan_details.written_off_amount) + pending_principal_amount = get_pending_principal_amount(loan_details) security_value = 0 unpledge_qty_map = {} @@ -61,8 +80,13 @@ class LoanSecurityUnpledge(Document): for security in self.securities: pledged_qty = pledge_qty_map.get(security.loan_security, 0) if security.qty > pledged_qty: - msg = _("Row {0}: {1} {2} of {3} is pledged against Loan {4}.").format(security.idx, pledged_qty, security.uom, - frappe.bold(security.loan_security), frappe.bold(self.loan)) + msg = _("Row {0}: {1} {2} of {3} is pledged against Loan {4}.").format( + security.idx, + pledged_qty, + security.uom, + frappe.bold(security.loan_security), + frappe.bold(self.loan), + ) msg += "
" msg += _("You are trying to unpledge more.") frappe.throw(msg, title=_("Loan Security Unpledge Error")) @@ -81,14 +105,14 @@ class LoanSecurityUnpledge(Document): if not security_value and flt(pending_principal_amount, 2) > 0: self._throw(security_value, pending_principal_amount, ltv_ratio) - if security_value and flt(pending_principal_amount/security_value) * 100 > ltv_ratio: + if security_value and flt(pending_principal_amount / security_value) * 100 > ltv_ratio: self._throw(security_value, pending_principal_amount, ltv_ratio) def _throw(self, security_value, pending_principal_amount, ltv_ratio): msg = _("Loan Security Value after unpledge is {0}").format(frappe.bold(security_value)) - msg += '
' + msg += "
" msg += _("Pending principal amount is {0}").format(frappe.bold(flt(pending_principal_amount, 2))) - msg += '
' + msg += "
" msg += _("Loan To Security Value ratio must always be {0}").format(frappe.bold(ltv_ratio)) frappe.throw(msg, title=_("Loan To Value ratio breach")) @@ -98,13 +122,13 @@ class LoanSecurityUnpledge(Document): def approve(self): if self.status == "Approved" and not self.unpledge_time: self.update_loan_status() - self.db_set('unpledge_time', get_datetime()) + self.db_set("unpledge_time", get_datetime()) def update_loan_status(self, cancel=0): if cancel: - loan_status = frappe.get_value('Loan', self.loan, 'status') - if loan_status == 'Closed': - frappe.db.set_value('Loan', self.loan, 'status', 'Loan Closure Requested') + loan_status = frappe.get_value("Loan", self.loan, "status") + if loan_status == "Closed": + frappe.db.set_value("Loan", self.loan, "status", "Loan Closure Requested") else: pledged_qty = 0 current_pledges = get_pledged_security_qty(self.loan) @@ -113,34 +137,41 @@ class LoanSecurityUnpledge(Document): pledged_qty += qty if not pledged_qty: - frappe.db.set_value('Loan', self.loan, - { - 'status': 'Closed', - 'closure_date': getdate() - }) + frappe.db.set_value("Loan", self.loan, {"status": "Closed", "closure_date": getdate()}) + @frappe.whitelist() def get_pledged_security_qty(loan): current_pledges = {} - unpledges = frappe._dict(frappe.db.sql(""" + unpledges = frappe._dict( + frappe.db.sql( + """ SELECT u.loan_security, sum(u.qty) as qty FROM `tabLoan Security Unpledge` up, `tabUnpledge` u WHERE up.loan = %s AND u.parent = up.name AND up.status = 'Approved' GROUP BY u.loan_security - """, (loan))) + """, + (loan), + ) + ) - pledges = frappe._dict(frappe.db.sql(""" + pledges = frappe._dict( + frappe.db.sql( + """ SELECT p.loan_security, sum(p.qty) as qty FROM `tabLoan Security Pledge` lp, `tabPledge`p WHERE lp.loan = %s AND p.parent = lp.name AND lp.status = 'Pledged' GROUP BY p.loan_security - """, (loan))) + """, + (loan), + ) + ) for security, qty in iteritems(pledges): current_pledges.setdefault(security, qty) diff --git a/erpnext/loan_management/doctype/loan_type/loan_type.js b/erpnext/loan_management/doctype/loan_type/loan_type.js index 04c89c45499..9f9137cfbcd 100644 --- a/erpnext/loan_management/doctype/loan_type/loan_type.js +++ b/erpnext/loan_management/doctype/loan_type/loan_type.js @@ -15,7 +15,7 @@ frappe.ui.form.on('Loan Type', { }); }); - $.each(["payment_account", "loan_account"], function (i, field) { + $.each(["payment_account", "loan_account", "disbursement_account"], function (i, field) { frm.set_query(field, function () { return { "filters": { diff --git a/erpnext/loan_management/doctype/loan_type/loan_type.json b/erpnext/loan_management/doctype/loan_type/loan_type.json index c0a5d2cda12..00337e4b4c3 100644 --- a/erpnext/loan_management/doctype/loan_type/loan_type.json +++ b/erpnext/loan_management/doctype/loan_type/loan_type.json @@ -19,9 +19,10 @@ "description", "account_details_section", "mode_of_payment", + "disbursement_account", "payment_account", - "loan_account", "column_break_12", + "loan_account", "interest_income_account", "penalty_income_account", "amended_from" @@ -79,7 +80,7 @@ { "fieldname": "payment_account", "fieldtype": "Link", - "label": "Payment Account", + "label": "Repayment Account", "options": "Account", "reqd": 1 }, @@ -149,15 +150,23 @@ "fieldtype": "Currency", "label": "Auto Write Off Amount ", "options": "Company:company:default_currency" + }, + { + "fieldname": "disbursement_account", + "fieldtype": "Link", + "label": "Disbursement Account", + "options": "Account", + "reqd": 1 } ], "index_web_pages_for_search": 1, "is_submittable": 1, "links": [], - "modified": "2021-04-19 18:10:57.368490", + "modified": "2022-01-25 16:23:57.009349", "modified_by": "Administrator", "module": "Loan Management", "name": "Loan Type", + "naming_rule": "By fieldname", "owner": "Administrator", "permissions": [ { @@ -181,5 +190,6 @@ } ], "sort_field": "modified", - "sort_order": "DESC" + "sort_order": "DESC", + "states": [] } \ No newline at end of file diff --git a/erpnext/loan_management/doctype/loan_type/loan_type.py b/erpnext/loan_management/doctype/loan_type/loan_type.py index 592229cf994..51ee05b277e 100644 --- a/erpnext/loan_management/doctype/loan_type/loan_type.py +++ b/erpnext/loan_management/doctype/loan_type/loan_type.py @@ -12,12 +12,20 @@ class LoanType(Document): self.validate_accounts() def validate_accounts(self): - for fieldname in ['payment_account', 'loan_account', 'interest_income_account', 'penalty_income_account']: - company = frappe.get_value("Account", self.get(fieldname), 'company') + for fieldname in [ + "payment_account", + "loan_account", + "interest_income_account", + "penalty_income_account", + ]: + company = frappe.get_value("Account", self.get(fieldname), "company") if company and company != self.company: - frappe.throw(_("Account {0} does not belong to company {1}").format(frappe.bold(self.get(fieldname)), - frappe.bold(self.company))) + frappe.throw( + _("Account {0} does not belong to company {1}").format( + frappe.bold(self.get(fieldname)), frappe.bold(self.company) + ) + ) - if self.get('loan_account') == self.get('payment_account'): - frappe.throw(_('Loan Account and Payment Account cannot be same')) + if self.get("loan_account") == self.get("payment_account"): + frappe.throw(_("Loan Account and Payment Account cannot be same")) diff --git a/erpnext/loan_management/doctype/loan_type/loan_type_dashboard.py b/erpnext/loan_management/doctype/loan_type/loan_type_dashboard.py index 19026da2f66..e2467c64558 100644 --- a/erpnext/loan_management/doctype/loan_type/loan_type_dashboard.py +++ b/erpnext/loan_management/doctype/loan_type/loan_type_dashboard.py @@ -1,14 +1,5 @@ - - def get_data(): return { - 'fieldname': 'loan_type', - 'transactions': [ - { - 'items': ['Loan Repayment', 'Loan'] - }, - { - 'items': ['Loan Application'] - } - ] + "fieldname": "loan_type", + "transactions": [{"items": ["Loan Repayment", "Loan"]}, {"items": ["Loan Application"]}], } diff --git a/erpnext/loan_management/doctype/loan_write_off/loan_write_off.py b/erpnext/loan_management/doctype/loan_write_off/loan_write_off.py index 35be587f87f..2eeb97c8f89 100644 --- a/erpnext/loan_management/doctype/loan_write_off/loan_write_off.py +++ b/erpnext/loan_management/doctype/loan_write_off/loan_write_off.py @@ -9,6 +9,9 @@ from frappe.utils import cint, flt, getdate import erpnext from erpnext.accounts.general_ledger import make_gl_entries from erpnext.controllers.accounts_controller import AccountsController +from erpnext.loan_management.doctype.loan_repayment.loan_repayment import ( + get_pending_principal_amount, +) class LoanWriteOff(AccountsController): @@ -22,11 +25,26 @@ class LoanWriteOff(AccountsController): def validate_write_off_amount(self): precision = cint(frappe.db.get_default("currency_precision")) or 2 - total_payment, principal_paid, interest_payable, written_off_amount = frappe.get_value("Loan", self.loan, - ['total_payment', 'total_principal_paid','total_interest_payable', 'written_off_amount']) - pending_principal_amount = flt(flt(total_payment) - flt(interest_payable) - flt(principal_paid) - flt(written_off_amount), - precision) + loan_details = frappe.get_value( + "Loan", + self.loan, + [ + "total_payment", + "debit_adjustment_amount", + "credit_adjustment_amount", + "refund_amount", + "total_principal_paid", + "loan_amount", + "total_interest_payable", + "written_off_amount", + "disbursed_amount", + "status", + ], + as_dict=1, + ) + + pending_principal_amount = flt(get_pending_principal_amount(loan_details), precision) if self.write_off_amount > pending_principal_amount: frappe.throw(_("Write off amount cannot be greater than pending principal amount")) @@ -37,52 +55,55 @@ class LoanWriteOff(AccountsController): def on_cancel(self): self.update_outstanding_amount(cancel=1) - self.ignore_linked_doctypes = ['GL Entry'] + self.ignore_linked_doctypes = ["GL Entry"] self.make_gl_entries(cancel=1) def update_outstanding_amount(self, cancel=0): - written_off_amount = frappe.db.get_value('Loan', self.loan, 'written_off_amount') + written_off_amount = frappe.db.get_value("Loan", self.loan, "written_off_amount") if cancel: written_off_amount -= self.write_off_amount else: written_off_amount += self.write_off_amount - frappe.db.set_value('Loan', self.loan, 'written_off_amount', written_off_amount) - + frappe.db.set_value("Loan", self.loan, "written_off_amount", written_off_amount) def make_gl_entries(self, cancel=0): gl_entries = [] loan_details = frappe.get_doc("Loan", self.loan) gl_entries.append( - self.get_gl_dict({ - "account": self.write_off_account, - "against": loan_details.loan_account, - "debit": self.write_off_amount, - "debit_in_account_currency": self.write_off_amount, - "against_voucher_type": "Loan", - "against_voucher": self.loan, - "remarks": _("Against Loan:") + self.loan, - "cost_center": self.cost_center, - "posting_date": getdate(self.posting_date) - }) + self.get_gl_dict( + { + "account": self.write_off_account, + "against": loan_details.loan_account, + "debit": self.write_off_amount, + "debit_in_account_currency": self.write_off_amount, + "against_voucher_type": "Loan", + "against_voucher": self.loan, + "remarks": _("Against Loan:") + self.loan, + "cost_center": self.cost_center, + "posting_date": getdate(self.posting_date), + } + ) ) gl_entries.append( - self.get_gl_dict({ - "account": loan_details.loan_account, - "party_type": loan_details.applicant_type, - "party": loan_details.applicant, - "against": self.write_off_account, - "credit": self.write_off_amount, - "credit_in_account_currency": self.write_off_amount, - "against_voucher_type": "Loan", - "against_voucher": self.loan, - "remarks": _("Against Loan:") + self.loan, - "cost_center": self.cost_center, - "posting_date": getdate(self.posting_date) - }) + self.get_gl_dict( + { + "account": loan_details.loan_account, + "party_type": loan_details.applicant_type, + "party": loan_details.applicant, + "against": self.write_off_account, + "credit": self.write_off_amount, + "credit_in_account_currency": self.write_off_amount, + "against_voucher_type": "Loan", + "against_voucher": self.loan, + "remarks": _("Against Loan:") + self.loan, + "cost_center": self.cost_center, + "posting_date": getdate(self.posting_date), + } + ) ) make_gl_entries(gl_entries, cancel=cancel, merge_entries=False) diff --git a/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual.json b/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual.json index 828df2e35f7..7fc4736216d 100644 --- a/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual.json +++ b/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual.json @@ -54,17 +54,18 @@ "fieldtype": "Select", "hidden": 1, "label": "Accrual Type", - "options": "Regular\nRepayment\nDisbursement", + "options": "Regular\nRepayment\nDisbursement\nCredit Adjustment\nDebit Adjustment\nRefund", "read_only": 1 } ], "index_web_pages_for_search": 1, "is_submittable": 1, "links": [], - "modified": "2020-11-06 13:28:51.478909", + "modified": "2022-06-29 11:19:33.203088", "modified_by": "Administrator", "module": "Loan Management", "name": "Process Loan Interest Accrual", + "naming_rule": "Expression (old style)", "owner": "Administrator", "permissions": [ { @@ -98,5 +99,6 @@ ], "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual.py b/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual.py index 4c34ccd983e..25c72d91a7c 100644 --- a/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual.py +++ b/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual.py @@ -17,24 +17,36 @@ class ProcessLoanInterestAccrual(Document): open_loans = [] if self.loan: - loan_doc = frappe.get_doc('Loan', self.loan) + loan_doc = frappe.get_doc("Loan", self.loan) if loan_doc: open_loans.append(loan_doc) - if (not self.loan or not loan_doc.is_term_loan) and self.process_type != 'Term Loans': - make_accrual_interest_entry_for_demand_loans(self.posting_date, self.name, - open_loans = open_loans, loan_type = self.loan_type, accrual_type=self.accrual_type) + if (not self.loan or not loan_doc.is_term_loan) and self.process_type != "Term Loans": + make_accrual_interest_entry_for_demand_loans( + self.posting_date, + self.name, + open_loans=open_loans, + loan_type=self.loan_type, + accrual_type=self.accrual_type, + ) - if (not self.loan or loan_doc.is_term_loan) and self.process_type != 'Demand Loans': - make_accrual_interest_entry_for_term_loans(self.posting_date, self.name, term_loan=self.loan, - loan_type=self.loan_type, accrual_type=self.accrual_type) + if (not self.loan or loan_doc.is_term_loan) and self.process_type != "Demand Loans": + make_accrual_interest_entry_for_term_loans( + self.posting_date, + self.name, + term_loan=self.loan, + loan_type=self.loan_type, + accrual_type=self.accrual_type, + ) -def process_loan_interest_accrual_for_demand_loans(posting_date=None, loan_type=None, loan=None, accrual_type="Regular"): - loan_process = frappe.new_doc('Process Loan Interest Accrual') +def process_loan_interest_accrual_for_demand_loans( + posting_date=None, loan_type=None, loan=None, accrual_type="Regular" +): + loan_process = frappe.new_doc("Process Loan Interest Accrual") loan_process.posting_date = posting_date or nowdate() loan_process.loan_type = loan_type - loan_process.process_type = 'Demand Loans' + loan_process.process_type = "Demand Loans" loan_process.loan = loan loan_process.accrual_type = accrual_type @@ -42,25 +54,29 @@ def process_loan_interest_accrual_for_demand_loans(posting_date=None, loan_type= return loan_process.name + def process_loan_interest_accrual_for_term_loans(posting_date=None, loan_type=None, loan=None): - if not term_loan_accrual_pending(posting_date or nowdate()): + if not term_loan_accrual_pending(posting_date or nowdate(), loan=loan): return - loan_process = frappe.new_doc('Process Loan Interest Accrual') + loan_process = frappe.new_doc("Process Loan Interest Accrual") loan_process.posting_date = posting_date or nowdate() loan_process.loan_type = loan_type - loan_process.process_type = 'Term Loans' + loan_process.process_type = "Term Loans" loan_process.loan = loan loan_process.submit() return loan_process.name -def term_loan_accrual_pending(date): - pending_accrual = frappe.db.get_value('Repayment Schedule', { - 'payment_date': ('<=', date), - 'is_accrued': 0 - }) + +def term_loan_accrual_pending(date, loan=None): + filters = {"payment_date": ("<=", date), "is_accrued": 0} + + if loan: + filters.update({"parent": loan}) + + pending_accrual = frappe.db.get_value("Repayment Schedule", filters) return pending_accrual diff --git a/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual_dashboard.py b/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual_dashboard.py index 4195960890c..ac85df761ce 100644 --- a/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual_dashboard.py +++ b/erpnext/loan_management/doctype/process_loan_interest_accrual/process_loan_interest_accrual_dashboard.py @@ -1,11 +1,5 @@ - - def get_data(): return { - 'fieldname': 'process_loan_interest_accrual', - 'transactions': [ - { - 'items': ['Loan Interest Accrual'] - } - ] + "fieldname": "process_loan_interest_accrual", + "transactions": [{"items": ["Loan Interest Accrual"]}], } diff --git a/erpnext/loan_management/doctype/process_loan_security_shortfall/process_loan_security_shortfall.py b/erpnext/loan_management/doctype/process_loan_security_shortfall/process_loan_security_shortfall.py index ba9fb0c449f..fffc5d4876b 100644 --- a/erpnext/loan_management/doctype/process_loan_security_shortfall/process_loan_security_shortfall.py +++ b/erpnext/loan_management/doctype/process_loan_security_shortfall/process_loan_security_shortfall.py @@ -13,16 +13,18 @@ from erpnext.loan_management.doctype.loan_security_shortfall.loan_security_short class ProcessLoanSecurityShortfall(Document): def onload(self): - self.set_onload('update_time', get_datetime()) + self.set_onload("update_time", get_datetime()) def on_submit(self): check_for_ltv_shortfall(self.name) + def create_process_loan_security_shortfall(): if check_for_secured_loans(): process = frappe.new_doc("Process Loan Security Shortfall") process.update_time = get_datetime() process.submit() + def check_for_secured_loans(): - return frappe.db.count('Loan', {'docstatus': 1, 'is_secured_loan': 1}) + return frappe.db.count("Loan", {"docstatus": 1, "is_secured_loan": 1}) diff --git a/erpnext/loan_management/doctype/process_loan_security_shortfall/process_loan_security_shortfall_dashboard.py b/erpnext/loan_management/doctype/process_loan_security_shortfall/process_loan_security_shortfall_dashboard.py index fa9d18b6fab..4d7b1630bad 100644 --- a/erpnext/loan_management/doctype/process_loan_security_shortfall/process_loan_security_shortfall_dashboard.py +++ b/erpnext/loan_management/doctype/process_loan_security_shortfall/process_loan_security_shortfall_dashboard.py @@ -1,11 +1,5 @@ - - def get_data(): return { - 'fieldname': 'process_loan_security_shortfall', - 'transactions': [ - { - 'items': ['Loan Security Shortfall'] - } - ] + "fieldname": "process_loan_security_shortfall", + "transactions": [{"items": ["Loan Security Shortfall"]}], } diff --git a/erpnext/loan_management/doctype/salary_slip_loan/salary_slip_loan.json b/erpnext/loan_management/doctype/salary_slip_loan/salary_slip_loan.json index 3d070812152..32e281ddf41 100644 --- a/erpnext/loan_management/doctype/salary_slip_loan/salary_slip_loan.json +++ b/erpnext/loan_management/doctype/salary_slip_loan/salary_slip_loan.json @@ -64,13 +64,12 @@ "fieldname": "total_payment", "fieldtype": "Currency", "in_list_view": 1, - "label": "Total Payment", + "label": "Paid Amount", "options": "Company:company:default_currency" }, { "fieldname": "loan_repayment_entry", "fieldtype": "Link", - "hidden": 1, "label": "Loan Repayment Entry", "no_copy": 1, "options": "Loan Repayment", @@ -88,7 +87,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-03-14 20:47:11.725818", + "modified": "2022-08-29 08:50:39.030296", "modified_by": "Administrator", "module": "Loan Management", "name": "Salary Slip Loan", diff --git a/erpnext/loan_management/doctype/sanctioned_loan_amount/sanctioned_loan_amount.py b/erpnext/loan_management/doctype/sanctioned_loan_amount/sanctioned_loan_amount.py index 6063b7bad8b..e7487cb34d3 100644 --- a/erpnext/loan_management/doctype/sanctioned_loan_amount/sanctioned_loan_amount.py +++ b/erpnext/loan_management/doctype/sanctioned_loan_amount/sanctioned_loan_amount.py @@ -9,9 +9,13 @@ from frappe.model.document import Document class SanctionedLoanAmount(Document): def validate(self): - sanctioned_doc = frappe.db.exists('Sanctioned Loan Amount', {'applicant': self.applicant, 'company': self.company}) + sanctioned_doc = frappe.db.exists( + "Sanctioned Loan Amount", {"applicant": self.applicant, "company": self.company} + ) if sanctioned_doc and sanctioned_doc != self.name: - frappe.throw(_("Sanctioned Loan Amount already exists for {0} against company {1}").format( - frappe.bold(self.applicant), frappe.bold(self.company) - )) + frappe.throw( + _("Sanctioned Loan Amount already exists for {0} against company {1}").format( + frappe.bold(self.applicant), frappe.bold(self.company) + ) + ) diff --git a/erpnext/loan_management/report/applicant_wise_loan_security_exposure/applicant_wise_loan_security_exposure.py b/erpnext/loan_management/report/applicant_wise_loan_security_exposure/applicant_wise_loan_security_exposure.py index 8ebca39061c..75c4b2877b1 100644 --- a/erpnext/loan_management/report/applicant_wise_loan_security_exposure/applicant_wise_loan_security_exposure.py +++ b/erpnext/loan_management/report/applicant_wise_loan_security_exposure/applicant_wise_loan_security_exposure.py @@ -18,84 +18,166 @@ def execute(filters=None): def get_columns(filters): columns = [ - {"label": _("Applicant Type"), "fieldname": "applicant_type", "options": "DocType", "width": 100}, - {"label": _("Applicant Name"), "fieldname": "applicant_name", "fieldtype": "Dynamic Link", "options": "applicant_type", "width": 150}, - {"label": _("Loan Security"), "fieldname": "loan_security", "fieldtype": "Link", "options": "Loan Security", "width": 160}, - {"label": _("Loan Security Code"), "fieldname": "loan_security_code", "fieldtype": "Data", "width": 100}, - {"label": _("Loan Security Name"), "fieldname": "loan_security_name", "fieldtype": "Data", "width": 150}, + { + "label": _("Applicant Type"), + "fieldname": "applicant_type", + "options": "DocType", + "width": 100, + }, + { + "label": _("Applicant Name"), + "fieldname": "applicant_name", + "fieldtype": "Dynamic Link", + "options": "applicant_type", + "width": 150, + }, + { + "label": _("Loan Security"), + "fieldname": "loan_security", + "fieldtype": "Link", + "options": "Loan Security", + "width": 160, + }, + { + "label": _("Loan Security Code"), + "fieldname": "loan_security_code", + "fieldtype": "Data", + "width": 100, + }, + { + "label": _("Loan Security Name"), + "fieldname": "loan_security_name", + "fieldtype": "Data", + "width": 150, + }, {"label": _("Haircut"), "fieldname": "haircut", "fieldtype": "Percent", "width": 100}, - {"label": _("Loan Security Type"), "fieldname": "loan_security_type", "fieldtype": "Link", "options": "Loan Security Type", "width": 120}, + { + "label": _("Loan Security Type"), + "fieldname": "loan_security_type", + "fieldtype": "Link", + "options": "Loan Security Type", + "width": 120, + }, {"label": _("Disabled"), "fieldname": "disabled", "fieldtype": "Check", "width": 80}, {"label": _("Total Qty"), "fieldname": "total_qty", "fieldtype": "Float", "width": 100}, - {"label": _("Latest Price"), "fieldname": "latest_price", "fieldtype": "Currency", "options": "currency", "width": 100}, - {"label": _("Price Valid Upto"), "fieldname": "price_valid_upto", "fieldtype": "Datetime", "width": 100}, - {"label": _("Current Value"), "fieldname": "current_value", "fieldtype": "Currency", "options": "currency", "width": 100}, - {"label": _("% Of Applicant Portfolio"), "fieldname": "portfolio_percent", "fieldtype": "Percentage", "width": 100}, - {"label": _("Currency"), "fieldname": "currency", "fieldtype": "Currency", "options": "Currency", "hidden": 1, "width": 100}, + { + "label": _("Latest Price"), + "fieldname": "latest_price", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + { + "label": _("Price Valid Upto"), + "fieldname": "price_valid_upto", + "fieldtype": "Datetime", + "width": 100, + }, + { + "label": _("Current Value"), + "fieldname": "current_value", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + { + "label": _("% Of Applicant Portfolio"), + "fieldname": "portfolio_percent", + "fieldtype": "Percentage", + "width": 100, + }, + { + "label": _("Currency"), + "fieldname": "currency", + "fieldtype": "Currency", + "options": "Currency", + "hidden": 1, + "width": 100, + }, ] return columns + def get_data(filters): data = [] loan_security_details = get_loan_security_details() - pledge_values, total_value_map, applicant_type_map = get_applicant_wise_total_loan_security_qty(filters, - loan_security_details) + pledge_values, total_value_map, applicant_type_map = get_applicant_wise_total_loan_security_qty( + filters, loan_security_details + ) - currency = erpnext.get_company_currency(filters.get('company')) + currency = erpnext.get_company_currency(filters.get("company")) for key, qty in iteritems(pledge_values): if qty: row = {} - current_value = flt(qty * loan_security_details.get(key[1], {}).get('latest_price', 0)) - valid_upto = loan_security_details.get(key[1], {}).get('valid_upto') + current_value = flt(qty * loan_security_details.get(key[1], {}).get("latest_price", 0)) + valid_upto = loan_security_details.get(key[1], {}).get("valid_upto") row.update(loan_security_details.get(key[1])) - row.update({ - 'applicant_type': applicant_type_map.get(key[0]), - 'applicant_name': key[0], - 'total_qty': qty, - 'current_value': current_value, - 'price_valid_upto': valid_upto, - 'portfolio_percent': flt(current_value * 100 / total_value_map.get(key[0]), 2) if total_value_map.get(key[0]) \ + row.update( + { + "applicant_type": applicant_type_map.get(key[0]), + "applicant_name": key[0], + "total_qty": qty, + "current_value": current_value, + "price_valid_upto": valid_upto, + "portfolio_percent": flt(current_value * 100 / total_value_map.get(key[0]), 2) + if total_value_map.get(key[0]) else 0.0, - 'currency': currency - }) + "currency": currency, + } + ) data.append(row) return data + def get_loan_security_details(): security_detail_map = {} loan_security_price_map = {} lsp_validity_map = {} - loan_security_prices = frappe.db.sql(""" + loan_security_prices = frappe.db.sql( + """ SELECT loan_security, loan_security_price, valid_upto FROM `tabLoan Security Price` t1 WHERE valid_from >= (SELECT MAX(valid_from) FROM `tabLoan Security Price` t2 WHERE t1.loan_security = t2.loan_security) - """, as_dict=1) + """, + as_dict=1, + ) for security in loan_security_prices: loan_security_price_map.setdefault(security.loan_security, security.loan_security_price) lsp_validity_map.setdefault(security.loan_security, security.valid_upto) - loan_security_details = frappe.get_all('Loan Security', fields=['name as loan_security', - 'loan_security_code', 'loan_security_name', 'haircut', 'loan_security_type', - 'disabled']) + loan_security_details = frappe.get_all( + "Loan Security", + fields=[ + "name as loan_security", + "loan_security_code", + "loan_security_name", + "haircut", + "loan_security_type", + "disabled", + ], + ) for security in loan_security_details: - security.update({ - 'latest_price': flt(loan_security_price_map.get(security.loan_security)), - 'valid_upto': lsp_validity_map.get(security.loan_security) - }) + security.update( + { + "latest_price": flt(loan_security_price_map.get(security.loan_security)), + "valid_upto": lsp_validity_map.get(security.loan_security), + } + ) security_detail_map.setdefault(security.loan_security, security) return security_detail_map + def get_applicant_wise_total_loan_security_qty(filters, loan_security_details): current_pledges = {} total_value_map = {} @@ -103,39 +185,53 @@ def get_applicant_wise_total_loan_security_qty(filters, loan_security_details): applicant_wise_unpledges = {} conditions = "" - if filters.get('company'): + if filters.get("company"): conditions = "AND company = %(company)s" - unpledges = frappe.db.sql(""" + unpledges = frappe.db.sql( + """ SELECT up.applicant, u.loan_security, sum(u.qty) as qty FROM `tabLoan Security Unpledge` up, `tabUnpledge` u WHERE u.parent = up.name AND up.status = 'Approved' {conditions} GROUP BY up.applicant, u.loan_security - """.format(conditions=conditions), filters, as_dict=1) + """.format( + conditions=conditions + ), + filters, + as_dict=1, + ) for unpledge in unpledges: applicant_wise_unpledges.setdefault((unpledge.applicant, unpledge.loan_security), unpledge.qty) - pledges = frappe.db.sql(""" + pledges = frappe.db.sql( + """ SELECT lp.applicant_type, lp.applicant, p.loan_security, sum(p.qty) as qty FROM `tabLoan Security Pledge` lp, `tabPledge`p WHERE p.parent = lp.name AND lp.status = 'Pledged' {conditions} GROUP BY lp.applicant, p.loan_security - """.format(conditions=conditions), filters, as_dict=1) + """.format( + conditions=conditions + ), + filters, + as_dict=1, + ) for security in pledges: current_pledges.setdefault((security.applicant, security.loan_security), security.qty) total_value_map.setdefault(security.applicant, 0.0) applicant_type_map.setdefault(security.applicant, security.applicant_type) - current_pledges[(security.applicant, security.loan_security)] -= \ - applicant_wise_unpledges.get((security.applicant, security.loan_security), 0.0) + current_pledges[(security.applicant, security.loan_security)] -= applicant_wise_unpledges.get( + (security.applicant, security.loan_security), 0.0 + ) - total_value_map[security.applicant] += current_pledges.get((security.applicant, security.loan_security)) \ - * loan_security_details.get(security.loan_security, {}).get('latest_price', 0) + total_value_map[security.applicant] += current_pledges.get( + (security.applicant, security.loan_security) + ) * loan_security_details.get(security.loan_security, {}).get("latest_price", 0) return current_pledges, total_value_map, applicant_type_map diff --git a/erpnext/loan_management/report/loan_interest_report/loan_interest_report.py b/erpnext/loan_management/report/loan_interest_report/loan_interest_report.py index 7c512679567..9186ce61743 100644 --- a/erpnext/loan_management/report/loan_interest_report/loan_interest_report.py +++ b/erpnext/loan_management/report/loan_interest_report/loan_interest_report.py @@ -17,41 +17,148 @@ def execute(filters=None): data = get_active_loan_details(filters) return columns, data + def get_columns(filters): columns = [ {"label": _("Loan"), "fieldname": "loan", "fieldtype": "Link", "options": "Loan", "width": 160}, {"label": _("Status"), "fieldname": "status", "fieldtype": "Data", "width": 160}, - {"label": _("Applicant Type"), "fieldname": "applicant_type", "options": "DocType", "width": 100}, - {"label": _("Applicant Name"), "fieldname": "applicant_name", "fieldtype": "Dynamic Link", "options": "applicant_type", "width": 150}, - {"label": _("Loan Type"), "fieldname": "loan_type", "fieldtype": "Link", "options": "Loan Type", "width": 100}, - {"label": _("Sanctioned Amount"), "fieldname": "sanctioned_amount", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Disbursed Amount"), "fieldname": "disbursed_amount", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Penalty Amount"), "fieldname": "penalty", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Accrued Interest"), "fieldname": "accrued_interest", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Total Repayment"), "fieldname": "total_repayment", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Principal Outstanding"), "fieldname": "principal_outstanding", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Interest Outstanding"), "fieldname": "interest_outstanding", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Total Outstanding"), "fieldname": "total_outstanding", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Undue Booked Interest"), "fieldname": "undue_interest", "fieldtype": "Currency", "options": "currency", "width": 120}, - {"label": _("Interest %"), "fieldname": "rate_of_interest", "fieldtype": "Percent", "width": 100}, - {"label": _("Penalty Interest %"), "fieldname": "penalty_interest", "fieldtype": "Percent", "width": 100}, - {"label": _("Loan To Value Ratio"), "fieldname": "loan_to_value", "fieldtype": "Percent", "width": 100}, - {"label": _("Currency"), "fieldname": "currency", "fieldtype": "Currency", "options": "Currency", "hidden": 1, "width": 100}, + { + "label": _("Applicant Type"), + "fieldname": "applicant_type", + "options": "DocType", + "width": 100, + }, + { + "label": _("Applicant Name"), + "fieldname": "applicant_name", + "fieldtype": "Dynamic Link", + "options": "applicant_type", + "width": 150, + }, + { + "label": _("Loan Type"), + "fieldname": "loan_type", + "fieldtype": "Link", + "options": "Loan Type", + "width": 100, + }, + { + "label": _("Sanctioned Amount"), + "fieldname": "sanctioned_amount", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Disbursed Amount"), + "fieldname": "disbursed_amount", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Penalty Amount"), + "fieldname": "penalty", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Accrued Interest"), + "fieldname": "accrued_interest", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Total Repayment"), + "fieldname": "total_repayment", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Principal Outstanding"), + "fieldname": "principal_outstanding", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Interest Outstanding"), + "fieldname": "interest_outstanding", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Total Outstanding"), + "fieldname": "total_outstanding", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Undue Booked Interest"), + "fieldname": "undue_interest", + "fieldtype": "Currency", + "options": "currency", + "width": 120, + }, + { + "label": _("Interest %"), + "fieldname": "rate_of_interest", + "fieldtype": "Percent", + "width": 100, + }, + { + "label": _("Penalty Interest %"), + "fieldname": "penalty_interest", + "fieldtype": "Percent", + "width": 100, + }, + { + "label": _("Loan To Value Ratio"), + "fieldname": "loan_to_value", + "fieldtype": "Percent", + "width": 100, + }, + { + "label": _("Currency"), + "fieldname": "currency", + "fieldtype": "Currency", + "options": "Currency", + "hidden": 1, + "width": 100, + }, ] return columns + def get_active_loan_details(filters): filter_obj = {"status": ("!=", "Closed")} - if filters.get('company'): - filter_obj.update({'company': filters.get('company')}) + if filters.get("company"): + filter_obj.update({"company": filters.get("company")}) - loan_details = frappe.get_all("Loan", - fields=["name as loan", "applicant_type", "applicant as applicant_name", "loan_type", - "disbursed_amount", "rate_of_interest", "total_payment", "total_principal_paid", - "total_interest_payable", "written_off_amount", "status"], - filters=filter_obj) + loan_details = frappe.get_all( + "Loan", + fields=[ + "name as loan", + "applicant_type", + "applicant as applicant_name", + "loan_type", + "disbursed_amount", + "rate_of_interest", + "total_payment", + "total_principal_paid", + "total_interest_payable", + "written_off_amount", + "status", + ], + filters=filter_obj, + ) loan_list = [d.loan for d in loan_details] @@ -62,70 +169,105 @@ def get_active_loan_details(filters): penal_interest_rate_map = get_penal_interest_rate_map() payments = get_payments(loan_list) accrual_map = get_interest_accruals(loan_list) - currency = erpnext.get_company_currency(filters.get('company')) + currency = erpnext.get_company_currency(filters.get("company")) for loan in loan_details: - total_payment = loan.total_payment if loan.status == 'Disbursed' else loan.disbursed_amount + total_payment = loan.total_payment if loan.status == "Disbursed" else loan.disbursed_amount - loan.update({ - "sanctioned_amount": flt(sanctioned_amount_map.get(loan.applicant_name)), - "principal_outstanding": flt(total_payment) - flt(loan.total_principal_paid) \ - - flt(loan.total_interest_payable) - flt(loan.written_off_amount), - "total_repayment": flt(payments.get(loan.loan)), - "accrued_interest": flt(accrual_map.get(loan.loan, {}).get("accrued_interest")), - "interest_outstanding": flt(accrual_map.get(loan.loan, {}).get("interest_outstanding")), - "penalty": flt(accrual_map.get(loan.loan, {}).get("penalty")), - "penalty_interest": penal_interest_rate_map.get(loan.loan_type), - "undue_interest": flt(accrual_map.get(loan.loan, {}).get("undue_interest")), - "loan_to_value": 0.0, - "currency": currency - }) + loan.update( + { + "sanctioned_amount": flt(sanctioned_amount_map.get(loan.applicant_name)), + "principal_outstanding": flt(total_payment) + - flt(loan.total_principal_paid) + - flt(loan.total_interest_payable) + - flt(loan.written_off_amount), + "total_repayment": flt(payments.get(loan.loan)), + "accrued_interest": flt(accrual_map.get(loan.loan, {}).get("accrued_interest")), + "interest_outstanding": flt(accrual_map.get(loan.loan, {}).get("interest_outstanding")), + "penalty": flt(accrual_map.get(loan.loan, {}).get("penalty")), + "penalty_interest": penal_interest_rate_map.get(loan.loan_type), + "undue_interest": flt(accrual_map.get(loan.loan, {}).get("undue_interest")), + "loan_to_value": 0.0, + "currency": currency, + } + ) - loan['total_outstanding'] = loan['principal_outstanding'] + loan['interest_outstanding'] \ - + loan['penalty'] + loan["total_outstanding"] = ( + loan["principal_outstanding"] + loan["interest_outstanding"] + loan["penalty"] + ) if loan_wise_security_value.get(loan.loan): - loan['loan_to_value'] = flt((loan['principal_outstanding'] * 100) / loan_wise_security_value.get(loan.loan)) + loan["loan_to_value"] = flt( + (loan["principal_outstanding"] * 100) / loan_wise_security_value.get(loan.loan) + ) return loan_details + def get_sanctioned_amount_map(): - return frappe._dict(frappe.get_all("Sanctioned Loan Amount", fields=["applicant", "sanctioned_amount_limit"], - as_list=1)) + return frappe._dict( + frappe.get_all( + "Sanctioned Loan Amount", fields=["applicant", "sanctioned_amount_limit"], as_list=1 + ) + ) + def get_payments(loans): - return frappe._dict(frappe.get_all("Loan Repayment", fields=["against_loan", "sum(amount_paid)"], - filters={"against_loan": ("in", loans)}, group_by="against_loan", as_list=1)) + return frappe._dict( + frappe.get_all( + "Loan Repayment", + fields=["against_loan", "sum(amount_paid)"], + filters={"against_loan": ("in", loans)}, + group_by="against_loan", + as_list=1, + ) + ) + def get_interest_accruals(loans): accrual_map = {} - interest_accruals = frappe.get_all("Loan Interest Accrual", - fields=["loan", "interest_amount", "posting_date", "penalty_amount", - "paid_interest_amount", "accrual_type"], filters={"loan": ("in", loans)}, order_by="posting_date desc") + interest_accruals = frappe.get_all( + "Loan Interest Accrual", + fields=[ + "loan", + "interest_amount", + "posting_date", + "penalty_amount", + "paid_interest_amount", + "accrual_type", + ], + filters={"loan": ("in", loans)}, + order_by="posting_date desc", + ) for entry in interest_accruals: - accrual_map.setdefault(entry.loan, { - "accrued_interest": 0.0, - "undue_interest": 0.0, - "interest_outstanding": 0.0, - "last_accrual_date": '', - "due_date": '' - }) + accrual_map.setdefault( + entry.loan, + { + "accrued_interest": 0.0, + "undue_interest": 0.0, + "interest_outstanding": 0.0, + "last_accrual_date": "", + "due_date": "", + }, + ) - if entry.accrual_type == 'Regular': - if not accrual_map[entry.loan]['due_date']: - accrual_map[entry.loan]['due_date'] = add_days(entry.posting_date, 1) - if not accrual_map[entry.loan]['last_accrual_date']: - accrual_map[entry.loan]['last_accrual_date'] = entry.posting_date + if entry.accrual_type == "Regular": + if not accrual_map[entry.loan]["due_date"]: + accrual_map[entry.loan]["due_date"] = add_days(entry.posting_date, 1) + if not accrual_map[entry.loan]["last_accrual_date"]: + accrual_map[entry.loan]["last_accrual_date"] = entry.posting_date - due_date = accrual_map[entry.loan]['due_date'] - last_accrual_date = accrual_map[entry.loan]['last_accrual_date'] + due_date = accrual_map[entry.loan]["due_date"] + last_accrual_date = accrual_map[entry.loan]["last_accrual_date"] if due_date and getdate(entry.posting_date) < getdate(due_date): - accrual_map[entry.loan]["interest_outstanding"] += entry.interest_amount - entry.paid_interest_amount + accrual_map[entry.loan]["interest_outstanding"] += ( + entry.interest_amount - entry.paid_interest_amount + ) else: - accrual_map[entry.loan]['undue_interest'] += entry.interest_amount - entry.paid_interest_amount + accrual_map[entry.loan]["undue_interest"] += entry.interest_amount - entry.paid_interest_amount accrual_map[entry.loan]["accrued_interest"] += entry.interest_amount @@ -134,8 +276,12 @@ def get_interest_accruals(loans): return accrual_map + def get_penal_interest_rate_map(): - return frappe._dict(frappe.get_all("Loan Type", fields=["name", "penalty_interest_rate"], as_list=1)) + return frappe._dict( + frappe.get_all("Loan Type", fields=["name", "penalty_interest_rate"], as_list=1) + ) + def get_loan_wise_pledges(filters): loan_wise_unpledges = {} @@ -143,37 +289,51 @@ def get_loan_wise_pledges(filters): conditions = "" - if filters.get('company'): + if filters.get("company"): conditions = "AND company = %(company)s" - unpledges = frappe.db.sql(""" + unpledges = frappe.db.sql( + """ SELECT up.loan, u.loan_security, sum(u.qty) as qty FROM `tabLoan Security Unpledge` up, `tabUnpledge` u WHERE u.parent = up.name AND up.status = 'Approved' {conditions} GROUP BY up.loan, u.loan_security - """.format(conditions=conditions), filters, as_dict=1) + """.format( + conditions=conditions + ), + filters, + as_dict=1, + ) for unpledge in unpledges: loan_wise_unpledges.setdefault((unpledge.loan, unpledge.loan_security), unpledge.qty) - pledges = frappe.db.sql(""" + pledges = frappe.db.sql( + """ SELECT lp.loan, p.loan_security, sum(p.qty) as qty FROM `tabLoan Security Pledge` lp, `tabPledge`p WHERE p.parent = lp.name AND lp.status = 'Pledged' {conditions} GROUP BY lp.loan, p.loan_security - """.format(conditions=conditions), filters, as_dict=1) + """.format( + conditions=conditions + ), + filters, + as_dict=1, + ) for security in pledges: current_pledges.setdefault((security.loan, security.loan_security), security.qty) - current_pledges[(security.loan, security.loan_security)] -= \ - loan_wise_unpledges.get((security.loan, security.loan_security), 0.0) + current_pledges[(security.loan, security.loan_security)] -= loan_wise_unpledges.get( + (security.loan, security.loan_security), 0.0 + ) return current_pledges + def get_loan_wise_security_value(filters, current_pledges): loan_security_details = get_loan_security_details() loan_wise_security_value = {} @@ -181,7 +341,8 @@ def get_loan_wise_security_value(filters, current_pledges): for key in current_pledges: qty = current_pledges.get(key) loan_wise_security_value.setdefault(key[0], 0.0) - loan_wise_security_value[key[0]] += \ - flt(qty * loan_security_details.get(key[1], {}).get('latest_price', 0)) + loan_wise_security_value[key[0]] += flt( + qty * loan_security_details.get(key[1], {}).get("latest_price", 0) + ) return loan_wise_security_value diff --git a/erpnext/loan_management/report/loan_repayment_and_closure/loan_repayment_and_closure.py b/erpnext/loan_management/report/loan_repayment_and_closure/loan_repayment_and_closure.py index 68fd3d8e8b5..253b994ae04 100644 --- a/erpnext/loan_management/report/loan_repayment_and_closure/loan_repayment_and_closure.py +++ b/erpnext/loan_management/report/loan_repayment_and_closure/loan_repayment_and_closure.py @@ -11,101 +11,96 @@ def execute(filters=None): data = get_data(filters) return columns, data + def get_columns(): return [ - { - "label": _("Posting Date"), - "fieldtype": "Date", - "fieldname": "posting_date", - "width": 100 - }, - { - "label": _("Loan Repayment"), - "fieldtype": "Link", - "fieldname": "loan_repayment", - "options": "Loan Repayment", - "width": 100 - }, - { - "label": _("Against Loan"), - "fieldtype": "Link", - "fieldname": "against_loan", - "options": "Loan", - "width": 200 - }, - { - "label": _("Applicant"), - "fieldtype": "Data", - "fieldname": "applicant", - "width": 150 - }, - { - "label": _("Payment Type"), - "fieldtype": "Data", - "fieldname": "payment_type", - "width": 150 - }, - { - "label": _("Principal Amount"), - "fieldtype": "Currency", - "fieldname": "principal_amount", - "options": "currency", - "width": 100 - }, - { - "label": _("Interest Amount"), - "fieldtype": "Currency", - "fieldname": "interest", - "options": "currency", - "width": 100 - }, - { - "label": _("Penalty Amount"), - "fieldtype": "Currency", - "fieldname": "penalty", - "options": "currency", - "width": 100 - }, - { - "label": _("Payable Amount"), - "fieldtype": "Currency", - "fieldname": "payable_amount", - "options": "currency", - "width": 100 - }, - { - "label": _("Paid Amount"), - "fieldtype": "Currency", - "fieldname": "paid_amount", - "options": "currency", - "width": 100 - }, - { - "label": _("Currency"), - "fieldtype": "Link", - "fieldname": "currency", - "options": "Currency", - "width": 100 - } - ] + {"label": _("Posting Date"), "fieldtype": "Date", "fieldname": "posting_date", "width": 100}, + { + "label": _("Loan Repayment"), + "fieldtype": "Link", + "fieldname": "loan_repayment", + "options": "Loan Repayment", + "width": 100, + }, + { + "label": _("Against Loan"), + "fieldtype": "Link", + "fieldname": "against_loan", + "options": "Loan", + "width": 200, + }, + {"label": _("Applicant"), "fieldtype": "Data", "fieldname": "applicant", "width": 150}, + {"label": _("Payment Type"), "fieldtype": "Data", "fieldname": "payment_type", "width": 150}, + { + "label": _("Principal Amount"), + "fieldtype": "Currency", + "fieldname": "principal_amount", + "options": "currency", + "width": 100, + }, + { + "label": _("Interest Amount"), + "fieldtype": "Currency", + "fieldname": "interest", + "options": "currency", + "width": 100, + }, + { + "label": _("Penalty Amount"), + "fieldtype": "Currency", + "fieldname": "penalty", + "options": "currency", + "width": 100, + }, + { + "label": _("Payable Amount"), + "fieldtype": "Currency", + "fieldname": "payable_amount", + "options": "currency", + "width": 100, + }, + { + "label": _("Paid Amount"), + "fieldtype": "Currency", + "fieldname": "paid_amount", + "options": "currency", + "width": 100, + }, + { + "label": _("Currency"), + "fieldtype": "Link", + "fieldname": "currency", + "options": "Currency", + "width": 100, + }, + ] + def get_data(filters): data = [] query_filters = { "docstatus": 1, - "company": filters.get('company'), + "company": filters.get("company"), } - if filters.get('applicant'): - query_filters.update({ - "applicant": filters.get('applicant') - }) + if filters.get("applicant"): + query_filters.update({"applicant": filters.get("applicant")}) - loan_repayments = frappe.get_all("Loan Repayment", - filters = query_filters, - fields=["posting_date", "applicant", "name", "against_loan", "payable_amount", - "pending_principal_amount", "interest_payable", "penalty_amount", "amount_paid"] + loan_repayments = frappe.get_all( + "Loan Repayment", + filters=query_filters, + fields=[ + "posting_date", + "applicant", + "name", + "against_loan", + "payable_amount", + "pending_principal_amount", + "interest_payable", + "penalty_amount", + "amount_paid", + ], ) default_currency = frappe.get_cached_value("Company", filters.get("company"), "default_currency") @@ -122,7 +117,7 @@ def get_data(filters): "penalty": repayment.penalty_amount, "payable_amount": repayment.payable_amount, "paid_amount": repayment.amount_paid, - "currency": default_currency + "currency": default_currency, } data.append(row) diff --git a/erpnext/loan_management/report/loan_security_exposure/loan_security_exposure.py b/erpnext/loan_management/report/loan_security_exposure/loan_security_exposure.py index e3d99952902..4a459413876 100644 --- a/erpnext/loan_management/report/loan_security_exposure/loan_security_exposure.py +++ b/erpnext/loan_management/report/loan_security_exposure/loan_security_exposure.py @@ -18,46 +18,110 @@ def execute(filters=None): data = get_data(filters) return columns, data + def get_columns(filters): columns = [ - {"label": _("Loan Security"), "fieldname": "loan_security", "fieldtype": "Link", "options": "Loan Security", "width": 160}, - {"label": _("Loan Security Code"), "fieldname": "loan_security_code", "fieldtype": "Data", "width": 100}, - {"label": _("Loan Security Name"), "fieldname": "loan_security_name", "fieldtype": "Data", "width": 150}, + { + "label": _("Loan Security"), + "fieldname": "loan_security", + "fieldtype": "Link", + "options": "Loan Security", + "width": 160, + }, + { + "label": _("Loan Security Code"), + "fieldname": "loan_security_code", + "fieldtype": "Data", + "width": 100, + }, + { + "label": _("Loan Security Name"), + "fieldname": "loan_security_name", + "fieldtype": "Data", + "width": 150, + }, {"label": _("Haircut"), "fieldname": "haircut", "fieldtype": "Percent", "width": 100}, - {"label": _("Loan Security Type"), "fieldname": "loan_security_type", "fieldtype": "Link", "options": "Loan Security Type", "width": 120}, + { + "label": _("Loan Security Type"), + "fieldname": "loan_security_type", + "fieldtype": "Link", + "options": "Loan Security Type", + "width": 120, + }, {"label": _("Disabled"), "fieldname": "disabled", "fieldtype": "Check", "width": 80}, {"label": _("Total Qty"), "fieldname": "total_qty", "fieldtype": "Float", "width": 100}, - {"label": _("Latest Price"), "fieldname": "latest_price", "fieldtype": "Currency", "options": "currency", "width": 100}, - {"label": _("Price Valid Upto"), "fieldname": "price_valid_upto", "fieldtype": "Datetime", "width": 100}, - {"label": _("Current Value"), "fieldname": "current_value", "fieldtype": "Currency", "options": "currency", "width": 100}, - {"label": _("% Of Total Portfolio"), "fieldname": "portfolio_percent", "fieldtype": "Percentage", "width": 100}, - {"label": _("Pledged Applicant Count"), "fieldname": "pledged_applicant_count", "fieldtype": "Percentage", "width": 100}, - {"label": _("Currency"), "fieldname": "currency", "fieldtype": "Currency", "options": "Currency", "hidden": 1, "width": 100}, + { + "label": _("Latest Price"), + "fieldname": "latest_price", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + { + "label": _("Price Valid Upto"), + "fieldname": "price_valid_upto", + "fieldtype": "Datetime", + "width": 100, + }, + { + "label": _("Current Value"), + "fieldname": "current_value", + "fieldtype": "Currency", + "options": "currency", + "width": 100, + }, + { + "label": _("% Of Total Portfolio"), + "fieldname": "portfolio_percent", + "fieldtype": "Percentage", + "width": 100, + }, + { + "label": _("Pledged Applicant Count"), + "fieldname": "pledged_applicant_count", + "fieldtype": "Percentage", + "width": 100, + }, + { + "label": _("Currency"), + "fieldname": "currency", + "fieldtype": "Currency", + "options": "Currency", + "hidden": 1, + "width": 100, + }, ] return columns + def get_data(filters): data = [] loan_security_details = get_loan_security_details() - current_pledges, total_portfolio_value = get_company_wise_loan_security_details(filters, loan_security_details) - currency = erpnext.get_company_currency(filters.get('company')) + current_pledges, total_portfolio_value = get_company_wise_loan_security_details( + filters, loan_security_details + ) + currency = erpnext.get_company_currency(filters.get("company")) for security, value in iteritems(current_pledges): - if value.get('qty'): + if value.get("qty"): row = {} - current_value = flt(value.get('qty', 0) * loan_security_details.get(security, {}).get('latest_price', 0)) - valid_upto = loan_security_details.get(security, {}).get('valid_upto') + current_value = flt( + value.get("qty", 0) * loan_security_details.get(security, {}).get("latest_price", 0) + ) + valid_upto = loan_security_details.get(security, {}).get("valid_upto") row.update(loan_security_details.get(security)) - row.update({ - 'total_qty': value.get('qty'), - 'current_value': current_value, - 'price_valid_upto': valid_upto, - 'portfolio_percent': flt(current_value * 100 / total_portfolio_value, 2), - 'pledged_applicant_count': value.get('applicant_count'), - 'currency': currency - }) + row.update( + { + "total_qty": value.get("qty"), + "current_value": current_value, + "price_valid_upto": valid_upto, + "portfolio_percent": flt(current_value * 100 / total_portfolio_value, 2), + "pledged_applicant_count": value.get("applicant_count"), + "currency": currency, + } + ) data.append(row) @@ -65,21 +129,19 @@ def get_data(filters): def get_company_wise_loan_security_details(filters, loan_security_details): - pledge_values, total_value_map, applicant_type_map = get_applicant_wise_total_loan_security_qty(filters, - loan_security_details) + pledge_values, total_value_map, applicant_type_map = get_applicant_wise_total_loan_security_qty( + filters, loan_security_details + ) total_portfolio_value = 0 security_wise_map = {} for key, qty in iteritems(pledge_values): - security_wise_map.setdefault(key[1], { - 'qty': 0.0, - 'applicant_count': 0.0 - }) + security_wise_map.setdefault(key[1], {"qty": 0.0, "applicant_count": 0.0}) - security_wise_map[key[1]]['qty'] += qty + security_wise_map[key[1]]["qty"] += qty if qty: - security_wise_map[key[1]]['applicant_count'] += 1 + security_wise_map[key[1]]["applicant_count"] += 1 - total_portfolio_value += flt(qty * loan_security_details.get(key[1], {}).get('latest_price', 0)) + total_portfolio_value += flt(qty * loan_security_details.get(key[1], {}).get("latest_price", 0)) return security_wise_map, total_portfolio_value diff --git a/erpnext/loan_management/report/loan_security_status/loan_security_status.py b/erpnext/loan_management/report/loan_security_status/loan_security_status.py index b7e716880e9..9a5a18001ea 100644 --- a/erpnext/loan_management/report/loan_security_status/loan_security_status.py +++ b/erpnext/loan_management/report/loan_security_status/loan_security_status.py @@ -11,66 +11,41 @@ def execute(filters=None): data = get_data(filters) return columns, data + def get_columns(filters): - columns= [ + columns = [ { "label": _("Loan Security Pledge"), "fieldtype": "Link", "fieldname": "loan_security_pledge", "options": "Loan Security Pledge", - "width": 200 - }, - { - "label": _("Loan"), - "fieldtype": "Link", - "fieldname": "loan", - "options": "Loan", - "width": 200 - }, - { - "label": _("Applicant"), - "fieldtype": "Data", - "fieldname": "applicant", - "width": 200 - }, - { - "label": _("Status"), - "fieldtype": "Data", - "fieldname": "status", - "width": 100 - }, - { - "label": _("Pledge Time"), - "fieldtype": "Data", - "fieldname": "pledge_time", - "width": 150 + "width": 200, }, + {"label": _("Loan"), "fieldtype": "Link", "fieldname": "loan", "options": "Loan", "width": 200}, + {"label": _("Applicant"), "fieldtype": "Data", "fieldname": "applicant", "width": 200}, + {"label": _("Status"), "fieldtype": "Data", "fieldname": "status", "width": 100}, + {"label": _("Pledge Time"), "fieldtype": "Data", "fieldname": "pledge_time", "width": 150}, { "label": _("Loan Security"), "fieldtype": "Link", "fieldname": "loan_security", "options": "Loan Security", - "width": 150 - }, - { - "label": _("Quantity"), - "fieldtype": "Float", - "fieldname": "qty", - "width": 100 + "width": 150, }, + {"label": _("Quantity"), "fieldtype": "Float", "fieldname": "qty", "width": 100}, { "label": _("Loan Security Price"), "fieldtype": "Currency", "fieldname": "loan_security_price", "options": "currency", - "width": 200 + "width": 200, }, { "label": _("Loan Security Value"), "fieldtype": "Currency", "fieldname": "loan_security_value", "options": "currency", - "width": 200 + "width": 200, }, { "label": _("Currency"), @@ -78,18 +53,20 @@ def get_columns(filters): "fieldname": "currency", "options": "Currency", "width": 50, - "hidden": 1 - } + "hidden": 1, + }, ] return columns + def get_data(filters): data = [] conditions = get_conditions(filters) - loan_security_pledges = frappe.db.sql(""" + loan_security_pledges = frappe.db.sql( + """ SELECT p.name, p.applicant, p.loan, p.status, p.pledge_time, c.loan_security, c.qty, c.loan_security_price, c.amount @@ -100,7 +77,12 @@ def get_data(filters): AND c.parent = p.name AND p.company = %(company)s {conditions} - """.format(conditions = conditions), (filters), as_dict=1) #nosec + """.format( + conditions=conditions + ), + (filters), + as_dict=1, + ) # nosec default_currency = frappe.get_cached_value("Company", filters.get("company"), "default_currency") @@ -121,6 +103,7 @@ def get_data(filters): return data + def get_conditions(filters): conditions = [] diff --git a/erpnext/maintenance/doctype/maintenance_schedule/maintenance_schedule.py b/erpnext/maintenance/doctype/maintenance_schedule/maintenance_schedule.py index 2ffae1a4f2a..2acafc848a1 100644 --- a/erpnext/maintenance/doctype/maintenance_schedule/maintenance_schedule.py +++ b/erpnext/maintenance/doctype/maintenance_schedule/maintenance_schedule.py @@ -1,7 +1,6 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt - import frappe from frappe import _, throw from frappe.utils import add_days, cint, cstr, date_diff, formatdate, getdate @@ -17,17 +16,17 @@ class MaintenanceSchedule(TransactionBase): def generate_schedule(self): if self.docstatus != 0: return - self.set('schedules', []) + self.set("schedules", []) count = 1 - for d in self.get('items'): + for d in self.get("items"): self.validate_maintenance_detail() s_list = [] s_list = self.create_schedule_list(d.start_date, d.end_date, d.no_of_visits, d.sales_person) for i in range(d.no_of_visits): - child = self.append('schedules') + child = self.append("schedules") child.item_code = d.item_code child.item_name = d.item_name - child.scheduled_date = s_list[i].strftime('%Y-%m-%d') + child.scheduled_date = s_list[i].strftime("%Y-%m-%d") if d.serial_no: child.serial_no = d.serial_no child.idx = count @@ -38,18 +37,14 @@ class MaintenanceSchedule(TransactionBase): @frappe.whitelist() def validate_end_date_visits(self): - days_in_period = { - "Weekly": 7, - "Monthly": 30, - "Quarterly": 91, - "Half Yearly": 182, - "Yearly": 365 - } + days_in_period = {"Weekly": 7, "Monthly": 30, "Quarterly": 91, "Half Yearly": 182, "Yearly": 365} for item in self.items: if item.periodicity and item.periodicity != "Random" and item.start_date: if not item.end_date: if item.no_of_visits: - item.end_date = add_days(item.start_date, item.no_of_visits * days_in_period[item.periodicity]) + item.end_date = add_days( + item.start_date, item.no_of_visits * days_in_period[item.periodicity] + ) else: item.end_date = add_days(item.start_date, days_in_period[item.periodicity]) @@ -62,20 +57,23 @@ class MaintenanceSchedule(TransactionBase): item.no_of_visits = cint(diff / days_in_period[item.periodicity]) elif item.no_of_visits > no_of_visits: - item.end_date = add_days(item.start_date, item.no_of_visits * days_in_period[item.periodicity]) + item.end_date = add_days( + item.start_date, item.no_of_visits * days_in_period[item.periodicity] + ) elif item.no_of_visits < no_of_visits: - item.end_date = add_days(item.start_date, item.no_of_visits * days_in_period[item.periodicity]) - + item.end_date = add_days( + item.start_date, item.no_of_visits * days_in_period[item.periodicity] + ) def on_submit(self): - if not self.get('schedules'): + if not self.get("schedules"): throw(_("Please click on 'Generate Schedule' to get schedule")) self.check_serial_no_added() self.validate_schedule() email_map = {} - for d in self.get('items'): + for d in self.get("items"): if d.serial_no: serial_nos = get_valid_serial_nos(d.serial_no) self.validate_serial_no(d.item_code, serial_nos, d.start_date) @@ -91,29 +89,37 @@ class MaintenanceSchedule(TransactionBase): if no_email_sp: frappe.msgprint( - _("Setting Events to {0}, since the Employee attached to the below Sales Persons does not have a User ID{1}").format( - self.owner, "
" + "
".join(no_email_sp) - ) + _( + "Setting Events to {0}, since the Employee attached to the below Sales Persons does not have a User ID{1}" + ).format(self.owner, "
" + "
".join(no_email_sp)) ) - scheduled_date = frappe.db.sql("""select scheduled_date from + scheduled_date = frappe.db.sql( + """select scheduled_date from `tabMaintenance Schedule Detail` where sales_person=%s and item_code=%s and - parent=%s""", (d.sales_person, d.item_code, self.name), as_dict=1) + parent=%s""", + (d.sales_person, d.item_code, self.name), + as_dict=1, + ) for key in scheduled_date: - description =frappe._("Reference: {0}, Item Code: {1} and Customer: {2}").format(self.name, d.item_code, self.customer) - event = frappe.get_doc({ - "doctype": "Event", - "owner": email_map.get(d.sales_person, self.owner), - "subject": description, - "description": description, - "starts_on": cstr(key["scheduled_date"]) + " 10:00:00", - "event_type": "Private", - }) + description = frappe._("Reference: {0}, Item Code: {1} and Customer: {2}").format( + self.name, d.item_code, self.customer + ) + event = frappe.get_doc( + { + "doctype": "Event", + "owner": email_map.get(d.sales_person, self.owner), + "subject": description, + "description": description, + "starts_on": cstr(key["scheduled_date"]) + " 10:00:00", + "event_type": "Private", + } + ) event.add_participant(self.doctype, self.name) event.insert(ignore_permissions=1) - frappe.db.set(self, 'status', 'Submitted') + frappe.db.set(self, "status", "Submitted") def create_schedule_list(self, start_date, end_date, no_of_visit, sales_person): schedule_list = [] @@ -122,11 +128,12 @@ class MaintenanceSchedule(TransactionBase): add_by = date_diff / no_of_visit for visit in range(cint(no_of_visit)): - if (getdate(start_date_copy) < getdate(end_date)): + if getdate(start_date_copy) < getdate(end_date): start_date_copy = add_days(start_date_copy, add_by) if len(schedule_list) < no_of_visit: - schedule_date = self.validate_schedule_date_for_holiday_list(getdate(start_date_copy), - sales_person) + schedule_date = self.validate_schedule_date_for_holiday_list( + getdate(start_date_copy), sales_person + ) if schedule_date > getdate(end_date): schedule_date = getdate(end_date) schedule_list.append(schedule_date) @@ -140,9 +147,11 @@ class MaintenanceSchedule(TransactionBase): if employee: holiday_list = get_holiday_list_for_employee(employee) else: - holiday_list = frappe.get_cached_value('Company', self.company, "default_holiday_list") + holiday_list = frappe.get_cached_value("Company", self.company, "default_holiday_list") - holidays = frappe.db.sql_list('''select holiday_date from `tabHoliday` where parent=%s''', holiday_list) + holidays = frappe.db.sql_list( + """select holiday_date from `tabHoliday` where parent=%s""", holiday_list + ) if not validated and holidays: @@ -158,25 +167,28 @@ class MaintenanceSchedule(TransactionBase): def validate_dates_with_periodicity(self): for d in self.get("items"): - if d.start_date and d.end_date and d.periodicity and d.periodicity!="Random": + if d.start_date and d.end_date and d.periodicity and d.periodicity != "Random": date_diff = (getdate(d.end_date) - getdate(d.start_date)).days + 1 days_in_period = { "Weekly": 7, "Monthly": 30, "Quarterly": 90, "Half Yearly": 180, - "Yearly": 365 + "Yearly": 365, } if date_diff < days_in_period[d.periodicity]: - throw(_("Row {0}: To set {1} periodicity, difference between from and to date must be greater than or equal to {2}") - .format(d.idx, d.periodicity, days_in_period[d.periodicity])) + throw( + _( + "Row {0}: To set {1} periodicity, difference between from and to date must be greater than or equal to {2}" + ).format(d.idx, d.periodicity, days_in_period[d.periodicity]) + ) def validate_maintenance_detail(self): - if not self.get('items'): + if not self.get("items"): throw(_("Please enter Maintaince Details first")) - for d in self.get('items'): + for d in self.get("items"): if not d.item_code: throw(_("Please select item code")) elif not d.start_date or not d.end_date: @@ -190,11 +202,14 @@ class MaintenanceSchedule(TransactionBase): throw(_("Start date should be less than end date for Item {0}").format(d.item_code)) def validate_sales_order(self): - for d in self.get('items'): + for d in self.get("items"): if d.sales_order: - chk = frappe.db.sql("""select ms.name from `tabMaintenance Schedule` ms, + chk = frappe.db.sql( + """select ms.name from `tabMaintenance Schedule` ms, `tabMaintenance Schedule Item` msi where msi.parent=ms.name and - msi.sales_order=%s and ms.docstatus=1""", d.sales_order) + msi.sales_order=%s and ms.docstatus=1""", + d.sales_order, + ) if chk: throw(_("Maintenance Schedule {0} exists against {1}").format(chk[0][0], d.sales_order)) @@ -210,7 +225,7 @@ class MaintenanceSchedule(TransactionBase): self.generate_schedule() def on_update(self): - frappe.db.set(self, 'status', 'Draft') + frappe.db.set(self, "status", "Draft") def update_amc_date(self, serial_nos, amc_expiry_date=None): for serial_no in serial_nos: @@ -220,65 +235,96 @@ class MaintenanceSchedule(TransactionBase): def validate_serial_no(self, item_code, serial_nos, amc_start_date): for serial_no in serial_nos: - sr_details = frappe.db.get_value("Serial No", serial_no, - ["warranty_expiry_date", "amc_expiry_date", "warehouse", "delivery_date", "item_code"], as_dict=1) + sr_details = frappe.db.get_value( + "Serial No", + serial_no, + ["warranty_expiry_date", "amc_expiry_date", "warehouse", "delivery_date", "item_code"], + as_dict=1, + ) if not sr_details: frappe.throw(_("Serial No {0} not found").format(serial_no)) if sr_details.get("item_code") != item_code: - frappe.throw(_("Serial No {0} does not belong to Item {1}") - .format(frappe.bold(serial_no), frappe.bold(item_code)), title="Invalid") + frappe.throw( + _("Serial No {0} does not belong to Item {1}").format( + frappe.bold(serial_no), frappe.bold(item_code) + ), + title="Invalid", + ) - if sr_details.warranty_expiry_date \ - and getdate(sr_details.warranty_expiry_date) >= getdate(amc_start_date): - throw(_("Serial No {0} is under warranty upto {1}") - .format(serial_no, sr_details.warranty_expiry_date)) + if sr_details.warranty_expiry_date and getdate(sr_details.warranty_expiry_date) >= getdate( + amc_start_date + ): + throw( + _("Serial No {0} is under warranty upto {1}").format( + serial_no, sr_details.warranty_expiry_date + ) + ) - if sr_details.amc_expiry_date and getdate(sr_details.amc_expiry_date) >= getdate(amc_start_date): - throw(_("Serial No {0} is under maintenance contract upto {1}") - .format(serial_no, sr_details.amc_expiry_date)) + if sr_details.amc_expiry_date and getdate(sr_details.amc_expiry_date) >= getdate( + amc_start_date + ): + throw( + _("Serial No {0} is under maintenance contract upto {1}").format( + serial_no, sr_details.amc_expiry_date + ) + ) - if not sr_details.warehouse and sr_details.delivery_date and \ - getdate(sr_details.delivery_date) >= getdate(amc_start_date): - throw(_("Maintenance start date can not be before delivery date for Serial No {0}") - .format(serial_no)) + if ( + not sr_details.warehouse + and sr_details.delivery_date + and getdate(sr_details.delivery_date) >= getdate(amc_start_date) + ): + throw( + _("Maintenance start date can not be before delivery date for Serial No {0}").format( + serial_no + ) + ) def validate_schedule(self): - item_lst1 =[] - item_lst2 =[] - for d in self.get('items'): + item_lst1 = [] + item_lst2 = [] + for d in self.get("items"): if d.item_code not in item_lst1: item_lst1.append(d.item_code) - for m in self.get('schedules'): + for m in self.get("schedules"): if m.item_code not in item_lst2: item_lst2.append(m.item_code) if len(item_lst1) != len(item_lst2): - throw(_("Maintenance Schedule is not generated for all the items. Please click on 'Generate Schedule'")) + throw( + _( + "Maintenance Schedule is not generated for all the items. Please click on 'Generate Schedule'" + ) + ) else: for x in item_lst1: if x not in item_lst2: throw(_("Please click on 'Generate Schedule'")) def check_serial_no_added(self): - serial_present =[] - for d in self.get('items'): + serial_present = [] + for d in self.get("items"): if d.serial_no: serial_present.append(d.item_code) - for m in self.get('schedules'): + for m in self.get("schedules"): if serial_present: if m.item_code in serial_present and not m.serial_no: - throw(_("Please click on 'Generate Schedule' to fetch Serial No added for Item {0}").format(m.item_code)) + throw( + _("Please click on 'Generate Schedule' to fetch Serial No added for Item {0}").format( + m.item_code + ) + ) def on_cancel(self): - for d in self.get('items'): + for d in self.get("items"): if d.serial_no: serial_nos = get_valid_serial_nos(d.serial_no) self.update_amc_date(serial_nos) - frappe.db.set(self, 'status', 'Cancelled') + frappe.db.set(self, "status", "Cancelled") delete_events(self.doctype, self.name) def on_trash(self): @@ -302,17 +348,25 @@ class MaintenanceSchedule(TransactionBase): return items elif data_type == "id": for schedule in self.schedules: - if schedule.item_name == item_name and s_date == formatdate(schedule.scheduled_date, "dd-mm-yyyy"): + if schedule.item_name == item_name and s_date == formatdate( + schedule.scheduled_date, "dd-mm-yyyy" + ): return schedule.name + @frappe.whitelist() -def update_serial_nos(s_id): - serial_nos = frappe.db.get_value('Maintenance Schedule Detail', s_id, 'serial_no') +def get_serial_nos_from_schedule(item_code, schedule=None): + serial_nos = [] + if schedule: + serial_nos = frappe.db.get_value( + "Maintenance Schedule Item", {"parent": schedule, "item_code": item_code}, "serial_no" + ) + if serial_nos: serial_nos = get_serial_nos(serial_nos) - return serial_nos - else: - return False + + return serial_nos + @frappe.whitelist() def make_maintenance_visit(source_name, target_doc=None, item_name=None, s_id=None): @@ -320,34 +374,33 @@ def make_maintenance_visit(source_name, target_doc=None, item_name=None, s_id=No def update_status_and_detail(source, target, parent): target.maintenance_type = "Scheduled" - target.maintenance_schedule = source.name target.maintenance_schedule_detail = s_id - def update_sales_and_serial(source, target, parent): - sales_person = frappe.db.get_value('Maintenance Schedule Detail', s_id, 'sales_person') - target.service_person = sales_person + def update_serial(source, target, parent): serial_nos = get_serial_nos(target.serial_no) if len(serial_nos) == 1: target.serial_no = serial_nos[0] else: - target.serial_no = '' + target.serial_no = "" - doclist = get_mapped_doc("Maintenance Schedule", source_name, { - "Maintenance Schedule": { - "doctype": "Maintenance Visit", - "field_map": { - "name": "maintenance_schedule" + doclist = get_mapped_doc( + "Maintenance Schedule", + source_name, + { + "Maintenance Schedule": { + "doctype": "Maintenance Visit", + "field_map": {"name": "maintenance_schedule"}, + "validation": {"docstatus": ["=", 1]}, + "postprocess": update_status_and_detail, }, - "validation": { - "docstatus": ["=", 1] + "Maintenance Schedule Item": { + "doctype": "Maintenance Visit Purpose", + "condition": lambda doc: doc.item_name == item_name if item_name else True, + "field_map": {"sales_person": "service_person"}, + "postprocess": update_serial, }, - "postprocess": update_status_and_detail }, - "Maintenance Schedule Item": { - "doctype": "Maintenance Visit Purpose", - "condition": lambda doc: doc.item_name == item_name, - "postprocess": update_sales_and_serial - } - }, target_doc) + target_doc, + ) return doclist diff --git a/erpnext/maintenance/doctype/maintenance_schedule/test_maintenance_schedule.py b/erpnext/maintenance/doctype/maintenance_schedule/test_maintenance_schedule.py index 501712613a8..a98cd10e320 100644 --- a/erpnext/maintenance/doctype/maintenance_schedule/test_maintenance_schedule.py +++ b/erpnext/maintenance/doctype/maintenance_schedule/test_maintenance_schedule.py @@ -4,14 +4,19 @@ import unittest import frappe +from frappe.utils import format_date from frappe.utils.data import add_days, formatdate, today from erpnext.maintenance.doctype.maintenance_schedule.maintenance_schedule import ( + get_serial_nos_from_schedule, make_maintenance_visit, ) +from erpnext.stock.doctype.item.test_item import create_item +from erpnext.stock.doctype.stock_entry.test_stock_entry import make_serialized_item # test_records = frappe.get_test_records('Maintenance Schedule') + class TestMaintenanceSchedule(unittest.TestCase): def test_events_should_be_created_and_deleted(self): ms = make_maintenance_schedule() @@ -38,15 +43,15 @@ class TestMaintenanceSchedule(unittest.TestCase): expected_end_date = add_days(i.start_date, i.no_of_visits * 7) self.assertEqual(i.end_date, expected_end_date) - items = ms.get_pending_data(data_type = "items") - items = items.split('\n') + items = ms.get_pending_data(data_type="items") + items = items.split("\n") items.pop(0) - expected_items = ['_Test Item'] + expected_items = ["_Test Item"] self.assertTrue(items, expected_items) # "dates" contains all generated schedule dates - dates = ms.get_pending_data(data_type = "date", item_name = i.item_name) - dates = dates.split('\n') + dates = ms.get_pending_data(data_type="date", item_name=i.item_name) + dates = dates.split("\n") dates.pop(0) expected_dates.append(formatdate(add_days(i.start_date, 7), "dd-MM-yyyy")) expected_dates.append(formatdate(add_days(i.start_date, 14), "dd-MM-yyyy")) @@ -55,51 +60,105 @@ class TestMaintenanceSchedule(unittest.TestCase): self.assertEqual(dates, expected_dates) ms.submit() - s_id = ms.get_pending_data(data_type = "id", item_name = i.item_name, s_date = expected_dates[1]) + s_id = ms.get_pending_data(data_type="id", item_name=i.item_name, s_date=expected_dates[1]) # Check if item is mapped in visit. - test_map_visit = make_maintenance_visit(source_name = ms.name, item_name = "_Test Item", s_id = s_id) + test_map_visit = make_maintenance_visit(source_name=ms.name, item_name="_Test Item", s_id=s_id) self.assertEqual(len(test_map_visit.purposes), 1) self.assertEqual(test_map_visit.purposes[0].item_name, "_Test Item") - visit = frappe.new_doc('Maintenance Visit') + visit = frappe.new_doc("Maintenance Visit") visit = test_map_visit visit.maintenance_schedule = ms.name visit.maintenance_schedule_detail = s_id visit.completion_status = "Partially Completed" - visit.set('purposes', [{ - 'item_code': i.item_code, - 'description': "test", - 'work_done': "test", - 'service_person': "Sales Team", - }]) + visit.set( + "purposes", + [ + { + "item_code": i.item_code, + "description": "test", + "work_done": "test", + "service_person": "Sales Team", + } + ], + ) visit.save() visit.submit() - ms = frappe.get_doc('Maintenance Schedule', ms.name) + ms = frappe.get_doc("Maintenance Schedule", ms.name) - #checks if visit status is back updated in schedule + # checks if visit status is back updated in schedule self.assertTrue(ms.schedules[1].completion_status, "Partially Completed") + self.assertEqual(format_date(visit.mntc_date), format_date(ms.schedules[1].actual_date)) + + # checks if visit status is updated on cancel + visit.cancel() + ms.reload() + self.assertTrue(ms.schedules[1].completion_status, "Pending") + self.assertEqual(ms.schedules[1].actual_date, None) + + def test_serial_no_filters(self): + # Without serial no. set in schedule -> returns None + item_code = "_Test Serial Item" + make_serial_item_with_serial(item_code) + ms = make_maintenance_schedule(item_code=item_code) + ms.submit() + + s_item = ms.schedules[0] + mv = make_maintenance_visit(source_name=ms.name, item_name=item_code, s_id=s_item.name) + mvi = mv.purposes[0] + serial_nos = get_serial_nos_from_schedule(mvi.item_name, ms.name) + self.assertEqual(serial_nos, None) + + # With serial no. set in schedule -> returns serial nos. + make_serial_item_with_serial(item_code) + ms = make_maintenance_schedule(item_code=item_code, serial_no="TEST001, TEST002") + ms.submit() + + s_item = ms.schedules[0] + mv = make_maintenance_visit(source_name=ms.name, item_name=item_code, s_id=s_item.name) + mvi = mv.purposes[0] + serial_nos = get_serial_nos_from_schedule(mvi.item_name, ms.name) + self.assertEqual(serial_nos, ["TEST001", "TEST002"]) + + frappe.db.rollback() + + +def make_serial_item_with_serial(item_code): + serial_item_doc = create_item(item_code, is_stock_item=1) + if not serial_item_doc.has_serial_no or not serial_item_doc.serial_no_series: + serial_item_doc.has_serial_no = 1 + serial_item_doc.serial_no_series = "TEST.###" + serial_item_doc.save(ignore_permissions=True) + active_serials = frappe.db.get_all("Serial No", {"status": "Active", "item_code": item_code}) + if len(active_serials) < 2: + make_serialized_item(item_code=item_code) + def get_events(ms): - return frappe.get_all("Event Participants", filters={ - "reference_doctype": ms.doctype, - "reference_docname": ms.name, - "parenttype": "Event" - }) + return frappe.get_all( + "Event Participants", + filters={"reference_doctype": ms.doctype, "reference_docname": ms.name, "parenttype": "Event"}, + ) -def make_maintenance_schedule(): + +def make_maintenance_schedule(**args): ms = frappe.new_doc("Maintenance Schedule") ms.company = "_Test Company" ms.customer = "_Test Customer" ms.transaction_date = today() - ms.append("items", { - "item_code": "_Test Item", - "start_date": today(), - "periodicity": "Weekly", - "no_of_visits": 4, - "sales_person": "Sales Team", - }) + ms.append( + "items", + { + "item_code": args.get("item_code") or "_Test Item", + "start_date": today(), + "periodicity": "Weekly", + "no_of_visits": 4, + "serial_no": args.get("serial_no"), + "sales_person": "Sales Team", + }, + ) ms.insert(ignore_permissions=True) return ms diff --git a/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.js b/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.js index 78289679744..939df5c07c5 100644 --- a/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.js +++ b/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.js @@ -2,52 +2,57 @@ // License: GNU General Public License v3. See license.txt frappe.provide("erpnext.maintenance"); -var serial_nos = []; frappe.ui.form.on('Maintenance Visit', { - refresh: function (frm) { - //filters for serial_no based on item_code - frm.set_query('serial_no', 'purposes', function (frm, cdt, cdn) { - let item = locals[cdt][cdn]; - if (serial_nos) { - return { - filters: { - 'item_code': item.item_code, - 'name': ["in", serial_nos] - } - }; - } else { - return { - filters: { - 'item_code': item.item_code - } - }; - } - }); - }, setup: function (frm) { frm.set_query('contact_person', erpnext.queries.contact_query); frm.set_query('customer_address', erpnext.queries.address_query); frm.set_query('customer', erpnext.queries.customer); }, - onload: function (frm, cdt, cdn) { - let item = locals[cdt][cdn]; + onload: function (frm) { + // filters for serial no based on item code if (frm.doc.maintenance_type === "Scheduled") { - const schedule_id = item.purposes[0].prevdoc_detail_docname || frm.doc.maintenance_schedule_detail; + let item_code = frm.doc.purposes[0].item_code; + if (!item_code) { + return; + } frappe.call({ - method: "erpnext.maintenance.doctype.maintenance_schedule.maintenance_schedule.update_serial_nos", + method: "erpnext.maintenance.doctype.maintenance_schedule.maintenance_schedule.get_serial_nos_from_schedule", args: { - s_id: schedule_id - }, - callback: function (r) { - serial_nos = r.message; + schedule: frm.doc.maintenance_schedule, + item_code: item_code } + }).then((r) => { + let serial_nos = r.message; + frm.set_query('serial_no', 'purposes', () => { + if (serial_nos.length > 0) { + return { + filters: { + 'item_code': item_code, + 'name': ["in", serial_nos] + } + }; + } + return { + filters: { + 'item_code': item_code + } + }; + }); + }); + } else { + frm.set_query('serial_no', 'purposes', (frm, cdt, cdn) => { + let row = locals[cdt][cdn]; + return { + filters: { + 'item_code': row.item_code + } + }; }); } if (!frm.doc.status) { frm.set_value({ status: 'Draft' }); } if (frm.doc.__islocal) { - frm.doc.maintenance_type == 'Unscheduled' && frm.clear_table("purposes"); frm.set_value({ mntc_date: frappe.datetime.get_today() }); } }, @@ -60,7 +65,6 @@ frappe.ui.form.on('Maintenance Visit', { contact_person: function (frm) { erpnext.utils.get_contact_details(frm); } - }) // TODO commonify this code diff --git a/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.json b/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.json index ec32239518f..4a6aa0a34bf 100644 --- a/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.json +++ b/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.json @@ -179,8 +179,7 @@ "label": "Purposes", "oldfieldname": "maintenance_visit_details", "oldfieldtype": "Table", - "options": "Maintenance Visit Purpose", - "reqd": 1 + "options": "Maintenance Visit Purpose" }, { "fieldname": "more_info", @@ -294,10 +293,11 @@ "idx": 1, "is_submittable": 1, "links": [], - "modified": "2021-05-27 16:06:17.352572", + "modified": "2021-12-17 03:10:27.608112", "modified_by": "Administrator", "module": "Maintenance", "name": "Maintenance Visit", + "naming_rule": "By \"Naming Series\" field", "owner": "Administrator", "permissions": [ { diff --git a/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.py b/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.py index 5a87b162af6..29a17849fd9 100644 --- a/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.py +++ b/erpnext/maintenance/doctype/maintenance_visit/maintenance_visit.py @@ -4,7 +4,7 @@ import frappe from frappe import _ -from frappe.utils import get_datetime +from frappe.utils import format_date, get_datetime from erpnext.utilities.transaction_base import TransactionBase @@ -14,95 +14,124 @@ class MaintenanceVisit(TransactionBase): return _("To {0}").format(self.customer_name) def validate_serial_no(self): - for d in self.get('purposes'): + for d in self.get("purposes"): if d.serial_no and not frappe.db.exists("Serial No", d.serial_no): frappe.throw(_("Serial No {0} does not exist").format(d.serial_no)) + def validate_purpose_table(self): + if not self.purposes: + frappe.throw(_("Add Items in the Purpose Table"), title="Purposes Required") + def validate_maintenance_date(self): if self.maintenance_type == "Scheduled" and self.maintenance_schedule_detail: - item_ref = frappe.db.get_value('Maintenance Schedule Detail', self.maintenance_schedule_detail, 'item_reference') + item_ref = frappe.db.get_value( + "Maintenance Schedule Detail", self.maintenance_schedule_detail, "item_reference" + ) if item_ref: - start_date, end_date = frappe.db.get_value('Maintenance Schedule Item', item_ref, ['start_date', 'end_date']) - if get_datetime(self.mntc_date) < get_datetime(start_date) or get_datetime(self.mntc_date) > get_datetime(end_date): - frappe.throw(_("Date must be between {0} and {1}").format(start_date, end_date)) + start_date, end_date = frappe.db.get_value( + "Maintenance Schedule Item", item_ref, ["start_date", "end_date"] + ) + if get_datetime(self.mntc_date) < get_datetime(start_date) or get_datetime( + self.mntc_date + ) > get_datetime(end_date): + frappe.throw( + _("Date must be between {0} and {1}").format(format_date(start_date), format_date(end_date)) + ) def validate(self): self.validate_serial_no() self.validate_maintenance_date() + self.validate_purpose_table() - def update_completion_status(self): + def update_status_and_actual_date(self, cancel=False): + status = "Pending" + actual_date = None + if not cancel: + status = self.completion_status + actual_date = self.mntc_date if self.maintenance_schedule_detail: - frappe.db.set_value('Maintenance Schedule Detail', self.maintenance_schedule_detail, 'completion_status', self.completion_status) - - def update_actual_date(self): - if self.maintenance_schedule_detail: - frappe.db.set_value('Maintenance Schedule Detail', self.maintenance_schedule_detail, 'actual_date', self.mntc_date) + frappe.db.set_value( + "Maintenance Schedule Detail", self.maintenance_schedule_detail, "completion_status", status + ) + frappe.db.set_value( + "Maintenance Schedule Detail", self.maintenance_schedule_detail, "actual_date", actual_date + ) def update_customer_issue(self, flag): if not self.maintenance_schedule: - for d in self.get('purposes'): - if d.prevdoc_docname and d.prevdoc_doctype == 'Warranty Claim' : - if flag==1: + for d in self.get("purposes"): + if d.prevdoc_docname and d.prevdoc_doctype == "Warranty Claim": + if flag == 1: mntc_date = self.mntc_date service_person = d.service_person work_done = d.work_done status = "Open" - if self.completion_status == 'Fully Completed': - status = 'Closed' - elif self.completion_status == 'Partially Completed': - status = 'Work In Progress' + if self.completion_status == "Fully Completed": + status = "Closed" + elif self.completion_status == "Partially Completed": + status = "Work In Progress" else: - nm = frappe.db.sql("select t1.name, t1.mntc_date, t2.service_person, t2.work_done from `tabMaintenance Visit` t1, `tabMaintenance Visit Purpose` t2 where t2.parent = t1.name and t1.completion_status = 'Partially Completed' and t2.prevdoc_docname = %s and t1.name!=%s and t1.docstatus = 1 order by t1.name desc limit 1", (d.prevdoc_docname, self.name)) + nm = frappe.db.sql( + "select t1.name, t1.mntc_date, t2.service_person, t2.work_done from `tabMaintenance Visit` t1, `tabMaintenance Visit Purpose` t2 where t2.parent = t1.name and t1.completion_status = 'Partially Completed' and t2.prevdoc_docname = %s and t1.name!=%s and t1.docstatus = 1 order by t1.name desc limit 1", + (d.prevdoc_docname, self.name), + ) if nm: - status = 'Work In Progress' - mntc_date = nm and nm[0][1] or '' - service_person = nm and nm[0][2] or '' - work_done = nm and nm[0][3] or '' + status = "Work In Progress" + mntc_date = nm and nm[0][1] or "" + service_person = nm and nm[0][2] or "" + work_done = nm and nm[0][3] or "" else: - status = 'Open' + status = "Open" mntc_date = None service_person = None work_done = None - wc_doc = frappe.get_doc('Warranty Claim', d.prevdoc_docname) - wc_doc.update({ - 'resolution_date': mntc_date, - 'resolved_by': service_person, - 'resolution_details': work_done, - 'status': status - }) + wc_doc = frappe.get_doc("Warranty Claim", d.prevdoc_docname) + wc_doc.update( + { + "resolution_date": mntc_date, + "resolved_by": service_person, + "resolution_details": work_done, + "status": status, + } + ) wc_doc.db_update() def check_if_last_visit(self): """check if last maintenance visit against same sales order/ Warranty Claim""" check_for_docname = None - for d in self.get('purposes'): + for d in self.get("purposes"): if d.prevdoc_docname: check_for_docname = d.prevdoc_docname - #check_for_doctype = d.prevdoc_doctype + # check_for_doctype = d.prevdoc_doctype if check_for_docname: - check = frappe.db.sql("select t1.name from `tabMaintenance Visit` t1, `tabMaintenance Visit Purpose` t2 where t2.parent = t1.name and t1.name!=%s and t2.prevdoc_docname=%s and t1.docstatus = 1 and (t1.mntc_date > %s or (t1.mntc_date = %s and t1.mntc_time > %s))", (self.name, check_for_docname, self.mntc_date, self.mntc_date, self.mntc_time)) + check = frappe.db.sql( + "select t1.name from `tabMaintenance Visit` t1, `tabMaintenance Visit Purpose` t2 where t2.parent = t1.name and t1.name!=%s and t2.prevdoc_docname=%s and t1.docstatus = 1 and (t1.mntc_date > %s or (t1.mntc_date = %s and t1.mntc_time > %s))", + (self.name, check_for_docname, self.mntc_date, self.mntc_date, self.mntc_time), + ) if check: check_lst = [x[0] for x in check] - check_lst =','.join(check_lst) - frappe.throw(_("Cancel Material Visits {0} before cancelling this Maintenance Visit").format(check_lst)) + check_lst = ",".join(check_lst) + frappe.throw( + _("Cancel Material Visits {0} before cancelling this Maintenance Visit").format(check_lst) + ) raise Exception else: self.update_customer_issue(0) def on_submit(self): self.update_customer_issue(1) - frappe.db.set(self, 'status', 'Submitted') - self.update_completion_status() - self.update_actual_date() + frappe.db.set(self, "status", "Submitted") + self.update_status_and_actual_date() def on_cancel(self): self.check_if_last_visit() - frappe.db.set(self, 'status', 'Cancelled') + frappe.db.set(self, "status", "Cancelled") + self.update_status_and_actual_date(cancel=True) def on_update(self): pass diff --git a/erpnext/maintenance/doctype/maintenance_visit/test_maintenance_visit.py b/erpnext/maintenance/doctype/maintenance_visit/test_maintenance_visit.py index a0c1a338e49..bdbed7c0965 100644 --- a/erpnext/maintenance/doctype/maintenance_visit/test_maintenance_visit.py +++ b/erpnext/maintenance/doctype/maintenance_visit/test_maintenance_visit.py @@ -5,5 +5,6 @@ import unittest # test_records = frappe.get_test_records('Maintenance Visit') + class TestMaintenanceVisit(unittest.TestCase): pass diff --git a/erpnext/manufacturing/dashboard_fixtures.py b/erpnext/manufacturing/dashboard_fixtures.py index 1bc12ff35eb..9e64f4dc196 100644 --- a/erpnext/manufacturing/dashboard_fixtures.py +++ b/erpnext/manufacturing/dashboard_fixtures.py @@ -11,33 +11,39 @@ import erpnext def get_data(): - return frappe._dict({ - "dashboards": get_dashboards(), - "charts": get_charts(), - "number_cards": get_number_cards(), - }) + return frappe._dict( + { + "dashboards": get_dashboards(), + "charts": get_charts(), + "number_cards": get_number_cards(), + } + ) + def get_dashboards(): - return [{ - "name": "Manufacturing", - "dashboard_name": "Manufacturing", - "charts": [ - { "chart": "Produced Quantity", "width": "Half" }, - { "chart": "Completed Operation", "width": "Half" }, - { "chart": "Work Order Analysis", "width": "Half" }, - { "chart": "Quality Inspection Analysis", "width": "Half" }, - { "chart": "Pending Work Order", "width": "Half" }, - { "chart": "Last Month Downtime Analysis", "width": "Half" }, - { "chart": "Work Order Qty Analysis", "width": "Full" }, - { "chart": "Job Card Analysis", "width": "Full" } - ], - "cards": [ - { "card": "Monthly Total Work Order" }, - { "card": "Monthly Completed Work Order" }, - { "card": "Ongoing Job Card" }, - { "card": "Monthly Quality Inspection"} - ] - }] + return [ + { + "name": "Manufacturing", + "dashboard_name": "Manufacturing", + "charts": [ + {"chart": "Produced Quantity", "width": "Half"}, + {"chart": "Completed Operation", "width": "Half"}, + {"chart": "Work Order Analysis", "width": "Half"}, + {"chart": "Quality Inspection Analysis", "width": "Half"}, + {"chart": "Pending Work Order", "width": "Half"}, + {"chart": "Last Month Downtime Analysis", "width": "Half"}, + {"chart": "Work Order Qty Analysis", "width": "Full"}, + {"chart": "Job Card Analysis", "width": "Full"}, + ], + "cards": [ + {"card": "Monthly Total Work Order"}, + {"card": "Monthly Completed Work Order"}, + {"card": "Ongoing Job Card"}, + {"card": "Monthly Quality Inspection"}, + ], + } + ] + def get_charts(): company = erpnext.get_default_company() @@ -45,200 +51,198 @@ def get_charts(): if not company: company = frappe.db.get_value("Company", {"is_group": 0}, "name") - return [{ - "doctype": "Dashboard Chart", - "based_on": "modified", - "chart_type": "Sum", - "chart_name": _("Produced Quantity"), - "name": "Produced Quantity", - "document_type": "Work Order", - "filters_json": json.dumps([['Work Order', 'docstatus', '=', 1, False]]), - "group_by_type": "Count", - "time_interval": "Monthly", - "timespan": "Last Year", - "owner": "Administrator", - "type": "Line", - "value_based_on": "produced_qty", - "is_public": 1, - "timeseries": 1 - }, { - "doctype": "Dashboard Chart", - "based_on": "creation", - "chart_type": "Sum", - "chart_name": _("Completed Operation"), - "name": "Completed Operation", - "document_type": "Work Order Operation", - "filters_json": json.dumps([['Work Order Operation', 'docstatus', '=', 1, False]]), - "group_by_type": "Count", - "time_interval": "Quarterly", - "timespan": "Last Year", - "owner": "Administrator", - "type": "Line", - "value_based_on": "completed_qty", - "is_public": 1, - "timeseries": 1 - }, { - "doctype": "Dashboard Chart", - "time_interval": "Yearly", - "chart_type": "Report", - "chart_name": _("Work Order Analysis"), - "name": "Work Order Analysis", - "timespan": "Last Year", - "report_name": "Work Order Summary", - "owner": "Administrator", - "filters_json": json.dumps({"company": company, "charts_based_on": "Status"}), - "type": "Donut", - "is_public": 1, - "is_custom": 1, - "custom_options": json.dumps({ - "axisOptions": { - "shortenYAxisNumbers": 1 - }, - "height": 300 - }), - }, { - "doctype": "Dashboard Chart", - "time_interval": "Yearly", - "chart_type": "Report", - "chart_name": _("Quality Inspection Analysis"), - "name": "Quality Inspection Analysis", - "timespan": "Last Year", - "report_name": "Quality Inspection Summary", - "owner": "Administrator", - "filters_json": json.dumps({}), - "type": "Donut", - "is_public": 1, - "is_custom": 1, - "custom_options": json.dumps({ - "axisOptions": { - "shortenYAxisNumbers": 1 - }, - "height": 300 - }), - }, { - "doctype": "Dashboard Chart", - "time_interval": "Yearly", - "chart_type": "Report", - "chart_name": _("Pending Work Order"), - "name": "Pending Work Order", - "timespan": "Last Year", - "report_name": "Work Order Summary", - "filters_json": json.dumps({"company": company, "charts_based_on": "Age"}), - "owner": "Administrator", - "type": "Donut", - "is_public": 1, - "is_custom": 1, - "custom_options": json.dumps({ - "axisOptions": { - "shortenYAxisNumbers": 1 - }, - "height": 300 - }), - }, { - "doctype": "Dashboard Chart", - "time_interval": "Yearly", - "chart_type": "Report", - "chart_name": _("Last Month Downtime Analysis"), - "name": "Last Month Downtime Analysis", - "timespan": "Last Year", - "filters_json": json.dumps({}), - "report_name": "Downtime Analysis", - "owner": "Administrator", - "is_public": 1, - "is_custom": 1, - "type": "Bar" - }, { - "doctype": "Dashboard Chart", - "time_interval": "Yearly", - "chart_type": "Report", - "chart_name": _("Work Order Qty Analysis"), - "name": "Work Order Qty Analysis", - "timespan": "Last Year", - "report_name": "Work Order Summary", - "filters_json": json.dumps({"company": company, "charts_based_on": "Quantity"}), - "owner": "Administrator", - "type": "Bar", - "is_public": 1, - "is_custom": 1, - "custom_options": json.dumps({ - "barOptions": { "stacked": 1 } - }), - }, { - "doctype": "Dashboard Chart", - "time_interval": "Yearly", - "chart_type": "Report", - "chart_name": _("Job Card Analysis"), - "name": "Job Card Analysis", - "timespan": "Last Year", - "report_name": "Job Card Summary", - "owner": "Administrator", - "is_public": 1, - "is_custom": 1, - "filters_json": json.dumps({"company": company, "docstatus": 1, "range":"Monthly"}), - "custom_options": json.dumps({ - "barOptions": { "stacked": 1 } - }), - "type": "Bar" - }] + return [ + { + "doctype": "Dashboard Chart", + "based_on": "modified", + "chart_type": "Sum", + "chart_name": _("Produced Quantity"), + "name": "Produced Quantity", + "document_type": "Work Order", + "filters_json": json.dumps([["Work Order", "docstatus", "=", 1, False]]), + "group_by_type": "Count", + "time_interval": "Monthly", + "timespan": "Last Year", + "owner": "Administrator", + "type": "Line", + "value_based_on": "produced_qty", + "is_public": 1, + "timeseries": 1, + }, + { + "doctype": "Dashboard Chart", + "based_on": "creation", + "chart_type": "Sum", + "chart_name": _("Completed Operation"), + "name": "Completed Operation", + "document_type": "Work Order Operation", + "filters_json": json.dumps([["Work Order Operation", "docstatus", "=", 1, False]]), + "group_by_type": "Count", + "time_interval": "Quarterly", + "timespan": "Last Year", + "owner": "Administrator", + "type": "Line", + "value_based_on": "completed_qty", + "is_public": 1, + "timeseries": 1, + }, + { + "doctype": "Dashboard Chart", + "time_interval": "Yearly", + "chart_type": "Report", + "chart_name": _("Work Order Analysis"), + "name": "Work Order Analysis", + "timespan": "Last Year", + "report_name": "Work Order Summary", + "owner": "Administrator", + "filters_json": json.dumps({"company": company, "charts_based_on": "Status"}), + "type": "Donut", + "is_public": 1, + "is_custom": 1, + "custom_options": json.dumps({"axisOptions": {"shortenYAxisNumbers": 1}, "height": 300}), + }, + { + "doctype": "Dashboard Chart", + "time_interval": "Yearly", + "chart_type": "Report", + "chart_name": _("Quality Inspection Analysis"), + "name": "Quality Inspection Analysis", + "timespan": "Last Year", + "report_name": "Quality Inspection Summary", + "owner": "Administrator", + "filters_json": json.dumps({}), + "type": "Donut", + "is_public": 1, + "is_custom": 1, + "custom_options": json.dumps({"axisOptions": {"shortenYAxisNumbers": 1}, "height": 300}), + }, + { + "doctype": "Dashboard Chart", + "time_interval": "Yearly", + "chart_type": "Report", + "chart_name": _("Pending Work Order"), + "name": "Pending Work Order", + "timespan": "Last Year", + "report_name": "Work Order Summary", + "filters_json": json.dumps({"company": company, "charts_based_on": "Age"}), + "owner": "Administrator", + "type": "Donut", + "is_public": 1, + "is_custom": 1, + "custom_options": json.dumps({"axisOptions": {"shortenYAxisNumbers": 1}, "height": 300}), + }, + { + "doctype": "Dashboard Chart", + "time_interval": "Yearly", + "chart_type": "Report", + "chart_name": _("Last Month Downtime Analysis"), + "name": "Last Month Downtime Analysis", + "timespan": "Last Year", + "filters_json": json.dumps({}), + "report_name": "Downtime Analysis", + "owner": "Administrator", + "is_public": 1, + "is_custom": 1, + "type": "Bar", + }, + { + "doctype": "Dashboard Chart", + "time_interval": "Yearly", + "chart_type": "Report", + "chart_name": _("Work Order Qty Analysis"), + "name": "Work Order Qty Analysis", + "timespan": "Last Year", + "report_name": "Work Order Summary", + "filters_json": json.dumps({"company": company, "charts_based_on": "Quantity"}), + "owner": "Administrator", + "type": "Bar", + "is_public": 1, + "is_custom": 1, + "custom_options": json.dumps({"barOptions": {"stacked": 1}}), + }, + { + "doctype": "Dashboard Chart", + "time_interval": "Yearly", + "chart_type": "Report", + "chart_name": _("Job Card Analysis"), + "name": "Job Card Analysis", + "timespan": "Last Year", + "report_name": "Job Card Summary", + "owner": "Administrator", + "is_public": 1, + "is_custom": 1, + "filters_json": json.dumps({"company": company, "docstatus": 1, "range": "Monthly"}), + "custom_options": json.dumps({"barOptions": {"stacked": 1}}), + "type": "Bar", + }, + ] + def get_number_cards(): start_date = add_months(nowdate(), -1) end_date = nowdate() - return [{ - "doctype": "Number Card", - "document_type": "Work Order", - "name": "Monthly Total Work Order", - "filters_json": json.dumps([ - ['Work Order', 'docstatus', '=', 1], - ['Work Order', 'creation', 'between', [start_date, end_date]] - ]), - "function": "Count", - "is_public": 1, - "label": _("Monthly Total Work Orders"), - "show_percentage_stats": 1, - "stats_time_interval": "Weekly" - }, - { - "doctype": "Number Card", - "document_type": "Work Order", - "name": "Monthly Completed Work Order", - "filters_json": json.dumps([ - ['Work Order', 'status', '=', 'Completed'], - ['Work Order', 'docstatus', '=', 1], - ['Work Order', 'creation', 'between', [start_date, end_date]] - ]), - "function": "Count", - "is_public": 1, - "label": _("Monthly Completed Work Orders"), - "show_percentage_stats": 1, - "stats_time_interval": "Weekly" - }, - { - "doctype": "Number Card", - "document_type": "Job Card", - "name": "Ongoing Job Card", - "filters_json": json.dumps([ - ['Job Card', 'status','!=','Completed'], - ['Job Card', 'docstatus', '=', 1] - ]), - "function": "Count", - "is_public": 1, - "label": _("Ongoing Job Cards"), - "show_percentage_stats": 1, - "stats_time_interval": "Weekly" - }, - { - "doctype": "Number Card", - "document_type": "Quality Inspection", - "name": "Monthly Quality Inspection", - "filters_json": json.dumps([ - ['Quality Inspection', 'docstatus', '=', 1], - ['Quality Inspection', 'creation', 'between', [start_date, end_date]] - ]), - "function": "Count", - "is_public": 1, - "label": _("Monthly Quality Inspections"), - "show_percentage_stats": 1, - "stats_time_interval": "Weekly" - }] + return [ + { + "doctype": "Number Card", + "document_type": "Work Order", + "name": "Monthly Total Work Order", + "filters_json": json.dumps( + [ + ["Work Order", "docstatus", "=", 1], + ["Work Order", "creation", "between", [start_date, end_date]], + ] + ), + "function": "Count", + "is_public": 1, + "label": _("Monthly Total Work Orders"), + "show_percentage_stats": 1, + "stats_time_interval": "Weekly", + }, + { + "doctype": "Number Card", + "document_type": "Work Order", + "name": "Monthly Completed Work Order", + "filters_json": json.dumps( + [ + ["Work Order", "status", "=", "Completed"], + ["Work Order", "docstatus", "=", 1], + ["Work Order", "creation", "between", [start_date, end_date]], + ] + ), + "function": "Count", + "is_public": 1, + "label": _("Monthly Completed Work Orders"), + "show_percentage_stats": 1, + "stats_time_interval": "Weekly", + }, + { + "doctype": "Number Card", + "document_type": "Job Card", + "name": "Ongoing Job Card", + "filters_json": json.dumps( + [["Job Card", "status", "!=", "Completed"], ["Job Card", "docstatus", "=", 1]] + ), + "function": "Count", + "is_public": 1, + "label": _("Ongoing Job Cards"), + "show_percentage_stats": 1, + "stats_time_interval": "Weekly", + }, + { + "doctype": "Number Card", + "document_type": "Quality Inspection", + "name": "Monthly Quality Inspection", + "filters_json": json.dumps( + [ + ["Quality Inspection", "docstatus", "=", 1], + ["Quality Inspection", "creation", "between", [start_date, end_date]], + ] + ), + "function": "Count", + "is_public": 1, + "label": _("Monthly Quality Inspections"), + "show_percentage_stats": 1, + "stats_time_interval": "Weekly", + }, + ] diff --git a/erpnext/manufacturing/doctype/blanket_order/blanket_order.py b/erpnext/manufacturing/doctype/blanket_order/blanket_order.py index 5340c51131f..ff2140199de 100644 --- a/erpnext/manufacturing/doctype/blanket_order/blanket_order.py +++ b/erpnext/manufacturing/doctype/blanket_order/blanket_order.py @@ -29,7 +29,9 @@ class BlanketOrder(Document): def update_ordered_qty(self): ref_doctype = "Sales Order" if self.blanket_order_type == "Selling" else "Purchase Order" - item_ordered_qty = frappe._dict(frappe.db.sql(""" + item_ordered_qty = frappe._dict( + frappe.db.sql( + """ select trans_item.item_code, sum(trans_item.stock_qty) as qty from `tab{0} Item` trans_item, `tab{0}` trans where trans.name = trans_item.parent @@ -37,18 +39,24 @@ class BlanketOrder(Document): and trans.docstatus=1 and trans.status not in ('Closed', 'Stopped') group by trans_item.item_code - """.format(ref_doctype), self.name)) + """.format( + ref_doctype + ), + self.name, + ) + ) for d in self.items: d.db_set("ordered_qty", item_ordered_qty.get(d.item_code, 0)) + @frappe.whitelist() def make_order(source_name): doctype = frappe.flags.args.doctype def update_doc(source_doc, target_doc, source_parent): - if doctype == 'Quotation': - target_doc.quotation_to = 'Customer' + if doctype == "Quotation": + target_doc.quotation_to = "Customer" target_doc.party_name = source_doc.customer def update_item(source, target, source_parent): @@ -62,18 +70,16 @@ def make_order(source_name): target.against_blanket_order = 1 target.blanket_order = source_name - target_doc = get_mapped_doc("Blanket Order", source_name, { - "Blanket Order": { - "doctype": doctype, - "postprocess": update_doc - }, - "Blanket Order Item": { - "doctype": doctype + " Item", - "field_map": { - "rate": "blanket_order_rate", - "parent": "blanket_order" + target_doc = get_mapped_doc( + "Blanket Order", + source_name, + { + "Blanket Order": {"doctype": doctype, "postprocess": update_doc}, + "Blanket Order Item": { + "doctype": doctype + " Item", + "field_map": {"rate": "blanket_order_rate", "parent": "blanket_order"}, + "postprocess": update_item, }, - "postprocess": update_item - } - }) + }, + ) return target_doc diff --git a/erpnext/manufacturing/doctype/blanket_order/blanket_order_dashboard.py b/erpnext/manufacturing/doctype/blanket_order/blanket_order_dashboard.py index 2556f2f163d..31062342d03 100644 --- a/erpnext/manufacturing/doctype/blanket_order/blanket_order_dashboard.py +++ b/erpnext/manufacturing/doctype/blanket_order/blanket_order_dashboard.py @@ -1,11 +1,5 @@ - - def get_data(): return { - 'fieldname': 'blanket_order', - 'transactions': [ - { - 'items': ['Purchase Order', 'Sales Order', 'Quotation'] - } - ] + "fieldname": "blanket_order", + "transactions": [{"items": ["Purchase Order", "Sales Order", "Quotation"]}], } diff --git a/erpnext/manufacturing/doctype/blanket_order/test_blanket_order.py b/erpnext/manufacturing/doctype/blanket_order/test_blanket_order.py index d5db3fc1ccf..2f1f3ae0f52 100644 --- a/erpnext/manufacturing/doctype/blanket_order/test_blanket_order.py +++ b/erpnext/manufacturing/doctype/blanket_order/test_blanket_order.py @@ -1,9 +1,7 @@ # Copyright (c) 2018, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt - -import unittest - import frappe +from frappe.tests.utils import FrappeTestCase from frappe.utils import add_months, today from erpnext import get_company_currency @@ -11,14 +9,14 @@ from erpnext import get_company_currency from .blanket_order import make_order -class TestBlanketOrder(unittest.TestCase): +class TestBlanketOrder(FrappeTestCase): def setUp(self): frappe.flags.args = frappe._dict() def test_sales_order_creation(self): bo = make_blanket_order(blanket_order_type="Selling") - frappe.flags.args.doctype = 'Sales Order' + frappe.flags.args.doctype = "Sales Order" so = make_order(bo.name) so.currency = get_company_currency(so.company) so.delivery_date = today() @@ -35,16 +33,15 @@ class TestBlanketOrder(unittest.TestCase): self.assertEqual(so.items[0].qty, bo.items[0].ordered_qty) # test the quantity - frappe.flags.args.doctype = 'Sales Order' + frappe.flags.args.doctype = "Sales Order" so1 = make_order(bo.name) so1.currency = get_company_currency(so1.company) - self.assertEqual(so1.items[0].qty, (bo.items[0].qty-bo.items[0].ordered_qty)) - + self.assertEqual(so1.items[0].qty, (bo.items[0].qty - bo.items[0].ordered_qty)) def test_purchase_order_creation(self): bo = make_blanket_order(blanket_order_type="Purchasing") - frappe.flags.args.doctype = 'Purchase Order' + frappe.flags.args.doctype = "Purchase Order" po = make_order(bo.name) po.currency = get_company_currency(po.company) po.schedule_date = today() @@ -61,11 +58,10 @@ class TestBlanketOrder(unittest.TestCase): self.assertEqual(po.items[0].qty, bo.items[0].ordered_qty) # test the quantity - frappe.flags.args.doctype = 'Purchase Order' + frappe.flags.args.doctype = "Purchase Order" po1 = make_order(bo.name) po1.currency = get_company_currency(po1.company) - self.assertEqual(po1.items[0].qty, (bo.items[0].qty-bo.items[0].ordered_qty)) - + self.assertEqual(po1.items[0].qty, (bo.items[0].qty - bo.items[0].ordered_qty)) def make_blanket_order(**args): @@ -82,11 +78,14 @@ def make_blanket_order(**args): bo.from_date = today() bo.to_date = add_months(bo.from_date, months=12) - bo.append("items", { - "item_code": args.item_code or "_Test Item", - "qty": args.quantity or 1000, - "rate": args.rate or 100 - }) + bo.append( + "items", + { + "item_code": args.item_code or "_Test Item", + "qty": args.quantity or 1000, + "rate": args.rate or 100, + }, + ) bo.insert() bo.submit() diff --git a/erpnext/manufacturing/doctype/bom/bom.js b/erpnext/manufacturing/doctype/bom/bom.js index 34d6d012418..ae0b26222ee 100644 --- a/erpnext/manufacturing/doctype/bom/bom.js +++ b/erpnext/manufacturing/doctype/bom/bom.js @@ -81,7 +81,7 @@ frappe.ui.form.on("BOM", { } ) - if (!frm.doc.__islocal && frm.doc.docstatus<2) { + if (!frm.is_new() && frm.doc.docstatus<2) { frm.add_custom_button(__("Update Cost"), function() { frm.events.update_cost(frm, true); }); @@ -93,7 +93,14 @@ frappe.ui.form.on("BOM", { }); } - if(frm.doc.docstatus!=0) { + if (!frm.is_new() && !frm.doc.docstatus == 0) { + frm.add_custom_button(__("New Version"), function() { + let new_bom = frappe.model.copy_doc(frm.doc); + frappe.set_route("Form", "BOM", new_bom.name); + }); + } + + if(frm.doc.docstatus==1) { frm.add_custom_button(__("Work Order"), function() { frm.trigger("make_work_order"); }, __("Create")); @@ -331,7 +338,7 @@ frappe.ui.form.on("BOM", { }); }); - if (has_template_rm) { + if (has_template_rm && has_template_rm.length) { dialog.fields_dict.items.grid.refresh(); } }, @@ -467,7 +474,8 @@ var get_bom_material_detail = function(doc, cdt, cdn, scrap_items) { "uom": d.uom, "stock_uom": d.stock_uom, "conversion_factor": d.conversion_factor, - "sourced_by_supplier": d.sourced_by_supplier + "sourced_by_supplier": d.sourced_by_supplier, + "do_not_explode": d.do_not_explode }, callback: function(r) { d = locals[cdt][cdn]; @@ -640,6 +648,13 @@ frappe.ui.form.on("BOM Operation", "workstation", function(frm, cdt, cdn) { }); }); +frappe.ui.form.on("BOM Item", { + do_not_explode: function(frm, cdt, cdn) { + get_bom_material_detail(frm.doc, cdt, cdn, false); + } +}) + + frappe.ui.form.on("BOM Item", "qty", function(frm, cdt, cdn) { var d = locals[cdt][cdn]; d.stock_qty = d.qty * d.conversion_factor; diff --git a/erpnext/manufacturing/doctype/bom/bom.json b/erpnext/manufacturing/doctype/bom/bom.json index 218ac64d8da..0b441969400 100644 --- a/erpnext/manufacturing/doctype/bom/bom.json +++ b/erpnext/manufacturing/doctype/bom/bom.json @@ -37,7 +37,6 @@ "inspection_required", "quality_inspection_template", "column_break_31", - "bom_level", "section_break_33", "items", "scrap_section", @@ -522,13 +521,6 @@ "fieldname": "column_break_31", "fieldtype": "Column Break" }, - { - "default": "0", - "fieldname": "bom_level", - "fieldtype": "Int", - "label": "BOM Level", - "read_only": 1 - }, { "fieldname": "section_break_33", "fieldtype": "Section Break", @@ -540,7 +532,7 @@ "image_field": "image", "is_submittable": 1, "links": [], - "modified": "2021-11-18 13:04:16.271975", + "modified": "2022-01-30 21:27:54.727298", "modified_by": "Administrator", "module": "Manufacturing", "name": "BOM", @@ -577,5 +569,6 @@ "show_name_in_global_search": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/bom/bom.py b/erpnext/manufacturing/doctype/bom/bom.py index 0ac64c2cfca..4cf29866326 100644 --- a/erpnext/manufacturing/doctype/bom/bom.py +++ b/erpnext/manufacturing/doctype/bom/bom.py @@ -1,10 +1,11 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt import functools +import re from collections import deque from operator import itemgetter -from typing import List +from typing import Dict, List import frappe from frappe import _ @@ -18,9 +19,11 @@ from erpnext.setup.utils import get_exchange_rate from erpnext.stock.doctype.item.item import get_item_details from erpnext.stock.get_item_details import get_conversion_factor, get_price_list_rate -form_grid_templates = { - "items": "templates/form_grid/item_grid.html" -} +form_grid_templates = {"items": "templates/form_grid/item_grid.html"} + + +class BOMRecursionError(frappe.ValidationError): + pass class BOMTree: @@ -30,10 +33,12 @@ class BOMTree: # ref: https://docs.python.org/3/reference/datamodel.html#slots __slots__ = ["name", "child_items", "is_bom", "item_code", "exploded_qty", "qty"] - def __init__(self, name: str, is_bom: bool = True, exploded_qty: float = 1.0, qty: float = 1) -> None: + def __init__( + self, name: str, is_bom: bool = True, exploded_qty: float = 1.0, qty: float = 1 + ) -> None: self.name = name # name of node, BOM number if is_bom else item_code self.child_items: List["BOMTree"] = [] # list of child items - self.is_bom = is_bom # true if the node is a BOM and not a leaf item + self.is_bom = is_bom # true if the node is a BOM and not a leaf item self.item_code: str = None # item_code associated with node self.qty = qty # required unit quantity to make one unit of parent item. self.exploded_qty = exploded_qty # total exploded qty required for making root of tree. @@ -61,12 +66,12 @@ class BOMTree: """Get level order traversal of tree. E.g. for following tree the traversal will return list of nodes in order from top to bottom. BOM: - - SubAssy1 - - item1 - - item2 - - SubAssy2 - - item3 - - item4 + - SubAssy1 + - item1 + - item2 + - SubAssy2 + - item3 + - item4 returns = [SubAssy1, item1, item2, SubAssy2, item3, item4] """ @@ -95,52 +100,84 @@ class BOMTree: rep += child.__repr__(level=level + 1) return rep + class BOM(WebsiteGenerator): website = frappe._dict( # page_title_field = "item_name", - condition_field = "show_in_website", - template = "templates/generators/bom.html" + condition_field="show_in_website", + template="templates/generators/bom.html", ) def autoname(self): - names = frappe.db.sql_list("""select name from `tabBOM` where item=%s""", self.item) + # ignore amended documents while calculating current index + existing_boms = frappe.get_all( + "BOM", filters={"item": self.item, "amended_from": ["is", "not set"]}, pluck="name" + ) - if names: - # name can be BOM/ITEM/001, BOM/ITEM/001-1, BOM-ITEM-001, BOM-ITEM-001-1 - - # split by item - names = [name.split(self.item, 1) for name in names] - names = [d[-1][1:] for d in filter(lambda x: len(x) > 1 and x[-1], names)] - - # split by (-) if cancelled - if names: - names = [cint(name.split('-')[-1]) for name in names] - idx = max(names) + 1 - else: - idx = 1 + if existing_boms: + index = self.get_next_version_index(existing_boms) else: - idx = 1 + index = 1 + + prefix = self.doctype + suffix = "%.3i" % index # convert index to string (1 -> "001") + bom_name = f"{prefix}-{self.item}-{suffix}" + + if len(bom_name) <= 140: + name = bom_name + else: + # since max characters for name is 140, remove enough characters from the + # item name to fit the prefix, suffix and the separators + truncated_length = 140 - (len(prefix) + len(suffix) + 2) + truncated_item_name = self.item[:truncated_length] + # if a partial word is found after truncate, remove the extra characters + truncated_item_name = truncated_item_name.rsplit(" ", 1)[0] + name = f"{prefix}-{truncated_item_name}-{suffix}" - name = 'BOM-' + self.item + ('-%.3i' % idx) if frappe.db.exists("BOM", name): conflicting_bom = frappe.get_doc("BOM", name) if conflicting_bom.item != self.item: - msg = (_("A BOM with name {0} already exists for item {1}.") - .format(frappe.bold(name), frappe.bold(conflicting_bom.item))) + msg = _("A BOM with name {0} already exists for item {1}.").format( + frappe.bold(name), frappe.bold(conflicting_bom.item) + ) - frappe.throw(_("{0}{1} Did you rename the item? Please contact Administrator / Tech support") - .format(msg, "
")) + frappe.throw( + _("{0}{1} Did you rename the item? Please contact Administrator / Tech support").format( + msg, "
" + ) + ) self.name = name + @staticmethod + def get_next_version_index(existing_boms: List[str]) -> int: + # split by "/" and "-" + delimiters = ["/", "-"] + pattern = "|".join(map(re.escape, delimiters)) + bom_parts = [re.split(pattern, bom_name) for bom_name in existing_boms] + + # filter out BOMs that do not follow the following formats: BOM/ITEM/001, BOM-ITEM-001 + valid_bom_parts = list(filter(lambda x: len(x) > 1 and x[-1], bom_parts)) + + # extract the current index from the BOM parts + if valid_bom_parts: + # handle cancelled and submitted documents + indexes = [cint(part[-1]) for part in valid_bom_parts] + index = max(indexes) + 1 + else: + index = 1 + + return index + def validate(self): - self.route = frappe.scrub(self.name).replace('_', '-') + self.route = frappe.scrub(self.name).replace("_", "-") if not self.company: frappe.throw(_("Please select a Company first."), title=_("Mandatory")) self.clear_operations() + self.clear_inspection() self.validate_main_item() self.validate_currency() self.set_conversion_rate() @@ -149,20 +186,20 @@ class BOM(WebsiteGenerator): self.set_bom_material_details() self.set_bom_scrap_items_detail() self.validate_materials() + self.validate_transfer_against() self.set_routing_operations() self.validate_operations() self.calculate_cost() + self.update_exploded_items(save=False) self.update_stock_qty() self.validate_scrap_items() - self.update_cost(update_parent=False, from_child_bom=True, update_hour_rate = False, save=False) - self.set_bom_level() - + self.update_cost(update_parent=False, from_child_bom=True, update_hour_rate=False, save=False) def get_context(self, context): - context.parents = [{'name': 'boms', 'title': _('All BOMs') }] + context.parents = [{"name": "boms", "title": _("All BOMs")}] def on_update(self): - frappe.cache().hdel('bom_children', self.name) + frappe.cache().hdel("bom_children", self.name) self.check_recursion() def on_submit(self): @@ -192,31 +229,52 @@ class BOM(WebsiteGenerator): def get_routing(self): if self.routing: self.set("operations", []) - fields = ["sequence_id", "operation", "workstation", "description", - "time_in_mins", "batch_size", "operating_cost", "idx", "hour_rate"] + fields = [ + "sequence_id", + "operation", + "workstation", + "description", + "time_in_mins", + "batch_size", + "operating_cost", + "idx", + "hour_rate", + "set_cost_based_on_bom_qty", + ] - for row in frappe.get_all("BOM Operation", fields = fields, - filters = {'parenttype': 'Routing', 'parent': self.routing}, order_by="sequence_id, idx"): - child = self.append('operations', row) - child.hour_rate = flt(row.hour_rate / self.conversion_rate, 2) + for row in frappe.get_all( + "BOM Operation", + fields=fields, + filters={"parenttype": "Routing", "parent": self.routing}, + order_by="sequence_id, idx", + ): + child = self.append("operations", row) + child.hour_rate = flt(row.hour_rate / self.conversion_rate, child.precision("hour_rate")) def set_bom_material_details(self): for item in self.get("items"): self.validate_bom_currency(item) - ret = self.get_bom_material_detail({ - "company": self.company, - "item_code": item.item_code, - "item_name": item.item_name, - "bom_no": item.bom_no, - "stock_qty": item.stock_qty, - "include_item_in_manufacturing": item.include_item_in_manufacturing, - "qty": item.qty, - "uom": item.uom, - "stock_uom": item.stock_uom, - "conversion_factor": item.conversion_factor, - "sourced_by_supplier": item.sourced_by_supplier - }) + if item.do_not_explode: + item.bom_no = "" + + ret = self.get_bom_material_detail( + { + "company": self.company, + "item_code": item.item_code, + "item_name": item.item_name, + "bom_no": item.bom_no, + "stock_qty": item.stock_qty, + "include_item_in_manufacturing": item.include_item_in_manufacturing, + "qty": item.qty, + "uom": item.uom, + "stock_uom": item.stock_uom, + "conversion_factor": item.conversion_factor, + "sourced_by_supplier": item.sourced_by_supplier, + "do_not_explode": item.do_not_explode, + } + ) + for r in ret: if not item.get(r): item.set(r, ret[r]) @@ -227,7 +285,7 @@ class BOM(WebsiteGenerator): "item_code": item.item_code, "company": self.company, "scrap_items": True, - "bom_no": '', + "bom_no": "", } ret = self.get_bom_material_detail(args) for key, value in ret.items(): @@ -236,113 +294,113 @@ class BOM(WebsiteGenerator): @frappe.whitelist() def get_bom_material_detail(self, args=None): - """ Get raw material details like uom, desc and rate""" + """Get raw material details like uom, desc and rate""" if not args: - args = frappe.form_dict.get('args') + args = frappe.form_dict.get("args") if isinstance(args, str): import json + args = json.loads(args) - item = self.get_item_det(args['item_code']) + item = self.get_item_det(args["item_code"]) - args['bom_no'] = args['bom_no'] or item and cstr(item['default_bom']) or '' - args['transfer_for_manufacture'] = (cstr(args.get('include_item_in_manufacturing', '')) or - item and item.include_item_in_manufacturing or 0) + args["bom_no"] = args["bom_no"] or item and cstr(item["default_bom"]) or "" + args["transfer_for_manufacture"] = ( + cstr(args.get("include_item_in_manufacturing", "")) + or item + and item.include_item_in_manufacturing + or 0 + ) args.update(item) rate = self.get_rm_rate(args) ret_item = { - 'item_name' : item and args['item_name'] or '', - 'description' : item and args['description'] or '', - 'image' : item and args['image'] or '', - 'stock_uom' : item and args['stock_uom'] or '', - 'uom' : item and args['stock_uom'] or '', - 'conversion_factor': 1, - 'bom_no' : args['bom_no'], - 'rate' : rate, - 'qty' : args.get("qty") or args.get("stock_qty") or 1, - 'stock_qty' : args.get("qty") or args.get("stock_qty") or 1, - 'base_rate' : flt(rate) * (flt(self.conversion_rate) or 1), - 'include_item_in_manufacturing': cint(args.get('transfer_for_manufacture')), - 'sourced_by_supplier' : args.get('sourced_by_supplier', 0) + "item_name": item and args["item_name"] or "", + "description": item and args["description"] or "", + "image": item and args["image"] or "", + "stock_uom": item and args["stock_uom"] or "", + "uom": item and args["stock_uom"] or "", + "conversion_factor": 1, + "bom_no": args["bom_no"], + "rate": rate, + "qty": args.get("qty") or args.get("stock_qty") or 1, + "stock_qty": args.get("qty") or args.get("stock_qty") or 1, + "base_rate": flt(rate) * (flt(self.conversion_rate) or 1), + "include_item_in_manufacturing": cint(args.get("transfer_for_manufacture")), + "sourced_by_supplier": args.get("sourced_by_supplier", 0), } + if args.get("do_not_explode"): + ret_item["bom_no"] = "" + return ret_item def validate_bom_currency(self, item): - if item.get('bom_no') and frappe.db.get_value('BOM', item.get('bom_no'), 'currency') != self.currency: - frappe.throw(_("Row {0}: Currency of the BOM #{1} should be equal to the selected currency {2}") - .format(item.idx, item.bom_no, self.currency)) + if ( + item.get("bom_no") + and frappe.db.get_value("BOM", item.get("bom_no"), "currency") != self.currency + ): + frappe.throw( + _("Row {0}: Currency of the BOM #{1} should be equal to the selected currency {2}").format( + item.idx, item.bom_no, self.currency + ) + ) def get_rm_rate(self, arg): - """ Get raw material rate as per selected method, if bom exists takes bom cost """ + """Get raw material rate as per selected method, if bom exists takes bom cost""" rate = 0 if not self.rm_cost_as_per: self.rm_cost_as_per = "Valuation Rate" - if arg.get('scrap_items'): + if arg.get("scrap_items"): rate = get_valuation_rate(arg) elif arg: - #Customer Provided parts and Supplier sourced parts will have zero rate - if not frappe.db.get_value('Item', arg["item_code"], 'is_customer_provided_item') and not arg.get('sourced_by_supplier'): - if arg.get('bom_no') and self.set_rate_of_sub_assembly_item_based_on_bom: - rate = flt(self.get_bom_unitcost(arg['bom_no'])) * (arg.get("conversion_factor") or 1) + # Customer Provided parts and Supplier sourced parts will have zero rate + if not frappe.db.get_value( + "Item", arg["item_code"], "is_customer_provided_item" + ) and not arg.get("sourced_by_supplier"): + if arg.get("bom_no") and self.set_rate_of_sub_assembly_item_based_on_bom: + rate = flt(self.get_bom_unitcost(arg["bom_no"])) * (arg.get("conversion_factor") or 1) else: rate = get_bom_item_rate(arg, self) if not rate: if self.rm_cost_as_per == "Price List": - frappe.msgprint(_("Price not found for item {0} in price list {1}") - .format(arg["item_code"], self.buying_price_list), alert=True) + frappe.msgprint( + _("Price not found for item {0} in price list {1}").format( + arg["item_code"], self.buying_price_list + ), + alert=True, + ) else: - frappe.msgprint(_("{0} not found for item {1}") - .format(self.rm_cost_as_per, arg["item_code"]), alert=True) + frappe.msgprint( + _("{0} not found for item {1}").format(self.rm_cost_as_per, arg["item_code"]), alert=True + ) return flt(rate) * flt(self.plc_conversion_rate or 1) / (self.conversion_rate or 1) @frappe.whitelist() - def update_cost(self, update_parent=True, from_child_bom=False, update_hour_rate = True, save=True): + def update_cost(self, update_parent=True, from_child_bom=False, update_hour_rate=True, save=True): if self.docstatus == 2: return existing_bom_cost = self.total_cost - for d in self.get("items"): - if not d.item_code: - continue - - rate = self.get_rm_rate({ - "company": self.company, - "item_code": d.item_code, - "bom_no": d.bom_no, - "qty": d.qty, - "uom": d.uom, - "stock_uom": d.stock_uom, - "conversion_factor": d.conversion_factor, - "sourced_by_supplier": d.sourced_by_supplier - }) - - if rate: - d.rate = rate - d.amount = flt(d.rate) * flt(d.qty) - d.base_rate = flt(d.rate) * flt(self.conversion_rate) - d.base_amount = flt(d.amount) * flt(self.conversion_rate) - - if save: - d.db_update() - if self.docstatus == 1: self.flags.ignore_validate_update_after_submit = True - self.calculate_cost(update_hour_rate) + + self.calculate_cost(save_updates=save, update_hour_rate=update_hour_rate) + if save: self.db_update() - self.update_exploded_items(save=save) - # update parent BOMs if self.total_cost != existing_bom_cost and update_parent: - parent_boms = frappe.db.sql_list("""select distinct parent from `tabBOM Item` - where bom_no = %s and docstatus=1 and parenttype='BOM'""", self.name) + parent_boms = frappe.db.sql_list( + """select distinct parent from `tabBOM Item` + where bom_no = %s and docstatus=1 and parenttype='BOM'""", + self.name, + ) for bom in parent_boms: frappe.get_doc("BOM", bom).update_cost(from_child_bom=True) @@ -354,41 +412,55 @@ class BOM(WebsiteGenerator): if self.total_cost: cost = self.total_cost / self.quantity - frappe.db.sql("""update `tabBOM Item` set rate=%s, amount=stock_qty*%s + frappe.db.sql( + """update `tabBOM Item` set rate=%s, amount=stock_qty*%s where bom_no = %s and docstatus < 2 and parenttype='BOM'""", - (cost, cost, self.name)) + (cost, cost, self.name), + ) def get_bom_unitcost(self, bom_no): - bom = frappe.db.sql("""select name, base_total_cost/quantity as unit_cost from `tabBOM` - where is_active = 1 and name = %s""", bom_no, as_dict=1) - return bom and bom[0]['unit_cost'] or 0 + bom = frappe.db.sql( + """select name, base_total_cost/quantity as unit_cost from `tabBOM` + where is_active = 1 and name = %s""", + bom_no, + as_dict=1, + ) + return bom and bom[0]["unit_cost"] or 0 def manage_default_bom(self): - """ Uncheck others if current one is selected as default or - check the current one as default if it the only bom for the selected item, - update default bom in item master + """Uncheck others if current one is selected as default or + check the current one as default if it the only bom for the selected item, + update default bom in item master """ if self.is_default and self.is_active: from frappe.model.utils import set_default + set_default(self, "item") item = frappe.get_doc("Item", self.item) if item.default_bom != self.name: - frappe.db.set_value('Item', self.item, 'default_bom', self.name) - elif not frappe.db.exists(dict(doctype='BOM', docstatus=1, item=self.item, is_default=1)) \ - and self.is_active: + frappe.db.set_value("Item", self.item, "default_bom", self.name) + elif ( + not frappe.db.exists(dict(doctype="BOM", docstatus=1, item=self.item, is_default=1)) + and self.is_active + ): frappe.db.set(self, "is_default", 1) + frappe.db.set_value("Item", self.item, "default_bom", self.name) else: frappe.db.set(self, "is_default", 0) item = frappe.get_doc("Item", self.item) if item.default_bom == self.name: - frappe.db.set_value('Item', self.item, 'default_bom', None) + frappe.db.set_value("Item", self.item, "default_bom", None) def clear_operations(self): if not self.with_operations: - self.set('operations', []) + self.set("operations", []) + + def clear_inspection(self): + if not self.inspection_required: + self.quality_inspection_template = None def validate_main_item(self): - """ Validate main FG item""" + """Validate main FG item""" item = self.get_item_det(self.item) if not item: frappe.throw(_("Item {0} does not exist in the system or has expired").format(self.item)) @@ -396,30 +468,34 @@ class BOM(WebsiteGenerator): ret = frappe.db.get_value("Item", self.item, ["description", "stock_uom", "item_name"]) self.description = ret[0] self.uom = ret[1] - self.item_name= ret[2] + self.item_name = ret[2] if not self.quantity: frappe.throw(_("Quantity should be greater than 0")) def validate_currency(self): - if self.rm_cost_as_per == 'Price List': - price_list_currency = frappe.db.get_value('Price List', self.buying_price_list, 'currency') + if self.rm_cost_as_per == "Price List": + price_list_currency = frappe.db.get_value("Price List", self.buying_price_list, "currency") if price_list_currency not in (self.currency, self.company_currency()): - frappe.throw(_("Currency of the price list {0} must be {1} or {2}") - .format(self.buying_price_list, self.currency, self.company_currency())) + frappe.throw( + _("Currency of the price list {0} must be {1} or {2}").format( + self.buying_price_list, self.currency, self.company_currency() + ) + ) def update_stock_qty(self): - for m in self.get('items'): + for m in self.get("items"): if not m.conversion_factor: - m.conversion_factor = flt(get_conversion_factor(m.item_code, m.uom)['conversion_factor']) + m.conversion_factor = flt(get_conversion_factor(m.item_code, m.uom)["conversion_factor"]) if m.uom and m.qty: - m.stock_qty = flt(m.conversion_factor)*flt(m.qty) + m.stock_qty = flt(m.conversion_factor) * flt(m.qty) if not m.uom and m.stock_uom: m.uom = m.stock_uom m.qty = m.stock_qty def validate_uom_is_interger(self): from erpnext.utilities.transaction_base import validate_uom_is_integer + validate_uom_is_integer(self, "uom", "qty", "BOM Item") validate_uom_is_integer(self, "stock_uom", "stock_qty", "BOM Item") @@ -427,23 +503,26 @@ class BOM(WebsiteGenerator): if self.currency == self.company_currency(): self.conversion_rate = 1 elif self.conversion_rate == 1 or flt(self.conversion_rate) <= 0: - self.conversion_rate = get_exchange_rate(self.currency, self.company_currency(), args="for_buying") + self.conversion_rate = get_exchange_rate( + self.currency, self.company_currency(), args="for_buying" + ) def set_plc_conversion_rate(self): if self.rm_cost_as_per in ["Valuation Rate", "Last Purchase Rate"]: self.plc_conversion_rate = 1 elif not self.plc_conversion_rate and self.price_list_currency: - self.plc_conversion_rate = get_exchange_rate(self.price_list_currency, - self.company_currency(), args="for_buying") + self.plc_conversion_rate = get_exchange_rate( + self.price_list_currency, self.company_currency(), args="for_buying" + ) def validate_materials(self): - """ Validate raw material entries """ + """Validate raw material entries""" - if not self.get('items'): + if not self.get("items"): frappe.throw(_("Raw Materials cannot be blank.")) check_list = [] - for m in self.get('items'): + for m in self.get("items"): if m.bom_no: validate_bom_no(m.item_code, m.bom_no) if flt(m.qty) <= 0: @@ -451,36 +530,42 @@ class BOM(WebsiteGenerator): check_list.append(m) def check_recursion(self, bom_list=None): - """ Check whether recursion occurs in any bom""" + """Check whether recursion occurs in any bom""" + def _throw_error(bom_name): - frappe.throw(_("BOM recursion: {0} cannot be parent or child of {0}").format(bom_name)) + frappe.throw( + _("BOM recursion: {1} cannot be parent or child of {0}").format(self.name, bom_name), + exc=BOMRecursionError, + ) bom_list = self.traverse_tree() - child_items = frappe.get_all('BOM Item', fields=["bom_no", "item_code"], - filters={'parent': ('in', bom_list), 'parenttype': 'BOM'}) or [] + child_items = frappe.get_all( + "BOM Item", + fields=["bom_no", "item_code"], + filters={"parent": ("in", bom_list), "parenttype": "BOM"}, + ) - child_bom = {d.bom_no for d in child_items} - child_items_codes = {d.item_code for d in child_items} + for item in child_items: + if self.name == item.bom_no: + _throw_error(self.name) + if self.item == item.item_code and item.bom_no: + # Same item but with different BOM should not be allowed. + # Same item can appear recursively once as long as it doesn't have BOM. + _throw_error(item.bom_no) - if self.name in child_bom: - _throw_error(self.name) - - if self.item in child_items_codes: - _throw_error(self.item) - - bom_nos = frappe.get_all('BOM Item', fields=["parent"], - filters={'bom_no': self.name, 'parenttype': 'BOM'}) or [] - - if self.name in {d.parent for d in bom_nos}: + if self.name in {d.bom_no for d in self.items}: _throw_error(self.name) def traverse_tree(self, bom_list=None): def _get_children(bom_no): - children = frappe.cache().hget('bom_children', bom_no) + children = frappe.cache().hget("bom_children", bom_no) if children is None: - children = frappe.db.sql_list("""SELECT `bom_no` FROM `tabBOM Item` - WHERE `parent`=%s AND `bom_no`!='' AND `parenttype`='BOM'""", bom_no) - frappe.cache().hset('bom_children', bom_no, children) + children = frappe.db.sql_list( + """SELECT `bom_no` FROM `tabBOM Item` + WHERE `parent`=%s AND `bom_no`!='' AND `parenttype`='BOM'""", + bom_no, + ) + frappe.cache().hset("bom_children", bom_no, children) return children count = 0 @@ -490,7 +575,7 @@ class BOM(WebsiteGenerator): if self.name not in bom_list: bom_list.append(self.name) - while(count < len(bom_list)): + while count < len(bom_list): for child_bom in _get_children(bom_list[count]): if child_bom not in bom_list: bom_list.append(child_bom) @@ -498,19 +583,25 @@ class BOM(WebsiteGenerator): bom_list.reverse() return bom_list - def calculate_cost(self, update_hour_rate = False): + def calculate_cost(self, save_updates=False, update_hour_rate=False): """Calculate bom totals""" self.calculate_op_cost(update_hour_rate) - self.calculate_rm_cost() - self.calculate_sm_cost() - self.total_cost = self.operating_cost + self.raw_material_cost - self.scrap_material_cost - self.base_total_cost = self.base_operating_cost + self.base_raw_material_cost - self.base_scrap_material_cost + self.calculate_rm_cost(save=save_updates) + self.calculate_sm_cost(save=save_updates) + if save_updates: + # not via doc event, table is not regenerated and needs updation + self.calculate_exploded_cost() - def calculate_op_cost(self, update_hour_rate = False): + self.total_cost = self.operating_cost + self.raw_material_cost - self.scrap_material_cost + self.base_total_cost = ( + self.base_operating_cost + self.base_raw_material_cost - self.base_scrap_material_cost + ) + + def calculate_op_cost(self, update_hour_rate=False): """Update workstation rate and calculates totals""" self.operating_cost = 0 self.base_operating_cost = 0 - for d in self.get('operations'): + for d in self.get("operations"): if d.workstation: self.update_rate_and_time(d, update_hour_rate) @@ -523,23 +614,14 @@ class BOM(WebsiteGenerator): self.operating_cost += flt(operating_cost) self.base_operating_cost += flt(base_operating_cost) - def update_rate_and_time(self, row, update_hour_rate = False): + def update_rate_and_time(self, row, update_hour_rate=False): if not row.hour_rate or update_hour_rate: hour_rate = flt(frappe.get_cached_value("Workstation", row.workstation, "hour_rate")) if hour_rate: - row.hour_rate = (hour_rate / flt(self.conversion_rate) - if self.conversion_rate and hour_rate else hour_rate) - - if self.routing: - time_in_mins = flt(frappe.db.get_value("BOM Operation", { - "workstation": row.workstation, - "operation": row.operation, - "parent": self.routing - }, ["time_in_mins"])) - - if time_in_mins: - row.time_in_mins = time_in_mins + row.hour_rate = ( + hour_rate / flt(self.conversion_rate) if self.conversion_rate and hour_rate else hour_rate + ) if row.hour_rate and row.time_in_mins: row.base_hour_rate = flt(row.hour_rate) * flt(self.conversion_rate) @@ -551,72 +633,124 @@ class BOM(WebsiteGenerator): if update_hour_rate: row.db_update() - def calculate_rm_cost(self): + def calculate_rm_cost(self, save=False): """Fetch RM rate as per today's valuation rate and calculate totals""" total_rm_cost = 0 base_total_rm_cost = 0 - for d in self.get('items'): + for d in self.get("items"): + old_rate = d.rate + d.rate = self.get_rm_rate( + { + "company": self.company, + "item_code": d.item_code, + "bom_no": d.bom_no, + "qty": d.qty, + "uom": d.uom, + "stock_uom": d.stock_uom, + "conversion_factor": d.conversion_factor, + "sourced_by_supplier": d.sourced_by_supplier, + } + ) + d.base_rate = flt(d.rate) * flt(self.conversion_rate) d.amount = flt(d.rate, d.precision("rate")) * flt(d.qty, d.precision("qty")) d.base_amount = d.amount * flt(self.conversion_rate) - d.qty_consumed_per_unit = flt(d.stock_qty, d.precision("stock_qty")) \ - / flt(self.quantity, self.precision("quantity")) + d.qty_consumed_per_unit = flt(d.stock_qty, d.precision("stock_qty")) / flt( + self.quantity, self.precision("quantity") + ) total_rm_cost += d.amount base_total_rm_cost += d.base_amount + if save and (old_rate != d.rate): + d.db_update() self.raw_material_cost = total_rm_cost self.base_raw_material_cost = base_total_rm_cost - def calculate_sm_cost(self): + def calculate_sm_cost(self, save=False): """Fetch RM rate as per today's valuation rate and calculate totals""" total_sm_cost = 0 base_total_sm_cost = 0 - for d in self.get('scrap_items'): - d.base_rate = flt(d.rate, d.precision("rate")) * flt(self.conversion_rate, self.precision("conversion_rate")) + for d in self.get("scrap_items"): + d.base_rate = flt(d.rate, d.precision("rate")) * flt( + self.conversion_rate, self.precision("conversion_rate") + ) d.amount = flt(d.rate, d.precision("rate")) * flt(d.stock_qty, d.precision("stock_qty")) - d.base_amount = flt(d.amount, d.precision("amount")) * flt(self.conversion_rate, self.precision("conversion_rate")) + d.base_amount = flt(d.amount, d.precision("amount")) * flt( + self.conversion_rate, self.precision("conversion_rate") + ) total_sm_cost += d.amount base_total_sm_cost += d.base_amount + if save: + d.db_update() self.scrap_material_cost = total_sm_cost self.base_scrap_material_cost = base_total_sm_cost - def update_new_bom(self, old_bom, new_bom, rate): - for d in self.get("items"): - if d.bom_no != old_bom: continue + def calculate_exploded_cost(self): + "Set exploded row cost from it's parent BOM." + rm_rate_map = self.get_rm_rate_map() - d.bom_no = new_bom - d.rate = rate - d.amount = (d.stock_qty or d.qty) * rate + for row in self.get("exploded_items"): + old_rate = flt(row.rate) + row.rate = rm_rate_map.get(row.item_code) + row.amount = flt(row.stock_qty) * flt(row.rate) + + if old_rate != row.rate: + # Only db_update if changed + row.db_update() + + def get_rm_rate_map(self) -> Dict[str, float]: + "Create Raw Material-Rate map for Exploded Items. Fetch rate from Items table or Subassembly BOM." + rm_rate_map = {} + + for item in self.get("items"): + if item.bom_no: + # Get Item-Rate from Subassembly BOM + explosion_items = frappe.get_all( + "BOM Explosion Item", + filters={"parent": item.bom_no}, + fields=["item_code", "rate"], + order_by=None, # to avoid sort index creation at db level (granular change) + ) + explosion_item_rate = {item.item_code: flt(item.rate) for item in explosion_items} + rm_rate_map.update(explosion_item_rate) + else: + rm_rate_map[item.item_code] = flt(item.base_rate) / flt(item.conversion_factor or 1.0) + + return rm_rate_map def update_exploded_items(self, save=True): - """ Update Flat BOM, following will be correct data""" + """Update Flat BOM, following will be correct data""" self.get_exploded_items() self.add_exploded_items(save=save) def get_exploded_items(self): - """ Get all raw materials including items from child bom""" + """Get all raw materials including items from child bom""" self.cur_exploded_items = {} - for d in self.get('items'): + for d in self.get("items"): if d.bom_no: self.get_child_exploded_items(d.bom_no, d.stock_qty) elif d.item_code: - self.add_to_cur_exploded_items(frappe._dict({ - 'item_code' : d.item_code, - 'item_name' : d.item_name, - 'operation' : d.operation, - 'source_warehouse': d.source_warehouse, - 'description' : d.description, - 'image' : d.image, - 'stock_uom' : d.stock_uom, - 'stock_qty' : flt(d.stock_qty), - 'rate' : flt(d.base_rate) / (flt(d.conversion_factor) or 1.0), - 'include_item_in_manufacturing': d.include_item_in_manufacturing, - 'sourced_by_supplier': d.sourced_by_supplier - })) + self.add_to_cur_exploded_items( + frappe._dict( + { + "item_code": d.item_code, + "item_name": d.item_name, + "operation": d.operation, + "source_warehouse": d.source_warehouse, + "description": d.description, + "image": d.image, + "stock_uom": d.stock_uom, + "stock_qty": flt(d.stock_qty), + "rate": flt(d.base_rate) / (flt(d.conversion_factor) or 1.0), + "include_item_in_manufacturing": d.include_item_in_manufacturing, + "sourced_by_supplier": d.sourced_by_supplier, + } + ) + ) def company_currency(self): return erpnext.get_company_currency(self.company) @@ -628,9 +762,10 @@ class BOM(WebsiteGenerator): self.cur_exploded_items[args.item_code] = args def get_child_exploded_items(self, bom_no, stock_qty): - """ Add all items from Flat BOM of child BOM""" + """Add all items from Flat BOM of child BOM""" # Did not use qty_consumed_per_unit in the query, as it leads to rounding loss - child_fb_items = frappe.db.sql(""" + child_fb_items = frappe.db.sql( + """ SELECT bom_item.item_code, bom_item.item_name, @@ -648,31 +783,38 @@ class BOM(WebsiteGenerator): bom_item.parent = bom.name AND bom.name = %s AND bom.docstatus = 1 - """, bom_no, as_dict = 1) + """, + bom_no, + as_dict=1, + ) for d in child_fb_items: - self.add_to_cur_exploded_items(frappe._dict({ - 'item_code' : d['item_code'], - 'item_name' : d['item_name'], - 'source_warehouse' : d['source_warehouse'], - 'operation' : d['operation'], - 'description' : d['description'], - 'stock_uom' : d['stock_uom'], - 'stock_qty' : d['qty_consumed_per_unit'] * stock_qty, - 'rate' : flt(d['rate']), - 'include_item_in_manufacturing': d.get('include_item_in_manufacturing', 0), - 'sourced_by_supplier': d.get('sourced_by_supplier', 0) - })) + self.add_to_cur_exploded_items( + frappe._dict( + { + "item_code": d["item_code"], + "item_name": d["item_name"], + "source_warehouse": d["source_warehouse"], + "operation": d["operation"], + "description": d["description"], + "stock_uom": d["stock_uom"], + "stock_qty": d["qty_consumed_per_unit"] * stock_qty, + "rate": flt(d["rate"]), + "include_item_in_manufacturing": d.get("include_item_in_manufacturing", 0), + "sourced_by_supplier": d.get("sourced_by_supplier", 0), + } + ) + ) def add_exploded_items(self, save=True): "Add items to Flat BOM table" - self.set('exploded_items', []) + self.set("exploded_items", []) if save: frappe.db.sql("""delete from `tabBOM Explosion Item` where parent=%s""", self.name) for d in sorted(self.cur_exploded_items, key=itemgetter(0)): - ch = self.append('exploded_items', {}) + ch = self.append("exploded_items", {}) for i in self.cur_exploded_items[d].keys(): ch.set(i, self.cur_exploded_items[d][i]) ch.amount = flt(ch.stock_qty) * flt(ch.rate) @@ -684,52 +826,68 @@ class BOM(WebsiteGenerator): def validate_bom_links(self): if not self.is_active: - act_pbom = frappe.db.sql("""select distinct bom_item.parent from `tabBOM Item` bom_item + act_pbom = frappe.db.sql( + """select distinct bom_item.parent from `tabBOM Item` bom_item where bom_item.bom_no = %s and bom_item.docstatus = 1 and bom_item.parenttype='BOM' and exists (select * from `tabBOM` where name = bom_item.parent - and docstatus = 1 and is_active = 1)""", self.name) + and docstatus = 1 and is_active = 1)""", + self.name, + ) if act_pbom and act_pbom[0][0]: frappe.throw(_("Cannot deactivate or cancel BOM as it is linked with other BOMs")) + def validate_transfer_against(self): + if not self.with_operations: + self.transfer_material_against = "Work Order" + if not self.transfer_material_against and not self.is_new(): + frappe.throw( + _("Setting {} is required").format(self.meta.get_label("transfer_material_against")), + title=_("Missing value"), + ) + def set_routing_operations(self): if self.routing and self.with_operations and not self.operations: self.get_routing() def validate_operations(self): - if self.with_operations and not self.get('operations') and self.docstatus == 1: + if self.with_operations and not self.get("operations") and self.docstatus == 1: frappe.throw(_("Operations cannot be left blank")) if self.with_operations: for d in self.operations: if not d.description: - d.description = frappe.db.get_value('Operation', d.operation, 'description') + d.description = frappe.db.get_value("Operation", d.operation, "description") if not d.batch_size or d.batch_size <= 0: d.batch_size = 1 - def validate_scrap_items(self): for item in self.scrap_items: msg = "" if item.item_code == self.item and not item.is_process_loss: - msg = _('Scrap/Loss Item: {0} should have Is Process Loss checked as it is the same as the item to be manufactured or repacked.') \ - .format(frappe.bold(item.item_code)) + msg = _( + "Scrap/Loss Item: {0} should have Is Process Loss checked as it is the same as the item to be manufactured or repacked." + ).format(frappe.bold(item.item_code)) elif item.item_code != self.item and item.is_process_loss: - msg = _('Scrap/Loss Item: {0} should not have Is Process Loss checked as it is different from the item to be manufactured or repacked') \ - .format(frappe.bold(item.item_code)) + msg = _( + "Scrap/Loss Item: {0} should not have Is Process Loss checked as it is different from the item to be manufactured or repacked" + ).format(frappe.bold(item.item_code)) must_be_whole_number = frappe.get_value("UOM", item.stock_uom, "must_be_whole_number") if item.is_process_loss and must_be_whole_number: - msg = _("Item: {0} with Stock UOM: {1} cannot be a Scrap/Loss Item as {1} is a whole UOM.") \ - .format(frappe.bold(item.item_code), frappe.bold(item.stock_uom)) + msg = _( + "Item: {0} with Stock UOM: {1} cannot be a Scrap/Loss Item as {1} is a whole UOM." + ).format(frappe.bold(item.item_code), frappe.bold(item.stock_uom)) if item.is_process_loss and (item.stock_qty >= self.quantity): - msg = _("Scrap/Loss Item: {0} should have Qty less than finished goods Quantity.") \ - .format(frappe.bold(item.item_code)) + msg = _("Scrap/Loss Item: {0} should have Qty less than finished goods Quantity.").format( + frappe.bold(item.item_code) + ) if item.is_process_loss and (item.rate > 0): - msg = _("Scrap/Loss Item: {0} should have Rate set to 0 because Is Process Loss is checked.") \ - .format(frappe.bold(item.item_code)) + msg = _( + "Scrap/Loss Item: {0} should have Rate set to 0 because Is Process Loss is checked." + ).format(frappe.bold(item.item_code)) if msg: frappe.throw(msg, title=_("Note")) @@ -738,91 +896,100 @@ class BOM(WebsiteGenerator): """Get a complete tree representation preserving order of child items.""" return BOMTree(self.name) - def set_bom_level(self, update=False): - levels = [] - - self.bom_level = 0 - for row in self.items: - if row.bom_no: - levels.append(frappe.get_cached_value("BOM", row.bom_no, "bom_level") or 0) - - if levels: - self.bom_level = max(levels) + 1 - - if update: - self.db_set("bom_level", self.bom_level) def get_bom_item_rate(args, bom_doc): - if bom_doc.rm_cost_as_per == 'Valuation Rate': + if bom_doc.rm_cost_as_per == "Valuation Rate": rate = get_valuation_rate(args) * (args.get("conversion_factor") or 1) - elif bom_doc.rm_cost_as_per == 'Last Purchase Rate': - rate = ( flt(args.get('last_purchase_rate')) \ - or frappe.db.get_value("Item", args['item_code'], "last_purchase_rate")) \ - * (args.get("conversion_factor") or 1) + elif bom_doc.rm_cost_as_per == "Last Purchase Rate": + rate = ( + flt(args.get("last_purchase_rate")) + or flt(frappe.db.get_value("Item", args["item_code"], "last_purchase_rate")) + ) * (args.get("conversion_factor") or 1) elif bom_doc.rm_cost_as_per == "Price List": if not bom_doc.buying_price_list: frappe.throw(_("Please select Price List")) - bom_args = frappe._dict({ - "doctype": "BOM", - "price_list": bom_doc.buying_price_list, - "qty": args.get("qty") or 1, - "uom": args.get("uom") or args.get("stock_uom"), - "stock_uom": args.get("stock_uom"), - "transaction_type": "buying", - "company": bom_doc.company, - "currency": bom_doc.currency, - "conversion_rate": 1, # Passed conversion rate as 1 purposefully, as conversion rate is applied at the end of the function - "conversion_factor": args.get("conversion_factor") or 1, - "plc_conversion_rate": 1, - "ignore_party": True, - "ignore_conversion_rate": True - }) + bom_args = frappe._dict( + { + "doctype": "BOM", + "price_list": bom_doc.buying_price_list, + "qty": args.get("qty") or 1, + "uom": args.get("uom") or args.get("stock_uom"), + "stock_uom": args.get("stock_uom"), + "transaction_type": "buying", + "company": bom_doc.company, + "currency": bom_doc.currency, + "conversion_rate": 1, # Passed conversion rate as 1 purposefully, as conversion rate is applied at the end of the function + "conversion_factor": args.get("conversion_factor") or 1, + "plc_conversion_rate": 1, + "ignore_party": True, + "ignore_conversion_rate": True, + } + ) item_doc = frappe.get_cached_doc("Item", args.get("item_code")) price_list_data = get_price_list_rate(bom_args, item_doc) rate = price_list_data.price_list_rate - return rate + return flt(rate) -def get_valuation_rate(args): - """ Get weighted average of valuation rate from all warehouses """ - total_qty, total_value, valuation_rate = 0.0, 0.0, 0.0 - item_bins = frappe.db.sql(""" - select - bin.actual_qty, bin.stock_value - from - `tabBin` bin, `tabWarehouse` warehouse - where - bin.item_code=%(item)s - and bin.warehouse = warehouse.name - and warehouse.company=%(company)s""", - {"item": args['item_code'], "company": args['company']}, as_dict=1) +def get_valuation_rate(data): + """ + 1) Get average valuation rate from all warehouses + 2) If no value, get last valuation rate from SLE + 3) If no value, get valuation rate from Item + """ + from frappe.query_builder.functions import Sum - for d in item_bins: - total_qty += flt(d.actual_qty) - total_value += flt(d.stock_value) + item_code, company = data.get("item_code"), data.get("company") + valuation_rate = 0.0 - if total_qty: - valuation_rate = total_value / total_qty + bin_table = frappe.qb.DocType("Bin") + wh_table = frappe.qb.DocType("Warehouse") + item_valuation = ( + frappe.qb.from_(bin_table) + .join(wh_table) + .on(bin_table.warehouse == wh_table.name) + .select((Sum(bin_table.stock_value) / Sum(bin_table.actual_qty)).as_("valuation_rate")) + .where((bin_table.item_code == item_code) & (wh_table.company == company)) + ).run(as_dict=True)[0] - if valuation_rate <= 0: - last_valuation_rate = frappe.db.sql("""select valuation_rate - from `tabStock Ledger Entry` - where item_code = %s and valuation_rate > 0 and is_cancelled = 0 - order by posting_date desc, posting_time desc, creation desc limit 1""", args['item_code']) + valuation_rate = item_valuation.get("valuation_rate") - valuation_rate = flt(last_valuation_rate[0][0]) if last_valuation_rate else 0 + if (valuation_rate is not None) and valuation_rate <= 0: + # Explicit null value check. If None, Bins don't exist, neither does SLE + sle = frappe.qb.DocType("Stock Ledger Entry") + last_val_rate = ( + frappe.qb.from_(sle) + .select(sle.valuation_rate) + .where((sle.item_code == item_code) & (sle.valuation_rate > 0) & (sle.is_cancelled == 0)) + .orderby(sle.posting_date, order=frappe.qb.desc) + .orderby(sle.posting_time, order=frappe.qb.desc) + .orderby(sle.creation, order=frappe.qb.desc) + .limit(1) + ).run(as_dict=True) + + valuation_rate = flt(last_val_rate[0].get("valuation_rate")) if last_val_rate else 0 if not valuation_rate: - valuation_rate = frappe.db.get_value("Item", args['item_code'], "valuation_rate") + valuation_rate = frappe.db.get_value("Item", item_code, "valuation_rate") return flt(valuation_rate) + def get_list_context(context): context.title = _("Bill of Materials") # context.introduction = _('Boms') -def get_bom_items_as_dict(bom, company, qty=1, fetch_exploded=1, fetch_scrap_items=0, include_non_stock_items=False, fetch_qty_in_stock_uom=True): + +def get_bom_items_as_dict( + bom, + company, + qty=1, + fetch_exploded=1, + fetch_scrap_items=0, + include_non_stock_items=False, + fetch_qty_in_stock_uom=True, +): item_dict = {} # Did not use qty_consumed_per_unit in the query, as it leads to rounding loss @@ -859,30 +1026,40 @@ def get_bom_items_as_dict(bom, company, qty=1, fetch_exploded=1, fetch_scrap_ite is_stock_item = 0 if include_non_stock_items else 1 if cint(fetch_exploded): - query = query.format(table="BOM Explosion Item", + query = query.format( + table="BOM Explosion Item", where_conditions="", is_stock_item=is_stock_item, qty_field="stock_qty", - select_columns = """, bom_item.source_warehouse, bom_item.operation, + select_columns=""", bom_item.source_warehouse, bom_item.operation, bom_item.include_item_in_manufacturing, bom_item.description, bom_item.rate, bom_item.sourced_by_supplier, - (Select idx from `tabBOM Item` where item_code = bom_item.item_code and parent = %(parent)s limit 1) as idx""") - - items = frappe.db.sql(query, { "parent": bom, "qty": qty, "bom": bom, "company": company }, as_dict=True) - elif fetch_scrap_items: - query = query.format( - table="BOM Scrap Item", where_conditions="", - select_columns=", bom_item.idx, item.description, is_process_loss", - is_stock_item=is_stock_item, qty_field="stock_qty" + (Select idx from `tabBOM Item` where item_code = bom_item.item_code and parent = %(parent)s limit 1) as idx""", ) - items = frappe.db.sql(query, { "qty": qty, "bom": bom, "company": company }, as_dict=True) + items = frappe.db.sql( + query, {"parent": bom, "qty": qty, "bom": bom, "company": company}, as_dict=True + ) + elif fetch_scrap_items: + query = query.format( + table="BOM Scrap Item", + where_conditions="", + select_columns=", item.description, is_process_loss", + is_stock_item=is_stock_item, + qty_field="stock_qty", + ) + + items = frappe.db.sql(query, {"qty": qty, "bom": bom, "company": company}, as_dict=True) else: - query = query.format(table="BOM Item", where_conditions="", is_stock_item=is_stock_item, + query = query.format( + table="BOM Item", + where_conditions="", + is_stock_item=is_stock_item, qty_field="stock_qty" if fetch_qty_in_stock_uom else "qty", - select_columns = """, bom_item.uom, bom_item.conversion_factor, bom_item.source_warehouse, - bom_item.idx, bom_item.operation, bom_item.include_item_in_manufacturing, bom_item.sourced_by_supplier, - bom_item.description, bom_item.base_rate as rate """) - items = frappe.db.sql(query, { "qty": qty, "bom": bom, "company": company }, as_dict=True) + select_columns=""", bom_item.uom, bom_item.conversion_factor, bom_item.source_warehouse, + bom_item.operation, bom_item.include_item_in_manufacturing, bom_item.sourced_by_supplier, + bom_item.description, bom_item.base_rate as rate """, + ) + items = frappe.db.sql(query, {"qty": qty, "bom": bom, "company": company}, as_dict=True) for item in items: if item.item_code in item_dict: @@ -891,21 +1068,28 @@ def get_bom_items_as_dict(bom, company, qty=1, fetch_exploded=1, fetch_scrap_ite item_dict[item.item_code] = item for item, item_details in item_dict.items(): - for d in [["Account", "expense_account", "stock_adjustment_account"], - ["Cost Center", "cost_center", "cost_center"], ["Warehouse", "default_warehouse", ""]]: - company_in_record = frappe.db.get_value(d[0], item_details.get(d[1]), "company") - if not item_details.get(d[1]) or (company_in_record and company != company_in_record): - item_dict[item][d[1]] = frappe.get_cached_value('Company', company, d[2]) if d[2] else None + for d in [ + ["Account", "expense_account", "stock_adjustment_account"], + ["Cost Center", "cost_center", "cost_center"], + ["Warehouse", "default_warehouse", ""], + ]: + company_in_record = frappe.db.get_value(d[0], item_details.get(d[1]), "company") + if not item_details.get(d[1]) or (company_in_record and company != company_in_record): + item_dict[item][d[1]] = frappe.get_cached_value("Company", company, d[2]) if d[2] else None return item_dict + @frappe.whitelist() def get_bom_items(bom, company, qty=1, fetch_exploded=1): - items = get_bom_items_as_dict(bom, company, qty, fetch_exploded, include_non_stock_items=True).values() + items = get_bom_items_as_dict( + bom, company, qty, fetch_exploded, include_non_stock_items=True + ).values() items = list(items) - items.sort(key = functools.cmp_to_key(lambda a, b: a.item_code > b.item_code and 1 or -1)) + items.sort(key=functools.cmp_to_key(lambda a, b: a.item_code > b.item_code and 1 or -1)) return items + def validate_bom_no(item, bom_no): """Validate BOM No of sub-contracted items""" bom = frappe.get_doc("BOM", bom_no) @@ -917,21 +1101,24 @@ def validate_bom_no(item, bom_no): if item: rm_item_exists = False for d in bom.items: - if (d.item_code.lower() == item.lower()): + if d.item_code.lower() == item.lower(): rm_item_exists = True for d in bom.scrap_items: - if (d.item_code.lower() == item.lower()): + if d.item_code.lower() == item.lower(): rm_item_exists = True - if bom.item.lower() == item.lower() or \ - bom.item.lower() == cstr(frappe.db.get_value("Item", item, "variant_of")).lower(): - rm_item_exists = True + if ( + bom.item.lower() == item.lower() + or bom.item.lower() == cstr(frappe.db.get_value("Item", item, "variant_of")).lower() + ): + rm_item_exists = True if not rm_item_exists: frappe.throw(_("BOM {0} does not belong to Item {1}").format(bom_no, item)) + @frappe.whitelist() def get_children(doctype, parent=None, is_root=False, **filters): - if not parent or parent=="BOM": - frappe.msgprint(_('Please select a BOM')) + if not parent or parent == "BOM": + frappe.msgprint(_("Please select a BOM")) return if parent: @@ -941,121 +1128,120 @@ def get_children(doctype, parent=None, is_root=False, **filters): bom_doc = frappe.get_cached_doc("BOM", frappe.form_dict.parent) frappe.has_permission("BOM", doc=bom_doc, throw=True) - bom_items = frappe.get_all('BOM Item', - fields=['item_code', 'bom_no as value', 'stock_qty'], - filters=[['parent', '=', frappe.form_dict.parent]], - order_by='idx') + bom_items = frappe.get_all( + "BOM Item", + fields=["item_code", "bom_no as value", "stock_qty"], + filters=[["parent", "=", frappe.form_dict.parent]], + order_by="idx", + ) - item_names = tuple(d.get('item_code') for d in bom_items) + item_names = tuple(d.get("item_code") for d in bom_items) - items = frappe.get_list('Item', - fields=['image', 'description', 'name', 'stock_uom', 'item_name', 'is_sub_contracted_item'], - filters=[['name', 'in', item_names]]) # to get only required item dicts + items = frappe.get_list( + "Item", + fields=["image", "description", "name", "stock_uom", "item_name", "is_sub_contracted_item"], + filters=[["name", "in", item_names]], + ) # to get only required item dicts for bom_item in bom_items: # extend bom_item dict with respective item dict bom_item.update( # returns an item dict from items list which matches with item_code - next(item for item in items if item.get('name') - == bom_item.get('item_code')) + next(item for item in items if item.get("name") == bom_item.get("item_code")) ) bom_item.parent_bom_qty = bom_doc.quantity - bom_item.expandable = 0 if bom_item.value in ('', None) else 1 + bom_item.expandable = 0 if bom_item.value in ("", None) else 1 bom_item.image = frappe.db.escape(bom_item.image) return bom_items -def get_boms_in_bottom_up_order(bom_no=None): - def _get_parent(bom_no): - return frappe.db.sql_list(""" - select distinct bom_item.parent from `tabBOM Item` bom_item - where bom_item.bom_no = %s and bom_item.docstatus=1 and bom_item.parenttype='BOM' - and exists(select bom.name from `tabBOM` bom where bom.name=bom_item.parent and bom.is_active=1) - """, bom_no) - - count = 0 - bom_list = [] - if bom_no: - bom_list.append(bom_no) - else: - # get all leaf BOMs - bom_list = frappe.db.sql_list("""select name from `tabBOM` bom - where docstatus=1 and is_active=1 - and not exists(select bom_no from `tabBOM Item` - where parent=bom.name and ifnull(bom_no, '')!='')""") - - while(count < len(bom_list)): - for child_bom in _get_parent(bom_list[count]): - if child_bom not in bom_list: - bom_list.append(child_bom) - count += 1 - - return bom_list def add_additional_cost(stock_entry, work_order): # Add non stock items cost in the additional cost stock_entry.additional_costs = [] - expenses_included_in_valuation = frappe.get_cached_value("Company", work_order.company, - "expenses_included_in_valuation") + expenses_included_in_valuation = frappe.get_cached_value( + "Company", work_order.company, "expenses_included_in_valuation" + ) add_non_stock_items_cost(stock_entry, work_order, expenses_included_in_valuation) add_operations_cost(stock_entry, work_order, expenses_included_in_valuation) + def add_non_stock_items_cost(stock_entry, work_order, expense_account): - bom = frappe.get_doc('BOM', work_order.bom_no) - table = 'exploded_items' if work_order.get('use_multi_level_bom') else 'items' + bom = frappe.get_doc("BOM", work_order.bom_no) + table = "exploded_items" if work_order.get("use_multi_level_bom") else "items" items = {} for d in bom.get(table): items.setdefault(d.item_code, d.amount) - non_stock_items = frappe.get_all('Item', - fields="name", filters={'name': ('in', list(items.keys())), 'ifnull(is_stock_item, 0)': 0}, as_list=1) + non_stock_items = frappe.get_all( + "Item", + fields="name", + filters={"name": ("in", list(items.keys())), "ifnull(is_stock_item, 0)": 0}, + as_list=1, + ) non_stock_items_cost = 0.0 for name in non_stock_items: - non_stock_items_cost += flt(items.get(name[0])) * flt(stock_entry.fg_completed_qty) / flt(bom.quantity) + non_stock_items_cost += ( + flt(items.get(name[0])) * flt(stock_entry.fg_completed_qty) / flt(bom.quantity) + ) if non_stock_items_cost: - stock_entry.append('additional_costs', { - 'expense_account': expense_account, - 'description': _("Non stock items"), - 'amount': non_stock_items_cost - }) + stock_entry.append( + "additional_costs", + { + "expense_account": expense_account, + "description": _("Non stock items"), + "amount": non_stock_items_cost, + }, + ) + def add_operations_cost(stock_entry, work_order=None, expense_account=None): from erpnext.stock.doctype.stock_entry.stock_entry import get_operating_cost_per_unit + operating_cost_per_unit = get_operating_cost_per_unit(work_order, stock_entry.bom_no) if operating_cost_per_unit: - stock_entry.append('additional_costs', { - "expense_account": expense_account, - "description": _("Operating Cost as per Work Order / BOM"), - "amount": operating_cost_per_unit * flt(stock_entry.fg_completed_qty) - }) + stock_entry.append( + "additional_costs", + { + "expense_account": expense_account, + "description": _("Operating Cost as per Work Order / BOM"), + "amount": operating_cost_per_unit * flt(stock_entry.fg_completed_qty), + }, + ) if work_order and work_order.additional_operating_cost and work_order.qty: - additional_operating_cost_per_unit = \ - flt(work_order.additional_operating_cost) / flt(work_order.qty) + additional_operating_cost_per_unit = flt(work_order.additional_operating_cost) / flt( + work_order.qty + ) if additional_operating_cost_per_unit: - stock_entry.append('additional_costs', { - "expense_account": expense_account, - "description": "Additional Operating Cost", - "amount": additional_operating_cost_per_unit * flt(stock_entry.fg_completed_qty) - }) + stock_entry.append( + "additional_costs", + { + "expense_account": expense_account, + "description": "Additional Operating Cost", + "amount": additional_operating_cost_per_unit * flt(stock_entry.fg_completed_qty), + }, + ) + @frappe.whitelist() def get_bom_diff(bom1, bom2): from frappe.model import table_fields if bom1 == bom2: - frappe.throw(_("BOM 1 {0} and BOM 2 {1} should not be same") - .format(frappe.bold(bom1), frappe.bold(bom2))) + frappe.throw( + _("BOM 1 {0} and BOM 2 {1} should not be same").format(frappe.bold(bom1), frappe.bold(bom2)) + ) - doc1 = frappe.get_doc('BOM', bom1) - doc2 = frappe.get_doc('BOM', bom2) + doc1 = frappe.get_doc("BOM", bom1) + doc2 = frappe.get_doc("BOM", bom2) out = get_diff(doc1, doc2) out.row_changed = [] @@ -1065,10 +1251,10 @@ def get_bom_diff(bom1, bom2): meta = doc1.meta identifiers = { - 'operations': 'operation', - 'items': 'item_code', - 'scrap_items': 'item_code', - 'exploded_items': 'item_code' + "operations": "operation", + "items": "item_code", + "scrap_items": "item_code", + "exploded_items": "item_code", } for df in meta.fields: @@ -1099,6 +1285,7 @@ def get_bom_diff(bom1, bom2): return out + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def item_query(doctype, txt, searchfield, start, page_len, filters): @@ -1108,25 +1295,28 @@ def item_query(doctype, txt, searchfield, start, page_len, filters): order_by = "idx desc, name, item_name" fields = ["name", "item_group", "item_name", "description"] - fields.extend([field for field in searchfields - if not field in ["name", "item_group", "description"]]) + fields.extend( + [field for field in searchfields if not field in ["name", "item_group", "description"]] + ) - searchfields = searchfields + [field for field in [searchfield or "name", "item_code", "item_group", "item_name"] - if not field in searchfields] + searchfields = searchfields + [ + field + for field in [searchfield or "name", "item_code", "item_group", "item_name"] + if not field in searchfields + ] - query_filters = { - "disabled": 0, - "ifnull(end_of_life, '5050-50-50')": (">", today()) - } + query_filters = {"disabled": 0, "ifnull(end_of_life, '5050-50-50')": (">", today())} or_cond_filters = {} if txt: for s_field in searchfields: or_cond_filters[s_field] = ("like", "%{0}%".format(txt)) - barcodes = frappe.get_all("Item Barcode", + barcodes = frappe.get_all( + "Item Barcode", fields=["distinct parent as item_code"], - filters = {"barcode": ("like", "%{0}%".format(txt))}) + filters={"barcode": ("like", "%{0}%".format(txt))}, + ) barcodes = [d.item_code for d in barcodes] if barcodes: @@ -1140,10 +1330,17 @@ def item_query(doctype, txt, searchfield, start, page_len, filters): if filters and filters.get("is_stock_item"): query_filters["is_stock_item"] = 1 - return frappe.get_list("Item", - fields = fields, filters=query_filters, - or_filters = or_cond_filters, order_by=order_by, - limit_start=start, limit_page_length=page_len, as_list=1) + return frappe.get_list( + "Item", + fields=fields, + filters=query_filters, + or_filters=or_cond_filters, + order_by=order_by, + limit_start=start, + limit_page_length=page_len, + as_list=1, + ) + @frappe.whitelist() def make_variant_bom(source_name, bom_no, item, variant_items, target_doc=None): @@ -1154,28 +1351,31 @@ def make_variant_bom(source_name, bom_no, item, variant_items, target_doc=None): doc.quantity = 1 item_data = get_item_details(item) - doc.update({ - "item_name": item_data.item_name, - "description": item_data.description, - "uom": item_data.stock_uom, - "allow_alternative_item": item_data.allow_alternative_item - }) + doc.update( + { + "item_name": item_data.item_name, + "description": item_data.description, + "uom": item_data.stock_uom, + "allow_alternative_item": item_data.allow_alternative_item, + } + ) add_variant_item(variant_items, doc, source_name) - doc = get_mapped_doc('BOM', source_name, { - 'BOM': { - 'doctype': 'BOM', - 'validation': { - 'docstatus': ['=', 1] - } + doc = get_mapped_doc( + "BOM", + source_name, + { + "BOM": {"doctype": "BOM", "validation": {"docstatus": ["=", 1]}}, + "BOM Item": { + "doctype": "BOM Item", + # stop get_mapped_doc copying parent bom_no to children + "field_no_map": ["bom_no"], + "condition": lambda doc: doc.has_variants == 0, + }, }, - 'BOM Item': { - 'doctype': 'BOM Item', - # stop get_mapped_doc copying parent bom_no to children - 'field_no_map': ['bom_no'], - 'condition': lambda doc: doc.has_variants == 0 - }, - }, target_doc, postprocess) + target_doc, + postprocess, + ) return doc diff --git a/erpnext/manufacturing/doctype/bom/bom_dashboard.py b/erpnext/manufacturing/doctype/bom/bom_dashboard.py index 9b8f6bff095..d8a810bd0ad 100644 --- a/erpnext/manufacturing/doctype/bom/bom_dashboard.py +++ b/erpnext/manufacturing/doctype/bom/bom_dashboard.py @@ -1,30 +1,30 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'bom_no', - 'non_standard_fieldnames': { - 'Item': 'default_bom', - 'Purchase Order': 'bom', - 'Purchase Receipt': 'bom', - 'Purchase Invoice': 'bom' + "fieldname": "bom_no", + "non_standard_fieldnames": { + "Item": "default_bom", + "Purchase Order": "bom", + "Purchase Receipt": "bom", + "Purchase Invoice": "bom", }, - 'transactions': [ + "transactions": [ + {"label": _("Stock"), "items": ["Item", "Stock Entry", "Quality Inspection"]}, + {"label": _("Manufacture"), "items": ["BOM", "Work Order", "Job Card"]}, { - 'label': _('Stock'), - 'items': ['Item', 'Stock Entry', 'Quality Inspection'] + "label": _("Subcontract"), + "items": ["Purchase Order", "Purchase Receipt", "Purchase Invoice"], }, - { - 'label': _('Manufacture'), - 'items': ['BOM', 'Work Order', 'Job Card'] - }, - { - 'label': _('Subcontract'), - 'items': ['Purchase Order', 'Purchase Receipt', 'Purchase Invoice'] - } ], - 'disable_create_buttons': ["Item", "Purchase Order", "Purchase Receipt", - "Purchase Invoice", "Job Card", "Stock Entry", "BOM"] + "disable_create_buttons": [ + "Item", + "Purchase Order", + "Purchase Receipt", + "Purchase Invoice", + "Job Card", + "Stock Entry", + "BOM", + ], } diff --git a/erpnext/manufacturing/doctype/bom/test_bom.py b/erpnext/manufacturing/doctype/bom/test_bom.py index 6126c95cd45..3c91c6d4d9b 100644 --- a/erpnext/manufacturing/doctype/bom/test_bom.py +++ b/erpnext/manufacturing/doctype/bom/test_bom.py @@ -2,42 +2,45 @@ # License: GNU General Public License v3. See license.txt -import unittest from collections import deque from functools import partial import frappe -from frappe.test_runner import make_test_records +from frappe.tests.utils import FrappeTestCase from frappe.utils import cstr, flt from erpnext.buying.doctype.purchase_order.test_purchase_order import create_purchase_order -from erpnext.manufacturing.doctype.bom.bom import item_query -from erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool import update_cost +from erpnext.manufacturing.doctype.bom.bom import BOMRecursionError, item_query +from erpnext.manufacturing.doctype.bom_update_log.test_bom_update_log import ( + update_cost_in_all_boms_in_test, +) from erpnext.stock.doctype.item.test_item import make_item from erpnext.stock.doctype.stock_reconciliation.test_stock_reconciliation import ( create_stock_reconciliation, ) from erpnext.tests.test_subcontracting import set_backflush_based_on -test_records = frappe.get_test_records('BOM') +test_records = frappe.get_test_records("BOM") +test_dependencies = ["Item", "Quality Inspection Template"] -class TestBOM(unittest.TestCase): - def setUp(self): - if not frappe.get_value('Item', '_Test Item'): - make_test_records('Item') +class TestBOM(FrappeTestCase): def test_get_items(self): from erpnext.manufacturing.doctype.bom.bom import get_bom_items_as_dict - items_dict = get_bom_items_as_dict(bom=get_default_bom(), - company="_Test Company", qty=1, fetch_exploded=0) + + items_dict = get_bom_items_as_dict( + bom=get_default_bom(), company="_Test Company", qty=1, fetch_exploded=0 + ) self.assertTrue(test_records[2]["items"][0]["item_code"] in items_dict) self.assertTrue(test_records[2]["items"][1]["item_code"] in items_dict) self.assertEqual(len(items_dict.values()), 2) def test_get_items_exploded(self): from erpnext.manufacturing.doctype.bom.bom import get_bom_items_as_dict - items_dict = get_bom_items_as_dict(bom=get_default_bom(), - company="_Test Company", qty=1, fetch_exploded=1) + + items_dict = get_bom_items_as_dict( + bom=get_default_bom(), company="_Test Company", qty=1, fetch_exploded=1 + ) self.assertTrue(test_records[2]["items"][0]["item_code"] in items_dict) self.assertFalse(test_records[2]["items"][1]["item_code"] in items_dict) self.assertTrue(test_records[0]["items"][0]["item_code"] in items_dict) @@ -46,13 +49,14 @@ class TestBOM(unittest.TestCase): def test_get_items_list(self): from erpnext.manufacturing.doctype.bom.bom import get_bom_items + self.assertEqual(len(get_bom_items(bom=get_default_bom(), company="_Test Company")), 3) def test_default_bom(self): def _get_default_bom_in_item(): return cstr(frappe.db.get_value("Item", "_Test FG Item 2", "default_bom")) - bom = frappe.get_doc("BOM", {"item":"_Test FG Item 2", "is_default": 1}) + bom = frappe.get_doc("BOM", {"item": "_Test FG Item 2", "is_default": 1}) self.assertEqual(_get_default_bom_in_item(), bom.name) bom.is_active = 0 @@ -60,28 +64,38 @@ class TestBOM(unittest.TestCase): self.assertEqual(_get_default_bom_in_item(), "") bom.is_active = 1 - bom.is_default=1 + bom.is_default = 1 bom.save() self.assertTrue(_get_default_bom_in_item(), bom.name) def test_update_bom_cost_in_all_boms(self): # get current rate for '_Test Item 2' - rm_rate = frappe.db.sql("""select rate from `tabBOM Item` - where parent='BOM-_Test Item Home Desktop Manufactured-001' - and item_code='_Test Item 2' and docstatus=1 and parenttype='BOM'""") - rm_rate = rm_rate[0][0] if rm_rate else 0 + bom_rates = frappe.db.get_values( + "BOM Item", + { + "parent": "BOM-_Test Item Home Desktop Manufactured-001", + "item_code": "_Test Item 2", + "docstatus": 1, + }, + fieldname=["rate", "base_rate"], + as_dict=True, + ) + rm_base_rate = bom_rates[0].get("base_rate") if bom_rates else 0 # Reset item valuation rate - reset_item_valuation_rate(item_code='_Test Item 2', qty=200, rate=rm_rate + 10) + reset_item_valuation_rate(item_code="_Test Item 2", qty=200, rate=rm_base_rate + 10) # update cost of all BOMs based on latest valuation rate - update_cost() + update_cost_in_all_boms_in_test() # check if new valuation rate updated in all BOMs - for d in frappe.db.sql("""select rate from `tabBOM Item` - where item_code='_Test Item 2' and docstatus=1 and parenttype='BOM'""", as_dict=1): - self.assertEqual(d.rate, rm_rate + 10) + for d in frappe.db.sql( + """select base_rate from `tabBOM Item` + where item_code='_Test Item 2' and docstatus=1 and parenttype='BOM'""", + as_dict=1, + ): + self.assertEqual(d.base_rate, rm_base_rate + 10) def test_bom_cost(self): bom = frappe.copy_doc(test_records[2]) @@ -96,7 +110,9 @@ class TestBOM(unittest.TestCase): for row in bom.items: raw_material_cost += row.amount - base_raw_material_cost = raw_material_cost * flt(bom.conversion_rate, bom.precision("conversion_rate")) + base_raw_material_cost = raw_material_cost * flt( + bom.conversion_rate, bom.precision("conversion_rate") + ) base_op_cost = op_cost * flt(bom.conversion_rate, bom.precision("conversion_rate")) # test amounts in selected currency, almostEqual checks for 7 digits by default @@ -124,14 +140,15 @@ class TestBOM(unittest.TestCase): for op_row in bom.operations: self.assertAlmostEqual(op_row.cost_per_unit, op_row.operating_cost / 2) - self.assertAlmostEqual(bom.operating_cost, op_cost/2) + self.assertAlmostEqual(bom.operating_cost, op_cost / 2) bom.delete() def test_bom_cost_multi_uom_multi_currency_based_on_price_list(self): frappe.db.set_value("Price List", "_Test Price List", "price_not_uom_dependent", 1) for item_code, rate in (("_Test Item", 3600), ("_Test Item Home Desktop Manufactured", 3000)): - frappe.db.sql("delete from `tabItem Price` where price_list='_Test Price List' and item_code=%s", - item_code) + frappe.db.sql( + "delete from `tabItem Price` where price_list='_Test Price List' and item_code=%s", item_code + ) item_price = frappe.new_doc("Item Price") item_price.price_list = "_Test Price List" item_price.item_code = item_code @@ -146,7 +163,7 @@ class TestBOM(unittest.TestCase): bom.items[0].conversion_factor = 5 bom.insert() - bom.update_cost(update_hour_rate = False) + bom.update_cost(update_hour_rate=False) # test amounts in selected currency self.assertEqual(bom.items[0].rate, 300) @@ -171,11 +188,12 @@ class TestBOM(unittest.TestCase): bom.insert() reset_item_valuation_rate( - item_code='_Test Item', - warehouse_list=frappe.get_all("Warehouse", - {"is_group":0, "company": bom.company}, pluck="name"), + item_code="_Test Item", + warehouse_list=frappe.get_all( + "Warehouse", {"is_group": 0, "company": bom.company}, pluck="name" + ), qty=200, - rate=200 + rate=200, ) bom.update_cost() @@ -184,112 +202,100 @@ class TestBOM(unittest.TestCase): def test_subcontractor_sourced_item(self): item_code = "_Test Subcontracted FG Item 1" - set_backflush_based_on('Material Transferred for Subcontract') + set_backflush_based_on("Material Transferred for Subcontract") - if not frappe.db.exists('Item', item_code): - make_item(item_code, { - 'is_stock_item': 1, - 'is_sub_contracted_item': 1, - 'stock_uom': 'Nos' - }) + if not frappe.db.exists("Item", item_code): + make_item(item_code, {"is_stock_item": 1, "is_sub_contracted_item": 1, "stock_uom": "Nos"}) - if not frappe.db.exists('Item', "Test Extra Item 1"): - make_item("Test Extra Item 1", { - 'is_stock_item': 1, - 'stock_uom': 'Nos' - }) + if not frappe.db.exists("Item", "Test Extra Item 1"): + make_item("Test Extra Item 1", {"is_stock_item": 1, "stock_uom": "Nos"}) - if not frappe.db.exists('Item', "Test Extra Item 2"): - make_item("Test Extra Item 2", { - 'is_stock_item': 1, - 'stock_uom': 'Nos' - }) + if not frappe.db.exists("Item", "Test Extra Item 2"): + make_item("Test Extra Item 2", {"is_stock_item": 1, "stock_uom": "Nos"}) - if not frappe.db.exists('Item', "Test Extra Item 3"): - make_item("Test Extra Item 3", { - 'is_stock_item': 1, - 'stock_uom': 'Nos' - }) - bom = frappe.get_doc({ - 'doctype': 'BOM', - 'is_default': 1, - 'item': item_code, - 'currency': 'USD', - 'quantity': 1, - 'company': '_Test Company' - }) + if not frappe.db.exists("Item", "Test Extra Item 3"): + make_item("Test Extra Item 3", {"is_stock_item": 1, "stock_uom": "Nos"}) + bom = frappe.get_doc( + { + "doctype": "BOM", + "is_default": 1, + "item": item_code, + "currency": "USD", + "quantity": 1, + "company": "_Test Company", + } + ) for item in ["Test Extra Item 1", "Test Extra Item 2"]: - item_doc = frappe.get_doc('Item', item) + item_doc = frappe.get_doc("Item", item) - bom.append('items', { - 'item_code': item, - 'qty': 1, - 'uom': item_doc.stock_uom, - 'stock_uom': item_doc.stock_uom, - 'rate': item_doc.valuation_rate - }) + bom.append( + "items", + { + "item_code": item, + "qty": 1, + "uom": item_doc.stock_uom, + "stock_uom": item_doc.stock_uom, + "rate": item_doc.valuation_rate, + }, + ) - bom.append('items', { - 'item_code': "Test Extra Item 3", - 'qty': 1, - 'uom': item_doc.stock_uom, - 'stock_uom': item_doc.stock_uom, - 'rate': 0, - 'sourced_by_supplier': 1 - }) + bom.append( + "items", + { + "item_code": "Test Extra Item 3", + "qty": 1, + "uom": item_doc.stock_uom, + "stock_uom": item_doc.stock_uom, + "rate": 0, + "sourced_by_supplier": 1, + }, + ) bom.insert(ignore_permissions=True) bom.update_cost() bom.submit() # test that sourced_by_supplier rate is zero even after updating cost self.assertEqual(bom.items[2].rate, 0) # test in Purchase Order sourced_by_supplier is not added to Supplied Item - po = create_purchase_order(item_code=item_code, qty=1, - is_subcontracted="Yes", supplier_warehouse="_Test Warehouse 1 - _TC") + po = create_purchase_order( + item_code=item_code, qty=1, is_subcontracted="Yes", supplier_warehouse="_Test Warehouse 1 - _TC" + ) bom_items = sorted([d.item_code for d in bom.items if d.sourced_by_supplier != 1]) supplied_items = sorted([d.rm_item_code for d in po.supplied_items]) self.assertEqual(bom_items, supplied_items) - def test_bom_recursion_1st_level(self): """BOM should not allow BOM item again in child""" - item_code = "_Test BOM Recursion" - make_item(item_code, {'is_stock_item': 1}) + item_code = make_item(properties={"is_stock_item": 1}).name bom = frappe.new_doc("BOM") bom.item = item_code bom.append("items", frappe._dict(item_code=item_code)) - with self.assertRaises(frappe.ValidationError) as err: + bom.save() + with self.assertRaises(BOMRecursionError): + bom.items[0].bom_no = bom.name bom.save() - self.assertTrue("recursion" in str(err.exception).lower()) - frappe.delete_doc("BOM", bom.name, ignore_missing=True) - def test_bom_recursion_transitive(self): - item1 = "_Test BOM Recursion" - item2 = "_Test BOM Recursion 2" - make_item(item1, {'is_stock_item': 1}) - make_item(item2, {'is_stock_item': 1}) + item1 = make_item(properties={"is_stock_item": 1}).name + item2 = make_item(properties={"is_stock_item": 1}).name bom1 = frappe.new_doc("BOM") bom1.item = item1 bom1.append("items", frappe._dict(item_code=item2)) bom1.save() - bom1.submit() bom2 = frappe.new_doc("BOM") bom2.item = item2 bom2.append("items", frappe._dict(item_code=item1)) + bom2.save() - with self.assertRaises(frappe.ValidationError) as err: + bom2.items[0].bom_no = bom1.name + bom1.items[0].bom_no = bom2.name + + with self.assertRaises(BOMRecursionError): + bom1.save() bom2.save() - bom2.submit() - - self.assertTrue("recursion" in str(err.exception).lower()) - - bom1.cancel() - frappe.delete_doc("BOM", bom1.name, ignore_missing=True, force=True) - frappe.delete_doc("BOM", bom2.name, ignore_missing=True, force=True) def test_bom_with_process_loss_item(self): fg_item_non_whole, fg_item_whole, bom_item = create_process_loss_bom_items() @@ -327,7 +333,10 @@ class TestBOM(unittest.TestCase): def test_bom_tree_representation(self): bom_tree = { "Assembly": { - "SubAssembly1": {"ChildPart1": {}, "ChildPart2": {},}, + "SubAssembly1": { + "ChildPart1": {}, + "ChildPart2": {}, + }, "SubAssembly2": {"ChildPart3": {}}, "SubAssembly3": {"SubSubAssy1": {"ChildPart4": {}}}, "ChildPart5": {}, @@ -338,7 +347,7 @@ class TestBOM(unittest.TestCase): parent_bom = create_nested_bom(bom_tree, prefix="") created_tree = parent_bom.get_tree_representation() - reqd_order = level_order_traversal(bom_tree)[1:] # skip first item + reqd_order = level_order_traversal(bom_tree)[1:] # skip first item created_order = created_tree.level_order_traversal() self.assertEqual(len(reqd_order), len(created_order)) @@ -347,18 +356,238 @@ class TestBOM(unittest.TestCase): self.assertEqual(reqd_item, created_item.item_code) def test_bom_item_query(self): - query = partial(item_query, doctype="Item", txt="", searchfield="name", start=0, page_len=20, filters={"is_stock_item": 1}) + query = partial( + item_query, + doctype="Item", + txt="", + searchfield="name", + start=0, + page_len=20, + filters={"is_stock_item": 1}, + ) test_items = query(txt="_Test") filtered = query(txt="_Test Item 2") - self.assertNotEqual(len(test_items), len(filtered), msg="Item filtering showing excessive results") + self.assertNotEqual( + len(test_items), len(filtered), msg="Item filtering showing excessive results" + ) self.assertTrue(0 < len(filtered) <= 3, msg="Item filtering showing excessive results") + def test_valid_transfer_defaults(self): + bom_with_op = frappe.db.get_value( + "BOM", {"item": "_Test FG Item 2", "with_operations": 1, "is_active": 1} + ) + bom = frappe.copy_doc(frappe.get_doc("BOM", bom_with_op), ignore_no_copy=False) + + # test defaults + bom.docstatus = 0 + bom.transfer_material_against = None + bom.insert() + self.assertEqual(bom.transfer_material_against, "Work Order") + + bom.reload() + bom.transfer_material_against = None + with self.assertRaises(frappe.ValidationError): + bom.save() + bom.reload() + + # test saner default + bom.transfer_material_against = "Job Card" + bom.with_operations = 0 + bom.save() + self.assertEqual(bom.transfer_material_against, "Work Order") + + # test no value on existing doc + bom.transfer_material_against = None + bom.with_operations = 0 + bom.save() + self.assertEqual(bom.transfer_material_against, "Work Order") + bom.delete() + + def test_bom_name_length(self): + """test >140 char names""" + bom_tree = {"x" * 140: {" ".join(["abc"] * 35): {}}} + create_nested_bom(bom_tree, prefix="") + + def test_version_index(self): + + bom = frappe.new_doc("BOM") + + version_index_test_cases = [ + (1, []), + (1, ["BOM#XYZ"]), + (2, ["BOM/ITEM/001"]), + (2, ["BOM-ITEM-001"]), + (3, ["BOM-ITEM-001", "BOM-ITEM-002"]), + (4, ["BOM-ITEM-001", "BOM-ITEM-002", "BOM-ITEM-003"]), + ] + + for expected_index, existing_boms in version_index_test_cases: + with self.subTest(): + self.assertEqual( + expected_index, + bom.get_next_version_index(existing_boms), + msg=f"Incorrect index for {existing_boms}", + ) + + def test_bom_versioning(self): + bom_tree = {frappe.generate_hash(length=10): {frappe.generate_hash(length=10): {}}} + bom = create_nested_bom(bom_tree, prefix="") + self.assertEqual(int(bom.name.split("-")[-1]), 1) + original_bom_name = bom.name + + bom.cancel() + bom.reload() + self.assertEqual(bom.name, original_bom_name) + + # create a new amendment + amendment = frappe.copy_doc(bom) + amendment.docstatus = 0 + amendment.amended_from = bom.name + + amendment.save() + amendment.submit() + amendment.reload() + + self.assertNotEqual(amendment.name, bom.name) + # `origname-001-1` version + self.assertEqual(int(amendment.name.split("-")[-1]), 1) + self.assertEqual(int(amendment.name.split("-")[-2]), 1) + + # create a new version + version = frappe.copy_doc(amendment) + version.docstatus = 0 + version.amended_from = None + version.save() + self.assertNotEqual(amendment.name, version.name) + self.assertEqual(int(version.name.split("-")[-1]), 2) + + def test_clear_inpection_quality(self): + + bom = frappe.copy_doc(test_records[2], ignore_no_copy=True) + bom.docstatus = 0 + bom.is_default = 0 + bom.quality_inspection_template = "_Test Quality Inspection Template" + bom.inspection_required = 1 + bom.save() + bom.reload() + + self.assertEqual(bom.quality_inspection_template, "_Test Quality Inspection Template") + + bom.inspection_required = 0 + bom.save() + bom.reload() + + self.assertEqual(bom.quality_inspection_template, None) + + def test_bom_pricing_based_on_lpp(self): + from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import make_purchase_receipt + + parent = frappe.generate_hash(length=10) + child = frappe.generate_hash(length=10) + bom_tree = {parent: {child: {}}} + bom = create_nested_bom(bom_tree, prefix="") + + # add last purchase price + make_purchase_receipt(item_code=child, rate=42) + + bom = frappe.copy_doc(bom) + bom.docstatus = 0 + bom.amended_from = None + bom.rm_cost_as_per = "Last Purchase Rate" + bom.conversion_rate = 1 + bom.save() + bom.submit() + self.assertEqual(bom.items[0].rate, 42) + + def test_exclude_exploded_items_from_bom(self): + bom_no = get_default_bom() + new_bom = frappe.copy_doc(frappe.get_doc("BOM", bom_no)) + for row in new_bom.items: + if row.item_code == "_Test Item Home Desktop Manufactured": + self.assertTrue(row.bom_no) + row.do_not_explode = True + + new_bom.docstatus = 0 + new_bom.save() + new_bom.load_from_db() + + for row in new_bom.items: + if row.item_code == "_Test Item Home Desktop Manufactured" and row.do_not_explode: + self.assertFalse(row.bom_no) + + new_bom.delete() + + def test_set_default_bom_for_item_having_single_bom(self): + from erpnext.stock.doctype.item.test_item import make_item + + fg_item = make_item(properties={"is_stock_item": 1}) + bom_item = make_item(properties={"is_stock_item": 1}) + + # Step 1: Create BOM + bom = frappe.new_doc("BOM") + bom.item = fg_item.item_code + bom.quantity = 1 + bom.append( + "items", + { + "item_code": bom_item.item_code, + "qty": 1, + "uom": bom_item.stock_uom, + "stock_uom": bom_item.stock_uom, + "rate": 100.0, + }, + ) + bom.save() + bom.submit() + self.assertEqual(frappe.get_value("Item", fg_item.item_code, "default_bom"), bom.name) + + # Step 2: Uncheck is_active field + bom.is_active = 0 + bom.save() + bom.reload() + self.assertIsNone(frappe.get_value("Item", fg_item.item_code, "default_bom")) + + # Step 3: Check is_active field + bom.is_active = 1 + bom.save() + bom.reload() + self.assertEqual(frappe.get_value("Item", fg_item.item_code, "default_bom"), bom.name) + + def test_exploded_items_rate(self): + rm_item = make_item( + properties={"is_stock_item": 1, "valuation_rate": 99, "last_purchase_rate": 89} + ).name + fg_item = make_item(properties={"is_stock_item": 1}).name + + from erpnext.manufacturing.doctype.production_plan.test_production_plan import make_bom + + bom = make_bom(item=fg_item, raw_materials=[rm_item], do_not_save=True) + + bom.rm_cost_as_per = "Last Purchase Rate" + bom.save() + self.assertEqual(bom.items[0].base_rate, 89) + self.assertEqual(bom.exploded_items[0].rate, bom.items[0].base_rate) + + bom.rm_cost_as_per = "Price List" + bom.save() + self.assertEqual(bom.items[0].base_rate, 0.0) + self.assertEqual(bom.exploded_items[0].rate, bom.items[0].base_rate) + + bom.rm_cost_as_per = "Valuation Rate" + bom.save() + self.assertEqual(bom.items[0].base_rate, 99) + self.assertEqual(bom.exploded_items[0].rate, bom.items[0].base_rate) + + bom.submit() + self.assertEqual(bom.exploded_items[0].rate, bom.items[0].base_rate) + def get_default_bom(item_code="_Test FG Item 2"): return frappe.db.get_value("BOM", {"item": item_code, "is_active": 1, "is_default": 1}) + def level_order_traversal(node): traversal = [] q = deque() @@ -373,9 +602,9 @@ def level_order_traversal(node): return traversal + def create_nested_bom(tree, prefix="_Test bom "): - """ Helper function to create a simple nested bom from tree describing item names. (along with required items) - """ + """Helper function to create a simple nested bom from tree describing item names. (along with required items)""" def create_items(bom_tree): for item_code, subtree in bom_tree.items(): @@ -383,6 +612,7 @@ def create_nested_bom(tree, prefix="_Test bom "): if not frappe.db.exists("Item", bom_item_code): frappe.get_doc(doctype="Item", item_code=bom_item_code, item_group="_Test Item Group").insert() create_items(subtree) + create_items(tree) def dfs(tree, node): @@ -404,6 +634,7 @@ def create_nested_bom(tree, prefix="_Test bom "): bom = frappe.get_doc(doctype="BOM", item=bom_item_code) for child_item in child_items.keys(): bom.append("items", {"item_code": prefix + child_item}) + bom.company = "_Test Company" bom.currency = "INR" bom.insert() bom.submit() @@ -416,10 +647,13 @@ def reset_item_valuation_rate(item_code, warehouse_list=None, qty=None, rate=Non warehouse_list = [warehouse_list] if not warehouse_list: - warehouse_list = frappe.db.sql_list(""" + warehouse_list = frappe.db.sql_list( + """ select warehouse from `tabBin` where item_code=%s and actual_qty > 0 - """, item_code) + """, + item_code, + ) if not warehouse_list: warehouse_list.append("_Test Warehouse - _TC") @@ -427,44 +661,51 @@ def reset_item_valuation_rate(item_code, warehouse_list=None, qty=None, rate=Non for warehouse in warehouse_list: create_stock_reconciliation(item_code=item_code, warehouse=warehouse, qty=qty, rate=rate) + def create_bom_with_process_loss_item( - fg_item, bom_item, scrap_qty, scrap_rate, fg_qty=2, is_process_loss=1): + fg_item, bom_item, scrap_qty, scrap_rate, fg_qty=2, is_process_loss=1 +): bom_doc = frappe.new_doc("BOM") bom_doc.item = fg_item.item_code bom_doc.quantity = fg_qty - bom_doc.append("items", { - "item_code": bom_item.item_code, - "qty": 1, - "uom": bom_item.stock_uom, - "stock_uom": bom_item.stock_uom, - "rate": 100.0 - }) - bom_doc.append("scrap_items", { - "item_code": fg_item.item_code, - "qty": scrap_qty, - "stock_qty": scrap_qty, - "uom": fg_item.stock_uom, - "stock_uom": fg_item.stock_uom, - "rate": scrap_rate, - "is_process_loss": is_process_loss - }) + bom_doc.append( + "items", + { + "item_code": bom_item.item_code, + "qty": 1, + "uom": bom_item.stock_uom, + "stock_uom": bom_item.stock_uom, + "rate": 100.0, + }, + ) + bom_doc.append( + "scrap_items", + { + "item_code": fg_item.item_code, + "qty": scrap_qty, + "stock_qty": scrap_qty, + "uom": fg_item.stock_uom, + "stock_uom": fg_item.stock_uom, + "rate": scrap_rate, + "is_process_loss": is_process_loss, + }, + ) bom_doc.currency = "INR" return bom_doc + def create_process_loss_bom_items(): item_list = [ ("_Test Item - Non Whole UOM", "Kg"), ("_Test Item - Whole UOM", "Unit"), - ("_Test PL BOM Item", "Unit") + ("_Test PL BOM Item", "Unit"), ] return [create_process_loss_bom_item(it) for it in item_list] + def create_process_loss_bom_item(item_tuple): item_code, stock_uom = item_tuple if frappe.db.exists("Item", item_code) is None: - return make_item( - item_code, - {'stock_uom':stock_uom, 'valuation_rate':100} - ) + return make_item(item_code, {"stock_uom": stock_uom, "valuation_rate": 100}) else: return frappe.get_doc("Item", item_code) diff --git a/erpnext/manufacturing/doctype/bom/test_records.json b/erpnext/manufacturing/doctype/bom/test_records.json index 25730f9b9f4..a79ccfc8ce4 100644 --- a/erpnext/manufacturing/doctype/bom/test_records.json +++ b/erpnext/manufacturing/doctype/bom/test_records.json @@ -32,6 +32,7 @@ "is_active": 1, "is_default": 1, "item": "_Test Item Home Desktop Manufactured", + "company": "_Test Company", "quantity": 1.0 }, { @@ -161,5 +162,54 @@ "item": "_Test Variant Item", "quantity": 1.0, "with_operations": 1 + }, + { + "operations": [ + { + "operation": "_Test Operation 1", + "description": "_Test", + "workstation": "_Test Workstation 1", + "hour_rate": 100, + "time_in_mins": 60, + "operating_cost": 100 + } + ], + "items": [ + { + "amount": 5000.0, + "doctype": "BOM Item", + "item_code": "_Test Item", + "parentfield": "items", + "qty": 1.0, + "rate": 5000.0, + "uom": "_Test UOM", + "stock_uom": "_Test UOM", + "source_warehouse": "_Test Warehouse - _TC", + "include_item_in_manufacturing": 1 + }, + { + "amount": 3000.0, + "bom_no": "BOM-_Test Item Home Desktop Manufactured-001", + "doctype": "BOM Item", + "item_code": "_Test Item Home Desktop Manufactured", + "parentfield": "items", + "qty": 3.0, + "rate": 1000.0, + "uom": "_Test UOM", + "stock_uom": "_Test UOM", + "source_warehouse": "_Test Warehouse - _TC", + "include_item_in_manufacturing": 1 + } + ], + "docstatus": 1, + "doctype": "BOM", + "is_active": 1, + "is_default": 1, + "currency": "USD", + "conversion_rate": 60, + "company": "_Test Company", + "item": "_Test FG Item 3", + "quantity": 1.0, + "with_operations": 1 } ] diff --git a/erpnext/manufacturing/doctype/bom_explosion_item/bom_explosion_item.json b/erpnext/manufacturing/doctype/bom_explosion_item/bom_explosion_item.json index f01d856e72a..9b1db63494b 100644 --- a/erpnext/manufacturing/doctype/bom_explosion_item/bom_explosion_item.json +++ b/erpnext/manufacturing/doctype/bom_explosion_item/bom_explosion_item.json @@ -169,13 +169,15 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2020-10-08 16:21:29.386212", + "modified": "2022-05-27 13:42:23.305455", "modified_by": "Administrator", "module": "Manufacturing", "name": "BOM Explosion Item", + "naming_rule": "Random", "owner": "Administrator", "permissions": [], "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/bom_item/bom_item.json b/erpnext/manufacturing/doctype/bom_item/bom_item.json index 4c9877f52b2..33ca2d93d8f 100644 --- a/erpnext/manufacturing/doctype/bom_item/bom_item.json +++ b/erpnext/manufacturing/doctype/bom_item/bom_item.json @@ -10,6 +10,7 @@ "item_name", "operation", "column_break_3", + "do_not_explode", "bom_no", "source_warehouse", "allow_alternative_item", @@ -73,6 +74,7 @@ "fieldtype": "Column Break" }, { + "depends_on": "eval:!doc.do_not_explode", "fieldname": "bom_no", "fieldtype": "Link", "in_filter": 1, @@ -183,6 +185,7 @@ "in_list_view": 1, "label": "Rate", "options": "currency", + "read_only": 1, "reqd": 1 }, { @@ -284,18 +287,25 @@ "fieldname": "sourced_by_supplier", "fieldtype": "Check", "label": "Sourced by Supplier" + }, + { + "default": "0", + "fieldname": "do_not_explode", + "fieldtype": "Check", + "label": "Do Not Explode" } ], "idx": 1, "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2020-10-08 14:19:37.563300", + "modified": "2022-07-28 10:20:51.559010", "modified_by": "Administrator", "module": "Manufacturing", "name": "BOM Item", "owner": "Administrator", "permissions": [], "sort_field": "modified", - "sort_order": "DESC" + "sort_order": "DESC", + "states": [] } \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/bom_operation/bom_operation.json b/erpnext/manufacturing/doctype/bom_operation/bom_operation.json index ec617f3aaa9..6bd64594202 100644 --- a/erpnext/manufacturing/doctype/bom_operation/bom_operation.json +++ b/erpnext/manufacturing/doctype/bom_operation/bom_operation.json @@ -11,6 +11,7 @@ "col_break1", "workstation", "time_in_mins", + "fixed_time", "costing_section", "hour_rate", "base_hour_rate", @@ -65,7 +66,8 @@ "label": "Hour Rate", "oldfieldname": "hour_rate", "oldfieldtype": "Currency", - "options": "currency" + "options": "currency", + "precision": "2" }, { "description": "In minutes", @@ -79,6 +81,14 @@ "oldfieldtype": "Currency", "reqd": 1 }, + { + "default": "0", + "description": "Operation time does not depend on quantity to produce", + "fieldname": "fixed_time", + "fieldtype": "Check", + "in_list_view": 1, + "label": "Fixed Time" + }, { "fieldname": "operating_cost", "fieldtype": "Currency", @@ -99,7 +109,6 @@ "read_only": 1 }, { - "default": "5", "depends_on": "eval:parent.doctype == 'BOM'", "fieldname": "base_operating_cost", "fieldtype": "Currency", @@ -177,7 +186,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-09-13 16:45:01.092868", + "modified": "2022-08-22 01:18:33.547481", "modified_by": "Administrator", "module": "Manufacturing", "name": "BOM Operation", @@ -185,4 +194,4 @@ "permissions": [], "sort_field": "modified", "sort_order": "DESC" -} \ No newline at end of file +} diff --git a/erpnext/manufacturing/doctype/bom_update_batch/__init__.py b/erpnext/manufacturing/doctype/bom_update_batch/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/erpnext/manufacturing/doctype/bom_update_batch/bom_update_batch.json b/erpnext/manufacturing/doctype/bom_update_batch/bom_update_batch.json new file mode 100644 index 00000000000..d204e8e6de9 --- /dev/null +++ b/erpnext/manufacturing/doctype/bom_update_batch/bom_update_batch.json @@ -0,0 +1,54 @@ +{ + "actions": [], + "autoname": "hash", + "creation": "2022-05-31 17:34:39.825537", + "doctype": "DocType", + "engine": "InnoDB", + "field_order": [ + "level", + "batch_no", + "boms_updated", + "status" + ], + "fields": [ + { + "fieldname": "level", + "fieldtype": "Int", + "in_list_view": 1, + "label": "Level" + }, + { + "fieldname": "batch_no", + "fieldtype": "Int", + "in_list_view": 1, + "label": "Batch No." + }, + { + "fieldname": "boms_updated", + "fieldtype": "Long Text", + "hidden": 1, + "in_list_view": 1, + "label": "BOMs Updated" + }, + { + "fieldname": "status", + "fieldtype": "Select", + "in_list_view": 1, + "label": "Status", + "options": "Pending\nCompleted", + "read_only": 1 + } + ], + "index_web_pages_for_search": 1, + "istable": 1, + "links": [], + "modified": "2022-06-20 15:10:15.826571", + "modified_by": "Administrator", + "module": "Manufacturing", + "name": "BOM Update Batch", + "naming_rule": "Autoincrement", + "owner": "Administrator", + "permissions": [], + "sort_field": "modified", + "sort_order": "DESC" +} \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/bom_update_batch/bom_update_batch.py b/erpnext/manufacturing/doctype/bom_update_batch/bom_update_batch.py new file mode 100644 index 00000000000..f952e435e67 --- /dev/null +++ b/erpnext/manufacturing/doctype/bom_update_batch/bom_update_batch.py @@ -0,0 +1,9 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +# For license information, please see license.txt + +# import frappe +from frappe.model.document import Document + + +class BOMUpdateBatch(Document): + pass diff --git a/erpnext/manufacturing/doctype/bom_update_log/__init__.py b/erpnext/manufacturing/doctype/bom_update_log/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.js b/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.js new file mode 100644 index 00000000000..6da808e26d1 --- /dev/null +++ b/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.js @@ -0,0 +1,8 @@ +// Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +// For license information, please see license.txt + +frappe.ui.form.on('BOM Update Log', { + // refresh: function(frm) { + + // } +}); diff --git a/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.json b/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.json new file mode 100644 index 00000000000..a926e69ee69 --- /dev/null +++ b/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.json @@ -0,0 +1,138 @@ +{ + "actions": [], + "autoname": "BOM-UPDT-LOG-.#####", + "creation": "2022-03-16 14:23:35.210155", + "description": "BOM Update Tool Log with job status maintained", + "doctype": "DocType", + "editable_grid": 1, + "engine": "InnoDB", + "field_order": [ + "update_type", + "status", + "column_break_3", + "current_bom", + "new_bom", + "error_log", + "progress_section", + "current_level", + "processed_boms", + "bom_batches", + "amended_from" + ], + "fields": [ + { + "fieldname": "current_bom", + "fieldtype": "Link", + "in_list_view": 1, + "in_standard_filter": 1, + "label": "Current BOM", + "options": "BOM" + }, + { + "fieldname": "new_bom", + "fieldtype": "Link", + "in_list_view": 1, + "in_standard_filter": 1, + "label": "New BOM", + "options": "BOM" + }, + { + "depends_on": "eval:doc.update_type === \"Replace BOM\"", + "fieldname": "column_break_3", + "fieldtype": "Column Break" + }, + { + "fieldname": "update_type", + "fieldtype": "Select", + "in_list_view": 1, + "label": "Update Type", + "options": "Replace BOM\nUpdate Cost" + }, + { + "fieldname": "status", + "fieldtype": "Select", + "label": "Status", + "options": "Queued\nIn Progress\nCompleted\nFailed" + }, + { + "fieldname": "amended_from", + "fieldtype": "Link", + "label": "Amended From", + "no_copy": 1, + "options": "BOM Update Log", + "print_hide": 1, + "read_only": 1 + }, + { + "fieldname": "error_log", + "fieldtype": "Link", + "label": "Error Log", + "options": "Error Log" + }, + { + "collapsible": 1, + "depends_on": "eval: doc.update_type == \"Update Cost\"", + "fieldname": "progress_section", + "fieldtype": "Section Break", + "label": "Progress" + }, + { + "fieldname": "processed_boms", + "fieldtype": "Long Text", + "hidden": 1, + "label": "Processed BOMs" + }, + { + "fieldname": "bom_batches", + "fieldtype": "Table", + "options": "BOM Update Batch" + }, + { + "depends_on": "eval:doc.status !== \"Completed\"", + "fieldname": "current_level", + "fieldtype": "Int", + "label": "Current Level" + } + ], + "in_create": 1, + "index_web_pages_for_search": 1, + "is_submittable": 1, + "links": [], + "modified": "2022-06-20 15:43:55.696388", + "modified_by": "Administrator", + "module": "Manufacturing", + "name": "BOM Update Log", + "naming_rule": "Expression (old style)", + "owner": "Administrator", + "permissions": [ + { + "create": 1, + "delete": 1, + "email": 1, + "export": 1, + "print": 1, + "read": 1, + "report": 1, + "role": "System Manager", + "share": 1, + "submit": 1, + "write": 1 + }, + { + "create": 1, + "email": 1, + "export": 1, + "print": 1, + "read": 1, + "report": 1, + "role": "Manufacturing Manager", + "share": 1, + "submit": 1, + "write": 1 + } + ], + "sort_field": "modified", + "sort_order": "DESC", + "states": [], + "track_changes": 1 +} \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.py b/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.py new file mode 100644 index 00000000000..af5ff8e1c21 --- /dev/null +++ b/erpnext/manufacturing/doctype/bom_update_log/bom_update_log.py @@ -0,0 +1,247 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +# For license information, please see license.txt +import json +from typing import Any, Dict, List, Optional, Tuple, Union + +import frappe +from frappe import _ +from frappe.model.document import Document +from frappe.utils import cint, cstr + +from erpnext.manufacturing.doctype.bom_update_log.bom_updation_utils import ( + get_leaf_boms, + get_next_higher_level_boms, + handle_exception, + replace_bom, + set_values_in_log, +) + + +class BOMMissingError(frappe.ValidationError): + pass + + +class BOMUpdateLog(Document): + def validate(self): + if self.update_type == "Replace BOM": + self.validate_boms_are_specified() + self.validate_same_bom() + self.validate_bom_items() + else: + self.validate_bom_cost_update_in_progress() + + self.status = "Queued" + + def validate_boms_are_specified(self): + if self.update_type == "Replace BOM" and not (self.current_bom and self.new_bom): + frappe.throw( + msg=_("Please mention the Current and New BOM for replacement."), + title=_("Mandatory"), + exc=BOMMissingError, + ) + + def validate_same_bom(self): + if cstr(self.current_bom) == cstr(self.new_bom): + frappe.throw(_("Current BOM and New BOM can not be same")) + + def validate_bom_items(self): + current_bom_item = frappe.db.get_value("BOM", self.current_bom, "item") + new_bom_item = frappe.db.get_value("BOM", self.new_bom, "item") + + if current_bom_item != new_bom_item: + frappe.throw(_("The selected BOMs are not for the same item")) + + def validate_bom_cost_update_in_progress(self): + "If another Cost Updation Log is still in progress, dont make new ones." + + wip_log = frappe.get_all( + "BOM Update Log", + {"update_type": "Update Cost", "status": ["in", ["Queued", "In Progress"]]}, + limit_page_length=1, + ) + if wip_log: + log_link = frappe.utils.get_link_to_form("BOM Update Log", wip_log[0].name) + frappe.throw( + _("BOM Updation already in progress. Please wait until {0} is complete.").format(log_link), + title=_("Note"), + ) + + def on_submit(self): + if self.update_type == "Replace BOM": + boms = {"current_bom": self.current_bom, "new_bom": self.new_bom} + frappe.enqueue( + method="erpnext.manufacturing.doctype.bom_update_log.bom_update_log.run_replace_bom_job", + doc=self, + boms=boms, + timeout=40000, + now=frappe.flags.in_test, + ) + else: + frappe.enqueue( + method="erpnext.manufacturing.doctype.bom_update_log.bom_update_log.process_boms_cost_level_wise", + update_doc=self, + now=frappe.flags.in_test, + ) + + +def run_replace_bom_job( + doc: "BOMUpdateLog", + boms: Optional[Dict[str, str]] = None, +) -> None: + try: + doc.db_set("status", "In Progress") + + if not frappe.flags.in_test: + frappe.db.commit() + + frappe.db.auto_commit_on_many_writes = 1 + boms = frappe._dict(boms or {}) + replace_bom(boms, doc.name) + + doc.db_set("status", "Completed") + except Exception: + handle_exception(doc) + finally: + frappe.db.auto_commit_on_many_writes = 0 + + if not frappe.flags.in_test: + frappe.db.commit() # nosemgrep + + +def process_boms_cost_level_wise( + update_doc: "BOMUpdateLog", parent_boms: List[str] = None +) -> Union[None, Tuple]: + "Queue jobs at the start of new BOM Level in 'Update Cost' Jobs." + + current_boms = {} + values = {} + + try: + if update_doc.status == "Queued": + # First level yet to process. On Submit. + current_level = 0 + current_boms = get_leaf_boms() + values = { + "processed_boms": json.dumps({}), + "status": "In Progress", + "current_level": current_level, + } + else: + # Resume next level. via Cron Job. + if not parent_boms: + return + + current_level = cint(update_doc.current_level) + 1 + + # Process the next level BOMs. Stage parents as current BOMs. + current_boms = parent_boms.copy() + values = {"current_level": current_level} + + set_values_in_log(update_doc.name, values, commit=True) + queue_bom_cost_jobs(current_boms, update_doc, current_level) + except Exception: + handle_exception(update_doc) + + +def queue_bom_cost_jobs( + current_boms_list: List[str], update_doc: "BOMUpdateLog", current_level: int +) -> None: + "Queue batches of 20k BOMs of the same level to process parallelly" + batch_no = 0 + + while current_boms_list: + batch_no += 1 + batch_size = 20_000 + boms_to_process = current_boms_list[:batch_size] # slice out batch of 20k BOMs + + # update list to exclude 20K (queued) BOMs + current_boms_list = current_boms_list[batch_size:] if len(current_boms_list) > batch_size else [] + + batch_row = update_doc.append( + "bom_batches", {"level": current_level, "batch_no": batch_no, "status": "Pending"} + ) + batch_row.db_insert() + + frappe.enqueue( + method="erpnext.manufacturing.doctype.bom_update_log.bom_updation_utils.update_cost_in_level", + doc=update_doc, + bom_list=boms_to_process, + batch_name=batch_row.name, + queue="long", + now=frappe.flags.in_test, + ) + + +def resume_bom_cost_update_jobs(): + """ + 1. Checks for In Progress BOM Update Log. + 2. Checks if this job has completed the _current level_. + 3. If current level is complete, get parent BOMs and start next level. + 4. If no parents, mark as Complete. + 5. If current level is WIP, skip the Log. + + Called every 5 minutes via Cron job. + """ + + in_progress_logs = frappe.db.get_all( + "BOM Update Log", + {"update_type": "Update Cost", "status": "In Progress"}, + ["name", "processed_boms", "current_level"], + ) + if not in_progress_logs: + return + + for log in in_progress_logs: + # check if all log batches of current level are processed + bom_batches = frappe.db.get_all( + "BOM Update Batch", + {"parent": log.name, "level": log.current_level}, + ["name", "boms_updated", "status"], + ) + incomplete_level = any(row.get("status") == "Pending" for row in bom_batches) + if not bom_batches or incomplete_level: + continue + + # Prep parent BOMs & updated processed BOMs for next level + current_boms, processed_boms = get_processed_current_boms(log, bom_batches) + parent_boms = get_next_higher_level_boms(child_boms=current_boms, processed_boms=processed_boms) + + # Unset processed BOMs (it is used for next level BOMs) & change status if log is complete + status = "Completed" if not parent_boms else "In Progress" + processed_boms = json.dumps([] if not parent_boms else processed_boms) + set_values_in_log( + log.name, + values={ + "processed_boms": processed_boms, + "status": status, + }, + commit=True, + ) + + # clear progress section + if status == "Completed": + frappe.db.delete("BOM Update Batch", {"parent": log.name}) + + if parent_boms: # there is a next level to process + process_boms_cost_level_wise( + update_doc=frappe.get_doc("BOM Update Log", log.name), parent_boms=parent_boms + ) + + +def get_processed_current_boms( + log: Dict[str, Any], bom_batches: Dict[str, Any] +) -> Tuple[List[str], Dict[str, Any]]: + """ + Aggregate all BOMs from BOM Update Batch rows into 'processed_boms' field + and into current boms list. + """ + processed_boms = json.loads(log.processed_boms) if log.processed_boms else {} + current_boms = [] + + for row in bom_batches: + boms_updated = json.loads(row.boms_updated) + current_boms.extend(boms_updated) + boms_updated_dict = {bom: True for bom in boms_updated} + processed_boms.update(boms_updated_dict) + + return current_boms, processed_boms diff --git a/erpnext/manufacturing/doctype/bom_update_log/bom_update_log_list.js b/erpnext/manufacturing/doctype/bom_update_log/bom_update_log_list.js new file mode 100644 index 00000000000..e39b5637c78 --- /dev/null +++ b/erpnext/manufacturing/doctype/bom_update_log/bom_update_log_list.js @@ -0,0 +1,13 @@ +frappe.listview_settings['BOM Update Log'] = { + add_fields: ["status"], + get_indicator: function(doc) { + let status_map = { + "Queued": "orange", + "In Progress": "blue", + "Completed": "green", + "Failed": "red" + }; + + return [__(doc.status), status_map[doc.status], "status,=," + doc.status]; + } +}; \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/bom_update_log/bom_updation_utils.py b/erpnext/manufacturing/doctype/bom_update_log/bom_updation_utils.py new file mode 100644 index 00000000000..3d52cd811bb --- /dev/null +++ b/erpnext/manufacturing/doctype/bom_update_log/bom_updation_utils.py @@ -0,0 +1,225 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +# For license information, please see license.txt + +import copy +import json +from collections import defaultdict +from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union + +if TYPE_CHECKING: + from erpnext.manufacturing.doctype.bom_update_log.bom_update_log import BOMUpdateLog + +import frappe +from frappe import _ + + +def replace_bom(boms: Dict, log_name: str) -> None: + "Replace current BOM with new BOM in parent BOMs." + + current_bom = boms.get("current_bom") + new_bom = boms.get("new_bom") + + unit_cost = get_bom_unit_cost(new_bom) + update_new_bom_in_bom_items(unit_cost, current_bom, new_bom) + + frappe.cache().delete_key("bom_children") + parent_boms = get_ancestor_boms(new_bom) + + for bom in parent_boms: + bom_obj = frappe.get_doc("BOM", bom) + # this is only used for versioning and we do not want + # to make separate db calls by using load_doc_before_save + # which proves to be expensive while doing bulk replace + bom_obj._doc_before_save = copy.deepcopy(bom_obj) + bom_obj.update_exploded_items() + bom_obj.calculate_cost() + bom_obj.update_parent_cost() + bom_obj.db_update() + bom_obj.flags.updater_reference = { + "doctype": "BOM Update Log", + "docname": log_name, + "label": _("via BOM Update Tool"), + } + bom_obj.save_version() + + +def update_cost_in_level( + doc: "BOMUpdateLog", bom_list: List[str], batch_name: Union[int, str] +) -> None: + "Updates Cost for BOMs within a given level. Runs via background jobs." + + try: + status = frappe.db.get_value("BOM Update Log", doc.name, "status") + if status == "Failed": + return + + update_cost_in_boms(bom_list=bom_list) # main updation logic + + bom_batch = frappe.qb.DocType("BOM Update Batch") + ( + frappe.qb.update(bom_batch) + .set(bom_batch.boms_updated, json.dumps(bom_list)) + .set(bom_batch.status, "Completed") + .where(bom_batch.name == batch_name) + ).run() + except Exception: + handle_exception(doc) + finally: + if not frappe.flags.in_test: + frappe.db.commit() # nosemgrep + + +def get_ancestor_boms(new_bom: str, bom_list: Optional[List] = None) -> List: + "Recursively get all ancestors of BOM." + + bom_list = bom_list or [] + bom_item = frappe.qb.DocType("BOM Item") + + parents = ( + frappe.qb.from_(bom_item) + .select(bom_item.parent) + .where((bom_item.bom_no == new_bom) & (bom_item.docstatus < 2) & (bom_item.parenttype == "BOM")) + .run(as_dict=True) + ) + + for d in parents: + if new_bom == d.parent: + frappe.throw(_("BOM recursion: {0} cannot be child of {1}").format(new_bom, d.parent)) + + bom_list.append(d.parent) + get_ancestor_boms(d.parent, bom_list) + + return list(set(bom_list)) + + +def update_new_bom_in_bom_items(unit_cost: float, current_bom: str, new_bom: str) -> None: + bom_item = frappe.qb.DocType("BOM Item") + ( + frappe.qb.update(bom_item) + .set(bom_item.bom_no, new_bom) + .set(bom_item.rate, unit_cost) + .set(bom_item.amount, (bom_item.stock_qty * unit_cost)) + .where( + (bom_item.bom_no == current_bom) & (bom_item.docstatus < 2) & (bom_item.parenttype == "BOM") + ) + ).run() + + +def get_bom_unit_cost(bom_name: str) -> float: + bom = frappe.qb.DocType("BOM") + new_bom_unitcost = ( + frappe.qb.from_(bom).select(bom.total_cost / bom.quantity).where(bom.name == bom_name).run() + ) + + return frappe.utils.flt(new_bom_unitcost[0][0]) + + +def update_cost_in_boms(bom_list: List[str]) -> None: + "Updates cost in given BOMs. Returns current and total updated BOMs." + + for index, bom in enumerate(bom_list): + bom_doc = frappe.get_doc("BOM", bom, for_update=True) + bom_doc.calculate_cost(save_updates=True, update_hour_rate=True) + bom_doc.db_update() + + if (index % 50 == 0) and not frappe.flags.in_test: + frappe.db.commit() # nosemgrep + + +def get_next_higher_level_boms( + child_boms: List[str], processed_boms: Dict[str, bool] +) -> List[str]: + "Generate immediate higher level dependants with no unresolved dependencies (children)." + + def _all_children_are_processed(parent_bom): + child_boms = dependency_map.get(parent_bom) + return all(processed_boms.get(bom) for bom in child_boms) + + dependants_map, dependency_map = _generate_dependence_map() + + dependants = [] + for bom in child_boms: + # generate list of immediate dependants + parents = dependants_map.get(bom) or [] + dependants.extend(parents) + + dependants = set(dependants) # remove duplicates + resolved_dependants = set() + + # consider only if children are all resolved + for parent_bom in dependants: + if _all_children_are_processed(parent_bom): + resolved_dependants.add(parent_bom) + + return list(resolved_dependants) + + +def get_leaf_boms() -> List[str]: + "Get BOMs that have no dependencies." + + return frappe.db.sql_list( + """select name from `tabBOM` bom + where docstatus=1 and is_active=1 + and not exists(select bom_no from `tabBOM Item` + where parent=bom.name and ifnull(bom_no, '')!='')""" + ) + + +def _generate_dependence_map() -> defaultdict: + """ + Generate maps such as: { BOM-1: [Dependant-BOM-1, Dependant-BOM-2, ..] }. + Here BOM-1 is the leaf/lower level node/dependency. + The list contains one level higher nodes/dependants that depend on BOM-1. + + Generate and return the reverse as well. + """ + + bom = frappe.qb.DocType("BOM") + bom_item = frappe.qb.DocType("BOM Item") + + bom_items = ( + frappe.qb.from_(bom_item) + .join(bom) + .on(bom_item.parent == bom.name) + .select(bom_item.bom_no, bom_item.parent) + .where( + (bom_item.bom_no.isnotnull()) + & (bom_item.bom_no != "") + & (bom.docstatus == 1) + & (bom.is_active == 1) + & (bom_item.parenttype == "BOM") + ) + ).run(as_dict=True) + + child_parent_map = defaultdict(list) + parent_child_map = defaultdict(list) + for row in bom_items: + child_parent_map[row.bom_no].append(row.parent) + parent_child_map[row.parent].append(row.bom_no) + + return child_parent_map, parent_child_map + + +def set_values_in_log(log_name: str, values: Dict[str, Any], commit: bool = False) -> None: + "Update BOM Update Log record." + + if not values: + return + + bom_update_log = frappe.qb.DocType("BOM Update Log") + query = frappe.qb.update(bom_update_log).where(bom_update_log.name == log_name) + + for key, value in values.items(): + query = query.set(key, value) + query.run() + + if commit and not frappe.flags.in_test: + frappe.db.commit() # nosemgrep + + +def handle_exception(doc: "BOMUpdateLog") -> None: + "Rolls back and fails BOM Update Log." + + frappe.db.rollback() + error_log = frappe.log_error(title=_("BOM Update Tool Error")) + set_values_in_log(doc.name, {"status": "Failed", "error_log": error_log.name}) diff --git a/erpnext/manufacturing/doctype/bom_update_log/test_bom_update_log.py b/erpnext/manufacturing/doctype/bom_update_log/test_bom_update_log.py new file mode 100644 index 00000000000..b38fc8976b2 --- /dev/null +++ b/erpnext/manufacturing/doctype/bom_update_log/test_bom_update_log.py @@ -0,0 +1,71 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors +# See license.txt + +import frappe +from frappe.tests.utils import FrappeTestCase + +from erpnext.manufacturing.doctype.bom_update_log.bom_update_log import ( + BOMMissingError, + resume_bom_cost_update_jobs, +) +from erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool import ( + enqueue_replace_bom, + enqueue_update_cost, +) + +test_records = frappe.get_test_records("BOM") + + +class TestBOMUpdateLog(FrappeTestCase): + "Test BOM Update Tool Operations via BOM Update Log." + + def setUp(self): + bom_doc = frappe.copy_doc(test_records[0]) + bom_doc.items[1].item_code = "_Test Item" + bom_doc.insert() + + self.boms = frappe._dict( + current_bom="BOM-_Test Item Home Desktop Manufactured-001", + new_bom=bom_doc.name, + ) + + self.new_bom_doc = bom_doc + + def tearDown(self): + frappe.db.rollback() + + def test_bom_update_log_validate(self): + """ + 1) Test if BOM presence is validated. + 2) Test if same BOMs are validated. + 3) Test of non-existent BOM is validated. + """ + + with self.assertRaises(BOMMissingError): + enqueue_replace_bom(boms={}) + + with self.assertRaises(frappe.ValidationError): + enqueue_replace_bom(boms=frappe._dict(current_bom=self.boms.new_bom, new_bom=self.boms.new_bom)) + + with self.assertRaises(frappe.ValidationError): + enqueue_replace_bom(boms=frappe._dict(current_bom=self.boms.new_bom, new_bom="Dummy BOM")) + + def test_bom_update_log_completion(self): + "Test if BOM Update Log handles job completion correctly." + + log = enqueue_replace_bom(boms=self.boms) + log.reload() + self.assertEqual(log.status, "Completed") + + +def update_cost_in_all_boms_in_test(): + """ + Utility to run 'Update Cost' job in tests without Cron job until fully complete. + """ + log = enqueue_update_cost() # create BOM Update Log + + while log.status != "Completed": + resume_bom_cost_update_jobs() # run cron job until complete + log.reload() + + return log diff --git a/erpnext/manufacturing/doctype/bom_update_tool/bom_update_tool.js b/erpnext/manufacturing/doctype/bom_update_tool/bom_update_tool.js index bf5fe2e18de..7ba6517a4fb 100644 --- a/erpnext/manufacturing/doctype/bom_update_tool/bom_update_tool.js +++ b/erpnext/manufacturing/doctype/bom_update_tool/bom_update_tool.js @@ -20,30 +20,67 @@ frappe.ui.form.on('BOM Update Tool', { refresh: function(frm) { frm.disable_save(); + frm.events.disable_button(frm, "replace"); + + frm.add_custom_button(__("View BOM Update Log"), () => { + frappe.set_route("List", "BOM Update Log"); + }); }, - replace: function(frm) { + disable_button: (frm, field, disable=true) => { + frm.get_field(field).input.disabled = disable; + }, + + current_bom: (frm) => { + if (frm.doc.current_bom && frm.doc.new_bom) { + frm.events.disable_button(frm, "replace", false); + } + }, + + new_bom: (frm) => { + if (frm.doc.current_bom && frm.doc.new_bom) { + frm.events.disable_button(frm, "replace", false); + } + }, + + replace: (frm) => { if (frm.doc.current_bom && frm.doc.new_bom) { frappe.call({ method: "erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool.enqueue_replace_bom", freeze: true, args: { - args: { + boms: { "current_bom": frm.doc.current_bom, "new_bom": frm.doc.new_bom } + }, + callback: result => { + if (result && result.message && !result.exc) { + frm.events.confirm_job_start(frm, result.message); + } } }); } }, - update_latest_price_in_all_boms: function() { + update_latest_price_in_all_boms: (frm) => { frappe.call({ method: "erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool.enqueue_update_cost", freeze: true, - callback: function() { - frappe.msgprint(__("Latest price updated in all BOMs")); + callback: result => { + if (result && result.message && !result.exc) { + frm.events.confirm_job_start(frm, result.message); + } } }); + }, + + confirm_job_start: (frm, log_data) => { + let log_link = frappe.utils.get_form_link("BOM Update Log", log_data.name, true); + frappe.msgprint({ + "message": __("BOM Updation is queued and may take a few minutes. Check {0} for progress.", [log_link]), + "title": __("BOM Update Initiated"), + "indicator": "blue" + }); } }); diff --git a/erpnext/manufacturing/doctype/bom_update_tool/bom_update_tool.py b/erpnext/manufacturing/doctype/bom_update_tool/bom_update_tool.py index f9c3b062179..974d0c3439b 100644 --- a/erpnext/manufacturing/doctype/bom_update_tool/bom_update_tool.py +++ b/erpnext/manufacturing/doctype/bom_update_tool/bom_update_tool.py @@ -1,114 +1,68 @@ -# Copyright (c) 2017, Frappe Technologies Pvt. Ltd. and contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors # For license information, please see license.txt - import json +from typing import TYPE_CHECKING, Dict, Optional, Union + +from typing_extensions import Literal + +if TYPE_CHECKING: + from erpnext.manufacturing.doctype.bom_update_log.bom_update_log import BOMUpdateLog -import click import frappe -from frappe import _ from frappe.model.document import Document -from frappe.utils import cstr, flt -from six import string_types - -from erpnext.manufacturing.doctype.bom.bom import get_boms_in_bottom_up_order class BOMUpdateTool(Document): - def replace_bom(self): - self.validate_bom() + pass - unit_cost = get_new_bom_unit_cost(self.new_bom) - self.update_new_bom(unit_cost) - - frappe.cache().delete_key('bom_children') - bom_list = self.get_parent_boms(self.new_bom) - - with click.progressbar(bom_list) as bom_list: - pass - for bom in bom_list: - try: - bom_obj = frappe.get_cached_doc('BOM', bom) - # this is only used for versioning and we do not want - # to make separate db calls by using load_doc_before_save - # which proves to be expensive while doing bulk replace - bom_obj._doc_before_save = bom_obj - bom_obj.update_new_bom(self.current_bom, self.new_bom, unit_cost) - bom_obj.update_exploded_items() - bom_obj.calculate_cost() - bom_obj.update_parent_cost() - bom_obj.db_update() - if bom_obj.meta.get('track_changes') and not bom_obj.flags.ignore_version: - bom_obj.save_version() - except Exception: - frappe.log_error(frappe.get_traceback()) - - def validate_bom(self): - if cstr(self.current_bom) == cstr(self.new_bom): - frappe.throw(_("Current BOM and New BOM can not be same")) - - if frappe.db.get_value("BOM", self.current_bom, "item") \ - != frappe.db.get_value("BOM", self.new_bom, "item"): - frappe.throw(_("The selected BOMs are not for the same item")) - - def update_new_bom(self, unit_cost): - frappe.db.sql("""update `tabBOM Item` set bom_no=%s, - rate=%s, amount=stock_qty*%s where bom_no = %s and docstatus < 2 and parenttype='BOM'""", - (self.new_bom, unit_cost, unit_cost, self.current_bom)) - - def get_parent_boms(self, bom, bom_list=None): - if bom_list is None: - bom_list = [] - data = frappe.db.sql("""SELECT DISTINCT parent FROM `tabBOM Item` - WHERE bom_no = %s AND docstatus < 2 AND parenttype='BOM'""", bom) - - for d in data: - if self.new_bom == d[0]: - frappe.throw(_("BOM recursion: {0} cannot be child of {1}").format(bom, self.new_bom)) - - bom_list.append(d[0]) - self.get_parent_boms(d[0], bom_list) - - return list(set(bom_list)) - -def get_new_bom_unit_cost(bom): - new_bom_unitcost = frappe.db.sql("""SELECT `total_cost`/`quantity` - FROM `tabBOM` WHERE name = %s""", bom) - - return flt(new_bom_unitcost[0][0]) if new_bom_unitcost else 0 @frappe.whitelist() -def enqueue_replace_bom(args): - if isinstance(args, string_types): - args = json.loads(args) +def enqueue_replace_bom( + boms: Optional[Union[Dict, str]] = None, args: Optional[Union[Dict, str]] = None +) -> "BOMUpdateLog": + """Returns a BOM Update Log (that queues a job) for BOM Replacement.""" + boms = boms or args + if isinstance(boms, str): + boms = json.loads(boms) + + update_log = create_bom_update_log(boms=boms) + return update_log - frappe.enqueue("erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool.replace_bom", args=args, timeout=40000) - frappe.msgprint(_("Queued for replacing the BOM. It may take a few minutes.")) @frappe.whitelist() -def enqueue_update_cost(): - frappe.enqueue("erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool.update_cost", timeout=40000) - frappe.msgprint(_("Queued for updating latest price in all Bill of Materials. It may take a few minutes.")) +def enqueue_update_cost() -> "BOMUpdateLog": + """Returns a BOM Update Log (that queues a job) for BOM Cost Updation.""" + update_log = create_bom_update_log(update_type="Update Cost") + return update_log -def update_latest_price_in_all_boms(): + +def auto_update_latest_price_in_all_boms() -> None: + """Called via hooks.py.""" if frappe.db.get_single_value("Manufacturing Settings", "update_bom_costs_automatically"): - update_cost() + wip_log = frappe.get_all( + "BOM Update Log", + {"update_type": "Update Cost", "status": ["in", ["Queued", "In Progress"]]}, + limit_page_length=1, + ) + if not wip_log: + create_bom_update_log(update_type="Update Cost") -def replace_bom(args): - frappe.db.auto_commit_on_many_writes = 1 - args = frappe._dict(args) - doc = frappe.get_doc("BOM Update Tool") - doc.current_bom = args.current_bom - doc.new_bom = args.new_bom - doc.replace_bom() +def create_bom_update_log( + boms: Optional[Dict[str, str]] = None, + update_type: Literal["Replace BOM", "Update Cost"] = "Replace BOM", +) -> "BOMUpdateLog": + """Creates a BOM Update Log that handles the background job.""" - frappe.db.auto_commit_on_many_writes = 0 - -def update_cost(): - frappe.db.auto_commit_on_many_writes = 1 - bom_list = get_boms_in_bottom_up_order() - for bom in bom_list: - frappe.get_doc("BOM", bom).update_cost(update_parent=False, from_child_bom=True) - - frappe.db.auto_commit_on_many_writes = 0 + boms = boms or {} + current_bom = boms.get("current_bom") + new_bom = boms.get("new_bom") + return frappe.get_doc( + { + "doctype": "BOM Update Log", + "current_bom": current_bom, + "new_bom": new_bom, + "update_type": update_type, + } + ).submit() diff --git a/erpnext/manufacturing/doctype/bom_update_tool/test_bom_update_tool.py b/erpnext/manufacturing/doctype/bom_update_tool/test_bom_update_tool.py index 526c243ed78..5dd557f8ab1 100644 --- a/erpnext/manufacturing/doctype/bom_update_tool/test_bom_update_tool.py +++ b/erpnext/manufacturing/doctype/bom_update_tool/test_bom_update_tool.py @@ -1,19 +1,25 @@ -# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt - - -import unittest - import frappe +from frappe.tests.utils import FrappeTestCase -from erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool import update_cost +from erpnext.manufacturing.doctype.bom_update_log.test_bom_update_log import ( + update_cost_in_all_boms_in_test, +) +from erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool import enqueue_replace_bom from erpnext.manufacturing.doctype.production_plan.test_production_plan import make_bom from erpnext.stock.doctype.item.test_item import create_item -test_records = frappe.get_test_records('BOM') +test_records = frappe.get_test_records("BOM") + + +class TestBOMUpdateTool(FrappeTestCase): + "Test major functions run via BOM Update Tool." + + def tearDown(self): + frappe.db.rollback() -class TestBOMUpdateTool(unittest.TestCase): def test_replace_bom(self): current_bom = "BOM-_Test Item Home Desktop Manufactured-001" @@ -21,18 +27,11 @@ class TestBOMUpdateTool(unittest.TestCase): bom_doc.items[1].item_code = "_Test Item" bom_doc.insert() - update_tool = frappe.get_doc("BOM Update Tool") - update_tool.current_bom = current_bom - update_tool.new_bom = bom_doc.name - update_tool.replace_bom() + boms = frappe._dict(current_bom=current_bom, new_bom=bom_doc.name) + enqueue_replace_bom(boms=boms) - self.assertFalse(frappe.db.sql("select name from `tabBOM Item` where bom_no=%s", current_bom)) - self.assertTrue(frappe.db.sql("select name from `tabBOM Item` where bom_no=%s", bom_doc.name)) - - # reverse, as it affects other testcases - update_tool.current_bom = bom_doc.name - update_tool.new_bom = current_bom - update_tool.replace_bom() + self.assertFalse(frappe.db.exists("BOM Item", {"bom_no": current_bom, "docstatus": 1})) + self.assertTrue(frappe.db.exists("BOM Item", {"bom_no": bom_doc.name, "docstatus": 1})) def test_bom_cost(self): for item in ["BOM Cost Test Item 1", "BOM Cost Test Item 2", "BOM Cost Test Item 3"]: @@ -40,23 +39,26 @@ class TestBOMUpdateTool(unittest.TestCase): if item_doc.valuation_rate != 100.00: frappe.db.set_value("Item", item_doc.name, "valuation_rate", 100) - bom_no = frappe.db.get_value('BOM', {'item': 'BOM Cost Test Item 1'}, "name") + bom_no = frappe.db.get_value("BOM", {"item": "BOM Cost Test Item 1"}, "name") if not bom_no: - doc = make_bom(item = 'BOM Cost Test Item 1', - raw_materials =['BOM Cost Test Item 2', 'BOM Cost Test Item 3'], currency="INR") + doc = make_bom( + item="BOM Cost Test Item 1", + raw_materials=["BOM Cost Test Item 2", "BOM Cost Test Item 3"], + currency="INR", + ) else: doc = frappe.get_doc("BOM", bom_no) self.assertEqual(doc.total_cost, 200) frappe.db.set_value("Item", "BOM Cost Test Item 2", "valuation_rate", 200) - update_cost() + update_cost_in_all_boms_in_test() doc.load_from_db() self.assertEqual(doc.total_cost, 300) frappe.db.set_value("Item", "BOM Cost Test Item 2", "valuation_rate", 100) - update_cost() + update_cost_in_all_boms_in_test() doc.load_from_db() self.assertEqual(doc.total_cost, 200) diff --git a/erpnext/manufacturing/doctype/job_card/job_card.js b/erpnext/manufacturing/doctype/job_card/job_card.js index bb258812b21..20bbbeaa8ea 100644 --- a/erpnext/manufacturing/doctype/job_card/job_card.js +++ b/erpnext/manufacturing/doctype/job_card/job_card.js @@ -28,12 +28,12 @@ frappe.ui.form.on('Job Card', { frappe.flags.resume_job = 0; let has_items = frm.doc.items && frm.doc.items.length; - if (frm.doc.__onload.work_order_stopped) { + if (!frm.is_new() && frm.doc.__onload.work_order_stopped) { frm.disable_save(); return; } - if (!frm.doc.__islocal && has_items && frm.doc.docstatus < 2) { + if (!frm.is_new() && has_items && frm.doc.docstatus < 2) { let to_request = frm.doc.for_quantity > frm.doc.transferred_qty; let excess_transfer_allowed = frm.doc.__onload.job_card_excess_transfer; @@ -73,9 +73,29 @@ frappe.ui.form.on('Job Card', { if (frm.doc.docstatus == 0 && !frm.is_new() && (frm.doc.for_quantity > frm.doc.total_completed_qty || !frm.doc.for_quantity) && (frm.doc.items || !frm.doc.items.length || frm.doc.for_quantity == frm.doc.transferred_qty)) { - frm.trigger("prepare_timer_buttons"); + + // if Job Card is link to Work Order, the job card must not be able to start if Work Order not "Started" + // and if stock mvt for WIP is required + if (frm.doc.work_order) { + frappe.db.get_value('Work Order', frm.doc.work_order, ['skip_transfer', 'status'], (result) => { + if (result.skip_transfer === 1 || result.status == 'In Process') { + frm.trigger("prepare_timer_buttons"); + } + }); + } else { + frm.trigger("prepare_timer_buttons"); + } } frm.trigger("setup_quality_inspection"); + + if (frm.doc.work_order) { + frappe.db.get_value('Work Order', frm.doc.work_order, + 'transfer_material_against').then((r) => { + if (r.message.transfer_material_against == 'Work Order') { + frm.set_df_property('items', 'hidden', 1); + } + }); + } }, setup_quality_inspection: function(frm) { diff --git a/erpnext/manufacturing/doctype/job_card/job_card.py b/erpnext/manufacturing/doctype/job_card/job_card.py index e6090ba02a2..c24d07d2194 100644 --- a/erpnext/manufacturing/doctype/job_card/job_card.py +++ b/erpnext/manufacturing/doctype/job_card/job_card.py @@ -26,15 +26,31 @@ from erpnext.manufacturing.doctype.manufacturing_settings.manufacturing_settings ) -class OverlapError(frappe.ValidationError): pass +class OverlapError(frappe.ValidationError): + pass + + +class OperationMismatchError(frappe.ValidationError): + pass + + +class OperationSequenceError(frappe.ValidationError): + pass + + +class JobCardCancelError(frappe.ValidationError): + pass + + +class JobCardOverTransferError(frappe.ValidationError): + pass -class OperationMismatchError(frappe.ValidationError): pass -class OperationSequenceError(frappe.ValidationError): pass -class JobCardCancelError(frappe.ValidationError): pass class JobCard(Document): def onload(self): - excess_transfer = frappe.db.get_single_value("Manufacturing Settings", "job_card_excess_transfer") + excess_transfer = frappe.db.get_single_value( + "Manufacturing Settings", "job_card_excess_transfer" + ) self.set_onload("job_card_excess_transfer", excess_transfer) self.set_onload("work_order_stopped", self.is_work_order_stopped()) @@ -48,27 +64,35 @@ class JobCard(Document): self.validate_work_order() def set_sub_operations(self): - if self.operation: + if not self.sub_operations and self.operation: self.sub_operations = [] - for row in frappe.get_all('Sub Operation', - filters = {'parent': self.operation}, fields=['operation', 'idx'], order_by='idx'): - row.status = 'Pending' + for row in frappe.get_all( + "Sub Operation", + filters={"parent": self.operation}, + fields=["operation", "idx"], + order_by="idx", + ): + row.status = "Pending" row.sub_operation = row.operation - self.append('sub_operations', row) + self.append("sub_operations", row) def validate_time_logs(self): self.total_time_in_mins = 0.0 self.total_completed_qty = 0.0 - if self.get('time_logs'): - for d in self.get('time_logs'): - if get_datetime(d.from_time) > get_datetime(d.to_time): + if self.get("time_logs"): + for d in self.get("time_logs"): + if d.to_time and get_datetime(d.from_time) > get_datetime(d.to_time): frappe.throw(_("Row {0}: From time must be less than to time").format(d.idx)) data = self.get_overlap_for(d) if data: - frappe.throw(_("Row {0}: From Time and To Time of {1} is overlapping with {2}") - .format(d.idx, self.name, data.name), OverlapError) + frappe.throw( + _("Row {0}: From Time and To Time of {1} is overlapping with {2}").format( + d.idx, self.name, data.name + ), + OverlapError, + ) if d.from_time and d.to_time: d.time_in_mins = time_diff_in_hours(d.to_time, d.from_time) * 60 @@ -86,8 +110,9 @@ class JobCard(Document): production_capacity = 1 if self.workstation: - production_capacity = frappe.get_cached_value("Workstation", - self.workstation, 'production_capacity') or 1 + production_capacity = ( + frappe.get_cached_value("Workstation", self.workstation, "production_capacity") or 1 + ) validate_overlap_for = " and jc.workstation = %(workstation)s " if args.get("employee"): @@ -95,11 +120,12 @@ class JobCard(Document): production_capacity = 1 validate_overlap_for = " and jctl.employee = %(employee)s " - extra_cond = '' + extra_cond = "" if check_next_available_slot: extra_cond = " or (%(from_time)s <= jctl.from_time and %(to_time)s <= jctl.to_time)" - existing = frappe.db.sql("""select jc.name as name, jctl.to_time from + existing = frappe.db.sql( + """select jc.name as name, jctl.to_time from `tabJob Card Time Log` jctl, `tabJob Card` jc where jctl.parent = jc.name and ( (%(from_time)s > jctl.from_time and %(from_time)s < jctl.to_time) or @@ -107,15 +133,19 @@ class JobCard(Document): (%(from_time)s <= jctl.from_time and %(to_time)s >= jctl.to_time) {0} ) and jctl.name != %(name)s and jc.name != %(parent)s and jc.docstatus < 2 {1} - order by jctl.to_time desc limit 1""".format(extra_cond, validate_overlap_for), + order by jctl.to_time desc limit 1""".format( + extra_cond, validate_overlap_for + ), { "from_time": args.from_time, "to_time": args.to_time, "name": args.name or "No Name", "parent": args.parent or "No Name", "employee": args.get("employee"), - "workstation": self.workstation - }, as_dict=True) + "workstation": self.workstation, + }, + as_dict=True, + ) if existing and production_capacity > len(existing): return @@ -125,10 +155,7 @@ class JobCard(Document): def schedule_time_logs(self, row): row.remaining_time_in_mins = row.time_in_mins while row.remaining_time_in_mins > 0: - args = frappe._dict({ - "from_time": row.planned_start_time, - "to_time": row.planned_end_time - }) + args = frappe._dict({"from_time": row.planned_start_time, "to_time": row.planned_end_time}) self.validate_overlap_for_workstation(args, row) self.check_workstation_time(row) @@ -141,13 +168,16 @@ class JobCard(Document): def check_workstation_time(self, row): workstation_doc = frappe.get_cached_doc("Workstation", self.workstation) - if (not workstation_doc.working_hours or - cint(frappe.db.get_single_value("Manufacturing Settings", "allow_overtime"))): + if not workstation_doc.working_hours or cint( + frappe.db.get_single_value("Manufacturing Settings", "allow_overtime") + ): if get_datetime(row.planned_end_time) < get_datetime(row.planned_start_time): row.planned_end_time = add_to_date(row.planned_start_time, minutes=row.time_in_mins) row.remaining_time_in_mins = 0.0 else: - row.remaining_time_in_mins -= time_diff_in_minutes(row.planned_end_time, row.planned_start_time) + row.remaining_time_in_mins -= time_diff_in_minutes( + row.planned_end_time, row.planned_start_time + ) self.update_time_logs(row) return @@ -167,14 +197,15 @@ class JobCard(Document): workstation_start_time = datetime.datetime.combine(start_date, get_time(time_slot.start_time)) workstation_end_time = datetime.datetime.combine(start_date, get_time(time_slot.end_time)) - if (get_datetime(row.planned_start_time) >= workstation_start_time and - get_datetime(row.planned_start_time) <= workstation_end_time): + if ( + get_datetime(row.planned_start_time) >= workstation_start_time + and get_datetime(row.planned_start_time) <= workstation_end_time + ): time_in_mins = time_diff_in_minutes(workstation_end_time, row.planned_start_time) # If remaining time fit in workstation time logs else split hours as per workstation time if time_in_mins > row.remaining_time_in_mins: - row.planned_end_time = add_to_date(row.planned_start_time, - minutes=row.remaining_time_in_mins) + row.planned_end_time = add_to_date(row.planned_start_time, minutes=row.remaining_time_in_mins) row.remaining_time_in_mins = 0 else: row.planned_end_time = add_to_date(row.planned_start_time, minutes=time_in_mins) @@ -182,14 +213,16 @@ class JobCard(Document): self.update_time_logs(row) - if total_idx != (i+1) and row.remaining_time_in_mins > 0: - row.planned_start_time = datetime.datetime.combine(start_date, - get_time(workstation_doc.working_hours[i+1].start_time)) + if total_idx != (i + 1) and row.remaining_time_in_mins > 0: + row.planned_start_time = datetime.datetime.combine( + start_date, get_time(workstation_doc.working_hours[i + 1].start_time) + ) if row.remaining_time_in_mins > 0: start_date = add_days(start_date, 1) - row.planned_start_time = datetime.datetime.combine(start_date, - get_time(workstation_doc.working_hours[0].start_time)) + row.planned_start_time = datetime.datetime.combine( + start_date, get_time(workstation_doc.working_hours[0].start_time) + ) def add_time_log(self, args): last_row = [] @@ -204,21 +237,25 @@ class JobCard(Document): if last_row and args.get("complete_time"): for row in self.time_logs: if not row.to_time: - row.update({ - "to_time": get_datetime(args.get("complete_time")), - "operation": args.get("sub_operation"), - "completed_qty": args.get("completed_qty") or 0.0 - }) + row.update( + { + "to_time": get_datetime(args.get("complete_time")), + "operation": args.get("sub_operation"), + "completed_qty": args.get("completed_qty") or 0.0, + } + ) elif args.get("start_time"): - new_args = frappe._dict({ - "from_time": get_datetime(args.get("start_time")), - "operation": args.get("sub_operation"), - "completed_qty": 0.0 - }) + new_args = frappe._dict( + { + "from_time": get_datetime(args.get("start_time")), + "operation": args.get("sub_operation"), + "completed_qty": 0.0, + } + ) if employees: for name in employees: - new_args.employee = name.get('employee') + new_args.employee = name.get("employee") self.add_start_time_log(new_args) else: self.add_start_time_log(new_args) @@ -236,10 +273,7 @@ class JobCard(Document): def set_employees(self, employees): for name in employees: - self.append('employee', { - 'employee': name.get('employee'), - 'completed_qty': 0.0 - }) + self.append("employee", {"employee": name.get("employee"), "completed_qty": 0.0}) def reset_timer_value(self, args): self.started_time = None @@ -263,13 +297,17 @@ class JobCard(Document): operation_wise_completed_time = {} for time_log in self.time_logs: if time_log.operation not in operation_wise_completed_time: - operation_wise_completed_time.setdefault(time_log.operation, - frappe._dict({"status": "Pending", "completed_qty":0.0, "completed_time": 0.0, "employee": []})) + operation_wise_completed_time.setdefault( + time_log.operation, + frappe._dict( + {"status": "Pending", "completed_qty": 0.0, "completed_time": 0.0, "employee": []} + ), + ) op_row = operation_wise_completed_time[time_log.operation] op_row.status = "Work In Progress" if not time_log.time_in_mins else "Complete" - if self.status == 'On Hold': - op_row.status = 'Pause' + if self.status == "On Hold": + op_row.status = "Pause" op_row.employee.append(time_log.employee) if time_log.time_in_mins: @@ -279,7 +317,7 @@ class JobCard(Document): for row in self.sub_operations: operation_deatils = operation_wise_completed_time.get(row.sub_operation) if operation_deatils: - if row.status != 'Complete': + if row.status != "Complete": row.status = operation_deatils.status row.completed_time = operation_deatils.completed_time @@ -289,43 +327,52 @@ class JobCard(Document): if operation_deatils.completed_qty: row.completed_qty = operation_deatils.completed_qty / len(set(operation_deatils.employee)) else: - row.status = 'Pending' + row.status = "Pending" row.completed_time = 0.0 row.completed_qty = 0.0 def update_time_logs(self, row): - self.append("time_logs", { - "from_time": row.planned_start_time, - "to_time": row.planned_end_time, - "completed_qty": 0, - "time_in_mins": time_diff_in_minutes(row.planned_end_time, row.planned_start_time), - }) + self.append( + "time_logs", + { + "from_time": row.planned_start_time, + "to_time": row.planned_end_time, + "completed_qty": 0, + "time_in_mins": time_diff_in_minutes(row.planned_end_time, row.planned_start_time), + }, + ) @frappe.whitelist() def get_required_items(self): - if not self.get('work_order'): + if not self.get("work_order"): return - doc = frappe.get_doc('Work Order', self.get('work_order')) - if doc.transfer_material_against == 'Work Order' or doc.skip_transfer: + doc = frappe.get_doc("Work Order", self.get("work_order")) + if doc.transfer_material_against == "Work Order" or doc.skip_transfer: return for d in doc.required_items: if not d.operation: - frappe.throw(_("Row {0} : Operation is required against the raw material item {1}") - .format(d.idx, d.item_code)) + frappe.throw( + _("Row {0} : Operation is required against the raw material item {1}").format( + d.idx, d.item_code + ) + ) - if self.get('operation') == d.operation: - self.append('items', { - "item_code": d.item_code, - "source_warehouse": d.source_warehouse, - "uom": frappe.db.get_value("Item", d.item_code, 'stock_uom'), - "item_name": d.item_name, - "description": d.description, - "required_qty": (d.required_qty * flt(self.for_quantity)) / doc.qty, - "rate": d.rate, - "amount": d.amount - }) + if self.get("operation") == d.operation: + self.append( + "items", + { + "item_code": d.item_code, + "source_warehouse": d.source_warehouse, + "uom": frappe.db.get_value("Item", d.item_code, "stock_uom"), + "item_name": d.item_name, + "description": d.description, + "required_qty": (d.required_qty * flt(self.for_quantity)) / doc.qty, + "rate": d.rate, + "amount": d.amount, + }, + ) def on_submit(self): self.validate_transfer_qty() @@ -339,31 +386,52 @@ class JobCard(Document): def validate_transfer_qty(self): if self.items and self.transferred_qty < self.for_quantity: - frappe.throw(_('Materials needs to be transferred to the work in progress warehouse for the job card {0}') - .format(self.name)) + frappe.throw( + _( + "Materials needs to be transferred to the work in progress warehouse for the job card {0}" + ).format(self.name) + ) def validate_job_card(self): - if self.work_order and frappe.get_cached_value('Work Order', self.work_order, 'status') == 'Stopped': - frappe.throw(_("Transaction not allowed against stopped Work Order {0}") - .format(get_link_to_form('Work Order', self.work_order))) + if ( + self.work_order + and frappe.get_cached_value("Work Order", self.work_order, "status") == "Stopped" + ): + frappe.throw( + _("Transaction not allowed against stopped Work Order {0}").format( + get_link_to_form("Work Order", self.work_order) + ) + ) if not self.time_logs: - frappe.throw(_("Time logs are required for {0} {1}") - .format(bold("Job Card"), get_link_to_form("Job Card", self.name))) + frappe.throw( + _("Time logs are required for {0} {1}").format( + bold("Job Card"), get_link_to_form("Job Card", self.name) + ) + ) if self.for_quantity and self.total_completed_qty != self.for_quantity: total_completed_qty = bold(_("Total Completed Qty")) qty_to_manufacture = bold(_("Qty to Manufacture")) - frappe.throw(_("The {0} ({1}) must be equal to {2} ({3})") - .format(total_completed_qty, bold(self.total_completed_qty), qty_to_manufacture,bold(self.for_quantity))) + frappe.throw( + _("The {0} ({1}) must be equal to {2} ({3})").format( + total_completed_qty, + bold(self.total_completed_qty), + qty_to_manufacture, + bold(self.for_quantity), + ) + ) def update_work_order(self): if not self.work_order: return - if self.is_corrective_job_card and not cint(frappe.db.get_single_value('Manufacturing Settings', - 'add_corrective_operation_cost_in_finished_good_valuation')): + if self.is_corrective_job_card and not cint( + frappe.db.get_single_value( + "Manufacturing Settings", "add_corrective_operation_cost_in_finished_good_valuation" + ) + ): return for_quantity, time_in_mins = 0, 0 @@ -375,7 +443,7 @@ class JobCard(Document): for_quantity = flt(data[0].completed_qty) time_in_mins = flt(data[0].time_in_mins) - wo = frappe.get_doc('Work Order', self.work_order) + wo = frappe.get_doc("Work Order", self.work_order) if self.is_corrective_job_card: self.update_corrective_in_work_order(wo) @@ -386,8 +454,11 @@ class JobCard(Document): def update_corrective_in_work_order(self, wo): wo.corrective_operation_cost = 0.0 - for row in frappe.get_all('Job Card', fields = ['total_time_in_mins', 'hour_rate'], - filters = {'is_corrective_job_card': 1, 'docstatus': 1, 'work_order': self.work_order}): + for row in frappe.get_all( + "Job Card", + fields=["total_time_in_mins", "hour_rate"], + filters={"is_corrective_job_card": 1, "docstatus": 1, "work_order": self.work_order}, + ): wo.corrective_operation_cost += flt(row.total_time_in_mins) * flt(row.hour_rate) wo.calculate_operating_cost() @@ -395,27 +466,37 @@ class JobCard(Document): wo.save() def validate_produced_quantity(self, for_quantity, wo): - if self.docstatus < 2: return + if self.docstatus < 2: + return if wo.produced_qty > for_quantity: - first_part_msg = (_("The {0} {1} is used to calculate the valuation cost for the finished good {2}.") - .format(frappe.bold(_("Job Card")), frappe.bold(self.name), frappe.bold(self.production_item))) + first_part_msg = _( + "The {0} {1} is used to calculate the valuation cost for the finished good {2}." + ).format( + frappe.bold(_("Job Card")), frappe.bold(self.name), frappe.bold(self.production_item) + ) - second_part_msg = (_("Kindly cancel the Manufacturing Entries first against the work order {0}.") - .format(frappe.bold(get_link_to_form("Work Order", self.work_order)))) + second_part_msg = _( + "Kindly cancel the Manufacturing Entries first against the work order {0}." + ).format(frappe.bold(get_link_to_form("Work Order", self.work_order))) - frappe.throw(_("{0} {1}").format(first_part_msg, second_part_msg), - JobCardCancelError, title = _("Error")) + frappe.throw( + _("{0} {1}").format(first_part_msg, second_part_msg), JobCardCancelError, title=_("Error") + ) def update_work_order_data(self, for_quantity, time_in_mins, wo): - time_data = frappe.db.sql(""" + time_data = frappe.db.sql( + """ SELECT min(from_time) as start_time, max(to_time) as end_time FROM `tabJob Card` jc, `tabJob Card Time Log` jctl WHERE jctl.parent = jc.name and jc.work_order = %s and jc.operation_id = %s and jc.docstatus = 1 and IFNULL(jc.is_corrective_job_card, 0) = 0 - """, (self.work_order, self.operation_id), as_dict=1) + """, + (self.work_order, self.operation_id), + as_dict=1, + ) for data in wo.operations: if data.get("name") == self.operation_id: @@ -434,92 +515,146 @@ class JobCard(Document): wo.save() def get_current_operation_data(self): - return frappe.get_all('Job Card', - fields = ["sum(total_time_in_mins) as time_in_mins", "sum(total_completed_qty) as completed_qty"], - filters = {"docstatus": 1, "work_order": self.work_order, "operation_id": self.operation_id, - "is_corrective_job_card": 0}) + return frappe.get_all( + "Job Card", + fields=["sum(total_time_in_mins) as time_in_mins", "sum(total_completed_qty) as completed_qty"], + filters={ + "docstatus": 1, + "work_order": self.work_order, + "operation_id": self.operation_id, + "is_corrective_job_card": 0, + }, + ) + + def set_transferred_qty_in_job_card_item(self, ste_doc): + from frappe.query_builder.functions import Sum + + def _validate_over_transfer(row, transferred_qty): + "Block over transfer of items if not allowed in settings." + required_qty = frappe.db.get_value("Job Card Item", row.job_card_item, "required_qty") + is_excess = flt(transferred_qty) > flt(required_qty) + if is_excess: + frappe.throw( + _( + "Row #{0}: Cannot transfer more than Required Qty {1} for Item {2} against Job Card {3}" + ).format( + row.idx, frappe.bold(required_qty), frappe.bold(row.item_code), ste_doc.job_card + ), + title=_("Excess Transfer"), + exc=JobCardOverTransferError, + ) - def set_transferred_qty_in_job_card(self, ste_doc): for row in ste_doc.items: - if not row.job_card_item: continue + if not row.job_card_item: + continue - qty = frappe.db.sql(""" SELECT SUM(qty) from `tabStock Entry Detail` sed, `tabStock Entry` se - WHERE sed.job_card_item = %s and se.docstatus = 1 and sed.parent = se.name and - se.purpose = 'Material Transfer for Manufacture' - """, (row.job_card_item))[0][0] + sed = frappe.qb.DocType("Stock Entry Detail") + se = frappe.qb.DocType("Stock Entry") + transferred_qty = ( + frappe.qb.from_(sed) + .join(se) + .on(sed.parent == se.name) + .select(Sum(sed.qty)) + .where( + (sed.job_card_item == row.job_card_item) + & (se.docstatus == 1) + & (se.purpose == "Material Transfer for Manufacture") + ) + ).run()[0][0] - frappe.db.set_value('Job Card Item', row.job_card_item, 'transferred_qty', flt(qty)) + allow_excess = frappe.db.get_single_value("Manufacturing Settings", "job_card_excess_transfer") + if not allow_excess: + _validate_over_transfer(row, transferred_qty) + + frappe.db.set_value("Job Card Item", row.job_card_item, "transferred_qty", flt(transferred_qty)) def set_transferred_qty(self, update_status=False): - "Set total FG Qty for which RM was transferred." + "Set total FG Qty in Job Card for which RM was transferred." if not self.items: self.transferred_qty = self.for_quantity if self.docstatus == 1 else 0 - doc = frappe.get_doc('Work Order', self.get('work_order')) - if doc.transfer_material_against == 'Work Order' or doc.skip_transfer: + doc = frappe.get_doc("Work Order", self.get("work_order")) + if doc.transfer_material_against == "Work Order" or doc.skip_transfer: return if self.items: # sum of 'For Quantity' of Stock Entries against JC - self.transferred_qty = frappe.db.get_value('Stock Entry', { - 'job_card': self.name, - 'work_order': self.work_order, - 'docstatus': 1, - 'purpose': 'Material Transfer for Manufacture' - }, 'sum(fg_completed_qty)') or 0 + self.transferred_qty = ( + frappe.db.get_value( + "Stock Entry", + { + "job_card": self.name, + "work_order": self.work_order, + "docstatus": 1, + "purpose": "Material Transfer for Manufacture", + }, + "sum(fg_completed_qty)", + ) + or 0 + ) self.db_set("transferred_qty", self.transferred_qty) qty = 0 if self.work_order: - doc = frappe.get_doc('Work Order', self.work_order) - if doc.transfer_material_against == 'Job Card' and not doc.skip_transfer: + doc = frappe.get_doc("Work Order", self.work_order) + if doc.transfer_material_against == "Job Card" and not doc.skip_transfer: completed = True for d in doc.operations: - if d.status != 'Completed': + if d.status != "Completed": completed = False break if completed: - job_cards = frappe.get_all('Job Card', filters = {'work_order': self.work_order, - 'docstatus': ('!=', 2)}, fields = 'sum(transferred_qty) as qty', group_by='operation_id') + job_cards = frappe.get_all( + "Job Card", + filters={"work_order": self.work_order, "docstatus": ("!=", 2)}, + fields="sum(transferred_qty) as qty", + group_by="operation_id", + ) if job_cards: qty = min(d.qty for d in job_cards) - doc.db_set('material_transferred_for_manufacturing', qty) + doc.db_set("material_transferred_for_manufacturing", qty) self.set_status(update_status) def set_status(self, update_status=False): - if self.status == "On Hold": return + if self.status == "On Hold" and self.docstatus == 0: + return - self.status = { - 0: "Open", - 1: "Submitted", - 2: "Cancelled" - }[self.docstatus or 0] + self.status = {0: "Open", 1: "Submitted", 2: "Cancelled"}[self.docstatus or 0] - if self.time_logs: - self.status = 'Work In Progress' - - if (self.docstatus == 1 and - (self.for_quantity <= self.total_completed_qty or not self.items)): - self.status = 'Completed' - - if self.status != 'Completed': + if self.docstatus < 2: if self.for_quantity <= self.transferred_qty: - self.status = 'Material Transferred' + self.status = "Material Transferred" + + if self.time_logs: + self.status = "Work In Progress" + + if self.docstatus == 1 and (self.for_quantity <= self.total_completed_qty or not self.items): + self.status = "Completed" if update_status: - self.db_set('status', self.status) + self.db_set("status", self.status) def validate_operation_id(self): - if (self.get("operation_id") and self.get("operation_row_number") and self.operation and self.work_order and - frappe.get_cached_value("Work Order Operation", self.operation_row_number, "name") != self.operation_id): + if ( + self.get("operation_id") + and self.get("operation_row_number") + and self.operation + and self.work_order + and frappe.get_cached_value("Work Order Operation", self.operation_row_number, "name") + != self.operation_id + ): work_order = bold(get_link_to_form("Work Order", self.work_order)) - frappe.throw(_("Operation {0} does not belong to the work order {1}") - .format(bold(self.operation), work_order), OperationMismatchError) + frappe.throw( + _("Operation {0} does not belong to the work order {1}").format( + bold(self.operation), work_order + ), + OperationMismatchError, + ) def validate_sequence_id(self): if self.is_corrective_job_card: @@ -535,18 +670,25 @@ class JobCard(Document): current_operation_qty += flt(self.total_completed_qty) - data = frappe.get_all("Work Order Operation", - fields = ["operation", "status", "completed_qty"], - filters={"docstatus": 1, "parent": self.work_order, "sequence_id": ('<', self.sequence_id)}, - order_by = "sequence_id, idx") + data = frappe.get_all( + "Work Order Operation", + fields=["operation", "status", "completed_qty"], + filters={"docstatus": 1, "parent": self.work_order, "sequence_id": ("<", self.sequence_id)}, + order_by="sequence_id, idx", + ) - message = "Job Card {0}: As per the sequence of the operations in the work order {1}".format(bold(self.name), - bold(get_link_to_form("Work Order", self.work_order))) + message = "Job Card {0}: As per the sequence of the operations in the work order {1}".format( + bold(self.name), bold(get_link_to_form("Work Order", self.work_order)) + ) for row in data: if row.status != "Completed" and row.completed_qty < current_operation_qty: - frappe.throw(_("{0}, complete the operation {1} before the operation {2}.") - .format(message, bold(row.operation), bold(self.operation)), OperationSequenceError) + frappe.throw( + _("{0}, complete the operation {1} before the operation {2}.").format( + message, bold(row.operation), bold(self.operation) + ), + OperationSequenceError, + ) def validate_work_order(self): if self.is_work_order_stopped(): @@ -554,13 +696,14 @@ class JobCard(Document): def is_work_order_stopped(self): if self.work_order: - status = frappe.get_value('Work Order', self.work_order) + status = frappe.get_value("Work Order", self.work_order) if status == "Closed": return True return False + @frappe.whitelist() def make_time_log(args): if isinstance(args, str): @@ -571,16 +714,17 @@ def make_time_log(args): doc.validate_sequence_id() doc.add_time_log(args) + @frappe.whitelist() def get_operation_details(work_order, operation): if work_order and operation: - return frappe.get_all("Work Order Operation", fields = ["name", "idx"], - filters = { - "parent": work_order, - "operation": operation - } + return frappe.get_all( + "Work Order Operation", + fields=["name", "idx"], + filters={"parent": work_order, "operation": operation}, ) + @frappe.whitelist() def get_operations(doctype, txt, searchfield, start, page_len, filters): if not filters.get("work_order"): @@ -590,12 +734,16 @@ def get_operations(doctype, txt, searchfield, start, page_len, filters): if txt: args["operation"] = ("like", "%{0}%".format(txt)) - return frappe.get_all("Work Order Operation", - filters = args, - fields = ["distinct operation as operation"], - limit_start = start, - limit_page_length = page_len, - order_by="idx asc", as_list=1) + return frappe.get_all( + "Work Order Operation", + filters=args, + fields=["distinct operation as operation"], + limit_start=start, + limit_page_length=page_len, + order_by="idx asc", + as_list=1, + ) + @frappe.whitelist() def make_material_request(source_name, target_doc=None): @@ -605,26 +753,29 @@ def make_material_request(source_name, target_doc=None): def set_missing_values(source, target): target.material_request_type = "Material Transfer" - doclist = get_mapped_doc("Job Card", source_name, { - "Job Card": { - "doctype": "Material Request", - "field_map": { - "name": "job_card", + doclist = get_mapped_doc( + "Job Card", + source_name, + { + "Job Card": { + "doctype": "Material Request", + "field_map": { + "name": "job_card", + }, + }, + "Job Card Item": { + "doctype": "Material Request Item", + "field_map": {"required_qty": "qty", "uom": "stock_uom", "name": "job_card_item"}, + "postprocess": update_item, }, }, - "Job Card Item": { - "doctype": "Material Request Item", - "field_map": { - "required_qty": "qty", - "uom": "stock_uom", - "name": "job_card_item" - }, - "postprocess": update_item, - } - }, target_doc, set_missing_values) + target_doc, + set_missing_values, + ) return doclist + @frappe.whitelist() def make_stock_entry(source_name, target_doc=None): def update_item(source, target, source_parent): @@ -642,44 +793,51 @@ def make_stock_entry(source_name, target_doc=None): target.from_bom = 1 # avoid negative 'For Quantity' - pending_fg_qty = flt(source.get('for_quantity', 0)) - flt(source.get('transferred_qty', 0)) + pending_fg_qty = flt(source.get("for_quantity", 0)) - flt(source.get("transferred_qty", 0)) target.fg_completed_qty = pending_fg_qty if pending_fg_qty > 0 else 0 - target.set_transfer_qty() - target.calculate_rate_and_amount() target.set_missing_values() target.set_stock_entry_type() - wo_allows_alternate_item = frappe.db.get_value("Work Order", target.work_order, "allow_alternative_item") + wo_allows_alternate_item = frappe.db.get_value( + "Work Order", target.work_order, "allow_alternative_item" + ) for item in target.items: - item.allow_alternative_item = int(wo_allows_alternate_item and - frappe.get_cached_value("Item", item.item_code, "allow_alternative_item")) + item.allow_alternative_item = int( + wo_allows_alternate_item + and frappe.get_cached_value("Item", item.item_code, "allow_alternative_item") + ) - doclist = get_mapped_doc("Job Card", source_name, { - "Job Card": { - "doctype": "Stock Entry", - "field_map": { - "name": "job_card", - "for_quantity": "fg_completed_qty" + doclist = get_mapped_doc( + "Job Card", + source_name, + { + "Job Card": { + "doctype": "Stock Entry", + "field_map": {"name": "job_card", "for_quantity": "fg_completed_qty"}, + }, + "Job Card Item": { + "doctype": "Stock Entry Detail", + "field_map": { + "source_warehouse": "s_warehouse", + "required_qty": "qty", + "name": "job_card_item", + }, + "postprocess": update_item, + "condition": lambda doc: doc.required_qty > 0, }, }, - "Job Card Item": { - "doctype": "Stock Entry Detail", - "field_map": { - "source_warehouse": "s_warehouse", - "required_qty": "qty", - "name": "job_card_item" - }, - "postprocess": update_item, - "condition": lambda doc: doc.required_qty > 0 - } - }, target_doc, set_missing_values) + target_doc, + set_missing_values, + ) return doclist + def time_diff_in_minutes(string_ed_date, string_st_date): return time_diff(string_ed_date, string_st_date).total_seconds() / 60 + @frappe.whitelist() def get_job_details(start, end, filters=None): events = [] @@ -687,41 +845,49 @@ def get_job_details(start, end, filters=None): event_color = { "Completed": "#cdf5a6", "Material Transferred": "#ffdd9e", - "Work In Progress": "#D3D3D3" + "Work In Progress": "#D3D3D3", } from frappe.desk.reportview import get_filters_cond + conditions = get_filters_cond("Job Card", filters, []) - job_cards = frappe.db.sql(""" SELECT `tabJob Card`.name, `tabJob Card`.work_order, + job_cards = frappe.db.sql( + """ SELECT `tabJob Card`.name, `tabJob Card`.work_order, `tabJob Card`.status, ifnull(`tabJob Card`.remarks, ''), min(`tabJob Card Time Log`.from_time) as from_time, max(`tabJob Card Time Log`.to_time) as to_time FROM `tabJob Card` , `tabJob Card Time Log` WHERE `tabJob Card`.name = `tabJob Card Time Log`.parent {0} - group by `tabJob Card`.name""".format(conditions), as_dict=1) + group by `tabJob Card`.name""".format( + conditions + ), + as_dict=1, + ) for d in job_cards: - subject_data = [] - for field in ["name", "work_order", "remarks"]: - if not d.get(field): continue + subject_data = [] + for field in ["name", "work_order", "remarks"]: + if not d.get(field): + continue - subject_data.append(d.get(field)) + subject_data.append(d.get(field)) - color = event_color.get(d.status) - job_card_data = { - 'from_time': d.from_time, - 'to_time': d.to_time, - 'name': d.name, - 'subject': '\n'.join(subject_data), - 'color': color if color else "#89bcde" - } + color = event_color.get(d.status) + job_card_data = { + "from_time": d.from_time, + "to_time": d.to_time, + "name": d.name, + "subject": "\n".join(subject_data), + "color": color if color else "#89bcde", + } - events.append(job_card_data) + events.append(job_card_data) return events + @frappe.whitelist() def make_corrective_job_card(source_name, operation=None, for_operation=None, target_doc=None): def set_missing_values(source, target): @@ -729,20 +895,27 @@ def make_corrective_job_card(source_name, operation=None, for_operation=None, ta target.operation = operation target.for_operation = for_operation - target.set('time_logs', []) - target.set('employee', []) - target.set('items', []) + target.set("time_logs", []) + target.set("employee", []) + target.set("items", []) + target.set("sub_operations", []) target.set_sub_operations() target.get_required_items() target.validate_time_logs() - doclist = get_mapped_doc("Job Card", source_name, { - "Job Card": { - "doctype": "Job Card", - "field_map": { - "name": "for_job_card", - }, - } - }, target_doc, set_missing_values) + doclist = get_mapped_doc( + "Job Card", + source_name, + { + "Job Card": { + "doctype": "Job Card", + "field_map": { + "name": "for_job_card", + }, + } + }, + target_doc, + set_missing_values, + ) return doclist diff --git a/erpnext/manufacturing/doctype/job_card/job_card_dashboard.py b/erpnext/manufacturing/doctype/job_card/job_card_dashboard.py index 24362f8246d..14c1f36d0dc 100644 --- a/erpnext/manufacturing/doctype/job_card/job_card_dashboard.py +++ b/erpnext/manufacturing/doctype/job_card/job_card_dashboard.py @@ -1,21 +1,12 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'job_card', - 'non_standard_fieldnames': { - 'Quality Inspection': 'reference_name' - }, - 'transactions': [ - { - 'label': _('Transactions'), - 'items': ['Material Request', 'Stock Entry'] - }, - { - 'label': _('Reference'), - 'items': ['Quality Inspection'] - } - ] + "fieldname": "job_card", + "non_standard_fieldnames": {"Quality Inspection": "reference_name"}, + "transactions": [ + {"label": _("Transactions"), "items": ["Material Request", "Stock Entry"]}, + {"label": _("Reference"), "items": ["Quality Inspection"]}, + ], } diff --git a/erpnext/manufacturing/doctype/job_card/job_card_list.js b/erpnext/manufacturing/doctype/job_card/job_card_list.js index 8017209e7de..5d883bf9fa7 100644 --- a/erpnext/manufacturing/doctype/job_card/job_card_list.js +++ b/erpnext/manufacturing/doctype/job_card/job_card_list.js @@ -1,15 +1,17 @@ frappe.listview_settings['Job Card'] = { + has_indicator_for_draft: true, + get_indicator: function(doc) { - if (doc.status === "Work In Progress") { - return [__("Work In Progress"), "orange", "status,=,Work In Progress"]; - } else if (doc.status === "Completed") { - return [__("Completed"), "green", "status,=,Completed"]; - } else if (doc.docstatus == 2) { - return [__("Cancelled"), "red", "status,=,Cancelled"]; - } else if (doc.status === "Material Transferred") { - return [__('Material Transferred'), "blue", "status,=,Material Transferred"]; - } else { - return [__("Open"), "red", "status,=,Open"]; - } + const status_colors = { + "Work In Progress": "orange", + "Completed": "green", + "Cancelled": "red", + "Material Transferred": "blue", + "Open": "red", + }; + const status = doc.status || "Open"; + const color = status_colors[status] || "blue"; + + return [__(status), color, `status,=,${status}`]; } }; diff --git a/erpnext/manufacturing/doctype/job_card/test_job_card.py b/erpnext/manufacturing/doctype/job_card/test_job_card.py index 9b4fc8b8b7a..71aa5ef0951 100644 --- a/erpnext/manufacturing/doctype/job_card/test_job_card.py +++ b/erpnext/manufacturing/doctype/job_card/test_job_card.py @@ -1,55 +1,63 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt -import unittest import frappe +from frappe.tests.utils import FrappeTestCase, change_settings from frappe.utils import random_string +from frappe.utils.data import add_to_date, now -from erpnext.manufacturing.doctype.job_card.job_card import OperationMismatchError, OverlapError +from erpnext.manufacturing.doctype.job_card.job_card import ( + JobCardOverTransferError, + OperationMismatchError, + OverlapError, + make_corrective_job_card, +) from erpnext.manufacturing.doctype.job_card.job_card import ( make_stock_entry as make_stock_entry_from_jc, ) from erpnext.manufacturing.doctype.work_order.test_work_order import make_wo_order_test_record +from erpnext.manufacturing.doctype.work_order.work_order import WorkOrder from erpnext.manufacturing.doctype.workstation.test_workstation import make_workstation from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry -class TestJobCard(unittest.TestCase): +class TestJobCard(FrappeTestCase): def setUp(self): make_bom_for_jc_tests() + self.transfer_material_against = "Work Order" + self.source_warehouse = None + self._work_order = None - transfer_material_against, source_warehouse = None, None + @property + def work_order(self) -> WorkOrder: + """Work Order lazily created for tests.""" + if not self._work_order: + self._work_order = make_wo_order_test_record( + item="_Test FG Item 2", + qty=2, + transfer_material_against=self.transfer_material_against, + source_warehouse=self.source_warehouse, + ) + return self._work_order - tests_that_skip_setup = ( - "test_job_card_material_transfer_correctness", - ) - tests_that_transfer_against_jc = ( - "test_job_card_multiple_materials_transfer", - "test_job_card_excess_material_transfer", - "test_job_card_partial_material_transfer" - ) - - if self._testMethodName in tests_that_skip_setup: - return - - if self._testMethodName in tests_that_transfer_against_jc: - transfer_material_against = "Job Card" - source_warehouse = "Stores - _TC" - - self.work_order = make_wo_order_test_record( - item="_Test FG Item 2", - qty=2, - transfer_material_against=transfer_material_against, - source_warehouse=source_warehouse - ) + def generate_required_stock(self, work_order: WorkOrder) -> None: + """Create twice the stock for all required items in work order.""" + for item in work_order.required_items: + make_stock_entry( + item_code=item.item_code, + target=item.source_warehouse or self.source_warehouse, + qty=item.required_qty * 2, + basic_rate=100, + ) def tearDown(self): frappe.db.rollback() - def test_job_card(self): + def test_job_card_operations(self): - job_cards = frappe.get_all('Job Card', - filters = {'work_order': self.work_order.name}, fields = ["operation_id", "name"]) + job_cards = frappe.get_all( + "Job Card", filters={"work_order": self.work_order.name}, fields=["operation_id", "name"] + ) if job_cards: job_card = job_cards[0] @@ -59,89 +67,84 @@ class TestJobCard(unittest.TestCase): doc.operation_id = "Test Data" self.assertRaises(OperationMismatchError, doc.save) - for d in job_cards: - frappe.delete_doc("Job Card", d.name) - def test_job_card_with_different_work_station(self): - job_cards = frappe.get_all('Job Card', - filters = {'work_order': self.work_order.name}, - fields = ["operation_id", "workstation", "name", "for_quantity"]) + job_cards = frappe.get_all( + "Job Card", + filters={"work_order": self.work_order.name}, + fields=["operation_id", "workstation", "name", "for_quantity"], + ) job_card = job_cards[0] if job_card: - workstation = frappe.db.get_value("Workstation", - {"name": ("not in", [job_card.workstation])}, "name") + workstation = frappe.db.get_value( + "Workstation", {"name": ("not in", [job_card.workstation])}, "name" + ) if not workstation or job_card.workstation == workstation: workstation = make_workstation(workstation_name=random_string(5)).name doc = frappe.get_doc("Job Card", job_card.name) doc.workstation = workstation - doc.append("time_logs", { - "from_time": "2009-01-01 12:06:25", - "to_time": "2009-01-01 12:37:25", - "time_in_mins": "31.00002", - "completed_qty": job_card.for_quantity - }) + doc.append( + "time_logs", + { + "from_time": "2009-01-01 12:06:25", + "to_time": "2009-01-01 12:37:25", + "time_in_mins": "31.00002", + "completed_qty": job_card.for_quantity, + }, + ) doc.submit() - completed_qty = frappe.db.get_value("Work Order Operation", job_card.operation_id, "completed_qty") + completed_qty = frappe.db.get_value( + "Work Order Operation", job_card.operation_id, "completed_qty" + ) self.assertEqual(completed_qty, job_card.for_quantity) - doc.cancel() - - for d in job_cards: - frappe.delete_doc("Job Card", d.name) - def test_job_card_overlap(self): wo2 = make_wo_order_test_record(item="_Test FG Item 2", qty=2) - jc1_name = frappe.db.get_value("Job Card", {'work_order': self.work_order.name}) - jc2_name = frappe.db.get_value("Job Card", {'work_order': wo2.name}) + jc1 = frappe.get_last_doc("Job Card", {"work_order": self.work_order.name}) + jc2 = frappe.get_last_doc("Job Card", {"work_order": wo2.name}) - jc1 = frappe.get_doc("Job Card", jc1_name) - jc2 = frappe.get_doc("Job Card", jc2_name) + employee = "_T-Employee-00001" # from test records - employee = "_T-Employee-00001" # from test records - - jc1.append("time_logs", { - "from_time": "2021-01-01 00:00:00", - "to_time": "2021-01-01 08:00:00", - "completed_qty": 1, - "employee": employee, - }) + jc1.append( + "time_logs", + { + "from_time": "2021-01-01 00:00:00", + "to_time": "2021-01-01 08:00:00", + "completed_qty": 1, + "employee": employee, + }, + ) jc1.save() # add a new entry in same time slice - jc2.append("time_logs", { - "from_time": "2021-01-01 00:01:00", - "to_time": "2021-01-01 06:00:00", - "completed_qty": 1, - "employee": employee, - }) + jc2.append( + "time_logs", + { + "from_time": "2021-01-01 00:01:00", + "to_time": "2021-01-01 06:00:00", + "completed_qty": 1, + "employee": employee, + }, + ) self.assertRaises(OverlapError, jc2.save) def test_job_card_multiple_materials_transfer(self): "Test transferring RMs separately against Job Card with multiple RMs." - make_stock_entry( - item_code="_Test Item", - target="Stores - _TC", - qty=10, - basic_rate=100 - ) - make_stock_entry( - item_code="_Test Item Home Desktop Manufactured", - target="Stores - _TC", - qty=6, - basic_rate=100 - ) + self.transfer_material_against = "Job Card" + self.source_warehouse = "Stores - _TC" - job_card_name = frappe.db.get_value("Job Card", {'work_order': self.work_order.name}) + self.generate_required_stock(self.work_order) + + job_card_name = frappe.db.get_value("Job Card", {"work_order": self.work_order.name}) job_card = frappe.get_doc("Job Card", job_card_name) transfer_entry_1 = make_stock_entry_from_jc(job_card_name) - del transfer_entry_1.items[1] # transfer only 1 of 2 RMs + del transfer_entry_1.items[1] # transfer only 1 of 2 RMs transfer_entry_1.insert() transfer_entry_1.submit() @@ -160,15 +163,58 @@ class TestJobCard(unittest.TestCase): # transfer was made for 2 fg qty in first transfer Stock Entry self.assertEqual(transfer_entry_2.fg_completed_qty, 0) + @change_settings("Manufacturing Settings", {"job_card_excess_transfer": 1}) def test_job_card_excess_material_transfer(self): "Test transferring more than required RM against Job Card." - make_stock_entry(item_code="_Test Item", target="Stores - _TC", - qty=25, basic_rate=100) - make_stock_entry(item_code="_Test Item Home Desktop Manufactured", - target="Stores - _TC", qty=15, basic_rate=100) + self.transfer_material_against = "Job Card" + self.source_warehouse = "Stores - _TC" - job_card_name = frappe.db.get_value("Job Card", {'work_order': self.work_order.name}) - job_card = frappe.get_doc("Job Card", job_card_name) + self.generate_required_stock(self.work_order) + + job_card = frappe.get_last_doc("Job Card", {"work_order": self.work_order.name}) + self.assertEqual(job_card.status, "Open") + + # fully transfer both RMs + transfer_entry_1 = make_stock_entry_from_jc(job_card.name) + transfer_entry_1.insert() + transfer_entry_1.submit() + + # transfer extra qty of both RM due to previously damaged RM + transfer_entry_2 = make_stock_entry_from_jc(job_card.name) + # deliberately change 'For Quantity' + transfer_entry_2.fg_completed_qty = 1 + transfer_entry_2.items[0].qty = 5 + transfer_entry_2.items[1].qty = 3 + transfer_entry_2.insert() + transfer_entry_2.submit() + + job_card.reload() + self.assertGreater(job_card.transferred_qty, job_card.for_quantity) + + # Check if 'For Quantity' is negative + # as 'transferred_qty' > Qty to Manufacture + transfer_entry_3 = make_stock_entry_from_jc(job_card.name) + self.assertEqual(transfer_entry_3.fg_completed_qty, 0) + + job_card.append( + "time_logs", + {"from_time": "2021-01-01 00:01:00", "to_time": "2021-01-01 06:00:00", "completed_qty": 2}, + ) + job_card.save() + job_card.submit() + + # JC is Completed with excess transfer + self.assertEqual(job_card.status, "Completed") + + @change_settings("Manufacturing Settings", {"job_card_excess_transfer": 0}) + def test_job_card_excess_material_transfer_block(self): + + self.transfer_material_against = "Job Card" + self.source_warehouse = "Stores - _TC" + + self.generate_required_stock(self.work_order) + + job_card_name = frappe.db.get_value("Job Card", {"work_order": self.work_order.name}) # fully transfer both RMs transfer_entry_1 = make_stock_entry_from_jc(job_card_name) @@ -182,40 +228,19 @@ class TestJobCard(unittest.TestCase): transfer_entry_2.items[0].qty = 5 transfer_entry_2.items[1].qty = 3 transfer_entry_2.insert() - transfer_entry_2.submit() - - job_card.reload() - self.assertGreater(job_card.transferred_qty, job_card.for_quantity) - - # Check if 'For Quantity' is negative - # as 'transferred_qty' > Qty to Manufacture - transfer_entry_3 = make_stock_entry_from_jc(job_card_name) - self.assertEqual(transfer_entry_3.fg_completed_qty, 0) - - job_card.append("time_logs", { - "from_time": "2021-01-01 00:01:00", - "to_time": "2021-01-01 06:00:00", - "completed_qty": 2 - }) - job_card.save() - job_card.submit() - - # JC is Completed with excess transfer - self.assertEqual(job_card.status, "Completed") + self.assertRaises(JobCardOverTransferError, transfer_entry_2.submit) def test_job_card_partial_material_transfer(self): "Test partial material transfer against Job Card" + self.transfer_material_against = "Job Card" + self.source_warehouse = "Stores - _TC" - make_stock_entry(item_code="_Test Item", target="Stores - _TC", - qty=25, basic_rate=100) - make_stock_entry(item_code="_Test Item Home Desktop Manufactured", - target="Stores - _TC", qty=15, basic_rate=100) + self.generate_required_stock(self.work_order) - job_card_name = frappe.db.get_value("Job Card", {'work_order': self.work_order.name}) - job_card = frappe.get_doc("Job Card", job_card_name) + job_card = frappe.get_last_doc("Job Card", {"work_order": self.work_order.name}) # partially transfer - transfer_entry = make_stock_entry_from_jc(job_card_name) + transfer_entry = make_stock_entry_from_jc(job_card.name) transfer_entry.fg_completed_qty = 1 transfer_entry.get_items() transfer_entry.insert() @@ -227,7 +252,7 @@ class TestJobCard(unittest.TestCase): self.assertEqual(transfer_entry.items[1].qty, 3) # transfer remaining - transfer_entry_2 = make_stock_entry_from_jc(job_card_name) + transfer_entry_2 = make_stock_entry_from_jc(job_card.name) self.assertEqual(transfer_entry_2.fg_completed_qty, 1) self.assertEqual(transfer_entry_2.items[0].qty, 5) @@ -241,15 +266,14 @@ class TestJobCard(unittest.TestCase): def test_job_card_material_transfer_correctness(self): """ - 1. Test if only current Job Card Items are pulled in a Stock Entry against a Job Card - 2. Test impact of changing 'For Qty' in such a Stock Entry + 1. Test if only current Job Card Items are pulled in a Stock Entry against a Job Card + 2. Test impact of changing 'For Qty' in such a Stock Entry """ create_bom_with_multiple_operations() work_order = make_wo_with_transfer_against_jc() job_card_name = frappe.db.get_value( - "Job Card", - {"work_order": work_order.name,"operation": "Test Operation A"} + "Job Card", {"work_order": work_order.name, "operation": "Test Operation A"} ) job_card = frappe.get_doc("Job Card", job_card_name) @@ -273,7 +297,75 @@ class TestJobCard(unittest.TestCase): self.assertEqual(transfer_entry.items[0].item_code, "_Test Item") self.assertEqual(transfer_entry.items[0].qty, 2) - # rollback via tearDown method + @change_settings( + "Manufacturing Settings", {"add_corrective_operation_cost_in_finished_good_valuation": 1} + ) + def test_corrective_costing(self): + job_card = frappe.get_last_doc("Job Card", {"work_order": self.work_order.name}) + + job_card.append( + "time_logs", + {"from_time": now(), "to_time": add_to_date(now(), hours=1), "completed_qty": 2}, + ) + job_card.submit() + + self.work_order.reload() + original_cost = self.work_order.total_operating_cost + + # Create a corrective operation against it + corrective_action = frappe.get_doc( + doctype="Operation", is_corrective_operation=1, name=frappe.generate_hash() + ).insert() + + corrective_job_card = make_corrective_job_card( + job_card.name, operation=corrective_action.name, for_operation=job_card.operation + ) + corrective_job_card.hour_rate = 100 + corrective_job_card.insert() + corrective_job_card.append( + "time_logs", + { + "from_time": add_to_date(now(), hours=2), + "to_time": add_to_date(now(), hours=2, minutes=30), + "completed_qty": 2, + }, + ) + corrective_job_card.submit() + + self.work_order.reload() + cost_after_correction = self.work_order.total_operating_cost + self.assertGreater(cost_after_correction, original_cost) + + corrective_job_card.cancel() + self.work_order.reload() + cost_after_cancel = self.work_order.total_operating_cost + self.assertEqual(cost_after_cancel, original_cost) + + def test_job_card_statuses(self): + def assertStatus(status): + jc.set_status() + self.assertEqual(jc.status, status) + + jc = frappe.new_doc("Job Card") + jc.for_quantity = 2 + jc.transferred_qty = 1 + jc.total_completed_qty = 0 + jc.time_logs = [] + assertStatus("Open") + + jc.transferred_qty = jc.for_quantity + assertStatus("Material Transferred") + + jc.append("time_logs", {}) + assertStatus("Work In Progress") + + jc.docstatus = 1 + jc.total_completed_qty = jc.for_quantity + assertStatus("Completed") + + jc.docstatus = 2 + assertStatus("Cancelled") + def create_bom_with_multiple_operations(): "Create a BOM with multiple operations and Material Transfer against Job Card" @@ -286,19 +378,22 @@ def create_bom_with_multiple_operations(): "operation": "Test Operation A", "workstation": "_Test Workstation A", "hour_rate_rent": 300, - "time_in_mins": 60 + "time_in_mins": 60, } make_workstation(row) make_operation(row) - bom_doc.append("operations", { - "operation": "Test Operation A", - "description": "Test Operation A", - "workstation": "_Test Workstation A", - "hour_rate": 300, - "time_in_mins": 60, - "operating_cost": 100 - }) + bom_doc.append( + "operations", + { + "operation": "Test Operation A", + "description": "Test Operation A", + "workstation": "_Test Workstation A", + "hour_rate": 300, + "time_in_mins": 60, + "operating_cost": 100, + }, + ) bom_doc.transfer_material_against = "Job Card" bom_doc.save() @@ -306,6 +401,7 @@ def create_bom_with_multiple_operations(): return bom_doc + def make_wo_with_transfer_against_jc(): "Create a WO with multiple operations and Material Transfer against Job Card" @@ -314,7 +410,7 @@ def make_wo_with_transfer_against_jc(): qty=4, transfer_material_against="Job Card", source_warehouse="Stores - _TC", - do_not_submit=True + do_not_submit=True, ) work_order.required_items[0].operation = "Test Operation A" work_order.required_items[1].operation = "_Test Operation 1" @@ -322,11 +418,12 @@ def make_wo_with_transfer_against_jc(): return work_order + def make_bom_for_jc_tests(): - test_records = frappe.get_test_records('BOM') + test_records = frappe.get_test_records("BOM") bom = frappe.copy_doc(test_records[2]) bom.set_rate_of_sub_assembly_item_based_on_bom = 0 bom.rm_cost_as_per = "Valuation Rate" bom.items[0].uom = "_Test UOM 1" bom.items[0].conversion_factor = 5 - bom.insert() \ No newline at end of file + bom.insert() diff --git a/erpnext/manufacturing/doctype/manufacturing_settings/manufacturing_settings.py b/erpnext/manufacturing/doctype/manufacturing_settings/manufacturing_settings.py index c919e8bef1d..730a8575247 100644 --- a/erpnext/manufacturing/doctype/manufacturing_settings/manufacturing_settings.py +++ b/erpnext/manufacturing/doctype/manufacturing_settings/manufacturing_settings.py @@ -11,14 +11,19 @@ from frappe.utils import cint class ManufacturingSettings(Document): pass + def get_mins_between_operations(): - return relativedelta(minutes=cint(frappe.db.get_single_value("Manufacturing Settings", - "mins_between_operations")) or 10) + return relativedelta( + minutes=cint(frappe.db.get_single_value("Manufacturing Settings", "mins_between_operations")) + or 10 + ) + @frappe.whitelist() def is_material_consumption_enabled(): - if not hasattr(frappe.local, 'material_consumption'): - frappe.local.material_consumption = cint(frappe.db.get_single_value('Manufacturing Settings', - 'material_consumption')) + if not hasattr(frappe.local, "material_consumption"): + frappe.local.material_consumption = cint( + frappe.db.get_single_value("Manufacturing Settings", "material_consumption") + ) return frappe.local.material_consumption diff --git a/erpnext/manufacturing/doctype/operation/operation.py b/erpnext/manufacturing/doctype/operation/operation.py index 41726f30cf5..9c8f9ac8d05 100644 --- a/erpnext/manufacturing/doctype/operation/operation.py +++ b/erpnext/manufacturing/doctype/operation/operation.py @@ -19,12 +19,14 @@ class Operation(Document): operation_list = [] for row in self.sub_operations: if row.operation in operation_list: - frappe.throw(_("The operation {0} can not add multiple times") - .format(frappe.bold(row.operation))) + frappe.throw( + _("The operation {0} can not add multiple times").format(frappe.bold(row.operation)) + ) if self.name == row.operation: - frappe.throw(_("The operation {0} can not be the sub operation") - .format(frappe.bold(row.operation))) + frappe.throw( + _("The operation {0} can not be the sub operation").format(frappe.bold(row.operation)) + ) operation_list.append(row.operation) diff --git a/erpnext/manufacturing/doctype/operation/operation_dashboard.py b/erpnext/manufacturing/doctype/operation/operation_dashboard.py index 076f6663bea..8dc901a2968 100644 --- a/erpnext/manufacturing/doctype/operation/operation_dashboard.py +++ b/erpnext/manufacturing/doctype/operation/operation_dashboard.py @@ -1,14 +1,8 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'operation', - 'transactions': [ - { - 'label': _('Manufacture'), - 'items': ['BOM', 'Work Order', 'Job Card', 'Timesheet'] - } - ] + "fieldname": "operation", + "transactions": [{"label": _("Manufacture"), "items": ["BOM", "Work Order", "Job Card"]}], } diff --git a/erpnext/manufacturing/doctype/operation/test_operation.py b/erpnext/manufacturing/doctype/operation/test_operation.py index e511084e7d0..ce9f8e06495 100644 --- a/erpnext/manufacturing/doctype/operation/test_operation.py +++ b/erpnext/manufacturing/doctype/operation/test_operation.py @@ -5,11 +5,13 @@ import unittest import frappe -test_records = frappe.get_test_records('Operation') +test_records = frappe.get_test_records("Operation") + class TestOperation(unittest.TestCase): pass + def make_operation(*args, **kwargs): args = args if args else kwargs if isinstance(args, tuple): @@ -18,11 +20,9 @@ def make_operation(*args, **kwargs): args = frappe._dict(args) if not frappe.db.exists("Operation", args.operation): - doc = frappe.get_doc({ - "doctype": "Operation", - "name": args.operation, - "workstation": args.workstation - }) + doc = frappe.get_doc( + {"doctype": "Operation", "name": args.operation, "workstation": args.workstation} + ) doc.insert() return doc diff --git a/erpnext/manufacturing/doctype/production_plan/production_plan.js b/erpnext/manufacturing/doctype/production_plan/production_plan.js index dba85a9fb6e..5653e1be75d 100644 --- a/erpnext/manufacturing/doctype/production_plan/production_plan.js +++ b/erpnext/manufacturing/doctype/production_plan/production_plan.js @@ -2,6 +2,13 @@ // For license information, please see license.txt frappe.ui.form.on('Production Plan', { + + before_save: function(frm) { + // preserve temporary names on production plan item to re-link sub-assembly items + frm.doc.po_items.forEach(item => { + item.temporary_name = item.name; + }); + }, setup: function(frm) { frm.custom_make_buttons = { 'Work Order': 'Work Order / Subcontract PO', @@ -49,7 +56,7 @@ frappe.ui.form.on('Production Plan', { if (d.item_code) { return { query: "erpnext.controllers.queries.bom", - filters:{'item': cstr(d.item_code)} + filters:{'item': cstr(d.item_code), 'docstatus': 1} } } else frappe.msgprint(__("Please enter Item first")); } diff --git a/erpnext/manufacturing/doctype/production_plan/production_plan.json b/erpnext/manufacturing/doctype/production_plan/production_plan.json index 56cf2b4f08a..23b32379413 100644 --- a/erpnext/manufacturing/doctype/production_plan/production_plan.json +++ b/erpnext/manufacturing/doctype/production_plan/production_plan.json @@ -189,7 +189,7 @@ "label": "Select Items to Manufacture" }, { - "depends_on": "get_items_from", + "depends_on": "eval:doc.get_items_from && doc.docstatus == 0", "fieldname": "get_items", "fieldtype": "Button", "label": "Get Finished Goods for Manufacture" @@ -197,6 +197,7 @@ { "fieldname": "po_items", "fieldtype": "Table", + "label": "Assembly Items", "no_copy": 1, "options": "Production Plan Item", "reqd": 1 @@ -357,6 +358,7 @@ "options": "Production Plan Sub Assembly Item" }, { + "depends_on": "eval:doc.po_items && doc.po_items.length && doc.docstatus == 0", "fieldname": "get_sub_assembly_items", "fieldtype": "Button", "label": "Get Sub Assembly Items" @@ -376,7 +378,7 @@ "index_web_pages_for_search": 1, "is_submittable": 1, "links": [], - "modified": "2021-09-06 18:35:59.642232", + "modified": "2022-03-25 09:15:25.017664", "modified_by": "Administrator", "module": "Manufacturing", "name": "Production Plan", @@ -397,5 +399,6 @@ } ], "sort_field": "modified", - "sort_order": "ASC" + "sort_order": "ASC", + "states": [] } \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/production_plan/production_plan.py b/erpnext/manufacturing/doctype/production_plan/production_plan.py index a63ed999e44..8bf633b145e 100644 --- a/erpnext/manufacturing/doctype/production_plan/production_plan.py +++ b/erpnext/manufacturing/doctype/production_plan/production_plan.py @@ -8,6 +8,7 @@ import json import frappe from frappe import _, msgprint from frappe.model.document import Document +from frappe.query_builder.functions import IfNull, Sum from frappe.utils import ( add_days, ceil, @@ -20,20 +21,39 @@ from frappe.utils import ( nowdate, ) from frappe.utils.csvutils import build_csv_response +from pypika.terms import ExistsCriterion from six import iteritems from erpnext.manufacturing.doctype.bom.bom import get_children, validate_bom_no from erpnext.manufacturing.doctype.work_order.work_order import get_item_details from erpnext.setup.doctype.item_group.item_group import get_item_group_defaults +from erpnext.utilities.transaction_base import validate_uom_is_integer class ProductionPlan(Document): def validate(self): + self.set_pending_qty_in_row_without_reference() self.calculate_total_planned_qty() self.set_status() + self._rename_temporary_references() + validate_uom_is_integer(self, "stock_uom", "planned_qty") + + def set_pending_qty_in_row_without_reference(self): + "Set Pending Qty in independent rows (not from SO or MR)." + if self.docstatus > 0: # set only to initialise value before submit + return + + for item in self.po_items: + if not item.get("sales_order") or not item.get("material_request"): + item.pending_qty = item.planned_qty + + def calculate_total_planned_qty(self): + self.total_planned_qty = 0 + for d in self.po_items: + self.total_planned_qty += flt(d.planned_qty) def validate_data(self): - for d in self.get('po_items'): + for d in self.get("po_items"): if not d.bom_no: frappe.throw(_("Please select BOM for Item in Row {0}").format(d.idx)) else: @@ -42,9 +62,21 @@ class ProductionPlan(Document): if not flt(d.planned_qty): frappe.throw(_("Please enter Planned Qty for Item {0} at row {1}").format(d.item_code, d.idx)) + def _rename_temporary_references(self): + """po_items and sub_assembly_items items are both constructed client side without saving. + + Attempt to fix linkages by using temporary names to map final row names. + """ + new_name_map = {d.temporary_name: d.name for d in self.po_items if d.temporary_name} + actual_names = {d.name for d in self.po_items} + + for sub_assy in self.sub_assembly_items: + if sub_assy.production_plan_item not in actual_names: + sub_assy.production_plan_item = new_name_map.get(sub_assy.production_plan_item) + @frappe.whitelist() def get_open_sales_orders(self): - """ Pull sales orders which are pending to deliver based on criteria selected""" + """Pull sales orders which are pending to deliver based on criteria selected""" open_so = get_sales_orders(self) if open_so: @@ -53,63 +85,79 @@ class ProductionPlan(Document): frappe.msgprint(_("Sales orders are not available for production")) def add_so_in_table(self, open_so): - """ Add sales orders in the table""" - self.set('sales_orders', []) + """Add sales orders in the table""" + self.set("sales_orders", []) for data in open_so: - self.append('sales_orders', { - 'sales_order': data.name, - 'sales_order_date': data.transaction_date, - 'customer': data.customer, - 'grand_total': data.base_grand_total - }) + self.append( + "sales_orders", + { + "sales_order": data.name, + "sales_order_date": data.transaction_date, + "customer": data.customer, + "grand_total": data.base_grand_total, + }, + ) @frappe.whitelist() def get_pending_material_requests(self): - """ Pull Material Requests that are pending based on criteria selected""" - mr_filter = item_filter = "" + """Pull Material Requests that are pending based on criteria selected""" + + bom = frappe.qb.DocType("BOM") + mr = frappe.qb.DocType("Material Request") + mr_item = frappe.qb.DocType("Material Request Item") + + pending_mr_query = ( + frappe.qb.from_(mr) + .from_(mr_item) + .select(mr.name, mr.transaction_date) + .distinct() + .where( + (mr_item.parent == mr.name) + & (mr.material_request_type == "Manufacture") + & (mr.docstatus == 1) + & (mr.status != "Stopped") + & (mr.company == self.company) + & (mr_item.qty > IfNull(mr_item.ordered_qty, 0)) + & ( + ExistsCriterion( + frappe.qb.from_(bom) + .select(bom.name) + .where((bom.item == mr_item.item_code) & (bom.is_active == 1)) + ) + ) + ) + ) + if self.from_date: - mr_filter += " and mr.transaction_date >= %(from_date)s" + pending_mr_query = pending_mr_query.where(mr.transaction_date >= self.from_date) + if self.to_date: - mr_filter += " and mr.transaction_date <= %(to_date)s" + pending_mr_query = pending_mr_query.where(mr.transaction_date <= self.to_date) + if self.warehouse: - mr_filter += " and mr_item.warehouse = %(warehouse)s" + pending_mr_query = pending_mr_query.where(mr_item.warehouse == self.warehouse) if self.item_code: - item_filter += " and mr_item.item_code = %(item)s" + pending_mr_query = pending_mr_query.where(mr_item.item_code == self.item_code) - pending_mr = frappe.db.sql(""" - select distinct mr.name, mr.transaction_date - from `tabMaterial Request` mr, `tabMaterial Request Item` mr_item - where mr_item.parent = mr.name - and mr.material_request_type = "Manufacture" - and mr.docstatus = 1 and mr.status != "Stopped" and mr.company = %(company)s - and mr_item.qty > ifnull(mr_item.ordered_qty,0) {0} {1} - and (exists (select name from `tabBOM` bom where bom.item=mr_item.item_code - and bom.is_active = 1)) - """.format(mr_filter, item_filter), { - "from_date": self.from_date, - "to_date": self.to_date, - "warehouse": self.warehouse, - "item": self.item_code, - "company": self.company - }, as_dict=1) + pending_mr = pending_mr_query.run(as_dict=True) self.add_mr_in_table(pending_mr) def add_mr_in_table(self, pending_mr): - """ Add Material Requests in the table""" - self.set('material_requests', []) + """Add Material Requests in the table""" + self.set("material_requests", []) for data in pending_mr: - self.append('material_requests', { - 'material_request': data.name, - 'material_request_date': data.transaction_date - }) + self.append( + "material_requests", + {"material_request": data.name, "material_request_date": data.transaction_date}, + ) @frappe.whitelist() def get_items(self): - self.set('po_items', []) + self.set("po_items", []) if self.get_items_from == "Sales Order": self.get_so_items() @@ -121,14 +169,17 @@ class ProductionPlan(Document): so_mr_list = [d.get(field) for d in self.get(table) if d.get(field)] return so_mr_list - def get_bom_item(self): + def get_bom_item_condition(self): """Check if Item or if its Template has a BOM.""" - bom_item = None - has_bom = frappe.db.exists({'doctype': 'BOM', 'item': self.item_code, 'docstatus': 1}) + bom_item_condition = None + has_bom = frappe.db.exists({"doctype": "BOM", "item": self.item_code, "docstatus": 1}) + if not has_bom: - template_item = frappe.db.get_value('Item', self.item_code, ['variant_of']) - bom_item = "bom.item = {0}".format(frappe.db.escape(template_item)) if template_item else bom_item - return bom_item + bom = frappe.qb.DocType("BOM") + template_item = frappe.db.get_value("Item", self.item_code, ["variant_of"]) + bom_item_condition = bom.item == template_item or None + + return bom_item_condition def get_so_items(self): # Check for empty table or empty rows @@ -137,63 +188,122 @@ class ProductionPlan(Document): so_list = self.get_so_mr_list("sales_order", "sales_orders") - item_condition = "" - bom_item = "bom.item = so_item.item_code" - if self.item_code and frappe.db.exists('Item', self.item_code): - bom_item = self.get_bom_item() or bom_item - item_condition = ' and so_item.item_code = {0}'.format(frappe.db.escape(self.item_code)) + bom = frappe.qb.DocType("BOM") + so_item = frappe.qb.DocType("Sales Order Item") - items = frappe.db.sql(""" - select - distinct parent, item_code, warehouse, - (qty - work_order_qty) * conversion_factor as pending_qty, - description, name - from - `tabSales Order Item` so_item - where - parent in (%s) and docstatus = 1 and qty > work_order_qty - and exists (select name from `tabBOM` bom where %s - and bom.is_active = 1) %s""" % - (", ".join(["%s"] * len(so_list)), - bom_item, - item_condition), - tuple(so_list), as_dict=1) + items_subquery = frappe.qb.from_(bom).select(bom.name).where(bom.is_active == 1) + items_query = ( + frappe.qb.from_(so_item) + .select( + so_item.parent, + so_item.item_code, + so_item.warehouse, + ( + (so_item.qty - so_item.work_order_qty - so_item.delivered_qty) * so_item.conversion_factor + ).as_("pending_qty"), + so_item.description, + so_item.name, + ) + .distinct() + .where( + (so_item.parent.isin(so_list)) + & (so_item.docstatus == 1) + & (so_item.qty > so_item.work_order_qty) + ) + ) + + if self.item_code and frappe.db.exists("Item", self.item_code): + items_query = items_query.where(so_item.item_code == self.item_code) + items_subquery = items_subquery.where( + self.get_bom_item_condition() or bom.item == so_item.item_code + ) + + items_query = items_query.where(ExistsCriterion(items_subquery)) + + items = items_query.run(as_dict=True) + + pi = frappe.qb.DocType("Packed Item") + + packed_items_query = ( + frappe.qb.from_(so_item) + .from_(pi) + .select( + pi.parent, + pi.item_code, + pi.warehouse.as_("warehouse"), + (((so_item.qty - so_item.work_order_qty) * pi.qty) / so_item.qty).as_("pending_qty"), + pi.parent_item, + pi.description, + so_item.name, + ) + .distinct() + .where( + (so_item.parent == pi.parent) + & (so_item.docstatus == 1) + & (pi.parent_item == so_item.item_code) + & (so_item.parent.isin(so_list)) + & (so_item.qty > so_item.work_order_qty) + & ( + ExistsCriterion( + frappe.qb.from_(bom) + .select(bom.name) + .where((bom.item == pi.item_code) & (bom.is_active == 1)) + ) + ) + ) + ) if self.item_code: - item_condition = ' and so_item.item_code = {0}'.format(frappe.db.escape(self.item_code)) + packed_items_query = packed_items_query.where(so_item.item_code == self.item_code) - packed_items = frappe.db.sql("""select distinct pi.parent, pi.item_code, pi.warehouse as warehouse, - (((so_item.qty - so_item.work_order_qty) * pi.qty) / so_item.qty) - as pending_qty, pi.parent_item, pi.description, so_item.name - from `tabSales Order Item` so_item, `tabPacked Item` pi - where so_item.parent = pi.parent and so_item.docstatus = 1 - and pi.parent_item = so_item.item_code - and so_item.parent in (%s) and so_item.qty > so_item.work_order_qty - and exists (select name from `tabBOM` bom where bom.item=pi.item_code - and bom.is_active = 1) %s""" % \ - (", ".join(["%s"] * len(so_list)), item_condition), tuple(so_list), as_dict=1) + packed_items = packed_items_query.run(as_dict=True) self.add_items(items + packed_items) self.calculate_total_planned_qty() def get_mr_items(self): # Check for empty table or empty rows - if not self.get("material_requests") or not self.get_so_mr_list("material_request", "material_requests"): - frappe.throw(_("Please fill the Material Requests table"), title=_("Material Requests Required")) + if not self.get("material_requests") or not self.get_so_mr_list( + "material_request", "material_requests" + ): + frappe.throw( + _("Please fill the Material Requests table"), title=_("Material Requests Required") + ) mr_list = self.get_so_mr_list("material_request", "material_requests") - item_condition = "" - if self.item_code: - item_condition = " and mr_item.item_code ={0}".format(frappe.db.escape(self.item_code)) + bom = frappe.qb.DocType("BOM") + mr_item = frappe.qb.DocType("Material Request Item") - items = frappe.db.sql("""select distinct parent, name, item_code, warehouse, description, - (qty - ordered_qty) * conversion_factor as pending_qty - from `tabMaterial Request Item` mr_item - where parent in (%s) and docstatus = 1 and qty > ordered_qty - and exists (select name from `tabBOM` bom where bom.item=mr_item.item_code - and bom.is_active = 1) %s""" % \ - (", ".join(["%s"] * len(mr_list)), item_condition), tuple(mr_list), as_dict=1) + items_query = ( + frappe.qb.from_(mr_item) + .select( + mr_item.parent, + mr_item.name, + mr_item.item_code, + mr_item.warehouse, + mr_item.description, + ((mr_item.qty - mr_item.ordered_qty) * mr_item.conversion_factor).as_("pending_qty"), + ) + .distinct() + .where( + (mr_item.parent.isin(mr_list)) + & (mr_item.docstatus == 1) + & (mr_item.qty > mr_item.ordered_qty) + & ( + ExistsCriterion( + frappe.qb.from_(bom) + .select(bom.name) + .where((bom.item == mr_item.item_code) & (bom.is_active == 1)) + ) + ) + ) + ) + + if self.item_code: + items_query = items_query.where(mr_item.item_code == self.item_code) + + items = items_query.run(as_dict=True) self.add_items(items) self.calculate_total_planned_qty() @@ -204,37 +314,36 @@ class ProductionPlan(Document): item_details = get_item_details(data.item_code) if self.combine_items: if item_details.bom_no in refs: - refs[item_details.bom_no]['so_details'].append({ - 'sales_order': data.parent, - 'sales_order_item': data.name, - 'qty': data.pending_qty - }) - refs[item_details.bom_no]['qty'] += data.pending_qty + refs[item_details.bom_no]["so_details"].append( + {"sales_order": data.parent, "sales_order_item": data.name, "qty": data.pending_qty} + ) + refs[item_details.bom_no]["qty"] += data.pending_qty continue else: refs[item_details.bom_no] = { - 'qty': data.pending_qty, - 'po_item_ref': data.name, - 'so_details': [] + "qty": data.pending_qty, + "po_item_ref": data.name, + "so_details": [], } - refs[item_details.bom_no]['so_details'].append({ - 'sales_order': data.parent, - 'sales_order_item': data.name, - 'qty': data.pending_qty - }) + refs[item_details.bom_no]["so_details"].append( + {"sales_order": data.parent, "sales_order_item": data.name, "qty": data.pending_qty} + ) - pi = self.append('po_items', { - 'warehouse': data.warehouse, - 'item_code': data.item_code, - 'description': data.description or item_details.description, - 'stock_uom': item_details and item_details.stock_uom or '', - 'bom_no': item_details and item_details.bom_no or '', - 'planned_qty': data.pending_qty, - 'pending_qty': data.pending_qty, - 'planned_start_date': now_datetime(), - 'product_bundle_item': data.parent_item - }) + pi = self.append( + "po_items", + { + "warehouse": data.warehouse, + "item_code": data.item_code, + "description": data.description or item_details.description, + "stock_uom": item_details and item_details.stock_uom or "", + "bom_no": item_details and item_details.bom_no or "", + "planned_qty": data.pending_qty, + "pending_qty": data.pending_qty, + "planned_start_date": now_datetime(), + "product_bundle_item": data.parent_item, + }, + ) pi._set_defaults() if self.get_items_from == "Sales Order": @@ -249,25 +358,23 @@ class ProductionPlan(Document): if refs: for po_item in self.po_items: - po_item.planned_qty = refs[po_item.bom_no]['qty'] - po_item.pending_qty = refs[po_item.bom_no]['qty'] - po_item.sales_order = '' + po_item.planned_qty = refs[po_item.bom_no]["qty"] + po_item.pending_qty = refs[po_item.bom_no]["qty"] + po_item.sales_order = "" self.add_pp_ref(refs) def add_pp_ref(self, refs): for bom_no in refs: - for so_detail in refs[bom_no]['so_details']: - self.append('prod_plan_references', { - 'item_reference': refs[bom_no]['po_item_ref'], - 'sales_order': so_detail['sales_order'], - 'sales_order_item': so_detail['sales_order_item'], - 'qty': so_detail['qty'] - }) - - def calculate_total_planned_qty(self): - self.total_planned_qty = 0 - for d in self.po_items: - self.total_planned_qty += flt(d.planned_qty) + for so_detail in refs[bom_no]["so_details"]: + self.append( + "prod_plan_references", + { + "item_reference": refs[bom_no]["po_item_ref"], + "sales_order": so_detail["sales_order"], + "sales_order_item": so_detail["sales_order_item"], + "qty": so_detail["qty"], + }, + ) def calculate_total_produced_qty(self): self.total_produced_qty = 0 @@ -276,48 +383,46 @@ class ProductionPlan(Document): self.db_set("total_produced_qty", self.total_produced_qty, update_modified=False) - def update_produced_qty(self, produced_qty, production_plan_item): + def update_produced_pending_qty(self, produced_qty, production_plan_item): for data in self.po_items: if data.name == production_plan_item: data.produced_qty = produced_qty + data.pending_qty = flt(data.planned_qty - produced_qty) data.db_update() self.calculate_total_produced_qty() self.set_status() - self.db_set('status', self.status) + self.db_set("status", self.status) def on_cancel(self): - self.db_set('status', 'Cancelled') + self.db_set("status", "Cancelled") self.delete_draft_work_order() def delete_draft_work_order(self): - for d in frappe.get_all('Work Order', fields = ["name"], - filters = {'docstatus': 0, 'production_plan': ("=", self.name)}): - frappe.delete_doc('Work Order', d.name) + for d in frappe.get_all( + "Work Order", fields=["name"], filters={"docstatus": 0, "production_plan": ("=", self.name)} + ): + frappe.delete_doc("Work Order", d.name) @frappe.whitelist() def set_status(self, close=None): - self.status = { - 0: 'Draft', - 1: 'Submitted', - 2: 'Cancelled' - }.get(self.docstatus) + self.status = {0: "Draft", 1: "Submitted", 2: "Cancelled"}.get(self.docstatus) if close: - self.db_set('status', 'Closed') + self.db_set("status", "Closed") return if self.total_produced_qty > 0: self.status = "In Process" - if self.check_have_work_orders_completed(): + if self.all_items_completed(): self.status = "Completed" - if self.status != 'Completed': + if self.status != "Completed": self.update_ordered_status() self.update_requested_status() if close is not None: - self.db_set('status', self.status) + self.db_set("status", self.status) def update_ordered_status(self): update_status = False @@ -325,8 +430,8 @@ class ProductionPlan(Document): if d.planned_qty == d.ordered_qty: update_status = True - if update_status and self.status != 'Completed': - self.status = 'In Process' + if update_status and self.status != "Completed": + self.status = "In Process" def update_requested_status(self): if not self.mr_items: @@ -338,105 +443,145 @@ class ProductionPlan(Document): update_status = False if update_status: - self.status = 'Material Requested' + self.status = "Material Requested" def get_production_items(self): item_dict = {} + for d in self.po_items: item_details = { - "production_item" : d.item_code, - "use_multi_level_bom" : d.include_exploded_items, - "sales_order" : d.sales_order, - "sales_order_item" : d.sales_order_item, - "material_request" : d.material_request, - "material_request_item" : d.material_request_item, - "bom_no" : d.bom_no, - "description" : d.description, - "stock_uom" : d.stock_uom, - "company" : self.company, - "fg_warehouse" : d.warehouse, - "production_plan" : self.name, - "production_plan_item" : d.name, - "product_bundle_item" : d.product_bundle_item, - "planned_start_date" : d.planned_start_date + "production_item": d.item_code, + "use_multi_level_bom": d.include_exploded_items, + "sales_order": d.sales_order, + "sales_order_item": d.sales_order_item, + "material_request": d.material_request, + "material_request_item": d.material_request_item, + "bom_no": d.bom_no, + "description": d.description, + "stock_uom": d.stock_uom, + "company": self.company, + "fg_warehouse": d.warehouse, + "production_plan": self.name, + "production_plan_item": d.name, + "product_bundle_item": d.product_bundle_item, + "planned_start_date": d.planned_start_date, + "project": self.project, } - item_details.update({ - "project": self.project or frappe.db.get_value("Sales Order", d.sales_order, "project") - }) + if not item_details["project"] and d.sales_order: + item_details["project"] = frappe.get_cached_value("Sales Order", d.sales_order, "project") if self.get_items_from == "Material Request": - item_details.update({ - "qty": d.planned_qty - }) + item_details.update({"qty": d.planned_qty}) item_dict[(d.item_code, d.material_request_item, d.warehouse)] = item_details else: - item_details.update({ - "qty": flt(item_dict.get((d.item_code, d.sales_order, d.warehouse),{}) - .get("qty")) + (flt(d.planned_qty) - flt(d.ordered_qty)) - }) + item_details.update( + { + "qty": flt(item_dict.get((d.item_code, d.sales_order, d.warehouse), {}).get("qty")) + + (flt(d.planned_qty) - flt(d.ordered_qty)) + } + ) item_dict[(d.item_code, d.sales_order, d.warehouse)] = item_details return item_dict @frappe.whitelist() def make_work_order(self): + from erpnext.manufacturing.doctype.work_order.work_order import get_default_warehouse + wo_list, po_list = [], [] subcontracted_po = {} + default_warehouses = get_default_warehouse() - self.validate_data() - self.make_work_order_for_finished_goods(wo_list) - self.make_work_order_for_subassembly_items(wo_list, subcontracted_po) + self.make_work_order_for_finished_goods(wo_list, default_warehouses) + self.make_work_order_for_subassembly_items(wo_list, subcontracted_po, default_warehouses) self.make_subcontracted_purchase_order(subcontracted_po, po_list) - self.show_list_created_message('Work Order', wo_list) - self.show_list_created_message('Purchase Order', po_list) + self.show_list_created_message("Work Order", wo_list) + self.show_list_created_message("Purchase Order", po_list) - def make_work_order_for_finished_goods(self, wo_list): + def make_work_order_for_finished_goods(self, wo_list, default_warehouses): items_data = self.get_production_items() for key, item in items_data.items(): if self.sub_assembly_items: - item['use_multi_level_bom'] = 0 + item["use_multi_level_bom"] = 0 + set_default_warehouses(item, default_warehouses) work_order = self.create_work_order(item) if work_order: wo_list.append(work_order) - def make_work_order_for_subassembly_items(self, wo_list, subcontracted_po): + def make_work_order_for_subassembly_items(self, wo_list, subcontracted_po, default_warehouses): for row in self.sub_assembly_items: - if row.type_of_manufacturing == 'Subcontract': + if row.type_of_manufacturing == "Subcontract": subcontracted_po.setdefault(row.supplier, []).append(row) continue - args = {} - self.prepare_args_for_sub_assembly_items(row, args) - work_order = self.create_work_order(args) + work_order_data = { + "wip_warehouse": default_warehouses.get("wip_warehouse"), + "fg_warehouse": default_warehouses.get("fg_warehouse"), + "company": self.get("company"), + } + + self.prepare_data_for_sub_assembly_items(row, work_order_data) + work_order = self.create_work_order(work_order_data) if work_order: wo_list.append(work_order) + def prepare_data_for_sub_assembly_items(self, row, wo_data): + for field in [ + "production_item", + "item_name", + "qty", + "fg_warehouse", + "description", + "bom_no", + "stock_uom", + "bom_level", + "schedule_date", + ]: + if row.get(field): + wo_data[field] = row.get(field) + + wo_data.update( + { + "use_multi_level_bom": 0, + "production_plan": self.name, + "production_plan_sub_assembly_item": row.name, + } + ) + def make_subcontracted_purchase_order(self, subcontracted_po, purchase_orders): if not subcontracted_po: return for supplier, po_list in subcontracted_po.items(): - po = frappe.new_doc('Purchase Order') + po = frappe.new_doc("Purchase Order") + po.company = self.company po.supplier = supplier po.schedule_date = getdate(po_list[0].schedule_date) if po_list[0].schedule_date else nowdate() - po.is_subcontracted = 'Yes' + po.is_subcontracted = "Yes" for row in po_list: - args = { - 'item_code': row.production_item, - 'warehouse': row.fg_warehouse, - 'production_plan_sub_assembly_item': row.name, - 'bom': row.bom_no, - 'production_plan': self.name + po_data = { + "item_code": row.production_item, + "warehouse": row.fg_warehouse, + "production_plan_sub_assembly_item": row.name, + "bom": row.bom_no, + "production_plan": self.name, } - for field in ['schedule_date', 'qty', 'uom', 'stock_uom', 'item_name', - 'description', 'production_plan_item']: - args[field] = row.get(field) + for field in [ + "schedule_date", + "qty", + "uom", + "stock_uom", + "item_name", + "description", + "production_plan_item", + ]: + po_data[field] = row.get(field) - po.append('items', args) + po.append("items", po_data) po.set_missing_values() po.flags.ignore_mandatory = True @@ -453,37 +598,22 @@ class ProductionPlan(Document): doc_list = [get_link_to_form(doctype, p) for p in doc_list] msgprint(_("{0} created").format(comma_and(doc_list))) - def prepare_args_for_sub_assembly_items(self, row, args): - for field in ["production_item", "item_name", "qty", "fg_warehouse", - "description", "bom_no", "stock_uom", "bom_level", - "production_plan_item", "schedule_date"]: - args[field] = row.get(field) - - args.update({ - "use_multi_level_bom": 0, - "production_plan": self.name, - "production_plan_sub_assembly_item": row.name - }) - def create_work_order(self, item): - from erpnext.manufacturing.doctype.work_order.work_order import ( - OverProductionError, - get_default_warehouse, - ) - warehouse = get_default_warehouse() + from erpnext.manufacturing.doctype.work_order.work_order import OverProductionError + wo = frappe.new_doc("Work Order") wo.update(item) - wo.planned_start_date = item.get('planned_start_date') or item.get('schedule_date') + wo.planned_start_date = item.get("planned_start_date") or item.get("schedule_date") if item.get("warehouse"): wo.fg_warehouse = item.get("warehouse") wo.set_work_order_operations() + wo.set_required_items() - if not wo.fg_warehouse: - wo.fg_warehouse = warehouse.get('fg_warehouse') try: wo.flags.ignore_mandatory = True + wo.flags.ignore_validate = True wo.insert() return wo.name except OverProductionError: @@ -491,54 +621,60 @@ class ProductionPlan(Document): @frappe.whitelist() def make_material_request(self): - '''Create Material Requests grouped by Sales Order and Material Request Type''' + """Create Material Requests grouped by Sales Order and Material Request Type""" material_request_list = [] material_request_map = {} for item in self.mr_items: - item_doc = frappe.get_cached_doc('Item', item.item_code) + item_doc = frappe.get_cached_doc("Item", item.item_code) material_request_type = item.material_request_type or item_doc.default_material_request_type # key for Sales Order:Material Request Type:Customer - key = '{}:{}:{}'.format(item.sales_order, material_request_type, item_doc.customer or '') + key = "{}:{}:{}".format(item.sales_order, material_request_type, item_doc.customer or "") schedule_date = add_days(nowdate(), cint(item_doc.lead_time_days)) if not key in material_request_map: # make a new MR for the combination material_request_map[key] = frappe.new_doc("Material Request") material_request = material_request_map[key] - material_request.update({ - "transaction_date": nowdate(), - "status": "Draft", - "company": self.company, - 'material_request_type': material_request_type, - 'customer': item_doc.customer or '' - }) + material_request.update( + { + "transaction_date": nowdate(), + "status": "Draft", + "company": self.company, + "material_request_type": material_request_type, + "customer": item_doc.customer or "", + } + ) material_request_list.append(material_request) else: material_request = material_request_map[key] # add item - material_request.append("items", { - "item_code": item.item_code, - "from_warehouse": item.from_warehouse, - "qty": item.quantity, - "schedule_date": schedule_date, - "warehouse": item.warehouse, - "sales_order": item.sales_order, - 'production_plan': self.name, - 'material_request_plan_item': item.name, - "project": frappe.db.get_value("Sales Order", item.sales_order, "project") \ - if item.sales_order else None - }) + material_request.append( + "items", + { + "item_code": item.item_code, + "from_warehouse": item.from_warehouse, + "qty": item.quantity, + "schedule_date": schedule_date, + "warehouse": item.warehouse, + "sales_order": item.sales_order, + "production_plan": self.name, + "material_request_plan_item": item.name, + "project": frappe.db.get_value("Sales Order", item.sales_order, "project") + if item.sales_order + else None, + }, + ) for material_request in material_request_list: # submit material_request.flags.ignore_permissions = 1 material_request.run_method("set_missing_values") - if self.get('submit_material_request'): + if self.get("submit_material_request"): material_request.submit() else: material_request.save() @@ -546,132 +682,242 @@ class ProductionPlan(Document): frappe.flags.mute_messages = False if material_request_list: - material_request_list = ["""{1}""".format(m.name, m.name) \ - for m in material_request_list] + material_request_list = [ + """{1}""".format(m.name, m.name) + for m in material_request_list + ] msgprint(_("{0} created").format(comma_and(material_request_list))) - else : + else: msgprint(_("No material request created")) @frappe.whitelist() def get_sub_assembly_items(self, manufacturing_type=None): self.sub_assembly_items = [] for row in self.po_items: + if not row.item_code: + frappe.throw(_("Row #{0}: Please select Item Code in Assembly Items").format(row.idx)) + bom_data = [] get_sub_assembly_items(row.bom_no, bom_data, row.planned_qty) self.set_sub_assembly_items_based_on_level(row, bom_data, manufacturing_type) - def set_sub_assembly_items_based_on_level(self, row, bom_data, manufacturing_type=None): - bom_data = sorted(bom_data, key = lambda i: i.bom_level) + self.sub_assembly_items.sort(key=lambda d: d.bom_level, reverse=True) + for idx, row in enumerate(self.sub_assembly_items, start=1): + row.idx = idx + def set_sub_assembly_items_based_on_level(self, row, bom_data, manufacturing_type=None): for data in bom_data: data.qty = data.stock_qty data.production_plan_item = row.name data.fg_warehouse = row.warehouse data.schedule_date = row.planned_start_date - data.type_of_manufacturing = manufacturing_type or ("Subcontract" if data.is_sub_contracted_item - else "In House") + data.type_of_manufacturing = manufacturing_type or ( + "Subcontract" if data.is_sub_contracted_item else "In House" + ) self.append("sub_assembly_items", data) - def check_have_work_orders_completed(self): - wo_status = frappe.db.get_list( - "Work Order", - filters={"production_plan": self.name}, - fields="status", - pluck="status" + def all_items_completed(self): + all_items_produced = all( + flt(d.planned_qty) - flt(d.produced_qty) < 0.000001 for d in self.po_items ) - return all(s == "Completed" for s in wo_status) + if not all_items_produced: + return False + + wo_status = frappe.get_all( + "Work Order", + filters={ + "production_plan": self.name, + "status": ("not in", ["Closed", "Stopped"]), + "docstatus": ("<", 2), + }, + fields="status", + pluck="status", + ) + all_work_orders_completed = all(s == "Completed" for s in wo_status) + return all_work_orders_completed + @frappe.whitelist() def download_raw_materials(doc, warehouses=None): if isinstance(doc, str): doc = frappe._dict(json.loads(doc)) - item_list = [['Item Code', 'Description', 'Stock UOM', 'Warehouse', 'Required Qty as per BOM', - 'Projected Qty', 'Available Qty In Hand', 'Ordered Qty', 'Planned Qty', - 'Reserved Qty for Production', 'Safety Stock', 'Required Qty']] + item_list = [ + [ + "Item Code", + "Item Name", + "Description", + "Stock UOM", + "Warehouse", + "Required Qty as per BOM", + "Projected Qty", + "Available Qty In Hand", + "Ordered Qty", + "Planned Qty", + "Reserved Qty for Production", + "Safety Stock", + "Required Qty", + ] + ] doc.warehouse = None frappe.flags.show_qty_in_stock_uom = 1 - items = get_items_for_material_requests(doc, warehouses=warehouses, get_parent_warehouse_data=True) + items = get_items_for_material_requests( + doc, warehouses=warehouses, get_parent_warehouse_data=True + ) for d in items: - item_list.append([d.get('item_code'), d.get('description'), d.get('stock_uom'), d.get('warehouse'), - d.get('required_bom_qty'), d.get('projected_qty'), d.get('actual_qty'), d.get('ordered_qty'), - d.get('planned_qty'), d.get('reserved_qty_for_production'), d.get('safety_stock'), d.get('quantity')]) + item_list.append( + [ + d.get("item_code"), + d.get("item_name"), + d.get("description"), + d.get("stock_uom"), + d.get("warehouse"), + d.get("required_bom_qty"), + d.get("projected_qty"), + d.get("actual_qty"), + d.get("ordered_qty"), + d.get("planned_qty"), + d.get("reserved_qty_for_production"), + d.get("safety_stock"), + d.get("quantity"), + ] + ) - if not doc.get('for_warehouse'): - row = {'item_code': d.get('item_code')} + if not doc.get("for_warehouse"): + row = {"item_code": d.get("item_code")} for bin_dict in get_bin_details(row, doc.company, all_warehouse=True): - if d.get("warehouse") == bin_dict.get('warehouse'): + if d.get("warehouse") == bin_dict.get("warehouse"): continue - item_list.append(['', '', '', bin_dict.get('warehouse'), '', - bin_dict.get('projected_qty', 0), bin_dict.get('actual_qty', 0), - bin_dict.get('ordered_qty', 0), bin_dict.get('reserved_qty_for_production', 0)]) + item_list.append( + [ + "", + "", + "", + bin_dict.get("warehouse"), + "", + bin_dict.get("projected_qty", 0), + bin_dict.get("actual_qty", 0), + bin_dict.get("ordered_qty", 0), + bin_dict.get("reserved_qty_for_production", 0), + ] + ) build_csv_response(item_list, doc.name) + def get_exploded_items(item_details, company, bom_no, include_non_stock_items, planned_qty=1): - for d in frappe.db.sql("""select bei.item_code, item.default_bom as bom, - ifnull(sum(bei.stock_qty/ifnull(bom.quantity, 1)), 0)*%s as qty, item.item_name, - bei.description, bei.stock_uom, item.min_order_qty, bei.source_warehouse, - item.default_material_request_type, item.min_order_qty, item_default.default_warehouse, - item.purchase_uom, item_uom.conversion_factor, item.safety_stock - from - `tabBOM Explosion Item` bei - JOIN `tabBOM` bom ON bom.name = bei.parent - JOIN `tabItem` item ON item.name = bei.item_code - LEFT JOIN `tabItem Default` item_default - ON item_default.parent = item.name and item_default.company=%s - LEFT JOIN `tabUOM Conversion Detail` item_uom - ON item.name = item_uom.parent and item_uom.uom = item.purchase_uom - where - bei.docstatus < 2 - and bom.name=%s and item.is_stock_item in (1, {0}) - group by bei.item_code, bei.stock_uom""".format(0 if include_non_stock_items else 1), - (planned_qty, company, bom_no), as_dict=1): + bei = frappe.qb.DocType("BOM Explosion Item") + bom = frappe.qb.DocType("BOM") + item = frappe.qb.DocType("Item") + item_default = frappe.qb.DocType("Item Default") + item_uom = frappe.qb.DocType("UOM Conversion Detail") + + data = ( + frappe.qb.from_(bei) + .join(bom) + .on(bom.name == bei.parent) + .join(item) + .on(item.name == bei.item_code) + .left_join(item_default) + .on((item_default.parent == item.name) & (item_default.company == company)) + .left_join(item_uom) + .on((item.name == item_uom.parent) & (item_uom.uom == item.purchase_uom)) + .select( + (IfNull(Sum(bei.stock_qty / IfNull(bom.quantity, 1)), 0) * planned_qty).as_("qty"), + item.item_name, + item.name.as_("item_code"), + bei.description, + bei.stock_uom, + item.min_order_qty, + bei.source_warehouse, + item.default_material_request_type, + item.min_order_qty, + item_default.default_warehouse, + item.purchase_uom, + item_uom.conversion_factor, + item.safety_stock, + ) + .where( + (bei.docstatus < 2) + & (bom.name == bom_no) + & (item.is_stock_item.isin([0, 1]) if include_non_stock_items else item.is_stock_item == 1) + ) + .groupby(bei.item_code, bei.stock_uom) + ).run(as_dict=True) + + for d in data: if not d.conversion_factor and d.purchase_uom: d.conversion_factor = get_uom_conversion_factor(d.item_code, d.purchase_uom) - item_details.setdefault(d.get('item_code'), d) + item_details.setdefault(d.get("item_code"), d) return item_details -def get_uom_conversion_factor(item_code, uom): - return frappe.db.get_value('UOM Conversion Detail', - {'parent': item_code, 'uom': uom}, 'conversion_factor') -def get_subitems(doc, data, item_details, bom_no, company, include_non_stock_items, - include_subcontracted_items, parent_qty, planned_qty=1): - items = frappe.db.sql(""" - SELECT - bom_item.item_code, default_material_request_type, item.item_name, - ifnull(%(parent_qty)s * sum(bom_item.stock_qty/ifnull(bom.quantity, 1)) * %(planned_qty)s, 0) as qty, - item.is_sub_contracted_item as is_sub_contracted, bom_item.source_warehouse, - item.default_bom as default_bom, bom_item.description as description, - bom_item.stock_uom as stock_uom, item.min_order_qty as min_order_qty, item.safety_stock as safety_stock, - item_default.default_warehouse, item.purchase_uom, item_uom.conversion_factor - FROM - `tabBOM Item` bom_item - JOIN `tabBOM` bom ON bom.name = bom_item.parent - JOIN tabItem item ON bom_item.item_code = item.name - LEFT JOIN `tabItem Default` item_default - ON item.name = item_default.parent and item_default.company = %(company)s - LEFT JOIN `tabUOM Conversion Detail` item_uom - ON item.name = item_uom.parent and item_uom.uom = item.purchase_uom - where - bom.name = %(bom)s - and bom_item.docstatus < 2 - and item.is_stock_item in (1, {0}) - group by bom_item.item_code""".format(0 if include_non_stock_items else 1),{ - 'bom': bom_no, - 'parent_qty': parent_qty, - 'planned_qty': planned_qty, - 'company': company - }, as_dict=1) +def get_uom_conversion_factor(item_code, uom): + return frappe.db.get_value( + "UOM Conversion Detail", {"parent": item_code, "uom": uom}, "conversion_factor" + ) + + +def get_subitems( + doc, + data, + item_details, + bom_no, + company, + include_non_stock_items, + include_subcontracted_items, + parent_qty, + planned_qty=1, +): + bom_item = frappe.qb.DocType("BOM Item") + bom = frappe.qb.DocType("BOM") + item = frappe.qb.DocType("Item") + item_default = frappe.qb.DocType("Item Default") + item_uom = frappe.qb.DocType("UOM Conversion Detail") + + items = ( + frappe.qb.from_(bom_item) + .join(bom) + .on(bom.name == bom_item.parent) + .join(item) + .on(bom_item.item_code == item.name) + .left_join(item_default) + .on((item.name == item_default.parent) & (item_default.company == company)) + .left_join(item_uom) + .on((item.name == item_uom.parent) & (item_uom.uom == item.purchase_uom)) + .select( + bom_item.item_code, + item.default_material_request_type, + item.item_name, + IfNull(parent_qty * Sum(bom_item.stock_qty / IfNull(bom.quantity, 1)) * planned_qty, 0).as_( + "qty" + ), + item.is_sub_contracted_item.as_("is_sub_contracted"), + bom_item.source_warehouse, + item.default_bom.as_("default_bom"), + bom_item.description.as_("description"), + bom_item.stock_uom.as_("stock_uom"), + item.min_order_qty.as_("min_order_qty"), + item.safety_stock.as_("safety_stock"), + item_default.default_warehouse, + item.purchase_uom, + item_uom.conversion_factor, + ) + .where( + (bom.name == bom_no) + & (bom_item.docstatus < 2) + & (item.is_stock_item.isin([0, 1]) if include_non_stock_items else item.is_stock_item == 1) + ) + .groupby(bom_item.item_code) + ).run(as_dict=True) for d in items: - if not data.get('include_exploded_items') or not d.default_bom: + if not data.get("include_exploded_items") or not d.default_bom: if d.item_code in item_details: item_details[d.item_code].qty = item_details[d.item_code].qty + d.qty else: @@ -680,137 +926,189 @@ def get_subitems(doc, data, item_details, bom_no, company, include_non_stock_ite item_details[d.item_code] = d - if data.get('include_exploded_items') and d.default_bom: - if ((d.default_material_request_type in ["Manufacture", "Purchase"] and - not d.is_sub_contracted) or (d.is_sub_contracted and include_subcontracted_items)): + if data.get("include_exploded_items") and d.default_bom: + if ( + d.default_material_request_type in ["Manufacture", "Purchase"] and not d.is_sub_contracted + ) or (d.is_sub_contracted and include_subcontracted_items): if d.qty > 0: - get_subitems(doc, data, item_details, d.default_bom, company, - include_non_stock_items, include_subcontracted_items, d.qty) + get_subitems( + doc, + data, + item_details, + d.default_bom, + company, + include_non_stock_items, + include_subcontracted_items, + d.qty, + ) return item_details -def get_material_request_items(row, sales_order, company, - ignore_existing_ordered_qty, include_safety_stock, warehouse, bin_dict): - total_qty = row['qty'] + +def get_material_request_items( + row, sales_order, company, ignore_existing_ordered_qty, include_safety_stock, warehouse, bin_dict +): + total_qty = row["qty"] required_qty = 0 if ignore_existing_ordered_qty or bin_dict.get("projected_qty", 0) < 0: required_qty = total_qty elif total_qty > bin_dict.get("projected_qty", 0): required_qty = total_qty - bin_dict.get("projected_qty", 0) - if required_qty > 0 and required_qty < row['min_order_qty']: - required_qty = row['min_order_qty'] + if required_qty > 0 and required_qty < row["min_order_qty"]: + required_qty = row["min_order_qty"] item_group_defaults = get_item_group_defaults(row.item_code, company) - if not row['purchase_uom']: - row['purchase_uom'] = row['stock_uom'] + if not row["purchase_uom"]: + row["purchase_uom"] = row["stock_uom"] - if row['purchase_uom'] != row['stock_uom']: - if not (row['conversion_factor'] or frappe.flags.show_qty_in_stock_uom): - frappe.throw(_("UOM Conversion factor ({0} -> {1}) not found for item: {2}") - .format(row['purchase_uom'], row['stock_uom'], row.item_code)) + if row["purchase_uom"] != row["stock_uom"]: + if not (row["conversion_factor"] or frappe.flags.show_qty_in_stock_uom): + frappe.throw( + _("UOM Conversion factor ({0} -> {1}) not found for item: {2}").format( + row["purchase_uom"], row["stock_uom"], row.item_code + ) + ) - required_qty = required_qty / row['conversion_factor'] + required_qty = required_qty / row["conversion_factor"] - if frappe.db.get_value("UOM", row['purchase_uom'], "must_be_whole_number"): + if frappe.db.get_value("UOM", row["purchase_uom"], "must_be_whole_number"): required_qty = ceil(required_qty) if include_safety_stock: - required_qty += flt(row['safety_stock']) + required_qty += flt(row["safety_stock"]) if required_qty > 0: return { - 'item_code': row.item_code, - 'item_name': row.item_name, - 'quantity': required_qty, - 'required_bom_qty': total_qty, - 'stock_uom': row.get("stock_uom"), - 'warehouse': warehouse or row.get('source_warehouse') \ - or row.get('default_warehouse') or item_group_defaults.get("default_warehouse"), - 'safety_stock': row.safety_stock, - 'actual_qty': bin_dict.get("actual_qty", 0), - 'projected_qty': bin_dict.get("projected_qty", 0), - 'ordered_qty': bin_dict.get("ordered_qty", 0), - 'reserved_qty_for_production': bin_dict.get("reserved_qty_for_production", 0), - 'min_order_qty': row['min_order_qty'], - 'material_request_type': row.get("default_material_request_type"), - 'sales_order': sales_order, - 'description': row.get("description"), - 'uom': row.get("purchase_uom") or row.get("stock_uom") + "item_code": row.item_code, + "item_name": row.item_name, + "quantity": required_qty, + "required_bom_qty": total_qty, + "stock_uom": row.get("stock_uom"), + "warehouse": warehouse + or row.get("source_warehouse") + or row.get("default_warehouse") + or item_group_defaults.get("default_warehouse"), + "safety_stock": row.safety_stock, + "actual_qty": bin_dict.get("actual_qty", 0), + "projected_qty": bin_dict.get("projected_qty", 0), + "ordered_qty": bin_dict.get("ordered_qty", 0), + "reserved_qty_for_production": bin_dict.get("reserved_qty_for_production", 0), + "min_order_qty": row["min_order_qty"], + "material_request_type": row.get("default_material_request_type"), + "sales_order": sales_order, + "description": row.get("description"), + "uom": row.get("purchase_uom") or row.get("stock_uom"), } + def get_sales_orders(self): - so_filter = item_filter = "" - bom_item = "bom.item = so_item.item_code" + bom = frappe.qb.DocType("BOM") + pi = frappe.qb.DocType("Packed Item") + so = frappe.qb.DocType("Sales Order") + so_item = frappe.qb.DocType("Sales Order Item") + + open_so_subquery1 = frappe.qb.from_(bom).select(bom.name).where(bom.is_active == 1) + + open_so_subquery2 = ( + frappe.qb.from_(pi) + .select(pi.name) + .where( + (pi.parent == so.name) + & (pi.parent_item == so_item.item_code) + & ( + ExistsCriterion( + frappe.qb.from_(bom).select(bom.name).where((bom.item == pi.item_code) & (bom.is_active == 1)) + ) + ) + ) + ) + + open_so_query = ( + frappe.qb.from_(so) + .from_(so_item) + .select(so.name, so.transaction_date, so.customer, so.base_grand_total) + .distinct() + .where( + (so_item.parent == so.name) + & (so.docstatus == 1) + & (so.status.notin(["Stopped", "Closed"])) + & (so.company == self.company) + & (so_item.qty > so_item.work_order_qty) + ) + ) date_field_mapper = { - 'from_date': ('>=', 'so.transaction_date'), - 'to_date': ('<=', 'so.transaction_date'), - 'from_delivery_date': ('>=', 'so_item.delivery_date'), - 'to_delivery_date': ('<=', 'so_item.delivery_date') + "from_date": self.from_date >= so.transaction_date, + "to_date": self.to_date <= so.transaction_date, + "from_delivery_date": self.from_delivery_date >= so_item.delivery_date, + "to_delivery_date": self.to_delivery_date <= so_item.delivery_date, } for field, value in date_field_mapper.items(): if self.get(field): - so_filter += f" and {value[1]} {value[0]} %({field})s" + open_so_query = open_so_query.where(value) - for field in ['customer', 'project', 'sales_order_status']: + for field in ("customer", "project", "sales_order_status"): if self.get(field): - so_field = 'status' if field == 'sales_order_status' else field - so_filter += f" and so.{so_field} = %({field})s" + so_field = "status" if field == "sales_order_status" else field + open_so_query = open_so_query.where(so[so_field] == self.get(field)) - if self.item_code and frappe.db.exists('Item', self.item_code): - bom_item = self.get_bom_item() or bom_item - item_filter += " and so_item.item_code = %(item_code)s" + if self.item_code and frappe.db.exists("Item", self.item_code): + open_so_query = open_so_query.where(so_item.item_code == self.item_code) + open_so_subquery1 = open_so_subquery1.where( + self.get_bom_item_condition() or bom.item == so_item.item_code + ) - open_so = frappe.db.sql(f""" - select distinct so.name, so.transaction_date, so.customer, so.base_grand_total - from `tabSales Order` so, `tabSales Order Item` so_item - where so_item.parent = so.name - and so.docstatus = 1 and so.status not in ("Stopped", "Closed") - and so.company = %(company)s - and so_item.qty > so_item.work_order_qty {so_filter} {item_filter} - and (exists (select name from `tabBOM` bom where {bom_item} - and bom.is_active = 1) - or exists (select name from `tabPacked Item` pi - where pi.parent = so.name and pi.parent_item = so_item.item_code - and exists (select name from `tabBOM` bom where bom.item=pi.item_code - and bom.is_active = 1))) - """, self.as_dict(), as_dict=1) + open_so_query = open_so_query.where( + (ExistsCriterion(open_so_subquery1) | ExistsCriterion(open_so_subquery2)) + ) + + open_so = open_so_query.run(as_dict=True) return open_so + @frappe.whitelist() def get_bin_details(row, company, for_warehouse=None, all_warehouse=False): if isinstance(row, str): row = frappe._dict(json.loads(row)) - company = frappe.db.escape(company) - conditions, warehouse = "", "" + bin = frappe.qb.DocType("Bin") + wh = frappe.qb.DocType("Warehouse") + + subquery = frappe.qb.from_(wh).select(wh.name).where(wh.company == company) - conditions = " and warehouse in (select name from `tabWarehouse` where company = {0})".format(company) if not all_warehouse: - warehouse = for_warehouse or row.get('source_warehouse') or row.get('default_warehouse') + warehouse = for_warehouse or row.get("source_warehouse") or row.get("default_warehouse") if warehouse: lft, rgt = frappe.db.get_value("Warehouse", warehouse, ["lft", "rgt"]) - conditions = """ and warehouse in (select name from `tabWarehouse` - where lft >= {0} and rgt <= {1} and name=`tabBin`.warehouse and company = {2}) - """.format(lft, rgt, company) + subquery = subquery.where((wh.lft >= lft) & (wh.rgt <= rgt) & (wh.name == bin.warehouse)) + + query = ( + frappe.qb.from_(bin) + .select( + bin.warehouse, + IfNull(Sum(bin.projected_qty), 0).as_("projected_qty"), + IfNull(Sum(bin.actual_qty), 0).as_("actual_qty"), + IfNull(Sum(bin.ordered_qty), 0).as_("ordered_qty"), + IfNull(Sum(bin.reserved_qty_for_production), 0).as_("reserved_qty_for_production"), + IfNull(Sum(bin.planned_qty), 0).as_("planned_qty"), + ) + .where((bin.item_code == row["item_code"]) & (bin.warehouse.isin(subquery))) + .groupby(bin.item_code, bin.warehouse) + ) + + return query.run(as_dict=True) - return frappe.db.sql(""" select ifnull(sum(projected_qty),0) as projected_qty, - ifnull(sum(actual_qty),0) as actual_qty, ifnull(sum(ordered_qty),0) as ordered_qty, - ifnull(sum(reserved_qty_for_production),0) as reserved_qty_for_production, warehouse, - ifnull(sum(planned_qty),0) as planned_qty - from `tabBin` where item_code = %(item_code)s {conditions} - group by item_code, warehouse - """.format(conditions=conditions), { "item_code": row['item_code'] }, as_dict=1) @frappe.whitelist() def get_so_details(sales_order): - return frappe.db.get_value("Sales Order", sales_order, - ['transaction_date', 'customer', 'grand_total'], as_dict=1 + return frappe.db.get_value( + "Sales Order", sales_order, ["transaction_date", "customer", "grand_total"], as_dict=1 ) + def get_warehouse_list(warehouses): warehouse_list = [] @@ -818,7 +1116,7 @@ def get_warehouse_list(warehouses): warehouses = json.loads(warehouses) for row in warehouses: - child_warehouses = frappe.db.get_descendants('Warehouse', row.get("warehouse")) + child_warehouses = frappe.db.get_descendants("Warehouse", row.get("warehouse")) if child_warehouses: warehouse_list.extend(child_warehouses) else: @@ -826,6 +1124,7 @@ def get_warehouse_list(warehouses): return warehouse_list + @frappe.whitelist() def get_items_for_material_requests(doc, warehouses=None, get_parent_warehouse_data=None): if isinstance(doc, str): @@ -834,73 +1133,92 @@ def get_items_for_material_requests(doc, warehouses=None, get_parent_warehouse_d if warehouses: warehouses = list(set(get_warehouse_list(warehouses))) - if doc.get("for_warehouse") and not get_parent_warehouse_data and doc.get("for_warehouse") in warehouses: + if ( + doc.get("for_warehouse") + and not get_parent_warehouse_data + and doc.get("for_warehouse") in warehouses + ): warehouses.remove(doc.get("for_warehouse")) - doc['mr_items'] = [] + doc["mr_items"] = [] - po_items = doc.get('po_items') if doc.get('po_items') else doc.get('items') + po_items = doc.get("po_items") if doc.get("po_items") else doc.get("items") # Check for empty table or empty rows - if not po_items or not [row.get('item_code') for row in po_items if row.get('item_code')]: - frappe.throw(_("Items to Manufacture are required to pull the Raw Materials associated with it."), - title=_("Items Required")) + if not po_items or not [row.get("item_code") for row in po_items if row.get("item_code")]: + frappe.throw( + _("Items to Manufacture are required to pull the Raw Materials associated with it."), + title=_("Items Required"), + ) - company = doc.get('company') - ignore_existing_ordered_qty = doc.get('ignore_existing_ordered_qty') - include_safety_stock = doc.get('include_safety_stock') + company = doc.get("company") + ignore_existing_ordered_qty = doc.get("ignore_existing_ordered_qty") + include_safety_stock = doc.get("include_safety_stock") so_item_details = frappe._dict() for data in po_items: if not data.get("include_exploded_items") and doc.get("sub_assembly_items"): data["include_exploded_items"] = 1 - planned_qty = data.get('required_qty') or data.get('planned_qty') - ignore_existing_ordered_qty = data.get('ignore_existing_ordered_qty') or ignore_existing_ordered_qty - warehouse = doc.get('for_warehouse') + planned_qty = data.get("required_qty") or data.get("planned_qty") + ignore_existing_ordered_qty = ( + data.get("ignore_existing_ordered_qty") or ignore_existing_ordered_qty + ) + warehouse = doc.get("for_warehouse") item_details = {} if data.get("bom") or data.get("bom_no"): - if data.get('required_qty'): - bom_no = data.get('bom') + if data.get("required_qty"): + bom_no = data.get("bom") include_non_stock_items = 1 - include_subcontracted_items = 1 if data.get('include_exploded_items') else 0 + include_subcontracted_items = 1 if data.get("include_exploded_items") else 0 else: - bom_no = data.get('bom_no') - include_subcontracted_items = doc.get('include_subcontracted_items') - include_non_stock_items = doc.get('include_non_stock_items') + bom_no = data.get("bom_no") + include_subcontracted_items = doc.get("include_subcontracted_items") + include_non_stock_items = doc.get("include_non_stock_items") if not planned_qty: - frappe.throw(_("For row {0}: Enter Planned Qty").format(data.get('idx'))) + frappe.throw(_("For row {0}: Enter Planned Qty").format(data.get("idx"))) if bom_no: - if data.get('include_exploded_items') and include_subcontracted_items: + if data.get("include_exploded_items") and include_subcontracted_items: # fetch exploded items from BOM - item_details = get_exploded_items(item_details, - company, bom_no, include_non_stock_items, planned_qty=planned_qty) + item_details = get_exploded_items( + item_details, company, bom_no, include_non_stock_items, planned_qty=planned_qty + ) else: - item_details = get_subitems(doc, data, item_details, bom_no, company, - include_non_stock_items, include_subcontracted_items, 1, planned_qty=planned_qty) - elif data.get('item_code'): - item_master = frappe.get_doc('Item', data['item_code']).as_dict() + item_details = get_subitems( + doc, + data, + item_details, + bom_no, + company, + include_non_stock_items, + include_subcontracted_items, + 1, + planned_qty=planned_qty, + ) + elif data.get("item_code"): + item_master = frappe.get_doc("Item", data["item_code"]).as_dict() purchase_uom = item_master.purchase_uom or item_master.stock_uom - conversion_factor = (get_uom_conversion_factor(item_master.name, purchase_uom) - if item_master.purchase_uom else 1.0) + conversion_factor = ( + get_uom_conversion_factor(item_master.name, purchase_uom) if item_master.purchase_uom else 1.0 + ) item_details[item_master.name] = frappe._dict( { - 'item_name' : item_master.item_name, - 'default_bom' : doc.bom, - 'purchase_uom' : purchase_uom, - 'default_warehouse': item_master.default_warehouse, - 'min_order_qty' : item_master.min_order_qty, - 'default_material_request_type' : item_master.default_material_request_type, - 'qty': planned_qty or 1, - 'is_sub_contracted' : item_master.is_subcontracted_item, - 'item_code' : item_master.name, - 'description' : item_master.description, - 'stock_uom' : item_master.stock_uom, - 'conversion_factor' : conversion_factor, - 'safety_stock': item_master.safety_stock + "item_name": item_master.item_name, + "default_bom": doc.bom, + "purchase_uom": purchase_uom, + "default_warehouse": item_master.default_warehouse, + "min_order_qty": item_master.min_order_qty, + "default_material_request_type": item_master.default_material_request_type, + "qty": planned_qty or 1, + "is_sub_contracted": item_master.is_subcontracted_item, + "item_code": item_master.name, + "description": item_master.description, + "stock_uom": item_master.stock_uom, + "conversion_factor": conversion_factor, + "safety_stock": item_master.safety_stock, } ) @@ -909,7 +1227,9 @@ def get_items_for_material_requests(doc, warehouses=None, get_parent_warehouse_d for item_code, details in iteritems(item_details): so_item_details.setdefault(sales_order, frappe._dict()) if item_code in so_item_details.get(sales_order, {}): - so_item_details[sales_order][item_code]['qty'] = so_item_details[sales_order][item_code].get("qty", 0) + flt(details.qty) + so_item_details[sales_order][item_code]["qty"] = so_item_details[sales_order][item_code].get( + "qty", 0 + ) + flt(details.qty) else: so_item_details[sales_order][item_code] = details @@ -921,8 +1241,15 @@ def get_items_for_material_requests(doc, warehouses=None, get_parent_warehouse_d bin_dict = bin_dict[0] if bin_dict else {} if details.qty > 0: - items = get_material_request_items(details, sales_order, company, - ignore_existing_ordered_qty, include_safety_stock, warehouse, bin_dict) + items = get_material_request_items( + details, + sales_order, + company, + ignore_existing_ordered_qty, + include_safety_stock, + warehouse, + bin_dict, + ) if items: mr_items.append(items) @@ -935,44 +1262,73 @@ def get_items_for_material_requests(doc, warehouses=None, get_parent_warehouse_d if not mr_items: to_enable = frappe.bold(_("Ignore Existing Projected Quantity")) - warehouse = frappe.bold(doc.get('for_warehouse')) - message = _("As there are sufficient raw materials, Material Request is not required for Warehouse {0}.").format(warehouse) + "
" + warehouse = frappe.bold(doc.get("for_warehouse")) + message = ( + _( + "As there are sufficient raw materials, Material Request is not required for Warehouse {0}." + ).format(warehouse) + + "
" + ) message += _("If you still want to proceed, please enable {0}.").format(to_enable) frappe.msgprint(message, title=_("Note")) return mr_items + def get_materials_from_other_locations(item, warehouses, new_mr_items, company): from erpnext.stock.doctype.pick_list.pick_list import get_available_item_locations - locations = get_available_item_locations(item.get("item_code"), - warehouses, item.get("quantity"), company, ignore_validation=True) - if not locations: - new_mr_items.append(item) - return + locations = get_available_item_locations( + item.get("item_code"), warehouses, item.get("quantity"), company, ignore_validation=True + ) required_qty = item.get("quantity") + # get available material by transferring to production warehouse for d in locations: - if required_qty <=0: return + if required_qty <= 0: + return new_dict = copy.deepcopy(item) quantity = required_qty if d.get("qty") > required_qty else d.get("qty") - if required_qty > 0: - new_dict.update({ + new_dict.update( + { "quantity": quantity, "material_request_type": "Material Transfer", - "from_warehouse": d.get("warehouse") - }) + "uom": new_dict.get("stock_uom"), # internal transfer should be in stock UOM + "from_warehouse": d.get("warehouse"), + } + ) - required_qty -= quantity - new_mr_items.append(new_dict) + required_qty -= quantity + new_mr_items.append(new_dict) + # raise purchase request for remaining qty if required_qty: + stock_uom, purchase_uom = frappe.db.get_value( + "Item", item["item_code"], ["stock_uom", "purchase_uom"] + ) + + if purchase_uom != stock_uom and purchase_uom == item["uom"]: + conversion_factor = get_uom_conversion_factor(item["item_code"], item["uom"]) + if not (conversion_factor or frappe.flags.show_qty_in_stock_uom): + frappe.throw( + _("UOM Conversion factor ({0} -> {1}) not found for item: {2}").format( + purchase_uom, stock_uom, item["item_code"] + ) + ) + + required_qty = required_qty / conversion_factor + + if frappe.db.get_value("UOM", purchase_uom, "must_be_whole_number"): + required_qty = ceil(required_qty) + item["quantity"] = required_qty + new_mr_items.append(item) + @frappe.whitelist() def get_item_data(item_code): item_details = get_item_details(item_code) @@ -980,31 +1336,39 @@ def get_item_data(item_code): return { "bom_no": item_details.get("bom_no"), "stock_uom": item_details.get("stock_uom") -# "description": item_details.get("description") + # "description": item_details.get("description") } + def get_sub_assembly_items(bom_no, bom_data, to_produce_qty, indent=0): - data = get_children('BOM', parent = bom_no) + data = get_children("BOM", parent=bom_no) for d in data: if d.expandable: parent_item_code = frappe.get_cached_value("BOM", bom_no, "item") - bom_level = (frappe.get_cached_value("BOM", d.value, "bom_level") - if d.value else 0) - stock_qty = (d.stock_qty / d.parent_bom_qty) * flt(to_produce_qty) - bom_data.append(frappe._dict({ - 'parent_item_code': parent_item_code, - 'description': d.description, - 'production_item': d.item_code, - 'item_name': d.item_name, - 'stock_uom': d.stock_uom, - 'uom': d.stock_uom, - 'bom_no': d.value, - 'is_sub_contracted_item': d.is_sub_contracted_item, - 'bom_level': bom_level, - 'indent': indent, - 'stock_qty': stock_qty - })) + bom_data.append( + frappe._dict( + { + "parent_item_code": parent_item_code, + "description": d.description, + "production_item": d.item_code, + "item_name": d.item_name, + "stock_uom": d.stock_uom, + "uom": d.stock_uom, + "bom_no": d.value, + "is_sub_contracted_item": d.is_sub_contracted_item, + "bom_level": indent, + "indent": indent, + "stock_qty": stock_qty, + } + ) + ) if d.value: - get_sub_assembly_items(d.value, bom_data, stock_qty, indent=indent+1) + get_sub_assembly_items(d.value, bom_data, stock_qty, indent=indent + 1) + + +def set_default_warehouses(row, default_warehouses): + for field in ["wip_warehouse", "fg_warehouse"]: + if not row.get(field): + row[field] = default_warehouses.get(field) diff --git a/erpnext/manufacturing/doctype/production_plan/production_plan_dashboard.py b/erpnext/manufacturing/doctype/production_plan/production_plan_dashboard.py index ef009765f92..6fc28a30971 100644 --- a/erpnext/manufacturing/doctype/production_plan/production_plan_dashboard.py +++ b/erpnext/manufacturing/doctype/production_plan/production_plan_dashboard.py @@ -1,18 +1,11 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'production_plan', - 'transactions': [ - { - 'label': _('Transactions'), - 'items': ['Work Order', 'Material Request'] - }, - { - 'label': _('Subcontract'), - 'items': ['Purchase Order'] - }, - ] + "fieldname": "production_plan", + "transactions": [ + {"label": _("Transactions"), "items": ["Work Order", "Material Request"]}, + {"label": _("Subcontract"), "items": ["Purchase Order"]}, + ], } diff --git a/erpnext/manufacturing/doctype/production_plan/test_production_plan.py b/erpnext/manufacturing/doctype/production_plan/test_production_plan.py index a2980a732ed..f0d4ce0ca82 100644 --- a/erpnext/manufacturing/doctype/production_plan/test_production_plan.py +++ b/erpnext/manufacturing/doctype/production_plan/test_production_plan.py @@ -1,9 +1,7 @@ # Copyright (c) 2017, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt - -import unittest - import frappe +from frappe.tests.utils import FrappeTestCase from frappe.utils import add_to_date, flt, now_datetime, nowdate from erpnext.controllers.item_variant import create_variant @@ -12,83 +10,115 @@ from erpnext.manufacturing.doctype.production_plan.production_plan import ( get_sales_orders, get_warehouse_list, ) +from erpnext.manufacturing.doctype.work_order.work_order import OverProductionError +from erpnext.manufacturing.doctype.work_order.work_order import make_stock_entry as make_se_from_wo +from erpnext.selling.doctype.sales_order.sales_order import make_delivery_note from erpnext.selling.doctype.sales_order.test_sales_order import make_sales_order -from erpnext.stock.doctype.item.test_item import create_item +from erpnext.stock.doctype.item.test_item import create_item, make_item +from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry from erpnext.stock.doctype.stock_reconciliation.test_stock_reconciliation import ( create_stock_reconciliation, ) -class TestProductionPlan(unittest.TestCase): +class TestProductionPlan(FrappeTestCase): def setUp(self): - for item in ['Test Production Item 1', 'Subassembly Item 1', - 'Raw Material Item 1', 'Raw Material Item 2']: + for item in [ + "Test Production Item 1", + "Subassembly Item 1", + "Raw Material Item 1", + "Raw Material Item 2", + ]: create_item(item, valuation_rate=100) - sr = frappe.db.get_value('Stock Reconciliation Item', - {'item_code': item, 'docstatus': 1}, 'parent') + sr = frappe.db.get_value( + "Stock Reconciliation Item", {"item_code": item, "docstatus": 1}, "parent" + ) if sr: - sr_doc = frappe.get_doc('Stock Reconciliation', sr) + sr_doc = frappe.get_doc("Stock Reconciliation", sr) sr_doc.cancel() - create_item('Test Non Stock Raw Material', is_stock_item=0) - for item, raw_materials in {'Subassembly Item 1': ['Raw Material Item 1', 'Raw Material Item 2'], - 'Test Production Item 1': ['Raw Material Item 1', 'Subassembly Item 1', - 'Test Non Stock Raw Material']}.items(): - if not frappe.db.get_value('BOM', {'item': item}): - make_bom(item = item, raw_materials = raw_materials) + create_item("Test Non Stock Raw Material", is_stock_item=0) + for item, raw_materials in { + "Subassembly Item 1": ["Raw Material Item 1", "Raw Material Item 2"], + "Test Production Item 1": [ + "Raw Material Item 1", + "Subassembly Item 1", + "Test Non Stock Raw Material", + ], + }.items(): + if not frappe.db.get_value("BOM", {"item": item}): + make_bom(item=item, raw_materials=raw_materials) - def test_production_plan(self): - pln = create_production_plan(item_code='Test Production Item 1') + def test_production_plan_mr_creation(self): + "Test if MRs are created for unavailable raw materials." + pln = create_production_plan(item_code="Test Production Item 1") self.assertTrue(len(pln.mr_items), 2) - pln.make_material_request() - pln = frappe.get_doc('Production Plan', pln.name) - self.assertTrue(pln.status, 'Material Requested') - material_requests = frappe.get_all('Material Request Item', fields = ['distinct parent'], - filters = {'production_plan': pln.name}, as_list=1) + pln.make_material_request() + pln.reload() + self.assertTrue(pln.status, "Material Requested") + + material_requests = frappe.get_all( + "Material Request Item", + fields=["distinct parent"], + filters={"production_plan": pln.name}, + as_list=1, + ) self.assertTrue(len(material_requests), 2) pln.make_work_order() - work_orders = frappe.get_all('Work Order', fields = ['name'], - filters = {'production_plan': pln.name}, as_list=1) + work_orders = frappe.get_all( + "Work Order", fields=["name"], filters={"production_plan": pln.name}, as_list=1 + ) self.assertTrue(len(work_orders), len(pln.po_items)) for name in material_requests: - mr = frappe.get_doc('Material Request', name[0]) + mr = frappe.get_doc("Material Request", name[0]) if mr.docstatus != 0: mr.cancel() for name in work_orders: - mr = frappe.delete_doc('Work Order', name[0]) + mr = frappe.delete_doc("Work Order", name[0]) - pln = frappe.get_doc('Production Plan', pln.name) + pln = frappe.get_doc("Production Plan", pln.name) pln.cancel() def test_production_plan_start_date(self): + "Test if Work Order has same Planned Start Date as Prod Plan." planned_date = add_to_date(date=None, days=3) - plan = create_production_plan(item_code='Test Production Item 1', planned_start_date=planned_date) + plan = create_production_plan( + item_code="Test Production Item 1", planned_start_date=planned_date + ) plan.make_work_order() - work_orders = frappe.get_all('Work Order', fields = ['name', 'planned_start_date'], - filters = {'production_plan': plan.name}) + work_orders = frappe.get_all( + "Work Order", fields=["name", "planned_start_date"], filters={"production_plan": plan.name} + ) self.assertEqual(work_orders[0].planned_start_date, planned_date) for wo in work_orders: - frappe.delete_doc('Work Order', wo.name) + frappe.delete_doc("Work Order", wo.name) - frappe.get_doc('Production Plan', plan.name).cancel() + plan.reload() + plan.cancel() def test_production_plan_for_existing_ordered_qty(self): - sr1 = create_stock_reconciliation(item_code="Raw Material Item 1", - target="_Test Warehouse - _TC", qty=1, rate=110) - sr2 = create_stock_reconciliation(item_code="Raw Material Item 2", - target="_Test Warehouse - _TC", qty=1, rate=120) + """ + - Enable 'ignore_existing_ordered_qty'. + - Test if MR Planning table pulls Raw Material Qty even if it is in stock. + """ + sr1 = create_stock_reconciliation( + item_code="Raw Material Item 1", target="_Test Warehouse - _TC", qty=1, rate=110 + ) + sr2 = create_stock_reconciliation( + item_code="Raw Material Item 2", target="_Test Warehouse - _TC", qty=1, rate=120 + ) - pln = create_production_plan(item_code='Test Production Item 1', ignore_existing_ordered_qty=0) + pln = create_production_plan(item_code="Test Production Item 1", ignore_existing_ordered_qty=1) self.assertTrue(len(pln.mr_items), 1) self.assertTrue(flt(pln.mr_items[0].quantity), 1.0) @@ -97,23 +127,33 @@ class TestProductionPlan(unittest.TestCase): pln.cancel() def test_production_plan_with_non_stock_item(self): - pln = create_production_plan(item_code='Test Production Item 1', include_non_stock_items=0) + "Test if MR Planning table includes Non Stock RM." + pln = create_production_plan(item_code="Test Production Item 1", include_non_stock_items=1) self.assertTrue(len(pln.mr_items), 3) pln.cancel() def test_production_plan_without_multi_level(self): - pln = create_production_plan(item_code='Test Production Item 1', use_multi_level_bom=0) + "Test MR Planning table for non exploded BOM." + pln = create_production_plan(item_code="Test Production Item 1", use_multi_level_bom=0) self.assertTrue(len(pln.mr_items), 2) pln.cancel() def test_production_plan_without_multi_level_for_existing_ordered_qty(self): - sr1 = create_stock_reconciliation(item_code="Raw Material Item 1", - target="_Test Warehouse - _TC", qty=1, rate=130) - sr2 = create_stock_reconciliation(item_code="Subassembly Item 1", - target="_Test Warehouse - _TC", qty=1, rate=140) + """ + - Disable 'ignore_existing_ordered_qty'. + - Test if MR Planning table avoids pulling Raw Material Qty as it is in stock for + non exploded BOM. + """ + sr1 = create_stock_reconciliation( + item_code="Raw Material Item 1", target="_Test Warehouse - _TC", qty=1, rate=130 + ) + sr2 = create_stock_reconciliation( + item_code="Subassembly Item 1", target="_Test Warehouse - _TC", qty=1, rate=140 + ) - pln = create_production_plan(item_code='Test Production Item 1', - use_multi_level_bom=0, ignore_existing_ordered_qty=0) + pln = create_production_plan( + item_code="Test Production Item 1", use_multi_level_bom=0, ignore_existing_ordered_qty=0 + ) self.assertTrue(len(pln.mr_items), 0) sr1.cancel() @@ -121,72 +161,87 @@ class TestProductionPlan(unittest.TestCase): pln.cancel() def test_production_plan_sales_orders(self): - item = 'Test Production Item 1' + "Test if previously fulfilled SO (with WO) is pulled into Prod Plan." + item = "Test Production Item 1" so = make_sales_order(item_code=item, qty=1) sales_order = so.name sales_order_item = so.items[0].name - pln = frappe.new_doc('Production Plan') + pln = frappe.new_doc("Production Plan") pln.company = so.company - pln.get_items_from = 'Sales Order' + pln.get_items_from = "Sales Order" - pln.append('sales_orders', { - 'sales_order': so.name, - 'sales_order_date': so.transaction_date, - 'customer': so.customer, - 'grand_total': so.grand_total - }) + pln.append( + "sales_orders", + { + "sales_order": so.name, + "sales_order_date": so.transaction_date, + "customer": so.customer, + "grand_total": so.grand_total, + }, + ) pln.get_so_items() pln.submit() pln.make_work_order() - work_order = frappe.db.get_value('Work Order', {'sales_order': sales_order, - 'production_plan': pln.name, 'sales_order_item': sales_order_item}, 'name') + work_order = frappe.db.get_value( + "Work Order", + {"sales_order": sales_order, "production_plan": pln.name, "sales_order_item": sales_order_item}, + "name", + ) - wo_doc = frappe.get_doc('Work Order', work_order) - wo_doc.update({ - 'wip_warehouse': 'Work In Progress - _TC', - 'fg_warehouse': 'Finished Goods - _TC' - }) + wo_doc = frappe.get_doc("Work Order", work_order) + wo_doc.update( + {"wip_warehouse": "Work In Progress - _TC", "fg_warehouse": "Finished Goods - _TC"} + ) wo_doc.submit() - so_wo_qty = frappe.db.get_value('Sales Order Item', sales_order_item, 'work_order_qty') + so_wo_qty = frappe.db.get_value("Sales Order Item", sales_order_item, "work_order_qty") self.assertTrue(so_wo_qty, 5) - pln = frappe.new_doc('Production Plan') - pln.update({ - 'from_date': so.transaction_date, - 'to_date': so.transaction_date, - 'customer': so.customer, - 'item_code': item, - 'sales_order_status': so.status - }) + pln = frappe.new_doc("Production Plan") + pln.update( + { + "from_date": so.transaction_date, + "to_date": so.transaction_date, + "customer": so.customer, + "item_code": item, + "sales_order_status": so.status, + } + ) sales_orders = get_sales_orders(pln) or {} - sales_orders = [d.get('name') for d in sales_orders if d.get('name') == sales_order] + sales_orders = [d.get("name") for d in sales_orders if d.get("name") == sales_order] self.assertEqual(sales_orders, []) def test_production_plan_combine_items(self): - item = 'Test Production Item 1' - so = make_sales_order(item_code=item, qty=1) + "Test combining FG items in Production Plan." + item = "Test Production Item 1" + so1 = make_sales_order(item_code=item, qty=1) - pln = frappe.new_doc('Production Plan') - pln.company = so.company - pln.get_items_from = 'Sales Order' - pln.append('sales_orders', { - 'sales_order': so.name, - 'sales_order_date': so.transaction_date, - 'customer': so.customer, - 'grand_total': so.grand_total - }) - so = make_sales_order(item_code=item, qty=2) - pln.append('sales_orders', { - 'sales_order': so.name, - 'sales_order_date': so.transaction_date, - 'customer': so.customer, - 'grand_total': so.grand_total - }) + pln = frappe.new_doc("Production Plan") + pln.company = so1.company + pln.get_items_from = "Sales Order" + pln.append( + "sales_orders", + { + "sales_order": so1.name, + "sales_order_date": so1.transaction_date, + "customer": so1.customer, + "grand_total": so1.grand_total, + }, + ) + so2 = make_sales_order(item_code=item, qty=2) + pln.append( + "sales_orders", + { + "sales_order": so2.name, + "sales_order_date": so2.transaction_date, + "customer": so2.customer, + "grand_total": so2.grand_total, + }, + ) pln.combine_items = 1 pln.get_items() pln.submit() @@ -194,149 +249,175 @@ class TestProductionPlan(unittest.TestCase): self.assertTrue(pln.po_items[0].planned_qty, 3) pln.make_work_order() - work_order = frappe.db.get_value('Work Order', { - 'production_plan_item': pln.po_items[0].name, - 'production_plan': pln.name - }, 'name') + work_order = frappe.db.get_value( + "Work Order", + {"production_plan_item": pln.po_items[0].name, "production_plan": pln.name}, + "name", + ) - wo_doc = frappe.get_doc('Work Order', work_order) - wo_doc.update({ - 'wip_warehouse': 'Work In Progress - _TC', - }) + wo_doc = frappe.get_doc("Work Order", work_order) + wo_doc.update( + { + "wip_warehouse": "Work In Progress - _TC", + } + ) wo_doc.submit() so_items = [] for plan_reference in pln.prod_plan_references: so_items.append(plan_reference.sales_order_item) - so_wo_qty = frappe.db.get_value('Sales Order Item', plan_reference.sales_order_item, 'work_order_qty') + so_wo_qty = frappe.db.get_value( + "Sales Order Item", plan_reference.sales_order_item, "work_order_qty" + ) self.assertEqual(so_wo_qty, plan_reference.qty) wo_doc.cancel() for so_item in so_items: - so_wo_qty = frappe.db.get_value('Sales Order Item', so_item, 'work_order_qty') + so_wo_qty = frappe.db.get_value("Sales Order Item", so_item, "work_order_qty") self.assertEqual(so_wo_qty, 0.0) - latest_plan = frappe.get_doc('Production Plan', pln.name) - latest_plan.cancel() + pln.reload() + pln.cancel() def test_pp_to_mr_customer_provided(self): - #Material Request from Production Plan for Customer Provided - create_item('CUST-0987', is_customer_provided_item = 1, customer = '_Test Customer', is_purchase_item = 0) - create_item('Production Item CUST') - for item, raw_materials in {'Production Item CUST': ['Raw Material Item 1', 'CUST-0987']}.items(): - if not frappe.db.get_value('BOM', {'item': item}): - make_bom(item = item, raw_materials = raw_materials) - production_plan = create_production_plan(item_code = 'Production Item CUST') + "Test Material Request from Production Plan for Customer Provided Item." + create_item( + "CUST-0987", is_customer_provided_item=1, customer="_Test Customer", is_purchase_item=0 + ) + create_item("Production Item CUST") + + for item, raw_materials in { + "Production Item CUST": ["Raw Material Item 1", "CUST-0987"] + }.items(): + if not frappe.db.get_value("BOM", {"item": item}): + make_bom(item=item, raw_materials=raw_materials) + production_plan = create_production_plan(item_code="Production Item CUST") production_plan.make_material_request() - material_request = frappe.db.get_value('Material Request Item', {'production_plan': production_plan.name, 'item_code': 'CUST-0987'}, 'parent') - mr = frappe.get_doc('Material Request', material_request) - self.assertTrue(mr.material_request_type, 'Customer Provided') - self.assertTrue(mr.customer, '_Test Customer') + + material_request = frappe.db.get_value( + "Material Request Item", + {"production_plan": production_plan.name, "item_code": "CUST-0987"}, + "parent", + ) + mr = frappe.get_doc("Material Request", material_request) + + self.assertTrue(mr.material_request_type, "Customer Provided") + self.assertTrue(mr.customer, "_Test Customer") def test_production_plan_with_multi_level_bom(self): - #|Item Code | Qty | - #|Test BOM 1 | 1 | - #| Test BOM 2 | 2 | - #| Test BOM 3 | 3 | + """ + Item Code | Qty | + |Test BOM 1 | 1 | + |Test BOM 2 | 2 | + |Test BOM 3 | 3 | + """ for item_code in ["Test BOM 1", "Test BOM 2", "Test BOM 3", "Test RM BOM 1"]: create_item(item_code, is_stock_item=1) # created bom upto 3 level - if not frappe.db.get_value('BOM', {'item': "Test BOM 3"}): - make_bom(item = "Test BOM 3", raw_materials = ["Test RM BOM 1"], rm_qty=3) + if not frappe.db.get_value("BOM", {"item": "Test BOM 3"}): + make_bom(item="Test BOM 3", raw_materials=["Test RM BOM 1"], rm_qty=3) - if not frappe.db.get_value('BOM', {'item': "Test BOM 2"}): - make_bom(item = "Test BOM 2", raw_materials = ["Test BOM 3"], rm_qty=3) + if not frappe.db.get_value("BOM", {"item": "Test BOM 2"}): + make_bom(item="Test BOM 2", raw_materials=["Test BOM 3"], rm_qty=3) - if not frappe.db.get_value('BOM', {'item': "Test BOM 1"}): - make_bom(item = "Test BOM 1", raw_materials = ["Test BOM 2"], rm_qty=2) + if not frappe.db.get_value("BOM", {"item": "Test BOM 1"}): + make_bom(item="Test BOM 1", raw_materials=["Test BOM 2"], rm_qty=2) item_code = "Test BOM 1" - pln = frappe.new_doc('Production Plan') + pln = frappe.new_doc("Production Plan") pln.company = "_Test Company" - pln.append("po_items", { - "item_code": item_code, - "bom_no": frappe.db.get_value('BOM', {'item': "Test BOM 1"}), - "planned_qty": 3 - }) + pln.append( + "po_items", + { + "item_code": item_code, + "bom_no": frappe.db.get_value("BOM", {"item": "Test BOM 1"}), + "planned_qty": 3, + }, + ) - pln.get_sub_assembly_items('In House') + pln.get_sub_assembly_items("In House") pln.submit() pln.make_work_order() - #last level sub-assembly work order produce qty - to_produce_qty = frappe.db.get_value("Work Order", - {"production_plan": pln.name, "production_item": "Test BOM 3"}, "qty") + # last level sub-assembly work order produce qty + to_produce_qty = frappe.db.get_value( + "Work Order", {"production_plan": pln.name, "production_item": "Test BOM 3"}, "qty" + ) self.assertEqual(to_produce_qty, 18.0) pln.cancel() frappe.delete_doc("Production Plan", pln.name) def test_get_warehouse_list_group(self): - """Check if required warehouses are returned""" - warehouse_json = '[{\"warehouse\":\"_Test Warehouse Group - _TC\"}]' + "Check if required child warehouses are returned." + warehouse_json = '[{"warehouse":"_Test Warehouse Group - _TC"}]' warehouses = set(get_warehouse_list(warehouse_json)) expected_warehouses = {"_Test Warehouse Group-C1 - _TC", "_Test Warehouse Group-C2 - _TC"} missing_warehouse = expected_warehouses - warehouses - self.assertTrue(len(missing_warehouse) == 0, - msg=f"Following warehouses were expected {', '.join(missing_warehouse)}") + self.assertTrue( + len(missing_warehouse) == 0, + msg=f"Following warehouses were expected {', '.join(missing_warehouse)}", + ) def test_get_warehouse_list_single(self): - warehouse_json = '[{\"warehouse\":\"_Test Scrap Warehouse - _TC\"}]' + "Check if same warehouse is returned in absence of child warehouses." + warehouse_json = '[{"warehouse":"_Test Scrap Warehouse - _TC"}]' warehouses = set(get_warehouse_list(warehouse_json)) - expected_warehouses = {"_Test Scrap Warehouse - _TC", } + expected_warehouses = { + "_Test Scrap Warehouse - _TC", + } self.assertEqual(warehouses, expected_warehouses) def test_get_sales_order_with_variant(self): - rm_item = create_item('PIV_RM', valuation_rate = 100) - if not frappe.db.exists('Item', {"item_code": 'PIV'}): - item = create_item('PIV', valuation_rate = 100) + "Check if Template BOM is fetched in absence of Variant BOM." + rm_item = create_item("PIV_RM", valuation_rate=100) + if not frappe.db.exists("Item", {"item_code": "PIV"}): + item = create_item("PIV", valuation_rate=100) variant_settings = { "attributes": [ - { - "attribute": "Colour" - }, + {"attribute": "Colour"}, ], - "has_variants": 1 + "has_variants": 1, } item.update(variant_settings) item.save() - parent_bom = make_bom(item = 'PIV', raw_materials = [rm_item.item_code]) - if not frappe.db.exists('BOM', {"item": 'PIV'}): - parent_bom = make_bom(item = 'PIV', raw_materials = [rm_item.item_code]) + parent_bom = make_bom(item="PIV", raw_materials=[rm_item.item_code]) + if not frappe.db.exists("BOM", {"item": "PIV"}): + parent_bom = make_bom(item="PIV", raw_materials=[rm_item.item_code]) else: - parent_bom = frappe.get_doc('BOM', {"item": 'PIV'}) + parent_bom = frappe.get_doc("BOM", {"item": "PIV"}) - if not frappe.db.exists('Item', {"item_code": 'PIV-RED'}): + if not frappe.db.exists("Item", {"item_code": "PIV-RED"}): variant = create_variant("PIV", {"Colour": "Red"}) variant.save() - variant_bom = make_bom(item = variant.item_code, raw_materials = [rm_item.item_code]) + variant_bom = make_bom(item=variant.item_code, raw_materials=[rm_item.item_code]) else: - variant = frappe.get_doc('Item', 'PIV-RED') - if not frappe.db.exists('BOM', {"item": 'PIV-RED'}): - variant_bom = make_bom(item = variant.item_code, raw_materials = [rm_item.item_code]) + variant = frappe.get_doc("Item", "PIV-RED") + if not frappe.db.exists("BOM", {"item": "PIV-RED"}): + variant_bom = make_bom(item=variant.item_code, raw_materials=[rm_item.item_code]) """Testing when item variant has a BOM""" so = make_sales_order(item_code="PIV-RED", qty=5) - pln = frappe.new_doc('Production Plan') + pln = frappe.new_doc("Production Plan") pln.company = so.company - pln.get_items_from = 'Sales Order' - pln.item_code = 'PIV-RED' + pln.get_items_from = "Sales Order" + pln.item_code = "PIV-RED" pln.get_open_sales_orders() self.assertEqual(pln.sales_orders[0].sales_order, so.name) pln.get_so_items() - self.assertEqual(pln.po_items[0].item_code, 'PIV-RED') + self.assertEqual(pln.po_items[0].item_code, "PIV-RED") self.assertEqual(pln.po_items[0].bom_no, variant_bom.name) so.cancel() - frappe.delete_doc('Sales Order', so.name) + frappe.delete_doc("Sales Order", so.name) variant_bom.cancel() - frappe.delete_doc('BOM', variant_bom.name) + frappe.delete_doc("BOM", variant_bom.name) """Testing when item variant doesn't have a BOM""" so = make_sales_order(item_code="PIV-RED", qty=5) @@ -344,33 +425,365 @@ class TestProductionPlan(unittest.TestCase): self.assertEqual(pln.sales_orders[0].sales_order, so.name) pln.po_items = [] pln.get_so_items() - self.assertEqual(pln.po_items[0].item_code, 'PIV-RED') + self.assertEqual(pln.po_items[0].item_code, "PIV-RED") self.assertEqual(pln.po_items[0].bom_no, parent_bom.name) frappe.db.rollback() + def test_subassmebly_sorting(self): + "Test subassembly sorting in case of multiple items with nested BOMs." + from erpnext.manufacturing.doctype.bom.test_bom import create_nested_bom + + prefix = "_TestLevel_" + boms = { + "Assembly": { + "SubAssembly1": { + "ChildPart1": {}, + "ChildPart2": {}, + }, + "ChildPart6": {}, + "SubAssembly4": {"SubSubAssy2": {"ChildPart7": {}}}, + }, + "MegaDeepAssy": { + "SecretSubassy": { + "SecretPart": {"VerySecret": {"SuperSecret": {"Classified": {}}}}, + }, + # ^ assert that this is + # first item in subassy table + }, + } + create_nested_bom(boms, prefix=prefix) + + items = [prefix + item_code for item_code in boms.keys()] + plan = create_production_plan(item_code=items[0], do_not_save=True) + plan.append( + "po_items", + { + "use_multi_level_bom": 1, + "item_code": items[1], + "bom_no": frappe.db.get_value("Item", items[1], "default_bom"), + "planned_qty": 1, + "planned_start_date": now_datetime(), + }, + ) + plan.get_sub_assembly_items() + + bom_level_order = [d.bom_level for d in plan.sub_assembly_items] + self.assertEqual(bom_level_order, sorted(bom_level_order, reverse=True)) + # lowest most level of subassembly should be first + self.assertIn("SuperSecret", plan.sub_assembly_items[0].production_item) + + def test_multiple_work_order_for_production_plan_item(self): + "Test producing Prod Plan (making WO) in parts." + + def create_work_order(item, pln, qty): + # Get Production Items + items_data = pln.get_production_items() + + # Update qty + items_data[(item, None, None)]["qty"] = qty + + # Create and Submit Work Order for each item in items_data + for key, item in items_data.items(): + if pln.sub_assembly_items: + item["use_multi_level_bom"] = 0 + + wo_name = pln.create_work_order(item) + wo_doc = frappe.get_doc("Work Order", wo_name) + wo_doc.update( + {"wip_warehouse": "Work In Progress - _TC", "fg_warehouse": "Finished Goods - _TC"} + ) + wo_doc.submit() + wo_list.append(wo_name) + + item = "Test Production Item 1" + raw_materials = ["Raw Material Item 1", "Raw Material Item 2"] + + # Create BOM + bom = make_bom(item=item, raw_materials=raw_materials) + + # Create Production Plan + pln = create_production_plan(item_code=bom.item, planned_qty=5) + + # All the created Work Orders + wo_list = [] + + # Create and Submit 1st Work Order for 3 qty + create_work_order(item, pln, 3) + pln.reload() + self.assertEqual(pln.po_items[0].ordered_qty, 3) + + # Create and Submit 2nd Work Order for 2 qty + create_work_order(item, pln, 2) + pln.reload() + self.assertEqual(pln.po_items[0].ordered_qty, 5) + + # Overproduction + self.assertRaises(OverProductionError, create_work_order, item=item, pln=pln, qty=2) + + # Cancel 1st Work Order + wo1 = frappe.get_doc("Work Order", wo_list[0]) + wo1.cancel() + pln.reload() + self.assertEqual(pln.po_items[0].ordered_qty, 2) + + # Cancel 2nd Work Order + wo2 = frappe.get_doc("Work Order", wo_list[1]) + wo2.cancel() + pln.reload() + self.assertEqual(pln.po_items[0].ordered_qty, 0) + + def test_production_plan_pending_qty_with_sales_order(self): + """ + Test Prod Plan impact via: SO -> Prod Plan -> WO -> SE -> SE (cancel) + """ + from erpnext.manufacturing.doctype.work_order.test_work_order import make_wo_order_test_record + + make_stock_entry(item_code="_Test Item", target="Work In Progress - _TC", qty=2, basic_rate=100) + make_stock_entry( + item_code="_Test Item Home Desktop 100", target="Work In Progress - _TC", qty=4, basic_rate=100 + ) + + item = "_Test FG Item" + + make_stock_entry(item_code=item, target="_Test Warehouse - _TC", qty=1) + + so = make_sales_order(item_code=item, qty=2) + + dn = make_delivery_note(so.name) + dn.items[0].qty = 1 + dn.save() + dn.submit() + + pln = create_production_plan( + company=so.company, get_items_from="Sales Order", sales_order=so, skip_getting_mr_items=True + ) + self.assertEqual(pln.po_items[0].pending_qty, 1) + + wo = make_wo_order_test_record( + item_code=item, + qty=1, + company=so.company, + wip_warehouse="Work In Progress - _TC", + fg_warehouse="Finished Goods - _TC", + skip_transfer=1, + do_not_submit=True, + ) + wo.production_plan = pln.name + wo.production_plan_item = pln.po_items[0].name + wo.submit() + + se = frappe.get_doc(make_se_from_wo(wo.name, "Manufacture", 1)) + se.submit() + + pln.reload() + self.assertEqual(pln.po_items[0].pending_qty, 0) + + se.cancel() + pln.reload() + self.assertEqual(pln.po_items[0].pending_qty, 1) + + def test_production_plan_pending_qty_independent_items(self): + "Test Prod Plan impact if items are added independently (no from SO or MR)." + from erpnext.manufacturing.doctype.work_order.test_work_order import make_wo_order_test_record + + make_stock_entry( + item_code="Raw Material Item 1", target="Work In Progress - _TC", qty=2, basic_rate=100 + ) + make_stock_entry( + item_code="Raw Material Item 2", target="Work In Progress - _TC", qty=2, basic_rate=100 + ) + + pln = create_production_plan(item_code="Test Production Item 1", skip_getting_mr_items=True) + self.assertEqual(pln.po_items[0].pending_qty, 1) + + wo = make_wo_order_test_record( + item_code="Test Production Item 1", + qty=1, + company=pln.company, + wip_warehouse="Work In Progress - _TC", + fg_warehouse="Finished Goods - _TC", + skip_transfer=1, + do_not_submit=True, + ) + wo.production_plan = pln.name + wo.production_plan_item = pln.po_items[0].name + wo.submit() + + se = frappe.get_doc(make_se_from_wo(wo.name, "Manufacture", 1)) + se.submit() + + pln.reload() + self.assertEqual(pln.po_items[0].pending_qty, 0) + + se.cancel() + pln.reload() + self.assertEqual(pln.po_items[0].pending_qty, 1) + + def test_qty_based_status(self): + pp = frappe.new_doc("Production Plan") + pp.po_items = [frappe._dict(planned_qty=5, produce_qty=4)] + self.assertFalse(pp.all_items_completed()) + + pp.po_items = [ + frappe._dict(planned_qty=5, produce_qty=10), + frappe._dict(planned_qty=5, produce_qty=4), + ] + self.assertFalse(pp.all_items_completed()) + + def test_production_plan_planned_qty(self): + # Case 1: When Planned Qty is non-integer and UOM is integer. + from erpnext.utilities.transaction_base import UOMMustBeIntegerError + + self.assertRaises( + UOMMustBeIntegerError, create_production_plan, item_code="_Test FG Item", planned_qty=0.55 + ) + + # Case 2: When Planned Qty is non-integer and UOM is also non-integer. + from erpnext.stock.doctype.item.test_item import make_item + + fg_item = make_item(properties={"is_stock_item": 1, "stock_uom": "_Test UOM 1"}).name + bom_item = make_item().name + + make_bom(item=fg_item, raw_materials=[bom_item], source_warehouse="_Test Warehouse - _TC") + + pln = create_production_plan(item_code=fg_item, planned_qty=0.55, stock_uom="_Test UOM 1") + self.assertEqual(pln.po_items[0].planned_qty, 0.55) + + def test_temporary_name_relinking(self): + + pp = frappe.new_doc("Production Plan") + + # this can not be unittested so mocking data that would be expected + # from client side. + for _ in range(10): + po_item = pp.append( + "po_items", + { + "name": frappe.generate_hash(length=10), + "temporary_name": frappe.generate_hash(length=10), + }, + ) + pp.append("sub_assembly_items", {"production_plan_item": po_item.temporary_name}) + pp._rename_temporary_references() + + for po_item, subassy_item in zip(pp.po_items, pp.sub_assembly_items): + self.assertEqual(po_item.name, subassy_item.production_plan_item) + + # bad links should be erased + pp.append("sub_assembly_items", {"production_plan_item": frappe.generate_hash(length=16)}) + pp._rename_temporary_references() + self.assertIsNone(pp.sub_assembly_items[-1].production_plan_item) + pp.sub_assembly_items.pop() + + # reattempting on same doc shouldn't change anything + pp._rename_temporary_references() + for po_item, subassy_item in zip(pp.po_items, pp.sub_assembly_items): + self.assertEqual(po_item.name, subassy_item.production_plan_item) + + def test_produced_qty_for_multi_level_bom_item(self): + # Create Items and BOMs + rm_item = make_item(properties={"is_stock_item": 1}).name + sub_assembly_item = make_item(properties={"is_stock_item": 1}).name + fg_item = make_item(properties={"is_stock_item": 1}).name + + make_stock_entry( + item_code=rm_item, + qty=60, + to_warehouse="Work In Progress - _TC", + rate=99, + purpose="Material Receipt", + ) + + make_bom(item=sub_assembly_item, raw_materials=[rm_item], rm_qty=3) + make_bom(item=fg_item, raw_materials=[sub_assembly_item], rm_qty=4) + + # Step - 1: Create Production Plan + pln = create_production_plan(item_code=fg_item, planned_qty=5, skip_getting_mr_items=1) + pln.get_sub_assembly_items() + + # Step - 2: Create Work Orders + pln.make_work_order() + work_orders = frappe.get_all("Work Order", filters={"production_plan": pln.name}, pluck="name") + sa_wo = fg_wo = None + for work_order in work_orders: + wo_doc = frappe.get_doc("Work Order", work_order) + if wo_doc.production_plan_item: + wo_doc.update( + {"wip_warehouse": "Work In Progress - _TC", "fg_warehouse": "Finished Goods - _TC"} + ) + fg_wo = wo_doc.name + else: + wo_doc.update( + {"wip_warehouse": "Work In Progress - _TC", "fg_warehouse": "Work In Progress - _TC"} + ) + sa_wo = wo_doc.name + wo_doc.submit() + + # Step - 3: Complete Work Orders + se = frappe.get_doc(make_se_from_wo(sa_wo, "Manufacture")) + se.submit() + + se = frappe.get_doc(make_se_from_wo(fg_wo, "Manufacture")) + se.submit() + + # Step - 4: Check Production Plan Item Produced Qty + pln.load_from_db() + self.assertEqual(pln.status, "Completed") + self.assertEqual(pln.po_items[0].produced_qty, 5) + + def create_production_plan(**args): + """ + sales_order (obj): Sales Order Doc Object + get_items_from (str): Sales Order/Material Request + skip_getting_mr_items (bool): Whether or not to plan for new MRs + """ args = frappe._dict(args) - pln = frappe.get_doc({ - 'doctype': 'Production Plan', - 'company': args.company or '_Test Company', - 'customer': args.customer or '_Test Customer', - 'posting_date': nowdate(), - 'include_non_stock_items': args.include_non_stock_items or 1, - 'include_subcontracted_items': args.include_subcontracted_items or 1, - 'ignore_existing_ordered_qty': args.ignore_existing_ordered_qty or 1, - 'po_items': [{ - 'use_multi_level_bom': args.use_multi_level_bom or 1, - 'item_code': args.item_code, - 'bom_no': frappe.db.get_value('Item', args.item_code, 'default_bom'), - 'planned_qty': args.planned_qty or 1, - 'planned_start_date': args.planned_start_date or now_datetime() - }] - }) - mr_items = get_items_for_material_requests(pln.as_dict()) - for d in mr_items: - pln.append('mr_items', d) + pln = frappe.get_doc( + { + "doctype": "Production Plan", + "company": args.company or "_Test Company", + "customer": args.customer or "_Test Customer", + "posting_date": nowdate(), + "include_non_stock_items": args.include_non_stock_items or 0, + "include_subcontracted_items": args.include_subcontracted_items or 0, + "ignore_existing_ordered_qty": args.ignore_existing_ordered_qty or 0, + "get_items_from": "Sales Order", + } + ) + + if not args.get("sales_order"): + pln.append( + "po_items", + { + "use_multi_level_bom": args.use_multi_level_bom or 1, + "item_code": args.item_code, + "bom_no": frappe.db.get_value("Item", args.item_code, "default_bom"), + "planned_qty": args.planned_qty or 1, + "planned_start_date": args.planned_start_date or now_datetime(), + "stock_uom": args.stock_uom or "Nos", + }, + ) + + if args.get("get_items_from") == "Sales Order" and args.get("sales_order"): + so = args.get("sales_order") + pln.append( + "sales_orders", + { + "sales_order": so.name, + "sales_order_date": so.transaction_date, + "customer": so.customer, + "grand_total": so.grand_total, + }, + ) + pln.get_items() + + if not args.get("skip_getting_mr_items"): + mr_items = get_items_for_material_requests(pln.as_dict()) + for d in mr_items: + pln.append("mr_items", d) if not args.do_not_save: pln.insert() @@ -379,31 +792,36 @@ def create_production_plan(**args): return pln + def make_bom(**args): args = frappe._dict(args) - bom = frappe.get_doc({ - 'doctype': 'BOM', - 'is_default': 1, - 'item': args.item, - 'currency': args.currency or 'USD', - 'quantity': args.quantity or 1, - 'company': args.company or '_Test Company', - 'routing': args.routing, - 'with_operations': args.with_operations or 0 - }) + bom = frappe.get_doc( + { + "doctype": "BOM", + "is_default": 1, + "item": args.item, + "currency": args.currency or "USD", + "quantity": args.quantity or 1, + "company": args.company or "_Test Company", + "routing": args.routing, + "with_operations": args.with_operations or 0, + } + ) for item in args.raw_materials: - item_doc = frappe.get_doc('Item', item) - - bom.append('items', { - 'item_code': item, - 'qty': args.rm_qty or 1.0, - 'uom': item_doc.stock_uom, - 'stock_uom': item_doc.stock_uom, - 'rate': item_doc.valuation_rate or args.rate, - 'source_warehouse': args.source_warehouse - }) + item_doc = frappe.get_doc("Item", item) + bom.append( + "items", + { + "item_code": item, + "qty": args.rm_qty or 1.0, + "uom": item_doc.stock_uom, + "stock_uom": item_doc.stock_uom, + "rate": item_doc.valuation_rate or args.rate, + "source_warehouse": args.source_warehouse, + }, + ) if not args.do_not_save: bom.insert(ignore_permissions=True) diff --git a/erpnext/manufacturing/doctype/production_plan_item/production_plan_item.json b/erpnext/manufacturing/doctype/production_plan_item/production_plan_item.json index f829d57475a..df5862fcac8 100644 --- a/erpnext/manufacturing/doctype/production_plan_item/production_plan_item.json +++ b/erpnext/manufacturing/doctype/production_plan_item/production_plan_item.json @@ -27,7 +27,8 @@ "material_request", "material_request_item", "product_bundle_item", - "item_reference" + "item_reference", + "temporary_name" ], "fields": [ { @@ -204,17 +205,25 @@ "fieldtype": "Data", "hidden": 1, "label": "Item Reference" + }, + { + "fieldname": "temporary_name", + "fieldtype": "Data", + "hidden": 1, + "label": "temporary name" } ], "idx": 1, "istable": 1, "links": [], - "modified": "2021-06-28 18:31:06.822168", + "modified": "2022-03-24 04:54:09.940224", "modified_by": "Administrator", "module": "Manufacturing", "name": "Production Plan Item", + "naming_rule": "Random", "owner": "Administrator", "permissions": [], "sort_field": "modified", - "sort_order": "ASC" + "sort_order": "ASC", + "states": [] } \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/production_plan_sub_assembly_item/production_plan_sub_assembly_item.json b/erpnext/manufacturing/doctype/production_plan_sub_assembly_item/production_plan_sub_assembly_item.json index 657ee35a852..45ea26c3a8a 100644 --- a/erpnext/manufacturing/doctype/production_plan_sub_assembly_item/production_plan_sub_assembly_item.json +++ b/erpnext/manufacturing/doctype/production_plan_sub_assembly_item/production_plan_sub_assembly_item.json @@ -102,7 +102,6 @@ }, { "columns": 1, - "fetch_from": "bom_no.bom_level", "fieldname": "bom_level", "fieldtype": "Int", "in_list_view": 1, @@ -189,7 +188,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-06-28 20:10:56.296410", + "modified": "2022-01-30 21:31:10.527559", "modified_by": "Administrator", "module": "Manufacturing", "name": "Production Plan Sub Assembly Item", @@ -198,5 +197,6 @@ "quick_entry": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/manufacturing/doctype/routing/routing.js b/erpnext/manufacturing/doctype/routing/routing.js index 032c9cd9a21..ebed6fcde64 100644 --- a/erpnext/manufacturing/doctype/routing/routing.js +++ b/erpnext/manufacturing/doctype/routing/routing.js @@ -17,7 +17,7 @@ frappe.ui.form.on('Routing', { }, calculate_operating_cost: function(frm, child) { - const operating_cost = flt(flt(child.hour_rate) * flt(child.time_in_mins) / 60, 2); + const operating_cost = flt(flt(child.hour_rate) * flt(child.time_in_mins) / 60, precision("operating_cost", child)); frappe.model.set_value(child.doctype, child.name, "operating_cost", operating_cost); } }); diff --git a/erpnext/manufacturing/doctype/routing/routing.py b/erpnext/manufacturing/doctype/routing/routing.py index 1c76634646d..d4c37cf79e7 100644 --- a/erpnext/manufacturing/doctype/routing/routing.py +++ b/erpnext/manufacturing/doctype/routing/routing.py @@ -19,8 +19,11 @@ class Routing(Document): def calculate_operating_cost(self): for operation in self.operations: if not operation.hour_rate: - operation.hour_rate = frappe.db.get_value("Workstation", operation.workstation, 'hour_rate') - operation.operating_cost = flt(flt(operation.hour_rate) * flt(operation.time_in_mins) / 60, 2) + operation.hour_rate = frappe.db.get_value("Workstation", operation.workstation, "hour_rate") + operation.operating_cost = flt( + flt(operation.hour_rate) * flt(operation.time_in_mins) / 60, + operation.precision("operating_cost"), + ) def set_routing_id(self): sequence_id = 0 @@ -28,7 +31,10 @@ class Routing(Document): if not row.sequence_id: row.sequence_id = sequence_id + 1 elif sequence_id and row.sequence_id and cint(sequence_id) > cint(row.sequence_id): - frappe.throw(_("At row #{0}: the sequence id {1} cannot be less than previous row sequence id {2}") - .format(row.idx, row.sequence_id, sequence_id)) + frappe.throw( + _("At row #{0}: the sequence id {1} cannot be less than previous row sequence id {2}").format( + row.idx, row.sequence_id, sequence_id + ) + ) sequence_id = row.sequence_id diff --git a/erpnext/manufacturing/doctype/routing/routing_dashboard.py b/erpnext/manufacturing/doctype/routing/routing_dashboard.py index 4bd4192de5d..65d7a452778 100644 --- a/erpnext/manufacturing/doctype/routing/routing_dashboard.py +++ b/erpnext/manufacturing/doctype/routing/routing_dashboard.py @@ -1,11 +1,2 @@ - - def get_data(): - return { - 'fieldname': 'routing', - 'transactions': [ - { - 'items': ['BOM'] - } - ] - } + return {"fieldname": "routing", "transactions": [{"items": ["BOM"]}]} diff --git a/erpnext/manufacturing/doctype/routing/test_routing.py b/erpnext/manufacturing/doctype/routing/test_routing.py index 68d9dec04b1..48f1851cb10 100644 --- a/erpnext/manufacturing/doctype/routing/test_routing.py +++ b/erpnext/manufacturing/doctype/routing/test_routing.py @@ -1,41 +1,42 @@ # Copyright (c) 2018, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt - -import unittest - import frappe from frappe.test_runner import make_test_records +from frappe.tests.utils import FrappeTestCase from erpnext.manufacturing.doctype.job_card.job_card import OperationSequenceError from erpnext.manufacturing.doctype.work_order.test_work_order import make_wo_order_test_record from erpnext.stock.doctype.item.test_item import make_item -class TestRouting(unittest.TestCase): +class TestRouting(FrappeTestCase): @classmethod def setUpClass(cls): cls.item_code = "Test Routing Item - A" @classmethod def tearDownClass(cls): - frappe.db.sql('delete from tabBOM where item=%s', cls.item_code) + frappe.db.sql("delete from tabBOM where item=%s", cls.item_code) def test_sequence_id(self): - operations = [{"operation": "Test Operation A", "workstation": "Test Workstation A", "time_in_mins": 30}, - {"operation": "Test Operation B", "workstation": "Test Workstation A", "time_in_mins": 20}] + operations = [ + {"operation": "Test Operation A", "workstation": "Test Workstation A", "time_in_mins": 30}, + {"operation": "Test Operation B", "workstation": "Test Workstation A", "time_in_mins": 20}, + ] make_test_records("UOM") setup_operations(operations) routing_doc = create_routing(routing_name="Testing Route", operations=operations) bom_doc = setup_bom(item_code=self.item_code, routing=routing_doc.name) - wo_doc = make_wo_order_test_record(production_item = self.item_code, bom_no=bom_doc.name) + wo_doc = make_wo_order_test_record(production_item=self.item_code, bom_no=bom_doc.name) for row in routing_doc.operations: self.assertEqual(row.sequence_id, row.idx) - for data in frappe.get_all("Job Card", - filters={"work_order": wo_doc.name}, order_by="sequence_id desc"): + for data in frappe.get_all( + "Job Card", filters={"work_order": wo_doc.name}, order_by="sequence_id desc" + ): job_card_doc = frappe.get_doc("Job Card", data.name) job_card_doc.time_logs[0].completed_qty = 10 if job_card_doc.sequence_id != 1: @@ -48,38 +49,31 @@ class TestRouting(unittest.TestCase): wo_doc.delete() def test_update_bom_operation_time(self): + """Update cost shouldn't update routing times.""" operations = [ { "operation": "Test Operation A", "workstation": "_Test Workstation A", "hour_rate_rent": 300, - "hour_rate_labour": 750 , - "time_in_mins": 30 + "hour_rate_labour": 750, + "time_in_mins": 30, }, { "operation": "Test Operation B", "workstation": "_Test Workstation B", "hour_rate_labour": 200, "hour_rate_rent": 1000, - "time_in_mins": 20 - } + "time_in_mins": 20, + }, ] test_routing_operations = [ - { - "operation": "Test Operation A", - "workstation": "_Test Workstation A", - "time_in_mins": 30 - }, - { - "operation": "Test Operation B", - "workstation": "_Test Workstation A", - "time_in_mins": 20 - } + {"operation": "Test Operation A", "workstation": "_Test Workstation A", "time_in_mins": 30}, + {"operation": "Test Operation B", "workstation": "_Test Workstation A", "time_in_mins": 20}, ] setup_operations(operations) routing_doc = create_routing(routing_name="Routing Test", operations=test_routing_operations) - bom_doc = setup_bom(item_code="_Testing Item", routing=routing_doc.name, currency = 'INR') + bom_doc = setup_bom(item_code="_Testing Item", routing=routing_doc.name, currency="INR") self.assertEqual(routing_doc.operations[0].time_in_mins, 30) self.assertEqual(routing_doc.operations[1].time_in_mins, 20) routing_doc.operations[0].time_in_mins = 90 @@ -87,17 +81,19 @@ class TestRouting(unittest.TestCase): routing_doc.save() bom_doc.update_cost() bom_doc.reload() - self.assertEqual(bom_doc.operations[0].time_in_mins, 90) - self.assertEqual(bom_doc.operations[1].time_in_mins, 42.2) + self.assertEqual(bom_doc.operations[0].time_in_mins, 30) + self.assertEqual(bom_doc.operations[1].time_in_mins, 20) def setup_operations(rows): from erpnext.manufacturing.doctype.operation.test_operation import make_operation from erpnext.manufacturing.doctype.workstation.test_workstation import make_workstation + for row in rows: make_workstation(row) make_operation(row) + def create_routing(**args): args = frappe._dict(args) @@ -109,7 +105,7 @@ def create_routing(**args): doc.insert() except frappe.DuplicateEntryError: doc = frappe.get_doc("Routing", args.routing_name) - doc.delete_key('operations') + doc.delete_key("operations") for operation in args.operations: doc.append("operations", operation) @@ -117,28 +113,35 @@ def create_routing(**args): return doc + def setup_bom(**args): from erpnext.manufacturing.doctype.production_plan.test_production_plan import make_bom args = frappe._dict(args) - if not frappe.db.exists('Item', args.item_code): - make_item(args.item_code, { - 'is_stock_item': 1 - }) + if not frappe.db.exists("Item", args.item_code): + make_item(args.item_code, {"is_stock_item": 1}) if not args.raw_materials: - if not frappe.db.exists('Item', "Test Extra Item N-1"): - make_item("Test Extra Item N-1", { - 'is_stock_item': 1, - }) + if not frappe.db.exists("Item", "Test Extra Item N-1"): + make_item( + "Test Extra Item N-1", + { + "is_stock_item": 1, + }, + ) - args.raw_materials = ['Test Extra Item N-1'] + args.raw_materials = ["Test Extra Item N-1"] - name = frappe.db.get_value('BOM', {'item': args.item_code}, 'name') + name = frappe.db.get_value("BOM", {"item": args.item_code}, "name") if not name: - bom_doc = make_bom(item = args.item_code, raw_materials = args.get("raw_materials"), - routing = args.routing, with_operations=1, currency = args.currency) + bom_doc = make_bom( + item=args.item_code, + raw_materials=args.get("raw_materials"), + routing=args.routing, + with_operations=1, + currency=args.currency, + ) else: bom_doc = frappe.get_doc("BOM", name) diff --git a/erpnext/manufacturing/doctype/work_order/test_work_order.py b/erpnext/manufacturing/doctype/work_order/test_work_order.py index f4a88dc4598..cfba0fff15e 100644 --- a/erpnext/manufacturing/doctype/work_order/test_work_order.py +++ b/erpnext/manufacturing/doctype/work_order/test_work_order.py @@ -1,9 +1,9 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt -import unittest import frappe -from frappe.utils import add_months, cint, flt, now, today +from frappe.tests.utils import FrappeTestCase, change_settings, timeout +from frappe.utils import add_days, add_months, cint, flt, now, today from erpnext.manufacturing.doctype.job_card.job_card import JobCardCancelError from erpnext.manufacturing.doctype.production_plan.test_production_plan import make_bom @@ -13,6 +13,7 @@ from erpnext.manufacturing.doctype.work_order.work_order import ( OverProductionError, StockOverProductionError, close_work_order, + make_job_card, make_stock_entry, stop_unstop, ) @@ -22,29 +23,38 @@ from erpnext.stock.doctype.stock_entry import test_stock_entry from erpnext.stock.doctype.warehouse.test_warehouse import create_warehouse from erpnext.stock.utils import get_bin +test_dependencies = ["BOM"] -class TestWorkOrder(unittest.TestCase): + +class TestWorkOrder(FrappeTestCase): def setUp(self): - self.warehouse = '_Test Warehouse 2 - _TC' - self.item = '_Test Item' + self.warehouse = "_Test Warehouse 2 - _TC" + self.item = "_Test Item" def check_planned_qty(self): - planned0 = frappe.db.get_value("Bin", {"item_code": "_Test FG Item", - "warehouse": "_Test Warehouse 1 - _TC"}, "planned_qty") or 0 + planned0 = ( + frappe.db.get_value( + "Bin", {"item_code": "_Test FG Item", "warehouse": "_Test Warehouse 1 - _TC"}, "planned_qty" + ) + or 0 + ) wo_order = make_wo_order_test_record() - planned1 = frappe.db.get_value("Bin", {"item_code": "_Test FG Item", - "warehouse": "_Test Warehouse 1 - _TC"}, "planned_qty") + planned1 = frappe.db.get_value( + "Bin", {"item_code": "_Test FG Item", "warehouse": "_Test Warehouse 1 - _TC"}, "planned_qty" + ) self.assertEqual(planned1, planned0 + 10) # add raw materials to stores - test_stock_entry.make_stock_entry(item_code="_Test Item", - target="Stores - _TC", qty=100, basic_rate=100) - test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target="Stores - _TC", qty=100, basic_rate=100) + test_stock_entry.make_stock_entry( + item_code="_Test Item", target="Stores - _TC", qty=100, basic_rate=100 + ) + test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", target="Stores - _TC", qty=100, basic_rate=100 + ) # from stores to wip s = frappe.get_doc(make_stock_entry(wo_order.name, "Material Transfer for Manufacture", 4)) @@ -60,8 +70,9 @@ class TestWorkOrder(unittest.TestCase): self.assertEqual(frappe.db.get_value("Work Order", wo_order.name, "produced_qty"), 4) - planned2 = frappe.db.get_value("Bin", {"item_code": "_Test FG Item", - "warehouse": "_Test Warehouse 1 - _TC"}, "planned_qty") + planned2 = frappe.db.get_value( + "Bin", {"item_code": "_Test FG Item", "warehouse": "_Test Warehouse 1 - _TC"}, "planned_qty" + ) self.assertEqual(planned2, planned0 + 6) @@ -70,10 +81,12 @@ class TestWorkOrder(unittest.TestCase): def test_over_production(self): wo_doc = self.check_planned_qty() - test_stock_entry.make_stock_entry(item_code="_Test Item", - target="_Test Warehouse - _TC", qty=100, basic_rate=100) - test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target="_Test Warehouse - _TC", qty=100, basic_rate=100) + test_stock_entry.make_stock_entry( + item_code="_Test Item", target="_Test Warehouse - _TC", qty=100, basic_rate=100 + ) + test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", target="_Test Warehouse - _TC", qty=100, basic_rate=100 + ) s = frappe.get_doc(make_stock_entry(wo_doc.name, "Manufacture", 7)) s.insert() @@ -81,44 +94,48 @@ class TestWorkOrder(unittest.TestCase): self.assertRaises(StockOverProductionError, s.submit) def test_planned_operating_cost(self): - wo_order = make_wo_order_test_record(item="_Test FG Item 2", - planned_start_date=now(), qty=1, do_not_save=True) + wo_order = make_wo_order_test_record( + item="_Test FG Item 3", planned_start_date=now(), qty=1, do_not_save=True + ) wo_order.set_work_order_operations() cost = wo_order.planned_operating_cost wo_order.qty = 2 wo_order.set_work_order_operations() - self.assertEqual(wo_order.planned_operating_cost, cost*2) + self.assertEqual(wo_order.planned_operating_cost, cost * 2) def test_reserved_qty_for_partial_completion(self): item = "_Test Item" - warehouse = create_warehouse("Test Warehouse for reserved_qty - _TC") + warehouse = "_Test Warehouse - _TC" bin1_at_start = get_bin(item, warehouse) # reset to correct value bin1_at_start.update_reserved_qty_for_production() - wo_order = make_wo_order_test_record(item="_Test FG Item", qty=2, - source_warehouse=warehouse, skip_transfer=1) + wo_order = make_wo_order_test_record( + item="_Test FG Item", qty=2, source_warehouse=warehouse, skip_transfer=1 + ) reserved_qty_on_submission = cint(get_bin(item, warehouse).reserved_qty_for_production) # reserved qty for production is updated self.assertEqual(cint(bin1_at_start.reserved_qty_for_production) + 2, reserved_qty_on_submission) - - test_stock_entry.make_stock_entry(item_code="_Test Item", - target=warehouse, qty=100, basic_rate=100) - test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target=warehouse, qty=100, basic_rate=100) + test_stock_entry.make_stock_entry( + item_code="_Test Item", target=warehouse, qty=100, basic_rate=100 + ) + test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", target=warehouse, qty=100, basic_rate=100 + ) s = frappe.get_doc(make_stock_entry(wo_order.name, "Manufacture", 1)) s.submit() bin1_at_completion = get_bin(item, warehouse) - self.assertEqual(cint(bin1_at_completion.reserved_qty_for_production), - reserved_qty_on_submission - 1) + self.assertEqual( + cint(bin1_at_completion.reserved_qty_for_production), reserved_qty_on_submission - 1 + ) def test_production_item(self): wo_order = make_wo_order_test_record(item="_Test FG Item", qty=1, do_not_save=True) @@ -142,16 +159,20 @@ class TestWorkOrder(unittest.TestCase): # reset to correct value self.bin1_at_start.update_reserved_qty_for_production() - self.wo_order = make_wo_order_test_record(item="_Test FG Item", qty=2, - source_warehouse=self.warehouse) + self.wo_order = make_wo_order_test_record( + item="_Test FG Item", qty=2, source_warehouse=self.warehouse + ) self.bin1_on_submit = get_bin(self.item, self.warehouse) # reserved qty for production is updated - self.assertEqual(cint(self.bin1_at_start.reserved_qty_for_production) + 2, - cint(self.bin1_on_submit.reserved_qty_for_production)) - self.assertEqual(cint(self.bin1_at_start.projected_qty), - cint(self.bin1_on_submit.projected_qty) + 2) + self.assertEqual( + cint(self.bin1_at_start.reserved_qty_for_production) + 2, + cint(self.bin1_on_submit.reserved_qty_for_production), + ) + self.assertEqual( + cint(self.bin1_at_start.projected_qty), cint(self.bin1_on_submit.projected_qty) + 2 + ) def test_reserved_qty_for_production_cancel(self): self.test_reserved_qty_for_production_submit() @@ -161,52 +182,75 @@ class TestWorkOrder(unittest.TestCase): bin1_on_cancel = get_bin(self.item, self.warehouse) # reserved_qty_for_producion updated - self.assertEqual(cint(self.bin1_at_start.reserved_qty_for_production), - cint(bin1_on_cancel.reserved_qty_for_production)) - self.assertEqual(self.bin1_at_start.projected_qty, - cint(bin1_on_cancel.projected_qty)) + self.assertEqual( + cint(self.bin1_at_start.reserved_qty_for_production), + cint(bin1_on_cancel.reserved_qty_for_production), + ) + self.assertEqual(self.bin1_at_start.projected_qty, cint(bin1_on_cancel.projected_qty)) def test_reserved_qty_for_production_on_stock_entry(self): - test_stock_entry.make_stock_entry(item_code="_Test Item", - target= self.warehouse, qty=100, basic_rate=100) - test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target= self.warehouse, qty=100, basic_rate=100) + test_stock_entry.make_stock_entry( + item_code="_Test Item", target=self.warehouse, qty=100, basic_rate=100 + ) + test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", target=self.warehouse, qty=100, basic_rate=100 + ) self.test_reserved_qty_for_production_submit() - s = frappe.get_doc(make_stock_entry(self.wo_order.name, - "Material Transfer for Manufacture", 2)) + s = frappe.get_doc(make_stock_entry(self.wo_order.name, "Material Transfer for Manufacture", 2)) s.submit() bin1_on_start_production = get_bin(self.item, self.warehouse) # reserved_qty_for_producion updated - self.assertEqual(cint(self.bin1_at_start.reserved_qty_for_production), - cint(bin1_on_start_production.reserved_qty_for_production)) + self.assertEqual( + cint(self.bin1_at_start.reserved_qty_for_production), + cint(bin1_on_start_production.reserved_qty_for_production), + ) # projected qty will now be 2 less (becuase of item movement) - self.assertEqual(cint(self.bin1_at_start.projected_qty), - cint(bin1_on_start_production.projected_qty) + 2) + self.assertEqual( + cint(self.bin1_at_start.projected_qty), cint(bin1_on_start_production.projected_qty) + 2 + ) s = frappe.get_doc(make_stock_entry(self.wo_order.name, "Manufacture", 2)) bin1_on_end_production = get_bin(self.item, self.warehouse) # no change in reserved / projected - self.assertEqual(cint(bin1_on_end_production.reserved_qty_for_production), - cint(bin1_on_start_production.reserved_qty_for_production)) - self.assertEqual(cint(bin1_on_end_production.projected_qty), - cint(bin1_on_end_production.projected_qty)) + self.assertEqual( + cint(bin1_on_end_production.reserved_qty_for_production), + cint(bin1_on_start_production.reserved_qty_for_production), + ) + + def test_reserved_qty_for_production_closed(self): + + wo1 = make_wo_order_test_record(item="_Test FG Item", qty=2, source_warehouse=self.warehouse) + item = wo1.required_items[0].item_code + bin_before = get_bin(item, self.warehouse) + bin_before.update_reserved_qty_for_production() + + make_wo_order_test_record(item="_Test FG Item", qty=2, source_warehouse=self.warehouse) + close_work_order(wo1.name, "Closed") + + bin_after = get_bin(item, self.warehouse) + self.assertEqual(bin_before.reserved_qty_for_production, bin_after.reserved_qty_for_production) def test_backflush_qty_for_overpduction_manufacture(self): cancel_stock_entry = [] allow_overproduction("overproduction_percentage_for_work_order", 30) wo_order = make_wo_order_test_record(planned_start_date=now(), qty=100) - ste1 = test_stock_entry.make_stock_entry(item_code="_Test Item", - target="_Test Warehouse - _TC", qty=120, basic_rate=5000.0) - ste2 = test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target="_Test Warehouse - _TC", qty=240, basic_rate=1000.0) + ste1 = test_stock_entry.make_stock_entry( + item_code="_Test Item", target="_Test Warehouse - _TC", qty=120, basic_rate=5000.0 + ) + ste2 = test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse - _TC", + qty=240, + basic_rate=1000.0, + ) cancel_stock_entry.extend([ste1.name, ste2.name]) @@ -236,33 +280,37 @@ class TestWorkOrder(unittest.TestCase): allow_overproduction("overproduction_percentage_for_work_order", 0) def test_reserved_qty_for_stopped_production(self): - test_stock_entry.make_stock_entry(item_code="_Test Item", - target= self.warehouse, qty=100, basic_rate=100) - test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target= self.warehouse, qty=100, basic_rate=100) + test_stock_entry.make_stock_entry( + item_code="_Test Item", target=self.warehouse, qty=100, basic_rate=100 + ) + test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", target=self.warehouse, qty=100, basic_rate=100 + ) # 0 0 0 self.test_reserved_qty_for_production_submit() - #2 0 -2 + # 2 0 -2 - s = frappe.get_doc(make_stock_entry(self.wo_order.name, - "Material Transfer for Manufacture", 1)) + s = frappe.get_doc(make_stock_entry(self.wo_order.name, "Material Transfer for Manufacture", 1)) s.submit() - #1 -1 0 + # 1 -1 0 bin1_on_start_production = get_bin(self.item, self.warehouse) # reserved_qty_for_producion updated - self.assertEqual(cint(self.bin1_at_start.reserved_qty_for_production) + 1, - cint(bin1_on_start_production.reserved_qty_for_production)) + self.assertEqual( + cint(self.bin1_at_start.reserved_qty_for_production) + 1, + cint(bin1_on_start_production.reserved_qty_for_production), + ) # projected qty will now be 2 less (becuase of item movement) - self.assertEqual(cint(self.bin1_at_start.projected_qty), - cint(bin1_on_start_production.projected_qty) + 2) + self.assertEqual( + cint(self.bin1_at_start.projected_qty), cint(bin1_on_start_production.projected_qty) + 2 + ) # STOP stop_unstop(self.wo_order.name, "Stopped") @@ -270,19 +318,24 @@ class TestWorkOrder(unittest.TestCase): bin1_on_stop_production = get_bin(self.item, self.warehouse) # no change in reserved / projected - self.assertEqual(cint(bin1_on_stop_production.reserved_qty_for_production), - cint(self.bin1_at_start.reserved_qty_for_production)) - self.assertEqual(cint(bin1_on_stop_production.projected_qty) + 1, - cint(self.bin1_at_start.projected_qty)) + self.assertEqual( + cint(bin1_on_stop_production.reserved_qty_for_production), + cint(self.bin1_at_start.reserved_qty_for_production), + ) + self.assertEqual( + cint(bin1_on_stop_production.projected_qty) + 1, cint(self.bin1_at_start.projected_qty) + ) def test_scrap_material_qty(self): wo_order = make_wo_order_test_record(planned_start_date=now(), qty=2) # add raw materials to stores - test_stock_entry.make_stock_entry(item_code="_Test Item", - target="Stores - _TC", qty=10, basic_rate=5000.0) - test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target="Stores - _TC", qty=10, basic_rate=1000.0) + test_stock_entry.make_stock_entry( + item_code="_Test Item", target="Stores - _TC", qty=10, basic_rate=5000.0 + ) + test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", target="Stores - _TC", qty=10, basic_rate=1000.0 + ) s = frappe.get_doc(make_stock_entry(wo_order.name, "Material Transfer for Manufacture", 2)) for d in s.get("items"): @@ -294,8 +347,9 @@ class TestWorkOrder(unittest.TestCase): s.insert() s.submit() - wo_order_details = frappe.db.get_value("Work Order", wo_order.name, - ["scrap_warehouse", "qty", "produced_qty", "bom_no"], as_dict=1) + wo_order_details = frappe.db.get_value( + "Work Order", wo_order.name, ["scrap_warehouse", "qty", "produced_qty", "bom_no"], as_dict=1 + ) scrap_item_details = get_scrap_item_details(wo_order_details.bom_no) @@ -304,15 +358,20 @@ class TestWorkOrder(unittest.TestCase): for item in s.items: if item.bom_no and item.item_code in scrap_item_details: self.assertEqual(wo_order_details.scrap_warehouse, item.t_warehouse) - self.assertEqual(flt(wo_order_details.qty)*flt(scrap_item_details[item.item_code]), item.qty) + self.assertEqual(flt(wo_order_details.qty) * flt(scrap_item_details[item.item_code]), item.qty) def test_allow_overproduction(self): allow_overproduction("overproduction_percentage_for_work_order", 0) wo_order = make_wo_order_test_record(planned_start_date=now(), qty=2) - test_stock_entry.make_stock_entry(item_code="_Test Item", - target="_Test Warehouse - _TC", qty=10, basic_rate=5000.0) - test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target="_Test Warehouse - _TC", qty=10, basic_rate=1000.0) + test_stock_entry.make_stock_entry( + item_code="_Test Item", target="_Test Warehouse - _TC", qty=10, basic_rate=5000.0 + ) + test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse - _TC", + qty=10, + basic_rate=1000.0, + ) s = frappe.get_doc(make_stock_entry(wo_order.name, "Material Transfer for Manufacture", 3)) s.insert() @@ -329,43 +388,56 @@ class TestWorkOrder(unittest.TestCase): so = make_sales_order(item_code="_Test FG Item", qty=2) allow_overproduction("overproduction_percentage_for_sales_order", 0) - wo_order = make_wo_order_test_record(planned_start_date=now(), - sales_order=so.name, qty=3, do_not_save=True) + wo_order = make_wo_order_test_record( + planned_start_date=now(), sales_order=so.name, qty=3, do_not_save=True + ) self.assertRaises(OverProductionError, wo_order.save) allow_overproduction("overproduction_percentage_for_sales_order", 50) - wo_order = make_wo_order_test_record(planned_start_date=now(), - sales_order=so.name, qty=3) + wo_order = make_wo_order_test_record(planned_start_date=now(), sales_order=so.name, qty=3) - wo_order.submit() self.assertEqual(wo_order.docstatus, 1) allow_overproduction("overproduction_percentage_for_sales_order", 0) def test_work_order_with_non_stock_item(self): - items = {'Finished Good Test Item For non stock': 1, '_Test FG Item': 1, '_Test FG Non Stock Item': 0} + items = { + "Finished Good Test Item For non stock": 1, + "_Test FG Item": 1, + "_Test FG Non Stock Item": 0, + } for item, is_stock_item in items.items(): - make_item(item, { - 'is_stock_item': is_stock_item - }) + make_item(item, {"is_stock_item": is_stock_item}) - if not frappe.db.get_value('Item Price', {'item_code': '_Test FG Non Stock Item'}): - frappe.get_doc({ - 'doctype': 'Item Price', - 'item_code': '_Test FG Non Stock Item', - 'price_list_rate': 1000, - 'price_list': 'Standard Buying' - }).insert(ignore_permissions=True) + if not frappe.db.get_value("Item Price", {"item_code": "_Test FG Non Stock Item"}): + frappe.get_doc( + { + "doctype": "Item Price", + "item_code": "_Test FG Non Stock Item", + "price_list_rate": 1000, + "price_list": "_Test Price List India", + } + ).insert(ignore_permissions=True) - fg_item = 'Finished Good Test Item For non stock' - test_stock_entry.make_stock_entry(item_code="_Test FG Item", - target="_Test Warehouse - _TC", qty=1, basic_rate=100) + fg_item = "Finished Good Test Item For non stock" + test_stock_entry.make_stock_entry( + item_code="_Test FG Item", target="_Test Warehouse - _TC", qty=1, basic_rate=100 + ) - if not frappe.db.get_value('BOM', {'item': fg_item}): - make_bom(item=fg_item, rate=1000, raw_materials = ['_Test FG Item', '_Test FG Non Stock Item']) + if not frappe.db.get_value("BOM", {"item": fg_item, "docstatus": 1}): + bom = make_bom( + item=fg_item, + rate=1000, + raw_materials=["_Test FG Item", "_Test FG Non Stock Item"], + do_not_save=True, + ) + bom.rm_cost_as_per = "Price List" # non stock item won't have valuation rate + bom.buying_price_list = "_Test Price List India" + bom.currency = "INR" + bom.save() - wo = make_wo_order_test_record(production_item = fg_item) + wo = make_wo_order_test_record(production_item=fg_item) se = frappe.get_doc(make_stock_entry(wo.name, "Material Transfer for Manufacture", 1)) se.insert() @@ -376,27 +448,28 @@ class TestWorkOrder(unittest.TestCase): self.assertEqual(len(ste.additional_costs), 1) self.assertEqual(ste.total_additional_costs, 1000) + @timeout(seconds=60) def test_job_card(self): stock_entries = [] - bom = frappe.get_doc('BOM', { - 'docstatus': 1, - 'with_operations': 1, - 'company': '_Test Company' - }) + bom = frappe.get_doc("BOM", {"docstatus": 1, "with_operations": 1, "company": "_Test Company"}) - work_order = make_wo_order_test_record(item=bom.item, qty=1, - bom_no=bom.name, source_warehouse="_Test Warehouse - _TC") + work_order = make_wo_order_test_record( + item=bom.item, qty=1, bom_no=bom.name, source_warehouse="_Test Warehouse - _TC" + ) for row in work_order.required_items: - stock_entry_doc = test_stock_entry.make_stock_entry(item_code=row.item_code, - target="_Test Warehouse - _TC", qty=row.required_qty, basic_rate=100) + stock_entry_doc = test_stock_entry.make_stock_entry( + item_code=row.item_code, target="_Test Warehouse - _TC", qty=row.required_qty, basic_rate=100 + ) stock_entries.append(stock_entry_doc) ste = frappe.get_doc(make_stock_entry(work_order.name, "Material Transfer for Manufacture", 1)) ste.submit() stock_entries.append(ste) - job_cards = frappe.get_all('Job Card', filters = {'work_order': work_order.name}, order_by='creation asc') + job_cards = frappe.get_all( + "Job Card", filters={"work_order": work_order.name}, order_by="creation asc" + ) self.assertEqual(len(job_cards), len(bom.operations)) for i, job_card in enumerate(job_cards): @@ -417,29 +490,33 @@ class TestWorkOrder(unittest.TestCase): stock_entry.cancel() def test_capcity_planning(self): - frappe.db.set_value("Manufacturing Settings", None, { - "disable_capacity_planning": 0, - "capacity_planning_for_days": 1 - }) + frappe.db.set_value( + "Manufacturing Settings", + None, + {"disable_capacity_planning": 0, "capacity_planning_for_days": 1}, + ) - data = frappe.get_cached_value('BOM', {'docstatus': 1, 'item': '_Test FG Item 2', - 'with_operations': 1, 'company': '_Test Company'}, ['name', 'item']) + data = frappe.get_cached_value( + "BOM", + {"docstatus": 1, "item": "_Test FG Item 2", "with_operations": 1, "company": "_Test Company"}, + ["name", "item"], + ) if data: bom, bom_item = data planned_start_date = add_months(today(), months=-1) - work_order = make_wo_order_test_record(item=bom_item, - qty=10, bom_no=bom, planned_start_date=planned_start_date) + work_order = make_wo_order_test_record( + item=bom_item, qty=10, bom_no=bom, planned_start_date=planned_start_date + ) - work_order1 = make_wo_order_test_record(item=bom_item, - qty=30, bom_no=bom, planned_start_date=planned_start_date, do_not_submit=1) + work_order1 = make_wo_order_test_record( + item=bom_item, qty=30, bom_no=bom, planned_start_date=planned_start_date, do_not_submit=1 + ) self.assertRaises(CapacityError, work_order1.submit) - frappe.db.set_value("Manufacturing Settings", None, { - "capacity_planning_for_days": 30 - }) + frappe.db.set_value("Manufacturing Settings", None, {"capacity_planning_for_days": 30}) work_order1.reload() work_order1.submit() @@ -449,22 +526,22 @@ class TestWorkOrder(unittest.TestCase): work_order.cancel() def test_work_order_with_non_transfer_item(self): - items = {'Finished Good Transfer Item': 1, '_Test FG Item': 1, '_Test FG Item 1': 0} + items = {"Finished Good Transfer Item": 1, "_Test FG Item": 1, "_Test FG Item 1": 0} for item, allow_transfer in items.items(): - make_item(item, { - 'include_item_in_manufacturing': allow_transfer - }) + make_item(item, {"include_item_in_manufacturing": allow_transfer}) - fg_item = 'Finished Good Transfer Item' - test_stock_entry.make_stock_entry(item_code="_Test FG Item", - target="_Test Warehouse - _TC", qty=1, basic_rate=100) - test_stock_entry.make_stock_entry(item_code="_Test FG Item 1", - target="_Test Warehouse - _TC", qty=1, basic_rate=100) + fg_item = "Finished Good Transfer Item" + test_stock_entry.make_stock_entry( + item_code="_Test FG Item", target="_Test Warehouse - _TC", qty=1, basic_rate=100 + ) + test_stock_entry.make_stock_entry( + item_code="_Test FG Item 1", target="_Test Warehouse - _TC", qty=1, basic_rate=100 + ) - if not frappe.db.get_value('BOM', {'item': fg_item}): - make_bom(item=fg_item, raw_materials = ['_Test FG Item', '_Test FG Item 1']) + if not frappe.db.get_value("BOM", {"item": fg_item}): + make_bom(item=fg_item, raw_materials=["_Test FG Item", "_Test FG Item 1"]) - wo = make_wo_order_test_record(production_item = fg_item) + wo = make_wo_order_test_record(production_item=fg_item) ste = frappe.get_doc(make_stock_entry(wo.name, "Material Transfer for Manufacture", 1)) ste.insert() ste.submit() @@ -482,39 +559,42 @@ class TestWorkOrder(unittest.TestCase): rm1 = "Test Batch Size Item RM 1 For BOM" for item in ["Test Batch Size Item For BOM", "Test Batch Size Item RM 1 For BOM"]: - make_item(item, { - "include_item_in_manufacturing": 1, - "is_stock_item": 1 - }) + make_item(item, {"include_item_in_manufacturing": 1, "is_stock_item": 1}) - bom_name = frappe.db.get_value("BOM", - {"item": fg_item, "is_active": 1, "with_operations": 1}, "name") + bom_name = frappe.db.get_value( + "BOM", {"item": fg_item, "is_active": 1, "with_operations": 1}, "name" + ) if not bom_name: - bom = make_bom(item=fg_item, rate=1000, raw_materials = [rm1], do_not_save=True) + bom = make_bom(item=fg_item, rate=1000, raw_materials=[rm1], do_not_save=True) bom.with_operations = 1 - bom.append("operations", { - "operation": "_Test Operation 1", - "workstation": "_Test Workstation 1", - "description": "Test Data", - "operating_cost": 100, - "time_in_mins": 40, - "batch_size": 5 - }) + bom.append( + "operations", + { + "operation": "_Test Operation 1", + "workstation": "_Test Workstation 1", + "description": "Test Data", + "operating_cost": 100, + "time_in_mins": 40, + "batch_size": 5, + }, + ) bom.save() bom.submit() bom_name = bom.name - work_order = make_wo_order_test_record(item=fg_item, - planned_start_date=now(), qty=1, do_not_save=True) + work_order = make_wo_order_test_record( + item=fg_item, planned_start_date=now(), qty=1, do_not_save=True + ) work_order.set_work_order_operations() work_order.save() self.assertEqual(work_order.operations[0].time_in_mins, 8.0) - work_order1 = make_wo_order_test_record(item=fg_item, - planned_start_date=now(), qty=5, do_not_save=True) + work_order1 = make_wo_order_test_record( + item=fg_item, planned_start_date=now(), qty=5, do_not_save=True + ) work_order1.set_work_order_operations() work_order1.save() @@ -524,65 +604,73 @@ class TestWorkOrder(unittest.TestCase): fg_item = "Test Batch Size Item For BOM 3" rm1 = "Test Batch Size Item RM 1 For BOM 3" - frappe.db.set_value('Manufacturing Settings', None, 'make_serial_no_batch_from_work_order', 0) + frappe.db.set_value("Manufacturing Settings", None, "make_serial_no_batch_from_work_order", 0) for item in ["Test Batch Size Item For BOM 3", "Test Batch Size Item RM 1 For BOM 3"]: - item_args = { - "include_item_in_manufacturing": 1, - "is_stock_item": 1 - } + item_args = {"include_item_in_manufacturing": 1, "is_stock_item": 1} if item == fg_item: - item_args['has_batch_no'] = 1 - item_args['create_new_batch'] = 1 - item_args['batch_number_series'] = 'TBSI3.#####' + item_args["has_batch_no"] = 1 + item_args["create_new_batch"] = 1 + item_args["batch_number_series"] = "TBSI3.#####" make_item(item, item_args) - bom_name = frappe.db.get_value("BOM", - {"item": fg_item, "is_active": 1, "with_operations": 1}, "name") + bom_name = frappe.db.get_value( + "BOM", {"item": fg_item, "is_active": 1, "with_operations": 1}, "name" + ) if not bom_name: - bom = make_bom(item=fg_item, rate=1000, raw_materials = [rm1], do_not_save=True) + bom = make_bom(item=fg_item, rate=1000, raw_materials=[rm1], do_not_save=True) bom.save() bom.submit() bom_name = bom.name - work_order = make_wo_order_test_record(item=fg_item, skip_transfer=True, planned_start_date=now(), qty=1) + work_order = make_wo_order_test_record( + item=fg_item, skip_transfer=True, planned_start_date=now(), qty=1 + ) ste1 = frappe.get_doc(make_stock_entry(work_order.name, "Manufacture", 1)) - for row in ste1.get('items'): + for row in ste1.get("items"): if row.is_finished_item: self.assertEqual(row.item_code, fg_item) - work_order = make_wo_order_test_record(item=fg_item, skip_transfer=True, planned_start_date=now(), qty=1) - frappe.db.set_value('Manufacturing Settings', None, 'make_serial_no_batch_from_work_order', 1) + work_order = make_wo_order_test_record( + item=fg_item, skip_transfer=True, planned_start_date=now(), qty=1 + ) + frappe.db.set_value("Manufacturing Settings", None, "make_serial_no_batch_from_work_order", 1) ste1 = frappe.get_doc(make_stock_entry(work_order.name, "Manufacture", 1)) - for row in ste1.get('items'): + for row in ste1.get("items"): if row.is_finished_item: self.assertEqual(row.item_code, fg_item) - work_order = make_wo_order_test_record(item=fg_item, skip_transfer=True, planned_start_date=now(), - qty=30, do_not_save = True) + work_order = make_wo_order_test_record( + item=fg_item, skip_transfer=True, planned_start_date=now(), qty=30, do_not_save=True + ) work_order.batch_size = 10 work_order.insert() work_order.submit() self.assertEqual(work_order.has_batch_no, 1) ste1 = frappe.get_doc(make_stock_entry(work_order.name, "Manufacture", 30)) - for row in ste1.get('items'): + for row in ste1.get("items"): if row.is_finished_item: self.assertEqual(row.item_code, fg_item) self.assertEqual(row.qty, 10) - frappe.db.set_value('Manufacturing Settings', None, 'make_serial_no_batch_from_work_order', 0) + frappe.db.set_value("Manufacturing Settings", None, "make_serial_no_batch_from_work_order", 0) def test_partial_material_consumption(self): frappe.db.set_value("Manufacturing Settings", None, "material_consumption", 1) wo_order = make_wo_order_test_record(planned_start_date=now(), qty=4) ste_cancel_list = [] - ste1 = test_stock_entry.make_stock_entry(item_code="_Test Item", - target="_Test Warehouse - _TC", qty=20, basic_rate=5000.0) - ste2 = test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target="_Test Warehouse - _TC", qty=20, basic_rate=1000.0) + ste1 = test_stock_entry.make_stock_entry( + item_code="_Test Item", target="_Test Warehouse - _TC", qty=20, basic_rate=5000.0 + ) + ste2 = test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse - _TC", + qty=20, + basic_rate=1000.0, + ) ste_cancel_list.extend([ste1, ste2]) @@ -608,16 +696,25 @@ class TestWorkOrder(unittest.TestCase): def test_extra_material_transfer(self): frappe.db.set_value("Manufacturing Settings", None, "material_consumption", 0) - frappe.db.set_value("Manufacturing Settings", None, "backflush_raw_materials_based_on", - "Material Transferred for Manufacture") + frappe.db.set_value( + "Manufacturing Settings", + None, + "backflush_raw_materials_based_on", + "Material Transferred for Manufacture", + ) wo_order = make_wo_order_test_record(planned_start_date=now(), qty=4) ste_cancel_list = [] - ste1 = test_stock_entry.make_stock_entry(item_code="_Test Item", - target="_Test Warehouse - _TC", qty=20, basic_rate=5000.0) - ste2 = test_stock_entry.make_stock_entry(item_code="_Test Item Home Desktop 100", - target="_Test Warehouse - _TC", qty=20, basic_rate=1000.0) + ste1 = test_stock_entry.make_stock_entry( + item_code="_Test Item", target="_Test Warehouse - _TC", qty=20, basic_rate=5000.0 + ) + ste2 = test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse - _TC", + qty=20, + basic_rate=1000.0, + ) ste_cancel_list.extend([ste1, ste2]) @@ -649,30 +746,31 @@ class TestWorkOrder(unittest.TestCase): frappe.db.set_value("Manufacturing Settings", None, "backflush_raw_materials_based_on", "BOM") def test_make_stock_entry_for_customer_provided_item(self): - finished_item = 'Test Item for Make Stock Entry 1' - make_item(finished_item, { + finished_item = "Test Item for Make Stock Entry 1" + make_item(finished_item, {"include_item_in_manufacturing": 1, "is_stock_item": 1}) + + customer_provided_item = "CUST-0987" + make_item( + customer_provided_item, + { + "is_purchase_item": 0, + "is_customer_provided_item": 1, + "is_stock_item": 1, "include_item_in_manufacturing": 1, - "is_stock_item": 1 - }) + "customer": "_Test Customer", + }, + ) - customer_provided_item = 'CUST-0987' - make_item(customer_provided_item, { - 'is_purchase_item': 0, - 'is_customer_provided_item': 1, - "is_stock_item": 1, - "include_item_in_manufacturing": 1, - 'customer': '_Test Customer' - }) - - if not frappe.db.exists('BOM', {'item': finished_item}): + if not frappe.db.exists("BOM", {"item": finished_item}): make_bom(item=finished_item, raw_materials=[customer_provided_item], rm_qty=1) company = "_Test Company with perpetual inventory" customer_warehouse = create_warehouse("Test Customer Provided Warehouse", company=company) - wo = make_wo_order_test_record(item=finished_item, qty=1, source_warehouse=customer_warehouse, - company=company) + wo = make_wo_order_test_record( + item=finished_item, qty=1, source_warehouse=customer_warehouse, company=company + ) - ste = frappe.get_doc(make_stock_entry(wo.name, purpose='Material Transfer for Manufacture')) + ste = frappe.get_doc(make_stock_entry(wo.name, purpose="Material Transfer for Manufacture")) ste.insert() self.assertEqual(len(ste.items), 1) @@ -681,26 +779,34 @@ class TestWorkOrder(unittest.TestCase): self.assertEqual(item.valuation_rate, 0) def test_valuation_rate_missing_on_make_stock_entry(self): - item_name = 'Test Valuation Rate Missing' - rm_item = '_Test raw material item' - make_item(item_name, { - "is_stock_item": 1, - "include_item_in_manufacturing": 1, - }) - make_item('_Test raw material item', { - "is_stock_item": 1, - "include_item_in_manufacturing": 1, - }) + item_name = "Test Valuation Rate Missing" + rm_item = "_Test raw material item" + make_item( + item_name, + { + "is_stock_item": 1, + "include_item_in_manufacturing": 1, + }, + ) + make_item( + "_Test raw material item", + { + "is_stock_item": 1, + "include_item_in_manufacturing": 1, + }, + ) - if not frappe.db.get_value('BOM', {'item': item_name}): + if not frappe.db.get_value("BOM", {"item": item_name}): make_bom(item=item_name, raw_materials=[rm_item], rm_qty=1) company = "_Test Company with perpetual inventory" source_warehouse = create_warehouse("Test Valuation Rate Missing Warehouse", company=company) - wo = make_wo_order_test_record(item=item_name, qty=1, source_warehouse=source_warehouse, - company=company) + wo = make_wo_order_test_record( + item=item_name, qty=1, source_warehouse=source_warehouse, company=company + ) - self.assertRaises(frappe.ValidationError, make_stock_entry, wo.name, 'Material Transfer for Manufacture') + stock_entry = frappe.get_doc(make_stock_entry(wo.name, "Material Transfer for Manufacture")) + self.assertRaises(frappe.ValidationError, stock_entry.save) def test_wo_completion_with_pl_bom(self): from erpnext.manufacturing.doctype.bom.test_bom import ( @@ -709,19 +815,19 @@ class TestWorkOrder(unittest.TestCase): ) qty = 4 - scrap_qty = 0.25 # bom item qty = 1, consider as 25% of FG + scrap_qty = 0.25 # bom item qty = 1, consider as 25% of FG source_warehouse = "Stores - _TC" wip_warehouse = "_Test Warehouse - _TC" fg_item_non_whole, _, bom_item = create_process_loss_bom_items() - test_stock_entry.make_stock_entry(item_code=bom_item.item_code, - target=source_warehouse, qty=4, basic_rate=100) + test_stock_entry.make_stock_entry( + item_code=bom_item.item_code, target=source_warehouse, qty=4, basic_rate=100 + ) bom_no = f"BOM-{fg_item_non_whole.item_code}-001" if not frappe.db.exists("BOM", bom_no): bom_doc = create_bom_with_process_loss_item( - fg_item_non_whole, bom_item, scrap_qty=scrap_qty, - scrap_rate=0, fg_qty=1, is_process_loss=1 + fg_item_non_whole, bom_item, scrap_qty=scrap_qty, scrap_rate=0, fg_qty=1, is_process_loss=1 ) bom_doc.submit() @@ -734,16 +840,12 @@ class TestWorkOrder(unittest.TestCase): stock_uom=fg_item_non_whole.stock_uom, ) - se = frappe.get_doc( - make_stock_entry(wo.name, "Material Transfer for Manufacture", qty) - ) + se = frappe.get_doc(make_stock_entry(wo.name, "Material Transfer for Manufacture", qty)) se.get("items")[0].s_warehouse = "Stores - _TC" se.insert() se.submit() - se = frappe.get_doc( - make_stock_entry(wo.name, "Manufacture", qty) - ) + se = frappe.get_doc(make_stock_entry(wo.name, "Manufacture", qty)) se.insert() se.submit() @@ -760,40 +862,52 @@ class TestWorkOrder(unittest.TestCase): self.assertEqual(fg_item.qty, actual_fg_qty) # Testing Work Order values - self.assertEqual( - frappe.db.get_value("Work Order", wo.name, "produced_qty"), - qty - ) - self.assertEqual( - frappe.db.get_value("Work Order", wo.name, "process_loss_qty"), - total_pl_qty - ) + self.assertEqual(frappe.db.get_value("Work Order", wo.name, "produced_qty"), qty) + self.assertEqual(frappe.db.get_value("Work Order", wo.name, "process_loss_qty"), total_pl_qty) + @timeout(seconds=60) def test_job_card_scrap_item(self): - items = ['Test FG Item for Scrap Item Test', 'Test RM Item 1 for Scrap Item Test', - 'Test RM Item 2 for Scrap Item Test'] + items = [ + "Test FG Item for Scrap Item Test", + "Test RM Item 1 for Scrap Item Test", + "Test RM Item 2 for Scrap Item Test", + ] - company = '_Test Company with perpetual inventory' + company = "_Test Company with perpetual inventory" for item_code in items: - create_item(item_code = item_code, is_stock_item = 1, - is_purchase_item=1, opening_stock=100, valuation_rate=10, company=company, warehouse='Stores - TCP1') + create_item( + item_code=item_code, + is_stock_item=1, + is_purchase_item=1, + opening_stock=100, + valuation_rate=10, + company=company, + warehouse="Stores - TCP1", + ) - item = 'Test FG Item for Scrap Item Test' - raw_materials = ['Test RM Item 1 for Scrap Item Test', 'Test RM Item 2 for Scrap Item Test'] - if not frappe.db.get_value('BOM', {'item': item}): - bom = make_bom(item=item, source_warehouse='Stores - TCP1', raw_materials=raw_materials, do_not_save=True) + item = "Test FG Item for Scrap Item Test" + raw_materials = ["Test RM Item 1 for Scrap Item Test", "Test RM Item 2 for Scrap Item Test"] + if not frappe.db.get_value("BOM", {"item": item}): + bom = make_bom( + item=item, source_warehouse="Stores - TCP1", raw_materials=raw_materials, do_not_save=True + ) bom.with_operations = 1 - bom.append('operations', { - 'operation': '_Test Operation 1', - 'workstation': '_Test Workstation 1', - 'hour_rate': 20, - 'time_in_mins': 60 - }) + bom.append( + "operations", + { + "operation": "_Test Operation 1", + "workstation": "_Test Workstation 1", + "hour_rate": 20, + "time_in_mins": 60, + }, + ) bom.submit() - wo_order = make_wo_order_test_record(item=item, company=company, planned_start_date=now(), qty=20, skip_transfer=1) - job_card = frappe.db.get_value('Job Card', {'work_order': wo_order.name}, 'name') + wo_order = make_wo_order_test_record( + item=item, company=company, planned_start_date=now(), qty=20, skip_transfer=1 + ) + job_card = frappe.db.get_value("Job Card", {"work_order": wo_order.name}, "name") update_job_card(job_card) stock_entry = frappe.get_doc(make_stock_entry(wo_order.name, "Manufacture", 10)) @@ -801,90 +915,346 @@ class TestWorkOrder(unittest.TestCase): if row.is_scrap_item: self.assertEqual(row.qty, 1) + # Partial Job Card 1 with qty 10 + wo_order = make_wo_order_test_record( + item=item, company=company, planned_start_date=add_days(now(), 60), qty=20, skip_transfer=1 + ) + job_card = frappe.db.get_value("Job Card", {"work_order": wo_order.name}, "name") + update_job_card(job_card, 10) + + stock_entry = frappe.get_doc(make_stock_entry(wo_order.name, "Manufacture", 10)) + for row in stock_entry.items: + if row.is_scrap_item: + self.assertEqual(row.qty, 2) + + # Partial Job Card 2 with qty 10 + operations = [] + wo_order.load_from_db() + for row in wo_order.operations: + n_dict = row.as_dict() + n_dict["qty"] = 10 + n_dict["pending_qty"] = 10 + operations.append(n_dict) + + make_job_card(wo_order.name, operations) + job_card = frappe.db.get_value("Job Card", {"work_order": wo_order.name, "docstatus": 0}, "name") + update_job_card(job_card, 10) + + stock_entry = frappe.get_doc(make_stock_entry(wo_order.name, "Manufacture", 10)) + for row in stock_entry.items: + if row.is_scrap_item: + self.assertEqual(row.qty, 2) + def test_close_work_order(self): - items = ['Test FG Item for Closed WO', 'Test RM Item 1 for Closed WO', - 'Test RM Item 2 for Closed WO'] + items = [ + "Test FG Item for Closed WO", + "Test RM Item 1 for Closed WO", + "Test RM Item 2 for Closed WO", + ] - company = '_Test Company with perpetual inventory' + company = "_Test Company with perpetual inventory" for item_code in items: - create_item(item_code = item_code, is_stock_item = 1, - is_purchase_item=1, opening_stock=100, valuation_rate=10, company=company, warehouse='Stores - TCP1') + create_item( + item_code=item_code, + is_stock_item=1, + is_purchase_item=1, + opening_stock=100, + valuation_rate=10, + company=company, + warehouse="Stores - TCP1", + ) - item = 'Test FG Item for Closed WO' - raw_materials = ['Test RM Item 1 for Closed WO', 'Test RM Item 2 for Closed WO'] - if not frappe.db.get_value('BOM', {'item': item}): - bom = make_bom(item=item, source_warehouse='Stores - TCP1', raw_materials=raw_materials, do_not_save=True) + item = "Test FG Item for Closed WO" + raw_materials = ["Test RM Item 1 for Closed WO", "Test RM Item 2 for Closed WO"] + if not frappe.db.get_value("BOM", {"item": item}): + bom = make_bom( + item=item, source_warehouse="Stores - TCP1", raw_materials=raw_materials, do_not_save=True + ) bom.with_operations = 1 - bom.append('operations', { - 'operation': '_Test Operation 1', - 'workstation': '_Test Workstation 1', - 'hour_rate': 20, - 'time_in_mins': 60 - }) + bom.append( + "operations", + { + "operation": "_Test Operation 1", + "workstation": "_Test Workstation 1", + "hour_rate": 20, + "time_in_mins": 60, + }, + ) bom.submit() - wo_order = make_wo_order_test_record(item=item, company=company, planned_start_date=now(), qty=20, skip_transfer=1) - job_cards = frappe.db.get_value('Job Card', {'work_order': wo_order.name}, 'name') + wo_order = make_wo_order_test_record( + item=item, company=company, planned_start_date=now(), qty=20, skip_transfer=1 + ) + job_cards = frappe.db.get_value("Job Card", {"work_order": wo_order.name}, "name") if len(job_cards) == len(bom.operations): for jc in job_cards: - job_card_doc = frappe.get_doc('Job Card', jc) - job_card_doc.append('time_logs', { - 'from_time': now(), - 'time_in_mins': 60, - 'completed_qty': job_card_doc.for_quantity - }) + job_card_doc = frappe.get_doc("Job Card", jc) + job_card_doc.append( + "time_logs", + {"from_time": now(), "time_in_mins": 60, "completed_qty": job_card_doc.for_quantity}, + ) job_card_doc.submit() close_work_order(wo_order, "Closed") - self.assertEqual(wo_order.get('status'), "Closed") + self.assertEqual(wo_order.get("status"), "Closed") -def update_job_card(job_card): - job_card_doc = frappe.get_doc('Job Card', job_card) - job_card_doc.set('scrap_items', [ - { - 'item_code': 'Test RM Item 1 for Scrap Item Test', - 'stock_qty': 2 - }, - { - 'item_code': 'Test RM Item 2 for Scrap Item Test', - 'stock_qty': 2 - }, - ]) + def test_fix_time_operations(self): + bom = frappe.get_doc( + { + "doctype": "BOM", + "item": "_Test FG Item 2", + "is_active": 1, + "is_default": 1, + "quantity": 1.0, + "with_operations": 1, + "operations": [ + { + "operation": "_Test Operation 1", + "description": "_Test", + "workstation": "_Test Workstation 1", + "time_in_mins": 60, + "operating_cost": 140, + "fixed_time": 1, + } + ], + "items": [ + { + "amount": 5000.0, + "doctype": "BOM Item", + "item_code": "_Test Item", + "parentfield": "items", + "qty": 1.0, + "rate": 5000.0, + }, + ], + } + ) + bom.save() + bom.submit() - job_card_doc.append('time_logs', { - 'from_time': now(), - 'time_in_mins': 60, - 'completed_qty': job_card_doc.for_quantity - }) + wo1 = make_wo_order_test_record( + item=bom.item, bom_no=bom.name, qty=1, skip_transfer=1, do_not_submit=1 + ) + wo2 = make_wo_order_test_record( + item=bom.item, bom_no=bom.name, qty=2, skip_transfer=1, do_not_submit=1 + ) + + self.assertEqual(wo1.operations[0].time_in_mins, wo2.operations[0].time_in_mins) + + def test_partial_manufacture_entries(self): + cancel_stock_entry = [] + + frappe.db.set_value( + "Manufacturing Settings", + None, + "backflush_raw_materials_based_on", + "Material Transferred for Manufacture", + ) + + wo_order = make_wo_order_test_record(planned_start_date=now(), qty=100) + ste1 = test_stock_entry.make_stock_entry( + item_code="_Test Item", target="_Test Warehouse - _TC", qty=120, basic_rate=5000.0 + ) + ste2 = test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse - _TC", + qty=240, + basic_rate=1000.0, + ) + + cancel_stock_entry.extend([ste1.name, ste2.name]) + + sm = frappe.get_doc(make_stock_entry(wo_order.name, "Material Transfer for Manufacture", 100)) + for row in sm.get("items"): + if row.get("item_code") == "_Test Item": + row.qty = 110 + + sm.submit() + cancel_stock_entry.append(sm.name) + + s = frappe.get_doc(make_stock_entry(wo_order.name, "Manufacture", 90)) + for row in s.get("items"): + if row.get("item_code") == "_Test Item": + self.assertEqual(row.get("qty"), 100) + + s.submit() + cancel_stock_entry.append(s.name) + + s1 = frappe.get_doc(make_stock_entry(wo_order.name, "Manufacture", 5)) + for row in s1.get("items"): + if row.get("item_code") == "_Test Item": + self.assertEqual(row.get("qty"), 5) + s1.submit() + cancel_stock_entry.append(s1.name) + + s2 = frappe.get_doc(make_stock_entry(wo_order.name, "Manufacture", 5)) + for row in s2.get("items"): + if row.get("item_code") == "_Test Item": + self.assertEqual(row.get("qty"), 5) + + cancel_stock_entry.reverse() + for ste in cancel_stock_entry: + doc = frappe.get_doc("Stock Entry", ste) + doc.cancel() + + frappe.db.set_value("Manufacturing Settings", None, "backflush_raw_materials_based_on", "BOM") + + @change_settings("Manufacturing Settings", {"make_serial_no_batch_from_work_order": 1}) + def test_auto_batch_creation(self): + from erpnext.manufacturing.doctype.bom.test_bom import create_nested_bom + + fg_item = frappe.generate_hash(length=20) + child_item = frappe.generate_hash(length=20) + + bom_tree = {fg_item: {child_item: {}}} + + create_nested_bom(bom_tree, prefix="") + + item = frappe.get_doc("Item", fg_item) + item.has_batch_no = 1 + item.create_new_batch = 0 + item.save() + + try: + make_wo_order_test_record(item=fg_item) + except frappe.MandatoryError: + self.fail("Batch generation causing failing in Work Order") + + @change_settings( + "Manufacturing Settings", + {"backflush_raw_materials_based_on": "Material Transferred for Manufacture"}, + ) + def test_manufacture_entry_mapped_idx_with_exploded_bom(self): + """Test if WO containing BOM with partial exploded items and scrap items, maps idx correctly.""" + test_stock_entry.make_stock_entry( + item_code="_Test Item", + target="_Test Warehouse - _TC", + basic_rate=5000.0, + qty=2, + ) + test_stock_entry.make_stock_entry( + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse - _TC", + basic_rate=1000.0, + qty=2, + ) + + wo_order = make_wo_order_test_record( + qty=1, + use_multi_level_bom=1, + skip_transfer=1, + ) + + ste_manu = frappe.get_doc(make_stock_entry(wo_order.name, "Manufacture", 1)) + + for index, row in enumerate(ste_manu.get("items"), start=1): + self.assertEqual(index, row.idx) + + @change_settings( + "Manufacturing Settings", + {"backflush_raw_materials_based_on": "Material Transferred for Manufacture"}, + ) + def test_work_order_multiple_material_transfer(self): + """ + Test transferring multiple RMs in separate Stock Entries. + """ + work_order = make_wo_order_test_record(planned_start_date=now(), qty=1) + test_stock_entry.make_stock_entry( # stock up RM + item_code="_Test Item", + target="_Test Warehouse - _TC", + qty=1, + basic_rate=5000.0, + ) + test_stock_entry.make_stock_entry( # stock up RM + item_code="_Test Item Home Desktop 100", + target="_Test Warehouse - _TC", + qty=2, + basic_rate=1000.0, + ) + + transfer_entry = frappe.get_doc( + make_stock_entry(work_order.name, "Material Transfer for Manufacture", 1) + ) + del transfer_entry.get("items")[0] # transfer only one RM + transfer_entry.submit() + + # WO's "Material Transferred for Mfg" shows all is transferred, one RM is pending + work_order.reload() + self.assertEqual(work_order.material_transferred_for_manufacturing, 1) + self.assertEqual(work_order.required_items[0].transferred_qty, 0) + self.assertEqual(work_order.required_items[1].transferred_qty, 2) + + final_transfer_entry = frappe.get_doc( # transfer last RM with For Quantity = 0 + make_stock_entry(work_order.name, "Material Transfer for Manufacture", 0) + ) + final_transfer_entry.save() + + self.assertEqual(final_transfer_entry.fg_completed_qty, 0.0) + self.assertEqual(final_transfer_entry.items[0].qty, 1) + + final_transfer_entry.submit() + work_order.reload() + + # WO's "Material Transferred for Mfg" shows all is transferred, no RM is pending + self.assertEqual(work_order.material_transferred_for_manufacturing, 1) + self.assertEqual(work_order.required_items[0].transferred_qty, 1) + self.assertEqual(work_order.required_items[1].transferred_qty, 2) + + +def update_job_card(job_card, jc_qty=None): + employee = frappe.db.get_value("Employee", {"status": "Active"}, "name") + + job_card_doc = frappe.get_doc("Job Card", job_card) + job_card_doc.set( + "scrap_items", + [ + {"item_code": "Test RM Item 1 for Scrap Item Test", "stock_qty": 2}, + {"item_code": "Test RM Item 2 for Scrap Item Test", "stock_qty": 2}, + ], + ) + + if jc_qty: + job_card_doc.for_quantity = jc_qty + + job_card_doc.append( + "time_logs", + { + "from_time": now(), + "employee": employee, + "time_in_mins": 60, + "completed_qty": job_card_doc.for_quantity, + }, + ) job_card_doc.submit() def get_scrap_item_details(bom_no): scrap_items = {} - for item in frappe.db.sql("""select item_code, stock_qty from `tabBOM Scrap Item` - where parent = %s""", bom_no, as_dict=1): + for item in frappe.db.sql( + """select item_code, stock_qty from `tabBOM Scrap Item` + where parent = %s""", + bom_no, + as_dict=1, + ): scrap_items[item.item_code] = item.stock_qty return scrap_items + def allow_overproduction(fieldname, percentage): doc = frappe.get_doc("Manufacturing Settings") - doc.update({ - fieldname: percentage - }) + doc.update({fieldname: percentage}) doc.save() + def make_wo_order_test_record(**args): args = frappe._dict(args) if args.company and args.company != "_Test Company": - warehouse_map = { - "fg_warehouse": "_Test FG Warehouse", - "wip_warehouse": "_Test WIP Warehouse" - } + warehouse_map = {"fg_warehouse": "_Test FG Warehouse", "wip_warehouse": "_Test WIP Warehouse"} for attr, wh_name in warehouse_map.items(): if not args.get(attr): @@ -892,16 +1262,17 @@ def make_wo_order_test_record(**args): wo_order = frappe.new_doc("Work Order") wo_order.production_item = args.production_item or args.item or args.item_code or "_Test FG Item" - wo_order.bom_no = args.bom_no or frappe.db.get_value("BOM", {"item": wo_order.production_item, - "is_active": 1, "is_default": 1}) + wo_order.bom_no = args.bom_no or frappe.db.get_value( + "BOM", {"item": wo_order.production_item, "is_active": 1, "is_default": 1} + ) wo_order.qty = args.qty or 10 wo_order.wip_warehouse = args.wip_warehouse or "_Test Warehouse - _TC" wo_order.fg_warehouse = args.fg_warehouse or "_Test Warehouse 1 - _TC" wo_order.scrap_warehouse = args.fg_warehouse or "_Test Scrap Warehouse - _TC" wo_order.company = args.company or "_Test Company" wo_order.stock_uom = args.stock_uom or "_Test UOM" - wo_order.use_multi_level_bom=0 - wo_order.skip_transfer=args.skip_transfer or 0 + wo_order.use_multi_level_bom = 0 + wo_order.skip_transfer = args.skip_transfer or 0 wo_order.get_items_and_operations_from_bom() wo_order.sales_order = args.sales_order or None wo_order.planned_start_date = args.planned_start_date or now() @@ -918,4 +1289,5 @@ def make_wo_order_test_record(**args): wo_order.submit() return wo_order -test_records = frappe.get_test_records('Work Order') + +test_records = frappe.get_test_records("Work Order") diff --git a/erpnext/manufacturing/doctype/work_order/work_order.js b/erpnext/manufacturing/doctype/work_order/work_order.js index e47103599e9..a27c42b109e 100644 --- a/erpnext/manufacturing/doctype/work_order/work_order.js +++ b/erpnext/manufacturing/doctype/work_order/work_order.js @@ -131,16 +131,14 @@ frappe.ui.form.on("Work Order", { erpnext.work_order.set_custom_buttons(frm); frm.set_intro(""); - if (frm.doc.docstatus === 0 && !frm.doc.__islocal) { + if (frm.doc.docstatus === 0 && !frm.is_new()) { frm.set_intro(__("Submit this Work Order for further processing.")); + } else { + frm.trigger("show_progress_for_items"); + frm.trigger("show_progress_for_operations"); } if (frm.doc.status != "Closed") { - if (frm.doc.docstatus===1) { - frm.trigger('show_progress_for_items'); - frm.trigger('show_progress_for_operations'); - } - if (frm.doc.docstatus === 1 && frm.doc.operations && frm.doc.operations.length) { @@ -542,8 +540,10 @@ erpnext.work_order = { || frm.doc.transfer_material_against == 'Job Card') ? 0 : 1; if (show_start_btn) { - if ((flt(doc.material_transferred_for_manufacturing) < flt(doc.qty)) - && frm.doc.status != 'Stopped') { + let pending_to_transfer = frm.doc.required_items.some( + item => flt(item.transferred_qty) < flt(item.required_qty) + ); + if (pending_to_transfer && frm.doc.status != 'Stopped') { frm.has_start_btn = true; frm.add_custom_button(__('Create Pick List'), function() { erpnext.work_order.create_pick_list(frm); @@ -557,37 +557,52 @@ erpnext.work_order = { if(!frm.doc.skip_transfer){ // If "Material Consumption is check in Manufacturing Settings, allow Material Consumption - if ((flt(doc.produced_qty) < flt(doc.material_transferred_for_manufacturing)) - && frm.doc.status != 'Stopped') { - frm.has_finish_btn = true; + if (flt(doc.material_transferred_for_manufacturing) > 0 && frm.doc.status != 'Stopped') { + if ((flt(doc.produced_qty) < flt(doc.material_transferred_for_manufacturing))) { + frm.has_finish_btn = true; - if (frm.doc.__onload && frm.doc.__onload.material_consumption == 1) { - // Only show "Material Consumption" when required_qty > consumed_qty - var counter = 0; - var tbl = frm.doc.required_items || []; - var tbl_lenght = tbl.length; - for (var i = 0, len = tbl_lenght; i < len; i++) { - let wo_item_qty = frm.doc.required_items[i].transferred_qty || frm.doc.required_items[i].required_qty; - if (flt(wo_item_qty) > flt(frm.doc.required_items[i].consumed_qty)) { - counter += 1; + if (frm.doc.__onload && frm.doc.__onload.material_consumption == 1) { + // Only show "Material Consumption" when required_qty > consumed_qty + var counter = 0; + var tbl = frm.doc.required_items || []; + var tbl_lenght = tbl.length; + for (var i = 0, len = tbl_lenght; i < len; i++) { + let wo_item_qty = frm.doc.required_items[i].transferred_qty || frm.doc.required_items[i].required_qty; + if (flt(wo_item_qty) > flt(frm.doc.required_items[i].consumed_qty)) { + counter += 1; + } + } + if (counter > 0) { + var consumption_btn = frm.add_custom_button(__('Material Consumption'), function() { + const backflush_raw_materials_based_on = frm.doc.__onload.backflush_raw_materials_based_on; + erpnext.work_order.make_consumption_se(frm, backflush_raw_materials_based_on); + }); + consumption_btn.addClass('btn-primary'); } } - if (counter > 0) { - var consumption_btn = frm.add_custom_button(__('Material Consumption'), function() { - const backflush_raw_materials_based_on = frm.doc.__onload.backflush_raw_materials_based_on; - erpnext.work_order.make_consumption_se(frm, backflush_raw_materials_based_on); - }); - consumption_btn.addClass('btn-primary'); + + var finish_btn = frm.add_custom_button(__('Finish'), function() { + erpnext.work_order.make_se(frm, 'Manufacture'); + }); + + if(doc.material_transferred_for_manufacturing>=doc.qty) { + // all materials transferred for manufacturing, make this primary + finish_btn.addClass('btn-primary'); } - } + } else { + frappe.db.get_doc("Manufacturing Settings").then((doc) => { + let allowance_percentage = doc.overproduction_percentage_for_work_order; - var finish_btn = frm.add_custom_button(__('Finish'), function() { - erpnext.work_order.make_se(frm, 'Manufacture'); - }); + if (allowance_percentage > 0) { + let allowed_qty = frm.doc.qty + ((allowance_percentage / 100) * frm.doc.qty); - if(doc.material_transferred_for_manufacturing>=doc.qty) { - // all materials transferred for manufacturing, make this primary - finish_btn.addClass('btn-primary'); + if ((flt(doc.produced_qty) < allowed_qty)) { + frm.add_custom_button(__('Finish'), function() { + erpnext.work_order.make_se(frm, 'Manufacture'); + }); + } + } + }); } } } else { diff --git a/erpnext/manufacturing/doctype/work_order/work_order.json b/erpnext/manufacturing/doctype/work_order/work_order.json index 12cd58f418b..9452a63d70b 100644 --- a/erpnext/manufacturing/doctype/work_order/work_order.json +++ b/erpnext/manufacturing/doctype/work_order/work_order.json @@ -333,12 +333,13 @@ "options": "fa fa-wrench" }, { - "default": "Work Order", "depends_on": "operations", + "fetch_from": "bom_no.transfer_material_against", + "fetch_if_empty": 1, "fieldname": "transfer_material_against", "fieldtype": "Select", "label": "Transfer Material Against", - "options": "Work Order\nJob Card" + "options": "\nWork Order\nJob Card" }, { "fieldname": "operations", @@ -574,7 +575,7 @@ "image_field": "image", "is_submittable": 1, "links": [], - "modified": "2021-11-08 17:36:07.016300", + "modified": "2022-01-24 21:18:12.160114", "modified_by": "Administrator", "module": "Manufacturing", "name": "Work Order", @@ -607,6 +608,7 @@ ], "sort_field": "modified", "sort_order": "ASC", + "states": [], "title_field": "production_item", "track_changes": 1, "track_seen": 1 diff --git a/erpnext/manufacturing/doctype/work_order/work_order.py b/erpnext/manufacturing/doctype/work_order/work_order.py index 0090f4d04ee..2802310250b 100644 --- a/erpnext/manufacturing/doctype/work_order/work_order.py +++ b/erpnext/manufacturing/doctype/work_order/work_order.py @@ -8,6 +8,8 @@ from dateutil.relativedelta import relativedelta from frappe import _ from frappe.model.document import Document from frappe.model.mapper import get_mapped_doc +from frappe.query_builder import Case +from frappe.query_builder.functions import Sum from frappe.utils import ( cint, date_diff, @@ -31,6 +33,7 @@ from erpnext.stock.doctype.batch.batch import make_batch from erpnext.stock.doctype.item.item import get_item_defaults, validate_end_of_life from erpnext.stock.doctype.serial_no.serial_no import ( auto_make_serial_nos, + clean_serial_no_string, get_auto_serial_nos, get_serial_nos, ) @@ -39,11 +42,26 @@ from erpnext.stock.utils import get_bin, get_latest_stock_qty, validate_warehous from erpnext.utilities.transaction_base import validate_uom_is_integer -class OverProductionError(frappe.ValidationError): pass -class CapacityError(frappe.ValidationError): pass -class StockOverProductionError(frappe.ValidationError): pass -class OperationTooLongError(frappe.ValidationError): pass -class ItemHasVariantError(frappe.ValidationError): pass +class OverProductionError(frappe.ValidationError): + pass + + +class CapacityError(frappe.ValidationError): + pass + + +class StockOverProductionError(frappe.ValidationError): + pass + + +class OperationTooLongError(frappe.ValidationError): + pass + + +class ItemHasVariantError(frappe.ValidationError): + pass + + class SerialNoQtyError(frappe.ValidationError): pass @@ -65,17 +83,19 @@ class WorkOrder(Document): self.validate_warehouse_belongs_to_company() self.calculate_operating_cost() self.validate_qty() + self.validate_transfer_against() self.validate_operation_time() self.status = self.get_status() validate_uom_is_integer(self, "stock_uom", ["qty", "produced_qty"]) - self.set_required_items(reset_only_qty = len(self.get("required_items"))) + self.set_required_items(reset_only_qty=len(self.get("required_items"))) def validate_sales_order(self): if self.sales_order: self.check_sales_order_on_hold_or_close() - so = frappe.db.sql(""" + so = frappe.db.sql( + """ select so.name, so_item.delivery_date, so.project from `tabSales Order` so inner join `tabSales Order Item` so_item on so_item.parent = so.name @@ -84,10 +104,14 @@ class WorkOrder(Document): and so.skip_delivery_note = 0 and ( so_item.item_code=%s or pk_item.item_code=%s ) - """, (self.sales_order, self.production_item, self.production_item), as_dict=1) + """, + (self.sales_order, self.production_item, self.production_item), + as_dict=1, + ) if not so: - so = frappe.db.sql(""" + so = frappe.db.sql( + """ select so.name, so_item.delivery_date, so.project from @@ -98,7 +122,10 @@ class WorkOrder(Document): and so.skip_delivery_note = 0 and so_item.item_code = packed_item.parent_item and so.docstatus = 1 and packed_item.item_code=%s - """, (self.sales_order, self.production_item), as_dict=1) + """, + (self.sales_order, self.production_item), + as_dict=1, + ) if len(so): if not self.expected_delivery_date: @@ -119,7 +146,9 @@ class WorkOrder(Document): def set_default_warehouse(self): if not self.wip_warehouse: - self.wip_warehouse = frappe.db.get_single_value("Manufacturing Settings", "default_wip_warehouse") + self.wip_warehouse = frappe.db.get_single_value( + "Manufacturing Settings", "default_wip_warehouse" + ) if not self.fg_warehouse: self.fg_warehouse = frappe.db.get_single_value("Manufacturing Settings", "default_fg_warehouse") @@ -141,40 +170,55 @@ class WorkOrder(Document): self.planned_operating_cost += flt(d.planned_operating_cost) self.actual_operating_cost += flt(d.actual_operating_cost) - variable_cost = self.actual_operating_cost if self.actual_operating_cost \ - else self.planned_operating_cost + variable_cost = ( + self.actual_operating_cost if self.actual_operating_cost else self.planned_operating_cost + ) - self.total_operating_cost = (flt(self.additional_operating_cost) - + flt(variable_cost) + flt(self.corrective_operation_cost)) + self.total_operating_cost = ( + flt(self.additional_operating_cost) + flt(variable_cost) + flt(self.corrective_operation_cost) + ) def validate_work_order_against_so(self): # already ordered qty - ordered_qty_against_so = frappe.db.sql("""select sum(qty) from `tabWork Order` + ordered_qty_against_so = frappe.db.sql( + """select sum(qty) from `tabWork Order` where production_item = %s and sales_order = %s and docstatus < 2 and name != %s""", - (self.production_item, self.sales_order, self.name))[0][0] + (self.production_item, self.sales_order, self.name), + )[0][0] total_qty = flt(ordered_qty_against_so) + flt(self.qty) # get qty from Sales Order Item table - so_item_qty = frappe.db.sql("""select sum(stock_qty) from `tabSales Order Item` + so_item_qty = frappe.db.sql( + """select sum(stock_qty) from `tabSales Order Item` where parent = %s and item_code = %s""", - (self.sales_order, self.production_item))[0][0] + (self.sales_order, self.production_item), + )[0][0] # get qty from Packing Item table - dnpi_qty = frappe.db.sql("""select sum(qty) from `tabPacked Item` + dnpi_qty = frappe.db.sql( + """select sum(qty) from `tabPacked Item` where parent = %s and parenttype = 'Sales Order' and item_code = %s""", - (self.sales_order, self.production_item))[0][0] + (self.sales_order, self.production_item), + )[0][0] # total qty in SO so_qty = flt(so_item_qty) + flt(dnpi_qty) - allowance_percentage = flt(frappe.db.get_single_value("Manufacturing Settings", - "overproduction_percentage_for_sales_order")) + allowance_percentage = flt( + frappe.db.get_single_value( + "Manufacturing Settings", "overproduction_percentage_for_sales_order" + ) + ) - if total_qty > so_qty + (allowance_percentage/100 * so_qty): - frappe.throw(_("Cannot produce more Item {0} than Sales Order quantity {1}") - .format(self.production_item, so_qty), OverProductionError) + if total_qty > so_qty + (allowance_percentage / 100 * so_qty): + frappe.throw( + _("Cannot produce more Item {0} than Sales Order quantity {1}").format( + self.production_item, so_qty + ), + OverProductionError, + ) def update_status(self, status=None): - '''Update status of work order if unknown''' + """Update status of work order if unknown""" if status != "Stopped" and status != "Closed": status = self.get_status(status) @@ -186,17 +230,22 @@ class WorkOrder(Document): return status def get_status(self, status=None): - '''Return the status based on stock entries against this work order''' + """Return the status based on stock entries against this work order""" if not status: status = self.status - if self.docstatus==0: - status = 'Draft' - elif self.docstatus==1: - if status != 'Stopped': - stock_entries = frappe._dict(frappe.db.sql("""select purpose, sum(fg_completed_qty) + if self.docstatus == 0: + status = "Draft" + elif self.docstatus == 1: + if status != "Stopped": + stock_entries = frappe._dict( + frappe.db.sql( + """select purpose, sum(fg_completed_qty) from `tabStock Entry` where work_order=%s and docstatus=1 - group by purpose""", self.name)) + group by purpose""", + self.name, + ) + ) status = "Not Started" if stock_entries: @@ -205,31 +254,46 @@ class WorkOrder(Document): if flt(produced_qty) >= flt(self.qty): status = "Completed" else: - status = 'Cancelled' + status = "Cancelled" return status def update_work_order_qty(self): """Update **Manufactured Qty** and **Material Transferred for Qty** in Work Order - based on Stock Entry""" + based on Stock Entry""" - allowance_percentage = flt(frappe.db.get_single_value("Manufacturing Settings", - "overproduction_percentage_for_work_order")) + allowance_percentage = flt( + frappe.db.get_single_value("Manufacturing Settings", "overproduction_percentage_for_work_order") + ) - for purpose, fieldname in (("Manufacture", "produced_qty"), - ("Material Transfer for Manufacture", "material_transferred_for_manufacturing")): - if (purpose == 'Material Transfer for Manufacture' and - self.operations and self.transfer_material_against == 'Job Card'): + for purpose, fieldname in ( + ("Manufacture", "produced_qty"), + ("Material Transfer for Manufacture", "material_transferred_for_manufacturing"), + ): + if ( + purpose == "Material Transfer for Manufacture" + and self.operations + and self.transfer_material_against == "Job Card" + ): continue - qty = flt(frappe.db.sql("""select sum(fg_completed_qty) + qty = flt( + frappe.db.sql( + """select sum(fg_completed_qty) from `tabStock Entry` where work_order=%s and docstatus=1 - and purpose=%s""", (self.name, purpose))[0][0]) + and purpose=%s""", + (self.name, purpose), + )[0][0] + ) - completed_qty = self.qty + (allowance_percentage/100 * self.qty) + completed_qty = self.qty + (allowance_percentage / 100 * self.qty) if qty > completed_qty: - frappe.throw(_("{0} ({1}) cannot be greater than planned quantity ({2}) in Work Order {3}").format(\ - self.meta.get_label(fieldname), qty, completed_qty, self.name), StockOverProductionError) + frappe.throw( + _("{0} ({1}) cannot be greater than planned quantity ({2}) in Work Order {3}").format( + self.meta.get_label(fieldname), qty, completed_qty, self.name + ), + StockOverProductionError, + ) self.db_set(fieldname, qty) self.set_process_loss_qty() @@ -243,7 +307,9 @@ class WorkOrder(Document): self.update_production_plan_status() def set_process_loss_qty(self): - process_loss_qty = flt(frappe.db.sql(""" + process_loss_qty = flt( + frappe.db.sql( + """ SELECT sum(qty) FROM `tabStock Entry Detail` WHERE is_process_loss=1 @@ -254,21 +320,33 @@ class WorkOrder(Document): AND purpose='Manufacture' AND docstatus=1 ) - """, (self.name, ))[0][0]) + """, + (self.name,), + )[0][0] + ) if process_loss_qty is not None: - self.db_set('process_loss_qty', process_loss_qty) + self.db_set("process_loss_qty", process_loss_qty) def update_production_plan_status(self): - production_plan = frappe.get_doc('Production Plan', self.production_plan) + production_plan = frappe.get_doc("Production Plan", self.production_plan) produced_qty = 0 if self.production_plan_item: - total_qty = frappe.get_all("Work Order", fields = "sum(produced_qty) as produced_qty", - filters = {'docstatus': 1, 'production_plan': self.production_plan, - 'production_plan_item': self.production_plan_item}, as_list=1) + total_qty = frappe.get_all( + "Work Order", + fields="sum(produced_qty) as produced_qty", + filters={ + "docstatus": 1, + "production_plan": self.production_plan, + "production_plan_item": self.production_plan_item, + }, + as_list=1, + ) produced_qty = total_qty[0][0] if total_qty else 0 - production_plan.run_method("update_produced_qty", produced_qty, self.production_plan_item) + production_plan.run_method( + "update_produced_pending_qty", produced_qty, self.production_plan_item + ) def before_submit(self): self.create_serial_no_batch_no() @@ -279,7 +357,9 @@ class WorkOrder(Document): if not self.fg_warehouse: frappe.throw(_("For Warehouse is required before Submit")) - if self.production_plan and frappe.db.exists('Production Plan Item Reference',{'parent':self.production_plan}): + if self.production_plan and frappe.db.exists( + "Production Plan Item Reference", {"parent": self.production_plan} + ): self.update_work_order_qty_in_combined_so() else: self.update_work_order_qty_in_so() @@ -292,9 +372,11 @@ class WorkOrder(Document): def on_cancel(self): self.validate_cancel() - frappe.db.set(self,'status', 'Cancelled') + frappe.db.set(self, "status", "Cancelled") - if self.production_plan and frappe.db.exists('Production Plan Item Reference',{'parent':self.production_plan}): + if self.production_plan and frappe.db.exists( + "Production Plan Item Reference", {"parent": self.production_plan} + ): self.update_work_order_qty_in_combined_so() else: self.update_work_order_qty_in_so() @@ -310,16 +392,15 @@ class WorkOrder(Document): if not (self.has_serial_no or self.has_batch_no): return - if not cint(frappe.db.get_single_value("Manufacturing Settings", "make_serial_no_batch_from_work_order")): + if not cint( + frappe.db.get_single_value("Manufacturing Settings", "make_serial_no_batch_from_work_order") + ): return if self.has_batch_no: self.create_batch_for_finished_good() - args = { - "item_code": self.production_item, - "work_order": self.name - } + args = {"item_code": self.production_item, "work_order": self.name} if self.has_serial_no: self.make_serial_nos(args) @@ -329,6 +410,17 @@ class WorkOrder(Document): if not self.batch_size: self.batch_size = total_qty + batch_auto_creation = frappe.get_cached_value("Item", self.production_item, "create_new_batch") + if not batch_auto_creation: + frappe.msgprint( + _("Batch not created for item {} since it does not have a batch series.").format( + frappe.bold(self.production_item) + ), + alert=True, + indicator="orange", + ) + return + while total_qty > 0: qty = self.batch_size if self.batch_size >= total_qty: @@ -340,22 +432,27 @@ class WorkOrder(Document): qty = total_qty total_qty = 0 - make_batch(frappe._dict({ - "item": self.production_item, - "qty_to_produce": qty, - "reference_doctype": self.doctype, - "reference_name": self.name - })) + make_batch( + frappe._dict( + { + "item": self.production_item, + "qty_to_produce": qty, + "reference_doctype": self.doctype, + "reference_name": self.name, + } + ) + ) def delete_auto_created_batch_and_serial_no(self): - for row in frappe.get_all("Serial No", filters = {"work_order": self.name}): + for row in frappe.get_all("Serial No", filters={"work_order": self.name}): frappe.delete_doc("Serial No", row.name) self.db_set("serial_no", "") - for row in frappe.get_all("Batch", filters = {"reference_name": self.name}): + for row in frappe.get_all("Batch", filters={"reference_name": self.name}): frappe.delete_doc("Batch", row.name) def make_serial_nos(self, args): + self.serial_no = clean_serial_no_string(self.serial_no) serial_no_series = frappe.get_cached_value("Item", self.production_item, "serial_no_series") if serial_no_series: self.serial_no = get_auto_serial_nos(serial_no_series, self.qty) @@ -366,8 +463,12 @@ class WorkOrder(Document): serial_nos_length = len(get_serial_nos(self.serial_no)) if serial_nos_length != self.qty: - frappe.throw(_("{0} Serial Numbers required for Item {1}. You have provided {2}.") - .format(self.qty, self.production_item, serial_nos_length), SerialNoQtyError) + frappe.throw( + _("{0} Serial Numbers required for Item {1}. You have provided {2}.").format( + self.qty, self.production_item, serial_nos_length + ), + SerialNoQtyError, + ) def create_job_card(self): manufacturing_settings_doc = frappe.get_doc("Manufacturing Settings") @@ -380,8 +481,7 @@ class WorkOrder(Document): while qty > 0: qty = split_qty_based_on_batch_size(self, row, qty) if row.job_card_qty > 0: - self.prepare_data_for_job_card(row, index, - plan_days, enable_capacity_planning) + self.prepare_data_for_job_card(row, index, plan_days, enable_capacity_planning) planned_end_date = self.operations and self.operations[-1].planned_end_time if planned_end_date: @@ -391,12 +491,14 @@ class WorkOrder(Document): self.set_operation_start_end_time(index, row) if not row.workstation: - frappe.throw(_("Row {0}: select the workstation against the operation {1}") - .format(row.idx, row.operation)) + frappe.throw( + _("Row {0}: select the workstation against the operation {1}").format(row.idx, row.operation) + ) original_start_time = row.planned_start_time - job_card_doc = create_job_card(self, row, auto_create=True, - enable_capacity_planning=enable_capacity_planning) + job_card_doc = create_job_card( + self, row, auto_create=True, enable_capacity_planning=enable_capacity_planning + ) if enable_capacity_planning and job_card_doc: row.planned_start_time = job_card_doc.time_logs[-1].from_time @@ -404,22 +506,29 @@ class WorkOrder(Document): if date_diff(row.planned_start_time, original_start_time) > plan_days: frappe.message_log.pop() - frappe.throw(_("Unable to find the time slot in the next {0} days for the operation {1}.") - .format(plan_days, row.operation), CapacityError) + frappe.throw( + _("Unable to find the time slot in the next {0} days for the operation {1}.").format( + plan_days, row.operation + ), + CapacityError, + ) row.db_update() def set_operation_start_end_time(self, idx, row): """Set start and end time for given operation. If first operation, set start as `planned_start_date`, else add time diff to end time of earlier operation.""" - if idx==0: + if idx == 0: # first operation at planned_start date row.planned_start_time = self.planned_start_date else: - row.planned_start_time = get_datetime(self.operations[idx-1].planned_end_time)\ - + get_mins_between_operations() + row.planned_start_time = ( + get_datetime(self.operations[idx - 1].planned_end_time) + get_mins_between_operations() + ) - row.planned_end_time = get_datetime(row.planned_start_time) + relativedelta(minutes = row.time_in_mins) + row.planned_end_time = get_datetime(row.planned_start_time) + relativedelta( + minutes=row.time_in_mins + ) if row.planned_start_time == row.planned_end_time: frappe.throw(_("Capacity Planning Error, planned start time can not be same as end time")) @@ -429,29 +538,47 @@ class WorkOrder(Document): frappe.throw(_("Stopped Work Order cannot be cancelled, Unstop it first to cancel")) # Check whether any stock entry exists against this Work Order - stock_entry = frappe.db.sql("""select name from `tabStock Entry` - where work_order = %s and docstatus = 1""", self.name) + stock_entry = frappe.db.sql( + """select name from `tabStock Entry` + where work_order = %s and docstatus = 1""", + self.name, + ) if stock_entry: - frappe.throw(_("Cannot cancel because submitted Stock Entry {0} exists").format(frappe.utils.get_link_to_form('Stock Entry', stock_entry[0][0]))) + frappe.throw( + _("Cannot cancel because submitted Stock Entry {0} exists").format( + frappe.utils.get_link_to_form("Stock Entry", stock_entry[0][0]) + ) + ) def update_planned_qty(self): - update_bin_qty(self.production_item, self.fg_warehouse, { - "planned_qty": get_planned_qty(self.production_item, self.fg_warehouse) - }) + update_bin_qty( + self.production_item, + self.fg_warehouse, + {"planned_qty": get_planned_qty(self.production_item, self.fg_warehouse)}, + ) if self.material_request: mr_obj = frappe.get_doc("Material Request", self.material_request) mr_obj.update_requested_qty([self.material_request_item]) def update_ordered_qty(self): - if self.production_plan and self.production_plan_item: - qty = self.qty if self.docstatus == 1 else 0 - frappe.db.set_value('Production Plan Item', - self.production_plan_item, 'ordered_qty', qty) + if ( + self.production_plan + and self.production_plan_item + and not self.production_plan_sub_assembly_item + ): + qty = frappe.get_value("Production Plan Item", self.production_plan_item, "ordered_qty") or 0.0 - doc = frappe.get_doc('Production Plan', self.production_plan) + if self.docstatus == 1: + qty += self.qty + elif self.docstatus == 2: + qty -= self.qty + + frappe.db.set_value("Production Plan Item", self.production_plan_item, "ordered_qty", qty) + + doc = frappe.get_doc("Production Plan", self.production_plan) doc.set_status() - doc.db_set('status', doc.status) + doc.db_set("status", doc.status) def update_work_order_qty_in_so(self): if not self.sales_order and not self.sales_order_item: @@ -459,8 +586,11 @@ class WorkOrder(Document): total_bundle_qty = 1 if self.product_bundle_item: - total_bundle_qty = frappe.db.sql(""" select sum(qty) from - `tabProduct Bundle Item` where parent = %s""", (frappe.db.escape(self.product_bundle_item)))[0][0] + total_bundle_qty = frappe.db.sql( + """ select sum(qty) from + `tabProduct Bundle Item` where parent = %s""", + (frappe.db.escape(self.product_bundle_item)), + )[0][0] if not total_bundle_qty: # product bundle is 0 (product bundle allows 0 qty for items) @@ -468,57 +598,88 @@ class WorkOrder(Document): cond = "product_bundle_item = %s" if self.product_bundle_item else "production_item = %s" - qty = frappe.db.sql(""" select sum(qty) from + qty = frappe.db.sql( + """ select sum(qty) from `tabWork Order` where sales_order = %s and docstatus = 1 and {0} - """.format(cond), (self.sales_order, (self.product_bundle_item or self.production_item)), as_list=1) + """.format( + cond + ), + (self.sales_order, (self.product_bundle_item or self.production_item)), + as_list=1, + ) work_order_qty = qty[0][0] if qty and qty[0][0] else 0 - frappe.db.set_value('Sales Order Item', - self.sales_order_item, 'work_order_qty', flt(work_order_qty/total_bundle_qty, 2)) + frappe.db.set_value( + "Sales Order Item", + self.sales_order_item, + "work_order_qty", + flt(work_order_qty / total_bundle_qty, 2), + ) def update_work_order_qty_in_combined_so(self): total_bundle_qty = 1 if self.product_bundle_item: - total_bundle_qty = frappe.db.sql(""" select sum(qty) from - `tabProduct Bundle Item` where parent = %s""", (frappe.db.escape(self.product_bundle_item)))[0][0] + total_bundle_qty = frappe.db.sql( + """ select sum(qty) from + `tabProduct Bundle Item` where parent = %s""", + (frappe.db.escape(self.product_bundle_item)), + )[0][0] if not total_bundle_qty: # product bundle is 0 (product bundle allows 0 qty for items) total_bundle_qty = 1 - prod_plan = frappe.get_doc('Production Plan', self.production_plan) - item_reference = frappe.get_value('Production Plan Item', self.production_plan_item, 'sales_order_item') + prod_plan = frappe.get_doc("Production Plan", self.production_plan) + item_reference = frappe.get_value( + "Production Plan Item", self.production_plan_item, "sales_order_item" + ) for plan_reference in prod_plan.prod_plan_references: work_order_qty = 0.0 if plan_reference.item_reference == item_reference: if self.docstatus == 1: work_order_qty = flt(plan_reference.qty) / total_bundle_qty - frappe.db.set_value('Sales Order Item', - plan_reference.sales_order_item, 'work_order_qty', work_order_qty) + frappe.db.set_value( + "Sales Order Item", plan_reference.sales_order_item, "work_order_qty", work_order_qty + ) def update_completed_qty_in_material_request(self): if self.material_request: - frappe.get_doc("Material Request", self.material_request).update_completed_qty([self.material_request_item]) + frappe.get_doc("Material Request", self.material_request).update_completed_qty( + [self.material_request_item] + ) def set_work_order_operations(self): """Fetch operations from BOM and set in 'Work Order'""" def _get_operations(bom_no, qty=1): - return frappe.db.sql( - f"""select - operation, description, workstation, idx, - base_hour_rate as hour_rate, time_in_mins * {qty} as time_in_mins, - "Pending" as status, parent as bom, batch_size, sequence_id - from - `tabBOM Operation` - where - parent = %s order by idx - """, bom_no, as_dict=1) + data = frappe.get_all( + "BOM Operation", + filters={"parent": bom_no}, + fields=[ + "operation", + "description", + "workstation", + "idx", + "base_hour_rate as hour_rate", + "time_in_mins", + "parent as bom", + "batch_size", + "sequence_id", + "fixed_time", + ], + order_by="idx", + ) + for d in data: + if not d.fixed_time: + d.time_in_mins = flt(d.time_in_mins) * flt(qty) + d.status = "Pending" - self.set('operations', []) - if not self.bom_no or not frappe.get_cached_value('BOM', self.bom_no, 'with_operations'): + return data + + self.set("operations", []) + if not self.bom_no or not frappe.get_cached_value("BOM", self.bom_no, "with_operations"): return operations = [] @@ -531,18 +692,19 @@ class WorkOrder(Document): if node.is_bom: operations.extend(_get_operations(node.name, qty=node.exploded_qty)) - bom_qty = frappe.db.get_value("BOM", self.bom_no, "quantity") - operations.extend(_get_operations(self.bom_no, qty=1.0/bom_qty)) + bom_qty = frappe.get_cached_value("BOM", self.bom_no, "quantity") + operations.extend(_get_operations(self.bom_no, qty=1.0 / bom_qty)) for correct_index, operation in enumerate(operations, start=1): operation.idx = correct_index - self.set('operations', operations) + self.set("operations", operations) self.calculate_time() def calculate_time(self): for d in self.get("operations"): - d.time_in_mins = flt(d.time_in_mins) * (flt(self.qty) / flt(d.batch_size)) + if not d.fixed_time: + d.time_in_mins = flt(d.time_in_mins) * (flt(self.qty) / flt(d.batch_size)) self.calculate_operating_cost() @@ -552,16 +714,27 @@ class WorkOrder(Document): holidays = {} if holiday_list not in holidays: - holiday_list_days = [getdate(d[0]) for d in frappe.get_all("Holiday", fields=["holiday_date"], - filters={"parent": holiday_list}, order_by="holiday_date", limit_page_length=0, as_list=1)] + holiday_list_days = [ + getdate(d[0]) + for d in frappe.get_all( + "Holiday", + fields=["holiday_date"], + filters={"parent": holiday_list}, + order_by="holiday_date", + limit_page_length=0, + as_list=1, + ) + ] holidays[holiday_list] = holiday_list_days return holidays[holiday_list] def update_operation_status(self): - allowance_percentage = flt(frappe.db.get_single_value("Manufacturing Settings", "overproduction_percentage_for_work_order")) - max_allowed_qty_for_wo = flt(self.qty) + (allowance_percentage/100 * flt(self.qty)) + allowance_percentage = flt( + frappe.db.get_single_value("Manufacturing Settings", "overproduction_percentage_for_work_order") + ) + max_allowed_qty_for_wo = flt(self.qty) + (allowance_percentage / 100 * flt(self.qty)) for d in self.get("operations"): if not d.completed_qty: @@ -577,7 +750,9 @@ class WorkOrder(Document): def set_actual_dates(self): if self.get("operations"): - actual_start_dates = [d.actual_start_time for d in self.get("operations") if d.actual_start_time] + actual_start_dates = [ + d.actual_start_time for d in self.get("operations") if d.actual_start_time + ] if actual_start_dates: self.actual_start_date = min(actual_start_dates) @@ -585,20 +760,21 @@ class WorkOrder(Document): if actual_end_dates: self.actual_end_date = max(actual_end_dates) else: - data = frappe.get_all("Stock Entry", - fields = ["timestamp(posting_date, posting_time) as posting_datetime"], - filters = { + data = frappe.get_all( + "Stock Entry", + fields=["timestamp(posting_date, posting_time) as posting_datetime"], + filters={ "work_order": self.name, - "purpose": ("in", ["Material Transfer for Manufacture", "Manufacture"]) - } + "purpose": ("in", ["Material Transfer for Manufacture", "Manufacture"]), + }, ) if data and len(data): dates = [d.posting_datetime for d in data] - self.db_set('actual_start_date', min(dates)) + self.db_set("actual_start_date", min(dates)) if self.status == "Completed": - self.db_set('actual_end_date', max(dates)) + self.db_set("actual_end_date", max(dates)) self.set_lead_time() @@ -611,7 +787,7 @@ class WorkOrder(Document): frappe.delete_doc("Job Card", d.name) def validate_production_item(self): - if frappe.db.get_value("Item", self.production_item, "has_variants"): + if frappe.get_cached_value("Item", self.production_item, "has_variants"): frappe.throw(_("Work Order cannot be raised against a Item Template"), ItemHasVariantError) if self.production_item: @@ -621,20 +797,66 @@ class WorkOrder(Document): if not self.qty > 0: frappe.throw(_("Quantity to Manufacture must be greater than 0.")) + if ( + self.production_plan + and self.production_plan_item + and not self.production_plan_sub_assembly_item + ): + qty_dict = frappe.db.get_value( + "Production Plan Item", self.production_plan_item, ["planned_qty", "ordered_qty"], as_dict=1 + ) + + if not qty_dict: + return + + allowance_qty = ( + flt( + frappe.db.get_single_value( + "Manufacturing Settings", "overproduction_percentage_for_work_order" + ) + ) + / 100 + * qty_dict.get("planned_qty", 0) + ) + + max_qty = qty_dict.get("planned_qty", 0) + allowance_qty - qty_dict.get("ordered_qty", 0) + + if not max_qty > 0: + frappe.throw( + _("Cannot produce more item for {0}").format(self.production_item), OverProductionError + ) + elif self.qty > max_qty: + frappe.throw( + _("Cannot produce more than {0} items for {1}").format(max_qty, self.production_item), + OverProductionError, + ) + + def validate_transfer_against(self): + if not self.docstatus == 1: + # let user configure operations until they're ready to submit + return + if not self.operations: + self.transfer_material_against = "Work Order" + if not self.transfer_material_against: + frappe.throw( + _("Setting {} is required").format(self.meta.get_label("transfer_material_against")), + title=_("Missing value"), + ) + def validate_operation_time(self): for d in self.operations: if not d.time_in_mins > 0: frappe.throw(_("Operation Time must be greater than 0 for Operation {0}").format(d.operation)) def update_required_items(self): - ''' + """ update bin reserved_qty_for_production called from Stock Entry for production, after submit, cancel - ''' + """ # calculate consumed qty based on submitted stock entries self.update_consumed_qty_for_required_items() - if self.docstatus==1: + if self.docstatus == 1: # calculate transferred qty based on submitted stock entries self.update_transferred_qty_for_required_items() @@ -642,7 +864,7 @@ class WorkOrder(Document): self.update_reserved_qty_for_production() def update_reserved_qty_for_production(self, items=None): - '''update reserved_qty_for_production in bins''' + """update reserved_qty_for_production in bins""" for d in self.required_items: if d.source_warehouse: stock_bin = get_bin(d.item_code, d.source_warehouse) @@ -664,17 +886,18 @@ class WorkOrder(Document): d.available_qty_at_wip_warehouse = get_latest_stock_qty(d.item_code, self.wip_warehouse) def set_required_items(self, reset_only_qty=False): - '''set required_items for production to keep track of reserved qty''' + """set required_items for production to keep track of reserved qty""" if not reset_only_qty: self.required_items = [] operation = None - if self.get('operations') and len(self.operations) == 1: + if self.get("operations") and len(self.operations) == 1: operation = self.operations[0].operation if self.bom_no and self.qty: - item_dict = get_bom_items_as_dict(self.bom_no, self.company, qty=self.qty, - fetch_exploded = self.use_multi_level_bom) + item_dict = get_bom_items_as_dict( + self.bom_no, self.company, qty=self.qty, fetch_exploded=self.use_multi_level_bom + ) if reset_only_qty: for d in self.get("required_items"): @@ -684,19 +907,22 @@ class WorkOrder(Document): if not d.operation: d.operation = operation else: - for item in sorted(item_dict.values(), key=lambda d: d['idx'] or float('inf')): - self.append('required_items', { - 'rate': item.rate, - 'amount': item.rate * item.qty, - 'operation': item.operation or operation, - 'item_code': item.item_code, - 'item_name': item.item_name, - 'description': item.description, - 'allow_alternative_item': item.allow_alternative_item, - 'required_qty': item.qty, - 'source_warehouse': item.source_warehouse or item.default_warehouse, - 'include_item_in_manufacturing': item.include_item_in_manufacturing - }) + for item in sorted(item_dict.values(), key=lambda d: d["idx"] or float("inf")): + self.append( + "required_items", + { + "rate": item.rate, + "amount": item.rate * item.qty, + "operation": item.operation or operation, + "item_code": item.item_code, + "item_name": item.item_name, + "description": item.description, + "allow_alternative_item": item.allow_alternative_item, + "required_qty": item.qty, + "source_warehouse": item.source_warehouse or item.default_warehouse, + "include_item_in_manufacturing": item.include_item_in_manufacturing, + }, + ) if not self.project: self.project = item.get("project") @@ -704,32 +930,33 @@ class WorkOrder(Document): self.set_available_qty() def update_transferred_qty_for_required_items(self): - '''update transferred qty from submitted stock entries for that item against - the work order''' + """update transferred qty from submitted stock entries for that item against + the work order""" for d in self.required_items: - transferred_qty = frappe.db.sql('''select sum(qty) + transferred_qty = frappe.db.sql( + """select sum(qty) from `tabStock Entry` entry, `tabStock Entry Detail` detail where entry.work_order = %(name)s and entry.purpose = "Material Transfer for Manufacture" and entry.docstatus = 1 and detail.parent = entry.name - and (detail.item_code = %(item)s or detail.original_item = %(item)s)''', { - 'name': self.name, - 'item': d.item_code - })[0][0] + and (detail.item_code = %(item)s or detail.original_item = %(item)s)""", + {"name": self.name, "item": d.item_code}, + )[0][0] - d.db_set('transferred_qty', flt(transferred_qty), update_modified = False) + d.db_set("transferred_qty", flt(transferred_qty), update_modified=False) def update_consumed_qty_for_required_items(self): - ''' - Update consumed qty from submitted stock entries - against a work order for each stock item - ''' + """ + Update consumed qty from submitted stock entries + against a work order for each stock item + """ for item in self.required_items: - consumed_qty = frappe.db.sql(''' + consumed_qty = frappe.db.sql( + """ SELECT SUM(qty) FROM @@ -744,85 +971,97 @@ class WorkOrder(Document): AND detail.s_warehouse IS NOT null AND (detail.item_code = %(item)s OR detail.original_item = %(item)s) - ''', { - 'name': self.name, - 'item': item.item_code - })[0][0] + """, + {"name": self.name, "item": item.item_code}, + )[0][0] - item.db_set('consumed_qty', flt(consumed_qty), update_modified=False) + item.db_set("consumed_qty", flt(consumed_qty), update_modified=False) @frappe.whitelist() def make_bom(self): - data = frappe.db.sql(""" select sed.item_code, sed.qty, sed.s_warehouse + data = frappe.db.sql( + """ select sed.item_code, sed.qty, sed.s_warehouse from `tabStock Entry Detail` sed, `tabStock Entry` se where se.name = sed.parent and se.purpose = 'Manufacture' and (sed.t_warehouse is null or sed.t_warehouse = '') and se.docstatus = 1 - and se.work_order = %s""", (self.name), as_dict=1) + and se.work_order = %s""", + (self.name), + as_dict=1, + ) bom = frappe.new_doc("BOM") bom.item = self.production_item bom.conversion_rate = 1 for d in data: - bom.append('items', { - 'item_code': d.item_code, - 'qty': d.qty, - 'source_warehouse': d.s_warehouse - }) + bom.append("items", {"item_code": d.item_code, "qty": d.qty, "source_warehouse": d.s_warehouse}) if self.operations: - bom.set('operations', self.operations) + bom.set("operations", self.operations) bom.with_operations = 1 bom.set_bom_material_details() return bom def update_batch_produced_qty(self, stock_entry_doc): - if not cint(frappe.db.get_single_value("Manufacturing Settings", "make_serial_no_batch_from_work_order")): + if not cint( + frappe.db.get_single_value("Manufacturing Settings", "make_serial_no_batch_from_work_order") + ): return for row in stock_entry_doc.items: if row.batch_no and (row.is_finished_item or row.is_scrap_item): - qty = frappe.get_all("Stock Entry Detail", filters = {"batch_no": row.batch_no, "docstatus": 1}, - or_filters= {"is_finished_item": 1, "is_scrap_item": 1}, fields = ["sum(qty)"], as_list=1)[0][0] + qty = frappe.get_all( + "Stock Entry Detail", + filters={"batch_no": row.batch_no, "docstatus": 1}, + or_filters={"is_finished_item": 1, "is_scrap_item": 1}, + fields=["sum(qty)"], + as_list=1, + )[0][0] frappe.db.set_value("Batch", row.batch_no, "produced_qty", flt(qty)) + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_bom_operations(doctype, txt, searchfield, start, page_len, filters): if txt: - filters['operation'] = ('like', '%%%s%%' % txt) + filters["operation"] = ("like", "%%%s%%" % txt) + + return frappe.get_all("BOM Operation", filters=filters, fields=["operation"], as_list=1) - return frappe.get_all('BOM Operation', - filters = filters, fields = ['operation'], as_list=1) @frappe.whitelist() -def get_item_details(item, project = None, skip_bom_info=False): - res = frappe.db.sql(""" +def get_item_details(item, project=None, skip_bom_info=False): + res = frappe.db.sql( + """ select stock_uom, description, item_name, allow_alternative_item, include_item_in_manufacturing from `tabItem` where disabled=0 and (end_of_life is null or end_of_life='0000-00-00' or end_of_life > %s) and name=%s - """, (nowdate(), item), as_dict=1) + """, + (nowdate(), item), + as_dict=1, + ) if not res: return {} res = res[0] - if skip_bom_info: return res + if skip_bom_info: + return res - filters = {"item": item, "is_default": 1} + filters = {"item": item, "is_default": 1, "docstatus": 1} if project: filters = {"item": item, "project": project} - res["bom_no"] = frappe.db.get_value("BOM", filters = filters) + res["bom_no"] = frappe.db.get_value("BOM", filters=filters) if not res["bom_no"]: - variant_of= frappe.db.get_value("Item", item, "variant_of") + variant_of = frappe.db.get_value("Item", item, "variant_of") if variant_of: res["bom_no"] = frappe.db.get_value("BOM", filters={"item": variant_of, "is_default": 1}) @@ -830,19 +1069,26 @@ def get_item_details(item, project = None, skip_bom_info=False): if not res["bom_no"]: if project: res = get_item_details(item) - frappe.msgprint(_("Default BOM not found for Item {0} and Project {1}").format(item, project), alert=1) + frappe.msgprint( + _("Default BOM not found for Item {0} and Project {1}").format(item, project), alert=1 + ) else: frappe.throw(_("Default BOM for {0} not found").format(item)) - bom_data = frappe.db.get_value('BOM', res['bom_no'], - ['project', 'allow_alternative_item', 'transfer_material_against', 'item_name'], as_dict=1) + bom_data = frappe.db.get_value( + "BOM", + res["bom_no"], + ["project", "allow_alternative_item", "transfer_material_against", "item_name"], + as_dict=1, + ) - res['project'] = project or bom_data.pop("project") + res["project"] = project or bom_data.pop("project") res.update(bom_data) res.update(check_if_scrap_warehouse_mandatory(res["bom_no"])) return res + @frappe.whitelist() def make_work_order(bom_no, item, qty=0, project=None, variant_items=None): if not frappe.has_permission("Work Order", "write"): @@ -864,43 +1110,51 @@ def make_work_order(bom_no, item, qty=0, project=None, variant_items=None): return wo_doc + def add_variant_item(variant_items, wo_doc, bom_no, table_name="items"): if isinstance(variant_items, str): variant_items = json.loads(variant_items) for item in variant_items: - args = frappe._dict({ - "item_code": item.get("variant_item_code"), - "required_qty": item.get("qty"), - "qty": item.get("qty"), # for bom - "source_warehouse": item.get("source_warehouse"), - "operation": item.get("operation") - }) + args = frappe._dict( + { + "item_code": item.get("variant_item_code"), + "required_qty": item.get("qty"), + "qty": item.get("qty"), # for bom + "source_warehouse": item.get("source_warehouse"), + "operation": item.get("operation"), + } + ) bom_doc = frappe.get_cached_doc("BOM", bom_no) item_data = get_item_details(args.item_code, skip_bom_info=True) args.update(item_data) - args["rate"] = get_bom_item_rate({ - "company": wo_doc.company, - "item_code": args.get("item_code"), - "qty": args.get("required_qty"), - "uom": args.get("stock_uom"), - "stock_uom": args.get("stock_uom"), - "conversion_factor": 1 - }, bom_doc) + args["rate"] = get_bom_item_rate( + { + "company": wo_doc.company, + "item_code": args.get("item_code"), + "qty": args.get("required_qty"), + "uom": args.get("stock_uom"), + "stock_uom": args.get("stock_uom"), + "conversion_factor": 1, + }, + bom_doc, + ) if not args.source_warehouse: - args["source_warehouse"] = get_item_defaults(item.get("variant_item_code"), - wo_doc.company).default_warehouse + args["source_warehouse"] = get_item_defaults( + item.get("variant_item_code"), wo_doc.company + ).default_warehouse args["amount"] = flt(args.get("required_qty")) * flt(args.get("rate")) args["uom"] = item_data.stock_uom wo_doc.append(table_name, args) + @frappe.whitelist() def check_if_scrap_warehouse_mandatory(bom_no): - res = {"set_scrap_wh_mandatory": False } + res = {"set_scrap_wh_mandatory": False} if bom_no: bom = frappe.get_doc("BOM", bom_no) @@ -909,12 +1163,14 @@ def check_if_scrap_warehouse_mandatory(bom_no): return res + @frappe.whitelist() def set_work_order_ops(name): - po = frappe.get_doc('Work Order', name) + po = frappe.get_doc("Work Order", name) po.set_work_order_operations() po.save() + @frappe.whitelist() def make_stock_entry(work_order_id, purpose, qty=None): work_order = frappe.get_doc("Work Order", work_order_id) @@ -930,12 +1186,17 @@ def make_stock_entry(work_order_id, purpose, qty=None): stock_entry.from_bom = 1 stock_entry.bom_no = work_order.bom_no stock_entry.use_multi_level_bom = work_order.use_multi_level_bom - stock_entry.fg_completed_qty = qty or (flt(work_order.qty) - flt(work_order.produced_qty)) - if work_order.bom_no: - stock_entry.inspection_required = frappe.db.get_value('BOM', - work_order.bom_no, 'inspection_required') + # accept 0 qty as well + stock_entry.fg_completed_qty = ( + qty if qty is not None else (flt(work_order.qty) - flt(work_order.produced_qty)) + ) - if purpose=="Material Transfer for Manufacture": + if work_order.bom_no: + stock_entry.inspection_required = frappe.db.get_value( + "BOM", work_order.bom_no, "inspection_required" + ) + + if purpose == "Material Transfer for Manufacture": stock_entry.to_warehouse = wip_warehouse stock_entry.project = work_order.project else: @@ -948,6 +1209,7 @@ def make_stock_entry(work_order_id, purpose, qty=None): stock_entry.set_serial_no_batch_for_finished_good() return stock_entry.as_dict() + @frappe.whitelist() def get_default_warehouse(): doc = frappe.get_cached_doc("Manufacturing Settings") @@ -955,12 +1217,13 @@ def get_default_warehouse(): return { "wip_warehouse": doc.default_wip_warehouse, "fg_warehouse": doc.default_fg_warehouse, - "scrap_warehouse": doc.default_scrap_warehouse + "scrap_warehouse": doc.default_scrap_warehouse, } + @frappe.whitelist() def stop_unstop(work_order, status): - """ Called from client side on Stop/Unstop event""" + """Called from client side on Stop/Unstop event""" if not frappe.has_permission("Work Order", "write"): frappe.throw(_("Not permitted"), frappe.PermissionError) @@ -977,24 +1240,29 @@ def stop_unstop(work_order, status): return pro_order.status + @frappe.whitelist() def query_sales_order(production_item): - out = frappe.db.sql_list(""" + out = frappe.db.sql_list( + """ select distinct so.name from `tabSales Order` so, `tabSales Order Item` so_item where so_item.parent=so.name and so_item.item_code=%s and so.docstatus=1 union select distinct so.name from `tabSales Order` so, `tabPacked Item` pi_item where pi_item.parent=so.name and pi_item.item_code=%s and so.docstatus=1 - """, (production_item, production_item)) + """, + (production_item, production_item), + ) return out + @frappe.whitelist() def make_job_card(work_order, operations): if isinstance(operations, str): operations = json.loads(operations) - work_order = frappe.get_doc('Work Order', work_order) + work_order = frappe.get_doc("Work Order", work_order) for row in operations: row = frappe._dict(row) validate_operation_data(row) @@ -1004,6 +1272,7 @@ def make_job_card(work_order, operations): if row.job_card_qty > 0: create_job_card(work_order, row, auto_create=True) + @frappe.whitelist() def close_work_order(work_order, status): if not frappe.has_permission("Work Order", "write"): @@ -1011,15 +1280,17 @@ def close_work_order(work_order, status): work_order = frappe.get_doc("Work Order", work_order) if work_order.get("operations"): - job_cards = frappe.get_list("Job Card", - filters={ - "work_order": work_order.name, - "status": "Work In Progress" - }, pluck='name') + job_cards = frappe.get_list( + "Job Card", filters={"work_order": work_order.name, "status": "Work In Progress"}, pluck="name" + ) if job_cards: job_cards = ", ".join(job_cards) - frappe.throw(_("Can not close Work Order. Since {0} Job Cards are in Work In Progress state.").format(job_cards)) + frappe.throw( + _("Can not close Work Order. Since {0} Job Cards are in Work In Progress state.").format( + job_cards + ) + ) work_order.update_status(status) work_order.update_planned_qty() @@ -1027,9 +1298,11 @@ def close_work_order(work_order, status): work_order.notify_update() return work_order.status + def split_qty_based_on_batch_size(wo_doc, row, qty): - if not cint(frappe.db.get_value("Operation", - row.operation, "create_job_card_based_on_batch_size")): + if not cint( + frappe.db.get_value("Operation", row.operation, "create_job_card_based_on_batch_size") + ): row.batch_size = row.get("qty") or wo_doc.qty row.job_card_qty = row.batch_size @@ -1043,55 +1316,63 @@ def split_qty_based_on_batch_size(wo_doc, row, qty): return qty + def get_serial_nos_for_job_card(row, wo_doc): if not wo_doc.serial_no: return serial_nos = get_serial_nos(wo_doc.serial_no) used_serial_nos = [] - for d in frappe.get_all('Job Card', fields=['serial_no'], - filters={'docstatus': ('<', 2), 'work_order': wo_doc.name, 'operation_id': row.name}): + for d in frappe.get_all( + "Job Card", + fields=["serial_no"], + filters={"docstatus": ("<", 2), "work_order": wo_doc.name, "operation_id": row.name}, + ): used_serial_nos.extend(get_serial_nos(d.serial_no)) serial_nos = sorted(list(set(serial_nos) - set(used_serial_nos))) - row.serial_no = '\n'.join(serial_nos[0:row.job_card_qty]) + row.serial_no = "\n".join(serial_nos[0 : cint(row.job_card_qty)]) + def validate_operation_data(row): if row.get("qty") <= 0: - frappe.throw(_("Quantity to Manufacture can not be zero for the operation {0}") - .format( + frappe.throw( + _("Quantity to Manufacture can not be zero for the operation {0}").format( frappe.bold(row.get("operation")) ) ) if row.get("qty") > row.get("pending_qty"): - frappe.throw(_("For operation {0}: Quantity ({1}) can not be greter than pending quantity({2})") - .format( + frappe.throw( + _("For operation {0}: Quantity ({1}) can not be greter than pending quantity({2})").format( frappe.bold(row.get("operation")), frappe.bold(row.get("qty")), - frappe.bold(row.get("pending_qty")) + frappe.bold(row.get("pending_qty")), ) ) + def create_job_card(work_order, row, enable_capacity_planning=False, auto_create=False): doc = frappe.new_doc("Job Card") - doc.update({ - 'work_order': work_order.name, - 'operation': row.get("operation"), - 'workstation': row.get("workstation"), - 'posting_date': nowdate(), - 'for_quantity': row.job_card_qty or work_order.get('qty', 0), - 'operation_id': row.get("name"), - 'bom_no': work_order.bom_no, - 'project': work_order.project, - 'company': work_order.company, - 'sequence_id': row.get("sequence_id"), - 'wip_warehouse': work_order.wip_warehouse, - 'hour_rate': row.get("hour_rate"), - 'serial_no': row.get("serial_no") - }) + doc.update( + { + "work_order": work_order.name, + "operation": row.get("operation"), + "workstation": row.get("workstation"), + "posting_date": nowdate(), + "for_quantity": row.job_card_qty or work_order.get("qty", 0), + "operation_id": row.get("name"), + "bom_no": work_order.bom_no, + "project": work_order.project, + "company": work_order.company, + "sequence_id": row.get("sequence_id"), + "wip_warehouse": work_order.wip_warehouse, + "hour_rate": row.get("hour_rate"), + "serial_no": row.get("serial_no"), + } + ) - if work_order.transfer_material_against == 'Job Card' and not work_order.skip_transfer: + if work_order.transfer_material_against == "Job Card" and not work_order.skip_transfer: doc.get_required_items() if auto_create: @@ -1100,19 +1381,28 @@ def create_job_card(work_order, row, enable_capacity_planning=False, auto_create doc.schedule_time_logs(row) doc.insert() - frappe.msgprint(_("Job card {0} created").format(get_link_to_form("Job Card", doc.name)), alert=True) + frappe.msgprint( + _("Job card {0} created").format(get_link_to_form("Job Card", doc.name)), alert=True + ) + + if enable_capacity_planning: + # automatically added scheduling rows shouldn't change status to WIP + doc.db_set("status", "Open") return doc + def get_work_order_operation_data(work_order, operation, workstation): for d in work_order.operations: if d.operation == operation and d.workstation == workstation: return d + @frappe.whitelist() def create_pick_list(source_name, target_doc=None, for_qty=None): - for_qty = for_qty or json.loads(target_doc).get('for_qty') - max_finished_goods_qty = frappe.db.get_value('Work Order', source_name, 'qty') + for_qty = for_qty or json.loads(target_doc).get("for_qty") + max_finished_goods_qty = frappe.db.get_value("Work Order", source_name, "qty") + def update_item_quantity(source, target, source_parent): pending_to_issue = flt(source.required_qty) - flt(source.transferred_qty) desire_to_transfer = flt(source.required_qty) / max_finished_goods_qty * flt(for_qty) @@ -1126,28 +1416,57 @@ def create_pick_list(source_name, target_doc=None, for_qty=None): if qty: target.qty = qty target.stock_qty = qty - target.uom = frappe.get_value('Item', source.item_code, 'stock_uom') + target.uom = frappe.get_value("Item", source.item_code, "stock_uom") target.stock_uom = target.uom target.conversion_factor = 1 else: target.delete() - doc = get_mapped_doc('Work Order', source_name, { - 'Work Order': { - 'doctype': 'Pick List', - 'validation': { - 'docstatus': ['=', 1] - } + doc = get_mapped_doc( + "Work Order", + source_name, + { + "Work Order": {"doctype": "Pick List", "validation": {"docstatus": ["=", 1]}}, + "Work Order Item": { + "doctype": "Pick List Item", + "postprocess": update_item_quantity, + "condition": lambda doc: abs(doc.transferred_qty) < abs(doc.required_qty), + }, }, - 'Work Order Item': { - 'doctype': 'Pick List Item', - 'postprocess': update_item_quantity, - 'condition': lambda doc: abs(doc.transferred_qty) < abs(doc.required_qty) - }, - }, target_doc) + target_doc, + ) doc.for_qty = for_qty doc.set_item_locations() return doc + + +def get_reserved_qty_for_production(item_code: str, warehouse: str) -> float: + """Get total reserved quantity for any item in specified warehouse""" + wo = frappe.qb.DocType("Work Order") + wo_item = frappe.qb.DocType("Work Order Item") + + return ( + frappe.qb.from_(wo) + .from_(wo_item) + .select( + Sum( + Case() + .when(wo.skip_transfer == 0, wo_item.required_qty - wo_item.transferred_qty) + .else_(wo_item.required_qty - wo_item.consumed_qty) + ) + ) + .where( + (wo_item.item_code == item_code) + & (wo_item.parent == wo.name) + & (wo.docstatus == 1) + & (wo_item.source_warehouse == warehouse) + & (wo.status.notin(["Stopped", "Completed", "Closed"])) + & ( + (wo_item.required_qty > wo_item.transferred_qty) + | (wo_item.required_qty > wo_item.consumed_qty) + ) + ) + ).run()[0][0] or 0.0 diff --git a/erpnext/manufacturing/doctype/work_order/work_order_dashboard.py b/erpnext/manufacturing/doctype/work_order/work_order_dashboard.py index 91279d8e616..465460f95d8 100644 --- a/erpnext/manufacturing/doctype/work_order/work_order_dashboard.py +++ b/erpnext/manufacturing/doctype/work_order/work_order_dashboard.py @@ -1,21 +1,12 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'work_order', - 'non_standard_fieldnames': { - 'Batch': 'reference_name' - }, - 'transactions': [ - { - 'label': _('Transactions'), - 'items': ['Stock Entry', 'Job Card', 'Pick List'] - }, - { - 'label': _('Reference'), - 'items': ['Serial No', 'Batch'] - } - ] + "fieldname": "work_order", + "non_standard_fieldnames": {"Batch": "reference_name"}, + "transactions": [ + {"label": _("Transactions"), "items": ["Stock Entry", "Job Card", "Pick List"]}, + {"label": _("Reference"), "items": ["Serial No", "Batch"]}, + ], } diff --git a/erpnext/manufacturing/doctype/work_order_item/work_order_item.py b/erpnext/manufacturing/doctype/work_order_item/work_order_item.py index 4311d3bf17f..179274707e3 100644 --- a/erpnext/manufacturing/doctype/work_order_item/work_order_item.py +++ b/erpnext/manufacturing/doctype/work_order_item/work_order_item.py @@ -9,5 +9,6 @@ from frappe.model.document import Document class WorkOrderItem(Document): pass + def on_doctype_update(): frappe.db.add_index("Work Order Item", ["item_code", "source_warehouse"]) diff --git a/erpnext/manufacturing/doctype/workstation/test_workstation.py b/erpnext/manufacturing/doctype/workstation/test_workstation.py index 5ed51535282..6db985c8c2e 100644 --- a/erpnext/manufacturing/doctype/workstation/test_workstation.py +++ b/erpnext/manufacturing/doctype/workstation/test_workstation.py @@ -1,10 +1,8 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors and Contributors # See license.txt - -import unittest - import frappe from frappe.test_runner import make_test_records +from frappe.tests.utils import FrappeTestCase from erpnext.manufacturing.doctype.operation.test_operation import make_operation from erpnext.manufacturing.doctype.routing.test_routing import create_routing, setup_bom @@ -15,19 +13,42 @@ from erpnext.manufacturing.doctype.workstation.workstation import ( ) test_dependencies = ["Warehouse"] -test_records = frappe.get_test_records('Workstation') -make_test_records('Workstation') +test_records = frappe.get_test_records("Workstation") +make_test_records("Workstation") -class TestWorkstation(unittest.TestCase): + +class TestWorkstation(FrappeTestCase): def test_validate_timings(self): - check_if_within_operating_hours("_Test Workstation 1", "Operation 1", "2013-02-02 11:00:00", "2013-02-02 19:00:00") - check_if_within_operating_hours("_Test Workstation 1", "Operation 1", "2013-02-02 10:00:00", "2013-02-02 20:00:00") - self.assertRaises(NotInWorkingHoursError, check_if_within_operating_hours, - "_Test Workstation 1", "Operation 1", "2013-02-02 05:00:00", "2013-02-02 20:00:00") - self.assertRaises(NotInWorkingHoursError, check_if_within_operating_hours, - "_Test Workstation 1", "Operation 1", "2013-02-02 05:00:00", "2013-02-02 20:00:00") - self.assertRaises(WorkstationHolidayError, check_if_within_operating_hours, - "_Test Workstation 1", "Operation 1", "2013-02-01 10:00:00", "2013-02-02 20:00:00") + check_if_within_operating_hours( + "_Test Workstation 1", "Operation 1", "2013-02-02 11:00:00", "2013-02-02 19:00:00" + ) + check_if_within_operating_hours( + "_Test Workstation 1", "Operation 1", "2013-02-02 10:00:00", "2013-02-02 20:00:00" + ) + self.assertRaises( + NotInWorkingHoursError, + check_if_within_operating_hours, + "_Test Workstation 1", + "Operation 1", + "2013-02-02 05:00:00", + "2013-02-02 20:00:00", + ) + self.assertRaises( + NotInWorkingHoursError, + check_if_within_operating_hours, + "_Test Workstation 1", + "Operation 1", + "2013-02-02 05:00:00", + "2013-02-02 20:00:00", + ) + self.assertRaises( + WorkstationHolidayError, + check_if_within_operating_hours, + "_Test Workstation 1", + "Operation 1", + "2013-02-01 10:00:00", + "2013-02-02 20:00:00", + ) def test_update_bom_operation_rate(self): operations = [ @@ -35,14 +56,14 @@ class TestWorkstation(unittest.TestCase): "operation": "Test Operation A", "workstation": "_Test Workstation A", "hour_rate_rent": 300, - "time_in_mins": 60 + "time_in_mins": 60, }, { "operation": "Test Operation B", "workstation": "_Test Workstation B", "hour_rate_rent": 1000, - "time_in_mins": 60 - } + "time_in_mins": 60, + }, ] for row in operations: @@ -50,21 +71,13 @@ class TestWorkstation(unittest.TestCase): make_operation(row) test_routing_operations = [ - { - "operation": "Test Operation A", - "workstation": "_Test Workstation A", - "time_in_mins": 60 - }, - { - "operation": "Test Operation B", - "workstation": "_Test Workstation A", - "time_in_mins": 60 - } + {"operation": "Test Operation A", "workstation": "_Test Workstation A", "time_in_mins": 60}, + {"operation": "Test Operation B", "workstation": "_Test Workstation A", "time_in_mins": 60}, ] - routing_doc = create_routing(routing_name = "Routing Test", operations=test_routing_operations) + routing_doc = create_routing(routing_name="Routing Test", operations=test_routing_operations) bom_doc = setup_bom(item_code="_Testing Item", routing=routing_doc.name, currency="INR") w1 = frappe.get_doc("Workstation", "_Test Workstation A") - #resets values + # resets values w1.hour_rate_rent = 300 w1.hour_rate_labour = 0 w1.save() @@ -74,13 +87,14 @@ class TestWorkstation(unittest.TestCase): self.assertEqual(bom_doc.operations[0].hour_rate, 300) w1.hour_rate_rent = 250 w1.save() - #updating after setting new rates in workstations + # updating after setting new rates in workstations bom_doc.update_cost() bom_doc.reload() self.assertEqual(w1.hour_rate, 250) self.assertEqual(bom_doc.operations[0].hour_rate, 250) self.assertEqual(bom_doc.operations[1].hour_rate, 250) + def make_workstation(*args, **kwargs): args = args if args else kwargs if isinstance(args, tuple): @@ -90,10 +104,7 @@ def make_workstation(*args, **kwargs): workstation_name = args.workstation_name or args.workstation if not frappe.db.exists("Workstation", workstation_name): - doc = frappe.get_doc({ - "doctype": "Workstation", - "workstation_name": workstation_name - }) + doc = frappe.get_doc({"doctype": "Workstation", "workstation_name": workstation_name}) doc.hour_rate_rent = args.get("hour_rate_rent") doc.hour_rate_labour = args.get("hour_rate_labour") doc.insert() diff --git a/erpnext/manufacturing/doctype/workstation/workstation.py b/erpnext/manufacturing/doctype/workstation/workstation.py index 4cfd410ac72..59e5318ab8d 100644 --- a/erpnext/manufacturing/doctype/workstation/workstation.py +++ b/erpnext/manufacturing/doctype/workstation/workstation.py @@ -19,14 +19,26 @@ from frappe.utils import ( from erpnext.support.doctype.issue.issue import get_holidays -class WorkstationHolidayError(frappe.ValidationError): pass -class NotInWorkingHoursError(frappe.ValidationError): pass -class OverlapError(frappe.ValidationError): pass +class WorkstationHolidayError(frappe.ValidationError): + pass + + +class NotInWorkingHoursError(frappe.ValidationError): + pass + + +class OverlapError(frappe.ValidationError): + pass + class Workstation(Document): def validate(self): - self.hour_rate = (flt(self.hour_rate_labour) + flt(self.hour_rate_electricity) + - flt(self.hour_rate_consumable) + flt(self.hour_rate_rent)) + self.hour_rate = ( + flt(self.hour_rate_labour) + + flt(self.hour_rate_electricity) + + flt(self.hour_rate_consumable) + + flt(self.hour_rate_rent) + ) def on_update(self): self.validate_overlap_for_operation_timings() @@ -35,29 +47,41 @@ class Workstation(Document): def validate_overlap_for_operation_timings(self): """Check if there is no overlap in setting Workstation Operating Hours""" for d in self.get("working_hours"): - existing = frappe.db.sql_list("""select idx from `tabWorkstation Working Hour` + existing = frappe.db.sql_list( + """select idx from `tabWorkstation Working Hour` where parent = %s and name != %s and ( (start_time between %s and %s) or (end_time between %s and %s) or (%s between start_time and end_time)) - """, (self.name, d.name, d.start_time, d.end_time, d.start_time, d.end_time, d.start_time)) + """, + (self.name, d.name, d.start_time, d.end_time, d.start_time, d.end_time, d.start_time), + ) if existing: - frappe.throw(_("Row #{0}: Timings conflicts with row {1}").format(d.idx, comma_and(existing)), OverlapError) + frappe.throw( + _("Row #{0}: Timings conflicts with row {1}").format(d.idx, comma_and(existing)), OverlapError + ) def update_bom_operation(self): - bom_list = frappe.db.sql("""select DISTINCT parent from `tabBOM Operation` - where workstation = %s and parenttype = 'routing' """, self.name) + bom_list = frappe.db.sql( + """select DISTINCT parent from `tabBOM Operation` + where workstation = %s and parenttype = 'routing' """, + self.name, + ) for bom_no in bom_list: - frappe.db.sql("""update `tabBOM Operation` set hour_rate = %s + frappe.db.sql( + """update `tabBOM Operation` set hour_rate = %s where parent = %s and workstation = %s""", - (self.hour_rate, bom_no[0], self.name)) + (self.hour_rate, bom_no[0], self.name), + ) def validate_workstation_holiday(self, schedule_date, skip_holiday_list_check=False): - if not skip_holiday_list_check and (not self.holiday_list or - cint(frappe.db.get_single_value("Manufacturing Settings", "allow_production_on_holidays"))): + if not skip_holiday_list_check and ( + not self.holiday_list + or cint(frappe.db.get_single_value("Manufacturing Settings", "allow_production_on_holidays")) + ): return schedule_date if schedule_date in tuple(get_holidays(self.holiday_list)): @@ -66,18 +90,25 @@ class Workstation(Document): return schedule_date + @frappe.whitelist() def get_default_holiday_list(): - return frappe.get_cached_value('Company', frappe.defaults.get_user_default("Company"), "default_holiday_list") + return frappe.get_cached_value( + "Company", frappe.defaults.get_user_default("Company"), "default_holiday_list" + ) + def check_if_within_operating_hours(workstation, operation, from_datetime, to_datetime): if from_datetime and to_datetime: - if not cint(frappe.db.get_value("Manufacturing Settings", "None", "allow_production_on_holidays")): + if not cint( + frappe.db.get_value("Manufacturing Settings", "None", "allow_production_on_holidays") + ): check_workstation_for_holiday(workstation, from_datetime, to_datetime) if not cint(frappe.db.get_value("Manufacturing Settings", None, "allow_overtime")): is_within_operating_hours(workstation, operation, from_datetime, to_datetime) + def is_within_operating_hours(workstation, operation, from_datetime, to_datetime): operation_length = time_diff_in_seconds(to_datetime, from_datetime) workstation = frappe.get_doc("Workstation", workstation) @@ -87,21 +118,35 @@ def is_within_operating_hours(workstation, operation, from_datetime, to_datetime for working_hour in workstation.working_hours: if working_hour.start_time and working_hour.end_time: - slot_length = (to_timedelta(working_hour.end_time or "") - to_timedelta(working_hour.start_time or "")).total_seconds() + slot_length = ( + to_timedelta(working_hour.end_time or "") - to_timedelta(working_hour.start_time or "") + ).total_seconds() if slot_length >= operation_length: return - frappe.throw(_("Operation {0} longer than any available working hours in workstation {1}, break down the operation into multiple operations").format(operation, workstation.name), NotInWorkingHoursError) + frappe.throw( + _( + "Operation {0} longer than any available working hours in workstation {1}, break down the operation into multiple operations" + ).format(operation, workstation.name), + NotInWorkingHoursError, + ) + def check_workstation_for_holiday(workstation, from_datetime, to_datetime): holiday_list = frappe.db.get_value("Workstation", workstation, "holiday_list") if holiday_list and from_datetime and to_datetime: applicable_holidays = [] - for d in frappe.db.sql("""select holiday_date from `tabHoliday` where parent = %s + for d in frappe.db.sql( + """select holiday_date from `tabHoliday` where parent = %s and holiday_date between %s and %s """, - (holiday_list, getdate(from_datetime), getdate(to_datetime))): - applicable_holidays.append(formatdate(d[0])) + (holiday_list, getdate(from_datetime), getdate(to_datetime)), + ): + applicable_holidays.append(formatdate(d[0])) if applicable_holidays: - frappe.throw(_("Workstation is closed on the following dates as per Holiday List: {0}") - .format(holiday_list) + "\n" + "\n".join(applicable_holidays), WorkstationHolidayError) + frappe.throw( + _("Workstation is closed on the following dates as per Holiday List: {0}").format(holiday_list) + + "\n" + + "\n".join(applicable_holidays), + WorkstationHolidayError, + ) diff --git a/erpnext/manufacturing/doctype/workstation/workstation_dashboard.py b/erpnext/manufacturing/doctype/workstation/workstation_dashboard.py index c779fbf9c3b..6d022216bd0 100644 --- a/erpnext/manufacturing/doctype/workstation/workstation_dashboard.py +++ b/erpnext/manufacturing/doctype/workstation/workstation_dashboard.py @@ -1,20 +1,24 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'workstation', - 'transactions': [ + "fieldname": "workstation", + "transactions": [ + {"label": _("Master"), "items": ["BOM", "Routing", "Operation"]}, { - 'label': _('Master'), - 'items': ['BOM', 'Routing', 'Operation'] + "label": _("Transaction"), + "items": [ + "Work Order", + "Job Card", + ], }, - { - 'label': _('Transaction'), - 'items': ['Work Order', 'Job Card', 'Timesheet'] - } ], - 'disable_create_buttons': ['BOM', 'Routing', 'Operation', - 'Work Order', 'Job Card', 'Timesheet'] + "disable_create_buttons": [ + "BOM", + "Routing", + "Operation", + "Work Order", + "Job Card", + ], } diff --git a/erpnext/manufacturing/notification/material_request_receipt_notification/material_request_receipt_notification.py b/erpnext/manufacturing/notification/material_request_receipt_notification/material_request_receipt_notification.py index 19b550feea7..02e3e933330 100644 --- a/erpnext/manufacturing/notification/material_request_receipt_notification/material_request_receipt_notification.py +++ b/erpnext/manufacturing/notification/material_request_receipt_notification/material_request_receipt_notification.py @@ -1,5 +1,3 @@ - - def get_context(context): # do your magic here pass diff --git a/erpnext/manufacturing/report/bom_explorer/bom_explorer.py b/erpnext/manufacturing/report/bom_explorer/bom_explorer.py index 25de2e03797..c0affd9cada 100644 --- a/erpnext/manufacturing/report/bom_explorer/bom_explorer.py +++ b/erpnext/manufacturing/report/bom_explorer/bom_explorer.py @@ -11,31 +11,37 @@ def execute(filters=None): get_data(filters, data) return columns, data + def get_data(filters, data): get_exploded_items(filters.bom, data) + def get_exploded_items(bom, data, indent=0, qty=1): - exploded_items = frappe.get_all("BOM Item", + exploded_items = frappe.get_all( + "BOM Item", filters={"parent": bom}, - fields= ['qty','bom_no','qty','scrap','item_code','item_name','description','uom']) + fields=["qty", "bom_no", "qty", "scrap", "item_code", "item_name", "description", "uom"], + ) for item in exploded_items: print(item.bom_no, indent) item["indent"] = indent - data.append({ - 'item_code': item.item_code, - 'item_name': item.item_name, - 'indent': indent, - 'bom_level': (frappe.get_cached_value("BOM", item.bom_no, "bom_level") - if item.bom_no else ""), - 'bom': item.bom_no, - 'qty': item.qty * qty, - 'uom': item.uom, - 'description': item.description, - 'scrap': item.scrap - }) + data.append( + { + "item_code": item.item_code, + "item_name": item.item_name, + "indent": indent, + "bom_level": indent, + "bom": item.bom_no, + "qty": item.qty * qty, + "uom": item.uom, + "description": item.description, + "scrap": item.scrap, + } + ) if item.bom_no: - get_exploded_items(item.bom_no, data, indent=indent+1, qty=item.qty) + get_exploded_items(item.bom_no, data, indent=indent + 1, qty=item.qty) + def get_columns(): return [ @@ -44,49 +50,13 @@ def get_columns(): "fieldtype": "Link", "fieldname": "item_code", "width": 300, - "options": "Item" - }, - { - "label": "Item Name", - "fieldtype": "data", - "fieldname": "item_name", - "width": 100 - }, - { - "label": "BOM", - "fieldtype": "Link", - "fieldname": "bom", - "width": 150, - "options": "BOM" - }, - { - "label": "Qty", - "fieldtype": "data", - "fieldname": "qty", - "width": 100 - }, - { - "label": "UOM", - "fieldtype": "data", - "fieldname": "uom", - "width": 100 - }, - { - "label": "BOM Level", - "fieldtype": "Data", - "fieldname": "bom_level", - "width": 100 - }, - { - "label": "Standard Description", - "fieldtype": "data", - "fieldname": "description", - "width": 150 - }, - { - "label": "Scrap", - "fieldtype": "data", - "fieldname": "scrap", - "width": 100 + "options": "Item", }, + {"label": "Item Name", "fieldtype": "data", "fieldname": "item_name", "width": 100}, + {"label": "BOM", "fieldtype": "Link", "fieldname": "bom", "width": 150, "options": "BOM"}, + {"label": "Qty", "fieldtype": "data", "fieldname": "qty", "width": 100}, + {"label": "UOM", "fieldtype": "data", "fieldname": "uom", "width": 100}, + {"label": "BOM Level", "fieldtype": "Int", "fieldname": "bom_level", "width": 100}, + {"label": "Standard Description", "fieldtype": "data", "fieldname": "description", "width": 150}, + {"label": "Scrap", "fieldtype": "data", "fieldname": "scrap", "width": 100}, ] diff --git a/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.js b/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.js index 7468e34020c..0eb22a22f73 100644 --- a/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.js +++ b/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.js @@ -4,6 +4,39 @@ frappe.query_reports["BOM Operations Time"] = { "filters": [ - + { + "fieldname": "item_code", + "label": __("Item Code"), + "fieldtype": "Link", + "width": "100", + "options": "Item", + "get_query": () =>{ + return { + filters: { "disabled": 0, "is_stock_item": 1 } + } + } + }, + { + "fieldname": "bom_id", + "label": __("BOM ID"), + "fieldtype": "MultiSelectList", + "width": "100", + "options": "BOM", + "get_data": function(txt) { + return frappe.db.get_link_options("BOM", txt); + }, + "get_query": () =>{ + return { + filters: { "docstatus": 1, "is_active": 1, "with_operations": 1 } + } + } + }, + { + "fieldname": "workstation", + "label": __("Workstation"), + "fieldtype": "Link", + "width": "100", + "options": "Workstation" + }, ] }; diff --git a/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.json b/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.json index 665c5b9f79e..8162017ca81 100644 --- a/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.json +++ b/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.json @@ -1,14 +1,16 @@ { - "add_total_row": 0, + "add_total_row": 1, + "columns": [], "creation": "2020-03-03 01:41:20.862521", "disable_prepared_report": 0, "disabled": 0, "docstatus": 0, "doctype": "Report", + "filters": [], "idx": 0, "is_standard": "Yes", "letter_head": "", - "modified": "2020-03-03 01:41:20.862521", + "modified": "2022-01-20 14:21:47.771591", "modified_by": "Administrator", "module": "Manufacturing", "name": "BOM Operations Time", diff --git a/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.py b/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.py index e7a818abd5d..92c69cf3e0a 100644 --- a/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.py +++ b/erpnext/manufacturing/report/bom_operations_time/bom_operations_time.py @@ -11,42 +11,79 @@ def execute(filters=None): columns = get_columns(filters) return columns, data -def get_data(filters): - data = [] - bom_data = [] - for d in frappe.db.sql(""" - SELECT - bom.name, bom.item, bom.item_name, bom.uom, - bomps.operation, bomps.workstation, bomps.time_in_mins - FROM `tabBOM` bom, `tabBOM Operation` bomps - WHERE - bom.docstatus = 1 and bom.is_active = 1 and bom.name = bomps.parent - """, as_dict=1): +def get_data(filters): + bom_wise_data = {} + bom_data, report_data = [], [] + + bom_operation_data = get_filtered_data(filters) + + for d in bom_operation_data: row = get_args() if d.name not in bom_data: + bom_wise_data[d.name] = [] bom_data.append(d.name) row.update(d) else: - row.update({ - "operation": d.operation, - "workstation": d.workstation, - "time_in_mins": d.time_in_mins - }) + row.update( + {"operation": d.operation, "workstation": d.workstation, "time_in_mins": d.time_in_mins} + ) - data.append(row) + # maintain BOM wise data for grouping such as: + # {"BOM A": [{Row1}, {Row2}], "BOM B": ...} + bom_wise_data[d.name].append(row) used_as_subassembly_items = get_bom_count(bom_data) - for d in data: - d.used_as_subassembly_items = used_as_subassembly_items.get(d.name, 0) + for d in bom_wise_data: + for row in bom_wise_data[d]: + row.used_as_subassembly_items = used_as_subassembly_items.get(row.name, 0) + report_data.append(row) + + return report_data + + +def get_filtered_data(filters): + bom = frappe.qb.DocType("BOM") + bom_ops = frappe.qb.DocType("BOM Operation") + + bom_ops_query = ( + frappe.qb.from_(bom) + .join(bom_ops) + .on(bom.name == bom_ops.parent) + .select( + bom.name, + bom.item, + bom.item_name, + bom.uom, + bom_ops.operation, + bom_ops.workstation, + bom_ops.time_in_mins, + ) + .where((bom.docstatus == 1) & (bom.is_active == 1)) + ) + + if filters.get("item_code"): + bom_ops_query = bom_ops_query.where(bom.item == filters.get("item_code")) + + if filters.get("bom_id"): + bom_ops_query = bom_ops_query.where(bom.name.isin(filters.get("bom_id"))) + + if filters.get("workstation"): + bom_ops_query = bom_ops_query.where(bom_ops.workstation == filters.get("workstation")) + + bom_operation_data = bom_ops_query.run(as_dict=True) + + return bom_operation_data - return data def get_bom_count(bom_data): - data = frappe.get_all("BOM Item", + data = frappe.get_all( + "BOM Item", fields=["count(name) as count", "bom_no"], - filters= {"bom_no": ("in", bom_data)}, group_by = "bom_no") + filters={"bom_no": ("in", bom_data)}, + group_by="bom_no", + ) bom_count = {} for d in data: @@ -54,58 +91,42 @@ def get_bom_count(bom_data): return bom_count + def get_args(): - return frappe._dict({ - "name": "", - "item": "", - "item_name": "", - "uom": "" - }) + return frappe._dict({"name": "", "item": "", "item_name": "", "uom": ""}) + def get_columns(filters): - return [{ - "label": _("BOM ID"), - "options": "BOM", - "fieldname": "name", - "fieldtype": "Link", - "width": 140 - }, { - "label": _("BOM Item Code"), - "options": "Item", - "fieldname": "item", - "fieldtype": "Link", - "width": 140 - }, { - "label": _("Item Name"), - "fieldname": "item_name", - "fieldtype": "Data", - "width": 110 - }, { - "label": _("UOM"), - "options": "UOM", - "fieldname": "uom", - "fieldtype": "Link", - "width": 140 - }, { - "label": _("Operation"), - "options": "Operation", - "fieldname": "operation", - "fieldtype": "Link", - "width": 120 - }, { - "label": _("Workstation"), - "options": "Workstation", - "fieldname": "workstation", - "fieldtype": "Link", - "width": 110 - }, { - "label": _("Time (In Mins)"), - "fieldname": "time_in_mins", - "fieldtype": "Int", - "width": 140 - }, { - "label": _("Sub-assembly BOM Count"), - "fieldname": "used_as_subassembly_items", - "fieldtype": "Int", - "width": 180 - }] + return [ + {"label": _("BOM ID"), "options": "BOM", "fieldname": "name", "fieldtype": "Link", "width": 220}, + { + "label": _("Item Code"), + "options": "Item", + "fieldname": "item", + "fieldtype": "Link", + "width": 150, + }, + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 110}, + {"label": _("UOM"), "options": "UOM", "fieldname": "uom", "fieldtype": "Link", "width": 100}, + { + "label": _("Operation"), + "options": "Operation", + "fieldname": "operation", + "fieldtype": "Link", + "width": 140, + }, + { + "label": _("Workstation"), + "options": "Workstation", + "fieldname": "workstation", + "fieldtype": "Link", + "width": 110, + }, + {"label": _("Time (In Mins)"), "fieldname": "time_in_mins", "fieldtype": "Float", "width": 120}, + { + "label": _("Sub-assembly BOM Count"), + "fieldname": "used_as_subassembly_items", + "fieldtype": "Int", + "width": 200, + }, + ] diff --git a/erpnext/manufacturing/report/bom_stock_calculated/bom_stock_calculated.js b/erpnext/manufacturing/report/bom_stock_calculated/bom_stock_calculated.js index 0d5bfcbaf40..a0fd91e866f 100644 --- a/erpnext/manufacturing/report/bom_stock_calculated/bom_stock_calculated.js +++ b/erpnext/manufacturing/report/bom_stock_calculated/bom_stock_calculated.js @@ -11,17 +11,24 @@ frappe.query_reports["BOM Stock Calculated"] = { "options": "BOM", "reqd": 1 }, - { - "fieldname": "qty_to_make", - "label": __("Quantity to Make"), - "fieldtype": "Int", - "default": "1" - }, - - { + { + "fieldname": "warehouse", + "label": __("Warehouse"), + "fieldtype": "Link", + "options": "Warehouse", + }, + { + "fieldname": "qty_to_make", + "label": __("Quantity to Make"), + "fieldtype": "Float", + "default": "1.0", + "reqd": 1 + }, + { "fieldname": "show_exploded_view", "label": __("Show exploded view"), - "fieldtype": "Check" + "fieldtype": "Check", + "default": false, } ] } diff --git a/erpnext/manufacturing/report/bom_stock_calculated/bom_stock_calculated.py b/erpnext/manufacturing/report/bom_stock_calculated/bom_stock_calculated.py index 090a3e74fc8..550445c1f77 100644 --- a/erpnext/manufacturing/report/bom_stock_calculated/bom_stock_calculated.py +++ b/erpnext/manufacturing/report/bom_stock_calculated/bom_stock_calculated.py @@ -4,96 +4,162 @@ import frappe from frappe import _ +from frappe.query_builder.functions import IfNull, Sum from frappe.utils.data import comma_and +from pypika.terms import ExistsCriterion def execute(filters=None): - # if not filters: filters = {} columns = get_columns() - summ_data = [] + data = [] - data = get_bom_stock(filters) + bom_data = get_bom_data(filters) qty_to_make = filters.get("qty_to_make") - manufacture_details = get_manufacturer_records() - for row in data: - reqd_qty = qty_to_make * row.actual_qty - last_pur_price = frappe.db.get_value("Item", row.item_code, "last_purchase_rate") - summ_data.append(get_report_data(last_pur_price, reqd_qty, row, manufacture_details)) - return columns, summ_data + for row in bom_data: + required_qty = qty_to_make * row.qty_per_unit + last_purchase_rate = frappe.db.get_value("Item", row.item_code, "last_purchase_rate") + + data.append(get_report_data(last_purchase_rate, required_qty, row, manufacture_details)) + + return columns, data + + +def get_report_data(last_purchase_rate, required_qty, row, manufacture_details): + qty_per_unit = row.qty_per_unit if row.qty_per_unit > 0 else 0 + difference_qty = row.actual_qty - required_qty + return [ + row.item_code, + row.description, + comma_and(manufacture_details.get(row.item_code, {}).get("manufacturer", []), add_quotes=False), + comma_and( + manufacture_details.get(row.item_code, {}).get("manufacturer_part", []), add_quotes=False + ), + qty_per_unit, + row.actual_qty, + required_qty, + difference_qty, + last_purchase_rate, + ] -def get_report_data(last_pur_price, reqd_qty, row, manufacture_details): - to_build = row.to_build if row.to_build > 0 else 0 - diff_qty = to_build - reqd_qty - return [row.item_code, row.description, - comma_and(manufacture_details.get(row.item_code, {}).get('manufacturer', []), add_quotes=False), - comma_and(manufacture_details.get(row.item_code, {}).get('manufacturer_part', []), add_quotes=False), - row.actual_qty, str(to_build), - reqd_qty, diff_qty, last_pur_price] def get_columns(): - """return columns""" - columns = [ - _("Item") + ":Link/Item:100", - _("Description") + "::150", - _("Manufacturer") + "::250", - _("Manufacturer Part Number") + "::250", - _("Qty") + ":Float:50", - _("Stock Qty") + ":Float:100", - _("Reqd Qty")+ ":Float:100", - _("Diff Qty")+ ":Float:100", - _("Last Purchase Price")+ ":Float:100", + return [ + { + "fieldname": "item", + "label": _("Item"), + "fieldtype": "Link", + "options": "Item", + "width": 120, + }, + { + "fieldname": "description", + "label": _("Description"), + "fieldtype": "Data", + "width": 150, + }, + { + "fieldname": "manufacturer", + "label": _("Manufacturer"), + "fieldtype": "Data", + "width": 120, + }, + { + "fieldname": "manufacturer_part_number", + "label": _("Manufacturer Part Number"), + "fieldtype": "Data", + "width": 150, + }, + { + "fieldname": "qty_per_unit", + "label": _("Qty Per Unit"), + "fieldtype": "Float", + "width": 110, + }, + { + "fieldname": "available_qty", + "label": _("Available Qty"), + "fieldtype": "Float", + "width": 120, + }, + { + "fieldname": "required_qty", + "label": _("Required Qty"), + "fieldtype": "Float", + "width": 120, + }, + { + "fieldname": "difference_qty", + "label": _("Difference Qty"), + "fieldtype": "Float", + "width": 130, + }, + { + "fieldname": "last_purchase_rate", + "label": _("Last Purchase Rate"), + "fieldtype": "Float", + "width": 160, + }, ] - return columns -def get_bom_stock(filters): - conditions = "" - bom = filters.get("bom") - - table = "`tabBOM Item`" - qty_field = "qty" +def get_bom_data(filters): if filters.get("show_exploded_view"): - table = "`tabBOM Explosion Item`" - qty_field = "stock_qty" + bom_item_table = "BOM Explosion Item" + else: + bom_item_table = "BOM Item" + + bom_item = frappe.qb.DocType(bom_item_table) + bin = frappe.qb.DocType("Bin") + + query = ( + frappe.qb.from_(bom_item) + .left_join(bin) + .on(bom_item.item_code == bin.item_code) + .select( + bom_item.item_code, + bom_item.description, + bom_item.qty_consumed_per_unit.as_("qty_per_unit"), + IfNull(Sum(bin.actual_qty), 0).as_("actual_qty"), + ) + .where((bom_item.parent == filters.get("bom")) & (bom_item.parenttype == "BOM")) + .groupby(bom_item.item_code) + ) if filters.get("warehouse"): - warehouse_details = frappe.db.get_value("Warehouse", filters.get("warehouse"), ["lft", "rgt"], as_dict=1) + warehouse_details = frappe.db.get_value( + "Warehouse", filters.get("warehouse"), ["lft", "rgt"], as_dict=1 + ) + if warehouse_details: - conditions += " and exists (select name from `tabWarehouse` wh \ - where wh.lft >= %s and wh.rgt <= %s and ledger.warehouse = wh.name)" % (warehouse_details.lft, - warehouse_details.rgt) + wh = frappe.qb.DocType("Warehouse") + query = query.where( + ExistsCriterion( + frappe.qb.from_(wh) + .select(wh.name) + .where( + (wh.lft >= warehouse_details.lft) + & (wh.rgt <= warehouse_details.rgt) + & (bin.warehouse == wh.name) + ) + ) + ) else: - conditions += " and ledger.warehouse = %s" % frappe.db.escape(filters.get("warehouse")) + query = query.where(bin.warehouse == filters.get("warehouse")) - else: - conditions += "" + return query.run(as_dict=True) - return frappe.db.sql(""" - SELECT - bom_item.item_code, - bom_item.description, - bom_item.{qty_field}, - ifnull(sum(ledger.actual_qty), 0) as actual_qty, - ifnull(sum(FLOOR(ledger.actual_qty / bom_item.{qty_field})), 0) as to_build - FROM - {table} AS bom_item - LEFT JOIN `tabBin` AS ledger - ON bom_item.item_code = ledger.item_code - {conditions} - - WHERE - bom_item.parent = '{bom}' and bom_item.parenttype='BOM' - - GROUP BY bom_item.item_code""".format(qty_field=qty_field, table=table, conditions=conditions, bom=bom), as_dict=1) def get_manufacturer_records(): - details = frappe.get_all('Item Manufacturer', fields = ["manufacturer", "manufacturer_part_no", "parent"]) + details = frappe.get_all( + "Item Manufacturer", fields=["manufacturer", "manufacturer_part_no", "item_code"] + ) + manufacture_details = frappe._dict() for detail in details: - dic = manufacture_details.setdefault(detail.get('parent'), {}) - dic.setdefault('manufacturer', []).append(detail.get('manufacturer')) - dic.setdefault('manufacturer_part', []).append(detail.get('manufacturer_part_no')) + dic = manufacture_details.setdefault(detail.get("item_code"), {}) + dic.setdefault("manufacturer", []).append(detail.get("manufacturer")) + dic.setdefault("manufacturer_part", []).append(detail.get("manufacturer_part_no")) return manufacture_details diff --git a/erpnext/manufacturing/report/bom_stock_calculated/test_bom_stock_calculated.py b/erpnext/manufacturing/report/bom_stock_calculated/test_bom_stock_calculated.py new file mode 100644 index 00000000000..8ad980fa19a --- /dev/null +++ b/erpnext/manufacturing/report/bom_stock_calculated/test_bom_stock_calculated.py @@ -0,0 +1,115 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +# For license information, please see license.txt + +from frappe.tests.utils import FrappeTestCase + +from erpnext.manufacturing.doctype.production_plan.test_production_plan import make_bom +from erpnext.manufacturing.report.bom_stock_calculated.bom_stock_calculated import ( + execute as bom_stock_calculated_report, +) +from erpnext.stock.doctype.item.test_item import make_item + + +class TestBOMStockCalculated(FrappeTestCase): + def setUp(self): + self.fg_item, self.rm_items = create_items() + self.boms = create_boms(self.fg_item, self.rm_items) + + def test_bom_stock_calculated(self): + qty_to_make = 10 + + # Case 1: When Item(s) Qty and Stock Qty are equal. + data = bom_stock_calculated_report( + filters={ + "qty_to_make": qty_to_make, + "bom": self.boms[0].name, + } + )[1] + expected_data = get_expected_data(self.boms[0], qty_to_make) + self.assertSetEqual(set(tuple(x) for x in data), set(tuple(x) for x in expected_data)) + + # Case 2: When Item(s) Qty and Stock Qty are different and BOM Qty is 1. + data = bom_stock_calculated_report( + filters={ + "qty_to_make": qty_to_make, + "bom": self.boms[1].name, + } + )[1] + expected_data = get_expected_data(self.boms[1], qty_to_make) + self.assertSetEqual(set(tuple(x) for x in data), set(tuple(x) for x in expected_data)) + + # Case 3: When Item(s) Qty and Stock Qty are different and BOM Qty is greater than 1. + data = bom_stock_calculated_report( + filters={ + "qty_to_make": qty_to_make, + "bom": self.boms[2].name, + } + )[1] + expected_data = get_expected_data(self.boms[2], qty_to_make) + self.assertSetEqual(set(tuple(x) for x in data), set(tuple(x) for x in expected_data)) + + +def create_items(): + fg_item = make_item(properties={"is_stock_item": 1}).name + rm_item1 = make_item( + properties={ + "is_stock_item": 1, + "standard_rate": 100, + "opening_stock": 100, + "last_purchase_rate": 100, + } + ).name + rm_item2 = make_item( + properties={ + "is_stock_item": 1, + "standard_rate": 200, + "opening_stock": 200, + "last_purchase_rate": 200, + } + ).name + + return fg_item, [rm_item1, rm_item2] + + +def create_boms(fg_item, rm_items): + def update_bom_items(bom, uom, conversion_factor): + for item in bom.items: + item.uom = uom + item.conversion_factor = conversion_factor + + return bom + + bom1 = make_bom(item=fg_item, quantity=1, raw_materials=rm_items, rm_qty=10) + + bom2 = make_bom(item=fg_item, quantity=1, raw_materials=rm_items, rm_qty=10, do_not_submit=True) + bom2 = update_bom_items(bom2, "Box", 10) + bom2.save() + bom2.submit() + + bom3 = make_bom(item=fg_item, quantity=2, raw_materials=rm_items, rm_qty=10, do_not_submit=True) + bom3 = update_bom_items(bom3, "Box", 10) + bom3.save() + bom3.submit() + + return [bom1, bom2, bom3] + + +def get_expected_data(bom, qty_to_make): + expected_data = [] + + for idx in range(len(bom.items)): + expected_data.append( + [ + bom.items[idx].item_code, + bom.items[idx].item_code, + "", + "", + float(bom.items[idx].stock_qty / bom.quantity), + float(100 * (idx + 1)), + float(qty_to_make * (bom.items[idx].stock_qty / bom.quantity)), + float((100 * (idx + 1)) - (qty_to_make * (bom.items[idx].stock_qty / bom.quantity))), + float(100 * (idx + 1)), + ] + ) + + return expected_data diff --git a/erpnext/manufacturing/report/bom_stock_report/bom_stock_report.py b/erpnext/manufacturing/report/bom_stock_report/bom_stock_report.py index fa943912617..1e1b4356008 100644 --- a/erpnext/manufacturing/report/bom_stock_report/bom_stock_report.py +++ b/erpnext/manufacturing/report/bom_stock_report/bom_stock_report.py @@ -4,17 +4,20 @@ import frappe from frappe import _ +from frappe.query_builder.functions import Floor, Sum +from pypika.terms import ExistsCriterion def execute(filters=None): - if not filters: filters = {} + if not filters: + filters = {} columns = get_columns() - data = get_bom_stock(filters) return columns, data + def get_columns(): """return columns""" columns = [ @@ -29,54 +32,59 @@ def get_columns(): return columns + def get_bom_stock(filters): - conditions = "" - bom = filters.get("bom") - - table = "`tabBOM Item`" - qty_field = "stock_qty" - - qty_to_produce = filters.get("qty_to_produce", 1) - if int(qty_to_produce) <= 0: + qty_to_produce = filters.get("qty_to_produce") or 1 + if int(qty_to_produce) < 0: frappe.throw(_("Quantity to Produce can not be less than Zero")) if filters.get("show_exploded_view"): - table = "`tabBOM Explosion Item`" + bom_item_table = "BOM Explosion Item" + else: + bom_item_table = "BOM Item" + + bin = frappe.qb.DocType("Bin") + bom = frappe.qb.DocType("BOM") + bom_item = frappe.qb.DocType(bom_item_table) + + query = ( + frappe.qb.from_(bom) + .inner_join(bom_item) + .on(bom.name == bom_item.parent) + .left_join(bin) + .on(bom_item.item_code == bin.item_code) + .select( + bom_item.item_code, + bom_item.description, + bom_item.stock_qty, + bom_item.stock_uom, + bom_item.stock_qty * qty_to_produce / bom.quantity, + Sum(bin.actual_qty).as_("actual_qty"), + Sum(Floor(bin.actual_qty / (bom_item.stock_qty * qty_to_produce / bom.quantity))), + ) + .where((bom_item.parent == filters.get("bom")) & (bom_item.parenttype == "BOM")) + .groupby(bom_item.item_code) + ) if filters.get("warehouse"): - warehouse_details = frappe.db.get_value("Warehouse", filters.get("warehouse"), ["lft", "rgt"], as_dict=1) + warehouse_details = frappe.db.get_value( + "Warehouse", filters.get("warehouse"), ["lft", "rgt"], as_dict=1 + ) + if warehouse_details: - conditions += " and exists (select name from `tabWarehouse` wh \ - where wh.lft >= %s and wh.rgt <= %s and ledger.warehouse = wh.name)" % (warehouse_details.lft, - warehouse_details.rgt) - else: - conditions += " and ledger.warehouse = %s" % frappe.db.escape(filters.get("warehouse")) - - else: - conditions += "" - - return frappe.db.sql(""" - SELECT - bom_item.item_code, - bom_item.description , - bom_item.{qty_field}, - bom_item.stock_uom, - bom_item.{qty_field} * {qty_to_produce} / bom.quantity, - sum(ledger.actual_qty) as actual_qty, - sum(FLOOR(ledger.actual_qty / (bom_item.{qty_field} * {qty_to_produce} / bom.quantity))) - FROM - `tabBOM` AS bom INNER JOIN {table} AS bom_item - ON bom.name = bom_item.parent - LEFT JOIN `tabBin` AS ledger - ON bom_item.item_code = ledger.item_code - {conditions} - WHERE - bom_item.parent = {bom} and bom_item.parenttype='BOM' - - GROUP BY bom_item.item_code""".format( - qty_field=qty_field, - table=table, - conditions=conditions, - bom=frappe.db.escape(bom), - qty_to_produce=qty_to_produce or 1) + wh = frappe.qb.DocType("Warehouse") + query = query.where( + ExistsCriterion( + frappe.qb.from_(wh) + .select(wh.name) + .where( + (wh.lft >= warehouse_details.lft) + & (wh.rgt <= warehouse_details.rgt) + & (bin.warehouse == wh.name) + ) + ) ) + else: + query = query.where(bin.warehouse == filters.get("warehouse")) + + return query.run() diff --git a/erpnext/manufacturing/report/bom_variance_report/bom_variance_report.py b/erpnext/manufacturing/report/bom_variance_report/bom_variance_report.py index a5ae43e9add..70a1850fd0f 100644 --- a/erpnext/manufacturing/report/bom_variance_report/bom_variance_report.py +++ b/erpnext/manufacturing/report/bom_variance_report/bom_variance_report.py @@ -12,98 +12,99 @@ def execute(filters=None): data = get_data(filters) return columns, data + def get_columns(filters): - columns = [{ + columns = [ + { "label": _("Work Order"), "fieldname": "work_order", "fieldtype": "Link", "options": "Work Order", - "width": 120 - }] - - if not filters.get('bom_no'): - columns.extend([ - { - "label": _("BOM No"), - "fieldname": "bom_no", - "fieldtype": "Link", - "options": "BOM", - "width": 180 - } - ]) - - columns.extend([ - { - "label": _("Finished Good"), - "fieldname": "production_item", - "fieldtype": "Link", - "options": "Item", - "width": 120 - }, - { - "label": _("Ordered Qty"), - "fieldname": "qty", - "fieldtype": "Float", - "width": 120 - }, - { - "label": _("Produced Qty"), - "fieldname": "produced_qty", - "fieldtype": "Float", - "width": 120 - }, - { - "label": _("Raw Material"), - "fieldname": "raw_material_code", - "fieldtype": "Link", - "options": "Item", - "width": 120 - }, - { - "label": _("Required Qty"), - "fieldname": "required_qty", - "fieldtype": "Float", - "width": 120 - }, - { - "label": _("Consumed Qty"), - "fieldname": "consumed_qty", - "fieldtype": "Float", - "width": 120 + "width": 120, } - ]) + ] + + if not filters.get("bom_no"): + columns.extend( + [ + { + "label": _("BOM No"), + "fieldname": "bom_no", + "fieldtype": "Link", + "options": "BOM", + "width": 180, + } + ] + ) + + columns.extend( + [ + { + "label": _("Finished Good"), + "fieldname": "production_item", + "fieldtype": "Link", + "options": "Item", + "width": 120, + }, + {"label": _("Ordered Qty"), "fieldname": "qty", "fieldtype": "Float", "width": 120}, + {"label": _("Produced Qty"), "fieldname": "produced_qty", "fieldtype": "Float", "width": 120}, + { + "label": _("Raw Material"), + "fieldname": "raw_material_code", + "fieldtype": "Link", + "options": "Item", + "width": 120, + }, + {"label": _("Required Qty"), "fieldname": "required_qty", "fieldtype": "Float", "width": 120}, + {"label": _("Consumed Qty"), "fieldname": "consumed_qty", "fieldtype": "Float", "width": 120}, + ] + ) return columns + def get_data(filters): - cond = "1=1" + wo = frappe.qb.DocType("Work Order") + query = ( + frappe.qb.from_(wo) + .select(wo.name.as_("work_order"), wo.qty, wo.produced_qty, wo.production_item, wo.bom_no) + .where((wo.produced_qty > wo.qty) & (wo.docstatus == 1)) + ) - if filters.get('bom_no') and not filters.get('work_order'): - cond += " and bom_no = '%s'" % filters.get('bom_no') + if filters.get("bom_no") and not filters.get("work_order"): + query = query.where(wo.bom_no == filters.get("bom_no")) - if filters.get('work_order'): - cond += " and name = '%s'" % filters.get('work_order') + if filters.get("work_order"): + query = query.where(wo.name == filters.get("work_order")) results = [] - for d in frappe.db.sql(""" select name as work_order, qty, produced_qty, production_item, bom_no - from `tabWork Order` where produced_qty > qty and docstatus = 1 and {0}""".format(cond), as_dict=1): + for d in query.run(as_dict=True): results.append(d) - for data in frappe.get_all('Work Order Item', fields=["item_code as raw_material_code", - "required_qty", "consumed_qty"], filters={'parent': d.work_order, 'parenttype': 'Work Order'}): + for data in frappe.get_all( + "Work Order Item", + fields=["item_code as raw_material_code", "required_qty", "consumed_qty"], + filters={"parent": d.work_order, "parenttype": "Work Order"}, + ): results.append(data) return results + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_work_orders(doctype, txt, searchfield, start, page_len, filters): - cond = "1=1" - if filters.get('bom_no'): - cond += " and bom_no = '%s'" % filters.get('bom_no') + wo = frappe.qb.DocType("Work Order") + query = ( + frappe.qb.from_(wo) + .select(wo.name) + .where((wo.name.like(f"{txt}%")) & (wo.produced_qty > wo.qty) & (wo.docstatus == 1)) + .orderby(wo.name) + .limit(page_len) + .offset(start) + ) - return frappe.db.sql("""select name from `tabWork Order` - where name like %(name)s and {0} and produced_qty > qty and docstatus = 1 - order by name limit {1}, {2}""".format(cond, start, page_len),{ - 'name': "%%%s%%" % txt - }, as_list=1) + if filters.get("bom_no"): + query = query.where(wo.bom_no == filters.get("bom_no")) + + return query.run(as_list=True) diff --git a/erpnext/manufacturing/report/cost_of_poor_quality_report/cost_of_poor_quality_report.js b/erpnext/manufacturing/report/cost_of_poor_quality_report/cost_of_poor_quality_report.js index 97e7e0a7d20..72eed5e0d7c 100644 --- a/erpnext/manufacturing/report/cost_of_poor_quality_report/cost_of_poor_quality_report.js +++ b/erpnext/manufacturing/report/cost_of_poor_quality_report/cost_of_poor_quality_report.js @@ -17,14 +17,12 @@ frappe.query_reports["Cost of Poor Quality Report"] = { fieldname:"from_date", fieldtype: "Datetime", default: frappe.datetime.convert_to_system_tz(frappe.datetime.add_months(frappe.datetime.now_datetime(), -1)), - reqd: 1 }, { label: __("To Date"), fieldname:"to_date", fieldtype: "Datetime", default: frappe.datetime.now_datetime(), - reqd: 1, }, { label: __("Job Card"), diff --git a/erpnext/manufacturing/report/cost_of_poor_quality_report/cost_of_poor_quality_report.py b/erpnext/manufacturing/report/cost_of_poor_quality_report/cost_of_poor_quality_report.py index 77418235b07..481fe51d739 100644 --- a/erpnext/manufacturing/report/cost_of_poor_quality_report/cost_of_poor_quality_report.py +++ b/erpnext/manufacturing/report/cost_of_poor_quality_report/cost_of_poor_quality_report.py @@ -3,46 +3,84 @@ import frappe from frappe import _ -from frappe.utils import flt def execute(filters=None): - columns, data = [], [] + return get_columns(filters), get_data(filters) - columns = get_columns(filters) - data = get_data(filters) - - return columns, data def get_data(report_filters): data = [] - operations = frappe.get_all("Operation", filters = {"is_corrective_operation": 1}) + operations = frappe.get_all("Operation", filters={"is_corrective_operation": 1}) if operations: - operations = [d.name for d in operations] - fields = ["production_item as item_code", "item_name", "work_order", "operation", - "workstation", "total_time_in_mins", "name", "hour_rate", "serial_no", "batch_no"] + if report_filters.get("operation"): + operations = [report_filters.get("operation")] + else: + operations = [d.name for d in operations] - filters = get_filters(report_filters, operations) + job_card = frappe.qb.DocType("Job Card") - job_cards = frappe.get_all("Job Card", fields = fields, - filters = filters) + operating_cost = ((job_card.hour_rate) * (job_card.total_time_in_mins) / 60.0).as_( + "operating_cost" + ) + item_code = (job_card.production_item).as_("item_code") - for row in job_cards: - row.operating_cost = flt(row.hour_rate) * (flt(row.total_time_in_mins) / 60.0) - data.append(row) + query = ( + frappe.qb.from_(job_card) + .select( + job_card.name, + job_card.work_order, + item_code, + job_card.item_name, + job_card.operation, + job_card.serial_no, + job_card.batch_no, + job_card.workstation, + job_card.total_time_in_mins, + job_card.hour_rate, + operating_cost, + ) + .where((job_card.docstatus == 1) & (job_card.is_corrective_job_card == 1)) + .groupby(job_card.name) + ) + query = append_filters(query, report_filters, operations, job_card) + data = query.run(as_dict=True) return data -def get_filters(report_filters, operations): - filters = {"docstatus": 1, "operation": ("in", operations), "is_corrective_job_card": 1} - for field in ["name", "work_order", "operation", "workstation", "company", "serial_no", "batch_no", "production_item"]: - if report_filters.get(field): - if field != 'serial_no': - filters[field] = report_filters.get(field) - else: - filters[field] = ('like', '% {} %'.format(report_filters.get(field))) - return filters +def append_filters(query, report_filters, operations, job_card): + """Append optional filters to query builder.""" + + for field in ( + "name", + "work_order", + "operation", + "workstation", + "company", + "serial_no", + "batch_no", + "production_item", + ): + if report_filters.get(field): + if field == "serial_no": + query = query.where(job_card[field].like("%{}%".format(report_filters.get(field)))) + elif field == "operation": + query = query.where(job_card[field].isin(operations)) + else: + query = query.where(job_card[field] == report_filters.get(field)) + + if report_filters.get("from_date") or report_filters.get("to_date"): + job_card_time_log = frappe.qb.DocType("Job Card Time Log") + + query = query.join(job_card_time_log).on(job_card.name == job_card_time_log.parent) + if report_filters.get("from_date"): + query = query.where(job_card_time_log.from_time >= report_filters.get("from_date")) + if report_filters.get("to_date"): + query = query.where(job_card_time_log.to_time <= report_filters.get("to_date")) + + return query + def get_columns(filters): return [ @@ -51,64 +89,49 @@ def get_columns(filters): "fieldtype": "Link", "fieldname": "name", "options": "Job Card", - "width": "120" + "width": "120", }, { "label": _("Work Order"), "fieldtype": "Link", "fieldname": "work_order", "options": "Work Order", - "width": "100" + "width": "100", }, { "label": _("Item Code"), "fieldtype": "Link", "fieldname": "item_code", "options": "Item", - "width": "100" - }, - { - "label": _("Item Name"), - "fieldtype": "Data", - "fieldname": "item_name", - "width": "100" + "width": "100", }, + {"label": _("Item Name"), "fieldtype": "Data", "fieldname": "item_name", "width": "100"}, { "label": _("Operation"), "fieldtype": "Link", "fieldname": "operation", "options": "Operation", - "width": "100" - }, - { - "label": _("Serial No"), - "fieldtype": "Data", - "fieldname": "serial_no", - "width": "100" - }, - { - "label": _("Batch No"), - "fieldtype": "Data", - "fieldname": "batch_no", - "width": "100" + "width": "100", }, + {"label": _("Serial No"), "fieldtype": "Data", "fieldname": "serial_no", "width": "100"}, + {"label": _("Batch No"), "fieldtype": "Data", "fieldname": "batch_no", "width": "100"}, { "label": _("Workstation"), "fieldtype": "Link", "fieldname": "workstation", "options": "Workstation", - "width": "100" + "width": "100", }, { "label": _("Operating Cost"), "fieldtype": "Currency", "fieldname": "operating_cost", - "width": "150" + "width": "150", }, { "label": _("Total Time (in Mins)"), "fieldtype": "Float", "fieldname": "total_time_in_mins", - "width": "150" - } + "width": "150", + }, ] diff --git a/erpnext/manufacturing/report/downtime_analysis/downtime_analysis.py b/erpnext/manufacturing/report/downtime_analysis/downtime_analysis.py index 2c515d1b36f..80a15648670 100644 --- a/erpnext/manufacturing/report/downtime_analysis/downtime_analysis.py +++ b/erpnext/manufacturing/report/downtime_analysis/downtime_analysis.py @@ -14,10 +14,20 @@ def execute(filters=None): chart_data = get_chart_data(data, filters) return columns, data, None, chart_data + def get_data(filters): query_filters = {} - fields = ["name", "workstation", "operator", "from_time", "to_time", "downtime", "stop_reason", "remarks"] + fields = [ + "name", + "workstation", + "operator", + "from_time", + "to_time", + "downtime", + "stop_reason", + "remarks", + ] query_filters["from_time"] = (">=", filters.get("from_date")) query_filters["to_time"] = ("<=", filters.get("to_date")) @@ -25,13 +35,14 @@ def get_data(filters): if filters.get("workstation"): query_filters["workstation"] = filters.get("workstation") - data = frappe.get_all("Downtime Entry", fields= fields, filters=query_filters) or [] + data = frappe.get_all("Downtime Entry", fields=fields, filters=query_filters) or [] for d in data: if d.downtime: d.downtime = d.downtime / 60 return data + def get_chart_data(data, columns): labels = sorted(list(set([d.workstation for d in data]))) @@ -47,17 +58,13 @@ def get_chart_data(data, columns): datasets.append(workstation_wise_data.get(label, 0)) chart = { - "data": { - "labels": labels, - "datasets": [ - {"name": "Machine Downtime", "values": datasets} - ] - }, - "type": "bar" + "data": {"labels": labels, "datasets": [{"name": "Machine Downtime", "values": datasets}]}, + "type": "bar", } return chart + def get_columns(filters): return [ { @@ -65,50 +72,25 @@ def get_columns(filters): "fieldname": "name", "fieldtype": "Link", "options": "Downtime Entry", - "width": 100 + "width": 100, }, { "label": _("Machine"), "fieldname": "workstation", "fieldtype": "Link", "options": "Workstation", - "width": 100 + "width": 100, }, { "label": _("Operator"), "fieldname": "operator", "fieldtype": "Link", "options": "Employee", - "width": 130 + "width": 130, }, - { - "label": _("From Time"), - "fieldname": "from_time", - "fieldtype": "Datetime", - "width": 160 - }, - { - "label": _("To Time"), - "fieldname": "to_time", - "fieldtype": "Datetime", - "width": 160 - }, - { - "label": _("Downtime (In Hours)"), - "fieldname": "downtime", - "fieldtype": "Float", - "width": 150 - }, - { - "label": _("Stop Reason"), - "fieldname": "stop_reason", - "fieldtype": "Data", - "width": 220 - }, - { - "label": _("Remarks"), - "fieldname": "remarks", - "fieldtype": "Text", - "width": 100 - } + {"label": _("From Time"), "fieldname": "from_time", "fieldtype": "Datetime", "width": 160}, + {"label": _("To Time"), "fieldname": "to_time", "fieldtype": "Datetime", "width": 160}, + {"label": _("Downtime (In Hours)"), "fieldname": "downtime", "fieldtype": "Float", "width": 150}, + {"label": _("Stop Reason"), "fieldname": "stop_reason", "fieldtype": "Data", "width": 220}, + {"label": _("Remarks"), "fieldname": "remarks", "fieldtype": "Text", "width": 100}, ] diff --git a/erpnext/manufacturing/report/exponential_smoothing_forecasting/exponential_smoothing_forecasting.py b/erpnext/manufacturing/report/exponential_smoothing_forecasting/exponential_smoothing_forecasting.py index 26b3359dee1..d3bce831551 100644 --- a/erpnext/manufacturing/report/exponential_smoothing_forecasting/exponential_smoothing_forecasting.py +++ b/erpnext/manufacturing/report/exponential_smoothing_forecasting/exponential_smoothing_forecasting.py @@ -14,6 +14,7 @@ from erpnext.stock.doctype.warehouse.warehouse import get_child_warehouses def execute(filters=None): return ForecastingReport(filters).execute_report() + class ExponentialSmoothingForecast(object): def forecast_future_data(self): for key, value in self.period_wise_data.items(): @@ -26,24 +27,22 @@ class ExponentialSmoothingForecast(object): elif forecast_data: previous_period_data = forecast_data[-1] - value[forecast_key] = (previous_period_data[1] + - flt(self.filters.smoothing_constant) * ( - flt(previous_period_data[0]) - flt(previous_period_data[1]) - ) + value[forecast_key] = previous_period_data[1] + flt(self.filters.smoothing_constant) * ( + flt(previous_period_data[0]) - flt(previous_period_data[1]) ) if value.get(forecast_key): # will be use to forecaset next period forecast_data.append([value.get(period.key), value.get(forecast_key)]) + class ForecastingReport(ExponentialSmoothingForecast): def __init__(self, filters=None): self.filters = frappe._dict(filters or {}) self.data = [] self.doctype = self.filters.based_on_document self.child_doctype = self.doctype + " Item" - self.based_on_field = ("qty" - if self.filters.based_on_field == "Qty" else "amount") + self.based_on_field = "qty" if self.filters.based_on_field == "Qty" else "amount" self.fieldtype = "Float" if self.based_on_field == "qty" else "Currency" self.company_currency = erpnext.get_company_currency(self.filters.company) @@ -63,8 +62,15 @@ class ForecastingReport(ExponentialSmoothingForecast): self.period_wise_data = {} from_date = add_years(self.filters.from_date, cint(self.filters.no_of_years) * -1) - self.period_list = get_period_list(from_date, self.filters.to_date, - from_date, self.filters.to_date, "Date Range", self.filters.periodicity, ignore_fiscal_year=True) + self.period_list = get_period_list( + from_date, + self.filters.to_date, + from_date, + self.filters.to_date, + "Date Range", + self.filters.periodicity, + ignore_fiscal_year=True, + ) order_data = self.get_data_for_forecast() or [] @@ -76,8 +82,10 @@ class ForecastingReport(ExponentialSmoothingForecast): period_data = self.period_wise_data[key] for period in self.period_list: # check if posting date is within the period - if (entry.posting_date >= period.from_date and entry.posting_date <= period.to_date): - period_data[period.key] = period_data.get(period.key, 0.0) + flt(entry.get(self.based_on_field)) + if entry.posting_date >= period.from_date and entry.posting_date <= period.to_date: + period_data[period.key] = period_data.get(period.key, 0.0) + flt( + entry.get(self.based_on_field) + ) for key, value in self.period_wise_data.items(): list_of_period_value = [value.get(p.key, 0) for p in self.period_list] @@ -88,47 +96,53 @@ class ForecastingReport(ExponentialSmoothingForecast): value["avg"] = flt(sum(list_of_period_value)) / flt(sum(total_qty)) def get_data_for_forecast(self): - cond = "" - if self.filters.item_code: - cond = " AND soi.item_code = %s" %(frappe.db.escape(self.filters.item_code)) - - warehouses = [] - if self.filters.warehouse: - warehouses = get_child_warehouses(self.filters.warehouse) - cond += " AND soi.warehouse in ({})".format(','.join(['%s'] * len(warehouses))) - - input_data = [self.filters.from_date, self.filters.company] - if warehouses: - input_data.extend(warehouses) + parent = frappe.qb.DocType(self.doctype) + child = frappe.qb.DocType(self.child_doctype) date_field = "posting_date" if self.doctype == "Delivery Note" else "transaction_date" - return frappe.db.sql(""" - SELECT - so.{date_field} as posting_date, soi.item_code, soi.warehouse, - soi.item_name, soi.stock_qty as qty, soi.base_amount as amount - FROM - `tab{doc}` so, `tab{child_doc}` soi - WHERE - so.docstatus = 1 AND so.name = soi.parent AND - so.{date_field} < %s AND so.company = %s {cond} - """.format(doc=self.doctype, child_doc=self.child_doctype, date_field=date_field, cond=cond), - tuple(input_data), as_dict=1) + query = ( + frappe.qb.from_(parent) + .from_(child) + .select( + parent[date_field].as_("posting_date"), + child.item_code, + child.warehouse, + child.item_name, + child.stock_qty.as_("qty"), + child.base_amount.as_("amount"), + ) + .where( + (parent.docstatus == 1) + & (parent.name == child.parent) + & (parent[date_field] < self.filters.from_date) + & (parent.company == self.filters.company) + ) + ) + + if self.filters.item_code: + query = query.where(child.item_code == self.filters.item_code) + + if self.filters.warehouse: + warehouses = get_child_warehouses(self.filters.warehouse) or [] + query = query.where(child.warehouse.isin(warehouses)) + + return query.run(as_dict=True) def prepare_final_data(self): self.data = [] - if not self.period_wise_data: return + if not self.period_wise_data: + return for key in self.period_wise_data: self.data.append(self.period_wise_data.get(key)) def add_total(self): - if not self.data: return + if not self.data: + return - total_row = { - "item_code": _(frappe.bold("Total Quantity")) - } + total_row = {"item_code": _(frappe.bold("Total Quantity"))} for value in self.data: for period in self.period_list: @@ -145,43 +159,52 @@ class ForecastingReport(ExponentialSmoothingForecast): self.data.append(total_row) def get_columns(self): - columns = [{ - "label": _("Item Code"), - "options": "Item", - "fieldname": "item_code", - "fieldtype": "Link", - "width": 130 - }, { - "label": _("Warehouse"), - "options": "Warehouse", - "fieldname": "warehouse", - "fieldtype": "Link", - "width": 130 - }] + columns = [ + { + "label": _("Item Code"), + "options": "Item", + "fieldname": "item_code", + "fieldtype": "Link", + "width": 130, + }, + { + "label": _("Warehouse"), + "options": "Warehouse", + "fieldname": "warehouse", + "fieldtype": "Link", + "width": 130, + }, + ] - width = 180 if self.filters.periodicity in ['Yearly', "Half-Yearly", "Quarterly"] else 100 + width = 180 if self.filters.periodicity in ["Yearly", "Half-Yearly", "Quarterly"] else 100 for period in self.period_list: - if (self.filters.periodicity in ['Yearly', "Half-Yearly", "Quarterly"] - or period.from_date >= getdate(self.filters.from_date)): + if self.filters.periodicity in [ + "Yearly", + "Half-Yearly", + "Quarterly", + ] or period.from_date >= getdate(self.filters.from_date): forecast_key = period.key label = _(period.label) if period.from_date >= getdate(self.filters.from_date): - forecast_key = 'forecast_' + period.key + forecast_key = "forecast_" + period.key label = _(period.label) + " " + _("(Forecast)") - columns.append({ - "label": label, - "fieldname": forecast_key, - "fieldtype": self.fieldtype, - "width": width, - "default": 0.0 - }) + columns.append( + { + "label": label, + "fieldname": forecast_key, + "fieldtype": self.fieldtype, + "width": width, + "default": 0.0, + } + ) return columns def get_chart_data(self): - if not self.data: return + if not self.data: + return labels = [] self.total_demand = [] @@ -206,40 +229,35 @@ class ForecastingReport(ExponentialSmoothingForecast): "data": { "labels": labels, "datasets": [ - { - "name": "Demand", - "values": self.total_demand - }, - { - "name": "Forecast", - "values": self.total_forecast - } - ] + {"name": "Demand", "values": self.total_demand}, + {"name": "Forecast", "values": self.total_forecast}, + ], }, - "type": "line" + "type": "line", } def get_summary_data(self): - if not self.data: return + if not self.data: + return return [ { "value": sum(self.total_demand), "label": _("Total Demand (Past Data)"), "currency": self.company_currency, - "datatype": self.fieldtype + "datatype": self.fieldtype, }, { "value": sum(self.total_history_forecast), "label": _("Total Forecast (Past Data)"), "currency": self.company_currency, - "datatype": self.fieldtype + "datatype": self.fieldtype, }, { "value": sum(self.total_future_forecast), "indicator": "Green", "label": _("Total Forecast (Future Data)"), "currency": self.company_currency, - "datatype": self.fieldtype - } + "datatype": self.fieldtype, + }, ] diff --git a/erpnext/manufacturing/report/job_card_summary/job_card_summary.py b/erpnext/manufacturing/report/job_card_summary/job_card_summary.py index 4046bb12b86..a86c7a47c36 100644 --- a/erpnext/manufacturing/report/job_card_summary/job_card_summary.py +++ b/erpnext/manufacturing/report/job_card_summary/job_card_summary.py @@ -16,23 +16,34 @@ def execute(filters=None): chart_data = get_chart_data(data, filters) return columns, data, None, chart_data + def get_data(filters): query_filters = { "docstatus": ("<", 2), - "posting_date": ("between", [filters.from_date, filters.to_date]) + "posting_date": ("between", [filters.from_date, filters.to_date]), } - fields = ["name", "status", "work_order", "production_item", "item_name", "posting_date", - "total_completed_qty", "workstation", "operation", "total_time_in_mins"] + fields = [ + "name", + "status", + "work_order", + "production_item", + "item_name", + "posting_date", + "total_completed_qty", + "workstation", + "operation", + "total_time_in_mins", + ] for field in ["work_order", "workstation", "operation", "company"]: if filters.get(field): query_filters[field] = ("in", filters.get(field)) - data = frappe.get_all("Job Card", - fields= fields, filters=query_filters) + data = frappe.get_all("Job Card", fields=fields, filters=query_filters) - if not data: return [] + if not data: + return [] job_cards = [d.name for d in data] @@ -42,9 +53,12 @@ def get_data(filters): } job_card_time_details = {} - for job_card_data in frappe.get_all("Job Card Time Log", + for job_card_data in frappe.get_all( + "Job Card Time Log", fields=["min(from_time) as from_time", "max(to_time) as to_time", "parent"], - filters=job_card_time_filter, group_by="parent"): + filters=job_card_time_filter, + group_by="parent", + ): job_card_time_details[job_card_data.parent] = job_card_data res = [] @@ -60,6 +74,7 @@ def get_data(filters): return res + def get_chart_data(job_card_details, filters): labels, periodic_data = prepare_chart_data(job_card_details, filters) @@ -73,23 +88,15 @@ def get_chart_data(job_card_details, filters): datasets.append({"name": "Open", "values": open_job_cards}) datasets.append({"name": "Completed", "values": completed}) - chart = { - "data": { - 'labels': labels, - 'datasets': datasets - }, - "type": "bar" - } + chart = {"data": {"labels": labels, "datasets": datasets}, "type": "bar"} return chart + def prepare_chart_data(job_card_details, filters): labels = [] - periodic_data = { - "Open": {}, - "Completed": {} - } + periodic_data = {"Open": {}, "Completed": {}} filters.range = "Monthly" @@ -110,6 +117,7 @@ def prepare_chart_data(job_card_details, filters): return labels, periodic_data + def get_columns(filters): columns = [ { @@ -117,84 +125,62 @@ def get_columns(filters): "fieldname": "name", "fieldtype": "Link", "options": "Job Card", - "width": 100 - }, - { - "label": _("Posting Date"), - "fieldname": "posting_date", - "fieldtype": "Date", - "width": 100 + "width": 100, }, + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 100}, ] if not filters.get("status"): columns.append( - { - "label": _("Status"), - "fieldname": "status", - "width": 100 - }, + {"label": _("Status"), "fieldname": "status", "width": 100}, ) - columns.extend([ - { - "label": _("Work Order"), - "fieldname": "work_order", - "fieldtype": "Link", - "options": "Work Order", - "width": 100 - }, - { - "label": _("Production Item"), - "fieldname": "production_item", - "fieldtype": "Link", - "options": "Item", - "width": 110 - }, - { - "label": _("Item Name"), - "fieldname": "item_name", - "fieldtype": "Data", - "width": 100 - }, - { - "label": _("Workstation"), - "fieldname": "workstation", - "fieldtype": "Link", - "options": "Workstation", - "width": 110 - }, - { - "label": _("Operation"), - "fieldname": "operation", - "fieldtype": "Link", - "options": "Operation", - "width": 110 - }, - { - "label": _("Total Completed Qty"), - "fieldname": "total_completed_qty", - "fieldtype": "Float", - "width": 120 - }, - { - "label": _("From Time"), - "fieldname": "from_time", - "fieldtype": "Datetime", - "width": 120 - }, - { - "label": _("To Time"), - "fieldname": "to_time", - "fieldtype": "Datetime", - "width": 120 - }, - { - "label": _("Time Required (In Mins)"), - "fieldname": "total_time_in_mins", - "fieldtype": "Float", - "width": 100 - } - ]) + columns.extend( + [ + { + "label": _("Work Order"), + "fieldname": "work_order", + "fieldtype": "Link", + "options": "Work Order", + "width": 100, + }, + { + "label": _("Production Item"), + "fieldname": "production_item", + "fieldtype": "Link", + "options": "Item", + "width": 110, + }, + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 100}, + { + "label": _("Workstation"), + "fieldname": "workstation", + "fieldtype": "Link", + "options": "Workstation", + "width": 110, + }, + { + "label": _("Operation"), + "fieldname": "operation", + "fieldtype": "Link", + "options": "Operation", + "width": 110, + }, + { + "label": _("Total Completed Qty"), + "fieldname": "total_completed_qty", + "fieldtype": "Float", + "width": 120, + }, + {"label": _("From Time"), "fieldname": "from_time", "fieldtype": "Datetime", "width": 120}, + {"label": _("To Time"), "fieldname": "to_time", "fieldtype": "Datetime", "width": 120}, + { + "label": _("Time Required (In Mins)"), + "fieldname": "total_time_in_mins", + "fieldtype": "Float", + "width": 100, + }, + ] + ) return columns diff --git a/erpnext/manufacturing/report/process_loss_report/process_loss_report.py b/erpnext/manufacturing/report/process_loss_report/process_loss_report.py index d3dfd52b773..ce8f4f35a3f 100644 --- a/erpnext/manufacturing/report/process_loss_report/process_loss_report.py +++ b/erpnext/manufacturing/report/process_loss_report/process_loss_report.py @@ -5,6 +5,7 @@ from typing import Dict, List, Tuple import frappe from frappe import _ +from frappe.query_builder.functions import Sum Filters = frappe._dict Row = frappe._dict @@ -12,123 +13,97 @@ Data = List[Row] Columns = List[Dict[str, str]] QueryArgs = Dict[str, str] + def execute(filters: Filters) -> Tuple[Columns, Data]: + filters = frappe._dict(filters or {}) columns = get_columns() data = get_data(filters) return columns, data + def get_data(filters: Filters) -> Data: - query_args = get_query_args(filters) - data = run_query(query_args) + wo = frappe.qb.DocType("Work Order") + se = frappe.qb.DocType("Stock Entry") + + query = ( + frappe.qb.from_(wo) + .inner_join(se) + .on(wo.name == se.work_order) + .select( + wo.name, + wo.status, + wo.production_item, + wo.qty, + wo.produced_qty, + wo.process_loss_qty, + (wo.produced_qty - wo.process_loss_qty).as_("actual_produced_qty"), + Sum(se.total_incoming_value).as_("total_fg_value"), + Sum(se.total_outgoing_value).as_("total_rm_value"), + ) + .where( + (wo.process_loss_qty > 0) + & (wo.company == filters.company) + & (se.docstatus == 1) + & (se.posting_date.between(filters.from_date, filters.to_date)) + ) + .groupby(se.work_order) + ) + + if "item" in filters: + query.where(wo.production_item == filters.item) + + if "work_order" in filters: + query.where(wo.name == filters.work_order) + + data = query.run(as_dict=True) + update_data_with_total_pl_value(data) + return data + def get_columns() -> Columns: return [ { - 'label': _('Work Order'), - 'fieldname': 'name', - 'fieldtype': 'Link', - 'options': 'Work Order', - 'width': '200' + "label": _("Work Order"), + "fieldname": "name", + "fieldtype": "Link", + "options": "Work Order", + "width": "200", }, { - 'label': _('Item'), - 'fieldname': 'production_item', - 'fieldtype': 'Link', - 'options': 'Item', - 'width': '100' + "label": _("Item"), + "fieldname": "production_item", + "fieldtype": "Link", + "options": "Item", + "width": "100", }, + {"label": _("Status"), "fieldname": "status", "fieldtype": "Data", "width": "100"}, { - 'label': _('Status'), - 'fieldname': 'status', - 'fieldtype': 'Data', - 'width': '100' + "label": _("Manufactured Qty"), + "fieldname": "produced_qty", + "fieldtype": "Float", + "width": "150", }, + {"label": _("Loss Qty"), "fieldname": "process_loss_qty", "fieldtype": "Float", "width": "150"}, { - 'label': _('Manufactured Qty'), - 'fieldname': 'produced_qty', - 'fieldtype': 'Float', - 'width': '150' + "label": _("Actual Manufactured Qty"), + "fieldname": "actual_produced_qty", + "fieldtype": "Float", + "width": "150", }, + {"label": _("Loss Value"), "fieldname": "total_pl_value", "fieldtype": "Float", "width": "150"}, + {"label": _("FG Value"), "fieldname": "total_fg_value", "fieldtype": "Float", "width": "150"}, { - 'label': _('Loss Qty'), - 'fieldname': 'process_loss_qty', - 'fieldtype': 'Float', - 'width': '150' + "label": _("Raw Material Value"), + "fieldname": "total_rm_value", + "fieldtype": "Float", + "width": "150", }, - { - 'label': _('Actual Manufactured Qty'), - 'fieldname': 'actual_produced_qty', - 'fieldtype': 'Float', - 'width': '150' - }, - { - 'label': _('Loss Value'), - 'fieldname': 'total_pl_value', - 'fieldtype': 'Float', - 'width': '150' - }, - { - 'label': _('FG Value'), - 'fieldname': 'total_fg_value', - 'fieldtype': 'Float', - 'width': '150' - }, - { - 'label': _('Raw Material Value'), - 'fieldname': 'total_rm_value', - 'fieldtype': 'Float', - 'width': '150' - } ] -def get_query_args(filters: Filters) -> QueryArgs: - query_args = {} - query_args.update(filters) - query_args.update( - get_filter_conditions(filters) - ) - return query_args - -def run_query(query_args: QueryArgs) -> Data: - return frappe.db.sql(""" - SELECT - wo.name, wo.status, wo.production_item, wo.qty, - wo.produced_qty, wo.process_loss_qty, - (wo.produced_qty - wo.process_loss_qty) as actual_produced_qty, - sum(se.total_incoming_value) as total_fg_value, - sum(se.total_outgoing_value) as total_rm_value - FROM - `tabWork Order` wo INNER JOIN `tabStock Entry` se - ON wo.name=se.work_order - WHERE - process_loss_qty > 0 - AND wo.company = %(company)s - AND se.docstatus = 1 - AND se.posting_date BETWEEN %(from_date)s AND %(to_date)s - {item_filter} - {work_order_filter} - GROUP BY - se.work_order - """.format(**query_args), query_args, as_dict=1) def update_data_with_total_pl_value(data: Data) -> None: for row in data: - value_per_unit_fg = row['total_fg_value'] / row['actual_produced_qty'] - row['total_pl_value'] = row['process_loss_qty'] * value_per_unit_fg - -def get_filter_conditions(filters: Filters) -> QueryArgs: - filter_conditions = dict(item_filter="", work_order_filter="") - if "item" in filters: - production_item = filters.get("item") - filter_conditions.update( - {"item_filter": f"AND wo.production_item='{production_item}'"} - ) - if "work_order" in filters: - work_order_name = filters.get("work_order") - filter_conditions.update( - {"work_order_filter": f"AND wo.name='{work_order_name}'"} - ) - return filter_conditions - + value_per_unit_fg = row["total_fg_value"] / row["actual_produced_qty"] + row["total_pl_value"] = row["process_loss_qty"] * value_per_unit_fg diff --git a/erpnext/manufacturing/report/production_analytics/production_analytics.py b/erpnext/manufacturing/report/production_analytics/production_analytics.py index d4743d3a8ef..12b5d19ba87 100644 --- a/erpnext/manufacturing/report/production_analytics/production_analytics.py +++ b/erpnext/manufacturing/report/production_analytics/production_analytics.py @@ -12,16 +12,11 @@ from erpnext.stock.report.stock_analytics.stock_analytics import get_period, get def execute(filters=None): columns = get_columns(filters) data, chart = get_data(filters, columns) - return columns, data, None , chart + return columns, data, None, chart + def get_columns(filters): - columns =[ - { - "label": _("Status"), - "fieldname": "Status", - "fieldtype": "Data", - "width": 140 - }] + columns = [{"label": _("Status"), "fieldname": "Status", "fieldtype": "Data", "width": 140}] ranges = get_period_date_ranges(filters) @@ -29,22 +24,20 @@ def get_columns(filters): period = get_period(end_date, filters) - columns.append({ - "label": _(period), - "fieldname": scrub(period), - "fieldtype": "Float", - "width": 120 - }) + columns.append( + {"label": _(period), "fieldname": scrub(period), "fieldtype": "Float", "width": 120} + ) return columns + def get_periodic_data(filters, entry): periodic_data = { "All Work Orders": {}, "Not Started": {}, "Overdue": {}, "Pending": {}, - "Completed": {} + "Completed": {}, } ranges = get_period_date_ranges(filters) @@ -52,34 +45,37 @@ def get_periodic_data(filters, entry): for from_date, end_date in ranges: period = get_period(end_date, filters) for d in entry: - if getdate(d.creation) <= getdate(from_date) or getdate(d.creation) <= getdate(end_date) : + if getdate(d.creation) <= getdate(from_date) or getdate(d.creation) <= getdate(end_date): periodic_data = update_periodic_data(periodic_data, "All Work Orders", period) - if d.status == 'Completed': - if getdate(d.actual_end_date) < getdate(from_date) or getdate(d.modified) < getdate(from_date): + if d.status == "Completed": + if getdate(d.actual_end_date) < getdate(from_date) or getdate(d.modified) < getdate( + from_date + ): periodic_data = update_periodic_data(periodic_data, "Completed", period) - elif getdate(d.actual_start_date) < getdate(from_date) : + elif getdate(d.actual_start_date) < getdate(from_date): periodic_data = update_periodic_data(periodic_data, "Pending", period) - elif getdate(d.planned_start_date) < getdate(from_date) : + elif getdate(d.planned_start_date) < getdate(from_date): periodic_data = update_periodic_data(periodic_data, "Overdue", period) else: periodic_data = update_periodic_data(periodic_data, "Not Started", period) - elif d.status == 'In Process': - if getdate(d.actual_start_date) < getdate(from_date) : + elif d.status == "In Process": + if getdate(d.actual_start_date) < getdate(from_date): periodic_data = update_periodic_data(periodic_data, "Pending", period) - elif getdate(d.planned_start_date) < getdate(from_date) : + elif getdate(d.planned_start_date) < getdate(from_date): periodic_data = update_periodic_data(periodic_data, "Overdue", period) else: periodic_data = update_periodic_data(periodic_data, "Not Started", period) - elif d.status == 'Not Started': - if getdate(d.planned_start_date) < getdate(from_date) : + elif d.status == "Not Started": + if getdate(d.planned_start_date) < getdate(from_date): periodic_data = update_periodic_data(periodic_data, "Overdue", period) else: periodic_data = update_periodic_data(periodic_data, "Not Started", period) return periodic_data + def update_periodic_data(periodic_data, status, period): if periodic_data.get(status).get(period): periodic_data[status][period] += 1 @@ -88,22 +84,33 @@ def update_periodic_data(periodic_data, status, period): return periodic_data + def get_data(filters, columns): data = [] - entry = frappe.get_all("Work Order", - fields=["creation", "modified", "actual_start_date", "actual_end_date", "planned_start_date", "planned_end_date", "status"], - filters={"docstatus": 1, "company": filters["company"] }) + entry = frappe.get_all( + "Work Order", + fields=[ + "creation", + "modified", + "actual_start_date", + "actual_end_date", + "planned_start_date", + "planned_end_date", + "status", + ], + filters={"docstatus": 1, "company": filters["company"]}, + ) - periodic_data = get_periodic_data(filters,entry) + periodic_data = get_periodic_data(filters, entry) labels = ["All Work Orders", "Not Started", "Overdue", "Pending", "Completed"] - chart_data = get_chart_data(periodic_data,columns) + chart_data = get_chart_data(periodic_data, columns) ranges = get_period_date_ranges(filters) for label in labels: work = {} work["Status"] = label - for dummy,end_date in ranges: + for dummy, end_date in ranges: period = get_period(end_date, filters) if periodic_data.get(label).get(period): work[scrub(period)] = periodic_data.get(label).get(period) @@ -113,10 +120,11 @@ def get_data(filters, columns): return data, chart_data + def get_chart_data(periodic_data, columns): labels = [d.get("label") for d in columns[1:]] - all_data, not_start, overdue, pending, completed = [], [], [] , [], [] + all_data, not_start, overdue, pending, completed = [], [], [], [], [] datasets = [] for d in labels: @@ -126,18 +134,13 @@ def get_chart_data(periodic_data, columns): pending.append(periodic_data.get("Pending").get(d)) completed.append(periodic_data.get("Completed").get(d)) - datasets.append({'name':'All Work Orders', 'values': all_data}) - datasets.append({'name':'Not Started', 'values': not_start}) - datasets.append({'name':'Overdue', 'values': overdue}) - datasets.append({'name':'Pending', 'values': pending}) - datasets.append({'name':'Completed', 'values': completed}) + datasets.append({"name": "All Work Orders", "values": all_data}) + datasets.append({"name": "Not Started", "values": not_start}) + datasets.append({"name": "Overdue", "values": overdue}) + datasets.append({"name": "Pending", "values": pending}) + datasets.append({"name": "Completed", "values": completed}) - chart = { - "data": { - 'labels': labels, - 'datasets': datasets - } - } + chart = {"data": {"labels": labels, "datasets": datasets}} chart["type"] = "line" return chart diff --git a/erpnext/manufacturing/report/production_plan_summary/production_plan_summary.py b/erpnext/manufacturing/report/production_plan_summary/production_plan_summary.py index 55b1a3f2f9a..17f7f5e51fa 100644 --- a/erpnext/manufacturing/report/production_plan_summary/production_plan_summary.py +++ b/erpnext/manufacturing/report/production_plan_summary/production_plan_summary.py @@ -13,6 +13,7 @@ def execute(filters=None): return columns, data + def get_data(filters): data = [] @@ -23,6 +24,7 @@ def get_data(filters): return data + def get_production_plan_item_details(filters, data, order_details): itemwise_indent = {} @@ -30,77 +32,85 @@ def get_production_plan_item_details(filters, data, order_details): for row in production_plan_doc.po_items: work_order = frappe.get_value( "Work Order", - { - "production_plan_item": row.name, - "bom_no": row.bom_no, - "production_item": row.item_code - }, - "name" + {"production_plan_item": row.name, "bom_no": row.bom_no, "production_item": row.item_code}, + "name", ) if row.item_code not in itemwise_indent: itemwise_indent.setdefault(row.item_code, {}) - data.append({ - "indent": 0, - "item_code": row.item_code, - "item_name": frappe.get_cached_value("Item", row.item_code, "item_name"), - "qty": row.planned_qty, - "document_type": "Work Order", - "document_name": work_order or "", - "bom_level": frappe.get_cached_value("BOM", row.bom_no, "bom_level"), - "produced_qty": order_details.get((work_order, row.item_code), {}).get("produced_qty", 0), - "pending_qty": flt(row.planned_qty) - flt(order_details.get((work_order, row.item_code), {}).get("produced_qty", 0)) - }) + data.append( + { + "indent": 0, + "item_code": row.item_code, + "item_name": frappe.get_cached_value("Item", row.item_code, "item_name"), + "qty": row.planned_qty, + "document_type": "Work Order", + "document_name": work_order or "", + "bom_level": 0, + "produced_qty": order_details.get((work_order, row.item_code), {}).get("produced_qty", 0), + "pending_qty": flt(row.planned_qty) + - flt(order_details.get((work_order, row.item_code), {}).get("produced_qty", 0)), + } + ) - get_production_plan_sub_assembly_item_details(filters, row, production_plan_doc, data, order_details) + get_production_plan_sub_assembly_item_details( + filters, row, production_plan_doc, data, order_details + ) -def get_production_plan_sub_assembly_item_details(filters, row, production_plan_doc, data, order_details): + +def get_production_plan_sub_assembly_item_details( + filters, row, production_plan_doc, data, order_details +): for item in production_plan_doc.sub_assembly_items: if row.name == item.production_plan_item: - subcontracted_item = (item.type_of_manufacturing == 'Subcontract') + subcontracted_item = item.type_of_manufacturing == "Subcontract" if subcontracted_item: docname = frappe.get_value( "Purchase Order Item", - { - "production_plan_sub_assembly_item": item.name, - "docstatus": ("<", 2) - }, - "parent" + {"production_plan_sub_assembly_item": item.name, "docstatus": ("<", 2)}, + "parent", ) else: docname = frappe.get_value( - "Work Order", - { - "production_plan_sub_assembly_item": item.name, - "docstatus": ("<", 2) - }, - "name" + "Work Order", {"production_plan_sub_assembly_item": item.name, "docstatus": ("<", 2)}, "name" ) - data.append({ - "indent": 1, - "item_code": item.production_item, - "item_name": item.item_name, - "qty": item.qty, - "document_type": "Work Order" if not subcontracted_item else "Purchase Order", - "document_name": docname or "", - "bom_level": item.bom_level, - "produced_qty": order_details.get((docname, item.production_item), {}).get("produced_qty", 0), - "pending_qty": flt(item.qty) - flt(order_details.get((docname, item.production_item), {}).get("produced_qty", 0)) - }) + data.append( + { + "indent": 1, + "item_code": item.production_item, + "item_name": item.item_name, + "qty": item.qty, + "document_type": "Work Order" if not subcontracted_item else "Purchase Order", + "document_name": docname or "", + "bom_level": item.bom_level, + "produced_qty": order_details.get((docname, item.production_item), {}).get("produced_qty", 0), + "pending_qty": flt(item.qty) + - flt(order_details.get((docname, item.production_item), {}).get("produced_qty", 0)), + } + ) + def get_work_order_details(filters, order_details): - for row in frappe.get_all("Work Order", filters = {"production_plan": filters.get("production_plan")}, - fields=["name", "produced_qty", "production_plan", "production_item"]): + for row in frappe.get_all( + "Work Order", + filters={"production_plan": filters.get("production_plan")}, + fields=["name", "produced_qty", "production_plan", "production_item"], + ): order_details.setdefault((row.name, row.production_item), row) + def get_purchase_order_details(filters, order_details): - for row in frappe.get_all("Purchase Order Item", filters = {"production_plan": filters.get("production_plan")}, - fields=["parent", "received_qty as produced_qty", "item_code"]): + for row in frappe.get_all( + "Purchase Order Item", + filters={"production_plan": filters.get("production_plan")}, + fields=["parent", "received_qty as produced_qty", "item_code"], + ): order_details.setdefault((row.parent, row.item_code), row) + def get_column(filters): return [ { @@ -108,49 +118,24 @@ def get_column(filters): "fieldtype": "Link", "fieldname": "item_code", "width": 300, - "options": "Item" - }, - { - "label": "Item Name", - "fieldtype": "data", - "fieldname": "item_name", - "width": 100 + "options": "Item", }, + {"label": "Item Name", "fieldtype": "data", "fieldname": "item_name", "width": 100}, { "label": "Document Type", "fieldtype": "Link", "fieldname": "document_type", "width": 150, - "options": "DocType" + "options": "DocType", }, { "label": "Document Name", "fieldtype": "Dynamic Link", "fieldname": "document_name", - "width": 150 + "width": 150, }, - { - "label": "BOM Level", - "fieldtype": "Int", - "fieldname": "bom_level", - "width": 100 - }, - { - "label": "Order Qty", - "fieldtype": "Float", - "fieldname": "qty", - "width": 120 - }, - { - "label": "Received Qty", - "fieldtype": "Float", - "fieldname": "produced_qty", - "width": 160 - }, - { - "label": "Pending Qty", - "fieldtype": "Float", - "fieldname": "pending_qty", - "width": 110 - } + {"label": "BOM Level", "fieldtype": "Int", "fieldname": "bom_level", "width": 100}, + {"label": "Order Qty", "fieldtype": "Float", "fieldname": "qty", "width": 120}, + {"label": "Received Qty", "fieldtype": "Float", "fieldname": "produced_qty", "width": 160}, + {"label": "Pending Qty", "fieldtype": "Float", "fieldname": "pending_qty", "width": 110}, ] diff --git a/erpnext/manufacturing/report/production_planning_report/production_planning_report.py b/erpnext/manufacturing/report/production_planning_report/production_planning_report.py index 8368db6374b..16c25ce7e6d 100644 --- a/erpnext/manufacturing/report/production_planning_report/production_planning_report.py +++ b/erpnext/manufacturing/report/production_planning_report/production_planning_report.py @@ -4,49 +4,15 @@ import frappe from frappe import _ +from pypika import Order from erpnext.stock.doctype.warehouse.warehouse import get_child_warehouses -# and bom_no is not null and bom_no !='' - -mapper = { - "Sales Order": { - "fields": """ item_code as production_item, item_name as production_item_name, stock_uom, - stock_qty as qty_to_manufacture, `tabSales Order Item`.parent as name, bom_no, warehouse, - `tabSales Order Item`.delivery_date, `tabSales Order`.base_grand_total """, - "filters": """`tabSales Order Item`.docstatus = 1 and stock_qty > produced_qty - and `tabSales Order`.per_delivered < 100.0""" - }, - "Material Request": { - "fields": """ item_code as production_item, item_name as production_item_name, stock_uom, - stock_qty as qty_to_manufacture, `tabMaterial Request Item`.parent as name, bom_no, warehouse, - `tabMaterial Request Item`.schedule_date """, - "filters": """`tabMaterial Request`.docstatus = 1 and `tabMaterial Request`.per_ordered < 100 - and `tabMaterial Request`.material_request_type = 'Manufacture' """ - }, - "Work Order": { - "fields": """ production_item, item_name as production_item_name, planned_start_date, - stock_uom, qty as qty_to_manufacture, name, bom_no, fg_warehouse as warehouse """, - "filters": "docstatus = 1 and status not in ('Completed', 'Stopped')" - }, -} - -order_mapper = { - "Sales Order": { - "Delivery Date": "`tabSales Order Item`.delivery_date asc", - "Total Amount": "`tabSales Order`.base_grand_total desc" - }, - "Material Request": { - "Required Date": "`tabMaterial Request Item`.schedule_date asc" - }, - "Work Order": { - "Planned Start Date": "planned_start_date asc" - } -} def execute(filters=None): return ProductionPlanReport(filters).execute_report() + class ProductionPlanReport(object): def __init__(self, filters=None): self.filters = frappe._dict(filters or {}) @@ -65,46 +31,102 @@ class ProductionPlanReport(object): return self.columns, self.data def get_open_orders(self): - doctype = ("`tabWork Order`" if self.filters.based_on == "Work Order" - else "`tab{doc}`, `tab{doc} Item`".format(doc=self.filters.based_on)) + doctype, order_by = self.filters.based_on, self.filters.order_by - filters = mapper.get(self.filters.based_on)["filters"] - filters = self.prepare_other_conditions(filters, self.filters.based_on) - order_by = " ORDER BY %s" % (order_mapper[self.filters.based_on][self.filters.order_by]) + parent = frappe.qb.DocType(doctype) + query = None - self.orders = frappe.db.sql(""" SELECT {fields} from {doctype} - WHERE {filters} {order_by}""".format( - doctype = doctype, - filters = filters, - order_by = order_by, - fields = mapper.get(self.filters.based_on)["fields"] - ), tuple(self.filters.docnames), as_dict=1) + if doctype == "Work Order": + query = ( + frappe.qb.from_(parent) + .select( + parent.production_item, + parent.item_name.as_("production_item_name"), + parent.planned_start_date, + parent.stock_uom, + parent.qty.as_("qty_to_manufacture"), + parent.name, + parent.bom_no, + parent.fg_warehouse.as_("warehouse"), + ) + .where(parent.status.notin(["Completed", "Stopped"])) + ) - def prepare_other_conditions(self, filters, doctype): - if self.filters.docnames: - field = "name" if doctype == "Work Order" else "`tab{} Item`.parent".format(doctype) - filters += " and %s in (%s)" % (field, ','.join(['%s'] * len(self.filters.docnames))) + if order_by == "Planned Start Date": + query = query.orderby(parent.planned_start_date, order=Order.asc) - if doctype != "Work Order": - filters += " and `tab{doc}`.name = `tab{doc} Item`.parent".format(doc=doctype) + if self.filters.docnames: + query = query.where(parent.name.isin(self.filters.docnames)) + + else: + child = frappe.qb.DocType(f"{doctype} Item") + query = ( + frappe.qb.from_(parent) + .from_(child) + .select( + child.bom_no, + child.stock_uom, + child.warehouse, + child.parent.as_("name"), + child.item_code.as_("production_item"), + child.stock_qty.as_("qty_to_manufacture"), + child.item_name.as_("production_item_name"), + ) + .where(parent.name == child.parent) + ) + + if self.filters.docnames: + query = query.where(child.parent.isin(self.filters.docnames)) + + if doctype == "Sales Order": + query = query.select( + child.delivery_date, + parent.base_grand_total, + ).where((child.stock_qty > child.produced_qty) & (parent.per_delivered < 100.0)) + + if order_by == "Delivery Date": + query = query.orderby(child.delivery_date, order=Order.asc) + elif order_by == "Total Amount": + query = query.orderby(parent.base_grand_total, order=Order.desc) + + elif doctype == "Material Request": + query = query.select(child.schedule_date,).where( + (parent.per_ordered < 100) & (parent.material_request_type == "Manufacture") + ) + + if order_by == "Required Date": + query = query.orderby(child.schedule_date, order=Order.asc) + + query = query.where(parent.docstatus == 1) if self.filters.company: - filters += " and `tab%s`.company = %s" %(doctype, frappe.db.escape(self.filters.company)) + query = query.where(parent.company == self.filters.company) - return filters + self.orders = query.run(as_dict=True) def get_raw_materials(self): - if not self.orders: return + if not self.orders: + return self.warehouses = [d.warehouse for d in self.orders] self.item_codes = [d.production_item for d in self.orders] if self.filters.based_on == "Work Order": work_orders = [d.name for d in self.orders] - raw_materials = frappe.get_all("Work Order Item", - fields=["parent", "item_code", "item_name as raw_material_name", - "source_warehouse as warehouse", "required_qty"], - filters = {"docstatus": 1, "parent": ("in", work_orders), "source_warehouse": ("!=", "")}) or [] + raw_materials = ( + frappe.get_all( + "Work Order Item", + fields=[ + "parent", + "item_code", + "item_name as raw_material_name", + "source_warehouse as warehouse", + "required_qty", + ], + filters={"docstatus": 1, "parent": ("in", work_orders), "source_warehouse": ("!=", "")}, + ) + or [] + ) self.warehouses.extend([d.source_warehouse for d in raw_materials]) else: @@ -118,21 +140,32 @@ class ProductionPlanReport(object): bom_nos.append(bom_no) - bom_doctype = ("BOM Explosion Item" - if self.filters.include_subassembly_raw_materials else "BOM Item") + bom_item_doctype = ( + "BOM Explosion Item" if self.filters.include_subassembly_raw_materials else "BOM Item" + ) - qty_field = ("qty_consumed_per_unit" - if self.filters.include_subassembly_raw_materials else "(bom_item.qty / bom.quantity)") + bom = frappe.qb.DocType("BOM") + bom_item = frappe.qb.DocType(bom_item_doctype) - raw_materials = frappe.db.sql(""" SELECT bom_item.parent, bom_item.item_code, - bom_item.item_name as raw_material_name, {0} as required_qty_per_unit - FROM - `tabBOM` as bom, `tab{1}` as bom_item - WHERE - bom_item.parent in ({2}) and bom_item.parent = bom.name and bom.docstatus = 1 - """.format(qty_field, bom_doctype, ','.join(["%s"] * len(bom_nos))), tuple(bom_nos), as_dict=1) + if self.filters.include_subassembly_raw_materials: + qty_field = bom_item.qty_consumed_per_unit + else: + qty_field = bom_item.qty / bom.quantity - if not raw_materials: return + raw_materials = ( + frappe.qb.from_(bom) + .from_(bom_item) + .select( + bom_item.parent, + bom_item.item_code, + bom_item.item_name.as_("raw_material_name"), + qty_field.as_("required_qty_per_unit"), + ) + .where((bom_item.parent.isin(bom_nos)) & (bom_item.parent == bom.name) & (bom.docstatus == 1)) + ).run(as_dict=True) + + if not raw_materials: + return self.item_codes.extend([d.item_code for d in raw_materials]) @@ -144,15 +177,20 @@ class ProductionPlanReport(object): rows.append(d) def get_item_details(self): - if not (self.orders and self.item_codes): return + if not (self.orders and self.item_codes): + return self.item_details = {} - for d in frappe.get_all("Item Default", fields = ["parent", "default_warehouse"], - filters = {"company": self.filters.company, "parent": ("in", self.item_codes)}): + for d in frappe.get_all( + "Item Default", + fields=["parent", "default_warehouse"], + filters={"company": self.filters.company, "parent": ("in", self.item_codes)}, + ): self.item_details[d.parent] = d def get_bin_details(self): - if not (self.orders and self.raw_materials_dict): return + if not (self.orders and self.raw_materials_dict): + return self.bin_details = {} self.mrp_warehouses = [] @@ -160,43 +198,55 @@ class ProductionPlanReport(object): self.mrp_warehouses.extend(get_child_warehouses(self.filters.raw_material_warehouse)) self.warehouses.extend(self.mrp_warehouses) - for d in frappe.get_all("Bin", + for d in frappe.get_all( + "Bin", fields=["warehouse", "item_code", "actual_qty", "ordered_qty", "projected_qty"], - filters = {"item_code": ("in", self.item_codes), "warehouse": ("in", self.warehouses)}): + filters={"item_code": ("in", self.item_codes), "warehouse": ("in", self.warehouses)}, + ): key = (d.item_code, d.warehouse) if key not in self.bin_details: self.bin_details.setdefault(key, d) def get_purchase_details(self): - if not (self.orders and self.raw_materials_dict): return + if not (self.orders and self.raw_materials_dict): + return self.purchase_details = {} - for d in frappe.get_all("Purchase Order Item", + purchased_items = frappe.get_all( + "Purchase Order Item", fields=["item_code", "min(schedule_date) as arrival_date", "qty as arrival_qty", "warehouse"], - filters = {"item_code": ("in", self.item_codes), "warehouse": ("in", self.warehouses)}, - group_by = "item_code, warehouse"): + filters={ + "item_code": ("in", self.item_codes), + "warehouse": ("in", self.warehouses), + "docstatus": 1, + }, + group_by="item_code, warehouse", + ) + for d in purchased_items: key = (d.item_code, d.warehouse) if key not in self.purchase_details: self.purchase_details.setdefault(key, d) def prepare_data(self): - if not self.orders: return + if not self.orders: + return for d in self.orders: key = d.name if self.filters.based_on == "Work Order" else d.bom_no - if not self.raw_materials_dict.get(key): continue + if not self.raw_materials_dict.get(key): + continue bin_data = self.bin_details.get((d.production_item, d.warehouse)) or {} - d.update({ - "for_warehouse": d.warehouse, - "available_qty": 0 - }) + d.update({"for_warehouse": d.warehouse, "available_qty": 0}) if bin_data and bin_data.get("actual_qty") > 0 and d.qty_to_manufacture: - d.available_qty = (bin_data.get("actual_qty") - if (d.qty_to_manufacture > bin_data.get("actual_qty")) else d.qty_to_manufacture) + d.available_qty = ( + bin_data.get("actual_qty") + if (d.qty_to_manufacture > bin_data.get("actual_qty")) + else d.qty_to_manufacture + ) bin_data["actual_qty"] -= d.available_qty @@ -227,8 +277,9 @@ class ProductionPlanReport(object): d.remaining_qty = d.required_qty self.pick_materials_from_warehouses(d, data, warehouses) - if (d.remaining_qty and self.filters.raw_material_warehouse - and d.remaining_qty != d.required_qty): + if ( + d.remaining_qty and self.filters.raw_material_warehouse and d.remaining_qty != d.required_qty + ): row = self.get_args() d.warehouse = self.filters.raw_material_warehouse d.required_qty = d.remaining_qty @@ -238,7 +289,8 @@ class ProductionPlanReport(object): def pick_materials_from_warehouses(self, args, order_data, warehouses): for index, warehouse in enumerate(warehouses): - if not args.remaining_qty: return + if not args.remaining_qty: + return row = self.get_args() @@ -250,14 +302,18 @@ class ProductionPlanReport(object): args.allotted_qty = 0 if bin_data and bin_data.get("actual_qty") > 0: - args.allotted_qty = (bin_data.get("actual_qty") - if (args.required_qty > bin_data.get("actual_qty")) else args.required_qty) + args.allotted_qty = ( + bin_data.get("actual_qty") + if (args.required_qty > bin_data.get("actual_qty")) + else args.required_qty + ) args.remaining_qty -= args.allotted_qty bin_data["actual_qty"] -= args.allotted_qty - if ((self.mrp_warehouses and (args.allotted_qty or index == len(warehouses) - 1)) - or not self.mrp_warehouses): + if ( + self.mrp_warehouses and (args.allotted_qty or index == len(warehouses) - 1) + ) or not self.mrp_warehouses: if not self.index: row.update(order_data) self.index += 1 @@ -270,52 +326,45 @@ class ProductionPlanReport(object): self.data.append(row) def get_args(self): - return frappe._dict({ - "work_order": "", - "sales_order": "", - "production_item": "", - "production_item_name": "", - "qty_to_manufacture": "", - "produced_qty": "" - }) + return frappe._dict( + { + "work_order": "", + "sales_order": "", + "production_item": "", + "production_item_name": "", + "qty_to_manufacture": "", + "produced_qty": "", + } + ) def get_columns(self): based_on = self.filters.based_on - self.columns = [{ - "label": _("ID"), - "options": based_on, - "fieldname": "name", - "fieldtype": "Link", - "width": 100 - }, { - "label": _("Item Code"), - "fieldname": "production_item", - "fieldtype": "Link", - "options": "Item", - "width": 120 - }, { - "label": _("Item Name"), - "fieldname": "production_item_name", - "fieldtype": "Data", - "width": 130 - }, { - "label": _("Warehouse"), - "options": "Warehouse", - "fieldname": "for_warehouse", - "fieldtype": "Link", - "width": 100 - }, { - "label": _("Order Qty"), - "fieldname": "qty_to_manufacture", - "fieldtype": "Float", - "width": 80 - }, { - "label": _("Available"), - "fieldname": "available_qty", - "fieldtype": "Float", - "width": 80 - }] + self.columns = [ + {"label": _("ID"), "options": based_on, "fieldname": "name", "fieldtype": "Link", "width": 100}, + { + "label": _("Item Code"), + "fieldname": "production_item", + "fieldtype": "Link", + "options": "Item", + "width": 120, + }, + { + "label": _("Item Name"), + "fieldname": "production_item_name", + "fieldtype": "Data", + "width": 130, + }, + { + "label": _("Warehouse"), + "options": "Warehouse", + "fieldname": "for_warehouse", + "fieldtype": "Link", + "width": 100, + }, + {"label": _("Order Qty"), "fieldname": "qty_to_manufacture", "fieldtype": "Float", "width": 80}, + {"label": _("Available"), "fieldname": "available_qty", "fieldtype": "Float", "width": 80}, + ] fieldname, fieldtype = "delivery_date", "Date" if self.filters.based_on == "Sales Order" and self.filters.order_by == "Total Amount": @@ -325,48 +374,50 @@ class ProductionPlanReport(object): elif self.filters.based_on == "Work Order": fieldname = "planned_start_date" - self.columns.append({ - "label": _(self.filters.order_by), - "fieldname": fieldname, - "fieldtype": fieldtype, - "width": 100 - }) + self.columns.append( + { + "label": _(self.filters.order_by), + "fieldname": fieldname, + "fieldtype": fieldtype, + "width": 100, + } + ) - self.columns.extend([{ - "label": _("Raw Material Code"), - "fieldname": "item_code", - "fieldtype": "Link", - "options": "Item", - "width": 120 - }, { - "label": _("Raw Material Name"), - "fieldname": "raw_material_name", - "fieldtype": "Data", - "width": 130 - }, { - "label": _("Warehouse"), - "options": "Warehouse", - "fieldname": "warehouse", - "fieldtype": "Link", - "width": 110 - }, { - "label": _("Required Qty"), - "fieldname": "required_qty", - "fieldtype": "Float", - "width": 100 - }, { - "label": _("Allotted Qty"), - "fieldname": "allotted_qty", - "fieldtype": "Float", - "width": 100 - }, { - "label": _("Expected Arrival Date"), - "fieldname": "arrival_date", - "fieldtype": "Date", - "width": 160 - }, { - "label": _("Arrival Quantity"), - "fieldname": "arrival_qty", - "fieldtype": "Float", - "width": 140 - }]) + self.columns.extend( + [ + { + "label": _("Raw Material Code"), + "fieldname": "item_code", + "fieldtype": "Link", + "options": "Item", + "width": 120, + }, + { + "label": _("Raw Material Name"), + "fieldname": "raw_material_name", + "fieldtype": "Data", + "width": 130, + }, + { + "label": _("Warehouse"), + "options": "Warehouse", + "fieldname": "warehouse", + "fieldtype": "Link", + "width": 110, + }, + {"label": _("Required Qty"), "fieldname": "required_qty", "fieldtype": "Float", "width": 100}, + {"label": _("Allotted Qty"), "fieldname": "allotted_qty", "fieldtype": "Float", "width": 100}, + { + "label": _("Expected Arrival Date"), + "fieldname": "arrival_date", + "fieldtype": "Date", + "width": 160, + }, + { + "label": _("Arrival Quantity"), + "fieldname": "arrival_qty", + "fieldtype": "Float", + "width": 140, + }, + ] + ) diff --git a/erpnext/manufacturing/report/quality_inspection_summary/quality_inspection_summary.py b/erpnext/manufacturing/report/quality_inspection_summary/quality_inspection_summary.py index a0c4a43e90f..de96a6c0323 100644 --- a/erpnext/manufacturing/report/quality_inspection_summary/quality_inspection_summary.py +++ b/erpnext/manufacturing/report/quality_inspection_summary/quality_inspection_summary.py @@ -11,51 +11,58 @@ def execute(filters=None): data = get_data(filters) columns = get_columns(filters) chart_data = get_chart_data(data, filters) - return columns, data , None, chart_data + return columns, data, None, chart_data + def get_data(filters): query_filters = {"docstatus": ("<", 2)} - fields = ["name", "status", "report_date", "item_code", "item_name", "sample_size", - "inspection_type", "reference_type", "reference_name", "inspected_by"] + fields = [ + "name", + "status", + "report_date", + "item_code", + "item_name", + "sample_size", + "inspection_type", + "reference_type", + "reference_name", + "inspected_by", + ] for field in ["status", "item_code", "status", "inspected_by"]: if filters.get(field): query_filters[field] = ("in", filters.get(field)) - query_filters["report_date"] = (">=", filters.get("from_date")) - query_filters["report_date"] = ("<=", filters.get("to_date")) + query_filters["report_date"] = ["between", [filters.get("from_date"), filters.get("to_date")]] + + return frappe.get_all( + "Quality Inspection", fields=fields, filters=query_filters, order_by="report_date asc" + ) - return frappe.get_all("Quality Inspection", - fields= fields, filters=query_filters, order_by="report_date asc") def get_chart_data(periodic_data, columns): labels = ["Rejected", "Accepted"] - status_wise_data = { - "Accepted": 0, - "Rejected": 0 - } + status_wise_data = {"Accepted": 0, "Rejected": 0} datasets = [] for d in periodic_data: status_wise_data[d.status] += 1 - datasets.append({'name':'Qty Wise Chart', - 'values': [status_wise_data.get("Rejected"), status_wise_data.get("Accepted")]}) + datasets.append( + { + "name": "Qty Wise Chart", + "values": [status_wise_data.get("Rejected"), status_wise_data.get("Accepted")], + } + ) - chart = { - "data": { - 'labels': labels, - 'datasets': datasets - }, - "type": "donut", - "height": 300 - } + chart = {"data": {"labels": labels, "datasets": datasets}, "type": "donut", "height": 300} return chart + def get_columns(filters): columns = [ { @@ -63,71 +70,49 @@ def get_columns(filters): "fieldname": "name", "fieldtype": "Link", "options": "Work Order", - "width": 100 + "width": 100, }, - { - "label": _("Report Date"), - "fieldname": "report_date", - "fieldtype": "Date", - "width": 150 - } + {"label": _("Report Date"), "fieldname": "report_date", "fieldtype": "Date", "width": 150}, ] if not filters.get("status"): columns.append( - { - "label": _("Status"), - "fieldname": "status", - "width": 100 - }, + {"label": _("Status"), "fieldname": "status", "width": 100}, ) - columns.extend([ - { - "label": _("Item Code"), - "fieldname": "item_code", - "fieldtype": "Link", - "options": "Item", - "width": 130 - }, - { - "label": _("Item Name"), - "fieldname": "item_name", - "fieldtype": "Data", - "width": 130 - }, - { - "label": _("Sample Size"), - "fieldname": "sample_size", - "fieldtype": "Float", - "width": 110 - }, - { - "label": _("Inspection Type"), - "fieldname": "inspection_type", - "fieldtype": "Data", - "width": 110 - }, - { - "label": _("Document Type"), - "fieldname": "reference_type", - "fieldtype": "Data", - "width": 90 - }, - { - "label": _("Document Name"), - "fieldname": "reference_name", - "fieldtype": "Dynamic Link", - "options": "reference_type", - "width": 150 - }, - { - "label": _("Inspected By"), - "fieldname": "inspected_by", - "fieldtype": "Link", - "options": "User", - "width": 150 - } - ]) + columns.extend( + [ + { + "label": _("Item Code"), + "fieldname": "item_code", + "fieldtype": "Link", + "options": "Item", + "width": 130, + }, + {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 130}, + {"label": _("Sample Size"), "fieldname": "sample_size", "fieldtype": "Float", "width": 110}, + { + "label": _("Inspection Type"), + "fieldname": "inspection_type", + "fieldtype": "Data", + "width": 110, + }, + {"label": _("Document Type"), "fieldname": "reference_type", "fieldtype": "Data", "width": 90}, + { + "label": _("Document Name"), + "fieldname": "reference_name", + "fieldtype": "Dynamic Link", + "options": "reference_type", + "width": 150, + }, + { + "label": _("Inspected By"), + "fieldname": "inspected_by", + "fieldtype": "Link", + "options": "User", + "width": 150, + }, + ] + ) return columns diff --git a/erpnext/manufacturing/report/test_reports.py b/erpnext/manufacturing/report/test_reports.py index 1de472659eb..9f51ded6c77 100644 --- a/erpnext/manufacturing/report/test_reports.py +++ b/erpnext/manufacturing/report/test_reports.py @@ -18,7 +18,7 @@ REPORT_FILTER_TEST_CASES: List[Tuple[ReportName, ReportFilters]] = [ ("BOM Operations Time", {}), ("BOM Stock Calculated", {"bom": frappe.get_last_doc("BOM").name, "qty_to_make": 2}), ("BOM Stock Report", {"bom": frappe.get_last_doc("BOM").name, "qty_to_produce": 2}), - ("Cost of Poor Quality Report", {}), + ("Cost of Poor Quality Report", {"item": "_Test Item", "serial_no": "00"}), ("Downtime Analysis", {}), ( "Exponential Smoothing Forecasting", diff --git a/erpnext/manufacturing/report/work_order_stock_report/work_order_stock_report.py b/erpnext/manufacturing/report/work_order_stock_report/work_order_stock_report.py index db0b239ae20..d2e3e4081c2 100644 --- a/erpnext/manufacturing/report/work_order_stock_report/work_order_stock_report.py +++ b/erpnext/manufacturing/report/work_order_stock_report/work_order_stock_report.py @@ -3,6 +3,7 @@ import frappe +from frappe.query_builder.functions import IfNull from frappe.utils import cint @@ -12,139 +13,150 @@ def execute(filters=None): columns = get_columns() return columns, data + def get_item_list(wo_list, filters): out = [] - #Add a row for each item/qty - for wo_details in wo_list: - desc = frappe.db.get_value("BOM", wo_details.bom_no, "description") + if wo_list: + bin = frappe.qb.DocType("Bin") + bom = frappe.qb.DocType("BOM") + bom_item = frappe.qb.DocType("BOM Item") - for wo_item_details in frappe.db.get_values("Work Order Item", - {"parent": wo_details.name}, ["item_code", "source_warehouse"], as_dict=1): + # Add a row for each item/qty + for wo_details in wo_list: + desc = frappe.db.get_value("BOM", wo_details.bom_no, "description") - item_list = frappe.db.sql("""SELECT - bom_item.item_code as item_code, - ifnull(ledger.actual_qty*bom.quantity/bom_item.stock_qty,0) as build_qty - FROM - `tabBOM` as bom, `tabBOM Item` AS bom_item - LEFT JOIN `tabBin` AS ledger - ON bom_item.item_code = ledger.item_code - AND ledger.warehouse = ifnull(%(warehouse)s,%(filterhouse)s) - WHERE - bom.name = bom_item.parent - and bom_item.item_code = %(item_code)s - and bom.name = %(bom)s - GROUP BY - bom_item.item_code""", - {"bom": wo_details.bom_no, "warehouse": wo_item_details.source_warehouse, - "filterhouse": filters.warehouse, "item_code": wo_item_details.item_code}, as_dict=1) + for wo_item_details in frappe.db.get_values( + "Work Order Item", {"parent": wo_details.name}, ["item_code", "source_warehouse"], as_dict=1 + ): + item_list = ( + frappe.qb.from_(bom) + .from_(bom_item) + .left_join(bin) + .on( + (bom_item.item_code == bin.item_code) + & (bin.warehouse == IfNull(wo_item_details.source_warehouse, filters.warehouse)) + ) + .select( + bom_item.item_code.as_("item_code"), + IfNull(bin.actual_qty * bom.quantity / bom_item.stock_qty, 0).as_("build_qty"), + ) + .where( + (bom.name == bom_item.parent) + & (bom_item.item_code == wo_item_details.item_code) + & (bom.name == wo_details.bom_no) + ) + .groupby(bom_item.item_code) + ).run(as_dict=1) - stock_qty = 0 - count = 0 - buildable_qty = wo_details.qty - for item in item_list: - count = count + 1 - if item.build_qty >= (wo_details.qty - wo_details.produced_qty): - stock_qty = stock_qty + 1 - elif buildable_qty >= item.build_qty: - buildable_qty = item.build_qty + stock_qty = 0 + count = 0 + buildable_qty = wo_details.qty + for item in item_list: + count = count + 1 + if item.build_qty >= (wo_details.qty - wo_details.produced_qty): + stock_qty = stock_qty + 1 + elif buildable_qty >= item.build_qty: + buildable_qty = item.build_qty - if count == stock_qty: - build = "Y" - else: - build = "N" + if count == stock_qty: + build = "Y" + else: + build = "N" - row = frappe._dict({ - "work_order": wo_details.name, - "status": wo_details.status, - "req_items": cint(count), - "instock": stock_qty, - "description": desc, - "source_warehouse": wo_item_details.source_warehouse, - "item_code": wo_item_details.item_code, - "bom_no": wo_details.bom_no, - "qty": wo_details.qty, - "buildable_qty": buildable_qty, - "ready_to_build": build - }) + row = frappe._dict( + { + "work_order": wo_details.name, + "status": wo_details.status, + "req_items": cint(count), + "instock": stock_qty, + "description": desc, + "source_warehouse": wo_item_details.source_warehouse, + "item_code": wo_item_details.item_code, + "bom_no": wo_details.bom_no, + "qty": wo_details.qty, + "buildable_qty": buildable_qty, + "ready_to_build": build, + } + ) - out.append(row) + out.append(row) return out + def get_work_orders(): - out = frappe.get_all("Work Order", filters={"docstatus": 1, "status": ( "!=","Completed")}, - fields=["name","status", "bom_no", "qty", "produced_qty"], order_by='name') + out = frappe.get_all( + "Work Order", + filters={"docstatus": 1, "status": ("!=", "Completed")}, + fields=["name", "status", "bom_no", "qty", "produced_qty"], + order_by="name", + ) return out + def get_columns(): - columns = [{ - "fieldname": "work_order", - "label": "Work Order", - "fieldtype": "Link", - "options": "Work Order", - "width": 110 - }, { - "fieldname": "bom_no", - "label": "BOM", - "fieldtype": "Link", - "options": "BOM", - "width": 120 - }, { - "fieldname": "description", - "label": "Description", - "fieldtype": "Data", - "options": "", - "width": 230 - }, { - "fieldname": "item_code", - "label": "Item Code", - "fieldtype": "Link", - "options": "Item", - "width": 110 - },{ - "fieldname": "source_warehouse", - "label": "Source Warehouse", - "fieldtype": "Link", - "options": "Warehouse", - "width": 110 - },{ - "fieldname": "qty", - "label": "Qty to Build", - "fieldtype": "Data", - "options": "", - "width": 110 - }, { - "fieldname": "status", - "label": "Status", - "fieldtype": "Data", - "options": "", - "width": 100 - }, { - "fieldname": "req_items", - "label": "# Req'd Items", - "fieldtype": "Data", - "options": "", - "width": 105 - }, { - "fieldname": "instock", - "label": "# In Stock", - "fieldtype": "Data", - "options": "", - "width": 105 - }, { - "fieldname": "buildable_qty", - "label": "Buildable Qty", - "fieldtype": "Data", - "options": "", - "width": 100 - }, { - "fieldname": "ready_to_build", - "label": "Build All?", - "fieldtype": "Data", - "options": "", - "width": 90 - }] + columns = [ + { + "fieldname": "work_order", + "label": "Work Order", + "fieldtype": "Link", + "options": "Work Order", + "width": 110, + }, + {"fieldname": "bom_no", "label": "BOM", "fieldtype": "Link", "options": "BOM", "width": 120}, + { + "fieldname": "description", + "label": "Description", + "fieldtype": "Data", + "options": "", + "width": 230, + }, + { + "fieldname": "item_code", + "label": "Item Code", + "fieldtype": "Link", + "options": "Item", + "width": 110, + }, + { + "fieldname": "source_warehouse", + "label": "Source Warehouse", + "fieldtype": "Link", + "options": "Warehouse", + "width": 110, + }, + {"fieldname": "qty", "label": "Qty to Build", "fieldtype": "Data", "options": "", "width": 110}, + {"fieldname": "status", "label": "Status", "fieldtype": "Data", "options": "", "width": 100}, + { + "fieldname": "req_items", + "label": "# Req'd Items", + "fieldtype": "Data", + "options": "", + "width": 105, + }, + { + "fieldname": "instock", + "label": "# In Stock", + "fieldtype": "Data", + "options": "", + "width": 105, + }, + { + "fieldname": "buildable_qty", + "label": "Buildable Qty", + "fieldtype": "Data", + "options": "", + "width": 100, + }, + { + "fieldname": "ready_to_build", + "label": "Build All?", + "fieldtype": "Data", + "options": "", + "width": 90, + }, + ] return columns diff --git a/erpnext/manufacturing/report/work_order_summary/work_order_summary.py b/erpnext/manufacturing/report/work_order_summary/work_order_summary.py index d7469ddfdd6..2368bfdf2c6 100644 --- a/erpnext/manufacturing/report/work_order_summary/work_order_summary.py +++ b/erpnext/manufacturing/report/work_order_summary/work_order_summary.py @@ -21,11 +21,23 @@ def execute(filters=None): chart_data = get_chart_data(data, filters) return columns, data, None, chart_data + def get_data(filters): query_filters = {"docstatus": ("<", 2)} - fields = ["name", "status", "sales_order", "production_item", "qty", "produced_qty", - "planned_start_date", "planned_end_date", "actual_start_date", "actual_end_date", "lead_time"] + fields = [ + "name", + "status", + "sales_order", + "production_item", + "qty", + "produced_qty", + "planned_start_date", + "planned_end_date", + "actual_start_date", + "actual_end_date", + "lead_time", + ] for field in ["sales_order", "production_item", "status", "company"]: if filters.get(field): @@ -34,15 +46,16 @@ def get_data(filters): query_filters["planned_start_date"] = (">=", filters.get("from_date")) query_filters["planned_end_date"] = ("<=", filters.get("to_date")) - data = frappe.get_all("Work Order", - fields= fields, filters=query_filters, order_by="planned_start_date asc") + data = frappe.get_all( + "Work Order", fields=fields, filters=query_filters, order_by="planned_start_date asc" + ) res = [] for d in data: start_date = d.actual_start_date or d.planned_start_date d.age = 0 - if d.status != 'Completed': + if d.status != "Completed": d.age = date_diff(today(), start_date) if filters.get("age") <= d.age: @@ -50,6 +63,7 @@ def get_data(filters): return res + def get_chart_data(data, filters): if filters.get("charts_based_on") == "Status": return get_chart_based_on_status(data) @@ -58,6 +72,7 @@ def get_chart_data(data, filters): else: return get_chart_based_on_qty(data, filters) + def get_chart_based_on_status(data): labels = frappe.get_meta("Work Order").get_options("status").split("\n") if "" in labels: @@ -71,25 +86,18 @@ def get_chart_based_on_status(data): values = [status_wise_data[label] for label in labels] chart = { - "data": { - 'labels': labels, - 'datasets': [{'name':'Qty Wise Chart', 'values': values}] - }, + "data": {"labels": labels, "datasets": [{"name": "Qty Wise Chart", "values": values}]}, "type": "donut", - "height": 300 + "height": 300, } return chart + def get_chart_based_on_age(data): labels = ["0-30 Days", "30-60 Days", "60-90 Days", "90 Above"] - age_wise_data = { - "0-30 Days": 0, - "30-60 Days": 0, - "60-90 Days": 0, - "90 Above": 0 - } + age_wise_data = {"0-30 Days": 0, "30-60 Days": 0, "60-90 Days": 0, "90 Above": 0} for d in data: if d.age > 0 and d.age <= 30: @@ -101,20 +109,22 @@ def get_chart_based_on_age(data): else: age_wise_data["90 Above"] += 1 - values = [age_wise_data["0-30 Days"], age_wise_data["30-60 Days"], - age_wise_data["60-90 Days"], age_wise_data["90 Above"]] + values = [ + age_wise_data["0-30 Days"], + age_wise_data["30-60 Days"], + age_wise_data["60-90 Days"], + age_wise_data["90 Above"], + ] chart = { - "data": { - 'labels': labels, - 'datasets': [{'name':'Qty Wise Chart', 'values': values}] - }, + "data": {"labels": labels, "datasets": [{"name": "Qty Wise Chart", "values": values}]}, "type": "donut", - "height": 300 + "height": 300, } return chart + def get_chart_based_on_qty(data, filters): labels, periodic_data = prepare_chart_data(data, filters) @@ -129,25 +139,18 @@ def get_chart_based_on_qty(data, filters): datasets.append({"name": "Completed", "values": completed}) chart = { - "data": { - 'labels': labels, - 'datasets': datasets - }, + "data": {"labels": labels, "datasets": datasets}, "type": "bar", - "barOptions": { - "stacked": 1 - } + "barOptions": {"stacked": 1}, } return chart + def prepare_chart_data(data, filters): labels = [] - periodic_data = { - "Pending": {}, - "Completed": {} - } + periodic_data = {"Pending": {}, "Completed": {}} filters.range = "Monthly" @@ -165,11 +168,12 @@ def prepare_chart_data(data, filters): for d in data: if getdate(d.planned_start_date) >= from_date and getdate(d.planned_start_date) <= end_date: - periodic_data["Pending"][period] += (flt(d.qty) - flt(d.produced_qty)) + periodic_data["Pending"][period] += flt(d.qty) - flt(d.produced_qty) periodic_data["Completed"][period] += flt(d.produced_qty) return labels, periodic_data + def get_columns(filters): columns = [ { @@ -177,90 +181,77 @@ def get_columns(filters): "fieldname": "name", "fieldtype": "Link", "options": "Work Order", - "width": 100 + "width": 100, }, ] if not filters.get("status"): columns.append( - { - "label": _("Status"), - "fieldname": "status", - "width": 100 - }, + {"label": _("Status"), "fieldname": "status", "width": 100}, ) - columns.extend([ - { - "label": _("Production Item"), - "fieldname": "production_item", - "fieldtype": "Link", - "options": "Item", - "width": 130 - }, - { - "label": _("Produce Qty"), - "fieldname": "qty", - "fieldtype": "Float", - "width": 110 - }, - { - "label": _("Produced Qty"), - "fieldname": "produced_qty", - "fieldtype": "Float", - "width": 110 - }, - { - "label": _("Sales Order"), - "fieldname": "sales_order", - "fieldtype": "Link", - "options": "Sales Order", - "width": 90 - }, - { - "label": _("Planned Start Date"), - "fieldname": "planned_start_date", - "fieldtype": "Date", - "width": 150 - }, - { - "label": _("Planned End Date"), - "fieldname": "planned_end_date", - "fieldtype": "Date", - "width": 150 - } - ]) - - if filters.get("status") != 'Not Started': - columns.extend([ + columns.extend( + [ { - "label": _("Actual Start Date"), - "fieldname": "actual_start_date", + "label": _("Production Item"), + "fieldname": "production_item", + "fieldtype": "Link", + "options": "Item", + "width": 130, + }, + {"label": _("Produce Qty"), "fieldname": "qty", "fieldtype": "Float", "width": 110}, + {"label": _("Produced Qty"), "fieldname": "produced_qty", "fieldtype": "Float", "width": 110}, + { + "label": _("Sales Order"), + "fieldname": "sales_order", + "fieldtype": "Link", + "options": "Sales Order", + "width": 90, + }, + { + "label": _("Planned Start Date"), + "fieldname": "planned_start_date", "fieldtype": "Date", - "width": 100 + "width": 150, }, { - "label": _("Actual End Date"), - "fieldname": "actual_end_date", + "label": _("Planned End Date"), + "fieldname": "planned_end_date", "fieldtype": "Date", - "width": 100 + "width": 150, }, - { - "label": _("Age"), - "fieldname": "age", - "fieldtype": "Float", - "width": 110 - }, - ]) + ] + ) - if filters.get("status") == 'Completed': - columns.extend([ - { - "label": _("Lead Time (in mins)"), - "fieldname": "lead_time", - "fieldtype": "Float", - "width": 110 - }, - ]) + if filters.get("status") != "Not Started": + columns.extend( + [ + { + "label": _("Actual Start Date"), + "fieldname": "actual_start_date", + "fieldtype": "Date", + "width": 100, + }, + { + "label": _("Actual End Date"), + "fieldname": "actual_end_date", + "fieldtype": "Date", + "width": 100, + }, + {"label": _("Age"), "fieldname": "age", "fieldtype": "Float", "width": 110}, + ] + ) + + if filters.get("status") == "Completed": + columns.extend( + [ + { + "label": _("Lead Time (in mins)"), + "fieldname": "lead_time", + "fieldtype": "Float", + "width": 110, + }, + ] + ) return columns diff --git a/erpnext/non_profit/doctype/chapter/chapter.py b/erpnext/non_profit/doctype/chapter/chapter.py index c01b1ef3e42..ae2f75824d4 100644 --- a/erpnext/non_profit/doctype/chapter/chapter.py +++ b/erpnext/non_profit/doctype/chapter/chapter.py @@ -8,22 +8,21 @@ from frappe.website.website_generator import WebsiteGenerator class Chapter(WebsiteGenerator): _website = frappe._dict( - condition_field = "published", + condition_field="published", ) def get_context(self, context): context.no_cache = True context.show_sidebar = True - context.parents = [dict(label='View All Chapters', - route='chapters', title='View Chapters')] + context.parents = [dict(label="View All Chapters", route="chapters", title="View Chapters")] def validate(self): - if not self.route: #pylint: disable=E0203 - self.route = 'chapters/' + self.scrub(self.name) + if not self.route: # pylint: disable=E0203 + self.route = "chapters/" + self.scrub(self.name) def enable(self): - chapter = frappe.get_doc('Chapter', frappe.form_dict.name) - chapter.append('members', dict(enable=self.value)) + chapter = frappe.get_doc("Chapter", frappe.form_dict.name) + chapter.append("members", dict(enable=self.value)) chapter.save(ignore_permissions=1) frappe.db.commit() @@ -32,9 +31,9 @@ def get_list_context(context): context.allow_guest = True context.no_cache = True context.show_sidebar = True - context.title = 'All Chapters' + context.title = "All Chapters" context.no_breadcrumbs = True - context.order_by = 'creation desc' + context.order_by = "creation desc" @frappe.whitelist() diff --git a/erpnext/non_profit/doctype/donation/donation.json b/erpnext/non_profit/doctype/donation/donation.json index 6759569d54d..d2bcd17a20e 100644 --- a/erpnext/non_profit/doctype/donation/donation.json +++ b/erpnext/non_profit/doctype/donation/donation.json @@ -17,7 +17,8 @@ "paid", "amount", "mode_of_payment", - "razorpay_payment_id", + "column_break_12", + "payment_id", "amended_from" ], "fields": [ @@ -73,12 +74,6 @@ "label": "Mode of Payment", "options": "Mode of Payment" }, - { - "fieldname": "razorpay_payment_id", - "fieldtype": "Data", - "label": "Razorpay Payment ID", - "read_only": 1 - }, { "fieldname": "naming_series", "fieldtype": "Select", @@ -108,12 +103,21 @@ "options": "Donation", "print_hide": 1, "read_only": 1 + }, + { + "fieldname": "payment_id", + "fieldtype": "Data", + "label": "Payment ID" + }, + { + "fieldname": "column_break_12", + "fieldtype": "Column Break" } ], "index_web_pages_for_search": 1, "is_submittable": 1, "links": [], - "modified": "2021-03-11 10:53:11.269005", + "modified": "2022-03-16 17:18:45.611741", "modified_by": "Administrator", "module": "Non Profit", "name": "Donation", diff --git a/erpnext/non_profit/doctype/donation/donation.py b/erpnext/non_profit/doctype/donation/donation.py index 617979ef745..ed4b3d05b3f 100644 --- a/erpnext/non_profit/doctype/donation/donation.py +++ b/erpnext/non_profit/doctype/donation/donation.py @@ -16,28 +16,30 @@ from erpnext.non_profit.doctype.membership.membership import verify_signature class Donation(Document): def validate(self): - if not self.donor or not frappe.db.exists('Donor', self.donor): + if not self.donor or not frappe.db.exists("Donor", self.donor): # for web forms - user_type = frappe.db.get_value('User', frappe.session.user, 'user_type') - if user_type == 'Website User': + user_type = frappe.db.get_value("User", frappe.session.user, "user_type") + if user_type == "Website User": self.create_donor_for_website_user() else: - frappe.throw(_('Please select a Member')) + frappe.throw(_("Please select a Member")) def create_donor_for_website_user(self): - donor_name = frappe.get_value('Donor', dict(email=frappe.session.user)) + donor_name = frappe.get_value("Donor", dict(email=frappe.session.user)) if not donor_name: - user = frappe.get_doc('User', frappe.session.user) - donor = frappe.get_doc(dict( - doctype='Donor', - donor_type=self.get('donor_type'), - email=frappe.session.user, - member_name=user.get_fullname() - )).insert(ignore_permissions=True) + user = frappe.get_doc("User", frappe.session.user) + donor = frappe.get_doc( + dict( + doctype="Donor", + donor_type=self.get("donor_type"), + email=frappe.session.user, + member_name=user.get_fullname(), + ) + ).insert(ignore_permissions=True) donor_name = donor.name - if self.get('__islocal'): + if self.get("__islocal"): self.donor = donor_name def on_payment_authorized(self, *args, **kwargs): @@ -45,13 +47,16 @@ class Donation(Document): self.create_payment_entry() def create_payment_entry(self, date=None): - settings = frappe.get_doc('Non Profit Settings') + settings = frappe.get_doc("Non Profit Settings") if not settings.automate_donation_payment_entries: return if not settings.donation_payment_account: - frappe.throw(_('You need to set Payment Account for Donation in {0}').format( - get_link_to_form('Non Profit Settings', 'Non Profit Settings'))) + frappe.throw( + _("You need to set Payment Account for Donation in {0}").format( + get_link_to_form("Non Profit Settings", "Non Profit Settings") + ) + ) from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry @@ -71,77 +76,79 @@ class Donation(Document): @frappe.whitelist(allow_guest=True) def capture_razorpay_donations(*args, **kwargs): """ - Creates Donation from Razorpay Webhook Request Data on payment.captured event - Creates Donor from email if not found + Creates Donation from Razorpay Webhook Request Data on payment.captured event + Creates Donor from email if not found """ data = frappe.request.get_data(as_text=True) try: - verify_signature(data, endpoint='Donation') + verify_signature(data, endpoint="Donation") except Exception as e: - log = frappe.log_error(e, 'Donation Webhook Verification Error') + log = frappe.log_error(e, "Donation Webhook Verification Error") notify_failure(log) - return { 'status': 'Failed', 'reason': e } + return {"status": "Failed", "reason": e} if isinstance(data, six.string_types): data = json.loads(data) data = frappe._dict(data) - payment = data.payload.get('payment', {}).get('entity', {}) + payment = data.payload.get("payment", {}).get("entity", {}) payment = frappe._dict(payment) try: - if not data.event == 'payment.captured': + if not data.event == "payment.captured": return # to avoid capturing subscription payments as donations - if payment.description and 'subscription' in str(payment.description).lower(): + if payment.invoice_id or ( + payment.description and "subscription" in str(payment.description).lower() + ): return donor = get_donor(payment.email) if not donor: donor = create_donor(payment) - donation = create_donation(donor, payment) - donation.run_method('create_payment_entry') + donation = create_razorpay_donation(donor, payment) + donation.run_method("create_payment_entry") except Exception as e: - message = '{0}\n\n{1}\n\n{2}: {3}'.format(e, frappe.get_traceback(), _('Payment ID'), payment.id) - log = frappe.log_error(message, _('Error creating donation entry for {0}').format(donor.name)) + message = "{0}\n\n{1}\n\n{2}: {3}".format(e, frappe.get_traceback(), _("Payment ID"), payment.id) + log = frappe.log_error(message, _("Error creating donation entry for {0}").format(donor.name)) notify_failure(log) - return { 'status': 'Failed', 'reason': e } + return {"status": "Failed", "reason": e} - return { 'status': 'Success' } + return {"status": "Success"} -def create_donation(donor, payment): - if not frappe.db.exists('Mode of Payment', payment.method): +def create_razorpay_donation(donor, payment): + if not frappe.db.exists("Mode of Payment", payment.method): create_mode_of_payment(payment.method) company = get_company_for_donations() - donation = frappe.get_doc({ - 'doctype': 'Donation', - 'company': company, - 'donor': donor.name, - 'donor_name': donor.donor_name, - 'email': donor.email, - 'date': getdate(), - 'amount': flt(payment.amount) / 100, # Convert to rupees from paise - 'mode_of_payment': payment.method, - 'razorpay_payment_id': payment.id - }).insert(ignore_mandatory=True) + donation = frappe.get_doc( + { + "doctype": "Donation", + "company": company, + "donor": donor.name, + "donor_name": donor.donor_name, + "email": donor.email, + "date": getdate(), + "amount": flt(payment.amount) / 100, # Convert to rupees from paise + "mode_of_payment": payment.method, + "payment_id": payment.id, + } + ).insert(ignore_mandatory=True) donation.submit() return donation def get_donor(email): - donors = frappe.get_all('Donor', - filters={'email': email}, - order_by='creation desc') + donors = frappe.get_all("Donor", filters={"email": email}, order_by="creation desc") try: - return frappe.get_doc('Donor', donors[0]['name']) + return frappe.get_doc("Donor", donors[0]["name"]) except Exception: return None @@ -149,17 +156,19 @@ def get_donor(email): @frappe.whitelist() def create_donor(payment): donor_details = frappe._dict(payment) - donor_type = frappe.db.get_single_value('Non Profit Settings', 'default_donor_type') + donor_type = frappe.db.get_single_value("Non Profit Settings", "default_donor_type") - donor = frappe.new_doc('Donor') - donor.update({ - 'donor_name': donor_details.email, - 'donor_type': donor_type, - 'email': donor_details.email, - 'contact': donor_details.contact - }) + donor = frappe.new_doc("Donor") + donor.update( + { + "donor_name": donor_details.email, + "donor_type": donor_type, + "email": donor_details.email, + "contact": donor_details.contact, + } + ) - if donor_details.get('notes'): + if donor_details.get("notes"): donor = get_additional_notes(donor, donor_details) donor.insert(ignore_mandatory=True) @@ -167,9 +176,10 @@ def create_donor(payment): def get_company_for_donations(): - company = frappe.db.get_single_value('Non Profit Settings', 'donation_company') + company = frappe.db.get_single_value("Non Profit Settings", "donation_company") if not company: from erpnext.healthcare.setup import get_company + company = get_company() return company @@ -177,45 +187,44 @@ def get_company_for_donations(): def get_additional_notes(donor, donor_details): if type(donor_details.notes) == dict: for k, v in donor_details.notes.items(): - notes = '\n'.join('{}: {}'.format(k, v)) + notes = "\n".join("{}: {}".format(k, v)) # extract donor name from notes - if 'name' in k.lower(): - donor.update({ - 'donor_name': donor_details.notes.get(k) - }) + if "name" in k.lower(): + donor.update({"donor_name": donor_details.notes.get(k)}) # extract pan from notes - if 'pan' in k.lower(): - donor.update({ - 'pan_number': donor_details.notes.get(k) - }) + if "pan" in k.lower(): + donor.update({"pan_number": donor_details.notes.get(k)}) - donor.add_comment('Comment', notes) + donor.add_comment("Comment", notes) elif type(donor_details.notes) == str: - donor.add_comment('Comment', donor_details.notes) + donor.add_comment("Comment", donor_details.notes) return donor def create_mode_of_payment(method): - frappe.get_doc({ - 'doctype': 'Mode of Payment', - 'mode_of_payment': method - }).insert(ignore_mandatory=True) + frappe.get_doc({"doctype": "Mode of Payment", "mode_of_payment": method}).insert( + ignore_mandatory=True + ) def notify_failure(log): try: - content = ''' + content = """ Dear System Manager, Razorpay webhook for creating donation failed due to some reason. Please check the error log linked below Error Log: {0} Regards, Administrator - '''.format(get_link_to_form('Error Log', log.name)) + """.format( + get_link_to_form("Error Log", log.name) + ) - sendmail_to_system_managers(_('[Important] [ERPNext] Razorpay donation webhook failed, please check.'), content) + sendmail_to_system_managers( + _("[Important] [ERPNext] Razorpay donation webhook failed, please check."), content + ) except Exception: pass diff --git a/erpnext/non_profit/doctype/donation/donation_dashboard.py b/erpnext/non_profit/doctype/donation/donation_dashboard.py index 1d43ba23dcf..53700ca1ecb 100644 --- a/erpnext/non_profit/doctype/donation/donation_dashboard.py +++ b/erpnext/non_profit/doctype/donation/donation_dashboard.py @@ -1,17 +1,9 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'donation', - 'non_standard_fieldnames': { - 'Payment Entry': 'reference_name' - }, - 'transactions': [ - { - 'label': _('Payment'), - 'items': ['Payment Entry'] - } - ] + "fieldname": "donation", + "non_standard_fieldnames": {"Payment Entry": "reference_name"}, + "transactions": [{"label": _("Payment"), "items": ["Payment Entry"]}], } diff --git a/erpnext/non_profit/doctype/donation/test_donation.py b/erpnext/non_profit/doctype/donation/test_donation.py index 5fa731a6aa3..f24d0555b2a 100644 --- a/erpnext/non_profit/doctype/donation/test_donation.py +++ b/erpnext/non_profit/doctype/donation/test_donation.py @@ -5,32 +5,28 @@ import unittest import frappe -from erpnext.non_profit.doctype.donation.donation import create_donation +from erpnext.non_profit.doctype.donation.donation import create_razorpay_donation class TestDonation(unittest.TestCase): def setUp(self): create_donor_type() - settings = frappe.get_doc('Non Profit Settings') - settings.company = '_Test Company' - settings.donation_company = '_Test Company' - settings.default_donor_type = '_Test Donor' + settings = frappe.get_doc("Non Profit Settings") + settings.company = "_Test Company" + settings.donation_company = "_Test Company" + settings.default_donor_type = "_Test Donor" settings.automate_donation_payment_entries = 1 - settings.donation_debit_account = 'Debtors - _TC' - settings.donation_payment_account = 'Cash - _TC' - settings.creation_user = 'Administrator' + settings.donation_debit_account = "Debtors - _TC" + settings.donation_payment_account = "Cash - _TC" + settings.creation_user = "Administrator" settings.flags.ignore_permissions = True settings.save() def test_payment_entry_for_donations(self): donor = create_donor() create_mode_of_payment() - payment = frappe._dict({ - 'amount': 100, - 'method': 'Debit Card', - 'id': 'pay_MeXAmsgeKOhq7O' - }) - donation = create_donation(donor, payment) + payment = frappe._dict({"amount": 100, "method": "Debit Card", "id": "pay_MeXAmsgeKOhq7O"}) + donation = create_razorpay_donation(donor, payment) self.assertTrue(donation.name) @@ -41,37 +37,35 @@ class TestDonation(unittest.TestCase): donation.reload() self.assertEqual(donation.paid, 1) - self.assertTrue(frappe.db.exists('Payment Entry', {'reference_no': donation.name})) + self.assertTrue(frappe.db.exists("Payment Entry", {"reference_no": donation.name})) def create_donor_type(): - if not frappe.db.exists('Donor Type', '_Test Donor'): - frappe.get_doc({ - 'doctype': 'Donor Type', - 'donor_type': '_Test Donor' - }).insert() + if not frappe.db.exists("Donor Type", "_Test Donor"): + frappe.get_doc({"doctype": "Donor Type", "donor_type": "_Test Donor"}).insert() def create_donor(): - donor = frappe.db.exists('Donor', 'donor@test.com') + donor = frappe.db.exists("Donor", "donor@test.com") if donor: - return frappe.get_doc('Donor', 'donor@test.com') + return frappe.get_doc("Donor", "donor@test.com") else: - return frappe.get_doc({ - 'doctype': 'Donor', - 'donor_name': '_Test Donor', - 'donor_type': '_Test Donor', - 'email': 'donor@test.com' - }).insert() + return frappe.get_doc( + { + "doctype": "Donor", + "donor_name": "_Test Donor", + "donor_type": "_Test Donor", + "email": "donor@test.com", + } + ).insert() def create_mode_of_payment(): - if not frappe.db.exists('Mode of Payment', 'Debit Card'): - frappe.get_doc({ - 'doctype': 'Mode of Payment', - 'mode_of_payment': 'Debit Card', - 'accounts': [{ - 'company': '_Test Company', - 'default_account': 'Cash - _TC' - }] - }).insert() + if not frappe.db.exists("Mode of Payment", "Debit Card"): + frappe.get_doc( + { + "doctype": "Mode of Payment", + "mode_of_payment": "Debit Card", + "accounts": [{"company": "_Test Company", "default_account": "Cash - _TC"}], + } + ).insert() diff --git a/erpnext/non_profit/doctype/donor/donor.py b/erpnext/non_profit/doctype/donor/donor.py index 058321b1591..77ec17e823f 100644 --- a/erpnext/non_profit/doctype/donor/donor.py +++ b/erpnext/non_profit/doctype/donor/donor.py @@ -13,5 +13,6 @@ class Donor(Document): def validate(self): from frappe.utils import validate_email_address + if self.email: validate_email_address(self.email.strip(), True) diff --git a/erpnext/non_profit/doctype/grant_application/grant_application.py b/erpnext/non_profit/doctype/grant_application/grant_application.py index cc5e1b1442d..03db783696a 100644 --- a/erpnext/non_profit/doctype/grant_application/grant_application.py +++ b/erpnext/non_profit/doctype/grant_application/grant_application.py @@ -11,12 +11,12 @@ from frappe.website.website_generator import WebsiteGenerator class GrantApplication(WebsiteGenerator): _website = frappe._dict( - condition_field = "published", + condition_field="published", ) def validate(self): - if not self.route: #pylint: disable=E0203 - self.route = 'grant-application/' + self.scrub(self.name) + if not self.route: # pylint: disable=E0203 + self.route = "grant-application/" + self.scrub(self.name) def onload(self): """Load address and contacts in `__onload`""" @@ -25,32 +25,35 @@ class GrantApplication(WebsiteGenerator): def get_context(self, context): context.no_cache = True context.show_sidebar = True - context.parents = [dict(label='View All Grant Applications', - route='grant-application', title='View Grants')] + context.parents = [ + dict(label="View All Grant Applications", route="grant-application", title="View Grants") + ] + def get_list_context(context): context.allow_guest = True context.no_cache = True context.no_breadcrumbs = True context.show_sidebar = True - context.order_by = 'creation desc' - context.introduction =''' - Apply for new Grant Application''' + context.order_by = "creation desc" + context.introduction = """ + Apply for new Grant Application""" + @frappe.whitelist() def send_grant_review_emails(grant_application): grant = frappe.get_doc("Grant Application", grant_application) - url = get_url('grant-application/{0}'.format(grant_application)) + url = get_url("grant-application/{0}".format(grant_application)) frappe.sendmail( - recipients= grant.assessment_manager, + recipients=grant.assessment_manager, sender=frappe.session.user, - subject='Grant Application for {0}'.format(grant.applicant_name), - message='
Please Review this grant application
' + url, + subject="Grant Application for {0}".format(grant.applicant_name), + message="
Please Review this grant application
" + url, reference_doctype=grant.doctype, - reference_name=grant.name + reference_name=grant.name, ) - grant.status = 'In Progress' + grant.status = "In Progress" grant.email_notification_sent = 1 grant.save() frappe.db.commit() diff --git a/erpnext/non_profit/doctype/member/member.js b/erpnext/non_profit/doctype/member/member.js index e58ec0f5eea..f72d4d958b9 100644 --- a/erpnext/non_profit/doctype/member/member.js +++ b/erpnext/non_profit/doctype/member/member.js @@ -21,13 +21,18 @@ frappe.ui.form.on('Member', { // custom buttons frm.add_custom_button(__('Accounting Ledger'), function() { - frappe.set_route('query-report', 'General Ledger', - {party_type:'Member', party:frm.doc.name}); + if (frm.doc.customer) { + frappe.set_route('query-report', 'General Ledger', {party_type: 'Customer', party: frm.doc.customer}); + } else { + frappe.set_route('query-report', 'General Ledger', {party_type: 'Member', party: frm.doc.name}); + } }); - frm.add_custom_button(__('Accounts Receivable'), function() { - frappe.set_route('query-report', 'Accounts Receivable', {member:frm.doc.name}); - }); + if (frm.doc.customer) { + frm.add_custom_button(__('Accounts Receivable'), function() { + frappe.set_route('query-report', 'Accounts Receivable', {customer: frm.doc.customer}); + }); + } if (!frm.doc.customer) { frm.add_custom_button(__('Create Customer'), () => { @@ -44,21 +49,18 @@ frappe.ui.form.on('Member', { frappe.contacts.clear_address_and_contact(frm); } - frappe.call({ - method:"frappe.client.get_value", - args:{ - 'doctype':"Membership", - 'filters':{'member': frm.doc.name}, - 'fieldname':[ - 'to_date' - ] - }, - callback: function (data) { - if(data.message) { - frappe.model.set_value(frm.doctype,frm.docname, - "membership_expiry_date", data.message.to_date); + if (!frm.doc.membership_expiry_date && !frm.doc.__islocal) { + frappe.call({ + method: "erpnext.get_last_membership", + args: { + member: frm.doc.member + }, + callback: function(data) { + if (data.message) { + frappe.model.set_value(frm.doctype, frm.docname, "membership_expiry_date", data.message.to_date); + } } - } - }); + }); + } } }); diff --git a/erpnext/non_profit/doctype/member/member.py b/erpnext/non_profit/doctype/member/member.py index 4d80e57eccf..d2e4ae45fb0 100644 --- a/erpnext/non_profit/doctype/member/member.py +++ b/erpnext/non_profit/doctype/member/member.py @@ -17,20 +17,21 @@ class Member(Document): """Load address and contacts in `__onload`""" load_address_and_contact(self) - def validate(self): if self.email_id: self.validate_email_type(self.email_id) def validate_email_type(self, email): from frappe.utils import validate_email_address + validate_email_address(email.strip(), True) def setup_subscription(self): - non_profit_settings = frappe.get_doc('Non Profit Settings') + non_profit_settings = frappe.get_doc("Non Profit Settings") if not non_profit_settings.enable_razorpay_for_memberships: - frappe.throw(_('Please check Enable Razorpay for Memberships in {0} to setup subscription')).format( - get_link_to_form('Non Profit Settings', 'Non Profit Settings')) + frappe.throw( + _("Please check Enable Razorpay for Memberships in {0} to setup subscription") + ).format(get_link_to_form("Non Profit Settings", "Non Profit Settings")) controller = get_payment_gateway_controller("Razorpay") settings = controller.get_settings({}) @@ -43,12 +44,10 @@ class Member(Document): subscription_details = { "plan_id": plan_id, "billing_frequency": cint(non_profit_settings.billing_frequency), - "customer_notify": 1 + "customer_notify": 1, } - args = { - 'subscription_details': subscription_details - } + args = {"subscription_details": subscription_details} subscription = controller.setup_subscription(settings, **args) @@ -59,11 +58,9 @@ class Member(Document): if self.customer: frappe.msgprint(_("A customer is already linked to this Member")) - customer = create_customer(frappe._dict({ - 'fullname': self.member_name, - 'email': self.email_id, - 'phone': None - })) + customer = create_customer( + frappe._dict({"fullname": self.member_name, "email": self.email_id, "phone": None}) + ) self.customer = customer self.save() @@ -71,24 +68,29 @@ class Member(Document): def get_or_create_member(user_details): - member_list = frappe.get_all("Member", filters={'email': user_details.email, 'membership_type': user_details.plan_id}) + member_list = frappe.get_all( + "Member", filters={"email": user_details.email, "membership_type": user_details.plan_id} + ) if member_list and member_list[0]: - return member_list[0]['name'] + return member_list[0]["name"] else: return create_member(user_details) + def create_member(user_details): user_details = frappe._dict(user_details) member = frappe.new_doc("Member") - member.update({ - "member_name": user_details.fullname, - "email_id": user_details.email, - "pan_number": user_details.pan or None, - "membership_type": user_details.plan_id, - "customer_id": user_details.customer_id or None, - "subscription_id": user_details.subscription_id or None, - "subscription_status": user_details.subscription_status or "" - }) + member.update( + { + "member_name": user_details.fullname, + "email_id": user_details.email, + "pan_number": user_details.pan or None, + "membership_type": user_details.plan_id, + "customer_id": user_details.customer_id or None, + "subscription_id": user_details.subscription_id or None, + "subscription_status": user_details.subscription_status or "", + } + ) member.insert(ignore_permissions=True) member.customer = create_customer(user_details, member.name) @@ -96,14 +98,18 @@ def create_member(user_details): return member + def create_customer(user_details, member=None): customer = frappe.new_doc("Customer") customer.customer_name = user_details.fullname customer.customer_type = "Individual" + customer.customer_group = frappe.db.get_single_value("Selling Settings", "customer_group") + customer.territory = frappe.db.get_single_value("Selling Settings", "territory") customer.flags.ignore_mandatory = True customer.insert(ignore_permissions=True) try: + frappe.db.savepoint("contact_creation") contact = frappe.new_doc("Contact") contact.first_name = user_details.fullname if user_details.mobile: @@ -112,16 +118,10 @@ def create_customer(user_details, member=None): contact.add_email(user_details.email, is_primary=1) contact.insert(ignore_permissions=True) - contact.append("links", { - "link_doctype": "Customer", - "link_name": customer.name - }) + contact.append("links", {"link_doctype": "Customer", "link_name": customer.name}) if member: - contact.append("links", { - "link_doctype": "Member", - "link_name": member - }) + contact.append("links", {"link_doctype": "Member", "link_name": member}) contact.save(ignore_permissions=True) @@ -129,28 +129,30 @@ def create_customer(user_details, member=None): return customer.name except Exception as e: + frappe.db.rollback(save_point="contact_creation") frappe.log_error(frappe.get_traceback(), _("Contact Creation Failed")) pass return customer.name + @frappe.whitelist(allow_guest=True) def create_member_subscription_order(user_details): """Create Member subscription and order for payment Args: - user_details (TYPE): Description + user_details (TYPE): Description Returns: - Dictionary: Dictionary with subscription details - { - 'subscription_details': { - 'plan_id': 'plan_EXwyxDYDCj3X4v', - 'billing_frequency': 24, - 'customer_notify': 1 - }, - 'subscription_id': 'sub_EZycCvXFvqnC6p' - } + Dictionary: Dictionary with subscription details + { + 'subscription_details': { + 'plan_id': 'plan_EXwyxDYDCj3X4v', + 'billing_frequency': 24, + 'customer_notify': 1 + }, + 'subscription_id': 'sub_EZycCvXFvqnC6p' + } """ user_details = frappe._dict(user_details) @@ -158,28 +160,31 @@ def create_member_subscription_order(user_details): subscription = member.setup_subscription() - member.subscription_id = subscription.get('subscription_id') + member.subscription_id = subscription.get("subscription_id") member.save(ignore_permissions=True) return subscription + @frappe.whitelist() def register_member(fullname, email, rzpay_plan_id, subscription_id, pan=None, mobile=None): plan = get_membership_type(rzpay_plan_id) if not plan: raise frappe.DoesNotExistError - member = frappe.db.exists("Member", {'email': email, 'subscription_id': subscription_id }) + member = frappe.db.exists("Member", {"email": email, "subscription_id": subscription_id}) if member: return member else: - member = create_member(dict( - fullname=fullname, - email=email, - plan_id=plan, - subscription_id=subscription_id, - pan=pan, - mobile=mobile - )) + member = create_member( + dict( + fullname=fullname, + email=email, + plan_id=plan, + subscription_id=subscription_id, + pan=pan, + mobile=mobile, + ) + ) return member.name diff --git a/erpnext/non_profit/doctype/member/member_dashboard.py b/erpnext/non_profit/doctype/member/member_dashboard.py index 80bb9e3250d..19d9c388e19 100644 --- a/erpnext/non_profit/doctype/member/member_dashboard.py +++ b/erpnext/non_profit/doctype/member/member_dashboard.py @@ -1,23 +1,14 @@ - from frappe import _ def get_data(): return { - 'heatmap': True, - 'heatmap_message': _('Member Activity'), - 'fieldname': 'member', - 'non_standard_fieldnames': { - 'Bank Account': 'party' - }, - 'transactions': [ - { - 'label': _('Membership Details'), - 'items': ['Membership'] - }, - { - 'label': _('Fee'), - 'items': ['Bank Account'] - } - ] + "heatmap": True, + "heatmap_message": _("Member Activity"), + "fieldname": "member", + "non_standard_fieldnames": {"Bank Account": "party"}, + "transactions": [ + {"label": _("Membership Details"), "items": ["Membership"]}, + {"label": _("Fee"), "items": ["Bank Account"]}, + ], } diff --git a/erpnext/non_profit/doctype/membership/membership.json b/erpnext/non_profit/doctype/membership/membership.json index 11d32f9c2b4..df7f723c944 100644 --- a/erpnext/non_profit/doctype/membership/membership.json +++ b/erpnext/non_profit/doctype/membership/membership.json @@ -21,9 +21,11 @@ "paid", "currency", "amount", + "column_break_16", "invoice", "razorpay_details_section", "subscription_id", + "column_break_19", "payment_id" ], "fields": [ @@ -106,20 +108,17 @@ { "fieldname": "razorpay_details_section", "fieldtype": "Section Break", - "hidden": 1, "label": "Razorpay Details" }, { "fieldname": "subscription_id", "fieldtype": "Data", - "label": "Subscription ID", - "read_only": 1 + "label": "Subscription ID" }, { "fieldname": "payment_id", "fieldtype": "Data", - "label": "Payment ID", - "read_only": 1 + "label": "Payment ID" }, { "fieldname": "invoice", @@ -140,11 +139,19 @@ "label": "Company", "options": "Company", "reqd": 1 + }, + { + "fieldname": "column_break_19", + "fieldtype": "Column Break" + }, + { + "fieldname": "column_break_16", + "fieldtype": "Column Break" } ], "index_web_pages_for_search": 1, "links": [], - "modified": "2021-02-19 14:33:44.925122", + "modified": "2022-03-16 17:37:28.672916", "modified_by": "Administrator", "module": "Non Profit", "name": "Membership", diff --git a/erpnext/non_profit/doctype/membership/membership.py b/erpnext/non_profit/doctype/membership/membership.py index df5638c372b..7f7abd06594 100644 --- a/erpnext/non_profit/doctype/membership/membership.py +++ b/erpnext/non_profit/doctype/membership/membership.py @@ -13,6 +13,7 @@ from frappe.model.document import Document from frappe.utils import add_days, add_months, add_years, get_link_to_form, getdate, nowdate import erpnext +from erpnext import get_company_currency from erpnext.non_profit.doctype.member.member import create_member @@ -33,12 +34,14 @@ class Membership(Document): if not member_name: user = frappe.get_doc("User", frappe.session.user) - member = frappe.get_doc(dict( - doctype="Member", - email_id=frappe.session.user, - membership_type=self.membership_type, - member_name=user.get_fullname() - )).insert(ignore_permissions=True) + member = frappe.get_doc( + dict( + doctype="Member", + email_id=frappe.session.user, + membership_type=self.membership_type, + member_name=user.get_fullname(), + ) + ).insert(ignore_permissions=True) member_name = member.name if self.get("__islocal"): @@ -49,16 +52,16 @@ class Membership(Document): last_membership = erpnext.get_last_membership(self.member) # if person applied for offline membership - if last_membership and last_membership.name != self.name and not frappe.session.user == "Administrator": + if ( + last_membership + and last_membership.name != self.name + and not frappe.session.user == "Administrator" + ): # if last membership does not expire in 30 days, then do not allow to renew - if getdate(add_days(last_membership.to_date, -30)) > getdate(nowdate()) : + if getdate(add_days(last_membership.to_date, -30)) > getdate(nowdate()): frappe.throw(_("You can only renew if your membership expires within 30 days")) self.from_date = add_days(last_membership.to_date, 1) - elif frappe.session.user == "Administrator": - self.from_date = self.from_date - else: - self.from_date = nowdate() if frappe.db.get_single_value("Non Profit Settings", "billing_cycle") == "Yearly": self.to_date = add_years(self.from_date, 1) @@ -72,13 +75,16 @@ class Membership(Document): self.db_set("paid", 1) settings = frappe.get_doc("Non Profit Settings") if settings.allow_invoicing and settings.automate_membership_invoicing: - self.generate_invoice(with_payment_entry=settings.automate_membership_payment_entries, save=True) - + self.generate_invoice( + with_payment_entry=settings.automate_membership_payment_entries, save=True + ) @frappe.whitelist() def generate_invoice(self, save=True, with_payment_entry=False): if not (self.paid or self.currency or self.amount): - frappe.throw(_("The payment for this membership is not paid. To generate invoice fill the payment details")) + frappe.throw( + _("The payment for this membership is not paid. To generate invoice fill the payment details") + ) if self.invoice: frappe.throw(_("An invoice is already linked to this document")) @@ -104,27 +110,36 @@ class Membership(Document): return invoice def validate_membership_type_and_settings(self, plan, settings): - settings_link = get_link_to_form("Membership Type", self.membership_type) + settings_link = get_link_to_form("Non Profit Settings", "Non Profit Settings") if not settings.membership_debit_account: frappe.throw(_("You need to set Debit Account in {0}").format(settings_link)) if not settings.company: - frappe.throw(_("You need to set Default Company for invoicing in {0}").format(settings_link)) + frappe.throw( + _("You need to set Default Company for invoicing in {0}").format(settings_link) + ) if not plan.linked_item: - frappe.throw(_("Please set a Linked Item for the Membership Type {0}").format( - get_link_to_form("Membership Type", self.membership_type))) + frappe.throw( + _("Please set a Linked Item for the Membership Type {0}").format( + get_link_to_form("Membership Type", self.membership_type) + ) + ) def make_payment_entry(self, settings, invoice): if not settings.membership_payment_account: - frappe.throw(_("You need to set Payment Account for Membership in {0}").format( - get_link_to_form("Non Profit Settings", "Non Profit Settings"))) + frappe.throw( + _("You need to set Payment Account for Membership in {0}").format( + get_link_to_form("Non Profit Settings", "Non Profit Settings") + ) + ) from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry + frappe.flags.ignore_account_permission = True pe = get_payment_entry(dt="Sales Invoice", dn=invoice.name, bank_amount=invoice.grand_total) - frappe.flags.ignore_account_permission=False + frappe.flags.ignore_account_permission = False pe.paid_to = settings.membership_payment_account pe.reference_no = self.name pe.reference_date = getdate() @@ -136,22 +151,33 @@ class Membership(Document): def send_acknowlement(self): settings = frappe.get_doc("Non Profit Settings") if not settings.send_email: - frappe.throw(_("You need to enable Send Acknowledge Email in {0}").format( - get_link_to_form("Non Profit Settings", "Non Profit Settings"))) + frappe.throw( + _("You need to enable Send Acknowledge Email in {0}").format( + get_link_to_form("Non Profit Settings", "Non Profit Settings") + ) + ) member = frappe.get_doc("Member", self.member) if not member.email_id: - frappe.throw(_("Email address of member {0} is missing").format(frappe.utils.get_link_to_form("Member", self.member))) + frappe.throw( + _("Email address of member {0} is missing").format( + frappe.utils.get_link_to_form("Member", self.member) + ) + ) plan = frappe.get_doc("Membership Type", self.membership_type) email = member.email_id - attachments = [frappe.attach_print("Membership", self.name, print_format=settings.membership_print_format)] + attachments = [ + frappe.attach_print("Membership", self.name, print_format=settings.membership_print_format) + ] if self.invoice and settings.send_invoice: - attachments.append(frappe.attach_print("Sales Invoice", self.invoice, print_format=settings.inv_print_format)) + attachments.append( + frappe.attach_print("Sales Invoice", self.invoice, print_format=settings.inv_print_format) + ) email_template = frappe.get_doc("Email Template", settings.email_template) - context = { "doc": self, "member": member} + context = {"doc": self, "member": member} email_args = { "recipients": [email], @@ -159,7 +185,7 @@ class Membership(Document): "subject": frappe.render_template(email_template.get("subject"), context), "attachments": attachments, "reference_doctype": self.doctype, - "reference_name": self.name + "reference_name": self.name, } if not frappe.flags.in_test: @@ -173,21 +199,17 @@ class Membership(Document): def make_invoice(membership, member, plan, settings): - invoice = frappe.get_doc({ - "doctype": "Sales Invoice", - "customer": member.customer, - "debit_to": settings.membership_debit_account, - "currency": membership.currency, - "company": settings.company, - "is_pos": 0, - "items": [ - { - "item_code": plan.linked_item, - "rate": membership.amount, - "qty": 1 - } - ] - }) + invoice = frappe.get_doc( + { + "doctype": "Sales Invoice", + "customer": member.customer, + "debit_to": settings.membership_debit_account, + "currency": membership.currency or get_company_currency(settings.company), + "company": settings.company, + "is_pos": 0, + "items": [{"item_code": plan.linked_item, "rate": membership.amount, "qty": 1}], + } + ) invoice.set_missing_values() invoice.insert() invoice.submit() @@ -241,11 +263,15 @@ def trigger_razorpay_subscription(*args, **kwargs): member = get_member_based_on_subscription(subscription.id, payment.email) if not member: - member = create_member(frappe._dict({ - "fullname": payment.email, - "email": payment.email, - "plan_id": get_plan_from_razorpay_id(subscription.plan_id) - })) + member = create_member( + frappe._dict( + { + "fullname": payment.email, + "email": payment.email, + "plan_id": get_plan_from_razorpay_id(subscription.plan_id), + } + ) + ) member.subscription_id = subscription.id member.customer_id = payment.customer_id @@ -256,18 +282,20 @@ def trigger_razorpay_subscription(*args, **kwargs): company = get_company_for_memberships() # Update Membership membership = frappe.new_doc("Membership") - membership.update({ - "company": company, - "member": member.name, - "membership_status": "Current", - "membership_type": member.membership_type, - "currency": "INR", - "paid": 1, - "payment_id": payment.id, - "from_date": datetime.fromtimestamp(subscription.current_start), - "to_date": datetime.fromtimestamp(subscription.current_end), - "amount": payment.amount / 100 # Convert to rupees from paise - }) + membership.update( + { + "company": company, + "member": member.name, + "membership_status": "Current", + "membership_type": member.membership_type, + "currency": "INR", + "paid": 1, + "payment_id": payment.id, + "from_date": datetime.fromtimestamp(subscription.current_start), + "to_date": datetime.fromtimestamp(subscription.current_end), + "amount": payment.amount / 100, # Convert to rupees from paise + } + ) membership.flags.ignore_mandatory = True membership.insert() @@ -281,7 +309,9 @@ def trigger_razorpay_subscription(*args, **kwargs): settings = frappe.get_doc("Non Profit Settings") if settings.allow_invoicing and settings.automate_membership_invoicing: membership.reload() - membership.generate_invoice(with_payment_entry=settings.automate_membership_payment_entries, save=True) + membership.generate_invoice( + with_payment_entry=settings.automate_membership_payment_entries, save=True + ) except Exception as e: message = "{0}\n\n{1}\n\n{2}: {3}".format(e, frappe.get_traceback(), _("Payment ID"), payment.id) @@ -328,7 +358,9 @@ def update_halted_razorpay_subscription(*args, **kwargs): except Exception as e: message = "{0}\n\n{1}".format(e, frappe.get_traceback()) - log = frappe.log_error(message, _("Error updating halted status for member {0}").format(member.name)) + log = frappe.log_error( + message, _("Error updating halted status for member {0}").format(member.name) + ) notify_failure(log) return {"status": "Failed", "reason": e} @@ -354,6 +386,7 @@ def get_company_for_memberships(): company = frappe.db.get_single_value("Non Profit Settings", "company") if not company: from erpnext.healthcare.setup import get_company + company = get_company() return company @@ -365,15 +398,11 @@ def get_additional_notes(member, subscription): # extract member name from notes if "name" in k.lower(): - member.update({ - "member_name": subscription.notes.get(k) - }) + member.update({"member_name": subscription.notes.get(k)}) # extract pan number from notes if "pan" in k.lower(): - member.update({ - "pan_number": subscription.notes.get(k) - }) + member.update({"pan_number": subscription.notes.get(k)}) member.add_comment("Comment", notes) @@ -391,15 +420,21 @@ def notify_failure(log): Please check the following error log linked below Error Log: {0} Regards, Administrator - """.format(get_link_to_form("Error Log", log.name)) + """.format( + get_link_to_form("Error Log", log.name) + ) - sendmail_to_system_managers("[Important] [ERPNext] Razorpay membership webhook failed , please check.", content) + sendmail_to_system_managers( + "[Important] [ERPNext] Razorpay membership webhook failed , please check.", content + ) except Exception: pass def get_plan_from_razorpay_id(plan_id): - plan = frappe.get_all("Membership Type", filters={"razorpay_plan_id": plan_id}, order_by="creation desc") + plan = frappe.get_all( + "Membership Type", filters={"razorpay_plan_id": plan_id}, order_by="creation desc" + ) try: return plan[0]["name"] @@ -408,9 +443,12 @@ def get_plan_from_razorpay_id(plan_id): def set_expired_status(): - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE - `tabMembership` SET `status` = 'Expired' + `tabMembership` SET `membership_status` = 'Expired' WHERE - `status` not in ('Cancelled') AND `to_date` < %s - """, (nowdate())) + `membership_status` not in ('Cancelled') AND `to_date` < %s + """, + (nowdate()), + ) diff --git a/erpnext/non_profit/doctype/membership/test_membership.py b/erpnext/non_profit/doctype/membership/test_membership.py index fbe344c6a15..d73c2bed5f4 100644 --- a/erpnext/non_profit/doctype/membership/test_membership.py +++ b/erpnext/non_profit/doctype/membership/test_membership.py @@ -17,14 +17,16 @@ class TestMembership(unittest.TestCase): # make test member self.member_doc = create_member( - frappe._dict({ - "fullname": "_Test_Member", - "email": "_test_member_erpnext@example.com", - "plan_id": plan.name, - "subscription_id": "sub_DEX6xcJ1HSW4CR", - "customer_id": "cust_C0WlbKhp3aLA7W", - "subscription_status": "Active" - }) + frappe._dict( + { + "fullname": "_Test_Member", + "email": "_test_member_erpnext@example.com", + "plan_id": plan.name, + "subscription_id": "sub_DEX6xcJ1HSW4CR", + "customer_id": "cust_C0WlbKhp3aLA7W", + "subscription_status": "Active", + } + ) ) self.member_doc.make_customer_and_link() self.member = self.member_doc.name @@ -40,30 +42,38 @@ class TestMembership(unittest.TestCase): def test_renew_within_30_days(self): # create a membership for two months # Should work fine - make_membership(self.member, { "from_date": nowdate() }) - make_membership(self.member, { "from_date": add_months(nowdate(), 1) }) + make_membership(self.member, {"from_date": nowdate()}) + make_membership(self.member, {"from_date": add_months(nowdate(), 1)}) from frappe.utils.user import add_role + add_role("test@example.com", "Non Profit Manager") frappe.set_user("test@example.com") # create next membership with expiry not within 30 days - self.assertRaises(frappe.ValidationError, make_membership, self.member, { - "from_date": add_months(nowdate(), 2), - }) + self.assertRaises( + frappe.ValidationError, + make_membership, + self.member, + { + "from_date": add_months(nowdate(), 2), + }, + ) frappe.set_user("Administrator") # create the same membership but as administrator - make_membership(self.member, { - "from_date": add_months(nowdate(), 2), - "to_date": add_months(nowdate(), 3), - }) + make_membership( + self.member, + { + "from_date": add_months(nowdate(), 2), + "to_date": add_months(nowdate(), 3), + }, + ) def test_halted_memberships(self): - make_membership(self.member, { - "from_date": add_months(nowdate(), 2), - "to_date": add_months(nowdate(), 3) - }) + make_membership( + self.member, {"from_date": add_months(nowdate(), 2), "to_date": add_months(nowdate(), 3)} + ) self.assertEqual(frappe.db.get_value("Member", self.member, "subscription_status"), "Active") payload = get_subscription_payload() @@ -73,25 +83,28 @@ class TestMembership(unittest.TestCase): def tearDown(self): frappe.db.rollback() + def set_config(key, value): frappe.db.set_value("Non Profit Settings", None, key, value) + def make_membership(member, payload={}): data = { "doctype": "Membership", "member": member, "membership_status": "Current", "membership_type": "_rzpy_test_milythm", - "currency": "INR", + "currency": "USD", "paid": 1, "from_date": nowdate(), - "amount": 100 + "amount": 100, } data.update(payload) membership = frappe.get_doc(data) membership.insert(ignore_permissions=True, ignore_if_duplicate=True) return membership + def create_item(item_code): if not frappe.db.exists("Item", item_code): item = frappe.new_doc("Item") @@ -106,6 +119,7 @@ def create_item(item_code): item = frappe.get_doc("Item", item_code) return item + def setup_membership(): # Get default company company = frappe.get_doc("Company", erpnext.get_default_company()) @@ -139,14 +153,13 @@ def setup_membership(): return plan + def get_subscription_payload(): return { "entity": "event", "account_id": "acc_BFQ7uQEaa7j2z7", "event": "subscription.halted", - "contains": [ - "subscription" - ], + "contains": ["subscription"], "payload": { "subscription": { "entity": { @@ -155,10 +168,8 @@ def get_subscription_payload(): "plan_id": "_rzpy_test_milythm", "customer_id": "cust_C0WlbKhp3aLA7W", "status": "halted", - "notes": { - "Important": "Notes for Internal Reference" - }, + "notes": {"Important": "Notes for Internal Reference"}, } } - } + }, } diff --git a/erpnext/non_profit/doctype/membership_type/membership_type.py b/erpnext/non_profit/doctype/membership_type/membership_type.py index b4464215715..33a7ffd75bd 100644 --- a/erpnext/non_profit/doctype/membership_type/membership_type.py +++ b/erpnext/non_profit/doctype/membership_type/membership_type.py @@ -14,5 +14,6 @@ class MembershipType(Document): if is_stock_item: frappe.throw(_("The Linked Item should be a service item")) + def get_membership_type(razorpay_id): return frappe.db.exists("Membership Type", {"razorpay_plan_id": razorpay_id}) diff --git a/erpnext/non_profit/doctype/non_profit_settings/non_profit_settings.py b/erpnext/non_profit/doctype/non_profit_settings/non_profit_settings.py index ace66055427..ae36a335198 100644 --- a/erpnext/non_profit/doctype/non_profit_settings/non_profit_settings.py +++ b/erpnext/non_profit/doctype/non_profit_settings/non_profit_settings.py @@ -18,8 +18,12 @@ class NonProfitSettings(Document): secret_for = "Membership" if field == "membership_webhook_secret" else "Donation" frappe.msgprint( - _("Here is your webhook secret for {0} API, this will be shown to you only once.").format(secret_for) + "
" + key, - _("Webhook Secret") + _("Here is your webhook secret for {0} API, this will be shown to you only once.").format( + secret_for + ) + + "
" + + key, + _("Webhook Secret"), ) @frappe.whitelist() @@ -28,9 +32,12 @@ class NonProfitSettings(Document): self.save() def get_webhook_secret(self, endpoint="Membership"): - fieldname = "membership_webhook_secret" if endpoint == "Membership" else "donation_webhook_secret" + fieldname = ( + "membership_webhook_secret" if endpoint == "Membership" else "donation_webhook_secret" + ) return self.get_password(fieldname=fieldname, raise_exception=False) + @frappe.whitelist() def get_plans_for_membership(*args, **kwargs): controller = get_payment_gateway_controller("Razorpay") diff --git a/erpnext/non_profit/report/expiring_memberships/expiring_memberships.py b/erpnext/non_profit/report/expiring_memberships/expiring_memberships.py index 3ddbfdc3b0d..58f5bfec9dc 100644 --- a/erpnext/non_profit/report/expiring_memberships/expiring_memberships.py +++ b/erpnext/non_profit/report/expiring_memberships/expiring_memberships.py @@ -11,18 +11,37 @@ def execute(filters=None): data = get_data(filters) return columns, data + def get_columns(filters): return [ - _("Membership Type") + ":Link/Membership Type:100", _("Membership ID") + ":Link/Membership:140", - _("Member ID") + ":Link/Member:140", _("Member Name") + ":Data:140", _("Email") + ":Data:140", - _("Expiring On") + ":Date:120" + _("Membership Type") + ":Link/Membership Type:100", + _("Membership ID") + ":Link/Membership:140", + _("Member ID") + ":Link/Member:140", + _("Member Name") + ":Data:140", + _("Email") + ":Data:140", + _("Expiring On") + ":Date:120", ] + def get_data(filters): - filters["month"] = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"].index(filters.month) + 1 + filters["month"] = [ + "Jan", + "Feb", + "Mar", + "Apr", + "May", + "Jun", + "Jul", + "Aug", + "Sep", + "Oct", + "Nov", + "Dec", + ].index(filters.month) + 1 - return frappe.db.sql(""" + return frappe.db.sql( + """ select ms.membership_type,ms.name,m.name,m.member_name,m.email,ms.max_membership_date from `tabMember` m inner join (select name,membership_type,max(to_date) as max_membership_date,member @@ -31,4 +50,6 @@ def get_data(filters): group by member order by max_membership_date asc) ms on m.name = ms.member - where month(max_membership_date) = %(month)s and year(max_membership_date) = %(year)s """,{'month': filters.get('month'),'year':filters.get('fiscal_year')}) + where month(max_membership_date) = %(month)s and year(max_membership_date) = %(year)s """, + {"month": filters.get("month"), "year": filters.get("fiscal_year")}, + ) diff --git a/erpnext/non_profit/web_form/certification_application/certification_application.py b/erpnext/non_profit/web_form/certification_application/certification_application.py index 19b550feea7..02e3e933330 100644 --- a/erpnext/non_profit/web_form/certification_application/certification_application.py +++ b/erpnext/non_profit/web_form/certification_application/certification_application.py @@ -1,5 +1,3 @@ - - def get_context(context): # do your magic here pass diff --git a/erpnext/non_profit/web_form/certification_application_usd/certification_application_usd.py b/erpnext/non_profit/web_form/certification_application_usd/certification_application_usd.py index 19b550feea7..02e3e933330 100644 --- a/erpnext/non_profit/web_form/certification_application_usd/certification_application_usd.py +++ b/erpnext/non_profit/web_form/certification_application_usd/certification_application_usd.py @@ -1,5 +1,3 @@ - - def get_context(context): # do your magic here pass diff --git a/erpnext/non_profit/web_form/grant_application/grant_application.py b/erpnext/non_profit/web_form/grant_application/grant_application.py index 1f828940922..e14a613cd2a 100644 --- a/erpnext/non_profit/web_form/grant_application/grant_application.py +++ b/erpnext/non_profit/web_form/grant_application/grant_application.py @@ -1,6 +1,3 @@ - - def get_context(context): context.no_cache = True - context.parents = [dict(label='View All ', - route='grant-application', title='View All')] + context.parents = [dict(label="View All ", route="grant-application", title="View All")] diff --git a/erpnext/non_profit/workspace/non_profit/non_profit.json b/erpnext/non_profit/workspace/non_profit/non_profit.json index 2557d77d881..8265fab798c 100644 --- a/erpnext/non_profit/workspace/non_profit/non_profit.json +++ b/erpnext/non_profit/workspace/non_profit/non_profit.json @@ -109,7 +109,7 @@ "dependencies": "", "hidden": 0, "is_query_report": 0, - "label": "Membership Settings", + "label": "Non Profit Settings", "link_to": "Non Profit Settings", "link_type": "DocType", "onboard": 0, @@ -213,7 +213,7 @@ "type": "Link" } ], - "modified": "2021-03-11 11:38:09.140655", + "modified": "2022-05-09 11:38:09.140655", "modified_by": "Administrator", "module": "Non Profit", "name": "Non Profit", diff --git a/erpnext/patches.txt b/erpnext/patches.txt index 7b349b0c49f..b3099644780 100644 --- a/erpnext/patches.txt +++ b/erpnext/patches.txt @@ -1,5 +1,6 @@ erpnext.patches.v12_0.update_is_cancelled_field erpnext.patches.v11_0.rename_production_order_to_work_order +erpnext.patches.v13_0.add_bin_unique_constraint erpnext.patches.v11_0.refactor_naming_series erpnext.patches.v11_0.refactor_autoname_naming execute:frappe.reload_doc("accounts", "doctype", "POS Payment Method") #2020-05-28 @@ -178,7 +179,6 @@ erpnext.patches.v12_0.set_updated_purpose_in_pick_list erpnext.patches.v12_0.set_default_payroll_based_on erpnext.patches.v12_0.repost_stock_ledger_entries_for_target_warehouse erpnext.patches.v12_0.update_end_date_and_status_in_email_campaign -erpnext.patches.v13_0.validate_options_for_data_field erpnext.patches.v13_0.move_tax_slabs_from_payroll_period_to_income_tax_slab #123 erpnext.patches.v12_0.fix_quotation_expired_status erpnext.patches.v12_0.update_appointment_reminder_scheduler_entry @@ -248,7 +248,6 @@ execute:frappe.delete_doc("Report", "Quoted Item Comparison") erpnext.patches.v13_0.update_member_email_address erpnext.patches.v13_0.update_custom_fields_for_shopify erpnext.patches.v13_0.updates_for_multi_currency_payroll -erpnext.patches.v13_0.create_leave_policy_assignment_based_on_employee_current_leave_policy erpnext.patches.v13_0.update_pos_closing_entry_in_merge_log erpnext.patches.v13_0.add_po_to_global_search erpnext.patches.v13_0.update_returned_qty_in_pr_dn @@ -292,7 +291,6 @@ erpnext.patches.v13_0.set_training_event_attendance erpnext.patches.v13_0.rename_issue_status_hold_to_on_hold erpnext.patches.v13_0.bill_for_rejected_quantity_in_purchase_invoice erpnext.patches.v13_0.update_job_card_details -erpnext.patches.v13_0.update_level_in_bom #1234sswef erpnext.patches.v13_0.create_gst_payment_entry_fields #27-11-2021 erpnext.patches.v13_0.add_missing_fg_item_for_stock_entry erpnext.patches.v13_0.update_subscription_status_in_memberships @@ -306,6 +304,7 @@ erpnext.patches.v13_0.shopify_deprecation_warning erpnext.patches.v13_0.add_custom_field_for_south_africa #2 erpnext.patches.v13_0.rename_discharge_ordered_date_in_ip_record erpnext.patches.v13_0.remove_bad_selling_defaults +erpnext.patches.v13_0.trim_whitespace_from_serial_nos # 16-01-2022 erpnext.patches.v13_0.migrate_stripe_api erpnext.patches.v13_0.reset_clearance_date_for_intracompany_payment_entries execute:frappe.reload_doc("erpnext_integrations", "doctype", "TaxJar Settings") @@ -331,9 +330,47 @@ erpnext.patches.v13_0.enable_scheduler_job_for_item_reposting erpnext.patches.v13_0.requeue_failed_reposts erpnext.patches.v13_0.fetch_thumbnail_in_website_items erpnext.patches.v13_0.update_job_card_status +erpnext.patches.v13_0.enable_uoms erpnext.patches.v12_0.update_production_plan_status erpnext.patches.v13_0.item_naming_series_not_mandatory erpnext.patches.v13_0.update_category_in_ltds_certificate erpnext.patches.v13_0.create_ksa_vat_custom_fields erpnext.patches.v13_0.rename_ksa_qr_field -erpnext.patches.v13_0.disable_ksa_print_format_for_others #16-12-2021 +erpnext.patches.v13_0.wipe_serial_no_field_for_0_qty +erpnext.patches.v13_0.disable_ksa_print_format_for_others # 16-12-2021 +erpnext.patches.v13_0.update_tax_category_for_rcm +erpnext.patches.v13_0.convert_to_website_item_in_item_card_group_template +erpnext.patches.v13_0.agriculture_deprecation_warning +erpnext.patches.v13_0.update_maintenance_schedule_field_in_visit +erpnext.patches.v13_0.hospitality_deprecation_warning +erpnext.patches.v13_0.delete_bank_reconciliation_detail +erpnext.patches.v13_0.update_sane_transfer_against +erpnext.patches.v13_0.enable_provisional_accounting +erpnext.patches.v13_0.update_disbursement_account +erpnext.patches.v13_0.update_reserved_qty_closed_wo +erpnext.patches.v13_0.amazon_mws_deprecation_warning +erpnext.patches.v13_0.datev_deprecation_warning +erpnext.patches.v13_0.set_work_order_qty_in_so_from_mr +erpnext.patches.v13_0.update_accounts_in_loan_docs +erpnext.patches.v13_0.remove_unknown_links_to_prod_plan_items # 24-03-2022 +erpnext.patches.v13_0.rename_non_profit_fields +erpnext.patches.v13_0.enable_ksa_vat_docs #1 +erpnext.patches.v13_0.create_gst_custom_fields_in_quotation +erpnext.patches.v13_0.update_expense_claim_status_for_paid_advances +erpnext.patches.v13_0.change_default_item_manufacturer_fieldtype +erpnext.patches.v13_0.set_return_against_in_pos_invoice_references +erpnext.patches.v13_0.copy_custom_field_filters_to_website_item +erpnext.patches.v13_0.set_available_for_use_date_if_missing +erpnext.patches.v13_0.education_deprecation_warning +erpnext.patches.v13_0.requeue_recoverable_reposts +erpnext.patches.v13_0.create_accounting_dimensions_in_orders +erpnext.patches.v13_0.set_per_billed_in_return_delivery_note +erpnext.patches.v13_0.update_employee_advance_status +erpnext.patches.v13_0.job_card_status_on_hold +erpnext.patches.v13_0.add_cost_center_in_loans +erpnext.patches.v13_0.show_india_localisation_deprecation_warning +erpnext.patches.v13_0.fix_number_and_frequency_for_monthly_depreciation +erpnext.patches.v13_0.reset_corrupt_defaults +erpnext.patches.v13_0.show_hr_payroll_deprecation_warning +erpnext.patches.v13_0.create_accounting_dimensions_for_asset_repair +execute:frappe.db.set_value("Naming Series", "Naming Series", {"select_doc_for_series": "", "set_options": "", "prefix": "", "current_value": 0, "user_must_always_select": 0}) diff --git a/erpnext/patches/v10_0/add_default_cash_flow_mappers.py b/erpnext/patches/v10_0/add_default_cash_flow_mappers.py index 165ca0243bf..5493258e3de 100644 --- a/erpnext/patches/v10_0/add_default_cash_flow_mappers.py +++ b/erpnext/patches/v10_0/add_default_cash_flow_mappers.py @@ -8,8 +8,8 @@ from erpnext.setup.install import create_default_cash_flow_mapper_templates def execute(): - frappe.reload_doc('accounts', 'doctype', frappe.scrub('Cash Flow Mapping')) - frappe.reload_doc('accounts', 'doctype', frappe.scrub('Cash Flow Mapper')) - frappe.reload_doc('accounts', 'doctype', frappe.scrub('Cash Flow Mapping Template Details')) + frappe.reload_doc("accounts", "doctype", frappe.scrub("Cash Flow Mapping")) + frappe.reload_doc("accounts", "doctype", frappe.scrub("Cash Flow Mapper")) + frappe.reload_doc("accounts", "doctype", frappe.scrub("Cash Flow Mapping Template Details")) - create_default_cash_flow_mapper_templates() + create_default_cash_flow_mapper_templates() diff --git a/erpnext/patches/v10_0/delete_hub_documents.py b/erpnext/patches/v10_0/delete_hub_documents.py index 706d1d2b68a..986300ceffa 100644 --- a/erpnext/patches/v10_0/delete_hub_documents.py +++ b/erpnext/patches/v10_0/delete_hub_documents.py @@ -1,4 +1,3 @@ - import frappe @@ -7,7 +6,7 @@ def execute(): frappe.delete_doc(dt, dn, ignore_missing=True) if frappe.db.exists("DocType", "Data Migration Plan"): - data_migration_plans = frappe.get_all("Data Migration Plan", filters={"module": 'Hub Node'}) + data_migration_plans = frappe.get_all("Data Migration Plan", filters={"module": "Hub Node"}) for plan in data_migration_plans: plan_doc = frappe.get_doc("Data Migration Plan", plan.name) for m in plan_doc.get("mappings"): diff --git a/erpnext/patches/v10_0/fichier_des_ecritures_comptables_for_france.py b/erpnext/patches/v10_0/fichier_des_ecritures_comptables_for_france.py index cdf5ba29141..44497299c47 100644 --- a/erpnext/patches/v10_0/fichier_des_ecritures_comptables_for_france.py +++ b/erpnext/patches/v10_0/fichier_des_ecritures_comptables_for_france.py @@ -8,6 +8,6 @@ from erpnext.setup.doctype.company.company import install_country_fixtures def execute(): - frappe.reload_doc('regional', 'report', 'fichier_des_ecritures_comptables_[fec]') - for d in frappe.get_all('Company', filters = {'country': 'France'}): + frappe.reload_doc("regional", "report", "fichier_des_ecritures_comptables_[fec]") + for d in frappe.get_all("Company", filters={"country": "France"}): install_country_fixtures(d.name) diff --git a/erpnext/patches/v10_0/item_barcode_childtable_migrate.py b/erpnext/patches/v10_0/item_barcode_childtable_migrate.py index ffff95d223c..e2d0943d724 100644 --- a/erpnext/patches/v10_0/item_barcode_childtable_migrate.py +++ b/erpnext/patches/v10_0/item_barcode_childtable_migrate.py @@ -7,26 +7,30 @@ import frappe def execute(): frappe.reload_doc("stock", "doctype", "item_barcode") - if frappe.get_all("Item Barcode", limit=1): return - if "barcode" not in frappe.db.get_table_columns("Item"): return + if frappe.get_all("Item Barcode", limit=1): + return + if "barcode" not in frappe.db.get_table_columns("Item"): + return - items_barcode = frappe.db.sql("select name, barcode from tabItem where barcode is not null", as_dict=True) + items_barcode = frappe.db.sql( + "select name, barcode from tabItem where barcode is not null", as_dict=True + ) frappe.reload_doc("stock", "doctype", "item") - - for item in items_barcode: barcode = item.barcode.strip() - if barcode and '<' not in barcode: + if barcode and "<" not in barcode: try: - frappe.get_doc({ - 'idx': 0, - 'doctype': 'Item Barcode', - 'barcode': barcode, - 'parenttype': 'Item', - 'parent': item.name, - 'parentfield': 'barcodes' - }).insert() + frappe.get_doc( + { + "idx": 0, + "doctype": "Item Barcode", + "barcode": barcode, + "parenttype": "Item", + "parent": item.name, + "parentfield": "barcodes", + } + ).insert() except (frappe.DuplicateEntryError, frappe.UniqueValidationError): continue diff --git a/erpnext/patches/v10_0/migrate_daily_work_summary_settings_to_daily_work_summary_group.py b/erpnext/patches/v10_0/migrate_daily_work_summary_settings_to_daily_work_summary_group.py index fd511849b2b..2cbbe055f67 100644 --- a/erpnext/patches/v10_0/migrate_daily_work_summary_settings_to_daily_work_summary_group.py +++ b/erpnext/patches/v10_0/migrate_daily_work_summary_settings_to_daily_work_summary_group.py @@ -6,13 +6,13 @@ import frappe def execute(): - if not frappe.db.table_exists('Daily Work Summary Group'): + if not frappe.db.table_exists("Daily Work Summary Group"): frappe.reload_doc("hr", "doctype", "daily_work_summary_group") frappe.reload_doc("hr", "doctype", "daily_work_summary_group_user") # check if Daily Work Summary Settings Company table exists try: - frappe.db.sql('DESC `tabDaily Work Summary Settings Company`') + frappe.db.sql("DESC `tabDaily Work Summary Settings Company`") except Exception: return @@ -20,19 +20,24 @@ def execute(): previous_setting = get_previous_setting() if previous_setting["companies"]: for d in previous_setting["companies"]: - users = frappe.get_list("Employee", dict( - company=d.company, user_id=("!=", " ")), "user_id as user") - if(len(users)): + users = frappe.get_list( + "Employee", dict(company=d.company, user_id=("!=", " ")), "user_id as user" + ) + if len(users): # create new group entry for each company entry - new_group = frappe.get_doc(dict(doctype="Daily Work Summary Group", - name="Daily Work Summary for " + d.company, - users=users, - send_emails_at=d.send_emails_at, - subject=previous_setting["subject"], - message=previous_setting["message"])) + new_group = frappe.get_doc( + dict( + doctype="Daily Work Summary Group", + name="Daily Work Summary for " + d.company, + users=users, + send_emails_at=d.send_emails_at, + subject=previous_setting["subject"], + message=previous_setting["message"], + ) + ) new_group.flags.ignore_permissions = True new_group.flags.ignore_validate = True - new_group.insert(ignore_if_duplicate = True) + new_group.insert(ignore_if_duplicate=True) frappe.delete_doc("DocType", "Daily Work Summary Settings") frappe.delete_doc("DocType", "Daily Work Summary Settings Company") @@ -41,11 +46,13 @@ def execute(): def get_previous_setting(): obj = {} setting_data = frappe.db.sql( - "select field, value from tabSingles where doctype='Daily Work Summary Settings'") + "select field, value from tabSingles where doctype='Daily Work Summary Settings'" + ) for field, value in setting_data: obj[field] = value obj["companies"] = get_setting_companies() return obj + def get_setting_companies(): return frappe.db.sql("select * from `tabDaily Work Summary Settings Company`", as_dict=True) diff --git a/erpnext/patches/v10_0/rename_offer_letter_to_job_offer.py b/erpnext/patches/v10_0/rename_offer_letter_to_job_offer.py index 00d0dd75e4c..a2deab62258 100644 --- a/erpnext/patches/v10_0/rename_offer_letter_to_job_offer.py +++ b/erpnext/patches/v10_0/rename_offer_letter_to_job_offer.py @@ -1,4 +1,3 @@ - import frappe diff --git a/erpnext/patches/v10_0/rename_price_to_rate_in_pricing_rule.py b/erpnext/patches/v10_0/rename_price_to_rate_in_pricing_rule.py index 152c5b3ec48..1d5518f0728 100644 --- a/erpnext/patches/v10_0/rename_price_to_rate_in_pricing_rule.py +++ b/erpnext/patches/v10_0/rename_price_to_rate_in_pricing_rule.py @@ -1,4 +1,3 @@ - import frappe from frappe.model.utils.rename_field import rename_field @@ -11,5 +10,5 @@ def execute(): rename_field("Pricing Rule", "price", "rate") except Exception as e: - if e.args[0]!=1054: + if e.args[0] != 1054: raise diff --git a/erpnext/patches/v10_0/set_currency_in_pricing_rule.py b/erpnext/patches/v10_0/set_currency_in_pricing_rule.py index 374df2a4dc7..d68148eec1c 100644 --- a/erpnext/patches/v10_0/set_currency_in_pricing_rule.py +++ b/erpnext/patches/v10_0/set_currency_in_pricing_rule.py @@ -1,4 +1,3 @@ - import frappe @@ -6,8 +5,10 @@ def execute(): frappe.reload_doctype("Pricing Rule") currency = frappe.db.get_default("currency") - for doc in frappe.get_all('Pricing Rule', fields = ["company", "name"]): + for doc in frappe.get_all("Pricing Rule", fields=["company", "name"]): if doc.company: - currency = frappe.get_cached_value('Company', doc.company, "default_currency") + currency = frappe.get_cached_value("Company", doc.company, "default_currency") - frappe.db.sql("""update `tabPricing Rule` set currency = %s where name = %s""",(currency, doc.name)) + frappe.db.sql( + """update `tabPricing Rule` set currency = %s where name = %s""", (currency, doc.name) + ) diff --git a/erpnext/patches/v10_0/update_translatable_fields.py b/erpnext/patches/v10_0/update_translatable_fields.py index f111ac7b9de..481ff93984a 100644 --- a/erpnext/patches/v10_0/update_translatable_fields.py +++ b/erpnext/patches/v10_0/update_translatable_fields.py @@ -1,41 +1,42 @@ -#-*- coding: utf-8 -*- +# -*- coding: utf-8 -*- import frappe def execute(): - ''' + """ Enable translatable in these fields - Customer Name - Supplier Name - Contact Name - Item Name/ Description - Address - ''' + """ - frappe.reload_doc('core', 'doctype', 'docfield') - frappe.reload_doc('custom', 'doctype', 'custom_field') + frappe.reload_doc("core", "doctype", "docfield") + frappe.reload_doc("custom", "doctype", "custom_field") enable_for_fields = [ - ['Customer', 'customer_name'], - ['Supplier', 'supplier_name'], - ['Contact', 'first_name'], - ['Contact', 'last_name'], - ['Item', 'item_name'], - ['Item', 'description'], - ['Address', 'address_line1'], - ['Address', 'address_line2'], + ["Customer", "customer_name"], + ["Supplier", "supplier_name"], + ["Contact", "first_name"], + ["Contact", "last_name"], + ["Item", "item_name"], + ["Item", "description"], + ["Address", "address_line1"], + ["Address", "address_line2"], ] - for f in enable_for_fields: - frappe.get_doc({ - 'doctype': 'Property Setter', - 'doc_type': f[0], - 'doctype_or_field': 'DocField', - 'field_name': f[1], - 'property': 'translatable', - 'propery_type': 'Check', - 'value': 1 - }).db_insert() + frappe.get_doc( + { + "doctype": "Property Setter", + "doc_type": f[0], + "doctype_or_field": "DocField", + "field_name": f[1], + "property": "translatable", + "propery_type": "Check", + "value": 1, + } + ).db_insert() diff --git a/erpnext/patches/v10_1/transfer_subscription_to_auto_repeat.py b/erpnext/patches/v10_1/transfer_subscription_to_auto_repeat.py index dcb4a57ba2a..87151c102b1 100644 --- a/erpnext/patches/v10_1/transfer_subscription_to_auto_repeat.py +++ b/erpnext/patches/v10_1/transfer_subscription_to_auto_repeat.py @@ -1,44 +1,59 @@ - import frappe from frappe.model.utils.rename_field import rename_field def execute(): - frappe.reload_doc('automation', 'doctype', 'auto_repeat') + frappe.reload_doc("automation", "doctype", "auto_repeat") doctypes_to_rename = { - 'accounts': ['Journal Entry', 'Payment Entry', 'Purchase Invoice', 'Sales Invoice'], - 'buying': ['Purchase Order', 'Supplier Quotation'], - 'selling': ['Quotation', 'Sales Order'], - 'stock': ['Delivery Note', 'Purchase Receipt'] + "accounts": ["Journal Entry", "Payment Entry", "Purchase Invoice", "Sales Invoice"], + "buying": ["Purchase Order", "Supplier Quotation"], + "selling": ["Quotation", "Sales Order"], + "stock": ["Delivery Note", "Purchase Receipt"], } for module, doctypes in doctypes_to_rename.items(): for doctype in doctypes: - frappe.reload_doc(module, 'doctype', frappe.scrub(doctype)) + frappe.reload_doc(module, "doctype", frappe.scrub(doctype)) - if frappe.db.has_column(doctype, 'subscription'): - rename_field(doctype, 'subscription', 'auto_repeat') + if frappe.db.has_column(doctype, "subscription"): + rename_field(doctype, "subscription", "auto_repeat") - subscriptions = frappe.db.sql('select * from `tabSubscription`', as_dict=1) + subscriptions = frappe.db.sql("select * from `tabSubscription`", as_dict=1) for doc in subscriptions: - doc['doctype'] = 'Auto Repeat' + doc["doctype"] = "Auto Repeat" auto_repeat = frappe.get_doc(doc) auto_repeat.db_insert() - frappe.db.sql('delete from `tabSubscription`') + frappe.db.sql("delete from `tabSubscription`") frappe.db.commit() drop_columns_from_subscription() + def drop_columns_from_subscription(): - fields_to_drop = {'Subscription': []} - for field in ['naming_series', 'reference_doctype', 'reference_document', 'start_date', - 'end_date', 'submit_on_creation', 'disabled', 'frequency', 'repeat_on_day', - 'next_schedule_date', 'notify_by_email', 'subject', 'recipients', 'print_format', - 'message', 'status', 'amended_from']: + fields_to_drop = {"Subscription": []} + for field in [ + "naming_series", + "reference_doctype", + "reference_document", + "start_date", + "end_date", + "submit_on_creation", + "disabled", + "frequency", + "repeat_on_day", + "next_schedule_date", + "notify_by_email", + "subject", + "recipients", + "print_format", + "message", + "status", + "amended_from", + ]: if field in frappe.db.get_table_columns("Subscription"): - fields_to_drop['Subscription'].append(field) + fields_to_drop["Subscription"].append(field) frappe.model.delete_fields(fields_to_drop, delete=1) diff --git a/erpnext/patches/v11_0/add_default_dispatch_notification_template.py b/erpnext/patches/v11_0/add_default_dispatch_notification_template.py index 784b0eeafa5..48ca9b9f5b2 100644 --- a/erpnext/patches/v11_0/add_default_dispatch_notification_template.py +++ b/erpnext/patches/v11_0/add_default_dispatch_notification_template.py @@ -1,4 +1,3 @@ - import os import frappe @@ -11,16 +10,21 @@ def execute(): if not frappe.db.exists("Email Template", _("Dispatch Notification")): base_path = frappe.get_app_path("erpnext", "stock", "doctype") - response = frappe.read_file(os.path.join(base_path, "delivery_trip/dispatch_notification_template.html")) + response = frappe.read_file( + os.path.join(base_path, "delivery_trip/dispatch_notification_template.html") + ) - frappe.get_doc({ - "doctype": "Email Template", - "name": _("Dispatch Notification"), - "response": response, - "subject": _("Your order is out for delivery!"), - "owner": frappe.session.user, - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Email Template", + "name": _("Dispatch Notification"), + "response": response, + "subject": _("Your order is out for delivery!"), + "owner": frappe.session.user, + } + ).insert(ignore_permissions=True) delivery_settings = frappe.get_doc("Delivery Settings") delivery_settings.dispatch_template = _("Dispatch Notification") + delivery_settings.flags.ignore_links = True delivery_settings.save() diff --git a/erpnext/patches/v11_0/add_default_email_template_for_leave.py b/erpnext/patches/v11_0/add_default_email_template_for_leave.py index e52d12429b5..1fddc7f11ef 100644 --- a/erpnext/patches/v11_0/add_default_email_template_for_leave.py +++ b/erpnext/patches/v11_0/add_default_email_template_for_leave.py @@ -1,4 +1,3 @@ - import os import frappe @@ -8,25 +7,32 @@ from frappe import _ def execute(): frappe.reload_doc("email", "doctype", "email_template") - if not frappe.db.exists("Email Template", _('Leave Approval Notification')): + if not frappe.db.exists("Email Template", _("Leave Approval Notification")): base_path = frappe.get_app_path("erpnext", "hr", "doctype") - response = frappe.read_file(os.path.join(base_path, "leave_application/leave_application_email_template.html")) - frappe.get_doc({ - 'doctype': 'Email Template', - 'name': _("Leave Approval Notification"), - 'response': response, - 'subject': _("Leave Approval Notification"), - 'owner': frappe.session.user, - }).insert(ignore_permissions=True) + response = frappe.read_file( + os.path.join(base_path, "leave_application/leave_application_email_template.html") + ) + frappe.get_doc( + { + "doctype": "Email Template", + "name": _("Leave Approval Notification"), + "response": response, + "subject": _("Leave Approval Notification"), + "owner": frappe.session.user, + } + ).insert(ignore_permissions=True) - - if not frappe.db.exists("Email Template", _('Leave Status Notification')): + if not frappe.db.exists("Email Template", _("Leave Status Notification")): base_path = frappe.get_app_path("erpnext", "hr", "doctype") - response = frappe.read_file(os.path.join(base_path, "leave_application/leave_application_email_template.html")) - frappe.get_doc({ - 'doctype': 'Email Template', - 'name': _("Leave Status Notification"), - 'response': response, - 'subject': _("Leave Status Notification"), - 'owner': frappe.session.user, - }).insert(ignore_permissions=True) + response = frappe.read_file( + os.path.join(base_path, "leave_application/leave_application_email_template.html") + ) + frappe.get_doc( + { + "doctype": "Email Template", + "name": _("Leave Status Notification"), + "response": response, + "subject": _("Leave Status Notification"), + "owner": frappe.session.user, + } + ).insert(ignore_permissions=True) diff --git a/erpnext/patches/v11_0/add_expense_claim_default_account.py b/erpnext/patches/v11_0/add_expense_claim_default_account.py index 8629798ba82..ff393502d7d 100644 --- a/erpnext/patches/v11_0/add_expense_claim_default_account.py +++ b/erpnext/patches/v11_0/add_expense_claim_default_account.py @@ -1,4 +1,3 @@ - import frappe @@ -9,4 +8,9 @@ def execute(): for company in companies: if company.default_payable_account is not None: - frappe.db.set_value("Company", company.name, "default_expense_claim_payable_account", company.default_payable_account) + frappe.db.set_value( + "Company", + company.name, + "default_expense_claim_payable_account", + company.default_payable_account, + ) diff --git a/erpnext/patches/v11_0/add_healthcare_service_unit_tree_root.py b/erpnext/patches/v11_0/add_healthcare_service_unit_tree_root.py index 6091216a009..c5405d7f1e8 100644 --- a/erpnext/patches/v11_0/add_healthcare_service_unit_tree_root.py +++ b/erpnext/patches/v11_0/add_healthcare_service_unit_tree_root.py @@ -1,10 +1,9 @@ - import frappe from frappe import _ def execute(): - """ assign lft and rgt appropriately """ + """assign lft and rgt appropriately""" if "Healthcare" not in frappe.get_active_domains(): return @@ -13,9 +12,11 @@ def execute(): company = frappe.get_value("Company", {"domain": "Healthcare"}, "name") if company: - frappe.get_doc({ - 'doctype': 'Healthcare Service Unit', - 'healthcare_service_unit_name': _('All Healthcare Service Units'), - 'is_group': 1, - 'company': company - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Healthcare Service Unit", + "healthcare_service_unit_name": _("All Healthcare Service Units"), + "is_group": 1, + "company": company, + } + ).insert(ignore_permissions=True) diff --git a/erpnext/patches/v11_0/add_index_on_nestedset_doctypes.py b/erpnext/patches/v11_0/add_index_on_nestedset_doctypes.py index 7c99f580f7c..f354616fe7f 100644 --- a/erpnext/patches/v11_0/add_index_on_nestedset_doctypes.py +++ b/erpnext/patches/v11_0/add_index_on_nestedset_doctypes.py @@ -7,6 +7,16 @@ import frappe def execute(): frappe.reload_doc("assets", "doctype", "Location") - for dt in ("Account", "Cost Center", "File", "Employee", "Location", "Task", "Customer Group", "Sales Person", "Territory"): + for dt in ( + "Account", + "Cost Center", + "File", + "Employee", + "Location", + "Task", + "Customer Group", + "Sales Person", + "Territory", + ): frappe.reload_doctype(dt) frappe.get_doc("DocType", dt).run_module_method("on_doctype_update") diff --git a/erpnext/patches/v11_0/add_item_group_defaults.py b/erpnext/patches/v11_0/add_item_group_defaults.py index 026047a9612..4e6505a3565 100644 --- a/erpnext/patches/v11_0/add_item_group_defaults.py +++ b/erpnext/patches/v11_0/add_item_group_defaults.py @@ -6,31 +6,36 @@ import frappe def execute(): - ''' + """ Fields to move from item group to item defaults child table [ default_cost_center, default_expense_account, default_income_account ] - ''' + """ - frappe.reload_doc('stock', 'doctype', 'item_default') - frappe.reload_doc('setup', 'doctype', 'item_group') + frappe.reload_doc("stock", "doctype", "item_default") + frappe.reload_doc("setup", "doctype", "item_group") companies = frappe.get_all("Company") - item_groups = frappe.db.sql("""select name, default_income_account, default_expense_account,\ - default_cost_center from `tabItem Group`""", as_dict=True) + item_groups = frappe.db.sql( + """select name, default_income_account, default_expense_account,\ + default_cost_center from `tabItem Group`""", + as_dict=True, + ) if len(companies) == 1: for item_group in item_groups: doc = frappe.get_doc("Item Group", item_group.get("name")) item_group_defaults = [] - item_group_defaults.append({ - "company": companies[0].name, - "income_account": item_group.get("default_income_account"), - "expense_account": item_group.get("default_expense_account"), - "buying_cost_center": item_group.get("default_cost_center"), - "selling_cost_center": item_group.get("default_cost_center") - }) + item_group_defaults.append( + { + "company": companies[0].name, + "income_account": item_group.get("default_income_account"), + "expense_account": item_group.get("default_expense_account"), + "buying_cost_center": item_group.get("default_cost_center"), + "selling_cost_center": item_group.get("default_cost_center"), + } + ) doc.extend("item_group_defaults", item_group_defaults) for child_doc in doc.item_group_defaults: child_doc.db_insert() @@ -38,10 +43,11 @@ def execute(): item_group_dict = { "default_expense_account": ["expense_account"], "default_income_account": ["income_account"], - "default_cost_center": ["buying_cost_center", "selling_cost_center"] + "default_cost_center": ["buying_cost_center", "selling_cost_center"], } for item_group in item_groups: item_group_defaults = [] + def insert_into_item_defaults(doc_field_name, doc_field_value, company): for d in item_group_defaults: if d.get("company") == company: @@ -50,18 +56,16 @@ def execute(): d[doc_field_name[1]] = doc_field_value return - item_group_defaults.append({ - "company": company, - doc_field_name[0]: doc_field_value - }) + item_group_defaults.append({"company": company, doc_field_name[0]: doc_field_value}) - if(len(doc_field_name) > 1): - item_group_defaults[len(item_group_defaults)-1][doc_field_name[1]] = doc_field_value + if len(doc_field_name) > 1: + item_group_defaults[len(item_group_defaults) - 1][doc_field_name[1]] = doc_field_value for d in [ - ["default_expense_account", "Account"], ["default_income_account", "Account"], - ["default_cost_center", "Cost Center"] - ]: + ["default_expense_account", "Account"], + ["default_income_account", "Account"], + ["default_cost_center", "Cost Center"], + ]: if item_group.get(d[0]): company = frappe.get_value(d[1], item_group.get(d[0]), "company", cache=True) doc_field_name = item_group_dict.get(d[0]) diff --git a/erpnext/patches/v11_0/add_market_segments.py b/erpnext/patches/v11_0/add_market_segments.py index 820199569ab..d1111c21e07 100644 --- a/erpnext/patches/v11_0/add_market_segments.py +++ b/erpnext/patches/v11_0/add_market_segments.py @@ -1,12 +1,11 @@ - import frappe from erpnext.setup.setup_wizard.operations.install_fixtures import add_market_segments def execute(): - frappe.reload_doc('crm', 'doctype', 'market_segment') + frappe.reload_doc("crm", "doctype", "market_segment") - frappe.local.lang = frappe.db.get_default("lang") or 'en' + frappe.local.lang = frappe.db.get_default("lang") or "en" add_market_segments() diff --git a/erpnext/patches/v11_0/add_permissions_in_gst_settings.py b/erpnext/patches/v11_0/add_permissions_in_gst_settings.py index 9df1b586e30..f3429ef1c91 100644 --- a/erpnext/patches/v11_0/add_permissions_in_gst_settings.py +++ b/erpnext/patches/v11_0/add_permissions_in_gst_settings.py @@ -4,7 +4,7 @@ from erpnext.regional.india.setup import add_permissions def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return diff --git a/erpnext/patches/v11_0/add_sales_stages.py b/erpnext/patches/v11_0/add_sales_stages.py index 1699572551b..0dac1e10ed2 100644 --- a/erpnext/patches/v11_0/add_sales_stages.py +++ b/erpnext/patches/v11_0/add_sales_stages.py @@ -1,12 +1,11 @@ - import frappe from erpnext.setup.setup_wizard.operations.install_fixtures import add_sale_stages def execute(): - frappe.reload_doc('crm', 'doctype', 'sales_stage') + frappe.reload_doc("crm", "doctype", "sales_stage") - frappe.local.lang = frappe.db.get_default("lang") or 'en' + frappe.local.lang = frappe.db.get_default("lang") or "en" add_sale_stages() diff --git a/erpnext/patches/v11_0/check_buying_selling_in_currency_exchange.py b/erpnext/patches/v11_0/check_buying_selling_in_currency_exchange.py index 039238f9e1b..d9d7981965b 100644 --- a/erpnext/patches/v11_0/check_buying_selling_in_currency_exchange.py +++ b/erpnext/patches/v11_0/check_buying_selling_in_currency_exchange.py @@ -1,7 +1,6 @@ - import frappe def execute(): - frappe.reload_doc('setup', 'doctype', 'currency_exchange') + frappe.reload_doc("setup", "doctype", "currency_exchange") frappe.db.sql("""update `tabCurrency Exchange` set for_buying = 1, for_selling = 1""") diff --git a/erpnext/patches/v11_0/create_default_success_action.py b/erpnext/patches/v11_0/create_default_success_action.py index b45065cb0d2..e7b412cc5f2 100644 --- a/erpnext/patches/v11_0/create_default_success_action.py +++ b/erpnext/patches/v11_0/create_default_success_action.py @@ -1,4 +1,3 @@ - import frappe from erpnext.setup.install import create_default_success_action diff --git a/erpnext/patches/v11_0/create_department_records_for_each_company.py b/erpnext/patches/v11_0/create_department_records_for_each_company.py index a4cba0cfcca..84be2bee9dc 100644 --- a/erpnext/patches/v11_0/create_department_records_for_each_company.py +++ b/erpnext/patches/v11_0/create_department_records_for_each_company.py @@ -1,15 +1,14 @@ - import frappe from frappe import _ from frappe.utils.nestedset import rebuild_tree def execute(): - frappe.local.lang = frappe.db.get_default("lang") or 'en' + frappe.local.lang = frappe.db.get_default("lang") or "en" - for doctype in ['department', 'leave_period', 'staffing_plan', 'job_opening']: + for doctype in ["department", "leave_period", "staffing_plan", "job_opening"]: frappe.reload_doc("hr", "doctype", doctype) - frappe.reload_doc("Payroll", "doctype", 'payroll_entry') + frappe.reload_doc("Payroll", "doctype", "payroll_entry") companies = frappe.db.get_all("Company", fields=["name", "abbr"]) departments = frappe.db.get_all("Department") @@ -36,7 +35,7 @@ def execute(): # append list of new department for each company comp_dict[company.name][department.name] = copy_doc.name - rebuild_tree('Department', 'parent_department') + rebuild_tree("Department", "parent_department") doctypes = ["Asset", "Employee", "Payroll Entry", "Staffing Plan", "Job Opening"] for d in doctypes: @@ -44,7 +43,8 @@ def execute(): update_instructors(comp_dict) - frappe.local.lang = 'en' + frappe.local.lang = "en" + def update_records(doctype, comp_dict): when_then = [] @@ -52,20 +52,27 @@ def update_records(doctype, comp_dict): records = comp_dict[company] for department in records: - when_then.append(''' + when_then.append( + """ WHEN company = "%s" and department = "%s" THEN "%s" - '''%(company, department, records[department])) + """ + % (company, department, records[department]) + ) if not when_then: return - frappe.db.sql(""" + frappe.db.sql( + """ update `tab%s` set department = CASE %s END - """%(doctype, " ".join(when_then))) + """ + % (doctype, " ".join(when_then)) + ) + def update_instructors(comp_dict): when_then = [] @@ -75,17 +82,23 @@ def update_instructors(comp_dict): records = comp_dict[employee.company] if employee.company else [] for department in records: - when_then.append(''' + when_then.append( + """ WHEN employee = "%s" and department = "%s" THEN "%s" - '''%(employee.name, department, records[department])) + """ + % (employee.name, department, records[department]) + ) if not when_then: return - frappe.db.sql(""" + frappe.db.sql( + """ update `tabInstructor` set department = CASE %s END - """%(" ".join(when_then))) + """ + % (" ".join(when_then)) + ) diff --git a/erpnext/patches/v11_0/create_salary_structure_assignments.py b/erpnext/patches/v11_0/create_salary_structure_assignments.py index 823eca19b07..b81e867b9dd 100644 --- a/erpnext/patches/v11_0/create_salary_structure_assignments.py +++ b/erpnext/patches/v11_0/create_salary_structure_assignments.py @@ -13,48 +13,62 @@ from erpnext.payroll.doctype.salary_structure_assignment.salary_structure_assign def execute(): - frappe.reload_doc('Payroll', 'doctype', 'Salary Structure') + frappe.reload_doc("Payroll", "doctype", "Salary Structure") frappe.reload_doc("Payroll", "doctype", "Salary Structure Assignment") - frappe.db.sql(""" + frappe.db.sql( + """ delete from `tabSalary Structure Assignment` where salary_structure in (select name from `tabSalary Structure` where is_active='No' or docstatus!=1) - """) - if frappe.db.table_exists('Salary Structure Employee'): - ss_details = frappe.db.sql(""" + """ + ) + if frappe.db.table_exists("Salary Structure Employee"): + ss_details = frappe.db.sql( + """ select sse.employee, sse.employee_name, sse.from_date, sse.to_date, sse.base, sse.variable, sse.parent as salary_structure, ss.company from `tabSalary Structure Employee` sse, `tabSalary Structure` ss where ss.name = sse.parent AND ss.is_active='Yes' - AND sse.employee in (select name from `tabEmployee` where ifNull(status, '') != 'Left')""", as_dict=1) + AND sse.employee in (select name from `tabEmployee` where ifNull(status, '') != 'Left')""", + as_dict=1, + ) else: cols = "" if "base" in frappe.db.get_table_columns("Salary Structure"): cols = ", base, variable" - ss_details = frappe.db.sql(""" + ss_details = frappe.db.sql( + """ select name as salary_structure, employee, employee_name, from_date, to_date, company {0} from `tabSalary Structure` where is_active='Yes' AND employee in (select name from `tabEmployee` where ifNull(status, '') != 'Left') - """.format(cols), as_dict=1) + """.format( + cols + ), + as_dict=1, + ) all_companies = frappe.db.get_all("Company", fields=["name", "default_currency"]) for d in all_companies: company = d.name company_currency = d.default_currency - frappe.db.sql("""update `tabSalary Structure` set currency = %s where company=%s""", (company_currency, company)) + frappe.db.sql( + """update `tabSalary Structure` set currency = %s where company=%s""", + (company_currency, company), + ) for d in ss_details: try: - joining_date, relieving_date = frappe.db.get_value("Employee", d.employee, - ["date_of_joining", "relieving_date"]) + joining_date, relieving_date = frappe.db.get_value( + "Employee", d.employee, ["date_of_joining", "relieving_date"] + ) from_date = d.from_date if joining_date and getdate(from_date) < joining_date: from_date = joining_date elif relieving_date and getdate(from_date) > relieving_date: continue - company_currency = frappe.db.get_value('Company', d.company, 'default_currency') + company_currency = frappe.db.get_value("Company", d.company, "default_currency") s = frappe.new_doc("Salary Structure Assignment") s.employee = d.employee diff --git a/erpnext/patches/v11_0/drop_column_max_days_allowed.py b/erpnext/patches/v11_0/drop_column_max_days_allowed.py index 5c549258584..4b4770d809c 100644 --- a/erpnext/patches/v11_0/drop_column_max_days_allowed.py +++ b/erpnext/patches/v11_0/drop_column_max_days_allowed.py @@ -1,8 +1,7 @@ - import frappe def execute(): if frappe.db.exists("DocType", "Leave Type"): - if 'max_days_allowed' in frappe.db.get_table_columns("Leave Type"): + if "max_days_allowed" in frappe.db.get_table_columns("Leave Type"): frappe.db.sql("alter table `tabLeave Type` drop column max_days_allowed") diff --git a/erpnext/patches/v11_0/ewaybill_fields_gst_india.py b/erpnext/patches/v11_0/ewaybill_fields_gst_india.py index a7e662c78c5..7a06d522426 100644 --- a/erpnext/patches/v11_0/ewaybill_fields_gst_india.py +++ b/erpnext/patches/v11_0/ewaybill_fields_gst_india.py @@ -1,12 +1,11 @@ - import frappe from erpnext.regional.india.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) - if not company: - return + company = frappe.get_all("Company", filters={"country": "India"}) + if not company: + return - make_custom_fields() + make_custom_fields() diff --git a/erpnext/patches/v11_0/hr_ux_cleanups.py b/erpnext/patches/v11_0/hr_ux_cleanups.py index 00678c781e7..0749bfc0b9d 100644 --- a/erpnext/patches/v11_0/hr_ux_cleanups.py +++ b/erpnext/patches/v11_0/hr_ux_cleanups.py @@ -1,13 +1,12 @@ - import frappe def execute(): - frappe.reload_doctype('Employee') - frappe.db.sql('update tabEmployee set first_name = employee_name') + frappe.reload_doctype("Employee") + frappe.db.sql("update tabEmployee set first_name = employee_name") # update holiday list - frappe.reload_doctype('Holiday List') - for holiday_list in frappe.get_all('Holiday List'): - holiday_list = frappe.get_doc('Holiday List', holiday_list.name) - holiday_list.db_set('total_holidays', len(holiday_list.holidays), update_modified = False) + frappe.reload_doctype("Holiday List") + for holiday_list in frappe.get_all("Holiday List"): + holiday_list = frappe.get_doc("Holiday List", holiday_list.name) + holiday_list.db_set("total_holidays", len(holiday_list.holidays), update_modified=False) diff --git a/erpnext/patches/v11_0/inter_state_field_for_gst.py b/erpnext/patches/v11_0/inter_state_field_for_gst.py index d897941eab2..b8510297c28 100644 --- a/erpnext/patches/v11_0/inter_state_field_for_gst.py +++ b/erpnext/patches/v11_0/inter_state_field_for_gst.py @@ -1,11 +1,10 @@ - import frappe from erpnext.regional.india.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return frappe.reload_doc("Payroll", "doctype", "Employee Tax Exemption Declaration") @@ -29,38 +28,64 @@ def execute(): frappe.reload_doc("accounts", "doctype", "purchase_taxes_and_charges_template") # set is_inter_state in Taxes And Charges Templates - if frappe.db.has_column("Sales Taxes and Charges Template", "is_inter_state") and\ - frappe.db.has_column("Purchase Taxes and Charges Template", "is_inter_state"): + if frappe.db.has_column( + "Sales Taxes and Charges Template", "is_inter_state" + ) and frappe.db.has_column("Purchase Taxes and Charges Template", "is_inter_state"): - igst_accounts = set(frappe.db.sql_list('''SELECT igst_account from `tabGST Account` WHERE parent = "GST Settings"''')) - cgst_accounts = set(frappe.db.sql_list('''SELECT cgst_account FROM `tabGST Account` WHERE parenttype = "GST Settings"''')) + igst_accounts = set( + frappe.db.sql_list( + '''SELECT igst_account from `tabGST Account` WHERE parent = "GST Settings"''' + ) + ) + cgst_accounts = set( + frappe.db.sql_list( + '''SELECT cgst_account FROM `tabGST Account` WHERE parenttype = "GST Settings"''' + ) + ) when_then_sales = get_formatted_data("Sales Taxes and Charges", igst_accounts, cgst_accounts) - when_then_purchase = get_formatted_data("Purchase Taxes and Charges", igst_accounts, cgst_accounts) + when_then_purchase = get_formatted_data( + "Purchase Taxes and Charges", igst_accounts, cgst_accounts + ) if when_then_sales: - frappe.db.sql('''update `tabSales Taxes and Charges Template` + frappe.db.sql( + """update `tabSales Taxes and Charges Template` set is_inter_state = Case {when_then} Else 0 End - '''.format(when_then=" ".join(when_then_sales))) + """.format( + when_then=" ".join(when_then_sales) + ) + ) if when_then_purchase: - frappe.db.sql('''update `tabPurchase Taxes and Charges Template` + frappe.db.sql( + """update `tabPurchase Taxes and Charges Template` set is_inter_state = Case {when_then} Else 0 End - '''.format(when_then=" ".join(when_then_purchase))) + """.format( + when_then=" ".join(when_then_purchase) + ) + ) + def get_formatted_data(doctype, igst_accounts, cgst_accounts): # fetch all the rows data from child table - all_details = frappe.db.sql(''' + all_details = frappe.db.sql( + ''' select parent, account_head from `tab{doctype}` - where parenttype="{doctype} Template"'''.format(doctype=doctype), as_dict=True) + where parenttype="{doctype} Template"'''.format( + doctype=doctype + ), + as_dict=True, + ) # group the data in the form "parent: [list of accounts]"" group_detail = {} for i in all_details: - if not i['parent'] in group_detail: group_detail[i['parent']] = [] + if not i["parent"] in group_detail: + group_detail[i["parent"]] = [] for j in all_details: - if i['parent']==j['parent']: - group_detail[i['parent']].append(j['account_head']) + if i["parent"] == j["parent"]: + group_detail[i["parent"]].append(j["account_head"]) # form when_then condition based on - if list of accounts for a document # matches any account in igst_accounts list and not matches any in cgst_accounts list @@ -68,6 +93,6 @@ def get_formatted_data(doctype, igst_accounts, cgst_accounts): for i in group_detail: temp = set(group_detail[i]) if not temp.isdisjoint(igst_accounts) and temp.isdisjoint(cgst_accounts): - when_then.append('''When name='{name}' Then 1'''.format(name=i)) + when_then.append("""When name='{name}' Then 1""".format(name=i)) return when_then diff --git a/erpnext/patches/v11_0/make_asset_finance_book_against_old_entries.py b/erpnext/patches/v11_0/make_asset_finance_book_against_old_entries.py index cd3869b3600..213145653d3 100644 --- a/erpnext/patches/v11_0/make_asset_finance_book_against_old_entries.py +++ b/erpnext/patches/v11_0/make_asset_finance_book_against_old_entries.py @@ -6,40 +6,50 @@ import frappe def execute(): - frappe.reload_doc('assets', 'doctype', 'asset_finance_book') - frappe.reload_doc('assets', 'doctype', 'depreciation_schedule') - frappe.reload_doc('assets', 'doctype', 'asset_category') - frappe.reload_doc('assets', 'doctype', 'asset') - frappe.reload_doc('assets', 'doctype', 'asset_movement') - frappe.reload_doc('assets', 'doctype', 'asset_category_account') + frappe.reload_doc("assets", "doctype", "asset_finance_book") + frappe.reload_doc("assets", "doctype", "depreciation_schedule") + frappe.reload_doc("assets", "doctype", "asset_category") + frappe.reload_doc("assets", "doctype", "asset") + frappe.reload_doc("assets", "doctype", "asset_movement") + frappe.reload_doc("assets", "doctype", "asset_category_account") if frappe.db.has_column("Asset", "warehouse"): - frappe.db.sql(""" update `tabAsset` ast, `tabWarehouse` wh - set ast.location = wh.warehouse_name where ast.warehouse = wh.name""") + frappe.db.sql( + """ update `tabAsset` ast, `tabWarehouse` wh + set ast.location = wh.warehouse_name where ast.warehouse = wh.name""" + ) - for d in frappe.get_all('Asset'): - doc = frappe.get_doc('Asset', d.name) + for d in frappe.get_all("Asset"): + doc = frappe.get_doc("Asset", d.name) if doc.calculate_depreciation: - fb = doc.append('finance_books', { - 'depreciation_method': doc.depreciation_method, - 'total_number_of_depreciations': doc.total_number_of_depreciations, - 'frequency_of_depreciation': doc.frequency_of_depreciation, - 'depreciation_start_date': doc.next_depreciation_date, - 'expected_value_after_useful_life': doc.expected_value_after_useful_life, - 'value_after_depreciation': doc.value_after_depreciation - }) + fb = doc.append( + "finance_books", + { + "depreciation_method": doc.depreciation_method, + "total_number_of_depreciations": doc.total_number_of_depreciations, + "frequency_of_depreciation": doc.frequency_of_depreciation, + "depreciation_start_date": doc.next_depreciation_date, + "expected_value_after_useful_life": doc.expected_value_after_useful_life, + "value_after_depreciation": doc.value_after_depreciation, + }, + ) fb.db_update() - frappe.db.sql(""" update `tabDepreciation Schedule` ds, `tabAsset` ast - set ds.depreciation_method = ast.depreciation_method, ds.finance_book_id = 1 where ds.parent = ast.name """) + frappe.db.sql( + """ update `tabDepreciation Schedule` ds, `tabAsset` ast + set ds.depreciation_method = ast.depreciation_method, ds.finance_book_id = 1 where ds.parent = ast.name """ + ) - for category in frappe.get_all('Asset Category'): + for category in frappe.get_all("Asset Category"): asset_category_doc = frappe.get_doc("Asset Category", category) - row = asset_category_doc.append('finance_books', { - 'depreciation_method': asset_category_doc.depreciation_method, - 'total_number_of_depreciations': asset_category_doc.total_number_of_depreciations, - 'frequency_of_depreciation': asset_category_doc.frequency_of_depreciation - }) + row = asset_category_doc.append( + "finance_books", + { + "depreciation_method": asset_category_doc.depreciation_method, + "total_number_of_depreciations": asset_category_doc.total_number_of_depreciations, + "frequency_of_depreciation": asset_category_doc.frequency_of_depreciation, + }, + ) row.db_update() diff --git a/erpnext/patches/v11_0/make_italian_localization_fields.py b/erpnext/patches/v11_0/make_italian_localization_fields.py index 8ff23a50d4b..1b9793df80b 100644 --- a/erpnext/patches/v11_0/make_italian_localization_fields.py +++ b/erpnext/patches/v11_0/make_italian_localization_fields.py @@ -9,11 +9,11 @@ from erpnext.regional.italy.setup import make_custom_fields, setup_report def execute(): - company = frappe.get_all('Company', filters = {'country': 'Italy'}) + company = frappe.get_all("Company", filters={"country": "Italy"}) if not company: return - frappe.reload_doc('regional', 'report', 'electronic_invoice_register') + frappe.reload_doc("regional", "report", "electronic_invoice_register") make_custom_fields() setup_report() @@ -25,15 +25,21 @@ def execute(): if condition: condition = "state_code = (case state {0} end),".format(condition) - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE tabAddress set {condition} country_code = UPPER(ifnull((select code from `tabCountry` where name = `tabAddress`.country), '')) where country_code is null and state_code is null - """.format(condition=condition)) + """.format( + condition=condition + ) + ) - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabSales Invoice Item` si, `tabSales Order` so set si.customer_po_no = so.po_no, si.customer_po_date = so.po_date WHERE si.sales_order = so.name and so.po_no is not null - """) + """ + ) diff --git a/erpnext/patches/v11_0/make_job_card.py b/erpnext/patches/v11_0/make_job_card.py index 120e018805a..d4b208956b8 100644 --- a/erpnext/patches/v11_0/make_job_card.py +++ b/erpnext/patches/v11_0/make_job_card.py @@ -8,21 +8,26 @@ from erpnext.manufacturing.doctype.work_order.work_order import create_job_card def execute(): - frappe.reload_doc('manufacturing', 'doctype', 'work_order') - frappe.reload_doc('manufacturing', 'doctype', 'work_order_item') - frappe.reload_doc('manufacturing', 'doctype', 'job_card') - frappe.reload_doc('manufacturing', 'doctype', 'job_card_item') + frappe.reload_doc("manufacturing", "doctype", "work_order") + frappe.reload_doc("manufacturing", "doctype", "work_order_item") + frappe.reload_doc("manufacturing", "doctype", "job_card") + frappe.reload_doc("manufacturing", "doctype", "job_card_item") - fieldname = frappe.db.get_value('DocField', {'fieldname': 'work_order', 'parent': 'Timesheet'}, 'fieldname') + fieldname = frappe.db.get_value( + "DocField", {"fieldname": "work_order", "parent": "Timesheet"}, "fieldname" + ) if not fieldname: - fieldname = frappe.db.get_value('DocField', {'fieldname': 'production_order', 'parent': 'Timesheet'}, 'fieldname') - if not fieldname: return + fieldname = frappe.db.get_value( + "DocField", {"fieldname": "production_order", "parent": "Timesheet"}, "fieldname" + ) + if not fieldname: + return - for d in frappe.get_all('Timesheet', - filters={fieldname: ['!=', ""], 'docstatus': 0}, - fields=[fieldname, 'name']): + for d in frappe.get_all( + "Timesheet", filters={fieldname: ["!=", ""], "docstatus": 0}, fields=[fieldname, "name"] + ): if d[fieldname]: - doc = frappe.get_doc('Work Order', d[fieldname]) + doc = frappe.get_doc("Work Order", d[fieldname]) for row in doc.operations: create_job_card(doc, row, auto_create=True) - frappe.delete_doc('Timesheet', d.name) + frappe.delete_doc("Timesheet", d.name) diff --git a/erpnext/patches/v11_0/make_location_from_warehouse.py b/erpnext/patches/v11_0/make_location_from_warehouse.py index ef6262be15e..c863bb7ecf7 100644 --- a/erpnext/patches/v11_0/make_location_from_warehouse.py +++ b/erpnext/patches/v11_0/make_location_from_warehouse.py @@ -7,14 +7,16 @@ from frappe.utils.nestedset import rebuild_tree def execute(): - if not frappe.db.get_value('Asset', {'docstatus': ('<', 2) }, 'name'): return - frappe.reload_doc('assets', 'doctype', 'location') - frappe.reload_doc('stock', 'doctype', 'warehouse') + if not frappe.db.get_value("Asset", {"docstatus": ("<", 2)}, "name"): + return + frappe.reload_doc("assets", "doctype", "location") + frappe.reload_doc("stock", "doctype", "warehouse") - for d in frappe.get_all('Warehouse', - fields = ['warehouse_name', 'is_group', 'parent_warehouse'], order_by="lft asc"): + for d in frappe.get_all( + "Warehouse", fields=["warehouse_name", "is_group", "parent_warehouse"], order_by="lft asc" + ): try: - loc = frappe.new_doc('Location') + loc = frappe.new_doc("Location") loc.location_name = d.warehouse_name loc.is_group = d.is_group loc.flags.ignore_mandatory = True @@ -27,5 +29,6 @@ def execute(): rebuild_tree("Location", "parent_location") + def get_parent_warehouse_name(warehouse): - return frappe.db.get_value('Warehouse', warehouse, 'warehouse_name') + return frappe.db.get_value("Warehouse", warehouse, "warehouse_name") diff --git a/erpnext/patches/v11_0/make_quality_inspection_template.py b/erpnext/patches/v11_0/make_quality_inspection_template.py index 58c9fb9239f..deebfa88e6e 100644 --- a/erpnext/patches/v11_0/make_quality_inspection_template.py +++ b/erpnext/patches/v11_0/make_quality_inspection_template.py @@ -6,21 +6,29 @@ import frappe def execute(): - frappe.reload_doc('stock', 'doctype', 'quality_inspection_template') - frappe.reload_doc('stock', 'doctype', 'item') + frappe.reload_doc("stock", "doctype", "quality_inspection_template") + frappe.reload_doc("stock", "doctype", "item") - for data in frappe.get_all('Item Quality Inspection Parameter', - fields = ["distinct parent"], filters = {'parenttype': 'Item'}): + for data in frappe.get_all( + "Item Quality Inspection Parameter", fields=["distinct parent"], filters={"parenttype": "Item"} + ): qc_doc = frappe.new_doc("Quality Inspection Template") - qc_doc.quality_inspection_template_name = 'QIT/%s' % data.parent + qc_doc.quality_inspection_template_name = "QIT/%s" % data.parent qc_doc.flags.ignore_mandatory = True qc_doc.save(ignore_permissions=True) - frappe.db.set_value('Item', data.parent, "quality_inspection_template", qc_doc.name, update_modified=False) - frappe.db.sql(""" update `tabItem Quality Inspection Parameter` + frappe.db.set_value( + "Item", data.parent, "quality_inspection_template", qc_doc.name, update_modified=False + ) + frappe.db.sql( + """ update `tabItem Quality Inspection Parameter` set parentfield = 'item_quality_inspection_parameter', parenttype = 'Quality Inspection Template', - parent = %s where parenttype = 'Item' and parent = %s""", (qc_doc.name, data.parent)) + parent = %s where parenttype = 'Item' and parent = %s""", + (qc_doc.name, data.parent), + ) # update field in item variant settings - frappe.db.sql(""" update `tabVariant Field` set field_name = 'quality_inspection_template' - where field_name = 'quality_parameters'""") + frappe.db.sql( + """ update `tabVariant Field` set field_name = 'quality_inspection_template' + where field_name = 'quality_parameters'""" + ) diff --git a/erpnext/patches/v11_0/merge_land_unit_with_location.py b/erpnext/patches/v11_0/merge_land_unit_with_location.py index e1d0b127b9d..c1afef67785 100644 --- a/erpnext/patches/v11_0/merge_land_unit_with_location.py +++ b/erpnext/patches/v11_0/merge_land_unit_with_location.py @@ -8,51 +8,55 @@ from frappe.model.utils.rename_field import rename_field def execute(): # Rename and reload the Land Unit and Linked Land Unit doctypes - if frappe.db.table_exists('Land Unit') and not frappe.db.table_exists('Location'): - frappe.rename_doc('DocType', 'Land Unit', 'Location', force=True) + if frappe.db.table_exists("Land Unit") and not frappe.db.table_exists("Location"): + frappe.rename_doc("DocType", "Land Unit", "Location", force=True) - frappe.reload_doc('assets', 'doctype', 'location') + frappe.reload_doc("assets", "doctype", "location") - if frappe.db.table_exists('Linked Land Unit') and not frappe.db.table_exists('Linked Location'): - frappe.rename_doc('DocType', 'Linked Land Unit', 'Linked Location', force=True) + if frappe.db.table_exists("Linked Land Unit") and not frappe.db.table_exists("Linked Location"): + frappe.rename_doc("DocType", "Linked Land Unit", "Linked Location", force=True) - frappe.reload_doc('assets', 'doctype', 'linked_location') + frappe.reload_doc("assets", "doctype", "linked_location") - if not frappe.db.table_exists('Crop Cycle'): - frappe.reload_doc('agriculture', 'doctype', 'crop_cycle') + if not frappe.db.table_exists("Crop Cycle"): + frappe.reload_doc("agriculture", "doctype", "crop_cycle") # Rename the fields in related doctypes - if 'linked_land_unit' in frappe.db.get_table_columns('Crop Cycle'): - rename_field('Crop Cycle', 'linked_land_unit', 'linked_location') + if "linked_land_unit" in frappe.db.get_table_columns("Crop Cycle"): + rename_field("Crop Cycle", "linked_land_unit", "linked_location") - if 'land_unit' in frappe.db.get_table_columns('Linked Location'): - rename_field('Linked Location', 'land_unit', 'location') + if "land_unit" in frappe.db.get_table_columns("Linked Location"): + rename_field("Linked Location", "land_unit", "location") if not frappe.db.exists("Location", "All Land Units"): - frappe.get_doc({"doctype": "Location", "is_group": True, "location_name": "All Land Units"}).insert(ignore_permissions=True) + frappe.get_doc( + {"doctype": "Location", "is_group": True, "location_name": "All Land Units"} + ).insert(ignore_permissions=True) - if frappe.db.table_exists('Land Unit'): - land_units = frappe.get_all('Land Unit', fields=['*'], order_by='lft') + if frappe.db.table_exists("Land Unit"): + land_units = frappe.get_all("Land Unit", fields=["*"], order_by="lft") for land_unit in land_units: - if not frappe.db.exists('Location', land_unit.get('land_unit_name')): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': land_unit.get('land_unit_name'), - 'parent_location': land_unit.get('parent_land_unit') or "All Land Units", - 'is_container': land_unit.get('is_container'), - 'is_group': land_unit.get('is_group'), - 'latitude': land_unit.get('latitude'), - 'longitude': land_unit.get('longitude'), - 'area': land_unit.get('area'), - 'location': land_unit.get('location'), - 'lft': land_unit.get('lft'), - 'rgt': land_unit.get('rgt') - }).insert(ignore_permissions=True) + if not frappe.db.exists("Location", land_unit.get("land_unit_name")): + frappe.get_doc( + { + "doctype": "Location", + "location_name": land_unit.get("land_unit_name"), + "parent_location": land_unit.get("parent_land_unit") or "All Land Units", + "is_container": land_unit.get("is_container"), + "is_group": land_unit.get("is_group"), + "latitude": land_unit.get("latitude"), + "longitude": land_unit.get("longitude"), + "area": land_unit.get("area"), + "location": land_unit.get("location"), + "lft": land_unit.get("lft"), + "rgt": land_unit.get("rgt"), + } + ).insert(ignore_permissions=True) # Delete the Land Unit and Linked Land Unit doctypes - if frappe.db.table_exists('Land Unit'): - frappe.delete_doc('DocType', 'Land Unit', force=1) + if frappe.db.table_exists("Land Unit"): + frappe.delete_doc("DocType", "Land Unit", force=1) - if frappe.db.table_exists('Linked Land Unit'): - frappe.delete_doc('DocType', 'Linked Land Unit', force=1) + if frappe.db.table_exists("Linked Land Unit"): + frappe.delete_doc("DocType", "Linked Land Unit", force=1) diff --git a/erpnext/patches/v11_0/move_item_defaults_to_child_table_for_multicompany.py b/erpnext/patches/v11_0/move_item_defaults_to_child_table_for_multicompany.py index bfc3fbc6084..37c07799ddc 100644 --- a/erpnext/patches/v11_0/move_item_defaults_to_child_table_for_multicompany.py +++ b/erpnext/patches/v11_0/move_item_defaults_to_child_table_for_multicompany.py @@ -6,22 +6,23 @@ import frappe def execute(): - ''' + """ Fields to move from the item to item defaults child table [ default_warehouse, buying_cost_center, expense_account, selling_cost_center, income_account ] - ''' - if not frappe.db.has_column('Item', 'default_warehouse'): + """ + if not frappe.db.has_column("Item", "default_warehouse"): return - frappe.reload_doc('stock', 'doctype', 'item_default') - frappe.reload_doc('stock', 'doctype', 'item') + frappe.reload_doc("stock", "doctype", "item_default") + frappe.reload_doc("stock", "doctype", "item") companies = frappe.get_all("Company") if len(companies) == 1 and not frappe.get_all("Item Default", limit=1): try: - frappe.db.sql(''' + frappe.db.sql( + """ INSERT INTO `tabItem Default` (name, parent, parenttype, parentfield, idx, company, default_warehouse, buying_cost_center, selling_cost_center, expense_account, income_account, default_supplier) @@ -30,22 +31,30 @@ def execute(): 'item_defaults' as parentfield, 1 as idx, %s as company, default_warehouse, buying_cost_center, selling_cost_center, expense_account, income_account, default_supplier FROM `tabItem`; - ''', companies[0].name) + """, + companies[0].name, + ) except Exception: pass else: - item_details = frappe.db.sql(""" SELECT name, default_warehouse, + item_details = frappe.db.sql( + """ SELECT name, default_warehouse, buying_cost_center, expense_account, selling_cost_center, income_account FROM tabItem WHERE - name not in (select distinct parent from `tabItem Default`) and ifnull(disabled, 0) = 0""" - , as_dict=1) + name not in (select distinct parent from `tabItem Default`) and ifnull(disabled, 0) = 0""", + as_dict=1, + ) items_default_data = {} for item_data in item_details: - for d in [["default_warehouse", "Warehouse"], ["expense_account", "Account"], - ["income_account", "Account"], ["buying_cost_center", "Cost Center"], - ["selling_cost_center", "Cost Center"]]: + for d in [ + ["default_warehouse", "Warehouse"], + ["expense_account", "Account"], + ["income_account", "Account"], + ["buying_cost_center", "Cost Center"], + ["selling_cost_center", "Cost Center"], + ]: if item_data.get(d[0]): company = frappe.get_value(d[1], item_data.get(d[0]), "company", cache=True) @@ -73,25 +82,32 @@ def execute(): for item_code, companywise_item_data in items_default_data.items(): for company, item_default_data in companywise_item_data.items(): - to_insert_data.append(( - frappe.generate_hash("", 10), - item_code, - 'Item', - 'item_defaults', - company, - item_default_data.get('default_warehouse'), - item_default_data.get('expense_account'), - item_default_data.get('income_account'), - item_default_data.get('buying_cost_center'), - item_default_data.get('selling_cost_center'), - )) + to_insert_data.append( + ( + frappe.generate_hash("", 10), + item_code, + "Item", + "item_defaults", + company, + item_default_data.get("default_warehouse"), + item_default_data.get("expense_account"), + item_default_data.get("income_account"), + item_default_data.get("buying_cost_center"), + item_default_data.get("selling_cost_center"), + ) + ) if to_insert_data: - frappe.db.sql(''' + frappe.db.sql( + """ INSERT INTO `tabItem Default` ( `name`, `parent`, `parenttype`, `parentfield`, `company`, `default_warehouse`, `expense_account`, `income_account`, `buying_cost_center`, `selling_cost_center` ) VALUES {} - '''.format(', '.join(['%s'] * len(to_insert_data))), tuple(to_insert_data)) + """.format( + ", ".join(["%s"] * len(to_insert_data)) + ), + tuple(to_insert_data), + ) diff --git a/erpnext/patches/v11_0/move_leave_approvers_from_employee.py b/erpnext/patches/v11_0/move_leave_approvers_from_employee.py index fc3dbfbab92..f91a7db2a38 100644 --- a/erpnext/patches/v11_0/move_leave_approvers_from_employee.py +++ b/erpnext/patches/v11_0/move_leave_approvers_from_employee.py @@ -1,4 +1,3 @@ - import frappe from frappe.model.utils.rename_field import rename_field @@ -8,20 +7,23 @@ def execute(): frappe.reload_doc("hr", "doctype", "employee") frappe.reload_doc("hr", "doctype", "department") - if frappe.db.has_column('Department', 'leave_approver'): - rename_field('Department', "leave_approver", "leave_approvers") + if frappe.db.has_column("Department", "leave_approver"): + rename_field("Department", "leave_approver", "leave_approvers") - if frappe.db.has_column('Department', 'expense_approver'): - rename_field('Department', "expense_approver", "expense_approvers") + if frappe.db.has_column("Department", "expense_approver"): + rename_field("Department", "expense_approver", "expense_approvers") if not frappe.db.table_exists("Employee Leave Approver"): return - approvers = frappe.db.sql("""select distinct app.leave_approver, emp.department from + approvers = frappe.db.sql( + """select distinct app.leave_approver, emp.department from `tabEmployee Leave Approver` app, `tabEmployee` emp where app.parenttype = 'Employee' and emp.name = app.parent - """, as_dict=True) + """, + as_dict=True, + ) for record in approvers: if record.department: @@ -29,6 +31,4 @@ def execute(): if not department: return if not len(department.leave_approvers): - department.append("leave_approvers",{ - "approver": record.leave_approver - }).db_insert() + department.append("leave_approvers", {"approver": record.leave_approver}).db_insert() diff --git a/erpnext/patches/v11_0/rebuild_tree_for_company.py b/erpnext/patches/v11_0/rebuild_tree_for_company.py index 7866cfab4f7..fc06c5d30d9 100644 --- a/erpnext/patches/v11_0/rebuild_tree_for_company.py +++ b/erpnext/patches/v11_0/rebuild_tree_for_company.py @@ -1,8 +1,7 @@ - import frappe from frappe.utils.nestedset import rebuild_tree def execute(): frappe.reload_doc("setup", "doctype", "company") - rebuild_tree('Company', 'parent_company') + rebuild_tree("Company", "parent_company") diff --git a/erpnext/patches/v11_0/redesign_healthcare_billing_work_flow.py b/erpnext/patches/v11_0/redesign_healthcare_billing_work_flow.py index 9b723cb4840..674df7933eb 100644 --- a/erpnext/patches/v11_0/redesign_healthcare_billing_work_flow.py +++ b/erpnext/patches/v11_0/redesign_healthcare_billing_work_flow.py @@ -1,4 +1,3 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields from frappe.modules import get_doctype_module, scrub @@ -10,59 +9,77 @@ sales_invoice_referenced_doc = { "Patient Encounter": "invoice", "Lab Test": "invoice", "Lab Prescription": "invoice", - "Sample Collection": "invoice" + "Sample Collection": "invoice", } + def execute(): - frappe.reload_doc('accounts', 'doctype', 'loyalty_program') - frappe.reload_doc('accounts', 'doctype', 'sales_invoice_item') + frappe.reload_doc("accounts", "doctype", "loyalty_program") + frappe.reload_doc("accounts", "doctype", "sales_invoice_item") if "Healthcare" not in frappe.get_active_domains(): return healthcare_custom_field_in_sales_invoice() for si_ref_doc in sales_invoice_referenced_doc: - if frappe.db.exists('DocType', si_ref_doc): - frappe.reload_doc(get_doctype_module(si_ref_doc), 'doctype', scrub(si_ref_doc)) + if frappe.db.exists("DocType", si_ref_doc): + frappe.reload_doc(get_doctype_module(si_ref_doc), "doctype", scrub(si_ref_doc)) - if frappe.db.has_column(si_ref_doc, sales_invoice_referenced_doc[si_ref_doc]) \ - and frappe.db.has_column(si_ref_doc, 'invoiced'): + if frappe.db.has_column( + si_ref_doc, sales_invoice_referenced_doc[si_ref_doc] + ) and frappe.db.has_column(si_ref_doc, "invoiced"): # Set Reference DocType and Reference Docname - doc_list = frappe.db.sql(""" + doc_list = frappe.db.sql( + """ select name from `tab{0}` where {1} is not null - """.format(si_ref_doc, sales_invoice_referenced_doc[si_ref_doc])) + """.format( + si_ref_doc, sales_invoice_referenced_doc[si_ref_doc] + ) + ) if doc_list: - frappe.reload_doc(get_doctype_module("Sales Invoice"), 'doctype', 'sales_invoice') + frappe.reload_doc(get_doctype_module("Sales Invoice"), "doctype", "sales_invoice") for doc_id in doc_list: - invoice_id = frappe.db.get_value(si_ref_doc, doc_id[0], sales_invoice_referenced_doc[si_ref_doc]) + invoice_id = frappe.db.get_value( + si_ref_doc, doc_id[0], sales_invoice_referenced_doc[si_ref_doc] + ) if frappe.db.exists("Sales Invoice", invoice_id): if si_ref_doc == "Lab Test": template = frappe.db.get_value("Lab Test", doc_id[0], "template") if template: item = frappe.db.get_value("Lab Test Template", template, "item") if item: - frappe.db.sql("""update `tabSales Invoice Item` set reference_dt = '{0}', - reference_dn = '{1}' where parent = '{2}' and item_code='{3}'""".format\ - (si_ref_doc, doc_id[0], invoice_id, item)) + frappe.db.sql( + """update `tabSales Invoice Item` set reference_dt = '{0}', + reference_dn = '{1}' where parent = '{2}' and item_code='{3}'""".format( + si_ref_doc, doc_id[0], invoice_id, item + ) + ) else: invoice = frappe.get_doc("Sales Invoice", invoice_id) for item_line in invoice.items: if not item_line.reference_dn: - item_line.db_set({"reference_dt":si_ref_doc, "reference_dn": doc_id[0]}) + item_line.db_set({"reference_dt": si_ref_doc, "reference_dn": doc_id[0]}) break # Documents mark invoiced for submitted sales invoice - frappe.db.sql("""update `tab{0}` doc, `tabSales Invoice` si + frappe.db.sql( + """update `tab{0}` doc, `tabSales Invoice` si set doc.invoiced = 1 where si.docstatus = 1 and doc.{1} = si.name - """.format(si_ref_doc, sales_invoice_referenced_doc[si_ref_doc])) + """.format( + si_ref_doc, sales_invoice_referenced_doc[si_ref_doc] + ) + ) + def healthcare_custom_field_in_sales_invoice(): - frappe.reload_doc('healthcare', 'doctype', 'patient') - frappe.reload_doc('healthcare', 'doctype', 'healthcare_practitioner') - if data['custom_fields']: - create_custom_fields(data['custom_fields']) + frappe.reload_doc("healthcare", "doctype", "patient") + frappe.reload_doc("healthcare", "doctype", "healthcare_practitioner") + if data["custom_fields"]: + create_custom_fields(data["custom_fields"]) - frappe.db.sql(""" + frappe.db.sql( + """ delete from `tabCustom Field` where fieldname = 'appointment' and options = 'Patient Appointment' - """) + """ + ) diff --git a/erpnext/patches/v11_0/refactor_autoname_naming.py b/erpnext/patches/v11_0/refactor_autoname_naming.py index 1c4d8f1f79f..de453ccf21d 100644 --- a/erpnext/patches/v11_0/refactor_autoname_naming.py +++ b/erpnext/patches/v11_0/refactor_autoname_naming.py @@ -6,99 +6,102 @@ import frappe from frappe.custom.doctype.property_setter.property_setter import make_property_setter doctype_series_map = { - 'Activity Cost': 'PROJ-ACC-.#####', - 'Agriculture Task': 'AG-TASK-.#####', - 'Assessment Plan': 'EDU-ASP-.YYYY.-.#####', - 'Assessment Result': 'EDU-RES-.YYYY.-.#####', - 'Asset Movement': 'ACC-ASM-.YYYY.-.#####', - 'Attendance Request': 'HR-ARQ-.YY.-.MM.-.#####', - 'Authorization Rule': 'HR-ARU-.#####', - 'Bank Guarantee': 'ACC-BG-.YYYY.-.#####', - 'Bin': 'MAT-BIN-.YYYY.-.#####', - 'Certification Application': 'NPO-CAPP-.YYYY.-.#####', - 'Certified Consultant': 'NPO-CONS-.YYYY.-.#####', - 'Chat Room': 'CHAT-ROOM-.#####', - 'Compensatory Leave Request': 'HR-CMP-.YY.-.MM.-.#####', - 'Client Script': 'SYS-SCR-.#####', - 'Employee Benefit Application': 'HR-BEN-APP-.YY.-.MM.-.#####', - 'Employee Benefit Application Detail': '', - 'Employee Benefit Claim': 'HR-BEN-CLM-.YY.-.MM.-.#####', - 'Employee Incentive': 'HR-EINV-.YY.-.MM.-.#####', - 'Employee Onboarding': 'HR-EMP-ONB-.YYYY.-.#####', - 'Employee Onboarding Template': 'HR-EMP-ONT-.#####', - 'Employee Promotion': 'HR-EMP-PRO-.YYYY.-.#####', - 'Employee Separation': 'HR-EMP-SEP-.YYYY.-.#####', - 'Employee Separation Template': 'HR-EMP-STP-.#####', - 'Employee Tax Exemption Declaration': 'HR-TAX-DEC-.YYYY.-.#####', - 'Employee Tax Exemption Proof Submission': 'HR-TAX-PRF-.YYYY.-.#####', - 'Employee Transfer': 'HR-EMP-TRN-.YYYY.-.#####', - 'Event': 'EVENT-.YYYY.-.#####', - 'Exchange Rate Revaluation': 'ACC-ERR-.YYYY.-.#####', - 'GL Entry': 'ACC-GLE-.YYYY.-.#####', - 'Guardian': 'EDU-GRD-.YYYY.-.#####', - 'Hotel Room Reservation': 'HTL-RES-.YYYY.-.#####', - 'Item Price': '', - 'Job Applicant': 'HR-APP-.YYYY.-.#####', - 'Job Offer': 'HR-OFF-.YYYY.-.#####', - 'Leave Encashment': 'HR-ENC-.YYYY.-.#####', - 'Leave Period': 'HR-LPR-.YYYY.-.#####', - 'Leave Policy': 'HR-LPOL-.YYYY.-.#####', - 'Loan': 'ACC-LOAN-.YYYY.-.#####', - 'Loan Application': 'ACC-LOAP-.YYYY.-.#####', - 'Loyalty Point Entry': '', - 'Membership': 'NPO-MSH-.YYYY.-.#####', - 'Packing Slip': 'MAT-PAC-.YYYY.-.#####', - 'Patient Appointment': 'HLC-APP-.YYYY.-.#####', - 'Payment Terms Template Detail': '', - 'Payroll Entry': 'HR-PRUN-.YYYY.-.#####', - 'Period Closing Voucher': 'ACC-PCV-.YYYY.-.#####', - 'Plant Analysis': 'AG-PLA-.YYYY.-.#####', - 'POS Closing Entry': 'POS-CLO-.YYYY.-.#####', - 'Prepared Report': 'SYS-PREP-.YYYY.-.#####', - 'Program Enrollment': 'EDU-ENR-.YYYY.-.#####', - 'Quotation Item': '', - 'Restaurant Reservation': 'RES-RES-.YYYY.-.#####', - 'Retention Bonus': 'HR-RTB-.YYYY.-.#####', - 'Room': 'HTL-ROOM-.YYYY.-.#####', - 'Salary Structure Assignment': 'HR-SSA-.YY.-.MM.-.#####', - 'Sales Taxes and Charges': '', - 'Share Transfer': 'ACC-SHT-.YYYY.-.#####', - 'Shift Assignment': 'HR-SHA-.YY.-.MM.-.#####', - 'Shift Request': 'HR-SHR-.YY.-.MM.-.#####', - 'SMS Log': 'SYS-SMS-.#####', - 'Soil Analysis': 'AG-ANA-.YY.-.MM.-.#####', - 'Soil Texture': 'AG-TEX-.YYYY.-.#####', - 'Stock Ledger Entry': 'MAT-SLE-.YYYY.-.#####', - 'Student Leave Application': 'EDU-SLA-.YYYY.-.#####', - 'Student Log': 'EDU-SLOG-.YYYY.-.#####', - 'Subscription': 'ACC-SUB-.YYYY.-.#####', - 'Task': 'TASK-.YYYY.-.#####', - 'Tax Rule': 'ACC-TAX-RULE-.YYYY.-.#####', - 'Training Feedback': 'HR-TRF-.YYYY.-.#####', - 'Training Result': 'HR-TRR-.YYYY.-.#####', - 'Travel Request': 'HR-TRQ-.YYYY.-.#####', - 'UOM Conversion Factor': 'MAT-UOM-CNV-.#####', - 'Water Analysis': 'HR-WAT-.YYYY.-.#####', - 'Workflow Action': 'SYS-WACT-.#####', + "Activity Cost": "PROJ-ACC-.#####", + "Agriculture Task": "AG-TASK-.#####", + "Assessment Plan": "EDU-ASP-.YYYY.-.#####", + "Assessment Result": "EDU-RES-.YYYY.-.#####", + "Asset Movement": "ACC-ASM-.YYYY.-.#####", + "Attendance Request": "HR-ARQ-.YY.-.MM.-.#####", + "Authorization Rule": "HR-ARU-.#####", + "Bank Guarantee": "ACC-BG-.YYYY.-.#####", + "Bin": "MAT-BIN-.YYYY.-.#####", + "Certification Application": "NPO-CAPP-.YYYY.-.#####", + "Certified Consultant": "NPO-CONS-.YYYY.-.#####", + "Chat Room": "CHAT-ROOM-.#####", + "Compensatory Leave Request": "HR-CMP-.YY.-.MM.-.#####", + "Client Script": "SYS-SCR-.#####", + "Employee Benefit Application": "HR-BEN-APP-.YY.-.MM.-.#####", + "Employee Benefit Application Detail": "", + "Employee Benefit Claim": "HR-BEN-CLM-.YY.-.MM.-.#####", + "Employee Incentive": "HR-EINV-.YY.-.MM.-.#####", + "Employee Onboarding": "HR-EMP-ONB-.YYYY.-.#####", + "Employee Onboarding Template": "HR-EMP-ONT-.#####", + "Employee Promotion": "HR-EMP-PRO-.YYYY.-.#####", + "Employee Separation": "HR-EMP-SEP-.YYYY.-.#####", + "Employee Separation Template": "HR-EMP-STP-.#####", + "Employee Tax Exemption Declaration": "HR-TAX-DEC-.YYYY.-.#####", + "Employee Tax Exemption Proof Submission": "HR-TAX-PRF-.YYYY.-.#####", + "Employee Transfer": "HR-EMP-TRN-.YYYY.-.#####", + "Event": "EVENT-.YYYY.-.#####", + "Exchange Rate Revaluation": "ACC-ERR-.YYYY.-.#####", + "GL Entry": "ACC-GLE-.YYYY.-.#####", + "Guardian": "EDU-GRD-.YYYY.-.#####", + "Hotel Room Reservation": "HTL-RES-.YYYY.-.#####", + "Item Price": "", + "Job Applicant": "HR-APP-.YYYY.-.#####", + "Job Offer": "HR-OFF-.YYYY.-.#####", + "Leave Encashment": "HR-ENC-.YYYY.-.#####", + "Leave Period": "HR-LPR-.YYYY.-.#####", + "Leave Policy": "HR-LPOL-.YYYY.-.#####", + "Loan": "ACC-LOAN-.YYYY.-.#####", + "Loan Application": "ACC-LOAP-.YYYY.-.#####", + "Loyalty Point Entry": "", + "Membership": "NPO-MSH-.YYYY.-.#####", + "Packing Slip": "MAT-PAC-.YYYY.-.#####", + "Patient Appointment": "HLC-APP-.YYYY.-.#####", + "Payment Terms Template Detail": "", + "Payroll Entry": "HR-PRUN-.YYYY.-.#####", + "Period Closing Voucher": "ACC-PCV-.YYYY.-.#####", + "Plant Analysis": "AG-PLA-.YYYY.-.#####", + "POS Closing Entry": "POS-CLO-.YYYY.-.#####", + "Prepared Report": "SYS-PREP-.YYYY.-.#####", + "Program Enrollment": "EDU-ENR-.YYYY.-.#####", + "Quotation Item": "", + "Restaurant Reservation": "RES-RES-.YYYY.-.#####", + "Retention Bonus": "HR-RTB-.YYYY.-.#####", + "Room": "HTL-ROOM-.YYYY.-.#####", + "Salary Structure Assignment": "HR-SSA-.YY.-.MM.-.#####", + "Sales Taxes and Charges": "", + "Share Transfer": "ACC-SHT-.YYYY.-.#####", + "Shift Assignment": "HR-SHA-.YY.-.MM.-.#####", + "Shift Request": "HR-SHR-.YY.-.MM.-.#####", + "SMS Log": "SYS-SMS-.#####", + "Soil Analysis": "AG-ANA-.YY.-.MM.-.#####", + "Soil Texture": "AG-TEX-.YYYY.-.#####", + "Stock Ledger Entry": "MAT-SLE-.YYYY.-.#####", + "Student Leave Application": "EDU-SLA-.YYYY.-.#####", + "Student Log": "EDU-SLOG-.YYYY.-.#####", + "Subscription": "ACC-SUB-.YYYY.-.#####", + "Task": "TASK-.YYYY.-.#####", + "Tax Rule": "ACC-TAX-RULE-.YYYY.-.#####", + "Training Feedback": "HR-TRF-.YYYY.-.#####", + "Training Result": "HR-TRR-.YYYY.-.#####", + "Travel Request": "HR-TRQ-.YYYY.-.#####", + "UOM Conversion Factor": "MAT-UOM-CNV-.#####", + "Water Analysis": "HR-WAT-.YYYY.-.#####", + "Workflow Action": "SYS-WACT-.#####", } + def execute(): series_to_set = get_series() for doctype, opts in series_to_set.items(): - set_series(doctype, opts['value']) + set_series(doctype, opts["value"]) + def set_series(doctype, value): - doc = frappe.db.exists('Property Setter', {'doc_type': doctype, 'property': 'autoname'}) + doc = frappe.db.exists("Property Setter", {"doc_type": doctype, "property": "autoname"}) if doc: - frappe.db.set_value('Property Setter', doc, 'value', value) + frappe.db.set_value("Property Setter", doc, "value", value) else: - make_property_setter(doctype, '', 'autoname', value, '', for_doctype = True) + make_property_setter(doctype, "", "autoname", value, "", for_doctype=True) + def get_series(): series_to_set = {} for doctype in doctype_series_map: - if not frappe.db.exists('DocType', doctype): + if not frappe.db.exists("DocType", doctype): continue if not frappe.db.a_row_exists(doctype): @@ -110,10 +113,11 @@ def get_series(): # set autoname property setter if series_to_preserve: - series_to_set[doctype] = {'value': series_to_preserve} + series_to_set[doctype] = {"value": series_to_preserve} return series_to_set + def get_series_to_preserve(doctype): - series_to_preserve = frappe.db.get_value('DocType', doctype, 'autoname') + series_to_preserve = frappe.db.get_value("DocType", doctype, "autoname") return series_to_preserve diff --git a/erpnext/patches/v11_0/refactor_erpnext_shopify.py b/erpnext/patches/v11_0/refactor_erpnext_shopify.py index 684b1b3fd6a..308676d057d 100644 --- a/erpnext/patches/v11_0/refactor_erpnext_shopify.py +++ b/erpnext/patches/v11_0/refactor_erpnext_shopify.py @@ -1,18 +1,17 @@ - import frappe from frappe.installer import remove_from_installed_apps def execute(): - frappe.reload_doc('erpnext_integrations', 'doctype', 'shopify_settings') - frappe.reload_doc('erpnext_integrations', 'doctype', 'shopify_tax_account') - frappe.reload_doc('erpnext_integrations', 'doctype', 'shopify_log') - frappe.reload_doc('erpnext_integrations', 'doctype', 'shopify_webhook_detail') + frappe.reload_doc("erpnext_integrations", "doctype", "shopify_settings") + frappe.reload_doc("erpnext_integrations", "doctype", "shopify_tax_account") + frappe.reload_doc("erpnext_integrations", "doctype", "shopify_log") + frappe.reload_doc("erpnext_integrations", "doctype", "shopify_webhook_detail") - if 'erpnext_shopify' in frappe.get_installed_apps(): - remove_from_installed_apps('erpnext_shopify') + if "erpnext_shopify" in frappe.get_installed_apps(): + remove_from_installed_apps("erpnext_shopify") - frappe.delete_doc("Module Def", 'erpnext_shopify') + frappe.delete_doc("Module Def", "erpnext_shopify") frappe.db.commit() @@ -22,11 +21,14 @@ def execute(): else: disable_shopify() + def setup_app_type(): try: shopify_settings = frappe.get_doc("Shopify Settings") - shopify_settings.app_type = 'Private' - shopify_settings.update_price_in_erpnext_price_list = 0 if getattr(shopify_settings, 'push_prices_to_shopify', None) else 1 + shopify_settings.app_type = "Private" + shopify_settings.update_price_in_erpnext_price_list = ( + 0 if getattr(shopify_settings, "push_prices_to_shopify", None) else 1 + ) shopify_settings.flags.ignore_mandatory = True shopify_settings.ignore_permissions = True shopify_settings.save() @@ -34,11 +36,15 @@ def setup_app_type(): frappe.db.set_value("Shopify Settings", None, "enable_shopify", 0) frappe.log_error(frappe.get_traceback()) + def disable_shopify(): # due to frappe.db.set_value wrongly written and enable_shopify being default 1 # Shopify Settings isn't properly configured and leads to error - shopify = frappe.get_doc('Shopify Settings') + shopify = frappe.get_doc("Shopify Settings") - if shopify.app_type == "Public" or shopify.app_type == None or \ - (shopify.enable_shopify and not (shopify.shopify_url or shopify.api_key)): + if ( + shopify.app_type == "Public" + or shopify.app_type == None + or (shopify.enable_shopify and not (shopify.shopify_url or shopify.api_key)) + ): frappe.db.set_value("Shopify Settings", None, "enable_shopify", 0) diff --git a/erpnext/patches/v11_0/refactor_naming_series.py b/erpnext/patches/v11_0/refactor_naming_series.py index 6b275e2b1ef..efc1540f288 100644 --- a/erpnext/patches/v11_0/refactor_naming_series.py +++ b/erpnext/patches/v11_0/refactor_naming_series.py @@ -6,88 +6,94 @@ import frappe from frappe.custom.doctype.property_setter.property_setter import make_property_setter doctype_series_map = { - 'Additional Salary': 'HR-ADS-.YY.-.MM.-', - 'Appraisal': 'HR-APR-.YY.-.MM.', - 'Asset': 'ACC-ASS-.YYYY.-', - 'Attendance': 'HR-ATT-.YYYY.-', - 'Auto Repeat': 'SYS-ARP-.YYYY.-', - 'Blanket Order': 'MFG-BLR-.YYYY.-', - 'C-Form': 'ACC-CF-.YYYY.-', - 'Campaign': 'SAL-CAM-.YYYY.-', - 'Clinical Procedure': 'HLC-CPR-.YYYY.-', - 'Course Schedule': 'EDU-CSH-.YYYY.-', - 'Customer': 'CUST-.YYYY.-', - 'Delivery Note': 'MAT-DN-.YYYY.-', - 'Delivery Trip': 'MAT-DT-.YYYY.-', - 'Driver': 'HR-DRI-.YYYY.-', - 'Employee': 'HR-EMP-', - 'Employee Advance': 'HR-EAD-.YYYY.-', - 'Expense Claim': 'HR-EXP-.YYYY.-', - 'Fee Schedule': 'EDU-FSH-.YYYY.-', - 'Fee Structure': 'EDU-FST-.YYYY.-', - 'Fees': 'EDU-FEE-.YYYY.-', - 'Inpatient Record': 'HLC-INP-.YYYY.-', - 'Installation Note': 'MAT-INS-.YYYY.-', - 'Instructor': 'EDU-INS-.YYYY.-', - 'Issue': 'ISS-.YYYY.-', - 'Journal Entry': 'ACC-JV-.YYYY.-', - 'Lab Test': 'HLC-LT-.YYYY.-', - 'Landed Cost Voucher': 'MAT-LCV-.YYYY.-', - 'Lead': 'CRM-LEAD-.YYYY.-', - 'Leave Allocation': 'HR-LAL-.YYYY.-', - 'Leave Application': 'HR-LAP-.YYYY.-', - 'Maintenance Schedule': 'MAT-MSH-.YYYY.-', - 'Maintenance Visit': 'MAT-MVS-.YYYY.-', - 'Material Request': 'MAT-MR-.YYYY.-', - 'Member': 'NPO-MEM-.YYYY.-', - 'Opportunity': 'CRM-OPP-.YYYY.-', - 'Packing Slip': 'MAT-PAC-.YYYY.-', - 'Patient': 'HLC-PAT-.YYYY.-', - 'Patient Encounter': 'HLC-ENC-.YYYY.-', - 'Patient Medical Record': 'HLC-PMR-.YYYY.-', - 'Payment Entry': 'ACC-PAY-.YYYY.-', - 'Payment Request': 'ACC-PRQ-.YYYY.-', - 'Production Plan': 'MFG-PP-.YYYY.-', - 'Project Update': 'PROJ-UPD-.YYYY.-', - 'Purchase Invoice': 'ACC-PINV-.YYYY.-', - 'Purchase Order': 'PUR-ORD-.YYYY.-', - 'Purchase Receipt': 'MAT-PRE-.YYYY.-', - 'Quality Inspection': 'MAT-QA-.YYYY.-', - 'Quotation': 'SAL-QTN-.YYYY.-', - 'Request for Quotation': 'PUR-RFQ-.YYYY.-', - 'Sales Invoice': 'ACC-SINV-.YYYY.-', - 'Sales Order': 'SAL-ORD-.YYYY.-', - 'Sample Collection': 'HLC-SC-.YYYY.-', - 'Shareholder': 'ACC-SH-.YYYY.-', - 'Stock Entry': 'MAT-STE-.YYYY.-', - 'Stock Reconciliation': 'MAT-RECO-.YYYY.-', - 'Student': 'EDU-STU-.YYYY.-', - 'Student Applicant': 'EDU-APP-.YYYY.-', - 'Supplier': 'SUP-.YYYY.-', - 'Supplier Quotation': 'PUR-SQTN-.YYYY.-', - 'Supplier Scorecard Period': 'PU-SSP-.YYYY.-', - 'Timesheet': 'TS-.YYYY.-', - 'Vehicle Log': 'HR-VLOG-.YYYY.-', - 'Warranty Claim': 'SER-WRN-.YYYY.-', - 'Work Order': 'MFG-WO-.YYYY.-' + "Additional Salary": "HR-ADS-.YY.-.MM.-", + "Appraisal": "HR-APR-.YY.-.MM.", + "Asset": "ACC-ASS-.YYYY.-", + "Attendance": "HR-ATT-.YYYY.-", + "Auto Repeat": "SYS-ARP-.YYYY.-", + "Blanket Order": "MFG-BLR-.YYYY.-", + "C-Form": "ACC-CF-.YYYY.-", + "Campaign": "SAL-CAM-.YYYY.-", + "Clinical Procedure": "HLC-CPR-.YYYY.-", + "Course Schedule": "EDU-CSH-.YYYY.-", + "Customer": "CUST-.YYYY.-", + "Delivery Note": "MAT-DN-.YYYY.-", + "Delivery Trip": "MAT-DT-.YYYY.-", + "Driver": "HR-DRI-.YYYY.-", + "Employee": "HR-EMP-", + "Employee Advance": "HR-EAD-.YYYY.-", + "Expense Claim": "HR-EXP-.YYYY.-", + "Fee Schedule": "EDU-FSH-.YYYY.-", + "Fee Structure": "EDU-FST-.YYYY.-", + "Fees": "EDU-FEE-.YYYY.-", + "Inpatient Record": "HLC-INP-.YYYY.-", + "Installation Note": "MAT-INS-.YYYY.-", + "Instructor": "EDU-INS-.YYYY.-", + "Issue": "ISS-.YYYY.-", + "Journal Entry": "ACC-JV-.YYYY.-", + "Lab Test": "HLC-LT-.YYYY.-", + "Landed Cost Voucher": "MAT-LCV-.YYYY.-", + "Lead": "CRM-LEAD-.YYYY.-", + "Leave Allocation": "HR-LAL-.YYYY.-", + "Leave Application": "HR-LAP-.YYYY.-", + "Maintenance Schedule": "MAT-MSH-.YYYY.-", + "Maintenance Visit": "MAT-MVS-.YYYY.-", + "Material Request": "MAT-MR-.YYYY.-", + "Member": "NPO-MEM-.YYYY.-", + "Opportunity": "CRM-OPP-.YYYY.-", + "Packing Slip": "MAT-PAC-.YYYY.-", + "Patient": "HLC-PAT-.YYYY.-", + "Patient Encounter": "HLC-ENC-.YYYY.-", + "Patient Medical Record": "HLC-PMR-.YYYY.-", + "Payment Entry": "ACC-PAY-.YYYY.-", + "Payment Request": "ACC-PRQ-.YYYY.-", + "Production Plan": "MFG-PP-.YYYY.-", + "Project Update": "PROJ-UPD-.YYYY.-", + "Purchase Invoice": "ACC-PINV-.YYYY.-", + "Purchase Order": "PUR-ORD-.YYYY.-", + "Purchase Receipt": "MAT-PRE-.YYYY.-", + "Quality Inspection": "MAT-QA-.YYYY.-", + "Quotation": "SAL-QTN-.YYYY.-", + "Request for Quotation": "PUR-RFQ-.YYYY.-", + "Sales Invoice": "ACC-SINV-.YYYY.-", + "Sales Order": "SAL-ORD-.YYYY.-", + "Sample Collection": "HLC-SC-.YYYY.-", + "Shareholder": "ACC-SH-.YYYY.-", + "Stock Entry": "MAT-STE-.YYYY.-", + "Stock Reconciliation": "MAT-RECO-.YYYY.-", + "Student": "EDU-STU-.YYYY.-", + "Student Applicant": "EDU-APP-.YYYY.-", + "Supplier": "SUP-.YYYY.-", + "Supplier Quotation": "PUR-SQTN-.YYYY.-", + "Supplier Scorecard Period": "PU-SSP-.YYYY.-", + "Timesheet": "TS-.YYYY.-", + "Vehicle Log": "HR-VLOG-.YYYY.-", + "Warranty Claim": "SER-WRN-.YYYY.-", + "Work Order": "MFG-WO-.YYYY.-", } + def execute(): - frappe.db.sql(""" + frappe.db.sql( + """ update `tabProperty Setter` set name=concat(doc_type, '-', field_name, '-', property) where property='fetch_from' - """) + """ + ) series_to_set = get_series() for doctype, opts in series_to_set.items(): set_series(doctype, opts["options"], opts["default"]) + def set_series(doctype, options, default): def _make_property_setter(property_name, value): - property_setter = frappe.db.exists('Property Setter', - {'doc_type': doctype, 'field_name': 'naming_series', 'property': property_name}) + property_setter = frappe.db.exists( + "Property Setter", + {"doc_type": doctype, "field_name": "naming_series", "property": property_name}, + ) if property_setter: - frappe.db.set_value('Property Setter', property_setter, 'value', value) + frappe.db.set_value("Property Setter", property_setter, "value", value) else: make_property_setter(doctype, "naming_series", "options", value, "Text") @@ -95,17 +101,18 @@ def set_series(doctype, options, default): if default: _make_property_setter("default", default) + def get_series(): series_to_set = {} for doctype in doctype_series_map: - if not frappe.db.exists('DocType', doctype): + if not frappe.db.exists("DocType", doctype): continue if not frappe.db.a_row_exists(doctype): continue - if not frappe.db.has_column(doctype, 'naming_series'): + if not frappe.db.has_column(doctype, "naming_series"): continue - if not frappe.get_meta(doctype).has_field('naming_series'): + if not frappe.get_meta(doctype).has_field("naming_series"): continue series_to_preserve = list(filter(None, get_series_to_preserve(doctype))) default_series = get_default_series(doctype) @@ -123,12 +130,18 @@ def get_series(): return series_to_set + def get_series_to_preserve(doctype): - series_to_preserve = frappe.db.sql_list("""select distinct naming_series from `tab{doctype}` where ifnull(naming_series, '') != ''""".format(doctype=doctype)) + series_to_preserve = frappe.db.sql_list( + """select distinct naming_series from `tab{doctype}` where ifnull(naming_series, '') != ''""".format( + doctype=doctype + ) + ) series_to_preserve.sort() return series_to_preserve + def get_default_series(doctype): field = frappe.get_meta(doctype).get_field("naming_series") - default_series = field.get('default', '') if field else '' + default_series = field.get("default", "") if field else "" return default_series diff --git a/erpnext/patches/v11_0/remove_barcodes_field_from_copy_fields_to_variants.py b/erpnext/patches/v11_0/remove_barcodes_field_from_copy_fields_to_variants.py index caf74f578de..2e0204c22b9 100644 --- a/erpnext/patches/v11_0/remove_barcodes_field_from_copy_fields_to_variants.py +++ b/erpnext/patches/v11_0/remove_barcodes_field_from_copy_fields_to_variants.py @@ -2,7 +2,7 @@ import frappe def execute(): - '''Remove barcodes field from "Copy Fields to Variants" table because barcodes must be unique''' + """Remove barcodes field from "Copy Fields to Variants" table because barcodes must be unique""" - settings = frappe.get_doc('Item Variant Settings') + settings = frappe.get_doc("Item Variant Settings") settings.remove_invalid_fields_for_copy_fields_in_variants() diff --git a/erpnext/patches/v11_0/rename_additional_salary_component_additional_salary.py b/erpnext/patches/v11_0/rename_additional_salary_component_additional_salary.py index 85292e8d135..036ae8ebfc1 100644 --- a/erpnext/patches/v11_0/rename_additional_salary_component_additional_salary.py +++ b/erpnext/patches/v11_0/rename_additional_salary_component_additional_salary.py @@ -1,11 +1,11 @@ - import frappe # this patch should have been included with this PR https://github.com/frappe/erpnext/pull/14302 + def execute(): if frappe.db.table_exists("Additional Salary Component"): if not frappe.db.table_exists("Additional Salary"): frappe.rename_doc("DocType", "Additional Salary Component", "Additional Salary") - frappe.delete_doc('DocType', "Additional Salary Component") + frappe.delete_doc("DocType", "Additional Salary Component") diff --git a/erpnext/patches/v11_0/rename_asset_adjustment_doctype.py b/erpnext/patches/v11_0/rename_asset_adjustment_doctype.py index c7a3aa2abd4..c444c16a59b 100644 --- a/erpnext/patches/v11_0/rename_asset_adjustment_doctype.py +++ b/erpnext/patches/v11_0/rename_asset_adjustment_doctype.py @@ -6,6 +6,8 @@ import frappe def execute(): - if frappe.db.table_exists("Asset Adjustment") and not frappe.db.table_exists("Asset Value Adjustment"): - frappe.rename_doc('DocType', 'Asset Adjustment', 'Asset Value Adjustment', force=True) - frappe.reload_doc('assets', 'doctype', 'asset_value_adjustment') + if frappe.db.table_exists("Asset Adjustment") and not frappe.db.table_exists( + "Asset Value Adjustment" + ): + frappe.rename_doc("DocType", "Asset Adjustment", "Asset Value Adjustment", force=True) + frappe.reload_doc("assets", "doctype", "asset_value_adjustment") diff --git a/erpnext/patches/v11_0/rename_bom_wo_fields.py b/erpnext/patches/v11_0/rename_bom_wo_fields.py index cab7d0a673f..fb25eeb6fcc 100644 --- a/erpnext/patches/v11_0/rename_bom_wo_fields.py +++ b/erpnext/patches/v11_0/rename_bom_wo_fields.py @@ -7,28 +7,36 @@ from frappe.model.utils.rename_field import rename_field def execute(): - # updating column value to handle field change from Data to Currency - changed_field = "base_scrap_material_cost" - frappe.db.sql(f"update `tabBOM` set {changed_field} = '0' where trim(coalesce({changed_field}, ''))= ''") + # updating column value to handle field change from Data to Currency + changed_field = "base_scrap_material_cost" + frappe.db.sql( + f"update `tabBOM` set {changed_field} = '0' where trim(coalesce({changed_field}, ''))= ''" + ) - for doctype in ['BOM Explosion Item', 'BOM Item', 'Work Order Item', 'Item']: - if frappe.db.has_column(doctype, 'allow_transfer_for_manufacture'): - if doctype != 'Item': - frappe.reload_doc('manufacturing', 'doctype', frappe.scrub(doctype)) - else: - frappe.reload_doc('stock', 'doctype', frappe.scrub(doctype)) + for doctype in ["BOM Explosion Item", "BOM Item", "Work Order Item", "Item"]: + if frappe.db.has_column(doctype, "allow_transfer_for_manufacture"): + if doctype != "Item": + frappe.reload_doc("manufacturing", "doctype", frappe.scrub(doctype)) + else: + frappe.reload_doc("stock", "doctype", frappe.scrub(doctype)) - rename_field(doctype, "allow_transfer_for_manufacture", "include_item_in_manufacturing") + rename_field(doctype, "allow_transfer_for_manufacture", "include_item_in_manufacturing") - for doctype in ['BOM', 'Work Order']: - frappe.reload_doc('manufacturing', 'doctype', frappe.scrub(doctype)) + for doctype in ["BOM", "Work Order"]: + frappe.reload_doc("manufacturing", "doctype", frappe.scrub(doctype)) - if frappe.db.has_column(doctype, 'transfer_material_against_job_card'): - frappe.db.sql(""" UPDATE `tab%s` + if frappe.db.has_column(doctype, "transfer_material_against_job_card"): + frappe.db.sql( + """ UPDATE `tab%s` SET transfer_material_against = CASE WHEN transfer_material_against_job_card = 1 then 'Job Card' Else 'Work Order' END - WHERE docstatus < 2""" % (doctype)) - else: - frappe.db.sql(""" UPDATE `tab%s` + WHERE docstatus < 2""" + % (doctype) + ) + else: + frappe.db.sql( + """ UPDATE `tab%s` SET transfer_material_against = 'Work Order' - WHERE docstatus < 2""" % (doctype)) + WHERE docstatus < 2""" + % (doctype) + ) diff --git a/erpnext/patches/v11_0/rename_duplicate_item_code_values.py b/erpnext/patches/v11_0/rename_duplicate_item_code_values.py index 61f3856e8eb..1f65e14814d 100644 --- a/erpnext/patches/v11_0/rename_duplicate_item_code_values.py +++ b/erpnext/patches/v11_0/rename_duplicate_item_code_values.py @@ -3,7 +3,9 @@ import frappe def execute(): items = [] - items = frappe.db.sql("""select item_code from `tabItem` group by item_code having count(*) > 1""", as_dict=True) + items = frappe.db.sql( + """select item_code from `tabItem` group by item_code having count(*) > 1""", as_dict=True + ) if items: for item in items: frappe.db.sql("""update `tabItem` set item_code=name where item_code = %s""", (item.item_code)) diff --git a/erpnext/patches/v11_0/rename_field_max_days_allowed.py b/erpnext/patches/v11_0/rename_field_max_days_allowed.py index fb08be8628b..0813770efcc 100644 --- a/erpnext/patches/v11_0/rename_field_max_days_allowed.py +++ b/erpnext/patches/v11_0/rename_field_max_days_allowed.py @@ -1,14 +1,15 @@ - import frappe from frappe.model.utils.rename_field import rename_field def execute(): - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabLeave Type` SET max_days_allowed = '0' WHERE trim(coalesce(max_days_allowed, '')) = '' - """) + """ + ) frappe.db.sql_ddl("""ALTER table `tabLeave Type` modify max_days_allowed int(8) NOT NULL""") frappe.reload_doc("hr", "doctype", "leave_type") rename_field("Leave Type", "max_days_allowed", "max_continuous_days_allowed") diff --git a/erpnext/patches/v11_0/rename_health_insurance.py b/erpnext/patches/v11_0/rename_health_insurance.py index 1b6db89101b..3509c6b104e 100644 --- a/erpnext/patches/v11_0/rename_health_insurance.py +++ b/erpnext/patches/v11_0/rename_health_insurance.py @@ -6,5 +6,5 @@ import frappe def execute(): - frappe.rename_doc('DocType', 'Health Insurance', 'Employee Health Insurance', force=True) - frappe.reload_doc('hr', 'doctype', 'employee_health_insurance') + frappe.rename_doc("DocType", "Health Insurance", "Employee Health Insurance", force=True) + frappe.reload_doc("hr", "doctype", "employee_health_insurance") diff --git a/erpnext/patches/v11_0/rename_healthcare_doctype_and_fields.py b/erpnext/patches/v11_0/rename_healthcare_doctype_and_fields.py index 55717f88ea1..f237937e9cd 100644 --- a/erpnext/patches/v11_0/rename_healthcare_doctype_and_fields.py +++ b/erpnext/patches/v11_0/rename_healthcare_doctype_and_fields.py @@ -1,4 +1,3 @@ - import frappe from frappe.model.utils.rename_field import rename_field from frappe.modules import get_doctype_module, scrub @@ -8,21 +7,15 @@ field_rename_map = { ["consultation_time", "encounter_time"], ["consultation_date", "encounter_date"], ["consultation_comment", "encounter_comment"], - ["physician", "practitioner"] - ], - "Fee Validity": [ - ["physician", "practitioner"] - ], - "Lab Test": [ - ["physician", "practitioner"] + ["physician", "practitioner"], ], + "Fee Validity": [["physician", "practitioner"]], + "Lab Test": [["physician", "practitioner"]], "Patient Appointment": [ ["physician", "practitioner"], - ["referring_physician", "referring_practitioner"] + ["referring_physician", "referring_practitioner"], ], - "Procedure Prescription": [ - ["physician", "practitioner"] - ] + "Procedure Prescription": [["physician", "practitioner"]], } doc_rename_map = { @@ -30,37 +23,40 @@ doc_rename_map = { "Physician Schedule": "Practitioner Schedule", "Physician Service Unit Schedule": "Practitioner Service Unit Schedule", "Consultation": "Patient Encounter", - "Physician": "Healthcare Practitioner" + "Physician": "Healthcare Practitioner", } + def execute(): for dt in doc_rename_map: - if frappe.db.exists('DocType', dt): - frappe.rename_doc('DocType', dt, doc_rename_map[dt], force=True) + if frappe.db.exists("DocType", dt): + frappe.rename_doc("DocType", dt, doc_rename_map[dt], force=True) for dn in field_rename_map: - if frappe.db.exists('DocType', dn): + if frappe.db.exists("DocType", dn): frappe.reload_doc(get_doctype_module(dn), "doctype", scrub(dn)) for dt, field_list in field_rename_map.items(): - if frappe.db.exists('DocType', dt): + if frappe.db.exists("DocType", dt): for field in field_list: if frappe.db.has_column(dt, field[0]): rename_field(dt, field[0], field[1]) - if frappe.db.exists('DocType', 'Practitioner Service Unit Schedule'): - if frappe.db.has_column('Practitioner Service Unit Schedule', 'parentfield'): - frappe.db.sql(""" + if frappe.db.exists("DocType", "Practitioner Service Unit Schedule"): + if frappe.db.has_column("Practitioner Service Unit Schedule", "parentfield"): + frappe.db.sql( + """ update `tabPractitioner Service Unit Schedule` set parentfield = 'practitioner_schedules' where parentfield = 'physician_schedules' and parenttype = 'Healthcare Practitioner' - """) + """ + ) if frappe.db.exists("DocType", "Healthcare Practitioner"): frappe.reload_doc("healthcare", "doctype", "healthcare_practitioner") frappe.reload_doc("healthcare", "doctype", "practitioner_service_unit_schedule") - if frappe.db.has_column('Healthcare Practitioner', 'physician_schedule'): - for doc in frappe.get_all('Healthcare Practitioner'): - _doc = frappe.get_doc('Healthcare Practitioner', doc.name) + if frappe.db.has_column("Healthcare Practitioner", "physician_schedule"): + for doc in frappe.get_all("Healthcare Practitioner"): + _doc = frappe.get_doc("Healthcare Practitioner", doc.name) if _doc.physician_schedule: - _doc.append('practitioner_schedules', {'schedule': _doc.physician_schedule}) + _doc.append("practitioner_schedules", {"schedule": _doc.physician_schedule}) _doc.save() diff --git a/erpnext/patches/v11_0/rename_healthcare_fields.py b/erpnext/patches/v11_0/rename_healthcare_fields.py index 88aac61333a..f2ac4d223ef 100644 --- a/erpnext/patches/v11_0/rename_healthcare_fields.py +++ b/erpnext/patches/v11_0/rename_healthcare_fields.py @@ -1,4 +1,3 @@ - import frappe from frappe.model.utils.rename_field import rename_field from frappe.modules import get_doctype_module, scrub @@ -18,36 +17,48 @@ lab_test_event = ["test_event", "lab_test_event"] lab_test_particulars = ["test_particulars", "lab_test_particulars"] field_rename_map = { - "Lab Test Template": [lab_test_name, lab_test_code, lab_test_rate, lab_test_description, - lab_test_group, lab_test_template_type, lab_test_uom, lab_test_normal_range], + "Lab Test Template": [ + lab_test_name, + lab_test_code, + lab_test_rate, + lab_test_description, + lab_test_group, + lab_test_template_type, + lab_test_uom, + lab_test_normal_range, + ], "Normal Test Items": [lab_test_name, lab_test_comment, lab_test_uom, lab_test_event], "Lab Test": [lab_test_name, lab_test_comment, lab_test_group], "Lab Prescription": [lab_test_name, lab_test_code, lab_test_comment, lab_test_created], "Lab Test Groups": [lab_test_template, lab_test_rate, lab_test_description], "Lab Test UOM": [lab_test_uom], "Normal Test Template": [lab_test_uom, lab_test_event], - "Special Test Items": [lab_test_particulars] + "Special Test Items": [lab_test_particulars], } def execute(): for dt, field_list in field_rename_map.items(): - if frappe.db.exists('DocType', dt): + if frappe.db.exists("DocType", dt): frappe.reload_doc(get_doctype_module(dt), "doctype", scrub(dt)) for field in field_list: if frappe.db.has_column(dt, field[0]): rename_field(dt, field[0], field[1]) - if frappe.db.exists('DocType', 'Lab Prescription'): - if frappe.db.has_column('Lab Prescription', 'parentfield'): - frappe.db.sql(""" + if frappe.db.exists("DocType", "Lab Prescription"): + if frappe.db.has_column("Lab Prescription", "parentfield"): + frappe.db.sql( + """ update `tabLab Prescription` set parentfield = 'lab_test_prescription' where parentfield = 'test_prescription' - """) + """ + ) - if frappe.db.exists('DocType', 'Lab Test Groups'): - if frappe.db.has_column('Lab Test Groups', 'parentfield'): - frappe.db.sql(""" + if frappe.db.exists("DocType", "Lab Test Groups"): + if frappe.db.has_column("Lab Test Groups", "parentfield"): + frappe.db.sql( + """ update `tabLab Test Groups` set parentfield = 'lab_test_groups' where parentfield = 'test_groups' - """) + """ + ) diff --git a/erpnext/patches/v11_0/rename_members_with_naming_series.py b/erpnext/patches/v11_0/rename_members_with_naming_series.py index 49dbc8a6dc8..4dffbc8fe81 100644 --- a/erpnext/patches/v11_0/rename_members_with_naming_series.py +++ b/erpnext/patches/v11_0/rename_members_with_naming_series.py @@ -1,11 +1,10 @@ - import frappe def execute(): frappe.reload_doc("non_profit", "doctype", "member") - old_named_members = frappe.get_all("Member", filters = {"name": ("not like", "MEM-%")}) - correctly_named_members = frappe.get_all("Member", filters = {"name": ("like", "MEM-%")}) + old_named_members = frappe.get_all("Member", filters={"name": ("not like", "MEM-%")}) + correctly_named_members = frappe.get_all("Member", filters={"name": ("like", "MEM-%")}) current_index = len(correctly_named_members) for member in old_named_members: diff --git a/erpnext/patches/v11_0/rename_overproduction_percent_field.py b/erpnext/patches/v11_0/rename_overproduction_percent_field.py index c78ec5d0128..74699db41ef 100644 --- a/erpnext/patches/v11_0/rename_overproduction_percent_field.py +++ b/erpnext/patches/v11_0/rename_overproduction_percent_field.py @@ -7,5 +7,9 @@ from frappe.model.utils.rename_field import rename_field def execute(): - frappe.reload_doc('manufacturing', 'doctype', 'manufacturing_settings') - rename_field('Manufacturing Settings', 'over_production_allowance_percentage', 'overproduction_percentage_for_sales_order') + frappe.reload_doc("manufacturing", "doctype", "manufacturing_settings") + rename_field( + "Manufacturing Settings", + "over_production_allowance_percentage", + "overproduction_percentage_for_sales_order", + ) diff --git a/erpnext/patches/v11_0/rename_production_order_to_work_order.py b/erpnext/patches/v11_0/rename_production_order_to_work_order.py index 453a5710a1d..b58ac4e72f1 100644 --- a/erpnext/patches/v11_0/rename_production_order_to_work_order.py +++ b/erpnext/patches/v11_0/rename_production_order_to_work_order.py @@ -7,22 +7,28 @@ from frappe.model.utils.rename_field import rename_field def execute(): - frappe.rename_doc('DocType', 'Production Order', 'Work Order', force=True) - frappe.reload_doc('manufacturing', 'doctype', 'work_order') + frappe.rename_doc("DocType", "Production Order", "Work Order", force=True) + frappe.reload_doc("manufacturing", "doctype", "work_order") - frappe.rename_doc('DocType', 'Production Order Item', 'Work Order Item', force=True) - frappe.reload_doc('manufacturing', 'doctype', 'work_order_item') + frappe.rename_doc("DocType", "Production Order Item", "Work Order Item", force=True) + frappe.reload_doc("manufacturing", "doctype", "work_order_item") - frappe.rename_doc('DocType', 'Production Order Operation', 'Work Order Operation', force=True) - frappe.reload_doc('manufacturing', 'doctype', 'work_order_operation') + frappe.rename_doc("DocType", "Production Order Operation", "Work Order Operation", force=True) + frappe.reload_doc("manufacturing", "doctype", "work_order_operation") - frappe.reload_doc('projects', 'doctype', 'timesheet') - frappe.reload_doc('stock', 'doctype', 'stock_entry') + frappe.reload_doc("projects", "doctype", "timesheet") + frappe.reload_doc("stock", "doctype", "stock_entry") rename_field("Timesheet", "production_order", "work_order") rename_field("Stock Entry", "production_order", "work_order") - frappe.rename_doc("Report", "Production Orders in Progress", "Work Orders in Progress", force=True) + frappe.rename_doc( + "Report", "Production Orders in Progress", "Work Orders in Progress", force=True + ) frappe.rename_doc("Report", "Completed Production Orders", "Completed Work Orders", force=True) frappe.rename_doc("Report", "Open Production Orders", "Open Work Orders", force=True) - frappe.rename_doc("Report", "Issued Items Against Production Order", "Issued Items Against Work Order", force=True) - frappe.rename_doc("Report", "Production Order Stock Report", "Work Order Stock Report", force=True) + frappe.rename_doc( + "Report", "Issued Items Against Production Order", "Issued Items Against Work Order", force=True + ) + frappe.rename_doc( + "Report", "Production Order Stock Report", "Work Order Stock Report", force=True + ) diff --git a/erpnext/patches/v11_0/rename_supplier_type_to_supplier_group.py b/erpnext/patches/v11_0/rename_supplier_type_to_supplier_group.py index fd7e684c61a..96daba7d368 100644 --- a/erpnext/patches/v11_0/rename_supplier_type_to_supplier_group.py +++ b/erpnext/patches/v11_0/rename_supplier_type_to_supplier_group.py @@ -1,4 +1,3 @@ - import frappe from frappe import _ from frappe.model.utils.rename_field import rename_field @@ -7,10 +6,10 @@ from frappe.utils.nestedset import rebuild_tree def execute(): if frappe.db.table_exists("Supplier Group"): - frappe.reload_doc('setup', 'doctype', 'supplier_group') + frappe.reload_doc("setup", "doctype", "supplier_group") elif frappe.db.table_exists("Supplier Type"): frappe.rename_doc("DocType", "Supplier Type", "Supplier Group", force=True) - frappe.reload_doc('setup', 'doctype', 'supplier_group') + frappe.reload_doc("setup", "doctype", "supplier_group") frappe.reload_doc("accounts", "doctype", "pricing_rule") frappe.reload_doc("accounts", "doctype", "tax_rule") frappe.reload_doc("buying", "doctype", "buying_settings") @@ -23,16 +22,23 @@ def execute(): build_tree() -def build_tree(): - frappe.db.sql("""update `tabSupplier Group` set parent_supplier_group = '{0}' - where is_group = 0""".format(_('All Supplier Groups'))) - if not frappe.db.exists("Supplier Group", _('All Supplier Groups')): - frappe.get_doc({ - 'doctype': 'Supplier Group', - 'supplier_group_name': _('All Supplier Groups'), - 'is_group': 1, - 'parent_supplier_group': '' - }).insert(ignore_permissions=True) +def build_tree(): + frappe.db.sql( + """update `tabSupplier Group` set parent_supplier_group = '{0}' + where is_group = 0""".format( + _("All Supplier Groups") + ) + ) + + if not frappe.db.exists("Supplier Group", _("All Supplier Groups")): + frappe.get_doc( + { + "doctype": "Supplier Group", + "supplier_group_name": _("All Supplier Groups"), + "is_group": 1, + "parent_supplier_group": "", + } + ).insert(ignore_permissions=True) rebuild_tree("Supplier Group", "parent_supplier_group") diff --git a/erpnext/patches/v11_0/renamed_from_to_fields_in_project.py b/erpnext/patches/v11_0/renamed_from_to_fields_in_project.py index f23a81494be..4dc2521d391 100644 --- a/erpnext/patches/v11_0/renamed_from_to_fields_in_project.py +++ b/erpnext/patches/v11_0/renamed_from_to_fields_in_project.py @@ -7,8 +7,8 @@ from frappe.model.utils.rename_field import rename_field def execute(): - frappe.reload_doc('projects', 'doctype', 'project') + frappe.reload_doc("projects", "doctype", "project") - if frappe.db.has_column('Project', 'from'): - rename_field('Project', 'from', 'from_time') - rename_field('Project', 'to', 'to_time') + if frappe.db.has_column("Project", "from"): + rename_field("Project", "from", "from_time") + rename_field("Project", "to", "to_time") diff --git a/erpnext/patches/v11_0/reset_publish_in_hub_for_all_items.py b/erpnext/patches/v11_0/reset_publish_in_hub_for_all_items.py index 2f75c0826e5..1bdb53b7074 100644 --- a/erpnext/patches/v11_0/reset_publish_in_hub_for_all_items.py +++ b/erpnext/patches/v11_0/reset_publish_in_hub_for_all_items.py @@ -1,7 +1,6 @@ - import frappe def execute(): - frappe.reload_doc('stock', 'doctype', 'item') + frappe.reload_doc("stock", "doctype", "item") frappe.db.sql("""update `tabItem` set publish_in_hub = 0""") diff --git a/erpnext/patches/v11_0/set_default_email_template_in_hr.py b/erpnext/patches/v11_0/set_default_email_template_in_hr.py index a77dee93692..ee083ca4b80 100644 --- a/erpnext/patches/v11_0/set_default_email_template_in_hr.py +++ b/erpnext/patches/v11_0/set_default_email_template_in_hr.py @@ -1,4 +1,3 @@ - import frappe from frappe import _ diff --git a/erpnext/patches/v11_0/set_department_for_doctypes.py b/erpnext/patches/v11_0/set_department_for_doctypes.py index a3ece7fc768..1e14b9ceb0f 100644 --- a/erpnext/patches/v11_0/set_department_for_doctypes.py +++ b/erpnext/patches/v11_0/set_department_for_doctypes.py @@ -1,24 +1,37 @@ - import frappe # Set department value based on employee value + def execute(): doctypes_to_update = { - 'hr': ['Appraisal', 'Leave Allocation', 'Expense Claim', 'Salary Slip', - 'Attendance', 'Training Feedback', 'Training Result Employee','Leave Application', - 'Employee Advance', 'Training Event Employee', 'Payroll Employee Detail'], - 'education': ['Instructor'], - 'projects': ['Activity Cost', 'Timesheet'], - 'setup': ['Sales Person'] + "hr": [ + "Appraisal", + "Leave Allocation", + "Expense Claim", + "Salary Slip", + "Attendance", + "Training Feedback", + "Training Result Employee", + "Leave Application", + "Employee Advance", + "Training Event Employee", + "Payroll Employee Detail", + ], + "education": ["Instructor"], + "projects": ["Activity Cost", "Timesheet"], + "setup": ["Sales Person"], } for module, doctypes in doctypes_to_update.items(): for doctype in doctypes: if frappe.db.table_exists(doctype): - frappe.reload_doc(module, 'doctype', frappe.scrub(doctype)) - frappe.db.sql(""" + frappe.reload_doc(module, "doctype", frappe.scrub(doctype)) + frappe.db.sql( + """ update `tab%s` dt set department=(select department from `tabEmployee` where name=dt.employee) - """ % doctype) + """ + % doctype + ) diff --git a/erpnext/patches/v11_0/set_missing_gst_hsn_code.py b/erpnext/patches/v11_0/set_missing_gst_hsn_code.py index 262ca2d61f9..d9356e758d7 100644 --- a/erpnext/patches/v11_0/set_missing_gst_hsn_code.py +++ b/erpnext/patches/v11_0/set_missing_gst_hsn_code.py @@ -1,4 +1,3 @@ - import frappe from erpnext.controllers.taxes_and_totals import get_itemised_tax_breakup_html @@ -9,15 +8,24 @@ def execute(): if not company: return - doctypes = ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice", - "Supplier Quotation", "Purchase Order", "Purchase Receipt", "Purchase Invoice"] + doctypes = [ + "Quotation", + "Sales Order", + "Delivery Note", + "Sales Invoice", + "Supplier Quotation", + "Purchase Order", + "Purchase Receipt", + "Purchase Invoice", + ] for dt in doctypes: date_field = "posting_date" if dt in ["Quotation", "Sales Order", "Supplier Quotation", "Purchase Order"]: date_field = "transaction_date" - transactions = frappe.db.sql(""" + transactions = frappe.db.sql( + """ select dt.name, dt_item.name as child_name from `tab{dt}` dt, `tab{dt} Item` dt_item where dt.name = dt_item.parent @@ -26,18 +34,28 @@ def execute(): and ifnull(dt_item.gst_hsn_code, '') = '' and ifnull(dt_item.item_code, '') != '' and dt.company in ({company}) - """.format(dt=dt, date_field=date_field, company=", ".join(['%s']*len(company))), tuple(company), as_dict=1) + """.format( + dt=dt, date_field=date_field, company=", ".join(["%s"] * len(company)) + ), + tuple(company), + as_dict=1, + ) if not transactions: continue transaction_rows_name = [d.child_name for d in transactions] - frappe.db.sql(""" + frappe.db.sql( + """ update `tab{dt} Item` dt_item set dt_item.gst_hsn_code = (select gst_hsn_code from tabItem where name=dt_item.item_code) where dt_item.name in ({rows_name}) - """.format(dt=dt, rows_name=", ".join(['%s']*len(transaction_rows_name))), tuple(transaction_rows_name)) + """.format( + dt=dt, rows_name=", ".join(["%s"] * len(transaction_rows_name)) + ), + tuple(transaction_rows_name), + ) parent = set([d.name for d in transactions]) for t in list(parent): diff --git a/erpnext/patches/v11_0/set_salary_component_properties.py b/erpnext/patches/v11_0/set_salary_component_properties.py index 5ff9e4ab6fd..3ec9f8ab29a 100644 --- a/erpnext/patches/v11_0/set_salary_component_properties.py +++ b/erpnext/patches/v11_0/set_salary_component_properties.py @@ -1,17 +1,22 @@ - import frappe def execute(): - frappe.reload_doc('Payroll', 'doctype', 'salary_detail') - frappe.reload_doc('Payroll', 'doctype', 'salary_component') + frappe.reload_doc("Payroll", "doctype", "salary_detail") + frappe.reload_doc("Payroll", "doctype", "salary_component") frappe.db.sql("update `tabSalary Component` set is_tax_applicable=1 where type='Earning'") - frappe.db.sql("""update `tabSalary Component` set variable_based_on_taxable_salary=1 - where type='Deduction' and name in ('TDS', 'Tax Deducted at Source')""") + frappe.db.sql( + """update `tabSalary Component` set variable_based_on_taxable_salary=1 + where type='Deduction' and name in ('TDS', 'Tax Deducted at Source')""" + ) - frappe.db.sql("""update `tabSalary Detail` set is_tax_applicable=1 - where parentfield='earnings' and statistical_component=0""") - frappe.db.sql("""update `tabSalary Detail` set variable_based_on_taxable_salary=1 - where parentfield='deductions' and salary_component in ('TDS', 'Tax Deducted at Source')""") + frappe.db.sql( + """update `tabSalary Detail` set is_tax_applicable=1 + where parentfield='earnings' and statistical_component=0""" + ) + frappe.db.sql( + """update `tabSalary Detail` set variable_based_on_taxable_salary=1 + where parentfield='deductions' and salary_component in ('TDS', 'Tax Deducted at Source')""" + ) diff --git a/erpnext/patches/v11_0/set_update_field_and_value_in_workflow_state.py b/erpnext/patches/v11_0/set_update_field_and_value_in_workflow_state.py index f23018d0b4d..548a7cb158c 100644 --- a/erpnext/patches/v11_0/set_update_field_and_value_in_workflow_state.py +++ b/erpnext/patches/v11_0/set_update_field_and_value_in_workflow_state.py @@ -1,20 +1,21 @@ - import frappe from frappe.model.workflow import get_workflow_name def execute(): - for doctype in ['Expense Claim', 'Leave Application']: + for doctype in ["Expense Claim", "Leave Application"]: active_workflow = get_workflow_name(doctype) - if not active_workflow: continue + if not active_workflow: + continue - workflow_states = frappe.get_all('Workflow Document State', - filters=[['parent', '=', active_workflow]], - fields=['*']) + workflow_states = frappe.get_all( + "Workflow Document State", filters=[["parent", "=", active_workflow]], fields=["*"] + ) for state in workflow_states: - if state.update_field: continue - status_field = 'approval_status' if doctype=="Expense Claim" else 'status' - frappe.set_value('Workflow Document State', state.name, 'update_field', status_field) - frappe.set_value('Workflow Document State', state.name, 'update_value', state.state) + if state.update_field: + continue + status_field = "approval_status" if doctype == "Expense Claim" else "status" + frappe.set_value("Workflow Document State", state.name, "update_field", status_field) + frappe.set_value("Workflow Document State", state.name, "update_value", state.state) diff --git a/erpnext/patches/v11_0/set_user_permissions_for_department.py b/erpnext/patches/v11_0/set_user_permissions_for_department.py index cb38beb51c1..9b5cb243729 100644 --- a/erpnext/patches/v11_0/set_user_permissions_for_department.py +++ b/erpnext/patches/v11_0/set_user_permissions_for_department.py @@ -1,20 +1,25 @@ - import frappe def execute(): - user_permissions = frappe.db.sql("""select name, for_value from `tabUser Permission` - where allow='Department'""", as_dict=1) - for d in user_permissions: - user_permission = frappe.get_doc("User Permission", d.name) - for new_dept in frappe.db.sql("""select name from tabDepartment - where ifnull(company, '') != '' and department_name=%s""", d.for_value): - try: - new_user_permission = frappe.copy_doc(user_permission) - new_user_permission.for_value = new_dept[0] - new_user_permission.save() - except frappe.DuplicateEntryError: - pass + user_permissions = frappe.db.sql( + """select name, for_value from `tabUser Permission` + where allow='Department'""", + as_dict=1, + ) + for d in user_permissions: + user_permission = frappe.get_doc("User Permission", d.name) + for new_dept in frappe.db.sql( + """select name from tabDepartment + where ifnull(company, '') != '' and department_name=%s""", + d.for_value, + ): + try: + new_user_permission = frappe.copy_doc(user_permission) + new_user_permission.for_value = new_dept[0] + new_user_permission.save() + except frappe.DuplicateEntryError: + pass - frappe.reload_doc("hr", "doctype", "department") - frappe.db.sql("update tabDepartment set disabled=1 where ifnull(company, '') = ''") + frappe.reload_doc("hr", "doctype", "department") + frappe.db.sql("update tabDepartment set disabled=1 where ifnull(company, '') = ''") diff --git a/erpnext/patches/v11_0/skip_user_permission_check_for_department.py b/erpnext/patches/v11_0/skip_user_permission_check_for_department.py index 8e2aa47785d..1327da981e1 100644 --- a/erpnext/patches/v11_0/skip_user_permission_check_for_department.py +++ b/erpnext/patches/v11_0/skip_user_permission_check_for_department.py @@ -1,24 +1,40 @@ - import frappe from frappe.desk.form.linked_with import get_linked_doctypes # Skips user permission check for doctypes where department link field was recently added # https://github.com/frappe/erpnext/pull/14121 + def execute(): doctypes_to_skip = [] - for doctype in ['Appraisal', 'Leave Allocation', 'Expense Claim', 'Instructor', 'Salary Slip', - 'Attendance', 'Training Feedback', 'Training Result Employee', - 'Leave Application', 'Employee Advance', 'Activity Cost', 'Training Event Employee', - 'Timesheet', 'Sales Person', 'Payroll Employee Detail']: - if frappe.db.exists('Custom Field', { 'dt': doctype, 'fieldname': 'department'}): continue + for doctype in [ + "Appraisal", + "Leave Allocation", + "Expense Claim", + "Instructor", + "Salary Slip", + "Attendance", + "Training Feedback", + "Training Result Employee", + "Leave Application", + "Employee Advance", + "Activity Cost", + "Training Event Employee", + "Timesheet", + "Sales Person", + "Payroll Employee Detail", + ]: + if frappe.db.exists("Custom Field", {"dt": doctype, "fieldname": "department"}): + continue doctypes_to_skip.append(doctype) - frappe.reload_doctype('User Permission') + frappe.reload_doctype("User Permission") - user_permissions = frappe.get_all("User Permission", - filters=[['allow', '=', 'Department'], ['applicable_for', 'in', [None] + doctypes_to_skip]], - fields=['name', 'applicable_for']) + user_permissions = frappe.get_all( + "User Permission", + filters=[["allow", "=", "Department"], ["applicable_for", "in", [None] + doctypes_to_skip]], + fields=["name", "applicable_for"], + ) user_permissions_to_delete = [] new_user_permissions_list = [] @@ -38,24 +54,32 @@ def execute(): for doctype in applicable_for_doctypes: if doctype: # Maintain sequence (name, user, allow, for_value, applicable_for, apply_to_all_doctypes) - new_user_permissions_list.append(( - frappe.generate_hash("", 10), - user_permission.user, - user_permission.allow, - user_permission.for_value, - doctype, - 0 - )) + new_user_permissions_list.append( + ( + frappe.generate_hash("", 10), + user_permission.user, + user_permission.allow, + user_permission.for_value, + doctype, + 0, + ) + ) if new_user_permissions_list: - frappe.db.sql(''' + frappe.db.sql( + """ INSERT INTO `tabUser Permission` (`name`, `user`, `allow`, `for_value`, `applicable_for`, `apply_to_all_doctypes`) - VALUES {}'''.format(', '.join(['%s'] * len(new_user_permissions_list))), # nosec - tuple(new_user_permissions_list) + VALUES {}""".format( + ", ".join(["%s"] * len(new_user_permissions_list)) + ), # nosec + tuple(new_user_permissions_list), ) if user_permissions_to_delete: - frappe.db.sql('DELETE FROM `tabUser Permission` WHERE `name` IN ({})'.format( # nosec - ','.join(['%s'] * len(user_permissions_to_delete)) - ), tuple(user_permissions_to_delete)) + frappe.db.sql( + "DELETE FROM `tabUser Permission` WHERE `name` IN ({})".format( # nosec + ",".join(["%s"] * len(user_permissions_to_delete)) + ), + tuple(user_permissions_to_delete), + ) diff --git a/erpnext/patches/v11_0/uom_conversion_data.py b/erpnext/patches/v11_0/uom_conversion_data.py index 854f5223470..5dee0840eb8 100644 --- a/erpnext/patches/v11_0/uom_conversion_data.py +++ b/erpnext/patches/v11_0/uom_conversion_data.py @@ -1,4 +1,3 @@ - import frappe @@ -15,8 +14,8 @@ def execute(): # delete conversion data and insert again frappe.db.sql("delete from `tabUOM Conversion Factor`") try: - frappe.delete_doc('UOM', 'Hundredweight') - frappe.delete_doc('UOM', 'Pound Cubic Yard') + frappe.delete_doc("UOM", "Hundredweight") + frappe.delete_doc("UOM", "Pound Cubic Yard") except frappe.LinkExistsError: pass diff --git a/erpnext/patches/v11_0/update_account_type_in_party_type.py b/erpnext/patches/v11_0/update_account_type_in_party_type.py index c66cef042d9..e55f9f20cc8 100644 --- a/erpnext/patches/v11_0/update_account_type_in_party_type.py +++ b/erpnext/patches/v11_0/update_account_type_in_party_type.py @@ -6,9 +6,15 @@ import frappe def execute(): - frappe.reload_doc('setup', 'doctype', 'party_type') - party_types = {'Customer': 'Receivable', 'Supplier': 'Payable', - 'Employee': 'Payable', 'Member': 'Receivable', 'Shareholder': 'Payable', 'Student': 'Receivable'} + frappe.reload_doc("setup", "doctype", "party_type") + party_types = { + "Customer": "Receivable", + "Supplier": "Payable", + "Employee": "Payable", + "Member": "Receivable", + "Shareholder": "Payable", + "Student": "Receivable", + } for party_type, account_type in party_types.items(): - frappe.db.set_value('Party Type', party_type, 'account_type', account_type) + frappe.db.set_value("Party Type", party_type, "account_type", account_type) diff --git a/erpnext/patches/v11_0/update_allow_transfer_for_manufacture.py b/erpnext/patches/v11_0/update_allow_transfer_for_manufacture.py index 3e36a4bb90d..a7351d27595 100644 --- a/erpnext/patches/v11_0/update_allow_transfer_for_manufacture.py +++ b/erpnext/patches/v11_0/update_allow_transfer_for_manufacture.py @@ -6,16 +6,22 @@ import frappe def execute(): - frappe.reload_doc('stock', 'doctype', 'item') - frappe.db.sql(""" update `tabItem` set include_item_in_manufacturing = 1 - where ifnull(is_stock_item, 0) = 1""") + frappe.reload_doc("stock", "doctype", "item") + frappe.db.sql( + """ update `tabItem` set include_item_in_manufacturing = 1 + where ifnull(is_stock_item, 0) = 1""" + ) - for doctype in ['BOM Item', 'Work Order Item', 'BOM Explosion Item']: - frappe.reload_doc('manufacturing', 'doctype', frappe.scrub(doctype)) + for doctype in ["BOM Item", "Work Order Item", "BOM Explosion Item"]: + frappe.reload_doc("manufacturing", "doctype", frappe.scrub(doctype)) - frappe.db.sql(""" update `tab{0}` child, tabItem item + frappe.db.sql( + """ update `tab{0}` child, tabItem item set child.include_item_in_manufacturing = 1 where child.item_code = item.name and ifnull(item.is_stock_item, 0) = 1 - """.format(doctype)) + """.format( + doctype + ) + ) diff --git a/erpnext/patches/v11_0/update_backflush_subcontract_rm_based_on_bom.py b/erpnext/patches/v11_0/update_backflush_subcontract_rm_based_on_bom.py index f3a2ac6a655..51ba706dcf0 100644 --- a/erpnext/patches/v11_0/update_backflush_subcontract_rm_based_on_bom.py +++ b/erpnext/patches/v11_0/update_backflush_subcontract_rm_based_on_bom.py @@ -6,15 +6,19 @@ import frappe def execute(): - frappe.reload_doc('buying', 'doctype', 'buying_settings') - frappe.db.set_value('Buying Settings', None, 'backflush_raw_materials_of_subcontract_based_on', 'BOM') + frappe.reload_doc("buying", "doctype", "buying_settings") + frappe.db.set_value( + "Buying Settings", None, "backflush_raw_materials_of_subcontract_based_on", "BOM" + ) - frappe.reload_doc('stock', 'doctype', 'stock_entry_detail') - frappe.db.sql(""" update `tabStock Entry Detail` as sed, + frappe.reload_doc("stock", "doctype", "stock_entry_detail") + frappe.db.sql( + """ update `tabStock Entry Detail` as sed, `tabStock Entry` as se, `tabPurchase Order Item Supplied` as pois set sed.subcontracted_item = pois.main_item_code where se.purpose = 'Send to Subcontractor' and sed.parent = se.name and pois.rm_item_code = sed.item_code and se.docstatus = 1 - and pois.parenttype = 'Purchase Order'""") + and pois.parenttype = 'Purchase Order'""" + ) diff --git a/erpnext/patches/v11_0/update_brand_in_item_price.py b/erpnext/patches/v11_0/update_brand_in_item_price.py index ce1df78083f..f4859ae1c77 100644 --- a/erpnext/patches/v11_0/update_brand_in_item_price.py +++ b/erpnext/patches/v11_0/update_brand_in_item_price.py @@ -6,11 +6,13 @@ import frappe def execute(): - frappe.reload_doc('stock', 'doctype', 'item_price') + frappe.reload_doc("stock", "doctype", "item_price") - frappe.db.sql(""" update `tabItem Price`, `tabItem` + frappe.db.sql( + """ update `tabItem Price`, `tabItem` set `tabItem Price`.brand = `tabItem`.brand where `tabItem Price`.item_code = `tabItem`.name - and `tabItem`.brand is not null and `tabItem`.brand != ''""") + and `tabItem`.brand is not null and `tabItem`.brand != ''""" + ) diff --git a/erpnext/patches/v11_0/update_delivery_trip_status.py b/erpnext/patches/v11_0/update_delivery_trip_status.py index 35b95353b12..1badfab5025 100755 --- a/erpnext/patches/v11_0/update_delivery_trip_status.py +++ b/erpnext/patches/v11_0/update_delivery_trip_status.py @@ -6,18 +6,14 @@ import frappe def execute(): - frappe.reload_doc('setup', 'doctype', 'global_defaults', force=True) - frappe.reload_doc('stock', 'doctype', 'delivery_trip') - frappe.reload_doc('stock', 'doctype', 'delivery_stop', force=True) + frappe.reload_doc("setup", "doctype", "global_defaults", force=True) + frappe.reload_doc("stock", "doctype", "delivery_trip") + frappe.reload_doc("stock", "doctype", "delivery_stop", force=True) for trip in frappe.get_all("Delivery Trip"): trip_doc = frappe.get_doc("Delivery Trip", trip.name) - status = { - 0: "Draft", - 1: "Scheduled", - 2: "Cancelled" - }[trip_doc.docstatus] + status = {0: "Draft", 1: "Scheduled", 2: "Cancelled"}[trip_doc.docstatus] if trip_doc.docstatus == 1: visited_stops = [stop.visited for stop in trip_doc.delivery_stops] diff --git a/erpnext/patches/v11_0/update_department_lft_rgt.py b/erpnext/patches/v11_0/update_department_lft_rgt.py index 4cb2dccbb27..bca5e9e8825 100644 --- a/erpnext/patches/v11_0/update_department_lft_rgt.py +++ b/erpnext/patches/v11_0/update_department_lft_rgt.py @@ -1,20 +1,21 @@ - import frappe from frappe import _ from frappe.utils.nestedset import rebuild_tree def execute(): - """ assign lft and rgt appropriately """ + """assign lft and rgt appropriately""" frappe.reload_doc("hr", "doctype", "department") - if not frappe.db.exists("Department", _('All Departments')): - frappe.get_doc({ - 'doctype': 'Department', - 'department_name': _('All Departments'), - 'is_group': 1 - }).insert(ignore_permissions=True, ignore_mandatory=True) + if not frappe.db.exists("Department", _("All Departments")): + frappe.get_doc( + {"doctype": "Department", "department_name": _("All Departments"), "is_group": 1} + ).insert(ignore_permissions=True, ignore_mandatory=True) - frappe.db.sql("""update `tabDepartment` set parent_department = '{0}' - where is_group = 0""".format(_('All Departments'))) + frappe.db.sql( + """update `tabDepartment` set parent_department = '{0}' + where is_group = 0""".format( + _("All Departments") + ) + ) rebuild_tree("Department", "parent_department") diff --git a/erpnext/patches/v11_0/update_hub_url.py b/erpnext/patches/v11_0/update_hub_url.py index 9150581c580..8eec3f3f318 100644 --- a/erpnext/patches/v11_0/update_hub_url.py +++ b/erpnext/patches/v11_0/update_hub_url.py @@ -1,7 +1,8 @@ - import frappe def execute(): - frappe.reload_doc('hub_node', 'doctype', 'Marketplace Settings') - frappe.db.set_value('Marketplace Settings', 'Marketplace Settings', 'marketplace_url', 'https://hubmarket.org') + frappe.reload_doc("hub_node", "doctype", "Marketplace Settings") + frappe.db.set_value( + "Marketplace Settings", "Marketplace Settings", "marketplace_url", "https://hubmarket.org" + ) diff --git a/erpnext/patches/v11_0/update_sales_partner_type.py b/erpnext/patches/v11_0/update_sales_partner_type.py index c7937e532be..2d37fd69b19 100644 --- a/erpnext/patches/v11_0/update_sales_partner_type.py +++ b/erpnext/patches/v11_0/update_sales_partner_type.py @@ -1,4 +1,3 @@ - import frappe from frappe import _ @@ -6,25 +5,28 @@ from frappe import _ def execute(): from erpnext.setup.setup_wizard.operations.install_fixtures import default_sales_partner_type - frappe.reload_doc('selling', 'doctype', 'sales_partner_type') + frappe.reload_doc("selling", "doctype", "sales_partner_type") - frappe.local.lang = frappe.db.get_default("lang") or 'en' + frappe.local.lang = frappe.db.get_default("lang") or "en" for s in default_sales_partner_type: insert_sales_partner_type(_(s)) # get partner type in existing forms (customized) # and create a document if not created - for d in ['Sales Partner']: - partner_type = frappe.db.sql_list('select distinct partner_type from `tab{0}`'.format(d)) + for d in ["Sales Partner"]: + partner_type = frappe.db.sql_list("select distinct partner_type from `tab{0}`".format(d)) for s in partner_type: if s and s not in default_sales_partner_type: insert_sales_partner_type(s) # remove customization for partner type - for p in frappe.get_all('Property Setter', {'doc_type':d, 'field_name':'partner_type', 'property':'options'}): - frappe.delete_doc('Property Setter', p.name) + for p in frappe.get_all( + "Property Setter", {"doc_type": d, "field_name": "partner_type", "property": "options"} + ): + frappe.delete_doc("Property Setter", p.name) + def insert_sales_partner_type(s): - if not frappe.db.exists('Sales Partner Type', s): - frappe.get_doc(dict(doctype='Sales Partner Type', sales_partner_type=s)).insert() + if not frappe.db.exists("Sales Partner Type", s): + frappe.get_doc(dict(doctype="Sales Partner Type", sales_partner_type=s)).insert() diff --git a/erpnext/patches/v11_0/update_total_qty_field.py b/erpnext/patches/v11_0/update_total_qty_field.py index 09bb02f9593..09fcdb8723d 100644 --- a/erpnext/patches/v11_0/update_total_qty_field.py +++ b/erpnext/patches/v11_0/update_total_qty_field.py @@ -1,35 +1,47 @@ - import frappe def execute(): - frappe.reload_doc('buying', 'doctype', 'purchase_order') - frappe.reload_doc('buying', 'doctype', 'supplier_quotation') - frappe.reload_doc('selling', 'doctype', 'sales_order') - frappe.reload_doc('selling', 'doctype', 'quotation') - frappe.reload_doc('stock', 'doctype', 'delivery_note') - frappe.reload_doc('stock', 'doctype', 'purchase_receipt') - frappe.reload_doc('accounts', 'doctype', 'sales_invoice') - frappe.reload_doc('accounts', 'doctype', 'purchase_invoice') + frappe.reload_doc("buying", "doctype", "purchase_order") + frappe.reload_doc("buying", "doctype", "supplier_quotation") + frappe.reload_doc("selling", "doctype", "sales_order") + frappe.reload_doc("selling", "doctype", "quotation") + frappe.reload_doc("stock", "doctype", "delivery_note") + frappe.reload_doc("stock", "doctype", "purchase_receipt") + frappe.reload_doc("accounts", "doctype", "sales_invoice") + frappe.reload_doc("accounts", "doctype", "purchase_invoice") - doctypes = ["Sales Order", "Sales Invoice", "Delivery Note",\ - "Purchase Order", "Purchase Invoice", "Purchase Receipt", "Quotation", "Supplier Quotation"] + doctypes = [ + "Sales Order", + "Sales Invoice", + "Delivery Note", + "Purchase Order", + "Purchase Invoice", + "Purchase Receipt", + "Quotation", + "Supplier Quotation", + ] for doctype in doctypes: - total_qty = frappe.db.sql(''' + total_qty = frappe.db.sql( + """ SELECT parent, SUM(qty) as qty FROM `tab{0} Item` where parenttype = '{0}' GROUP BY parent - '''.format(doctype), as_dict = True) + """.format( + doctype + ), + as_dict=True, + ) # Query to update total_qty might become too big, Update in batches # batch_size is chosen arbitrarily, Don't try too hard to reason about it batch_size = 100000 for i in range(0, len(total_qty), batch_size): - batch_transactions = total_qty[i:i + batch_size] + batch_transactions = total_qty[i : i + batch_size] # UPDATE with CASE for some reason cannot use PRIMARY INDEX, # causing all rows to be examined, leading to a very slow update @@ -43,7 +55,11 @@ def execute(): for d in batch_transactions: values.append("({0}, {1})".format(frappe.db.escape(d.parent), d.qty)) conditions = ",".join(values) - frappe.db.sql(""" + frappe.db.sql( + """ INSERT INTO `tab{}` (name, total_qty) VALUES {} ON DUPLICATE KEY UPDATE name = VALUES(name), total_qty = VALUES(total_qty) - """.format(doctype, conditions)) + """.format( + doctype, conditions + ) + ) diff --git a/erpnext/patches/v11_1/delete_bom_browser.py b/erpnext/patches/v11_1/delete_bom_browser.py index 9b5c169717a..09ee1695b9f 100644 --- a/erpnext/patches/v11_1/delete_bom_browser.py +++ b/erpnext/patches/v11_1/delete_bom_browser.py @@ -6,4 +6,4 @@ import frappe def execute(): - frappe.delete_doc_if_exists('Page', 'bom-browser') + frappe.delete_doc_if_exists("Page", "bom-browser") diff --git a/erpnext/patches/v11_1/make_job_card_time_logs.py b/erpnext/patches/v11_1/make_job_card_time_logs.py index 100cd64f8fe..beb2c4e5341 100644 --- a/erpnext/patches/v11_1/make_job_card_time_logs.py +++ b/erpnext/patches/v11_1/make_job_card_time_logs.py @@ -6,25 +6,45 @@ import frappe def execute(): - frappe.reload_doc('manufacturing', 'doctype', 'job_card_time_log') + frappe.reload_doc("manufacturing", "doctype", "job_card_time_log") - if (frappe.db.table_exists("Job Card") - and frappe.get_meta("Job Card").has_field("actual_start_date")): - time_logs = [] - for d in frappe.get_all('Job Card', - fields = ["actual_start_date", "actual_end_date", "time_in_mins", "name", "for_quantity"], - filters = {'docstatus': ("<", 2)}): - if d.actual_start_date: - time_logs.append([d.actual_start_date, d.actual_end_date, d.time_in_mins, - d.for_quantity, d.name, 'Job Card', 'time_logs', frappe.generate_hash("", 10)]) + if frappe.db.table_exists("Job Card") and frappe.get_meta("Job Card").has_field( + "actual_start_date" + ): + time_logs = [] + for d in frappe.get_all( + "Job Card", + fields=["actual_start_date", "actual_end_date", "time_in_mins", "name", "for_quantity"], + filters={"docstatus": ("<", 2)}, + ): + if d.actual_start_date: + time_logs.append( + [ + d.actual_start_date, + d.actual_end_date, + d.time_in_mins, + d.for_quantity, + d.name, + "Job Card", + "time_logs", + frappe.generate_hash("", 10), + ] + ) - if time_logs: - frappe.db.sql(""" INSERT INTO + if time_logs: + frappe.db.sql( + """ INSERT INTO `tabJob Card Time Log` (from_time, to_time, time_in_mins, completed_qty, parent, parenttype, parentfield, name) values {values} - """.format(values = ','.join(['%s'] * len(time_logs))), tuple(time_logs)) + """.format( + values=",".join(["%s"] * len(time_logs)) + ), + tuple(time_logs), + ) - frappe.reload_doc('manufacturing', 'doctype', 'job_card') - frappe.db.sql(""" update `tabJob Card` set total_completed_qty = for_quantity, - total_time_in_mins = time_in_mins where docstatus < 2 """) + frappe.reload_doc("manufacturing", "doctype", "job_card") + frappe.db.sql( + """ update `tabJob Card` set total_completed_qty = for_quantity, + total_time_in_mins = time_in_mins where docstatus < 2 """ + ) diff --git a/erpnext/patches/v11_1/move_customer_lead_to_dynamic_column.py b/erpnext/patches/v11_1/move_customer_lead_to_dynamic_column.py index d292d7ae432..b681f25d84e 100644 --- a/erpnext/patches/v11_1/move_customer_lead_to_dynamic_column.py +++ b/erpnext/patches/v11_1/move_customer_lead_to_dynamic_column.py @@ -8,8 +8,14 @@ import frappe def execute(): frappe.reload_doctype("Quotation") frappe.db.sql(""" UPDATE `tabQuotation` set party_name = lead WHERE quotation_to = 'Lead' """) - frappe.db.sql(""" UPDATE `tabQuotation` set party_name = customer WHERE quotation_to = 'Customer' """) + frappe.db.sql( + """ UPDATE `tabQuotation` set party_name = customer WHERE quotation_to = 'Customer' """ + ) frappe.reload_doctype("Opportunity") - frappe.db.sql(""" UPDATE `tabOpportunity` set party_name = lead WHERE opportunity_from = 'Lead' """) - frappe.db.sql(""" UPDATE `tabOpportunity` set party_name = customer WHERE opportunity_from = 'Customer' """) + frappe.db.sql( + """ UPDATE `tabOpportunity` set party_name = lead WHERE opportunity_from = 'Lead' """ + ) + frappe.db.sql( + """ UPDATE `tabOpportunity` set party_name = customer WHERE opportunity_from = 'Customer' """ + ) diff --git a/erpnext/patches/v11_1/renamed_delayed_item_report.py b/erpnext/patches/v11_1/renamed_delayed_item_report.py index c160b79d0e9..86247815e29 100644 --- a/erpnext/patches/v11_1/renamed_delayed_item_report.py +++ b/erpnext/patches/v11_1/renamed_delayed_item_report.py @@ -6,6 +6,6 @@ import frappe def execute(): - for report in ["Delayed Order Item Summary", "Delayed Order Summary"]: - if frappe.db.exists("Report", report): - frappe.delete_doc("Report", report) + for report in ["Delayed Order Item Summary", "Delayed Order Summary"]: + if frappe.db.exists("Report", report): + frappe.delete_doc("Report", report) diff --git a/erpnext/patches/v11_1/set_default_action_for_quality_inspection.py b/erpnext/patches/v11_1/set_default_action_for_quality_inspection.py index 672b7628bb4..39aa6dd8e8e 100644 --- a/erpnext/patches/v11_1/set_default_action_for_quality_inspection.py +++ b/erpnext/patches/v11_1/set_default_action_for_quality_inspection.py @@ -6,11 +6,13 @@ import frappe def execute(): - stock_settings = frappe.get_doc('Stock Settings') - if stock_settings.default_warehouse and not frappe.db.exists("Warehouse", stock_settings.default_warehouse): - stock_settings.default_warehouse = None - if stock_settings.stock_uom and not frappe.db.exists("UOM", stock_settings.stock_uom): - stock_settings.stock_uom = None - stock_settings.flags.ignore_mandatory = True - stock_settings.action_if_quality_inspection_is_not_submitted = "Stop" - stock_settings.save() + stock_settings = frappe.get_doc("Stock Settings") + if stock_settings.default_warehouse and not frappe.db.exists( + "Warehouse", stock_settings.default_warehouse + ): + stock_settings.default_warehouse = None + if stock_settings.stock_uom and not frappe.db.exists("UOM", stock_settings.stock_uom): + stock_settings.stock_uom = None + stock_settings.flags.ignore_mandatory = True + stock_settings.action_if_quality_inspection_is_not_submitted = "Stop" + stock_settings.save() diff --git a/erpnext/patches/v11_1/set_missing_opportunity_from.py b/erpnext/patches/v11_1/set_missing_opportunity_from.py index 7a041919a15..ae5f6200145 100644 --- a/erpnext/patches/v11_1/set_missing_opportunity_from.py +++ b/erpnext/patches/v11_1/set_missing_opportunity_from.py @@ -1,4 +1,3 @@ - import frappe @@ -6,13 +5,23 @@ def execute(): frappe.reload_doctype("Opportunity") if frappe.db.has_column("Opportunity", "enquiry_from"): - frappe.db.sql(""" UPDATE `tabOpportunity` set opportunity_from = enquiry_from - where ifnull(opportunity_from, '') = '' and ifnull(enquiry_from, '') != ''""") + frappe.db.sql( + """ UPDATE `tabOpportunity` set opportunity_from = enquiry_from + where ifnull(opportunity_from, '') = '' and ifnull(enquiry_from, '') != ''""" + ) - if frappe.db.has_column("Opportunity", "lead") and frappe.db.has_column("Opportunity", "enquiry_from"): - frappe.db.sql(""" UPDATE `tabOpportunity` set party_name = lead - where enquiry_from = 'Lead' and ifnull(party_name, '') = '' and ifnull(lead, '') != ''""") + if frappe.db.has_column("Opportunity", "lead") and frappe.db.has_column( + "Opportunity", "enquiry_from" + ): + frappe.db.sql( + """ UPDATE `tabOpportunity` set party_name = lead + where enquiry_from = 'Lead' and ifnull(party_name, '') = '' and ifnull(lead, '') != ''""" + ) - if frappe.db.has_column("Opportunity", "customer") and frappe.db.has_column("Opportunity", "enquiry_from"): - frappe.db.sql(""" UPDATE `tabOpportunity` set party_name = customer - where enquiry_from = 'Customer' and ifnull(party_name, '') = '' and ifnull(customer, '') != ''""") + if frappe.db.has_column("Opportunity", "customer") and frappe.db.has_column( + "Opportunity", "enquiry_from" + ): + frappe.db.sql( + """ UPDATE `tabOpportunity` set party_name = customer + where enquiry_from = 'Customer' and ifnull(party_name, '') = '' and ifnull(customer, '') != ''""" + ) diff --git a/erpnext/patches/v11_1/set_missing_title_for_quotation.py b/erpnext/patches/v11_1/set_missing_title_for_quotation.py index 93d9f0e7d89..6e7e2c9d8bf 100644 --- a/erpnext/patches/v11_1/set_missing_title_for_quotation.py +++ b/erpnext/patches/v11_1/set_missing_title_for_quotation.py @@ -4,7 +4,8 @@ import frappe def execute(): frappe.reload_doctype("Quotation") # update customer_name from Customer document if quotation_to is set to Customer - frappe.db.sql(''' + frappe.db.sql( + """ update tabQuotation, tabCustomer set tabQuotation.customer_name = tabCustomer.customer_name, @@ -13,11 +14,13 @@ def execute(): tabQuotation.customer_name is null and tabQuotation.party_name = tabCustomer.name and tabQuotation.quotation_to = 'Customer' - ''') + """ + ) # update customer_name from Lead document if quotation_to is set to Lead - frappe.db.sql(''' + frappe.db.sql( + """ update tabQuotation, tabLead set tabQuotation.customer_name = case when ifnull(tabLead.company_name, '') != '' then tabLead.company_name else tabLead.lead_name end, @@ -26,4 +29,5 @@ def execute(): tabQuotation.customer_name is null and tabQuotation.party_name = tabLead.name and tabQuotation.quotation_to = 'Lead' - ''') + """ + ) diff --git a/erpnext/patches/v11_1/set_salary_details_submittable.py b/erpnext/patches/v11_1/set_salary_details_submittable.py index 8ad8ff8c2ba..e5ecce6486a 100644 --- a/erpnext/patches/v11_1/set_salary_details_submittable.py +++ b/erpnext/patches/v11_1/set_salary_details_submittable.py @@ -1,10 +1,11 @@ - import frappe def execute(): - frappe.db.sql(""" + frappe.db.sql( + """ update `tabSalary Structure` ss, `tabSalary Detail` sd set sd.docstatus=1 where ss.name=sd.parent and ss.docstatus=1 and sd.parenttype='Salary Structure' - """) + """ + ) diff --git a/erpnext/patches/v11_1/set_status_for_material_request_type_manufacture.py b/erpnext/patches/v11_1/set_status_for_material_request_type_manufacture.py index 2da1ecbda26..6e2edfea878 100644 --- a/erpnext/patches/v11_1/set_status_for_material_request_type_manufacture.py +++ b/erpnext/patches/v11_1/set_status_for_material_request_type_manufacture.py @@ -1,10 +1,11 @@ - import frappe def execute(): - frappe.db.sql(""" + frappe.db.sql( + """ update `tabMaterial Request` set status='Manufactured' where docstatus=1 and material_request_type='Manufacture' and per_ordered=100 and status != 'Stopped' - """) + """ + ) diff --git a/erpnext/patches/v11_1/set_variant_based_on.py b/erpnext/patches/v11_1/set_variant_based_on.py index 2e06e63a8aa..1d57527b1f8 100644 --- a/erpnext/patches/v11_1/set_variant_based_on.py +++ b/erpnext/patches/v11_1/set_variant_based_on.py @@ -6,7 +6,9 @@ import frappe def execute(): - frappe.db.sql("""update tabItem set variant_based_on = 'Item Attribute' + frappe.db.sql( + """update tabItem set variant_based_on = 'Item Attribute' where ifnull(variant_based_on, '') = '' and (has_variants=1 or ifnull(variant_of, '') != '') - """) + """ + ) diff --git a/erpnext/patches/v11_1/setup_guardian_role.py b/erpnext/patches/v11_1/setup_guardian_role.py index 385bc209fa2..2b25e132540 100644 --- a/erpnext/patches/v11_1/setup_guardian_role.py +++ b/erpnext/patches/v11_1/setup_guardian_role.py @@ -1,13 +1,9 @@ - import frappe def execute(): - if 'Education' in frappe.get_active_domains() and not frappe.db.exists("Role", "Guardian"): + if "Education" in frappe.get_active_domains() and not frappe.db.exists("Role", "Guardian"): doc = frappe.new_doc("Role") - doc.update({ - "role_name": "Guardian", - "desk_access": 0 - }) + doc.update({"role_name": "Guardian", "desk_access": 0}) doc.insert(ignore_permissions=True) diff --git a/erpnext/patches/v11_1/update_bank_transaction_status.py b/erpnext/patches/v11_1/update_bank_transaction_status.py index 9b8be3de1b0..0615b04a57f 100644 --- a/erpnext/patches/v11_1/update_bank_transaction_status.py +++ b/erpnext/patches/v11_1/update_bank_transaction_status.py @@ -6,22 +6,26 @@ import frappe def execute(): - frappe.reload_doc("accounts", "doctype", "bank_transaction") + frappe.reload_doc("accounts", "doctype", "bank_transaction") - bank_transaction_fields = frappe.get_meta("Bank Transaction").get_valid_columns() + bank_transaction_fields = frappe.get_meta("Bank Transaction").get_valid_columns() - if 'debit' in bank_transaction_fields: - frappe.db.sql(""" UPDATE `tabBank Transaction` + if "debit" in bank_transaction_fields: + frappe.db.sql( + """ UPDATE `tabBank Transaction` SET status = 'Reconciled' WHERE status = 'Settled' and (debit = allocated_amount or credit = allocated_amount) and ifnull(allocated_amount, 0) > 0 - """) + """ + ) - elif 'deposit' in bank_transaction_fields: - frappe.db.sql(""" UPDATE `tabBank Transaction` + elif "deposit" in bank_transaction_fields: + frappe.db.sql( + """ UPDATE `tabBank Transaction` SET status = 'Reconciled' WHERE status = 'Settled' and (deposit = allocated_amount or withdrawal = allocated_amount) and ifnull(allocated_amount, 0) > 0 - """) + """ + ) diff --git a/erpnext/patches/v11_1/update_default_supplier_in_item_defaults.py b/erpnext/patches/v11_1/update_default_supplier_in_item_defaults.py index 902df201a42..16e11ed7be3 100644 --- a/erpnext/patches/v11_1/update_default_supplier_in_item_defaults.py +++ b/erpnext/patches/v11_1/update_default_supplier_in_item_defaults.py @@ -6,21 +6,23 @@ import frappe def execute(): - ''' - default supplier was not set in the item defaults for multi company instance, - this patch will set the default supplier + """ + default supplier was not set in the item defaults for multi company instance, + this patch will set the default supplier - ''' - if not frappe.db.has_column('Item', 'default_supplier'): + """ + if not frappe.db.has_column("Item", "default_supplier"): return - frappe.reload_doc('stock', 'doctype', 'item_default') - frappe.reload_doc('stock', 'doctype', 'item') + frappe.reload_doc("stock", "doctype", "item_default") + frappe.reload_doc("stock", "doctype", "item") companies = frappe.get_all("Company") if len(companies) > 1: - frappe.db.sql(""" UPDATE `tabItem Default`, `tabItem` + frappe.db.sql( + """ UPDATE `tabItem Default`, `tabItem` SET `tabItem Default`.default_supplier = `tabItem`.default_supplier WHERE `tabItem Default`.parent = `tabItem`.name and `tabItem Default`.default_supplier is null - and `tabItem`.default_supplier is not null and `tabItem`.default_supplier != '' """) + and `tabItem`.default_supplier is not null and `tabItem`.default_supplier != '' """ + ) diff --git a/erpnext/patches/v11_1/woocommerce_set_creation_user.py b/erpnext/patches/v11_1/woocommerce_set_creation_user.py index 1de25bb739c..e2d9e3ef38a 100644 --- a/erpnext/patches/v11_1/woocommerce_set_creation_user.py +++ b/erpnext/patches/v11_1/woocommerce_set_creation_user.py @@ -1,10 +1,9 @@ - import frappe from frappe.utils import cint def execute(): - frappe.reload_doc("erpnext_integrations", "doctype","woocommerce_settings") + frappe.reload_doc("erpnext_integrations", "doctype", "woocommerce_settings") doc = frappe.get_doc("Woocommerce Settings") if cint(doc.enable_sync): diff --git a/erpnext/patches/v12_0/add_company_link_to_einvoice_settings.py b/erpnext/patches/v12_0/add_company_link_to_einvoice_settings.py index 53d363f233f..1778a45049b 100644 --- a/erpnext/patches/v12_0/add_company_link_to_einvoice_settings.py +++ b/erpnext/patches/v12_0/add_company_link_to_einvoice_settings.py @@ -1,21 +1,23 @@ - import frappe def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return frappe.reload_doc("regional", "doctype", "e_invoice_user") - if not frappe.db.count('E Invoice User'): + if not frappe.db.count("E Invoice User"): return - for creds in frappe.db.get_all('E Invoice User', fields=['name', 'gstin']): - company_name = frappe.db.sql(""" + for creds in frappe.db.get_all("E Invoice User", fields=["name", "gstin"]): + company_name = frappe.db.sql( + """ select dl.link_name from `tabAddress` a, `tabDynamic Link` dl where a.gstin = %s and dl.parent = a.name and dl.link_doctype = 'Company' - """, (creds.get('gstin'))) + """, + (creds.get("gstin")), + ) if company_name and len(company_name) > 0: - frappe.db.set_value('E Invoice User', creds.get('name'), 'company', company_name[0][0]) + frappe.db.set_value("E Invoice User", creds.get("name"), "company", company_name[0][0]) diff --git a/erpnext/patches/v12_0/add_default_buying_selling_terms_in_company.py b/erpnext/patches/v12_0/add_default_buying_selling_terms_in_company.py index 80187d834a4..284b616bbda 100644 --- a/erpnext/patches/v12_0/add_default_buying_selling_terms_in_company.py +++ b/erpnext/patches/v12_0/add_default_buying_selling_terms_in_company.py @@ -8,12 +8,16 @@ from frappe.model.utils.rename_field import rename_field def execute(): frappe.reload_doc("setup", "doctype", "company") - if frappe.db.has_column('Company', 'default_terms'): - rename_field('Company', "default_terms", "default_selling_terms") + if frappe.db.has_column("Company", "default_terms"): + rename_field("Company", "default_terms", "default_selling_terms") - for company in frappe.get_all("Company", ["name", "default_selling_terms", "default_buying_terms"]): + for company in frappe.get_all( + "Company", ["name", "default_selling_terms", "default_buying_terms"] + ): if company.default_selling_terms and not company.default_buying_terms: - frappe.db.set_value("Company", company.name, "default_buying_terms", company.default_selling_terms) + frappe.db.set_value( + "Company", company.name, "default_buying_terms", company.default_selling_terms + ) frappe.reload_doc("setup", "doctype", "terms_and_conditions") frappe.db.sql("update `tabTerms and Conditions` set selling=1, buying=1, hr=1") diff --git a/erpnext/patches/v12_0/add_document_type_field_for_italy_einvoicing.py b/erpnext/patches/v12_0/add_document_type_field_for_italy_einvoicing.py index 41264819ef3..a98976a968c 100644 --- a/erpnext/patches/v12_0/add_document_type_field_for_italy_einvoicing.py +++ b/erpnext/patches/v12_0/add_document_type_field_for_italy_einvoicing.py @@ -1,18 +1,21 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'Italy'}) + company = frappe.get_all("Company", filters={"country": "Italy"}) if not company: return custom_fields = { - 'Sales Invoice': [ - dict(fieldname='type_of_document', label='Type of Document', - fieldtype='Select', insert_after='customer_fiscal_code', - options='\nTD01\nTD02\nTD03\nTD04\nTD05\nTD06\nTD16\nTD17\nTD18\nTD19\nTD20\nTD21\nTD22\nTD23\nTD24\nTD25\nTD26\nTD27'), + "Sales Invoice": [ + dict( + fieldname="type_of_document", + label="Type of Document", + fieldtype="Select", + insert_after="customer_fiscal_code", + options="\nTD01\nTD02\nTD03\nTD04\nTD05\nTD06\nTD16\nTD17\nTD18\nTD19\nTD20\nTD21\nTD22\nTD23\nTD24\nTD25\nTD26\nTD27", + ), ] } diff --git a/erpnext/patches/v12_0/add_einvoice_status_field.py b/erpnext/patches/v12_0/add_einvoice_status_field.py index ae908573236..0948e822974 100644 --- a/erpnext/patches/v12_0/add_einvoice_status_field.py +++ b/erpnext/patches/v12_0/add_einvoice_status_field.py @@ -1,4 +1,3 @@ - import json import frappe @@ -6,66 +5,154 @@ from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return # move hidden einvoice fields to a different section custom_fields = { - 'Sales Invoice': [ - dict(fieldname='einvoice_section', label='E-Invoice Fields', fieldtype='Section Break', insert_after='gst_vehicle_type', - print_hide=1, hidden=1), - - dict(fieldname='ack_no', label='Ack. No.', fieldtype='Data', read_only=1, hidden=1, insert_after='einvoice_section', - no_copy=1, print_hide=1), - - dict(fieldname='ack_date', label='Ack. Date', fieldtype='Data', read_only=1, hidden=1, insert_after='ack_no', no_copy=1, print_hide=1), - - dict(fieldname='irn_cancel_date', label='Cancel Date', fieldtype='Data', read_only=1, hidden=1, insert_after='ack_date', - no_copy=1, print_hide=1), - - dict(fieldname='signed_einvoice', label='Signed E-Invoice', fieldtype='Code', options='JSON', hidden=1, insert_after='irn_cancel_date', - no_copy=1, print_hide=1, read_only=1), - - dict(fieldname='signed_qr_code', label='Signed QRCode', fieldtype='Code', options='JSON', hidden=1, insert_after='signed_einvoice', - no_copy=1, print_hide=1, read_only=1), - - dict(fieldname='qrcode_image', label='QRCode', fieldtype='Attach Image', hidden=1, insert_after='signed_qr_code', - no_copy=1, print_hide=1, read_only=1), - - dict(fieldname='einvoice_status', label='E-Invoice Status', fieldtype='Select', insert_after='qrcode_image', - options='\nPending\nGenerated\nCancelled\nFailed', default=None, hidden=1, no_copy=1, print_hide=1, read_only=1), - - dict(fieldname='failure_description', label='E-Invoice Failure Description', fieldtype='Code', options='JSON', - hidden=1, insert_after='einvoice_status', no_copy=1, print_hide=1, read_only=1) + "Sales Invoice": [ + dict( + fieldname="einvoice_section", + label="E-Invoice Fields", + fieldtype="Section Break", + insert_after="gst_vehicle_type", + print_hide=1, + hidden=1, + ), + dict( + fieldname="ack_no", + label="Ack. No.", + fieldtype="Data", + read_only=1, + hidden=1, + insert_after="einvoice_section", + no_copy=1, + print_hide=1, + ), + dict( + fieldname="ack_date", + label="Ack. Date", + fieldtype="Data", + read_only=1, + hidden=1, + insert_after="ack_no", + no_copy=1, + print_hide=1, + ), + dict( + fieldname="irn_cancel_date", + label="Cancel Date", + fieldtype="Data", + read_only=1, + hidden=1, + insert_after="ack_date", + no_copy=1, + print_hide=1, + ), + dict( + fieldname="signed_einvoice", + label="Signed E-Invoice", + fieldtype="Code", + options="JSON", + hidden=1, + insert_after="irn_cancel_date", + no_copy=1, + print_hide=1, + read_only=1, + ), + dict( + fieldname="signed_qr_code", + label="Signed QRCode", + fieldtype="Code", + options="JSON", + hidden=1, + insert_after="signed_einvoice", + no_copy=1, + print_hide=1, + read_only=1, + ), + dict( + fieldname="qrcode_image", + label="QRCode", + fieldtype="Attach Image", + hidden=1, + insert_after="signed_qr_code", + no_copy=1, + print_hide=1, + read_only=1, + ), + dict( + fieldname="einvoice_status", + label="E-Invoice Status", + fieldtype="Select", + insert_after="qrcode_image", + options="\nPending\nGenerated\nCancelled\nFailed", + default=None, + hidden=1, + no_copy=1, + print_hide=1, + read_only=1, + ), + dict( + fieldname="failure_description", + label="E-Invoice Failure Description", + fieldtype="Code", + options="JSON", + hidden=1, + insert_after="einvoice_status", + no_copy=1, + print_hide=1, + read_only=1, + ), ] } create_custom_fields(custom_fields, update=True) - if frappe.db.exists('E Invoice Settings') and frappe.db.get_single_value('E Invoice Settings', 'enable'): - frappe.db.sql(''' + if frappe.db.exists("E Invoice Settings") and frappe.db.get_single_value( + "E Invoice Settings", "enable" + ): + frappe.db.sql( + """ UPDATE `tabSales Invoice` SET einvoice_status = 'Pending' WHERE posting_date >= '2021-04-01' AND ifnull(irn, '') = '' AND ifnull(`billing_address_gstin`, '') != ifnull(`company_gstin`, '') AND ifnull(gst_category, '') in ('Registered Regular', 'SEZ', 'Overseas', 'Deemed Export') - ''') + """ + ) # set appropriate statuses - frappe.db.sql('''UPDATE `tabSales Invoice` SET einvoice_status = 'Generated' - WHERE ifnull(irn, '') != '' AND ifnull(irn_cancelled, 0) = 0''') + frappe.db.sql( + """UPDATE `tabSales Invoice` SET einvoice_status = 'Generated' + WHERE ifnull(irn, '') != '' AND ifnull(irn_cancelled, 0) = 0""" + ) - frappe.db.sql('''UPDATE `tabSales Invoice` SET einvoice_status = 'Cancelled' - WHERE ifnull(irn_cancelled, 0) = 1''') + frappe.db.sql( + """UPDATE `tabSales Invoice` SET einvoice_status = 'Cancelled' + WHERE ifnull(irn_cancelled, 0) = 1""" + ) # set correct acknowledgement in e-invoices - einvoices = frappe.get_all('Sales Invoice', {'irn': ['is', 'set']}, ['name', 'signed_einvoice']) + einvoices = frappe.get_all("Sales Invoice", {"irn": ["is", "set"]}, ["name", "signed_einvoice"]) if einvoices: for inv in einvoices: - signed_einvoice = inv.get('signed_einvoice') + signed_einvoice = inv.get("signed_einvoice") if signed_einvoice: signed_einvoice = json.loads(signed_einvoice) - frappe.db.set_value('Sales Invoice', inv.get('name'), 'ack_no', signed_einvoice.get('AckNo'), update_modified=False) - frappe.db.set_value('Sales Invoice', inv.get('name'), 'ack_date', signed_einvoice.get('AckDt'), update_modified=False) + frappe.db.set_value( + "Sales Invoice", + inv.get("name"), + "ack_no", + signed_einvoice.get("AckNo"), + update_modified=False, + ) + frappe.db.set_value( + "Sales Invoice", + inv.get("name"), + "ack_date", + signed_einvoice.get("AckDt"), + update_modified=False, + ) diff --git a/erpnext/patches/v12_0/add_einvoice_summary_report_permissions.py b/erpnext/patches/v12_0/add_einvoice_summary_report_permissions.py index b5d8493ae0b..d15f4d1327e 100644 --- a/erpnext/patches/v12_0/add_einvoice_summary_report_permissions.py +++ b/erpnext/patches/v12_0/add_einvoice_summary_report_permissions.py @@ -1,19 +1,18 @@ - import frappe def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - if frappe.db.exists('Report', 'E-Invoice Summary') and \ - not frappe.db.get_value('Custom Role', dict(report='E-Invoice Summary')): - frappe.get_doc(dict( - doctype='Custom Role', - report='E-Invoice Summary', - roles= [ - dict(role='Accounts User'), - dict(role='Accounts Manager') - ] - )).insert() + if frappe.db.exists("Report", "E-Invoice Summary") and not frappe.db.get_value( + "Custom Role", dict(report="E-Invoice Summary") + ): + frappe.get_doc( + dict( + doctype="Custom Role", + report="E-Invoice Summary", + roles=[dict(role="Accounts User"), dict(role="Accounts Manager")], + ) + ).insert() diff --git a/erpnext/patches/v12_0/add_eway_bill_in_delivery_note.py b/erpnext/patches/v12_0/add_eway_bill_in_delivery_note.py index 973da895623..db9fa247ed5 100644 --- a/erpnext/patches/v12_0/add_eway_bill_in_delivery_note.py +++ b/erpnext/patches/v12_0/add_eway_bill_in_delivery_note.py @@ -3,18 +3,21 @@ from frappe.custom.doctype.custom_field.custom_field import create_custom_field def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) - if not company: - return + if not company: + return - create_custom_field('Delivery Note', { - 'fieldname': 'ewaybill', - 'label': 'E-Way Bill No.', - 'fieldtype': 'Data', - 'depends_on': 'eval:(doc.docstatus === 1)', - 'allow_on_submit': 1, - 'insert_after': 'customer_name_in_arabic', - 'translatable': 0, - 'owner': 'Administrator' - }) + create_custom_field( + "Delivery Note", + { + "fieldname": "ewaybill", + "label": "E-Way Bill No.", + "fieldtype": "Data", + "depends_on": "eval:(doc.docstatus === 1)", + "allow_on_submit": 1, + "insert_after": "customer_name_in_arabic", + "translatable": 0, + "owner": "Administrator", + }, + ) diff --git a/erpnext/patches/v12_0/add_ewaybill_validity_field.py b/erpnext/patches/v12_0/add_ewaybill_validity_field.py index 1c8a68a7517..19b96159ef7 100644 --- a/erpnext/patches/v12_0/add_ewaybill_validity_field.py +++ b/erpnext/patches/v12_0/add_ewaybill_validity_field.py @@ -1,17 +1,25 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return custom_fields = { - 'Sales Invoice': [ - dict(fieldname='eway_bill_validity', label='E-Way Bill Validity', fieldtype='Data', no_copy=1, print_hide=1, - depends_on='ewaybill', read_only=1, allow_on_submit=1, insert_after='ewaybill') + "Sales Invoice": [ + dict( + fieldname="eway_bill_validity", + label="E-Way Bill Validity", + fieldtype="Data", + no_copy=1, + print_hide=1, + depends_on="ewaybill", + read_only=1, + allow_on_submit=1, + insert_after="ewaybill", + ) ] } create_custom_fields(custom_fields, update=True) diff --git a/erpnext/patches/v12_0/add_export_type_field_in_party_master.py b/erpnext/patches/v12_0/add_export_type_field_in_party_master.py index df9bbea344a..b14ffd2d349 100644 --- a/erpnext/patches/v12_0/add_export_type_field_in_party_master.py +++ b/erpnext/patches/v12_0/add_export_type_field_in_party_master.py @@ -1,4 +1,3 @@ - import frappe from erpnext.regional.india.setup import make_custom_fields @@ -6,37 +5,38 @@ from erpnext.regional.india.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return make_custom_fields() - frappe.reload_doctype('Tax Category') - frappe.reload_doctype('Sales Taxes and Charges Template') - frappe.reload_doctype('Purchase Taxes and Charges Template') + frappe.reload_doctype("Tax Category") + frappe.reload_doctype("Sales Taxes and Charges Template") + frappe.reload_doctype("Purchase Taxes and Charges Template") # Create tax category with inter state field checked - tax_category = frappe.db.get_value('Tax Category', {'name': 'OUT OF STATE'}, 'name') + tax_category = frappe.db.get_value("Tax Category", {"name": "OUT OF STATE"}, "name") if not tax_category: - inter_state_category = frappe.get_doc({ - 'doctype': 'Tax Category', - 'title': 'OUT OF STATE', - 'is_inter_state': 1 - }).insert() + inter_state_category = frappe.get_doc( + {"doctype": "Tax Category", "title": "OUT OF STATE", "is_inter_state": 1} + ).insert() tax_category = inter_state_category.name - for doctype in ('Sales Taxes and Charges Template', 'Purchase Taxes and Charges Template'): - if not frappe.get_meta(doctype).has_field('is_inter_state'): continue + for doctype in ("Sales Taxes and Charges Template", "Purchase Taxes and Charges Template"): + if not frappe.get_meta(doctype).has_field("is_inter_state"): + continue - template = frappe.db.get_value(doctype, {'is_inter_state': 1, 'disabled': 0}, ['name']) + template = frappe.db.get_value(doctype, {"is_inter_state": 1, "disabled": 0}, ["name"]) if template: - frappe.db.set_value(doctype, template, 'tax_category', tax_category) + frappe.db.set_value(doctype, template, "tax_category", tax_category) - frappe.db.sql(""" + frappe.db.sql( + """ DELETE FROM `tabCustom Field` WHERE fieldname = 'is_inter_state' AND dt IN ('Sales Taxes and Charges Template', 'Purchase Taxes and Charges Template') - """) + """ + ) diff --git a/erpnext/patches/v12_0/add_gst_category_in_delivery_note.py b/erpnext/patches/v12_0/add_gst_category_in_delivery_note.py index 77b63487ca7..5944889b63d 100644 --- a/erpnext/patches/v12_0/add_gst_category_in_delivery_note.py +++ b/erpnext/patches/v12_0/add_gst_category_in_delivery_note.py @@ -1,19 +1,24 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return custom_fields = { - 'Delivery Note': [ - dict(fieldname='gst_category', label='GST Category', - fieldtype='Select', insert_after='gst_vehicle_type', print_hide=1, - options='\nRegistered Regular\nRegistered Composition\nUnregistered\nSEZ\nOverseas\nConsumer\nDeemed Export\nUIN Holders', - fetch_from='customer.gst_category', fetch_if_empty=1), + "Delivery Note": [ + dict( + fieldname="gst_category", + label="GST Category", + fieldtype="Select", + insert_after="gst_vehicle_type", + print_hide=1, + options="\nRegistered Regular\nRegistered Composition\nUnregistered\nSEZ\nOverseas\nConsumer\nDeemed Export\nUIN Holders", + fetch_from="customer.gst_category", + fetch_if_empty=1, + ), ] } diff --git a/erpnext/patches/v12_0/add_item_name_in_work_orders.py b/erpnext/patches/v12_0/add_item_name_in_work_orders.py index d765b93d218..0e5cd4eed52 100644 --- a/erpnext/patches/v12_0/add_item_name_in_work_orders.py +++ b/erpnext/patches/v12_0/add_item_name_in_work_orders.py @@ -4,11 +4,13 @@ import frappe def execute(): frappe.reload_doc("manufacturing", "doctype", "work_order") - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabWork Order` wo JOIN `tabItem` item ON wo.production_item = item.item_code SET wo.item_name = item.item_name - """) + """ + ) frappe.db.commit() diff --git a/erpnext/patches/v12_0/add_permission_in_lower_deduction.py b/erpnext/patches/v12_0/add_permission_in_lower_deduction.py index 1d77e5ad3d1..24748b2cc65 100644 --- a/erpnext/patches/v12_0/add_permission_in_lower_deduction.py +++ b/erpnext/patches/v12_0/add_permission_in_lower_deduction.py @@ -3,12 +3,12 @@ from frappe.permissions import add_permission, update_permission_property def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - frappe.reload_doc('regional', 'doctype', 'Lower Deduction Certificate') + frappe.reload_doc("regional", "doctype", "Lower Deduction Certificate") - add_permission('Lower Deduction Certificate', 'Accounts Manager', 0) - update_permission_property('Lower Deduction Certificate', 'Accounts Manager', 0, 'write', 1) - update_permission_property('Lower Deduction Certificate', 'Accounts Manager', 0, 'create', 1) + add_permission("Lower Deduction Certificate", "Accounts Manager", 0) + update_permission_property("Lower Deduction Certificate", "Accounts Manager", 0, "write", 1) + update_permission_property("Lower Deduction Certificate", "Accounts Manager", 0, "create", 1) diff --git a/erpnext/patches/v12_0/add_state_code_for_ladakh.py b/erpnext/patches/v12_0/add_state_code_for_ladakh.py index 6722b7bcef0..4b06eb1921e 100644 --- a/erpnext/patches/v12_0/add_state_code_for_ladakh.py +++ b/erpnext/patches/v12_0/add_state_code_for_ladakh.py @@ -5,15 +5,15 @@ from erpnext.regional.india import states def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - custom_fields = ['Address-gst_state', 'Tax Category-gst_state'] + custom_fields = ["Address-gst_state", "Tax Category-gst_state"] # Update options in gst_state custom fields for field in custom_fields: - if frappe.db.exists('Custom Field', field): - gst_state_field = frappe.get_doc('Custom Field', field) - gst_state_field.options = '\n'.join(states) + if frappe.db.exists("Custom Field", field): + gst_state_field = frappe.get_doc("Custom Field", field) + gst_state_field.options = "\n".join(states) gst_state_field.save() diff --git a/erpnext/patches/v12_0/add_taxjar_integration_field.py b/erpnext/patches/v12_0/add_taxjar_integration_field.py index fbaf6f83a7b..9217384b813 100644 --- a/erpnext/patches/v12_0/add_taxjar_integration_field.py +++ b/erpnext/patches/v12_0/add_taxjar_integration_field.py @@ -1,11 +1,10 @@ - import frappe from erpnext.regional.united_states.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters={'country': 'United States'}) + company = frappe.get_all("Company", filters={"country": "United States"}) if not company: return diff --git a/erpnext/patches/v12_0/add_variant_of_in_item_attribute_table.py b/erpnext/patches/v12_0/add_variant_of_in_item_attribute_table.py index c3a422c49e5..7f044c8d479 100644 --- a/erpnext/patches/v12_0/add_variant_of_in_item_attribute_table.py +++ b/erpnext/patches/v12_0/add_variant_of_in_item_attribute_table.py @@ -2,9 +2,11 @@ import frappe def execute(): - frappe.reload_doc('stock', 'doctype', 'item_variant_attribute') - frappe.db.sql(''' + frappe.reload_doc("stock", "doctype", "item_variant_attribute") + frappe.db.sql( + """ UPDATE `tabItem Variant Attribute` t1 INNER JOIN `tabItem` t2 ON t2.name = t1.parent SET t1.variant_of = t2.variant_of - ''') + """ + ) diff --git a/erpnext/patches/v12_0/create_accounting_dimensions_in_missing_doctypes.py b/erpnext/patches/v12_0/create_accounting_dimensions_in_missing_doctypes.py index e0ed9d8c147..744ea1ccd8a 100644 --- a/erpnext/patches/v12_0/create_accounting_dimensions_in_missing_doctypes.py +++ b/erpnext/patches/v12_0/create_accounting_dimensions_in_missing_doctypes.py @@ -1,14 +1,16 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_field def execute(): - frappe.reload_doc('accounts', 'doctype', 'accounting_dimension') + frappe.reload_doc("accounts", "doctype", "accounting_dimension") - accounting_dimensions = frappe.db.sql("""select fieldname, label, document_type, disabled from - `tabAccounting Dimension`""", as_dict=1) + accounting_dimensions = frappe.db.sql( + """select fieldname, label, document_type, disabled from + `tabAccounting Dimension`""", + as_dict=1, + ) if not accounting_dimensions: return @@ -16,13 +18,19 @@ def execute(): count = 1 for d in accounting_dimensions: - if count%2 == 0: - insert_after_field = 'dimension_col_break' + if count % 2 == 0: + insert_after_field = "dimension_col_break" else: - insert_after_field = 'accounting_dimensions_section' + insert_after_field = "accounting_dimensions_section" - for doctype in ["Subscription Plan", "Subscription", "Opening Invoice Creation Tool", "Opening Invoice Creation Tool Item", - "Expense Claim Detail", "Expense Taxes and Charges"]: + for doctype in [ + "Subscription Plan", + "Subscription", + "Opening Invoice Creation Tool", + "Opening Invoice Creation Tool Item", + "Expense Claim Detail", + "Expense Taxes and Charges", + ]: field = frappe.db.get_value("Custom Field", {"dt": doctype, "fieldname": d.fieldname}) @@ -34,7 +42,7 @@ def execute(): "label": d.label, "fieldtype": "Link", "options": d.document_type, - "insert_after": insert_after_field + "insert_after": insert_after_field, } create_custom_field(doctype, df) diff --git a/erpnext/patches/v12_0/create_default_energy_point_rules.py b/erpnext/patches/v12_0/create_default_energy_point_rules.py index 35eaca7f400..da200de9b77 100644 --- a/erpnext/patches/v12_0/create_default_energy_point_rules.py +++ b/erpnext/patches/v12_0/create_default_energy_point_rules.py @@ -4,5 +4,5 @@ from erpnext.setup.install import create_default_energy_point_rules def execute(): - frappe.reload_doc('social', 'doctype', 'energy_point_rule') + frappe.reload_doc("social", "doctype", "energy_point_rule") create_default_energy_point_rules() diff --git a/erpnext/patches/v12_0/create_irs_1099_field_united_states.py b/erpnext/patches/v12_0/create_irs_1099_field_united_states.py index 0f5e07b5e53..80e9047cf06 100644 --- a/erpnext/patches/v12_0/create_irs_1099_field_united_states.py +++ b/erpnext/patches/v12_0/create_irs_1099_field_united_states.py @@ -1,4 +1,3 @@ - import frappe from erpnext.regional.united_states.setup import make_custom_fields @@ -6,12 +5,12 @@ from erpnext.regional.united_states.setup import make_custom_fields def execute(): - frappe.reload_doc('accounts', 'doctype', 'allowed_to_transact_with', force=True) - frappe.reload_doc('accounts', 'doctype', 'pricing_rule_detail', force=True) - frappe.reload_doc('crm', 'doctype', 'lost_reason_detail', force=True) - frappe.reload_doc('setup', 'doctype', 'quotation_lost_reason_detail', force=True) + frappe.reload_doc("accounts", "doctype", "allowed_to_transact_with", force=True) + frappe.reload_doc("accounts", "doctype", "pricing_rule_detail", force=True) + frappe.reload_doc("crm", "doctype", "lost_reason_detail", force=True) + frappe.reload_doc("setup", "doctype", "quotation_lost_reason_detail", force=True) - company = frappe.get_all('Company', filters = {'country': 'United States'}) + company = frappe.get_all("Company", filters={"country": "United States"}) if not company: return diff --git a/erpnext/patches/v12_0/create_itc_reversal_custom_fields.py b/erpnext/patches/v12_0/create_itc_reversal_custom_fields.py index 7a1da52128c..906baf22ccb 100644 --- a/erpnext/patches/v12_0/create_itc_reversal_custom_fields.py +++ b/erpnext/patches/v12_0/create_itc_reversal_custom_fields.py @@ -1,4 +1,3 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields from frappe.custom.doctype.property_setter.property_setter import make_property_setter @@ -7,44 +6,76 @@ from erpnext.regional.india.utils import get_gst_accounts def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}, fields=['name']) + company = frappe.get_all("Company", filters={"country": "India"}, fields=["name"]) if not company: return frappe.reload_doc("regional", "doctype", "gst_settings") frappe.reload_doc("accounts", "doctype", "gst_account") - journal_entry_types = frappe.get_meta("Journal Entry").get_options("voucher_type").split("\n") + ['Reversal Of ITC'] - make_property_setter('Journal Entry', 'voucher_type', 'options', '\n'.join(journal_entry_types), '') + journal_entry_types = frappe.get_meta("Journal Entry").get_options("voucher_type").split("\n") + [ + "Reversal Of ITC" + ] + make_property_setter( + "Journal Entry", "voucher_type", "options", "\n".join(journal_entry_types), "" + ) custom_fields = { - 'Journal Entry': [ - dict(fieldname='reversal_type', label='Reversal Type', - fieldtype='Select', insert_after='voucher_type', print_hide=1, + "Journal Entry": [ + dict( + fieldname="reversal_type", + label="Reversal Type", + fieldtype="Select", + insert_after="voucher_type", + print_hide=1, options="As per rules 42 & 43 of CGST Rules\nOthers", depends_on="eval:doc.voucher_type=='Reversal Of ITC'", - mandatory_depends_on="eval:doc.voucher_type=='Reversal Of ITC'"), - dict(fieldname='company_address', label='Company Address', - fieldtype='Link', options='Address', insert_after='reversal_type', - print_hide=1, depends_on="eval:doc.voucher_type=='Reversal Of ITC'", - mandatory_depends_on="eval:doc.voucher_type=='Reversal Of ITC'"), - dict(fieldname='company_gstin', label='Company GSTIN', - fieldtype='Data', read_only=1, insert_after='company_address', print_hide=1, - fetch_from='company_address.gstin', + mandatory_depends_on="eval:doc.voucher_type=='Reversal Of ITC'", + ), + dict( + fieldname="company_address", + label="Company Address", + fieldtype="Link", + options="Address", + insert_after="reversal_type", + print_hide=1, depends_on="eval:doc.voucher_type=='Reversal Of ITC'", - mandatory_depends_on="eval:doc.voucher_type=='Reversal Of ITC'") + mandatory_depends_on="eval:doc.voucher_type=='Reversal Of ITC'", + ), + dict( + fieldname="company_gstin", + label="Company GSTIN", + fieldtype="Data", + read_only=1, + insert_after="company_address", + print_hide=1, + fetch_from="company_address.gstin", + depends_on="eval:doc.voucher_type=='Reversal Of ITC'", + mandatory_depends_on="eval:doc.voucher_type=='Reversal Of ITC'", + ), ], - 'Purchase Invoice': [ - dict(fieldname='eligibility_for_itc', label='Eligibility For ITC', - fieldtype='Select', insert_after='reason_for_issuing_document', print_hide=1, - options='Input Service Distributor\nImport Of Service\nImport Of Capital Goods\nITC on Reverse Charge\nIneligible As Per Section 17(5)\nIneligible Others\nAll Other ITC', - default="All Other ITC") + "Purchase Invoice": [ + dict( + fieldname="eligibility_for_itc", + label="Eligibility For ITC", + fieldtype="Select", + insert_after="reason_for_issuing_document", + print_hide=1, + options="Input Service Distributor\nImport Of Service\nImport Of Capital Goods\nITC on Reverse Charge\nIneligible As Per Section 17(5)\nIneligible Others\nAll Other ITC", + default="All Other ITC", + ) + ], + "Purchase Invoice Item": [ + dict( + fieldname="taxable_value", + label="Taxable Value", + fieldtype="Currency", + insert_after="base_net_amount", + hidden=1, + options="Company:company:default_currency", + print_hide=1, + ) ], - 'Purchase Invoice Item': [ - dict(fieldname='taxable_value', label='Taxable Value', - fieldtype='Currency', insert_after='base_net_amount', hidden=1, options="Company:company:default_currency", - print_hide=1) - ] } create_custom_fields(custom_fields, update=True) @@ -54,28 +85,40 @@ def execute(): gst_accounts = get_gst_accounts(only_non_reverse_charge=1) - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabCustom Field` SET fieldtype='Currency', options='Company:company:default_currency' WHERE dt = 'Purchase Invoice' and fieldname in ('itc_integrated_tax', 'itc_state_tax', 'itc_central_tax', 'itc_cess_amount') - """) + """ + ) - frappe.db.sql("""UPDATE `tabPurchase Invoice` set itc_integrated_tax = '0' - WHERE trim(coalesce(itc_integrated_tax, '')) = '' """) + frappe.db.sql( + """UPDATE `tabPurchase Invoice` set itc_integrated_tax = '0' + WHERE trim(coalesce(itc_integrated_tax, '')) = '' """ + ) - frappe.db.sql("""UPDATE `tabPurchase Invoice` set itc_state_tax = '0' - WHERE trim(coalesce(itc_state_tax, '')) = '' """) + frappe.db.sql( + """UPDATE `tabPurchase Invoice` set itc_state_tax = '0' + WHERE trim(coalesce(itc_state_tax, '')) = '' """ + ) - frappe.db.sql("""UPDATE `tabPurchase Invoice` set itc_central_tax = '0' - WHERE trim(coalesce(itc_central_tax, '')) = '' """) + frappe.db.sql( + """UPDATE `tabPurchase Invoice` set itc_central_tax = '0' + WHERE trim(coalesce(itc_central_tax, '')) = '' """ + ) - frappe.db.sql("""UPDATE `tabPurchase Invoice` set itc_cess_amount = '0' - WHERE trim(coalesce(itc_cess_amount, '')) = '' """) + frappe.db.sql( + """UPDATE `tabPurchase Invoice` set itc_cess_amount = '0' + WHERE trim(coalesce(itc_cess_amount, '')) = '' """ + ) # Get purchase invoices - invoices = frappe.get_all('Purchase Invoice', - {'posting_date': ('>=', '2021-04-01'), 'eligibility_for_itc': ('!=', 'Ineligible')}, - ['name']) + invoices = frappe.get_all( + "Purchase Invoice", + {"posting_date": (">=", "2021-04-01"), "eligibility_for_itc": ("!=", "Ineligible")}, + ["name"], + ) amount_map = {} @@ -83,35 +126,42 @@ def execute(): invoice_list = set([d.name for d in invoices]) # Get GST applied - amounts = frappe.db.sql(""" + amounts = frappe.db.sql( + """ SELECT parent, account_head, sum(base_tax_amount_after_discount_amount) as amount FROM `tabPurchase Taxes and Charges` where parent in %s GROUP BY parent, account_head - """, (invoice_list), as_dict=1) + """, + (invoice_list), + as_dict=1, + ) for d in amounts: - amount_map.setdefault(d.parent, - { - 'itc_integrated_tax': 0, - 'itc_state_tax': 0, - 'itc_central_tax': 0, - 'itc_cess_amount': 0 - }) + amount_map.setdefault( + d.parent, + {"itc_integrated_tax": 0, "itc_state_tax": 0, "itc_central_tax": 0, "itc_cess_amount": 0}, + ) + if not gst_accounts: + continue - if d.account_head in gst_accounts.get('igst_account'): - amount_map[d.parent]['itc_integrated_tax'] += d.amount - if d.account_head in gst_accounts.get('cgst_account'): - amount_map[d.parent]['itc_central_tax'] += d.amount - if d.account_head in gst_accounts.get('sgst_account'): - amount_map[d.parent]['itc_state_tax'] += d.amount - if d.account_head in gst_accounts.get('cess_account'): - amount_map[d.parent]['itc_cess_amount'] += d.amount + if d.account_head in gst_accounts.get("igst_account"): + amount_map[d.parent]["itc_integrated_tax"] += d.amount + if d.account_head in gst_accounts.get("cgst_account"): + amount_map[d.parent]["itc_central_tax"] += d.amount + if d.account_head in gst_accounts.get("sgst_account"): + amount_map[d.parent]["itc_state_tax"] += d.amount + if d.account_head in gst_accounts.get("cess_account"): + amount_map[d.parent]["itc_cess_amount"] += d.amount for invoice, values in amount_map.items(): - frappe.db.set_value('Purchase Invoice', invoice, { - 'itc_integrated_tax': values.get('itc_integrated_tax'), - 'itc_central_tax': values.get('itc_central_tax'), - 'itc_state_tax': values['itc_state_tax'], - 'itc_cess_amount': values['itc_cess_amount'], - }) + frappe.db.set_value( + "Purchase Invoice", + invoice, + { + "itc_integrated_tax": values.get("itc_integrated_tax"), + "itc_central_tax": values.get("itc_central_tax"), + "itc_state_tax": values["itc_state_tax"], + "itc_cess_amount": values["itc_cess_amount"], + }, + ) diff --git a/erpnext/patches/v12_0/create_taxable_value_field.py b/erpnext/patches/v12_0/create_taxable_value_field.py index df0269d3a8c..ad953032e7c 100644 --- a/erpnext/patches/v12_0/create_taxable_value_field.py +++ b/erpnext/patches/v12_0/create_taxable_value_field.py @@ -1,18 +1,23 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return custom_fields = { - 'Sales Invoice Item': [ - dict(fieldname='taxable_value', label='Taxable Value', - fieldtype='Currency', insert_after='base_net_amount', hidden=1, options="Company:company:default_currency", - print_hide=1) + "Sales Invoice Item": [ + dict( + fieldname="taxable_value", + label="Taxable Value", + fieldtype="Currency", + insert_after="base_net_amount", + hidden=1, + options="Company:company:default_currency", + print_hide=1, + ) ] } diff --git a/erpnext/patches/v12_0/delete_priority_property_setter.py b/erpnext/patches/v12_0/delete_priority_property_setter.py index cacc463d4b4..fbb02430f49 100644 --- a/erpnext/patches/v12_0/delete_priority_property_setter.py +++ b/erpnext/patches/v12_0/delete_priority_property_setter.py @@ -2,9 +2,11 @@ import frappe def execute(): - frappe.db.sql(""" + frappe.db.sql( + """ DELETE FROM `tabProperty Setter` WHERE `tabProperty Setter`.doc_type='Issue' AND `tabProperty Setter`.field_name='priority' AND `tabProperty Setter`.property='options' - """) + """ + ) diff --git a/erpnext/patches/v12_0/fix_percent_complete_for_projects.py b/erpnext/patches/v12_0/fix_percent_complete_for_projects.py index 36f51bca60d..1fbcfa4e59a 100644 --- a/erpnext/patches/v12_0/fix_percent_complete_for_projects.py +++ b/erpnext/patches/v12_0/fix_percent_complete_for_projects.py @@ -4,10 +4,13 @@ from frappe.utils import flt def execute(): for project in frappe.get_all("Project", fields=["name", "percent_complete_method"]): - total = frappe.db.count('Task', dict(project=project.name)) + total = frappe.db.count("Task", dict(project=project.name)) if project.percent_complete_method == "Task Completion" and total > 0: - completed = frappe.db.sql("""select count(name) from tabTask where - project=%s and status in ('Cancelled', 'Completed')""", project.name)[0][0] + completed = frappe.db.sql( + """select count(name) from tabTask where + project=%s and status in ('Cancelled', 'Completed')""", + project.name, + )[0][0] percent_complete = flt(flt(completed) / total * 100, 2) if project.percent_complete != percent_complete: frappe.db.set_value("Project", project.name, "percent_complete", percent_complete) diff --git a/erpnext/patches/v12_0/fix_quotation_expired_status.py b/erpnext/patches/v12_0/fix_quotation_expired_status.py index e5c4b8c524f..285183bfa25 100644 --- a/erpnext/patches/v12_0/fix_quotation_expired_status.py +++ b/erpnext/patches/v12_0/fix_quotation_expired_status.py @@ -13,12 +13,13 @@ def execute(): so_item.docstatus = 1 and so.docstatus = 1 and so_item.parent = so.name and so_item.prevdoc_docname = qo.name - and qo.valid_till < so.transaction_date""" # check if SO was created after quotation expired + and qo.valid_till < so.transaction_date""" # check if SO was created after quotation expired frappe.db.sql( - """UPDATE `tabQuotation` qo SET qo.status = 'Expired' WHERE {cond} and exists({invalid_so_against_quo})""" - .format(cond=cond, invalid_so_against_quo=invalid_so_against_quo) + """UPDATE `tabQuotation` qo SET qo.status = 'Expired' WHERE {cond} and exists({invalid_so_against_quo})""".format( + cond=cond, invalid_so_against_quo=invalid_so_against_quo ) + ) valid_so_against_quo = """ SELECT @@ -27,9 +28,10 @@ def execute(): so_item.docstatus = 1 and so.docstatus = 1 and so_item.parent = so.name and so_item.prevdoc_docname = qo.name - and qo.valid_till >= so.transaction_date""" # check if SO was created before quotation expired + and qo.valid_till >= so.transaction_date""" # check if SO was created before quotation expired frappe.db.sql( - """UPDATE `tabQuotation` qo SET qo.status = 'Closed' WHERE {cond} and exists({valid_so_against_quo})""" - .format(cond=cond, valid_so_against_quo=valid_so_against_quo) + """UPDATE `tabQuotation` qo SET qo.status = 'Closed' WHERE {cond} and exists({valid_so_against_quo})""".format( + cond=cond, valid_so_against_quo=valid_so_against_quo ) + ) diff --git a/erpnext/patches/v12_0/generate_leave_ledger_entries.py b/erpnext/patches/v12_0/generate_leave_ledger_entries.py index 90e46d07e40..354c5096c0f 100644 --- a/erpnext/patches/v12_0/generate_leave_ledger_entries.py +++ b/erpnext/patches/v12_0/generate_leave_ledger_entries.py @@ -7,8 +7,8 @@ from frappe.utils import getdate, today def execute(): - """ Generates leave ledger entries for leave allocation/application/encashment - for last allocation """ + """Generates leave ledger entries for leave allocation/application/encashment + for last allocation""" frappe.reload_doc("HR", "doctype", "Leave Ledger Entry") frappe.reload_doc("HR", "doctype", "Leave Encashment") frappe.reload_doc("HR", "doctype", "Leave Type") @@ -22,55 +22,79 @@ def execute(): generate_encashment_leave_ledger_entries() generate_expiry_allocation_ledger_entries() + def update_leave_allocation_fieldname(): - ''' maps data from old field to the new field ''' - frappe.db.sql(""" + """maps data from old field to the new field""" + frappe.db.sql( + """ UPDATE `tabLeave Allocation` SET `unused_leaves` = `carry_forwarded_leaves` - """) + """ + ) + def generate_allocation_ledger_entries(): - ''' fix ledger entries for missing leave allocation transaction ''' + """fix ledger entries for missing leave allocation transaction""" allocation_list = get_allocation_records() for allocation in allocation_list: - if not frappe.db.exists("Leave Ledger Entry", {'transaction_type': 'Leave Allocation', 'transaction_name': allocation.name}): + if not frappe.db.exists( + "Leave Ledger Entry", + {"transaction_type": "Leave Allocation", "transaction_name": allocation.name}, + ): allocation_obj = frappe.get_doc("Leave Allocation", allocation) allocation_obj.create_leave_ledger_entry() + def generate_application_leave_ledger_entries(): - ''' fix ledger entries for missing leave application transaction ''' + """fix ledger entries for missing leave application transaction""" leave_applications = get_leaves_application_records() for application in leave_applications: - if not frappe.db.exists("Leave Ledger Entry", {'transaction_type': 'Leave Application', 'transaction_name': application.name}): + if not frappe.db.exists( + "Leave Ledger Entry", + {"transaction_type": "Leave Application", "transaction_name": application.name}, + ): frappe.get_doc("Leave Application", application.name).create_leave_ledger_entry() + def generate_encashment_leave_ledger_entries(): - ''' fix ledger entries for missing leave encashment transaction ''' + """fix ledger entries for missing leave encashment transaction""" leave_encashments = get_leave_encashment_records() for encashment in leave_encashments: - if not frappe.db.exists("Leave Ledger Entry", {'transaction_type': 'Leave Encashment', 'transaction_name': encashment.name}): + if not frappe.db.exists( + "Leave Ledger Entry", + {"transaction_type": "Leave Encashment", "transaction_name": encashment.name}, + ): frappe.get_doc("Leave Encashment", encashment).create_leave_ledger_entry() + def generate_expiry_allocation_ledger_entries(): - ''' fix ledger entries for missing leave allocation transaction ''' + """fix ledger entries for missing leave allocation transaction""" from erpnext.hr.doctype.leave_ledger_entry.leave_ledger_entry import expire_allocation + allocation_list = get_allocation_records() for allocation in allocation_list: - if not frappe.db.exists("Leave Ledger Entry", {'transaction_type': 'Leave Allocation', 'transaction_name': allocation.name, 'is_expired': 1}): + if not frappe.db.exists( + "Leave Ledger Entry", + {"transaction_type": "Leave Allocation", "transaction_name": allocation.name, "is_expired": 1}, + ): allocation_obj = frappe.get_doc("Leave Allocation", allocation) if allocation_obj.to_date <= getdate(today()): expire_allocation(allocation_obj) + def get_allocation_records(): - return frappe.get_all("Leave Allocation", filters={"docstatus": 1}, - fields=['name'], order_by='to_date ASC') + return frappe.get_all( + "Leave Allocation", filters={"docstatus": 1}, fields=["name"], order_by="to_date ASC" + ) + def get_leaves_application_records(): - return frappe.get_all("Leave Application", filters={"docstatus": 1}, fields=['name']) + return frappe.get_all("Leave Application", filters={"docstatus": 1}, fields=["name"]) + def get_leave_encashment_records(): - return frappe.get_all("Leave Encashment", filters={"docstatus": 1}, fields=['name']) + return frappe.get_all("Leave Encashment", filters={"docstatus": 1}, fields=["name"]) diff --git a/erpnext/patches/v12_0/make_item_manufacturer.py b/erpnext/patches/v12_0/make_item_manufacturer.py index d66f429de3c..3f233659d01 100644 --- a/erpnext/patches/v12_0/make_item_manufacturer.py +++ b/erpnext/patches/v12_0/make_item_manufacturer.py @@ -9,20 +9,29 @@ def execute(): frappe.reload_doc("stock", "doctype", "item_manufacturer") item_manufacturer = [] - for d in frappe.db.sql(""" SELECT name, manufacturer, manufacturer_part_no, creation, owner - FROM `tabItem` WHERE manufacturer is not null and manufacturer != ''""", as_dict=1): - item_manufacturer.append(( - frappe.generate_hash("", 10), - d.name, - d.manufacturer, - d.manufacturer_part_no, - d.creation, - d.owner - )) + for d in frappe.db.sql( + """ SELECT name, manufacturer, manufacturer_part_no, creation, owner + FROM `tabItem` WHERE manufacturer is not null and manufacturer != ''""", + as_dict=1, + ): + item_manufacturer.append( + ( + frappe.generate_hash("", 10), + d.name, + d.manufacturer, + d.manufacturer_part_no, + d.creation, + d.owner, + ) + ) if item_manufacturer: - frappe.db.sql(''' + frappe.db.sql( + """ INSERT INTO `tabItem Manufacturer` (`name`, `item_code`, `manufacturer`, `manufacturer_part_no`, `creation`, `owner`) - VALUES {}'''.format(', '.join(['%s'] * len(item_manufacturer))), tuple(item_manufacturer) + VALUES {}""".format( + ", ".join(["%s"] * len(item_manufacturer)) + ), + tuple(item_manufacturer), ) diff --git a/erpnext/patches/v12_0/move_bank_account_swift_number_to_bank.py b/erpnext/patches/v12_0/move_bank_account_swift_number_to_bank.py index c0b262395d8..c069c24cfa5 100644 --- a/erpnext/patches/v12_0/move_bank_account_swift_number_to_bank.py +++ b/erpnext/patches/v12_0/move_bank_account_swift_number_to_bank.py @@ -1,15 +1,23 @@ - import frappe def execute(): - frappe.reload_doc('accounts', 'doctype', 'bank', force=1) + frappe.reload_doc("accounts", "doctype", "bank", force=1) - if frappe.db.table_exists('Bank') and frappe.db.table_exists('Bank Account') and frappe.db.has_column('Bank Account', 'swift_number'): - frappe.db.sql(""" - UPDATE `tabBank` b, `tabBank Account` ba - SET b.swift_number = ba.swift_number WHERE b.name = ba.bank - """) + if ( + frappe.db.table_exists("Bank") + and frappe.db.table_exists("Bank Account") + and frappe.db.has_column("Bank Account", "swift_number") + ): + try: + frappe.db.sql( + """ + UPDATE `tabBank` b, `tabBank Account` ba + SET b.swift_number = ba.swift_number WHERE b.name = ba.bank + """ + ) + except Exception as e: + frappe.log_error(e, title="Patch Migration Failed") - frappe.reload_doc('accounts', 'doctype', 'bank_account') - frappe.reload_doc('accounts', 'doctype', 'payment_request') + frappe.reload_doc("accounts", "doctype", "bank_account") + frappe.reload_doc("accounts", "doctype", "payment_request") diff --git a/erpnext/patches/v12_0/move_credit_limit_to_customer_credit_limit.py b/erpnext/patches/v12_0/move_credit_limit_to_customer_credit_limit.py index 82dfba52c9f..17c1966624e 100644 --- a/erpnext/patches/v12_0/move_credit_limit_to_customer_credit_limit.py +++ b/erpnext/patches/v12_0/move_credit_limit_to_customer_credit_limit.py @@ -6,7 +6,7 @@ import frappe def execute(): - ''' Move credit limit and bypass credit limit to the child table of customer credit limit ''' + """Move credit limit and bypass credit limit to the child table of customer credit limit""" frappe.reload_doc("Selling", "doctype", "Customer Credit Limit") frappe.reload_doc("Selling", "doctype", "Customer") frappe.reload_doc("Setup", "doctype", "Customer Group") @@ -16,28 +16,32 @@ def execute(): move_credit_limit_to_child_table() -def move_credit_limit_to_child_table(): - ''' maps data from old field to the new field in the child table ''' - companies = frappe.get_all("Company", 'name') +def move_credit_limit_to_child_table(): + """maps data from old field to the new field in the child table""" + + companies = frappe.get_all("Company", "name") for doctype in ("Customer", "Customer Group"): fields = "" - if doctype == "Customer" \ - and frappe.db.has_column('Customer', 'bypass_credit_limit_check_at_sales_order'): + if doctype == "Customer" and frappe.db.has_column( + "Customer", "bypass_credit_limit_check_at_sales_order" + ): fields = ", bypass_credit_limit_check_at_sales_order" - credit_limit_records = frappe.db.sql(''' + credit_limit_records = frappe.db.sql( + """ SELECT name, credit_limit {0} FROM `tab{1}` where credit_limit > 0 - '''.format(fields, doctype), as_dict=1) #nosec + """.format( + fields, doctype + ), + as_dict=1, + ) # nosec for record in credit_limit_records: doc = frappe.get_doc(doctype, record.name) for company in companies: - row = frappe._dict({ - 'credit_limit': record.credit_limit, - 'company': company.name - }) + row = frappe._dict({"credit_limit": record.credit_limit, "company": company.name}) if doctype == "Customer": row.bypass_credit_limit_check = record.bypass_credit_limit_check_at_sales_order diff --git a/erpnext/patches/v12_0/move_due_advance_amount_to_pending_amount.py b/erpnext/patches/v12_0/move_due_advance_amount_to_pending_amount.py index 5de7e69620b..8b8d9637f22 100644 --- a/erpnext/patches/v12_0/move_due_advance_amount_to_pending_amount.py +++ b/erpnext/patches/v12_0/move_due_advance_amount_to_pending_amount.py @@ -6,7 +6,7 @@ import frappe def execute(): - ''' Move from due_advance_amount to pending_amount ''' + """Move from due_advance_amount to pending_amount""" - if frappe.db.has_column("Employee Advance", "due_advance_amount"): - frappe.db.sql(''' UPDATE `tabEmployee Advance` SET pending_amount=due_advance_amount ''') + if frappe.db.has_column("Employee Advance", "due_advance_amount"): + frappe.db.sql(""" UPDATE `tabEmployee Advance` SET pending_amount=due_advance_amount """) diff --git a/erpnext/patches/v12_0/move_item_tax_to_item_tax_template.py b/erpnext/patches/v12_0/move_item_tax_to_item_tax_template.py index 677a564af0d..35354dade75 100644 --- a/erpnext/patches/v12_0/move_item_tax_to_item_tax_template.py +++ b/erpnext/patches/v12_0/move_item_tax_to_item_tax_template.py @@ -13,17 +13,22 @@ def execute(): frappe.reload_doc("accounts", "doctype", "item_tax_template_detail", force=1) frappe.reload_doc("accounts", "doctype", "item_tax_template", force=1) - existing_templates = frappe.db.sql("""select template.name, details.tax_type, details.tax_rate + existing_templates = frappe.db.sql( + """select template.name, details.tax_type, details.tax_rate from `tabItem Tax Template` template, `tabItem Tax Template Detail` details where details.parent=template.name - """, as_dict=1) + """, + as_dict=1, + ) if len(existing_templates): for d in existing_templates: item_tax_templates.setdefault(d.name, {}) item_tax_templates[d.name][d.tax_type] = d.tax_rate - for d in frappe.db.sql("""select parent as item_code, tax_type, tax_rate from `tabItem Tax`""", as_dict=1): + for d in frappe.db.sql( + """select parent as item_code, tax_type, tax_rate from `tabItem Tax`""", as_dict=1 + ): old_item_taxes.setdefault(d.item_code, []) old_item_taxes[d.item_code].append(d) @@ -50,7 +55,9 @@ def execute(): item_tax_map[d.tax_type] = d.tax_rate tax_types = [] - item_tax_template_name = get_item_tax_template(item_tax_templates, item_tax_map, item_code, tax_types=tax_types) + item_tax_template_name = get_item_tax_template( + item_tax_templates, item_tax_map, item_code, tax_types=tax_types + ) # update the item tax table frappe.db.sql("delete from `tabItem Tax` where parent=%s and parenttype='Item'", item_code) @@ -62,17 +69,29 @@ def execute(): d.db_insert() doctypes = [ - 'Quotation', 'Sales Order', 'Delivery Note', 'Sales Invoice', - 'Supplier Quotation', 'Purchase Order', 'Purchase Receipt', 'Purchase Invoice' + "Quotation", + "Sales Order", + "Delivery Note", + "Sales Invoice", + "Supplier Quotation", + "Purchase Order", + "Purchase Receipt", + "Purchase Invoice", ] for dt in doctypes: - for d in frappe.db.sql("""select name, parenttype, parent, item_code, item_tax_rate from `tab{0} Item` + for d in frappe.db.sql( + """select name, parenttype, parent, item_code, item_tax_rate from `tab{0} Item` where ifnull(item_tax_rate, '') not in ('', '{{}}') - and item_tax_template is NULL""".format(dt), as_dict=1): + and item_tax_template is NULL""".format( + dt + ), + as_dict=1, + ): item_tax_map = json.loads(d.item_tax_rate) - item_tax_template_name = get_item_tax_template(item_tax_templates, - item_tax_map, d.item_code, d.parenttype, d.parent, tax_types=tax_types) + item_tax_template_name = get_item_tax_template( + item_tax_templates, item_tax_map, d.item_code, d.parenttype, d.parent, tax_types=tax_types + ) frappe.db.set_value(dt + " Item", d.name, "item_tax_template", item_tax_template_name) frappe.db.auto_commit_on_many_writes = False @@ -82,7 +101,10 @@ def execute(): settings.determine_address_tax_category_from = "Billing Address" settings.save() -def get_item_tax_template(item_tax_templates, item_tax_map, item_code, parenttype=None, parent=None, tax_types=None): + +def get_item_tax_template( + item_tax_templates, item_tax_map, item_code, parenttype=None, parent=None, tax_types=None +): # search for previously created item tax template by comparing tax maps for template, item_tax_template_map in iteritems(item_tax_templates): if item_tax_map == item_tax_template_map: @@ -91,13 +113,26 @@ def get_item_tax_template(item_tax_templates, item_tax_map, item_code, parenttyp # if no item tax template found, create one item_tax_template = frappe.new_doc("Item Tax Template") item_tax_template.title = make_autoname("Item Tax Template-.####") + item_tax_template_name = item_tax_template.title for tax_type, tax_rate in iteritems(item_tax_map): - account_details = frappe.db.get_value("Account", tax_type, ['name', 'account_type', 'company'], as_dict=1) + account_details = frappe.db.get_value( + "Account", tax_type, ["name", "account_type", "company"], as_dict=1 + ) if account_details: item_tax_template.company = account_details.company - if account_details.account_type not in ('Tax', 'Chargeable', 'Income Account', 'Expense Account', 'Expenses Included In Valuation'): - frappe.db.set_value('Account', account_details.name, 'account_type', 'Chargeable') + if not item_tax_template_name: + # set name once company is set as name is generated from company & title + # setting name is required to update `item_tax_templates` dict + item_tax_template_name = item_tax_template.set_new_name() + if account_details.account_type not in ( + "Tax", + "Chargeable", + "Income Account", + "Expense Account", + "Expenses Included In Valuation", + ): + frappe.db.set_value("Account", account_details.name, "account_type", "Chargeable") else: parts = tax_type.strip().split(" - ") account_name = " - ".join(parts[:-1]) @@ -105,18 +140,25 @@ def get_item_tax_template(item_tax_templates, item_tax_map, item_code, parenttyp tax_type = None else: company = get_company(parts[-1], parenttype, parent) - parent_account = frappe.get_value("Account", {"account_name": account_name, "company": company}, "parent_account") + parent_account = frappe.get_value( + "Account", {"account_name": account_name, "company": company}, "parent_account" + ) if not parent_account: - parent_account = frappe.db.get_value("Account", - filters={"account_type": "Tax", "root_type": "Liability", "is_group": 0, "company": company}, fieldname="parent_account") + parent_account = frappe.db.get_value( + "Account", + filters={"account_type": "Tax", "root_type": "Liability", "is_group": 0, "company": company}, + fieldname="parent_account", + ) if not parent_account: - parent_account = frappe.db.get_value("Account", - filters={"account_type": "Tax", "root_type": "Liability", "is_group": 1, "company": company}) + parent_account = frappe.db.get_value( + "Account", + filters={"account_type": "Tax", "root_type": "Liability", "is_group": 1, "company": company}, + ) filters = { "account_name": account_name, "company": company, "account_type": "Tax", - "parent_account": parent_account + "parent_account": parent_account, } tax_type = frappe.db.get_value("Account", filters) if not tax_type: @@ -126,28 +168,38 @@ def get_item_tax_template(item_tax_templates, item_tax_map, item_code, parenttyp account.insert() tax_type = account.name except frappe.DuplicateEntryError: - tax_type = frappe.db.get_value("Account", {"account_name": account_name, "company": company}, "name") + tax_type = frappe.db.get_value( + "Account", {"account_name": account_name, "company": company}, "name" + ) account_type = frappe.get_cached_value("Account", tax_type, "account_type") - if tax_type and account_type in ('Tax', 'Chargeable', 'Income Account', 'Expense Account', 'Expenses Included In Valuation'): + if tax_type and account_type in ( + "Tax", + "Chargeable", + "Income Account", + "Expense Account", + "Expenses Included In Valuation", + ): if tax_type not in tax_types: item_tax_template.append("taxes", {"tax_type": tax_type, "tax_rate": tax_rate}) tax_types.append(tax_type) - item_tax_templates.setdefault(item_tax_template.title, {}) - item_tax_templates[item_tax_template.title][tax_type] = tax_rate + item_tax_templates.setdefault(item_tax_template_name, {}) + item_tax_templates[item_tax_template_name][tax_type] = tax_rate + if item_tax_template.get("taxes"): item_tax_template.save() return item_tax_template.name + def get_company(company_abbr, parenttype=None, parent=None): if parenttype and parent: - company = frappe.get_cached_value(parenttype, parent, 'company') + company = frappe.get_cached_value(parenttype, parent, "company") else: company = frappe.db.get_value("Company", filters={"abbr": company_abbr}) if not company: - companies = frappe.get_all('Company') + companies = frappe.get_all("Company") if len(companies) == 1: company = companies[0].name diff --git a/erpnext/patches/v12_0/move_plaid_settings_to_doctype.py b/erpnext/patches/v12_0/move_plaid_settings_to_doctype.py index c396891b59e..6788cb2e264 100644 --- a/erpnext/patches/v12_0/move_plaid_settings_to_doctype.py +++ b/erpnext/patches/v12_0/move_plaid_settings_to_doctype.py @@ -12,10 +12,12 @@ def execute(): if not (frappe.conf.plaid_client_id and frappe.conf.plaid_env and frappe.conf.plaid_secret): plaid_settings.enabled = 0 else: - plaid_settings.update({ - "plaid_client_id": frappe.conf.plaid_client_id, - "plaid_env": frappe.conf.plaid_env, - "plaid_secret": frappe.conf.plaid_secret - }) + plaid_settings.update( + { + "plaid_client_id": frappe.conf.plaid_client_id, + "plaid_env": frappe.conf.plaid_env, + "plaid_secret": frappe.conf.plaid_secret, + } + ) plaid_settings.flags.ignore_mandatory = True plaid_settings.save() diff --git a/erpnext/patches/v12_0/move_target_distribution_from_parent_to_child.py b/erpnext/patches/v12_0/move_target_distribution_from_parent_to_child.py index 36fe18d8b71..71926107bd5 100644 --- a/erpnext/patches/v12_0/move_target_distribution_from_parent_to_child.py +++ b/erpnext/patches/v12_0/move_target_distribution_from_parent_to_child.py @@ -6,19 +6,23 @@ import frappe def execute(): - frappe.reload_doc("setup", "doctype", "target_detail") - frappe.reload_doc("core", "doctype", "prepared_report") + frappe.reload_doc("setup", "doctype", "target_detail") + frappe.reload_doc("core", "doctype", "prepared_report") - for d in ['Sales Person', 'Sales Partner', 'Territory']: - frappe.db.sql(""" + for d in ["Sales Person", "Sales Partner", "Territory"]: + frappe.db.sql( + """ UPDATE `tab{child_doc}`, `tab{parent_doc}` SET `tab{child_doc}`.distribution_id = `tab{parent_doc}`.distribution_id WHERE `tab{child_doc}`.parent = `tab{parent_doc}`.name and `tab{parent_doc}`.distribution_id is not null and `tab{parent_doc}`.distribution_id != '' - """.format(parent_doc = d, child_doc = "Target Detail")) + """.format( + parent_doc=d, child_doc="Target Detail" + ) + ) - frappe.delete_doc("Report", "Sales Partner-wise Transaction Summary") - frappe.delete_doc("Report", "Sales Person Target Variance Item Group-Wise") - frappe.delete_doc("Report", "Territory Target Variance Item Group-Wise") + frappe.delete_doc("Report", "Sales Partner-wise Transaction Summary") + frappe.delete_doc("Report", "Sales Person Target Variance Item Group-Wise") + frappe.delete_doc("Report", "Territory Target Variance Item Group-Wise") diff --git a/erpnext/patches/v12_0/purchase_receipt_status.py b/erpnext/patches/v12_0/purchase_receipt_status.py index 459221e7695..3b828d69cb2 100644 --- a/erpnext/patches/v12_0/purchase_receipt_status.py +++ b/erpnext/patches/v12_0/purchase_receipt_status.py @@ -7,6 +7,7 @@ import frappe logger = frappe.logger("patch", allow_site=True, file_count=50) + def execute(): affected_purchase_receipts = frappe.db.sql( """select name from `tabPurchase Receipt` @@ -16,13 +17,13 @@ def execute(): if not affected_purchase_receipts: return - logger.info("purchase_receipt_status: begin patch, PR count: {}" - .format(len(affected_purchase_receipts))) + logger.info( + "purchase_receipt_status: begin patch, PR count: {}".format(len(affected_purchase_receipts)) + ) frappe.reload_doc("stock", "doctype", "Purchase Receipt") frappe.reload_doc("stock", "doctype", "Purchase Receipt Item") - for pr in affected_purchase_receipts: pr_name = pr[0] logger.info("purchase_receipt_status: patching PR - {}".format(pr_name)) diff --git a/erpnext/patches/v12_0/recalculate_requested_qty_in_bin.py b/erpnext/patches/v12_0/recalculate_requested_qty_in_bin.py index c89e4bb9eae..661152bef34 100644 --- a/erpnext/patches/v12_0/recalculate_requested_qty_in_bin.py +++ b/erpnext/patches/v12_0/recalculate_requested_qty_in_bin.py @@ -1,15 +1,21 @@ - import frappe from erpnext.stock.stock_balance import get_indented_qty, update_bin_qty def execute(): - bin_details = frappe.db.sql(""" + bin_details = frappe.db.sql( + """ SELECT item_code, warehouse - FROM `tabBin`""",as_dict=1) + FROM `tabBin`""", + as_dict=1, + ) for entry in bin_details: - update_bin_qty(entry.get("item_code"), entry.get("warehouse"), { - "indented_qty": get_indented_qty(entry.get("item_code"), entry.get("warehouse")) - }) + if not (entry.item_code and entry.warehouse): + continue + update_bin_qty( + entry.get("item_code"), + entry.get("warehouse"), + {"indented_qty": get_indented_qty(entry.get("item_code"), entry.get("warehouse"))}, + ) diff --git a/erpnext/patches/v12_0/remove_bank_remittance_custom_fields.py b/erpnext/patches/v12_0/remove_bank_remittance_custom_fields.py index 0f4a366c657..b18f4ebe2ed 100644 --- a/erpnext/patches/v12_0/remove_bank_remittance_custom_fields.py +++ b/erpnext/patches/v12_0/remove_bank_remittance_custom_fields.py @@ -1,14 +1,18 @@ - import frappe def execute(): frappe.reload_doc("accounts", "doctype", "tax_category") frappe.reload_doc("stock", "doctype", "item_manufacturer") - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return if frappe.db.exists("Custom Field", "Company-bank_remittance_section"): - deprecated_fields = ['bank_remittance_section', 'client_code', 'remittance_column_break', 'product_code'] + deprecated_fields = [ + "bank_remittance_section", + "client_code", + "remittance_column_break", + "product_code", + ] for i in range(len(deprecated_fields)): - frappe.delete_doc("Custom Field", 'Company-'+deprecated_fields[i]) + frappe.delete_doc("Custom Field", "Company-" + deprecated_fields[i]) diff --git a/erpnext/patches/v12_0/remove_denied_leaves_from_leave_ledger.py b/erpnext/patches/v12_0/remove_denied_leaves_from_leave_ledger.py index d1d4bcc140f..4029a3f0e22 100644 --- a/erpnext/patches/v12_0/remove_denied_leaves_from_leave_ledger.py +++ b/erpnext/patches/v12_0/remove_denied_leaves_from_leave_ledger.py @@ -6,8 +6,8 @@ import frappe def execute(): - ''' Delete leave ledger entry created - via leave applications with status != Approved ''' + """Delete leave ledger entry created + via leave applications with status != Approved""" if not frappe.db.a_row_exists("Leave Ledger Entry"): return @@ -15,14 +15,21 @@ def execute(): if leave_application_list: delete_denied_leaves_from_leave_ledger_entry(leave_application_list) + def get_denied_leave_application_list(): - return frappe.db.sql_list(''' Select name from `tabLeave Application` where status <> 'Approved' ''') + return frappe.db.sql_list( + """ Select name from `tabLeave Application` where status <> 'Approved' """ + ) + def delete_denied_leaves_from_leave_ledger_entry(leave_application_list): if leave_application_list: - frappe.db.sql(''' Delete + frappe.db.sql( + """ Delete FROM `tabLeave Ledger Entry` WHERE transaction_type = 'Leave Application' - AND transaction_name in (%s) ''' % (', '.join(['%s'] * len(leave_application_list))), #nosec - tuple(leave_application_list)) + AND transaction_name in (%s) """ + % (", ".join(["%s"] * len(leave_application_list))), # nosec + tuple(leave_application_list), + ) diff --git a/erpnext/patches/v12_0/remove_duplicate_leave_ledger_entries.py b/erpnext/patches/v12_0/remove_duplicate_leave_ledger_entries.py index 6ad68ccc6e4..8247734a4a1 100644 --- a/erpnext/patches/v12_0/remove_duplicate_leave_ledger_entries.py +++ b/erpnext/patches/v12_0/remove_duplicate_leave_ledger_entries.py @@ -7,16 +7,18 @@ import frappe def execute(): """Delete duplicate leave ledger entries of type allocation created.""" - frappe.reload_doc('hr', 'doctype', 'leave_ledger_entry') + frappe.reload_doc("hr", "doctype", "leave_ledger_entry") if not frappe.db.a_row_exists("Leave Ledger Entry"): return duplicate_records_list = get_duplicate_records() delete_duplicate_ledger_entries(duplicate_records_list) + def get_duplicate_records(): """Fetch all but one duplicate records from the list of expired leave allocation.""" - return frappe.db.sql(""" + return frappe.db.sql( + """ SELECT name, employee, transaction_name, leave_type, is_carry_forward, from_date, to_date FROM `tabLeave Ledger Entry` WHERE @@ -29,13 +31,17 @@ def get_duplicate_records(): count(name) > 1 ORDER BY creation - """) + """ + ) + def delete_duplicate_ledger_entries(duplicate_records_list): """Delete duplicate leave ledger entries.""" - if not duplicate_records_list: return + if not duplicate_records_list: + return for d in duplicate_records_list: - frappe.db.sql(''' + frappe.db.sql( + """ DELETE FROM `tabLeave Ledger Entry` WHERE name != %s AND employee = %s @@ -44,4 +50,6 @@ def delete_duplicate_ledger_entries(duplicate_records_list): AND is_carry_forward = %s AND from_date = %s AND to_date = %s - ''', tuple(d)) + """, + tuple(d), + ) diff --git a/erpnext/patches/v12_0/rename_account_type_doctype.py b/erpnext/patches/v12_0/rename_account_type_doctype.py index c2c834bf98c..ab195549a42 100644 --- a/erpnext/patches/v12_0/rename_account_type_doctype.py +++ b/erpnext/patches/v12_0/rename_account_type_doctype.py @@ -1,8 +1,7 @@ - import frappe def execute(): - frappe.rename_doc('DocType', 'Account Type', 'Bank Account Type', force=True) - frappe.rename_doc('DocType', 'Account Subtype', 'Bank Account Subtype', force=True) - frappe.reload_doc('accounts', 'doctype', 'bank_account') + frappe.rename_doc("DocType", "Account Type", "Bank Account Type", force=True) + frappe.rename_doc("DocType", "Account Subtype", "Bank Account Subtype", force=True) + frappe.reload_doc("accounts", "doctype", "bank_account") diff --git a/erpnext/patches/v12_0/rename_bank_account_field_in_journal_entry_account.py b/erpnext/patches/v12_0/rename_bank_account_field_in_journal_entry_account.py index a5d986a0a16..92687530ebc 100644 --- a/erpnext/patches/v12_0/rename_bank_account_field_in_journal_entry_account.py +++ b/erpnext/patches/v12_0/rename_bank_account_field_in_journal_entry_account.py @@ -7,12 +7,13 @@ from frappe.model.utils.rename_field import rename_field def execute(): - ''' Change the fieldname from bank_account_no to bank_account ''' + """Change the fieldname from bank_account_no to bank_account""" if not frappe.get_meta("Journal Entry Account").has_field("bank_account"): frappe.reload_doc("Accounts", "doctype", "Journal Entry Account") update_journal_entry_account_fieldname() + def update_journal_entry_account_fieldname(): - ''' maps data from old field to the new field ''' - if frappe.db.has_column('Journal Entry Account', 'bank_account_no'): + """maps data from old field to the new field""" + if frappe.db.has_column("Journal Entry Account", "bank_account_no"): rename_field("Journal Entry Account", "bank_account_no", "bank_account") diff --git a/erpnext/patches/v12_0/rename_bank_reconciliation.py b/erpnext/patches/v12_0/rename_bank_reconciliation.py index 51ff0c8c949..aacd6e8161d 100644 --- a/erpnext/patches/v12_0/rename_bank_reconciliation.py +++ b/erpnext/patches/v12_0/rename_bank_reconciliation.py @@ -7,8 +7,8 @@ import frappe def execute(): if frappe.db.table_exists("Bank Reconciliation"): - frappe.rename_doc('DocType', 'Bank Reconciliation', 'Bank Clearance', force=True) - frappe.reload_doc('Accounts', 'doctype', 'Bank Clearance') + frappe.rename_doc("DocType", "Bank Reconciliation", "Bank Clearance", force=True) + frappe.reload_doc("Accounts", "doctype", "Bank Clearance") - frappe.rename_doc('DocType', 'Bank Reconciliation Detail', 'Bank Clearance Detail', force=True) - frappe.reload_doc('Accounts', 'doctype', 'Bank Clearance Detail') + frappe.rename_doc("DocType", "Bank Reconciliation Detail", "Bank Clearance Detail", force=True) + frappe.reload_doc("Accounts", "doctype", "Bank Clearance Detail") diff --git a/erpnext/patches/v12_0/rename_bank_reconciliation_fields.py b/erpnext/patches/v12_0/rename_bank_reconciliation_fields.py index 629cd5bda66..e2a3887b9ac 100644 --- a/erpnext/patches/v12_0/rename_bank_reconciliation_fields.py +++ b/erpnext/patches/v12_0/rename_bank_reconciliation_fields.py @@ -5,11 +5,24 @@ import frappe def _rename_single_field(**kwargs): - count = frappe.db.sql("SELECT COUNT(*) FROM tabSingles WHERE doctype='{doctype}' AND field='{new_name}';".format(**kwargs))[0][0] #nosec + count = frappe.db.sql( + "SELECT COUNT(*) FROM tabSingles WHERE doctype='{doctype}' AND field='{new_name}';".format( + **kwargs + ) + )[0][ + 0 + ] # nosec if count == 0: - frappe.db.sql("UPDATE tabSingles SET field='{new_name}' WHERE doctype='{doctype}' AND field='{old_name}';".format(**kwargs)) #nosec + frappe.db.sql( + "UPDATE tabSingles SET field='{new_name}' WHERE doctype='{doctype}' AND field='{old_name}';".format( + **kwargs + ) + ) # nosec + def execute(): - _rename_single_field(doctype = "Bank Clearance", old_name = "bank_account" , new_name = "account") - _rename_single_field(doctype = "Bank Clearance", old_name = "bank_account_no", new_name = "bank_account") + _rename_single_field(doctype="Bank Clearance", old_name="bank_account", new_name="account") + _rename_single_field( + doctype="Bank Clearance", old_name="bank_account_no", new_name="bank_account" + ) frappe.reload_doc("Accounts", "doctype", "Bank Clearance") diff --git a/erpnext/patches/v12_0/rename_lost_reason_detail.py b/erpnext/patches/v12_0/rename_lost_reason_detail.py index 55bf6f223fb..2f7f8428482 100644 --- a/erpnext/patches/v12_0/rename_lost_reason_detail.py +++ b/erpnext/patches/v12_0/rename_lost_reason_detail.py @@ -1,19 +1,24 @@ - import frappe def execute(): - if frappe.db.exists("DocType", "Lost Reason Detail"): - frappe.reload_doc("crm", "doctype", "opportunity_lost_reason") - frappe.reload_doc("crm", "doctype", "opportunity_lost_reason_detail") - frappe.reload_doc("setup", "doctype", "quotation_lost_reason_detail") + if frappe.db.exists("DocType", "Lost Reason Detail"): + frappe.reload_doc("crm", "doctype", "opportunity_lost_reason") + frappe.reload_doc("crm", "doctype", "opportunity_lost_reason_detail") + frappe.reload_doc("setup", "doctype", "quotation_lost_reason_detail") - frappe.db.sql("""INSERT INTO `tabOpportunity Lost Reason Detail` SELECT * FROM `tabLost Reason Detail` WHERE `parenttype` = 'Opportunity'""") + frappe.db.sql( + """INSERT INTO `tabOpportunity Lost Reason Detail` SELECT * FROM `tabLost Reason Detail` WHERE `parenttype` = 'Opportunity'""" + ) - frappe.db.sql("""INSERT INTO `tabQuotation Lost Reason Detail` SELECT * FROM `tabLost Reason Detail` WHERE `parenttype` = 'Quotation'""") + frappe.db.sql( + """INSERT INTO `tabQuotation Lost Reason Detail` SELECT * FROM `tabLost Reason Detail` WHERE `parenttype` = 'Quotation'""" + ) - frappe.db.sql("""INSERT INTO `tabQuotation Lost Reason` (`name`, `creation`, `modified`, `modified_by`, `owner`, `docstatus`, `parent`, `parentfield`, `parenttype`, `idx`, `_comments`, `_assign`, `_user_tags`, `_liked_by`, `order_lost_reason`) + frappe.db.sql( + """INSERT INTO `tabQuotation Lost Reason` (`name`, `creation`, `modified`, `modified_by`, `owner`, `docstatus`, `parent`, `parentfield`, `parenttype`, `idx`, `_comments`, `_assign`, `_user_tags`, `_liked_by`, `order_lost_reason`) SELECT o.`name`, o.`creation`, o.`modified`, o.`modified_by`, o.`owner`, o.`docstatus`, o.`parent`, o.`parentfield`, o.`parenttype`, o.`idx`, o.`_comments`, o.`_assign`, o.`_user_tags`, o.`_liked_by`, o.`lost_reason` - FROM `tabOpportunity Lost Reason` o LEFT JOIN `tabQuotation Lost Reason` q ON q.name = o.name WHERE q.name IS NULL""") + FROM `tabOpportunity Lost Reason` o LEFT JOIN `tabQuotation Lost Reason` q ON q.name = o.name WHERE q.name IS NULL""" + ) - frappe.delete_doc("DocType", "Lost Reason Detail") + frappe.delete_doc("DocType", "Lost Reason Detail") diff --git a/erpnext/patches/v12_0/rename_mws_settings_fields.py b/erpnext/patches/v12_0/rename_mws_settings_fields.py index d5bf38d204d..97c89e0dbf9 100644 --- a/erpnext/patches/v12_0/rename_mws_settings_fields.py +++ b/erpnext/patches/v12_0/rename_mws_settings_fields.py @@ -5,8 +5,12 @@ import frappe def execute(): - count = frappe.db.sql("SELECT COUNT(*) FROM `tabSingles` WHERE doctype='Amazon MWS Settings' AND field='enable_sync';")[0][0] + count = frappe.db.sql( + "SELECT COUNT(*) FROM `tabSingles` WHERE doctype='Amazon MWS Settings' AND field='enable_sync';" + )[0][0] if count == 0: - frappe.db.sql("UPDATE `tabSingles` SET field='enable_sync' WHERE doctype='Amazon MWS Settings' AND field='enable_synch';") + frappe.db.sql( + "UPDATE `tabSingles` SET field='enable_sync' WHERE doctype='Amazon MWS Settings' AND field='enable_synch';" + ) frappe.reload_doc("ERPNext Integrations", "doctype", "Amazon MWS Settings") diff --git a/erpnext/patches/v12_0/rename_pos_closing_doctype.py b/erpnext/patches/v12_0/rename_pos_closing_doctype.py index f5f0112e036..fb80f8dc615 100644 --- a/erpnext/patches/v12_0/rename_pos_closing_doctype.py +++ b/erpnext/patches/v12_0/rename_pos_closing_doctype.py @@ -7,17 +7,19 @@ import frappe def execute(): if frappe.db.table_exists("POS Closing Voucher"): if not frappe.db.exists("DocType", "POS Closing Entry"): - frappe.rename_doc('DocType', 'POS Closing Voucher', 'POS Closing Entry', force=True) + frappe.rename_doc("DocType", "POS Closing Voucher", "POS Closing Entry", force=True) - if not frappe.db.exists('DocType', 'POS Closing Entry Taxes'): - frappe.rename_doc('DocType', 'POS Closing Voucher Taxes', 'POS Closing Entry Taxes', force=True) + if not frappe.db.exists("DocType", "POS Closing Entry Taxes"): + frappe.rename_doc("DocType", "POS Closing Voucher Taxes", "POS Closing Entry Taxes", force=True) - if not frappe.db.exists('DocType', 'POS Closing Voucher Details'): - frappe.rename_doc('DocType', 'POS Closing Voucher Details', 'POS Closing Entry Detail', force=True) + if not frappe.db.exists("DocType", "POS Closing Voucher Details"): + frappe.rename_doc( + "DocType", "POS Closing Voucher Details", "POS Closing Entry Detail", force=True + ) - frappe.reload_doc('Accounts', 'doctype', 'POS Closing Entry') - frappe.reload_doc('Accounts', 'doctype', 'POS Closing Entry Taxes') - frappe.reload_doc('Accounts', 'doctype', 'POS Closing Entry Detail') + frappe.reload_doc("Accounts", "doctype", "POS Closing Entry") + frappe.reload_doc("Accounts", "doctype", "POS Closing Entry Taxes") + frappe.reload_doc("Accounts", "doctype", "POS Closing Entry Detail") if frappe.db.exists("DocType", "POS Closing Voucher"): frappe.delete_doc("DocType", "POS Closing Voucher") diff --git a/erpnext/patches/v12_0/rename_pricing_rule_child_doctypes.py b/erpnext/patches/v12_0/rename_pricing_rule_child_doctypes.py index 87630fbcaf9..8d4c01359d4 100644 --- a/erpnext/patches/v12_0/rename_pricing_rule_child_doctypes.py +++ b/erpnext/patches/v12_0/rename_pricing_rule_child_doctypes.py @@ -5,16 +5,17 @@ import frappe doctypes = { - 'Price Discount Slab': 'Promotional Scheme Price Discount', - 'Product Discount Slab': 'Promotional Scheme Product Discount', - 'Apply Rule On Item Code': 'Pricing Rule Item Code', - 'Apply Rule On Item Group': 'Pricing Rule Item Group', - 'Apply Rule On Brand': 'Pricing Rule Brand' + "Price Discount Slab": "Promotional Scheme Price Discount", + "Product Discount Slab": "Promotional Scheme Product Discount", + "Apply Rule On Item Code": "Pricing Rule Item Code", + "Apply Rule On Item Group": "Pricing Rule Item Group", + "Apply Rule On Brand": "Pricing Rule Brand", } + def execute(): - for old_doc, new_doc in doctypes.items(): - if not frappe.db.table_exists(new_doc) and frappe.db.table_exists(old_doc): - frappe.rename_doc('DocType', old_doc, new_doc) - frappe.reload_doc("accounts", "doctype", frappe.scrub(new_doc)) - frappe.delete_doc("DocType", old_doc) + for old_doc, new_doc in doctypes.items(): + if not frappe.db.table_exists(new_doc) and frappe.db.table_exists(old_doc): + frappe.rename_doc("DocType", old_doc, new_doc) + frappe.reload_doc("accounts", "doctype", frappe.scrub(new_doc)) + frappe.delete_doc("DocType", old_doc) diff --git a/erpnext/patches/v12_0/rename_tolerance_fields.py b/erpnext/patches/v12_0/rename_tolerance_fields.py index ca2427bc3dd..ef1ba655a9f 100644 --- a/erpnext/patches/v12_0/rename_tolerance_fields.py +++ b/erpnext/patches/v12_0/rename_tolerance_fields.py @@ -7,8 +7,8 @@ def execute(): frappe.reload_doc("stock", "doctype", "stock_settings") frappe.reload_doc("accounts", "doctype", "accounts_settings") - rename_field('Stock Settings', "tolerance", "over_delivery_receipt_allowance") - rename_field('Item', "tolerance", "over_delivery_receipt_allowance") + rename_field("Stock Settings", "tolerance", "over_delivery_receipt_allowance") + rename_field("Item", "tolerance", "over_delivery_receipt_allowance") qty_allowance = frappe.db.get_single_value("Stock Settings", "over_delivery_receipt_allowance") frappe.db.set_value("Accounts Settings", None, "over_delivery_receipt_allowance", qty_allowance) diff --git a/erpnext/patches/v12_0/replace_accounting_with_accounts_in_home_settings.py b/erpnext/patches/v12_0/replace_accounting_with_accounts_in_home_settings.py index ff332f771d3..21dd258eadc 100644 --- a/erpnext/patches/v12_0/replace_accounting_with_accounts_in_home_settings.py +++ b/erpnext/patches/v12_0/replace_accounting_with_accounts_in_home_settings.py @@ -2,5 +2,7 @@ import frappe def execute(): - frappe.db.sql("""UPDATE `tabUser` SET `home_settings` = REPLACE(`home_settings`, 'Accounting', 'Accounts')""") - frappe.cache().delete_key('home_settings') + frappe.db.sql( + """UPDATE `tabUser` SET `home_settings` = REPLACE(`home_settings`, 'Accounting', 'Accounts')""" + ) + frappe.cache().delete_key("home_settings") diff --git a/erpnext/patches/v12_0/repost_stock_ledger_entries_for_target_warehouse.py b/erpnext/patches/v12_0/repost_stock_ledger_entries_for_target_warehouse.py index 198963df711..a4a85871ea2 100644 --- a/erpnext/patches/v12_0/repost_stock_ledger_entries_for_target_warehouse.py +++ b/erpnext/patches/v12_0/repost_stock_ledger_entries_for_target_warehouse.py @@ -6,51 +6,79 @@ import frappe def execute(): - warehouse_perm = frappe.get_all("User Permission", - fields=["count(*) as p_count", "is_default", "user"], filters={"allow": "Warehouse"}, group_by="user") + warehouse_perm = frappe.get_all( + "User Permission", + fields=["count(*) as p_count", "is_default", "user"], + filters={"allow": "Warehouse"}, + group_by="user", + ) if not warehouse_perm: return execute_patch = False for perm_data in warehouse_perm: - if perm_data.p_count == 1 or (perm_data.p_count > 1 and frappe.get_all("User Permission", - filters = {"user": perm_data.user, "allow": "warehouse", "is_default": 1}, limit=1)): + if perm_data.p_count == 1 or ( + perm_data.p_count > 1 + and frappe.get_all( + "User Permission", + filters={"user": perm_data.user, "allow": "warehouse", "is_default": 1}, + limit=1, + ) + ): execute_patch = True break - if not execute_patch: return + if not execute_patch: + return for doctype in ["Sales Invoice", "Delivery Note"]: - if not frappe.get_meta(doctype + ' Item').get_field("target_warehouse").hidden: continue + if not frappe.get_meta(doctype + " Item").get_field("target_warehouse").hidden: + continue cond = "" if doctype == "Sales Invoice": cond = " AND parent_doc.update_stock = 1" - data = frappe.db.sql(""" SELECT parent_doc.name as name, child_doc.name as child_name + data = frappe.db.sql( + """ SELECT parent_doc.name as name, child_doc.name as child_name FROM `tab{doctype}` parent_doc, `tab{doctype} Item` child_doc WHERE parent_doc.name = child_doc.parent AND parent_doc.docstatus < 2 AND child_doc.target_warehouse is not null AND child_doc.target_warehouse != '' AND child_doc.creation > '2020-04-16' {cond} - """.format(doctype=doctype, cond=cond), as_dict=1) + """.format( + doctype=doctype, cond=cond + ), + as_dict=1, + ) if data: names = [d.child_name for d in data] - frappe.db.sql(""" UPDATE `tab{0} Item` set target_warehouse = null - WHERE name in ({1}) """.format(doctype, ','.join(["%s"] * len(names) )), tuple(names)) + frappe.db.sql( + """ UPDATE `tab{0} Item` set target_warehouse = null + WHERE name in ({1}) """.format( + doctype, ",".join(["%s"] * len(names)) + ), + tuple(names), + ) - frappe.db.sql(""" UPDATE `tabPacked Item` set target_warehouse = null + frappe.db.sql( + """ UPDATE `tabPacked Item` set target_warehouse = null WHERE parenttype = '{0}' and parent_detail_docname in ({1}) - """.format(doctype, ','.join(["%s"] * len(names) )), tuple(names)) + """.format( + doctype, ",".join(["%s"] * len(names)) + ), + tuple(names), + ) parent_names = list(set([d.name for d in data])) for d in parent_names: doc = frappe.get_doc(doctype, d) - if doc.docstatus != 1: continue + if doc.docstatus != 1: + continue doc.docstatus = 2 doc.update_stock_ledger() @@ -61,9 +89,13 @@ def execute(): doc.update_stock_ledger() doc.make_gl_entries() - if frappe.get_meta('Sales Order Item').get_field("target_warehouse").hidden: - frappe.db.sql(""" UPDATE `tabSales Order Item` set target_warehouse = null - WHERE creation > '2020-04-16' and docstatus < 2 """) + if frappe.get_meta("Sales Order Item").get_field("target_warehouse").hidden: + frappe.db.sql( + """ UPDATE `tabSales Order Item` set target_warehouse = null + WHERE creation > '2020-04-16' and docstatus < 2 """ + ) - frappe.db.sql(""" UPDATE `tabPacked Item` set target_warehouse = null - WHERE creation > '2020-04-16' and docstatus < 2 and parenttype = 'Sales Order' """) + frappe.db.sql( + """ UPDATE `tabPacked Item` set target_warehouse = null + WHERE creation > '2020-04-16' and docstatus < 2 and parenttype = 'Sales Order' """ + ) diff --git a/erpnext/patches/v12_0/set_against_blanket_order_in_sales_and_purchase_order.py b/erpnext/patches/v12_0/set_against_blanket_order_in_sales_and_purchase_order.py index b76e34abe13..d88593b4984 100644 --- a/erpnext/patches/v12_0/set_against_blanket_order_in_sales_and_purchase_order.py +++ b/erpnext/patches/v12_0/set_against_blanket_order_in_sales_and_purchase_order.py @@ -3,12 +3,16 @@ import frappe def execute(): - frappe.reload_doc('selling', 'doctype', 'sales_order_item', force=True) - frappe.reload_doc('buying', 'doctype', 'purchase_order_item', force=True) + frappe.reload_doc("selling", "doctype", "sales_order_item", force=True) + frappe.reload_doc("buying", "doctype", "purchase_order_item", force=True) - for doctype in ('Sales Order Item', 'Purchase Order Item'): - frappe.db.sql(""" + for doctype in ("Sales Order Item", "Purchase Order Item"): + frappe.db.sql( + """ UPDATE `tab{0}` SET against_blanket_order = 1 WHERE ifnull(blanket_order, '') != '' - """.format(doctype)) + """.format( + doctype + ) + ) diff --git a/erpnext/patches/v12_0/set_automatically_process_deferred_accounting_in_accounts_settings.py b/erpnext/patches/v12_0/set_automatically_process_deferred_accounting_in_accounts_settings.py index b4f8a0631a6..37af989549f 100644 --- a/erpnext/patches/v12_0/set_automatically_process_deferred_accounting_in_accounts_settings.py +++ b/erpnext/patches/v12_0/set_automatically_process_deferred_accounting_in_accounts_settings.py @@ -1,8 +1,9 @@ - import frappe def execute(): frappe.reload_doc("accounts", "doctype", "accounts_settings") - frappe.db.set_value("Accounts Settings", None, "automatically_process_deferred_accounting_entry", 1) + frappe.db.set_value( + "Accounts Settings", None, "automatically_process_deferred_accounting_entry", 1 + ) diff --git a/erpnext/patches/v12_0/set_cost_center_in_child_table_of_expense_claim.py b/erpnext/patches/v12_0/set_cost_center_in_child_table_of_expense_claim.py index d3045a1a576..a5b4c66ce87 100644 --- a/erpnext/patches/v12_0/set_cost_center_in_child_table_of_expense_claim.py +++ b/erpnext/patches/v12_0/set_cost_center_in_child_table_of_expense_claim.py @@ -2,9 +2,11 @@ import frappe def execute(): - frappe.reload_doc('hr', 'doctype', 'expense_claim_detail') - frappe.db.sql(""" + frappe.reload_doc("hr", "doctype", "expense_claim_detail") + frappe.db.sql( + """ UPDATE `tabExpense Claim Detail` child, `tabExpense Claim` par SET child.cost_center = par.cost_center WHERE child.parent = par.name - """) + """ + ) diff --git a/erpnext/patches/v12_0/set_cwip_and_delete_asset_settings.py b/erpnext/patches/v12_0/set_cwip_and_delete_asset_settings.py index fe580ce0236..952f64be2e7 100644 --- a/erpnext/patches/v12_0/set_cwip_and_delete_asset_settings.py +++ b/erpnext/patches/v12_0/set_cwip_and_delete_asset_settings.py @@ -1,11 +1,10 @@ - import frappe from frappe.utils import cint def execute(): - '''Get 'Disable CWIP Accounting value' from Asset Settings, set it in 'Enable Capital Work in Progress Accounting' field - in Company, delete Asset Settings ''' + """Get 'Disable CWIP Accounting value' from Asset Settings, set it in 'Enable Capital Work in Progress Accounting' field + in Company, delete Asset Settings""" if frappe.db.exists("DocType", "Asset Settings"): frappe.reload_doctype("Asset Category") diff --git a/erpnext/patches/v12_0/set_default_batch_size.py b/erpnext/patches/v12_0/set_default_batch_size.py index 6fb69456dd1..ac3e2f47ee5 100644 --- a/erpnext/patches/v12_0/set_default_batch_size.py +++ b/erpnext/patches/v12_0/set_default_batch_size.py @@ -2,18 +2,22 @@ import frappe def execute(): - frappe.reload_doc("manufacturing", "doctype", "bom_operation") - frappe.reload_doc("manufacturing", "doctype", "work_order_operation") + frappe.reload_doc("manufacturing", "doctype", "bom_operation") + frappe.reload_doc("manufacturing", "doctype", "work_order_operation") - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabBOM Operation` bo SET bo.batch_size = 1 - """) - frappe.db.sql(""" + """ + ) + frappe.db.sql( + """ UPDATE `tabWork Order Operation` wop SET wop.batch_size = 1 - """) + """ + ) diff --git a/erpnext/patches/v12_0/set_default_homepage_type.py b/erpnext/patches/v12_0/set_default_homepage_type.py index 1e4333aa466..d70b28efd85 100644 --- a/erpnext/patches/v12_0/set_default_homepage_type.py +++ b/erpnext/patches/v12_0/set_default_homepage_type.py @@ -2,4 +2,4 @@ import frappe def execute(): - frappe.db.set_value('Homepage', 'Homepage', 'hero_section_based_on', 'Default') + frappe.db.set_value("Homepage", "Homepage", "hero_section_based_on", "Default") diff --git a/erpnext/patches/v12_0/set_default_payroll_based_on.py b/erpnext/patches/v12_0/set_default_payroll_based_on.py index b70bb18b60b..de641c65a1c 100644 --- a/erpnext/patches/v12_0/set_default_payroll_based_on.py +++ b/erpnext/patches/v12_0/set_default_payroll_based_on.py @@ -1,4 +1,3 @@ - import frappe diff --git a/erpnext/patches/v12_0/set_default_shopify_app_type.py b/erpnext/patches/v12_0/set_default_shopify_app_type.py index c712287c0dc..41516ba850c 100644 --- a/erpnext/patches/v12_0/set_default_shopify_app_type.py +++ b/erpnext/patches/v12_0/set_default_shopify_app_type.py @@ -1,7 +1,6 @@ - import frappe def execute(): - frappe.reload_doc('erpnext_integrations', 'doctype', 'shopify_settings') - frappe.db.set_value('Shopify Settings', None, 'app_type', 'Private') + frappe.reload_doc("erpnext_integrations", "doctype", "shopify_settings") + frappe.db.set_value("Shopify Settings", None, "app_type", "Private") diff --git a/erpnext/patches/v12_0/set_employee_preferred_emails.py b/erpnext/patches/v12_0/set_employee_preferred_emails.py index f6eb12e2b9f..a6159c6b6b0 100644 --- a/erpnext/patches/v12_0/set_employee_preferred_emails.py +++ b/erpnext/patches/v12_0/set_employee_preferred_emails.py @@ -2,9 +2,11 @@ import frappe def execute(): - employees = frappe.get_all("Employee", + employees = frappe.get_all( + "Employee", filters={"prefered_email": ""}, - fields=["name", "prefered_contact_email", "company_email", "personal_email", "user_id"]) + fields=["name", "prefered_contact_email", "company_email", "personal_email", "user_id"], + ) for employee in employees: if not employee.prefered_contact_email: @@ -13,4 +15,6 @@ def execute(): preferred_email_field = frappe.scrub(employee.prefered_contact_email) preferred_email = employee.get(preferred_email_field) - frappe.db.set_value("Employee", employee.name, "prefered_email", preferred_email, update_modified=False) + frappe.db.set_value( + "Employee", employee.name, "prefered_email", preferred_email, update_modified=False + ) diff --git a/erpnext/patches/v12_0/set_expense_account_in_landed_cost_voucher_taxes.py b/erpnext/patches/v12_0/set_expense_account_in_landed_cost_voucher_taxes.py index 47d4eb599b8..96f80a057b4 100644 --- a/erpnext/patches/v12_0/set_expense_account_in_landed_cost_voucher_taxes.py +++ b/erpnext/patches/v12_0/set_expense_account_in_landed_cost_voucher_taxes.py @@ -1,17 +1,21 @@ - import frappe from six import iteritems def execute(): - frappe.reload_doctype('Landed Cost Taxes and Charges') + frappe.reload_doctype("Landed Cost Taxes and Charges") - company_account_map = frappe._dict(frappe.db.sql(""" + company_account_map = frappe._dict( + frappe.db.sql( + """ SELECT name, expenses_included_in_valuation from `tabCompany` - """)) + """ + ) + ) for company, account in iteritems(company_account_map): - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabLanded Cost Taxes and Charges` t, `tabLanded Cost Voucher` l SET @@ -20,9 +24,12 @@ def execute(): l.docstatus = 1 AND l.company = %s AND t.parent = l.name - """, (account, company)) + """, + (account, company), + ) - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabLanded Cost Taxes and Charges` t, `tabStock Entry` s SET @@ -31,4 +38,6 @@ def execute(): s.docstatus = 1 AND s.company = %s AND t.parent = s.name - """, (account, company)) + """, + (account, company), + ) diff --git a/erpnext/patches/v12_0/set_gst_category.py b/erpnext/patches/v12_0/set_gst_category.py index 094e2a3134b..126a73bd3d0 100644 --- a/erpnext/patches/v12_0/set_gst_category.py +++ b/erpnext/patches/v12_0/set_gst_category.py @@ -5,48 +5,62 @@ from erpnext.regional.india.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - frappe.reload_doc('accounts', 'doctype', 'Tax Category') + frappe.reload_doc("accounts", "doctype", "Tax Category") make_custom_fields() - for doctype in ['Sales Invoice', 'Purchase Invoice']: - has_column = frappe.db.has_column(doctype,'invoice_type') + for doctype in ["Sales Invoice", "Purchase Invoice"]: + has_column = frappe.db.has_column(doctype, "invoice_type") if has_column: update_map = { - 'Regular': 'Registered Regular', - 'Export': 'Overseas', - 'SEZ': 'SEZ', - 'Deemed Export': 'Deemed Export', + "Regular": "Registered Regular", + "Export": "Overseas", + "SEZ": "SEZ", + "Deemed Export": "Deemed Export", } for old, new in update_map.items(): - frappe.db.sql("UPDATE `tab{doctype}` SET gst_category = %s where invoice_type = %s".format(doctype=doctype), (new, old)) #nosec + frappe.db.sql( + "UPDATE `tab{doctype}` SET gst_category = %s where invoice_type = %s".format(doctype=doctype), + (new, old), + ) # nosec - frappe.delete_doc('Custom Field', 'Sales Invoice-invoice_type') - frappe.delete_doc('Custom Field', 'Purchase Invoice-invoice_type') + frappe.delete_doc("Custom Field", "Sales Invoice-invoice_type") + frappe.delete_doc("Custom Field", "Purchase Invoice-invoice_type") itc_update_map = { "ineligible": "Ineligible", "input service": "Input Service Distributor", "capital goods": "Import Of Capital Goods", - "input": "All Other ITC" + "input": "All Other ITC", } - has_gst_fields = frappe.db.has_column('Purchase Invoice','eligibility_for_itc') + has_gst_fields = frappe.db.has_column("Purchase Invoice", "eligibility_for_itc") if has_gst_fields: for old, new in itc_update_map.items(): - frappe.db.sql("UPDATE `tabPurchase Invoice` SET eligibility_for_itc = %s where eligibility_for_itc = %s ", (new, old)) + frappe.db.sql( + "UPDATE `tabPurchase Invoice` SET eligibility_for_itc = %s where eligibility_for_itc = %s ", + (new, old), + ) for doctype in ["Customer", "Supplier"]: - frappe.db.sql(""" UPDATE `tab{doctype}` t1, `tabAddress` t2, `tabDynamic Link` t3 SET t1.gst_category = "Registered Regular" - where t3.link_name = t1.name and t3.parent = t2.name and t2.gstin IS NOT NULL and t2.gstin != '' """.format(doctype=doctype)) #nosec + frappe.db.sql( + """ UPDATE `tab{doctype}` t1, `tabAddress` t2, `tabDynamic Link` t3 SET t1.gst_category = "Registered Regular" + where t3.link_name = t1.name and t3.parent = t2.name and t2.gstin IS NOT NULL and t2.gstin != '' """.format( + doctype=doctype + ) + ) # nosec - frappe.db.sql(""" UPDATE `tab{doctype}` t1, `tabAddress` t2, `tabDynamic Link` t3 SET t1.gst_category = "Overseas" - where t3.link_name = t1.name and t3.parent = t2.name and t2.country != 'India' """.format(doctype=doctype)) #nosec + frappe.db.sql( + """ UPDATE `tab{doctype}` t1, `tabAddress` t2, `tabDynamic Link` t3 SET t1.gst_category = "Overseas" + where t3.link_name = t1.name and t3.parent = t2.name and t2.country != 'India' """.format( + doctype=doctype + ) + ) # nosec diff --git a/erpnext/patches/v12_0/set_job_offer_applicant_email.py b/erpnext/patches/v12_0/set_job_offer_applicant_email.py index 7dd8492081e..0e3b5c4d2aa 100644 --- a/erpnext/patches/v12_0/set_job_offer_applicant_email.py +++ b/erpnext/patches/v12_0/set_job_offer_applicant_email.py @@ -4,9 +4,11 @@ import frappe def execute(): frappe.reload_doc("hr", "doctype", "job_offer") - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabJob Offer` AS offer SET applicant_email = (SELECT email_id FROM `tabJob Applicant` WHERE name = offer.job_applicant) - """) + """ + ) diff --git a/erpnext/patches/v12_0/set_lead_title_field.py b/erpnext/patches/v12_0/set_lead_title_field.py index 86e00038f6c..eda3007e29b 100644 --- a/erpnext/patches/v12_0/set_lead_title_field.py +++ b/erpnext/patches/v12_0/set_lead_title_field.py @@ -3,9 +3,11 @@ import frappe def execute(): frappe.reload_doc("crm", "doctype", "lead") - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabLead` SET title = IF(organization_lead = 1, company_name, lead_name) - """) + """ + ) diff --git a/erpnext/patches/v12_0/set_multi_uom_in_rfq.py b/erpnext/patches/v12_0/set_multi_uom_in_rfq.py index a8e0ec1f816..4d19007313d 100644 --- a/erpnext/patches/v12_0/set_multi_uom_in_rfq.py +++ b/erpnext/patches/v12_0/set_multi_uom_in_rfq.py @@ -6,10 +6,12 @@ import frappe def execute(): - frappe.reload_doc('buying', 'doctype', 'request_for_quotation_item') + frappe.reload_doc("buying", "doctype", "request_for_quotation_item") - frappe.db.sql("""UPDATE `tabRequest for Quotation Item` + frappe.db.sql( + """UPDATE `tabRequest for Quotation Item` SET stock_uom = uom, conversion_factor = 1, - stock_qty = qty""") + stock_qty = qty""" + ) diff --git a/erpnext/patches/v12_0/set_payment_entry_status.py b/erpnext/patches/v12_0/set_payment_entry_status.py index f8792952d8b..2a3a3ad45e4 100644 --- a/erpnext/patches/v12_0/set_payment_entry_status.py +++ b/erpnext/patches/v12_0/set_payment_entry_status.py @@ -3,8 +3,10 @@ import frappe def execute(): frappe.reload_doctype("Payment Entry") - frappe.db.sql("""update `tabPayment Entry` set status = CASE + frappe.db.sql( + """update `tabPayment Entry` set status = CASE WHEN docstatus = 1 THEN 'Submitted' WHEN docstatus = 2 THEN 'Cancelled' ELSE 'Draft' - END;""") + END;""" + ) diff --git a/erpnext/patches/v12_0/set_permission_einvoicing.py b/erpnext/patches/v12_0/set_permission_einvoicing.py index 01cab14db9d..65d70977d20 100644 --- a/erpnext/patches/v12_0/set_permission_einvoicing.py +++ b/erpnext/patches/v12_0/set_permission_einvoicing.py @@ -5,7 +5,7 @@ from erpnext.regional.italy.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'Italy'}) + company = frappe.get_all("Company", filters={"country": "Italy"}) if not company: return @@ -14,6 +14,6 @@ def execute(): frappe.reload_doc("regional", "doctype", "import_supplier_invoice") - add_permission('Import Supplier Invoice', 'Accounts Manager', 0) - update_permission_property('Import Supplier Invoice', 'Accounts Manager', 0, 'write', 1) - update_permission_property('Import Supplier Invoice', 'Accounts Manager', 0, 'create', 1) + add_permission("Import Supplier Invoice", "Accounts Manager", 0) + update_permission_property("Import Supplier Invoice", "Accounts Manager", 0, "write", 1) + update_permission_property("Import Supplier Invoice", "Accounts Manager", 0, "create", 1) diff --git a/erpnext/patches/v12_0/set_priority_for_support.py b/erpnext/patches/v12_0/set_priority_for_support.py index 6d7d0993460..a8a07e76eab 100644 --- a/erpnext/patches/v12_0/set_priority_for_support.py +++ b/erpnext/patches/v12_0/set_priority_for_support.py @@ -4,21 +4,20 @@ import frappe def execute(): frappe.reload_doc("support", "doctype", "issue_priority") frappe.reload_doc("support", "doctype", "service_level_priority") - frappe.reload_doc('support', 'doctype', 'issue') + frappe.reload_doc("support", "doctype", "issue") set_issue_priority() set_priority_for_issue() set_priorities_service_level() set_priorities_service_level_agreement() + def set_issue_priority(): # Adds priority from issue to Issue Priority DocType as Priority is a new DocType. for priority in frappe.get_meta("Issue").get_field("priority").options.split("\n"): if priority and not frappe.db.exists("Issue Priority", priority): - frappe.get_doc({ - "doctype": "Issue Priority", - "name": priority - }).insert(ignore_permissions=True) + frappe.get_doc({"doctype": "Issue Priority", "name": priority}).insert(ignore_permissions=True) + def set_priority_for_issue(): # Sets priority for Issues as Select field is changed to Link field. @@ -28,38 +27,63 @@ def set_priority_for_issue(): for issue in issue_priority: frappe.db.set_value("Issue", issue.name, "priority", issue.priority) + def set_priorities_service_level(): # Migrates "priority", "response_time", "response_time_period", "resolution_time", "resolution_time_period" to Child Table # as a Service Level can have multiple priorities try: - service_level_priorities = frappe.get_list("Service Level", fields=["name", "priority", "response_time", "response_time_period", "resolution_time", "resolution_time_period"]) + service_level_priorities = frappe.get_list( + "Service Level", + fields=[ + "name", + "priority", + "response_time", + "response_time_period", + "resolution_time", + "resolution_time_period", + ], + ) frappe.reload_doc("support", "doctype", "service_level") frappe.reload_doc("support", "doctype", "support_settings") - frappe.db.set_value('Support Settings', None, 'track_service_level_agreement', 1) + frappe.db.set_value("Support Settings", None, "track_service_level_agreement", 1) for service_level in service_level_priorities: if service_level: doc = frappe.get_doc("Service Level", service_level.name) if not doc.priorities: - doc.append("priorities", { - "priority": service_level.priority, - "default_priority": 1, - "response_time": service_level.response_time, - "response_time_period": service_level.response_time_period, - "resolution_time": service_level.resolution_time, - "resolution_time_period": service_level.resolution_time_period - }) + doc.append( + "priorities", + { + "priority": service_level.priority, + "default_priority": 1, + "response_time": service_level.response_time, + "response_time_period": service_level.response_time_period, + "resolution_time": service_level.resolution_time, + "resolution_time_period": service_level.resolution_time_period, + }, + ) doc.flags.ignore_validate = True doc.save(ignore_permissions=True) except frappe.db.TableMissingError: frappe.reload_doc("support", "doctype", "service_level") + def set_priorities_service_level_agreement(): # Migrates "priority", "response_time", "response_time_period", "resolution_time", "resolution_time_period" to Child Table # as a Service Level Agreement can have multiple priorities try: - service_level_agreement_priorities = frappe.get_list("Service Level Agreement", fields=["name", "priority", "response_time", "response_time_period", "resolution_time", "resolution_time_period"]) + service_level_agreement_priorities = frappe.get_list( + "Service Level Agreement", + fields=[ + "name", + "priority", + "response_time", + "response_time_period", + "resolution_time", + "resolution_time_period", + ], + ) frappe.reload_doc("support", "doctype", "service_level_agreement") @@ -71,14 +95,17 @@ def set_priorities_service_level_agreement(): doc.entity_type = "Customer" doc.entity = doc.customer - doc.append("priorities", { - "priority": service_level_agreement.priority, - "default_priority": 1, - "response_time": service_level_agreement.response_time, - "response_time_period": service_level_agreement.response_time_period, - "resolution_time": service_level_agreement.resolution_time, - "resolution_time_period": service_level_agreement.resolution_time_period - }) + doc.append( + "priorities", + { + "priority": service_level_agreement.priority, + "default_priority": 1, + "response_time": service_level_agreement.response_time, + "response_time_period": service_level_agreement.response_time_period, + "resolution_time": service_level_agreement.resolution_time, + "resolution_time_period": service_level_agreement.resolution_time_period, + }, + ) doc.flags.ignore_validate = True doc.save(ignore_permissions=True) except frappe.db.TableMissingError: diff --git a/erpnext/patches/v12_0/set_produced_qty_field_in_sales_order_for_work_order.py b/erpnext/patches/v12_0/set_produced_qty_field_in_sales_order_for_work_order.py index 9c851ddcee1..562ebed757b 100644 --- a/erpnext/patches/v12_0/set_produced_qty_field_in_sales_order_for_work_order.py +++ b/erpnext/patches/v12_0/set_produced_qty_field_in_sales_order_for_work_order.py @@ -4,12 +4,14 @@ from erpnext.selling.doctype.sales_order.sales_order import update_produced_qty_ def execute(): - frappe.reload_doctype('Sales Order Item') - frappe.reload_doctype('Sales Order') + frappe.reload_doctype("Sales Order Item") + frappe.reload_doctype("Sales Order") - for d in frappe.get_all('Work Order', - fields = ['sales_order', 'sales_order_item'], - filters={'sales_order': ('!=', ''), 'sales_order_item': ('!=', '')}): + for d in frappe.get_all( + "Work Order", + fields=["sales_order", "sales_order_item"], + filters={"sales_order": ("!=", ""), "sales_order_item": ("!=", "")}, + ): # update produced qty in sales order update_produced_qty_in_so_item(d.sales_order, d.sales_order_item) diff --git a/erpnext/patches/v12_0/set_production_capacity_in_workstation.py b/erpnext/patches/v12_0/set_production_capacity_in_workstation.py index 14956a23b43..0246c35447b 100644 --- a/erpnext/patches/v12_0/set_production_capacity_in_workstation.py +++ b/erpnext/patches/v12_0/set_production_capacity_in_workstation.py @@ -1,9 +1,10 @@ - import frappe def execute(): - frappe.reload_doc("manufacturing", "doctype", "workstation") + frappe.reload_doc("manufacturing", "doctype", "workstation") - frappe.db.sql(""" UPDATE `tabWorkstation` - SET production_capacity = 1 """) + frappe.db.sql( + """ UPDATE `tabWorkstation` + SET production_capacity = 1 """ + ) diff --git a/erpnext/patches/v12_0/set_published_in_hub_tracked_item.py b/erpnext/patches/v12_0/set_published_in_hub_tracked_item.py index a0fe8aa2fe8..d90464ea8e5 100644 --- a/erpnext/patches/v12_0/set_published_in_hub_tracked_item.py +++ b/erpnext/patches/v12_0/set_published_in_hub_tracked_item.py @@ -1,4 +1,3 @@ - import frappe @@ -7,7 +6,9 @@ def execute(): if not frappe.db.a_row_exists("Hub Tracked Item"): return - frappe.db.sql(''' + frappe.db.sql( + """ Update `tabHub Tracked Item` SET published = 1 - ''') + """ + ) diff --git a/erpnext/patches/v12_0/set_purchase_receipt_delivery_note_detail.py b/erpnext/patches/v12_0/set_purchase_receipt_delivery_note_detail.py index 05b86f3204a..2edf0f54fcf 100644 --- a/erpnext/patches/v12_0/set_purchase_receipt_delivery_note_detail.py +++ b/erpnext/patches/v12_0/set_purchase_receipt_delivery_note_detail.py @@ -1,4 +1,3 @@ - from collections import defaultdict import frappe @@ -6,29 +5,36 @@ import frappe def execute(): - frappe.reload_doc('stock', 'doctype', 'delivery_note_item', force=True) - frappe.reload_doc('stock', 'doctype', 'purchase_receipt_item', force=True) + frappe.reload_doc("stock", "doctype", "delivery_note_item", force=True) + frappe.reload_doc("stock", "doctype", "purchase_receipt_item", force=True) def map_rows(doc_row, return_doc_row, detail_field, doctype): """Map rows after identifying similar ones.""" - frappe.db.sql(""" UPDATE `tab{doctype} Item` set {detail_field} = '{doc_row_name}' - where name = '{return_doc_row_name}'""" \ - .format(doctype=doctype, - detail_field=detail_field, - doc_row_name=doc_row.get('name'), - return_doc_row_name=return_doc_row.get('name'))) #nosec + frappe.db.sql( + """ UPDATE `tab{doctype} Item` set {detail_field} = '{doc_row_name}' + where name = '{return_doc_row_name}'""".format( + doctype=doctype, + detail_field=detail_field, + doc_row_name=doc_row.get("name"), + return_doc_row_name=return_doc_row.get("name"), + ) + ) # nosec def row_is_mappable(doc_row, return_doc_row, detail_field): """Checks if two rows are similar enough to be mapped.""" if doc_row.item_code == return_doc_row.item_code and not return_doc_row.get(detail_field): - if doc_row.get('batch_no') and return_doc_row.get('batch_no') and doc_row.batch_no == return_doc_row.batch_no: + if ( + doc_row.get("batch_no") + and return_doc_row.get("batch_no") + and doc_row.batch_no == return_doc_row.batch_no + ): return True - elif doc_row.get('serial_no') and return_doc_row.get('serial_no'): - doc_sn = doc_row.serial_no.split('\n') - return_doc_sn = return_doc_row.serial_no.split('\n') + elif doc_row.get("serial_no") and return_doc_row.get("serial_no"): + doc_sn = doc_row.serial_no.split("\n") + return_doc_sn = return_doc_row.serial_no.split("\n") if set(doc_sn) & set(return_doc_sn): # if two rows have serial nos in common, map them @@ -43,12 +49,17 @@ def execute(): """Returns a map of documents and it's return documents. Format => { 'document' : ['return_document_1','return_document_2'] }""" - return_against_documents = frappe.db.sql(""" + return_against_documents = frappe.db.sql( + """ SELECT return_against as document, name as return_document FROM `tab{doctype}` WHERE - is_return = 1 and docstatus = 1""".format(doctype=doctype),as_dict=1) #nosec + is_return = 1 and docstatus = 1""".format( + doctype=doctype + ), + as_dict=1, + ) # nosec for entry in return_against_documents: return_document_map[entry.document].append(entry.return_document) @@ -59,7 +70,7 @@ def execute(): """Map each row of the original document in the return document.""" mapped = [] return_document_map = defaultdict(list) - detail_field = "purchase_receipt_item" if doctype=="Purchase Receipt" else "dn_detail" + detail_field = "purchase_receipt_item" if doctype == "Purchase Receipt" else "dn_detail" child_doc = frappe.scrub("{0} Item".format(doctype)) frappe.reload_doc("stock", "doctype", child_doc) @@ -68,25 +79,27 @@ def execute(): count = 0 - #iterate through original documents and its return documents + # iterate through original documents and its return documents for docname in return_document_map: doc_items = frappe.get_cached_doc(doctype, docname).get("items") for return_doc in return_document_map[docname]: return_doc_items = frappe.get_cached_doc(doctype, return_doc).get("items") - #iterate through return document items and original document items for mapping + # iterate through return document items and original document items for mapping for return_item in return_doc_items: for doc_item in doc_items: - if row_is_mappable(doc_item, return_item, detail_field) and doc_item.get('name') not in mapped: + if ( + row_is_mappable(doc_item, return_item, detail_field) and doc_item.get("name") not in mapped + ): map_rows(doc_item, return_item, detail_field, doctype) - mapped.append(doc_item.get('name')) + mapped.append(doc_item.get("name")) break else: continue # commit after every 100 sql updates count += 1 - if count%100 == 0: + if count % 100 == 0: frappe.db.commit() set_document_detail_in_return_document("Purchase Receipt") diff --git a/erpnext/patches/v12_0/set_quotation_status.py b/erpnext/patches/v12_0/set_quotation_status.py index adfc5e96798..bebedd3a498 100644 --- a/erpnext/patches/v12_0/set_quotation_status.py +++ b/erpnext/patches/v12_0/set_quotation_status.py @@ -1,8 +1,9 @@ - import frappe def execute(): - frappe.db.sql(""" UPDATE `tabQuotation` set status = 'Open' - where docstatus = 1 and status = 'Submitted' """) + frappe.db.sql( + """ UPDATE `tabQuotation` set status = 'Open' + where docstatus = 1 and status = 'Submitted' """ + ) diff --git a/erpnext/patches/v12_0/set_received_qty_in_material_request_as_per_stock_uom.py b/erpnext/patches/v12_0/set_received_qty_in_material_request_as_per_stock_uom.py index 83db7961d9d..dcdd19fbb65 100644 --- a/erpnext/patches/v12_0/set_received_qty_in_material_request_as_per_stock_uom.py +++ b/erpnext/patches/v12_0/set_received_qty_in_material_request_as_per_stock_uom.py @@ -1,15 +1,17 @@ - import frappe def execute(): - purchase_receipts = frappe.db.sql(""" + purchase_receipts = frappe.db.sql( + """ SELECT parent from `tabPurchase Receipt Item` WHERE material_request is not null AND docstatus=1 - """,as_dict=1) + """, + as_dict=1, + ) purchase_receipts = set([d.parent for d in purchase_receipts]) @@ -17,15 +19,15 @@ def execute(): doc = frappe.get_doc("Purchase Receipt", pr) doc.status_updater = [ { - 'source_dt': 'Purchase Receipt Item', - 'target_dt': 'Material Request Item', - 'join_field': 'material_request_item', - 'target_field': 'received_qty', - 'target_parent_dt': 'Material Request', - 'target_parent_field': 'per_received', - 'target_ref_field': 'stock_qty', - 'source_field': 'stock_qty', - 'percent_join_field': 'material_request' + "source_dt": "Purchase Receipt Item", + "target_dt": "Material Request Item", + "join_field": "material_request_item", + "target_field": "received_qty", + "target_parent_dt": "Material Request", + "target_parent_field": "per_received", + "target_ref_field": "stock_qty", + "source_field": "stock_qty", + "percent_join_field": "material_request", } ] doc.update_qty() diff --git a/erpnext/patches/v12_0/set_serial_no_status.py b/erpnext/patches/v12_0/set_serial_no_status.py index 57206ced3e2..8ab342e9f2b 100644 --- a/erpnext/patches/v12_0/set_serial_no_status.py +++ b/erpnext/patches/v12_0/set_serial_no_status.py @@ -1,20 +1,24 @@ - import frappe from frappe.utils import getdate, nowdate def execute(): - frappe.reload_doc('stock', 'doctype', 'serial_no') + frappe.reload_doc("stock", "doctype", "serial_no") - serial_no_list = frappe.db.sql("""select name, delivery_document_type, warranty_expiry_date, warehouse from `tabSerial No` - where (status is NULL OR status='')""", as_dict = 1) + serial_no_list = frappe.db.sql( + """select name, delivery_document_type, warranty_expiry_date, warehouse from `tabSerial No` + where (status is NULL OR status='')""", + as_dict=1, + ) if len(serial_no_list) > 20000: frappe.db.auto_commit_on_many_writes = True for serial_no in serial_no_list: if serial_no.get("delivery_document_type"): status = "Delivered" - elif serial_no.get("warranty_expiry_date") and getdate(serial_no.get("warranty_expiry_date")) <= getdate(nowdate()): + elif serial_no.get("warranty_expiry_date") and getdate( + serial_no.get("warranty_expiry_date") + ) <= getdate(nowdate()): status = "Expired" elif not serial_no.get("warehouse"): status = "Inactive" diff --git a/erpnext/patches/v12_0/set_task_status.py b/erpnext/patches/v12_0/set_task_status.py index 1b4955a75be..1c6654e57ac 100644 --- a/erpnext/patches/v12_0/set_task_status.py +++ b/erpnext/patches/v12_0/set_task_status.py @@ -2,14 +2,16 @@ import frappe def execute(): - frappe.reload_doctype('Task') + frappe.reload_doctype("Task") # add "Completed" if customized - property_setter_name = frappe.db.exists('Property Setter', dict(doc_type='Task', field_name = 'status', property = 'options')) + property_setter_name = frappe.db.exists( + "Property Setter", dict(doc_type="Task", field_name="status", property="options") + ) if property_setter_name: - property_setter = frappe.get_doc('Property Setter', property_setter_name) + property_setter = frappe.get_doc("Property Setter", property_setter_name) if not "Completed" in property_setter.value: - property_setter.value = property_setter.value + '\nCompleted' + property_setter.value = property_setter.value + "\nCompleted" property_setter.save() # renamed default status to Completed as status "Closed" is ambiguous diff --git a/erpnext/patches/v12_0/set_total_batch_quantity.py b/erpnext/patches/v12_0/set_total_batch_quantity.py index 7296eaa33d8..068e0a6a4c1 100644 --- a/erpnext/patches/v12_0/set_total_batch_quantity.py +++ b/erpnext/patches/v12_0/set_total_batch_quantity.py @@ -5,7 +5,12 @@ def execute(): frappe.reload_doc("stock", "doctype", "batch") for batch in frappe.get_all("Batch", fields=["name", "batch_id"]): - batch_qty = frappe.db.get_value("Stock Ledger Entry", - {"docstatus": 1, "batch_no": batch.batch_id, "is_cancelled": 0}, - "sum(actual_qty)") or 0.0 + batch_qty = ( + frappe.db.get_value( + "Stock Ledger Entry", + {"docstatus": 1, "batch_no": batch.batch_id, "is_cancelled": 0}, + "sum(actual_qty)", + ) + or 0.0 + ) frappe.db.set_value("Batch", batch.name, "batch_qty", batch_qty, update_modified=False) diff --git a/erpnext/patches/v12_0/set_updated_purpose_in_pick_list.py b/erpnext/patches/v12_0/set_updated_purpose_in_pick_list.py index 300d0f2ba47..1e390819cd5 100644 --- a/erpnext/patches/v12_0/set_updated_purpose_in_pick_list.py +++ b/erpnext/patches/v12_0/set_updated_purpose_in_pick_list.py @@ -6,6 +6,8 @@ import frappe def execute(): - frappe.reload_doc("stock", "doctype", "pick_list") - frappe.db.sql("""UPDATE `tabPick List` set purpose = 'Delivery' - WHERE docstatus = 1 and purpose = 'Delivery against Sales Order' """) + frappe.reload_doc("stock", "doctype", "pick_list") + frappe.db.sql( + """UPDATE `tabPick List` set purpose = 'Delivery' + WHERE docstatus = 1 and purpose = 'Delivery against Sales Order' """ + ) diff --git a/erpnext/patches/v12_0/set_valid_till_date_in_supplier_quotation.py b/erpnext/patches/v12_0/set_valid_till_date_in_supplier_quotation.py index d79628f2a90..94322cd1971 100644 --- a/erpnext/patches/v12_0/set_valid_till_date_in_supplier_quotation.py +++ b/erpnext/patches/v12_0/set_valid_till_date_in_supplier_quotation.py @@ -1,9 +1,10 @@ - import frappe def execute(): frappe.reload_doc("buying", "doctype", "supplier_quotation") - frappe.db.sql("""UPDATE `tabSupplier Quotation` + frappe.db.sql( + """UPDATE `tabSupplier Quotation` SET valid_till = DATE_ADD(transaction_date , INTERVAL 1 MONTH) - WHERE docstatus < 2""") + WHERE docstatus < 2""" + ) diff --git a/erpnext/patches/v12_0/setup_einvoice_fields.py b/erpnext/patches/v12_0/setup_einvoice_fields.py index af2e60fd79a..f704f977aa3 100644 --- a/erpnext/patches/v12_0/setup_einvoice_fields.py +++ b/erpnext/patches/v12_0/setup_einvoice_fields.py @@ -1,4 +1,3 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields @@ -6,53 +5,128 @@ from erpnext.regional.india.setup import add_permissions, add_print_formats def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return frappe.reload_doc("custom", "doctype", "custom_field") frappe.reload_doc("regional", "doctype", "e_invoice_settings") custom_fields = { - 'Sales Invoice': [ - dict(fieldname='irn', label='IRN', fieldtype='Data', read_only=1, insert_after='customer', no_copy=1, print_hide=1, - depends_on='eval:in_list(["Registered Regular", "SEZ", "Overseas", "Deemed Export"], doc.gst_category) && doc.irn_cancelled === 0'), - - dict(fieldname='ack_no', label='Ack. No.', fieldtype='Data', read_only=1, hidden=1, insert_after='irn', no_copy=1, print_hide=1), - - dict(fieldname='ack_date', label='Ack. Date', fieldtype='Data', read_only=1, hidden=1, insert_after='ack_no', no_copy=1, print_hide=1), - - dict(fieldname='irn_cancelled', label='IRN Cancelled', fieldtype='Check', no_copy=1, print_hide=1, - depends_on='eval:(doc.irn_cancelled === 1)', read_only=1, allow_on_submit=1, insert_after='customer'), - - dict(fieldname='eway_bill_cancelled', label='E-Way Bill Cancelled', fieldtype='Check', no_copy=1, print_hide=1, - depends_on='eval:(doc.eway_bill_cancelled === 1)', read_only=1, allow_on_submit=1, insert_after='customer'), - - dict(fieldname='signed_einvoice', fieldtype='Code', options='JSON', hidden=1, no_copy=1, print_hide=1, read_only=1), - - dict(fieldname='signed_qr_code', fieldtype='Code', options='JSON', hidden=1, no_copy=1, print_hide=1, read_only=1), - - dict(fieldname='qrcode_image', label='QRCode', fieldtype='Attach Image', hidden=1, no_copy=1, print_hide=1, read_only=1) + "Sales Invoice": [ + dict( + fieldname="irn", + label="IRN", + fieldtype="Data", + read_only=1, + insert_after="customer", + no_copy=1, + print_hide=1, + depends_on='eval:in_list(["Registered Regular", "SEZ", "Overseas", "Deemed Export"], doc.gst_category) && doc.irn_cancelled === 0', + ), + dict( + fieldname="ack_no", + label="Ack. No.", + fieldtype="Data", + read_only=1, + hidden=1, + insert_after="irn", + no_copy=1, + print_hide=1, + ), + dict( + fieldname="ack_date", + label="Ack. Date", + fieldtype="Data", + read_only=1, + hidden=1, + insert_after="ack_no", + no_copy=1, + print_hide=1, + ), + dict( + fieldname="irn_cancelled", + label="IRN Cancelled", + fieldtype="Check", + no_copy=1, + print_hide=1, + depends_on="eval:(doc.irn_cancelled === 1)", + read_only=1, + allow_on_submit=1, + insert_after="customer", + ), + dict( + fieldname="eway_bill_cancelled", + label="E-Way Bill Cancelled", + fieldtype="Check", + no_copy=1, + print_hide=1, + depends_on="eval:(doc.eway_bill_cancelled === 1)", + read_only=1, + allow_on_submit=1, + insert_after="customer", + ), + dict( + fieldname="signed_einvoice", + fieldtype="Code", + options="JSON", + hidden=1, + no_copy=1, + print_hide=1, + read_only=1, + ), + dict( + fieldname="signed_qr_code", + fieldtype="Code", + options="JSON", + hidden=1, + no_copy=1, + print_hide=1, + read_only=1, + ), + dict( + fieldname="qrcode_image", + label="QRCode", + fieldtype="Attach Image", + hidden=1, + no_copy=1, + print_hide=1, + read_only=1, + ), ] } create_custom_fields(custom_fields, update=True) add_permissions() add_print_formats() - einvoice_cond = 'in_list(["Registered Regular", "SEZ", "Overseas", "Deemed Export"], doc.gst_category)' + einvoice_cond = ( + 'in_list(["Registered Regular", "SEZ", "Overseas", "Deemed Export"], doc.gst_category)' + ) t = { - 'mode_of_transport': [{'default': None}], - 'distance': [{'mandatory_depends_on': f'eval:{einvoice_cond} && doc.transporter'}], - 'gst_vehicle_type': [{'mandatory_depends_on': f'eval:{einvoice_cond} && doc.mode_of_transport == "Road"'}], - 'lr_date': [{'mandatory_depends_on': f'eval:{einvoice_cond} && in_list(["Air", "Ship", "Rail"], doc.mode_of_transport)'}], - 'lr_no': [{'mandatory_depends_on': f'eval:{einvoice_cond} && in_list(["Air", "Ship", "Rail"], doc.mode_of_transport)'}], - 'vehicle_no': [{'mandatory_depends_on': f'eval:{einvoice_cond} && doc.mode_of_transport == "Road"'}], - 'ewaybill': [ - {'read_only_depends_on': 'eval:doc.irn && doc.ewaybill'}, - {'depends_on': 'eval:((doc.docstatus === 1 || doc.ewaybill) && doc.eway_bill_cancelled === 0)'} - ] + "mode_of_transport": [{"default": None}], + "distance": [{"mandatory_depends_on": f"eval:{einvoice_cond} && doc.transporter"}], + "gst_vehicle_type": [ + {"mandatory_depends_on": f'eval:{einvoice_cond} && doc.mode_of_transport == "Road"'} + ], + "lr_date": [ + { + "mandatory_depends_on": f'eval:{einvoice_cond} && in_list(["Air", "Ship", "Rail"], doc.mode_of_transport)' + } + ], + "lr_no": [ + { + "mandatory_depends_on": f'eval:{einvoice_cond} && in_list(["Air", "Ship", "Rail"], doc.mode_of_transport)' + } + ], + "vehicle_no": [ + {"mandatory_depends_on": f'eval:{einvoice_cond} && doc.mode_of_transport == "Road"'} + ], + "ewaybill": [ + {"read_only_depends_on": "eval:doc.irn && doc.ewaybill"}, + {"depends_on": "eval:((doc.docstatus === 1 || doc.ewaybill) && doc.eway_bill_cancelled === 0)"}, + ], } for field, conditions in t.items(): for c in conditions: [(prop, value)] = c.items() - frappe.db.set_value('Custom Field', { 'fieldname': field }, prop, value) + frappe.db.set_value("Custom Field", {"fieldname": field}, prop, value) diff --git a/erpnext/patches/v12_0/show_einvoice_irn_cancelled_field.py b/erpnext/patches/v12_0/show_einvoice_irn_cancelled_field.py index 630a9046a4e..5508d260660 100644 --- a/erpnext/patches/v12_0/show_einvoice_irn_cancelled_field.py +++ b/erpnext/patches/v12_0/show_einvoice_irn_cancelled_field.py @@ -1,13 +1,14 @@ - import frappe def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - irn_cancelled_field = frappe.db.exists('Custom Field', {'dt': 'Sales Invoice', 'fieldname': 'irn_cancelled'}) + irn_cancelled_field = frappe.db.exists( + "Custom Field", {"dt": "Sales Invoice", "fieldname": "irn_cancelled"} + ) if irn_cancelled_field: - frappe.db.set_value('Custom Field', irn_cancelled_field, 'depends_on', 'eval: doc.irn') - frappe.db.set_value('Custom Field', irn_cancelled_field, 'read_only', 0) + frappe.db.set_value("Custom Field", irn_cancelled_field, "depends_on", "eval: doc.irn") + frappe.db.set_value("Custom Field", irn_cancelled_field, "read_only", 0) diff --git a/erpnext/patches/v12_0/stock_entry_enhancements.py b/erpnext/patches/v12_0/stock_entry_enhancements.py index 94d8ff9cde3..db099a304cf 100644 --- a/erpnext/patches/v12_0/stock_entry_enhancements.py +++ b/erpnext/patches/v12_0/stock_entry_enhancements.py @@ -2,7 +2,6 @@ # License: GNU General Public License v3. See license.txt - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields @@ -10,44 +9,61 @@ from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): create_stock_entry_types() - company = frappe.db.get_value("Company", {'country': 'India'}, 'name') + company = frappe.db.get_value("Company", {"country": "India"}, "name") if company: add_gst_hsn_code_field() + def create_stock_entry_types(): - frappe.reload_doc('stock', 'doctype', 'stock_entry_type') - frappe.reload_doc('stock', 'doctype', 'stock_entry') + frappe.reload_doc("stock", "doctype", "stock_entry_type") + frappe.reload_doc("stock", "doctype", "stock_entry") - for purpose in ["Material Issue", "Material Receipt", "Material Transfer", - "Material Transfer for Manufacture", "Material Consumption for Manufacture", "Manufacture", - "Repack", "Send to Subcontractor"]: + for purpose in [ + "Material Issue", + "Material Receipt", + "Material Transfer", + "Material Transfer for Manufacture", + "Material Consumption for Manufacture", + "Manufacture", + "Repack", + "Send to Subcontractor", + ]: - ste_type = frappe.get_doc({ - 'doctype': 'Stock Entry Type', - 'name': purpose, - 'purpose': purpose - }) + ste_type = frappe.get_doc({"doctype": "Stock Entry Type", "name": purpose, "purpose": purpose}) try: ste_type.insert() except frappe.DuplicateEntryError: pass - frappe.db.sql(" UPDATE `tabStock Entry` set purpose = 'Send to Subcontractor' where purpose = 'Subcontract'") + frappe.db.sql( + " UPDATE `tabStock Entry` set purpose = 'Send to Subcontractor' where purpose = 'Subcontract'" + ) frappe.db.sql(" UPDATE `tabStock Entry` set stock_entry_type = purpose ") + def add_gst_hsn_code_field(): custom_fields = { - 'Stock Entry Detail': [dict(fieldname='gst_hsn_code', label='HSN/SAC', - fieldtype='Data', fetch_from='item_code.gst_hsn_code', - insert_after='description', allow_on_submit=1, print_hide=0)] + "Stock Entry Detail": [ + dict( + fieldname="gst_hsn_code", + label="HSN/SAC", + fieldtype="Data", + fetch_from="item_code.gst_hsn_code", + insert_after="description", + allow_on_submit=1, + print_hide=0, + ) + ] } - create_custom_fields(custom_fields, ignore_validate = frappe.flags.in_patch, update=True) + create_custom_fields(custom_fields, ignore_validate=frappe.flags.in_patch, update=True) - frappe.db.sql(""" update `tabStock Entry Detail`, `tabItem` + frappe.db.sql( + """ update `tabStock Entry Detail`, `tabItem` SET `tabStock Entry Detail`.gst_hsn_code = `tabItem`.gst_hsn_code Where `tabItem`.name = `tabStock Entry Detail`.item_code and `tabItem`.gst_hsn_code is not null - """) + """ + ) diff --git a/erpnext/patches/v12_0/unhide_cost_center_field.py b/erpnext/patches/v12_0/unhide_cost_center_field.py index 72450212872..5f91ef6260a 100644 --- a/erpnext/patches/v12_0/unhide_cost_center_field.py +++ b/erpnext/patches/v12_0/unhide_cost_center_field.py @@ -6,9 +6,11 @@ import frappe def execute(): - frappe.db.sql(""" + frappe.db.sql( + """ DELETE FROM `tabProperty Setter` WHERE doc_type in ('Sales Invoice', 'Purchase Invoice', 'Payment Entry') AND field_name = 'cost_center' AND property = 'hidden' - """) + """ + ) diff --git a/erpnext/patches/v12_0/unset_customer_supplier_based_on_type_of_item_price.py b/erpnext/patches/v12_0/unset_customer_supplier_based_on_type_of_item_price.py index 1a677f91672..332609b8466 100644 --- a/erpnext/patches/v12_0/unset_customer_supplier_based_on_type_of_item_price.py +++ b/erpnext/patches/v12_0/unset_customer_supplier_based_on_type_of_item_price.py @@ -1,29 +1,30 @@ - import frappe def execute(): - """ - set proper customer and supplier details for item price - based on selling and buying values - """ + """ + set proper customer and supplier details for item price + based on selling and buying values + """ - # update for selling - frappe.db.sql( - """UPDATE `tabItem Price` ip, `tabPrice List` pl + # update for selling + frappe.db.sql( + """UPDATE `tabItem Price` ip, `tabPrice List` pl SET ip.`reference` = ip.`customer`, ip.`supplier` = NULL WHERE ip.`selling` = 1 AND ip.`buying` = 0 AND (ip.`supplier` IS NOT NULL OR ip.`supplier` = '') AND ip.`price_list` = pl.`name` - AND pl.`enabled` = 1""") + AND pl.`enabled` = 1""" + ) - # update for buying - frappe.db.sql( - """UPDATE `tabItem Price` ip, `tabPrice List` pl + # update for buying + frappe.db.sql( + """UPDATE `tabItem Price` ip, `tabPrice List` pl SET ip.`reference` = ip.`supplier`, ip.`customer` = NULL WHERE ip.`selling` = 0 AND ip.`buying` = 1 AND (ip.`customer` IS NOT NULL OR ip.`customer` = '') AND ip.`price_list` = pl.`name` - AND pl.`enabled` = 1""") + AND pl.`enabled` = 1""" + ) diff --git a/erpnext/patches/v12_0/update_address_template_for_india.py b/erpnext/patches/v12_0/update_address_template_for_india.py index 64a2e41587f..27b1bb6dc18 100644 --- a/erpnext/patches/v12_0/update_address_template_for_india.py +++ b/erpnext/patches/v12_0/update_address_template_for_india.py @@ -8,7 +8,7 @@ from erpnext.regional.address_template.setup import set_up_address_templates def execute(): - if frappe.db.get_value('Company', {'country': 'India'}, 'name'): - address_template = frappe.db.get_value('Address Template', 'India', 'template') + if frappe.db.get_value("Company", {"country": "India"}, "name"): + address_template = frappe.db.get_value("Address Template", "India", "template") if not address_template or "gstin" not in address_template: - set_up_address_templates(default_country='India') + set_up_address_templates(default_country="India") diff --git a/erpnext/patches/v12_0/update_appointment_reminder_scheduler_entry.py b/erpnext/patches/v12_0/update_appointment_reminder_scheduler_entry.py index 024cb2b7630..725ff1e4797 100644 --- a/erpnext/patches/v12_0/update_appointment_reminder_scheduler_entry.py +++ b/erpnext/patches/v12_0/update_appointment_reminder_scheduler_entry.py @@ -2,7 +2,9 @@ import frappe def execute(): - job = frappe.db.exists('Scheduled Job Type', 'patient_appointment.send_appointment_reminder') + job = frappe.db.exists("Scheduled Job Type", "patient_appointment.send_appointment_reminder") if job: - method = 'erpnext.healthcare.doctype.patient_appointment.patient_appointment.send_appointment_reminder' - frappe.db.set_value('Scheduled Job Type', job, 'method', method) + method = ( + "erpnext.healthcare.doctype.patient_appointment.patient_appointment.send_appointment_reminder" + ) + frappe.db.set_value("Scheduled Job Type", job, "method", method) diff --git a/erpnext/patches/v12_0/update_bom_in_so_mr.py b/erpnext/patches/v12_0/update_bom_in_so_mr.py index 7683031e278..114f65d100e 100644 --- a/erpnext/patches/v12_0/update_bom_in_so_mr.py +++ b/erpnext/patches/v12_0/update_bom_in_so_mr.py @@ -1,4 +1,3 @@ - import frappe @@ -7,14 +6,19 @@ def execute(): frappe.reload_doc("selling", "doctype", "sales_order_item") for doctype in ["Sales Order", "Material Request"]: - condition = " and child_doc.stock_qty > child_doc.produced_qty" + condition = " and child_doc.stock_qty > child_doc.produced_qty and doc.per_delivered < 100" if doctype == "Material Request": condition = " and doc.per_ordered < 100 and doc.material_request_type = 'Manufacture'" - frappe.db.sql(""" UPDATE `tab{doc}` as doc, `tab{doc} Item` as child_doc, tabItem as item + frappe.db.sql( + """ UPDATE `tab{doc}` as doc, `tab{doc} Item` as child_doc, tabItem as item SET child_doc.bom_no = item.default_bom WHERE child_doc.item_code = item.name and child_doc.docstatus < 2 + and child_doc.parent = doc.name and item.default_bom is not null and item.default_bom != '' {cond} - """.format(doc = doctype, cond = condition)) + """.format( + doc=doctype, cond=condition + ) + ) diff --git a/erpnext/patches/v12_0/update_due_date_in_gle.py b/erpnext/patches/v12_0/update_due_date_in_gle.py index 032c2bb9538..a1c4f51ad01 100644 --- a/erpnext/patches/v12_0/update_due_date_in_gle.py +++ b/erpnext/patches/v12_0/update_due_date_in_gle.py @@ -1,18 +1,20 @@ - import frappe def execute(): - frappe.reload_doc("accounts", "doctype", "gl_entry") + frappe.reload_doc("accounts", "doctype", "gl_entry") - for doctype in ["Sales Invoice", "Purchase Invoice", "Journal Entry"]: - frappe.reload_doc("accounts", "doctype", frappe.scrub(doctype)) + for doctype in ["Sales Invoice", "Purchase Invoice", "Journal Entry"]: + frappe.reload_doc("accounts", "doctype", frappe.scrub(doctype)) - frappe.db.sql(""" UPDATE `tabGL Entry`, `tab{doctype}` + frappe.db.sql( + """ UPDATE `tabGL Entry`, `tab{doctype}` SET `tabGL Entry`.due_date = `tab{doctype}`.due_date WHERE `tabGL Entry`.voucher_no = `tab{doctype}`.name and `tabGL Entry`.party is not null and `tabGL Entry`.voucher_type in ('Sales Invoice', 'Purchase Invoice', 'Journal Entry') - and `tabGL Entry`.account in (select name from `tabAccount` where account_type in ('Receivable', 'Payable'))""" #nosec - .format(doctype=doctype)) + and `tabGL Entry`.account in (select name from `tabAccount` where account_type in ('Receivable', 'Payable'))""".format( # nosec + doctype=doctype + ) + ) diff --git a/erpnext/patches/v12_0/update_end_date_and_status_in_email_campaign.py b/erpnext/patches/v12_0/update_end_date_and_status_in_email_campaign.py index 48febc5aa45..570b77b88e1 100644 --- a/erpnext/patches/v12_0/update_end_date_and_status_in_email_campaign.py +++ b/erpnext/patches/v12_0/update_end_date_and_status_in_email_campaign.py @@ -1,25 +1,24 @@ - import frappe from frappe.utils import add_days, getdate, today def execute(): - if frappe.db.exists('DocType', 'Email Campaign'): - email_campaign = frappe.get_all('Email Campaign') - for campaign in email_campaign: - doc = frappe.get_doc("Email Campaign",campaign["name"]) - send_after_days = [] + if frappe.db.exists("DocType", "Email Campaign"): + email_campaign = frappe.get_all("Email Campaign") + for campaign in email_campaign: + doc = frappe.get_doc("Email Campaign", campaign["name"]) + send_after_days = [] - camp = frappe.get_doc("Campaign", doc.campaign_name) - for entry in camp.get("campaign_schedules"): - send_after_days.append(entry.send_after_days) - if send_after_days: - end_date = add_days(getdate(doc.start_date), max(send_after_days)) - doc.db_set("end_date", end_date) - today_date = getdate(today()) - if doc.start_date > today_date: - doc.db_set("status", "Scheduled") - elif end_date >= today_date: - doc.db_set("status", "In Progress") - elif end_date < today_date: - doc.db_set("status", "Completed") + camp = frappe.get_doc("Campaign", doc.campaign_name) + for entry in camp.get("campaign_schedules"): + send_after_days.append(entry.send_after_days) + if send_after_days: + end_date = add_days(getdate(doc.start_date), max(send_after_days)) + doc.db_set("end_date", end_date) + today_date = getdate(today()) + if doc.start_date > today_date: + doc.db_set("status", "Scheduled") + elif end_date >= today_date: + doc.db_set("status", "In Progress") + elif end_date < today_date: + doc.db_set("status", "Completed") diff --git a/erpnext/patches/v12_0/update_ewaybill_field_position.py b/erpnext/patches/v12_0/update_ewaybill_field_position.py index ace3aceebba..24a834b05c7 100644 --- a/erpnext/patches/v12_0/update_ewaybill_field_position.py +++ b/erpnext/patches/v12_0/update_ewaybill_field_position.py @@ -1,9 +1,8 @@ - import frappe def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return @@ -15,14 +14,16 @@ def execute(): ewaybill_field.flags.ignore_validate = True - ewaybill_field.update({ - 'fieldname': 'ewaybill', - 'label': 'e-Way Bill No.', - 'fieldtype': 'Data', - 'depends_on': 'eval:(doc.docstatus === 1)', - 'allow_on_submit': 1, - 'insert_after': 'tax_id', - 'translatable': 0 - }) + ewaybill_field.update( + { + "fieldname": "ewaybill", + "label": "e-Way Bill No.", + "fieldtype": "Data", + "depends_on": "eval:(doc.docstatus === 1)", + "allow_on_submit": 1, + "insert_after": "tax_id", + "translatable": 0, + } + ) ewaybill_field.save() diff --git a/erpnext/patches/v12_0/update_gst_category.py b/erpnext/patches/v12_0/update_gst_category.py index 20dce94f2ff..16168f022cd 100644 --- a/erpnext/patches/v12_0/update_gst_category.py +++ b/erpnext/patches/v12_0/update_gst_category.py @@ -1,20 +1,23 @@ - import frappe def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) - if not company: - return + company = frappe.get_all("Company", filters={"country": "India"}) + if not company: + return - frappe.db.sql(""" UPDATE `tabSales Invoice` set gst_category = 'Unregistered' + frappe.db.sql( + """ UPDATE `tabSales Invoice` set gst_category = 'Unregistered' where gst_category = 'Registered Regular' and ifnull(customer_gstin, '')='' and ifnull(billing_address_gstin,'')='' - """) + """ + ) - frappe.db.sql(""" UPDATE `tabPurchase Invoice` set gst_category = 'Unregistered' + frappe.db.sql( + """ UPDATE `tabPurchase Invoice` set gst_category = 'Unregistered' where gst_category = 'Registered Regular' and ifnull(supplier_gstin, '')='' - """) + """ + ) diff --git a/erpnext/patches/v12_0/update_healthcare_refactored_changes.py b/erpnext/patches/v12_0/update_healthcare_refactored_changes.py index 4e24a638f98..5ca0d5d47d9 100644 --- a/erpnext/patches/v12_0/update_healthcare_refactored_changes.py +++ b/erpnext/patches/v12_0/update_healthcare_refactored_changes.py @@ -1,79 +1,81 @@ - import frappe from frappe.model.utils.rename_field import rename_field from frappe.modules import get_doctype_module, scrub field_rename_map = { - 'Healthcare Settings': [ - ['patient_master_name', 'patient_name_by'], - ['max_visit', 'max_visits'], - ['reg_sms', 'send_registration_msg'], - ['reg_msg', 'registration_msg'], - ['app_con', 'send_appointment_confirmation'], - ['app_con_msg', 'appointment_confirmation_msg'], - ['no_con', 'avoid_confirmation'], - ['app_rem', 'send_appointment_reminder'], - ['app_rem_msg', 'appointment_reminder_msg'], - ['rem_before', 'remind_before'], - ['manage_customer', 'link_customer_to_patient'], - ['create_test_on_si_submit', 'create_lab_test_on_si_submit'], - ['require_sample_collection', 'create_sample_collection_for_lab_test'], - ['require_test_result_approval', 'lab_test_approval_required'], - ['manage_appointment_invoice_automatically', 'automate_appointment_invoicing'] + "Healthcare Settings": [ + ["patient_master_name", "patient_name_by"], + ["max_visit", "max_visits"], + ["reg_sms", "send_registration_msg"], + ["reg_msg", "registration_msg"], + ["app_con", "send_appointment_confirmation"], + ["app_con_msg", "appointment_confirmation_msg"], + ["no_con", "avoid_confirmation"], + ["app_rem", "send_appointment_reminder"], + ["app_rem_msg", "appointment_reminder_msg"], + ["rem_before", "remind_before"], + ["manage_customer", "link_customer_to_patient"], + ["create_test_on_si_submit", "create_lab_test_on_si_submit"], + ["require_sample_collection", "create_sample_collection_for_lab_test"], + ["require_test_result_approval", "lab_test_approval_required"], + ["manage_appointment_invoice_automatically", "automate_appointment_invoicing"], ], - 'Drug Prescription':[ - ['use_interval', 'usage_interval'], - ['in_every', 'interval_uom'] + "Drug Prescription": [["use_interval", "usage_interval"], ["in_every", "interval_uom"]], + "Lab Test Template": [ + ["sample_quantity", "sample_qty"], + ["sample_collection_details", "sample_details"], ], - 'Lab Test Template':[ - ['sample_quantity', 'sample_qty'], - ['sample_collection_details', 'sample_details'] + "Sample Collection": [ + ["sample_quantity", "sample_qty"], + ["sample_collection_details", "sample_details"], ], - 'Sample Collection':[ - ['sample_quantity', 'sample_qty'], - ['sample_collection_details', 'sample_details'] - ], - 'Fee Validity': [ - ['max_visit', 'max_visits'] - ] + "Fee Validity": [["max_visit", "max_visits"]], } + def execute(): for dn in field_rename_map: - if frappe.db.exists('DocType', dn): - if dn == 'Healthcare Settings': - frappe.reload_doctype('Healthcare Settings') + if frappe.db.exists("DocType", dn): + if dn == "Healthcare Settings": + frappe.reload_doctype("Healthcare Settings") else: frappe.reload_doc(get_doctype_module(dn), "doctype", scrub(dn)) for dt, field_list in field_rename_map.items(): - if frappe.db.exists('DocType', dt): + if frappe.db.exists("DocType", dt): for field in field_list: - if dt == 'Healthcare Settings': + if dt == "Healthcare Settings": rename_field(dt, field[0], field[1]) elif frappe.db.has_column(dt, field[0]): rename_field(dt, field[0], field[1]) # first name mandatory in Patient - if frappe.db.exists('DocType', 'Patient'): + if frappe.db.exists("DocType", "Patient"): patients = frappe.db.sql("select name, patient_name from `tabPatient`", as_dict=1) - frappe.reload_doc('healthcare', 'doctype', 'patient') + frappe.reload_doc("healthcare", "doctype", "patient") for entry in patients: - name = entry.patient_name.split(' ') - frappe.db.set_value('Patient', entry.name, 'first_name', name[0]) + name = entry.patient_name.split(" ") + frappe.db.set_value("Patient", entry.name, "first_name", name[0]) # mark Healthcare Practitioner status as Disabled - if frappe.db.exists('DocType', 'Healthcare Practitioner'): - practitioners = frappe.db.sql("select name from `tabHealthcare Practitioner` where 'active'= 0", as_dict=1) + if frappe.db.exists("DocType", "Healthcare Practitioner"): + practitioners = frappe.db.sql( + "select name from `tabHealthcare Practitioner` where 'active'= 0", as_dict=1 + ) practitioners_lst = [p.name for p in practitioners] - frappe.reload_doc('healthcare', 'doctype', 'healthcare_practitioner') + frappe.reload_doc("healthcare", "doctype", "healthcare_practitioner") if practitioners_lst: - frappe.db.sql("update `tabHealthcare Practitioner` set status = 'Disabled' where name IN %(practitioners)s""", {"practitioners": practitioners_lst}) + frappe.db.sql( + "update `tabHealthcare Practitioner` set status = 'Disabled' where name IN %(practitioners)s" + "", + {"practitioners": practitioners_lst}, + ) # set Clinical Procedure status - if frappe.db.exists('DocType', 'Clinical Procedure'): - frappe.reload_doc('healthcare', 'doctype', 'clinical_procedure') - frappe.db.sql(""" + if frappe.db.exists("DocType", "Clinical Procedure"): + frappe.reload_doc("healthcare", "doctype", "clinical_procedure") + frappe.db.sql( + """ UPDATE `tabClinical Procedure` SET @@ -81,57 +83,49 @@ def execute(): WHEN status = 'Draft' THEN 0 ELSE 1 END) - """) + """ + ) # set complaints and diagnosis in table multiselect in Patient Encounter - if frappe.db.exists('DocType', 'Patient Encounter'): - field_list = [ - ['visit_department', 'medical_department'], - ['type', 'appointment_type'] - ] - encounter_details = frappe.db.sql("""select symptoms, diagnosis, name from `tabPatient Encounter`""", as_dict=True) - frappe.reload_doc('healthcare', 'doctype', 'patient_encounter') - frappe.reload_doc('healthcare', 'doctype', 'patient_encounter_symptom') - frappe.reload_doc('healthcare', 'doctype', 'patient_encounter_diagnosis') + if frappe.db.exists("DocType", "Patient Encounter"): + field_list = [["visit_department", "medical_department"], ["type", "appointment_type"]] + encounter_details = frappe.db.sql( + """select symptoms, diagnosis, name from `tabPatient Encounter`""", as_dict=True + ) + frappe.reload_doc("healthcare", "doctype", "patient_encounter") + frappe.reload_doc("healthcare", "doctype", "patient_encounter_symptom") + frappe.reload_doc("healthcare", "doctype", "patient_encounter_diagnosis") for field in field_list: if frappe.db.has_column(dt, field[0]): rename_field(dt, field[0], field[1]) for entry in encounter_details: - doc = frappe.get_doc('Patient Encounter', entry.name) - symptoms = entry.symptoms.split('\n') if entry.symptoms else [] + doc = frappe.get_doc("Patient Encounter", entry.name) + symptoms = entry.symptoms.split("\n") if entry.symptoms else [] for symptom in symptoms: - if not frappe.db.exists('Complaint', symptom): - frappe.get_doc({ - 'doctype': 'Complaint', - 'complaints': symptom - }).insert() - row = doc.append('symptoms', { - 'complaint': symptom - }) + if not frappe.db.exists("Complaint", symptom): + frappe.get_doc({"doctype": "Complaint", "complaints": symptom}).insert() + row = doc.append("symptoms", {"complaint": symptom}) row.db_update() - diagnosis = entry.diagnosis.split('\n') if entry.diagnosis else [] + diagnosis = entry.diagnosis.split("\n") if entry.diagnosis else [] for d in diagnosis: - if not frappe.db.exists('Diagnosis', d): - frappe.get_doc({ - 'doctype': 'Diagnosis', - 'diagnosis': d - }).insert() - row = doc.append('diagnosis', { - 'diagnosis': d - }) + if not frappe.db.exists("Diagnosis", d): + frappe.get_doc({"doctype": "Diagnosis", "diagnosis": d}).insert() + row = doc.append("diagnosis", {"diagnosis": d}) row.db_update() doc.db_update() - if frappe.db.exists('DocType', 'Fee Validity'): + if frappe.db.exists("DocType", "Fee Validity"): # update fee validity status - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabFee Validity` SET status = (CASE WHEN visited >= max_visits THEN 'Completed' ELSE 'Pending' END) - """) + """ + ) diff --git a/erpnext/patches/v12_0/update_is_cancelled_field.py b/erpnext/patches/v12_0/update_is_cancelled_field.py index 18787848dfd..398dd700eda 100644 --- a/erpnext/patches/v12_0/update_is_cancelled_field.py +++ b/erpnext/patches/v12_0/update_is_cancelled_field.py @@ -1,16 +1,36 @@ - import frappe def execute(): - try: - frappe.db.sql("UPDATE `tabStock Ledger Entry` SET is_cancelled = 0 where is_cancelled in ('', NULL, 'No')") - frappe.db.sql("UPDATE `tabSerial No` SET is_cancelled = 0 where is_cancelled in ('', NULL, 'No')") + # handle type casting for is_cancelled field + module_doctypes = ( + ("stock", "Stock Ledger Entry"), + ("stock", "Serial No"), + ("accounts", "GL Entry"), + ) - frappe.db.sql("UPDATE `tabStock Ledger Entry` SET is_cancelled = 1 where is_cancelled = 'Yes'") - frappe.db.sql("UPDATE `tabSerial No` SET is_cancelled = 1 where is_cancelled = 'Yes'") + for module, doctype in module_doctypes: + if ( + not frappe.db.has_column(doctype, "is_cancelled") + or frappe.db.get_column_type(doctype, "is_cancelled").lower() == "int(1)" + ): + continue - frappe.reload_doc("stock", "doctype", "stock_ledger_entry") - frappe.reload_doc("stock", "doctype", "serial_no") - except Exception: - pass + frappe.db.sql( + """ + UPDATE `tab{doctype}` + SET is_cancelled = 0 + where is_cancelled in ('', 'No') or is_cancelled is NULL""".format( + doctype=doctype + ) + ) + frappe.db.sql( + """ + UPDATE `tab{doctype}` + SET is_cancelled = 1 + where is_cancelled = 'Yes'""".format( + doctype=doctype + ) + ) + + frappe.reload_doc(module, "doctype", frappe.scrub(doctype)) diff --git a/erpnext/patches/v12_0/update_item_tax_template_company.py b/erpnext/patches/v12_0/update_item_tax_template_company.py index a737cb2dfa5..489f70d4497 100644 --- a/erpnext/patches/v12_0/update_item_tax_template_company.py +++ b/erpnext/patches/v12_0/update_item_tax_template_company.py @@ -1,14 +1,13 @@ - import frappe def execute(): - frappe.reload_doc('accounts', 'doctype', 'item_tax_template') + frappe.reload_doc("accounts", "doctype", "item_tax_template") - item_tax_template_list = frappe.get_list('Item Tax Template') - for template in item_tax_template_list: - doc = frappe.get_doc('Item Tax Template', template.name) - for tax in doc.taxes: - doc.company = frappe.get_value('Account', tax.tax_type, 'company') - break - doc.save() + item_tax_template_list = frappe.get_list("Item Tax Template") + for template in item_tax_template_list: + doc = frappe.get_doc("Item Tax Template", template.name) + for tax in doc.taxes: + doc.company = frappe.get_value("Account", tax.tax_type, "company") + break + doc.save() diff --git a/erpnext/patches/v12_0/update_owner_fields_in_acc_dimension_custom_fields.py b/erpnext/patches/v12_0/update_owner_fields_in_acc_dimension_custom_fields.py index 53e83216673..7dc0af9a1aa 100644 --- a/erpnext/patches/v12_0/update_owner_fields_in_acc_dimension_custom_fields.py +++ b/erpnext/patches/v12_0/update_owner_fields_in_acc_dimension_custom_fields.py @@ -1,4 +1,3 @@ - import frappe from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import ( @@ -7,15 +6,21 @@ from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import ( def execute(): - accounting_dimensions = frappe.db.sql("""select fieldname from - `tabAccounting Dimension`""", as_dict=1) + accounting_dimensions = frappe.db.sql( + """select fieldname from + `tabAccounting Dimension`""", + as_dict=1, + ) doclist = get_doctypes_with_dimensions() for dimension in accounting_dimensions: - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabCustom Field` SET owner = 'Administrator' WHERE fieldname = %s - AND dt IN (%s)""" % #nosec - ('%s', ', '.join(['%s']* len(doclist))), tuple([dimension.fieldname] + doclist)) + AND dt IN (%s)""" + % ("%s", ", ".join(["%s"] * len(doclist))), # nosec + tuple([dimension.fieldname] + doclist), + ) diff --git a/erpnext/patches/v12_0/update_price_list_currency_in_bom.py b/erpnext/patches/v12_0/update_price_list_currency_in_bom.py index e0382d818ea..5710320e62d 100644 --- a/erpnext/patches/v12_0/update_price_list_currency_in_bom.py +++ b/erpnext/patches/v12_0/update_price_list_currency_in_bom.py @@ -1,4 +1,3 @@ - import frappe from frappe.utils import getdate @@ -9,16 +8,19 @@ def execute(): frappe.reload_doc("manufacturing", "doctype", "bom") frappe.reload_doc("manufacturing", "doctype", "bom_item") - frappe.db.sql(""" UPDATE `tabBOM`, `tabPrice List` + frappe.db.sql( + """ UPDATE `tabBOM`, `tabPrice List` SET `tabBOM`.price_list_currency = `tabPrice List`.currency, `tabBOM`.plc_conversion_rate = 1.0 WHERE `tabBOM`.buying_price_list = `tabPrice List`.name AND `tabBOM`.docstatus < 2 AND `tabBOM`.rm_cost_as_per = 'Price List' - """) + """ + ) - for d in frappe.db.sql(""" + for d in frappe.db.sql( + """ SELECT bom.creation, bom.name, bom.price_list_currency as currency, company.default_currency as company_currency @@ -26,8 +28,11 @@ def execute(): `tabBOM` as bom, `tabCompany` as company WHERE bom.company = company.name AND bom.rm_cost_as_per = 'Price List' AND - bom.price_list_currency != company.default_currency AND bom.docstatus < 2""", as_dict=1): - plc_conversion_rate = get_exchange_rate(d.currency, - d.company_currency, getdate(d.creation), "for_buying") + bom.price_list_currency != company.default_currency AND bom.docstatus < 2""", + as_dict=1, + ): + plc_conversion_rate = get_exchange_rate( + d.currency, d.company_currency, getdate(d.creation), "for_buying" + ) - frappe.db.set_value("BOM", d.name, "plc_conversion_rate", plc_conversion_rate) + frappe.db.set_value("BOM", d.name, "plc_conversion_rate", plc_conversion_rate) diff --git a/erpnext/patches/v12_0/update_price_or_product_discount.py b/erpnext/patches/v12_0/update_price_or_product_discount.py index 86105a469db..64344c8cd42 100644 --- a/erpnext/patches/v12_0/update_price_or_product_discount.py +++ b/erpnext/patches/v12_0/update_price_or_product_discount.py @@ -1,9 +1,10 @@ - import frappe def execute(): frappe.reload_doc("accounts", "doctype", "pricing_rule") - frappe.db.sql(""" UPDATE `tabPricing Rule` SET price_or_product_discount = 'Price' - WHERE ifnull(price_or_product_discount,'') = '' """) + frappe.db.sql( + """ UPDATE `tabPricing Rule` SET price_or_product_discount = 'Price' + WHERE ifnull(price_or_product_discount,'') = '' """ + ) diff --git a/erpnext/patches/v12_0/update_pricing_rule_fields.py b/erpnext/patches/v12_0/update_pricing_rule_fields.py index b7c36ae7780..8da06b0bda0 100644 --- a/erpnext/patches/v12_0/update_pricing_rule_fields.py +++ b/erpnext/patches/v12_0/update_pricing_rule_fields.py @@ -4,68 +4,120 @@ import frappe -parentfield = { - 'item_code': 'items', - 'item_group': 'item_groups', - 'brand': 'brands' -} +parentfield = {"item_code": "items", "item_group": "item_groups", "brand": "brands"} + def execute(): - if not frappe.get_all('Pricing Rule', limit=1): + if not frappe.get_all("Pricing Rule", limit=1): return - frappe.reload_doc('accounts', 'doctype', 'pricing_rule_detail') - doctypes = {'Supplier Quotation': 'buying', 'Purchase Order': 'buying', 'Purchase Invoice': 'accounts', - 'Purchase Receipt': 'stock', 'Quotation': 'selling', 'Sales Order': 'selling', - 'Sales Invoice': 'accounts', 'Delivery Note': 'stock'} + frappe.reload_doc("accounts", "doctype", "pricing_rule_detail") + doctypes = { + "Supplier Quotation": "buying", + "Purchase Order": "buying", + "Purchase Invoice": "accounts", + "Purchase Receipt": "stock", + "Quotation": "selling", + "Sales Order": "selling", + "Sales Invoice": "accounts", + "Delivery Note": "stock", + } for doctype, module in doctypes.items(): - frappe.reload_doc(module, 'doctype', frappe.scrub(doctype)) + frappe.reload_doc(module, "doctype", frappe.scrub(doctype)) - child_doc = frappe.scrub(doctype) + '_item' - frappe.reload_doc(module, 'doctype', child_doc, force=True) + child_doc = frappe.scrub(doctype) + "_item" + frappe.reload_doc(module, "doctype", child_doc, force=True) - child_doctype = doctype + ' Item' + child_doctype = doctype + " Item" - frappe.db.sql(""" UPDATE `tab{child_doctype}` SET pricing_rules = pricing_rule + frappe.db.sql( + """ UPDATE `tab{child_doctype}` SET pricing_rules = pricing_rule WHERE docstatus < 2 and pricing_rule is not null and pricing_rule != '' - """.format(child_doctype= child_doctype)) + """.format( + child_doctype=child_doctype + ) + ) - data = frappe.db.sql(""" SELECT pricing_rule, name, parent, + data = frappe.db.sql( + """ SELECT pricing_rule, name, parent, parenttype, creation, modified, docstatus, modified_by, owner, name FROM `tab{child_doc}` where docstatus < 2 and pricing_rule is not null - and pricing_rule != ''""".format(child_doc=child_doctype), as_dict=1) + and pricing_rule != ''""".format( + child_doc=child_doctype + ), + as_dict=1, + ) values = [] for d in data: - values.append((d.pricing_rule, d.name, d.parent, 'pricing_rules', d.parenttype, - d.creation, d.modified, d.docstatus, d.modified_by, d.owner, frappe.generate_hash("", 10))) + values.append( + ( + d.pricing_rule, + d.name, + d.parent, + "pricing_rules", + d.parenttype, + d.creation, + d.modified, + d.docstatus, + d.modified_by, + d.owner, + frappe.generate_hash("", 10), + ) + ) if values: - frappe.db.sql(""" INSERT INTO + frappe.db.sql( + """ INSERT INTO `tabPricing Rule Detail` (`pricing_rule`, `child_docname`, `parent`, `parentfield`, `parenttype`, `creation`, `modified`, `docstatus`, `modified_by`, `owner`, `name`) - VALUES {values} """.format(values=', '.join(['%s'] * len(values))), tuple(values)) + VALUES {values} """.format( + values=", ".join(["%s"] * len(values)) + ), + tuple(values), + ) - frappe.reload_doc('accounts', 'doctype', 'pricing_rule') + frappe.reload_doc("accounts", "doctype", "pricing_rule") - for doctype, apply_on in {'Pricing Rule Item Code': 'Item Code', - 'Pricing Rule Item Group': 'Item Group', 'Pricing Rule Brand': 'Brand'}.items(): - frappe.reload_doc('accounts', 'doctype', frappe.scrub(doctype)) + for doctype, apply_on in { + "Pricing Rule Item Code": "Item Code", + "Pricing Rule Item Group": "Item Group", + "Pricing Rule Brand": "Brand", + }.items(): + frappe.reload_doc("accounts", "doctype", frappe.scrub(doctype)) field = frappe.scrub(apply_on) - data = frappe.get_all('Pricing Rule', fields=[field, "name", "creation", "modified", - "owner", "modified_by"], filters= {'apply_on': apply_on}) + data = frappe.get_all( + "Pricing Rule", + fields=[field, "name", "creation", "modified", "owner", "modified_by"], + filters={"apply_on": apply_on}, + ) values = [] for d in data: - values.append((d.get(field), d.name, parentfield.get(field), 'Pricing Rule', - d.creation, d.modified, d.owner, d.modified_by, frappe.generate_hash("", 10))) + values.append( + ( + d.get(field), + d.name, + parentfield.get(field), + "Pricing Rule", + d.creation, + d.modified, + d.owner, + d.modified_by, + frappe.generate_hash("", 10), + ) + ) if values: - frappe.db.sql(""" INSERT INTO + frappe.db.sql( + """ INSERT INTO `tab{doctype}` ({field}, parent, parentfield, parenttype, creation, modified, owner, modified_by, name) - VALUES {values} """.format(doctype=doctype, - field=field, values=', '.join(['%s'] * len(values))), tuple(values)) + VALUES {values} """.format( + doctype=doctype, field=field, values=", ".join(["%s"] * len(values)) + ), + tuple(values), + ) diff --git a/erpnext/patches/v12_0/update_production_plan_status.py b/erpnext/patches/v12_0/update_production_plan_status.py index 06fc503a33f..dc65ec25f21 100644 --- a/erpnext/patches/v12_0/update_production_plan_status.py +++ b/erpnext/patches/v12_0/update_production_plan_status.py @@ -6,7 +6,8 @@ import frappe def execute(): frappe.reload_doc("manufacturing", "doctype", "production_plan") - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabProduction Plan` ppl SET status = "Completed" WHERE ppl.name IN ( @@ -28,4 +29,5 @@ def execute(): HAVING should_set = 1 ) ss ) - """) + """ + ) diff --git a/erpnext/patches/v12_0/update_state_code_for_daman_and_diu.py b/erpnext/patches/v12_0/update_state_code_for_daman_and_diu.py index 25cf6b97e3b..d7e96fafd60 100644 --- a/erpnext/patches/v12_0/update_state_code_for_daman_and_diu.py +++ b/erpnext/patches/v12_0/update_state_code_for_daman_and_diu.py @@ -5,20 +5,22 @@ from erpnext.regional.india import states def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return # Update options in gst_state custom field - gst_state = frappe.get_doc('Custom Field', 'Address-gst_state') - gst_state.options = '\n'.join(states) + gst_state = frappe.get_doc("Custom Field", "Address-gst_state") + gst_state.options = "\n".join(states) gst_state.save() # Update gst_state and state code in existing address - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabAddress` SET gst_state = 'Dadra and Nagar Haveli and Daman and Diu', gst_state_number = 26 WHERE gst_state = 'Daman and Diu' - """) + """ + ) diff --git a/erpnext/patches/v12_0/update_uom_conversion_factor.py b/erpnext/patches/v12_0/update_uom_conversion_factor.py index 3184d1195f0..a09ac190e2e 100644 --- a/erpnext/patches/v12_0/update_uom_conversion_factor.py +++ b/erpnext/patches/v12_0/update_uom_conversion_factor.py @@ -1,4 +1,3 @@ - import frappe diff --git a/erpnext/patches/v13_0/add_bin_unique_constraint.py b/erpnext/patches/v13_0/add_bin_unique_constraint.py new file mode 100644 index 00000000000..38a8500ac73 --- /dev/null +++ b/erpnext/patches/v13_0/add_bin_unique_constraint.py @@ -0,0 +1,67 @@ +import frappe + +from erpnext.stock.stock_balance import ( + get_balance_qty_from_sle, + get_indented_qty, + get_ordered_qty, + get_planned_qty, + get_reserved_qty, +) +from erpnext.stock.utils import get_bin + + +def execute(): + delete_broken_bins() + delete_and_patch_duplicate_bins() + + +def delete_broken_bins(): + # delete useless bins + frappe.db.sql("delete from `tabBin` where item_code is null or warehouse is null") + + +def delete_and_patch_duplicate_bins(): + + duplicate_bins = frappe.db.sql( + """ + SELECT + item_code, warehouse, count(*) as bin_count + FROM + tabBin + GROUP BY + item_code, warehouse + HAVING + bin_count > 1 + """, + as_dict=1, + ) + + for duplicate_bin in duplicate_bins: + item_code = duplicate_bin.item_code + warehouse = duplicate_bin.warehouse + existing_bins = frappe.get_list( + "Bin", + filters={"item_code": item_code, "warehouse": warehouse}, + fields=["name"], + order_by="creation", + ) + + # keep last one + existing_bins.pop() + + for broken_bin in existing_bins: + frappe.delete_doc("Bin", broken_bin.name) + + qty_dict = { + "reserved_qty": get_reserved_qty(item_code, warehouse), + "indented_qty": get_indented_qty(item_code, warehouse), + "ordered_qty": get_ordered_qty(item_code, warehouse), + "planned_qty": get_planned_qty(item_code, warehouse), + "actual_qty": get_balance_qty_from_sle(item_code, warehouse), + } + + bin = get_bin(item_code, warehouse) + bin.update(qty_dict) + bin.update_reserved_qty_for_production() + bin.update_reserved_qty_for_sub_contracting() + bin.db_update() diff --git a/erpnext/patches/v13_0/add_cost_center_in_loans.py b/erpnext/patches/v13_0/add_cost_center_in_loans.py new file mode 100644 index 00000000000..e293cf2874e --- /dev/null +++ b/erpnext/patches/v13_0/add_cost_center_in_loans.py @@ -0,0 +1,12 @@ +import frappe + + +def execute(): + frappe.reload_doc("loan_management", "doctype", "loan") + loan = frappe.qb.DocType("Loan") + + for company in frappe.get_all("Company", pluck="name"): + default_cost_center = frappe.db.get_value("Company", company, "cost_center") + frappe.qb.update(loan).set(loan.cost_center, default_cost_center).where( + loan.company == company + ).run() diff --git a/erpnext/patches/v13_0/add_custom_field_for_south_africa.py b/erpnext/patches/v13_0/add_custom_field_for_south_africa.py index b34b5c1801f..353376b6038 100644 --- a/erpnext/patches/v13_0/add_custom_field_for_south_africa.py +++ b/erpnext/patches/v13_0/add_custom_field_for_south_africa.py @@ -7,13 +7,13 @@ from erpnext.regional.south_africa.setup import add_permissions, make_custom_fie def execute(): - company = frappe.get_all('Company', filters = {'country': 'South Africa'}) + company = frappe.get_all("Company", filters={"country": "South Africa"}) if not company: return - frappe.reload_doc('regional', 'doctype', 'south_africa_vat_settings') - frappe.reload_doc('regional', 'report', 'vat_audit_report') - frappe.reload_doc('accounts', 'doctype', 'south_africa_vat_account') + frappe.reload_doc("regional", "doctype", "south_africa_vat_settings") + frappe.reload_doc("regional", "report", "vat_audit_report") + frappe.reload_doc("accounts", "doctype", "south_africa_vat_account") make_custom_fields() add_permissions() diff --git a/erpnext/patches/v13_0/add_default_interview_notification_templates.py b/erpnext/patches/v13_0/add_default_interview_notification_templates.py index 8d9f5cc89b5..9a47efe8704 100644 --- a/erpnext/patches/v13_0/add_default_interview_notification_templates.py +++ b/erpnext/patches/v13_0/add_default_interview_notification_templates.py @@ -1,4 +1,3 @@ - import os import frappe @@ -6,31 +5,40 @@ from frappe import _ def execute(): - if not frappe.db.exists('Email Template', _('Interview Reminder')): - base_path = frappe.get_app_path('erpnext', 'hr', 'doctype') - response = frappe.read_file(os.path.join(base_path, 'interview/interview_reminder_notification_template.html')) + if not frappe.db.exists("Email Template", _("Interview Reminder")): + base_path = frappe.get_app_path("erpnext", "hr", "doctype") + response = frappe.read_file( + os.path.join(base_path, "interview/interview_reminder_notification_template.html") + ) - frappe.get_doc({ - 'doctype': 'Email Template', - 'name': _('Interview Reminder'), - 'response': response, - 'subject': _('Interview Reminder'), - 'owner': frappe.session.user, - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Email Template", + "name": _("Interview Reminder"), + "response": response, + "subject": _("Interview Reminder"), + "owner": frappe.session.user, + } + ).insert(ignore_permissions=True) - if not frappe.db.exists('Email Template', _('Interview Feedback Reminder')): - base_path = frappe.get_app_path('erpnext', 'hr', 'doctype') - response = frappe.read_file(os.path.join(base_path, 'interview/interview_feedback_reminder_template.html')) + if not frappe.db.exists("Email Template", _("Interview Feedback Reminder")): + base_path = frappe.get_app_path("erpnext", "hr", "doctype") + response = frappe.read_file( + os.path.join(base_path, "interview/interview_feedback_reminder_template.html") + ) - frappe.get_doc({ - 'doctype': 'Email Template', - 'name': _('Interview Feedback Reminder'), - 'response': response, - 'subject': _('Interview Feedback Reminder'), - 'owner': frappe.session.user, - }).insert(ignore_permissions=True) + frappe.get_doc( + { + "doctype": "Email Template", + "name": _("Interview Feedback Reminder"), + "response": response, + "subject": _("Interview Feedback Reminder"), + "owner": frappe.session.user, + } + ).insert(ignore_permissions=True) - hr_settings = frappe.get_doc('HR Settings') - hr_settings.interview_reminder_template = _('Interview Reminder') - hr_settings.feedback_reminder_notification_template = _('Interview Feedback Reminder') + hr_settings = frappe.get_doc("HR Settings") + hr_settings.interview_reminder_template = _("Interview Reminder") + hr_settings.feedback_reminder_notification_template = _("Interview Feedback Reminder") + hr_settings.flags.ignore_links = True hr_settings.save() diff --git a/erpnext/patches/v13_0/add_missing_fg_item_for_stock_entry.py b/erpnext/patches/v13_0/add_missing_fg_item_for_stock_entry.py index bd18b9bd173..517a14a8300 100644 --- a/erpnext/patches/v13_0/add_missing_fg_item_for_stock_entry.py +++ b/erpnext/patches/v13_0/add_missing_fg_item_for_stock_entry.py @@ -9,31 +9,34 @@ from erpnext.stock.stock_ledger import make_sl_entries def execute(): - if not frappe.db.has_column('Work Order', 'has_batch_no'): + if not frappe.db.has_column("Work Order", "has_batch_no"): return - frappe.reload_doc('manufacturing', 'doctype', 'manufacturing_settings') - if cint(frappe.db.get_single_value('Manufacturing Settings', 'make_serial_no_batch_from_work_order')): + frappe.reload_doc("manufacturing", "doctype", "manufacturing_settings") + if cint( + frappe.db.get_single_value("Manufacturing Settings", "make_serial_no_batch_from_work_order") + ): return - frappe.reload_doc('manufacturing', 'doctype', 'work_order') + frappe.reload_doc("manufacturing", "doctype", "work_order") filters = { - 'docstatus': 1, - 'produced_qty': ('>', 0), - 'creation': ('>=', '2021-06-29 00:00:00'), - 'has_batch_no': 1 + "docstatus": 1, + "produced_qty": (">", 0), + "creation": (">=", "2021-06-29 00:00:00"), + "has_batch_no": 1, } - fields = ['name', 'production_item'] + fields = ["name", "production_item"] - work_orders = [d.name for d in frappe.get_all('Work Order', filters = filters, fields=fields)] + work_orders = [d.name for d in frappe.get_all("Work Order", filters=filters, fields=fields)] if not work_orders: return repost_stock_entries = [] - stock_entries = frappe.db.sql_list(''' + stock_entries = frappe.db.sql_list( + """ SELECT se.name FROM @@ -45,18 +48,20 @@ def execute(): ) ORDER BY se.posting_date, se.posting_time - ''', (work_orders,)) + """, + (work_orders,), + ) if stock_entries: - print('Length of stock entries', len(stock_entries)) + print("Length of stock entries", len(stock_entries)) for stock_entry in stock_entries: - doc = frappe.get_doc('Stock Entry', stock_entry) + doc = frappe.get_doc("Stock Entry", stock_entry) doc.set_work_order_details() doc.load_items_from_bom() doc.calculate_rate_and_amount() set_expense_account(doc) - doc.make_batches('t_warehouse') + doc.make_batches("t_warehouse") if doc.docstatus == 0: doc.save() @@ -67,10 +72,14 @@ def execute(): for repost_doc in repost_stock_entries: repost_future_sle_and_gle(repost_doc) + def set_expense_account(doc): for row in doc.items: if row.is_finished_item and not row.expense_account: - row.expense_account = frappe.get_cached_value('Company', doc.company, 'stock_adjustment_account') + row.expense_account = frappe.get_cached_value( + "Company", doc.company, "stock_adjustment_account" + ) + def repost_stock_entry(doc): doc.db_update() @@ -86,29 +95,36 @@ def repost_stock_entry(doc): try: make_sl_entries(sl_entries, True) except Exception: - print(f'SLE entries not posted for the stock entry {doc.name}') + print(f"SLE entries not posted for the stock entry {doc.name}") traceback = frappe.get_traceback() frappe.log_error(traceback) + def get_sle_for_target_warehouse(doc, sl_entries, finished_item_row): - for d in doc.get('items'): + for d in doc.get("items"): if cstr(d.t_warehouse) and finished_item_row and d.name == finished_item_row.name: - sle = doc.get_sl_entries(d, { - "warehouse": cstr(d.t_warehouse), - "actual_qty": flt(d.transfer_qty), - "incoming_rate": flt(d.valuation_rate) - }) + sle = doc.get_sl_entries( + d, + { + "warehouse": cstr(d.t_warehouse), + "actual_qty": flt(d.transfer_qty), + "incoming_rate": flt(d.valuation_rate), + }, + ) sle.recalculate_rate = 1 sl_entries.append(sle) + def repost_future_sle_and_gle(doc): - args = frappe._dict({ - "posting_date": doc.posting_date, - "posting_time": doc.posting_time, - "voucher_type": doc.doctype, - "voucher_no": doc.name, - "company": doc.company - }) + args = frappe._dict( + { + "posting_date": doc.posting_date, + "posting_time": doc.posting_time, + "voucher_type": doc.doctype, + "voucher_no": doc.name, + "company": doc.company, + } + ) create_repost_item_valuation_entry(args) diff --git a/erpnext/patches/v13_0/add_naming_series_to_old_projects.py b/erpnext/patches/v13_0/add_naming_series_to_old_projects.py index 3bf2762456e..7dce95c1b82 100644 --- a/erpnext/patches/v13_0/add_naming_series_to_old_projects.py +++ b/erpnext/patches/v13_0/add_naming_series_to_old_projects.py @@ -1,12 +1,13 @@ - import frappe def execute(): frappe.reload_doc("projects", "doctype", "project") - frappe.db.sql("""UPDATE `tabProject` + frappe.db.sql( + """UPDATE `tabProject` SET naming_series = 'PROJ-.####' WHERE - naming_series is NULL""") + naming_series is NULL""" + ) diff --git a/erpnext/patches/v13_0/add_po_to_global_search.py b/erpnext/patches/v13_0/add_po_to_global_search.py index 396d3343ba6..514cd343900 100644 --- a/erpnext/patches/v13_0/add_po_to_global_search.py +++ b/erpnext/patches/v13_0/add_po_to_global_search.py @@ -1,17 +1,14 @@ - import frappe def execute(): - global_search_settings = frappe.get_single("Global Search Settings") + global_search_settings = frappe.get_single("Global Search Settings") - if "Purchase Order" in ( - dt.document_type for dt in global_search_settings.allowed_in_global_search - ): - return + if "Purchase Order" in ( + dt.document_type for dt in global_search_settings.allowed_in_global_search + ): + return - global_search_settings.append( - "allowed_in_global_search", {"document_type": "Purchase Order"} - ) + global_search_settings.append("allowed_in_global_search", {"document_type": "Purchase Order"}) - global_search_settings.save(ignore_permissions=True) + global_search_settings.save(ignore_permissions=True) diff --git a/erpnext/patches/v13_0/add_standard_navbar_items.py b/erpnext/patches/v13_0/add_standard_navbar_items.py index c739a7a93f9..24141b7862d 100644 --- a/erpnext/patches/v13_0/add_standard_navbar_items.py +++ b/erpnext/patches/v13_0/add_standard_navbar_items.py @@ -1,4 +1,3 @@ - # import frappe from erpnext.setup.install import add_standard_navbar_items diff --git a/erpnext/patches/v13_0/agriculture_deprecation_warning.py b/erpnext/patches/v13_0/agriculture_deprecation_warning.py new file mode 100644 index 00000000000..09ccfb3ea47 --- /dev/null +++ b/erpnext/patches/v13_0/agriculture_deprecation_warning.py @@ -0,0 +1,10 @@ +import click + + +def execute(): + + click.secho( + "Agriculture Domain is moved to a separate app and will be removed from ERPNext in version-14.\n" + "When upgrading to ERPNext version-14, please install the app to continue using the Agriculture domain: https://github.com/frappe/agriculture", + fg="yellow", + ) diff --git a/erpnext/patches/v13_0/amazon_mws_deprecation_warning.py b/erpnext/patches/v13_0/amazon_mws_deprecation_warning.py new file mode 100644 index 00000000000..cc424c6d3e0 --- /dev/null +++ b/erpnext/patches/v13_0/amazon_mws_deprecation_warning.py @@ -0,0 +1,15 @@ +import click +import frappe + + +def execute(): + + frappe.reload_doc("erpnext_integrations", "doctype", "amazon_mws_settings") + if not frappe.db.get_single_value("Amazon MWS Settings", "enable_amazon"): + return + + click.secho( + "Amazon MWS Integration is moved to a separate app and will be removed from ERPNext in version-14.\n" + "Please install the app to continue using the integration: https://github.com/frappe/ecommerce_integrations", + fg="yellow", + ) diff --git a/erpnext/patches/v13_0/bill_for_rejected_quantity_in_purchase_invoice.py b/erpnext/patches/v13_0/bill_for_rejected_quantity_in_purchase_invoice.py index a95f822d281..ee23747cc04 100644 --- a/erpnext/patches/v13_0/bill_for_rejected_quantity_in_purchase_invoice.py +++ b/erpnext/patches/v13_0/bill_for_rejected_quantity_in_purchase_invoice.py @@ -1,4 +1,3 @@ - import frappe diff --git a/erpnext/patches/v13_0/change_default_item_manufacturer_fieldtype.py b/erpnext/patches/v13_0/change_default_item_manufacturer_fieldtype.py new file mode 100644 index 00000000000..0b00188e6a8 --- /dev/null +++ b/erpnext/patches/v13_0/change_default_item_manufacturer_fieldtype.py @@ -0,0 +1,16 @@ +import frappe + + +def execute(): + + # Erase all default item manufacturers that dont exist. + item = frappe.qb.DocType("Item") + manufacturer = frappe.qb.DocType("Manufacturer") + + ( + frappe.qb.update(item) + .set(item.default_item_manufacturer, None) + .left_join(manufacturer) + .on(item.default_item_manufacturer == manufacturer.name) + .where(manufacturer.name.isnull() & item.default_item_manufacturer.isnotnull()) + ).run() diff --git a/erpnext/patches/v13_0/change_default_pos_print_format.py b/erpnext/patches/v13_0/change_default_pos_print_format.py index 9664247ab41..be478a2b67f 100644 --- a/erpnext/patches/v13_0/change_default_pos_print_format.py +++ b/erpnext/patches/v13_0/change_default_pos_print_format.py @@ -1,4 +1,3 @@ - import frappe @@ -6,4 +5,5 @@ def execute(): frappe.db.sql( """UPDATE `tabPOS Profile` profile SET profile.`print_format` = 'POS Invoice' - WHERE profile.`print_format` = 'Point of Sale'""") + WHERE profile.`print_format` = 'Point of Sale'""" + ) diff --git a/erpnext/patches/v13_0/check_is_income_tax_component.py b/erpnext/patches/v13_0/check_is_income_tax_component.py index 5e1df14d4e0..0ae3a3e3bd7 100644 --- a/erpnext/patches/v13_0/check_is_income_tax_component.py +++ b/erpnext/patches/v13_0/check_is_income_tax_component.py @@ -10,33 +10,36 @@ import erpnext def execute(): - doctypes = ['salary_component', - 'Employee Tax Exemption Declaration', - 'Employee Tax Exemption Proof Submission', - 'Employee Tax Exemption Declaration Category', - 'Employee Tax Exemption Proof Submission Detail', - 'gratuity_rule', - 'gratuity_rule_slab', - 'gratuity_applicable_component' + doctypes = [ + "salary_component", + "Employee Tax Exemption Declaration", + "Employee Tax Exemption Proof Submission", + "Employee Tax Exemption Declaration Category", + "Employee Tax Exemption Proof Submission Detail", + "gratuity_rule", + "gratuity_rule_slab", + "gratuity_applicable_component", ] for doctype in doctypes: - frappe.reload_doc('Payroll', 'doctype', doctype, force=True) + frappe.reload_doc("Payroll", "doctype", doctype, force=True) - - reports = ['Professional Tax Deductions', 'Provident Fund Deductions', 'E-Invoice Summary'] + reports = ["Professional Tax Deductions", "Provident Fund Deductions", "E-Invoice Summary"] for report in reports: - frappe.reload_doc('Regional', 'Report', report) - frappe.reload_doc('Regional', 'Report', report) + frappe.reload_doc("Regional", "Report", report) + frappe.reload_doc("Regional", "Report", report) if erpnext.get_region() == "India": - create_custom_field('Salary Component', - dict(fieldname='component_type', - label='Component Type', - fieldtype='Select', - insert_after='description', - options='\nProvident Fund\nAdditional Provident Fund\nProvident Fund Loan\nProfessional Tax', - depends_on='eval:doc.type == "Deduction"') + create_custom_field( + "Salary Component", + dict( + fieldname="component_type", + label="Component Type", + fieldtype="Select", + insert_after="description", + options="\nProvident Fund\nAdditional Provident Fund\nProvident Fund Loan\nProfessional Tax", + depends_on='eval:doc.type == "Deduction"', + ), ) if frappe.db.exists("Salary Component", "Income Tax"): @@ -44,7 +47,9 @@ def execute(): if frappe.db.exists("Salary Component", "TDS"): frappe.db.set_value("Salary Component", "TDS", "is_income_tax_component", 1) - components = frappe.db.sql("select name from `tabSalary Component` where variable_based_on_taxable_salary = 1", as_dict=1) + components = frappe.db.sql( + "select name from `tabSalary Component` where variable_based_on_taxable_salary = 1", as_dict=1 + ) for component in components: frappe.db.set_value("Salary Component", component.name, "is_income_tax_component", 1) @@ -52,4 +57,6 @@ def execute(): if frappe.db.exists("Salary Component", "Provident Fund"): frappe.db.set_value("Salary Component", "Provident Fund", "component_type", "Provident Fund") if frappe.db.exists("Salary Component", "Professional Tax"): - frappe.db.set_value("Salary Component", "Professional Tax", "component_type", "Professional Tax") + frappe.db.set_value( + "Salary Component", "Professional Tax", "component_type", "Professional Tax" + ) diff --git a/erpnext/patches/v13_0/convert_qi_parameter_to_link_field.py b/erpnext/patches/v13_0/convert_qi_parameter_to_link_field.py index 7ef154e6066..efbb96c100a 100644 --- a/erpnext/patches/v13_0/convert_qi_parameter_to_link_field.py +++ b/erpnext/patches/v13_0/convert_qi_parameter_to_link_field.py @@ -1,24 +1,25 @@ - import frappe def execute(): - frappe.reload_doc('stock', 'doctype', 'quality_inspection_parameter') + frappe.reload_doc("stock", "doctype", "quality_inspection_parameter") # get all distinct parameters from QI readigs table - reading_params = frappe.db.get_all("Quality Inspection Reading", fields=["distinct specification"]) + reading_params = frappe.db.get_all( + "Quality Inspection Reading", fields=["distinct specification"] + ) reading_params = [d.specification for d in reading_params] # get all distinct parameters from QI Template as some may be unused in QI - template_params = frappe.db.get_all("Item Quality Inspection Parameter", fields=["distinct specification"]) + template_params = frappe.db.get_all( + "Item Quality Inspection Parameter", fields=["distinct specification"] + ) template_params = [d.specification for d in template_params] params = list(set(reading_params + template_params)) for parameter in params: if not frappe.db.exists("Quality Inspection Parameter", parameter): - frappe.get_doc({ - "doctype": "Quality Inspection Parameter", - "parameter": parameter, - "description": parameter - }).insert(ignore_permissions=True) + frappe.get_doc( + {"doctype": "Quality Inspection Parameter", "parameter": parameter, "description": parameter} + ).insert(ignore_permissions=True) diff --git a/erpnext/patches/v13_0/convert_to_website_item_in_item_card_group_template.py b/erpnext/patches/v13_0/convert_to_website_item_in_item_card_group_template.py new file mode 100644 index 00000000000..020521d5b95 --- /dev/null +++ b/erpnext/patches/v13_0/convert_to_website_item_in_item_card_group_template.py @@ -0,0 +1,63 @@ +import json +from typing import List, Union + +import frappe + +from erpnext.e_commerce.doctype.website_item.website_item import make_website_item + + +def execute(): + """ + Convert all Item links to Website Item link values in + exisitng 'Item Card Group' Web Page Block data. + """ + frappe.reload_doc("e_commerce", "web_template", "item_card_group") + + blocks = frappe.db.get_all( + "Web Page Block", + filters={"web_template": "Item Card Group"}, + fields=["parent", "web_template_values", "name"], + ) + + fields = generate_fields_to_edit() + + for block in blocks: + web_template_value = json.loads(block.get("web_template_values")) + + for field in fields: + item = web_template_value.get(field) + if not item: + continue + + if frappe.db.exists("Website Item", {"item_code": item}): + website_item = frappe.db.get_value("Website Item", {"item_code": item}) + else: + website_item = make_new_website_item(item) + + if website_item: + web_template_value[field] = website_item + + frappe.db.set_value( + "Web Page Block", block.name, "web_template_values", json.dumps(web_template_value) + ) + + +def generate_fields_to_edit() -> List: + fields = [] + for i in range(1, 13): + fields.append(f"card_{i}_item") # fields like 'card_1_item', etc. + + return fields + + +def make_new_website_item(item: str) -> Union[str, None]: + try: + doc = frappe.get_doc("Item", item) + web_item = make_website_item(doc) # returns [website_item.name, item_name] + return web_item[0] + except Exception: + title = f"{item}: Error while converting to Website Item " + frappe.log_error( + title + "for Item Card Group Template" + "\n\n" + frappe.get_traceback(), title=title + ) + return None diff --git a/erpnext/patches/v13_0/copy_custom_field_filters_to_website_item.py b/erpnext/patches/v13_0/copy_custom_field_filters_to_website_item.py new file mode 100644 index 00000000000..e8d0b593e6f --- /dev/null +++ b/erpnext/patches/v13_0/copy_custom_field_filters_to_website_item.py @@ -0,0 +1,94 @@ +import frappe +from frappe.custom.doctype.custom_field.custom_field import create_custom_field + + +def execute(): + "Add Field Filters, that are not standard fields in Website Item, as Custom Fields." + + def move_table_multiselect_data(docfield): + "Copy child table data (Table Multiselect) from Item to Website Item for a docfield." + table_multiselect_data = get_table_multiselect_data(docfield) + field = docfield.fieldname + + for row in table_multiselect_data: + # add copied multiselect data rows in Website Item + web_item = frappe.db.get_value("Website Item", {"item_code": row.parent}) + web_item_doc = frappe.get_doc("Website Item", web_item) + + child_doc = frappe.new_doc(docfield.options, web_item_doc, field) + + for field in ["name", "creation", "modified", "idx"]: + row[field] = None + + child_doc.update(row) + + child_doc.parenttype = "Website Item" + child_doc.parent = web_item + + child_doc.insert() + + def get_table_multiselect_data(docfield): + child_table = frappe.qb.DocType(docfield.options) + item = frappe.qb.DocType("Item") + + table_multiselect_data = ( # query table data for field + frappe.qb.from_(child_table) + .join(item) + .on(item.item_code == child_table.parent) + .select(child_table.star) + .where((child_table.parentfield == docfield.fieldname) & (item.published_in_website == 1)) + ).run(as_dict=True) + + return table_multiselect_data + + settings = frappe.get_doc("E Commerce Settings") + + if not (settings.enable_field_filters or settings.filter_fields): + return + + item_meta = frappe.get_meta("Item") + valid_item_fields = [ + df.fieldname for df in item_meta.fields if df.fieldtype in ["Link", "Table MultiSelect"] + ] + + web_item_meta = frappe.get_meta("Website Item") + valid_web_item_fields = [ + df.fieldname for df in web_item_meta.fields if df.fieldtype in ["Link", "Table MultiSelect"] + ] + + for row in settings.filter_fields: + # skip if illegal field + if row.fieldname not in valid_item_fields: + continue + + # if Item field is not in Website Item, add it as a custom field + if row.fieldname not in valid_web_item_fields: + df = item_meta.get_field(row.fieldname) + create_custom_field( + "Website Item", + dict( + owner="Administrator", + fieldname=df.fieldname, + label=df.label, + fieldtype=df.fieldtype, + options=df.options, + description=df.description, + read_only=df.read_only, + no_copy=df.no_copy, + insert_after="on_backorder", + ), + ) + + # map field values + if df.fieldtype == "Table MultiSelect": + move_table_multiselect_data(df) + else: + frappe.db.sql( # nosemgrep + """ + UPDATE `tabWebsite Item` wi, `tabItem` i + SET wi.{0} = i.{0} + WHERE wi.item_code = i.item_code + """.format( + row.fieldname + ) + ) diff --git a/erpnext/patches/v13_0/create_accounting_dimensions_for_asset_repair.py b/erpnext/patches/v13_0/create_accounting_dimensions_for_asset_repair.py new file mode 100644 index 00000000000..61a5c86386c --- /dev/null +++ b/erpnext/patches/v13_0/create_accounting_dimensions_for_asset_repair.py @@ -0,0 +1,29 @@ +import frappe +from frappe.custom.doctype.custom_field.custom_field import create_custom_field + + +def execute(): + accounting_dimensions = frappe.db.get_all( + "Accounting Dimension", fields=["fieldname", "label", "document_type", "disabled"] + ) + + if not accounting_dimensions: + return + + for d in accounting_dimensions: + doctype = "Asset Repair" + field = frappe.db.get_value("Custom Field", {"dt": doctype, "fieldname": d.fieldname}) + + if field: + continue + + df = { + "fieldname": d.fieldname, + "label": d.label, + "fieldtype": "Link", + "options": d.document_type, + "insert_after": "accounting_dimensions_section", + } + + create_custom_field(doctype, df, ignore_validate=True) + frappe.clear_cache(doctype=doctype) diff --git a/erpnext/patches/v13_0/create_accounting_dimensions_in_orders.py b/erpnext/patches/v13_0/create_accounting_dimensions_in_orders.py new file mode 100644 index 00000000000..8e6bce66fe4 --- /dev/null +++ b/erpnext/patches/v13_0/create_accounting_dimensions_in_orders.py @@ -0,0 +1,42 @@ +import frappe +from frappe.custom.doctype.custom_field.custom_field import create_custom_field + + +def execute(): + accounting_dimensions = frappe.db.get_all( + "Accounting Dimension", fields=["fieldname", "label", "document_type", "disabled"] + ) + + if not accounting_dimensions: + return + + count = 1 + for d in accounting_dimensions: + + if count % 2 == 0: + insert_after_field = "dimension_col_break" + else: + insert_after_field = "accounting_dimensions_section" + + for doctype in ["Purchase Order", "Purchase Receipt", "Sales Order"]: + + field = frappe.db.get_value("Custom Field", {"dt": doctype, "fieldname": d.fieldname}) + + if field: + continue + + df = { + "fieldname": d.fieldname, + "label": d.label, + "fieldtype": "Link", + "options": d.document_type, + "insert_after": insert_after_field, + } + + try: + create_custom_field(doctype, df, ignore_validate=True) + frappe.clear_cache(doctype=doctype) + except Exception as e: + pass + + count += 1 diff --git a/erpnext/patches/v13_0/create_accounting_dimensions_in_pos_doctypes.py b/erpnext/patches/v13_0/create_accounting_dimensions_in_pos_doctypes.py index 44501088102..51ab0e8b65c 100644 --- a/erpnext/patches/v13_0/create_accounting_dimensions_in_pos_doctypes.py +++ b/erpnext/patches/v13_0/create_accounting_dimensions_in_pos_doctypes.py @@ -3,9 +3,12 @@ from frappe.custom.doctype.custom_field.custom_field import create_custom_field def execute(): - frappe.reload_doc('accounts', 'doctype', 'accounting_dimension') - accounting_dimensions = frappe.db.sql("""select fieldname, label, document_type, disabled from - `tabAccounting Dimension`""", as_dict=1) + frappe.reload_doc("accounts", "doctype", "accounting_dimension") + accounting_dimensions = frappe.db.sql( + """select fieldname, label, document_type, disabled from + `tabAccounting Dimension`""", + as_dict=1, + ) if not accounting_dimensions: return @@ -14,9 +17,9 @@ def execute(): for d in accounting_dimensions: if count % 2 == 0: - insert_after_field = 'dimension_col_break' + insert_after_field = "dimension_col_break" else: - insert_after_field = 'accounting_dimensions_section' + insert_after_field = "accounting_dimensions_section" for doctype in ["POS Invoice", "POS Invoice Item"]: @@ -32,10 +35,10 @@ def execute(): "label": d.label, "fieldtype": "Link", "options": d.document_type, - "insert_after": insert_after_field + "insert_after": insert_after_field, } - if df['fieldname'] not in fieldnames: + if df["fieldname"] not in fieldnames: create_custom_field(doctype, df) frappe.clear_cache(doctype=doctype) diff --git a/erpnext/patches/v13_0/create_custom_field_for_finance_book.py b/erpnext/patches/v13_0/create_custom_field_for_finance_book.py index 313b0e9a2eb..2b8666d21b6 100644 --- a/erpnext/patches/v13_0/create_custom_field_for_finance_book.py +++ b/erpnext/patches/v13_0/create_custom_field_for_finance_book.py @@ -3,18 +3,18 @@ from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return custom_field = { - 'Finance Book': [ + "Finance Book": [ { - 'fieldname': 'for_income_tax', - 'label': 'For Income Tax', - 'fieldtype': 'Check', - 'insert_after': 'finance_book_name', - 'description': 'If the asset is put to use for less than 180 days, the first Depreciation Rate will be reduced by 50%.' + "fieldname": "for_income_tax", + "label": "For Income Tax", + "fieldtype": "Check", + "insert_after": "finance_book_name", + "description": "If the asset is put to use for less than 180 days, the first Depreciation Rate will be reduced by 50%.", } ] } diff --git a/erpnext/patches/v13_0/create_gst_custom_fields_in_quotation.py b/erpnext/patches/v13_0/create_gst_custom_fields_in_quotation.py new file mode 100644 index 00000000000..3217eab43d6 --- /dev/null +++ b/erpnext/patches/v13_0/create_gst_custom_fields_in_quotation.py @@ -0,0 +1,53 @@ +import frappe +from frappe.custom.doctype.custom_field.custom_field import create_custom_fields + + +def execute(): + company = frappe.get_all("Company", filters={"country": "India"}, fields=["name"]) + if not company: + return + + sales_invoice_gst_fields = [ + dict( + fieldname="billing_address_gstin", + label="Billing Address GSTIN", + fieldtype="Data", + insert_after="customer_address", + read_only=1, + fetch_from="customer_address.gstin", + print_hide=1, + length=15, + ), + dict( + fieldname="customer_gstin", + label="Customer GSTIN", + fieldtype="Data", + insert_after="shipping_address_name", + fetch_from="shipping_address_name.gstin", + print_hide=1, + length=15, + ), + dict( + fieldname="place_of_supply", + label="Place of Supply", + fieldtype="Data", + insert_after="customer_gstin", + print_hide=1, + read_only=1, + length=50, + ), + dict( + fieldname="company_gstin", + label="Company GSTIN", + fieldtype="Data", + insert_after="company_address", + fetch_from="company_address.gstin", + print_hide=1, + read_only=1, + length=15, + ), + ] + + custom_fields = {"Quotation": sales_invoice_gst_fields} + + create_custom_fields(custom_fields, update=True) diff --git a/erpnext/patches/v13_0/create_gst_payment_entry_fields.py b/erpnext/patches/v13_0/create_gst_payment_entry_fields.py index 416694559cb..bef2516f6d0 100644 --- a/erpnext/patches/v13_0/create_gst_payment_entry_fields.py +++ b/erpnext/patches/v13_0/create_gst_payment_entry_fields.py @@ -6,32 +6,75 @@ from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): - frappe.reload_doc('accounts', 'doctype', 'advance_taxes_and_charges') - frappe.reload_doc('accounts', 'doctype', 'payment_entry') + frappe.reload_doc("accounts", "doctype", "advance_taxes_and_charges") + frappe.reload_doc("accounts", "doctype", "payment_entry") - if frappe.db.exists('Company', {'country': 'India'}): + if frappe.db.exists("Company", {"country": "India"}): custom_fields = { - 'Payment Entry': [ - dict(fieldname='gst_section', label='GST Details', fieldtype='Section Break', insert_after='deductions', - print_hide=1, collapsible=1), - dict(fieldname='company_address', label='Company Address', fieldtype='Link', insert_after='gst_section', - print_hide=1, options='Address'), - dict(fieldname='company_gstin', label='Company GSTIN', - fieldtype='Data', insert_after='company_address', - fetch_from='company_address.gstin', print_hide=1, read_only=1), - dict(fieldname='place_of_supply', label='Place of Supply', - fieldtype='Data', insert_after='company_gstin', - print_hide=1, read_only=1), - dict(fieldname='customer_address', label='Customer Address', fieldtype='Link', insert_after='place_of_supply', - print_hide=1, options='Address', depends_on = 'eval:doc.party_type == "Customer"'), - dict(fieldname='customer_gstin', label='Customer GSTIN', - fieldtype='Data', insert_after='customer_address', - fetch_from='customer_address.gstin', print_hide=1, read_only=1) + "Payment Entry": [ + dict( + fieldname="gst_section", + label="GST Details", + fieldtype="Section Break", + insert_after="deductions", + print_hide=1, + collapsible=1, + ), + dict( + fieldname="company_address", + label="Company Address", + fieldtype="Link", + insert_after="gst_section", + print_hide=1, + options="Address", + ), + dict( + fieldname="company_gstin", + label="Company GSTIN", + fieldtype="Data", + insert_after="company_address", + fetch_from="company_address.gstin", + print_hide=1, + read_only=1, + ), + dict( + fieldname="place_of_supply", + label="Place of Supply", + fieldtype="Data", + insert_after="company_gstin", + print_hide=1, + read_only=1, + ), + dict( + fieldname="customer_address", + label="Customer Address", + fieldtype="Link", + insert_after="place_of_supply", + print_hide=1, + options="Address", + depends_on='eval:doc.party_type == "Customer"', + ), + dict( + fieldname="customer_gstin", + label="Customer GSTIN", + fieldtype="Data", + insert_after="customer_address", + fetch_from="customer_address.gstin", + print_hide=1, + read_only=1, + ), ] } create_custom_fields(custom_fields, update=True) else: - fields = ['gst_section', 'company_address', 'company_gstin', 'place_of_supply', 'customer_address', 'customer_gstin'] + fields = [ + "gst_section", + "company_address", + "company_gstin", + "place_of_supply", + "customer_address", + "customer_gstin", + ] for field in fields: - frappe.delete_doc_if_exists("Custom Field", f"Payment Entry-{field}") \ No newline at end of file + frappe.delete_doc_if_exists("Custom Field", f"Payment Entry-{field}") diff --git a/erpnext/patches/v13_0/create_healthcare_custom_fields_in_stock_entry_detail.py b/erpnext/patches/v13_0/create_healthcare_custom_fields_in_stock_entry_detail.py index 543faeb74ac..3fe27b5c1a9 100644 --- a/erpnext/patches/v13_0/create_healthcare_custom_fields_in_stock_entry_detail.py +++ b/erpnext/patches/v13_0/create_healthcare_custom_fields_in_stock_entry_detail.py @@ -5,8 +5,8 @@ from erpnext.domains.healthcare import data def execute(): - if 'Healthcare' not in frappe.get_active_domains(): + if "Healthcare" not in frappe.get_active_domains(): return - if data['custom_fields']: - create_custom_fields(data['custom_fields']) + if data["custom_fields"]: + create_custom_fields(data["custom_fields"]) diff --git a/erpnext/patches/v13_0/create_ksa_vat_custom_fields.py b/erpnext/patches/v13_0/create_ksa_vat_custom_fields.py index f33b4b3ea0d..093463a12e9 100644 --- a/erpnext/patches/v13_0/create_ksa_vat_custom_fields.py +++ b/erpnext/patches/v13_0/create_ksa_vat_custom_fields.py @@ -4,9 +4,8 @@ from erpnext.regional.saudi_arabia.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'Saudi Arabia'}) + company = frappe.get_all("Company", filters={"country": "Saudi Arabia"}) if not company: return make_custom_fields() - diff --git a/erpnext/patches/v13_0/create_leave_policy_assignment_based_on_employee_current_leave_policy.py b/erpnext/patches/v13_0/create_leave_policy_assignment_based_on_employee_current_leave_policy.py deleted file mode 100644 index 55125431b52..00000000000 --- a/erpnext/patches/v13_0/create_leave_policy_assignment_based_on_employee_current_leave_policy.py +++ /dev/null @@ -1,76 +0,0 @@ -# Copyright (c) 2019, Frappe and Contributors -# License: GNU General Public License v3. See license.txt - - -import frappe - - -def execute(): - if "leave_policy" in frappe.db.get_table_columns("Employee"): - employees_with_leave_policy = frappe.db.sql("SELECT name, leave_policy FROM `tabEmployee` WHERE leave_policy IS NOT NULL and leave_policy != ''", as_dict = 1) - - employee_with_assignment = [] - leave_policy =[] - - #for employee - - for employee in employees_with_leave_policy: - alloc = frappe.db.exists("Leave Allocation", {"employee":employee.name, "leave_policy": employee.leave_policy, "docstatus": 1}) - if not alloc: - create_assignment(employee.name, employee.leave_policy) - - employee_with_assignment.append(employee.name) - leave_policy.append(employee.leave_policy) - - - if "default_leave_policy" in frappe.db.get_table_columns("Employee"): - employee_grade_with_leave_policy = frappe.db.sql("SELECT name, default_leave_policy FROM `tabEmployee Grade` WHERE default_leave_policy IS NOT NULL and default_leave_policy!=''", as_dict = 1) - - #for whole employee Grade - - for grade in employee_grade_with_leave_policy: - employees = get_employee_with_grade(grade.name) - for employee in employees: - - if employee not in employee_with_assignment: #Will ensure no duplicate - alloc = frappe.db.exists("Leave Allocation", {"employee":employee.name, "leave_policy": grade.default_leave_policy, "docstatus": 1}) - if not alloc: - create_assignment(employee.name, grade.default_leave_policy) - leave_policy.append(grade.default_leave_policy) - - #for old Leave allocation and leave policy from allocation, which may got updated in employee grade. - leave_allocations = frappe.db.sql("SELECT leave_policy, leave_period, employee FROM `tabLeave Allocation` WHERE leave_policy IS NOT NULL and leave_policy != '' and docstatus = 1 ", as_dict = 1) - - for allocation in leave_allocations: - if allocation.leave_policy not in leave_policy: - create_assignment(allocation.employee, allocation.leave_policy, leave_period=allocation.leave_period, - allocation_exists=True) - -def create_assignment(employee, leave_policy, leave_period=None, allocation_exists = False): - - filters = {"employee":employee, "leave_policy": leave_policy} - if leave_period: - filters["leave_period"] = leave_period - - frappe.reload_doc('hr', 'doctype', 'leave_policy_assignment') - - if not frappe.db.exists("Leave Policy Assignment" , filters): - lpa = frappe.new_doc("Leave Policy Assignment") - lpa.employee = employee - lpa.leave_policy = leave_policy - - lpa.flags.ignore_mandatory = True - if allocation_exists: - lpa.assignment_based_on = 'Leave Period' - lpa.leave_period = leave_period - lpa.leaves_allocated = 1 - - lpa.save() - if allocation_exists: - lpa.submit() - #Updating old Leave Allocation - frappe.db.sql("Update `tabLeave Allocation` set leave_policy_assignment = %s", lpa.name) - - -def get_employee_with_grade(grade): - return frappe.get_list("Employee", filters = {"grade": grade}) diff --git a/erpnext/patches/v13_0/create_uae_pos_invoice_fields.py b/erpnext/patches/v13_0/create_uae_pos_invoice_fields.py index 87c9cf1ebd5..66aae9a30af 100644 --- a/erpnext/patches/v13_0/create_uae_pos_invoice_fields.py +++ b/erpnext/patches/v13_0/create_uae_pos_invoice_fields.py @@ -8,12 +8,13 @@ from erpnext.regional.united_arab_emirates.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': ['in', ['Saudi Arabia', 'United Arab Emirates']]}) + company = frappe.get_all( + "Company", filters={"country": ["in", ["Saudi Arabia", "United Arab Emirates"]]} + ) if not company: return - - frappe.reload_doc('accounts', 'doctype', 'pos_invoice') - frappe.reload_doc('accounts', 'doctype', 'pos_invoice_item') + frappe.reload_doc("accounts", "doctype", "pos_invoice") + frappe.reload_doc("accounts", "doctype", "pos_invoice_item") make_custom_fields() diff --git a/erpnext/patches/v13_0/create_website_items.py b/erpnext/patches/v13_0/create_website_items.py index 3baa34b71c0..01c164960f5 100644 --- a/erpnext/patches/v13_0/create_website_items.py +++ b/erpnext/patches/v13_0/create_website_items.py @@ -11,14 +11,31 @@ def execute(): frappe.reload_doc("e_commerce", "doctype", "e_commerce_settings") frappe.reload_doc("stock", "doctype", "item") - item_fields = ["item_code", "item_name", "item_group", "stock_uom", "brand", "image", - "has_variants", "variant_of", "description", "weightage"] - web_fields_to_map = ["route", "slideshow", "website_image_alt", - "website_warehouse", "web_long_description", "website_content", "thumbnail"] + item_fields = [ + "item_code", + "item_name", + "item_group", + "stock_uom", + "brand", + "has_variants", + "variant_of", + "description", + "weightage", + ] + web_fields_to_map = [ + "route", + "slideshow", + "website_image_alt", + "website_warehouse", + "web_long_description", + "website_content", + "website_image", + "thumbnail", + ] # get all valid columns (fields) from Item master DB schema item_table_fields = frappe.db.sql("desc `tabItem`", as_dict=1) - item_table_fields = [d.get('Field') for d in item_table_fields] + item_table_fields = [d.get("Field") for d in item_table_fields] # prepare fields to query from Item, check if the web field exists in Item master web_query_fields = [] @@ -38,11 +55,7 @@ def execute(): # most likely a fresh installation that doesnt need this patch return - items = frappe.db.get_all( - "Item", - fields=item_fields, - or_filters=or_filters - ) + items = frappe.db.get_all("Item", fields=item_fields, or_filters=or_filters) total_count = len(items) for count, item in enumerate(items, start=1): @@ -62,11 +75,11 @@ def execute(): for doctype in ("Website Item Group", "Item Website Specification"): frappe.db.set_value( doctype, - {"parenttype": "Item", "parent": item.item_code}, # filters - {"parenttype": "Website Item", "parent": website_item.name} # value dict + {"parenttype": "Item", "parent": item.item_code}, # filters + {"parenttype": "Website Item", "parent": website_item.name}, # value dict ) - if count % 20 == 0: # commit after every 20 items + if count % 20 == 0: # commit after every 20 items frappe.db.commit() - frappe.utils.update_progress_bar('Creating Website Items', count, total_count) \ No newline at end of file + frappe.utils.update_progress_bar("Creating Website Items", count, total_count) diff --git a/erpnext/patches/v13_0/custom_fields_for_taxjar_integration.py b/erpnext/patches/v13_0/custom_fields_for_taxjar_integration.py index ed46e7a60a5..5cbd0b5fcb5 100644 --- a/erpnext/patches/v13_0/custom_fields_for_taxjar_integration.py +++ b/erpnext/patches/v13_0/custom_fields_for_taxjar_integration.py @@ -1,4 +1,3 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields @@ -6,35 +5,68 @@ from erpnext.erpnext_integrations.doctype.taxjar_settings.taxjar_settings import def execute(): - company = frappe.get_all('Company', filters = {'country': 'United States'}, fields=['name']) + company = frappe.get_all("Company", filters={"country": "United States"}, fields=["name"]) if not company: return - TAXJAR_CREATE_TRANSACTIONS = frappe.db.get_single_value("TaxJar Settings", "taxjar_create_transactions") + TAXJAR_CREATE_TRANSACTIONS = frappe.db.get_single_value( + "TaxJar Settings", "taxjar_create_transactions" + ) TAXJAR_CALCULATE_TAX = frappe.db.get_single_value("TaxJar Settings", "taxjar_calculate_tax") TAXJAR_SANDBOX_MODE = frappe.db.get_single_value("TaxJar Settings", "is_sandbox") - if (not TAXJAR_CREATE_TRANSACTIONS and not TAXJAR_CALCULATE_TAX and not TAXJAR_SANDBOX_MODE): + if not TAXJAR_CREATE_TRANSACTIONS and not TAXJAR_CALCULATE_TAX and not TAXJAR_SANDBOX_MODE: return custom_fields = { - 'Sales Invoice Item': [ - dict(fieldname='product_tax_category', fieldtype='Link', insert_after='description', options='Product Tax Category', - label='Product Tax Category', fetch_from='item_code.product_tax_category'), - dict(fieldname='tax_collectable', fieldtype='Currency', insert_after='net_amount', - label='Tax Collectable', read_only=1, options='currency'), - dict(fieldname='taxable_amount', fieldtype='Currency', insert_after='tax_collectable', - label='Taxable Amount', read_only=1, options='currency') + "Sales Invoice Item": [ + dict( + fieldname="product_tax_category", + fieldtype="Link", + insert_after="description", + options="Product Tax Category", + label="Product Tax Category", + fetch_from="item_code.product_tax_category", + ), + dict( + fieldname="tax_collectable", + fieldtype="Currency", + insert_after="net_amount", + label="Tax Collectable", + read_only=1, + options="currency", + ), + dict( + fieldname="taxable_amount", + fieldtype="Currency", + insert_after="tax_collectable", + label="Taxable Amount", + read_only=1, + options="currency", + ), ], - 'Item': [ - dict(fieldname='product_tax_category', fieldtype='Link', insert_after='item_group', options='Product Tax Category', - label='Product Tax Category') + "Item": [ + dict( + fieldname="product_tax_category", + fieldtype="Link", + insert_after="item_group", + options="Product Tax Category", + label="Product Tax Category", + ) + ], + "TaxJar Settings": [ + dict( + fieldname="company", + fieldtype="Link", + insert_after="configuration", + options="Company", + label="Company", + ) ], - 'TaxJar Settings': [ - dict(fieldname='company', fieldtype='Link', insert_after='configuration', options='Company', - label='Company') - ] } create_custom_fields(custom_fields, update=True) add_permissions() - frappe.enqueue('erpnext.erpnext_integrations.doctype.taxjar_settings.taxjar_settings.add_product_tax_categories', now=True) + frappe.enqueue( + "erpnext.erpnext_integrations.doctype.taxjar_settings.taxjar_settings.add_product_tax_categories", + now=True, + ) diff --git a/erpnext/patches/v13_0/datev_deprecation_warning.py b/erpnext/patches/v13_0/datev_deprecation_warning.py new file mode 100644 index 00000000000..bf58440a610 --- /dev/null +++ b/erpnext/patches/v13_0/datev_deprecation_warning.py @@ -0,0 +1,9 @@ +import click + + +def execute(): + click.secho( + "DATEV reports are moved to a separate app and will be removed from ERPNext in version-14.\n" + "Please install the app to continue using them: https://github.com/alyf-de/erpnext_datev", + fg="yellow", + ) diff --git a/erpnext/patches/v13_0/delete_bank_reconciliation_detail.py b/erpnext/patches/v13_0/delete_bank_reconciliation_detail.py new file mode 100644 index 00000000000..c53eb794378 --- /dev/null +++ b/erpnext/patches/v13_0/delete_bank_reconciliation_detail.py @@ -0,0 +1,14 @@ +# Copyright (c) 2019, Frappe and Contributors +# License: GNU General Public License v3. See license.txt + + +import frappe + + +def execute(): + + if frappe.db.exists("DocType", "Bank Reconciliation Detail") and frappe.db.exists( + "DocType", "Bank Clearance Detail" + ): + + frappe.delete_doc("DocType", "Bank Reconciliation Detail", force=1) diff --git a/erpnext/patches/v13_0/delete_old_bank_reconciliation_doctypes.py b/erpnext/patches/v13_0/delete_old_bank_reconciliation_doctypes.py index 2c5c577978e..3755315813f 100644 --- a/erpnext/patches/v13_0/delete_old_bank_reconciliation_doctypes.py +++ b/erpnext/patches/v13_0/delete_old_bank_reconciliation_doctypes.py @@ -22,7 +22,7 @@ def execute(): frappe.delete_doc("Page", "bank-reconciliation", force=1) - frappe.reload_doc('accounts', 'doctype', 'bank_transaction') + frappe.reload_doc("accounts", "doctype", "bank_transaction") rename_field("Bank Transaction", "debit", "deposit") rename_field("Bank Transaction", "credit", "withdrawal") diff --git a/erpnext/patches/v13_0/delete_old_purchase_reports.py b/erpnext/patches/v13_0/delete_old_purchase_reports.py index e57d6d0d3e2..987f53f37c1 100644 --- a/erpnext/patches/v13_0/delete_old_purchase_reports.py +++ b/erpnext/patches/v13_0/delete_old_purchase_reports.py @@ -8,9 +8,12 @@ from erpnext.accounts.utils import check_and_delete_linked_reports def execute(): - reports_to_delete = ["Requested Items To Be Ordered", - "Purchase Order Items To Be Received or Billed","Purchase Order Items To Be Received", - "Purchase Order Items To Be Billed"] + reports_to_delete = [ + "Requested Items To Be Ordered", + "Purchase Order Items To Be Received or Billed", + "Purchase Order Items To Be Received", + "Purchase Order Items To Be Billed", + ] for report in reports_to_delete: if frappe.db.exists("Report", report): @@ -19,8 +22,9 @@ def execute(): frappe.delete_doc("Report", report) + def delete_auto_email_reports(report): - """ Check for one or multiple Auto Email Reports and delete """ + """Check for one or multiple Auto Email Reports and delete""" auto_email_reports = frappe.db.get_values("Auto Email Report", {"report": report}, ["name"]) for auto_email_report in auto_email_reports: frappe.delete_doc("Auto Email Report", auto_email_report[0]) diff --git a/erpnext/patches/v13_0/delete_old_sales_reports.py b/erpnext/patches/v13_0/delete_old_sales_reports.py index c597fe86457..1b53da755cd 100644 --- a/erpnext/patches/v13_0/delete_old_sales_reports.py +++ b/erpnext/patches/v13_0/delete_old_sales_reports.py @@ -12,13 +12,22 @@ def execute(): for report in reports_to_delete: if frappe.db.exists("Report", report): + delete_links_from_desktop_icons(report) delete_auto_email_reports(report) check_and_delete_linked_reports(report) - frappe.delete_doc("Report", report) + frappe.delete_doc("Report", report, force=True) + def delete_auto_email_reports(report): - """ Check for one or multiple Auto Email Reports and delete """ + """Check for one or multiple Auto Email Reports and delete""" auto_email_reports = frappe.db.get_values("Auto Email Report", {"report": report}, ["name"]) for auto_email_report in auto_email_reports: - frappe.delete_doc("Auto Email Report", auto_email_report[0]) + frappe.delete_doc("Auto Email Report", auto_email_report[0], force=True) + + +def delete_links_from_desktop_icons(report): + """Check for one or multiple Desktop Icons and delete""" + desktop_icons = frappe.db.get_values("Desktop Icon", {"_report": report}, ["name"]) + for desktop_icon in desktop_icons: + frappe.delete_doc("Desktop Icon", desktop_icon[0], force=True) diff --git a/erpnext/patches/v13_0/delete_orphaned_tables.py b/erpnext/patches/v13_0/delete_orphaned_tables.py index c32f83067bc..794be098a9f 100644 --- a/erpnext/patches/v13_0/delete_orphaned_tables.py +++ b/erpnext/patches/v13_0/delete_orphaned_tables.py @@ -7,63 +7,66 @@ from frappe.utils import getdate def execute(): - frappe.reload_doc('setup', 'doctype', 'transaction_deletion_record') + frappe.reload_doc("setup", "doctype", "transaction_deletion_record") - if has_deleted_company_transactions(): - child_doctypes = get_child_doctypes_whose_parent_doctypes_were_affected() + if has_deleted_company_transactions(): + child_doctypes = get_child_doctypes_whose_parent_doctypes_were_affected() - for doctype in child_doctypes: - docs = frappe.get_all(doctype, fields=['name', 'parent', 'parenttype', 'creation']) + for doctype in child_doctypes: + docs = frappe.get_all(doctype, fields=["name", "parent", "parenttype", "creation"]) - for doc in docs: - if not frappe.db.exists(doc['parenttype'], doc['parent']): - frappe.db.delete(doctype, {'name': doc['name']}) + for doc in docs: + if not frappe.db.exists(doc["parenttype"], doc["parent"]): + frappe.db.delete(doctype, {"name": doc["name"]}) + + elif check_for_new_doc_with_same_name_as_deleted_parent(doc): + frappe.db.delete(doctype, {"name": doc["name"]}) - elif check_for_new_doc_with_same_name_as_deleted_parent(doc): - frappe.db.delete(doctype, {'name': doc['name']}) def has_deleted_company_transactions(): - return frappe.get_all('Transaction Deletion Record') + return frappe.get_all("Transaction Deletion Record") + def get_child_doctypes_whose_parent_doctypes_were_affected(): - parent_doctypes = get_affected_doctypes() - child_doctypes = frappe.get_all( - 'DocField', - filters={ - 'fieldtype': 'Table', - 'parent':['in', parent_doctypes] - }, pluck='options') + parent_doctypes = get_affected_doctypes() + child_doctypes = frappe.get_all( + "DocField", filters={"fieldtype": "Table", "parent": ["in", parent_doctypes]}, pluck="options" + ) + + return child_doctypes - return child_doctypes def get_affected_doctypes(): - affected_doctypes = [] - tdr_docs = frappe.get_all('Transaction Deletion Record', pluck="name") + affected_doctypes = [] + tdr_docs = frappe.get_all("Transaction Deletion Record", pluck="name") - for tdr in tdr_docs: - tdr_doc = frappe.get_doc("Transaction Deletion Record", tdr) + for tdr in tdr_docs: + tdr_doc = frappe.get_doc("Transaction Deletion Record", tdr) - for doctype in tdr_doc.doctypes: - if is_not_child_table(doctype.doctype_name): - affected_doctypes.append(doctype.doctype_name) + for doctype in tdr_doc.doctypes: + if is_not_child_table(doctype.doctype_name): + affected_doctypes.append(doctype.doctype_name) + + affected_doctypes = remove_duplicate_items(affected_doctypes) + return affected_doctypes - affected_doctypes = remove_duplicate_items(affected_doctypes) - return affected_doctypes def is_not_child_table(doctype): - return not bool(frappe.get_value('DocType', doctype, 'istable')) + return not bool(frappe.get_value("DocType", doctype, "istable")) + def remove_duplicate_items(affected_doctypes): - return list(set(affected_doctypes)) + return list(set(affected_doctypes)) + def check_for_new_doc_with_same_name_as_deleted_parent(doc): - """ - Compares creation times of parent and child docs. - Since Transaction Deletion Record resets the naming series after deletion, - it allows the creation of new docs with the same names as the deleted ones. - """ + """ + Compares creation times of parent and child docs. + Since Transaction Deletion Record resets the naming series after deletion, + it allows the creation of new docs with the same names as the deleted ones. + """ - parent_creation_time = frappe.db.get_value(doc['parenttype'], doc['parent'], 'creation') - child_creation_time = doc['creation'] + parent_creation_time = frappe.db.get_value(doc["parenttype"], doc["parent"], "creation") + child_creation_time = doc["creation"] - return getdate(parent_creation_time) > getdate(child_creation_time) + return getdate(parent_creation_time) > getdate(child_creation_time) diff --git a/erpnext/patches/v13_0/delete_report_requested_items_to_order.py b/erpnext/patches/v13_0/delete_report_requested_items_to_order.py index 87565f0fe42..430a3056cd1 100644 --- a/erpnext/patches/v13_0/delete_report_requested_items_to_order.py +++ b/erpnext/patches/v13_0/delete_report_requested_items_to_order.py @@ -2,12 +2,16 @@ import frappe def execute(): - """ Check for one or multiple Auto Email Reports and delete """ - auto_email_reports = frappe.db.get_values("Auto Email Report", {"report": "Requested Items to Order"}, ["name"]) + """Check for one or multiple Auto Email Reports and delete""" + auto_email_reports = frappe.db.get_values( + "Auto Email Report", {"report": "Requested Items to Order"}, ["name"] + ) for auto_email_report in auto_email_reports: frappe.delete_doc("Auto Email Report", auto_email_report[0]) - frappe.db.sql(""" + frappe.db.sql( + """ DELETE FROM `tabReport` WHERE name = 'Requested Items to Order' - """) + """ + ) diff --git a/erpnext/patches/v13_0/disable_ksa_print_format_for_others.py b/erpnext/patches/v13_0/disable_ksa_print_format_for_others.py index aa2a2d3b785..84b6c37dd9d 100644 --- a/erpnext/patches/v13_0/disable_ksa_print_format_for_others.py +++ b/erpnext/patches/v13_0/disable_ksa_print_format_for_others.py @@ -7,13 +7,13 @@ from erpnext.regional.saudi_arabia.setup import add_print_formats def execute(): - company = frappe.get_all('Company', filters = {'country': 'Saudi Arabia'}) + company = frappe.get_all("Company", filters={"country": "Saudi Arabia"}) if company: add_print_formats() return - if frappe.db.exists('DocType', 'Print Format'): + if frappe.db.exists("DocType", "Print Format"): frappe.reload_doc("regional", "print_format", "ksa_vat_invoice", force=True) frappe.reload_doc("regional", "print_format", "ksa_pos_invoice", force=True) - for d in ('KSA VAT Invoice', 'KSA POS Invoice'): + for d in ("KSA VAT Invoice", "KSA POS Invoice"): frappe.db.set_value("Print Format", d, "disabled", 1) diff --git a/erpnext/patches/v13_0/drop_razorpay_payload_column.py b/erpnext/patches/v13_0/drop_razorpay_payload_column.py index aea498d8d30..ca166cee74f 100644 --- a/erpnext/patches/v13_0/drop_razorpay_payload_column.py +++ b/erpnext/patches/v13_0/drop_razorpay_payload_column.py @@ -1,8 +1,7 @@ - import frappe def execute(): if frappe.db.exists("DocType", "Membership"): - if 'webhook_payload' in frappe.db.get_table_columns("Membership"): + if "webhook_payload" in frappe.db.get_table_columns("Membership"): frappe.db.sql("alter table `tabMembership` drop column webhook_payload") diff --git a/erpnext/patches/v13_0/education_deprecation_warning.py b/erpnext/patches/v13_0/education_deprecation_warning.py new file mode 100644 index 00000000000..96602ebdf94 --- /dev/null +++ b/erpnext/patches/v13_0/education_deprecation_warning.py @@ -0,0 +1,10 @@ +import click + + +def execute(): + + click.secho( + "Education Domain is moved to a separate app and will be removed from ERPNext in version-14.\n" + "When upgrading to ERPNext version-14, please install the app to continue using the Education domain: https://github.com/frappe/education", + fg="yellow", + ) diff --git a/erpnext/patches/v13_0/enable_ksa_vat_docs.py b/erpnext/patches/v13_0/enable_ksa_vat_docs.py new file mode 100644 index 00000000000..4adf4d71db7 --- /dev/null +++ b/erpnext/patches/v13_0/enable_ksa_vat_docs.py @@ -0,0 +1,12 @@ +import frappe + +from erpnext.regional.saudi_arabia.setup import add_permissions, add_print_formats + + +def execute(): + company = frappe.get_all("Company", filters={"country": "Saudi Arabia"}) + if not company: + return + + add_print_formats() + add_permissions() diff --git a/erpnext/patches/v13_0/enable_provisional_accounting.py b/erpnext/patches/v13_0/enable_provisional_accounting.py new file mode 100644 index 00000000000..7212146e458 --- /dev/null +++ b/erpnext/patches/v13_0/enable_provisional_accounting.py @@ -0,0 +1,19 @@ +import frappe + + +def execute(): + if not frappe.get_meta("Company").has_field("enable_perpetual_inventory_for_non_stock_items"): + return + + frappe.reload_doc("setup", "doctype", "company") + + company = frappe.qb.DocType("Company") + + frappe.qb.update(company).set( + company.enable_provisional_accounting_for_non_stock_items, + company.enable_perpetual_inventory_for_non_stock_items, + ).set(company.default_provisional_account, company.service_received_but_not_billed).where( + company.enable_perpetual_inventory_for_non_stock_items == 1 + ).where( + company.service_received_but_not_billed.isnotnull() + ).run() diff --git a/erpnext/patches/v13_0/enable_scheduler_job_for_item_reposting.py b/erpnext/patches/v13_0/enable_scheduler_job_for_item_reposting.py index 7a51b432117..68b5cde9203 100644 --- a/erpnext/patches/v13_0/enable_scheduler_job_for_item_reposting.py +++ b/erpnext/patches/v13_0/enable_scheduler_job_for_item_reposting.py @@ -2,7 +2,6 @@ import frappe def execute(): - frappe.reload_doc('core', 'doctype', 'scheduled_job_type') - if frappe.db.exists('Scheduled Job Type', 'repost_item_valuation.repost_entries'): - frappe.db.set_value('Scheduled Job Type', - 'repost_item_valuation.repost_entries', 'stopped', 0) + frappe.reload_doc("core", "doctype", "scheduled_job_type") + if frappe.db.exists("Scheduled Job Type", "repost_item_valuation.repost_entries"): + frappe.db.set_value("Scheduled Job Type", "repost_item_valuation.repost_entries", "stopped", 0) diff --git a/erpnext/patches/v13_0/enable_uoms.py b/erpnext/patches/v13_0/enable_uoms.py new file mode 100644 index 00000000000..8efd67e2806 --- /dev/null +++ b/erpnext/patches/v13_0/enable_uoms.py @@ -0,0 +1,13 @@ +import frappe + + +def execute(): + frappe.reload_doc("setup", "doctype", "uom") + + uom = frappe.qb.DocType("UOM") + + ( + frappe.qb.update(uom) + .set(uom.enabled, 1) + .where(uom.creation >= "2021-10-18") # date when this field was released + ).run() diff --git a/erpnext/patches/v13_0/fetch_thumbnail_in_website_items.py b/erpnext/patches/v13_0/fetch_thumbnail_in_website_items.py index 32ad542cf88..9197d86058d 100644 --- a/erpnext/patches/v13_0/fetch_thumbnail_in_website_items.py +++ b/erpnext/patches/v13_0/fetch_thumbnail_in_website_items.py @@ -2,15 +2,10 @@ import frappe def execute(): - if frappe.db.has_column("Item", "thumbnail"): - website_item = frappe.qb.DocType("Website Item").as_("wi") - item = frappe.qb.DocType("Item") + if frappe.db.has_column("Item", "thumbnail"): + website_item = frappe.qb.DocType("Website Item").as_("wi") + item = frappe.qb.DocType("Item") - frappe.qb.update(website_item).inner_join(item).on( - website_item.item_code == item.item_code - ).set( - website_item.thumbnail, item.thumbnail - ).where( - website_item.website_image.notnull() - & website_item.thumbnail.isnull() - ).run() + frappe.qb.update(website_item).inner_join(item).on(website_item.item_code == item.item_code).set( + website_item.thumbnail, item.thumbnail + ).where(website_item.website_image.notnull() & website_item.thumbnail.isnull()).run() diff --git a/erpnext/patches/v13_0/fix_invoice_statuses.py b/erpnext/patches/v13_0/fix_invoice_statuses.py index 4395757159f..253b425c58b 100644 --- a/erpnext/patches/v13_0/fix_invoice_statuses.py +++ b/erpnext/patches/v13_0/fix_invoice_statuses.py @@ -8,6 +8,7 @@ from erpnext.accounts.doctype.sales_invoice.sales_invoice import ( TODAY = getdate() + def execute(): # This fix is not related to Party Specific Item, # but it is needed for code introduced after Party Specific Item was @@ -35,39 +36,28 @@ def execute(): fields=fields, filters={ "docstatus": 1, - "status": ("in", ( - "Overdue", - "Overdue and Discounted", - "Partly Paid", - "Partly Paid and Discounted" - )), + "status": ( + "in", + ("Overdue", "Overdue and Discounted", "Partly Paid", "Partly Paid and Discounted"), + ), "outstanding_amount": (">", 0), "modified": (">", "2021-01-01") # an assumption is being made that only invoices modified # after 2021 got affected as incorrectly overdue. # required for performance reasons. - } + }, ) - invoices_to_update = { - invoice.name: invoice for invoice in invoices_to_update - } + invoices_to_update = {invoice.name: invoice for invoice in invoices_to_update} payment_schedule_items = frappe.get_all( "Payment Schedule", - fields=( - "due_date", - "payment_amount", - "base_payment_amount", - "parent" - ), - filters={"parent": ("in", invoices_to_update)} + fields=("due_date", "payment_amount", "base_payment_amount", "parent"), + filters={"parent": ("in", invoices_to_update)}, ) for item in payment_schedule_items: - invoices_to_update[item.parent].setdefault( - "payment_schedule", [] - ).append(item) + invoices_to_update[item.parent].setdefault("payment_schedule", []).append(item) status_map = {} @@ -81,19 +71,11 @@ def execute(): status_map.setdefault(correct_status, []).append(doc.name) for status, docs in status_map.items(): - frappe.db.set_value( - doctype, {"name": ("in", docs)}, - "status", - status, - update_modified=False - ) - + frappe.db.set_value(doctype, {"name": ("in", docs)}, "status", status, update_modified=False) def get_correct_status(doc): - outstanding_amount = flt( - doc.outstanding_amount, doc.precision("outstanding_amount") - ) + outstanding_amount = flt(doc.outstanding_amount, doc.precision("outstanding_amount")) total = get_total_in_party_account_currency(doc) status = "" diff --git a/erpnext/patches/v13_0/fix_non_unique_represents_company.py b/erpnext/patches/v13_0/fix_non_unique_represents_company.py index e91c1db4dd4..c604f9cb24f 100644 --- a/erpnext/patches/v13_0/fix_non_unique_represents_company.py +++ b/erpnext/patches/v13_0/fix_non_unique_represents_company.py @@ -2,8 +2,10 @@ import frappe def execute(): - frappe.db.sql(""" + frappe.db.sql( + """ update tabCustomer set represents_company = NULL where represents_company = '' - """) + """ + ) diff --git a/erpnext/patches/v13_0/fix_number_and_frequency_for_monthly_depreciation.py b/erpnext/patches/v13_0/fix_number_and_frequency_for_monthly_depreciation.py new file mode 100644 index 00000000000..fe645c81b88 --- /dev/null +++ b/erpnext/patches/v13_0/fix_number_and_frequency_for_monthly_depreciation.py @@ -0,0 +1,16 @@ +import frappe + + +def execute(): + if not frappe.db.has_column("Asset", "allow_monthly_depreciation"): + return + + assets = frappe.get_all("Asset", filters={"allow_monthly_depreciation": 1}) + for d in assets: + print(d.name) + asset_doc = frappe.get_doc("Asset", d.name) + for i in asset_doc.get("finance_books"): + if i.frequency_of_depreciation != 1: + i.total_number_of_depreciations *= i.frequency_of_depreciation + i.frequency_of_depreciation = 1 + i.db_update() diff --git a/erpnext/patches/v13_0/germany_fill_debtor_creditor_number.py b/erpnext/patches/v13_0/germany_fill_debtor_creditor_number.py index 72cda751e6c..fc3e68ac677 100644 --- a/erpnext/patches/v13_0/germany_fill_debtor_creditor_number.py +++ b/erpnext/patches/v13_0/germany_fill_debtor_creditor_number.py @@ -13,18 +13,24 @@ def execute(): "DATEV". This is no longer necessary. The reference ID for DATEV will be stored in a new custom field "debtor_creditor_number". """ - company_list = frappe.get_all('Company', filters={'country': 'Germany'}) + company_list = frappe.get_all("Company", filters={"country": "Germany"}) for company in company_list: - party_account_list = frappe.get_all('Party Account', filters={'company': company.name}, fields=['name', 'account', 'debtor_creditor_number']) + party_account_list = frappe.get_all( + "Party Account", + filters={"company": company.name}, + fields=["name", "account", "debtor_creditor_number"], + ) for party_account in party_account_list: if (not party_account.account) or party_account.debtor_creditor_number: # account empty or debtor_creditor_number already filled continue - account_number = frappe.db.get_value('Account', party_account.account, 'account_number') + account_number = frappe.db.get_value("Account", party_account.account, "account_number") if not account_number: continue - frappe.db.set_value('Party Account', party_account.name, 'debtor_creditor_number', account_number) - frappe.db.set_value('Party Account', party_account.name, 'account', '') + frappe.db.set_value( + "Party Account", party_account.name, "debtor_creditor_number", account_number + ) + frappe.db.set_value("Party Account", party_account.name, "account", "") diff --git a/erpnext/patches/v13_0/germany_make_custom_fields.py b/erpnext/patches/v13_0/germany_make_custom_fields.py index 80b6a3954a6..cc358135acd 100644 --- a/erpnext/patches/v13_0/germany_make_custom_fields.py +++ b/erpnext/patches/v13_0/germany_make_custom_fields.py @@ -13,7 +13,7 @@ def execute(): It is usually run once at setup of a new company. Since it's new, run it once for existing companies as well. """ - company_list = frappe.get_all('Company', filters = {'country': 'Germany'}) + company_list = frappe.get_all("Company", filters={"country": "Germany"}) if not company_list: return diff --git a/erpnext/patches/v13_0/gst_fields_for_pos_invoice.py b/erpnext/patches/v13_0/gst_fields_for_pos_invoice.py index cb3df3c5ddc..efd2c21d6a0 100644 --- a/erpnext/patches/v13_0/gst_fields_for_pos_invoice.py +++ b/erpnext/patches/v13_0/gst_fields_for_pos_invoice.py @@ -1,43 +1,87 @@ - import frappe from frappe.custom.doctype.custom_field.custom_field import create_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}, fields=['name']) + company = frappe.get_all("Company", filters={"country": "India"}, fields=["name"]) if not company: return - hsn_sac_field = dict(fieldname='gst_hsn_code', label='HSN/SAC', - fieldtype='Data', fetch_from='item_code.gst_hsn_code', insert_after='description', - allow_on_submit=1, print_hide=1, fetch_if_empty=1) - nil_rated_exempt = dict(fieldname='is_nil_exempt', label='Is Nil Rated or Exempted', - fieldtype='Check', fetch_from='item_code.is_nil_exempt', insert_after='gst_hsn_code', - print_hide=1) - is_non_gst = dict(fieldname='is_non_gst', label='Is Non GST', - fieldtype='Check', fetch_from='item_code.is_non_gst', insert_after='is_nil_exempt', - print_hide=1) - taxable_value = dict(fieldname='taxable_value', label='Taxable Value', - fieldtype='Currency', insert_after='base_net_amount', hidden=1, options="Company:company:default_currency", - print_hide=1) + hsn_sac_field = dict( + fieldname="gst_hsn_code", + label="HSN/SAC", + fieldtype="Data", + fetch_from="item_code.gst_hsn_code", + insert_after="description", + allow_on_submit=1, + print_hide=1, + fetch_if_empty=1, + ) + nil_rated_exempt = dict( + fieldname="is_nil_exempt", + label="Is Nil Rated or Exempted", + fieldtype="Check", + fetch_from="item_code.is_nil_exempt", + insert_after="gst_hsn_code", + print_hide=1, + ) + is_non_gst = dict( + fieldname="is_non_gst", + label="Is Non GST", + fieldtype="Check", + fetch_from="item_code.is_non_gst", + insert_after="is_nil_exempt", + print_hide=1, + ) + taxable_value = dict( + fieldname="taxable_value", + label="Taxable Value", + fieldtype="Currency", + insert_after="base_net_amount", + hidden=1, + options="Company:company:default_currency", + print_hide=1, + ) sales_invoice_gst_fields = [ - dict(fieldname='billing_address_gstin', label='Billing Address GSTIN', - fieldtype='Data', insert_after='customer_address', read_only=1, - fetch_from='customer_address.gstin', print_hide=1), - dict(fieldname='customer_gstin', label='Customer GSTIN', - fieldtype='Data', insert_after='shipping_address_name', - fetch_from='shipping_address_name.gstin', print_hide=1), - dict(fieldname='place_of_supply', label='Place of Supply', - fieldtype='Data', insert_after='customer_gstin', - print_hide=1, read_only=1), - dict(fieldname='company_gstin', label='Company GSTIN', - fieldtype='Data', insert_after='company_address', - fetch_from='company_address.gstin', print_hide=1, read_only=1), - ] + dict( + fieldname="billing_address_gstin", + label="Billing Address GSTIN", + fieldtype="Data", + insert_after="customer_address", + read_only=1, + fetch_from="customer_address.gstin", + print_hide=1, + ), + dict( + fieldname="customer_gstin", + label="Customer GSTIN", + fieldtype="Data", + insert_after="shipping_address_name", + fetch_from="shipping_address_name.gstin", + print_hide=1, + ), + dict( + fieldname="place_of_supply", + label="Place of Supply", + fieldtype="Data", + insert_after="customer_gstin", + print_hide=1, + read_only=1, + ), + dict( + fieldname="company_gstin", + label="Company GSTIN", + fieldtype="Data", + insert_after="company_address", + fetch_from="company_address.gstin", + print_hide=1, + read_only=1, + ), + ] custom_fields = { - 'POS Invoice': sales_invoice_gst_fields, - 'POS Invoice Item': [hsn_sac_field, nil_rated_exempt, is_non_gst, taxable_value], + "POS Invoice": sales_invoice_gst_fields, + "POS Invoice Item": [hsn_sac_field, nil_rated_exempt, is_non_gst, taxable_value], } - create_custom_fields(custom_fields, update=True) \ No newline at end of file + create_custom_fields(custom_fields, update=True) diff --git a/erpnext/patches/v13_0/healthcare_lab_module_rename_doctypes.py b/erpnext/patches/v13_0/healthcare_lab_module_rename_doctypes.py index d43e793b9a9..30b84accf3f 100644 --- a/erpnext/patches/v13_0/healthcare_lab_module_rename_doctypes.py +++ b/erpnext/patches/v13_0/healthcare_lab_module_rename_doctypes.py @@ -1,91 +1,94 @@ - import frappe from frappe.model.utils.rename_field import rename_field def execute(): - if frappe.db.exists('DocType', 'Lab Test') and frappe.db.exists('DocType', 'Lab Test Template'): + if frappe.db.exists("DocType", "Lab Test") and frappe.db.exists("DocType", "Lab Test Template"): # rename child doctypes doctypes = { - 'Lab Test Groups': 'Lab Test Group Template', - 'Normal Test Items': 'Normal Test Result', - 'Sensitivity Test Items': 'Sensitivity Test Result', - 'Special Test Items': 'Descriptive Test Result', - 'Special Test Template': 'Descriptive Test Template' + "Lab Test Groups": "Lab Test Group Template", + "Normal Test Items": "Normal Test Result", + "Sensitivity Test Items": "Sensitivity Test Result", + "Special Test Items": "Descriptive Test Result", + "Special Test Template": "Descriptive Test Template", } - frappe.reload_doc('healthcare', 'doctype', 'lab_test') - frappe.reload_doc('healthcare', 'doctype', 'lab_test_template') + frappe.reload_doc("healthcare", "doctype", "lab_test") + frappe.reload_doc("healthcare", "doctype", "lab_test_template") for old_dt, new_dt in doctypes.items(): frappe.flags.link_fields = {} - should_rename = ( - frappe.db.table_exists(old_dt) - and not frappe.db.table_exists(new_dt) - ) + should_rename = frappe.db.table_exists(old_dt) and not frappe.db.table_exists(new_dt) if should_rename: - frappe.reload_doc('healthcare', 'doctype', frappe.scrub(old_dt)) - frappe.rename_doc('DocType', old_dt, new_dt, force=True) - frappe.reload_doc('healthcare', 'doctype', frappe.scrub(new_dt)) - frappe.delete_doc_if_exists('DocType', old_dt) + frappe.reload_doc("healthcare", "doctype", frappe.scrub(old_dt)) + frappe.rename_doc("DocType", old_dt, new_dt, force=True) + frappe.reload_doc("healthcare", "doctype", frappe.scrub(new_dt)) + frappe.delete_doc_if_exists("DocType", old_dt) parent_fields = { - 'Lab Test Group Template': 'lab_test_groups', - 'Descriptive Test Template': 'descriptive_test_templates', - 'Normal Test Result': 'normal_test_items', - 'Sensitivity Test Result': 'sensitivity_test_items', - 'Descriptive Test Result': 'descriptive_test_items' + "Lab Test Group Template": "lab_test_groups", + "Descriptive Test Template": "descriptive_test_templates", + "Normal Test Result": "normal_test_items", + "Sensitivity Test Result": "sensitivity_test_items", + "Descriptive Test Result": "descriptive_test_items", } for doctype, parentfield in parent_fields.items(): - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tab{0}` SET parentfield = %(parentfield)s - """.format(doctype), {'parentfield': parentfield}) + """.format( + doctype + ), + {"parentfield": parentfield}, + ) # copy renamed child table fields (fields were already renamed in old doctype json, hence sql) rename_fields = { - 'lab_test_name': 'test_name', - 'lab_test_event': 'test_event', - 'lab_test_uom': 'test_uom', - 'lab_test_comment': 'test_comment' + "lab_test_name": "test_name", + "lab_test_event": "test_event", + "lab_test_uom": "test_uom", + "lab_test_comment": "test_comment", } for new, old in rename_fields.items(): - if frappe.db.has_column('Normal Test Result', old): - frappe.db.sql("""UPDATE `tabNormal Test Result` SET {} = {}""" - .format(new, old)) + if frappe.db.has_column("Normal Test Result", old): + frappe.db.sql("""UPDATE `tabNormal Test Result` SET {} = {}""".format(new, old)) - if frappe.db.has_column('Normal Test Template', 'test_event'): + if frappe.db.has_column("Normal Test Template", "test_event"): frappe.db.sql("""UPDATE `tabNormal Test Template` SET lab_test_event = test_event""") - if frappe.db.has_column('Normal Test Template', 'test_uom'): + if frappe.db.has_column("Normal Test Template", "test_uom"): frappe.db.sql("""UPDATE `tabNormal Test Template` SET lab_test_uom = test_uom""") - if frappe.db.has_column('Descriptive Test Result', 'test_particulars'): - frappe.db.sql("""UPDATE `tabDescriptive Test Result` SET lab_test_particulars = test_particulars""") + if frappe.db.has_column("Descriptive Test Result", "test_particulars"): + frappe.db.sql( + """UPDATE `tabDescriptive Test Result` SET lab_test_particulars = test_particulars""" + ) rename_fields = { - 'lab_test_template': 'test_template', - 'lab_test_description': 'test_description', - 'lab_test_rate': 'test_rate' + "lab_test_template": "test_template", + "lab_test_description": "test_description", + "lab_test_rate": "test_rate", } for new, old in rename_fields.items(): - if frappe.db.has_column('Lab Test Group Template', old): - frappe.db.sql("""UPDATE `tabLab Test Group Template` SET {} = {}""" - .format(new, old)) + if frappe.db.has_column("Lab Test Group Template", old): + frappe.db.sql("""UPDATE `tabLab Test Group Template` SET {} = {}""".format(new, old)) # rename field - frappe.reload_doc('healthcare', 'doctype', 'lab_test') - if frappe.db.has_column('Lab Test', 'special_toggle'): - rename_field('Lab Test', 'special_toggle', 'descriptive_toggle') + frappe.reload_doc("healthcare", "doctype", "lab_test") + if frappe.db.has_column("Lab Test", "special_toggle"): + rename_field("Lab Test", "special_toggle", "descriptive_toggle") - if frappe.db.exists('DocType', 'Lab Test Group Template'): + if frappe.db.exists("DocType", "Lab Test Group Template"): # fix select field option - frappe.reload_doc('healthcare', 'doctype', 'lab_test_group_template') - frappe.db.sql(""" + frappe.reload_doc("healthcare", "doctype", "lab_test_group_template") + frappe.db.sql( + """ UPDATE `tabLab Test Group Template` SET template_or_new_line = 'Add New Line' WHERE template_or_new_line = 'Add new line' - """) + """ + ) diff --git a/erpnext/patches/v13_0/hospitality_deprecation_warning.py b/erpnext/patches/v13_0/hospitality_deprecation_warning.py new file mode 100644 index 00000000000..9f9cf54f693 --- /dev/null +++ b/erpnext/patches/v13_0/hospitality_deprecation_warning.py @@ -0,0 +1,10 @@ +import click + + +def execute(): + + click.secho( + "Hospitality Domain is moved to a separate app and will be removed from ERPNext in version-14.\n" + "When upgrading to ERPNext version-14, please install the app to continue using the Agriculture domain: https://github.com/frappe/hospitality", + fg="yellow", + ) diff --git a/erpnext/patches/v13_0/item_naming_series_not_mandatory.py b/erpnext/patches/v13_0/item_naming_series_not_mandatory.py index 5fe85a48308..33fb8f963c5 100644 --- a/erpnext/patches/v13_0/item_naming_series_not_mandatory.py +++ b/erpnext/patches/v13_0/item_naming_series_not_mandatory.py @@ -7,5 +7,10 @@ def execute(): stock_settings = frappe.get_doc("Stock Settings") - set_by_naming_series("Item", "item_code", - stock_settings.get("item_naming_by")=="Naming Series", hide_name_field=True, make_mandatory=0) + set_by_naming_series( + "Item", + "item_code", + stock_settings.get("item_naming_by") == "Naming Series", + hide_name_field=True, + make_mandatory=0, + ) diff --git a/erpnext/patches/v13_0/item_reposting_for_incorrect_sl_and_gl.py b/erpnext/patches/v13_0/item_reposting_for_incorrect_sl_and_gl.py index 0f2ac4b4514..f6427ca55a6 100644 --- a/erpnext/patches/v13_0/item_reposting_for_incorrect_sl_and_gl.py +++ b/erpnext/patches/v13_0/item_reposting_for_incorrect_sl_and_gl.py @@ -7,18 +7,18 @@ from erpnext.stock.stock_ledger import update_entries_after def execute(): doctypes_to_reload = [ - ("stock", "repost_item_valuation"), - ("stock", "stock_entry_detail"), - ("stock", "purchase_receipt_item"), - ("stock", "delivery_note_item"), - ("stock", "packed_item"), - ("accounts", "sales_invoice_item"), - ("accounts", "purchase_invoice_item"), - ("buying", "purchase_receipt_item_supplied") - ] + ("stock", "repost_item_valuation"), + ("stock", "stock_entry_detail"), + ("stock", "purchase_receipt_item"), + ("stock", "delivery_note_item"), + ("stock", "packed_item"), + ("accounts", "sales_invoice_item"), + ("accounts", "purchase_invoice_item"), + ("buying", "purchase_receipt_item_supplied"), + ] for module, doctype in doctypes_to_reload: - frappe.reload_doc(module, 'doctype', doctype) + frappe.reload_doc(module, "doctype", doctype) reposting_project_deployed_on = get_creation_time() posting_date = getdate(reposting_project_deployed_on) @@ -32,7 +32,8 @@ def execute(): company_list = [] - data = frappe.db.sql(''' + data = frappe.db.sql( + """ SELECT name, item_code, warehouse, voucher_type, voucher_no, posting_date, posting_time, company FROM @@ -41,7 +42,10 @@ def execute(): creation > %s and is_cancelled = 0 ORDER BY timestamp(posting_date, posting_time) asc, creation asc - ''', reposting_project_deployed_on, as_dict=1) + """, + reposting_project_deployed_on, + as_dict=1, + ) frappe.db.auto_commit_on_many_writes = 1 print("Reposting Stock Ledger Entries...") @@ -51,30 +55,36 @@ def execute(): if d.company not in company_list: company_list.append(d.company) - update_entries_after({ - "item_code": d.item_code, - "warehouse": d.warehouse, - "posting_date": d.posting_date, - "posting_time": d.posting_time, - "voucher_type": d.voucher_type, - "voucher_no": d.voucher_no, - "sle_id": d.name - }, allow_negative_stock=True) + update_entries_after( + { + "item_code": d.item_code, + "warehouse": d.warehouse, + "posting_date": d.posting_date, + "posting_time": d.posting_time, + "voucher_type": d.voucher_type, + "voucher_no": d.voucher_no, + "sle_id": d.name, + }, + allow_negative_stock=True, + ) i += 1 - if i%100 == 0: + if i % 100 == 0: print(i, "/", total_sle) - print("Reposting General Ledger Entries...") if data: - for row in frappe.get_all('Company', filters= {'enable_perpetual_inventory': 1}): + for row in frappe.get_all("Company", filters={"enable_perpetual_inventory": 1}): if row.name in company_list: update_gl_entries_after(posting_date, posting_time, company=row.name) frappe.db.auto_commit_on_many_writes = 0 + def get_creation_time(): - return frappe.db.sql(''' SELECT create_time FROM - INFORMATION_SCHEMA.TABLES where TABLE_NAME = "tabRepost Item Valuation" ''', as_list=1)[0][0] + return frappe.db.sql( + """ SELECT create_time FROM + INFORMATION_SCHEMA.TABLES where TABLE_NAME = "tabRepost Item Valuation" """, + as_list=1, + )[0][0] diff --git a/erpnext/patches/v13_0/job_card_status_on_hold.py b/erpnext/patches/v13_0/job_card_status_on_hold.py new file mode 100644 index 00000000000..8c67c3c858e --- /dev/null +++ b/erpnext/patches/v13_0/job_card_status_on_hold.py @@ -0,0 +1,19 @@ +import frappe + + +def execute(): + job_cards = frappe.get_all( + "Job Card", + {"status": "On Hold", "docstatus": ("!=", 0)}, + pluck="name", + ) + + for idx, job_card in enumerate(job_cards): + try: + doc = frappe.get_doc("Job Card", job_card) + doc.set_status() + doc.db_set("status", doc.status, update_modified=False) + if idx % 100 == 0: + frappe.db.commit() + except Exception: + continue diff --git a/erpnext/patches/v13_0/loyalty_points_entry_for_pos_invoice.py b/erpnext/patches/v13_0/loyalty_points_entry_for_pos_invoice.py index 68bcd8a8da5..69a695ef301 100644 --- a/erpnext/patches/v13_0/loyalty_points_entry_for_pos_invoice.py +++ b/erpnext/patches/v13_0/loyalty_points_entry_for_pos_invoice.py @@ -6,15 +6,16 @@ import frappe def execute(): - '''`sales_invoice` field from loyalty point entry is splitted into `invoice_type` & `invoice` fields''' + """`sales_invoice` field from loyalty point entry is splitted into `invoice_type` & `invoice` fields""" frappe.reload_doc("Accounts", "doctype", "loyalty_point_entry") - if not frappe.db.has_column('Loyalty Point Entry', 'sales_invoice'): + if not frappe.db.has_column("Loyalty Point Entry", "sales_invoice"): return frappe.db.sql( """UPDATE `tabLoyalty Point Entry` lpe SET lpe.`invoice_type` = 'Sales Invoice', lpe.`invoice` = lpe.`sales_invoice` WHERE lpe.`sales_invoice` IS NOT NULL - AND (lpe.`invoice` IS NULL OR lpe.`invoice` = '')""") + AND (lpe.`invoice` IS NULL OR lpe.`invoice` = '')""" + ) diff --git a/erpnext/patches/v13_0/make_homepage_products_website_items.py b/erpnext/patches/v13_0/make_homepage_products_website_items.py index bb0630aafdc..3f23e9cdd5d 100644 --- a/erpnext/patches/v13_0/make_homepage_products_website_items.py +++ b/erpnext/patches/v13_0/make_homepage_products_website_items.py @@ -1,4 +1,3 @@ - import frappe @@ -13,4 +12,6 @@ def execute(): row.item_code = web_item homepage.flags.ignore_mandatory = True - homepage.save() \ No newline at end of file + homepage.flags.ignore_links = True + + homepage.save() diff --git a/erpnext/patches/v13_0/make_non_standard_user_type.py b/erpnext/patches/v13_0/make_non_standard_user_type.py index 9faf298c262..ba34cb98172 100644 --- a/erpnext/patches/v13_0/make_non_standard_user_type.py +++ b/erpnext/patches/v13_0/make_non_standard_user_type.py @@ -10,15 +10,24 @@ from erpnext.setup.install import add_non_standard_user_types def execute(): doctype_dict = { - 'projects': ['Timesheet'], - 'payroll': ['Salary Slip', 'Employee Tax Exemption Declaration', 'Employee Tax Exemption Proof Submission'], - 'hr': ['Employee', 'Expense Claim', 'Leave Application', 'Attendance Request', 'Compensatory Leave Request'] + "projects": ["Timesheet"], + "payroll": [ + "Salary Slip", + "Employee Tax Exemption Declaration", + "Employee Tax Exemption Proof Submission", + ], + "hr": [ + "Employee", + "Expense Claim", + "Leave Application", + "Attendance Request", + "Compensatory Leave Request", + ], } for module, doctypes in iteritems(doctype_dict): for doctype in doctypes: - frappe.reload_doc(module, 'doctype', doctype) - + frappe.reload_doc(module, "doctype", doctype) frappe.flags.ignore_select_perm = True frappe.flags.update_select_perm_after_migrate = True diff --git a/erpnext/patches/v13_0/modify_invalid_gain_loss_gl_entries.py b/erpnext/patches/v13_0/modify_invalid_gain_loss_gl_entries.py index ad79c811c06..492e0403ec4 100644 --- a/erpnext/patches/v13_0/modify_invalid_gain_loss_gl_entries.py +++ b/erpnext/patches/v13_0/modify_invalid_gain_loss_gl_entries.py @@ -1,14 +1,14 @@ - import json import frappe def execute(): - frappe.reload_doc('accounts', 'doctype', 'purchase_invoice_advance') - frappe.reload_doc('accounts', 'doctype', 'sales_invoice_advance') + frappe.reload_doc("accounts", "doctype", "purchase_invoice_advance") + frappe.reload_doc("accounts", "doctype", "sales_invoice_advance") - purchase_invoices = frappe.db.sql(""" + purchase_invoices = frappe.db.sql( + """ select parenttype as type, parent as name from @@ -19,9 +19,12 @@ def execute(): and ifnull(exchange_gain_loss, 0) != 0 group by parent - """, as_dict=1) + """, + as_dict=1, + ) - sales_invoices = frappe.db.sql(""" + sales_invoices = frappe.db.sql( + """ select parenttype as type, parent as name from @@ -32,14 +35,16 @@ def execute(): and ifnull(exchange_gain_loss, 0) != 0 group by parent - """, as_dict=1) + """, + as_dict=1, + ) if purchase_invoices + sales_invoices: frappe.log_error(json.dumps(purchase_invoices + sales_invoices, indent=2), title="Patch Log") - acc_frozen_upto = frappe.db.get_value('Accounts Settings', None, 'acc_frozen_upto') + acc_frozen_upto = frappe.db.get_value("Accounts Settings", None, "acc_frozen_upto") if acc_frozen_upto: - frappe.db.set_value('Accounts Settings', None, 'acc_frozen_upto', None) + frappe.db.set_value("Accounts Settings", None, "acc_frozen_upto", None) for invoice in purchase_invoices + sales_invoices: try: @@ -48,13 +53,13 @@ def execute(): doc.make_gl_entries() for advance in doc.advances: if advance.ref_exchange_rate == 1: - advance.db_set('exchange_gain_loss', 0, False) + advance.db_set("exchange_gain_loss", 0, False) doc.docstatus = 1 doc.make_gl_entries() frappe.db.commit() except Exception: frappe.db.rollback() - print(f'Failed to correct gl entries of {invoice.name}') + print(f"Failed to correct gl entries of {invoice.name}") if acc_frozen_upto: - frappe.db.set_value('Accounts Settings', None, 'acc_frozen_upto', acc_frozen_upto) \ No newline at end of file + frappe.db.set_value("Accounts Settings", None, "acc_frozen_upto", acc_frozen_upto) diff --git a/erpnext/patches/v13_0/move_branch_code_to_bank_account.py b/erpnext/patches/v13_0/move_branch_code_to_bank_account.py index 350744fd41f..24061271484 100644 --- a/erpnext/patches/v13_0/move_branch_code_to_bank_account.py +++ b/erpnext/patches/v13_0/move_branch_code_to_bank_account.py @@ -7,11 +7,15 @@ import frappe def execute(): - frappe.reload_doc('accounts', 'doctype', 'bank_account') - frappe.reload_doc('accounts', 'doctype', 'bank') + frappe.reload_doc("accounts", "doctype", "bank_account") + frappe.reload_doc("accounts", "doctype", "bank") - if frappe.db.has_column('Bank', 'branch_code') and frappe.db.has_column('Bank Account', 'branch_code'): - frappe.db.sql("""UPDATE `tabBank` b, `tabBank Account` ba + if frappe.db.has_column("Bank", "branch_code") and frappe.db.has_column( + "Bank Account", "branch_code" + ): + frappe.db.sql( + """UPDATE `tabBank` b, `tabBank Account` ba SET ba.branch_code = b.branch_code WHERE ba.bank = b.name AND - ifnull(b.branch_code, '') != '' AND ifnull(ba.branch_code, '') = ''""") + ifnull(b.branch_code, '') != '' AND ifnull(ba.branch_code, '') = ''""" + ) diff --git a/erpnext/patches/v13_0/move_doctype_reports_and_notification_from_hr_to_payroll.py b/erpnext/patches/v13_0/move_doctype_reports_and_notification_from_hr_to_payroll.py index c07caaef661..0290af0f73e 100644 --- a/erpnext/patches/v13_0/move_doctype_reports_and_notification_from_hr_to_payroll.py +++ b/erpnext/patches/v13_0/move_doctype_reports_and_notification_from_hr_to_payroll.py @@ -6,47 +6,47 @@ import frappe def execute(): - frappe.db.sql("""UPDATE `tabPrint Format` + frappe.db.sql( + """UPDATE `tabPrint Format` SET module = 'Payroll' WHERE name IN ('Salary Slip Based On Timesheet', 'Salary Slip Standard')""" - ) + ) - frappe.db.sql("""UPDATE `tabNotification` SET module='Payroll' WHERE name='Retention Bonus';""" - ) + frappe.db.sql("""UPDATE `tabNotification` SET module='Payroll' WHERE name='Retention Bonus';""") - doctypes_moved = [ - 'Employee Benefit Application Detail', - 'Employee Tax Exemption Declaration Category', - 'Salary Component', - 'Employee Tax Exemption Proof Submission Detail', - 'Income Tax Slab Other Charges', - 'Taxable Salary Slab', - 'Payroll Period Date', - 'Salary Slip Timesheet', - 'Payroll Employee Detail', - 'Salary Detail', - 'Employee Tax Exemption Sub Category', - 'Employee Tax Exemption Category', - 'Employee Benefit Claim', - 'Employee Benefit Application', - 'Employee Other Income', - 'Employee Tax Exemption Proof Submission', - 'Employee Tax Exemption Declaration', - 'Employee Incentive', - 'Retention Bonus', - 'Additional Salary', - 'Income Tax Slab', - 'Payroll Period', - 'Salary Slip', - 'Payroll Entry', - 'Salary Structure Assignment', - 'Salary Structure' - ] + doctypes_moved = [ + "Employee Benefit Application Detail", + "Employee Tax Exemption Declaration Category", + "Salary Component", + "Employee Tax Exemption Proof Submission Detail", + "Income Tax Slab Other Charges", + "Taxable Salary Slab", + "Payroll Period Date", + "Salary Slip Timesheet", + "Payroll Employee Detail", + "Salary Detail", + "Employee Tax Exemption Sub Category", + "Employee Tax Exemption Category", + "Employee Benefit Claim", + "Employee Benefit Application", + "Employee Other Income", + "Employee Tax Exemption Proof Submission", + "Employee Tax Exemption Declaration", + "Employee Incentive", + "Retention Bonus", + "Additional Salary", + "Income Tax Slab", + "Payroll Period", + "Salary Slip", + "Payroll Entry", + "Salary Structure Assignment", + "Salary Structure", + ] - for doctype in doctypes_moved: - frappe.delete_doc_if_exists("DocType", doctype) + for doctype in doctypes_moved: + frappe.delete_doc_if_exists("DocType", doctype) - reports = ["Salary Register", "Bank Remittance"] + reports = ["Salary Register", "Bank Remittance"] - for report in reports: - frappe.delete_doc_if_exists("Report", report) + for report in reports: + frappe.delete_doc_if_exists("Report", report) diff --git a/erpnext/patches/v13_0/move_payroll_setting_separately_from_hr_settings.py b/erpnext/patches/v13_0/move_payroll_setting_separately_from_hr_settings.py index fca7c09c91a..37a3c357b32 100644 --- a/erpnext/patches/v13_0/move_payroll_setting_separately_from_hr_settings.py +++ b/erpnext/patches/v13_0/move_payroll_setting_separately_from_hr_settings.py @@ -6,7 +6,8 @@ import frappe def execute(): - data = frappe.db.sql('''SELECT * + data = frappe.db.sql( + """SELECT * FROM `tabSingles` WHERE doctype = "HR Settings" @@ -21,7 +22,9 @@ def execute(): "payroll_based_on", "password_policy" ) - ''', as_dict=1) + """, + as_dict=1, + ) - for d in data: - frappe.db.set_value("Payroll Settings", None, d.field, d.value) + for d in data: + frappe.db.set_value("Payroll Settings", None, d.field, d.value) diff --git a/erpnext/patches/v13_0/move_tax_slabs_from_payroll_period_to_income_tax_slab.py b/erpnext/patches/v13_0/move_tax_slabs_from_payroll_period_to_income_tax_slab.py index d1ea22f7f26..f84a739d741 100644 --- a/erpnext/patches/v13_0/move_tax_slabs_from_payroll_period_to_income_tax_slab.py +++ b/erpnext/patches/v13_0/move_tax_slabs_from_payroll_period_to_income_tax_slab.py @@ -6,28 +6,42 @@ import frappe def execute(): - if not (frappe.db.table_exists("Payroll Period") and frappe.db.table_exists("Taxable Salary Slab")): + if not ( + frappe.db.table_exists("Payroll Period") and frappe.db.table_exists("Taxable Salary Slab") + ): return - for doctype in ("income_tax_slab", "salary_structure_assignment", "employee_other_income", "income_tax_slab_other_charges"): + for doctype in ( + "income_tax_slab", + "salary_structure_assignment", + "employee_other_income", + "income_tax_slab_other_charges", + ): frappe.reload_doc("Payroll", "doctype", doctype) - - standard_tax_exemption_amount_exists = frappe.db.has_column("Payroll Period", "standard_tax_exemption_amount") + standard_tax_exemption_amount_exists = frappe.db.has_column( + "Payroll Period", "standard_tax_exemption_amount" + ) select_fields = "name, start_date, end_date" if standard_tax_exemption_amount_exists: select_fields = "name, start_date, end_date, standard_tax_exemption_amount" for company in frappe.get_all("Company"): - payroll_periods = frappe.db.sql(""" + payroll_periods = frappe.db.sql( + """ SELECT {0} FROM `tabPayroll Period` WHERE company=%s ORDER BY start_date DESC - """.format(select_fields), company.name, as_dict = 1) + """.format( + select_fields + ), + company.name, + as_dict=1, + ) for i, period in enumerate(payroll_periods): income_tax_slab = frappe.new_doc("Income Tax Slab") @@ -48,13 +62,17 @@ def execute(): income_tax_slab.submit() frappe.db.sql( - """ UPDATE `tabTaxable Salary Slab` + """ UPDATE `tabTaxable Salary Slab` SET parent = %s , parentfield = 'slabs' , parenttype = "Income Tax Slab" WHERE parent = %s - """, (income_tax_slab.name, period.name), as_dict = 1) + """, + (income_tax_slab.name, period.name), + as_dict=1, + ) if i == 0: - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabSalary Structure Assignment` set @@ -63,16 +81,19 @@ def execute(): company = %s and from_date >= %s and docstatus < 2 - """, (income_tax_slab.name, company.name, period.start_date)) + """, + (income_tax_slab.name, company.name, period.start_date), + ) # move other incomes to separate document if not frappe.db.table_exists("Employee Tax Exemption Proof Submission"): return migrated = [] - proofs = frappe.get_all("Employee Tax Exemption Proof Submission", - filters = {'docstatus': 1}, - fields =['payroll_period', 'employee', 'company', 'income_from_other_sources'] + proofs = frappe.get_all( + "Employee Tax Exemption Proof Submission", + filters={"docstatus": 1}, + fields=["payroll_period", "employee", "company", "income_from_other_sources"], ) for proof in proofs: if proof.income_from_other_sources: @@ -91,14 +112,17 @@ def execute(): if not frappe.db.table_exists("Employee Tax Exemption Declaration"): return - declerations = frappe.get_all("Employee Tax Exemption Declaration", - filters = {'docstatus': 1}, - fields =['payroll_period', 'employee', 'company', 'income_from_other_sources'] + declerations = frappe.get_all( + "Employee Tax Exemption Declaration", + filters={"docstatus": 1}, + fields=["payroll_period", "employee", "company", "income_from_other_sources"], ) for declaration in declerations: - if declaration.income_from_other_sources \ - and [declaration.employee, declaration.payroll_period] not in migrated: + if ( + declaration.income_from_other_sources + and [declaration.employee, declaration.payroll_period] not in migrated + ): employee_other_income = frappe.new_doc("Employee Other Income") employee_other_income.employee = declaration.employee employee_other_income.payroll_period = declaration.payroll_period diff --git a/erpnext/patches/v13_0/patch_to_fix_reverse_linking_in_additional_salary_encashment_and_incentive.py b/erpnext/patches/v13_0/patch_to_fix_reverse_linking_in_additional_salary_encashment_and_incentive.py index 3d999bf3240..45acf49205b 100644 --- a/erpnext/patches/v13_0/patch_to_fix_reverse_linking_in_additional_salary_encashment_and_incentive.py +++ b/erpnext/patches/v13_0/patch_to_fix_reverse_linking_in_additional_salary_encashment_and_incentive.py @@ -1,4 +1,3 @@ - import frappe @@ -11,43 +10,58 @@ def execute(): frappe.reload_doc("hr", "doctype", "Leave Encashment") - additional_salaries = frappe.get_all("Additional Salary", - fields = ['name', "salary_slip", "type", "salary_component"], - filters = {'salary_slip': ['!=', '']}, - group_by = 'salary_slip' - ) - leave_encashments = frappe.get_all("Leave Encashment", - fields = ["name","additional_salary"], - filters = {'additional_salary': ['!=', '']} - ) - employee_incentives = frappe.get_all("Employee Incentive", - fields= ["name", "additional_salary"], - filters = {'additional_salary': ['!=', '']} - ) + if frappe.db.has_column("Leave Encashment", "additional_salary"): + leave_encashments = frappe.get_all( + "Leave Encashment", + fields=["name", "additional_salary"], + filters={"additional_salary": ["!=", ""]}, + ) + for leave_encashment in leave_encashments: + frappe.db.sql( + """ UPDATE `tabAdditional Salary` + SET ref_doctype = 'Leave Encashment', ref_docname = %s + WHERE name = %s + """, + (leave_encashment["name"], leave_encashment["additional_salary"]), + ) - for incentive in employee_incentives: - frappe.db.sql(""" UPDATE `tabAdditional Salary` - SET ref_doctype = 'Employee Incentive', ref_docname = %s - WHERE name = %s - """, (incentive['name'], incentive['additional_salary'])) + if frappe.db.has_column("Employee Incentive", "additional_salary"): + employee_incentives = frappe.get_all( + "Employee Incentive", + fields=["name", "additional_salary"], + filters={"additional_salary": ["!=", ""]}, + ) + for incentive in employee_incentives: + frappe.db.sql( + """ UPDATE `tabAdditional Salary` + SET ref_doctype = 'Employee Incentive', ref_docname = %s + WHERE name = %s + """, + (incentive["name"], incentive["additional_salary"]), + ) - for leave_encashment in leave_encashments: - frappe.db.sql(""" UPDATE `tabAdditional Salary` - SET ref_doctype = 'Leave Encashment', ref_docname = %s - WHERE name = %s - """, (leave_encashment['name'], leave_encashment['additional_salary'])) + if frappe.db.has_column("Additional Salary", "salary_slip"): + additional_salaries = frappe.get_all( + "Additional Salary", + fields=["name", "salary_slip", "type", "salary_component"], + filters={"salary_slip": ["!=", ""]}, + group_by="salary_slip", + ) - salary_slips = [sal["salary_slip"] for sal in additional_salaries] + salary_slips = [sal["salary_slip"] for sal in additional_salaries] - for salary in additional_salaries: - comp_type = "earnings" if salary['type'] == 'Earning' else 'deductions' - if salary["salary_slip"] and salary_slips.count(salary["salary_slip"]) == 1: - frappe.db.sql(""" - UPDATE `tabSalary Detail` - SET additional_salary = %s - WHERE parenttype = 'Salary Slip' - and parentfield = %s - and parent = %s - and salary_component = %s - """, (salary["name"], comp_type, salary["salary_slip"], salary["salary_component"])) + for salary in additional_salaries: + comp_type = "earnings" if salary["type"] == "Earning" else "deductions" + if salary["salary_slip"] and salary_slips.count(salary["salary_slip"]) == 1: + frappe.db.sql( + """ + UPDATE `tabSalary Detail` + SET additional_salary = %s + WHERE parenttype = 'Salary Slip' + and parentfield = %s + and parent = %s + and salary_component = %s + """, + (salary["name"], comp_type, salary["salary_slip"], salary["salary_component"]), + ) diff --git a/erpnext/patches/v13_0/populate_e_commerce_settings.py b/erpnext/patches/v13_0/populate_e_commerce_settings.py index 024619c4dba..29427da2bc5 100644 --- a/erpnext/patches/v13_0/populate_e_commerce_settings.py +++ b/erpnext/patches/v13_0/populate_e_commerce_settings.py @@ -1,4 +1,3 @@ - import frappe from frappe.utils import cint @@ -9,23 +8,37 @@ def execute(): frappe.reload_doc("portal", "doctype", "website_attribute") products_settings_fields = [ - "hide_variants", "products_per_page", - "enable_attribute_filters", "enable_field_filters" + "hide_variants", + "products_per_page", + "enable_attribute_filters", + "enable_field_filters", ] shopping_cart_settings_fields = [ - "enabled", "show_attachments", "show_price", - "show_stock_availability", "enable_variants", "show_contact_us_button", - "show_quantity_in_website", "show_apply_coupon_code_in_website", - "allow_items_not_in_stock", "company", "price_list", "default_customer_group", - "quotation_series", "enable_checkout", "payment_success_url", - "payment_gateway_account", "save_quotations_as_draft" + "enabled", + "show_attachments", + "show_price", + "show_stock_availability", + "enable_variants", + "show_contact_us_button", + "show_quantity_in_website", + "show_apply_coupon_code_in_website", + "allow_items_not_in_stock", + "company", + "price_list", + "default_customer_group", + "quotation_series", + "enable_checkout", + "payment_success_url", + "payment_gateway_account", + "save_quotations_as_draft", ] settings = frappe.get_doc("E Commerce Settings") def map_into_e_commerce_settings(doctype, fields): - data = frappe.db.sql(""" + data = frappe.db.sql( + """ Select field, value from `tabSingles` @@ -33,9 +46,11 @@ def execute(): doctype='{doctype}' and field in ({fields}) """.format( - doctype=doctype, - fields=(",").join(['%s'] * len(fields)) - ), tuple(fields), as_dict=1) + doctype=doctype, fields=(",").join(["%s"] * len(fields)) + ), + tuple(fields), + as_dict=1, + ) # {'enable_attribute_filters': '1', ...} mapper = {row.field: row.value for row in data} @@ -52,10 +67,14 @@ def execute(): # move filters and attributes tables to E Commerce Settings from Products Settings for doctype in ("Website Filter Field", "Website Attribute"): - frappe.db.sql("""Update `tab{doctype}` + frappe.db.sql( + """Update `tab{doctype}` set parenttype = 'E Commerce Settings', parent = 'E Commerce Settings' where parent = 'Products Settings' - """.format(doctype=doctype)) \ No newline at end of file + """.format( + doctype=doctype + ) + ) diff --git a/erpnext/patches/v13_0/print_uom_after_quantity_patch.py b/erpnext/patches/v13_0/print_uom_after_quantity_patch.py index 3da6f749aff..a16f909fc38 100644 --- a/erpnext/patches/v13_0/print_uom_after_quantity_patch.py +++ b/erpnext/patches/v13_0/print_uom_after_quantity_patch.py @@ -6,4 +6,4 @@ from erpnext.setup.install import create_print_uom_after_qty_custom_field def execute(): - create_print_uom_after_qty_custom_field() + create_print_uom_after_qty_custom_field() diff --git a/erpnext/patches/v13_0/remove_attribute_field_from_item_variant_setting.py b/erpnext/patches/v13_0/remove_attribute_field_from_item_variant_setting.py index bbe3eb5815b..4efbe4df96a 100644 --- a/erpnext/patches/v13_0/remove_attribute_field_from_item_variant_setting.py +++ b/erpnext/patches/v13_0/remove_attribute_field_from_item_variant_setting.py @@ -5,5 +5,7 @@ def execute(): """Remove has_variants and attribute fields from item variant settings.""" frappe.reload_doc("stock", "doctype", "Item Variant Settings") - frappe.db.sql("""delete from `tabVariant Field` - where field_name in ('attributes', 'has_variants')""") + frappe.db.sql( + """delete from `tabVariant Field` + where field_name in ('attributes', 'has_variants')""" + ) diff --git a/erpnext/patches/v13_0/remove_bad_selling_defaults.py b/erpnext/patches/v13_0/remove_bad_selling_defaults.py index 381c3902da0..efd2098d9ed 100644 --- a/erpnext/patches/v13_0/remove_bad_selling_defaults.py +++ b/erpnext/patches/v13_0/remove_bad_selling_defaults.py @@ -12,5 +12,5 @@ def execute(): if selling_settings.territory in (_("All Territories"), "All Territories"): selling_settings.territory = None - selling_settings.flags.ignore_mandatory=True + selling_settings.flags.ignore_mandatory = True selling_settings.save(ignore_permissions=True) diff --git a/erpnext/patches/v13_0/remove_unknown_links_to_prod_plan_items.py b/erpnext/patches/v13_0/remove_unknown_links_to_prod_plan_items.py new file mode 100644 index 00000000000..35c93805c8b --- /dev/null +++ b/erpnext/patches/v13_0/remove_unknown_links_to_prod_plan_items.py @@ -0,0 +1,35 @@ +import frappe + + +def execute(): + """ + Remove "production_plan_item" field where linked field doesn't exist in tha table. + """ + frappe.reload_doc("manufacturing", "doctype", "production_plan_item") + + work_order = frappe.qb.DocType("Work Order") + pp_item = frappe.qb.DocType("Production Plan Item") + + broken_work_orders = ( + frappe.qb.from_(work_order) + .left_join(pp_item) + .on(work_order.production_plan_item == pp_item.name) + .select(work_order.name) + .where( + (work_order.docstatus == 0) + & (work_order.production_plan_item.notnull()) + & (work_order.production_plan_item.like("new-production-plan%")) + & (pp_item.name.isnull()) + ) + ).run() + + if not broken_work_orders: + return + + broken_work_order_names = [d[0] for d in broken_work_orders] + + ( + frappe.qb.update(work_order) + .set(work_order.production_plan_item, None) + .where(work_order.name.isin(broken_work_order_names)) + ).run() diff --git a/erpnext/patches/v13_0/rename_discharge_date_in_ip_record.py b/erpnext/patches/v13_0/rename_discharge_date_in_ip_record.py index e9778043229..3bd717d77b8 100644 --- a/erpnext/patches/v13_0/rename_discharge_date_in_ip_record.py +++ b/erpnext/patches/v13_0/rename_discharge_date_in_ip_record.py @@ -1,4 +1,3 @@ - import frappe from frappe.model.utils.rename_field import rename_field diff --git a/erpnext/patches/v13_0/rename_discharge_ordered_date_in_ip_record.py b/erpnext/patches/v13_0/rename_discharge_ordered_date_in_ip_record.py index 002166409dc..7010f47275b 100644 --- a/erpnext/patches/v13_0/rename_discharge_ordered_date_in_ip_record.py +++ b/erpnext/patches/v13_0/rename_discharge_ordered_date_in_ip_record.py @@ -1,4 +1,3 @@ - import frappe from frappe.model.utils.rename_field import rename_field diff --git a/erpnext/patches/v13_0/rename_issue_doctype_fields.py b/erpnext/patches/v13_0/rename_issue_doctype_fields.py index bf5438c4d2e..a9b6df70985 100644 --- a/erpnext/patches/v13_0/rename_issue_doctype_fields.py +++ b/erpnext/patches/v13_0/rename_issue_doctype_fields.py @@ -7,63 +7,78 @@ from frappe.model.utils.rename_field import rename_field def execute(): - if frappe.db.exists('DocType', 'Issue'): - issues = frappe.db.get_all('Issue', fields=['name', 'response_by_variance', 'resolution_by_variance', 'mins_to_first_response'], - order_by='creation desc') - frappe.reload_doc('support', 'doctype', 'issue') + if frappe.db.exists("DocType", "Issue"): + issues = frappe.db.get_all( + "Issue", + fields=["name", "response_by_variance", "resolution_by_variance", "mins_to_first_response"], + order_by="creation desc", + ) + frappe.reload_doc("support", "doctype", "issue") # rename fields rename_map = { - 'agreement_fulfilled': 'agreement_status', - 'mins_to_first_response': 'first_response_time' + "agreement_fulfilled": "agreement_status", + "mins_to_first_response": "first_response_time", } for old, new in rename_map.items(): - rename_field('Issue', old, new) + rename_field("Issue", old, new) # change fieldtype to duration count = 0 for entry in issues: - response_by_variance = convert_to_seconds(entry.response_by_variance, 'Hours') - resolution_by_variance = convert_to_seconds(entry.resolution_by_variance, 'Hours') - mins_to_first_response = convert_to_seconds(entry.mins_to_first_response, 'Minutes') - frappe.db.set_value('Issue', entry.name, { - 'response_by_variance': response_by_variance, - 'resolution_by_variance': resolution_by_variance, - 'first_response_time': mins_to_first_response - }, update_modified=False) + response_by_variance = convert_to_seconds(entry.response_by_variance, "Hours") + resolution_by_variance = convert_to_seconds(entry.resolution_by_variance, "Hours") + mins_to_first_response = convert_to_seconds(entry.mins_to_first_response, "Minutes") + frappe.db.set_value( + "Issue", + entry.name, + { + "response_by_variance": response_by_variance, + "resolution_by_variance": resolution_by_variance, + "first_response_time": mins_to_first_response, + }, + update_modified=False, + ) # commit after every 100 updates count += 1 - if count%100 == 0: + if count % 100 == 0: frappe.db.commit() - if frappe.db.exists('DocType', 'Opportunity'): - opportunities = frappe.db.get_all('Opportunity', fields=['name', 'mins_to_first_response'], order_by='creation desc') - frappe.reload_doctype('Opportunity', force=True) - rename_field('Opportunity', 'mins_to_first_response', 'first_response_time') + if frappe.db.exists("DocType", "Opportunity"): + opportunities = frappe.db.get_all( + "Opportunity", fields=["name", "mins_to_first_response"], order_by="creation desc" + ) + frappe.reload_doctype("Opportunity", force=True) + rename_field("Opportunity", "mins_to_first_response", "first_response_time") # change fieldtype to duration - frappe.reload_doc('crm', 'doctype', 'opportunity', force=True) + frappe.reload_doc("crm", "doctype", "opportunity", force=True) count = 0 for entry in opportunities: - mins_to_first_response = convert_to_seconds(entry.mins_to_first_response, 'Minutes') - frappe.db.set_value('Opportunity', entry.name, 'first_response_time', mins_to_first_response, update_modified=False) + mins_to_first_response = convert_to_seconds(entry.mins_to_first_response, "Minutes") + frappe.db.set_value( + "Opportunity", entry.name, "first_response_time", mins_to_first_response, update_modified=False + ) # commit after every 100 updates count += 1 - if count%100 == 0: + if count % 100 == 0: frappe.db.commit() # renamed reports from "Minutes to First Response for Issues" to "First Response Time for Issues". Same for Opportunity - for report in ['Minutes to First Response for Issues', 'Minutes to First Response for Opportunity']: - if frappe.db.exists('Report', report): - frappe.delete_doc('Report', report, ignore_permissions=True) + for report in [ + "Minutes to First Response for Issues", + "Minutes to First Response for Opportunity", + ]: + if frappe.db.exists("Report", report): + frappe.delete_doc("Report", report, ignore_permissions=True) def convert_to_seconds(value, unit): seconds = 0 - if value == 0: + if not value: return seconds - if unit == 'Hours': + if unit == "Hours": seconds = value * 3600 - if unit == 'Minutes': + if unit == "Minutes": seconds = value * 60 return seconds diff --git a/erpnext/patches/v13_0/rename_issue_status_hold_to_on_hold.py b/erpnext/patches/v13_0/rename_issue_status_hold_to_on_hold.py index b129cbe80bc..d3896dd0a84 100644 --- a/erpnext/patches/v13_0/rename_issue_status_hold_to_on_hold.py +++ b/erpnext/patches/v13_0/rename_issue_status_hold_to_on_hold.py @@ -6,16 +6,19 @@ import frappe def execute(): - if frappe.db.exists('DocType', 'Issue'): + if frappe.db.exists("DocType", "Issue"): frappe.reload_doc("support", "doctype", "issue") rename_status() + def rename_status(): - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabIssue` SET status = 'On Hold' WHERE status = 'Hold' - """) + """ + ) diff --git a/erpnext/patches/v13_0/rename_ksa_qr_field.py b/erpnext/patches/v13_0/rename_ksa_qr_field.py index f4f9b17fb81..e4b91412ee1 100644 --- a/erpnext/patches/v13_0/rename_ksa_qr_field.py +++ b/erpnext/patches/v13_0/rename_ksa_qr_field.py @@ -7,26 +7,30 @@ from frappe.model.utils.rename_field import rename_field def execute(): - company = frappe.get_all('Company', filters = {'country': 'Saudi Arabia'}) + company = frappe.get_all("Company", filters={"country": "Saudi Arabia"}) if not company: return - if frappe.db.exists('DocType', 'Sales Invoice'): - frappe.reload_doc('accounts', 'doctype', 'sales_invoice', force=True) + if frappe.db.exists("DocType", "Sales Invoice"): + frappe.reload_doc("accounts", "doctype", "sales_invoice", force=True) # rename_field method assumes that the field already exists or the doc is synced - if not frappe.db.has_column('Sales Invoice', 'ksa_einv_qr'): - create_custom_fields({ - 'Sales Invoice': [ - dict( - fieldname='ksa_einv_qr', - label='KSA E-Invoicing QR', - fieldtype='Attach Image', - read_only=1, no_copy=1, hidden=1 - ) - ] - }) + if not frappe.db.has_column("Sales Invoice", "ksa_einv_qr"): + create_custom_fields( + { + "Sales Invoice": [ + dict( + fieldname="ksa_einv_qr", + label="KSA E-Invoicing QR", + fieldtype="Attach Image", + read_only=1, + no_copy=1, + hidden=1, + ) + ] + } + ) - if frappe.db.has_column('Sales Invoice', 'qr_code'): - rename_field('Sales Invoice', 'qr_code', 'ksa_einv_qr') + if frappe.db.has_column("Sales Invoice", "qr_code"): + rename_field("Sales Invoice", "qr_code", "ksa_einv_qr") frappe.delete_doc_if_exists("Custom Field", "Sales Invoice-qr_code") diff --git a/erpnext/patches/v13_0/rename_membership_settings_to_non_profit_settings.py b/erpnext/patches/v13_0/rename_membership_settings_to_non_profit_settings.py index ecd03441e0a..9f75869d89b 100644 --- a/erpnext/patches/v13_0/rename_membership_settings_to_non_profit_settings.py +++ b/erpnext/patches/v13_0/rename_membership_settings_to_non_profit_settings.py @@ -1,14 +1,13 @@ - import frappe from frappe.model.utils.rename_field import rename_field def execute(): - if frappe.db.table_exists("Membership Settings"): + if frappe.db.exists("DocType", "Membership Settings"): frappe.rename_doc("DocType", "Membership Settings", "Non Profit Settings") frappe.reload_doctype("Non Profit Settings", force=True) - if frappe.db.table_exists("Non Profit Settings"): + if frappe.db.exists("DocType", "Non Profit Settings"): rename_fields_map = { "enable_invoicing": "allow_invoicing", "create_for_web_forms": "automate_membership_invoicing", @@ -16,8 +15,10 @@ def execute(): "enable_razorpay": "enable_razorpay_for_memberships", "debit_account": "membership_debit_account", "payment_account": "membership_payment_account", - "webhook_secret": "membership_webhook_secret" + "webhook_secret": "membership_webhook_secret", } for old_name, new_name in rename_fields_map.items(): rename_field("Non Profit Settings", old_name, new_name) + + frappe.delete_doc_if_exists("DocType", "Membership Settings") diff --git a/erpnext/patches/v13_0/rename_non_profit_fields.py b/erpnext/patches/v13_0/rename_non_profit_fields.py new file mode 100644 index 00000000000..285403c004f --- /dev/null +++ b/erpnext/patches/v13_0/rename_non_profit_fields.py @@ -0,0 +1,16 @@ +import frappe +from frappe.model.utils.rename_field import rename_field + + +def execute(): + if frappe.db.table_exists("Donation"): + frappe.reload_doc("non_profit", "doctype", "Donation") + + rename_field("Donation", "razorpay_payment_id", "payment_id") + + if frappe.db.table_exists("Tax Exemption 80G Certificate"): + frappe.reload_doc("regional", "doctype", "Tax Exemption 80G Certificate") + frappe.reload_doc("regional", "doctype", "Tax Exemption 80G Certificate Detail") + + rename_field("Tax Exemption 80G Certificate", "razorpay_payment_id", "payment_id") + rename_field("Tax Exemption 80G Certificate Detail", "razorpay_payment_id", "payment_id") diff --git a/erpnext/patches/v13_0/rename_stop_to_send_birthday_reminders.py b/erpnext/patches/v13_0/rename_stop_to_send_birthday_reminders.py index 28054317ad3..434dbb47e76 100644 --- a/erpnext/patches/v13_0/rename_stop_to_send_birthday_reminders.py +++ b/erpnext/patches/v13_0/rename_stop_to_send_birthday_reminders.py @@ -3,22 +3,19 @@ from frappe.model.utils.rename_field import rename_field def execute(): - frappe.reload_doc('hr', 'doctype', 'hr_settings') + frappe.reload_doc("hr", "doctype", "hr_settings") try: # Rename the field - rename_field('HR Settings', 'stop_birthday_reminders', 'send_birthday_reminders') + rename_field("HR Settings", "stop_birthday_reminders", "send_birthday_reminders") # Reverse the value - old_value = frappe.db.get_single_value('HR Settings', 'send_birthday_reminders') + old_value = frappe.db.get_single_value("HR Settings", "send_birthday_reminders") frappe.db.set_value( - 'HR Settings', - 'HR Settings', - 'send_birthday_reminders', - 1 if old_value == 0 else 0 + "HR Settings", "HR Settings", "send_birthday_reminders", 1 if old_value == 0 else 0 ) except Exception as e: if e.args[0] != 1054: - raise \ No newline at end of file + raise diff --git a/erpnext/patches/v13_0/replace_pos_page_with_point_of_sale_page.py b/erpnext/patches/v13_0/replace_pos_page_with_point_of_sale_page.py index f49b1e4bd8c..7d757b7a0fb 100644 --- a/erpnext/patches/v13_0/replace_pos_page_with_point_of_sale_page.py +++ b/erpnext/patches/v13_0/replace_pos_page_with_point_of_sale_page.py @@ -1,4 +1,3 @@ - import frappe diff --git a/erpnext/patches/v13_0/replace_pos_payment_mode_table.py b/erpnext/patches/v13_0/replace_pos_payment_mode_table.py index a2c960c8f37..ba2feb3a4d0 100644 --- a/erpnext/patches/v13_0/replace_pos_payment_mode_table.py +++ b/erpnext/patches/v13_0/replace_pos_payment_mode_table.py @@ -10,9 +10,13 @@ def execute(): pos_profiles = frappe.get_all("POS Profile") for pos_profile in pos_profiles: - payments = frappe.db.sql(""" + payments = frappe.db.sql( + """ select idx, parentfield, parenttype, parent, mode_of_payment, `default` from `tabSales Invoice Payment` where parent=%s - """, pos_profile.name, as_dict=1) + """, + pos_profile.name, + as_dict=1, + ) if payments: for payment_mode in payments: pos_payment_method = frappe.new_doc("POS Payment Method") diff --git a/erpnext/patches/v13_0/replace_supplier_item_group_with_party_specific_item.py b/erpnext/patches/v13_0/replace_supplier_item_group_with_party_specific_item.py index ba96fdd2266..bf82f443082 100644 --- a/erpnext/patches/v13_0/replace_supplier_item_group_with_party_specific_item.py +++ b/erpnext/patches/v13_0/replace_supplier_item_group_with_party_specific_item.py @@ -5,7 +5,7 @@ import frappe def execute(): - if frappe.db.table_exists('Supplier Item Group'): + if frappe.db.table_exists("Supplier Item Group"): frappe.reload_doc("selling", "doctype", "party_specific_item") sig = frappe.db.get_all("Supplier Item Group", fields=["name", "supplier", "item_group"]) for item in sig: diff --git a/erpnext/patches/v13_0/requeue_failed_reposts.py b/erpnext/patches/v13_0/requeue_failed_reposts.py index 213cb9e26e4..752490da304 100644 --- a/erpnext/patches/v13_0/requeue_failed_reposts.py +++ b/erpnext/patches/v13_0/requeue_failed_reposts.py @@ -4,9 +4,11 @@ from frappe.utils import cstr def execute(): - reposts = frappe.get_all("Repost Item Valuation", - {"status": "Failed", "modified": [">", "2021-10-05"] }, - ["name", "modified", "error_log"]) + reposts = frappe.get_all( + "Repost Item Valuation", + {"status": "Failed", "modified": [">", "2021-10-05"]}, + ["name", "modified", "error_log"], + ) for repost in reposts: if "check_freezing_date" in cstr(repost.error_log): diff --git a/erpnext/patches/v13_0/requeue_recoverable_reposts.py b/erpnext/patches/v13_0/requeue_recoverable_reposts.py new file mode 100644 index 00000000000..f37c21c9769 --- /dev/null +++ b/erpnext/patches/v13_0/requeue_recoverable_reposts.py @@ -0,0 +1,21 @@ +import frappe + + +def execute(): + recoverable = ("QueryDeadlockError", "QueryTimeoutError", "JobTimeoutException") + + failed_reposts = frappe.get_all( + "Repost Item Valuation", + fields=["name", "error_log"], + filters={ + "status": "Failed", + "docstatus": 1, + "modified": (">", "2022-04-20"), + "error_log": ("is", "set"), + }, + ) + for riv in failed_reposts: + for exc in recoverable: + if exc in riv.error_log: + frappe.db.set_value("Repost Item Valuation", riv.name, "status", "Queued") + break diff --git a/erpnext/patches/v13_0/reset_clearance_date_for_intracompany_payment_entries.py b/erpnext/patches/v13_0/reset_clearance_date_for_intracompany_payment_entries.py index e6717c57db3..5dfea5eaed7 100644 --- a/erpnext/patches/v13_0/reset_clearance_date_for_intracompany_payment_entries.py +++ b/erpnext/patches/v13_0/reset_clearance_date_for_intracompany_payment_entries.py @@ -6,40 +6,35 @@ import frappe def execute(): - """ - Reset Clearance Date for Payment Entries of type Internal Transfer that have only been reconciled with one Bank Transaction. - This will allow the Payment Entries to be reconciled with the second Bank Transaction using the Bank Reconciliation Tool. - """ + """ + Reset Clearance Date for Payment Entries of type Internal Transfer that have only been reconciled with one Bank Transaction. + This will allow the Payment Entries to be reconciled with the second Bank Transaction using the Bank Reconciliation Tool. + """ - intra_company_pe = get_intra_company_payment_entries_with_clearance_dates() - reconciled_bank_transactions = get_reconciled_bank_transactions(intra_company_pe) + intra_company_pe = get_intra_company_payment_entries_with_clearance_dates() + reconciled_bank_transactions = get_reconciled_bank_transactions(intra_company_pe) + + for payment_entry in reconciled_bank_transactions: + if len(reconciled_bank_transactions[payment_entry]) == 1: + frappe.db.set_value("Payment Entry", payment_entry, "clearance_date", None) - for payment_entry in reconciled_bank_transactions: - if len(reconciled_bank_transactions[payment_entry]) == 1: - frappe.db.set_value('Payment Entry', payment_entry, 'clearance_date', None) def get_intra_company_payment_entries_with_clearance_dates(): - return frappe.get_all( - 'Payment Entry', - filters = { - 'payment_type': 'Internal Transfer', - 'clearance_date': ["not in", None] - }, - pluck = 'name' - ) + return frappe.get_all( + "Payment Entry", + filters={"payment_type": "Internal Transfer", "clearance_date": ["not in", None]}, + pluck="name", + ) + def get_reconciled_bank_transactions(intra_company_pe): - """Returns dictionary where each key:value pair is Payment Entry : List of Bank Transactions reconciled with Payment Entry""" + """Returns dictionary where each key:value pair is Payment Entry : List of Bank Transactions reconciled with Payment Entry""" - reconciled_bank_transactions = {} + reconciled_bank_transactions = {} - for payment_entry in intra_company_pe: - reconciled_bank_transactions[payment_entry] = frappe.get_all( - 'Bank Transaction Payments', - filters = { - 'payment_entry': payment_entry - }, - pluck='parent' - ) + for payment_entry in intra_company_pe: + reconciled_bank_transactions[payment_entry] = frappe.get_all( + "Bank Transaction Payments", filters={"payment_entry": payment_entry}, pluck="parent" + ) - return reconciled_bank_transactions \ No newline at end of file + return reconciled_bank_transactions diff --git a/erpnext/patches/v13_0/reset_corrupt_defaults.py b/erpnext/patches/v13_0/reset_corrupt_defaults.py new file mode 100644 index 00000000000..7a6d50f19d6 --- /dev/null +++ b/erpnext/patches/v13_0/reset_corrupt_defaults.py @@ -0,0 +1,29 @@ +import frappe + + +def execute(): + """ + This patch is needed to fix parent incorrectly set as `__2fa` because of + https://github.com/frappe/frappe/commit/a822092211533ff17ff9b92dd86f6f868ed63e2e + """ + + for doctype in ( + "Accounts Settings", + "Stock Settings", + "Selling Settings", + "Buying Settings", + "CRM Settings", + "Global Defaults", + "Healthcare Settings", + "Education Settings", + ): + try: + frappe.get_single(doctype).save() + except Exception: + pass + + try: + pos_profile = frappe.get_last_doc("POS Profile") + pos_profile.set_defaults() + except Exception: + pass diff --git a/erpnext/patches/v13_0/set_available_for_use_date_if_missing.py b/erpnext/patches/v13_0/set_available_for_use_date_if_missing.py new file mode 100644 index 00000000000..6c522789892 --- /dev/null +++ b/erpnext/patches/v13_0/set_available_for_use_date_if_missing.py @@ -0,0 +1,19 @@ +import frappe + + +def execute(): + """ + Sets available-for-use date for Assets created in older versions of ERPNext, + before the field was introduced. + """ + + assets = get_assets_without_available_for_use_date() + + for asset in assets: + frappe.db.set_value("Asset", asset.name, "available_for_use_date", asset.purchase_date) + + +def get_assets_without_available_for_use_date(): + return frappe.get_all( + "Asset", filters={"available_for_use_date": ["in", ["", None]]}, fields=["name", "purchase_date"] + ) diff --git a/erpnext/patches/v13_0/set_company_field_in_healthcare_doctypes.py b/erpnext/patches/v13_0/set_company_field_in_healthcare_doctypes.py index b955686a17e..bc2d1b94f79 100644 --- a/erpnext/patches/v13_0/set_company_field_in_healthcare_doctypes.py +++ b/erpnext/patches/v13_0/set_company_field_in_healthcare_doctypes.py @@ -1,11 +1,25 @@ - import frappe def execute(): - company = frappe.db.get_single_value('Global Defaults', 'default_company') - doctypes = ['Clinical Procedure', 'Inpatient Record', 'Lab Test', 'Sample Collection', 'Patient Appointment', 'Patient Encounter', 'Vital Signs', 'Therapy Session', 'Therapy Plan', 'Patient Assessment'] + company = frappe.db.get_single_value("Global Defaults", "default_company") + doctypes = [ + "Clinical Procedure", + "Inpatient Record", + "Lab Test", + "Sample Collection", + "Patient Appointment", + "Patient Encounter", + "Vital Signs", + "Therapy Session", + "Therapy Plan", + "Patient Assessment", + ] for entry in doctypes: - if frappe.db.exists('DocType', entry): - frappe.reload_doc('Healthcare', 'doctype', entry) - frappe.db.sql("update `tab{dt}` set company = {company} where ifnull(company, '') = ''".format(dt=entry, company=frappe.db.escape(company))) + if frappe.db.exists("DocType", entry): + frappe.reload_doc("Healthcare", "doctype", entry) + frappe.db.sql( + "update `tab{dt}` set company = {company} where ifnull(company, '') = ''".format( + dt=entry, company=frappe.db.escape(company) + ) + ) diff --git a/erpnext/patches/v13_0/set_company_in_leave_ledger_entry.py b/erpnext/patches/v13_0/set_company_in_leave_ledger_entry.py index c744f35b72f..adc8784b5ba 100644 --- a/erpnext/patches/v13_0/set_company_in_leave_ledger_entry.py +++ b/erpnext/patches/v13_0/set_company_in_leave_ledger_entry.py @@ -2,7 +2,11 @@ import frappe def execute(): - frappe.reload_doc('HR', 'doctype', 'Leave Allocation') - frappe.reload_doc('HR', 'doctype', 'Leave Ledger Entry') - frappe.db.sql("""update `tabLeave Ledger Entry` as lle set company = (select company from `tabEmployee` where employee = lle.employee)""") - frappe.db.sql("""update `tabLeave Allocation` as la set company = (select company from `tabEmployee` where employee = la.employee)""") + frappe.reload_doc("HR", "doctype", "Leave Allocation") + frappe.reload_doc("HR", "doctype", "Leave Ledger Entry") + frappe.db.sql( + """update `tabLeave Ledger Entry` as lle set company = (select company from `tabEmployee` where employee = lle.employee)""" + ) + frappe.db.sql( + """update `tabLeave Allocation` as la set company = (select company from `tabEmployee` where employee = la.employee)""" + ) diff --git a/erpnext/patches/v13_0/set_operation_time_based_on_operating_cost.py b/erpnext/patches/v13_0/set_operation_time_based_on_operating_cost.py index 0366d4902dc..ef02e250c89 100644 --- a/erpnext/patches/v13_0/set_operation_time_based_on_operating_cost.py +++ b/erpnext/patches/v13_0/set_operation_time_based_on_operating_cost.py @@ -2,10 +2,11 @@ import frappe def execute(): - frappe.reload_doc('manufacturing', 'doctype', 'bom') - frappe.reload_doc('manufacturing', 'doctype', 'bom_operation') + frappe.reload_doc("manufacturing", "doctype", "bom") + frappe.reload_doc("manufacturing", "doctype", "bom_operation") - frappe.db.sql(''' + frappe.db.sql( + """ UPDATE `tabBOM Operation` SET @@ -13,4 +14,5 @@ def execute(): WHERE time_in_mins = 0 AND operating_cost > 0 AND hour_rate > 0 AND docstatus = 1 AND parenttype = "BOM" - ''') \ No newline at end of file + """ + ) diff --git a/erpnext/patches/v13_0/set_payment_channel_in_payment_gateway_account.py b/erpnext/patches/v13_0/set_payment_channel_in_payment_gateway_account.py index 3b751415eed..0cefa028ec4 100644 --- a/erpnext/patches/v13_0/set_payment_channel_in_payment_gateway_account.py +++ b/erpnext/patches/v13_0/set_payment_channel_in_payment_gateway_account.py @@ -1,4 +1,3 @@ - import frappe @@ -11,8 +10,11 @@ def execute(): frappe.reload_doc("Accounts", "doctype", "Payment Gateway Account") set_payment_channel_as_email() + def set_payment_channel_as_email(): - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabPayment Gateway Account` SET `payment_channel` = "Email" - """) + """ + ) diff --git a/erpnext/patches/v13_0/set_per_billed_in_return_delivery_note.py b/erpnext/patches/v13_0/set_per_billed_in_return_delivery_note.py new file mode 100644 index 00000000000..a4d70124492 --- /dev/null +++ b/erpnext/patches/v13_0/set_per_billed_in_return_delivery_note.py @@ -0,0 +1,29 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +# For license information, please see license.txt + +import frappe + + +def execute(): + dn = frappe.qb.DocType("Delivery Note") + dn_item = frappe.qb.DocType("Delivery Note Item") + + dn_list = ( + frappe.qb.from_(dn) + .inner_join(dn_item) + .on(dn.name == dn_item.parent) + .select(dn.name) + .where(dn.docstatus == 1) + .where(dn.is_return == 1) + .where(dn.per_billed < 100) + .where(dn_item.returned_qty > 0) + .run(as_dict=True) + ) + + frappe.qb.update(dn_item).inner_join(dn).on(dn.name == dn_item.parent).set( + dn_item.returned_qty, 0 + ).where(dn.is_return == 1).where(dn_item.returned_qty > 0).run() + + for d in dn_list: + dn_doc = frappe.get_doc("Delivery Note", d.get("name")) + dn_doc.run_method("update_billing_status") diff --git a/erpnext/patches/v13_0/set_pos_closing_as_failed.py b/erpnext/patches/v13_0/set_pos_closing_as_failed.py index a838ce07b93..e2226c1cf0a 100644 --- a/erpnext/patches/v13_0/set_pos_closing_as_failed.py +++ b/erpnext/patches/v13_0/set_pos_closing_as_failed.py @@ -1,8 +1,7 @@ - import frappe def execute(): - frappe.reload_doc('accounts', 'doctype', 'pos_closing_entry') + frappe.reload_doc("accounts", "doctype", "pos_closing_entry") - frappe.db.sql("update `tabPOS Closing Entry` set `status` = 'Failed' where `status` = 'Queued'") + frappe.db.sql("update `tabPOS Closing Entry` set `status` = 'Failed' where `status` = 'Queued'") diff --git a/erpnext/patches/v13_0/set_return_against_in_pos_invoice_references.py b/erpnext/patches/v13_0/set_return_against_in_pos_invoice_references.py new file mode 100644 index 00000000000..fe9eb8b2cc1 --- /dev/null +++ b/erpnext/patches/v13_0/set_return_against_in_pos_invoice_references.py @@ -0,0 +1,40 @@ +import frappe + + +def execute(): + """ + Fetch and Set is_return & return_against from POS Invoice in POS Invoice References table. + """ + + POSClosingEntry = frappe.qb.DocType("POS Closing Entry") + open_pos_closing_entries = ( + frappe.qb.from_(POSClosingEntry) + .select(POSClosingEntry.name) + .where(POSClosingEntry.docstatus == 0) + .run() + ) + if open_pos_closing_entries: + open_pos_closing_entries = [d[0] for d in open_pos_closing_entries] + + if not open_pos_closing_entries: + return + + frappe.reload_doc("Accounts", "doctype", "pos_invoice_reference") + + POSInvoiceReference = frappe.qb.DocType("POS Invoice Reference") + POSInvoice = frappe.qb.DocType("POS Invoice") + pos_invoice_references = ( + frappe.qb.from_(POSInvoiceReference) + .join(POSInvoice) + .on(POSInvoiceReference.pos_invoice == POSInvoice.name) + .select(POSInvoiceReference.name, POSInvoice.is_return, POSInvoice.return_against) + .where(POSInvoiceReference.parent.isin(open_pos_closing_entries)) + .run(as_dict=True) + ) + + for row in pos_invoice_references: + frappe.db.set_value("POS Invoice Reference", row.name, "is_return", row.is_return) + if row.is_return: + frappe.db.set_value("POS Invoice Reference", row.name, "return_against", row.return_against) + else: + frappe.db.set_value("POS Invoice Reference", row.name, "return_against", None) diff --git a/erpnext/patches/v13_0/set_status_in_maintenance_schedule_table.py b/erpnext/patches/v13_0/set_status_in_maintenance_schedule_table.py index 9887ad9df0c..e1c8526f10d 100644 --- a/erpnext/patches/v13_0/set_status_in_maintenance_schedule_table.py +++ b/erpnext/patches/v13_0/set_status_in_maintenance_schedule_table.py @@ -3,8 +3,10 @@ import frappe def execute(): frappe.reload_doc("maintenance", "doctype", "Maintenance Schedule Detail") - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabMaintenance Schedule Detail` SET completion_status = 'Pending' WHERE docstatus < 2 - """) + """ + ) diff --git a/erpnext/patches/v13_0/set_training_event_attendance.py b/erpnext/patches/v13_0/set_training_event_attendance.py index 27a9d3ff089..7b557589723 100644 --- a/erpnext/patches/v13_0/set_training_event_attendance.py +++ b/erpnext/patches/v13_0/set_training_event_attendance.py @@ -1,10 +1,11 @@ - import frappe def execute(): - frappe.reload_doc('hr', 'doctype', 'training_event') - frappe.reload_doc('hr', 'doctype', 'training_event_employee') + frappe.reload_doc("hr", "doctype", "training_event") + frappe.reload_doc("hr", "doctype", "training_event_employee") - frappe.db.sql("update `tabTraining Event Employee` set `attendance` = 'Present'") - frappe.db.sql("update `tabTraining Event Employee` set `is_mandatory` = 1 where `attendance` = 'Mandatory'") + frappe.db.sql("update `tabTraining Event Employee` set `attendance` = 'Present'") + frappe.db.sql( + "update `tabTraining Event Employee` set `is_mandatory` = 1 where `attendance` = 'Mandatory'" + ) diff --git a/erpnext/patches/v13_0/set_work_order_qty_in_so_from_mr.py b/erpnext/patches/v13_0/set_work_order_qty_in_so_from_mr.py new file mode 100644 index 00000000000..1adf0d84538 --- /dev/null +++ b/erpnext/patches/v13_0/set_work_order_qty_in_so_from_mr.py @@ -0,0 +1,38 @@ +import frappe + + +def execute(): + """ + 1. Get submitted Work Orders with MR, MR Item and SO set + 2. Get SO Item detail from MR Item detail in WO, and set in WO + 3. Update work_order_qty in SO + """ + work_order = frappe.qb.DocType("Work Order") + query = ( + frappe.qb.from_(work_order) + .select( + work_order.name, + work_order.produced_qty, + work_order.material_request, + work_order.material_request_item, + work_order.sales_order, + ) + .where( + (work_order.material_request.isnotnull()) + & (work_order.material_request_item.isnotnull()) + & (work_order.sales_order.isnotnull()) + & (work_order.docstatus == 1) + & (work_order.produced_qty > 0) + ) + ) + results = query.run(as_dict=True) + + for row in results: + so_item = frappe.get_value( + "Material Request Item", row.material_request_item, "sales_order_item" + ) + frappe.db.set_value("Work Order", row.name, "sales_order_item", so_item) + + if so_item: + wo = frappe.get_doc("Work Order", row.name) + wo.update_work_order_qty_in_so() diff --git a/erpnext/patches/v13_0/set_youtube_video_id.py b/erpnext/patches/v13_0/set_youtube_video_id.py index 76aaaea279c..9766bb871cf 100644 --- a/erpnext/patches/v13_0/set_youtube_video_id.py +++ b/erpnext/patches/v13_0/set_youtube_video_id.py @@ -1,11 +1,10 @@ - import frappe from erpnext.utilities.doctype.video.video import get_id_from_url def execute(): - frappe.reload_doc("utilities", "doctype","video") + frappe.reload_doc("utilities", "doctype", "video") for video in frappe.get_all("Video", fields=["name", "url", "youtube_video_id"]): if video.url and not video.youtube_video_id: diff --git a/erpnext/patches/v13_0/setting_custom_roles_for_some_regional_reports.py b/erpnext/patches/v13_0/setting_custom_roles_for_some_regional_reports.py index 36bedf4f9ba..40c10f30354 100644 --- a/erpnext/patches/v13_0/setting_custom_roles_for_some_regional_reports.py +++ b/erpnext/patches/v13_0/setting_custom_roles_for_some_regional_reports.py @@ -1,12 +1,11 @@ - import frappe from erpnext.regional.india.setup import add_custom_roles_for_reports def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) - if not company: - return + company = frappe.get_all("Company", filters={"country": "India"}) + if not company: + return - add_custom_roles_for_reports() + add_custom_roles_for_reports() diff --git a/erpnext/patches/v13_0/setup_fields_for_80g_certificate_and_donation.py b/erpnext/patches/v13_0/setup_fields_for_80g_certificate_and_donation.py index 7a2a2539670..1c36b536841 100644 --- a/erpnext/patches/v13_0/setup_fields_for_80g_certificate_and_donation.py +++ b/erpnext/patches/v13_0/setup_fields_for_80g_certificate_and_donation.py @@ -4,12 +4,13 @@ from erpnext.regional.india.setup import make_custom_fields def execute(): - if frappe.get_all('Company', filters = {'country': 'India'}): + if frappe.get_all("Company", filters={"country": "India"}): + frappe.reload_doc("accounts", "doctype", "POS Invoice") + frappe.reload_doc("accounts", "doctype", "POS Invoice Item") + make_custom_fields() - if not frappe.db.exists('Party Type', 'Donor'): - frappe.get_doc({ - 'doctype': 'Party Type', - 'party_type': 'Donor', - 'account_type': 'Receivable' - }).insert(ignore_permissions=True) + if not frappe.db.exists("Party Type", "Donor"): + frappe.get_doc( + {"doctype": "Party Type", "party_type": "Donor", "account_type": "Receivable"} + ).insert(ignore_permissions=True) diff --git a/erpnext/patches/v13_0/setup_gratuity_rule_for_india_and_uae.py b/erpnext/patches/v13_0/setup_gratuity_rule_for_india_and_uae.py index 82cc1ff771c..093e8a7646f 100644 --- a/erpnext/patches/v13_0/setup_gratuity_rule_for_india_and_uae.py +++ b/erpnext/patches/v13_0/setup_gratuity_rule_for_india_and_uae.py @@ -6,12 +6,14 @@ import frappe def execute(): - frappe.reload_doc('payroll', 'doctype', 'gratuity_rule') - frappe.reload_doc('payroll', 'doctype', 'gratuity_rule_slab') - frappe.reload_doc('payroll', 'doctype', 'gratuity_applicable_component') - if frappe.db.exists("Company", {"country": "India"}): - from erpnext.regional.india.setup import create_gratuity_rule - create_gratuity_rule() - if frappe.db.exists("Company", {"country": "United Arab Emirates"}): - from erpnext.regional.united_arab_emirates.setup import create_gratuity_rule - create_gratuity_rule() + frappe.reload_doc("payroll", "doctype", "gratuity_rule") + frappe.reload_doc("payroll", "doctype", "gratuity_rule_slab") + frappe.reload_doc("payroll", "doctype", "gratuity_applicable_component") + if frappe.db.exists("Company", {"country": "India"}): + from erpnext.regional.india.setup import create_gratuity_rule + + create_gratuity_rule() + if frappe.db.exists("Company", {"country": "United Arab Emirates"}): + from erpnext.regional.united_arab_emirates.setup import create_gratuity_rule + + create_gratuity_rule() diff --git a/erpnext/patches/v13_0/setup_patient_history_settings_for_standard_doctypes.py b/erpnext/patches/v13_0/setup_patient_history_settings_for_standard_doctypes.py index ee8f96d0070..339acfe426b 100644 --- a/erpnext/patches/v13_0/setup_patient_history_settings_for_standard_doctypes.py +++ b/erpnext/patches/v13_0/setup_patient_history_settings_for_standard_doctypes.py @@ -1,4 +1,3 @@ - import frappe from erpnext.healthcare.setup import setup_patient_history_settings diff --git a/erpnext/patches/v13_0/setup_uae_vat_fields.py b/erpnext/patches/v13_0/setup_uae_vat_fields.py index d89e0521d8d..70466465e42 100644 --- a/erpnext/patches/v13_0/setup_uae_vat_fields.py +++ b/erpnext/patches/v13_0/setup_uae_vat_fields.py @@ -7,12 +7,12 @@ from erpnext.regional.united_arab_emirates.setup import setup def execute(): - company = frappe.get_all('Company', filters = {'country': 'United Arab Emirates'}) + company = frappe.get_all("Company", filters={"country": "United Arab Emirates"}) if not company: return - frappe.reload_doc('regional', 'report', 'uae_vat_201') - frappe.reload_doc('regional', 'doctype', 'uae_vat_settings') - frappe.reload_doc('regional', 'doctype', 'uae_vat_account') + frappe.reload_doc("regional", "report", "uae_vat_201") + frappe.reload_doc("regional", "doctype", "uae_vat_settings") + frappe.reload_doc("regional", "doctype", "uae_vat_account") setup() diff --git a/erpnext/patches/v13_0/show_hr_payroll_deprecation_warning.py b/erpnext/patches/v13_0/show_hr_payroll_deprecation_warning.py new file mode 100644 index 00000000000..c9cb7ac5e25 --- /dev/null +++ b/erpnext/patches/v13_0/show_hr_payroll_deprecation_warning.py @@ -0,0 +1,16 @@ +import click +import frappe + + +def execute(): + if "hrms" in frappe.get_installed_apps(): + return + + click.secho( + "HR and Payroll modules have been moved to a separate app" + " and will be removed from ERPNext in Version 14." + " Please install the HRMS app when upgrading to Version 14" + " to continue using the HR and Payroll modules:\n" + "https://github.com/frappe/hrms", + fg="yellow", + ) diff --git a/erpnext/patches/v13_0/show_india_localisation_deprecation_warning.py b/erpnext/patches/v13_0/show_india_localisation_deprecation_warning.py new file mode 100644 index 00000000000..1d76b252192 --- /dev/null +++ b/erpnext/patches/v13_0/show_india_localisation_deprecation_warning.py @@ -0,0 +1,15 @@ +import click +import frappe + + +def execute(): + if not frappe.db.exists("Company", {"country": "India"}): + return + + click.secho( + "India-specific regional features have been moved to a separate app" + " and will be removed from ERPNext in Version 14." + " Please install India Compliance after upgrading to Version 14:\n" + "https://github.com/resilient-tech/india-compliance", + fg="yellow", + ) diff --git a/erpnext/patches/v13_0/stock_entry_enhancements.py b/erpnext/patches/v13_0/stock_entry_enhancements.py index 968a83a4212..005980e80a5 100644 --- a/erpnext/patches/v13_0/stock_entry_enhancements.py +++ b/erpnext/patches/v13_0/stock_entry_enhancements.py @@ -6,27 +6,31 @@ import frappe def execute(): - frappe.reload_doc("stock", "doctype", "stock_entry") - if frappe.db.has_column("Stock Entry", "add_to_transit"): - frappe.db.sql(""" + frappe.reload_doc("stock", "doctype", "stock_entry") + if frappe.db.has_column("Stock Entry", "add_to_transit"): + frappe.db.sql( + """ UPDATE `tabStock Entry` SET stock_entry_type = 'Material Transfer', purpose = 'Material Transfer', add_to_transit = 1 WHERE stock_entry_type = 'Send to Warehouse' - """) + """ + ) - frappe.db.sql("""UPDATE `tabStock Entry` SET + frappe.db.sql( + """UPDATE `tabStock Entry` SET stock_entry_type = 'Material Transfer', purpose = 'Material Transfer' WHERE stock_entry_type = 'Receive at Warehouse' - """) + """ + ) - frappe.reload_doc("stock", "doctype", "warehouse_type") - if not frappe.db.exists('Warehouse Type', 'Transit'): - doc = frappe.new_doc('Warehouse Type') - doc.name = 'Transit' - doc.insert() + frappe.reload_doc("stock", "doctype", "warehouse_type") + if not frappe.db.exists("Warehouse Type", "Transit"): + doc = frappe.new_doc("Warehouse Type") + doc.name = "Transit" + doc.insert() - frappe.reload_doc("stock", "doctype", "stock_entry_type") - frappe.delete_doc_if_exists("Stock Entry Type", "Send to Warehouse") - frappe.delete_doc_if_exists("Stock Entry Type", "Receive at Warehouse") + frappe.reload_doc("stock", "doctype", "stock_entry_type") + frappe.delete_doc_if_exists("Stock Entry Type", "Send to Warehouse") + frappe.delete_doc_if_exists("Stock Entry Type", "Receive at Warehouse") diff --git a/erpnext/patches/v13_0/trim_sales_invoice_custom_field_length.py b/erpnext/patches/v13_0/trim_sales_invoice_custom_field_length.py index fd48c0d902d..5f3fc5761ac 100644 --- a/erpnext/patches/v13_0/trim_sales_invoice_custom_field_length.py +++ b/erpnext/patches/v13_0/trim_sales_invoice_custom_field_length.py @@ -7,12 +7,10 @@ from erpnext.regional.india.setup import create_custom_fields, get_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - custom_fields = { - 'Sales Invoice': get_custom_fields().get('Sales Invoice') - } + custom_fields = {"Sales Invoice": get_custom_fields().get("Sales Invoice")} create_custom_fields(custom_fields, update=True) diff --git a/erpnext/patches/v13_0/trim_whitespace_from_serial_nos.py b/erpnext/patches/v13_0/trim_whitespace_from_serial_nos.py new file mode 100644 index 00000000000..b69a408e65b --- /dev/null +++ b/erpnext/patches/v13_0/trim_whitespace_from_serial_nos.py @@ -0,0 +1,71 @@ +import frappe + +from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos + + +def execute(): + broken_sles = frappe.db.sql( + """ + select name, serial_no + from `tabStock Ledger Entry` + where + is_cancelled = 0 + and ( serial_no like %s or serial_no like %s or serial_no like %s or serial_no like %s + or serial_no = %s ) + """, + ( + " %", # leading whitespace + "% ", # trailing whitespace + "%\n %", # leading whitespace on newline + "% \n%", # trailing whitespace on newline + "\n", # just new line + ), + as_dict=True, + ) + + frappe.db.MAX_WRITES_PER_TRANSACTION += len(broken_sles) + + if not broken_sles: + return + + broken_serial_nos = set() + + # patch SLEs + for sle in broken_sles: + serial_no_list = get_serial_nos(sle.serial_no) + correct_sr_no = "\n".join(serial_no_list) + + if correct_sr_no == sle.serial_no: + continue + + frappe.db.set_value( + "Stock Ledger Entry", sle.name, "serial_no", correct_sr_no, update_modified=False + ) + broken_serial_nos.update(serial_no_list) + + if not broken_serial_nos: + return + + # Patch serial No documents if they don't have purchase info + # Purchase info is used for fetching incoming rate + broken_sr_no_records = frappe.get_list( + "Serial No", + filters={ + "status": "Active", + "name": ("in", broken_serial_nos), + "purchase_document_type": ("is", "not set"), + }, + pluck="name", + ) + + frappe.db.MAX_WRITES_PER_TRANSACTION += len(broken_sr_no_records) + + patch_savepoint = "serial_no_patch" + for serial_no in broken_sr_no_records: + try: + frappe.db.savepoint(patch_savepoint) + sn = frappe.get_doc("Serial No", serial_no) + sn.update_serial_no_reference() + sn.db_update() + except Exception: + frappe.db.rollback(save_point=patch_savepoint) diff --git a/erpnext/patches/v13_0/update_accounts_in_loan_docs.py b/erpnext/patches/v13_0/update_accounts_in_loan_docs.py new file mode 100644 index 00000000000..f593dc28410 --- /dev/null +++ b/erpnext/patches/v13_0/update_accounts_in_loan_docs.py @@ -0,0 +1,24 @@ +import frappe + + +def execute(): + + frappe.reload_doc("loan_management", "doctype", "loan") + frappe.reload_doc("loan_management", "doctype", "loan_disbursement") + frappe.reload_doc("loan_management", "doctype", "loan_repayment") + + ld = frappe.qb.DocType("Loan Disbursement").as_("ld") + lr = frappe.qb.DocType("Loan Repayment").as_("lr") + loan = frappe.qb.DocType("Loan") + + frappe.qb.update(ld).inner_join(loan).on(loan.name == ld.against_loan).set( + ld.disbursement_account, loan.disbursement_account + ).set(ld.loan_account, loan.loan_account).where(ld.docstatus < 2).run() + + frappe.qb.update(lr).inner_join(loan).on(loan.name == lr.against_loan).set( + lr.payment_account, loan.payment_account + ).set(lr.loan_account, loan.loan_account).set( + lr.penalty_income_account, loan.penalty_income_account + ).where( + lr.docstatus < 2 + ).run() diff --git a/erpnext/patches/v13_0/update_actual_start_and_end_date_in_wo.py b/erpnext/patches/v13_0/update_actual_start_and_end_date_in_wo.py index 10ecd093069..3c6c5b5b75f 100644 --- a/erpnext/patches/v13_0/update_actual_start_and_end_date_in_wo.py +++ b/erpnext/patches/v13_0/update_actual_start_and_end_date_in_wo.py @@ -1,4 +1,3 @@ - # Copyright (c) 2019, Frappe and Contributors # License: GNU General Public License v3. See license.txt @@ -12,11 +11,9 @@ def execute(): frappe.reload_doc("manufacturing", "doctype", "work_order_item") frappe.reload_doc("manufacturing", "doctype", "job_card") - data = frappe.get_all("Work Order", - filters = { - "docstatus": 1, - "status": ("in", ["In Process", "Completed"]) - }) + data = frappe.get_all( + "Work Order", filters={"docstatus": 1, "status": ("in", ["In Process", "Completed"])} + ) for d in data: doc = frappe.get_doc("Work Order", d.name) @@ -24,18 +21,22 @@ def execute(): doc.db_set("actual_start_date", doc.actual_start_date, update_modified=False) if doc.status == "Completed": - frappe.db.set_value("Work Order", d.name, { - "actual_end_date": doc.actual_end_date, - "lead_time": doc.lead_time - }, update_modified=False) + frappe.db.set_value( + "Work Order", + d.name, + {"actual_end_date": doc.actual_end_date, "lead_time": doc.lead_time}, + update_modified=False, + ) if not doc.planned_end_date: planned_end_date = add_to_date(doc.planned_start_date, minutes=doc.lead_time) doc.db_set("planned_end_date", doc.actual_start_date, update_modified=False) - frappe.db.sql(""" UPDATE `tabJob Card` as jc, `tabWork Order` as wo + frappe.db.sql( + """ UPDATE `tabJob Card` as jc, `tabWork Order` as wo SET jc.production_item = wo.production_item, jc.item_name = wo.item_name WHERE jc.work_order = wo.name and IFNULL(jc.production_item, "") = "" - """) + """ + ) diff --git a/erpnext/patches/v13_0/update_amt_in_work_order_required_items.py b/erpnext/patches/v13_0/update_amt_in_work_order_required_items.py index dc973a9d451..e37f291233e 100644 --- a/erpnext/patches/v13_0/update_amt_in_work_order_required_items.py +++ b/erpnext/patches/v13_0/update_amt_in_work_order_required_items.py @@ -2,7 +2,7 @@ import frappe def execute(): - """ Correct amount in child table of required items table.""" + """Correct amount in child table of required items table.""" frappe.reload_doc("manufacturing", "doctype", "work_order") frappe.reload_doc("manufacturing", "doctype", "work_order_item") diff --git a/erpnext/patches/v13_0/update_category_in_ltds_certificate.py b/erpnext/patches/v13_0/update_category_in_ltds_certificate.py index a5f5a23449a..5a0873e0e53 100644 --- a/erpnext/patches/v13_0/update_category_in_ltds_certificate.py +++ b/erpnext/patches/v13_0/update_category_in_ltds_certificate.py @@ -2,19 +2,15 @@ import frappe def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - frappe.reload_doc('regional', 'doctype', 'lower_deduction_certificate') + frappe.reload_doc("regional", "doctype", "lower_deduction_certificate") ldc = frappe.qb.DocType("Lower Deduction Certificate").as_("ldc") supplier = frappe.qb.DocType("Supplier") - frappe.qb.update(ldc).inner_join(supplier).on( - ldc.supplier == supplier.name - ).set( + frappe.qb.update(ldc).inner_join(supplier).on(ldc.supplier == supplier.name).set( ldc.tax_withholding_category, supplier.tax_withholding_category - ).where( - ldc.tax_withholding_category.isnull() - ).run() \ No newline at end of file + ).where(ldc.tax_withholding_category.isnull()).run() diff --git a/erpnext/patches/v13_0/update_custom_fields_for_shopify.py b/erpnext/patches/v13_0/update_custom_fields_for_shopify.py index 8c724a8cb31..53eb6e3c788 100644 --- a/erpnext/patches/v13_0/update_custom_fields_for_shopify.py +++ b/erpnext/patches/v13_0/update_custom_fields_for_shopify.py @@ -10,5 +10,5 @@ from erpnext.erpnext_integrations.doctype.shopify_settings.shopify_settings impo def execute(): - if frappe.db.get_single_value('Shopify Settings', 'enable_shopify'): + if frappe.db.get_single_value("Shopify Settings", "enable_shopify"): setup_custom_fields() diff --git a/erpnext/patches/v13_0/update_dates_in_tax_withholding_category.py b/erpnext/patches/v13_0/update_dates_in_tax_withholding_category.py index 90fb50fb42c..c538476edb3 100644 --- a/erpnext/patches/v13_0/update_dates_in_tax_withholding_category.py +++ b/erpnext/patches/v13_0/update_dates_in_tax_withholding_category.py @@ -5,22 +5,23 @@ import frappe def execute(): - frappe.reload_doc('accounts', 'doctype', 'Tax Withholding Rate') + frappe.reload_doc("accounts", "doctype", "Tax Withholding Rate") - if frappe.db.has_column('Tax Withholding Rate', 'fiscal_year'): - tds_category_rates = frappe.get_all('Tax Withholding Rate', fields=['name', 'fiscal_year']) + if frappe.db.has_column("Tax Withholding Rate", "fiscal_year"): + tds_category_rates = frappe.get_all("Tax Withholding Rate", fields=["name", "fiscal_year"]) fiscal_year_map = {} - fiscal_year_details = frappe.get_all('Fiscal Year', fields=['name', 'year_start_date', 'year_end_date']) + fiscal_year_details = frappe.get_all( + "Fiscal Year", fields=["name", "year_start_date", "year_end_date"] + ) for d in fiscal_year_details: fiscal_year_map.setdefault(d.name, d) for rate in tds_category_rates: - from_date = fiscal_year_map.get(rate.fiscal_year).get('year_start_date') - to_date = fiscal_year_map.get(rate.fiscal_year).get('year_end_date') + from_date = fiscal_year_map.get(rate.fiscal_year).get("year_start_date") + to_date = fiscal_year_map.get(rate.fiscal_year).get("year_end_date") - frappe.db.set_value('Tax Withholding Rate', rate.name, { - 'from_date': from_date, - 'to_date': to_date - }) \ No newline at end of file + frappe.db.set_value( + "Tax Withholding Rate", rate.name, {"from_date": from_date, "to_date": to_date} + ) diff --git a/erpnext/patches/v13_0/update_deferred_settings.py b/erpnext/patches/v13_0/update_deferred_settings.py index 1b63635b678..03fe66ffe89 100644 --- a/erpnext/patches/v13_0/update_deferred_settings.py +++ b/erpnext/patches/v13_0/update_deferred_settings.py @@ -5,8 +5,8 @@ import frappe def execute(): - accounts_settings = frappe.get_doc('Accounts Settings', 'Accounts Settings') - accounts_settings.book_deferred_entries_based_on = 'Days' + accounts_settings = frappe.get_doc("Accounts Settings", "Accounts Settings") + accounts_settings.book_deferred_entries_based_on = "Days" accounts_settings.book_deferred_entries_via_journal_entry = 0 accounts_settings.submit_journal_entries = 0 accounts_settings.save() diff --git a/erpnext/patches/v13_0/update_disbursement_account.py b/erpnext/patches/v13_0/update_disbursement_account.py new file mode 100644 index 00000000000..d6aba4720ee --- /dev/null +++ b/erpnext/patches/v13_0/update_disbursement_account.py @@ -0,0 +1,14 @@ +import frappe + + +def execute(): + + frappe.reload_doc("loan_management", "doctype", "loan_type") + frappe.reload_doc("loan_management", "doctype", "loan") + + loan_type = frappe.qb.DocType("Loan Type") + loan = frappe.qb.DocType("Loan") + + frappe.qb.update(loan_type).set(loan_type.disbursement_account, loan_type.payment_account).run() + + frappe.qb.update(loan).set(loan.disbursement_account, loan.payment_account).run() diff --git a/erpnext/patches/v13_0/update_employee_advance_status.py b/erpnext/patches/v13_0/update_employee_advance_status.py new file mode 100644 index 00000000000..fc9e05e836d --- /dev/null +++ b/erpnext/patches/v13_0/update_employee_advance_status.py @@ -0,0 +1,29 @@ +import frappe + + +def execute(): + frappe.reload_doc("hr", "doctype", "employee_advance") + + advance = frappe.qb.DocType("Employee Advance") + ( + frappe.qb.update(advance) + .set(advance.status, "Returned") + .where( + (advance.docstatus == 1) + & ((advance.return_amount) & (advance.paid_amount == advance.return_amount)) + & (advance.status == "Paid") + ) + ).run() + + ( + frappe.qb.update(advance) + .set(advance.status, "Partly Claimed and Returned") + .where( + (advance.docstatus == 1) + & ( + (advance.claimed_amount & advance.return_amount) + & (advance.paid_amount == (advance.return_amount + advance.claimed_amount)) + ) + & (advance.status == "Paid") + ) + ).run() diff --git a/erpnext/patches/v13_0/update_expense_claim_status_for_paid_advances.py b/erpnext/patches/v13_0/update_expense_claim_status_for_paid_advances.py new file mode 100644 index 00000000000..2bc17ae86bd --- /dev/null +++ b/erpnext/patches/v13_0/update_expense_claim_status_for_paid_advances.py @@ -0,0 +1,25 @@ +import frappe + + +def execute(): + """ + Update Expense Claim status to Paid if: + - the entire required amount is already covered via linked advances + - the claim is partially paid via advances and the rest is reimbursed + """ + + ExpenseClaim = frappe.qb.DocType("Expense Claim") + + ( + frappe.qb.update(ExpenseClaim) + .set(ExpenseClaim.status, "Paid") + .where( + ( + (ExpenseClaim.grand_total == 0) + | (ExpenseClaim.grand_total == ExpenseClaim.total_amount_reimbursed) + ) + & (ExpenseClaim.approval_status == "Approved") + & (ExpenseClaim.docstatus == 1) + & (ExpenseClaim.total_sanctioned_amount > 0) + ) + ).run() diff --git a/erpnext/patches/v13_0/update_export_type_for_gst.py b/erpnext/patches/v13_0/update_export_type_for_gst.py index de578612f7d..62368584dc3 100644 --- a/erpnext/patches/v13_0/update_export_type_for_gst.py +++ b/erpnext/patches/v13_0/update_export_type_for_gst.py @@ -2,32 +2,39 @@ import frappe def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return # Update custom fields - fieldname = frappe.db.get_value('Custom Field', {'dt': 'Customer', 'fieldname': 'export_type'}) + fieldname = frappe.db.get_value("Custom Field", {"dt": "Customer", "fieldname": "export_type"}) if fieldname: - frappe.db.set_value('Custom Field', fieldname, + frappe.db.set_value( + "Custom Field", + fieldname, { - 'default': '', - 'mandatory_depends_on': 'eval:in_list(["SEZ", "Overseas", "Deemed Export"], doc.gst_category)' - }) + "default": "", + "mandatory_depends_on": 'eval:in_list(["SEZ", "Overseas", "Deemed Export"], doc.gst_category)', + }, + ) - fieldname = frappe.db.get_value('Custom Field', {'dt': 'Supplier', 'fieldname': 'export_type'}) + fieldname = frappe.db.get_value("Custom Field", {"dt": "Supplier", "fieldname": "export_type"}) if fieldname: - frappe.db.set_value('Custom Field', fieldname, - { - 'default': '', - 'mandatory_depends_on': 'eval:in_list(["SEZ", "Overseas"], doc.gst_category)' - }) + frappe.db.set_value( + "Custom Field", + fieldname, + {"default": "", "mandatory_depends_on": 'eval:in_list(["SEZ", "Overseas"], doc.gst_category)'}, + ) # Update Customer/Supplier Masters - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabCustomer` set export_type = '' WHERE gst_category NOT IN ('SEZ', 'Overseas', 'Deemed Export') - """) + """ + ) - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabSupplier` set export_type = '' WHERE gst_category NOT IN ('SEZ', 'Overseas') - """) + """ + ) diff --git a/erpnext/patches/v13_0/update_job_card_details.py b/erpnext/patches/v13_0/update_job_card_details.py index 12f9006b76e..73baecf0dfa 100644 --- a/erpnext/patches/v13_0/update_job_card_details.py +++ b/erpnext/patches/v13_0/update_job_card_details.py @@ -10,8 +10,10 @@ def execute(): frappe.reload_doc("manufacturing", "doctype", "job_card_item") frappe.reload_doc("manufacturing", "doctype", "work_order_operation") - frappe.db.sql(""" update `tabJob Card` jc, `tabWork Order Operation` wo + frappe.db.sql( + """ update `tabJob Card` jc, `tabWork Order Operation` wo SET jc.hour_rate = wo.hour_rate WHERE jc.operation_id = wo.name and jc.docstatus < 2 and wo.hour_rate > 0 - """) + """ + ) diff --git a/erpnext/patches/v13_0/update_job_card_status.py b/erpnext/patches/v13_0/update_job_card_status.py index 797a3e2ae35..f2d12da119a 100644 --- a/erpnext/patches/v13_0/update_job_card_status.py +++ b/erpnext/patches/v13_0/update_job_card_status.py @@ -7,8 +7,8 @@ import frappe def execute(): job_card = frappe.qb.DocType("Job Card") - (frappe.qb - .update(job_card) + ( + frappe.qb.update(job_card) .set(job_card.status, "Completed") .where( (job_card.docstatus == 1) diff --git a/erpnext/patches/v13_0/update_level_in_bom.py b/erpnext/patches/v13_0/update_level_in_bom.py deleted file mode 100644 index 499412ee270..00000000000 --- a/erpnext/patches/v13_0/update_level_in_bom.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright (c) 2020, Frappe and Contributors -# License: GNU General Public License v3. See license.txt - - -import frappe - - -def execute(): - for document in ["bom", "bom_item", "bom_explosion_item"]: - frappe.reload_doc('manufacturing', 'doctype', document) - - frappe.db.sql(" update `tabBOM` set bom_level = 0 where docstatus = 1") - - bom_list = frappe.db.sql_list("""select name from `tabBOM` bom - where docstatus=1 and is_active=1 and not exists(select bom_no from `tabBOM Item` - where parent=bom.name and ifnull(bom_no, '')!='')""") - - count = 0 - while(count < len(bom_list)): - for parent_bom in get_parent_boms(bom_list[count]): - bom_doc = frappe.get_cached_doc("BOM", parent_bom) - bom_doc.set_bom_level(update=True) - bom_list.append(parent_bom) - count += 1 - -def get_parent_boms(bom_no): - return frappe.db.sql_list(""" - select distinct bom_item.parent from `tabBOM Item` bom_item - where bom_item.bom_no = %s and bom_item.docstatus=1 and bom_item.parenttype='BOM' - and exists(select bom.name from `tabBOM` bom where bom.name=bom_item.parent and bom.is_active=1) - """, bom_no) diff --git a/erpnext/patches/v13_0/update_maintenance_schedule_field_in_visit.py b/erpnext/patches/v13_0/update_maintenance_schedule_field_in_visit.py new file mode 100644 index 00000000000..b631c0bab73 --- /dev/null +++ b/erpnext/patches/v13_0/update_maintenance_schedule_field_in_visit.py @@ -0,0 +1,19 @@ +import frappe + + +def execute(): + frappe.reload_doc("maintenance", "doctype", "maintenance_visit") + + # Updates the Maintenance Schedule link to fetch serial nos + from frappe.query_builder.functions import Coalesce + + mvp = frappe.qb.DocType("Maintenance Visit Purpose") + mv = frappe.qb.DocType("Maintenance Visit") + + frappe.qb.update(mv).join(mvp).on(mvp.parent == mv.name).set( + mv.maintenance_schedule, Coalesce(mvp.prevdoc_docname, "") + ).where( + (mv.maintenance_type == "Scheduled") & (mvp.prevdoc_docname.notnull()) & (mv.docstatus < 2) + ).run( + as_dict=1 + ) diff --git a/erpnext/patches/v13_0/update_old_loans.py b/erpnext/patches/v13_0/update_old_loans.py index bcd80d4c5c4..0bd3fcdec4c 100644 --- a/erpnext/patches/v13_0/update_old_loans.py +++ b/erpnext/patches/v13_0/update_old_loans.py @@ -1,4 +1,3 @@ - import frappe from frappe import _ from frappe.model.naming import make_autoname @@ -17,69 +16,111 @@ def execute(): # Create a penalty account for loan types - frappe.reload_doc('loan_management', 'doctype', 'loan_type') - frappe.reload_doc('loan_management', 'doctype', 'loan') - frappe.reload_doc('loan_management', 'doctype', 'repayment_schedule') - frappe.reload_doc('loan_management', 'doctype', 'process_loan_interest_accrual') - frappe.reload_doc('loan_management', 'doctype', 'loan_repayment') - frappe.reload_doc('loan_management', 'doctype', 'loan_repayment_detail') - frappe.reload_doc('loan_management', 'doctype', 'loan_interest_accrual') - frappe.reload_doc('accounts', 'doctype', 'gl_entry') - frappe.reload_doc('accounts', 'doctype', 'journal_entry_account') + frappe.reload_doc("loan_management", "doctype", "loan_type") + frappe.reload_doc("loan_management", "doctype", "loan") + frappe.reload_doc("loan_management", "doctype", "repayment_schedule") + frappe.reload_doc("loan_management", "doctype", "process_loan_interest_accrual") + frappe.reload_doc("loan_management", "doctype", "loan_repayment") + frappe.reload_doc("loan_management", "doctype", "loan_repayment_detail") + frappe.reload_doc("loan_management", "doctype", "loan_interest_accrual") + frappe.reload_doc("accounts", "doctype", "gl_entry") + frappe.reload_doc("accounts", "doctype", "journal_entry_account") updated_loan_types = [] loans_to_close = [] # Update old loan status as closed - if frappe.db.has_column('Repayment Schedule', 'paid'): - loans_list = frappe.db.sql("""SELECT distinct parent from `tabRepayment Schedule` - where paid = 0 and docstatus = 1""", as_dict=1) + if frappe.db.has_column("Repayment Schedule", "paid"): + loans_list = frappe.db.sql( + """SELECT distinct parent from `tabRepayment Schedule` + where paid = 0 and docstatus = 1""", + as_dict=1, + ) loans_to_close = [d.parent for d in loans_list] if loans_to_close: - frappe.db.sql("UPDATE `tabLoan` set status = 'Closed' where name not in (%s)" % (', '.join(['%s'] * len(loans_to_close))), tuple(loans_to_close)) + frappe.db.sql( + "UPDATE `tabLoan` set status = 'Closed' where name not in (%s)" + % (", ".join(["%s"] * len(loans_to_close))), + tuple(loans_to_close), + ) - loans = frappe.get_all('Loan', fields=['name', 'loan_type', 'company', 'status', 'mode_of_payment', - 'applicant_type', 'applicant', 'loan_account', 'payment_account', 'interest_income_account'], - filters={'docstatus': 1, 'status': ('!=', 'Closed')}) + loans = frappe.get_all( + "Loan", + fields=[ + "name", + "loan_type", + "company", + "status", + "mode_of_payment", + "applicant_type", + "applicant", + "loan_account", + "payment_account", + "interest_income_account", + ], + filters={"docstatus": 1, "status": ("!=", "Closed")}, + ) for loan in loans: # Update details in Loan Types and Loan - loan_type_company = frappe.db.get_value('Loan Type', loan.loan_type, 'company') + loan_type_company = frappe.db.get_value("Loan Type", loan.loan_type, "company") loan_type = loan.loan_type - group_income_account = frappe.get_value('Account', {'company': loan.company, - 'is_group': 1, 'root_type': 'Income', 'account_name': _('Indirect Income')}) + group_income_account = frappe.get_value( + "Account", + { + "company": loan.company, + "is_group": 1, + "root_type": "Income", + "account_name": _("Indirect Income"), + }, + ) if not group_income_account: - group_income_account = frappe.get_value('Account', {'company': loan.company, - 'is_group': 1, 'root_type': 'Income'}) + group_income_account = frappe.get_value( + "Account", {"company": loan.company, "is_group": 1, "root_type": "Income"} + ) - penalty_account = create_account(company=loan.company, account_type='Income Account', - account_name='Penalty Account', parent_account=group_income_account) + penalty_account = create_account( + company=loan.company, + account_type="Income Account", + account_name="Penalty Account", + parent_account=group_income_account, + ) # Same loan type used for multiple companies if loan_type_company and loan_type_company != loan.company: # get loan type for appropriate company - loan_type_name = frappe.get_value('Loan Type', {'company': loan.company, - 'mode_of_payment': loan.mode_of_payment, 'loan_account': loan.loan_account, - 'payment_account': loan.payment_account, 'interest_income_account': loan.interest_income_account, - 'penalty_income_account': loan.penalty_income_account}, 'name') + loan_type_name = frappe.get_value( + "Loan Type", + { + "company": loan.company, + "mode_of_payment": loan.mode_of_payment, + "loan_account": loan.loan_account, + "payment_account": loan.payment_account, + "disbursement_account": loan.payment_account, + "interest_income_account": loan.interest_income_account, + "penalty_income_account": loan.penalty_income_account, + }, + "name", + ) if not loan_type_name: loan_type_name = create_loan_type(loan, loan_type_name, penalty_account) # update loan type in loan - frappe.db.sql("UPDATE `tabLoan` set loan_type = %s where name = %s", (loan_type_name, - loan.name)) + frappe.db.sql( + "UPDATE `tabLoan` set loan_type = %s where name = %s", (loan_type_name, loan.name) + ) loan_type = loan_type_name if loan_type_name not in updated_loan_types: updated_loan_types.append(loan_type_name) elif not loan_type_company: - loan_type_doc = frappe.get_doc('Loan Type', loan.loan_type) + loan_type_doc = frappe.get_doc("Loan Type", loan.loan_type) loan_type_doc.is_term_loan = 1 loan_type_doc.company = loan.company loan_type_doc.mode_of_payment = loan.mode_of_payment @@ -92,26 +133,29 @@ def execute(): loan_type = loan.loan_type if loan_type in updated_loan_types: - if loan.status == 'Fully Disbursed': - status = 'Disbursed' - elif loan.status == 'Repaid/Closed': - status = 'Closed' + if loan.status == "Fully Disbursed": + status = "Disbursed" + elif loan.status == "Repaid/Closed": + status = "Closed" else: status = loan.status - frappe.db.set_value('Loan', loan.name, { - 'is_term_loan': 1, - 'penalty_income_account': penalty_account, - 'status': status - }) + frappe.db.set_value( + "Loan", + loan.name, + {"is_term_loan": 1, "penalty_income_account": penalty_account, "status": status}, + ) - process_loan_interest_accrual_for_term_loans(posting_date=nowdate(), loan_type=loan_type, - loan=loan.name) + process_loan_interest_accrual_for_term_loans( + posting_date=nowdate(), loan_type=loan_type, loan=loan.name + ) - - if frappe.db.has_column('Repayment Schedule', 'paid'): - total_principal, total_interest = frappe.db.get_value('Repayment Schedule', {'paid': 1, 'parent': loan.name}, - ['sum(principal_amount) as total_principal', 'sum(interest_amount) as total_interest']) + if frappe.db.has_column("Repayment Schedule", "paid"): + total_principal, total_interest = frappe.db.get_value( + "Repayment Schedule", + {"paid": 1, "parent": loan.name}, + ["sum(principal_amount) as total_principal", "sum(interest_amount) as total_interest"], + ) accrued_entries = get_accrued_interest_entries(loan.name) for entry in accrued_entries: @@ -128,22 +172,26 @@ def execute(): else: principal_paid = flt(total_principal) - frappe.db.sql(""" UPDATE `tabLoan Interest Accrual` + frappe.db.sql( + """ UPDATE `tabLoan Interest Accrual` SET paid_principal_amount = `paid_principal_amount` + %s, paid_interest_amount = `paid_interest_amount` + %s WHERE name = %s""", - (principal_paid, interest_paid, entry.name)) + (principal_paid, interest_paid, entry.name), + ) total_principal = flt(total_principal) - principal_paid total_interest = flt(total_interest) - interest_paid + def create_loan_type(loan, loan_type_name, penalty_account): - loan_type_doc = frappe.new_doc('Loan Type') + loan_type_doc = frappe.new_doc("Loan Type") loan_type_doc.loan_name = make_autoname("Loan Type-.####") loan_type_doc.is_term_loan = 1 loan_type_doc.company = loan.company loan_type_doc.mode_of_payment = loan.mode_of_payment loan_type_doc.payment_account = loan.payment_account + loan_type_doc.disbursement_account = loan.payment_account loan_type_doc.loan_account = loan.loan_account loan_type_doc.interest_income_account = loan.interest_income_account loan_type_doc.penalty_income_account = penalty_account diff --git a/erpnext/patches/v13_0/update_payment_terms_outstanding.py b/erpnext/patches/v13_0/update_payment_terms_outstanding.py index aea09ad7a37..d0c25f37ad7 100644 --- a/erpnext/patches/v13_0/update_payment_terms_outstanding.py +++ b/erpnext/patches/v13_0/update_payment_terms_outstanding.py @@ -7,10 +7,12 @@ import frappe def execute(): frappe.reload_doc("accounts", "doctype", "Payment Schedule") - if frappe.db.count('Payment Schedule'): - frappe.db.sql(''' + if frappe.db.count("Payment Schedule"): + frappe.db.sql( + """ UPDATE `tabPayment Schedule` ps SET ps.outstanding = (ps.payment_amount - ps.paid_amount) - ''') + """ + ) diff --git a/erpnext/patches/v13_0/update_pos_closing_entry_in_merge_log.py b/erpnext/patches/v13_0/update_pos_closing_entry_in_merge_log.py index b2e35591970..49826dfd261 100644 --- a/erpnext/patches/v13_0/update_pos_closing_entry_in_merge_log.py +++ b/erpnext/patches/v13_0/update_pos_closing_entry_in_merge_log.py @@ -8,8 +8,9 @@ import frappe def execute(): frappe.reload_doc("accounts", "doctype", "POS Invoice Merge Log") frappe.reload_doc("accounts", "doctype", "POS Closing Entry") - if frappe.db.count('POS Invoice Merge Log'): - frappe.db.sql(''' + if frappe.db.count("POS Invoice Merge Log"): + frappe.db.sql( + """ UPDATE `tabPOS Invoice Merge Log` log, `tabPOS Invoice Reference` log_ref SET @@ -20,7 +21,8 @@ def execute(): ) WHERE log_ref.parent = log.name - ''') + """ + ) - frappe.db.sql('''UPDATE `tabPOS Closing Entry` SET status = 'Submitted' where docstatus = 1''') - frappe.db.sql('''UPDATE `tabPOS Closing Entry` SET status = 'Cancelled' where docstatus = 2''') + frappe.db.sql("""UPDATE `tabPOS Closing Entry` SET status = 'Submitted' where docstatus = 1""") + frappe.db.sql("""UPDATE `tabPOS Closing Entry` SET status = 'Cancelled' where docstatus = 2""") diff --git a/erpnext/patches/v13_0/update_project_template_tasks.py b/erpnext/patches/v13_0/update_project_template_tasks.py index 29debc6ad14..c9a23222424 100644 --- a/erpnext/patches/v13_0/update_project_template_tasks.py +++ b/erpnext/patches/v13_0/update_project_template_tasks.py @@ -11,38 +11,39 @@ def execute(): frappe.reload_doc("projects", "doctype", "task") # Update property setter status if any - property_setter = frappe.db.get_value('Property Setter', {'doc_type': 'Task', - 'field_name': 'status', 'property': 'options'}) + property_setter = frappe.db.get_value( + "Property Setter", {"doc_type": "Task", "field_name": "status", "property": "options"} + ) if property_setter: - property_setter_doc = frappe.get_doc('Property Setter', {'doc_type': 'Task', - 'field_name': 'status', 'property': 'options'}) + property_setter_doc = frappe.get_doc( + "Property Setter", {"doc_type": "Task", "field_name": "status", "property": "options"} + ) property_setter_doc.value += "\nTemplate" property_setter_doc.save() - for template_name in frappe.get_all('Project Template'): + for template_name in frappe.get_all("Project Template"): template = frappe.get_doc("Project Template", template_name.name) replace_tasks = False new_tasks = [] for task in template.tasks: if task.subject: replace_tasks = True - new_task = frappe.get_doc(dict( - doctype = "Task", - subject = task.subject, - start = task.start, - duration = task.duration, - task_weight = task.task_weight, - description = task.description, - is_template = 1 - )).insert() + new_task = frappe.get_doc( + dict( + doctype="Task", + subject=task.subject, + start=task.start, + duration=task.duration, + task_weight=task.task_weight, + description=task.description, + is_template=1, + ) + ).insert() new_tasks.append(new_task) if replace_tasks: template.tasks = [] for tsk in new_tasks: - template.append("tasks", { - "task": tsk.name, - "subject": tsk.subject - }) + template.append("tasks", {"task": tsk.name, "subject": tsk.subject}) template.save() diff --git a/erpnext/patches/v13_0/update_reason_for_resignation_in_employee.py b/erpnext/patches/v13_0/update_reason_for_resignation_in_employee.py index f9bfc54502f..31aa29274d1 100644 --- a/erpnext/patches/v13_0/update_reason_for_resignation_in_employee.py +++ b/erpnext/patches/v13_0/update_reason_for_resignation_in_employee.py @@ -6,10 +6,12 @@ import frappe def execute(): - frappe.reload_doc("hr", "doctype", "employee") + frappe.reload_doc("hr", "doctype", "employee") - if frappe.db.has_column("Employee", "reason_for_resignation"): - frappe.db.sql(""" UPDATE `tabEmployee` + if frappe.db.has_column("Employee", "reason_for_resignation"): + frappe.db.sql( + """ UPDATE `tabEmployee` SET reason_for_leaving = reason_for_resignation WHERE status = 'Left' and reason_for_leaving is null and reason_for_resignation is not null - """) + """ + ) diff --git a/erpnext/patches/v13_0/update_recipient_email_digest.py b/erpnext/patches/v13_0/update_recipient_email_digest.py index e3528cc06bb..69961a87f78 100644 --- a/erpnext/patches/v13_0/update_recipient_email_digest.py +++ b/erpnext/patches/v13_0/update_recipient_email_digest.py @@ -8,16 +8,18 @@ import frappe def execute(): frappe.reload_doc("setup", "doctype", "Email Digest") frappe.reload_doc("setup", "doctype", "Email Digest Recipient") - email_digests = frappe.db.get_list('Email Digest', fields=['name', 'recipient_list']) + email_digests = frappe.db.get_list("Email Digest", fields=["name", "recipient_list"]) for email_digest in email_digests: if email_digest.recipient_list: for recipient in email_digest.recipient_list.split("\n"): - if frappe.db.exists('User', recipient): - doc = frappe.get_doc({ - 'doctype': 'Email Digest Recipient', - 'parenttype': 'Email Digest', - 'parentfield': 'recipients', - 'parent': email_digest.name, - 'recipient': recipient - }) + if frappe.db.exists("User", recipient): + doc = frappe.get_doc( + { + "doctype": "Email Digest Recipient", + "parenttype": "Email Digest", + "parentfield": "recipients", + "parent": email_digest.name, + "recipient": recipient, + } + ) doc.insert() diff --git a/erpnext/patches/v13_0/update_reserved_qty_closed_wo.py b/erpnext/patches/v13_0/update_reserved_qty_closed_wo.py new file mode 100644 index 00000000000..72e77fe2161 --- /dev/null +++ b/erpnext/patches/v13_0/update_reserved_qty_closed_wo.py @@ -0,0 +1,25 @@ +import frappe + +from erpnext.stock.utils import get_bin + + +def execute(): + + wo = frappe.qb.DocType("Work Order") + wo_item = frappe.qb.DocType("Work Order Item") + + incorrect_item_wh = ( + frappe.qb.from_(wo) + .join(wo_item) + .on(wo.name == wo_item.parent) + .select(wo_item.item_code, wo.source_warehouse) + .distinct() + .where((wo.status == "Closed") & (wo.docstatus == 1) & (wo.source_warehouse.notnull())) + ).run() + + for item_code, warehouse in incorrect_item_wh: + if not (item_code and warehouse): + continue + + bin = get_bin(item_code, warehouse) + bin.update_reserved_qty_for_production() diff --git a/erpnext/patches/v13_0/update_returned_qty_in_pr_dn.py b/erpnext/patches/v13_0/update_returned_qty_in_pr_dn.py index dd64e05ec16..9b5845f494d 100644 --- a/erpnext/patches/v13_0/update_returned_qty_in_pr_dn.py +++ b/erpnext/patches/v13_0/update_returned_qty_in_pr_dn.py @@ -6,14 +6,16 @@ from erpnext.controllers.status_updater import OverAllowanceError def execute(): - frappe.reload_doc('stock', 'doctype', 'purchase_receipt') - frappe.reload_doc('stock', 'doctype', 'purchase_receipt_item') - frappe.reload_doc('stock', 'doctype', 'delivery_note') - frappe.reload_doc('stock', 'doctype', 'delivery_note_item') - frappe.reload_doc('stock', 'doctype', 'stock_settings') + frappe.reload_doc("stock", "doctype", "purchase_receipt") + frappe.reload_doc("stock", "doctype", "purchase_receipt_item") + frappe.reload_doc("stock", "doctype", "delivery_note") + frappe.reload_doc("stock", "doctype", "delivery_note_item") + frappe.reload_doc("stock", "doctype", "stock_settings") def update_from_return_docs(doctype): - for return_doc in frappe.get_all(doctype, filters={'is_return' : 1, 'docstatus' : 1, 'return_against': ('!=', '')}): + for return_doc in frappe.get_all( + doctype, filters={"is_return": 1, "docstatus": 1, "return_against": ("!=", "")} + ): # Update original receipt/delivery document from return return_doc = frappe.get_cached_doc(doctype, return_doc.name) try: @@ -27,9 +29,11 @@ def execute(): frappe.db.commit() # Set received qty in stock uom in PR, as returned qty is checked against it - frappe.db.sql(""" update `tabPurchase Receipt Item` + frappe.db.sql( + """ update `tabPurchase Receipt Item` set received_stock_qty = received_qty * conversion_factor - where docstatus = 1 """) + where docstatus = 1 """ + ) - for doctype in ('Purchase Receipt', 'Delivery Note'): + for doctype in ("Purchase Receipt", "Delivery Note"): update_from_return_docs(doctype) diff --git a/erpnext/patches/v13_0/update_sane_transfer_against.py b/erpnext/patches/v13_0/update_sane_transfer_against.py new file mode 100644 index 00000000000..45691e2ded7 --- /dev/null +++ b/erpnext/patches/v13_0/update_sane_transfer_against.py @@ -0,0 +1,11 @@ +import frappe + + +def execute(): + bom = frappe.qb.DocType("BOM") + + ( + frappe.qb.update(bom) + .set(bom.transfer_material_against, "Work Order") + .where(bom.with_operations == 0) + ).run() diff --git a/erpnext/patches/v13_0/update_shipment_status.py b/erpnext/patches/v13_0/update_shipment_status.py index f2d7d1d1e3f..d21caf70add 100644 --- a/erpnext/patches/v13_0/update_shipment_status.py +++ b/erpnext/patches/v13_0/update_shipment_status.py @@ -5,11 +5,15 @@ def execute(): frappe.reload_doc("stock", "doctype", "shipment") # update submitted status - frappe.db.sql("""UPDATE `tabShipment` + frappe.db.sql( + """UPDATE `tabShipment` SET status = "Submitted" - WHERE status = "Draft" AND docstatus = 1""") + WHERE status = "Draft" AND docstatus = 1""" + ) # update cancelled status - frappe.db.sql("""UPDATE `tabShipment` + frappe.db.sql( + """UPDATE `tabShipment` SET status = "Cancelled" - WHERE status = "Draft" AND docstatus = 2""") + WHERE status = "Draft" AND docstatus = 2""" + ) diff --git a/erpnext/patches/v13_0/update_sla_enhancements.py b/erpnext/patches/v13_0/update_sla_enhancements.py index 7f61020309d..84c683acd2c 100644 --- a/erpnext/patches/v13_0/update_sla_enhancements.py +++ b/erpnext/patches/v13_0/update_sla_enhancements.py @@ -8,78 +8,94 @@ import frappe def execute(): # add holiday list and employee group fields in SLA # change response and resolution time in priorities child table - if frappe.db.exists('DocType', 'Service Level Agreement'): - sla_details = frappe.db.get_all('Service Level Agreement', fields=['name', 'service_level']) - priorities = frappe.db.get_all('Service Level Priority', fields=['*'], filters={ - 'parenttype': ('in', ['Service Level Agreement', 'Service Level']) - }) + if frappe.db.exists("DocType", "Service Level Agreement"): + sla_details = frappe.db.get_all("Service Level Agreement", fields=["name", "service_level"]) + priorities = frappe.db.get_all( + "Service Level Priority", + fields=["*"], + filters={"parenttype": ("in", ["Service Level Agreement", "Service Level"])}, + ) - frappe.reload_doc('support', 'doctype', 'service_level_agreement') - frappe.reload_doc('support', 'doctype', 'pause_sla_on_status') - frappe.reload_doc('support', 'doctype', 'service_level_priority') - frappe.reload_doc('support', 'doctype', 'service_day') + frappe.reload_doc("support", "doctype", "service_level_agreement") + frappe.reload_doc("support", "doctype", "pause_sla_on_status") + frappe.reload_doc("support", "doctype", "service_level_priority") + frappe.reload_doc("support", "doctype", "service_day") for entry in sla_details: - values = frappe.db.get_value('Service Level', entry.service_level, ['holiday_list', 'employee_group']) + values = frappe.db.get_value( + "Service Level", entry.service_level, ["holiday_list", "employee_group"] + ) if values: holiday_list = values[0] employee_group = values[1] - frappe.db.set_value('Service Level Agreement', entry.name, { - 'holiday_list': holiday_list, - 'employee_group': employee_group - }) + frappe.db.set_value( + "Service Level Agreement", + entry.name, + {"holiday_list": holiday_list, "employee_group": employee_group}, + ) priority_dict = {} for priority in priorities: - if priority.parenttype == 'Service Level Agreement': + if priority.parenttype == "Service Level Agreement": response_time = convert_to_seconds(priority.response_time, priority.response_time_period) resolution_time = convert_to_seconds(priority.resolution_time, priority.resolution_time_period) - frappe.db.set_value('Service Level Priority', priority.name, { - 'response_time': response_time, - 'resolution_time': resolution_time - }) - if priority.parenttype == 'Service Level': + frappe.db.set_value( + "Service Level Priority", + priority.name, + {"response_time": response_time, "resolution_time": resolution_time}, + ) + if priority.parenttype == "Service Level": if not priority.parent in priority_dict: priority_dict[priority.parent] = [] priority_dict[priority.parent].append(priority) - # copy Service Levels to Service Level Agreements sl = [entry.service_level for entry in sla_details] - if frappe.db.exists('DocType', 'Service Level'): - service_levels = frappe.db.get_all('Service Level', filters={'service_level': ('not in', sl)}, fields=['*']) + if frappe.db.exists("DocType", "Service Level"): + service_levels = frappe.db.get_all( + "Service Level", filters={"service_level": ("not in", sl)}, fields=["*"] + ) for entry in service_levels: - sla = frappe.new_doc('Service Level Agreement') + sla = frappe.new_doc("Service Level Agreement") sla.service_level = entry.service_level sla.holiday_list = entry.holiday_list sla.employee_group = entry.employee_group sla.flags.ignore_validate = True sla = sla.insert(ignore_mandatory=True) - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabService Day` SET parent = %(new_parent)s , parentfield = 'support_and_resolution', parenttype = 'Service Level Agreement' WHERE parent = %(old_parent)s - """, {'new_parent': sla.name, 'old_parent': entry.name}, as_dict = 1) + """, + {"new_parent": sla.name, "old_parent": entry.name}, + as_dict=1, + ) priority_list = priority_dict.get(entry.name) if priority_list: - sla = frappe.get_doc('Service Level Agreement', sla.name) + sla = frappe.get_doc("Service Level Agreement", sla.name) for priority in priority_list: - row = sla.append('priorities', { - 'priority': priority.priority, - 'default_priority': priority.default_priority, - 'response_time': convert_to_seconds(priority.response_time, priority.response_time_period), - 'resolution_time': convert_to_seconds(priority.resolution_time, priority.resolution_time_period) - }) + row = sla.append( + "priorities", + { + "priority": priority.priority, + "default_priority": priority.default_priority, + "response_time": convert_to_seconds(priority.response_time, priority.response_time_period), + "resolution_time": convert_to_seconds( + priority.resolution_time, priority.resolution_time_period + ), + }, + ) row.db_update() sla.db_update() - frappe.delete_doc_if_exists('DocType', 'Service Level') + frappe.delete_doc_if_exists("DocType", "Service Level") def convert_to_seconds(value, unit): diff --git a/erpnext/patches/v13_0/update_start_end_date_for_old_shift_assignment.py b/erpnext/patches/v13_0/update_start_end_date_for_old_shift_assignment.py index 665cc39923a..6d26ac543fc 100644 --- a/erpnext/patches/v13_0/update_start_end_date_for_old_shift_assignment.py +++ b/erpnext/patches/v13_0/update_start_end_date_for_old_shift_assignment.py @@ -6,8 +6,10 @@ import frappe def execute(): - frappe.reload_doc('hr', 'doctype', 'shift_assignment') - if frappe.db.has_column('Shift Assignment', 'date'): - frappe.db.sql("""update `tabShift Assignment` + frappe.reload_doc("hr", "doctype", "shift_assignment") + if frappe.db.has_column("Shift Assignment", "date"): + frappe.db.sql( + """update `tabShift Assignment` set end_date=date, start_date=date - where date IS NOT NULL and start_date IS NULL and end_date IS NULL;""") + where date IS NOT NULL and start_date IS NULL and end_date IS NULL;""" + ) diff --git a/erpnext/patches/v13_0/update_subscription.py b/erpnext/patches/v13_0/update_subscription.py index b0bb1c86eea..95783849ab6 100644 --- a/erpnext/patches/v13_0/update_subscription.py +++ b/erpnext/patches/v13_0/update_subscription.py @@ -8,12 +8,13 @@ from six import iteritems def execute(): - frappe.reload_doc('accounts', 'doctype', 'subscription') - frappe.reload_doc('accounts', 'doctype', 'subscription_invoice') - frappe.reload_doc('accounts', 'doctype', 'subscription_plan') + frappe.reload_doc("accounts", "doctype", "subscription") + frappe.reload_doc("accounts", "doctype", "subscription_invoice") + frappe.reload_doc("accounts", "doctype", "subscription_plan") - if frappe.db.has_column('Subscription', 'customer'): - frappe.db.sql(""" + if frappe.db.has_column("Subscription", "customer"): + frappe.db.sql( + """ UPDATE `tabSubscription` SET start_date = start, @@ -21,22 +22,28 @@ def execute(): party = customer, sales_tax_template = tax_template WHERE IFNULL(party,'') = '' - """) + """ + ) - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabSubscription Invoice` SET document_type = 'Sales Invoice' WHERE IFNULL(document_type, '') = '' - """) + """ + ) price_determination_map = { - 'Fixed rate': 'Fixed Rate', - 'Based on price list': 'Based On Price List' + "Fixed rate": "Fixed Rate", + "Based on price list": "Based On Price List", } for key, value in iteritems(price_determination_map): - frappe.db.sql(""" + frappe.db.sql( + """ UPDATE `tabSubscription Plan` SET price_determination = %s WHERE price_determination = %s - """, (value, key)) + """, + (value, key), + ) diff --git a/erpnext/patches/v13_0/update_subscription_status_in_memberships.py b/erpnext/patches/v13_0/update_subscription_status_in_memberships.py index e21fe578212..d7c849956e9 100644 --- a/erpnext/patches/v13_0/update_subscription_status_in_memberships.py +++ b/erpnext/patches/v13_0/update_subscription_status_in_memberships.py @@ -2,9 +2,11 @@ import frappe def execute(): - if frappe.db.exists('DocType', 'Member'): - frappe.reload_doc('Non Profit', 'doctype', 'Member') + if frappe.db.exists("DocType", "Member"): + frappe.reload_doc("Non Profit", "doctype", "Member") - if frappe.db.has_column('Member', 'subscription_activated'): - frappe.db.sql('UPDATE `tabMember` SET subscription_status = "Active" WHERE subscription_activated = 1') - frappe.db.sql_ddl('ALTER table `tabMember` DROP COLUMN subscription_activated') + if frappe.db.has_column("Member", "subscription_activated"): + frappe.db.sql( + 'UPDATE `tabMember` SET subscription_status = "Active" WHERE subscription_activated = 1' + ) + frappe.db.sql_ddl("ALTER table `tabMember` DROP COLUMN subscription_activated") diff --git a/erpnext/patches/v13_0/update_tax_category_for_rcm.py b/erpnext/patches/v13_0/update_tax_category_for_rcm.py new file mode 100644 index 00000000000..8ac95348894 --- /dev/null +++ b/erpnext/patches/v13_0/update_tax_category_for_rcm.py @@ -0,0 +1,50 @@ +import frappe +from frappe.custom.doctype.custom_field.custom_field import create_custom_fields + +from erpnext.regional.india import states + + +def execute(): + company = frappe.get_all("Company", filters={"country": "India"}) + if not company: + return + + create_custom_fields( + { + "Tax Category": [ + dict( + fieldname="is_inter_state", + label="Is Inter State", + fieldtype="Check", + insert_after="disabled", + print_hide=1, + ), + dict( + fieldname="is_reverse_charge", + label="Is Reverse Charge", + fieldtype="Check", + insert_after="is_inter_state", + print_hide=1, + ), + dict( + fieldname="tax_category_column_break", + fieldtype="Column Break", + insert_after="is_reverse_charge", + ), + dict( + fieldname="gst_state", + label="Source State", + fieldtype="Select", + options="\n".join(states), + insert_after="company", + ), + ] + }, + update=True, + ) + + tax_category = frappe.qb.DocType("Tax Category") + + frappe.qb.update(tax_category).set(tax_category.is_reverse_charge, 1).where( + tax_category.name.isin(["Reverse Charge Out-State", "Reverse Charge In-State"]) + ).run() diff --git a/erpnext/patches/v13_0/update_tds_check_field.py b/erpnext/patches/v13_0/update_tds_check_field.py index 436d2e6a6da..0505266b3c4 100644 --- a/erpnext/patches/v13_0/update_tds_check_field.py +++ b/erpnext/patches/v13_0/update_tds_check_field.py @@ -2,9 +2,12 @@ import frappe def execute(): - if frappe.db.has_table("Tax Withholding Category") \ - and frappe.db.has_column("Tax Withholding Category", "round_off_tax_amount"): - frappe.db.sql(""" + if frappe.db.has_table("Tax Withholding Category") and frappe.db.has_column( + "Tax Withholding Category", "round_off_tax_amount" + ): + frappe.db.sql( + """ UPDATE `tabTax Withholding Category` set round_off_tax_amount = 0 WHERE round_off_tax_amount IS NULL - """) + """ + ) diff --git a/erpnext/patches/v13_0/update_timesheet_changes.py b/erpnext/patches/v13_0/update_timesheet_changes.py index cc38a0c9a16..02654c11d30 100644 --- a/erpnext/patches/v13_0/update_timesheet_changes.py +++ b/erpnext/patches/v13_0/update_timesheet_changes.py @@ -1,4 +1,3 @@ - import frappe from frappe.model.utils.rename_field import rename_field @@ -10,17 +9,23 @@ def execute(): if frappe.db.has_column("Timesheet Detail", "billable"): rename_field("Timesheet Detail", "billable", "is_billable") - base_currency = frappe.defaults.get_global_default('currency') + base_currency = frappe.defaults.get_global_default("currency") - frappe.db.sql("""UPDATE `tabTimesheet Detail` + frappe.db.sql( + """UPDATE `tabTimesheet Detail` SET base_billing_rate = billing_rate, base_billing_amount = billing_amount, base_costing_rate = costing_rate, - base_costing_amount = costing_amount""") + base_costing_amount = costing_amount""" + ) - frappe.db.sql("""UPDATE `tabTimesheet` + frappe.db.sql( + """UPDATE `tabTimesheet` SET currency = '{0}', exchange_rate = 1.0, base_total_billable_amount = total_billable_amount, base_total_billed_amount = total_billed_amount, - base_total_costing_amount = total_costing_amount""".format(base_currency)) + base_total_costing_amount = total_costing_amount""".format( + base_currency + ) + ) diff --git a/erpnext/patches/v13_0/update_vehicle_no_reqd_condition.py b/erpnext/patches/v13_0/update_vehicle_no_reqd_condition.py index 902707b4b66..326fc579f4c 100644 --- a/erpnext/patches/v13_0/update_vehicle_no_reqd_condition.py +++ b/erpnext/patches/v13_0/update_vehicle_no_reqd_condition.py @@ -2,10 +2,10 @@ import frappe def execute(): - frappe.reload_doc('custom', 'doctype', 'custom_field', force=True) - company = frappe.get_all('Company', filters = {'country': 'India'}) + frappe.reload_doc("custom", "doctype", "custom_field", force=True) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - if frappe.db.exists('Custom Field', { 'fieldname': 'vehicle_no' }): - frappe.db.set_value('Custom Field', { 'fieldname': 'vehicle_no' }, 'mandatory_depends_on', '') + if frappe.db.exists("Custom Field", {"fieldname": "vehicle_no"}): + frappe.db.set_value("Custom Field", {"fieldname": "vehicle_no"}, "mandatory_depends_on", "") diff --git a/erpnext/patches/v13_0/updates_for_multi_currency_payroll.py b/erpnext/patches/v13_0/updates_for_multi_currency_payroll.py index c760a6a52f1..b395c01c1df 100644 --- a/erpnext/patches/v13_0/updates_for_multi_currency_payroll.py +++ b/erpnext/patches/v13_0/updates_for_multi_currency_payroll.py @@ -8,122 +8,116 @@ from frappe.model.utils.rename_field import rename_field def execute(): - frappe.reload_doc('Accounts', 'doctype', 'Salary Component Account') - if frappe.db.has_column('Salary Component Account', 'default_account'): + frappe.reload_doc("Accounts", "doctype", "Salary Component Account") + if frappe.db.has_column("Salary Component Account", "default_account"): rename_field("Salary Component Account", "default_account", "account") doctype_list = [ - { - 'module':'HR', - 'doctype':'Employee Advance' - }, - { - 'module':'HR', - 'doctype':'Leave Encashment' - }, - { - 'module':'Payroll', - 'doctype':'Additional Salary' - }, - { - 'module':'Payroll', - 'doctype':'Employee Benefit Application' - }, - { - 'module':'Payroll', - 'doctype':'Employee Benefit Claim' - }, - { - 'module':'Payroll', - 'doctype':'Employee Incentive' - }, - { - 'module':'Payroll', - 'doctype':'Employee Tax Exemption Declaration' - }, - { - 'module':'Payroll', - 'doctype':'Employee Tax Exemption Proof Submission' - }, - { - 'module':'Payroll', - 'doctype':'Income Tax Slab' - }, - { - 'module':'Payroll', - 'doctype':'Payroll Entry' - }, - { - 'module':'Payroll', - 'doctype':'Retention Bonus' - }, - { - 'module':'Payroll', - 'doctype':'Salary Structure' - }, - { - 'module':'Payroll', - 'doctype':'Salary Structure Assignment' - }, - { - 'module':'Payroll', - 'doctype':'Salary Slip' - }, + {"module": "HR", "doctype": "Employee Advance"}, + {"module": "HR", "doctype": "Leave Encashment"}, + {"module": "Payroll", "doctype": "Additional Salary"}, + {"module": "Payroll", "doctype": "Employee Benefit Application"}, + {"module": "Payroll", "doctype": "Employee Benefit Claim"}, + {"module": "Payroll", "doctype": "Employee Incentive"}, + {"module": "Payroll", "doctype": "Employee Tax Exemption Declaration"}, + {"module": "Payroll", "doctype": "Employee Tax Exemption Proof Submission"}, + {"module": "Payroll", "doctype": "Income Tax Slab"}, + {"module": "Payroll", "doctype": "Payroll Entry"}, + {"module": "Payroll", "doctype": "Retention Bonus"}, + {"module": "Payroll", "doctype": "Salary Structure"}, + {"module": "Payroll", "doctype": "Salary Structure Assignment"}, + {"module": "Payroll", "doctype": "Salary Slip"}, ] for item in doctype_list: - frappe.reload_doc(item['module'], 'doctype', item['doctype']) + frappe.reload_doc(item["module"], "doctype", item["doctype"]) # update company in employee advance based on employee company - for dt in ['Employee Incentive', 'Leave Encashment', 'Employee Benefit Application', 'Employee Benefit Claim']: - frappe.db.sql(""" + for dt in [ + "Employee Incentive", + "Leave Encashment", + "Employee Benefit Application", + "Employee Benefit Claim", + ]: + frappe.db.sql( + """ update `tab{doctype}` set company = (select company from tabEmployee where name=`tab{doctype}`.employee) - """.format(doctype=dt)) + """.format( + doctype=dt + ) + ) # update exchange rate for employee advance frappe.db.sql("update `tabEmployee Advance` set exchange_rate=1") # get all companies and it's currency - all_companies = frappe.db.get_all("Company", fields=["name", "default_currency", "default_payroll_payable_account"]) + all_companies = frappe.db.get_all( + "Company", fields=["name", "default_currency", "default_payroll_payable_account"] + ) for d in all_companies: company = d.name company_currency = d.default_currency default_payroll_payable_account = d.default_payroll_payable_account if not default_payroll_payable_account: - default_payroll_payable_account = frappe.db.get_value("Account", - {"account_name": _("Payroll Payable"), "company": company, "account_currency": company_currency, "is_group": 0}) + default_payroll_payable_account = frappe.db.get_value( + "Account", + { + "account_name": _("Payroll Payable"), + "company": company, + "account_currency": company_currency, + "is_group": 0, + }, + ) # update currency in following doctypes based on company currency - doctypes_for_currency = ['Employee Advance', 'Leave Encashment', 'Employee Benefit Application', - 'Employee Benefit Claim', 'Employee Incentive', 'Additional Salary', - 'Employee Tax Exemption Declaration', 'Employee Tax Exemption Proof Submission', - 'Income Tax Slab', 'Retention Bonus', 'Salary Structure'] + doctypes_for_currency = [ + "Employee Advance", + "Leave Encashment", + "Employee Benefit Application", + "Employee Benefit Claim", + "Employee Incentive", + "Additional Salary", + "Employee Tax Exemption Declaration", + "Employee Tax Exemption Proof Submission", + "Income Tax Slab", + "Retention Bonus", + "Salary Structure", + ] for dt in doctypes_for_currency: - frappe.db.sql("""update `tab{doctype}` set currency = %s where company=%s""" - .format(doctype=dt), (company_currency, company)) + frappe.db.sql( + """update `tab{doctype}` set currency = %s where company=%s""".format(doctype=dt), + (company_currency, company), + ) # update fields in payroll entry - frappe.db.sql(""" + frappe.db.sql( + """ update `tabPayroll Entry` set currency = %s, exchange_rate = 1, payroll_payable_account=%s where company=%s - """, (company_currency, default_payroll_payable_account, company)) + """, + (company_currency, default_payroll_payable_account, company), + ) # update fields in Salary Structure Assignment - frappe.db.sql(""" + frappe.db.sql( + """ update `tabSalary Structure Assignment` set currency = %s, payroll_payable_account=%s where company=%s - """, (company_currency, default_payroll_payable_account, company)) + """, + (company_currency, default_payroll_payable_account, company), + ) # update fields in Salary Slip - frappe.db.sql(""" + frappe.db.sql( + """ update `tabSalary Slip` set currency = %s, exchange_rate = 1, @@ -134,4 +128,6 @@ def execute(): base_rounded_total = rounded_total, base_total_in_words = total_in_words where company=%s - """, (company_currency, company)) + """, + (company_currency, company), + ) diff --git a/erpnext/patches/v13_0/validate_options_for_data_field.py b/erpnext/patches/v13_0/validate_options_for_data_field.py deleted file mode 100644 index ad777b8586d..00000000000 --- a/erpnext/patches/v13_0/validate_options_for_data_field.py +++ /dev/null @@ -1,26 +0,0 @@ -# Copyright (c) 2021, Frappe and Contributors -# License: GNU General Public License v3. See license.txt - - -import frappe -from frappe.model import data_field_options - - -def execute(): - - for field in frappe.get_all('Custom Field', - fields = ['name'], - filters = { - 'fieldtype': 'Data', - 'options': ['!=', None] - }): - - if field not in data_field_options: - frappe.db.sql(""" - UPDATE - `tabCustom Field` - SET - options=NULL - WHERE - name=%s - """, (field)) diff --git a/erpnext/patches/v13_0/wipe_serial_no_field_for_0_qty.py b/erpnext/patches/v13_0/wipe_serial_no_field_for_0_qty.py new file mode 100644 index 00000000000..693d06dc1a0 --- /dev/null +++ b/erpnext/patches/v13_0/wipe_serial_no_field_for_0_qty.py @@ -0,0 +1,16 @@ +import frappe + + +def execute(): + + doctype = "Stock Reconciliation Item" + + if not frappe.db.has_column(doctype, "current_serial_no"): + # nothing to fix if column doesn't exist + return + + sr_item = frappe.qb.DocType(doctype) + + ( + frappe.qb.update(sr_item).set(sr_item.current_serial_no, None).where(sr_item.current_qty == 0) + ).run() diff --git a/erpnext/patches/v4_2/repost_reserved_qty.py b/erpnext/patches/v4_2/repost_reserved_qty.py index c2ca9be64aa..72ac524a5c8 100644 --- a/erpnext/patches/v4_2/repost_reserved_qty.py +++ b/erpnext/patches/v4_2/repost_reserved_qty.py @@ -11,7 +11,8 @@ def execute(): for doctype in ("Sales Order Item", "Bin"): frappe.reload_doctype(doctype) - repost_for = frappe.db.sql(""" + repost_for = frappe.db.sql( + """ select distinct item_code, warehouse from @@ -26,15 +27,18 @@ def execute(): ) so_item where exists(select name from tabItem where name=so_item.item_code and ifnull(is_stock_item, 0)=1) - """) + """ + ) for item_code, warehouse in repost_for: - update_bin_qty(item_code, warehouse, { - "reserved_qty": get_reserved_qty(item_code, warehouse) - }) + if not (item_code and warehouse): + continue + update_bin_qty(item_code, warehouse, {"reserved_qty": get_reserved_qty(item_code, warehouse)}) - frappe.db.sql("""delete from tabBin + frappe.db.sql( + """delete from tabBin where exists( select name from tabItem where name=tabBin.item_code and ifnull(is_stock_item, 0) = 0 ) - """) + """ + ) diff --git a/erpnext/patches/v4_2/update_requested_and_ordered_qty.py b/erpnext/patches/v4_2/update_requested_and_ordered_qty.py index 42b0b04076f..8ebc649aee4 100644 --- a/erpnext/patches/v4_2/update_requested_and_ordered_qty.py +++ b/erpnext/patches/v4_2/update_requested_and_ordered_qty.py @@ -8,18 +8,26 @@ import frappe def execute(): from erpnext.stock.stock_balance import get_indented_qty, get_ordered_qty, update_bin_qty - count=0 - for item_code, warehouse in frappe.db.sql("""select distinct item_code, warehouse from + count = 0 + for item_code, warehouse in frappe.db.sql( + """select distinct item_code, warehouse from (select item_code, warehouse from tabBin union - select item_code, warehouse from `tabStock Ledger Entry`) a"""): - try: - count += 1 - update_bin_qty(item_code, warehouse, { + select item_code, warehouse from `tabStock Ledger Entry`) a""" + ): + try: + if not (item_code and warehouse): + continue + count += 1 + update_bin_qty( + item_code, + warehouse, + { "indented_qty": get_indented_qty(item_code, warehouse), - "ordered_qty": get_ordered_qty(item_code, warehouse) - }) - if count % 200 == 0: - frappe.db.commit() - except Exception: - frappe.db.rollback() + "ordered_qty": get_ordered_qty(item_code, warehouse), + }, + ) + if count % 200 == 0: + frappe.db.commit() + except Exception: + frappe.db.rollback() diff --git a/erpnext/patches/v5_7/update_item_description_based_on_item_master.py b/erpnext/patches/v5_7/update_item_description_based_on_item_master.py index e7ef5ff0b49..edb0eaa6b9e 100644 --- a/erpnext/patches/v5_7/update_item_description_based_on_item_master.py +++ b/erpnext/patches/v5_7/update_item_description_based_on_item_master.py @@ -1,14 +1,17 @@ - import frappe def execute(): - name = frappe.db.sql(""" select name from `tabPatch Log` \ + name = frappe.db.sql( + """ select name from `tabPatch Log` \ where \ - patch like 'execute:frappe.db.sql("update `tabProduction Order` pro set description%' """) + patch like 'execute:frappe.db.sql("update `tabProduction Order` pro set description%' """ + ) if not name: - frappe.db.sql("update `tabProduction Order` pro \ + frappe.db.sql( + "update `tabProduction Order` pro \ set \ description = (select description from tabItem where name=pro.production_item) \ where \ - ifnull(description, '') = ''") + ifnull(description, '') = ''" + ) diff --git a/erpnext/patches/v8_1/removed_roles_from_gst_report_non_indian_account.py b/erpnext/patches/v8_1/removed_roles_from_gst_report_non_indian_account.py index ed1dffe75c8..a8108745e98 100644 --- a/erpnext/patches/v8_1/removed_roles_from_gst_report_non_indian_account.py +++ b/erpnext/patches/v8_1/removed_roles_from_gst_report_non_indian_account.py @@ -6,14 +6,16 @@ import frappe def execute(): - frappe.reload_doc('core', 'doctype', 'has_role') - company = frappe.get_all('Company', filters = {'country': 'India'}) + frappe.reload_doc("core", "doctype", "has_role") + company = frappe.get_all("Company", filters={"country": "India"}) if not company: - frappe.db.sql(""" + frappe.db.sql( + """ delete from `tabHas Role` where parenttype = 'Report' and parent in('GST Sales Register', 'GST Purchase Register', 'GST Itemised Sales Register', - 'GST Itemised Purchase Register', 'Eway Bill')""") + 'GST Itemised Purchase Register', 'Eway Bill')""" + ) diff --git a/erpnext/patches/v8_1/setup_gst_india.py b/erpnext/patches/v8_1/setup_gst_india.py index 98097d00501..b03439842f2 100644 --- a/erpnext/patches/v8_1/setup_gst_india.py +++ b/erpnext/patches/v8_1/setup_gst_india.py @@ -1,37 +1,45 @@ - import frappe from frappe.email import sendmail_to_system_managers def execute(): - frappe.reload_doc('stock', 'doctype', 'item') + frappe.reload_doc("stock", "doctype", "item") frappe.reload_doc("stock", "doctype", "customs_tariff_number") frappe.reload_doc("accounts", "doctype", "payment_terms_template") frappe.reload_doc("accounts", "doctype", "payment_schedule") - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - frappe.reload_doc('regional', 'doctype', 'gst_settings') - frappe.reload_doc('regional', 'doctype', 'gst_hsn_code') + frappe.reload_doc("regional", "doctype", "gst_settings") + frappe.reload_doc("regional", "doctype", "gst_hsn_code") - for report_name in ('GST Sales Register', 'GST Purchase Register', - 'GST Itemised Sales Register', 'GST Itemised Purchase Register'): + for report_name in ( + "GST Sales Register", + "GST Purchase Register", + "GST Itemised Sales Register", + "GST Itemised Purchase Register", + ): - frappe.reload_doc('regional', 'report', frappe.scrub(report_name)) + frappe.reload_doc("regional", "report", frappe.scrub(report_name)) from erpnext.regional.india.setup import setup + delete_custom_field_tax_id_if_exists() setup(patch=True) send_gst_update_email() + def delete_custom_field_tax_id_if_exists(): - for field in frappe.db.sql_list("""select name from `tabCustom Field` where fieldname='tax_id' - and dt in ('Sales Order', 'Sales Invoice', 'Delivery Note')"""): + for field in frappe.db.sql_list( + """select name from `tabCustom Field` where fieldname='tax_id' + and dt in ('Sales Order', 'Sales Invoice', 'Delivery Note')""" + ): frappe.delete_doc("Custom Field", field, ignore_permissions=True) frappe.db.commit() + def send_gst_update_email(): message = """Hello, @@ -46,7 +54,9 @@ Templates and update your Customer's and Supplier's GST Numbers.
Thanks,
ERPNext Team. - """.format(gst_document_link=" ERPNext GST Document ") + """.format( + gst_document_link=" ERPNext GST Document " + ) try: sendmail_to_system_managers("[Important] ERPNext GST updates", message) diff --git a/erpnext/patches/v8_7/sync_india_custom_fields.py b/erpnext/patches/v8_7/sync_india_custom_fields.py index b5d58dc2eb8..e1b9a732dea 100644 --- a/erpnext/patches/v8_7/sync_india_custom_fields.py +++ b/erpnext/patches/v8_7/sync_india_custom_fields.py @@ -1,36 +1,42 @@ - import frappe from erpnext.regional.india.setup import make_custom_fields def execute(): - company = frappe.get_all('Company', filters = {'country': 'India'}) + company = frappe.get_all("Company", filters={"country": "India"}) if not company: return - frappe.reload_doc('Payroll', 'doctype', 'payroll_period') - frappe.reload_doc('Payroll', 'doctype', 'employee_tax_exemption_declaration') - frappe.reload_doc('Payroll', 'doctype', 'employee_tax_exemption_proof_submission') - frappe.reload_doc('Payroll', 'doctype', 'employee_tax_exemption_declaration_category') - frappe.reload_doc('Payroll', 'doctype', 'employee_tax_exemption_proof_submission_detail') + frappe.reload_doc("Payroll", "doctype", "payroll_period") + frappe.reload_doc("Payroll", "doctype", "employee_tax_exemption_declaration") + frappe.reload_doc("Payroll", "doctype", "employee_tax_exemption_proof_submission") + frappe.reload_doc("Payroll", "doctype", "employee_tax_exemption_declaration_category") + frappe.reload_doc("Payroll", "doctype", "employee_tax_exemption_proof_submission_detail") - frappe.reload_doc('accounts', 'doctype', 'tax_category') + frappe.reload_doc("accounts", "doctype", "tax_category") for doctype in ["Sales Invoice", "Delivery Note", "Purchase Invoice"]: - frappe.db.sql("""delete from `tabCustom Field` where dt = %s - and fieldname in ('port_code', 'shipping_bill_number', 'shipping_bill_date')""", doctype) + frappe.db.sql( + """delete from `tabCustom Field` where dt = %s + and fieldname in ('port_code', 'shipping_bill_number', 'shipping_bill_date')""", + doctype, + ) make_custom_fields() - frappe.db.sql(""" + frappe.db.sql( + """ update `tabCustom Field` set reqd = 0, `default` = '' where fieldname = 'reason_for_issuing_document' - """) + """ + ) - frappe.db.sql(""" + frappe.db.sql( + """ update tabAddress set gst_state_number=concat("0", gst_state_number) where ifnull(gst_state_number, '') != '' and gst_state_number<10 - """) + """ + ) diff --git a/erpnext/payroll/doctype/additional_salary/additional_salary.py b/erpnext/payroll/doctype/additional_salary/additional_salary.py index bf8bd05fcc0..18bd3b7733c 100644 --- a/erpnext/payroll/doctype/additional_salary/additional_salary.py +++ b/erpnext/payroll/doctype/additional_salary/additional_salary.py @@ -30,12 +30,17 @@ class AdditionalSalary(Document): frappe.throw(_("Amount should not be less than zero")) def validate_salary_structure(self): - if not frappe.db.exists('Salary Structure Assignment', {'employee': self.employee}): - frappe.throw(_("There is no Salary Structure assigned to {0}. First assign a Salary Stucture.").format(self.employee)) + if not frappe.db.exists("Salary Structure Assignment", {"employee": self.employee}): + frappe.throw( + _("There is no Salary Structure assigned to {0}. First assign a Salary Stucture.").format( + self.employee + ) + ) def validate_recurring_additional_salary_overlap(self): if self.is_recurring: - additional_salaries = frappe.db.sql(""" + additional_salaries = frappe.db.sql( + """ SELECT name FROM `tabAdditional Salary` @@ -47,22 +52,28 @@ class AdditionalSalary(Document): AND salary_component = %s AND to_date >= %s AND from_date <= %s""", - (self.employee, self.name, self.salary_component, self.from_date, self.to_date), as_dict = 1) + (self.employee, self.name, self.salary_component, self.from_date, self.to_date), + as_dict=1, + ) additional_salaries = [salary.name for salary in additional_salaries] if additional_salaries and len(additional_salaries): - frappe.throw(_("Additional Salary: {0} already exist for Salary Component: {1} for period {2} and {3}").format( - bold(comma_and(additional_salaries)), - bold(self.salary_component), - bold(formatdate(self.from_date)), - bold(formatdate(self.to_date) - ))) - + frappe.throw( + _( + "Additional Salary: {0} already exist for Salary Component: {1} for period {2} and {3}" + ).format( + bold(comma_and(additional_salaries)), + bold(self.salary_component), + bold(formatdate(self.from_date)), + bold(formatdate(self.to_date)), + ) + ) def validate_dates(self): - date_of_joining, relieving_date = frappe.db.get_value("Employee", self.employee, - ["date_of_joining", "relieving_date"]) + date_of_joining, relieving_date = frappe.db.get_value( + "Employee", self.employee, ["date_of_joining", "relieving_date"] + ) if getdate(self.from_date) > getdate(self.to_date): frappe.throw(_("From Date can not be greater than To Date.")) @@ -81,19 +92,27 @@ class AdditionalSalary(Document): def validate_employee_referral(self): if self.ref_doctype == "Employee Referral": - referral_details = frappe.db.get_value("Employee Referral", self.ref_docname, - ["is_applicable_for_referral_bonus", "status"], as_dict=1) + referral_details = frappe.db.get_value( + "Employee Referral", + self.ref_docname, + ["is_applicable_for_referral_bonus", "status"], + as_dict=1, + ) if not referral_details.is_applicable_for_referral_bonus: - frappe.throw(_("Employee Referral {0} is not applicable for referral bonus.").format( - self.ref_docname)) + frappe.throw( + _("Employee Referral {0} is not applicable for referral bonus.").format(self.ref_docname) + ) if self.type == "Deduction": frappe.throw(_("Earning Salary Component is required for Employee Referral Bonus.")) if referral_details.status != "Accepted": - frappe.throw(_("Additional Salary for referral bonus can only be created against Employee Referral with status {0}").format( - frappe.bold("Accepted"))) + frappe.throw( + _( + "Additional Salary for referral bonus can only be created against Employee Referral with status {0}" + ).format(frappe.bold("Accepted")) + ) def update_return_amount_in_employee_advance(self): if self.ref_doctype == "Employee Advance" and self.ref_docname: @@ -105,6 +124,8 @@ class AdditionalSalary(Document): return_amount += self.amount frappe.db.set_value("Employee Advance", self.ref_docname, "return_amount", return_amount) + advance = frappe.get_doc("Employee Advance", self.ref_docname) + advance.set_status(update=True) def update_employee_referral(self, cancel=False): if self.ref_doctype == "Employee Referral": @@ -123,28 +144,54 @@ class AdditionalSalary(Document): no_of_days = date_diff(getdate(end_date), getdate(start_date)) + 1 return amount_per_day * no_of_days + @frappe.whitelist() def get_additional_salaries(employee, start_date, end_date, component_type): - comp_type = 'Earning' if component_type == 'earnings' else 'Deduction' + from frappe.query_builder import Criterion - additional_sal = frappe.qb.DocType('Additional Salary') - component_field = additional_sal.salary_component.as_('component') - overwrite_field = additional_sal.overwrite_salary_structure_amount.as_('overwrite') + comp_type = "Earning" if component_type == "earnings" else "Deduction" - additional_salary_list = frappe.qb.from_( - additional_sal - ).select( - additional_sal.name, component_field, additional_sal.type, - additional_sal.amount, additional_sal.is_recurring, overwrite_field, - additional_sal.deduct_full_tax_on_selected_payroll_date - ).where( - (additional_sal.employee == employee) - & (additional_sal.docstatus == 1) - & (additional_sal.type == comp_type) - ).where( - additional_sal.payroll_date[start_date: end_date] - | ((additional_sal.from_date <= end_date) & (additional_sal.to_date >= end_date)) - ).run(as_dict=True) + additional_sal = frappe.qb.DocType("Additional Salary") + component_field = additional_sal.salary_component.as_("component") + overwrite_field = additional_sal.overwrite_salary_structure_amount.as_("overwrite") + + additional_salary_list = ( + frappe.qb.from_(additional_sal) + .select( + additional_sal.name, + component_field, + additional_sal.type, + additional_sal.amount, + additional_sal.is_recurring, + overwrite_field, + additional_sal.deduct_full_tax_on_selected_payroll_date, + ) + .where( + (additional_sal.employee == employee) + & (additional_sal.docstatus == 1) + & (additional_sal.type == comp_type) + ) + .where( + Criterion.any( + [ + Criterion.all( + [ # is recurring and additional salary dates fall within the payroll period + additional_sal.is_recurring == 1, + additional_sal.from_date <= end_date, + additional_sal.to_date >= end_date, + ] + ), + Criterion.all( + [ # is not recurring and additional salary's payroll date falls within the payroll period + additional_sal.is_recurring == 0, + additional_sal.payroll_date[start_date:end_date], + ] + ), + ] + ) + ) + .run(as_dict=True) + ) additional_salaries = [] components_to_overwrite = [] @@ -152,8 +199,12 @@ def get_additional_salaries(employee, start_date, end_date, component_type): for d in additional_salary_list: if d.overwrite: if d.component in components_to_overwrite: - frappe.throw(_("Multiple Additional Salaries with overwrite property exist for Salary Component {0} between {1} and {2}.").format( - frappe.bold(d.component), start_date, end_date), title=_("Error")) + frappe.throw( + _( + "Multiple Additional Salaries with overwrite property exist for Salary Component {0} between {1} and {2}." + ).format(frappe.bold(d.component), start_date, end_date), + title=_("Error"), + ) components_to_overwrite.append(d.component) diff --git a/erpnext/payroll/doctype/additional_salary/test_additional_salary.py b/erpnext/payroll/doctype/additional_salary/test_additional_salary.py index 84de912e431..bd739368a0a 100644 --- a/erpnext/payroll/doctype/additional_salary/test_additional_salary.py +++ b/erpnext/payroll/doctype/additional_salary/test_additional_salary.py @@ -4,7 +4,8 @@ import unittest import frappe -from frappe.utils import add_days, nowdate +from frappe.tests.utils import FrappeTestCase +from frappe.utils import add_days, add_months, nowdate import erpnext from erpnext.hr.doctype.employee.test_employee import make_employee @@ -16,40 +17,87 @@ from erpnext.payroll.doctype.salary_slip.test_salary_slip import ( from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure -class TestAdditionalSalary(unittest.TestCase): - +class TestAdditionalSalary(FrappeTestCase): def setUp(self): setup_test() - def tearDown(self): - for dt in ["Salary Slip", "Additional Salary", "Salary Structure Assignment", "Salary Structure"]: - frappe.db.sql("delete from `tab%s`" % dt) - def test_recurring_additional_salary(self): amount = 0 salary_component = None emp_id = make_employee("test_additional@salary.com") frappe.db.set_value("Employee", emp_id, "relieving_date", add_days(nowdate(), 1800)) - salary_structure = make_salary_structure("Test Salary Structure Additional Salary", "Monthly", employee=emp_id) + salary_structure = make_salary_structure( + "Test Salary Structure Additional Salary", "Monthly", employee=emp_id + ) add_sal = get_additional_salary(emp_id) - ss = make_employee_salary_slip("test_additional@salary.com", "Monthly", salary_structure=salary_structure.name) + ss = make_employee_salary_slip( + "test_additional@salary.com", "Monthly", salary_structure=salary_structure.name + ) for earning in ss.earnings: if earning.salary_component == "Recurring Salary Component": amount = earning.amount salary_component = earning.salary_component + break self.assertEqual(amount, add_sal.amount) self.assertEqual(salary_component, add_sal.salary_component) -def get_additional_salary(emp_id): + def test_non_recurring_additional_salary(self): + amount = 0 + salary_component = None + date = nowdate() + + emp_id = make_employee("test_additional@salary.com") + frappe.db.set_value("Employee", emp_id, "relieving_date", add_days(date, 1800)) + salary_structure = make_salary_structure( + "Test Salary Structure Additional Salary", "Monthly", employee=emp_id + ) + add_sal = get_additional_salary(emp_id, recurring=False, payroll_date=date) + + ss = make_employee_salary_slip( + "test_additional@salary.com", "Monthly", salary_structure=salary_structure.name + ) + + amount, salary_component = None, None + for earning in ss.earnings: + if earning.salary_component == "Recurring Salary Component": + amount = earning.amount + salary_component = earning.salary_component + break + + self.assertEqual(amount, add_sal.amount) + self.assertEqual(salary_component, add_sal.salary_component) + + # should not show up in next months + ss.posting_date = add_months(date, 1) + ss.start_date = ss.end_date = None + ss.earnings = [] + ss.deductions = [] + ss.save() + + amount, salary_component = None, None + for earning in ss.earnings: + if earning.salary_component == "Recurring Salary Component": + amount = earning.amount + salary_component = earning.salary_component + break + + self.assertIsNone(amount) + self.assertIsNone(salary_component) + + +def get_additional_salary(emp_id, recurring=True, payroll_date=None): create_salary_component("Recurring Salary Component") add_sal = frappe.new_doc("Additional Salary") add_sal.employee = emp_id add_sal.salary_component = "Recurring Salary Component" - add_sal.is_recurring = 1 + + add_sal.is_recurring = 1 if recurring else 0 add_sal.from_date = add_days(nowdate(), -50) add_sal.to_date = add_days(nowdate(), 180) + add_sal.payroll_date = payroll_date + add_sal.amount = 5000 add_sal.currency = erpnext.get_default_currency() add_sal.save() diff --git a/erpnext/payroll/doctype/employee_benefit_application/employee_benefit_application.py b/erpnext/payroll/doctype/employee_benefit_application/employee_benefit_application.py index eda50150ebd..8df1bb6e87e 100644 --- a/erpnext/payroll/doctype/employee_benefit_application/employee_benefit_application.py +++ b/erpnext/payroll/doctype/employee_benefit_application/employee_benefit_application.py @@ -5,7 +5,7 @@ import frappe from frappe import _ from frappe.model.document import Document -from frappe.utils import add_days, cint, cstr, date_diff, getdate, rounded +from frappe.utils import add_days, cstr, date_diff, flt, getdate, rounded from erpnext.hr.utils import ( get_holiday_dates_for_employee, @@ -27,26 +27,40 @@ class EmployeeBenefitApplication(Document): validate_active_employee(self.employee) self.validate_duplicate_on_payroll_period() if not self.max_benefits: - self.max_benefits = get_max_benefits_remaining(self.employee, self.date, self.payroll_period) + self.max_benefits = flt( + get_max_benefits_remaining(self.employee, self.date, self.payroll_period), + self.precision("max_benefits"), + ) if self.max_benefits and self.max_benefits > 0: self.validate_max_benefit_for_component() self.validate_prev_benefit_claim() - if self.remaining_benefit > 0: + if self.remaining_benefit and self.remaining_benefit > 0: self.validate_remaining_benefit_amount() else: - frappe.throw(_("As per your assigned Salary Structure you cannot apply for benefits").format(self.employee)) + frappe.throw( + _("As per your assigned Salary Structure you cannot apply for benefits").format(self.employee) + ) def validate_prev_benefit_claim(self): if self.employee_benefits: for benefit in self.employee_benefits: if benefit.pay_against_benefit_claim == 1: payroll_period = frappe.get_doc("Payroll Period", self.payroll_period) - benefit_claimed = get_previous_claimed_amount(self.employee, payroll_period, component = benefit.earning_component) - benefit_given = get_sal_slip_total_benefit_given(self.employee, payroll_period, component = benefit.earning_component) + benefit_claimed = get_previous_claimed_amount( + self.employee, payroll_period, component=benefit.earning_component + ) + benefit_given = get_sal_slip_total_benefit_given( + self.employee, payroll_period, component=benefit.earning_component + ) benefit_claim_remining = benefit_claimed - benefit_given if benefit_claimed > 0 and benefit_claim_remining > benefit.amount: - frappe.throw(_("An amount of {0} already claimed for the component {1}, set the amount equal or greater than {2}").format( - benefit_claimed, benefit.earning_component, benefit_claim_remining)) + frappe.throw( + _( + "An amount of {0} already claimed for the component {1}, set the amount equal or greater than {2}" + ).format( + benefit_claimed, benefit.earning_component, benefit_claim_remining + ) + ) def validate_remaining_benefit_amount(self): # check salary structure earnings have flexi component (sum of max_benefit_amount) @@ -65,52 +79,80 @@ class EmployeeBenefitApplication(Document): if salary_structure.earnings: for earnings in salary_structure.earnings: if earnings.is_flexible_benefit == 1 and earnings.salary_component not in benefit_components: - pay_against_benefit_claim, max_benefit_amount = frappe.db.get_value("Salary Component", earnings.salary_component, ["pay_against_benefit_claim", "max_benefit_amount"]) + pay_against_benefit_claim, max_benefit_amount = frappe.db.get_value( + "Salary Component", + earnings.salary_component, + ["pay_against_benefit_claim", "max_benefit_amount"], + ) if pay_against_benefit_claim != 1: pro_rata_amount += max_benefit_amount else: non_pro_rata_amount += max_benefit_amount - if pro_rata_amount == 0 and non_pro_rata_amount == 0: - frappe.throw(_("Please add the remaining benefits {0} to any of the existing component").format(self.remaining_benefit)) + if pro_rata_amount == 0 and non_pro_rata_amount == 0: + frappe.throw( + _("Please add the remaining benefits {0} to any of the existing component").format( + self.remaining_benefit + ) + ) elif non_pro_rata_amount > 0 and non_pro_rata_amount < rounded(self.remaining_benefit): - frappe.throw(_("You can claim only an amount of {0}, the rest amount {1} should be in the application as pro-rata component").format( - non_pro_rata_amount, self.remaining_benefit - non_pro_rata_amount)) + frappe.throw( + _( + "You can claim only an amount of {0}, the rest amount {1} should be in the application as pro-rata component" + ).format(non_pro_rata_amount, self.remaining_benefit - non_pro_rata_amount) + ) elif non_pro_rata_amount == 0: - frappe.throw(_("Please add the remaining benefits {0} to the application as pro-rata component").format( - self.remaining_benefit)) + frappe.throw( + _("Please add the remaining benefits {0} to the application as pro-rata component").format( + self.remaining_benefit + ) + ) def validate_max_benefit_for_component(self): if self.employee_benefits: max_benefit_amount = 0 for employee_benefit in self.employee_benefits: self.validate_max_benefit(employee_benefit.earning_component) - max_benefit_amount += employee_benefit.amount + max_benefit_amount += flt(employee_benefit.amount) if max_benefit_amount > self.max_benefits: - frappe.throw(_("Maximum benefit amount of employee {0} exceeds {1}").format(self.employee, self.max_benefits)) + frappe.throw( + _("Maximum benefit amount of employee {0} exceeds {1}").format( + self.employee, self.max_benefits + ) + ) def validate_max_benefit(self, earning_component_name): - max_benefit_amount = frappe.db.get_value("Salary Component", earning_component_name, "max_benefit_amount") + max_benefit_amount = frappe.db.get_value( + "Salary Component", earning_component_name, "max_benefit_amount" + ) benefit_amount = 0 for employee_benefit in self.employee_benefits: if employee_benefit.earning_component == earning_component_name: - benefit_amount += employee_benefit.amount - prev_sal_slip_flexi_amount = get_sal_slip_total_benefit_given(self.employee, frappe.get_doc("Payroll Period", self.payroll_period), earning_component_name) + benefit_amount += flt(employee_benefit.amount) + + prev_sal_slip_flexi_amount = get_sal_slip_total_benefit_given( + self.employee, frappe.get_doc("Payroll Period", self.payroll_period), earning_component_name + ) benefit_amount += prev_sal_slip_flexi_amount if rounded(benefit_amount, 2) > max_benefit_amount: - frappe.throw(_("Maximum benefit amount of component {0} exceeds {1}").format(earning_component_name, max_benefit_amount)) + frappe.throw( + _("Maximum benefit amount of component {0} exceeds {1}").format( + earning_component_name, max_benefit_amount + ) + ) def validate_duplicate_on_payroll_period(self): application = frappe.db.exists( "Employee Benefit Application", - { - 'employee': self.employee, - 'payroll_period': self.payroll_period, - 'docstatus': 1 - } + {"employee": self.employee, "payroll_period": self.payroll_period, "docstatus": 1}, ) if application: - frappe.throw(_("Employee {0} already submited an apllication {1} for the payroll period {2}").format(self.employee, application, self.payroll_period)) + frappe.throw( + _("Employee {0} already submited an apllication {1} for the payroll period {2}").format( + self.employee, application, self.payroll_period + ) + ) + @frappe.whitelist() def get_max_benefits(employee, on_date): @@ -121,6 +163,7 @@ def get_max_benefits(employee, on_date): return max_benefits return False + @frappe.whitelist() def get_max_benefits_remaining(employee, on_date, payroll_period): max_benefits = get_max_benefits(employee, on_date) @@ -141,9 +184,14 @@ def get_max_benefits_remaining(employee, on_date, payroll_period): sal_struct = frappe.get_doc("Salary Structure", sal_struct_name) for sal_struct_row in sal_struct.get("earnings"): salary_component = frappe.get_doc("Salary Component", sal_struct_row.salary_component) - if salary_component.depends_on_payment_days == 1 and salary_component.pay_against_benefit_claim != 1: + if ( + salary_component.depends_on_payment_days == 1 + and salary_component.pay_against_benefit_claim != 1 + ): have_depends_on_payment_days = True - benefit_amount = get_benefit_amount_based_on_pro_rata(sal_struct, salary_component.max_benefit_amount) + benefit_amount = get_benefit_amount_based_on_pro_rata( + sal_struct, salary_component.max_benefit_amount + ) amount_per_day = benefit_amount / payroll_period_days per_day_amount_total += amount_per_day @@ -159,71 +207,115 @@ def get_max_benefits_remaining(employee, on_date, payroll_period): return max_benefits - prev_sal_slip_flexi_total return max_benefits + def calculate_lwp(employee, start_date, holidays, working_days): lwp = 0 holidays = "','".join(holidays) + for d in range(working_days): - dt = add_days(cstr(getdate(start_date)), d) - leave = frappe.db.sql(""" - select t1.name, t1.half_day - from `tabLeave Application` t1, `tabLeave Type` t2 - where t2.name = t1.leave_type - and t2.is_lwp = 1 - and t1.docstatus = 1 - and t1.employee = %(employee)s - and CASE WHEN t2.include_holiday != 1 THEN %(dt)s not in ('{0}') and %(dt)s between from_date and to_date - WHEN t2.include_holiday THEN %(dt)s between from_date and to_date - END - """.format(holidays), {"employee": employee, "dt": dt}) - if leave: - lwp = cint(leave[0][1]) and (lwp + 0.5) or (lwp + 1) + date = add_days(cstr(getdate(start_date)), d) + + LeaveApplication = frappe.qb.DocType("Leave Application") + LeaveType = frappe.qb.DocType("Leave Type") + + is_half_day = ( + frappe.qb.terms.Case() + .when( + ( + (LeaveApplication.half_day_date == date) + | (LeaveApplication.from_date == LeaveApplication.to_date) + ), + LeaveApplication.half_day, + ) + .else_(0) + ).as_("is_half_day") + + query = ( + frappe.qb.from_(LeaveApplication) + .inner_join(LeaveType) + .on((LeaveType.name == LeaveApplication.leave_type)) + .select(LeaveApplication.name, is_half_day) + .where( + (LeaveType.is_lwp == 1) + & (LeaveApplication.docstatus == 1) + & (LeaveApplication.status == "Approved") + & (LeaveApplication.employee == employee) + & ((LeaveApplication.from_date <= date) & (date <= LeaveApplication.to_date)) + ) + ) + + # if it's a holiday only include if leave type has "include holiday" enabled + if date in holidays: + query = query.where((LeaveType.include_holiday == "1")) + leaves = query.run(as_dict=True) + + if leaves: + lwp += 0.5 if leaves[0].is_half_day else 1 + return lwp -def get_benefit_component_amount(employee, start_date, end_date, salary_component, sal_struct, payroll_frequency, payroll_period): + +def get_benefit_component_amount( + employee, start_date, end_date, salary_component, sal_struct, payroll_frequency, payroll_period +): if not payroll_period: - frappe.msgprint(_("Start and end dates not in a valid Payroll Period, cannot calculate {0}") - .format(salary_component)) + frappe.msgprint( + _("Start and end dates not in a valid Payroll Period, cannot calculate {0}").format( + salary_component + ) + ) return False # Considering there is only one application for a year - benefit_application = frappe.db.sql(""" + benefit_application = frappe.db.sql( + """ select name from `tabEmployee Benefit Application` where payroll_period=%(payroll_period)s and employee=%(employee)s and docstatus = 1 - """, { - 'employee': employee, - 'payroll_period': payroll_period.name - }) + """, + {"employee": employee, "payroll_period": payroll_period.name}, + ) current_benefit_amount = 0.0 - component_max_benefit, depends_on_payment_days = frappe.db.get_value("Salary Component", - salary_component, ["max_benefit_amount", "depends_on_payment_days"]) + component_max_benefit, depends_on_payment_days = frappe.db.get_value( + "Salary Component", salary_component, ["max_benefit_amount", "depends_on_payment_days"] + ) benefit_amount = 0 if benefit_application: - benefit_amount = frappe.db.get_value("Employee Benefit Application Detail", - {"parent": benefit_application[0][0], "earning_component": salary_component}, "amount") + benefit_amount = frappe.db.get_value( + "Employee Benefit Application Detail", + {"parent": benefit_application[0][0], "earning_component": salary_component}, + "amount", + ) elif component_max_benefit: benefit_amount = get_benefit_amount_based_on_pro_rata(sal_struct, component_max_benefit) current_benefit_amount = 0 if benefit_amount: - total_sub_periods = get_period_factor(employee, - start_date, end_date, payroll_frequency, payroll_period, depends_on_payment_days)[0] + total_sub_periods = get_period_factor( + employee, start_date, end_date, payroll_frequency, payroll_period, depends_on_payment_days + )[0] current_benefit_amount = benefit_amount / total_sub_periods return current_benefit_amount + def get_benefit_amount_based_on_pro_rata(sal_struct, component_max_benefit): max_benefits_total = 0 benefit_amount = 0 for d in sal_struct.get("earnings"): if d.is_flexible_benefit == 1: - component = frappe.db.get_value("Salary Component", d.salary_component, ["max_benefit_amount", "pay_against_benefit_claim"], as_dict=1) + component = frappe.db.get_value( + "Salary Component", + d.salary_component, + ["max_benefit_amount", "pay_against_benefit_claim"], + as_dict=1, + ) if not component.pay_against_benefit_claim: max_benefits_total += component.max_benefit_amount @@ -234,34 +326,46 @@ def get_benefit_amount_based_on_pro_rata(sal_struct, component_max_benefit): return benefit_amount + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_earning_components(doctype, txt, searchfield, start, page_len, filters): if len(filters) < 2: return {} - salary_structure = get_assigned_salary_structure(filters['employee'], filters['date']) + salary_structure = get_assigned_salary_structure(filters["employee"], filters["date"]) if salary_structure: - return frappe.db.sql(""" + return frappe.db.sql( + """ select salary_component from `tabSalary Detail` where parent = %s and is_flexible_benefit = 1 order by name - """, salary_structure) + """, + salary_structure, + ) else: - frappe.throw(_("Salary Structure not found for employee {0} and date {1}") - .format(filters['employee'], filters['date'])) + frappe.throw( + _("Salary Structure not found for employee {0} and date {1}").format( + filters["employee"], filters["date"] + ) + ) + @frappe.whitelist() def get_earning_components_max_benefits(employee, date, earning_component): salary_structure = get_assigned_salary_structure(employee, date) - amount = frappe.db.sql(""" + amount = frappe.db.sql( + """ select amount from `tabSalary Detail` where parent = %s and is_flexible_benefit = 1 and salary_component = %s order by name - """, salary_structure, earning_component) + """, + salary_structure, + earning_component, + ) return amount if amount else 0 diff --git a/erpnext/payroll/doctype/employee_benefit_application/test_employee_benefit_application.py b/erpnext/payroll/doctype/employee_benefit_application/test_employee_benefit_application.py index 02149adfce5..f2b86b3ff37 100644 --- a/erpnext/payroll/doctype/employee_benefit_application/test_employee_benefit_application.py +++ b/erpnext/payroll/doctype/employee_benefit_application/test_employee_benefit_application.py @@ -3,6 +3,82 @@ import unittest +import frappe +from frappe.tests.utils import FrappeTestCase +from frappe.utils import add_days, date_diff, get_year_ending, get_year_start, getdate -class TestEmployeeBenefitApplication(unittest.TestCase): - pass +from erpnext.hr.doctype.employee.test_employee import make_employee +from erpnext.hr.doctype.holiday_list.test_holiday_list import set_holiday_list +from erpnext.hr.tests.test_utils import get_first_sunday +from erpnext.hr.utils import get_holiday_dates_for_employee +from erpnext.payroll.doctype.employee_benefit_application.employee_benefit_application import ( + calculate_lwp, +) +from erpnext.payroll.doctype.employee_tax_exemption_declaration.test_employee_tax_exemption_declaration import ( + create_payroll_period, +) +from erpnext.payroll.doctype.salary_slip.test_salary_slip import ( + make_holiday_list, + make_leave_application, +) +from erpnext.payroll.doctype.salary_structure.salary_structure import make_salary_slip +from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure + + +class TestEmployeeBenefitApplication(FrappeTestCase): + def setUp(self): + date = getdate() + make_holiday_list(from_date=get_year_start(date), to_date=get_year_ending(date)) + + @set_holiday_list("Salary Slip Test Holiday List", "_Test Company") + def test_employee_benefit_application(self): + payroll_period = create_payroll_period(name="_Test Payroll Period 1", company="_Test Company") + employee = make_employee("test_employee_benefits@salary.com", company="_Test Company") + first_sunday = get_first_sunday("Salary Slip Test Holiday List") + + leave_application = make_leave_application( + employee, + add_days(first_sunday, 1), + add_days(first_sunday, 3), + "Leave Without Pay", + half_day=1, + half_day_date=add_days(first_sunday, 1), + submit=True, + ) + + frappe.db.set_value("Leave Type", "Leave Without Pay", "include_holiday", 0) + salary_structure = make_salary_structure( + "Test Employee Benefits", + "Monthly", + other_details={"max_benefits": 100000}, + include_flexi_benefits=True, + employee=employee, + payroll_period=payroll_period, + ) + salary_slip = make_salary_slip(salary_structure.name, employee=employee, posting_date=getdate()) + salary_slip.insert() + salary_slip.submit() + + application = make_employee_benefit_application( + employee, payroll_period.name, date=leave_application.to_date + ) + self.assertEqual(application.employee_benefits[0].max_benefit_amount, 15000) + + holidays = get_holiday_dates_for_employee(employee, payroll_period.start_date, application.date) + working_days = date_diff(application.date, payroll_period.start_date) + 1 + lwp = calculate_lwp(employee, payroll_period.start_date, holidays, working_days) + self.assertEqual(lwp, 2.5) + + +def make_employee_benefit_application(employee, payroll_period, date): + frappe.db.delete("Employee Benefit Application") + + return frappe.get_doc( + { + "doctype": "Employee Benefit Application", + "employee": employee, + "date": date, + "payroll_period": payroll_period, + "employee_benefits": [{"earning_component": "Medical Allowance", "amount": 1500}], + } + ).insert() diff --git a/erpnext/payroll/doctype/employee_benefit_claim/employee_benefit_claim.py b/erpnext/payroll/doctype/employee_benefit_claim/employee_benefit_claim.py index 801ce4ba367..31f26b25e73 100644 --- a/erpnext/payroll/doctype/employee_benefit_claim/employee_benefit_claim.py +++ b/erpnext/payroll/doctype/employee_benefit_claim/employee_benefit_claim.py @@ -23,9 +23,15 @@ class EmployeeBenefitClaim(Document): max_benefits = get_max_benefits(self.employee, self.claim_date) if not max_benefits or max_benefits <= 0: frappe.throw(_("Employee {0} has no maximum benefit amount").format(self.employee)) - payroll_period = get_payroll_period(self.claim_date, self.claim_date, frappe.db.get_value("Employee", self.employee, "company")) + payroll_period = get_payroll_period( + self.claim_date, self.claim_date, frappe.db.get_value("Employee", self.employee, "company") + ) if not payroll_period: - frappe.throw(_("{0} is not in a valid Payroll Period").format(frappe.format(self.claim_date, dict(fieldtype='Date')))) + frappe.throw( + _("{0} is not in a valid Payroll Period").format( + frappe.format(self.claim_date, dict(fieldtype="Date")) + ) + ) self.validate_max_benefit_for_component(payroll_period) self.validate_max_benefit_for_sal_struct(max_benefits) self.validate_benefit_claim_amount(max_benefits, payroll_period) @@ -36,21 +42,31 @@ class EmployeeBenefitClaim(Document): claimed_amount = self.claimed_amount claimed_amount += get_previous_claimed_amount(self.employee, payroll_period) if max_benefits < claimed_amount: - frappe.throw(_("Maximum benefit of employee {0} exceeds {1} by the sum {2} of previous claimed\ - amount").format(self.employee, max_benefits, claimed_amount-max_benefits)) + frappe.throw( + _( + "Maximum benefit of employee {0} exceeds {1} by the sum {2} of previous claimed\ + amount" + ).format(self.employee, max_benefits, claimed_amount - max_benefits) + ) def validate_max_benefit_for_sal_struct(self, max_benefits): if self.claimed_amount > max_benefits: - frappe.throw(_("Maximum benefit amount of employee {0} exceeds {1}").format(self.employee, max_benefits)) + frappe.throw( + _("Maximum benefit amount of employee {0} exceeds {1}").format(self.employee, max_benefits) + ) def validate_max_benefit_for_component(self, payroll_period): if self.max_amount_eligible: claimed_amount = self.claimed_amount - claimed_amount += get_previous_claimed_amount(self.employee, - payroll_period, component = self.earning_component) + claimed_amount += get_previous_claimed_amount( + self.employee, payroll_period, component=self.earning_component + ) if claimed_amount > self.max_amount_eligible: - frappe.throw(_("Maximum amount eligible for the component {0} exceeds {1}") - .format(self.earning_component, self.max_amount_eligible)) + frappe.throw( + _("Maximum amount eligible for the component {0} exceeds {1}").format( + self.earning_component, self.max_amount_eligible + ) + ) def validate_non_pro_rata_benefit_claim(self, max_benefits, payroll_period): claimed_amount = self.claimed_amount @@ -64,30 +80,39 @@ class EmployeeBenefitClaim(Document): sal_struct = frappe.get_doc("Salary Structure", sal_struct_name) pro_rata_amount = get_benefit_pro_rata_ratio_amount(self.employee, self.claim_date, sal_struct) - claimed_amount += get_previous_claimed_amount(self.employee, payroll_period, non_pro_rata = True) + claimed_amount += get_previous_claimed_amount(self.employee, payroll_period, non_pro_rata=True) if max_benefits < pro_rata_amount + claimed_amount: - frappe.throw(_("Maximum benefit of employee {0} exceeds {1} by the sum {2} of benefit application pro-rata component\ - amount and previous claimed amount").format(self.employee, max_benefits, pro_rata_amount+claimed_amount-max_benefits)) + frappe.throw( + _( + "Maximum benefit of employee {0} exceeds {1} by the sum {2} of benefit application pro-rata component\ + amount and previous claimed amount" + ).format( + self.employee, max_benefits, pro_rata_amount + claimed_amount - max_benefits + ) + ) def get_pro_rata_amount_in_application(self, payroll_period): application = frappe.db.exists( "Employee Benefit Application", - { - 'employee': self.employee, - 'payroll_period': payroll_period, - 'docstatus': 1 - } + {"employee": self.employee, "payroll_period": payroll_period, "docstatus": 1}, ) if application: - return frappe.db.get_value("Employee Benefit Application", application, "pro_rata_dispensed_amount") + return frappe.db.get_value( + "Employee Benefit Application", application, "pro_rata_dispensed_amount" + ) return False + def get_benefit_pro_rata_ratio_amount(employee, on_date, sal_struct): total_pro_rata_max = 0 benefit_amount_total = 0 for sal_struct_row in sal_struct.get("earnings"): try: - pay_against_benefit_claim, max_benefit_amount = frappe.db.get_value("Salary Component", sal_struct_row.salary_component, ["pay_against_benefit_claim", "max_benefit_amount"]) + pay_against_benefit_claim, max_benefit_amount = frappe.db.get_value( + "Salary Component", + sal_struct_row.salary_component, + ["pay_against_benefit_claim", "max_benefit_amount"], + ) except TypeError: # show the error in tests? frappe.throw(_("Unable to find Salary Component {0}").format(sal_struct_row.salary_component)) @@ -95,7 +120,11 @@ def get_benefit_pro_rata_ratio_amount(employee, on_date, sal_struct): total_pro_rata_max += max_benefit_amount if total_pro_rata_max > 0: for sal_struct_row in sal_struct.get("earnings"): - pay_against_benefit_claim, max_benefit_amount = frappe.db.get_value("Salary Component", sal_struct_row.salary_component, ["pay_against_benefit_claim", "max_benefit_amount"]) + pay_against_benefit_claim, max_benefit_amount = frappe.db.get_value( + "Salary Component", + sal_struct_row.salary_component, + ["pay_against_benefit_claim", "max_benefit_amount"], + ) if sal_struct_row.is_flexible_benefit == 1 and pay_against_benefit_claim != 1: component_max = max_benefit_amount @@ -105,6 +134,7 @@ def get_benefit_pro_rata_ratio_amount(employee, on_date, sal_struct): benefit_amount_total += benefit_amount return benefit_amount_total + def get_benefit_claim_amount(employee, start_date, end_date, salary_component=None): query = """ select sum(claimed_amount) @@ -119,41 +149,54 @@ def get_benefit_claim_amount(employee, start_date, end_date, salary_component=No if salary_component: query += " and earning_component = %(earning_component)s" - claimed_amount = flt(frappe.db.sql(query, { - 'employee': employee, - 'start_date': start_date, - 'end_date': end_date, - 'earning_component': salary_component - })[0][0]) + claimed_amount = flt( + frappe.db.sql( + query, + { + "employee": employee, + "start_date": start_date, + "end_date": end_date, + "earning_component": salary_component, + }, + )[0][0] + ) return claimed_amount + def get_total_benefit_dispensed(employee, sal_struct, sal_slip_start_date, payroll_period): pro_rata_amount = 0 claimed_amount = 0 application = frappe.db.exists( "Employee Benefit Application", - { - 'employee': employee, - 'payroll_period': payroll_period.name, - 'docstatus': 1 - } + {"employee": employee, "payroll_period": payroll_period.name, "docstatus": 1}, ) if application: application_obj = frappe.get_doc("Employee Benefit Application", application) - pro_rata_amount = application_obj.pro_rata_dispensed_amount + application_obj.max_benefits - application_obj.remaining_benefit + pro_rata_amount = ( + application_obj.pro_rata_dispensed_amount + + application_obj.max_benefits + - application_obj.remaining_benefit + ) else: pro_rata_amount = get_benefit_pro_rata_ratio_amount(employee, sal_slip_start_date, sal_struct) - claimed_amount += get_benefit_claim_amount(employee, payroll_period.start_date, payroll_period.end_date) + claimed_amount += get_benefit_claim_amount( + employee, payroll_period.start_date, payroll_period.end_date + ) return claimed_amount + pro_rata_amount -def get_last_payroll_period_benefits(employee, sal_slip_start_date, sal_slip_end_date, payroll_period, sal_struct): + +def get_last_payroll_period_benefits( + employee, sal_slip_start_date, sal_slip_end_date, payroll_period, sal_struct +): max_benefits = get_max_benefits(employee, payroll_period.end_date) if not max_benefits: max_benefits = 0 - remaining_benefit = max_benefits - get_total_benefit_dispensed(employee, sal_struct, sal_slip_start_date, payroll_period) + remaining_benefit = max_benefits - get_total_benefit_dispensed( + employee, sal_struct, sal_slip_start_date, payroll_period + ) if remaining_benefit > 0: have_remaining = True # Set the remaining benefits to flexi non pro-rata component in the salary structure @@ -162,7 +205,9 @@ def get_last_payroll_period_benefits(employee, sal_slip_start_date, sal_slip_end if d.is_flexible_benefit == 1: salary_component = frappe.get_doc("Salary Component", d.salary_component) if salary_component.pay_against_benefit_claim == 1: - claimed_amount = get_benefit_claim_amount(employee, payroll_period.start_date, sal_slip_end_date, d.salary_component) + claimed_amount = get_benefit_claim_amount( + employee, payroll_period.start_date, sal_slip_end_date, d.salary_component + ) amount_fit_to_component = salary_component.max_benefit_amount - claimed_amount if amount_fit_to_component > 0: if remaining_benefit > amount_fit_to_component: @@ -171,19 +216,23 @@ def get_last_payroll_period_benefits(employee, sal_slip_start_date, sal_slip_end else: amount = remaining_benefit have_remaining = False - current_claimed_amount = get_benefit_claim_amount(employee, sal_slip_start_date, sal_slip_end_date, d.salary_component) + current_claimed_amount = get_benefit_claim_amount( + employee, sal_slip_start_date, sal_slip_end_date, d.salary_component + ) amount += current_claimed_amount struct_row = {} salary_components_dict = {} - struct_row['depends_on_payment_days'] = salary_component.depends_on_payment_days - struct_row['salary_component'] = salary_component.name - struct_row['abbr'] = salary_component.salary_component_abbr - struct_row['do_not_include_in_total'] = salary_component.do_not_include_in_total - struct_row['is_tax_applicable'] = salary_component.is_tax_applicable, - struct_row['is_flexible_benefit'] = salary_component.is_flexible_benefit, - struct_row['variable_based_on_taxable_salary'] = salary_component.variable_based_on_taxable_salary - salary_components_dict['amount'] = amount - salary_components_dict['struct_row'] = struct_row + struct_row["depends_on_payment_days"] = salary_component.depends_on_payment_days + struct_row["salary_component"] = salary_component.name + struct_row["abbr"] = salary_component.salary_component_abbr + struct_row["do_not_include_in_total"] = salary_component.do_not_include_in_total + struct_row["is_tax_applicable"] = (salary_component.is_tax_applicable,) + struct_row["is_flexible_benefit"] = (salary_component.is_flexible_benefit,) + struct_row[ + "variable_based_on_taxable_salary" + ] = salary_component.variable_based_on_taxable_salary + salary_components_dict["amount"] = amount + salary_components_dict["struct_row"] = struct_row salary_components_array.append(salary_components_dict) if not have_remaining: break diff --git a/erpnext/payroll/doctype/employee_incentive/employee_incentive.py b/erpnext/payroll/doctype/employee_incentive/employee_incentive.py index a37e22425f7..7686185349f 100644 --- a/erpnext/payroll/doctype/employee_incentive/employee_incentive.py +++ b/erpnext/payroll/doctype/employee_incentive/employee_incentive.py @@ -15,13 +15,17 @@ class EmployeeIncentive(Document): self.validate_salary_structure() def validate_salary_structure(self): - if not frappe.db.exists('Salary Structure Assignment', {'employee': self.employee}): - frappe.throw(_("There is no Salary Structure assigned to {0}. First assign a Salary Stucture.").format(self.employee)) + if not frappe.db.exists("Salary Structure Assignment", {"employee": self.employee}): + frappe.throw( + _("There is no Salary Structure assigned to {0}. First assign a Salary Stucture.").format( + self.employee + ) + ) def on_submit(self): - company = frappe.db.get_value('Employee', self.employee, 'company') + company = frappe.db.get_value("Employee", self.employee, "company") - additional_salary = frappe.new_doc('Additional Salary') + additional_salary = frappe.new_doc("Additional Salary") additional_salary.employee = self.employee additional_salary.currency = self.currency additional_salary.salary_component = self.salary_component diff --git a/erpnext/payroll/doctype/employee_tax_exemption_declaration/employee_tax_exemption_declaration.py b/erpnext/payroll/doctype/employee_tax_exemption_declaration/employee_tax_exemption_declaration.py index 9b5eab636f1..3d1d96598fc 100644 --- a/erpnext/payroll/doctype/employee_tax_exemption_declaration/employee_tax_exemption_declaration.py +++ b/erpnext/payroll/doctype/employee_tax_exemption_declaration/employee_tax_exemption_declaration.py @@ -20,7 +20,9 @@ class EmployeeTaxExemptionDeclaration(Document): def validate(self): validate_active_employee(self.employee) validate_tax_declaration(self.declarations) - validate_duplicate_exemption_for_payroll_period(self.doctype, self.name, self.payroll_period, self.employee) + validate_duplicate_exemption_for_payroll_period( + self.doctype, self.name, self.payroll_period, self.employee + ) self.set_total_declared_amount() self.set_total_exemption_amount() self.calculate_hra_exemption() @@ -31,7 +33,9 @@ class EmployeeTaxExemptionDeclaration(Document): self.total_declared_amount += flt(d.amount) def set_total_exemption_amount(self): - self.total_exemption_amount = get_total_exemption_amount(self.declarations) + self.total_exemption_amount = flt( + get_total_exemption_amount(self.declarations), self.precision("total_exemption_amount") + ) def calculate_hra_exemption(self): self.salary_structure_hra, self.annual_hra_exemption, self.monthly_hra_exemption = 0, 0, 0 @@ -39,21 +43,36 @@ class EmployeeTaxExemptionDeclaration(Document): hra_exemption = calculate_annual_eligible_hra_exemption(self) if hra_exemption: self.total_exemption_amount += hra_exemption["annual_exemption"] - self.salary_structure_hra = hra_exemption["hra_amount"] - self.annual_hra_exemption = hra_exemption["annual_exemption"] - self.monthly_hra_exemption = hra_exemption["monthly_exemption"] + self.total_exemption_amount = flt( + self.total_exemption_amount, self.precision("total_exemption_amount") + ) + self.salary_structure_hra = flt( + hra_exemption["hra_amount"], self.precision("salary_structure_hra") + ) + self.annual_hra_exemption = flt( + hra_exemption["annual_exemption"], self.precision("annual_hra_exemption") + ) + self.monthly_hra_exemption = flt( + hra_exemption["monthly_exemption"], self.precision("monthly_hra_exemption") + ) + @frappe.whitelist() def make_proof_submission(source_name, target_doc=None): - doclist = get_mapped_doc("Employee Tax Exemption Declaration", source_name, { - "Employee Tax Exemption Declaration": { - "doctype": "Employee Tax Exemption Proof Submission", - "field_no_map": ["monthly_house_rent", "monthly_hra_exemption"] + doclist = get_mapped_doc( + "Employee Tax Exemption Declaration", + source_name, + { + "Employee Tax Exemption Declaration": { + "doctype": "Employee Tax Exemption Proof Submission", + "field_no_map": ["monthly_house_rent", "monthly_hra_exemption"], + }, + "Employee Tax Exemption Declaration Category": { + "doctype": "Employee Tax Exemption Proof Submission Detail", + "add_if_empty": True, + }, }, - "Employee Tax Exemption Declaration Category": { - "doctype": "Employee Tax Exemption Proof Submission Detail", - "add_if_empty": True - } - }, target_doc) + target_doc, + ) return doclist diff --git a/erpnext/payroll/doctype/employee_tax_exemption_declaration/test_employee_tax_exemption_declaration.py b/erpnext/payroll/doctype/employee_tax_exemption_declaration/test_employee_tax_exemption_declaration.py index fc28afdc3e5..2d8df350118 100644 --- a/erpnext/payroll/doctype/employee_tax_exemption_declaration/test_employee_tax_exemption_declaration.py +++ b/erpnext/payroll/doctype/employee_tax_exemption_declaration/test_employee_tax_exemption_declaration.py @@ -4,127 +4,487 @@ import unittest import frappe +from frappe.tests.utils import FrappeTestCase +from frappe.utils import add_months, getdate import erpnext from erpnext.hr.doctype.employee.test_employee import make_employee from erpnext.hr.utils import DuplicateDeclarationError -class TestEmployeeTaxExemptionDeclaration(unittest.TestCase): +class TestEmployeeTaxExemptionDeclaration(FrappeTestCase): def setUp(self): - make_employee("employee@taxexepmtion.com") - make_employee("employee1@taxexepmtion.com") - create_payroll_period() + make_employee("employee@taxexemption.com", company="_Test Company") + make_employee("employee1@taxexemption.com", company="_Test Company") + create_payroll_period(company="_Test Company") create_exemption_category() - frappe.db.sql("""delete from `tabEmployee Tax Exemption Declaration`""") + frappe.db.delete("Employee Tax Exemption Declaration") + frappe.db.delete("Salary Structure Assignment") def test_duplicate_category_in_declaration(self): - declaration = frappe.get_doc({ - "doctype": "Employee Tax Exemption Declaration", - "employee": frappe.get_value("Employee", {"user_id":"employee@taxexepmtion.com"}, "name"), - "company": erpnext.get_default_company(), - "payroll_period": "_Test Payroll Period", - "currency": erpnext.get_default_currency(), - "declarations": [ - dict(exemption_sub_category = "_Test Sub Category", - exemption_category = "_Test Category", - amount = 100000), - dict(exemption_sub_category = "_Test Sub Category", - exemption_category = "_Test Category", - amount = 50000) - ] - }) + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name"), + "company": erpnext.get_default_company(), + "payroll_period": "_Test Payroll Period", + "currency": erpnext.get_default_currency(), + "declarations": [ + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + amount=100000, + ), + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + amount=50000, + ), + ], + } + ) self.assertRaises(frappe.ValidationError, declaration.save) def test_duplicate_entry_for_payroll_period(self): - declaration = frappe.get_doc({ - "doctype": "Employee Tax Exemption Declaration", - "employee": frappe.get_value("Employee", {"user_id":"employee@taxexepmtion.com"}, "name"), - "company": erpnext.get_default_company(), - "payroll_period": "_Test Payroll Period", - "currency": erpnext.get_default_currency(), - "declarations": [ - dict(exemption_sub_category = "_Test Sub Category", - exemption_category = "_Test Category", - amount = 100000), - dict(exemption_sub_category = "_Test1 Sub Category", - exemption_category = "_Test Category", - amount = 50000), - ] - }).insert() + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name"), + "company": erpnext.get_default_company(), + "payroll_period": "_Test Payroll Period", + "currency": erpnext.get_default_currency(), + "declarations": [ + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + amount=100000, + ), + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + amount=50000, + ), + ], + } + ).insert() - duplicate_declaration = frappe.get_doc({ - "doctype": "Employee Tax Exemption Declaration", - "employee": frappe.get_value("Employee", {"user_id":"employee@taxexepmtion.com"}, "name"), - "company": erpnext.get_default_company(), - "payroll_period": "_Test Payroll Period", - "currency": erpnext.get_default_currency(), - "declarations": [ - dict(exemption_sub_category = "_Test Sub Category", - exemption_category = "_Test Category", - amount = 100000) - ] - }) + duplicate_declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name"), + "company": erpnext.get_default_company(), + "payroll_period": "_Test Payroll Period", + "currency": erpnext.get_default_currency(), + "declarations": [ + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + amount=100000, + ) + ], + } + ) self.assertRaises(DuplicateDeclarationError, duplicate_declaration.insert) - duplicate_declaration.employee = frappe.get_value("Employee", {"user_id":"employee1@taxexepmtion.com"}, "name") + duplicate_declaration.employee = frappe.get_value( + "Employee", {"user_id": "employee1@taxexemption.com"}, "name" + ) self.assertTrue(duplicate_declaration.insert) def test_exemption_amount(self): - declaration = frappe.get_doc({ - "doctype": "Employee Tax Exemption Declaration", - "employee": frappe.get_value("Employee", {"user_id":"employee@taxexepmtion.com"}, "name"), - "company": erpnext.get_default_company(), - "payroll_period": "_Test Payroll Period", - "currency": erpnext.get_default_currency(), - "declarations": [ - dict(exemption_sub_category = "_Test Sub Category", - exemption_category = "_Test Category", - amount = 80000), - dict(exemption_sub_category = "_Test1 Sub Category", - exemption_category = "_Test Category", - amount = 60000), - ] - }).insert() + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name"), + "company": erpnext.get_default_company(), + "payroll_period": "_Test Payroll Period", + "currency": erpnext.get_default_currency(), + "declarations": [ + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + amount=80000, + ), + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + amount=60000, + ), + ], + } + ).insert() self.assertEqual(declaration.total_exemption_amount, 100000) + def test_india_hra_exemption(self): + # set country + current_country = frappe.flags.country + frappe.flags.country = "India" + + setup_hra_exemption_prerequisites("Monthly") + employee = frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name") + + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": employee, + "company": "_Test Company", + "payroll_period": "_Test Payroll Period", + "currency": "INR", + "monthly_house_rent": 50000, + "rented_in_metro_city": 1, + "declarations": [ + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + amount=80000, + ), + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + amount=60000, + ), + ], + } + ).insert() + + # Monthly HRA received = 3000 + # should set HRA exemption as per actual annual HRA because that's the minimum + self.assertEqual(declaration.monthly_hra_exemption, 3000) + self.assertEqual(declaration.annual_hra_exemption, 36000) + # 100000 Standard Exemption + 36000 HRA exemption + self.assertEqual(declaration.total_exemption_amount, 136000) + + # reset + frappe.flags.country = current_country + + def test_india_hra_exemption_with_daily_payroll_frequency(self): + # set country + current_country = frappe.flags.country + frappe.flags.country = "India" + + setup_hra_exemption_prerequisites("Daily") + employee = frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name") + + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": employee, + "company": "_Test Company", + "payroll_period": "_Test Payroll Period", + "currency": "INR", + "monthly_house_rent": 170000, + "rented_in_metro_city": 1, + "declarations": [ + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + amount=60000, + ), + ], + } + ).insert() + + # Daily HRA received = 3000 + # should set HRA exemption as per (rent - 10% of Basic Salary), that's the minimum + self.assertEqual(declaration.monthly_hra_exemption, 17916.67) + self.assertEqual(declaration.annual_hra_exemption, 215000) + # 50000 Standard Exemption + 215000 HRA exemption + self.assertEqual(declaration.total_exemption_amount, 265000) + + # reset + frappe.flags.country = current_country + + def test_india_hra_exemption_with_weekly_payroll_frequency(self): + # set country + current_country = frappe.flags.country + frappe.flags.country = "India" + + setup_hra_exemption_prerequisites("Weekly") + employee = frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name") + + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": employee, + "company": "_Test Company", + "payroll_period": "_Test Payroll Period", + "currency": "INR", + "monthly_house_rent": 170000, + "rented_in_metro_city": 1, + "declarations": [ + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + amount=60000, + ), + ], + } + ).insert() + + # Weekly HRA received = 3000 + # should set HRA exemption as per actual annual HRA because that's the minimum + self.assertEqual(declaration.monthly_hra_exemption, 13000) + self.assertEqual(declaration.annual_hra_exemption, 156000) + # 50000 Standard Exemption + 156000 HRA exemption + self.assertEqual(declaration.total_exemption_amount, 206000) + + # reset + frappe.flags.country = current_country + + def test_india_hra_exemption_with_fortnightly_payroll_frequency(self): + # set country + current_country = frappe.flags.country + frappe.flags.country = "India" + + setup_hra_exemption_prerequisites("Fortnightly") + employee = frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name") + + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": employee, + "company": "_Test Company", + "payroll_period": "_Test Payroll Period", + "currency": "INR", + "monthly_house_rent": 170000, + "rented_in_metro_city": 1, + "declarations": [ + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + amount=60000, + ), + ], + } + ).insert() + + # Fortnightly HRA received = 3000 + # should set HRA exemption as per actual annual HRA because that's the minimum + self.assertEqual(declaration.monthly_hra_exemption, 6500) + self.assertEqual(declaration.annual_hra_exemption, 78000) + # 50000 Standard Exemption + 78000 HRA exemption + self.assertEqual(declaration.total_exemption_amount, 128000) + + # reset + frappe.flags.country = current_country + + def test_india_hra_exemption_with_bimonthly_payroll_frequency(self): + # set country + current_country = frappe.flags.country + frappe.flags.country = "India" + + setup_hra_exemption_prerequisites("Bimonthly") + employee = frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name") + + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": employee, + "company": "_Test Company", + "payroll_period": "_Test Payroll Period", + "currency": "INR", + "monthly_house_rent": 50000, + "rented_in_metro_city": 1, + "declarations": [ + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + amount=80000, + ), + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + amount=60000, + ), + ], + } + ).insert() + + # Bimonthly HRA received = 3000 + # should set HRA exemption as per actual annual HRA because that's the minimum + self.assertEqual(declaration.monthly_hra_exemption, 1500) + self.assertEqual(declaration.annual_hra_exemption, 18000) + # 100000 Standard Exemption + 18000 HRA exemption + self.assertEqual(declaration.total_exemption_amount, 118000) + + # reset + frappe.flags.country = current_country + + def test_india_hra_exemption_with_multiple_salary_structure_assignments(self): + from erpnext.payroll.doctype.salary_slip.test_salary_slip import create_tax_slab + from erpnext.payroll.doctype.salary_structure.test_salary_structure import ( + create_salary_structure_assignment, + make_salary_structure, + ) + + # set country + current_country = frappe.flags.country + frappe.flags.country = "India" + + employee = make_employee("employee@taxexemption2.com", company="_Test Company") + payroll_period = create_payroll_period(name="_Test Payroll Period", company="_Test Company") + + create_tax_slab( + payroll_period, + allow_tax_exemption=True, + currency="INR", + effective_date=getdate("2019-04-01"), + company="_Test Company", + ) + + frappe.db.set_value( + "Company", "_Test Company", {"basic_component": "Basic Salary", "hra_component": "HRA"} + ) + + # salary structure with base 50000, HRA 3000 + make_salary_structure( + "Monthly Structure for HRA Exemption 1", + "Monthly", + employee=employee, + company="_Test Company", + currency="INR", + payroll_period=payroll_period.name, + from_date=payroll_period.start_date, + ) + + # salary structure with base 70000, HRA = base * 0.2 = 14000 + salary_structure = make_salary_structure( + "Monthly Structure for HRA Exemption 2", + "Monthly", + employee=employee, + company="_Test Company", + currency="INR", + payroll_period=payroll_period.name, + from_date=payroll_period.start_date, + dont_submit=True, + ) + for component_row in salary_structure.earnings: + if component_row.salary_component == "HRA": + component_row.amount = 0 + component_row.amount_based_on_formula = 1 + component_row.formula = "base * 0.2" + break + + salary_structure.submit() + + create_salary_structure_assignment( + employee, + salary_structure.name, + from_date=add_months(payroll_period.start_date, 6), + company="_Test Company", + currency="INR", + payroll_period=payroll_period.name, + base=70000, + allow_duplicate=True, + ) + + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": employee, + "company": "_Test Company", + "payroll_period": payroll_period.name, + "currency": "INR", + "monthly_house_rent": 50000, + "rented_in_metro_city": 1, + "declarations": [ + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + amount=60000, + ), + ], + } + ).insert() + + # Monthly HRA received = 50000 * 6 months + 70000 * 6 months + # should set HRA exemption as per actual annual HRA because that's the minimum + self.assertEqual(declaration.monthly_hra_exemption, 8500) + self.assertEqual(declaration.annual_hra_exemption, 102000) + # 50000 Standard Exemption + 102000 HRA exemption + self.assertEqual(declaration.total_exemption_amount, 152000) + + # reset + frappe.flags.country = current_country + + def create_payroll_period(**args): args = frappe._dict(args) name = args.name or "_Test Payroll Period" if not frappe.db.exists("Payroll Period", name): from datetime import date - payroll_period = frappe.get_doc(dict( - doctype = 'Payroll Period', - name = name, - company = args.company or erpnext.get_default_company(), - start_date = args.start_date or date(date.today().year, 1, 1), - end_date = args.end_date or date(date.today().year, 12, 31) - )).insert() + + payroll_period = frappe.get_doc( + dict( + doctype="Payroll Period", + name=name, + company=args.company or erpnext.get_default_company(), + start_date=args.start_date or date(date.today().year, 1, 1), + end_date=args.end_date or date(date.today().year, 12, 31), + ) + ).insert() return payroll_period else: return frappe.get_doc("Payroll Period", name) + def create_exemption_category(): if not frappe.db.exists("Employee Tax Exemption Category", "_Test Category"): - category = frappe.get_doc({ - "doctype": "Employee Tax Exemption Category", - "name": "_Test Category", - "deduction_component": "Income Tax", - "max_amount": 100000 - }).insert() + category = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Category", + "name": "_Test Category", + "deduction_component": "Income Tax", + "max_amount": 100000, + } + ).insert() if not frappe.db.exists("Employee Tax Exemption Sub Category", "_Test Sub Category"): - frappe.get_doc({ - "doctype": "Employee Tax Exemption Sub Category", - "name": "_Test Sub Category", - "exemption_category": "_Test Category", - "max_amount": 100000, - "is_active": 1 - }).insert() + frappe.get_doc( + { + "doctype": "Employee Tax Exemption Sub Category", + "name": "_Test Sub Category", + "exemption_category": "_Test Category", + "max_amount": 100000, + "is_active": 1, + } + ).insert() if not frappe.db.exists("Employee Tax Exemption Sub Category", "_Test1 Sub Category"): - frappe.get_doc({ - "doctype": "Employee Tax Exemption Sub Category", - "name": "_Test1 Sub Category", - "exemption_category": "_Test Category", - "max_amount": 50000, - "is_active": 1 - }).insert() + frappe.get_doc( + { + "doctype": "Employee Tax Exemption Sub Category", + "name": "_Test1 Sub Category", + "exemption_category": "_Test Category", + "max_amount": 50000, + "is_active": 1, + } + ).insert() + + +def setup_hra_exemption_prerequisites(frequency, employee=None): + from erpnext.payroll.doctype.salary_slip.test_salary_slip import create_tax_slab + from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure + + payroll_period = create_payroll_period(name="_Test Payroll Period", company="_Test Company") + if not employee: + employee = frappe.get_value("Employee", {"user_id": "employee@taxexemption.com"}, "name") + + create_tax_slab( + payroll_period, + allow_tax_exemption=True, + currency="INR", + effective_date=getdate("2019-04-01"), + company="_Test Company", + ) + + make_salary_structure( + f"{frequency} Structure for HRA Exemption", + frequency, + employee=employee, + company="_Test Company", + currency="INR", + payroll_period=payroll_period, + ) + + frappe.db.set_value( + "Company", "_Test Company", {"basic_component": "Basic Salary", "hra_component": "HRA"} + ) diff --git a/erpnext/payroll/doctype/employee_tax_exemption_proof_submission/employee_tax_exemption_proof_submission.py b/erpnext/payroll/doctype/employee_tax_exemption_proof_submission/employee_tax_exemption_proof_submission.py index 56e73b37dff..b3b66b9e7b1 100644 --- a/erpnext/payroll/doctype/employee_tax_exemption_proof_submission/employee_tax_exemption_proof_submission.py +++ b/erpnext/payroll/doctype/employee_tax_exemption_proof_submission/employee_tax_exemption_proof_submission.py @@ -21,7 +21,9 @@ class EmployeeTaxExemptionProofSubmission(Document): self.set_total_actual_amount() self.set_total_exemption_amount() self.calculate_hra_exemption() - validate_duplicate_exemption_for_payroll_period(self.doctype, self.name, self.payroll_period, self.employee) + validate_duplicate_exemption_for_payroll_period( + self.doctype, self.name, self.payroll_period, self.employee + ) def set_total_actual_amount(self): self.total_actual_amount = flt(self.get("house_rent_payment_amount")) @@ -29,7 +31,9 @@ class EmployeeTaxExemptionProofSubmission(Document): self.total_actual_amount += flt(d.amount) def set_total_exemption_amount(self): - self.exemption_amount = get_total_exemption_amount(self.tax_exemption_proofs) + self.exemption_amount = flt( + get_total_exemption_amount(self.tax_exemption_proofs), self.precision("exemption_amount") + ) def calculate_hra_exemption(self): self.monthly_hra_exemption, self.monthly_house_rent, self.total_eligible_hra_exemption = 0, 0, 0 @@ -37,6 +41,13 @@ class EmployeeTaxExemptionProofSubmission(Document): hra_exemption = calculate_hra_exemption_for_period(self) if hra_exemption: self.exemption_amount += hra_exemption["total_eligible_hra_exemption"] - self.monthly_hra_exemption = hra_exemption["monthly_exemption"] - self.monthly_house_rent = hra_exemption["monthly_house_rent"] - self.total_eligible_hra_exemption = hra_exemption["total_eligible_hra_exemption"] + self.exemption_amount = flt(self.exemption_amount, self.precision("exemption_amount")) + self.monthly_hra_exemption = flt( + hra_exemption["monthly_exemption"], self.precision("monthly_hra_exemption") + ) + self.monthly_house_rent = flt( + hra_exemption["monthly_house_rent"], self.precision("monthly_house_rent") + ) + self.total_eligible_hra_exemption = flt( + hra_exemption["total_eligible_hra_exemption"], self.precision("total_eligible_hra_exemption") + ) diff --git a/erpnext/payroll/doctype/employee_tax_exemption_proof_submission/test_employee_tax_exemption_proof_submission.py b/erpnext/payroll/doctype/employee_tax_exemption_proof_submission/test_employee_tax_exemption_proof_submission.py index f2aa64c2878..416cf316c97 100644 --- a/erpnext/payroll/doctype/employee_tax_exemption_proof_submission/test_employee_tax_exemption_proof_submission.py +++ b/erpnext/payroll/doctype/employee_tax_exemption_proof_submission/test_employee_tax_exemption_proof_submission.py @@ -4,55 +4,133 @@ import unittest import frappe +from frappe.tests.utils import FrappeTestCase +from erpnext.hr.doctype.employee.test_employee import make_employee from erpnext.payroll.doctype.employee_tax_exemption_declaration.test_employee_tax_exemption_declaration import ( create_exemption_category, create_payroll_period, + setup_hra_exemption_prerequisites, ) -class TestEmployeeTaxExemptionProofSubmission(unittest.TestCase): - def setup(self): - make_employee("employee@proofsubmission.com") - create_payroll_period() +class TestEmployeeTaxExemptionProofSubmission(FrappeTestCase): + def setUp(self): + make_employee("employee@proofsubmission.com", company="_Test Company") + create_payroll_period(company="_Test Company") create_exemption_category() - frappe.db.sql("""delete from `tabEmployee Tax Exemption Proof Submission`""") + frappe.db.delete("Employee Tax Exemption Proof Submission") + frappe.db.delete("Salary Structure Assignment") def test_exemption_amount_lesser_than_category_max(self): - declaration = frappe.get_doc({ - "doctype": "Employee Tax Exemption Proof Submission", - "employee": frappe.get_value("Employee", {"user_id":"employee@proofsubmission.com"}, "name"), - "payroll_period": "Test Payroll Period", - "tax_exemption_proofs": [dict(exemption_sub_category = "_Test Sub Category", - type_of_proof = "Test Proof", - exemption_category = "_Test Category", - amount = 150000)] - }) - self.assertRaises(frappe.ValidationError, declaration.save) - declaration = frappe.get_doc({ - "doctype": "Employee Tax Exemption Proof Submission", - "payroll_period": "Test Payroll Period", - "employee": frappe.get_value("Employee", {"user_id":"employee@proofsubmission.com"}, "name"), - "tax_exemption_proofs": [dict(exemption_sub_category = "_Test Sub Category", - type_of_proof = "Test Proof", - exemption_category = "_Test Category", - amount = 100000)] - }) - self.assertTrue(declaration.save) - self.assertTrue(declaration.submit) + proof = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Proof Submission", + "employee": frappe.get_value("Employee", {"user_id": "employee@proofsubmission.com"}, "name"), + "payroll_period": "Test Payroll Period", + "tax_exemption_proofs": [ + dict( + exemption_sub_category="_Test Sub Category", + type_of_proof="Test Proof", + exemption_category="_Test Category", + amount=150000, + ) + ], + } + ) + self.assertRaises(frappe.ValidationError, proof.save) + proof = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Proof Submission", + "payroll_period": "Test Payroll Period", + "employee": frappe.get_value("Employee", {"user_id": "employee@proofsubmission.com"}, "name"), + "tax_exemption_proofs": [ + dict( + exemption_sub_category="_Test Sub Category", + type_of_proof="Test Proof", + exemption_category="_Test Category", + amount=100000, + ) + ], + } + ) + self.assertTrue(proof.save) + self.assertTrue(proof.submit) def test_duplicate_category_in_proof_submission(self): - declaration = frappe.get_doc({ - "doctype": "Employee Tax Exemption Proof Submission", - "employee": frappe.get_value("Employee", {"user_id":"employee@proofsubmission.com"}, "name"), - "payroll_period": "Test Payroll Period", - "tax_exemption_proofs": [dict(exemption_sub_category = "_Test Sub Category", - exemption_category = "_Test Category", - type_of_proof = "Test Proof", - amount = 100000), - dict(exemption_sub_category = "_Test Sub Category", - exemption_category = "_Test Category", - amount = 50000), - ] - }) - self.assertRaises(frappe.ValidationError, declaration.save) + proof = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Proof Submission", + "employee": frappe.get_value("Employee", {"user_id": "employee@proofsubmission.com"}, "name"), + "payroll_period": "Test Payroll Period", + "tax_exemption_proofs": [ + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + type_of_proof="Test Proof", + amount=100000, + ), + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + amount=50000, + ), + ], + } + ) + self.assertRaises(frappe.ValidationError, proof.save) + + def test_india_hra_exemption(self): + # set country + current_country = frappe.flags.country + frappe.flags.country = "India" + + employee = frappe.get_value("Employee", {"user_id": "employee@proofsubmission.com"}, "name") + setup_hra_exemption_prerequisites("Monthly", employee) + payroll_period = frappe.db.get_value( + "Payroll Period", "_Test Payroll Period", ["start_date", "end_date"], as_dict=True + ) + + proof = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Proof Submission", + "employee": employee, + "company": "_Test Company", + "payroll_period": "_Test Payroll Period", + "currency": "INR", + "house_rent_payment_amount": 600000, + "rented_in_metro_city": 1, + "rented_from_date": payroll_period.start_date, + "rented_to_date": payroll_period.end_date, + "tax_exemption_proofs": [ + dict( + exemption_sub_category="_Test Sub Category", + exemption_category="_Test Category", + type_of_proof="Test Proof", + amount=100000, + ), + dict( + exemption_sub_category="_Test1 Sub Category", + exemption_category="_Test Category", + type_of_proof="Test Proof", + amount=50000, + ), + ], + } + ).insert() + + self.assertEqual(proof.monthly_house_rent, 50000) + + # Monthly HRA received = 3000 + # should set HRA exemption as per actual annual HRA because that's the minimum + self.assertEqual(proof.monthly_hra_exemption, 3000) + self.assertEqual(proof.total_eligible_hra_exemption, 36000) + + # total exemptions + house rent payment amount + self.assertEqual(proof.total_actual_amount, 750000) + + # 100000 Standard Exemption + 36000 HRA exemption + self.assertEqual(proof.exemption_amount, 136000) + + # reset + frappe.flags.country = current_country diff --git a/erpnext/payroll/doctype/employee_tax_exemption_sub_category/employee_tax_exemption_sub_category.py b/erpnext/payroll/doctype/employee_tax_exemption_sub_category/employee_tax_exemption_sub_category.py index 4ac11f7112d..fb75d6706c3 100644 --- a/erpnext/payroll/doctype/employee_tax_exemption_sub_category/employee_tax_exemption_sub_category.py +++ b/erpnext/payroll/doctype/employee_tax_exemption_sub_category/employee_tax_exemption_sub_category.py @@ -10,7 +10,12 @@ from frappe.utils import flt class EmployeeTaxExemptionSubCategory(Document): def validate(self): - category_max_amount = frappe.db.get_value("Employee Tax Exemption Category", self.exemption_category, "max_amount") + category_max_amount = frappe.db.get_value( + "Employee Tax Exemption Category", self.exemption_category, "max_amount" + ) if flt(self.max_amount) > flt(category_max_amount): - frappe.throw(_("Max Exemption Amount cannot be greater than maximum exemption amount {0} of Tax Exemption Category {1}") - .format(category_max_amount, self.exemption_category)) + frappe.throw( + _( + "Max Exemption Amount cannot be greater than maximum exemption amount {0} of Tax Exemption Category {1}" + ).format(category_max_amount, self.exemption_category) + ) diff --git a/erpnext/payroll/doctype/gratuity/gratuity.json b/erpnext/payroll/doctype/gratuity/gratuity.json index 5cffd7eebf9..0d823cac06c 100644 --- a/erpnext/payroll/doctype/gratuity/gratuity.json +++ b/erpnext/payroll/doctype/gratuity/gratuity.json @@ -90,9 +90,8 @@ "fieldtype": "Select", "in_list_view": 1, "label": "Status", - "options": "Draft\nUnpaid\nPaid", - "read_only": 1, - "reqd": 1 + "options": "Draft\nUnpaid\nPaid\nSubmitted\nCancelled", + "read_only": 1 }, { "depends_on": "eval: doc.pay_via_salary_slip == 0", @@ -196,7 +195,7 @@ "index_web_pages_for_search": 1, "is_submittable": 1, "links": [], - "modified": "2020-11-02 18:21:11.971488", + "modified": "2022-05-27 13:56:14.349183", "modified_by": "Administrator", "module": "Payroll", "name": "Gratuity", diff --git a/erpnext/payroll/doctype/gratuity/gratuity.py b/erpnext/payroll/doctype/gratuity/gratuity.py index 939634a9310..91740ae8c6c 100644 --- a/erpnext/payroll/doctype/gratuity/gratuity.py +++ b/erpnext/payroll/doctype/gratuity/gratuity.py @@ -27,7 +27,7 @@ class Gratuity(AccountsController): self.create_gl_entries() def on_cancel(self): - self.ignore_linked_doctypes = ['GL Entry'] + self.ignore_linked_doctypes = ["GL Entry"] self.create_gl_entries(cancel=True) def create_gl_entries(self, cancel=False): @@ -39,28 +39,34 @@ class Gratuity(AccountsController): # payable entry if self.amount: gl_entry.append( - self.get_gl_dict({ - "account": self.payable_account, - "credit": self.amount, - "credit_in_account_currency": self.amount, - "against": self.expense_account, - "party_type": "Employee", - "party": self.employee, - "against_voucher_type": self.doctype, - "against_voucher": self.name, - "cost_center": self.cost_center - }, item=self) + self.get_gl_dict( + { + "account": self.payable_account, + "credit": self.amount, + "credit_in_account_currency": self.amount, + "against": self.expense_account, + "party_type": "Employee", + "party": self.employee, + "against_voucher_type": self.doctype, + "against_voucher": self.name, + "cost_center": self.cost_center, + }, + item=self, + ) ) # expense entries gl_entry.append( - self.get_gl_dict({ - "account": self.expense_account, - "debit": self.amount, - "debit_in_account_currency": self.amount, - "against": self.payable_account, - "cost_center": self.cost_center - }, item=self) + self.get_gl_dict( + { + "account": self.expense_account, + "debit": self.amount, + "debit_in_account_currency": self.amount, + "against": self.payable_account, + "cost_center": self.cost_center, + }, + item=self, + ) ) else: frappe.throw(_("Total Amount can not be zero")) @@ -69,7 +75,7 @@ class Gratuity(AccountsController): def create_additional_salary(self): if self.pay_via_salary_slip: - additional_salary = frappe.new_doc('Additional Salary') + additional_salary = frappe.new_doc("Additional Salary") additional_salary.employee = self.employee additional_salary.salary_component = self.salary_component additional_salary.overwrite_salary_structure_amount = 0 @@ -81,19 +87,22 @@ class Gratuity(AccountsController): additional_salary.submit() def set_total_advance_paid(self): - paid_amount = frappe.db.sql(""" + paid_amount = frappe.db.sql( + """ select ifnull(sum(debit_in_account_currency), 0) as paid_amount from `tabGL Entry` where against_voucher_type = 'Gratuity' and against_voucher = %s and party_type = 'Employee' and party = %s - """, (self.name, self.employee), as_dict=1)[0].paid_amount + """, + (self.name, self.employee), + as_dict=1, + )[0].paid_amount if flt(paid_amount) > self.amount: frappe.throw(_("Row {0}# Paid Amount cannot be greater than Total amount")) - self.db_set("paid_amount", paid_amount) if self.amount == self.paid_amount: self.db_set("status", "Paid") @@ -104,69 +113,97 @@ def calculate_work_experience_and_amount(employee, gratuity_rule): current_work_experience = calculate_work_experience(employee, gratuity_rule) or 0 gratuity_amount = calculate_gratuity_amount(employee, gratuity_rule, current_work_experience) or 0 - return {'current_work_experience': current_work_experience, "amount": gratuity_amount} + return {"current_work_experience": current_work_experience, "amount": gratuity_amount} + def calculate_work_experience(employee, gratuity_rule): - total_working_days_per_year, minimum_year_for_gratuity = frappe.db.get_value("Gratuity Rule", gratuity_rule, ["total_working_days_per_year", "minimum_year_for_gratuity"]) + total_working_days_per_year, minimum_year_for_gratuity = frappe.db.get_value( + "Gratuity Rule", gratuity_rule, ["total_working_days_per_year", "minimum_year_for_gratuity"] + ) - date_of_joining, relieving_date = frappe.db.get_value('Employee', employee, ['date_of_joining', 'relieving_date']) + date_of_joining, relieving_date = frappe.db.get_value( + "Employee", employee, ["date_of_joining", "relieving_date"] + ) if not relieving_date: - frappe.throw(_("Please set Relieving Date for employee: {0}").format(bold(get_link_to_form("Employee", employee)))) + frappe.throw( + _("Please set Relieving Date for employee: {0}").format( + bold(get_link_to_form("Employee", employee)) + ) + ) - method = frappe.db.get_value("Gratuity Rule", gratuity_rule, "work_experience_calculation_function") - employee_total_workings_days = calculate_employee_total_workings_days(employee, date_of_joining, relieving_date) + method = frappe.db.get_value( + "Gratuity Rule", gratuity_rule, "work_experience_calculation_function" + ) + employee_total_workings_days = calculate_employee_total_workings_days( + employee, date_of_joining, relieving_date + ) - current_work_experience = employee_total_workings_days/total_working_days_per_year or 1 - current_work_experience = get_work_experience_using_method(method, current_work_experience, minimum_year_for_gratuity, employee) + current_work_experience = employee_total_workings_days / total_working_days_per_year or 1 + current_work_experience = get_work_experience_using_method( + method, current_work_experience, minimum_year_for_gratuity, employee + ) return current_work_experience -def calculate_employee_total_workings_days(employee, date_of_joining, relieving_date ): + +def calculate_employee_total_workings_days(employee, date_of_joining, relieving_date): employee_total_workings_days = (get_datetime(relieving_date) - get_datetime(date_of_joining)).days payroll_based_on = frappe.db.get_value("Payroll Settings", None, "payroll_based_on") or "Leave" if payroll_based_on == "Leave": total_lwp = get_non_working_days(employee, relieving_date, "On Leave") employee_total_workings_days -= total_lwp - elif payroll_based_on == "Attendance": + elif payroll_based_on == "Attendance": total_absents = get_non_working_days(employee, relieving_date, "Absent") employee_total_workings_days -= total_absents return employee_total_workings_days -def get_work_experience_using_method(method, current_work_experience, minimum_year_for_gratuity, employee): + +def get_work_experience_using_method( + method, current_work_experience, minimum_year_for_gratuity, employee +): if method == "Round off Work Experience": current_work_experience = round(current_work_experience) else: current_work_experience = floor(current_work_experience) if current_work_experience < minimum_year_for_gratuity: - frappe.throw(_("Employee: {0} have to complete minimum {1} years for gratuity").format(bold(employee), minimum_year_for_gratuity)) + frappe.throw( + _("Employee: {0} have to complete minimum {1} years for gratuity").format( + bold(employee), minimum_year_for_gratuity + ) + ) return current_work_experience + def get_non_working_days(employee, relieving_date, status): - filters={ - "docstatus": 1, - "status": status, - "employee": employee, - "attendance_date": ("<=", get_datetime(relieving_date)) - } + filters = { + "docstatus": 1, + "status": status, + "employee": employee, + "attendance_date": ("<=", get_datetime(relieving_date)), + } if status == "On Leave": - lwp_leave_types = frappe.get_list("Leave Type", filters = {"is_lwp":1}) + lwp_leave_types = frappe.get_list("Leave Type", filters={"is_lwp": 1}) lwp_leave_types = [leave_type.name for leave_type in lwp_leave_types] - filters["leave_type"] = ("IN", lwp_leave_types) + filters["leave_type"] = ("IN", lwp_leave_types) - - record = frappe.get_all("Attendance", filters=filters, fields = ["COUNT(name) as total_lwp"]) + record = frappe.get_all("Attendance", filters=filters, fields=["COUNT(name) as total_lwp"]) return record[0].total_lwp if len(record) else 0 + def calculate_gratuity_amount(employee, gratuity_rule, experience): applicable_earnings_component = get_applicable_components(gratuity_rule) - total_applicable_components_amount = get_total_applicable_component_amount(employee, applicable_earnings_component, gratuity_rule) + total_applicable_components_amount = get_total_applicable_component_amount( + employee, applicable_earnings_component, gratuity_rule + ) - calculate_gratuity_amount_based_on = frappe.db.get_value("Gratuity Rule", gratuity_rule, "calculate_gratuity_amount_based_on") + calculate_gratuity_amount_based_on = frappe.db.get_value( + "Gratuity Rule", gratuity_rule, "calculate_gratuity_amount_based_on" + ) gratuity_amount = 0 slabs = get_gratuity_rule_slabs(gratuity_rule) slab_found = False @@ -174,49 +211,78 @@ def calculate_gratuity_amount(employee, gratuity_rule, experience): for slab in slabs: if calculate_gratuity_amount_based_on == "Current Slab": - slab_found, gratuity_amount = calculate_amount_based_on_current_slab(slab.from_year, slab.to_year, - experience, total_applicable_components_amount, slab.fraction_of_applicable_earnings) + slab_found, gratuity_amount = calculate_amount_based_on_current_slab( + slab.from_year, + slab.to_year, + experience, + total_applicable_components_amount, + slab.fraction_of_applicable_earnings, + ) if slab_found: - break + break elif calculate_gratuity_amount_based_on == "Sum of all previous slabs": if slab.to_year == 0 and slab.from_year == 0: - gratuity_amount += year_left * total_applicable_components_amount * slab.fraction_of_applicable_earnings + gratuity_amount += ( + year_left * total_applicable_components_amount * slab.fraction_of_applicable_earnings + ) slab_found = True break - if experience > slab.to_year and experience > slab.from_year and slab.to_year !=0: - gratuity_amount += (slab.to_year - slab.from_year) * total_applicable_components_amount * slab.fraction_of_applicable_earnings - year_left -= (slab.to_year - slab.from_year) + if experience > slab.to_year and experience > slab.from_year and slab.to_year != 0: + gratuity_amount += ( + (slab.to_year - slab.from_year) + * total_applicable_components_amount + * slab.fraction_of_applicable_earnings + ) + year_left -= slab.to_year - slab.from_year slab_found = True elif slab.from_year <= experience and (experience < slab.to_year or slab.to_year == 0): - gratuity_amount += year_left * total_applicable_components_amount * slab.fraction_of_applicable_earnings + gratuity_amount += ( + year_left * total_applicable_components_amount * slab.fraction_of_applicable_earnings + ) slab_found = True if not slab_found: - frappe.throw(_("No Suitable Slab found for Calculation of gratuity amount in Gratuity Rule: {0}").format(bold(gratuity_rule))) + frappe.throw( + _("No Suitable Slab found for Calculation of gratuity amount in Gratuity Rule: {0}").format( + bold(gratuity_rule) + ) + ) return gratuity_amount + def get_applicable_components(gratuity_rule): - applicable_earnings_component = frappe.get_all("Gratuity Applicable Component", filters= {'parent': gratuity_rule}, fields=["salary_component"]) + applicable_earnings_component = frappe.get_all( + "Gratuity Applicable Component", filters={"parent": gratuity_rule}, fields=["salary_component"] + ) if len(applicable_earnings_component) == 0: - frappe.throw(_("No Applicable Earnings Component found for Gratuity Rule: {0}").format(bold(get_link_to_form("Gratuity Rule",gratuity_rule)))) - applicable_earnings_component = [component.salary_component for component in applicable_earnings_component] + frappe.throw( + _("No Applicable Earnings Component found for Gratuity Rule: {0}").format( + bold(get_link_to_form("Gratuity Rule", gratuity_rule)) + ) + ) + applicable_earnings_component = [ + component.salary_component for component in applicable_earnings_component + ] return applicable_earnings_component + def get_total_applicable_component_amount(employee, applicable_earnings_component, gratuity_rule): - sal_slip = get_last_salary_slip(employee) + sal_slip = get_last_salary_slip(employee) if not sal_slip: frappe.throw(_("No Salary Slip is found for Employee: {0}").format(bold(employee))) - component_and_amounts = frappe.get_all("Salary Detail", + component_and_amounts = frappe.get_all( + "Salary Detail", filters={ "docstatus": 1, - 'parent': sal_slip, + "parent": sal_slip, "parentfield": "earnings", - 'salary_component': ('in', applicable_earnings_component) + "salary_component": ("in", applicable_earnings_component), }, - fields=["amount"]) + fields=["amount"], + ) total_applicable_components_amount = 0 if not len(component_and_amounts): frappe.throw(_("No Applicable Component is present in last month salary slip")) @@ -224,30 +290,44 @@ def get_total_applicable_component_amount(employee, applicable_earnings_componen total_applicable_components_amount += data.amount return total_applicable_components_amount -def calculate_amount_based_on_current_slab(from_year, to_year, experience, total_applicable_components_amount, fraction_of_applicable_earnings): - slab_found = False; gratuity_amount = 0 + +def calculate_amount_based_on_current_slab( + from_year, + to_year, + experience, + total_applicable_components_amount, + fraction_of_applicable_earnings, +): + slab_found = False + gratuity_amount = 0 if experience >= from_year and (to_year == 0 or experience < to_year): - gratuity_amount = total_applicable_components_amount * experience * fraction_of_applicable_earnings + gratuity_amount = ( + total_applicable_components_amount * experience * fraction_of_applicable_earnings + ) if fraction_of_applicable_earnings: slab_found = True return slab_found, gratuity_amount + def get_gratuity_rule_slabs(gratuity_rule): - return frappe.get_all("Gratuity Rule Slab", filters= {'parent': gratuity_rule}, fields = ["*"], order_by="idx") + return frappe.get_all( + "Gratuity Rule Slab", filters={"parent": gratuity_rule}, fields=["*"], order_by="idx" + ) + def get_salary_structure(employee): - return frappe.get_list("Salary Structure Assignment", filters = { - "employee": employee, 'docstatus': 1 - }, + return frappe.get_list( + "Salary Structure Assignment", + filters={"employee": employee, "docstatus": 1}, fields=["from_date", "salary_structure"], - order_by = "from_date desc")[0].salary_structure + order_by="from_date desc", + )[0].salary_structure + def get_last_salary_slip(employee): - salary_slips = frappe.get_list("Salary Slip", filters = { - "employee": employee, 'docstatus': 1 - }, - order_by = "start_date desc" + salary_slips = frappe.get_list( + "Salary Slip", filters={"employee": employee, "docstatus": 1}, order_by="start_date desc" ) if not salary_slips: return diff --git a/erpnext/payroll/doctype/gratuity/gratuity_dashboard.py b/erpnext/payroll/doctype/gratuity/gratuity_dashboard.py index 6c3cdfda512..35ae1f4feaf 100644 --- a/erpnext/payroll/doctype/gratuity/gratuity_dashboard.py +++ b/erpnext/payroll/doctype/gratuity/gratuity_dashboard.py @@ -1,21 +1,14 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'reference_name', - 'non_standard_fieldnames': { - 'Additional Salary': 'ref_docname', + "fieldname": "reference_name", + "non_standard_fieldnames": { + "Additional Salary": "ref_docname", }, - 'transactions': [ - { - 'label': _('Payment'), - 'items': ['Payment Entry'] - }, - { - 'label': _('Additional Salary'), - 'items': ['Additional Salary'] - } - ] + "transactions": [ + {"label": _("Payment"), "items": ["Payment Entry"]}, + {"label": _("Additional Salary"), "items": ["Additional Salary"]}, + ], } diff --git a/erpnext/payroll/doctype/gratuity/gratuity_list.js b/erpnext/payroll/doctype/gratuity/gratuity_list.js new file mode 100644 index 00000000000..20e3d5b4e52 --- /dev/null +++ b/erpnext/payroll/doctype/gratuity/gratuity_list.js @@ -0,0 +1,12 @@ +frappe.listview_settings["Gratuity"] = { + get_indicator: function(doc) { + let status_color = { + "Draft": "red", + "Submitted": "blue", + "Cancelled": "red", + "Paid": "green", + "Unpaid": "orange", + }; + return [__(doc.status), status_color[doc.status], "status,=,"+doc.status]; + } +}; \ No newline at end of file diff --git a/erpnext/payroll/doctype/gratuity/test_gratuity.py b/erpnext/payroll/doctype/gratuity/test_gratuity.py index 098d71c8f80..67313feb5a2 100644 --- a/erpnext/payroll/doctype/gratuity/test_gratuity.py +++ b/erpnext/payroll/doctype/gratuity/test_gratuity.py @@ -4,125 +4,155 @@ import unittest import frappe -from frappe.utils import add_days, flt, get_datetime, getdate +from frappe.tests.utils import FrappeTestCase +from frappe.utils import add_days, add_months, floor, flt, get_datetime, get_first_day, getdate from erpnext.hr.doctype.employee.test_employee import make_employee from erpnext.hr.doctype.expense_claim.test_expense_claim import get_payable_account +from erpnext.hr.doctype.holiday_list.test_holiday_list import set_holiday_list from erpnext.payroll.doctype.gratuity.gratuity import get_last_salary_slip from erpnext.payroll.doctype.salary_slip.test_salary_slip import ( make_deduction_salary_component, make_earning_salary_component, make_employee_salary_slip, + make_holiday_list, ) +from erpnext.payroll.doctype.salary_structure.salary_structure import make_salary_slip from erpnext.regional.united_arab_emirates.setup import create_gratuity_rule test_dependencies = ["Salary Component", "Salary Slip", "Account"] -class TestGratuity(unittest.TestCase): - @classmethod - def setUpClass(cls): - make_earning_salary_component(setup=True, test_tax=True, company_list=['_Test Company']) - make_deduction_salary_component(setup=True, test_tax=True, company_list=['_Test Company']) + +class TestGratuity(FrappeTestCase): def setUp(self): - frappe.db.sql("DELETE FROM `tabGratuity`") - frappe.db.sql("DELETE FROM `tabAdditional Salary` WHERE ref_doctype = 'Gratuity'") + frappe.db.delete("Gratuity") + frappe.db.delete("Salary Slip") + frappe.db.delete("Additional Salary", {"ref_doctype": "Gratuity"}) + make_earning_salary_component( + setup=True, test_tax=True, company_list=["_Test Company"], include_flexi_benefits=True + ) + make_deduction_salary_component(setup=True, test_tax=True, company_list=["_Test Company"]) + make_holiday_list() + + @set_holiday_list("Salary Slip Test Holiday List", "_Test Company") def test_get_last_salary_slip_should_return_none_for_new_employee(self): - new_employee = make_employee("new_employee@salary.com", company='_Test Company') + new_employee = make_employee("new_employee@salary.com", company="_Test Company") salary_slip = get_last_salary_slip(new_employee) - assert salary_slip is None + self.assertIsNone(salary_slip) - def test_check_gratuity_amount_based_on_current_slab_and_additional_salary_creation(self): - employee, sal_slip = create_employee_and_get_last_salary_slip() + @set_holiday_list("Salary Slip Test Holiday List", "_Test Company") + def test_gratuity_based_on_current_slab_via_additional_salary(self): + """ + Range | Fraction + 5-0 | 1 + """ + doj = add_days(getdate(), -(6 * 365)) + relieving_date = getdate() + + employee = make_employee( + "test_employee_gratuity@salary.com", + company="_Test Company", + date_of_joining=doj, + relieving_date=relieving_date, + ) + sal_slip = create_salary_slip("test_employee_gratuity@salary.com") rule = get_gratuity_rule("Rule Under Unlimited Contract on termination (UAE)") - gratuity = create_gratuity(pay_via_salary_slip = 1, employee=employee, rule=rule.name) + gratuity = create_gratuity(pay_via_salary_slip=1, employee=employee, rule=rule.name) - #work experience calculation - date_of_joining, relieving_date = frappe.db.get_value('Employee', employee, ['date_of_joining', 'relieving_date']) - employee_total_workings_days = (get_datetime(relieving_date) - get_datetime(date_of_joining)).days - - experience = employee_total_workings_days/rule.total_working_days_per_year - gratuity.reload() - from math import floor - self.assertEqual(floor(experience), gratuity.current_work_experience) - - #amount Calculation - component_amount = frappe.get_all("Salary Detail", - filters={ - "docstatus": 1, - 'parent': sal_slip, - "parentfield": "earnings", - 'salary_component': "Basic Salary" - }, - fields=["amount"]) - - ''' 5 - 0 fraction is 1 ''' + # work experience calculation + employee_total_workings_days = (get_datetime(relieving_date) - get_datetime(doj)).days + experience = floor(employee_total_workings_days / rule.total_working_days_per_year) + self.assertEqual(gratuity.current_work_experience, experience) + # amount calculation + component_amount = frappe.get_all( + "Salary Detail", + filters={ + "docstatus": 1, + "parent": sal_slip, + "parentfield": "earnings", + "salary_component": "Basic Salary", + }, + fields=["amount"], + limit=1, + ) gratuity_amount = component_amount[0].amount * experience - gratuity.reload() - self.assertEqual(flt(gratuity_amount, 2), flt(gratuity.amount, 2)) - #additional salary creation (Pay via salary slip) + # additional salary creation (Pay via salary slip) self.assertTrue(frappe.db.exists("Additional Salary", {"ref_docname": gratuity.name})) - def test_check_gratuity_amount_based_on_all_previous_slabs(self): - employee, sal_slip = create_employee_and_get_last_salary_slip() + # gratuity should be marked "Paid" on the next salary slip submission + salary_slip = make_salary_slip("Test Gratuity", employee=employee) + salary_slip.posting_date = getdate() + salary_slip.insert() + salary_slip.submit() + + gratuity.reload() + self.assertEqual(gratuity.status, "Paid") + + @set_holiday_list("Salary Slip Test Holiday List", "_Test Company") + def test_gratuity_based_on_all_previous_slabs_via_payment_entry(self): + """ + Range | Fraction + 0-1 | 0 + 1-5 | 0.7 + 5-0 | 1 + """ + from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry + + doj = add_days(getdate(), -(6 * 365)) + relieving_date = getdate() + + employee = make_employee( + "test_employee_gratuity@salary.com", + company="_Test Company", + date_of_joining=doj, + relieving_date=relieving_date, + ) + + sal_slip = create_salary_slip("test_employee_gratuity@salary.com") rule = get_gratuity_rule("Rule Under Limited Contract (UAE)") set_mode_of_payment_account() - gratuity = create_gratuity(expense_account = 'Payment Account - _TC', mode_of_payment='Cash', employee=employee) + gratuity = create_gratuity( + expense_account="Payment Account - _TC", mode_of_payment="Cash", employee=employee + ) - #work experience calculation - date_of_joining, relieving_date = frappe.db.get_value('Employee', employee, ['date_of_joining', 'relieving_date']) - employee_total_workings_days = (get_datetime(relieving_date) - get_datetime(date_of_joining)).days + # work experience calculation + employee_total_workings_days = (get_datetime(relieving_date) - get_datetime(doj)).days + experience = floor(employee_total_workings_days / rule.total_working_days_per_year) + self.assertEqual(gratuity.current_work_experience, experience) - experience = employee_total_workings_days/rule.total_working_days_per_year - - gratuity.reload() - - from math import floor - - self.assertEqual(floor(experience), gratuity.current_work_experience) - - #amount Calculation - component_amount = frappe.get_all("Salary Detail", - filters={ - "docstatus": 1, - 'parent': sal_slip, - "parentfield": "earnings", - 'salary_component': "Basic Salary" - }, - fields=["amount"]) - - ''' range | Fraction - 0-1 | 0 - 1-5 | 0.7 - 5-0 | 1 - ''' - - gratuity_amount = ((0 * 1) + (4 * 0.7) + (1 * 1)) * component_amount[0].amount - gratuity.reload() + # amount calculation + component_amount = frappe.get_all( + "Salary Detail", + filters={ + "docstatus": 1, + "parent": sal_slip, + "parentfield": "earnings", + "salary_component": "Basic Salary", + }, + fields=["amount"], + limit=1, + ) + gratuity_amount = ((0 * 1) + (4 * 0.7) + (1 * 1)) * component_amount[0].amount self.assertEqual(flt(gratuity_amount, 2), flt(gratuity.amount, 2)) self.assertEqual(gratuity.status, "Unpaid") - from erpnext.accounts.doctype.payment_entry.payment_entry import get_payment_entry - pay_entry = get_payment_entry("Gratuity", gratuity.name) - pay_entry.reference_no = "123467" - pay_entry.reference_date = getdate() - pay_entry.save() - pay_entry.submit() + pe = get_payment_entry("Gratuity", gratuity.name) + pe.reference_no = "123467" + pe.reference_date = getdate() + pe.submit() + gratuity.reload() - self.assertEqual(gratuity.status, "Paid") - self.assertEqual(flt(gratuity.paid_amount,2), flt(gratuity.amount, 2)) + self.assertEqual(flt(gratuity.paid_amount, 2), flt(gratuity.amount, 2)) - def tearDown(self): - frappe.db.sql("DELETE FROM `tabGratuity`") - frappe.db.sql("DELETE FROM `tabAdditional Salary` WHERE ref_doctype = 'Gratuity'") def get_gratuity_rule(name): rule = frappe.db.exists("Gratuity Rule", name) @@ -130,14 +160,12 @@ def get_gratuity_rule(name): create_gratuity_rule() rule = frappe.get_doc("Gratuity Rule", name) rule.applicable_earnings_component = [] - rule.append("applicable_earnings_component", { - "salary_component": "Basic Salary" - }) + rule.append("applicable_earnings_component", {"salary_component": "Basic Salary"}) rule.save() - rule.reload() return rule + def create_gratuity(**args): if args: args = frappe._dict(args) @@ -150,15 +178,16 @@ def create_gratuity(**args): gratuity.payroll_date = getdate() gratuity.salary_component = "Performance Bonus" else: - gratuity.expense_account = args.expense_account or 'Payment Account - _TC' + gratuity.expense_account = args.expense_account or "Payment Account - _TC" gratuity.payable_account = args.payable_account or get_payable_account("_Test Company") - gratuity.mode_of_payment = args.mode_of_payment or 'Cash' + gratuity.mode_of_payment = args.mode_of_payment or "Cash" gratuity.save() gratuity.submit() return gratuity + def set_mode_of_payment_account(): if not frappe.db.exists("Account", "Payment Account - _TC"): mode_of_payment = create_account() @@ -166,14 +195,15 @@ def set_mode_of_payment_account(): mode_of_payment = frappe.get_doc("Mode of Payment", "Cash") mode_of_payment.accounts = [] - mode_of_payment.append("accounts", { - "company": "_Test Company", - "default_account": "_Test Bank - _TC" - }) + mode_of_payment.append( + "accounts", {"company": "_Test Company", "default_account": "_Test Bank - _TC"} + ) mode_of_payment.save() + def create_account(): - return frappe.get_doc({ + return frappe.get_doc( + { "doctype": "Account", "company": "_Test Company", "account_name": "Payment Account", @@ -182,22 +212,21 @@ def create_account(): "currency": "INR", "parent_account": "Bank Accounts - _TC", "account_type": "Bank", - }).insert(ignore_permissions=True) + } + ).insert(ignore_permissions=True) -def create_employee_and_get_last_salary_slip(): - employee = make_employee("test_employee@salary.com", company='_Test Company') - frappe.db.set_value("Employee", employee, "relieving_date", getdate()) - frappe.db.set_value("Employee", employee, "date_of_joining", add_days(getdate(), - (6*365))) - if not frappe.db.exists("Salary Slip", {"employee":employee}): - salary_slip = make_employee_salary_slip("test_employee@salary.com", "Monthly") + +def create_salary_slip(employee): + if not frappe.db.exists("Salary Slip", {"employee": employee}): + posting_date = get_first_day(add_months(getdate(), -1)) + salary_slip = make_employee_salary_slip( + employee, "Monthly", "Test Gratuity", posting_date=posting_date + ) + salary_slip.start_date = posting_date + salary_slip.end_date = None salary_slip.submit() salary_slip = salary_slip.name else: salary_slip = get_last_salary_slip(employee) - if not frappe.db.get_value("Employee", "test_employee@salary.com", "holiday_list"): - from erpnext.payroll.doctype.salary_slip.test_salary_slip import make_holiday_list - make_holiday_list() - frappe.db.set_value("Company", '_Test Company', "default_holiday_list", "Salary Slip Test Holiday List") - - return employee, salary_slip + return salary_slip diff --git a/erpnext/payroll/doctype/gratuity_rule/gratuity_rule.py b/erpnext/payroll/doctype/gratuity_rule/gratuity_rule.py index d30cfc64848..5cde79a1627 100644 --- a/erpnext/payroll/doctype/gratuity_rule/gratuity_rule.py +++ b/erpnext/payroll/doctype/gratuity_rule/gratuity_rule.py @@ -8,25 +8,34 @@ from frappe.model.document import Document class GratuityRule(Document): - def validate(self): for current_slab in self.gratuity_rule_slabs: if (current_slab.from_year > current_slab.to_year) and current_slab.to_year != 0: - frappe.throw(_("Row {0}: From (Year) can not be greater than To (Year)").format(current_slab.idx)) + frappe.throw( + _("Row {0}: From (Year) can not be greater than To (Year)").format(current_slab.idx) + ) + + if ( + current_slab.to_year == 0 and current_slab.from_year == 0 and len(self.gratuity_rule_slabs) > 1 + ): + frappe.throw( + _("You can not define multiple slabs if you have a slab with no lower and upper limits.") + ) - if current_slab.to_year == 0 and current_slab.from_year == 0 and len(self.gratuity_rule_slabs) > 1: - frappe.throw(_("You can not define multiple slabs if you have a slab with no lower and upper limits.")) def get_gratuity_rule(name, slabs, **args): args = frappe._dict(args) rule = frappe.new_doc("Gratuity Rule") rule.name = name - rule.calculate_gratuity_amount_based_on = args.calculate_gratuity_amount_based_on or "Current Slab" - rule.work_experience_calculation_method = args.work_experience_calculation_method or "Take Exact Completed Years" + rule.calculate_gratuity_amount_based_on = ( + args.calculate_gratuity_amount_based_on or "Current Slab" + ) + rule.work_experience_calculation_method = ( + args.work_experience_calculation_method or "Take Exact Completed Years" + ) rule.minimum_year_for_gratuity = 1 - for slab in slabs: slab = frappe._dict(slab) rule.append("gratuity_rule_slabs", slab) diff --git a/erpnext/payroll/doctype/gratuity_rule/gratuity_rule_dashboard.py b/erpnext/payroll/doctype/gratuity_rule/gratuity_rule_dashboard.py index 15e15d13620..fa5a9dedd35 100644 --- a/erpnext/payroll/doctype/gratuity_rule/gratuity_rule_dashboard.py +++ b/erpnext/payroll/doctype/gratuity_rule/gratuity_rule_dashboard.py @@ -1,14 +1,8 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'gratuity_rule', - 'transactions': [ - { - 'label': _('Gratuity'), - 'items': ['Gratuity'] - } - ] + "fieldname": "gratuity_rule", + "transactions": [{"label": _("Gratuity"), "items": ["Gratuity"]}], } diff --git a/erpnext/payroll/doctype/income_tax_slab/income_tax_slab.py b/erpnext/payroll/doctype/income_tax_slab/income_tax_slab.py index 040b2c89353..e62d61f4c2f 100644 --- a/erpnext/payroll/doctype/income_tax_slab/income_tax_slab.py +++ b/erpnext/payroll/doctype/income_tax_slab/income_tax_slab.py @@ -4,7 +4,7 @@ from frappe.model.document import Document -#import frappe +# import frappe import erpnext diff --git a/erpnext/payroll/doctype/payroll_entry/payroll_entry.py b/erpnext/payroll/doctype/payroll_entry/payroll_entry.py index 84c59a2c2b8..5f2af74dca6 100644 --- a/erpnext/payroll/doctype/payroll_entry/payroll_entry.py +++ b/erpnext/payroll/doctype/payroll_entry/payroll_entry.py @@ -15,6 +15,7 @@ from frappe.utils import ( comma_and, date_diff, flt, + get_link_to_form, getdate, ) @@ -28,11 +29,11 @@ from erpnext.hr.doctype.employee.employee import get_holiday_list_for_employee class PayrollEntry(Document): def onload(self): - if not self.docstatus==1 or self.salary_slips_submitted: + if not self.docstatus == 1 or self.salary_slips_submitted: return # check if salary slips were manually submitted - entries = frappe.db.count("Salary Slip", {'payroll_entry': self.name, 'docstatus': 1}, ['name']) + entries = frappe.db.count("Salary Slip", {"payroll_entry": self.name, "docstatus": 1}, ["name"]) if cint(entries) == len(self.employees): self.set_onload("submitted_ss", True) @@ -44,6 +45,7 @@ class PayrollEntry(Document): def before_submit(self): self.validate_employee_details() + self.validate_payroll_payable_account() if self.validate_attendance: if self.validate_employee_attendance(): frappe.throw(_("Cannot Submit, Employees left to mark attendance")) @@ -51,31 +53,59 @@ class PayrollEntry(Document): def validate_employee_details(self): emp_with_sal_slip = [] for employee_details in self.employees: - if frappe.db.exists("Salary Slip", {"employee": employee_details.employee, "start_date": self.start_date, "end_date": self.end_date, "docstatus": 1}): + if frappe.db.exists( + "Salary Slip", + { + "employee": employee_details.employee, + "start_date": self.start_date, + "end_date": self.end_date, + "docstatus": 1, + }, + ): emp_with_sal_slip.append(employee_details.employee) if len(emp_with_sal_slip): frappe.throw(_("Salary Slip already exists for {0}").format(comma_and(emp_with_sal_slip))) + def validate_payroll_payable_account(self): + if frappe.db.get_value("Account", self.payroll_payable_account, "account_type"): + frappe.throw( + _( + "Account type cannot be set for payroll payable account {0}, please remove and try again" + ).format(frappe.bold(get_link_to_form("Account", self.payroll_payable_account))) + ) + def on_cancel(self): - frappe.delete_doc("Salary Slip", frappe.db.sql_list("""select name from `tabSalary Slip` - where payroll_entry=%s """, (self.name))) + frappe.delete_doc( + "Salary Slip", + frappe.db.sql_list( + """select name from `tabSalary Slip` + where payroll_entry=%s """, + (self.name), + ), + ) + self.db_set("salary_slips_created", 0) + self.db_set("salary_slips_submitted", 0) def get_emp_list(self): """ - Returns list of active employees based on selected criteria - and for which salary structure exists + Returns list of active employees based on selected criteria + and for which salary structure exists """ self.check_mandatory() filters = self.make_filters() cond = get_filter_condition(filters) cond += get_joining_relieving_condition(self.start_date, self.end_date) - condition = '' + condition = "" if self.payroll_frequency: - condition = """and payroll_frequency = '%(payroll_frequency)s'"""% {"payroll_frequency": self.payroll_frequency} + condition = """and payroll_frequency = '%(payroll_frequency)s'""" % { + "payroll_frequency": self.payroll_frequency + } - sal_struct = get_sal_struct(self.company, self.currency, self.salary_slip_based_on_timesheet, condition) + sal_struct = get_sal_struct( + self.company, self.currency, self.salary_slip_based_on_timesheet, condition + ) if sal_struct: cond += "and t2.salary_structure IN %(sal_struct)s " cond += "and t2.payroll_payable_account = %(payroll_payable_account)s " @@ -86,20 +116,25 @@ class PayrollEntry(Document): def make_filters(self): filters = frappe._dict() - filters['company'] = self.company - filters['branch'] = self.branch - filters['department'] = self.department - filters['designation'] = self.designation + filters["company"] = self.company + filters["branch"] = self.branch + filters["department"] = self.department + filters["designation"] = self.designation return filters @frappe.whitelist() def fill_employee_details(self): - self.set('employees', []) + self.set("employees", []) employees = self.get_emp_list() if not employees: - error_msg = _("No employees found for the mentioned criteria:Company: {0}
Currency: {1}
Payroll Payable Account: {2}").format( - frappe.bold(self.company), frappe.bold(self.currency), frappe.bold(self.payroll_payable_account)) + error_msg = _( + "No employees found for the mentioned criteria:
Company: {0}
Currency: {1}
Payroll Payable Account: {2}" + ).format( + frappe.bold(self.company), + frappe.bold(self.currency), + frappe.bold(self.payroll_payable_account), + ) if self.branch: error_msg += "
" + _("Branch: {0}").format(frappe.bold(self.branch)) if self.department: @@ -113,38 +148,40 @@ class PayrollEntry(Document): frappe.throw(error_msg, title=_("No employees found")) for d in employees: - self.append('employees', d) + self.append("employees", d) self.number_of_employees = len(self.employees) if self.validate_attendance: return self.validate_employee_attendance() def check_mandatory(self): - for fieldname in ['company', 'start_date', 'end_date']: + for fieldname in ["company", "start_date", "end_date"]: if not self.get(fieldname): frappe.throw(_("Please set {0}").format(self.meta.get_label(fieldname))) @frappe.whitelist() def create_salary_slips(self): """ - Creates salary slip for selected employees if already not created + Creates salary slip for selected employees if already not created """ - self.check_permission('write') + self.check_permission("write") employees = [emp.employee for emp in self.employees] if employees: - args = frappe._dict({ - "salary_slip_based_on_timesheet": self.salary_slip_based_on_timesheet, - "payroll_frequency": self.payroll_frequency, - "start_date": self.start_date, - "end_date": self.end_date, - "company": self.company, - "posting_date": self.posting_date, - "deduct_tax_for_unclaimed_employee_benefits": self.deduct_tax_for_unclaimed_employee_benefits, - "deduct_tax_for_unsubmitted_tax_exemption_proof": self.deduct_tax_for_unsubmitted_tax_exemption_proof, - "payroll_entry": self.name, - "exchange_rate": self.exchange_rate, - "currency": self.currency - }) + args = frappe._dict( + { + "salary_slip_based_on_timesheet": self.salary_slip_based_on_timesheet, + "payroll_frequency": self.payroll_frequency, + "start_date": self.start_date, + "end_date": self.end_date, + "company": self.company, + "posting_date": self.posting_date, + "deduct_tax_for_unclaimed_employee_benefits": self.deduct_tax_for_unclaimed_employee_benefits, + "deduct_tax_for_unsubmitted_tax_exemption_proof": self.deduct_tax_for_unsubmitted_tax_exemption_proof, + "payroll_entry": self.name, + "exchange_rate": self.exchange_rate, + "currency": self.currency, + } + ) if len(employees) > 30: frappe.enqueue(create_salary_slips_for_employees, timeout=600, employees=employees, args=args) else: @@ -154,22 +191,28 @@ class PayrollEntry(Document): def get_sal_slip_list(self, ss_status, as_dict=False): """ - Returns list of salary slips based on selected criteria + Returns list of salary slips based on selected criteria """ - ss_list = frappe.db.sql(""" + ss_list = frappe.db.sql( + """ select t1.name, t1.salary_structure, t1.payroll_cost_center from `tabSalary Slip` t1 where t1.docstatus = %s and t1.start_date >= %s and t1.end_date <= %s and t1.payroll_entry = %s and (t1.journal_entry is null or t1.journal_entry = "") and ifnull(salary_slip_based_on_timesheet,0) = %s - """, (ss_status, self.start_date, self.end_date, self.name, self.salary_slip_based_on_timesheet), as_dict=as_dict) + """, + (ss_status, self.start_date, self.end_date, self.name, self.salary_slip_based_on_timesheet), + as_dict=as_dict, + ) return ss_list @frappe.whitelist() def submit_salary_slips(self): - self.check_permission('write') + self.check_permission("write") ss_list = self.get_sal_slip_list(ss_status=0) if len(ss_list) > 30: - frappe.enqueue(submit_salary_slips_for_employees, timeout=600, payroll_entry=self, salary_slips=ss_list) + frappe.enqueue( + submit_salary_slips_for_employees, timeout=600, payroll_entry=self, salary_slips=ss_list + ) else: submit_salary_slips_for_employees(self, ss_list, publish_progress=False) @@ -179,44 +222,51 @@ class PayrollEntry(Document): ss.email_salary_slip() def get_salary_component_account(self, salary_component): - account = frappe.db.get_value("Salary Component Account", - {"parent": salary_component, "company": self.company}, "account") + account = frappe.db.get_value( + "Salary Component Account", {"parent": salary_component, "company": self.company}, "account" + ) if not account: - frappe.throw(_("Please set account in Salary Component {0}") - .format(salary_component)) + frappe.throw(_("Please set account in Salary Component {0}").format(salary_component)) return account def get_salary_components(self, component_type): - salary_slips = self.get_sal_slip_list(ss_status = 1, as_dict = True) + salary_slips = self.get_sal_slip_list(ss_status=1, as_dict=True) if salary_slips: - salary_components = frappe.db.sql(""" + salary_components = frappe.db.sql( + """ select ssd.salary_component, ssd.amount, ssd.parentfield, ss.payroll_cost_center from `tabSalary Slip` ss, `tabSalary Detail` ssd where ss.name = ssd.parent and ssd.parentfield = '%s' and ss.name in (%s) - """ % (component_type, ', '.join(['%s']*len(salary_slips))), - tuple([d.name for d in salary_slips]), as_dict=True) + """ + % (component_type, ", ".join(["%s"] * len(salary_slips))), + tuple([d.name for d in salary_slips]), + as_dict=True, + ) return salary_components - def get_salary_component_total(self, component_type = None): + def get_salary_component_total(self, component_type=None): salary_components = self.get_salary_components(component_type) if salary_components: component_dict = {} for item in salary_components: add_component_to_accrual_jv_entry = True if component_type == "earnings": - is_flexible_benefit, only_tax_impact = frappe.db.get_value("Salary Component", item['salary_component'], ['is_flexible_benefit', 'only_tax_impact']) - if is_flexible_benefit == 1 and only_tax_impact ==1: + is_flexible_benefit, only_tax_impact = frappe.db.get_value( + "Salary Component", item["salary_component"], ["is_flexible_benefit", "only_tax_impact"] + ) + if is_flexible_benefit == 1 and only_tax_impact == 1: add_component_to_accrual_jv_entry = False if add_component_to_accrual_jv_entry: - component_dict[(item.salary_component, item.payroll_cost_center)] \ - = component_dict.get((item.salary_component, item.payroll_cost_center), 0) + flt(item.amount) - account_details = self.get_account(component_dict = component_dict) + component_dict[(item.salary_component, item.payroll_cost_center)] = component_dict.get( + (item.salary_component, item.payroll_cost_center), 0 + ) + flt(item.amount) + account_details = self.get_account(component_dict=component_dict) return account_details - def get_account(self, component_dict = None): + def get_account(self, component_dict=None): account_dict = {} for key, amount in component_dict.items(): account = self.get_salary_component_account(key[0]) @@ -225,8 +275,8 @@ class PayrollEntry(Document): def make_accrual_jv_entry(self): self.check_permission("write") - earnings = self.get_salary_component_total(component_type = "earnings") or {} - deductions = self.get_salary_component_total(component_type = "deductions") or {} + earnings = self.get_salary_component_total(component_type="earnings") or {} + deductions = self.get_salary_component_total(component_type="deductions") or {} payroll_payable_account = self.payroll_payable_account jv_name = "" precision = frappe.get_precision("Journal Entry Account", "debit_in_account_currency") @@ -234,8 +284,9 @@ class PayrollEntry(Document): if earnings or deductions: journal_entry = frappe.new_doc("Journal Entry") journal_entry.voucher_type = "Journal Entry" - journal_entry.user_remark = _("Accrual Journal Entry for salaries from {0} to {1}")\ - .format(self.start_date, self.end_date) + journal_entry.user_remark = _("Accrual Journal Entry for salaries from {0} to {1}").format( + self.start_date, self.end_date + ) journal_entry.company = self.company journal_entry.posting_date = self.posting_date accounting_dimensions = get_accounting_dimensions() or [] @@ -248,36 +299,57 @@ class PayrollEntry(Document): # Earnings for acc_cc, amount in earnings.items(): - exchange_rate, amt = self.get_amount_and_exchange_rate_for_journal_entry(acc_cc[0], amount, company_currency, currencies) + exchange_rate, amt = self.get_amount_and_exchange_rate_for_journal_entry( + acc_cc[0], amount, company_currency, currencies + ) payable_amount += flt(amount, precision) - accounts.append(self.update_accounting_dimensions({ - "account": acc_cc[0], - "debit_in_account_currency": flt(amt, precision), - "exchange_rate": flt(exchange_rate), - "cost_center": acc_cc[1] or self.cost_center, - "project": self.project - }, accounting_dimensions)) + accounts.append( + self.update_accounting_dimensions( + { + "account": acc_cc[0], + "debit_in_account_currency": flt(amt, precision), + "exchange_rate": flt(exchange_rate), + "cost_center": acc_cc[1] or self.cost_center, + "project": self.project, + }, + accounting_dimensions, + ) + ) # Deductions for acc_cc, amount in deductions.items(): - exchange_rate, amt = self.get_amount_and_exchange_rate_for_journal_entry(acc_cc[0], amount, company_currency, currencies) + exchange_rate, amt = self.get_amount_and_exchange_rate_for_journal_entry( + acc_cc[0], amount, company_currency, currencies + ) payable_amount -= flt(amount, precision) - accounts.append(self.update_accounting_dimensions({ - "account": acc_cc[0], - "credit_in_account_currency": flt(amt, precision), - "exchange_rate": flt(exchange_rate), - "cost_center": acc_cc[1] or self.cost_center, - "project": self.project - }, accounting_dimensions)) + accounts.append( + self.update_accounting_dimensions( + { + "account": acc_cc[0], + "credit_in_account_currency": flt(amt, precision), + "exchange_rate": flt(exchange_rate), + "cost_center": acc_cc[1] or self.cost_center, + "project": self.project, + }, + accounting_dimensions, + ) + ) # Payable amount - exchange_rate, payable_amt = self.get_amount_and_exchange_rate_for_journal_entry(payroll_payable_account, payable_amount, company_currency, currencies) - accounts.append(self.update_accounting_dimensions({ - "account": payroll_payable_account, - "credit_in_account_currency": flt(payable_amt, precision), - "exchange_rate": flt(exchange_rate), - "cost_center": self.cost_center - }, accounting_dimensions)) + exchange_rate, payable_amt = self.get_amount_and_exchange_rate_for_journal_entry( + payroll_payable_account, payable_amount, company_currency, currencies + ) + accounts.append( + self.update_accounting_dimensions( + { + "account": payroll_payable_account, + "credit_in_account_currency": flt(payable_amt, precision), + "exchange_rate": flt(exchange_rate), + "cost_center": self.cost_center, + }, + accounting_dimensions, + ) + ) journal_entry.set("accounts", accounts) if len(currencies) > 1: @@ -289,7 +361,7 @@ class PayrollEntry(Document): try: journal_entry.submit() jv_name = journal_entry.name - self.update_salary_slip_status(jv_name = jv_name) + self.update_salary_slip_status(jv_name=jv_name) except Exception as e: if type(e) in (str, list, tuple): frappe.msgprint(e) @@ -303,10 +375,12 @@ class PayrollEntry(Document): return row - def get_amount_and_exchange_rate_for_journal_entry(self, account, amount, company_currency, currencies): + def get_amount_and_exchange_rate_for_journal_entry( + self, account, amount, company_currency, currencies + ): conversion_rate = 1 exchange_rate = self.exchange_rate - account_currency = frappe.db.get_value('Account', account, 'account_currency') + account_currency = frappe.db.get_value("Account", account, "account_currency") if account_currency not in currencies: currencies.append(account_currency) if account_currency == company_currency: @@ -317,26 +391,45 @@ class PayrollEntry(Document): @frappe.whitelist() def make_payment_entry(self): - self.check_permission('write') + self.check_permission("write") - salary_slip_name_list = frappe.db.sql(""" select t1.name from `tabSalary Slip` t1 + salary_slip_name_list = frappe.db.sql( + """ select t1.name from `tabSalary Slip` t1 where t1.docstatus = 1 and start_date >= %s and end_date <= %s and t1.payroll_entry = %s - """, (self.start_date, self.end_date, self.name), as_list = True) + """, + (self.start_date, self.end_date, self.name), + as_list=True, + ) if salary_slip_name_list and len(salary_slip_name_list) > 0: salary_slip_total = 0 for salary_slip_name in salary_slip_name_list: salary_slip = frappe.get_doc("Salary Slip", salary_slip_name[0]) for sal_detail in salary_slip.earnings: - is_flexible_benefit, only_tax_impact, creat_separate_je, statistical_component = frappe.db.get_value("Salary Component", sal_detail.salary_component, - ['is_flexible_benefit', 'only_tax_impact', 'create_separate_payment_entry_against_benefit_claim', 'statistical_component']) + ( + is_flexible_benefit, + only_tax_impact, + creat_separate_je, + statistical_component, + ) = frappe.db.get_value( + "Salary Component", + sal_detail.salary_component, + [ + "is_flexible_benefit", + "only_tax_impact", + "create_separate_payment_entry_against_benefit_claim", + "statistical_component", + ], + ) if only_tax_impact != 1 and statistical_component != 1: if is_flexible_benefit == 1 and creat_separate_je == 1: self.create_journal_entry(sal_detail.amount, sal_detail.salary_component) else: salary_slip_total += sal_detail.amount for sal_detail in salary_slip.deductions: - statistical_component = frappe.db.get_value("Salary Component", sal_detail.salary_component, 'statistical_component') + statistical_component = frappe.db.get_value( + "Salary Component", sal_detail.salary_component, "statistical_component" + ) if statistical_component != 1: salary_slip_total -= sal_detail.amount if salary_slip_total > 0: @@ -350,92 +443,116 @@ class PayrollEntry(Document): currencies = [] multi_currency = 0 company_currency = erpnext.get_company_currency(self.company) + accounting_dimensions = get_accounting_dimensions() or [] - exchange_rate, amount = self.get_amount_and_exchange_rate_for_journal_entry(self.payment_account, je_payment_amount, company_currency, currencies) - accounts.append({ - "account": self.payment_account, - "bank_account": self.bank_account, - "credit_in_account_currency": flt(amount, precision), - "exchange_rate": flt(exchange_rate), - }) + exchange_rate, amount = self.get_amount_and_exchange_rate_for_journal_entry( + self.payment_account, je_payment_amount, company_currency, currencies + ) + accounts.append( + self.update_accounting_dimensions( + { + "account": self.payment_account, + "bank_account": self.bank_account, + "credit_in_account_currency": flt(amount, precision), + "exchange_rate": flt(exchange_rate), + }, + accounting_dimensions, + ) + ) - exchange_rate, amount = self.get_amount_and_exchange_rate_for_journal_entry(payroll_payable_account, je_payment_amount, company_currency, currencies) - accounts.append({ - "account": payroll_payable_account, - "debit_in_account_currency": flt(amount, precision), - "exchange_rate": flt(exchange_rate), - "reference_type": self.doctype, - "reference_name": self.name - }) + exchange_rate, amount = self.get_amount_and_exchange_rate_for_journal_entry( + payroll_payable_account, je_payment_amount, company_currency, currencies + ) + accounts.append( + self.update_accounting_dimensions( + { + "account": payroll_payable_account, + "debit_in_account_currency": flt(amount, precision), + "exchange_rate": flt(exchange_rate), + "reference_type": self.doctype, + "reference_name": self.name, + }, + accounting_dimensions, + ) + ) if len(currencies) > 1: - multi_currency = 1 + multi_currency = 1 - journal_entry = frappe.new_doc('Journal Entry') - journal_entry.voucher_type = 'Bank Entry' - journal_entry.user_remark = _('Payment of {0} from {1} to {2}')\ - .format(user_remark, self.start_date, self.end_date) + journal_entry = frappe.new_doc("Journal Entry") + journal_entry.voucher_type = "Bank Entry" + journal_entry.user_remark = _("Payment of {0} from {1} to {2}").format( + user_remark, self.start_date, self.end_date + ) journal_entry.company = self.company journal_entry.posting_date = self.posting_date journal_entry.multi_currency = multi_currency journal_entry.set("accounts", accounts) - journal_entry.save(ignore_permissions = True) + journal_entry.save(ignore_permissions=True) - def update_salary_slip_status(self, jv_name = None): + def update_salary_slip_status(self, jv_name=None): ss_list = self.get_sal_slip_list(ss_status=1) for ss in ss_list: - ss_obj = frappe.get_doc("Salary Slip",ss[0]) + ss_obj = frappe.get_doc("Salary Slip", ss[0]) frappe.db.set_value("Salary Slip", ss_obj.name, "journal_entry", jv_name) def set_start_end_dates(self): - self.update(get_start_end_dates(self.payroll_frequency, - self.start_date or self.posting_date, self.company)) + self.update( + get_start_end_dates(self.payroll_frequency, self.start_date or self.posting_date, self.company) + ) @frappe.whitelist() def validate_employee_attendance(self): employees_to_mark_attendance = [] days_in_payroll, days_holiday, days_attendance_marked = 0, 0, 0 for employee_detail in self.employees: - employee_joining_date = frappe.db.get_value("Employee", employee_detail.employee, 'date_of_joining') + employee_joining_date = frappe.db.get_value( + "Employee", employee_detail.employee, "date_of_joining" + ) start_date = self.start_date if employee_joining_date > getdate(self.start_date): start_date = employee_joining_date days_holiday = self.get_count_holidays_of_employee(employee_detail.employee, start_date) - days_attendance_marked = self.get_count_employee_attendance(employee_detail.employee, start_date) + days_attendance_marked = self.get_count_employee_attendance( + employee_detail.employee, start_date + ) days_in_payroll = date_diff(self.end_date, start_date) + 1 if days_in_payroll > days_holiday + days_attendance_marked: - employees_to_mark_attendance.append({ - "employee": employee_detail.employee, - "employee_name": employee_detail.employee_name - }) + employees_to_mark_attendance.append( + {"employee": employee_detail.employee, "employee_name": employee_detail.employee_name} + ) return employees_to_mark_attendance def get_count_holidays_of_employee(self, employee, start_date): holiday_list = get_holiday_list_for_employee(employee) holidays = 0 if holiday_list: - days = frappe.db.sql("""select count(*) from tabHoliday where - parent=%s and holiday_date between %s and %s""", (holiday_list, - start_date, self.end_date)) + days = frappe.db.sql( + """select count(*) from tabHoliday where + parent=%s and holiday_date between %s and %s""", + (holiday_list, start_date, self.end_date), + ) if days and days[0][0]: holidays = days[0][0] return holidays def get_count_employee_attendance(self, employee, start_date): marked_days = 0 - attendances = frappe.get_all("Attendance", - fields = ["count(*)"], - filters = { - "employee": employee, - "attendance_date": ('between', [start_date, self.end_date]) - }, as_list=1) + attendances = frappe.get_all( + "Attendance", + fields=["count(*)"], + filters={"employee": employee, "attendance_date": ("between", [start_date, self.end_date])}, + as_list=1, + ) if attendances and attendances[0][0]: marked_days = attendances[0][0] return marked_days + def get_sal_struct(company, currency, salary_slip_based_on_timesheet, condition): - return frappe.db.sql_list(""" + return frappe.db.sql_list( + """ select name from `tabSalary Structure` where @@ -444,26 +561,40 @@ def get_sal_struct(company, currency, salary_slip_based_on_timesheet, condition) and company = %(company)s and currency = %(currency)s and ifnull(salary_slip_based_on_timesheet,0) = %(salary_slip_based_on_timesheet)s - {condition}""".format(condition=condition), - {"company": company, "currency": currency, "salary_slip_based_on_timesheet": salary_slip_based_on_timesheet}) + {condition}""".format( + condition=condition + ), + { + "company": company, + "currency": currency, + "salary_slip_based_on_timesheet": salary_slip_based_on_timesheet, + }, + ) + def get_filter_condition(filters): - cond = '' - for f in ['company', 'branch', 'department', 'designation']: + cond = "" + for f in ["company", "branch", "department", "designation"]: if filters.get(f): cond += " and t1." + f + " = " + frappe.db.escape(filters.get(f)) return cond + def get_joining_relieving_condition(start_date, end_date): cond = """ and ifnull(t1.date_of_joining, '0000-00-00') <= '%(end_date)s' and ifnull(t1.relieving_date, '2199-12-31') >= '%(start_date)s' - """ % {"start_date": start_date, "end_date": end_date} + """ % { + "start_date": start_date, + "end_date": end_date, + } return cond + def get_emp_list(sal_struct, cond, end_date, payroll_payable_account): - return frappe.db.sql(""" + return frappe.db.sql( + """ select distinct t1.name as employee, t1.employee_name, t1.department, t1.designation from @@ -473,18 +604,37 @@ def get_emp_list(sal_struct, cond, end_date, payroll_payable_account): and t2.docstatus = 1 and t1.status != 'Inactive' %s order by t2.from_date desc - """ % cond, {"sal_struct": tuple(sal_struct), "from_date": end_date, "payroll_payable_account": payroll_payable_account}, as_dict=True) + """ + % cond, + { + "sal_struct": tuple(sal_struct), + "from_date": end_date, + "payroll_payable_account": payroll_payable_account, + }, + as_dict=True, + ) + def remove_payrolled_employees(emp_list, start_date, end_date): + new_emp_list = [] for employee_details in emp_list: - if frappe.db.exists("Salary Slip", {"employee": employee_details.employee, "start_date": start_date, "end_date": end_date, "docstatus": 1}): - emp_list.remove(employee_details) + if not frappe.db.exists( + "Salary Slip", + { + "employee": employee_details.employee, + "start_date": start_date, + "end_date": end_date, + "docstatus": 1, + }, + ): + new_emp_list.append(employee_details) + + return new_emp_list - return emp_list @frappe.whitelist() def get_start_end_dates(payroll_frequency, start_date=None, company=None): - '''Returns dict of start and end dates for given payroll frequency based on start_date''' + """Returns dict of start and end dates for given payroll frequency based on start_date""" if payroll_frequency == "Monthly" or payroll_frequency == "Bimonthly" or payroll_frequency == "": fiscal_year = get_fiscal_year(start_date, company=company)[0] @@ -492,14 +642,14 @@ def get_start_end_dates(payroll_frequency, start_date=None, company=None): m = get_month_details(fiscal_year, month) if payroll_frequency == "Bimonthly": if getdate(start_date).day <= 15: - start_date = m['month_start_date'] - end_date = m['month_mid_end_date'] + start_date = m["month_start_date"] + end_date = m["month_mid_end_date"] else: - start_date = m['month_mid_start_date'] - end_date = m['month_end_date'] + start_date = m["month_mid_start_date"] + end_date = m["month_end_date"] else: - start_date = m['month_start_date'] - end_date = m['month_end_date'] + start_date = m["month_start_date"] + end_date = m["month_end_date"] if payroll_frequency == "Weekly": end_date = add_days(start_date, 6) @@ -510,16 +660,15 @@ def get_start_end_dates(payroll_frequency, start_date=None, company=None): if payroll_frequency == "Daily": end_date = start_date - return frappe._dict({ - 'start_date': start_date, 'end_date': end_date - }) + return frappe._dict({"start_date": start_date, "end_date": end_date}) + def get_frequency_kwargs(frequency_name): frequency_dict = { - 'monthly': {'months': 1}, - 'fortnightly': {'days': 14}, - 'weekly': {'days': 7}, - 'daily': {'days': 1} + "monthly": {"months": 1}, + "fortnightly": {"days": 14}, + "weekly": {"days": 7}, + "daily": {"days": 1}, } return frequency_dict.get(frequency_name) @@ -527,16 +676,18 @@ def get_frequency_kwargs(frequency_name): @frappe.whitelist() def get_end_date(start_date, frequency): start_date = getdate(start_date) - frequency = frequency.lower() if frequency else 'monthly' - kwargs = get_frequency_kwargs(frequency) if frequency != 'bimonthly' else get_frequency_kwargs('monthly') + frequency = frequency.lower() if frequency else "monthly" + kwargs = ( + get_frequency_kwargs(frequency) if frequency != "bimonthly" else get_frequency_kwargs("monthly") + ) # weekly, fortnightly and daily intervals have fixed days so no problems end_date = add_to_date(start_date, **kwargs) - relativedelta(days=1) - if frequency != 'bimonthly': + if frequency != "bimonthly": return dict(end_date=end_date.strftime(DATE_FORMAT)) else: - return dict(end_date='') + return dict(end_date="") def get_month_details(year, month): @@ -544,32 +695,36 @@ def get_month_details(year, month): if ysd: import calendar import datetime - diff_mnt = cint(month)-cint(ysd.month) - if diff_mnt<0: - diff_mnt = 12-int(ysd.month)+cint(month) - msd = ysd + relativedelta(months=diff_mnt) # month start date - month_days = cint(calendar.monthrange(cint(msd.year) ,cint(month))[1]) # days in month - mid_start = datetime.date(msd.year, cint(month), 16) # month mid start date - mid_end = datetime.date(msd.year, cint(month), 15) # month mid end date - med = datetime.date(msd.year, cint(month), month_days) # month end date - return frappe._dict({ - 'year': msd.year, - 'month_start_date': msd, - 'month_end_date': med, - 'month_mid_start_date': mid_start, - 'month_mid_end_date': mid_end, - 'month_days': month_days - }) + + diff_mnt = cint(month) - cint(ysd.month) + if diff_mnt < 0: + diff_mnt = 12 - int(ysd.month) + cint(month) + msd = ysd + relativedelta(months=diff_mnt) # month start date + month_days = cint(calendar.monthrange(cint(msd.year), cint(month))[1]) # days in month + mid_start = datetime.date(msd.year, cint(month), 16) # month mid start date + mid_end = datetime.date(msd.year, cint(month), 15) # month mid end date + med = datetime.date(msd.year, cint(month), month_days) # month end date + return frappe._dict( + { + "year": msd.year, + "month_start_date": msd, + "month_end_date": med, + "month_mid_start_date": mid_start, + "month_mid_end_date": mid_end, + "month_days": month_days, + } + ) else: frappe.throw(_("Fiscal Year {0} not found").format(year)) + def get_payroll_entry_bank_entries(payroll_entry_name): journal_entries = frappe.db.sql( - 'select name from `tabJournal Entry Account` ' + "select name from `tabJournal Entry Account` " 'where reference_type="Payroll Entry" ' - 'and reference_name=%s and docstatus=1', + "and reference_name=%s and docstatus=1", payroll_entry_name, - as_dict=1 + as_dict=1, ) return journal_entries @@ -579,26 +734,26 @@ def get_payroll_entry_bank_entries(payroll_entry_name): def payroll_entry_has_bank_entries(name): response = {} bank_entries = get_payroll_entry_bank_entries(name) - response['submitted'] = 1 if bank_entries else 0 + response["submitted"] = 1 if bank_entries else 0 return response + def create_salary_slips_for_employees(employees, args, publish_progress=True): salary_slips_exists_for = get_existing_salary_slips(employees, args) - count=0 + count = 0 salary_slips_not_created = [] for emp in employees: if emp not in salary_slips_exists_for: - args.update({ - "doctype": "Salary Slip", - "employee": emp - }) + args.update({"doctype": "Salary Slip", "employee": emp}) ss = frappe.get_doc(args) ss.insert() - count+=1 + count += 1 if publish_progress: - frappe.publish_progress(count*100/len(set(employees) - set(salary_slips_exists_for)), - title = _("Creating Salary Slips...")) + frappe.publish_progress( + count * 100 / len(set(employees) - set(salary_slips_exists_for)), + title=_("Creating Salary Slips..."), + ) else: salary_slips_not_created.append(emp) @@ -608,17 +763,27 @@ def create_salary_slips_for_employees(employees, args, publish_progress=True): payroll_entry.notify_update() if salary_slips_not_created: - frappe.msgprint(_("Salary Slips already exists for employees {}, and will not be processed by this payroll.") - .format(frappe.bold(", ".join([emp for emp in salary_slips_not_created]))) , title=_("Message"), indicator="orange") + frappe.msgprint( + _( + "Salary Slips already exists for employees {}, and will not be processed by this payroll." + ).format(frappe.bold(", ".join([emp for emp in salary_slips_not_created]))), + title=_("Message"), + indicator="orange", + ) + def get_existing_salary_slips(employees, args): - return frappe.db.sql_list(""" + return frappe.db.sql_list( + """ select distinct employee from `tabSalary Slip` where docstatus!= 2 and company = %s and payroll_entry = %s and start_date >= %s and end_date <= %s and employee in (%s) - """ % ('%s', '%s', '%s', '%s', ', '.join(['%s']*len(employees))), - [args.company, args.payroll_entry, args.start_date, args.end_date] + employees) + """ + % ("%s", "%s", "%s", "%s", ", ".join(["%s"] * len(employees))), + [args.company, args.payroll_entry, args.start_date, args.end_date] + employees, + ) + def submit_salary_slips_for_employees(payroll_entry, salary_slips, publish_progress=True): submitted_ss = [] @@ -627,8 +792,8 @@ def submit_salary_slips_for_employees(payroll_entry, salary_slips, publish_progr count = 0 for ss in salary_slips: - ss_obj = frappe.get_doc("Salary Slip",ss[0]) - if ss_obj.net_pay<0: + ss_obj = frappe.get_doc("Salary Slip", ss[0]) + if ss_obj.net_pay < 0: not_submitted_ss.append(ss[0]) else: try: @@ -639,11 +804,12 @@ def submit_salary_slips_for_employees(payroll_entry, salary_slips, publish_progr count += 1 if publish_progress: - frappe.publish_progress(count*100/len(salary_slips), title = _("Submitting Salary Slips...")) + frappe.publish_progress(count * 100 / len(salary_slips), title=_("Submitting Salary Slips...")) if submitted_ss: payroll_entry.make_accrual_jv_entry() - frappe.msgprint(_("Salary Slip submitted for period from {0} to {1}") - .format(ss_obj.start_date, ss_obj.end_date)) + frappe.msgprint( + _("Salary Slip submitted for period from {0} to {1}").format(ss_obj.start_date, ss_obj.end_date) + ) payroll_entry.email_salary_slip(submitted_ss) @@ -651,31 +817,44 @@ def submit_salary_slips_for_employees(payroll_entry, salary_slips, publish_progr payroll_entry.notify_update() if not submitted_ss and not not_submitted_ss: - frappe.msgprint(_("No salary slip found to submit for the above selected criteria OR salary slip already submitted")) + frappe.msgprint( + _( + "No salary slip found to submit for the above selected criteria OR salary slip already submitted" + ) + ) if not_submitted_ss: frappe.msgprint(_("Could not submit some Salary Slips")) + frappe.flags.via_payroll_entry = False + + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_payroll_entries_for_jv(doctype, txt, searchfield, start, page_len, filters): - return frappe.db.sql(""" + return frappe.db.sql( + """ select name from `tabPayroll Entry` where `{key}` LIKE %(txt)s and name not in (select reference_name from `tabJournal Entry Account` where reference_type="Payroll Entry") - order by name limit %(start)s, %(page_len)s""" - .format(key=searchfield), { - 'txt': "%%%s%%" % frappe.db.escape(txt), - 'start': start, 'page_len': page_len - }) + order by name limit %(start)s, %(page_len)s""".format( + key=searchfield + ), + {"txt": "%%%s%%" % txt, "start": start, "page_len": page_len}, + ) + def get_employee_list(filters): cond = get_filter_condition(filters) cond += get_joining_relieving_condition(filters.start_date, filters.end_date) - condition = """and payroll_frequency = '%(payroll_frequency)s'"""% {"payroll_frequency": filters.payroll_frequency} - sal_struct = get_sal_struct(filters.company, filters.currency, filters.salary_slip_based_on_timesheet, condition) + condition = """and payroll_frequency = '%(payroll_frequency)s'""" % { + "payroll_frequency": filters.payroll_frequency + } + sal_struct = get_sal_struct( + filters.company, filters.currency, filters.salary_slip_based_on_timesheet, condition + ) if sal_struct: cond += "and t2.salary_structure IN %(sal_struct)s " cond += "and t2.payroll_payable_account = %(payroll_payable_account)s " @@ -686,34 +865,38 @@ def get_employee_list(filters): return [] + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def employee_query(doctype, txt, searchfield, start, page_len, filters): filters = frappe._dict(filters) conditions = [] include_employees = [] - emp_cond = '' + emp_cond = "" if not filters.payroll_frequency: - frappe.throw(_('Select Payroll Frequency.')) + frappe.throw(_("Select Payroll Frequency.")) if filters.start_date and filters.end_date: employee_list = get_employee_list(filters) - emp = filters.get('employees') or [] - include_employees = [employee.employee for employee in employee_list if employee.employee not in emp] - filters.pop('start_date') - filters.pop('end_date') - filters.pop('salary_slip_based_on_timesheet') - filters.pop('payroll_frequency') - filters.pop('payroll_payable_account') - filters.pop('currency') + emp = filters.get("employees") or [] + include_employees = [ + employee.employee for employee in employee_list if employee.employee not in emp + ] + filters.pop("start_date") + filters.pop("end_date") + filters.pop("salary_slip_based_on_timesheet") + filters.pop("payroll_frequency") + filters.pop("payroll_payable_account") + filters.pop("currency") if filters.employees is not None: - filters.pop('employees') + filters.pop("employees") if include_employees: - emp_cond += 'and employee in %(include_employees)s' + emp_cond += "and employee in %(include_employees)s" - return frappe.db.sql("""select name, employee_name from `tabEmployee` + return frappe.db.sql( + """select name, employee_name from `tabEmployee` where status = 'Active' and docstatus < 2 and ({key} like %(txt)s @@ -725,14 +908,19 @@ def employee_query(doctype, txt, searchfield, start, page_len, filters): if(locate(%(_txt)s, employee_name), locate(%(_txt)s, employee_name), 99999), idx desc, name, employee_name - limit %(start)s, %(page_len)s""".format(**{ - 'key': searchfield, - 'fcond': get_filters_cond(doctype, filters, conditions), - 'mcond': get_match_cond(doctype), - 'emp_cond': emp_cond - }), { - 'txt': "%%%s%%" % txt, - '_txt': txt.replace("%", ""), - 'start': start, - 'page_len': page_len, - 'include_employees': include_employees}) + limit %(start)s, %(page_len)s""".format( + **{ + "key": searchfield, + "fcond": get_filters_cond(doctype, filters, conditions), + "mcond": get_match_cond(doctype), + "emp_cond": emp_cond, + } + ), + { + "txt": "%%%s%%" % txt, + "_txt": txt.replace("%", ""), + "start": start, + "page_len": page_len, + "include_employees": include_employees, + }, + ) diff --git a/erpnext/payroll/doctype/payroll_entry/payroll_entry_dashboard.py b/erpnext/payroll/doctype/payroll_entry/payroll_entry_dashboard.py index 138fed68f4c..eb93d688f92 100644 --- a/erpnext/payroll/doctype/payroll_entry/payroll_entry_dashboard.py +++ b/erpnext/payroll/doctype/payroll_entry/payroll_entry_dashboard.py @@ -1,15 +1,9 @@ - - def get_data(): return { - 'fieldname': 'payroll_entry', - 'non_standard_fieldnames': { - 'Journal Entry': 'reference_name', - 'Payment Entry': 'reference_name', + "fieldname": "payroll_entry", + "non_standard_fieldnames": { + "Journal Entry": "reference_name", + "Payment Entry": "reference_name", }, - 'transactions': [ - { - 'items': ['Salary Slip', 'Journal Entry'] - } - ] + "transactions": [{"items": ["Salary Slip", "Journal Entry"]}], } diff --git a/erpnext/payroll/doctype/payroll_entry/test_payroll_entry.py b/erpnext/payroll/doctype/payroll_entry/test_payroll_entry.py index c6f38972880..35cea017e8c 100644 --- a/erpnext/payroll/doctype/payroll_entry/test_payroll_entry.py +++ b/erpnext/payroll/doctype/payroll_entry/test_payroll_entry.py @@ -5,6 +5,7 @@ import unittest import frappe from dateutil.relativedelta import relativedelta +from frappe.tests.utils import FrappeTestCase from frappe.utils import add_months import erpnext @@ -32,139 +33,224 @@ from erpnext.payroll.doctype.salary_structure.test_salary_structure import ( make_salary_structure, ) -test_dependencies = ['Holiday List'] +test_dependencies = ["Holiday List"] -class TestPayrollEntry(unittest.TestCase): + +class TestPayrollEntry(FrappeTestCase): @classmethod def setUpClass(cls): - frappe.db.set_value("Company", erpnext.get_default_company(), "default_holiday_list", '_Test Holiday List') + frappe.db.set_value( + "Company", erpnext.get_default_company(), "default_holiday_list", "_Test Holiday List" + ) def setUp(self): - for dt in ["Salary Slip", "Salary Component", "Salary Component Account", - "Payroll Entry", "Salary Structure", "Salary Structure Assignment", "Payroll Employee Detail", "Additional Salary"]: - frappe.db.sql("delete from `tab%s`" % dt) + for dt in [ + "Salary Slip", + "Salary Component", + "Salary Component Account", + "Payroll Entry", + "Salary Structure", + "Salary Structure Assignment", + "Payroll Employee Detail", + "Additional Salary", + ]: + frappe.db.sql("delete from `tab%s`" % dt) make_earning_salary_component(setup=True, company_list=["_Test Company"]) make_deduction_salary_component(setup=True, test_tax=False, company_list=["_Test Company"]) frappe.db.set_value("Payroll Settings", None, "email_salary_slip_to_employee", 0) - def test_payroll_entry(self): # pylint: disable=no-self-use + def test_payroll_entry(self): # pylint: disable=no-self-use company = erpnext.get_default_company() - for data in frappe.get_all('Salary Component', fields = ["name"]): - if not frappe.db.get_value('Salary Component Account', - {'parent': data.name, 'company': company}, 'name'): + for data in frappe.get_all("Salary Component", fields=["name"]): + if not frappe.db.get_value( + "Salary Component Account", {"parent": data.name, "company": company}, "name" + ): get_salary_component_account(data.name) - employee = frappe.db.get_value("Employee", {'company': company}) - company_doc = frappe.get_doc('Company', company) - make_salary_structure("_Test Salary Structure", "Monthly", employee, company=company, currency=company_doc.default_currency) - dates = get_start_end_dates('Monthly', nowdate()) - if not frappe.db.get_value("Salary Slip", {"start_date": dates.start_date, "end_date": dates.end_date}): - make_payroll_entry(start_date=dates.start_date, end_date=dates.end_date, payable_account=company_doc.default_payroll_payable_account, - currency=company_doc.default_currency) + employee = frappe.db.get_value("Employee", {"company": company}) + company_doc = frappe.get_doc("Company", company) + make_salary_structure( + "_Test Salary Structure", + "Monthly", + employee, + company=company, + currency=company_doc.default_currency, + ) + dates = get_start_end_dates("Monthly", nowdate()) + if not frappe.db.get_value( + "Salary Slip", {"start_date": dates.start_date, "end_date": dates.end_date} + ): + make_payroll_entry( + start_date=dates.start_date, + end_date=dates.end_date, + payable_account=company_doc.default_payroll_payable_account, + currency=company_doc.default_currency, + ) - def test_multi_currency_payroll_entry(self): # pylint: disable=no-self-use + def test_multi_currency_payroll_entry(self): # pylint: disable=no-self-use company = erpnext.get_default_company() employee = make_employee("test_muti_currency_employee@payroll.com", company=company) - for data in frappe.get_all('Salary Component', fields = ["name"]): - if not frappe.db.get_value('Salary Component Account', - {'parent': data.name, 'company': company}, 'name'): + for data in frappe.get_all("Salary Component", fields=["name"]): + if not frappe.db.get_value( + "Salary Component Account", {"parent": data.name, "company": company}, "name" + ): get_salary_component_account(data.name) - company_doc = frappe.get_doc('Company', company) - salary_structure = make_salary_structure("_Test Multi Currency Salary Structure", "Monthly", company=company, currency='USD') - create_salary_structure_assignment(employee, salary_structure.name, company=company, currency='USD') - frappe.db.sql("""delete from `tabSalary Slip` where employee=%s""",(frappe.db.get_value("Employee", {"user_id": "test_muti_currency_employee@payroll.com"}))) - salary_slip = get_salary_slip("test_muti_currency_employee@payroll.com", "Monthly", "_Test Multi Currency Salary Structure") - dates = get_start_end_dates('Monthly', nowdate()) - payroll_entry = make_payroll_entry(start_date=dates.start_date, end_date=dates.end_date, - payable_account=company_doc.default_payroll_payable_account, currency='USD', exchange_rate=70) + company_doc = frappe.get_doc("Company", company) + salary_structure = make_salary_structure( + "_Test Multi Currency Salary Structure", "Monthly", company=company, currency="USD" + ) + create_salary_structure_assignment( + employee, salary_structure.name, company=company, currency="USD" + ) + frappe.db.sql( + """delete from `tabSalary Slip` where employee=%s""", + (frappe.db.get_value("Employee", {"user_id": "test_muti_currency_employee@payroll.com"})), + ) + salary_slip = get_salary_slip( + "test_muti_currency_employee@payroll.com", "Monthly", "_Test Multi Currency Salary Structure" + ) + dates = get_start_end_dates("Monthly", nowdate()) + payroll_entry = make_payroll_entry( + start_date=dates.start_date, + end_date=dates.end_date, + payable_account=company_doc.default_payroll_payable_account, + currency="USD", + exchange_rate=70, + ) payroll_entry.make_payment_entry() salary_slip.load_from_db() payroll_je = salary_slip.journal_entry if payroll_je: - payroll_je_doc = frappe.get_doc('Journal Entry', payroll_je) + payroll_je_doc = frappe.get_doc("Journal Entry", payroll_je) self.assertEqual(salary_slip.base_gross_pay, payroll_je_doc.total_debit) self.assertEqual(salary_slip.base_gross_pay, payroll_je_doc.total_credit) - payment_entry = frappe.db.sql(''' + payment_entry = frappe.db.sql( + """ Select ifnull(sum(je.total_debit),0) as total_debit, ifnull(sum(je.total_credit),0) as total_credit from `tabJournal Entry` je, `tabJournal Entry Account` jea Where je.name = jea.parent And jea.reference_name = %s - ''', (payroll_entry.name), as_dict=1) + """, + (payroll_entry.name), + as_dict=1, + ) self.assertEqual(salary_slip.base_net_pay, payment_entry[0].total_debit) self.assertEqual(salary_slip.base_net_pay, payment_entry[0].total_credit) - def test_payroll_entry_with_employee_cost_center(self): # pylint: disable=no-self-use - for data in frappe.get_all('Salary Component', fields = ["name"]): - if not frappe.db.get_value('Salary Component Account', - {'parent': data.name, 'company': "_Test Company"}, 'name'): + def test_payroll_entry_with_employee_cost_center(self): # pylint: disable=no-self-use + for data in frappe.get_all("Salary Component", fields=["name"]): + if not frappe.db.get_value( + "Salary Component Account", {"parent": data.name, "company": "_Test Company"}, "name" + ): get_salary_component_account(data.name) - if not frappe.db.exists('Department', "cc - _TC"): - frappe.get_doc({ - 'doctype': 'Department', - 'department_name': "cc", - "company": "_Test Company" - }).insert() + if not frappe.db.exists("Department", "cc - _TC"): + frappe.get_doc( + {"doctype": "Department", "department_name": "cc", "company": "_Test Company"} + ).insert() frappe.db.sql("""delete from `tabEmployee` where employee_name='test_employee1@example.com' """) frappe.db.sql("""delete from `tabEmployee` where employee_name='test_employee2@example.com' """) frappe.db.sql("""delete from `tabSalary Structure` where name='_Test Salary Structure 1' """) frappe.db.sql("""delete from `tabSalary Structure` where name='_Test Salary Structure 2' """) - employee1 = make_employee("test_employee1@example.com", payroll_cost_center="_Test Cost Center - _TC", - department="cc - _TC", company="_Test Company") - employee2 = make_employee("test_employee2@example.com", payroll_cost_center="_Test Cost Center 2 - _TC", - department="cc - _TC", company="_Test Company") + employee1 = make_employee( + "test_employee1@example.com", + payroll_cost_center="_Test Cost Center - _TC", + department="cc - _TC", + company="_Test Company", + ) + employee2 = make_employee( + "test_employee2@example.com", + payroll_cost_center="_Test Cost Center 2 - _TC", + department="cc - _TC", + company="_Test Company", + ) if not frappe.db.exists("Account", "_Test Payroll Payable - _TC"): - create_account(account_name="_Test Payroll Payable", - company="_Test Company", parent_account="Current Liabilities - _TC") + create_account( + account_name="_Test Payroll Payable", + company="_Test Company", + parent_account="Current Liabilities - _TC", + account_type="Payable", + ) - if not frappe.db.get_value("Company", "_Test Company", "default_payroll_payable_account") or \ - frappe.db.get_value("Company", "_Test Company", "default_payroll_payable_account") != "_Test Payroll Payable - _TC": - frappe.db.set_value("Company", "_Test Company", "default_payroll_payable_account", - "_Test Payroll Payable - _TC") - currency=frappe.db.get_value("Company", "_Test Company", "default_currency") - make_salary_structure("_Test Salary Structure 1", "Monthly", employee1, company="_Test Company", currency=currency, test_tax=False) - make_salary_structure("_Test Salary Structure 2", "Monthly", employee2, company="_Test Company", currency=currency, test_tax=False) + if ( + not frappe.db.get_value("Company", "_Test Company", "default_payroll_payable_account") + or frappe.db.get_value("Company", "_Test Company", "default_payroll_payable_account") + != "_Test Payroll Payable - _TC" + ): + frappe.db.set_value( + "Company", "_Test Company", "default_payroll_payable_account", "_Test Payroll Payable - _TC" + ) + currency = frappe.db.get_value("Company", "_Test Company", "default_currency") + make_salary_structure( + "_Test Salary Structure 1", + "Monthly", + employee1, + company="_Test Company", + currency=currency, + test_tax=False, + ) + make_salary_structure( + "_Test Salary Structure 2", + "Monthly", + employee2, + company="_Test Company", + currency=currency, + test_tax=False, + ) - dates = get_start_end_dates('Monthly', nowdate()) - if not frappe.db.get_value("Salary Slip", {"start_date": dates.start_date, "end_date": dates.end_date}): - pe = make_payroll_entry(start_date=dates.start_date, end_date=dates.end_date, payable_account="_Test Payroll Payable - _TC", - currency=frappe.db.get_value("Company", "_Test Company", "default_currency"), department="cc - _TC", company="_Test Company", payment_account="Cash - _TC", cost_center="Main - _TC") + dates = get_start_end_dates("Monthly", nowdate()) + if not frappe.db.get_value( + "Salary Slip", {"start_date": dates.start_date, "end_date": dates.end_date} + ): + pe = make_payroll_entry( + start_date=dates.start_date, + end_date=dates.end_date, + payable_account="_Test Payroll Payable - _TC", + currency=frappe.db.get_value("Company", "_Test Company", "default_currency"), + department="cc - _TC", + company="_Test Company", + payment_account="Cash - _TC", + cost_center="Main - _TC", + ) je = frappe.db.get_value("Salary Slip", {"payroll_entry": pe.name}, "journal_entry") - je_entries = frappe.db.sql(""" + je_entries = frappe.db.sql( + """ select account, cost_center, debit, credit from `tabJournal Entry Account` where parent=%s order by account, cost_center - """, je) + """, + je, + ) expected_je = ( - ('_Test Payroll Payable - _TC', 'Main - _TC', 0.0, 155600.0), - ('Salary - _TC', '_Test Cost Center - _TC', 78000.0, 0.0), - ('Salary - _TC', '_Test Cost Center 2 - _TC', 78000.0, 0.0), - ('Salary Deductions - _TC', '_Test Cost Center - _TC', 0.0, 200.0), - ('Salary Deductions - _TC', '_Test Cost Center 2 - _TC', 0.0, 200.0) + ("_Test Payroll Payable - _TC", "Main - _TC", 0.0, 155600.0), + ("Salary - _TC", "_Test Cost Center - _TC", 78000.0, 0.0), + ("Salary - _TC", "_Test Cost Center 2 - _TC", 78000.0, 0.0), + ("Salary Deductions - _TC", "_Test Cost Center - _TC", 0.0, 200.0), + ("Salary Deductions - _TC", "_Test Cost Center 2 - _TC", 0.0, 200.0), ) self.assertEqual(je_entries, expected_je) def test_get_end_date(self): - self.assertEqual(get_end_date('2017-01-01', 'monthly'), {'end_date': '2017-01-31'}) - self.assertEqual(get_end_date('2017-02-01', 'monthly'), {'end_date': '2017-02-28'}) - self.assertEqual(get_end_date('2017-02-01', 'fortnightly'), {'end_date': '2017-02-14'}) - self.assertEqual(get_end_date('2017-02-01', 'bimonthly'), {'end_date': ''}) - self.assertEqual(get_end_date('2017-01-01', 'bimonthly'), {'end_date': ''}) - self.assertEqual(get_end_date('2020-02-15', 'bimonthly'), {'end_date': ''}) - self.assertEqual(get_end_date('2017-02-15', 'monthly'), {'end_date': '2017-03-14'}) - self.assertEqual(get_end_date('2017-02-15', 'daily'), {'end_date': '2017-02-15'}) + self.assertEqual(get_end_date("2017-01-01", "monthly"), {"end_date": "2017-01-31"}) + self.assertEqual(get_end_date("2017-02-01", "monthly"), {"end_date": "2017-02-28"}) + self.assertEqual(get_end_date("2017-02-01", "fortnightly"), {"end_date": "2017-02-14"}) + self.assertEqual(get_end_date("2017-02-01", "bimonthly"), {"end_date": ""}) + self.assertEqual(get_end_date("2017-01-01", "bimonthly"), {"end_date": ""}) + self.assertEqual(get_end_date("2020-02-15", "bimonthly"), {"end_date": ""}) + self.assertEqual(get_end_date("2017-02-15", "monthly"), {"end_date": "2017-03-14"}) + self.assertEqual(get_end_date("2017-02-15", "daily"), {"end_date": "2017-02-15"}) def test_loan(self): branch = "Test Employee Branch" @@ -172,62 +258,88 @@ class TestPayrollEntry(unittest.TestCase): company = "_Test Company" holiday_list = make_holiday("test holiday for loan") - company_doc = frappe.get_doc('Company', company) + company_doc = frappe.get_doc("Company", company) if not company_doc.default_payroll_payable_account: - company_doc.default_payroll_payable_account = frappe.db.get_value('Account', - {'company': company, 'root_type': 'Liability', 'account_type': ''}, 'name') + company_doc.default_payroll_payable_account = frappe.db.get_value( + "Account", {"company": company, "root_type": "Liability", "account_type": ""}, "name" + ) company_doc.save() - if not frappe.db.exists('Branch', branch): - frappe.get_doc({ - 'doctype': 'Branch', - 'branch': branch - }).insert() + if not frappe.db.exists("Branch", branch): + frappe.get_doc({"doctype": "Branch", "branch": branch}).insert() - employee_doc = frappe.get_doc('Employee', applicant) + employee_doc = frappe.get_doc("Employee", applicant) employee_doc.branch = branch employee_doc.holiday_list = holiday_list employee_doc.save() salary_structure = "Test Salary Structure for Loan" - make_salary_structure(salary_structure, "Monthly", employee=employee_doc.name, company="_Test Company", currency=company_doc.default_currency) + make_salary_structure( + salary_structure, + "Monthly", + employee=employee_doc.name, + company="_Test Company", + currency=company_doc.default_currency, + ) if not frappe.db.exists("Loan Type", "Car Loan"): create_loan_accounts() - create_loan_type("Car Loan", 500000, 8.4, + create_loan_type( + "Car Loan", + 500000, + 8.4, is_term_loan=1, - mode_of_payment='Cash', - payment_account='Payment Account - _TC', - loan_account='Loan Account - _TC', - interest_income_account='Interest Income Account - _TC', - penalty_income_account='Penalty Income Account - _TC') + mode_of_payment="Cash", + disbursement_account="Disbursement Account - _TC", + payment_account="Payment Account - _TC", + loan_account="Loan Account - _TC", + interest_income_account="Interest Income Account - _TC", + penalty_income_account="Penalty Income Account - _TC", + ) - loan = create_loan(applicant, "Car Loan", 280000, "Repay Over Number of Periods", 20, posting_date=add_months(nowdate(), -1)) + loan = create_loan( + applicant, + "Car Loan", + 280000, + "Repay Over Number of Periods", + 20, + posting_date=add_months(nowdate(), -1), + ) loan.repay_from_salary = 1 loan.submit() - make_loan_disbursement_entry(loan.name, loan.loan_amount, disbursement_date=add_months(nowdate(), -1)) + make_loan_disbursement_entry( + loan.name, loan.loan_amount, disbursement_date=add_months(nowdate(), -1) + ) process_loan_interest_accrual_for_term_loans(posting_date=nowdate()) - dates = get_start_end_dates('Monthly', nowdate()) - make_payroll_entry(company="_Test Company", start_date=dates.start_date, payable_account=company_doc.default_payroll_payable_account, - currency=company_doc.default_currency, end_date=dates.end_date, branch=branch, cost_center="Main - _TC", payment_account="Cash - _TC") + dates = get_start_end_dates("Monthly", nowdate()) + make_payroll_entry( + company="_Test Company", + start_date=dates.start_date, + payable_account=company_doc.default_payroll_payable_account, + currency=company_doc.default_currency, + end_date=dates.end_date, + branch=branch, + cost_center="Main - _TC", + payment_account="Cash - _TC", + ) - name = frappe.db.get_value('Salary Slip', - {'posting_date': nowdate(), 'employee': applicant}, 'name') + name = frappe.db.get_value( + "Salary Slip", {"posting_date": nowdate(), "employee": applicant}, "name" + ) + + salary_slip = frappe.get_doc("Salary Slip", name) - salary_slip = frappe.get_doc('Salary Slip', name) for row in salary_slip.loans: if row.loan == loan.name: - interest_amount = (280000 * 8.4)/(12*100) + interest_amount = (280000 * 8.4) / (12 * 100) principal_amount = loan.monthly_repayment_amount - interest_amount self.assertEqual(row.interest_amount, interest_amount) self.assertEqual(row.principal_amount, principal_amount) - self.assertEqual(row.total_payment, - interest_amount + principal_amount) if salary_slip.docstatus == 0: - frappe.delete_doc('Salary Slip', name) + frappe.delete_doc("Salary Slip", name) def make_payroll_entry(**args): @@ -256,17 +368,22 @@ def make_payroll_entry(**args): payroll_entry.save() payroll_entry.create_salary_slips() payroll_entry.submit_salary_slips() - if payroll_entry.get_sal_slip_list(ss_status = 1): + if payroll_entry.get_sal_slip_list(ss_status=1): payroll_entry.make_payment_entry() return payroll_entry + def get_payment_account(): - return frappe.get_value('Account', - {'account_type': 'Cash', 'company': erpnext.get_default_company(),'is_group':0}, "name") + return frappe.get_value( + "Account", + {"account_type": "Cash", "company": erpnext.get_default_company(), "is_group": 0}, + "name", + ) + def make_holiday(holiday_list_name): - if not frappe.db.exists('Holiday List', holiday_list_name): + if not frappe.db.exists("Holiday List", holiday_list_name): current_fiscal_year = get_fiscal_year(nowdate(), as_dict=True) dt = getdate(nowdate()) @@ -274,25 +391,23 @@ def make_holiday(holiday_list_name): republic_day = dt + relativedelta(month=1, day=26, year=dt.year) test_holiday = dt + relativedelta(month=2, day=2, year=dt.year) - frappe.get_doc({ - 'doctype': 'Holiday List', - 'from_date': current_fiscal_year.year_start_date, - 'to_date': current_fiscal_year.year_end_date, - 'holiday_list_name': holiday_list_name, - 'holidays': [{ - 'holiday_date': new_year, - 'description': 'New Year' - }, { - 'holiday_date': republic_day, - 'description': 'Republic Day' - }, { - 'holiday_date': test_holiday, - 'description': 'Test Holiday' - }] - }).insert() + frappe.get_doc( + { + "doctype": "Holiday List", + "from_date": current_fiscal_year.year_start_date, + "to_date": current_fiscal_year.year_end_date, + "holiday_list_name": holiday_list_name, + "holidays": [ + {"holiday_date": new_year, "description": "New Year"}, + {"holiday_date": republic_day, "description": "Republic Day"}, + {"holiday_date": test_holiday, "description": "Test Holiday"}, + ], + } + ).insert() return holiday_list_name + def get_salary_slip(user, period, salary_structure): salary_slip = make_employee_salary_slip(user, period, salary_structure) salary_slip.exchange_rate = 70 diff --git a/erpnext/payroll/doctype/payroll_period/payroll_period.py b/erpnext/payroll/doctype/payroll_period/payroll_period.py index 659ec6de7b6..e1f1cabbc7e 100644 --- a/erpnext/payroll/doctype/payroll_period/payroll_period.py +++ b/erpnext/payroll/doctype/payroll_period/payroll_period.py @@ -30,71 +30,92 @@ class PayrollPeriod(Document): """ if not self.name: # hack! if name is null, it could cause problems with != - self.name = "New "+self.doctype + self.name = "New " + self.doctype - overlap_doc = frappe.db.sql(query.format(self.doctype),{ + overlap_doc = frappe.db.sql( + query.format(self.doctype), + { "start_date": self.start_date, "end_date": self.end_date, "name": self.name, - "company": self.company - }, as_dict = 1) + "company": self.company, + }, + as_dict=1, + ) if overlap_doc: - msg = _("A {0} exists between {1} and {2} (").format(self.doctype, - formatdate(self.start_date), formatdate(self.end_date)) \ - + """ {1}""".format(self.doctype, overlap_doc[0].name) \ + msg = ( + _("A {0} exists between {1} and {2} (").format( + self.doctype, formatdate(self.start_date), formatdate(self.end_date) + ) + + """ {1}""".format(self.doctype, overlap_doc[0].name) + _(") for {0}").format(self.company) + ) frappe.throw(msg) + def get_payroll_period_days(start_date, end_date, employee, company=None): if not company: company = frappe.db.get_value("Employee", employee, "company") - payroll_period = frappe.db.sql(""" + payroll_period = frappe.db.sql( + """ select name, start_date, end_date from `tabPayroll Period` where company=%(company)s and %(start_date)s between start_date and end_date and %(end_date)s between start_date and end_date - """, { - 'company': company, - 'start_date': start_date, - 'end_date': end_date - }) + """, + {"company": company, "start_date": start_date, "end_date": end_date}, + ) if len(payroll_period) > 0: actual_no_of_days = date_diff(getdate(payroll_period[0][2]), getdate(payroll_period[0][1])) + 1 working_days = actual_no_of_days - if not cint(frappe.db.get_value("Payroll Settings", None, "include_holidays_in_total_working_days")): - holidays = get_holiday_dates_for_employee(employee, getdate(payroll_period[0][1]), getdate(payroll_period[0][2])) + if not cint( + frappe.db.get_value("Payroll Settings", None, "include_holidays_in_total_working_days") + ): + holidays = get_holiday_dates_for_employee( + employee, getdate(payroll_period[0][1]), getdate(payroll_period[0][2]) + ) working_days -= len(holidays) return payroll_period[0][0], working_days, actual_no_of_days return False, False, False + def get_payroll_period(from_date, to_date, company): - payroll_period = frappe.db.sql(""" + payroll_period = frappe.db.sql( + """ select name, start_date, end_date from `tabPayroll Period` where start_date<=%s and end_date>= %s and company=%s - """, (from_date, to_date, company), as_dict=1) + """, + (from_date, to_date, company), + as_dict=1, + ) return payroll_period[0] if payroll_period else None -def get_period_factor(employee, start_date, end_date, payroll_frequency, payroll_period, depends_on_payment_days=0): + +def get_period_factor( + employee, start_date, end_date, payroll_frequency, payroll_period, depends_on_payment_days=0 +): # TODO if both deduct checked update the factor to make tax consistent period_start, period_end = payroll_period.start_date, payroll_period.end_date - joining_date, relieving_date = frappe.db.get_value("Employee", employee, ["date_of_joining", "relieving_date"]) + joining_date, relieving_date = frappe.db.get_value( + "Employee", employee, ["date_of_joining", "relieving_date"] + ) if getdate(joining_date) > getdate(period_start): period_start = joining_date if relieving_date and getdate(relieving_date) < getdate(period_end): period_end = relieving_date if month_diff(period_end, start_date) > 1: - start_date = add_months(start_date, - (month_diff(period_end, start_date)+1)) + start_date = add_months(start_date, -(month_diff(period_end, start_date) + 1)) total_sub_periods, remaining_sub_periods = 0.0, 0.0 - if payroll_frequency == "Monthly" and not depends_on_payment_days: + if payroll_frequency == "Monthly" and not depends_on_payment_days: total_sub_periods = month_diff(payroll_period.end_date, payroll_period.start_date) remaining_sub_periods = month_diff(period_end, start_date) else: diff --git a/erpnext/payroll/doctype/payroll_period/payroll_period_dashboard.py b/erpnext/payroll/doctype/payroll_period/payroll_period_dashboard.py index eaa67732af4..96632c50085 100644 --- a/erpnext/payroll/doctype/payroll_period/payroll_period_dashboard.py +++ b/erpnext/payroll/doctype/payroll_period/payroll_period_dashboard.py @@ -1,11 +1,7 @@ - - def get_data(): - return { - 'fieldname': 'payroll_period', - 'transactions': [ - { - 'items': ['Employee Tax Exemption Proof Submission', 'Employee Tax Exemption Declaration'] - }, - ], - } + return { + "fieldname": "payroll_period", + "transactions": [ + {"items": ["Employee Tax Exemption Proof Submission", "Employee Tax Exemption Declaration"]}, + ], + } diff --git a/erpnext/payroll/doctype/payroll_settings/payroll_settings.py b/erpnext/payroll/doctype/payroll_settings/payroll_settings.py index 6fd30946f55..33614e9d30a 100644 --- a/erpnext/payroll/doctype/payroll_settings/payroll_settings.py +++ b/erpnext/payroll/doctype/payroll_settings/payroll_settings.py @@ -21,12 +21,25 @@ class PayrollSettings(Document): if not self.password_policy: frappe.throw(_("Password policy for Salary Slips is not set")) - def on_update(self): self.toggle_rounded_total() frappe.clear_cache() def toggle_rounded_total(self): self.disable_rounded_total = cint(self.disable_rounded_total) - make_property_setter("Salary Slip", "rounded_total", "hidden", self.disable_rounded_total, "Check", validate_fields_for_doctype=False) - make_property_setter("Salary Slip", "rounded_total", "print_hide", self.disable_rounded_total, "Check", validate_fields_for_doctype=False) + make_property_setter( + "Salary Slip", + "rounded_total", + "hidden", + self.disable_rounded_total, + "Check", + validate_fields_for_doctype=False, + ) + make_property_setter( + "Salary Slip", + "rounded_total", + "print_hide", + self.disable_rounded_total, + "Check", + validate_fields_for_doctype=False, + ) diff --git a/erpnext/payroll/doctype/retention_bonus/retention_bonus.py b/erpnext/payroll/doctype/retention_bonus/retention_bonus.py index 10e8381007b..cdcd9a90259 100644 --- a/erpnext/payroll/doctype/retention_bonus/retention_bonus.py +++ b/erpnext/payroll/doctype/retention_bonus/retention_bonus.py @@ -14,14 +14,14 @@ class RetentionBonus(Document): def validate(self): validate_active_employee(self.employee) if getdate(self.bonus_payment_date) < getdate(): - frappe.throw(_('Bonus Payment Date cannot be a past date')) + frappe.throw(_("Bonus Payment Date cannot be a past date")) def on_submit(self): - company = frappe.db.get_value('Employee', self.employee, 'company') + company = frappe.db.get_value("Employee", self.employee, "company") additional_salary = self.get_additional_salary() if not additional_salary: - additional_salary = frappe.new_doc('Additional Salary') + additional_salary = frappe.new_doc("Additional Salary") additional_salary.employee = self.employee additional_salary.salary_component = self.salary_component additional_salary.amount = self.bonus_amount @@ -34,29 +34,36 @@ class RetentionBonus(Document): # self.db_set('additional_salary', additional_salary.name) else: - bonus_added = frappe.db.get_value('Additional Salary', additional_salary, 'amount') + self.bonus_amount - frappe.db.set_value('Additional Salary', additional_salary, 'amount', bonus_added) - self.db_set('additional_salary', additional_salary) + bonus_added = ( + frappe.db.get_value("Additional Salary", additional_salary, "amount") + self.bonus_amount + ) + frappe.db.set_value("Additional Salary", additional_salary, "amount", bonus_added) + self.db_set("additional_salary", additional_salary) def on_cancel(self): additional_salary = self.get_additional_salary() if self.additional_salary: - bonus_removed = frappe.db.get_value('Additional Salary', self.additional_salary, 'amount') - self.bonus_amount + bonus_removed = ( + frappe.db.get_value("Additional Salary", self.additional_salary, "amount") - self.bonus_amount + ) if bonus_removed == 0: - frappe.get_doc('Additional Salary', self.additional_salary).cancel() + frappe.get_doc("Additional Salary", self.additional_salary).cancel() else: - frappe.db.set_value('Additional Salary', self.additional_salary, 'amount', bonus_removed) + frappe.db.set_value("Additional Salary", self.additional_salary, "amount", bonus_removed) # self.db_set('additional_salary', '') def get_additional_salary(self): - return frappe.db.exists('Additional Salary', { - 'employee': self.employee, - 'salary_component': self.salary_component, - 'payroll_date': self.bonus_payment_date, - 'company': self.company, - 'docstatus': 1, - 'ref_doctype': self.doctype, - 'ref_docname': self.name - }) + return frappe.db.exists( + "Additional Salary", + { + "employee": self.employee, + "salary_component": self.salary_component, + "payroll_date": self.bonus_payment_date, + "company": self.company, + "docstatus": 1, + "ref_doctype": self.doctype, + "ref_docname": self.name, + }, + ) diff --git a/erpnext/payroll/doctype/salary_component/salary_component.py b/erpnext/payroll/doctype/salary_component/salary_component.py index b8def58643a..409c4a1769e 100644 --- a/erpnext/payroll/doctype/salary_component/salary_component.py +++ b/erpnext/payroll/doctype/salary_component/salary_component.py @@ -12,9 +12,13 @@ class SalaryComponent(Document): def validate_abbr(self): if not self.salary_component_abbr: - self.salary_component_abbr = ''.join([c[0] for c in - self.salary_component.split()]).upper() + self.salary_component_abbr = "".join([c[0] for c in self.salary_component.split()]).upper() self.salary_component_abbr = self.salary_component_abbr.strip() - self.salary_component_abbr = append_number_if_name_exists('Salary Component', self.salary_component_abbr, - 'salary_component_abbr', separator='_', filters={"name": ["!=", self.name]}) + self.salary_component_abbr = append_number_if_name_exists( + "Salary Component", + self.salary_component_abbr, + "salary_component_abbr", + separator="_", + filters={"name": ["!=", self.name]}, + ) diff --git a/erpnext/payroll/doctype/salary_component/test_salary_component.py b/erpnext/payroll/doctype/salary_component/test_salary_component.py index 6e00971a230..cd729e82400 100644 --- a/erpnext/payroll/doctype/salary_component/test_salary_component.py +++ b/erpnext/payroll/doctype/salary_component/test_salary_component.py @@ -7,15 +7,18 @@ import frappe # test_records = frappe.get_test_records('Salary Component') + class TestSalaryComponent(unittest.TestCase): pass def create_salary_component(component_name, **args): if not frappe.db.exists("Salary Component", component_name): - frappe.get_doc({ + frappe.get_doc( + { "doctype": "Salary Component", "salary_component": component_name, "type": args.get("type") or "Earning", - "is_tax_applicable": args.get("is_tax_applicable") or 1 - }).insert() + "is_tax_applicable": args.get("is_tax_applicable") or 1, + } + ).insert() diff --git a/erpnext/payroll/doctype/salary_slip/salary_slip.json b/erpnext/payroll/doctype/salary_slip/salary_slip.json index ad00d6d323f..4214c0238c3 100644 --- a/erpnext/payroll/doctype/salary_slip/salary_slip.json +++ b/erpnext/payroll/doctype/salary_slip/salary_slip.json @@ -377,7 +377,6 @@ "fieldtype": "Column Break" }, { - "depends_on": "total_loan_repayment", "fieldname": "loan_repayment", "fieldtype": "Section Break", "label": "Loan Repayment" @@ -647,7 +646,7 @@ "idx": 9, "is_submittable": 1, "links": [], - "modified": "2021-10-08 11:48:47.098248", + "modified": "2022-08-29 08:59:50.819986", "modified_by": "Administrator", "module": "Payroll", "name": "Salary Slip", diff --git a/erpnext/payroll/doctype/salary_slip/salary_slip.py b/erpnext/payroll/doctype/salary_slip/salary_slip.py index 6e9503fb9a6..b2243838202 100644 --- a/erpnext/payroll/doctype/salary_slip/salary_slip.py +++ b/erpnext/payroll/doctype/salary_slip/salary_slip.py @@ -30,6 +30,9 @@ from erpnext.loan_management.doctype.loan_repayment.loan_repayment import ( calculate_amounts, create_repayment_entry, ) +from erpnext.loan_management.doctype.process_loan_interest_accrual.process_loan_interest_accrual import ( + process_loan_interest_accrual_for_term_loans, +) from erpnext.payroll.doctype.additional_salary.additional_salary import get_additional_salaries from erpnext.payroll.doctype.employee_benefit_application.employee_benefit_application import ( get_benefit_component_amount, @@ -49,14 +52,14 @@ from erpnext.utilities.transaction_base import TransactionBase class SalarySlip(TransactionBase): def __init__(self, *args, **kwargs): super(SalarySlip, self).__init__(*args, **kwargs) - self.series = 'Sal Slip/{0}/.#####'.format(self.employee) + self.series = "Sal Slip/{0}/.#####".format(self.employee) self.whitelisted_globals = { "int": int, "float": float, "long": int, "round": round, "date": datetime.date, - "getdate": getdate + "getdate": getdate, } def autoname(self): @@ -74,7 +77,7 @@ class SalarySlip(TransactionBase): # get details from salary structure self.get_emp_and_working_day_details() else: - self.get_working_days_details(lwp = self.leave_without_pay) + self.get_working_days_details(lwp=self.leave_without_pay) self.calculate_net_pay() self.compute_year_to_date() @@ -83,10 +86,16 @@ class SalarySlip(TransactionBase): self.add_leave_balances() if frappe.db.get_single_value("Payroll Settings", "max_working_hours_against_timesheet"): - max_working_hours = frappe.db.get_single_value("Payroll Settings", "max_working_hours_against_timesheet") + max_working_hours = frappe.db.get_single_value( + "Payroll Settings", "max_working_hours_against_timesheet" + ) if self.salary_slip_based_on_timesheet and (self.total_working_hours > int(max_working_hours)): - frappe.msgprint(_("Total working hours should not be greater than max working hours {0}"). - format(max_working_hours), alert=True) + frappe.msgprint( + _("Total working hours should not be greater than max working hours {0}").format( + max_working_hours + ), + alert=True, + ) def set_net_total_in_words(self): doc_currency = self.currency @@ -103,24 +112,30 @@ class SalarySlip(TransactionBase): self.set_status() self.update_status(self.name) self.make_loan_repayment_entry() - if (frappe.db.get_single_value("Payroll Settings", "email_salary_slip_to_employee")) and not frappe.flags.via_payroll_entry: + if ( + frappe.db.get_single_value("Payroll Settings", "email_salary_slip_to_employee") + ) and not frappe.flags.via_payroll_entry: self.email_salary_slip() self.update_payment_status_for_gratuity() def update_payment_status_for_gratuity(self): - add_salary = frappe.db.get_all("Additional Salary", - filters = { - "payroll_date": ("BETWEEN", [self.start_date, self.end_date]), + additional_salary = frappe.db.get_all( + "Additional Salary", + filters={ + "payroll_date": ("between", [self.start_date, self.end_date]), "employee": self.employee, "ref_doctype": "Gratuity", "docstatus": 1, - }, fields = ["ref_docname", "name"], limit=1) + }, + fields=["ref_docname", "name"], + limit=1, + ) - if len(add_salary): + if additional_salary: status = "Paid" if self.docstatus == 1 else "Unpaid" - if add_salary[0].name in [data.additional_salary for data in self.earnings]: - frappe.db.set_value("Gratuity", add_salary.ref_docname, "status", status) + if additional_salary[0].name in [entry.additional_salary for entry in self.earnings]: + frappe.db.set_value("Gratuity", additional_salary[0].ref_docname, "status", status) def on_cancel(self): self.set_status() @@ -130,6 +145,7 @@ class SalarySlip(TransactionBase): def on_trash(self): from frappe.model.naming import revert_series_if_last + revert_series_if_last(self.series, self.name) def get_status(self): @@ -147,9 +163,7 @@ class SalarySlip(TransactionBase): if not joining_date: joining_date, relieving_date = frappe.get_cached_value( - "Employee", - self.employee, - ("date_of_joining", "relieving_date") + "Employee", self.employee, ("date_of_joining", "relieving_date") ) if date_diff(self.end_date, joining_date) < 0: @@ -166,16 +180,26 @@ class SalarySlip(TransactionBase): cond = "" if self.payroll_entry: cond += "and payroll_entry = '{0}'".format(self.payroll_entry) - ret_exist = frappe.db.sql("""select name from `tabSalary Slip` + ret_exist = frappe.db.sql( + """select name from `tabSalary Slip` where start_date = %s and end_date = %s and docstatus != 2 - and employee = %s and name != %s {0}""".format(cond), - (self.start_date, self.end_date, self.employee, self.name)) + and employee = %s and name != %s {0}""".format( + cond + ), + (self.start_date, self.end_date, self.employee, self.name), + ) if ret_exist: - frappe.throw(_("Salary Slip of employee {0} already created for this period").format(self.employee)) + frappe.throw( + _("Salary Slip of employee {0} already created for this period").format(self.employee) + ) else: for data in self.timesheets: - if frappe.db.get_value('Timesheet', data.time_sheet, 'status') == 'Payrolled': - frappe.throw(_("Salary Slip of employee {0} already created for time sheet {1}").format(self.employee, data.time_sheet)) + if frappe.db.get_value("Timesheet", data.time_sheet, "status") == "Payrolled": + frappe.throw( + _("Salary Slip of employee {0} already created for time sheet {1}").format( + self.employee, data.time_sheet + ) + ) def get_date_details(self): if not self.end_date: @@ -185,7 +209,7 @@ class SalarySlip(TransactionBase): @frappe.whitelist() def get_emp_and_working_day_details(self): - '''First time, load all the components from salary structure''' + """First time, load all the components from salary structure""" if self.employee: self.set("earnings", []) self.set("deductions", []) @@ -194,52 +218,65 @@ class SalarySlip(TransactionBase): self.get_date_details() joining_date, relieving_date = frappe.get_cached_value( - "Employee", - self.employee, - ("date_of_joining", "relieving_date") + "Employee", self.employee, ("date_of_joining", "relieving_date") ) self.validate_dates(joining_date, relieving_date) - #getin leave details + # getin leave details self.get_working_days_details(joining_date, relieving_date) struct = self.check_sal_struct(joining_date, relieving_date) if struct: - self._salary_structure_doc = frappe.get_doc('Salary Structure', struct) - self.salary_slip_based_on_timesheet = self._salary_structure_doc.salary_slip_based_on_timesheet or 0 + self._salary_structure_doc = frappe.get_doc("Salary Structure", struct) + self.salary_slip_based_on_timesheet = ( + self._salary_structure_doc.salary_slip_based_on_timesheet or 0 + ) self.set_time_sheet() self.pull_sal_struct() - ps = frappe.db.get_value("Payroll Settings", None, ["payroll_based_on","consider_unmarked_attendance_as"], as_dict=1) + ps = frappe.db.get_value( + "Payroll Settings", None, ["payroll_based_on", "consider_unmarked_attendance_as"], as_dict=1 + ) return [ps.payroll_based_on, ps.consider_unmarked_attendance_as] def set_time_sheet(self): if self.salary_slip_based_on_timesheet: self.set("timesheets", []) - timesheets = frappe.db.sql(""" select * from `tabTimesheet` where employee = %(employee)s and start_date BETWEEN %(start_date)s AND %(end_date)s and (status = 'Submitted' or - status = 'Billed')""", {'employee': self.employee, 'start_date': self.start_date, 'end_date': self.end_date}, as_dict=1) + timesheets = frappe.db.sql( + """ select * from `tabTimesheet` where employee = %(employee)s and start_date BETWEEN %(start_date)s AND %(end_date)s and (status = 'Submitted' or + status = 'Billed')""", + {"employee": self.employee, "start_date": self.start_date, "end_date": self.end_date}, + as_dict=1, + ) for data in timesheets: - self.append('timesheets', { - 'time_sheet': data.name, - 'working_hours': data.total_hours - }) + self.append("timesheets", {"time_sheet": data.name, "working_hours": data.total_hours}) def check_sal_struct(self, joining_date, relieving_date): cond = """and sa.employee=%(employee)s and (sa.from_date <= %(start_date)s or sa.from_date <= %(end_date)s or sa.from_date <= %(joining_date)s)""" if self.payroll_frequency: - cond += """and ss.payroll_frequency = '%(payroll_frequency)s'""" % {"payroll_frequency": self.payroll_frequency} + cond += """and ss.payroll_frequency = '%(payroll_frequency)s'""" % { + "payroll_frequency": self.payroll_frequency + } - st_name = frappe.db.sql(""" + st_name = frappe.db.sql( + """ select sa.salary_structure from `tabSalary Structure Assignment` sa join `tabSalary Structure` ss where sa.salary_structure=ss.name and sa.docstatus = 1 and ss.docstatus = 1 and ss.is_active ='Yes' %s order by sa.from_date desc limit 1 - """ %cond, {'employee': self.employee, 'start_date': self.start_date, - 'end_date': self.end_date, 'joining_date': joining_date}) + """ + % cond, + { + "employee": self.employee, + "start_date": self.start_date, + "end_date": self.end_date, + "joining_date": joining_date, + }, + ) if st_name: self.salary_structure = st_name[0][0] @@ -247,8 +284,12 @@ class SalarySlip(TransactionBase): else: self.salary_structure = None - frappe.msgprint(_("No active or default Salary Structure found for employee {0} for the given dates") - .format(self.employee), title=_('Salary Structure Missing')) + frappe.msgprint( + _("No active or default Salary Structure found for employee {0} for the given dates").format( + self.employee + ), + title=_("Salary Structure Missing"), + ) def pull_sal_struct(self): from erpnext.payroll.doctype.salary_structure.salary_structure import make_salary_slip @@ -260,13 +301,19 @@ class SalarySlip(TransactionBase): self.total_working_hours = sum([d.working_hours or 0.0 for d in self.timesheets]) or 0.0 wages_amount = self.hour_rate * self.total_working_hours - self.add_earning_for_hourly_wages(self, self._salary_structure_doc.salary_component, wages_amount) + self.add_earning_for_hourly_wages( + self, self._salary_structure_doc.salary_component, wages_amount + ) make_salary_slip(self._salary_structure_doc.name, self) - def get_working_days_details(self, joining_date=None, relieving_date=None, lwp=None, for_preview=0): + def get_working_days_details( + self, joining_date=None, relieving_date=None, lwp=None, for_preview=0 + ): payroll_based_on = frappe.db.get_value("Payroll Settings", None, "payroll_based_on") - include_holidays_in_total_working_days = frappe.db.get_single_value("Payroll Settings", "include_holidays_in_total_working_days") + include_holidays_in_total_working_days = frappe.db.get_single_value( + "Payroll Settings", "include_holidays_in_total_working_days" + ) working_days = date_diff(self.end_date, self.start_date) + 1 if for_preview: @@ -293,14 +340,16 @@ class SalarySlip(TransactionBase): if not lwp: lwp = actual_lwp elif lwp != actual_lwp: - frappe.msgprint(_("Leave Without Pay does not match with approved {} records") - .format(payroll_based_on)) + frappe.msgprint( + _("Leave Without Pay does not match with approved {} records").format(payroll_based_on) + ) self.leave_without_pay = lwp self.total_working_days = working_days - payment_days = self.get_payment_days(joining_date, - relieving_date, include_holidays_in_total_working_days) + payment_days = self.get_payment_days( + joining_date, relieving_date, include_holidays_in_total_working_days + ) if flt(payment_days) > flt(lwp): self.payment_days = flt(payment_days) - flt(lwp) @@ -308,33 +357,81 @@ class SalarySlip(TransactionBase): if payroll_based_on == "Attendance": self.payment_days -= flt(absent) - unmarked_days = self.get_unmarked_days() - consider_unmarked_attendance_as = frappe.db.get_value("Payroll Settings", None, "consider_unmarked_attendance_as") or "Present" + consider_unmarked_attendance_as = ( + frappe.db.get_value("Payroll Settings", None, "consider_unmarked_attendance_as") or "Present" + ) - if payroll_based_on == "Attendance" and consider_unmarked_attendance_as =="Absent": - self.absent_days += unmarked_days #will be treated as absent + if payroll_based_on == "Attendance" and consider_unmarked_attendance_as == "Absent": + unmarked_days = self.get_unmarked_days(include_holidays_in_total_working_days) + self.absent_days += unmarked_days # will be treated as absent self.payment_days -= unmarked_days - if include_holidays_in_total_working_days: - for holiday in holidays: - if not frappe.db.exists("Attendance", {"employee": self.employee, "attendance_date": holiday, "docstatus": 1 }): - self.payment_days += 1 else: self.payment_days = 0 - def get_unmarked_days(self): - marked_days = frappe.get_all("Attendance", filters = { - "attendance_date": ["between", [self.start_date, self.end_date]], - "employee": self.employee, - "docstatus": 1 - }, fields = ["COUNT(*) as marked_days"])[0].marked_days + def get_unmarked_days(self, include_holidays_in_total_working_days): + unmarked_days = self.total_working_days + joining_date, relieving_date = frappe.get_cached_value( + "Employee", self.employee, ["date_of_joining", "relieving_date"] + ) + start_date = self.start_date + end_date = self.end_date - return self.total_working_days - marked_days + if joining_date and (getdate(self.start_date) < joining_date <= getdate(self.end_date)): + start_date = joining_date + unmarked_days = self.get_unmarked_days_based_on_doj_or_relieving( + unmarked_days, + include_holidays_in_total_working_days, + self.start_date, + add_days(joining_date, -1), + ) + if relieving_date and (getdate(self.start_date) <= relieving_date < getdate(self.end_date)): + end_date = relieving_date + unmarked_days = self.get_unmarked_days_based_on_doj_or_relieving( + unmarked_days, + include_holidays_in_total_working_days, + add_days(relieving_date, 1), + self.end_date, + ) + + # exclude days for which attendance has been marked + unmarked_days -= frappe.get_all( + "Attendance", + filters={ + "attendance_date": ["between", [start_date, end_date]], + "employee": self.employee, + "docstatus": 1, + }, + fields=["COUNT(*) as marked_days"], + )[0].marked_days + + return unmarked_days + + def get_unmarked_days_based_on_doj_or_relieving( + self, unmarked_days, include_holidays_in_total_working_days, start_date, end_date + ): + """ + Exclude days before DOJ or after + Relieving Date from unmarked days + """ + from erpnext.hr.doctype.employee.employee import is_holiday + + if include_holidays_in_total_working_days: + unmarked_days -= date_diff(end_date, start_date) + 1 + else: + # exclude only if not holidays + for days in range(date_diff(end_date, start_date) + 1): + date = add_days(end_date, -days) + if not is_holiday(self.employee, date): + unmarked_days -= 1 + + return unmarked_days def get_payment_days(self, joining_date, relieving_date, include_holidays_in_total_working_days): if not joining_date: - joining_date, relieving_date = frappe.get_cached_value("Employee", self.employee, - ["date_of_joining", "relieving_date"]) + joining_date, relieving_date = frappe.get_cached_value( + "Employee", self.employee, ["date_of_joining", "relieving_date"] + ) start_date = getdate(self.start_date) if joining_date: @@ -348,8 +445,7 @@ class SalarySlip(TransactionBase): if getdate(self.start_date) <= relieving_date <= getdate(self.end_date): end_date = relieving_date elif relieving_date < getdate(self.start_date): - frappe.throw(_("Employee relieved on {0} must be set as 'Left'") - .format(relieving_date)) + frappe.throw(_("Employee relieved on {0} must be set as 'Left'").format(relieving_date)) payment_days = date_diff(end_date, start_date) + 1 @@ -365,41 +461,26 @@ class SalarySlip(TransactionBase): def calculate_lwp_or_ppl_based_on_leave_application(self, holidays, working_days): lwp = 0 holidays = "','".join(holidays) - daily_wages_fraction_for_half_day = \ + daily_wages_fraction_for_half_day = ( flt(frappe.db.get_value("Payroll Settings", None, "daily_wages_fraction_for_half_day")) or 0.5 + ) for d in range(working_days): - dt = add_days(cstr(getdate(self.start_date)), d) - leave = frappe.db.sql(""" - SELECT t1.name, - CASE WHEN (t1.half_day_date = %(dt)s or t1.to_date = t1.from_date) - THEN t1.half_day else 0 END, - t2.is_ppl, - t2.fraction_of_daily_salary_per_leave - FROM `tabLeave Application` t1, `tabLeave Type` t2 - WHERE t2.name = t1.leave_type - AND (t2.is_lwp = 1 or t2.is_ppl = 1) - AND t1.docstatus = 1 - AND t1.employee = %(employee)s - AND ifnull(t1.salary_slip, '') = '' - AND CASE - WHEN t2.include_holiday != 1 - THEN %(dt)s not in ('{0}') and %(dt)s between from_date and to_date - WHEN t2.include_holiday - THEN %(dt)s between from_date and to_date - END - """.format(holidays), {"employee": self.employee, "dt": dt}) + date = add_days(cstr(getdate(self.start_date)), d) + leave = get_lwp_or_ppl_for_date(date, self.employee, holidays) if leave: equivalent_lwp_count = 0 - is_half_day_leave = cint(leave[0][1]) - is_partially_paid_leave = cint(leave[0][2]) - fraction_of_daily_salary_per_leave = flt(leave[0][3]) + is_half_day_leave = cint(leave[0].is_half_day) + is_partially_paid_leave = cint(leave[0].is_ppl) + fraction_of_daily_salary_per_leave = flt(leave[0].fraction_of_daily_salary_per_leave) - equivalent_lwp_count = (1 - daily_wages_fraction_for_half_day) if is_half_day_leave else 1 + equivalent_lwp_count = (1 - daily_wages_fraction_for_half_day) if is_half_day_leave else 1 if is_partially_paid_leave: - equivalent_lwp_count *= fraction_of_daily_salary_per_leave if fraction_of_daily_salary_per_leave else 1 + equivalent_lwp_count *= ( + fraction_of_daily_salary_per_leave if fraction_of_daily_salary_per_leave else 1 + ) lwp += equivalent_lwp_count @@ -409,18 +490,22 @@ class SalarySlip(TransactionBase): lwp = 0 absent = 0 - daily_wages_fraction_for_half_day = \ + daily_wages_fraction_for_half_day = ( flt(frappe.db.get_value("Payroll Settings", None, "daily_wages_fraction_for_half_day")) or 0.5 + ) - leave_types = frappe.get_all("Leave Type", + leave_types = frappe.get_all( + "Leave Type", or_filters=[["is_ppl", "=", 1], ["is_lwp", "=", 1]], - fields =["name", "is_lwp", "is_ppl", "fraction_of_daily_salary_per_leave", "include_holiday"]) + fields=["name", "is_lwp", "is_ppl", "fraction_of_daily_salary_per_leave", "include_holiday"], + ) leave_type_map = {} for leave_type in leave_types: leave_type_map[leave_type.name] = leave_type - attendances = frappe.db.sql(''' + attendances = frappe.db.sql( + """ SELECT attendance_date, status, leave_type FROM `tabAttendance` WHERE @@ -428,30 +513,46 @@ class SalarySlip(TransactionBase): AND employee = %s AND docstatus = 1 AND attendance_date between %s and %s - ''', values=(self.employee, self.start_date, self.end_date), as_dict=1) + """, + values=(self.employee, self.start_date, self.end_date), + as_dict=1, + ) for d in attendances: - if d.status in ('Half Day', 'On Leave') and d.leave_type and d.leave_type not in leave_type_map.keys(): + if ( + d.status in ("Half Day", "On Leave") + and d.leave_type + and d.leave_type not in leave_type_map.keys() + ): continue if formatdate(d.attendance_date, "yyyy-mm-dd") in holidays: - if d.status == "Absent" or \ - (d.leave_type and d.leave_type in leave_type_map.keys() and not leave_type_map[d.leave_type]['include_holiday']): - continue + if d.status == "Absent" or ( + d.leave_type + and d.leave_type in leave_type_map.keys() + and not leave_type_map[d.leave_type]["include_holiday"] + ): + continue if d.leave_type: - fraction_of_daily_salary_per_leave = leave_type_map[d.leave_type]["fraction_of_daily_salary_per_leave"] + fraction_of_daily_salary_per_leave = leave_type_map[d.leave_type][ + "fraction_of_daily_salary_per_leave" + ] if d.status == "Half Day": - equivalent_lwp = (1 - daily_wages_fraction_for_half_day) + equivalent_lwp = 1 - daily_wages_fraction_for_half_day if d.leave_type in leave_type_map.keys() and leave_type_map[d.leave_type]["is_ppl"]: - equivalent_lwp *= fraction_of_daily_salary_per_leave if fraction_of_daily_salary_per_leave else 1 + equivalent_lwp *= ( + fraction_of_daily_salary_per_leave if fraction_of_daily_salary_per_leave else 1 + ) lwp += equivalent_lwp elif d.status == "On Leave" and d.leave_type and d.leave_type in leave_type_map.keys(): equivalent_lwp = 1 if leave_type_map[d.leave_type]["is_ppl"]: - equivalent_lwp *= fraction_of_daily_salary_per_leave if fraction_of_daily_salary_per_leave else 1 + equivalent_lwp *= ( + fraction_of_daily_salary_per_leave if fraction_of_daily_salary_per_leave else 1 + ) lwp += equivalent_lwp elif d.status == "Absent": absent += 1 @@ -471,37 +572,45 @@ class SalarySlip(TransactionBase): "abbr": frappe.db.get_value("Salary Component", salary_component, "salary_component_abbr"), "amount": self.hour_rate * self.total_working_hours, "default_amount": 0.0, - "additional_amount": 0.0 + "additional_amount": 0.0, } - doc.append('earnings', wages_row) + doc.append("earnings", wages_row) def calculate_net_pay(self): if self.salary_structure: self.calculate_component_amounts("earnings") self.gross_pay = self.get_component_totals("earnings", depends_on_payment_days=1) - self.base_gross_pay = flt(flt(self.gross_pay) * flt(self.exchange_rate), self.precision('base_gross_pay')) + self.base_gross_pay = flt( + flt(self.gross_pay) * flt(self.exchange_rate), self.precision("base_gross_pay") + ) if self.salary_structure: self.calculate_component_amounts("deductions") - self.set_loan_repayment() + self.add_applicable_loans() self.set_precision_for_component_amounts() self.set_net_pay() def set_net_pay(self): self.total_deduction = self.get_component_totals("deductions") - self.base_total_deduction = flt(flt(self.total_deduction) * flt(self.exchange_rate), self.precision('base_total_deduction')) + self.base_total_deduction = flt( + flt(self.total_deduction) * flt(self.exchange_rate), self.precision("base_total_deduction") + ) self.net_pay = flt(self.gross_pay) - (flt(self.total_deduction) + flt(self.total_loan_repayment)) self.rounded_total = rounded(self.net_pay) - self.base_net_pay = flt(flt(self.net_pay) * flt(self.exchange_rate), self.precision('base_net_pay')) - self.base_rounded_total = flt(rounded(self.base_net_pay), self.precision('base_net_pay')) + self.base_net_pay = flt( + flt(self.net_pay) * flt(self.exchange_rate), self.precision("base_net_pay") + ) + self.base_rounded_total = flt(rounded(self.base_net_pay), self.precision("base_net_pay")) if self.hour_rate: - self.base_hour_rate = flt(flt(self.hour_rate) * flt(self.exchange_rate), self.precision('base_hour_rate')) + self.base_hour_rate = flt( + flt(self.hour_rate) * flt(self.exchange_rate), self.precision("base_hour_rate") + ) self.set_net_total_in_words() def calculate_component_amounts(self, component_type): - if not getattr(self, '_salary_structure_doc', None): - self._salary_structure_doc = frappe.get_doc('Salary Structure', self.salary_structure) + if not getattr(self, "_salary_structure_doc", None): + self._salary_structure_doc = frappe.get_doc("Salary Structure", self.salary_structure) payroll_period = get_payroll_period(self.start_date, self.end_date, self.company) @@ -513,22 +622,42 @@ class SalarySlip(TransactionBase): self.add_tax_components(payroll_period) def add_structure_components(self, component_type): - data = self.get_data_for_eval() + data, default_data = self.get_data_for_eval() + timesheet_component = frappe.db.get_value( + "Salary Structure", self.salary_structure, "salary_component" + ) + for struct_row in self._salary_structure_doc.get(component_type): + if self.salary_slip_based_on_timesheet and struct_row.salary_component == timesheet_component: + continue + amount = self.eval_condition_and_formula(struct_row, data) - if amount and struct_row.statistical_component == 0: - self.update_component_row(struct_row, amount, component_type) + + if struct_row.statistical_component: + # update statitical component amount in reference data based on payment days + # since row for statistical component is not added to salary slip + if struct_row.depends_on_payment_days: + joining_date, relieving_date = self.get_joining_and_relieving_dates() + default_data[struct_row.abbr] = amount + data[struct_row.abbr] = flt( + (flt(amount) * flt(self.payment_days) / cint(self.total_working_days)), + struct_row.precision("amount"), + ) + + elif amount or struct_row.amount_based_on_formula and amount is not None: + default_amount = self.eval_condition_and_formula(struct_row, default_data) + self.update_component_row( + struct_row, amount, component_type, data=data, default_amount=default_amount + ) def get_data_for_eval(self): - '''Returns data for evaluating formula''' + """Returns data for evaluating formula""" data = frappe._dict() employee = frappe.get_doc("Employee", self.employee).as_dict() start_date = getdate(self.start_date) date_to_validate = ( - employee.date_of_joining - if employee.date_of_joining > start_date - else start_date + employee.date_of_joining if employee.date_of_joining > start_date else start_date ) salary_structure_assignment = frappe.get_value( @@ -546,8 +675,9 @@ class SalarySlip(TransactionBase): if not salary_structure_assignment: frappe.throw( - _("Please assign a Salary Structure for Employee {0} " - "applicable from or before {1} first").format( + _( + "Please assign a Salary Structure for Employee {0} " "applicable from or before {1} first" + ).format( frappe.bold(self.employee_name), frappe.bold(formatdate(date_to_validate)), ) @@ -562,11 +692,15 @@ class SalarySlip(TransactionBase): for sc in salary_components: data.setdefault(sc.salary_component_abbr, 0) - for key in ('earnings', 'deductions'): - for d in self.get(key): - data[d.abbr] = d.amount + # shallow copy of data to store default amounts (without payment days) for tax calculation + default_data = data.copy() - return data + for key in ("earnings", "deductions"): + for d in self.get(key): + default_data[d.abbr] = d.default_amount or 0 + data[d.abbr] = d.amount or 0 + + return data, default_data def eval_condition_and_formula(self, d, data): try: @@ -585,8 +719,10 @@ class SalarySlip(TransactionBase): return amount except NameError as err: - frappe.throw(_("{0}
This error can be due to missing or deleted field.").format(err), - title=_("Name error")) + frappe.throw( + _("{0}
This error can be due to missing or deleted field.").format(err), + title=_("Name error"), + ) except SyntaxError as err: frappe.throw(_("Syntax error in formula or condition: {0}").format(err)) except Exception as e: @@ -596,13 +732,27 @@ class SalarySlip(TransactionBase): def add_employee_benefits(self, payroll_period): for struct_row in self._salary_structure_doc.get("earnings"): if struct_row.is_flexible_benefit == 1: - if frappe.db.get_value("Salary Component", struct_row.salary_component, "pay_against_benefit_claim") != 1: - benefit_component_amount = get_benefit_component_amount(self.employee, self.start_date, self.end_date, - struct_row.salary_component, self._salary_structure_doc, self.payroll_frequency, payroll_period) + if ( + frappe.db.get_value( + "Salary Component", struct_row.salary_component, "pay_against_benefit_claim" + ) + != 1 + ): + benefit_component_amount = get_benefit_component_amount( + self.employee, + self.start_date, + self.end_date, + struct_row.salary_component, + self._salary_structure_doc, + self.payroll_frequency, + payroll_period, + ) if benefit_component_amount: self.update_component_row(struct_row, benefit_component_amount, "earnings") else: - benefit_claim_amount = get_benefit_claim_amount(self.employee, self.start_date, self.end_date, struct_row.salary_component) + benefit_claim_amount = get_benefit_claim_amount( + self.employee, self.start_date, self.end_date, struct_row.salary_component + ) if benefit_claim_amount: self.update_component_row(struct_row, benefit_claim_amount, "earnings") @@ -610,9 +760,10 @@ class SalarySlip(TransactionBase): def adjust_benefits_in_last_payroll_period(self, payroll_period): if payroll_period: - if (getdate(payroll_period.end_date) <= getdate(self.end_date)): - last_benefits = get_last_payroll_period_benefits(self.employee, self.start_date, self.end_date, - payroll_period, self._salary_structure_doc) + if getdate(payroll_period.end_date) <= getdate(self.end_date): + last_benefits = get_last_payroll_period_benefits( + self.employee, self.start_date, self.end_date, payroll_period, self._salary_structure_doc + ) if last_benefits: for last_benefit in last_benefits: last_benefit = frappe._dict(last_benefit) @@ -620,8 +771,9 @@ class SalarySlip(TransactionBase): self.update_component_row(frappe._dict(last_benefit.struct_row), amount, "earnings") def add_additional_salary_components(self, component_type): - additional_salaries = get_additional_salaries(self.employee, - self.start_date, self.end_date, component_type) + additional_salaries = get_additional_salaries( + self.employee, self.start_date, self.end_date, component_type + ) for additional_salary in additional_salaries: self.update_component_row( @@ -629,7 +781,7 @@ class SalarySlip(TransactionBase): additional_salary.amount, component_type, additional_salary, - is_recurring = additional_salary.is_recurring + is_recurring=additional_salary.is_recurring, ) def add_tax_components(self, payroll_period): @@ -642,40 +794,50 @@ class SalarySlip(TransactionBase): other_deduction_components.append(d.salary_component) if not tax_components: - tax_components = [d.name for d in frappe.get_all("Salary Component", filters={"variable_based_on_taxable_salary": 1}) - if d.name not in other_deduction_components] + tax_components = [ + d.name + for d in frappe.get_all("Salary Component", filters={"variable_based_on_taxable_salary": 1}) + if d.name not in other_deduction_components + ] for d in tax_components: tax_amount = self.calculate_variable_based_on_taxable_salary(d, payroll_period) tax_row = get_salary_component_data(d) self.update_component_row(tax_row, tax_amount, "deductions") - def update_component_row(self, component_data, amount, component_type, additional_salary=None, is_recurring = 0): + def update_component_row( + self, + component_data, + amount, + component_type, + additional_salary=None, + is_recurring=0, + data=None, + default_amount=None, + ): component_row = None for d in self.get(component_type): if d.salary_component != component_data.salary_component: continue - if ( - ( - not d.additional_salary - and (not additional_salary or additional_salary.overwrite) - ) or ( - additional_salary - and additional_salary.name == d.additional_salary - ) + if (not d.additional_salary and (not additional_salary or additional_salary.overwrite)) or ( + additional_salary and additional_salary.name == d.additional_salary ): component_row = d break if additional_salary and additional_salary.overwrite: # Additional Salary with overwrite checked, remove default rows of same component - self.set(component_type, [ - d for d in self.get(component_type) - if d.salary_component != component_data.salary_component - or (d.additional_salary and additional_salary.name != d.additional_salary) - or d == component_row - ]) + self.set( + component_type, + [ + d + for d in self.get(component_type) + if d.salary_component != component_data.salary_component + or (d.additional_salary and additional_salary.name != d.additional_salary) + or d == component_row + ], + ) if not component_row: if not amount: @@ -683,41 +845,56 @@ class SalarySlip(TransactionBase): component_row = self.append(component_type) for attr in ( - 'depends_on_payment_days', 'salary_component', - 'do_not_include_in_total', 'is_tax_applicable', - 'is_flexible_benefit', 'variable_based_on_taxable_salary', - 'exempted_from_income_tax' + "depends_on_payment_days", + "salary_component", + "do_not_include_in_total", + "is_tax_applicable", + "is_flexible_benefit", + "variable_based_on_taxable_salary", + "exempted_from_income_tax", ): component_row.set(attr, component_data.get(attr)) - abbr = component_data.get('abbr') or component_data.get('salary_component_abbr') - component_row.set('abbr', abbr) + abbr = component_data.get("abbr") or component_data.get("salary_component_abbr") + component_row.set("abbr", abbr) if additional_salary: if additional_salary.overwrite: - component_row.additional_amount = flt(flt(amount) - flt(component_row.get("default_amount", 0)), - component_row.precision("additional_amount")) + component_row.additional_amount = flt( + flt(amount) - flt(component_row.get("default_amount", 0)), + component_row.precision("additional_amount"), + ) else: component_row.default_amount = 0 component_row.additional_amount = amount component_row.is_recurring_additional_salary = is_recurring component_row.additional_salary = additional_salary.name - component_row.deduct_full_tax_on_selected_payroll_date = \ + component_row.deduct_full_tax_on_selected_payroll_date = ( additional_salary.deduct_full_tax_on_selected_payroll_date + ) else: - component_row.default_amount = amount + component_row.default_amount = default_amount or amount component_row.additional_amount = 0 - component_row.deduct_full_tax_on_selected_payroll_date = \ + component_row.deduct_full_tax_on_selected_payroll_date = ( component_data.deduct_full_tax_on_selected_payroll_date + ) component_row.amount = amount self.update_component_amount_based_on_payment_days(component_row) + if data: + data[component_row.abbr] = component_row.amount def update_component_amount_based_on_payment_days(self, component_row): joining_date, relieving_date = self.get_joining_and_relieving_dates() - component_row.amount = self.get_amount_based_on_payment_days(component_row, joining_date, relieving_date)[0] + component_row.amount = self.get_amount_based_on_payment_days( + component_row, joining_date, relieving_date + )[0] + + # remove 0 valued components that have been updated later + if component_row.amount == 0: + self.remove(component_row) def set_precision_for_component_amounts(self): for component_type in ("earnings", "deductions"): @@ -726,8 +903,11 @@ class SalarySlip(TransactionBase): def calculate_variable_based_on_taxable_salary(self, tax_component, payroll_period): if not payroll_period: - frappe.msgprint(_("Start and end dates not in a valid Payroll Period, cannot calculate {0}.") - .format(tax_component)) + frappe.msgprint( + _("Start and end dates not in a valid Payroll Period, cannot calculate {0}.").format( + tax_component + ) + ) return # Deduct taxes forcefully for unsubmitted tax exemption proof and unclaimed benefits in the last period @@ -742,22 +922,34 @@ class SalarySlip(TransactionBase): tax_slab = self.get_income_tax_slabs(payroll_period) # get remaining numbers of sub-period (period for which one salary is processed) - remaining_sub_periods = get_period_factor(self.employee, - self.start_date, self.end_date, self.payroll_frequency, payroll_period)[1] + remaining_sub_periods = get_period_factor( + self.employee, self.start_date, self.end_date, self.payroll_frequency, payroll_period + )[1] # get taxable_earnings, paid_taxes for previous period - previous_taxable_earnings = self.get_taxable_earnings_for_prev_period(payroll_period.start_date, - self.start_date, tax_slab.allow_tax_exemption) - previous_total_paid_taxes = self.get_tax_paid_in_period(payroll_period.start_date, self.start_date, tax_component) + previous_taxable_earnings = self.get_taxable_earnings_for_prev_period( + payroll_period.start_date, self.start_date, tax_slab.allow_tax_exemption + ) + previous_total_paid_taxes = self.get_tax_paid_in_period( + payroll_period.start_date, self.start_date, tax_component + ) # get taxable_earnings for current period (all days) - current_taxable_earnings = self.get_taxable_earnings(tax_slab.allow_tax_exemption) - future_structured_taxable_earnings = current_taxable_earnings.taxable_earnings * (math.ceil(remaining_sub_periods) - 1) + current_taxable_earnings = self.get_taxable_earnings( + tax_slab.allow_tax_exemption, payroll_period=payroll_period + ) + future_structured_taxable_earnings = current_taxable_earnings.taxable_earnings * ( + math.ceil(remaining_sub_periods) - 1 + ) # get taxable_earnings, addition_earnings for current actual payment days - current_taxable_earnings_for_payment_days = self.get_taxable_earnings(tax_slab.allow_tax_exemption, based_on_payment_days=1) + current_taxable_earnings_for_payment_days = self.get_taxable_earnings( + tax_slab.allow_tax_exemption, based_on_payment_days=1, payroll_period=payroll_period + ) current_structured_taxable_earnings = current_taxable_earnings_for_payment_days.taxable_earnings current_additional_earnings = current_taxable_earnings_for_payment_days.additional_income - current_additional_earnings_with_full_tax = current_taxable_earnings_for_payment_days.additional_income_with_full_tax + current_additional_earnings_with_full_tax = ( + current_taxable_earnings_for_payment_days.additional_income_with_full_tax + ) # Get taxable unclaimed benefits unclaimed_taxable_benefits = 0 @@ -768,20 +960,32 @@ class SalarySlip(TransactionBase): # Total exemption amount based on tax exemption declaration total_exemption_amount = self.get_total_exemption_amount(payroll_period, tax_slab) - #Employee Other Incomes + # Employee Other Incomes other_incomes = self.get_income_form_other_sources(payroll_period) or 0.0 # Total taxable earnings including additional and other incomes - total_taxable_earnings = previous_taxable_earnings + current_structured_taxable_earnings + future_structured_taxable_earnings \ - + current_additional_earnings + other_incomes + unclaimed_taxable_benefits - total_exemption_amount + total_taxable_earnings = ( + previous_taxable_earnings + + current_structured_taxable_earnings + + future_structured_taxable_earnings + + current_additional_earnings + + other_incomes + + unclaimed_taxable_benefits + - total_exemption_amount + ) # Total taxable earnings without additional earnings with full tax - total_taxable_earnings_without_full_tax_addl_components = total_taxable_earnings - current_additional_earnings_with_full_tax + total_taxable_earnings_without_full_tax_addl_components = ( + total_taxable_earnings - current_additional_earnings_with_full_tax + ) # Structured tax amount total_structured_tax_amount = self.calculate_tax_by_tax_slab( - total_taxable_earnings_without_full_tax_addl_components, tax_slab) - current_structured_tax_amount = (total_structured_tax_amount - previous_total_paid_taxes) / remaining_sub_periods + total_taxable_earnings_without_full_tax_addl_components, tax_slab + ) + current_structured_tax_amount = ( + total_structured_tax_amount - previous_total_paid_taxes + ) / remaining_sub_periods # Total taxable earnings with additional earnings with full tax full_tax_on_additional_earnings = 0.0 @@ -796,25 +1000,33 @@ class SalarySlip(TransactionBase): return current_tax_amount def get_income_tax_slabs(self, payroll_period): - income_tax_slab, ss_assignment_name = frappe.db.get_value("Salary Structure Assignment", - {"employee": self.employee, "salary_structure": self.salary_structure, "docstatus": 1}, ["income_tax_slab", 'name']) + income_tax_slab, ss_assignment_name = frappe.db.get_value( + "Salary Structure Assignment", + {"employee": self.employee, "salary_structure": self.salary_structure, "docstatus": 1}, + ["income_tax_slab", "name"], + ) if not income_tax_slab: - frappe.throw(_("Income Tax Slab not set in Salary Structure Assignment: {0}").format(ss_assignment_name)) + frappe.throw( + _("Income Tax Slab not set in Salary Structure Assignment: {0}").format(ss_assignment_name) + ) income_tax_slab_doc = frappe.get_doc("Income Tax Slab", income_tax_slab) if income_tax_slab_doc.disabled: frappe.throw(_("Income Tax Slab: {0} is disabled").format(income_tax_slab)) if getdate(income_tax_slab_doc.effective_from) > getdate(payroll_period.start_date): - frappe.throw(_("Income Tax Slab must be effective on or before Payroll Period Start Date: {0}") - .format(payroll_period.start_date)) + frappe.throw( + _("Income Tax Slab must be effective on or before Payroll Period Start Date: {0}").format( + payroll_period.start_date + ) + ) return income_tax_slab_doc - def get_taxable_earnings_for_prev_period(self, start_date, end_date, allow_tax_exemption=False): - taxable_earnings = frappe.db.sql(""" + taxable_earnings = frappe.db.sql( + """ select sum(sd.amount) from `tabSalary Detail` sd join `tabSalary Slip` ss on sd.parent=ss.name @@ -826,16 +1038,15 @@ class SalarySlip(TransactionBase): and ss.employee=%(employee)s and ss.start_date between %(from_date)s and %(to_date)s and ss.end_date between %(from_date)s and %(to_date)s - """, { - "employee": self.employee, - "from_date": start_date, - "to_date": end_date - }) + """, + {"employee": self.employee, "from_date": start_date, "to_date": end_date}, + ) taxable_earnings = flt(taxable_earnings[0][0]) if taxable_earnings else 0 exempted_amount = 0 if allow_tax_exemption: - exempted_amount = frappe.db.sql(""" + exempted_amount = frappe.db.sql( + """ select sum(sd.amount) from `tabSalary Detail` sd join `tabSalary Slip` ss on sd.parent=ss.name @@ -847,18 +1058,18 @@ class SalarySlip(TransactionBase): and ss.employee=%(employee)s and ss.start_date between %(from_date)s and %(to_date)s and ss.end_date between %(from_date)s and %(to_date)s - """, { - "employee": self.employee, - "from_date": start_date, - "to_date": end_date - }) + """, + {"employee": self.employee, "from_date": start_date, "to_date": end_date}, + ) exempted_amount = flt(exempted_amount[0][0]) if exempted_amount else 0 return taxable_earnings - exempted_amount def get_tax_paid_in_period(self, start_date, end_date, tax_component): # find total_tax_paid, tax paid for benefit, additional_salary - total_tax_paid = flt(frappe.db.sql(""" + total_tax_paid = flt( + frappe.db.sql( + """ select sum(sd.amount) from @@ -871,16 +1082,21 @@ class SalarySlip(TransactionBase): and ss.employee=%(employee)s and ss.start_date between %(from_date)s and %(to_date)s and ss.end_date between %(from_date)s and %(to_date)s - """, { - "salary_component": tax_component, - "employee": self.employee, - "from_date": start_date, - "to_date": end_date - })[0][0]) + """, + { + "salary_component": tax_component, + "employee": self.employee, + "from_date": start_date, + "to_date": end_date, + }, + )[0][0] + ) return total_tax_paid - def get_taxable_earnings(self, allow_tax_exemption=False, based_on_payment_days=0): + def get_taxable_earnings( + self, allow_tax_exemption=False, based_on_payment_days=0, payroll_period=None + ): joining_date, relieving_date = self.get_joining_and_relieving_dates() taxable_earnings = 0 @@ -890,7 +1106,9 @@ class SalarySlip(TransactionBase): for earning in self.earnings: if based_on_payment_days: - amount, additional_amount = self.get_amount_based_on_payment_days(earning, joining_date, relieving_date) + amount, additional_amount = self.get_amount_based_on_payment_days( + earning, joining_date, relieving_date + ) else: if earning.additional_amount: amount, additional_amount = earning.amount, earning.additional_amount @@ -901,13 +1119,14 @@ class SalarySlip(TransactionBase): if earning.is_flexible_benefit: flexi_benefits += amount else: - taxable_earnings += (amount - additional_amount) + taxable_earnings += amount - additional_amount additional_income += additional_amount # Get additional amount based on future recurring additional salary if additional_amount and earning.is_recurring_additional_salary: - additional_income += self.get_future_recurring_additional_amount(earning.additional_salary, - earning.additional_amount) # Used earning.additional_amount to consider the amount for the full month + additional_income += self.get_future_recurring_additional_amount( + earning.additional_salary, earning.additional_amount, payroll_period + ) # Used earning.additional_amount to consider the amount for the full month if earning.deduct_full_tax_on_selected_payroll_date: additional_income_with_full_tax += additional_amount @@ -917,59 +1136,104 @@ class SalarySlip(TransactionBase): if ded.exempted_from_income_tax: amount, additional_amount = ded.amount, ded.additional_amount if based_on_payment_days: - amount, additional_amount = self.get_amount_based_on_payment_days(ded, joining_date, relieving_date) + amount, additional_amount = self.get_amount_based_on_payment_days( + ded, joining_date, relieving_date + ) taxable_earnings -= flt(amount - additional_amount) additional_income -= additional_amount if additional_amount and ded.is_recurring_additional_salary: - additional_income -= self.get_future_recurring_additional_amount(ded.additional_salary, - ded.additional_amount) # Used ded.additional_amount to consider the amount for the full month + additional_income -= self.get_future_recurring_additional_amount( + ded.additional_salary, ded.additional_amount, payroll_period + ) # Used ded.additional_amount to consider the amount for the full month - return frappe._dict({ - "taxable_earnings": taxable_earnings, - "additional_income": additional_income, - "additional_income_with_full_tax": additional_income_with_full_tax, - "flexi_benefits": flexi_benefits - }) + return frappe._dict( + { + "taxable_earnings": taxable_earnings, + "additional_income": additional_income, + "additional_income_with_full_tax": additional_income_with_full_tax, + "flexi_benefits": flexi_benefits, + } + ) - def get_future_recurring_additional_amount(self, additional_salary, monthly_additional_amount): + def get_future_recurring_additional_amount( + self, additional_salary, monthly_additional_amount, payroll_period + ): future_recurring_additional_amount = 0 - to_date = frappe.db.get_value("Additional Salary", additional_salary, 'to_date') + to_date = frappe.db.get_value("Additional Salary", additional_salary, "to_date") + # future month count excluding current - future_recurring_period = (getdate(to_date).month - getdate(self.start_date).month) + from_date, to_date = getdate(self.start_date), getdate(to_date) + + # If recurring period end date is beyond the payroll period, + # last day of payroll period should be considered for recurring period calculation + if getdate(to_date) > getdate(payroll_period.end_date): + to_date = getdate(payroll_period.end_date) + + future_recurring_period = ((to_date.year - from_date.year) * 12) + ( + to_date.month - from_date.month + ) + if future_recurring_period > 0: - future_recurring_additional_amount = monthly_additional_amount * future_recurring_period # Used earning.additional_amount to consider the amount for the full month + future_recurring_additional_amount = ( + monthly_additional_amount * future_recurring_period + ) # Used earning.additional_amount to consider the amount for the full month return future_recurring_additional_amount def get_amount_based_on_payment_days(self, row, joining_date, relieving_date): amount, additional_amount = row.amount, row.additional_amount - if (self.salary_structure and - cint(row.depends_on_payment_days) and cint(self.total_working_days) - and not (row.additional_salary and row.default_amount) # to identify overwritten additional salary - and (not self.salary_slip_based_on_timesheet or - getdate(self.start_date) < joining_date or - (relieving_date and getdate(self.end_date) > relieving_date) - )): - additional_amount = flt((flt(row.additional_amount) * flt(self.payment_days) - / cint(self.total_working_days)), row.precision("additional_amount")) - amount = flt((flt(row.default_amount) * flt(self.payment_days) - / cint(self.total_working_days)), row.precision("amount")) + additional_amount + timesheet_component = frappe.db.get_value( + "Salary Structure", self.salary_structure, "salary_component" + ) - elif not self.payment_days and not self.salary_slip_based_on_timesheet and cint(row.depends_on_payment_days): + if ( + self.salary_structure + and cint(row.depends_on_payment_days) + and cint(self.total_working_days) + and not ( + row.additional_salary and row.default_amount + ) # to identify overwritten additional salary + and ( + row.salary_component != timesheet_component + or getdate(self.start_date) < joining_date + or (relieving_date and getdate(self.end_date) > relieving_date) + ) + ): + additional_amount = flt( + (flt(row.additional_amount) * flt(self.payment_days) / cint(self.total_working_days)), + row.precision("additional_amount"), + ) + amount = ( + flt( + (flt(row.default_amount) * flt(self.payment_days) / cint(self.total_working_days)), + row.precision("amount"), + ) + + additional_amount + ) + + elif ( + not self.payment_days + and row.salary_component != timesheet_component + and cint(row.depends_on_payment_days) + ): amount, additional_amount = 0, 0 elif not row.amount: amount = flt(row.default_amount) + flt(row.additional_amount) # apply rounding - if frappe.get_cached_value("Salary Component", row.salary_component, "round_to_the_nearest_integer"): - amount, additional_amount = rounded(amount), rounded(additional_amount) + if frappe.get_cached_value( + "Salary Component", row.salary_component, "round_to_the_nearest_integer" + ): + amount, additional_amount = rounded(amount or 0), rounded(additional_amount or 0) return amount, additional_amount def calculate_unclaimed_taxable_benefits(self, payroll_period): # get total sum of benefits paid - total_benefits_paid = flt(frappe.db.sql(""" + total_benefits_paid = flt( + frappe.db.sql( + """ select sum(sd.amount) from `tabSalary Detail` sd join `tabSalary Slip` ss on sd.parent=ss.name where @@ -980,21 +1244,29 @@ class SalarySlip(TransactionBase): and ss.employee=%(employee)s and ss.start_date between %(start_date)s and %(end_date)s and ss.end_date between %(start_date)s and %(end_date)s - """, { - "employee": self.employee, - "start_date": payroll_period.start_date, - "end_date": self.start_date - })[0][0]) + """, + { + "employee": self.employee, + "start_date": payroll_period.start_date, + "end_date": self.start_date, + }, + )[0][0] + ) # get total benefits claimed - total_benefits_claimed = flt(frappe.db.sql(""" + total_benefits_claimed = flt( + frappe.db.sql( + """ select sum(claimed_amount) from `tabEmployee Benefit Claim` where docstatus=1 and employee=%s and claim_date between %s and %s - """, (self.employee, payroll_period.start_date, self.end_date))[0][0]) + """, + (self.employee, payroll_period.start_date, self.end_date), + )[0][0] + ) return total_benefits_paid - total_benefits_claimed @@ -1002,15 +1274,19 @@ class SalarySlip(TransactionBase): total_exemption_amount = 0 if tax_slab.allow_tax_exemption: if self.deduct_tax_for_unsubmitted_tax_exemption_proof: - exemption_proof = frappe.db.get_value("Employee Tax Exemption Proof Submission", + exemption_proof = frappe.db.get_value( + "Employee Tax Exemption Proof Submission", {"employee": self.employee, "payroll_period": payroll_period.name, "docstatus": 1}, - ["exemption_amount"]) + ["exemption_amount"], + ) if exemption_proof: total_exemption_amount = exemption_proof else: - declaration = frappe.db.get_value("Employee Tax Exemption Declaration", + declaration = frappe.db.get_value( + "Employee Tax Exemption Declaration", {"employee": self.employee, "payroll_period": payroll_period.name, "docstatus": 1}, - ["total_exemption_amount"]) + ["total_exemption_amount"], + ) if declaration: total_exemption_amount = declaration @@ -1019,30 +1295,32 @@ class SalarySlip(TransactionBase): return total_exemption_amount def get_income_form_other_sources(self, payroll_period): - return frappe.get_all("Employee Other Income", + return frappe.get_all( + "Employee Other Income", filters={ "employee": self.employee, "payroll_period": payroll_period.name, "company": self.company, - "docstatus": 1 + "docstatus": 1, }, - fields="SUM(amount) as total_amount" + fields="SUM(amount) as total_amount", )[0].total_amount def calculate_tax_by_tax_slab(self, annual_taxable_earning, tax_slab): - data = self.get_data_for_eval() + data, default_data = self.get_data_for_eval() data.update({"annual_taxable_earning": annual_taxable_earning}) tax_amount = 0 for slab in tax_slab.slabs: - if slab.condition and not self.eval_tax_slab_condition(slab.condition, data): + cond = cstr(slab.condition).strip() + if cond and not self.eval_tax_slab_condition(cond, data): continue if not slab.to_amount and annual_taxable_earning >= slab.from_amount: - tax_amount += (annual_taxable_earning - slab.from_amount + 1) * slab.percent_deduction *.01 + tax_amount += (annual_taxable_earning - slab.from_amount + 1) * slab.percent_deduction * 0.01 continue if annual_taxable_earning >= slab.from_amount and annual_taxable_earning < slab.to_amount: - tax_amount += (annual_taxable_earning - slab.from_amount + 1) * slab.percent_deduction *.01 + tax_amount += (annual_taxable_earning - slab.from_amount + 1) * slab.percent_deduction * 0.01 elif annual_taxable_earning >= slab.from_amount and annual_taxable_earning >= slab.to_amount: - tax_amount += (slab.to_amount - slab.from_amount + 1) * slab.percent_deduction * .01 + tax_amount += (slab.to_amount - slab.from_amount + 1) * slab.percent_deduction * 0.01 # other taxes and charges on income tax for d in tax_slab.other_taxes_and_charges: @@ -1062,8 +1340,10 @@ class SalarySlip(TransactionBase): if condition: return frappe.safe_eval(condition, self.whitelisted_globals, data) except NameError as err: - frappe.throw(_("{0}
This error can be due to missing or deleted field.").format(err), - title=_("Name error")) + frappe.throw( + _("{0}
This error can be due to missing or deleted field.").format(err), + title=_("Name error"), + ) except SyntaxError as err: frappe.throw(_("Syntax error in condition: {0}").format(err)) except Exception as e: @@ -1071,8 +1351,9 @@ class SalarySlip(TransactionBase): raise def get_component_totals(self, component_type, depends_on_payment_days=0): - joining_date, relieving_date = frappe.get_cached_value("Employee", self.employee, - ["date_of_joining", "relieving_date"]) + joining_date, relieving_date = frappe.get_cached_value( + "Employee", self.employee, ["date_of_joining", "relieving_date"] + ) total = 0.0 for d in self.get(component_type): @@ -1085,70 +1366,133 @@ class SalarySlip(TransactionBase): return total def get_joining_and_relieving_dates(self): - joining_date, relieving_date = frappe.get_cached_value("Employee", self.employee, - ["date_of_joining", "relieving_date"]) + joining_date, relieving_date = frappe.get_cached_value( + "Employee", self.employee, ["date_of_joining", "relieving_date"] + ) if not relieving_date: relieving_date = getdate(self.end_date) if not joining_date: - frappe.throw(_("Please set the Date Of Joining for employee {0}").format(frappe.bold(self.employee_name))) + frappe.throw( + _("Please set the Date Of Joining for employee {0}").format(frappe.bold(self.employee_name)) + ) return joining_date, relieving_date - def set_loan_repayment(self): + def add_applicable_loans(self): self.total_loan_repayment = 0 self.total_interest_amount = 0 self.total_principal_amount = 0 - if not self.get('loans'): - for loan in self.get_loan_details(): + loans = [d.loan for d in self.get("loans")] + for loan in self.get_loan_details(): + if loan.name not in loans: amounts = calculate_amounts(loan.name, self.posting_date, "Regular Payment") + if ( + amounts["interest_amount"] + amounts["payable_principal_amount"] + > amounts["written_off_amount"] + ): + if amounts["interest_amount"] > amounts["written_off_amount"]: + amounts["interest_amount"] -= amounts["written_off_amount"] + amounts["written_off_amount"] = 0 + else: + amounts["written_off_amount"] -= amounts["interest_amount"] + amounts["interest_amount"] = 0 - if amounts['interest_amount'] or amounts['payable_principal_amount']: - self.append('loans', { - 'loan': loan.name, - 'total_payment': amounts['interest_amount'] + amounts['payable_principal_amount'], - 'interest_amount': amounts['interest_amount'], - 'principal_amount': amounts['payable_principal_amount'], - 'loan_account': loan.loan_account, - 'interest_income_account': loan.interest_income_account - }) + if amounts["payable_principal_amount"] > amounts["written_off_amount"]: + amounts["payable_principal_amount"] -= amounts["written_off_amount"] + amounts["written_off_amount"] = 0 + else: + amounts["written_off_amount"] -= amounts["payable_principal_amount"] + amounts["payable_principal_amount"] = 0 - for payment in self.get('loans'): + self.append( + "loans", + { + "loan": loan.name, + "interest_amount": amounts["interest_amount"], + "principal_amount": amounts["payable_principal_amount"], + "total_payment": amounts["interest_amount"] + amounts["payable_principal_amount"] + if not loan.manually_update_paid_amount_in_salary_slip + else 0, + "loan_account": loan.loan_account, + "interest_income_account": loan.interest_income_account, + }, + ) + + for payment in self.get("loans"): amounts = calculate_amounts(payment.loan, self.posting_date, "Regular Payment") - total_amount = amounts['interest_amount'] + amounts['payable_principal_amount'] - if payment.total_payment > total_amount: - frappe.throw(_("""Row {0}: Paid amount {1} is greater than pending accrued amount {2} against loan {3}""") - .format(payment.idx, frappe.bold(payment.total_payment), - frappe.bold(total_amount), frappe.bold(payment.loan))) + total_amount = amounts["interest_amount"] + amounts["payable_principal_amount"] + if flt(payment.total_payment) > total_amount: + frappe.throw( + _( + """Row {0}: Paid amount {1} is greater than pending accrued amount {2} against loan {3}""" + ).format( + payment.idx, + frappe.bold(payment.total_payment), + frappe.bold(total_amount), + frappe.bold(payment.loan), + ) + ) - self.total_interest_amount += payment.interest_amount - self.total_principal_amount += payment.principal_amount + self.total_interest_amount += flt(payment.interest_amount) + self.total_principal_amount += flt(payment.principal_amount) - self.total_loan_repayment += payment.total_payment + self.total_loan_repayment += flt(payment.total_payment) def get_loan_details(self): - return frappe.get_all("Loan", - fields=["name", "interest_income_account", "loan_account", "loan_type"], - filters = { + loan_details = frappe.get_all( + "Loan", + fields=[ + "name", + "interest_income_account", + "loan_account", + "loan_type", + "is_term_loan", + "manually_update_paid_amount_in_salary_slip", + ], + filters={ "applicant": self.employee, "docstatus": 1, "repay_from_salary": 1, - "company": self.company - }) + "company": self.company, + }, + ) + + if loan_details: + for loan in loan_details: + if loan.is_term_loan: + process_loan_interest_accrual_for_term_loans( + posting_date=self.posting_date, loan_type=loan.loan_type, loan=loan.name + ) + + return loan_details def make_loan_repayment_entry(self): + payroll_payable_account = get_payroll_payable_account(self.company, self.payroll_entry) for loan in self.loans: - repayment_entry = create_repayment_entry(loan.loan, self.employee, - self.company, self.posting_date, loan.loan_type, "Regular Payment", loan.interest_amount, - loan.principal_amount, loan.total_payment) + if flt(loan.total_payment) > 0: + repayment_entry = create_repayment_entry( + loan.loan, + self.employee, + self.company, + self.posting_date, + loan.loan_type, + "Regular Payment", + loan.interest_amount, + loan.principal_amount, + loan.total_payment, + payroll_payable_account=payroll_payable_account, + ) - repayment_entry.save() - repayment_entry.submit() + repayment_entry.save() + repayment_entry.submit() - frappe.db.set_value("Salary Slip Loan", loan.name, "loan_repayment_entry", repayment_entry.name) + frappe.db.set_value( + "Salary Slip Loan", loan.name, "loan_repayment_entry", repayment_entry.name + ) def cancel_loan_repayment_entry(self): for loan in self.loans: @@ -1164,19 +1508,23 @@ class SalarySlip(TransactionBase): if payroll_settings.encrypt_salary_slips_in_emails: password = generate_password_for_pdf(payroll_settings.password_policy, self.employee) message += """
Note: Your salary slip is password protected, - the password to unlock the PDF is of the format {0}. """.format(payroll_settings.password_policy) + the password to unlock the PDF is of the format {0}. """.format( + payroll_settings.password_policy + ) if receiver: email_args = { "recipients": [receiver], "message": _(message), - "subject": 'Salary Slip - from {0} to {1}'.format(self.start_date, self.end_date), - "attachments": [frappe.attach_print(self.doctype, self.name, file_name=self.name, password=password)], + "subject": "Salary Slip - from {0} to {1}".format(self.start_date, self.end_date), + "attachments": [ + frappe.attach_print(self.doctype, self.name, file_name=self.name, password=password) + ], "reference_doctype": self.doctype, - "reference_name": self.name - } + "reference_name": self.name, + } if not frappe.flags.in_test: - enqueue(method=frappe.sendmail, queue='short', timeout=300, is_async=True, **email_args) + enqueue(method=frappe.sendmail, queue="short", timeout=300, is_async=True, **email_args) else: frappe.sendmail(**email_args) else: @@ -1185,21 +1533,20 @@ class SalarySlip(TransactionBase): def update_status(self, salary_slip=None): for data in self.timesheets: if data.time_sheet: - timesheet = frappe.get_doc('Timesheet', data.time_sheet) + timesheet = frappe.get_doc("Timesheet", data.time_sheet) timesheet.salary_slip = salary_slip timesheet.flags.ignore_validate_update_after_submit = True timesheet.set_status() timesheet.save() def set_status(self, status=None): - '''Get and update status''' + """Get and update status""" if not status: status = self.get_status() self.db_set("status", status) - def process_salary_structure(self, for_preview=0): - '''Calculate salary after salary structure details have been updated''' + """Calculate salary after salary structure details have been updated""" if not self.salary_slip_based_on_timesheet: self.get_date_details() self.pull_emp_details() @@ -1207,7 +1554,9 @@ class SalarySlip(TransactionBase): self.calculate_net_pay() def pull_emp_details(self): - emp = frappe.db.get_value("Employee", self.employee, ["bank_name", "bank_ac_no", "salary_mode"], as_dict=1) + emp = frappe.db.get_value( + "Employee", self.employee, ["bank_name", "bank_ac_no", "salary_mode"], as_dict=1 + ) if emp: self.mode_of_payment = emp.salary_mode self.bank_name = emp.bank_name @@ -1237,12 +1586,12 @@ class SalarySlip(TransactionBase): def set_base_totals(self): self.base_gross_pay = flt(self.gross_pay) * flt(self.exchange_rate) self.base_total_deduction = flt(self.total_deduction) * flt(self.exchange_rate) - self.rounded_total = rounded(self.net_pay) + self.rounded_total = rounded(self.net_pay or 0) self.base_net_pay = flt(self.net_pay) * flt(self.exchange_rate) - self.base_rounded_total = rounded(self.base_net_pay) + self.base_rounded_total = rounded(self.base_net_pay or 0) self.set_net_total_in_words() - #calculate total working hours, earnings based on hourly wages and totals + # calculate total working hours, earnings based on hourly wages and totals def calculate_total_for_salary_slip_based_on_timesheet(self): if self.timesheets: self.total_working_hours = 0 @@ -1252,26 +1601,31 @@ class SalarySlip(TransactionBase): wages_amount = self.total_working_hours * self.hour_rate self.base_hour_rate = flt(self.hour_rate) * flt(self.exchange_rate) - salary_component = frappe.db.get_value('Salary Structure', {'name': self.salary_structure}, 'salary_component') + salary_component = frappe.db.get_value( + "Salary Structure", {"name": self.salary_structure}, "salary_component" + ) if self.earnings: for i, earning in enumerate(self.earnings): if earning.salary_component == salary_component: self.earnings[i].amount = wages_amount - self.gross_pay += self.earnings[i].amount + self.gross_pay += flt(self.earnings[i].amount, earning.precision("amount")) self.net_pay = flt(self.gross_pay) - flt(self.total_deduction) def compute_year_to_date(self): year_to_date = 0 period_start_date, period_end_date = self.get_year_to_date_period() - salary_slip_sum = frappe.get_list('Salary Slip', - fields = ['sum(net_pay) as net_sum', 'sum(gross_pay) as gross_sum'], - filters = {'employee' : self.employee, - 'start_date' : ['>=', period_start_date], - 'end_date' : ['<', period_end_date], - 'name': ['!=', self.name], - 'docstatus': 1 - }) + salary_slip_sum = frappe.get_list( + "Salary Slip", + fields=["sum(net_pay) as net_sum", "sum(gross_pay) as gross_sum"], + filters={ + "employee": self.employee, + "start_date": [">=", period_start_date], + "end_date": ["<", period_end_date], + "name": ["!=", self.name], + "docstatus": 1, + }, + ) year_to_date = flt(salary_slip_sum[0].net_sum) if salary_slip_sum else 0.0 gross_year_to_date = flt(salary_slip_sum[0].gross_sum) if salary_slip_sum else 0.0 @@ -1284,14 +1638,17 @@ class SalarySlip(TransactionBase): def compute_month_to_date(self): month_to_date = 0 first_day_of_the_month = get_first_day(self.start_date) - salary_slip_sum = frappe.get_list('Salary Slip', - fields = ['sum(net_pay) as sum'], - filters = {'employee' : self.employee, - 'start_date' : ['>=', first_day_of_the_month], - 'end_date' : ['<', self.start_date], - 'name': ['!=', self.name], - 'docstatus': 1 - }) + salary_slip_sum = frappe.get_list( + "Salary Slip", + fields=["sum(net_pay) as sum"], + filters={ + "employee": self.employee, + "start_date": [">=", first_day_of_the_month], + "end_date": ["<", self.start_date], + "name": ["!=", self.name], + "docstatus": 1, + }, + ) month_to_date = flt(salary_slip_sum[0].sum) if salary_slip_sum else 0.0 @@ -1301,10 +1658,11 @@ class SalarySlip(TransactionBase): def compute_component_wise_year_to_date(self): period_start_date, period_end_date = self.get_year_to_date_period() - for key in ('earnings', 'deductions'): + for key in ("earnings", "deductions"): for component in self.get(key): year_to_date = 0 - component_sum = frappe.db.sql(""" + component_sum = frappe.db.sql( + """ SELECT sum(detail.amount) as sum FROM `tabSalary Detail` as detail INNER JOIN `tabSalary Slip` as salary_slip @@ -1316,8 +1674,13 @@ class SalarySlip(TransactionBase): AND salary_slip.end_date < %(period_end_date)s AND salary_slip.name != %(docname)s AND salary_slip.docstatus = 1""", - {'employee': self.employee, 'component': component.salary_component, 'period_start_date': period_start_date, - 'period_end_date': period_end_date, 'docname': self.name} + { + "employee": self.employee, + "component": component.salary_component, + "period_start_date": period_start_date, + "period_end_date": period_end_date, + "docname": self.name, + }, ) year_to_date = flt(component_sum[0][0]) if component_sum else 0.0 @@ -1339,34 +1702,44 @@ class SalarySlip(TransactionBase): return period_start_date, period_end_date def add_leave_balances(self): - self.set('leave_details', []) + self.set("leave_details", []) - if frappe.db.get_single_value('Payroll Settings', 'show_leave_balances_in_salary_slip'): + if frappe.db.get_single_value("Payroll Settings", "show_leave_balances_in_salary_slip"): from erpnext.hr.doctype.leave_application.leave_application import get_leave_details + leave_details = get_leave_details(self.employee, self.end_date) - for leave_type, leave_values in iteritems(leave_details['leave_allocation']): - self.append('leave_details', { - 'leave_type': leave_type, - 'total_allocated_leaves': flt(leave_values.get('total_leaves')), - 'expired_leaves': flt(leave_values.get('expired_leaves')), - 'used_leaves': flt(leave_values.get('leaves_taken')), - 'pending_leaves': flt(leave_values.get('pending_leaves')), - 'available_leaves': flt(leave_values.get('remaining_leaves')) - }) + for leave_type, leave_values in iteritems(leave_details["leave_allocation"]): + self.append( + "leave_details", + { + "leave_type": leave_type, + "total_allocated_leaves": flt(leave_values.get("total_leaves")), + "expired_leaves": flt(leave_values.get("expired_leaves")), + "used_leaves": flt(leave_values.get("leaves_taken")), + "pending_leaves": flt(leave_values.get("leaves_pending_approval")), + "available_leaves": flt(leave_values.get("remaining_leaves")), + }, + ) + def unlink_ref_doc_from_salary_slip(ref_no): - linked_ss = frappe.db.sql_list("""select name from `tabSalary Slip` - where journal_entry=%s and docstatus < 2""", (ref_no)) + linked_ss = frappe.db.sql_list( + """select name from `tabSalary Slip` + where journal_entry=%s and docstatus < 2""", + (ref_no), + ) if linked_ss: for ss in linked_ss: ss_doc = frappe.get_doc("Salary Slip", ss) frappe.db.set_value("Salary Slip", ss_doc.name, "journal_entry", "") + def generate_password_for_pdf(policy_template, employee): employee = frappe.get_doc("Employee", employee) return policy_template.format(**employee.as_dict()) + def get_salary_component_data(component): return frappe.get_value( "Salary Component", @@ -1382,3 +1755,59 @@ def get_salary_component_data(component): ], as_dict=1, ) + + +def get_payroll_payable_account(company, payroll_entry): + if payroll_entry: + payroll_payable_account = frappe.db.get_value( + "Payroll Entry", payroll_entry, "payroll_payable_account" + ) + else: + payroll_payable_account = frappe.db.get_value( + "Company", company, "default_payroll_payable_account" + ) + + return payroll_payable_account + + +def get_lwp_or_ppl_for_date(date, employee, holidays): + LeaveApplication = frappe.qb.DocType("Leave Application") + LeaveType = frappe.qb.DocType("Leave Type") + + is_half_day = ( + frappe.qb.terms.Case() + .when( + ( + (LeaveApplication.half_day_date == date) + | (LeaveApplication.from_date == LeaveApplication.to_date) + ), + LeaveApplication.half_day, + ) + .else_(0) + ).as_("is_half_day") + + query = ( + frappe.qb.from_(LeaveApplication) + .inner_join(LeaveType) + .on((LeaveType.name == LeaveApplication.leave_type)) + .select( + LeaveApplication.name, + LeaveType.is_ppl, + LeaveType.fraction_of_daily_salary_per_leave, + (is_half_day), + ) + .where( + (((LeaveType.is_lwp == 1) | (LeaveType.is_ppl == 1))) + & (LeaveApplication.docstatus == 1) + & (LeaveApplication.status == "Approved") + & (LeaveApplication.employee == employee) + & ((LeaveApplication.salary_slip.isnull()) | (LeaveApplication.salary_slip == "")) + & ((LeaveApplication.from_date <= date) & (date <= LeaveApplication.to_date)) + ) + ) + + # if it's a holiday only include if leave type has "include holiday" enabled + if date in holidays: + query = query.where((LeaveType.include_holiday == "1")) + + return query.run(as_dict=True) diff --git a/erpnext/payroll/doctype/salary_slip/test_salary_slip.py b/erpnext/payroll/doctype/salary_slip/test_salary_slip.py index 0f97b7aaf85..6e3b57239d4 100644 --- a/erpnext/payroll/doctype/salary_slip/test_salary_slip.py +++ b/erpnext/payroll/doctype/salary_slip/test_salary_slip.py @@ -6,10 +6,13 @@ import random import unittest import frappe +from frappe.model.document import Document +from frappe.tests.utils import FrappeTestCase, change_settings from frappe.utils import ( add_days, add_months, cstr, + date_diff, flt, get_first_day, get_last_day, @@ -20,9 +23,11 @@ from frappe.utils.make_random import get_random import erpnext from erpnext.accounts.utils import get_fiscal_year +from erpnext.hr.doctype.attendance.attendance import mark_attendance from erpnext.hr.doctype.employee.test_employee import make_employee from erpnext.hr.doctype.leave_allocation.test_leave_allocation import create_leave_allocation from erpnext.hr.doctype.leave_type.test_leave_type import create_leave_type +from erpnext.hr.tests.test_utils import get_first_sunday from erpnext.payroll.doctype.employee_tax_exemption_declaration.test_employee_tax_exemption_declaration import ( create_exemption_category, create_payroll_period, @@ -31,45 +36,62 @@ from erpnext.payroll.doctype.payroll_entry.payroll_entry import get_month_detail from erpnext.payroll.doctype.salary_structure.salary_structure import make_salary_slip -class TestSalarySlip(unittest.TestCase): +class TestSalarySlip(FrappeTestCase): def setUp(self): setup_test() + frappe.flags.pop("via_payroll_entry", None) def tearDown(self): frappe.db.set_value("Payroll Settings", None, "include_holidays_in_total_working_days", 0) frappe.set_user("Administrator") + @change_settings( + "Payroll Settings", {"payroll_based_on": "Attendance", "daily_wages_fraction_for_half_day": 0.75} + ) def test_payment_days_based_on_attendance(self): - from erpnext.hr.doctype.attendance.attendance import mark_attendance - no_of_days = self.get_no_of_days() - - # Payroll based on attendance - frappe.db.set_value("Payroll Settings", None, "payroll_based_on", "Attendance") - frappe.db.set_value("Payroll Settings", None, "daily_wages_fraction_for_half_day", 0.75) + no_of_days = get_no_of_days() emp_id = make_employee("test_payment_days_based_on_attendance@salary.com") frappe.db.set_value("Employee", emp_id, {"relieving_date": None, "status": "Active"}) frappe.db.set_value("Leave Type", "Leave Without Pay", "include_holiday", 0) - month_start_date = get_first_day(nowdate()) - month_end_date = get_last_day(nowdate()) + first_sunday = get_first_sunday() - first_sunday = frappe.db.sql(""" - select holiday_date from `tabHoliday` - where parent = 'Salary Slip Test Holiday List' - and holiday_date between %s and %s - order by holiday_date - """, (month_start_date, month_end_date))[0][0] + mark_attendance(emp_id, first_sunday, "Absent", ignore_validate=True) # invalid lwp + mark_attendance( + emp_id, add_days(first_sunday, 1), "Absent", ignore_validate=True + ) # counted as absent + mark_attendance( + emp_id, + add_days(first_sunday, 2), + "Half Day", + leave_type="Leave Without Pay", + ignore_validate=True, + ) # valid 0.75 lwp + mark_attendance( + emp_id, + add_days(first_sunday, 3), + "On Leave", + leave_type="Leave Without Pay", + ignore_validate=True, + ) # valid lwp + mark_attendance( + emp_id, add_days(first_sunday, 4), "On Leave", leave_type="Casual Leave", ignore_validate=True + ) # invalid lwp + mark_attendance( + emp_id, + add_days(first_sunday, 7), + "On Leave", + leave_type="Leave Without Pay", + ignore_validate=True, + ) # invalid lwp - mark_attendance(emp_id, first_sunday, 'Absent', ignore_validate=True) # invalid lwp - mark_attendance(emp_id, add_days(first_sunday, 1), 'Absent', ignore_validate=True) # counted as absent - mark_attendance(emp_id, add_days(first_sunday, 2), 'Half Day', leave_type='Leave Without Pay', ignore_validate=True) # valid 0.75 lwp - mark_attendance(emp_id, add_days(first_sunday, 3), 'On Leave', leave_type='Leave Without Pay', ignore_validate=True) # valid lwp - mark_attendance(emp_id, add_days(first_sunday, 4), 'On Leave', leave_type='Casual Leave', ignore_validate=True) # invalid lwp - mark_attendance(emp_id, add_days(first_sunday, 7), 'On Leave', leave_type='Leave Without Pay', ignore_validate=True) # invalid lwp - - ss = make_employee_salary_slip("test_payment_days_based_on_attendance@salary.com", "Monthly", "Test Payment Based On Attendence") + ss = make_employee_salary_slip( + "test_payment_days_based_on_attendance@salary.com", + "Monthly", + "Test Payment Based On Attendence", + ) self.assertEqual(ss.leave_without_pay, 1.25) self.assertEqual(ss.absent_days, 1) @@ -79,51 +101,194 @@ class TestSalarySlip(unittest.TestCase): self.assertEqual(ss.payment_days, days_in_month - no_of_holidays - 2.25) - #Gross pay calculation based on attendances - gross_pay = 78000 - ((78000 / (days_in_month - no_of_holidays)) * flt(ss.leave_without_pay + ss.absent_days)) + # Gross pay calculation based on attendances + gross_pay = 78000 - ( + (78000 / (days_in_month - no_of_holidays)) * flt(ss.leave_without_pay + ss.absent_days) + ) self.assertEqual(ss.gross_pay, gross_pay) - frappe.db.set_value("Payroll Settings", None, "payroll_based_on", "Leave") + @change_settings( + "Payroll Settings", + { + "payroll_based_on": "Attendance", + "consider_unmarked_attendance_as": "Absent", + "include_holidays_in_total_working_days": True, + }, + ) + def test_payment_days_for_mid_joinee_including_holidays(self): + no_of_days = get_no_of_days() + month_start_date, month_end_date = get_first_day(nowdate()), get_last_day(nowdate()) + new_emp_id = make_employee("test_payment_days_based_on_joining_date@salary.com") + joining_date, relieving_date = add_days(month_start_date, 3), add_days(month_end_date, -5) + + for days in range(date_diff(month_end_date, month_start_date) + 1): + date = add_days(month_start_date, days) + mark_attendance(new_emp_id, date, "Present", ignore_validate=True) + + # Case 1: relieving in mid month + frappe.db.set_value( + "Employee", + new_emp_id, + {"date_of_joining": month_start_date, "relieving_date": relieving_date, "status": "Active"}, + ) + + new_ss = make_employee_salary_slip( + "test_payment_days_based_on_joining_date@salary.com", + "Monthly", + "Test Payment Based On Attendence", + ) + self.assertEqual(new_ss.payment_days, no_of_days[0] - 5) + + # Case 2: joining in mid month + frappe.db.set_value( + "Employee", + new_emp_id, + {"date_of_joining": joining_date, "relieving_date": month_end_date, "status": "Active"}, + ) + + frappe.delete_doc("Salary Slip", new_ss.name, force=True) + new_ss = make_employee_salary_slip( + "test_payment_days_based_on_joining_date@salary.com", + "Monthly", + "Test Payment Based On Attendence", + ) + self.assertEqual(new_ss.payment_days, no_of_days[0] - 3) + + # Case 3: joining and relieving in mid-month + frappe.db.set_value( + "Employee", + new_emp_id, + {"date_of_joining": joining_date, "relieving_date": relieving_date, "status": "Left"}, + ) + + frappe.delete_doc("Salary Slip", new_ss.name, force=True) + new_ss = make_employee_salary_slip( + "test_payment_days_based_on_joining_date@salary.com", + "Monthly", + "Test Payment Based On Attendence", + ) + + self.assertEqual(new_ss.total_working_days, no_of_days[0]) + self.assertEqual(new_ss.payment_days, no_of_days[0] - 8) + + @change_settings( + "Payroll Settings", + { + "payroll_based_on": "Attendance", + "consider_unmarked_attendance_as": "Absent", + "include_holidays_in_total_working_days": True, + }, + ) + def test_payment_days_for_mid_joinee_including_holidays_and_unmarked_days(self): + # tests mid month joining and relieving along with unmarked days + from erpnext.hr.doctype.holiday_list.holiday_list import is_holiday + + no_of_days = get_no_of_days() + month_start_date, month_end_date = get_first_day(nowdate()), get_last_day(nowdate()) + + new_emp_id = make_employee("test_payment_days_based_on_joining_date@salary.com") + joining_date, relieving_date = add_days(month_start_date, 3), add_days(month_end_date, -5) + holidays = 0 + + for days in range(date_diff(relieving_date, joining_date) + 1): + date = add_days(joining_date, days) + if not is_holiday("Salary Slip Test Holiday List", date): + mark_attendance(new_emp_id, date, "Present", ignore_validate=True) + else: + holidays += 1 + + frappe.db.set_value( + "Employee", + new_emp_id, + {"date_of_joining": joining_date, "relieving_date": relieving_date, "status": "Left"}, + ) + + new_ss = make_employee_salary_slip( + "test_payment_days_based_on_joining_date@salary.com", + "Monthly", + "Test Payment Based On Attendence", + ) + + self.assertEqual(new_ss.total_working_days, no_of_days[0]) + self.assertEqual(new_ss.payment_days, no_of_days[0] - holidays - 8) + + @change_settings( + "Payroll Settings", + { + "payroll_based_on": "Attendance", + "consider_unmarked_attendance_as": "Absent", + "include_holidays_in_total_working_days": False, + }, + ) + def test_payment_days_for_mid_joinee_excluding_holidays(self): + from erpnext.hr.doctype.holiday_list.holiday_list import is_holiday + + no_of_days = get_no_of_days() + month_start_date, month_end_date = get_first_day(nowdate()), get_last_day(nowdate()) + + new_emp_id = make_employee("test_payment_days_based_on_joining_date@salary.com") + joining_date, relieving_date = add_days(month_start_date, 3), add_days(month_end_date, -5) + frappe.db.set_value( + "Employee", + new_emp_id, + {"date_of_joining": joining_date, "relieving_date": relieving_date, "status": "Left"}, + ) + + holidays = 0 + + for days in range(date_diff(relieving_date, joining_date) + 1): + date = add_days(joining_date, days) + if not is_holiday("Salary Slip Test Holiday List", date): + mark_attendance(new_emp_id, date, "Present", ignore_validate=True) + else: + holidays += 1 + + new_ss = make_employee_salary_slip( + "test_payment_days_based_on_joining_date@salary.com", + "Monthly", + "Test Payment Based On Attendence", + ) + + self.assertEqual(new_ss.total_working_days, no_of_days[0] - no_of_days[1]) + self.assertEqual(new_ss.payment_days, no_of_days[0] - holidays - 8) + + @change_settings("Payroll Settings", {"payroll_based_on": "Leave"}) def test_payment_days_based_on_leave_application(self): - no_of_days = self.get_no_of_days() - - # Payroll based on attendance - frappe.db.set_value("Payroll Settings", None, "payroll_based_on", "Leave") + no_of_days = get_no_of_days() emp_id = make_employee("test_payment_days_based_on_leave_application@salary.com") frappe.db.set_value("Employee", emp_id, {"relieving_date": None, "status": "Active"}) frappe.db.set_value("Leave Type", "Leave Without Pay", "include_holiday", 0) - month_start_date = get_first_day(nowdate()) - month_end_date = get_last_day(nowdate()) - - first_sunday = frappe.db.sql(""" - select holiday_date from `tabHoliday` - where parent = 'Salary Slip Test Holiday List' - and holiday_date between %s and %s - order by holiday_date - """, (month_start_date, month_end_date))[0][0] - + first_sunday = get_first_sunday() make_leave_application(emp_id, first_sunday, add_days(first_sunday, 3), "Leave Without Pay") - leave_type_ppl = create_leave_type(leave_type_name="Test Partially Paid Leave", is_ppl = 1) + leave_type_ppl = create_leave_type(leave_type_name="Test Partially Paid Leave", is_ppl=1) leave_type_ppl.save() alloc = create_leave_allocation( - employee = emp_id, from_date = add_days(first_sunday, 4), - to_date = add_days(first_sunday, 10), new_leaves_allocated = 3, - leave_type = "Test Partially Paid Leave") + employee=emp_id, + from_date=add_days(first_sunday, 4), + to_date=add_days(first_sunday, 10), + new_leaves_allocated=3, + leave_type="Test Partially Paid Leave", + ) alloc.save() alloc.submit() - #two day leave ppl with fraction_of_daily_salary_per_leave = 0.5 equivalent to single day lwp - make_leave_application(emp_id, add_days(first_sunday, 4), add_days(first_sunday, 5), "Test Partially Paid Leave") - - ss = make_employee_salary_slip("test_payment_days_based_on_leave_application@salary.com", "Monthly", "Test Payment Based On Leave Application") + # two day leave ppl with fraction_of_daily_salary_per_leave = 0.5 equivalent to single day lwp + make_leave_application( + emp_id, add_days(first_sunday, 4), add_days(first_sunday, 5), "Test Partially Paid Leave" + ) + ss = make_employee_salary_slip( + "test_payment_days_based_on_leave_application@salary.com", + "Monthly", + "Test Payment Based On Leave Application", + ) self.assertEqual(ss.leave_without_pay, 4) @@ -132,39 +297,87 @@ class TestSalarySlip(unittest.TestCase): self.assertEqual(ss.payment_days, days_in_month - no_of_holidays - 4) - frappe.db.set_value("Payroll Settings", None, "payroll_based_on", "Leave") + @change_settings("Payroll Settings", {"payroll_based_on": "Attendance"}) + def test_payment_days_in_salary_slip_based_on_timesheet(self): + from erpnext.hr.doctype.attendance.attendance import mark_attendance + from erpnext.projects.doctype.timesheet.test_timesheet import ( + make_salary_structure_for_timesheet, + make_timesheet, + ) + from erpnext.projects.doctype.timesheet.timesheet import ( + make_salary_slip as make_salary_slip_for_timesheet, + ) + emp = make_employee( + "test_employee_timesheet@salary.com", + company="_Test Company", + holiday_list="Salary Slip Test Holiday List", + ) + frappe.db.set_value("Employee", emp, {"relieving_date": None, "status": "Active"}) + + # mark attendance + first_sunday = get_first_sunday() + mark_attendance( + emp, add_days(first_sunday, 1), "Absent", ignore_validate=True + ) # counted as absent + + # salary structure based on timesheet + make_salary_structure_for_timesheet(emp) + timesheet = make_timesheet(emp, simulate=True, is_billable=1) + salary_slip = make_salary_slip_for_timesheet(timesheet.name) + salary_slip.start_date = get_first_day(nowdate()) + salary_slip.end_date = get_last_day(nowdate()) + salary_slip.save() + salary_slip.submit() + salary_slip.reload() + + no_of_days = get_no_of_days() + days_in_month = no_of_days[0] + no_of_holidays = no_of_days[1] + + self.assertEqual(salary_slip.payment_days, days_in_month - no_of_holidays - 1) + + # component calculation based on attendance (payment days) + amount, precision = None, None + + for row in salary_slip.earnings: + if row.salary_component == "Basic Salary": + amount = row.amount + precision = row.precision("amount") + break + expected_amount = flt( + (50000 * salary_slip.payment_days / salary_slip.total_working_days), precision + ) + + self.assertEqual(amount, expected_amount) + + @change_settings("Payroll Settings", {"payroll_based_on": "Attendance"}) def test_component_amount_dependent_on_another_payment_days_based_component(self): from erpnext.hr.doctype.attendance.attendance import mark_attendance from erpnext.payroll.doctype.salary_structure.test_salary_structure import ( create_salary_structure_assignment, ) - no_of_days = self.get_no_of_days() - # Payroll based on attendance - frappe.db.set_value("Payroll Settings", None, "payroll_based_on", "Attendance") - + no_of_days = get_no_of_days() salary_structure = make_salary_structure_for_payment_days_based_component_dependency() employee = make_employee("test_payment_days_based_component@salary.com", company="_Test Company") # base = 50000 - create_salary_structure_assignment(employee, salary_structure.name, company="_Test Company", currency="INR") + create_salary_structure_assignment( + employee, salary_structure.name, company="_Test Company", currency="INR" + ) # mark employee absent for a day since this case works fine if payment days are equal to working days - month_start_date = get_first_day(nowdate()) - month_end_date = get_last_day(nowdate()) + first_sunday = get_first_sunday() - first_sunday = frappe.db.sql(""" - select holiday_date from `tabHoliday` - where parent = 'Salary Slip Test Holiday List' - and holiday_date between %s and %s - order by holiday_date - """, (month_start_date, month_end_date))[0][0] - - mark_attendance(employee, add_days(first_sunday, 1), 'Absent', ignore_validate=True) # counted as absent + mark_attendance( + employee, add_days(first_sunday, 1), "Absent", ignore_validate=True + ) # counted as absent # make salary slip and assert payment days - ss = make_salary_slip_for_payment_days_dependency_test("test_payment_days_based_component@salary.com", salary_structure.name) + ss = make_salary_slip_for_payment_days_dependency_test( + "test_payment_days_based_component@salary.com", salary_structure.name + ) self.assertEqual(ss.absent_days, 1) days_in_month = no_of_days[0] @@ -189,17 +402,32 @@ class TestSalarySlip(unittest.TestCase): expected_amount = flt((flt(ss.gross_pay) - payment_days_based_comp_amount) * 0.12, precision) self.assertEqual(actual_amount, expected_amount) - frappe.db.set_value("Payroll Settings", None, "payroll_based_on", "Leave") + @change_settings("Payroll Settings", {"include_holidays_in_total_working_days": 1}) def test_salary_slip_with_holidays_included(self): - no_of_days = self.get_no_of_days() - frappe.db.set_value("Payroll Settings", None, "include_holidays_in_total_working_days", 1) + no_of_days = get_no_of_days() make_employee("test_salary_slip_with_holidays_included@salary.com") - frappe.db.set_value("Employee", frappe.get_value("Employee", - {"employee_name":"test_salary_slip_with_holidays_included@salary.com"}, "name"), "relieving_date", None) - frappe.db.set_value("Employee", frappe.get_value("Employee", - {"employee_name":"test_salary_slip_with_holidays_included@salary.com"}, "name"), "status", "Active") - ss = make_employee_salary_slip("test_salary_slip_with_holidays_included@salary.com", "Monthly", "Test Salary Slip With Holidays Included") + frappe.db.set_value( + "Employee", + frappe.get_value( + "Employee", {"employee_name": "test_salary_slip_with_holidays_included@salary.com"}, "name" + ), + "relieving_date", + None, + ) + frappe.db.set_value( + "Employee", + frappe.get_value( + "Employee", {"employee_name": "test_salary_slip_with_holidays_included@salary.com"}, "name" + ), + "status", + "Active", + ) + ss = make_employee_salary_slip( + "test_salary_slip_with_holidays_included@salary.com", + "Monthly", + "Test Salary Slip With Holidays Included", + ) self.assertEqual(ss.total_working_days, no_of_days[0]) self.assertEqual(ss.payment_days, no_of_days[0]) @@ -207,15 +435,31 @@ class TestSalarySlip(unittest.TestCase): self.assertEqual(ss.earnings[1].amount, 3000) self.assertEqual(ss.gross_pay, 78000) + @change_settings("Payroll Settings", {"include_holidays_in_total_working_days": 0}) def test_salary_slip_with_holidays_excluded(self): - no_of_days = self.get_no_of_days() - frappe.db.set_value("Payroll Settings", None, "include_holidays_in_total_working_days", 0) + no_of_days = get_no_of_days() make_employee("test_salary_slip_with_holidays_excluded@salary.com") - frappe.db.set_value("Employee", frappe.get_value("Employee", - {"employee_name":"test_salary_slip_with_holidays_excluded@salary.com"}, "name"), "relieving_date", None) - frappe.db.set_value("Employee", frappe.get_value("Employee", - {"employee_name":"test_salary_slip_with_holidays_excluded@salary.com"}, "name"), "status", "Active") - ss = make_employee_salary_slip("test_salary_slip_with_holidays_excluded@salary.com", "Monthly", "Test Salary Slip With Holidays Excluded") + frappe.db.set_value( + "Employee", + frappe.get_value( + "Employee", {"employee_name": "test_salary_slip_with_holidays_excluded@salary.com"}, "name" + ), + "relieving_date", + None, + ) + frappe.db.set_value( + "Employee", + frappe.get_value( + "Employee", {"employee_name": "test_salary_slip_with_holidays_excluded@salary.com"}, "name" + ), + "status", + "Active", + ) + ss = make_employee_salary_slip( + "test_salary_slip_with_holidays_excluded@salary.com", + "Monthly", + "Test Salary Slip With Holidays Excluded", + ) self.assertEqual(ss.total_working_days, no_of_days[0] - no_of_days[1]) self.assertEqual(ss.payment_days, no_of_days[0] - no_of_days[1]) @@ -224,35 +468,34 @@ class TestSalarySlip(unittest.TestCase): self.assertEqual(ss.earnings[1].amount, 3000) self.assertEqual(ss.gross_pay, 78000) + @change_settings("Payroll Settings", {"include_holidays_in_total_working_days": 1}) def test_payment_days(self): from erpnext.payroll.doctype.salary_structure.test_salary_structure import ( create_salary_structure_assignment, ) - no_of_days = self.get_no_of_days() - # Holidays not included in working days - frappe.db.set_value("Payroll Settings", None, "include_holidays_in_total_working_days", 1) + no_of_days = get_no_of_days() # set joinng date in the same month employee = make_employee("test_payment_days@salary.com") if getdate(nowdate()).day >= 15: - relieving_date = getdate(add_days(nowdate(),-10)) - date_of_joining = getdate(add_days(nowdate(),-10)) + relieving_date = getdate(add_days(nowdate(), -10)) + date_of_joining = getdate(add_days(nowdate(), -10)) elif getdate(nowdate()).day < 15 and getdate(nowdate()).day >= 5: - date_of_joining = getdate(add_days(nowdate(),-3)) - relieving_date = getdate(add_days(nowdate(),-3)) + date_of_joining = getdate(add_days(nowdate(), -3)) + relieving_date = getdate(add_days(nowdate(), -3)) elif getdate(nowdate()).day < 5 and not getdate(nowdate()).day == 1: - date_of_joining = getdate(add_days(nowdate(),-1)) - relieving_date = getdate(add_days(nowdate(),-1)) + date_of_joining = getdate(add_days(nowdate(), -1)) + relieving_date = getdate(add_days(nowdate(), -1)) elif getdate(nowdate()).day == 1: date_of_joining = getdate(nowdate()) relieving_date = getdate(nowdate()) - frappe.db.set_value("Employee", employee, { - "date_of_joining": date_of_joining, - "relieving_date": None, - "status": "Active" - }) + frappe.db.set_value( + "Employee", + employee, + {"date_of_joining": date_of_joining, "relieving_date": None, "status": "Active"}, + ) salary_structure = "Test Payment Days" ss = make_employee_salary_slip("test_payment_days@salary.com", "Monthly", salary_structure) @@ -261,11 +504,15 @@ class TestSalarySlip(unittest.TestCase): self.assertEqual(ss.payment_days, (no_of_days[0] - getdate(date_of_joining).day + 1)) # set relieving date in the same month - frappe.db.set_value("Employee", employee, { - "date_of_joining": add_days(nowdate(),-60), - "relieving_date": relieving_date, - "status": "Left" - }) + frappe.db.set_value( + "Employee", + employee, + { + "date_of_joining": add_days(nowdate(), -60), + "relieving_date": relieving_date, + "status": "Left", + }, + ) if date_of_joining.day > 1: self.assertRaises(frappe.ValidationError, ss.save) @@ -277,30 +524,43 @@ class TestSalarySlip(unittest.TestCase): self.assertEqual(ss.total_working_days, no_of_days[0]) self.assertEqual(ss.payment_days, getdate(relieving_date).day) - frappe.db.set_value("Employee", frappe.get_value("Employee", - {"employee_name":"test_payment_days@salary.com"}, "name"), "relieving_date", None) - frappe.db.set_value("Employee", frappe.get_value("Employee", - {"employee_name":"test_payment_days@salary.com"}, "name"), "status", "Active") + frappe.db.set_value( + "Employee", + frappe.get_value("Employee", {"employee_name": "test_payment_days@salary.com"}, "name"), + "relieving_date", + None, + ) + frappe.db.set_value( + "Employee", + frappe.get_value("Employee", {"employee_name": "test_payment_days@salary.com"}, "name"), + "status", + "Active", + ) def test_employee_salary_slip_read_permission(self): make_employee("test_employee_salary_slip_read_permission@salary.com") - salary_slip_test_employee = make_employee_salary_slip("test_employee_salary_slip_read_permission@salary.com", "Monthly", "Test Employee Salary Slip Read Permission") + salary_slip_test_employee = make_employee_salary_slip( + "test_employee_salary_slip_read_permission@salary.com", + "Monthly", + "Test Employee Salary Slip Read Permission", + ) frappe.set_user("test_employee_salary_slip_read_permission@salary.com") self.assertTrue(salary_slip_test_employee.has_permission("read")) + @change_settings("Payroll Settings", {"email_salary_slip_to_employee": 1}) def test_email_salary_slip(self): - frappe.db.sql("delete from `tabEmail Queue`") + frappe.db.delete("Email Queue") - frappe.db.set_value("Payroll Settings", None, "email_salary_slip_to_employee", 1) + user_id = "test_email_salary_slip@salary.com" - make_employee("test_email_salary_slip@salary.com") - ss = make_employee_salary_slip("test_email_salary_slip@salary.com", "Monthly", "Test Salary Slip Email") + make_employee(user_id, company="_Test Company") + ss = make_employee_salary_slip(user_id, "Monthly", "Test Salary Slip Email") ss.company = "_Test Company" ss.save() ss.submit() - email_queue = frappe.db.sql("""select name from `tabEmail Queue`""") + email_queue = frappe.db.a_row_exists("Email Queue") self.assertTrue(email_queue) def test_loan_repayment_salary_slip(self): @@ -319,33 +579,59 @@ class TestSalarySlip(unittest.TestCase): create_loan_accounts() - create_loan_type("Car Loan", 500000, 8.4, + create_loan_type( + "Car Loan", + 500000, + 8.4, is_term_loan=1, - mode_of_payment='Cash', - payment_account='Payment Account - _TC', - loan_account='Loan Account - _TC', - interest_income_account='Interest Income Account - _TC', - penalty_income_account='Penalty Income Account - _TC') + mode_of_payment="Cash", + disbursement_account="Disbursement Account - _TC", + payment_account="Payment Account - _TC", + loan_account="Loan Account - _TC", + interest_income_account="Interest Income Account - _TC", + penalty_income_account="Penalty Income Account - _TC", + ) payroll_period = create_payroll_period(name="_Test Payroll Period 1", company="_Test Company") - make_salary_structure("Test Loan Repayment Salary Structure", "Monthly", employee=applicant, currency='INR', - payroll_period=payroll_period) + make_salary_structure( + "Test Loan Repayment Salary Structure", + "Monthly", + employee=applicant, + currency="INR", + payroll_period=payroll_period, + ) - frappe.db.sql("delete from tabLoan") - loan = create_loan(applicant, "Car Loan", 11000, "Repay Over Number of Periods", 20, posting_date=add_months(nowdate(), -1)) + frappe.db.sql( + "delete from tabLoan where applicant = 'test_loan_repayment_salary_slip@salary.com'" + ) + loan = create_loan( + applicant, + "Car Loan", + 11000, + "Repay Over Number of Periods", + 20, + posting_date=add_months(nowdate(), -1), + ) loan.repay_from_salary = 1 loan.submit() - make_loan_disbursement_entry(loan.name, loan.loan_amount, disbursement_date=add_months(nowdate(), -1)) + make_loan_disbursement_entry( + loan.name, loan.loan_amount, disbursement_date=add_months(nowdate(), -1) + ) process_loan_interest_accrual_for_term_loans(posting_date=nowdate()) - ss = make_employee_salary_slip("test_loan_repayment_salary_slip@salary.com", "Monthly", "Test Loan Repayment Salary Structure") + ss = make_employee_salary_slip( + "test_loan_repayment_salary_slip@salary.com", "Monthly", "Test Loan Repayment Salary Structure" + ) + + ss.loans[0].total_payment = 592 ss.submit() - self.assertEqual(ss.total_loan_repayment, 592) - self.assertEqual(ss.net_pay, (flt(ss.gross_pay) - (flt(ss.total_deduction) + flt(ss.total_loan_repayment)))) + self.assertEqual( + ss.net_pay, (flt(ss.gross_pay) - (flt(ss.total_deduction) + flt(ss.total_loan_repayment))) + ) def test_payroll_frequency(self): fiscal_year = get_fiscal_year(nowdate(), company=erpnext.get_default_company())[0] @@ -354,18 +640,22 @@ class TestSalarySlip(unittest.TestCase): for payroll_frequency in ["Monthly", "Bimonthly", "Fortnightly", "Weekly", "Daily"]: make_employee(payroll_frequency + "_test_employee@salary.com") - ss = make_employee_salary_slip(payroll_frequency + "_test_employee@salary.com", payroll_frequency, payroll_frequency + "_Test Payroll Frequency") + ss = make_employee_salary_slip( + payroll_frequency + "_test_employee@salary.com", + payroll_frequency, + payroll_frequency + "_Test Payroll Frequency", + ) if payroll_frequency == "Monthly": - self.assertEqual(ss.end_date, m['month_end_date']) + self.assertEqual(ss.end_date, m["month_end_date"]) elif payroll_frequency == "Bimonthly": if getdate(ss.start_date).day <= 15: - self.assertEqual(ss.end_date, m['month_mid_end_date']) + self.assertEqual(ss.end_date, m["month_mid_end_date"]) else: - self.assertEqual(ss.end_date, m['month_end_date']) + self.assertEqual(ss.end_date, m["month_end_date"]) elif payroll_frequency == "Fortnightly": - self.assertEqual(ss.end_date, add_days(nowdate(),13)) + self.assertEqual(ss.end_date, add_days(nowdate(), 13)) elif payroll_frequency == "Weekly": - self.assertEqual(ss.end_date, add_days(nowdate(),6)) + self.assertEqual(ss.end_date, add_days(nowdate(), 6)) elif payroll_frequency == "Daily": self.assertEqual(ss.end_date, nowdate()) @@ -373,14 +663,22 @@ class TestSalarySlip(unittest.TestCase): from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure applicant = make_employee("test_multi_currency_salary_slip@salary.com", company="_Test Company") - frappe.db.sql("""delete from `tabSalary Structure` where name='Test Multi Currency Salary Slip'""") - salary_structure = make_salary_structure("Test Multi Currency Salary Slip", "Monthly", employee=applicant, company="_Test Company", currency='USD') - salary_slip = make_salary_slip(salary_structure.name, employee = applicant) + frappe.db.sql( + """delete from `tabSalary Structure` where name='Test Multi Currency Salary Slip'""" + ) + salary_structure = make_salary_structure( + "Test Multi Currency Salary Slip", + "Monthly", + employee=applicant, + company="_Test Company", + currency="USD", + ) + salary_slip = make_salary_slip(salary_structure.name, employee=applicant) salary_slip.exchange_rate = 70 salary_slip.calculate_net_pay() self.assertEqual(salary_slip.gross_pay, 78000) - self.assertEqual(salary_slip.base_gross_pay, 78000*70) + self.assertEqual(salary_slip.base_gross_pay, 78000 * 70) def test_year_to_date_computation(self): from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure @@ -389,20 +687,36 @@ class TestSalarySlip(unittest.TestCase): payroll_period = create_payroll_period(name="_Test Payroll Period 1", company="_Test Company") - create_tax_slab(payroll_period, allow_tax_exemption=True, currency="INR", effective_date=getdate("2019-04-01"), - company="_Test Company") + create_tax_slab( + payroll_period, + allow_tax_exemption=True, + currency="INR", + effective_date=getdate("2019-04-01"), + company="_Test Company", + ) - salary_structure = make_salary_structure("Monthly Salary Structure Test for Salary Slip YTD", - "Monthly", employee=applicant, company="_Test Company", currency="INR", payroll_period=payroll_period) + salary_structure = make_salary_structure( + "Monthly Salary Structure Test for Salary Slip YTD", + "Monthly", + employee=applicant, + company="_Test Company", + currency="INR", + payroll_period=payroll_period, + ) # clear salary slip for this employee frappe.db.sql("DELETE FROM `tabSalary Slip` where employee_name = 'test_ytd@salary.com'") - create_salary_slips_for_payroll_period(applicant, salary_structure.name, - payroll_period, deduct_random=False, num=6) + create_salary_slips_for_payroll_period( + applicant, salary_structure.name, payroll_period, deduct_random=False, num=6 + ) - salary_slips = frappe.get_all('Salary Slip', fields=['year_to_date', 'net_pay'], filters={'employee_name': - 'test_ytd@salary.com'}, order_by = 'posting_date') + salary_slips = frappe.get_all( + "Salary Slip", + fields=["year_to_date", "net_pay"], + filters={"employee_name": "test_ytd@salary.com"}, + order_by="posting_date", + ) year_to_date = 0 for slip in salary_slips: @@ -417,20 +731,36 @@ class TestSalarySlip(unittest.TestCase): payroll_period = create_payroll_period(name="_Test Payroll Period 1", company="_Test Company") - create_tax_slab(payroll_period, allow_tax_exemption=True, currency="INR", effective_date=getdate("2019-04-01"), - company="_Test Company") + create_tax_slab( + payroll_period, + allow_tax_exemption=True, + currency="INR", + effective_date=getdate("2019-04-01"), + company="_Test Company", + ) - salary_structure = make_salary_structure("Monthly Salary Structure Test for Salary Slip YTD", - "Monthly", employee=applicant, company="_Test Company", currency="INR", payroll_period=payroll_period) + salary_structure = make_salary_structure( + "Monthly Salary Structure Test for Salary Slip YTD", + "Monthly", + employee=applicant, + company="_Test Company", + currency="INR", + payroll_period=payroll_period, + ) # clear salary slip for this employee frappe.db.sql("DELETE FROM `tabSalary Slip` where employee_name = '%s'" % employee_name) - create_salary_slips_for_payroll_period(applicant, salary_structure.name, - payroll_period, deduct_random=False, num=3) + create_salary_slips_for_payroll_period( + applicant, salary_structure.name, payroll_period, deduct_random=False, num=3 + ) - salary_slips = frappe.get_all("Salary Slip", fields=["name"], filters={"employee_name": - employee_name}, order_by="posting_date") + salary_slips = frappe.get_all( + "Salary Slip", + fields=["name"], + filters={"employee_name": employee_name}, + order_by="posting_date", + ) year_to_date = dict() for slip in salary_slips: @@ -461,21 +791,28 @@ class TestSalarySlip(unittest.TestCase): "Employee Tax Exemption Declaration", "Employee Tax Exemption Proof Submission", "Employee Benefit Claim", - "Salary Structure Assignment" + "Salary Structure Assignment", ] for doc in delete_docs: frappe.db.sql("delete from `tab%s` where employee='%s'" % (doc, employee)) from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure - salary_structure = make_salary_structure("Stucture to test tax", "Monthly", - other_details={"max_benefits": 100000}, test_tax=True, - employee=employee, payroll_period=payroll_period) + salary_structure = make_salary_structure( + "Stucture to test tax", + "Monthly", + other_details={"max_benefits": 100000}, + test_tax=True, + include_flexi_benefits=True, + employee=employee, + payroll_period=payroll_period, + ) # create salary slip for whole period deducting tax only on last period # to find the total tax amount paid - create_salary_slips_for_payroll_period(employee, salary_structure.name, - payroll_period, deduct_random=False) + create_salary_slips_for_payroll_period( + employee, salary_structure.name, payroll_period, deduct_random=False + ) tax_paid = get_tax_paid_in_period(employee) annual_tax = 113589.0 @@ -490,8 +827,9 @@ class TestSalarySlip(unittest.TestCase): create_exemption_declaration(employee, payroll_period.name) # create for payroll deducting in random months - data["deducted_dates"] = create_salary_slips_for_payroll_period(employee, - salary_structure.name, payroll_period) + data["deducted_dates"] = create_salary_slips_for_payroll_period( + employee, salary_structure.name, payroll_period + ) tax_paid = get_tax_paid_in_period(employee) # No proof, benefit claim sumitted, total tax paid, should not change @@ -506,12 +844,14 @@ class TestSalarySlip(unittest.TestCase): # Submit benefit claim for total 50000 data["benefit-1"] = create_benefit_claim(employee, payroll_period, 15000, "Medical Allowance") - data["benefit-2"] = create_benefit_claim(employee, payroll_period, 35000, "Leave Travel Allowance") - + data["benefit-2"] = create_benefit_claim( + employee, payroll_period, 35000, "Leave Travel Allowance" + ) frappe.db.sql("""delete from `tabSalary Slip` where employee=%s""", (employee)) - data["deducted_dates"] = create_salary_slips_for_payroll_period(employee, - salary_structure.name, payroll_period) + data["deducted_dates"] = create_salary_slips_for_payroll_period( + employee, salary_structure.name, payroll_period + ) tax_paid = get_tax_paid_in_period(employee) # total taxable income 416000, 166000 @ 5% ie. 8300 @@ -524,8 +864,9 @@ class TestSalarySlip(unittest.TestCase): # create additional salary of 150000 frappe.db.sql("""delete from `tabSalary Slip` where employee=%s""", (employee)) data["additional-1"] = create_additional_salary(employee, payroll_period, 150000) - data["deducted_dates"] = create_salary_slips_for_payroll_period(employee, - salary_structure.name, payroll_period) + data["deducted_dates"] = create_salary_slips_for_payroll_period( + employee, salary_structure.name, payroll_period + ) # total taxable income 566000, 250000 @ 5%, 66000 @ 20%, 12500 + 13200 tax_paid = get_tax_paid_in_period(employee) @@ -539,6 +880,41 @@ class TestSalarySlip(unittest.TestCase): # undelete fixture data frappe.db.rollback() + @change_settings( + "Payroll Settings", + { + "payroll_based_on": "Attendance", + "consider_unmarked_attendance_as": "Present", + "include_holidays_in_total_working_days": True, + }, + ) + def test_default_amount(self): + # Special Allowance (SA) uses another component Basic (BS) in it's formula : BD * .5 + # Basic has "Depends on Payment Days" enabled + # Test default amount for SA is based on default amount for BS (irrespective of PD) + # Test amount for SA is based on amount for BS (based on PD) + from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure + + month_start_date = get_first_day(nowdate()) + joining_date = add_days(month_start_date, 3) + employee = make_employee("test_tax_for_mid_joinee@salary.com", date_of_joining=joining_date) + + salary_structure = make_salary_structure( + "Stucture to test tax", + "Monthly", + test_tax=True, + from_date=joining_date, + employee=employee, + ) + + ss = make_salary_slip(salary_structure.name, employee=employee) + + # default amount for SA (special allowance = BS*0.5) should be based on default amount for basic + self.assertEqual(ss.earnings[2].default_amount, 25000) + self.assertEqual( + ss.earnings[2].amount, flt(ss.earnings[0].amount * 0.5, ss.earnings[0].precision("amount")) + ) + def test_tax_for_recurring_additional_salary(self): frappe.db.sql("""delete from `tabPayroll Period`""") frappe.db.sql("""delete from `tabSalary Component`""") @@ -554,20 +930,26 @@ class TestSalarySlip(unittest.TestCase): "Employee Tax Exemption Declaration", "Employee Tax Exemption Proof Submission", "Employee Benefit Claim", - "Salary Structure Assignment" + "Salary Structure Assignment", ] for doc in delete_docs: frappe.db.sql("delete from `tab%s` where employee='%s'" % (doc, employee)) from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure - salary_structure = make_salary_structure("Stucture to test tax", "Monthly", - other_details={"max_benefits": 100000}, test_tax=True, - employee=employee, payroll_period=payroll_period) + salary_structure = make_salary_structure( + "Stucture to test tax", + "Monthly", + other_details={"max_benefits": 100000}, + test_tax=True, + include_flexi_benefits=True, + employee=employee, + payroll_period=payroll_period, + ) - - create_salary_slips_for_payroll_period(employee, salary_structure.name, - payroll_period, deduct_random=False, num=3) + create_salary_slips_for_payroll_period( + employee, salary_structure.name, payroll_period, deduct_random=False, num=3 + ) tax_paid = get_tax_paid_in_period(employee) @@ -576,7 +958,7 @@ class TestSalarySlip(unittest.TestCase): frappe.db.sql("""delete from `tabSalary Slip` where employee=%s""", (employee)) - #------------------------------------ + # ------------------------------------ # Recurring additional salary start_date = add_months(payroll_period.start_date, 3) end_date = add_months(payroll_period.start_date, 5) @@ -584,8 +966,9 @@ class TestSalarySlip(unittest.TestCase): frappe.db.sql("""delete from `tabSalary Slip` where employee=%s""", (employee)) - create_salary_slips_for_payroll_period(employee, salary_structure.name, - payroll_period, deduct_random=False, num=4) + create_salary_slips_for_payroll_period( + employee, salary_structure.name, payroll_period, deduct_random=False, num=4 + ) tax_paid = get_tax_paid_in_period(employee) @@ -594,6 +977,52 @@ class TestSalarySlip(unittest.TestCase): frappe.db.rollback() + def test_do_not_show_statistical_component_in_slip(self): + make_employee("test_statistical_component@salary.com") + new_ss = make_employee_salary_slip( + "test_statistical_component@salary.com", + "Monthly", + "Test Payment Based On Attendence", + ) + components = [row.salary_component for row in new_ss.get("earnings")] + self.assertNotIn("Statistical Component", components) + + @change_settings( + "Payroll Settings", + {"payroll_based_on": "Attendance", "consider_unmarked_attendance_as": "Present"}, + ) + def test_statistical_component_based_on_payment_days(self): + """ + Tests whether component using statistical component in the formula + gets the updated value based on payment days + """ + from erpnext.payroll.doctype.salary_structure.test_salary_structure import ( + create_salary_structure_assignment, + ) + + emp = make_employee("test_statistical_component@salary.com") + first_sunday = get_first_sunday() + mark_attendance(emp, add_days(first_sunday, 1), "Absent", ignore_validate=True) + salary_structure = make_salary_structure_for_payment_days_based_component_dependency( + test_statistical_comp=True + ) + create_salary_structure_assignment( + emp, salary_structure.name, company="_Test Company", currency="INR" + ) + # make salary slip and assert payment days + ss = make_salary_slip_for_payment_days_dependency_test( + "test_statistical_component@salary.com", salary_structure.name + ) + + amount = precision = None + for entry in ss.earnings: + if entry.salary_component == "Dependency Component": + amount = entry.amount + precision = entry.precision("amount") + break + + self.assertEqual(amount, flt((1000 * ss.payment_days / ss.total_working_days) * 0.5, precision)) + def make_activity_for_employee(self): activity_type = frappe.get_doc("Activity Type", "_Test Activity Type") activity_type.billing_rate = 50 @@ -601,58 +1030,75 @@ class TestSalarySlip(unittest.TestCase): activity_type.wage_rate = 25 activity_type.save() - def get_no_of_days(self): - no_of_days_in_month = calendar.monthrange(getdate(nowdate()).year, - getdate(nowdate()).month) - no_of_holidays_in_month = len([1 for i in calendar.monthcalendar(getdate(nowdate()).year, - getdate(nowdate()).month) if i[6] != 0]) - return [no_of_days_in_month[1], no_of_holidays_in_month] +def get_no_of_days(): + no_of_days_in_month = calendar.monthrange(getdate(nowdate()).year, getdate(nowdate()).month) + no_of_holidays_in_month = len( + [ + 1 + for i in calendar.monthcalendar(getdate(nowdate()).year, getdate(nowdate()).month) + if i[6] != 0 + ] + ) -def make_employee_salary_slip(user, payroll_frequency, salary_structure=None): + return [no_of_days_in_month[1], no_of_holidays_in_month] + + +def make_employee_salary_slip(user, payroll_frequency, salary_structure=None, posting_date=None): from erpnext.payroll.doctype.salary_structure.test_salary_structure import make_salary_structure if not salary_structure: salary_structure = payroll_frequency + " Salary Structure Test for Salary Slip" + employee = frappe.db.get_value( + "Employee", {"user_id": user}, ["name", "company", "employee_name"], as_dict=True + ) - employee = frappe.db.get_value("Employee", - { - "user_id": user - }, - ["name", "company", "employee_name"], - as_dict=True) - - salary_structure_doc = make_salary_structure(salary_structure, payroll_frequency, employee=employee.name, company=employee.company) - salary_slip_name = frappe.db.get_value("Salary Slip", {"employee": frappe.db.get_value("Employee", {"user_id": user})}) + salary_structure_doc = make_salary_structure( + salary_structure, + payroll_frequency, + employee=employee.name, + company=employee.company, + from_date=posting_date, + ) + salary_slip_name = frappe.db.get_value( + "Salary Slip", {"employee": frappe.db.get_value("Employee", {"user_id": user})} + ) if not salary_slip_name: - salary_slip = make_salary_slip(salary_structure_doc.name, employee = employee.name) + salary_slip = make_salary_slip(salary_structure_doc.name, employee=employee.name) salary_slip.employee_name = employee.employee_name salary_slip.payroll_frequency = payroll_frequency - salary_slip.posting_date = nowdate() + salary_slip.posting_date = posting_date or nowdate() salary_slip.insert() else: - salary_slip = frappe.get_doc('Salary Slip', salary_slip_name) + salary_slip = frappe.get_doc("Salary Slip", salary_slip_name) return salary_slip + def make_salary_component(salary_components, test_tax, company_list=None): for salary_component in salary_components: - if not frappe.db.exists('Salary Component', salary_component["salary_component"]): - if test_tax: - if salary_component["type"] == "Earning": - salary_component["is_tax_applicable"] = 1 - elif salary_component["salary_component"] == "TDS": - salary_component["variable_based_on_taxable_salary"] = 1 - salary_component["amount_based_on_formula"] = 0 - salary_component["amount"] = 0 - salary_component["formula"] = "" - salary_component["condition"] = "" - salary_component["doctype"] = "Salary Component" - salary_component["salary_component_abbr"] = salary_component["abbr"] - frappe.get_doc(salary_component).insert() - get_salary_component_account(salary_component["salary_component"], company_list) + if frappe.db.exists("Salary Component", salary_component["salary_component"]): + frappe.delete_doc("Salary Component", salary_component["salary_component"], force=True) + + if test_tax: + if salary_component["type"] == "Earning": + salary_component["is_tax_applicable"] = 1 + elif salary_component["salary_component"] == "TDS": + salary_component["variable_based_on_taxable_salary"] = 1 + salary_component["amount_based_on_formula"] = 0 + salary_component["amount"] = 0 + salary_component["formula"] = "" + salary_component["condition"] = "" + + salary_component["salary_component_abbr"] = salary_component["abbr"] + doc = frappe.new_doc("Salary Component") + doc.update(salary_component) + doc.insert() + + get_salary_component_account(doc, company_list) + def get_salary_component_account(sal_comp, company_list=None): company = erpnext.get_default_company() @@ -660,10 +1106,12 @@ def get_salary_component_account(sal_comp, company_list=None): if company_list and company not in company_list: company_list.append(company) - sal_comp = frappe.get_doc("Salary Component", sal_comp) + if not isinstance(sal_comp, Document): + sal_comp = frappe.get_doc("Salary Component", sal_comp) + if not sal_comp.get("accounts"): for d in company_list: - company_abbr = frappe.get_cached_value('Company', d, 'abbr') + company_abbr = frappe.get_cached_value("Company", d, "abbr") if sal_comp.type == "Earning": account_name = "Salary" @@ -672,177 +1120,224 @@ def get_salary_component_account(sal_comp, company_list=None): account_name = "Salary Deductions" parent_account = "Current Liabilities - " + company_abbr - sal_comp.append("accounts", { - "company": d, - "account": create_account(account_name, d, parent_account) - }) + sal_comp.append( + "accounts", {"company": d, "account": create_account(account_name, d, parent_account)} + ) sal_comp.save() -def create_account(account_name, company, parent_account): - company_abbr = frappe.get_cached_value('Company', company, 'abbr') + +def create_account(account_name, company, parent_account, account_type=None): + company_abbr = frappe.get_cached_value("Company", company, "abbr") account = frappe.db.get_value("Account", account_name + " - " + company_abbr) if not account: - frappe.get_doc({ - "doctype": "Account", - "account_name": account_name, - "parent_account": parent_account, - "company": company - }).insert() + frappe.get_doc( + { + "doctype": "Account", + "account_name": account_name, + "parent_account": parent_account, + "company": company, + } + ).insert() return account -def make_earning_salary_component(setup=False, test_tax=False, company_list=None): + +def make_earning_salary_component( + setup=False, + test_tax=False, + company_list=None, + include_flexi_benefits=False, + test_statistical_comp=False, +): data = [ { - "salary_component": 'Basic Salary', - "abbr":'BS', - "condition": 'base > 10000', - "formula": 'base', + "salary_component": "Basic Salary", + "abbr": "BS", + "condition": "base > 10000", + "formula": "base", "type": "Earning", - "amount_based_on_formula": 1 + "amount_based_on_formula": 1, }, + {"salary_component": "HRA", "abbr": "H", "amount": 3000, "type": "Earning"}, { - "salary_component": 'HRA', - "abbr":'H', - "amount": 3000, - "type": "Earning" - }, - { - "salary_component": 'Special Allowance', - "abbr":'SA', - "condition": 'H < 10000', - "formula": 'BS*.5', + "salary_component": "Special Allowance", + "abbr": "SA", + "condition": "H < 10000", + "formula": "BS*.5", "type": "Earning", - "amount_based_on_formula": 1 + "amount_based_on_formula": 1, + "depends_on_payment_days": 0, }, + {"salary_component": "Leave Encashment", "abbr": "LE", "type": "Earning"}, { - "salary_component": "Leave Encashment", - "abbr": 'LE', - "type": "Earning" - } + "salary_component": "Statistical Component", + "abbr": "SC", + "type": "Earning", + "statistical_component": 1, + "amount": 500, + }, ] + if include_flexi_benefits: + data.extend( + [ + { + "salary_component": "Leave Travel Allowance", + "abbr": "B", + "is_flexible_benefit": 1, + "type": "Earning", + "pay_against_benefit_claim": 1, + "max_benefit_amount": 100000, + "depends_on_payment_days": 0, + }, + { + "salary_component": "Medical Allowance", + "abbr": "B", + "is_flexible_benefit": 1, + "pay_against_benefit_claim": 0, + "type": "Earning", + "max_benefit_amount": 15000, + "depends_on_payment_days": 1, + }, + ] + ) if test_tax: - data.extend([ - { - "salary_component": "Leave Travel Allowance", - "abbr": 'B', - "is_flexible_benefit": 1, - "type": "Earning", - "pay_against_benefit_claim": 1, - "max_benefit_amount": 100000, - "depends_on_payment_days": 0 - }, - { - "salary_component": "Medical Allowance", - "abbr": 'B', - "is_flexible_benefit": 1, - "pay_against_benefit_claim": 0, - "type": "Earning", - "max_benefit_amount": 15000 - }, - { - "salary_component": "Performance Bonus", - "abbr": 'B', - "type": "Earning" - } - ]) + data.extend( + [ + {"salary_component": "Performance Bonus", "abbr": "B", "type": "Earning"}, + ] + ) + if setup or test_tax: make_salary_component(data, test_tax, company_list) - data.append({ - "salary_component": 'Basic Salary', - "abbr":'BS', - "condition": 'base < 10000', - "formula": 'base*.2', - "type": "Earning", - "amount_based_on_formula": 1 - }) + + data.append( + { + "salary_component": "Basic Salary", + "abbr": "BS", + "condition": "base < 10000", + "formula": "base*.2", + "type": "Earning", + "amount_based_on_formula": 1, + } + ) return data + def make_deduction_salary_component(setup=False, test_tax=False, company_list=None): - data = [ + data = [ { - "salary_component": 'Professional Tax', - "abbr":'PT', + "salary_component": "Professional Tax", + "abbr": "PT", "type": "Deduction", "amount": 200, - "exempted_from_income_tax": 1 - + "exempted_from_income_tax": 1, } ] if not test_tax: - data.append({ - "salary_component": 'TDS', - "abbr":'T', - "condition": 'employment_type=="Intern"', - "type": "Deduction", - "round_to_the_nearest_integer": 1 - }) + data.append( + { + "salary_component": "TDS", + "abbr": "T", + "condition": 'employment_type=="Intern"', + "type": "Deduction", + "round_to_the_nearest_integer": 1, + } + ) else: - data.append({ - "salary_component": 'TDS', - "abbr":'T', - "type": "Deduction", - "depends_on_payment_days": 0, - "variable_based_on_taxable_salary": 1, - "round_to_the_nearest_integer": 1 - }) + data.append( + { + "salary_component": "TDS", + "abbr": "T", + "type": "Deduction", + "depends_on_payment_days": 0, + "variable_based_on_taxable_salary": 1, + "round_to_the_nearest_integer": 1, + } + ) if setup or test_tax: make_salary_component(data, test_tax, company_list) return data + def get_tax_paid_in_period(employee): - tax_paid_amount = frappe.db.sql("""select sum(sd.amount) from `tabSalary Detail` + tax_paid_amount = frappe.db.sql( + """select sum(sd.amount) from `tabSalary Detail` sd join `tabSalary Slip` ss where ss.name=sd.parent and ss.employee=%s - and ss.docstatus=1 and sd.salary_component='TDS'""", (employee)) + and ss.docstatus=1 and sd.salary_component='TDS'""", + (employee), + ) return tax_paid_amount[0][0] + def create_exemption_declaration(employee, payroll_period): create_exemption_category() - declaration = frappe.get_doc({ - "doctype": "Employee Tax Exemption Declaration", - "employee": employee, - "payroll_period": payroll_period, - "company": erpnext.get_default_company(), - "currency": erpnext.get_default_currency() - }) - declaration.append("declarations", { - "exemption_sub_category": "_Test Sub Category", - "exemption_category": "_Test Category", - "amount": 100000 - }) + declaration = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Declaration", + "employee": employee, + "payroll_period": payroll_period, + "company": erpnext.get_default_company(), + "currency": erpnext.get_default_currency(), + } + ) + declaration.append( + "declarations", + { + "exemption_sub_category": "_Test Sub Category", + "exemption_category": "_Test Category", + "amount": 100000, + }, + ) declaration.submit() + def create_proof_submission(employee, payroll_period, amount): submission_date = add_months(payroll_period.start_date, random.randint(0, 11)) - proof_submission = frappe.get_doc({ - "doctype": "Employee Tax Exemption Proof Submission", - "employee": employee, - "payroll_period": payroll_period.name, - "submission_date": submission_date, - "currency": erpnext.get_default_currency() - }) - proof_submission.append("tax_exemption_proofs", { - "exemption_sub_category": "_Test Sub Category", - "exemption_category": "_Test Category", - "type_of_proof": "Test", "amount": amount - }) + proof_submission = frappe.get_doc( + { + "doctype": "Employee Tax Exemption Proof Submission", + "employee": employee, + "payroll_period": payroll_period.name, + "submission_date": submission_date, + "currency": erpnext.get_default_currency(), + } + ) + proof_submission.append( + "tax_exemption_proofs", + { + "exemption_sub_category": "_Test Sub Category", + "exemption_category": "_Test Category", + "type_of_proof": "Test", + "amount": amount, + }, + ) proof_submission.submit() return submission_date + def create_benefit_claim(employee, payroll_period, amount, component): claim_date = add_months(payroll_period.start_date, random.randint(0, 11)) - frappe.get_doc({ - "doctype": "Employee Benefit Claim", - "employee": employee, - "claimed_amount": amount, - "claim_date": claim_date, - "earning_component": component, - "currency": erpnext.get_default_currency() - }).submit() + frappe.get_doc( + { + "doctype": "Employee Benefit Claim", + "employee": employee, + "claimed_amount": amount, + "claim_date": claim_date, + "earning_component": component, + "currency": erpnext.get_default_currency(), + } + ).submit() return claim_date -def create_tax_slab(payroll_period, effective_date = None, allow_tax_exemption = False, dont_submit = False, currency=None, - company=None): + +def create_tax_slab( + payroll_period, + effective_date=None, + allow_tax_exemption=False, + dont_submit=False, + currency=None, + company=None, +): if not currency: currency = erpnext.get_default_currency() @@ -854,17 +1349,10 @@ def create_tax_slab(payroll_period, effective_date = None, allow_tax_exemption = "from_amount": 250000, "to_amount": 500000, "percent_deduction": 5, - "condition": "annual_taxable_earning > 500000" + "condition": "annual_taxable_earning > 500000", }, - { - "from_amount": 500001, - "to_amount": 1000000, - "percent_deduction": 20 - }, - { - "from_amount": 1000001, - "percent_deduction": 30 - } + {"from_amount": 500001, "to_amount": 1000000, "percent_deduction": 20}, + {"from_amount": 1000001, "percent_deduction": 30}, ] income_tax_slab_name = frappe.db.get_value("Income Tax Slab", {"currency": currency}) @@ -872,7 +1360,7 @@ def create_tax_slab(payroll_period, effective_date = None, allow_tax_exemption = income_tax_slab = frappe.new_doc("Income Tax Slab") income_tax_slab.name = "Tax Slab: " + payroll_period.name + " " + cstr(currency) income_tax_slab.effective_from = effective_date or add_days(payroll_period.start_date, -2) - income_tax_slab.company = company or '' + income_tax_slab.company = company or "" income_tax_slab.currency = currency if allow_tax_exemption: @@ -882,10 +1370,7 @@ def create_tax_slab(payroll_period, effective_date = None, allow_tax_exemption = for item in slabs: income_tax_slab.append("slabs", item) - income_tax_slab.append("other_taxes_and_charges", { - "description": "cess", - "percent": 4 - }) + income_tax_slab.append("other_taxes_and_charges", {"description": "cess", "percent": 4}) income_tax_slab.save() if not dont_submit: @@ -895,12 +1380,21 @@ def create_tax_slab(payroll_period, effective_date = None, allow_tax_exemption = else: return income_tax_slab_name -def create_salary_slips_for_payroll_period(employee, salary_structure, payroll_period, deduct_random=True, num=12): + +def create_salary_slips_for_payroll_period( + employee, salary_structure, payroll_period, deduct_random=True, num=12 +): deducted_dates = [] i = 0 while i < num: - slip = frappe.get_doc({"doctype": "Salary Slip", "employee": employee, - "salary_structure": salary_structure, "frequency": "Monthly"}) + slip = frappe.get_doc( + { + "doctype": "Salary Slip", + "employee": employee, + "salary_structure": salary_structure, + "frequency": "Monthly", + } + ) if i == 0: posting_date = add_days(payroll_period.start_date, 25) else: @@ -919,73 +1413,113 @@ def create_salary_slips_for_payroll_period(employee, salary_structure, payroll_p i += 1 return deducted_dates + def create_additional_salary(employee, payroll_period, amount): salary_date = add_months(payroll_period.start_date, random.randint(0, 11)) - frappe.get_doc({ - "doctype": "Additional Salary", - "employee": employee, - "company": erpnext.get_default_company(), - "salary_component": "Performance Bonus", - "payroll_date": salary_date, - "amount": amount, - "type": "Earning", - "currency": erpnext.get_default_currency() - }).submit() + frappe.get_doc( + { + "doctype": "Additional Salary", + "employee": employee, + "company": erpnext.get_default_company(), + "salary_component": "Performance Bonus", + "payroll_date": salary_date, + "amount": amount, + "type": "Earning", + "currency": erpnext.get_default_currency(), + } + ).submit() return salary_date -def make_leave_application(employee, from_date, to_date, leave_type, company=None): - leave_application = frappe.get_doc(dict( - doctype = 'Leave Application', - employee = employee, - leave_type = leave_type, - from_date = from_date, - to_date = to_date, - company = company or erpnext.get_default_company() or "_Test Company", - docstatus = 1, - status = "Approved", - leave_approver = 'test@example.com' - )) - leave_application.submit() + +def make_leave_application( + employee, + from_date, + to_date, + leave_type, + company=None, + half_day=False, + half_day_date=None, + submit=True, +): + leave_application = frappe.get_doc( + dict( + doctype="Leave Application", + employee=employee, + leave_type=leave_type, + from_date=from_date, + to_date=to_date, + half_day=half_day, + half_day_date=half_day_date, + company=company or erpnext.get_default_company() or "_Test Company", + status="Approved", + leave_approver="test@example.com", + ) + ).insert() + + if submit: + leave_application.submit() + + return leave_application + def setup_test(): make_earning_salary_component(setup=True, company_list=["_Test Company"]) make_deduction_salary_component(setup=True, company_list=["_Test Company"]) - for dt in ["Leave Application", "Leave Allocation", "Salary Slip", "Attendance", "Additional Salary"]: + for dt in [ + "Leave Application", + "Leave Allocation", + "Salary Slip", + "Attendance", + "Additional Salary", + "Employee Tax Exemption Declaration", + "Employee Tax Exemption Proof Submission", + "Employee Benefit Claim", + "Salary Structure Assignment", + ]: frappe.db.sql("delete from `tab%s`" % dt) make_holiday_list() - frappe.db.set_value("Company", erpnext.get_default_company(), "default_holiday_list", "Salary Slip Test Holiday List") + frappe.db.set_value( + "Company", erpnext.get_default_company(), "default_holiday_list", "Salary Slip Test Holiday List" + ) frappe.db.set_value("Payroll Settings", None, "email_salary_slip_to_employee", 0) - frappe.db.set_value('HR Settings', None, 'leave_status_notification_template', None) - frappe.db.set_value('HR Settings', None, 'leave_approval_notification_template', None) + frappe.db.set_value("HR Settings", None, "leave_status_notification_template", None) + frappe.db.set_value("HR Settings", None, "leave_approval_notification_template", None) -def make_holiday_list(): - fiscal_year = get_fiscal_year(nowdate(), company=erpnext.get_default_company()) - holiday_list = frappe.db.exists("Holiday List", "Salary Slip Test Holiday List") - if not frappe.db.get_value("Holiday List", "Salary Slip Test Holiday List"): - holiday_list = frappe.get_doc({ + +def make_holiday_list(list_name=None, from_date=None, to_date=None): + if not (from_date and to_date): + fiscal_year = get_fiscal_year(nowdate(), company=erpnext.get_default_company()) + name = list_name or "Salary Slip Test Holiday List" + + frappe.delete_doc_if_exists("Holiday List", name, force=True) + + holiday_list = frappe.get_doc( + { "doctype": "Holiday List", - "holiday_list_name": "Salary Slip Test Holiday List", - "from_date": fiscal_year[1], - "to_date": fiscal_year[2], - "weekly_off": "Sunday" - }).insert() - holiday_list.get_weekly_off_dates() - holiday_list.save() - holiday_list = holiday_list.name + "holiday_list_name": name, + "from_date": from_date or fiscal_year[1], + "to_date": to_date or fiscal_year[2], + "weekly_off": "Sunday", + } + ).insert() + holiday_list.get_weekly_off_dates() + holiday_list.save() + holiday_list = holiday_list.name return holiday_list -def make_salary_structure_for_payment_days_based_component_dependency(): + +def make_salary_structure_for_payment_days_based_component_dependency(test_statistical_comp=False): earnings = [ { "salary_component": "Basic Salary - Payment Days", "abbr": "P_BS", "type": "Earning", "formula": "base", - "amount_based_on_formula": 1 + "amount_based_on_formula": 1, }, { "salary_component": "HRA - Payment Days", @@ -993,9 +1527,30 @@ def make_salary_structure_for_payment_days_based_component_dependency(): "type": "Earning", "depends_on_payment_days": 1, "amount_based_on_formula": 1, - "formula": "base * 0.20" - } + "formula": "base * 0.20", + }, ] + if test_statistical_comp: + earnings.extend( + [ + { + "salary_component": "Statistical Component", + "abbr": "SC", + "type": "Earning", + "statistical_component": 1, + "amount": 1000, + "depends_on_payment_days": 1, + }, + { + "salary_component": "Dependency Component", + "abbr": "DC", + "type": "Earning", + "amount_based_on_formula": 1, + "formula": "SC * 0.5", + "depends_on_payment_days": 0, + }, + ] + ) make_salary_component(earnings, False, company_list=["_Test Company"]) @@ -1005,7 +1560,7 @@ def make_salary_structure_for_payment_days_based_component_dependency(): "abbr": "P_PT", "type": "Deduction", "depends_on_payment_days": 1, - "amount": 200.00 + "amount": 200.00, }, { "salary_component": "P - Employee Provident Fund", @@ -1014,8 +1569,8 @@ def make_salary_structure_for_payment_days_based_component_dependency(): "exempted_from_income_tax": 1, "amount_based_on_formula": 1, "depends_on_payment_days": 0, - "formula": "(gross_pay - P_HRA) * 0.12" - } + "formula": "(gross_pay - P_HRA) * 0.12", + }, ] make_salary_component(deductions, False, company_list=["_Test Company"]) @@ -1030,7 +1585,7 @@ def make_salary_structure_for_payment_days_based_component_dependency(): "company": "_Test Company", "payroll_frequency": "Monthly", "payment_account": get_random("Account", filters={"account_currency": "INR"}), - "currency": "INR" + "currency": "INR", } salary_structure_doc = frappe.get_doc(details) @@ -1046,14 +1601,15 @@ def make_salary_structure_for_payment_days_based_component_dependency(): return salary_structure_doc -def make_salary_slip_for_payment_days_dependency_test(employee, salary_structure): - employee = frappe.db.get_value("Employee", { - "user_id": employee - }, - ["name", "company", "employee_name"], - as_dict=True) - salary_slip_name = frappe.db.get_value("Salary Slip", {"employee": frappe.db.get_value("Employee", {"user_id": employee})}) +def make_salary_slip_for_payment_days_dependency_test(employee, salary_structure): + employee = frappe.db.get_value( + "Employee", {"user_id": employee}, ["name", "company", "employee_name"], as_dict=True + ) + + salary_slip_name = frappe.db.get_value( + "Salary Slip", {"employee": frappe.db.get_value("Employee", {"user_id": employee})} + ) if not salary_slip_name: salary_slip = make_salary_slip(salary_structure, employee=employee.name) @@ -1066,16 +1622,21 @@ def make_salary_slip_for_payment_days_dependency_test(employee, salary_structure return salary_slip -def create_recurring_additional_salary(employee, salary_component, amount, from_date, to_date, company=None): - frappe.get_doc({ - "doctype": "Additional Salary", - "employee": employee, - "company": company or erpnext.get_default_company(), - "salary_component": salary_component, - "is_recurring": 1, - "from_date": from_date, - "to_date": to_date, - "amount": amount, - "type": "Earning", - "currency": erpnext.get_default_currency() - }).submit() + +def create_recurring_additional_salary( + employee, salary_component, amount, from_date, to_date, company=None +): + frappe.get_doc( + { + "doctype": "Additional Salary", + "employee": employee, + "company": company or erpnext.get_default_company(), + "salary_component": salary_component, + "is_recurring": 1, + "from_date": from_date, + "to_date": to_date, + "amount": amount, + "type": "Earning", + "currency": erpnext.get_default_currency(), + } + ).submit() diff --git a/erpnext/payroll/doctype/salary_slip_leave/salary_slip_leave.json b/erpnext/payroll/doctype/salary_slip_leave/salary_slip_leave.json index 7ac453b3c3d..60ed4539385 100644 --- a/erpnext/payroll/doctype/salary_slip_leave/salary_slip_leave.json +++ b/erpnext/payroll/doctype/salary_slip_leave/salary_slip_leave.json @@ -26,7 +26,7 @@ "fieldname": "total_allocated_leaves", "fieldtype": "Float", "in_list_view": 1, - "label": "Total Allocated Leave", + "label": "Total Allocated Leave(s)", "no_copy": 1, "read_only": 1 }, @@ -34,7 +34,7 @@ "fieldname": "expired_leaves", "fieldtype": "Float", "in_list_view": 1, - "label": "Expired Leave", + "label": "Expired Leave(s)", "no_copy": 1, "read_only": 1 }, @@ -42,7 +42,7 @@ "fieldname": "used_leaves", "fieldtype": "Float", "in_list_view": 1, - "label": "Used Leave", + "label": "Used Leave(s)", "no_copy": 1, "read_only": 1 }, @@ -50,7 +50,7 @@ "fieldname": "pending_leaves", "fieldtype": "Float", "in_list_view": 1, - "label": "Pending Leave", + "label": "Leave(s) Pending Approval", "no_copy": 1, "read_only": 1 }, @@ -58,7 +58,7 @@ "fieldname": "available_leaves", "fieldtype": "Float", "in_list_view": 1, - "label": "Available Leave", + "label": "Available Leave(s)", "no_copy": 1, "read_only": 1 } @@ -66,7 +66,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-02-19 10:47:48.546724", + "modified": "2022-02-28 14:01:32.327204", "modified_by": "Administrator", "module": "Payroll", "name": "Salary Slip Leave", @@ -74,5 +74,6 @@ "permissions": [], "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/payroll/doctype/salary_structure/salary_structure.json b/erpnext/payroll/doctype/salary_structure/salary_structure.json index 5dd1d701f02..8df995769d3 100644 --- a/erpnext/payroll/doctype/salary_structure/salary_structure.json +++ b/erpnext/payroll/doctype/salary_structure/salary_structure.json @@ -58,6 +58,7 @@ "width": "50%" }, { + "allow_on_submit": 1, "default": "Yes", "fieldname": "is_active", "fieldtype": "Select", @@ -232,10 +233,11 @@ "idx": 1, "is_submittable": 1, "links": [], - "modified": "2021-03-31 15:41:12.342380", + "modified": "2022-02-03 23:50:10.205676", "modified_by": "Administrator", "module": "Payroll", "name": "Salary Structure", + "naming_rule": "Set by user", "owner": "Administrator", "permissions": [ { @@ -271,5 +273,6 @@ ], "show_name_in_global_search": 1, "sort_field": "modified", - "sort_order": "DESC" + "sort_order": "DESC", + "states": [] } \ No newline at end of file diff --git a/erpnext/payroll/doctype/salary_structure/salary_structure.py b/erpnext/payroll/doctype/salary_structure/salary_structure.py index ae83c046a5e..caf9d9bb7c8 100644 --- a/erpnext/payroll/doctype/salary_structure/salary_structure.py +++ b/erpnext/payroll/doctype/salary_structure/salary_structure.py @@ -1,6 +1,7 @@ # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt +import re import frappe from frappe import _ @@ -18,14 +19,25 @@ class SalaryStructure(Document): self.strip_condition_and_formula_fields() self.validate_max_benefits_with_flexi() self.validate_component_based_on_tax_slab() + self.validate_payment_days_based_dependent_component() + self.validate_timesheet_component() def set_missing_values(self): - overwritten_fields = ["depends_on_payment_days", "variable_based_on_taxable_salary", "is_tax_applicable", "is_flexible_benefit"] + overwritten_fields = [ + "depends_on_payment_days", + "variable_based_on_taxable_salary", + "is_tax_applicable", + "is_flexible_benefit", + ] overwritten_fields_if_missing = ["amount_based_on_formula", "formula", "amount"] for table in ["earnings", "deductions"]: for d in self.get(table): - component_default_value = frappe.db.get_value("Salary Component", cstr(d.salary_component), - overwritten_fields + overwritten_fields_if_missing, as_dict=1) + component_default_value = frappe.db.get_value( + "Salary Component", + cstr(d.salary_component), + overwritten_fields + overwritten_fields_if_missing, + as_dict=1, + ) if component_default_value: for fieldname in overwritten_fields: value = component_default_value.get(fieldname) @@ -39,13 +51,60 @@ class SalaryStructure(Document): def validate_component_based_on_tax_slab(self): for row in self.deductions: if row.variable_based_on_taxable_salary and (row.amount or row.formula): - frappe.throw(_("Row #{0}: Cannot set amount or formula for Salary Component {1} with Variable Based On Taxable Salary") - .format(row.idx, row.salary_component)) + frappe.throw( + _( + "Row #{0}: Cannot set amount or formula for Salary Component {1} with Variable Based On Taxable Salary" + ).format(row.idx, row.salary_component) + ) def validate_amount(self): if flt(self.net_pay) < 0 and self.salary_slip_based_on_timesheet: frappe.throw(_("Net pay cannot be negative")) + def validate_payment_days_based_dependent_component(self): + abbreviations = self.get_component_abbreviations() + for component_type in ("earnings", "deductions"): + for row in self.get(component_type): + if ( + row.formula + and row.depends_on_payment_days + # check if the formula contains any of the payment days components + and any(re.search(r"\b" + abbr + r"\b", row.formula) for abbr in abbreviations) + ): + message = _("Row #{0}: The {1} Component has the options {2} and {3} enabled.").format( + row.idx, + frappe.bold(row.salary_component), + frappe.bold("Amount based on formula"), + frappe.bold("Depends On Payment Days"), + ) + message += "
" + _( + "Disable {0} for the {1} component, to prevent the amount from being deducted twice, as its formula already uses a payment-days-based component." + ).format( + frappe.bold("Depends On Payment Days"), frappe.bold(row.salary_component) + ) + frappe.throw(message, title=_("Payment Days Dependency")) + + def get_component_abbreviations(self): + abbr = [d.abbr for d in self.earnings if d.depends_on_payment_days] + abbr += [d.abbr for d in self.deductions if d.depends_on_payment_days] + + return abbr + + def validate_timesheet_component(self): + if not self.salary_slip_based_on_timesheet: + return + + for component in self.earnings: + if component.salary_component == self.salary_component: + frappe.msgprint( + _( + "Row #{0}: Timesheet amount will overwrite the Earning component amount for the Salary Component {1}" + ).format(self.idx, frappe.bold(self.salary_component)), + title=_("Warning"), + indicator="orange", + ) + break + def strip_condition_and_formula_fields(self): # remove whitespaces from condition and formula fields for row in self.earnings: @@ -63,16 +122,23 @@ class SalaryStructure(Document): for earning_component in self.earnings: if earning_component.is_flexible_benefit == 1: have_a_flexi = True - max_of_component = frappe.db.get_value("Salary Component", earning_component.salary_component, "max_benefit_amount") + max_of_component = frappe.db.get_value( + "Salary Component", earning_component.salary_component, "max_benefit_amount" + ) flexi_amount += max_of_component if have_a_flexi and flt(self.max_benefits) == 0: frappe.throw(_("Max benefits should be greater than zero to dispense benefits")) if have_a_flexi and flexi_amount and flt(self.max_benefits) > flexi_amount: - frappe.throw(_("Total flexible benefit component amount {0} should not be less than max benefits {1}") - .format(flexi_amount, self.max_benefits)) + frappe.throw( + _( + "Total flexible benefit component amount {0} should not be less than max benefits {1}" + ).format(flexi_amount, self.max_benefits) + ) if not have_a_flexi and flt(self.max_benefits) > 0: - frappe.throw(_("Salary Structure should have flexible benefit component(s) to dispense benefit amount")) + frappe.throw( + _("Salary Structure should have flexible benefit component(s) to dispense benefit amount") + ) def get_employees(self, **kwargs): conditions, values = [], [] @@ -83,58 +149,117 @@ class SalaryStructure(Document): condition_str = " and " + " and ".join(conditions) if conditions else "" - employees = frappe.db.sql_list("select name from tabEmployee where status='Active' {condition}" - .format(condition=condition_str), tuple(values)) + employees = frappe.db.sql_list( + "select name from tabEmployee where status='Active' {condition}".format( + condition=condition_str + ), + tuple(values), + ) return employees @frappe.whitelist() - def assign_salary_structure(self, grade=None, department=None, designation=None, employee=None, - payroll_payable_account=None, from_date=None, base=None, variable=None, income_tax_slab=None): - employees = self.get_employees(company= self.company, grade= grade,department= department,designation= designation,name=employee) + def assign_salary_structure( + self, + grade=None, + department=None, + designation=None, + employee=None, + payroll_payable_account=None, + from_date=None, + base=None, + variable=None, + income_tax_slab=None, + ): + employees = self.get_employees( + company=self.company, grade=grade, department=department, designation=designation, name=employee + ) if employees: if len(employees) > 20: - frappe.enqueue(assign_salary_structure_for_employees, timeout=600, - employees=employees, salary_structure=self, + frappe.enqueue( + assign_salary_structure_for_employees, + timeout=600, + employees=employees, + salary_structure=self, payroll_payable_account=payroll_payable_account, - from_date=from_date, base=base, variable=variable, income_tax_slab=income_tax_slab) + from_date=from_date, + base=base, + variable=variable, + income_tax_slab=income_tax_slab, + ) else: - assign_salary_structure_for_employees(employees, self, + assign_salary_structure_for_employees( + employees, + self, payroll_payable_account=payroll_payable_account, - from_date=from_date, base=base, variable=variable, income_tax_slab=income_tax_slab) + from_date=from_date, + base=base, + variable=variable, + income_tax_slab=income_tax_slab, + ) else: frappe.msgprint(_("No Employee Found")) - -def assign_salary_structure_for_employees(employees, salary_structure, payroll_payable_account=None, from_date=None, base=None, variable=None, income_tax_slab=None): +def assign_salary_structure_for_employees( + employees, + salary_structure, + payroll_payable_account=None, + from_date=None, + base=None, + variable=None, + income_tax_slab=None, +): salary_structures_assignments = [] existing_assignments_for = get_existing_assignments(employees, salary_structure, from_date) - count=0 + count = 0 for employee in employees: if employee in existing_assignments_for: continue - count +=1 + count += 1 - salary_structures_assignment = create_salary_structures_assignment(employee, - salary_structure, payroll_payable_account, from_date, base, variable, income_tax_slab) + salary_structures_assignment = create_salary_structures_assignment( + employee, salary_structure, payroll_payable_account, from_date, base, variable, income_tax_slab + ) salary_structures_assignments.append(salary_structures_assignment) - frappe.publish_progress(count*100/len(set(employees) - set(existing_assignments_for)), title = _("Assigning Structures...")) + frappe.publish_progress( + count * 100 / len(set(employees) - set(existing_assignments_for)), + title=_("Assigning Structures..."), + ) if salary_structures_assignments: frappe.msgprint(_("Structures have been assigned successfully")) -def create_salary_structures_assignment(employee, salary_structure, payroll_payable_account, from_date, base, variable, income_tax_slab=None): +def create_salary_structures_assignment( + employee, + salary_structure, + payroll_payable_account, + from_date, + base, + variable, + income_tax_slab=None, +): if not payroll_payable_account: - payroll_payable_account = frappe.db.get_value('Company', salary_structure.company, 'default_payroll_payable_account') + payroll_payable_account = frappe.db.get_value( + "Company", salary_structure.company, "default_payroll_payable_account" + ) if not payroll_payable_account: frappe.throw(_('Please set "Default Payroll Payable Account" in Company Defaults')) - payroll_payable_account_currency = frappe.db.get_value('Account', payroll_payable_account, 'account_currency') + payroll_payable_account_currency = frappe.db.get_value( + "Account", payroll_payable_account, "account_currency" + ) company_curency = erpnext.get_company_currency(salary_structure.company) - if payroll_payable_account_currency != salary_structure.currency and payroll_payable_account_currency != company_curency: - frappe.throw(_("Invalid Payroll Payable Account. The account currency must be {0} or {1}").format(salary_structure.currency, company_curency)) + if ( + payroll_payable_account_currency != salary_structure.currency + and payroll_payable_account_currency != company_curency + ): + frappe.throw( + _("Invalid Payroll Payable Account. The account currency must be {0} or {1}").format( + salary_structure.currency, company_curency + ) + ) assignment = frappe.new_doc("Salary Structure Assignment") assignment.employee = employee @@ -146,28 +271,49 @@ def create_salary_structures_assignment(employee, salary_structure, payroll_paya assignment.base = base assignment.variable = variable assignment.income_tax_slab = income_tax_slab - assignment.save(ignore_permissions = True) + assignment.save(ignore_permissions=True) assignment.submit() return assignment.name def get_existing_assignments(employees, salary_structure, from_date): - salary_structures_assignments = frappe.db.sql_list(""" + salary_structures_assignments = frappe.db.sql_list( + """ select distinct employee from `tabSalary Structure Assignment` where salary_structure=%s and employee in (%s) and from_date=%s and company= %s and docstatus=1 - """ % ('%s', ', '.join(['%s']*len(employees)),'%s', '%s'), [salary_structure.name] + employees+[from_date]+[salary_structure.company]) + """ + % ("%s", ", ".join(["%s"] * len(employees)), "%s", "%s"), + [salary_structure.name] + employees + [from_date] + [salary_structure.company], + ) if salary_structures_assignments: - frappe.msgprint(_("Skipping Salary Structure Assignment for the following employees, as Salary Structure Assignment records already exists against them. {0}") - .format("\n".join(salary_structures_assignments))) + frappe.msgprint( + _( + "Skipping Salary Structure Assignment for the following employees, as Salary Structure Assignment records already exists against them. {0}" + ).format("\n".join(salary_structures_assignments)) + ) return salary_structures_assignments + @frappe.whitelist() -def make_salary_slip(source_name, target_doc = None, employee = None, as_print = False, print_format = None, for_preview=0, ignore_permissions=False): +def make_salary_slip( + source_name, + target_doc=None, + employee=None, + posting_date=None, + as_print=False, + print_format=None, + for_preview=0, + ignore_permissions=False, +): def postprocess(source, target): if employee: - employee_details = frappe.db.get_value("Employee", employee, - ["employee_name", "branch", "designation", "department", "payroll_cost_center"], as_dict=1) + employee_details = frappe.db.get_value( + "Employee", + employee, + ["employee_name", "branch", "designation", "department", "payroll_cost_center"], + as_dict=1, + ) target.employee = employee target.employee_name = employee_details.employee_name target.branch = employee_details.branch @@ -175,35 +321,54 @@ def make_salary_slip(source_name, target_doc = None, employee = None, as_print = target.department = employee_details.department target.payroll_cost_center = employee_details.payroll_cost_center if not target.payroll_cost_center and target.department: - target.payroll_cost_center = frappe.db.get_value("Department", target.department, "payroll_cost_center") + target.payroll_cost_center = frappe.db.get_value( + "Department", target.department, "payroll_cost_center" + ) - target.run_method('process_salary_structure', for_preview=for_preview) + if posting_date: + target.posting_date = posting_date - doc = get_mapped_doc("Salary Structure", source_name, { - "Salary Structure": { - "doctype": "Salary Slip", - "field_map": { - "total_earning": "gross_pay", - "name": "salary_structure", - "currency": "currency" + target.run_method("process_salary_structure", for_preview=for_preview) + + doc = get_mapped_doc( + "Salary Structure", + source_name, + { + "Salary Structure": { + "doctype": "Salary Slip", + "field_map": { + "total_earning": "gross_pay", + "name": "salary_structure", + "currency": "currency", + }, } - } - }, target_doc, postprocess, ignore_child_tables=True, ignore_permissions=ignore_permissions) + }, + target_doc, + postprocess, + ignore_child_tables=True, + ignore_permissions=ignore_permissions, + ) if cint(as_print): - doc.name = 'Preview for {0}'.format(employee) - return frappe.get_print(doc.doctype, doc.name, doc = doc, print_format = print_format) + doc.name = "Preview for {0}".format(employee) + return frappe.get_print(doc.doctype, doc.name, doc=doc, print_format=print_format) else: return doc @frappe.whitelist() def get_employees(salary_structure): - employees = frappe.get_list('Salary Structure Assignment', - filters={'salary_structure': salary_structure, 'docstatus': 1}, fields=['employee']) + employees = frappe.get_list( + "Salary Structure Assignment", + filters={"salary_structure": salary_structure, "docstatus": 1}, + fields=["employee"], + ) if not employees: - frappe.throw(_("There's no Employee with Salary Structure: {0}. Assign {1} to an Employee to preview Salary Slip").format( - salary_structure, salary_structure)) + frappe.throw( + _( + "There's no Employee with Salary Structure: {0}. Assign {1} to an Employee to preview Salary Slip" + ).format(salary_structure, salary_structure) + ) return list(set([d.employee for d in employees])) diff --git a/erpnext/payroll/doctype/salary_structure/salary_structure_dashboard.py b/erpnext/payroll/doctype/salary_structure/salary_structure_dashboard.py index 27eb5ed8b11..cf363b410df 100644 --- a/erpnext/payroll/doctype/salary_structure/salary_structure_dashboard.py +++ b/erpnext/payroll/doctype/salary_structure/salary_structure_dashboard.py @@ -1,17 +1,9 @@ - - def get_data(): return { - 'fieldname': 'salary_structure', - 'non_standard_fieldnames': { - 'Employee Grade': 'default_salary_structure' - }, - 'transactions': [ - { - 'items': ['Salary Structure Assignment', 'Salary Slip'] - }, - { - 'items': ['Employee Grade'] - }, - ] + "fieldname": "salary_structure", + "non_standard_fieldnames": {"Employee Grade": "default_salary_structure"}, + "transactions": [ + {"items": ["Salary Structure Assignment", "Salary Slip"]}, + {"items": ["Employee Grade"]}, + ], } diff --git a/erpnext/payroll/doctype/salary_structure/test_salary_structure.py b/erpnext/payroll/doctype/salary_structure/test_salary_structure.py index e2d0d1c864c..c598904bbe4 100644 --- a/erpnext/payroll/doctype/salary_structure/test_salary_structure.py +++ b/erpnext/payroll/doctype/salary_structure/test_salary_structure.py @@ -22,25 +22,33 @@ from erpnext.payroll.doctype.salary_structure.salary_structure import make_salar test_dependencies = ["Fiscal Year"] + class TestSalaryStructure(unittest.TestCase): def setUp(self): for dt in ["Salary Slip", "Salary Structure", "Salary Structure Assignment"]: frappe.db.sql("delete from `tab%s`" % dt) self.make_holiday_list() - frappe.db.set_value("Company", erpnext.get_default_company(), "default_holiday_list", "Salary Structure Test Holiday List") + frappe.db.set_value( + "Company", + erpnext.get_default_company(), + "default_holiday_list", + "Salary Structure Test Holiday List", + ) make_employee("test_employee@salary.com") make_employee("test_employee_2@salary.com") def make_holiday_list(self): if not frappe.db.get_value("Holiday List", "Salary Structure Test Holiday List"): - holiday_list = frappe.get_doc({ - "doctype": "Holiday List", - "holiday_list_name": "Salary Structure Test Holiday List", - "from_date": nowdate(), - "to_date": add_years(nowdate(), 1), - "weekly_off": "Sunday" - }).insert() + holiday_list = frappe.get_doc( + { + "doctype": "Holiday List", + "holiday_list_name": "Salary Structure Test Holiday List", + "from_date": nowdate(), + "to_date": add_years(nowdate(), 1), + "weekly_off": "Sunday", + } + ).insert() holiday_list.get_weekly_off_dates() holiday_list.save() @@ -48,31 +56,33 @@ class TestSalaryStructure(unittest.TestCase): emp = make_employee("test_employee_3@salary.com") - sal_struct = make_salary_structure("Salary Structure 2", "Monthly", dont_submit = True) + sal_struct = make_salary_structure("Salary Structure 2", "Monthly", dont_submit=True) sal_struct.earnings = [sal_struct.earnings[0]] sal_struct.earnings[0].amount_based_on_formula = 1 - sal_struct.earnings[0].formula = "base" + sal_struct.earnings[0].formula = "base" sal_struct.deductions = [sal_struct.deductions[0]] sal_struct.deductions[0].amount_based_on_formula = 1 sal_struct.deductions[0].condition = "gross_pay > 100" - sal_struct.deductions[0].formula = "gross_pay * 0.2" + sal_struct.deductions[0].formula = "gross_pay * 0.2" sal_struct.submit() assignment = create_salary_structure_assignment(emp, "Salary Structure 2") - ss = make_salary_slip(sal_struct.name, employee = emp) + ss = make_salary_slip(sal_struct.name, employee=emp) self.assertEqual(assignment.base * 0.2, ss.deductions[0].amount) def test_amount_totals(self): frappe.db.set_value("Payroll Settings", None, "include_holidays_in_total_working_days", 0) - sal_slip = frappe.get_value("Salary Slip", {"employee_name":"test_employee_2@salary.com"}) + sal_slip = frappe.get_value("Salary Slip", {"employee_name": "test_employee_2@salary.com"}) if not sal_slip: - sal_slip = make_employee_salary_slip("test_employee_2@salary.com", "Monthly", "Salary Structure Sample") - self.assertEqual(sal_slip.get("salary_structure"), 'Salary Structure Sample') + sal_slip = make_employee_salary_slip( + "test_employee_2@salary.com", "Monthly", "Salary Structure Sample" + ) + self.assertEqual(sal_slip.get("salary_structure"), "Salary Structure Sample") self.assertEqual(sal_slip.get("earnings")[0].amount, 50000) self.assertEqual(sal_slip.get("earnings")[1].amount, 3000) self.assertEqual(sal_slip.get("earnings")[2].amount, 25000) @@ -84,12 +94,12 @@ class TestSalaryStructure(unittest.TestCase): salary_structure = make_salary_structure("Salary Structure Sample", "Monthly", dont_submit=True) for row in salary_structure.earnings: - row.formula = "\n%s\n\n"%row.formula - row.condition = "\n%s\n\n"%row.condition + row.formula = "\n%s\n\n" % row.formula + row.condition = "\n%s\n\n" % row.condition for row in salary_structure.deductions: - row.formula = "\n%s\n\n"%row.formula - row.condition = "\n%s\n\n"%row.condition + row.formula = "\n%s\n\n" % row.formula + row.condition = "\n%s\n\n" % row.condition salary_structure.save() @@ -101,29 +111,49 @@ class TestSalaryStructure(unittest.TestCase): def test_salary_structures_assignment(self): company_currency = erpnext.get_default_currency() - salary_structure = make_salary_structure("Salary Structure Sample", "Monthly", currency=company_currency) + salary_structure = make_salary_structure( + "Salary Structure Sample", "Monthly", currency=company_currency + ) employee = "test_assign_stucture@salary.com" employee_doc_name = make_employee(employee) # clear the already assigned stuctures - frappe.db.sql('''delete from `tabSalary Structure Assignment` where employee=%s and salary_structure=%s ''', - ("test_assign_stucture@salary.com",salary_structure.name)) - #test structure_assignment - salary_structure.assign_salary_structure(employee=employee_doc_name,from_date='2013-01-01',base=5000,variable=200) - salary_structure_assignment = frappe.get_doc("Salary Structure Assignment",{'employee':employee_doc_name, 'from_date':'2013-01-01'}) + frappe.db.sql( + """delete from `tabSalary Structure Assignment` where employee=%s and salary_structure=%s """, + ("test_assign_stucture@salary.com", salary_structure.name), + ) + # test structure_assignment + salary_structure.assign_salary_structure( + employee=employee_doc_name, from_date="2013-01-01", base=5000, variable=200 + ) + salary_structure_assignment = frappe.get_doc( + "Salary Structure Assignment", {"employee": employee_doc_name, "from_date": "2013-01-01"} + ) self.assertEqual(salary_structure_assignment.docstatus, 1) self.assertEqual(salary_structure_assignment.base, 5000) self.assertEqual(salary_structure_assignment.variable, 200) def test_multi_currency_salary_structure(self): make_employee("test_muti_currency_employee@salary.com") - sal_struct = make_salary_structure("Salary Structure Multi Currency", "Monthly", currency='USD') - self.assertEqual(sal_struct.currency, 'USD') + sal_struct = make_salary_structure("Salary Structure Multi Currency", "Monthly", currency="USD") + self.assertEqual(sal_struct.currency, "USD") -def make_salary_structure(salary_structure, payroll_frequency, employee=None, - from_date=None, dont_submit=False, other_details=None,test_tax=False, - company=None, currency=erpnext.get_default_currency(), payroll_period=None): + +def make_salary_structure( + salary_structure, + payroll_frequency, + employee=None, + from_date=None, + dont_submit=False, + other_details=None, + test_tax=False, + company=None, + currency=erpnext.get_default_currency(), + payroll_period=None, + include_flexi_benefits=False, + base=None, +): if test_tax: - frappe.db.sql("""delete from `tabSalary Structure` where name=%s""",(salary_structure)) + frappe.db.sql("""delete from `tabSalary Structure` where name=%s""", (salary_structure)) if frappe.db.exists("Salary Structure", salary_structure): frappe.db.delete("Salary Structure", salary_structure) @@ -132,11 +162,18 @@ def make_salary_structure(salary_structure, payroll_frequency, employee=None, "doctype": "Salary Structure", "name": salary_structure, "company": company or erpnext.get_default_company(), - "earnings": make_earning_salary_component(setup=True, test_tax=test_tax, company_list=["_Test Company"]), - "deductions": make_deduction_salary_component(setup=True, test_tax=test_tax, company_list=["_Test Company"]), + "earnings": make_earning_salary_component( + setup=True, + test_tax=test_tax, + company_list=["_Test Company"], + include_flexi_benefits=include_flexi_benefits, + ), + "deductions": make_deduction_salary_component( + setup=True, test_tax=test_tax, company_list=["_Test Company"] + ), "payroll_frequency": payroll_frequency, - "payment_account": get_random("Account", filters={'account_currency': currency}), - "currency": currency + "payment_account": get_random("Account", filters={"account_currency": currency}), + "currency": currency, } if other_details and isinstance(other_details, dict): details.update(other_details) @@ -145,31 +182,45 @@ def make_salary_structure(salary_structure, payroll_frequency, employee=None, if not dont_submit: salary_structure_doc.submit() - filters = {'employee':employee, 'docstatus': 1} + filters = {"employee": employee, "docstatus": 1} if not from_date and payroll_period: from_date = payroll_period.start_date if from_date: - filters['from_date'] = from_date + filters["from_date"] = from_date - if employee and not frappe.db.get_value("Salary Structure Assignment", - filters) and salary_structure_doc.docstatus==1: + if ( + employee + and not frappe.db.get_value("Salary Structure Assignment", filters) + and salary_structure_doc.docstatus == 1 + ): create_salary_structure_assignment( employee, salary_structure, from_date=from_date, company=company, currency=currency, - payroll_period=payroll_period + payroll_period=payroll_period, + base=base, ) return salary_structure_doc -def create_salary_structure_assignment(employee, salary_structure, from_date=None, company=None, currency=erpnext.get_default_currency(), - payroll_period=None): - if frappe.db.exists("Salary Structure Assignment", {"employee": employee}): - frappe.db.sql("""delete from `tabSalary Structure Assignment` where employee=%s""",(employee)) +def create_salary_structure_assignment( + employee, + salary_structure, + from_date=None, + company=None, + currency=erpnext.get_default_currency(), + payroll_period=None, + base=None, + allow_duplicate=False, +): + if not allow_duplicate and frappe.db.exists( + "Salary Structure Assignment", {"employee": employee} + ): + frappe.db.sql("""delete from `tabSalary Structure Assignment` where employee=%s""", (employee)) if not payroll_period: payroll_period = create_payroll_period() @@ -181,7 +232,7 @@ def create_salary_structure_assignment(employee, salary_structure, from_date=Non salary_structure_assignment = frappe.new_doc("Salary Structure Assignment") salary_structure_assignment.employee = employee - salary_structure_assignment.base = 50000 + salary_structure_assignment.base = base or 50000 salary_structure_assignment.variable = 5000 if not from_date: @@ -200,6 +251,7 @@ def create_salary_structure_assignment(employee, salary_structure, from_date=Non salary_structure_assignment.submit() return salary_structure_assignment + def get_payable_account(company=None): if not company: company = erpnext.get_default_company() diff --git a/erpnext/payroll/doctype/salary_structure_assignment/salary_structure_assignment.py b/erpnext/payroll/doctype/salary_structure_assignment/salary_structure_assignment.py index e1ff9ca9f04..e34e48e6c05 100644 --- a/erpnext/payroll/doctype/salary_structure_assignment/salary_structure_assignment.py +++ b/erpnext/payroll/doctype/salary_structure_assignment/salary_structure_assignment.py @@ -8,7 +8,9 @@ from frappe.model.document import Document from frappe.utils import getdate -class DuplicateAssignment(frappe.ValidationError): pass +class DuplicateAssignment(frappe.ValidationError): + pass + class SalaryStructureAssignment(Document): def validate(self): @@ -17,56 +19,90 @@ class SalaryStructureAssignment(Document): self.set_payroll_payable_account() def validate_dates(self): - joining_date, relieving_date = frappe.db.get_value("Employee", self.employee, - ["date_of_joining", "relieving_date"]) + joining_date, relieving_date = frappe.db.get_value( + "Employee", self.employee, ["date_of_joining", "relieving_date"] + ) if self.from_date: - if frappe.db.exists("Salary Structure Assignment", {"employee": self.employee, "from_date": self.from_date, "docstatus": 1}): + if frappe.db.exists( + "Salary Structure Assignment", + {"employee": self.employee, "from_date": self.from_date, "docstatus": 1}, + ): frappe.throw(_("Salary Structure Assignment for Employee already exists"), DuplicateAssignment) if joining_date and getdate(self.from_date) < joining_date: - frappe.throw(_("From Date {0} cannot be before employee's joining Date {1}") - .format(self.from_date, joining_date)) + frappe.throw( + _("From Date {0} cannot be before employee's joining Date {1}").format( + self.from_date, joining_date + ) + ) # flag - old_employee is for migrating the old employees data via patch if relieving_date and getdate(self.from_date) > relieving_date and not self.flags.old_employee: - frappe.throw(_("From Date {0} cannot be after employee's relieving Date {1}") - .format(self.from_date, relieving_date)) + frappe.throw( + _("From Date {0} cannot be after employee's relieving Date {1}").format( + self.from_date, relieving_date + ) + ) def validate_income_tax_slab(self): if not self.income_tax_slab: return - income_tax_slab_currency = frappe.db.get_value('Income Tax Slab', self.income_tax_slab, 'currency') + income_tax_slab_currency = frappe.db.get_value( + "Income Tax Slab", self.income_tax_slab, "currency" + ) if self.currency != income_tax_slab_currency: - frappe.throw(_("Currency of selected Income Tax Slab should be {0} instead of {1}").format(self.currency, income_tax_slab_currency)) + frappe.throw( + _("Currency of selected Income Tax Slab should be {0} instead of {1}").format( + self.currency, income_tax_slab_currency + ) + ) def set_payroll_payable_account(self): if not self.payroll_payable_account: - payroll_payable_account = frappe.db.get_value('Company', self.company, 'default_payroll_payable_account') + payroll_payable_account = frappe.db.get_value( + "Company", self.company, "default_payroll_payable_account" + ) if not payroll_payable_account: payroll_payable_account = frappe.db.get_value( - "Account", { - "account_name": _("Payroll Payable"), "company": self.company, "account_currency": frappe.db.get_value( - "Company", self.company, "default_currency"), "is_group": 0}) + "Account", + { + "account_name": _("Payroll Payable"), + "company": self.company, + "account_currency": frappe.db.get_value("Company", self.company, "default_currency"), + "is_group": 0, + }, + ) self.payroll_payable_account = payroll_payable_account + def get_assigned_salary_structure(employee, on_date): if not employee or not on_date: return None - salary_structure = frappe.db.sql(""" + salary_structure = frappe.db.sql( + """ select salary_structure from `tabSalary Structure Assignment` where employee=%(employee)s and docstatus = 1 - and %(on_date)s >= from_date order by from_date desc limit 1""", { - 'employee': employee, - 'on_date': on_date, - }) + and %(on_date)s >= from_date order by from_date desc limit 1""", + { + "employee": employee, + "on_date": on_date, + }, + ) return salary_structure[0][0] if salary_structure else None + @frappe.whitelist() def get_employee_currency(employee): - employee_currency = frappe.db.get_value('Salary Structure Assignment', {'employee': employee}, 'currency') + employee_currency = frappe.db.get_value( + "Salary Structure Assignment", {"employee": employee}, "currency" + ) if not employee_currency: - frappe.throw(_("There is no Salary Structure assigned to {0}. First assign a Salary Stucture.").format(employee)) + frappe.throw( + _("There is no Salary Structure assigned to {0}. First assign a Salary Stucture.").format( + employee + ) + ) return employee_currency diff --git a/erpnext/payroll/notification/retention_bonus/retention_bonus.py b/erpnext/payroll/notification/retention_bonus/retention_bonus.py index 19b550feea7..02e3e933330 100644 --- a/erpnext/payroll/notification/retention_bonus/retention_bonus.py +++ b/erpnext/payroll/notification/retention_bonus/retention_bonus.py @@ -1,5 +1,3 @@ - - def get_context(context): # do your magic here pass diff --git a/erpnext/payroll/report/bank_remittance/bank_remittance.py b/erpnext/payroll/report/bank_remittance/bank_remittance.py index 6c3bd37b043..9d8efff8218 100644 --- a/erpnext/payroll/report/bank_remittance/bank_remittance.py +++ b/erpnext/payroll/report/bank_remittance/bank_remittance.py @@ -13,63 +13,47 @@ def execute(filters=None): "fieldtype": "Link", "fieldname": "payroll_no", "options": "Payroll Entry", - "width": 150 + "width": 150, }, { "label": _("Debit A/C Number"), "fieldtype": "Int", "fieldname": "debit_account", "hidden": 1, - "width": 200 - }, - { - "label": _("Payment Date"), - "fieldtype": "Data", - "fieldname": "payment_date", - "width": 100 + "width": 200, }, + {"label": _("Payment Date"), "fieldtype": "Data", "fieldname": "payment_date", "width": 100}, { "label": _("Employee Name"), "fieldtype": "Link", "fieldname": "employee_name", "options": "Employee", - "width": 200 - }, - { - "label": _("Bank Name"), - "fieldtype": "Data", - "fieldname": "bank_name", - "width": 50 + "width": 200, }, + {"label": _("Bank Name"), "fieldtype": "Data", "fieldname": "bank_name", "width": 50}, { "label": _("Employee A/C Number"), "fieldtype": "Int", "fieldname": "employee_account_no", - "width": 50 - } + "width": 50, + }, ] - if frappe.db.has_column('Employee', 'ifsc_code'): - columns.append({ - "label": _("IFSC Code"), - "fieldtype": "Data", - "fieldname": "bank_code", - "width": 100 - }) + if frappe.db.has_column("Employee", "ifsc_code"): + columns.append( + {"label": _("IFSC Code"), "fieldtype": "Data", "fieldname": "bank_code", "width": 100} + ) - columns += [{ - "label": _("Currency"), - "fieldtype": "Data", - "fieldname": "currency", - "width": 50 - }, - { - "label": _("Net Salary Amount"), - "fieldtype": "Currency", - "options": "currency", - "fieldname": "amount", - "width": 100 - }] + columns += [ + {"label": _("Currency"), "fieldtype": "Data", "fieldname": "currency", "width": 50}, + { + "label": _("Net Salary Amount"), + "fieldtype": "Currency", + "options": "currency", + "fieldname": "amount", + "width": 100, + }, + ] data = [] @@ -77,41 +61,48 @@ def execute(filters=None): payroll_entries = get_payroll_entries(accounts, filters) salary_slips = get_salary_slips(payroll_entries) - if frappe.db.has_column('Employee', 'ifsc_code'): + if frappe.db.has_column("Employee", "ifsc_code"): get_emp_bank_ifsc_code(salary_slips) for salary in salary_slips: - if salary.bank_name and salary.bank_account_no and salary.debit_acc_no and salary.status in ["Submitted", "Paid"]: + if ( + salary.bank_name + and salary.bank_account_no + and salary.debit_acc_no + and salary.status in ["Submitted", "Paid"] + ): row = { "payroll_no": salary.payroll_entry, "debit_account": salary.debit_acc_no, - "payment_date": frappe.utils.formatdate(salary.modified.strftime('%Y-%m-%d')), + "payment_date": frappe.utils.formatdate(salary.modified.strftime("%Y-%m-%d")), "bank_name": salary.bank_name, "employee_account_no": salary.bank_account_no, "bank_code": salary.ifsc_code, - "employee_name": salary.employee+": " + salary.employee_name, - "currency": frappe.get_cached_value('Company', filters.company, 'default_currency'), + "employee_name": salary.employee + ": " + salary.employee_name, + "currency": frappe.get_cached_value("Company", filters.company, "default_currency"), "amount": salary.net_pay, } data.append(row) return columns, data + def get_bank_accounts(): accounts = [d.name for d in get_all("Account", filters={"account_type": "Bank"})] return accounts + def get_payroll_entries(accounts, filters): payroll_filter = [ - ('payment_account', 'IN', accounts), - ('number_of_employees', '>', 0), - ('Company', '=', filters.company) + ("payment_account", "IN", accounts), + ("number_of_employees", ">", 0), + ("Company", "=", filters.company), ] if filters.to_date: - payroll_filter.append(('posting_date', '<', filters.to_date)) + payroll_filter.append(("posting_date", "<", filters.to_date)) if filters.from_date: - payroll_filter.append(('posting_date', '>', filters.from_date)) + payroll_filter.append(("posting_date", ">", filters.from_date)) entries = get_all("Payroll Entry", payroll_filter, ["name", "payment_account"]) @@ -119,10 +110,22 @@ def get_payroll_entries(accounts, filters): entries = set_company_account(payment_accounts, entries) return entries + def get_salary_slips(payroll_entries): - payroll = [d.name for d in payroll_entries] - salary_slips = get_all("Salary Slip", filters = [("payroll_entry", "IN", payroll)], - fields = ["modified", "net_pay", "bank_name", "bank_account_no", "payroll_entry", "employee", "employee_name", "status"] + payroll = [d.name for d in payroll_entries] + salary_slips = get_all( + "Salary Slip", + filters=[("payroll_entry", "IN", payroll)], + fields=[ + "modified", + "net_pay", + "bank_name", + "bank_account_no", + "payroll_entry", + "employee", + "employee_name", + "status", + ], ) payroll_entry_map = {} @@ -132,12 +135,13 @@ def get_salary_slips(payroll_entries): # appending company debit accounts for slip in salary_slips: if slip.payroll_entry: - slip["debit_acc_no"] = payroll_entry_map[slip.payroll_entry]['company_account'] + slip["debit_acc_no"] = payroll_entry_map[slip.payroll_entry]["company_account"] else: slip["debit_acc_no"] = None return salary_slips + def get_emp_bank_ifsc_code(salary_slips): emp_names = [d.employee for d in salary_slips] ifsc_codes = get_all("Employee", [("name", "IN", emp_names)], ["ifsc_code", "name"]) @@ -147,20 +151,23 @@ def get_emp_bank_ifsc_code(salary_slips): ifsc_codes_map[code.name] = code for slip in salary_slips: - slip["ifsc_code"] = ifsc_codes_map[code.name]['ifsc_code'] + slip["ifsc_code"] = ifsc_codes_map[code.name]["ifsc_code"] return salary_slips + def set_company_account(payment_accounts, payroll_entries): - company_accounts = get_all("Bank Account", [("account", "in", payment_accounts)], ["account", "bank_account_no"]) + company_accounts = get_all( + "Bank Account", [("account", "in", payment_accounts)], ["account", "bank_account_no"] + ) company_accounts_map = {} for acc in company_accounts: company_accounts_map[acc.account] = acc for entry in payroll_entries: - company_account = '' + company_account = "" if entry.payment_account in company_accounts_map: - company_account = company_accounts_map[entry.payment_account]['bank_account_no'] + company_account = company_accounts_map[entry.payment_account]["bank_account_no"] entry["company_account"] = company_account return payroll_entries diff --git a/erpnext/payroll/report/income_tax_deductions/income_tax_deductions.py b/erpnext/payroll/report/income_tax_deductions/income_tax_deductions.py index 75a9f97ea58..ccf16565c1f 100644 --- a/erpnext/payroll/report/income_tax_deductions/income_tax_deductions.py +++ b/erpnext/payroll/report/income_tax_deductions/income_tax_deductions.py @@ -14,6 +14,7 @@ def execute(filters=None): return columns, data + def get_columns(filters): columns = [ { @@ -21,65 +22,55 @@ def get_columns(filters): "options": "Employee", "fieldname": "employee", "fieldtype": "Link", - "width": 200 + "width": 200, }, { "label": _("Employee Name"), "options": "Employee", "fieldname": "employee_name", "fieldtype": "Link", - "width": 160 - }] + "width": 160, + }, + ] if erpnext.get_region() == "India": - columns.append({ - "label": _("PAN Number"), - "fieldname": "pan_number", - "fieldtype": "Data", - "width": 140 - }) + columns.append( + {"label": _("PAN Number"), "fieldname": "pan_number", "fieldtype": "Data", "width": 140} + ) - columns += [{ - "label": _("Income Tax Component"), - "fieldname": "it_comp", - "fieldtype": "Data", - "width": 170 - }, + columns += [ + {"label": _("Income Tax Component"), "fieldname": "it_comp", "fieldtype": "Data", "width": 170}, { "label": _("Income Tax Amount"), "fieldname": "it_amount", "fieldtype": "Currency", "options": "currency", - "width": 140 + "width": 140, }, { "label": _("Gross Pay"), "fieldname": "gross_pay", "fieldtype": "Currency", "options": "currency", - "width": 140 + "width": 140, }, - { - "label": _("Posting Date"), - "fieldname": "posting_date", - "fieldtype": "Date", - "width": 140 - } + {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date", "width": 140}, ] return columns + def get_conditions(filters): conditions = [""] if filters.get("department"): - conditions.append("sal.department = '%s' " % (filters["department"]) ) + conditions.append("sal.department = '%s' " % (filters["department"])) if filters.get("branch"): - conditions.append("sal.branch = '%s' " % (filters["branch"]) ) + conditions.append("sal.branch = '%s' " % (filters["branch"])) if filters.get("company"): - conditions.append("sal.company = '%s' " % (filters["company"]) ) + conditions.append("sal.company = '%s' " % (filters["company"])) if filters.get("month"): conditions.append("month(sal.start_date) = '%s' " % (filters["month"])) @@ -95,10 +86,14 @@ def get_data(filters): data = [] if erpnext.get_region() == "India": - employee_pan_dict = frappe._dict(frappe.db.sql(""" select employee, pan_number from `tabEmployee`""")) + employee_pan_dict = frappe._dict( + frappe.db.sql(""" select employee, pan_number from `tabEmployee`""") + ) - component_types = frappe.db.sql(""" select name from `tabSalary Component` - where is_income_tax_component = 1 """) + component_types = frappe.db.sql( + """ select name from `tabSalary Component` + where is_income_tax_component = 1 """ + ) component_types = [comp_type[0] for comp_type in component_types] @@ -107,14 +102,19 @@ def get_data(filters): conditions = get_conditions(filters) - entry = frappe.db.sql(""" select sal.employee, sal.employee_name, sal.posting_date, ded.salary_component, ded.amount,sal.gross_pay + entry = frappe.db.sql( + """ select sal.employee, sal.employee_name, sal.posting_date, ded.salary_component, ded.amount,sal.gross_pay from `tabSalary Slip` sal, `tabSalary Detail` ded where sal.name = ded.parent and ded.parentfield = 'deductions' and ded.parenttype = 'Salary Slip' and sal.docstatus = 1 %s and ded.salary_component in (%s) - """ % (conditions , ", ".join(['%s']*len(component_types))), tuple(component_types), as_dict=1) + """ + % (conditions, ", ".join(["%s"] * len(component_types))), + tuple(component_types), + as_dict=1, + ) for d in entry: @@ -125,7 +125,7 @@ def get_data(filters): "posting_date": d.posting_date, # "pan_number": employee_pan_dict.get(d.employee), "it_amount": d.amount, - "gross_pay": d.gross_pay + "gross_pay": d.gross_pay, } if erpnext.get_region() == "India": diff --git a/erpnext/payroll/report/salary_payments_based_on_payment_mode/salary_payments_based_on_payment_mode.py b/erpnext/payroll/report/salary_payments_based_on_payment_mode/salary_payments_based_on_payment_mode.py index fa68575e688..e5348df8864 100644 --- a/erpnext/payroll/report/salary_payments_based_on_payment_mode/salary_payments_based_on_payment_mode.py +++ b/erpnext/payroll/report/salary_payments_based_on_payment_mode/salary_payments_based_on_payment_mode.py @@ -19,42 +19,39 @@ def execute(filters=None): columns = get_columns(filters, mode_of_payments) data, total_rows, report_summary = get_data(filters, mode_of_payments) - chart = get_chart(mode_of_payments, total_rows) + chart = get_chart(mode_of_payments, total_rows) return columns, data, None, chart, report_summary + def get_columns(filters, mode_of_payments): - columns = [{ - "label": _("Branch"), - "options": "Branch", - "fieldname": "branch", - "fieldtype": "Link", - "width": 200 - }] + columns = [ + { + "label": _("Branch"), + "options": "Branch", + "fieldname": "branch", + "fieldtype": "Link", + "width": 200, + } + ] for mode in mode_of_payments: - columns.append({ - "label": _(mode), - "fieldname": mode, - "fieldtype": "Currency", - "width": 160 - }) + columns.append({"label": _(mode), "fieldname": mode, "fieldtype": "Currency", "width": 160}) - columns.append({ - "label": _("Total"), - "fieldname": "total", - "fieldtype": "Currency", - "width": 140 - }) + columns.append({"label": _("Total"), "fieldname": "total", "fieldtype": "Currency", "width": 140}) return columns + def get_payment_modes(): - mode_of_payments = frappe.db.sql_list(""" + mode_of_payments = frappe.db.sql_list( + """ select distinct mode_of_payment from `tabSalary Slip` where docstatus = 1 - """) + """ + ) return mode_of_payments + def prepare_data(entry): branch_wise_entries = {} gross_pay = 0 @@ -68,36 +65,42 @@ def prepare_data(entry): return branch_wise_entries, gross_pay + def get_data(filters, mode_of_payments): data = [] conditions = get_conditions(filters) - entry = frappe.db.sql(""" + entry = frappe.db.sql( + """ select branch, mode_of_payment, sum(net_pay) as net_pay, sum(gross_pay) as gross_pay from `tabSalary Slip` sal where docstatus = 1 %s group by branch, mode_of_payment - """ % (conditions), as_dict=1) + """ + % (conditions), + as_dict=1, + ) branch_wise_entries, gross_pay = prepare_data(entry) - branches = frappe.db.sql_list(""" + branches = frappe.db.sql_list( + """ select distinct branch from `tabSalary Slip` sal where docstatus = 1 %s - """ % (conditions)) + """ + % (conditions) + ) total_row = {"total": 0, "branch": "Total"} for branch in branches: total = 0 - row = { - "branch": branch - } + row = {"branch": branch} for mode in mode_of_payments: if branch_wise_entries.get(branch).get(mode): row[mode] = branch_wise_entries.get(branch).get(mode) - total += branch_wise_entries.get(branch).get(mode) + total += branch_wise_entries.get(branch).get(mode) row["total"] = total data.append(row) @@ -110,24 +113,18 @@ def get_data(filters, mode_of_payments): if data: data.append(total_row) data.append({}) - data.append({ - "branch": "Total Gross Pay", - mode_of_payments[0]:gross_pay - }) - data.append({ - "branch": "Total Deductions", - mode_of_payments[0]:total_deductions - }) - data.append({ - "branch": "Total Net Pay", - mode_of_payments[0]:total_row.get("total") - }) + data.append({"branch": "Total Gross Pay", mode_of_payments[0]: gross_pay}) + data.append({"branch": "Total Deductions", mode_of_payments[0]: total_deductions}) + data.append({"branch": "Total Net Pay", mode_of_payments[0]: total_row.get("total")}) currency = erpnext.get_company_currency(filters.company) - report_summary = get_report_summary(gross_pay, total_deductions, total_row.get("total"), currency) + report_summary = get_report_summary( + gross_pay, total_deductions, total_row.get("total"), currency + ) return data, total_row, report_summary + def get_total_based_on_mode_of_payment(data, mode_of_payments): total = 0 @@ -140,6 +137,7 @@ def get_total_based_on_mode_of_payment(data, mode_of_payments): total_row["total"] = total return total_row + def get_report_summary(gross_pay, total_deductions, net_pay, currency): return [ { @@ -147,24 +145,25 @@ def get_report_summary(gross_pay, total_deductions, net_pay, currency): "label": "Total Gross Pay", "indicator": "Green", "datatype": "Currency", - "currency": currency + "currency": currency, }, { "value": total_deductions, "label": "Total Deduction", "datatype": "Currency", "indicator": "Red", - "currency": currency + "currency": currency, }, { "value": net_pay, "label": "Total Net Pay", "datatype": "Currency", "indicator": "Blue", - "currency": currency - } + "currency": currency, + }, ] + def get_chart(mode_of_payments, data): if data: values = [] @@ -175,10 +174,7 @@ def get_chart(mode_of_payments, data): labels.append([mode]) chart = { - "data": { - "labels": labels, - "datasets": [{'name': 'Mode Of Payments', "values": values}] - } + "data": {"labels": labels, "datasets": [{"name": "Mode Of Payments", "values": values}]} } - chart['type'] = "bar" + chart["type"] = "bar" return chart diff --git a/erpnext/payroll/report/salary_payments_via_ecs/salary_payments_via_ecs.py b/erpnext/payroll/report/salary_payments_via_ecs/salary_payments_via_ecs.py index 578c8164009..4f9370b742b 100644 --- a/erpnext/payroll/report/salary_payments_via_ecs/salary_payments_via_ecs.py +++ b/erpnext/payroll/report/salary_payments_via_ecs/salary_payments_via_ecs.py @@ -14,6 +14,7 @@ def execute(filters=None): return columns, data + def get_columns(filters): columns = [ { @@ -21,71 +22,52 @@ def get_columns(filters): "options": "Branch", "fieldname": "branch", "fieldtype": "Link", - "width": 200 + "width": 200, }, { "label": _("Employee Name"), "options": "Employee", "fieldname": "employee_name", "fieldtype": "Link", - "width": 160 + "width": 160, }, { "label": _("Employee"), - "options":"Employee", + "options": "Employee", "fieldname": "employee", "fieldtype": "Link", - "width": 140 + "width": 140, }, { "label": _("Gross Pay"), "fieldname": "gross_pay", "fieldtype": "Currency", "options": "currency", - "width": 140 - }, - { - "label": _("Bank"), - "fieldname": "bank", - "fieldtype": "Data", - "width": 140 - }, - { - "label": _("Account No"), - "fieldname": "account_no", - "fieldtype": "Data", - "width": 140 + "width": 140, }, + {"label": _("Bank"), "fieldname": "bank", "fieldtype": "Data", "width": 140}, + {"label": _("Account No"), "fieldname": "account_no", "fieldtype": "Data", "width": 140}, ] if erpnext.get_region() == "India": columns += [ - { - "label": _("IFSC"), - "fieldname": "ifsc", - "fieldtype": "Data", - "width": 140 - }, - { - "label": _("MICR"), - "fieldname": "micr", - "fieldtype": "Data", - "width": 140 - } + {"label": _("IFSC"), "fieldname": "ifsc", "fieldtype": "Data", "width": 140}, + {"label": _("MICR"), "fieldname": "micr", "fieldtype": "Data", "width": 140}, ] return columns + def get_conditions(filters): conditions = [""] if filters.get("department"): - conditions.append("department = '%s' " % (filters["department"]) ) + conditions.append("department = '%s' " % (filters["department"])) if filters.get("branch"): - conditions.append("branch = '%s' " % (filters["branch"]) ) + conditions.append("branch = '%s' " % (filters["branch"])) if filters.get("company"): - conditions.append("company = '%s' " % (filters["company"]) ) + conditions.append("company = '%s' " % (filters["company"])) if filters.get("month"): conditions.append("month(start_date) = '%s' " % (filters["month"])) @@ -95,6 +77,7 @@ def get_conditions(filters): return " and ".join(conditions) + def get_data(filters): data = [] @@ -103,36 +86,39 @@ def get_data(filters): if erpnext.get_region() == "India": fields += ["ifsc_code", "micr_code"] - - employee_details = frappe.get_list("Employee", fields = fields) + employee_details = frappe.get_list("Employee", fields=fields) employee_data_dict = {} for d in employee_details: employee_data_dict.setdefault( - d.employee,{ - "bank_ac_no" : d.bank_ac_no, - "ifsc_code" : d.ifsc_code or None, - "micr_code" : d.micr_code or None, - "branch" : d.branch, - "salary_mode" : d.salary_mode, - "bank_name": d.bank_name - } + d.employee, + { + "bank_ac_no": d.bank_ac_no, + "ifsc_code": d.ifsc_code or None, + "micr_code": d.micr_code or None, + "branch": d.branch, + "salary_mode": d.salary_mode, + "bank_name": d.bank_name, + }, ) conditions = get_conditions(filters) - entry = frappe.db.sql(""" select employee, employee_name, gross_pay + entry = frappe.db.sql( + """ select employee, employee_name, gross_pay from `tabSalary Slip` where docstatus = 1 %s """ - %(conditions), as_dict =1) + % (conditions), + as_dict=1, + ) for d in entry: employee = { - "branch" : employee_data_dict.get(d.employee).get("branch"), - "employee_name" : d.employee_name, - "employee" : d.employee, - "gross_pay" : d.gross_pay, + "branch": employee_data_dict.get(d.employee).get("branch"), + "employee_name": d.employee_name, + "employee": d.employee, + "gross_pay": d.gross_pay, } if employee_data_dict.get(d.employee).get("salary_mode") == "Bank": @@ -144,7 +130,9 @@ def get_data(filters): else: employee["account_no"] = employee_data_dict.get(d.employee).get("salary_mode") - if filters.get("type") and employee_data_dict.get(d.employee).get("salary_mode") == filters.get("type"): + if filters.get("type") and employee_data_dict.get(d.employee).get("salary_mode") == filters.get( + "type" + ): data.append(employee) elif not filters.get("type"): data.append(employee) diff --git a/erpnext/payroll/report/salary_register/salary_register.py b/erpnext/payroll/report/salary_register/salary_register.py index 78deb227783..0a62b43a8ea 100644 --- a/erpnext/payroll/report/salary_register/salary_register.py +++ b/erpnext/payroll/report/salary_register/salary_register.py @@ -10,29 +10,46 @@ import erpnext def execute(filters=None): - if not filters: filters = {} + if not filters: + filters = {} currency = None - if filters.get('currency'): - currency = filters.get('currency') + if filters.get("currency"): + currency = filters.get("currency") company_currency = erpnext.get_company_currency(filters.get("company")) salary_slips = get_salary_slips(filters, company_currency) - if not salary_slips: return [], [] + if not salary_slips: + return [], [] columns, earning_types, ded_types = get_columns(salary_slips) ss_earning_map = get_ss_earning_map(salary_slips, currency, company_currency) - ss_ded_map = get_ss_ded_map(salary_slips,currency, company_currency) + ss_ded_map = get_ss_ded_map(salary_slips, currency, company_currency) doj_map = get_employee_doj_map() data = [] for ss in salary_slips: - row = [ss.name, ss.employee, ss.employee_name, doj_map.get(ss.employee), ss.branch, ss.department, ss.designation, - ss.company, ss.start_date, ss.end_date, ss.leave_without_pay, ss.payment_days] - - if ss.branch is not None: columns[3] = columns[3].replace('-1','120') - if ss.department is not None: columns[4] = columns[4].replace('-1','120') - if ss.designation is not None: columns[5] = columns[5].replace('-1','120') - if ss.leave_without_pay is not None: columns[9] = columns[9].replace('-1','130') + row = [ + ss.name, + ss.employee, + ss.employee_name, + doj_map.get(ss.employee), + ss.branch, + ss.department, + ss.designation, + ss.company, + ss.start_date, + ss.end_date, + ss.leave_without_pay, + ss.payment_days, + ] + if ss.branch is not None: + columns[3] = columns[3].replace("-1", "120") + if ss.department is not None: + columns[4] = columns[4].replace("-1", "120") + if ss.designation is not None: + columns[5] = columns[5].replace("-1", "120") + if ss.leave_without_pay is not None: + columns[9] = columns[9].replace("-1", "130") for e in earning_types: row.append(ss_earning_map.get(ss.name, {}).get(e)) @@ -48,7 +65,10 @@ def execute(filters=None): row.append(ss.total_loan_repayment) if currency == company_currency: - row += [flt(ss.total_deduction) * flt(ss.exchange_rate), flt(ss.net_pay) * flt(ss.exchange_rate)] + row += [ + flt(ss.total_deduction) * flt(ss.exchange_rate), + flt(ss.net_pay) * flt(ss.exchange_rate), + ] else: row += [ss.total_deduction, ss.net_pay] row.append(currency or company_currency) @@ -56,53 +76,81 @@ def execute(filters=None): return columns, data + def get_columns(salary_slips): + """ + columns = [ + _("Salary Slip ID") + ":Link/Salary Slip:150", + _("Employee") + ":Link/Employee:120", + _("Employee Name") + "::140", + _("Date of Joining") + "::80", + _("Branch") + ":Link/Branch:120", + _("Department") + ":Link/Department:120", + _("Designation") + ":Link/Designation:120", + _("Company") + ":Link/Company:120", + _("Start Date") + "::80", + _("End Date") + "::80", + _("Leave Without Pay") + ":Float:130", + _("Payment Days") + ":Float:120", + _("Currency") + ":Link/Currency:80" + ] """ columns = [ _("Salary Slip ID") + ":Link/Salary Slip:150", _("Employee") + ":Link/Employee:120", _("Employee Name") + "::140", _("Date of Joining") + "::80", - _("Branch") + ":Link/Branch:120", - _("Department") + ":Link/Department:120", + _("Branch") + ":Link/Branch:-1", + _("Department") + ":Link/Department:-1", _("Designation") + ":Link/Designation:120", _("Company") + ":Link/Company:120", _("Start Date") + "::80", _("End Date") + "::80", - _("Leave Without Pay") + ":Float:130", + _("Leave Without Pay") + ":Float:50", _("Payment Days") + ":Float:120", - _("Currency") + ":Link/Currency:80" - ] - """ - columns = [ - _("Salary Slip ID") + ":Link/Salary Slip:150",_("Employee") + ":Link/Employee:120", _("Employee Name") + "::140", - _("Date of Joining") + "::80", _("Branch") + ":Link/Branch:-1", _("Department") + ":Link/Department:-1", - _("Designation") + ":Link/Designation:120", _("Company") + ":Link/Company:120", _("Start Date") + "::80", - _("End Date") + "::80", _("Leave Without Pay") + ":Float:50", _("Payment Days") + ":Float:120" ] salary_components = {_("Earning"): [], _("Deduction"): []} - for component in frappe.db.sql("""select distinct sd.salary_component, sc.type + for component in frappe.db.sql( + """select distinct sd.salary_component, sc.type from `tabSalary Detail` sd, `tabSalary Component` sc - where sc.name=sd.salary_component and sd.amount != 0 and sd.parent in (%s)""" % - (', '.join(['%s']*len(salary_slips))), tuple([d.name for d in salary_slips]), as_dict=1): + where sc.name=sd.salary_component and sd.amount != 0 and sd.parent in (%s)""" + % (", ".join(["%s"] * len(salary_slips))), + tuple([d.name for d in salary_slips]), + as_dict=1, + ): salary_components[_(component.type)].append(component.salary_component) - columns = columns + [(e + ":Currency:120") for e in salary_components[_("Earning")]] + \ - [_("Gross Pay") + ":Currency:120"] + [(d + ":Currency:120") for d in salary_components[_("Deduction")]] + \ - [_("Loan Repayment") + ":Currency:120", _("Total Deduction") + ":Currency:120", _("Net Pay") + ":Currency:120"] + columns = ( + columns + + [(e + ":Currency:120") for e in salary_components[_("Earning")]] + + [_("Gross Pay") + ":Currency:120"] + + [(d + ":Currency:120") for d in salary_components[_("Deduction")]] + + [ + _("Loan Repayment") + ":Currency:120", + _("Total Deduction") + ":Currency:120", + _("Net Pay") + ":Currency:120", + ] + ) return columns, salary_components[_("Earning")], salary_components[_("Deduction")] + def get_salary_slips(filters, company_currency): - filters.update({"from_date": filters.get("from_date"), "to_date":filters.get("to_date")}) + filters.update({"from_date": filters.get("from_date"), "to_date": filters.get("to_date")}) conditions, filters = get_conditions(filters, company_currency) - salary_slips = frappe.db.sql("""select * from `tabSalary Slip` where %s - order by employee""" % conditions, filters, as_dict=1) + salary_slips = frappe.db.sql( + """select * from `tabSalary Slip` where %s + order by employee""" + % conditions, + filters, + as_dict=1, + ) return salary_slips or [] + def get_conditions(filters, company_currency): conditions = "" doc_status = {"Draft": 0, "Submitted": 1, "Cancelled": 2} @@ -110,48 +158,71 @@ def get_conditions(filters, company_currency): if filters.get("docstatus"): conditions += "docstatus = {0}".format(doc_status[filters.get("docstatus")]) - if filters.get("from_date"): conditions += " and start_date >= %(from_date)s" - if filters.get("to_date"): conditions += " and end_date <= %(to_date)s" - if filters.get("company"): conditions += " and company = %(company)s" - if filters.get("employee"): conditions += " and employee = %(employee)s" + if filters.get("from_date"): + conditions += " and start_date >= %(from_date)s" + if filters.get("to_date"): + conditions += " and end_date <= %(to_date)s" + if filters.get("company"): + conditions += " and company = %(company)s" + if filters.get("employee"): + conditions += " and employee = %(employee)s" if filters.get("currency") and filters.get("currency") != company_currency: conditions += " and currency = %(currency)s" return conditions, filters + def get_employee_doj_map(): - return frappe._dict(frappe.db.sql(""" + return frappe._dict( + frappe.db.sql( + """ SELECT employee, date_of_joining FROM `tabEmployee` - """)) + """ + ) + ) + def get_ss_earning_map(salary_slips, currency, company_currency): - ss_earnings = frappe.db.sql("""select sd.parent, sd.salary_component, sd.amount, ss.exchange_rate, ss.name - from `tabSalary Detail` sd, `tabSalary Slip` ss where sd.parent=ss.name and sd.parent in (%s)""" % - (', '.join(['%s']*len(salary_slips))), tuple([d.name for d in salary_slips]), as_dict=1) + ss_earnings = frappe.db.sql( + """select sd.parent, sd.salary_component, sd.amount, ss.exchange_rate, ss.name + from `tabSalary Detail` sd, `tabSalary Slip` ss where sd.parent=ss.name and sd.parent in (%s)""" + % (", ".join(["%s"] * len(salary_slips))), + tuple([d.name for d in salary_slips]), + as_dict=1, + ) ss_earning_map = {} for d in ss_earnings: ss_earning_map.setdefault(d.parent, frappe._dict()).setdefault(d.salary_component, 0.0) if currency == company_currency: - ss_earning_map[d.parent][d.salary_component] += flt(d.amount) * flt(d.exchange_rate if d.exchange_rate else 1) + ss_earning_map[d.parent][d.salary_component] += flt(d.amount) * flt( + d.exchange_rate if d.exchange_rate else 1 + ) else: ss_earning_map[d.parent][d.salary_component] += flt(d.amount) return ss_earning_map + def get_ss_ded_map(salary_slips, currency, company_currency): - ss_deductions = frappe.db.sql("""select sd.parent, sd.salary_component, sd.amount, ss.exchange_rate, ss.name - from `tabSalary Detail` sd, `tabSalary Slip` ss where sd.parent=ss.name and sd.parent in (%s)""" % - (', '.join(['%s']*len(salary_slips))), tuple([d.name for d in salary_slips]), as_dict=1) + ss_deductions = frappe.db.sql( + """select sd.parent, sd.salary_component, sd.amount, ss.exchange_rate, ss.name + from `tabSalary Detail` sd, `tabSalary Slip` ss where sd.parent=ss.name and sd.parent in (%s)""" + % (", ".join(["%s"] * len(salary_slips))), + tuple([d.name for d in salary_slips]), + as_dict=1, + ) ss_ded_map = {} for d in ss_deductions: ss_ded_map.setdefault(d.parent, frappe._dict()).setdefault(d.salary_component, 0.0) if currency == company_currency: - ss_ded_map[d.parent][d.salary_component] += flt(d.amount) * flt(d.exchange_rate if d.exchange_rate else 1) + ss_ded_map[d.parent][d.salary_component] += flt(d.amount) * flt( + d.exchange_rate if d.exchange_rate else 1 + ) else: ss_ded_map[d.parent][d.salary_component] += flt(d.amount) diff --git a/erpnext/portal/doctype/homepage/homepage.py b/erpnext/portal/doctype/homepage/homepage.py index 8092ba208a4..0d2e3607881 100644 --- a/erpnext/portal/doctype/homepage/homepage.py +++ b/erpnext/portal/doctype/homepage/homepage.py @@ -11,17 +11,27 @@ class Homepage(Document): def validate(self): if not self.description: self.description = frappe._("This is an example website auto-generated from ERPNext") - delete_page_cache('home') + delete_page_cache("home") def setup_items(self): - for d in frappe.get_all('Website Item', fields=['name', 'item_name', 'description', 'image', 'route'], - filters={'published': 1}, limit=3): + for d in frappe.get_all( + "Website Item", + fields=["name", "item_name", "description", "website_image", "route"], + filters={"published": 1}, + limit=3, + ): - doc = frappe.get_doc('Website Item', d.name) + doc = frappe.get_doc("Website Item", d.name) if not doc.route: # set missing route doc.save() - self.append('products', dict(item_code=d.name, - item_name=d.item_name, description=d.description, - image=d.image, route=d.route)) - + self.append( + "products", + dict( + item_code=d.name, + item_name=d.item_name, + description=d.description, + image=d.website_image, + route=d.route, + ), + ) diff --git a/erpnext/portal/doctype/homepage/test_homepage.py b/erpnext/portal/doctype/homepage/test_homepage.py index 9eb1f015af6..c8a1a1deec2 100644 --- a/erpnext/portal/doctype/homepage/test_homepage.py +++ b/erpnext/portal/doctype/homepage/test_homepage.py @@ -10,7 +10,7 @@ from frappe.website.render import render class TestHomepage(unittest.TestCase): def test_homepage_load(self): - set_request(method='GET', path='home') + set_request(method="GET", path="home") response = render() self.assertEqual(response.status_code, 200) diff --git a/erpnext/portal/doctype/homepage_section/test_homepage_section.py b/erpnext/portal/doctype/homepage_section/test_homepage_section.py index 4b8ba3002f0..ae1183a5a51 100644 --- a/erpnext/portal/doctype/homepage_section/test_homepage_section.py +++ b/erpnext/portal/doctype/homepage_section/test_homepage_section.py @@ -12,65 +12,79 @@ from frappe.website.render import render class TestHomepageSection(unittest.TestCase): def test_homepage_section_card(self): try: - frappe.get_doc({ - 'doctype': 'Homepage Section', - 'name': 'Card Section', - 'section_based_on': 'Cards', - 'section_cards': [ - {'title': 'Card 1', 'subtitle': 'Subtitle 1', 'content': 'This is test card 1', 'route': '/card-1'}, - {'title': 'Card 2', 'subtitle': 'Subtitle 2', 'content': 'This is test card 2', 'image': 'test.jpg'}, - ], - 'no_of_columns': 3 - }).insert() + frappe.get_doc( + { + "doctype": "Homepage Section", + "name": "Card Section", + "section_based_on": "Cards", + "section_cards": [ + { + "title": "Card 1", + "subtitle": "Subtitle 1", + "content": "This is test card 1", + "route": "/card-1", + }, + { + "title": "Card 2", + "subtitle": "Subtitle 2", + "content": "This is test card 2", + "image": "test.jpg", + }, + ], + "no_of_columns": 3, + } + ).insert() except frappe.DuplicateEntryError: pass - set_request(method='GET', path='home') + set_request(method="GET", path="home") response = render() self.assertEqual(response.status_code, 200) html = frappe.safe_decode(response.get_data()) - soup = BeautifulSoup(html, 'html.parser') - sections = soup.find('main').find_all('section') + soup = BeautifulSoup(html, "html.parser") + sections = soup.find("main").find_all("section") self.assertEqual(len(sections), 3) homepage_section = sections[2] - self.assertEqual(homepage_section.h3.text, 'Card Section') + self.assertEqual(homepage_section.h3.text, "Card Section") cards = homepage_section.find_all(class_="card") self.assertEqual(len(cards), 2) - self.assertEqual(cards[0].h5.text, 'Card 1') - self.assertEqual(cards[0].a['href'], '/card-1') - self.assertEqual(cards[1].p.text, 'Subtitle 2') - self.assertEqual(cards[1].find(class_='website-image-lazy')['data-src'], 'test.jpg') + self.assertEqual(cards[0].h5.text, "Card 1") + self.assertEqual(cards[0].a["href"], "/card-1") + self.assertEqual(cards[1].p.text, "Subtitle 2") + self.assertEqual(cards[1].find(class_="website-image-lazy")["data-src"], "test.jpg") # cleanup frappe.db.rollback() def test_homepage_section_custom_html(self): - frappe.get_doc({ - 'doctype': 'Homepage Section', - 'name': 'Custom HTML Section', - 'section_based_on': 'Custom HTML', - 'section_html': '
My custom html
',
- }).insert()
+ frappe.get_doc(
+ {
+ "doctype": "Homepage Section",
+ "name": "Custom HTML Section",
+ "section_based_on": "Custom HTML",
+ "section_html": 'My custom html
',
+ }
+ ).insert()
- set_request(method='GET', path='home')
+ set_request(method="GET", path="home")
response = render()
self.assertEqual(response.status_code, 200)
html = frappe.safe_decode(response.get_data())
- soup = BeautifulSoup(html, 'html.parser')
- sections = soup.find('main').find_all(class_='custom-section')
+ soup = BeautifulSoup(html, "html.parser")
+ sections = soup.find("main").find_all(class_="custom-section")
self.assertEqual(len(sections), 1)
homepage_section = sections[0]
- self.assertEqual(homepage_section.text, 'My custom html')
+ self.assertEqual(homepage_section.text, "My custom html")
# cleanup
frappe.db.rollback()
diff --git a/erpnext/portal/utils.py b/erpnext/portal/utils.py
index 4552e1257d0..09d100708e3 100644
--- a/erpnext/portal/utils.py
+++ b/erpnext/portal/utils.py
@@ -1,4 +1,3 @@
-
import frappe
from frappe.utils.nestedset import get_root_of
@@ -9,40 +8,41 @@ from erpnext.e_commerce.shopping_cart.cart import get_debtors_account
def set_default_role(doc, method):
- '''Set customer, supplier, student, guardian based on email'''
+ """Set customer, supplier, student, guardian based on email"""
if frappe.flags.setting_role or frappe.flags.in_migrate:
return
roles = frappe.get_roles(doc.name)
- contact_name = frappe.get_value('Contact', dict(email_id=doc.email))
+ contact_name = frappe.get_value("Contact", dict(email_id=doc.email))
if contact_name:
- contact = frappe.get_doc('Contact', contact_name)
+ contact = frappe.get_doc("Contact", contact_name)
for link in contact.links:
frappe.flags.setting_role = True
- if link.link_doctype=='Customer' and 'Customer' not in roles:
- doc.add_roles('Customer')
- elif link.link_doctype=='Supplier' and 'Supplier' not in roles:
- doc.add_roles('Supplier')
- elif frappe.get_value('Student', dict(student_email_id=doc.email)) and 'Student' not in roles:
- doc.add_roles('Student')
- elif frappe.get_value('Guardian', dict(email_address=doc.email)) and 'Guardian' not in roles:
- doc.add_roles('Guardian')
+ if link.link_doctype == "Customer" and "Customer" not in roles:
+ doc.add_roles("Customer")
+ elif link.link_doctype == "Supplier" and "Supplier" not in roles:
+ doc.add_roles("Supplier")
+ elif frappe.get_value("Student", dict(student_email_id=doc.email)) and "Student" not in roles:
+ doc.add_roles("Student")
+ elif frappe.get_value("Guardian", dict(email_address=doc.email)) and "Guardian" not in roles:
+ doc.add_roles("Guardian")
+
def create_customer_or_supplier():
- '''Based on the default Role (Customer, Supplier), create a Customer / Supplier.
+ """Based on the default Role (Customer, Supplier), create a Customer / Supplier.
Called on_session_creation hook.
- '''
+ """
user = frappe.session.user
- if frappe.db.get_value('User', user, 'user_type') != 'Website User':
+ if frappe.db.get_value("User", user, "user_type") != "Website User":
return
user_roles = frappe.get_roles()
- portal_settings = frappe.get_single('Portal Settings')
+ portal_settings = frappe.get_single("Portal Settings")
default_role = portal_settings.default_role
- if default_role not in ['Customer', 'Supplier']:
+ if default_role not in ["Customer", "Supplier"]:
return
# create customer / supplier if the user has that role
@@ -60,34 +60,33 @@ def create_customer_or_supplier():
party = frappe.new_doc(doctype)
fullname = frappe.utils.get_fullname(user)
- if doctype == 'Customer':
+ if doctype == "Customer":
cart_settings = get_shopping_cart_settings()
if cart_settings.enable_checkout:
debtors_account = get_debtors_account(cart_settings)
else:
- debtors_account = ''
+ debtors_account = ""
- party.update({
- "customer_name": fullname,
- "customer_type": "Individual",
- "customer_group": cart_settings.default_customer_group,
- "territory": get_root_of("Territory")
- })
+ party.update(
+ {
+ "customer_name": fullname,
+ "customer_type": "Individual",
+ "customer_group": cart_settings.default_customer_group,
+ "territory": get_root_of("Territory"),
+ }
+ )
if debtors_account:
- party.update({
- "accounts": [{
- "company": cart_settings.company,
- "account": debtors_account
- }]
- })
+ party.update({"accounts": [{"company": cart_settings.company, "account": debtors_account}]})
else:
- party.update({
- "supplier_name": fullname,
- "supplier_group": "All Supplier Groups",
- "supplier_type": "Individual"
- })
+ party.update(
+ {
+ "supplier_name": fullname,
+ "supplier_group": "All Supplier Groups",
+ "supplier_type": "Individual",
+ }
+ )
party.flags.ignore_mandatory = True
party.insert(ignore_permissions=True)
@@ -96,28 +95,27 @@ def create_customer_or_supplier():
if party_exists(alternate_doctype, user):
# if user is both customer and supplier, alter fullname to avoid contact name duplication
- fullname += "-" + doctype
+ fullname += "-" + doctype
create_party_contact(doctype, fullname, user, party.name)
return party
+
def create_party_contact(doctype, fullname, user, party_name):
contact = frappe.new_doc("Contact")
- contact.update({
- "first_name": fullname,
- "email_id": user
- })
- contact.append('links', dict(link_doctype=doctype, link_name=party_name))
- contact.append('email_ids', dict(email_id=user))
+ contact.update({"first_name": fullname, "email_id": user})
+ contact.append("links", dict(link_doctype=doctype, link_name=party_name))
+ contact.append("email_ids", dict(email_id=user))
contact.flags.ignore_mandatory = True
contact.insert(ignore_permissions=True)
+
def party_exists(doctype, user):
# check if contact exists against party and if it is linked to the doctype
contact_name = frappe.db.get_value("Contact", {"email_id": user})
if contact_name:
- contact = frappe.get_doc('Contact', contact_name)
+ contact = frappe.get_doc("Contact", contact_name)
doctypes = [d.link_doctype for d in contact.links]
return doctype in doctypes
diff --git a/erpnext/projects/doctype/activity_cost/activity_cost.py b/erpnext/projects/doctype/activity_cost/activity_cost.py
index bc4bb9dcba4..b99aa1e37d5 100644
--- a/erpnext/projects/doctype/activity_cost/activity_cost.py
+++ b/erpnext/projects/doctype/activity_cost/activity_cost.py
@@ -7,7 +7,9 @@ from frappe import _
from frappe.model.document import Document
-class DuplicationError(frappe.ValidationError): pass
+class DuplicationError(frappe.ValidationError):
+ pass
+
class ActivityCost(Document):
def validate(self):
@@ -24,12 +26,22 @@ class ActivityCost(Document):
def check_unique(self):
if self.employee:
- if frappe.db.sql("""select name from `tabActivity Cost` where employee_name= %s and activity_type= %s and name != %s""",
- (self.employee_name, self.activity_type, self.name)):
- frappe.throw(_("Activity Cost exists for Employee {0} against Activity Type - {1}")
- .format(self.employee, self.activity_type), DuplicationError)
+ if frappe.db.sql(
+ """select name from `tabActivity Cost` where employee_name= %s and activity_type= %s and name != %s""",
+ (self.employee_name, self.activity_type, self.name),
+ ):
+ frappe.throw(
+ _("Activity Cost exists for Employee {0} against Activity Type - {1}").format(
+ self.employee, self.activity_type
+ ),
+ DuplicationError,
+ )
else:
- if frappe.db.sql("""select name from `tabActivity Cost` where ifnull(employee, '')='' and activity_type= %s and name != %s""",
- (self.activity_type, self.name)):
- frappe.throw(_("Default Activity Cost exists for Activity Type - {0}")
- .format(self.activity_type), DuplicationError)
+ if frappe.db.sql(
+ """select name from `tabActivity Cost` where ifnull(employee, '')='' and activity_type= %s and name != %s""",
+ (self.activity_type, self.name),
+ ):
+ frappe.throw(
+ _("Default Activity Cost exists for Activity Type - {0}").format(self.activity_type),
+ DuplicationError,
+ )
diff --git a/erpnext/projects/doctype/activity_cost/test_activity_cost.py b/erpnext/projects/doctype/activity_cost/test_activity_cost.py
index d53e582adc6..8da797ed4f2 100644
--- a/erpnext/projects/doctype/activity_cost/test_activity_cost.py
+++ b/erpnext/projects/doctype/activity_cost/test_activity_cost.py
@@ -11,15 +11,17 @@ from erpnext.projects.doctype.activity_cost.activity_cost import DuplicationErro
class TestActivityCost(unittest.TestCase):
def test_duplication(self):
frappe.db.sql("delete from `tabActivity Cost`")
- activity_cost1 = frappe.new_doc('Activity Cost')
- activity_cost1.update({
- "employee": "_T-Employee-00001",
- "employee_name": "_Test Employee",
- "activity_type": "_Test Activity Type 1",
- "billing_rate": 100,
- "costing_rate": 50
- })
+ activity_cost1 = frappe.new_doc("Activity Cost")
+ activity_cost1.update(
+ {
+ "employee": "_T-Employee-00001",
+ "employee_name": "_Test Employee",
+ "activity_type": "_Test Activity Type 1",
+ "billing_rate": 100,
+ "costing_rate": 50,
+ }
+ )
activity_cost1.insert()
activity_cost2 = frappe.copy_doc(activity_cost1)
- self.assertRaises(DuplicationError, activity_cost2.insert )
+ self.assertRaises(DuplicationError, activity_cost2.insert)
frappe.db.sql("delete from `tabActivity Cost`")
diff --git a/erpnext/projects/doctype/activity_type/test_activity_type.py b/erpnext/projects/doctype/activity_type/test_activity_type.py
index bb74b881f4c..d51439eb5b1 100644
--- a/erpnext/projects/doctype/activity_type/test_activity_type.py
+++ b/erpnext/projects/doctype/activity_type/test_activity_type.py
@@ -3,4 +3,4 @@
import frappe
-test_records = frappe.get_test_records('Activity Type')
+test_records = frappe.get_test_records("Activity Type")
diff --git a/erpnext/projects/doctype/project/project.js b/erpnext/projects/doctype/project/project.js
index 31460f66ea3..9f1bdb0a11d 100644
--- a/erpnext/projects/doctype/project/project.js
+++ b/erpnext/projects/doctype/project/project.js
@@ -134,6 +134,7 @@ function open_form(frm, doctype, child_doctype, parentfield) {
new_child_doc.parentfield = parentfield;
new_child_doc.parenttype = doctype;
new_doc[parentfield] = [new_child_doc];
+ new_doc.project = frm.doc.name;
frappe.ui.form.make_quick_entry(doctype, null, null, new_doc);
});
diff --git a/erpnext/projects/doctype/project/project.json b/erpnext/projects/doctype/project/project.json
index 2570df70261..4aeef81cbfb 100644
--- a/erpnext/projects/doctype/project/project.json
+++ b/erpnext/projects/doctype/project/project.json
@@ -234,7 +234,7 @@
},
{
"fieldname": "actual_start_date",
- "fieldtype": "Data",
+ "fieldtype": "Date",
"label": "Actual Start Date",
"read_only": 1
},
@@ -458,7 +458,7 @@
"index_web_pages_for_search": 1,
"links": [],
"max_attachments": 4,
- "modified": "2021-04-28 16:36:11.654632",
+ "modified": "2022-05-25 22:45:06.108499",
"modified_by": "Administrator",
"module": "Projects",
"name": "Project",
@@ -502,4 +502,4 @@
"timeline_field": "customer",
"title_field": "project_name",
"track_seen": 1
-}
\ No newline at end of file
+}
diff --git a/erpnext/projects/doctype/project/project.py b/erpnext/projects/doctype/project/project.py
index 5ffae2d0fb9..6b691786a1a 100644
--- a/erpnext/projects/doctype/project/project.py
+++ b/erpnext/projects/doctype/project/project.py
@@ -17,20 +17,26 @@ from erpnext.hr.doctype.holiday_list.holiday_list import is_holiday
class Project(Document):
def get_feed(self):
- return '{0}: {1}'.format(_(self.status), frappe.safe_decode(self.project_name))
+ return "{0}: {1}".format(_(self.status), frappe.safe_decode(self.project_name))
def onload(self):
- self.set_onload('activity_summary', frappe.db.sql('''select activity_type,
+ self.set_onload(
+ "activity_summary",
+ frappe.db.sql(
+ """select activity_type,
sum(hours) as total_hours
from `tabTimesheet Detail` where project=%s and docstatus < 2 group by activity_type
- order by total_hours desc''', self.name, as_dict=True))
+ order by total_hours desc""",
+ self.name,
+ as_dict=True,
+ ),
+ )
self.update_costing()
def before_print(self, settings=None):
self.onload()
-
def validate(self):
if not self.is_new():
self.copy_from_template()
@@ -39,17 +45,17 @@ class Project(Document):
self.update_percent_complete()
def copy_from_template(self):
- '''
+ """
Copy tasks from template
- '''
- if self.project_template and not frappe.db.get_all('Task', dict(project = self.name), limit=1):
+ """
+ if self.project_template and not frappe.db.get_all("Task", dict(project=self.name), limit=1):
# has a template, and no loaded tasks, so lets create
if not self.expected_start_date:
# project starts today
self.expected_start_date = today()
- template = frappe.get_doc('Project Template', self.project_template)
+ template = frappe.get_doc("Project Template", self.project_template)
if not self.project_type:
self.project_type = template.project_type
@@ -65,19 +71,22 @@ class Project(Document):
self.dependency_mapping(tmp_task_details, project_tasks)
def create_task_from_template(self, task_details):
- return frappe.get_doc(dict(
- doctype = 'Task',
- subject = task_details.subject,
- project = self.name,
- status = 'Open',
- exp_start_date = self.calculate_start_date(task_details),
- exp_end_date = self.calculate_end_date(task_details),
- description = task_details.description,
- task_weight = task_details.task_weight,
- type = task_details.type,
- issue = task_details.issue,
- is_group = task_details.is_group
- )).insert()
+ return frappe.get_doc(
+ dict(
+ doctype="Task",
+ subject=task_details.subject,
+ project=self.name,
+ status="Open",
+ exp_start_date=self.calculate_start_date(task_details),
+ exp_end_date=self.calculate_end_date(task_details),
+ description=task_details.description,
+ task_weight=task_details.task_weight,
+ type=task_details.type,
+ issue=task_details.issue,
+ is_group=task_details.is_group,
+ color=task_details.color,
+ )
+ ).insert()
def calculate_start_date(self, task_details):
self.start_date = add_days(self.expected_start_date, task_details.start)
@@ -105,23 +114,26 @@ class Project(Document):
if template_task.get("depends_on") and not project_task.get("depends_on"):
for child_task in template_task.get("depends_on"):
child_task_subject = frappe.db.get_value("Task", child_task.task, "subject")
- corresponding_project_task = list(filter(lambda x: x.subject == child_task_subject, project_tasks))
+ corresponding_project_task = list(
+ filter(lambda x: x.subject == child_task_subject, project_tasks)
+ )
if len(corresponding_project_task):
- project_task.append("depends_on",{
- "task": corresponding_project_task[0].name
- })
+ project_task.append("depends_on", {"task": corresponding_project_task[0].name})
project_task.save()
def check_for_parent_tasks(self, template_task, project_task, project_tasks):
if template_task.get("parent_task") and not project_task.get("parent_task"):
parent_task_subject = frappe.db.get_value("Task", template_task.get("parent_task"), "subject")
- corresponding_project_task = list(filter(lambda x: x.subject == parent_task_subject, project_tasks))
+ corresponding_project_task = list(
+ filter(lambda x: x.subject == parent_task_subject, project_tasks)
+ )
if len(corresponding_project_task):
project_task.parent_task = corresponding_project_task[0].name
project_task.save()
def is_row_updated(self, row, existing_task_data, fields):
- if self.get("__islocal") or not existing_task_data: return True
+ if self.get("__islocal") or not existing_task_data:
+ return True
d = existing_task_data.get(row.task_id, {})
@@ -130,7 +142,7 @@ class Project(Document):
return True
def update_project(self):
- '''Called externally by Task'''
+ """Called externally by Task"""
self.update_percent_complete()
self.update_costing()
self.db_update()
@@ -149,52 +161,74 @@ class Project(Document):
self.percent_complete = 100
return
- total = frappe.db.count('Task', dict(project=self.name))
+ total = frappe.db.count("Task", dict(project=self.name))
if not total:
self.percent_complete = 0
else:
if (self.percent_complete_method == "Task Completion" and total > 0) or (
- not self.percent_complete_method and total > 0):
- completed = frappe.db.sql("""select count(name) from tabTask where
- project=%s and status in ('Cancelled', 'Completed')""", self.name)[0][0]
+ not self.percent_complete_method and total > 0
+ ):
+ completed = frappe.db.sql(
+ """select count(name) from tabTask where
+ project=%s and status in ('Cancelled', 'Completed')""",
+ self.name,
+ )[0][0]
self.percent_complete = flt(flt(completed) / total * 100, 2)
- if (self.percent_complete_method == "Task Progress" and total > 0):
- progress = frappe.db.sql("""select sum(progress) from tabTask where
- project=%s""", self.name)[0][0]
+ if self.percent_complete_method == "Task Progress" and total > 0:
+ progress = frappe.db.sql(
+ """select sum(progress) from tabTask where
+ project=%s""",
+ self.name,
+ )[0][0]
self.percent_complete = flt(flt(progress) / total, 2)
- if (self.percent_complete_method == "Task Weight" and total > 0):
- weight_sum = frappe.db.sql("""select sum(task_weight) from tabTask where
- project=%s""", self.name)[0][0]
- weighted_progress = frappe.db.sql("""select progress, task_weight from tabTask where
- project=%s""", self.name, as_dict=1)
+ if self.percent_complete_method == "Task Weight" and total > 0:
+ weight_sum = frappe.db.sql(
+ """select sum(task_weight) from tabTask where
+ project=%s""",
+ self.name,
+ )[0][0]
+ weighted_progress = frappe.db.sql(
+ """select progress, task_weight from tabTask where
+ project=%s""",
+ self.name,
+ as_dict=1,
+ )
pct_complete = 0
for row in weighted_progress:
pct_complete += row["progress"] * frappe.utils.safe_div(row["task_weight"], weight_sum)
self.percent_complete = flt(flt(pct_complete), 2)
# don't update status if it is cancelled
- if self.status == 'Cancelled':
+ if self.status == "Cancelled":
return
if self.percent_complete == 100:
self.status = "Completed"
def update_costing(self):
- from_time_sheet = frappe.db.sql("""select
+ from_time_sheet = frappe.db.sql(
+ """select
sum(costing_amount) as costing_amount,
sum(billing_amount) as billing_amount,
min(from_time) as start_date,
max(to_time) as end_date,
sum(hours) as time
- from `tabTimesheet Detail` where project = %s and docstatus = 1""", self.name, as_dict=1)[0]
+ from `tabTimesheet Detail` where project = %s and docstatus = 1""",
+ self.name,
+ as_dict=1,
+ )[0]
- from_expense_claim = frappe.db.sql("""select
+ from_expense_claim = frappe.db.sql(
+ """select
sum(total_sanctioned_amount) as total_sanctioned_amount
from `tabExpense Claim` where project = %s
- and docstatus = 1""", self.name, as_dict=1)[0]
+ and docstatus = 1""",
+ self.name,
+ as_dict=1,
+ )[0]
self.actual_start_date = from_time_sheet.start_date
self.actual_end_date = from_time_sheet.end_date
@@ -210,41 +244,54 @@ class Project(Document):
self.calculate_gross_margin()
def calculate_gross_margin(self):
- expense_amount = (flt(self.total_costing_amount) + flt(self.total_expense_claim)
- + flt(self.total_purchase_cost) + flt(self.get('total_consumed_material_cost', 0)))
+ expense_amount = (
+ flt(self.total_costing_amount)
+ + flt(self.total_expense_claim)
+ + flt(self.total_purchase_cost)
+ + flt(self.get("total_consumed_material_cost", 0))
+ )
self.gross_margin = flt(self.total_billed_amount) - expense_amount
if self.total_billed_amount:
self.per_gross_margin = (self.gross_margin / flt(self.total_billed_amount)) * 100
def update_purchase_costing(self):
- total_purchase_cost = frappe.db.sql("""select sum(base_net_amount)
- from `tabPurchase Invoice Item` where project = %s and docstatus=1""", self.name)
+ total_purchase_cost = frappe.db.sql(
+ """select sum(base_net_amount)
+ from `tabPurchase Invoice Item` where project = %s and docstatus=1""",
+ self.name,
+ )
self.total_purchase_cost = total_purchase_cost and total_purchase_cost[0][0] or 0
def update_sales_amount(self):
- total_sales_amount = frappe.db.sql("""select sum(base_net_total)
- from `tabSales Order` where project = %s and docstatus=1""", self.name)
+ total_sales_amount = frappe.db.sql(
+ """select sum(base_net_total)
+ from `tabSales Order` where project = %s and docstatus=1""",
+ self.name,
+ )
self.total_sales_amount = total_sales_amount and total_sales_amount[0][0] or 0
def update_billed_amount(self):
- total_billed_amount = frappe.db.sql("""select sum(base_net_total)
- from `tabSales Invoice` where project = %s and docstatus=1""", self.name)
+ total_billed_amount = frappe.db.sql(
+ """select sum(base_net_total)
+ from `tabSales Invoice` where project = %s and docstatus=1""",
+ self.name,
+ )
self.total_billed_amount = total_billed_amount and total_billed_amount[0][0] or 0
def after_rename(self, old_name, new_name, merge=False):
if old_name == self.copied_from:
- frappe.db.set_value('Project', new_name, 'copied_from', new_name)
+ frappe.db.set_value("Project", new_name, "copied_from", new_name)
def send_welcome_email(self):
url = get_url("/project/?name={0}".format(self.name))
messages = (
_("You have been invited to collaborate on the project: {0}").format(self.name),
url,
- _("Join")
+ _("Join"),
)
content = """
@@ -254,21 +301,31 @@ class Project(Document):
for user in self.users:
if user.welcome_email_sent == 0:
- frappe.sendmail(user.user, subject=_("Project Collaboration Invitation"),
- content=content.format(*messages))
+ frappe.sendmail(
+ user.user, subject=_("Project Collaboration Invitation"), content=content.format(*messages)
+ )
user.welcome_email_sent = 1
+
def get_timeline_data(doctype, name):
- '''Return timeline for attendance'''
- return dict(frappe.db.sql('''select unix_timestamp(from_time), count(*)
+ """Return timeline for attendance"""
+ return dict(
+ frappe.db.sql(
+ """select unix_timestamp(from_time), count(*)
from `tabTimesheet Detail` where project=%s
and from_time > date_sub(curdate(), interval 1 year)
and docstatus < 2
- group by date(from_time)''', name))
+ group by date(from_time)""",
+ name,
+ )
+ )
-def get_project_list(doctype, txt, filters, limit_start, limit_page_length=20, order_by="modified"):
- return frappe.db.sql('''select distinct project.*
+def get_project_list(
+ doctype, txt, filters, limit_start, limit_page_length=20, order_by="modified"
+):
+ return frappe.db.sql(
+ """select distinct project.*
from tabProject project, `tabProject User` project_user
where
(project_user.user = %(user)s
@@ -276,27 +333,32 @@ def get_project_list(doctype, txt, filters, limit_start, limit_page_length=20, o
or project.owner = %(user)s
order by project.modified desc
limit {0}, {1}
- '''.format(limit_start, limit_page_length),
- {'user': frappe.session.user},
- as_dict=True,
- update={'doctype': 'Project'})
+ """.format(
+ limit_start, limit_page_length
+ ),
+ {"user": frappe.session.user},
+ as_dict=True,
+ update={"doctype": "Project"},
+ )
def get_list_context(context=None):
return {
"show_sidebar": True,
"show_search": True,
- 'no_breadcrumbs': True,
+ "no_breadcrumbs": True,
"title": _("Projects"),
"get_list": get_project_list,
- "row_template": "templates/includes/projects/project_row.html"
+ "row_template": "templates/includes/projects/project_row.html",
}
+
@frappe.whitelist()
@frappe.validate_and_sanitize_search_inputs
def get_users_for_project(doctype, txt, searchfield, start, page_len, filters):
conditions = []
- return frappe.db.sql("""select name, concat_ws(' ', first_name, middle_name, last_name)
+ return frappe.db.sql(
+ """select name, concat_ws(' ', first_name, middle_name, last_name)
from `tabUser`
where enabled=1
and name not in ("Guest", "Administrator")
@@ -308,47 +370,51 @@ def get_users_for_project(doctype, txt, searchfield, start, page_len, filters):
if(locate(%(_txt)s, full_name), locate(%(_txt)s, full_name), 99999),
idx desc,
name, full_name
- limit %(start)s, %(page_len)s""".format(**{
- 'key': searchfield,
- 'fcond': get_filters_cond(doctype, filters, conditions),
- 'mcond': get_match_cond(doctype)
- }), {
- 'txt': "%%%s%%" % txt,
- '_txt': txt.replace("%", ""),
- 'start': start,
- 'page_len': page_len
- })
+ limit %(start)s, %(page_len)s""".format(
+ **{
+ "key": searchfield,
+ "fcond": get_filters_cond(doctype, filters, conditions),
+ "mcond": get_match_cond(doctype),
+ }
+ ),
+ {"txt": "%%%s%%" % txt, "_txt": txt.replace("%", ""), "start": start, "page_len": page_len},
+ )
@frappe.whitelist()
def get_cost_center_name(project):
return frappe.db.get_value("Project", project, "cost_center")
+
def hourly_reminder():
fields = ["from_time", "to_time"]
projects = get_projects_for_collect_progress("Hourly", fields)
for project in projects:
- if (get_time(nowtime()) >= get_time(project.from_time) or
- get_time(nowtime()) <= get_time(project.to_time)):
+ if get_time(nowtime()) >= get_time(project.from_time) or get_time(nowtime()) <= get_time(
+ project.to_time
+ ):
send_project_update_email_to_users(project.name)
+
def project_status_update_reminder():
daily_reminder()
twice_daily_reminder()
weekly_reminder()
+
def daily_reminder():
fields = ["daily_time_to_send"]
- projects = get_projects_for_collect_progress("Daily", fields)
+ projects = get_projects_for_collect_progress("Daily", fields)
for project in projects:
if allow_to_make_project_update(project.name, project.get("daily_time_to_send"), "Daily"):
send_project_update_email_to_users(project.name)
+
def twice_daily_reminder():
fields = ["first_email", "second_email"]
- projects = get_projects_for_collect_progress("Twice Daily", fields)
+ projects = get_projects_for_collect_progress("Twice Daily", fields)
fields.remove("name")
for project in projects:
@@ -356,9 +422,10 @@ def twice_daily_reminder():
if allow_to_make_project_update(project.name, project.get(d), "Twicely"):
send_project_update_email_to_users(project.name)
+
def weekly_reminder():
fields = ["day_to_send", "weekly_time_to_send"]
- projects = get_projects_for_collect_progress("Weekly", fields)
+ projects = get_projects_for_collect_progress("Weekly", fields)
current_day = get_datetime().strftime("%A")
for project in projects:
@@ -368,12 +435,16 @@ def weekly_reminder():
if allow_to_make_project_update(project.name, project.get("weekly_time_to_send"), "Weekly"):
send_project_update_email_to_users(project.name)
+
def allow_to_make_project_update(project, time, frequency):
- data = frappe.db.sql(""" SELECT name from `tabProject Update`
- WHERE project = %s and date = %s """, (project, today()))
+ data = frappe.db.sql(
+ """ SELECT name from `tabProject Update`
+ WHERE project = %s and date = %s """,
+ (project, today()),
+ )
# len(data) > 1 condition is checked for twicely frequency
- if data and (frequency in ['Daily', 'Weekly'] or len(data) > 1):
+ if data and (frequency in ["Daily", "Weekly"] or len(data) > 1):
return False
if get_time(nowtime()) >= get_time(time):
@@ -382,138 +453,162 @@ def allow_to_make_project_update(project, time, frequency):
@frappe.whitelist()
def create_duplicate_project(prev_doc, project_name):
- ''' Create duplicate project based on the old project '''
+ """Create duplicate project based on the old project"""
import json
+
prev_doc = json.loads(prev_doc)
- if project_name == prev_doc.get('name'):
+ if project_name == prev_doc.get("name"):
frappe.throw(_("Use a name that is different from previous project name"))
# change the copied doc name to new project name
project = frappe.copy_doc(prev_doc)
project.name = project_name
- project.project_template = ''
+ project.project_template = ""
project.project_name = project_name
project.insert()
# fetch all the task linked with the old project
- task_list = frappe.get_all("Task", filters={
- 'project': prev_doc.get('name')
- }, fields=['name'])
+ task_list = frappe.get_all("Task", filters={"project": prev_doc.get("name")}, fields=["name"])
# Create duplicate task for all the task
for task in task_list:
- task = frappe.get_doc('Task', task)
+ task = frappe.get_doc("Task", task)
new_task = frappe.copy_doc(task)
new_task.project = project.name
new_task.insert()
- project.db_set('project_template', prev_doc.get('project_template'))
+ project.db_set("project_template", prev_doc.get("project_template"))
+
def get_projects_for_collect_progress(frequency, fields):
fields.extend(["name"])
- return frappe.get_all("Project", fields = fields,
- filters = {'collect_progress': 1, 'frequency': frequency, 'status': 'Open'})
+ return frappe.get_all(
+ "Project",
+ fields=fields,
+ filters={"collect_progress": 1, "frequency": frequency, "status": "Open"},
+ )
+
def send_project_update_email_to_users(project):
- doc = frappe.get_doc('Project', project)
+ doc = frappe.get_doc("Project", project)
- if is_holiday(doc.holiday_list) or not doc.users: return
+ if is_holiday(doc.holiday_list) or not doc.users:
+ return
- project_update = frappe.get_doc({
- "doctype" : "Project Update",
- "project" : project,
- "sent": 0,
- "date": today(),
- "time": nowtime(),
- "naming_series": "UPDATE-.project.-.YY.MM.DD.-",
- }).insert()
+ project_update = frappe.get_doc(
+ {
+ "doctype": "Project Update",
+ "project": project,
+ "sent": 0,
+ "date": today(),
+ "time": nowtime(),
+ "naming_series": "UPDATE-.project.-.YY.MM.DD.-",
+ }
+ ).insert()
subject = "For project %s, update your status" % (project)
- incoming_email_account = frappe.db.get_value('Email Account',
- dict(enable_incoming=1, default_incoming=1), 'email_id')
+ incoming_email_account = frappe.db.get_value(
+ "Email Account", dict(enable_incoming=1, default_incoming=1), "email_id"
+ )
- frappe.sendmail(recipients=get_users_email(doc),
+ frappe.sendmail(
+ recipients=get_users_email(doc),
message=doc.message,
subject=_(subject),
reference_doctype=project_update.doctype,
reference_name=project_update.name,
- reply_to=incoming_email_account
+ reply_to=incoming_email_account,
)
+
def collect_project_status():
- for data in frappe.get_all("Project Update",
- {'date': today(), 'sent': 0}):
- replies = frappe.get_all('Communication',
- fields=['content', 'text_content', 'sender'],
- filters=dict(reference_doctype="Project Update",
+ for data in frappe.get_all("Project Update", {"date": today(), "sent": 0}):
+ replies = frappe.get_all(
+ "Communication",
+ fields=["content", "text_content", "sender"],
+ filters=dict(
+ reference_doctype="Project Update",
reference_name=data.name,
- communication_type='Communication',
- sent_or_received='Received'),
- order_by='creation asc')
+ communication_type="Communication",
+ sent_or_received="Received",
+ ),
+ order_by="creation asc",
+ )
for d in replies:
doc = frappe.get_doc("Project Update", data.name)
- user_data = frappe.db.get_values("User", {"email": d.sender},
- ["full_name", "user_image", "name"], as_dict=True)[0]
+ user_data = frappe.db.get_values(
+ "User", {"email": d.sender}, ["full_name", "user_image", "name"], as_dict=True
+ )[0]
- doc.append("users", {
- 'user': user_data.name,
- 'full_name': user_data.full_name,
- 'image': user_data.user_image,
- 'project_status': frappe.utils.md_to_html(
- EmailReplyParser.parse_reply(d.text_content) or d.content
- )
- })
+ doc.append(
+ "users",
+ {
+ "user": user_data.name,
+ "full_name": user_data.full_name,
+ "image": user_data.user_image,
+ "project_status": frappe.utils.md_to_html(
+ EmailReplyParser.parse_reply(d.text_content) or d.content
+ ),
+ },
+ )
doc.save(ignore_permissions=True)
+
def send_project_status_email_to_users():
yesterday = add_days(today(), -1)
- for d in frappe.get_all("Project Update",
- {'date': yesterday, 'sent': 0}):
+ for d in frappe.get_all("Project Update", {"date": yesterday, "sent": 0}):
doc = frappe.get_doc("Project Update", d.name)
- project_doc = frappe.get_doc('Project', doc.project)
+ project_doc = frappe.get_doc("Project", doc.project)
- args = {
- "users": doc.users,
- "title": _("Project Summary for {0}").format(yesterday)
- }
+ args = {"users": doc.users, "title": _("Project Summary for {0}").format(yesterday)}
- frappe.sendmail(recipients=get_users_email(project_doc),
- template='daily_project_summary',
+ frappe.sendmail(
+ recipients=get_users_email(project_doc),
+ template="daily_project_summary",
args=args,
subject=_("Daily Project Summary for {0}").format(d.name),
reference_doctype="Project Update",
- reference_name=d.name)
+ reference_name=d.name,
+ )
+
+ doc.db_set("sent", 1)
- doc.db_set('sent', 1)
def update_project_sales_billing():
sales_update_frequency = frappe.db.get_single_value("Selling Settings", "sales_update_frequency")
if sales_update_frequency == "Each Transaction":
return
- elif (sales_update_frequency == "Monthly" and frappe.utils.now_datetime().day != 1):
+ elif sales_update_frequency == "Monthly" and frappe.utils.now_datetime().day != 1:
return
- #Else simply fallback to Daily
- exists_query = '(SELECT 1 from `tab{doctype}` where docstatus = 1 and project = `tabProject`.name)'
+ # Else simply fallback to Daily
+ exists_query = (
+ "(SELECT 1 from `tab{doctype}` where docstatus = 1 and project = `tabProject`.name)"
+ )
project_map = {}
- for project_details in frappe.db.sql('''
+ for project_details in frappe.db.sql(
+ """
SELECT name, 1 as order_exists, null as invoice_exists from `tabProject` where
exists {order_exists}
union
SELECT name, null as order_exists, 1 as invoice_exists from `tabProject` where
exists {invoice_exists}
- '''.format(
+ """.format(
order_exists=exists_query.format(doctype="Sales Order"),
invoice_exists=exists_query.format(doctype="Sales Invoice"),
- ), as_dict=True):
- project = project_map.setdefault(project_details.name, frappe.get_doc('Project', project_details.name))
+ ),
+ as_dict=True,
+ ):
+ project = project_map.setdefault(
+ project_details.name, frappe.get_doc("Project", project_details.name)
+ )
if project_details.order_exists:
project.update_sales_amount()
if project_details.invoice_exists:
@@ -522,29 +617,31 @@ def update_project_sales_billing():
for project in project_map.values():
project.save()
+
@frappe.whitelist()
def create_kanban_board_if_not_exists(project):
from frappe.desk.doctype.kanban_board.kanban_board import quick_kanban_board
- project = frappe.get_doc('Project', project)
- if not frappe.db.exists('Kanban Board', project.project_name):
- quick_kanban_board('Task', project.project_name, 'status', project.name)
+ project = frappe.get_doc("Project", project)
+ if not frappe.db.exists("Kanban Board", project.project_name):
+ quick_kanban_board("Task", project.project_name, "status", project.name)
return True
+
@frappe.whitelist()
def set_project_status(project, status):
- '''
+ """
set status for project and all related tasks
- '''
- if not status in ('Completed', 'Cancelled'):
- frappe.throw(_('Status must be Cancelled or Completed'))
+ """
+ if not status in ("Completed", "Cancelled"):
+ frappe.throw(_("Status must be Cancelled or Completed"))
- project = frappe.get_doc('Project', project)
- frappe.has_permission(doc = project, throw = True)
+ project = frappe.get_doc("Project", project)
+ frappe.has_permission(doc=project, throw=True)
- for task in frappe.get_all('Task', dict(project = project.name)):
- frappe.db.set_value('Task', task.name, 'status', status)
+ for task in frappe.get_all("Task", dict(project=project.name)):
+ frappe.db.set_value("Task", task.name, "status", status)
project.status = status
project.save()
diff --git a/erpnext/projects/doctype/project/project_dashboard.py b/erpnext/projects/doctype/project/project_dashboard.py
index df274ed9a94..b6c74f93870 100644
--- a/erpnext/projects/doctype/project/project_dashboard.py
+++ b/erpnext/projects/doctype/project/project_dashboard.py
@@ -1,28 +1,18 @@
-
from frappe import _
def get_data():
return {
- 'heatmap': True,
- 'heatmap_message': _('This is based on the Time Sheets created against this project'),
- 'fieldname': 'project',
- 'transactions': [
+ "heatmap": True,
+ "heatmap_message": _("This is based on the Time Sheets created against this project"),
+ "fieldname": "project",
+ "transactions": [
{
- 'label': _('Project'),
- 'items': ['Task', 'Timesheet', 'Expense Claim', 'Issue' , 'Project Update']
+ "label": _("Project"),
+ "items": ["Task", "Timesheet", "Expense Claim", "Issue", "Project Update"],
},
- {
- 'label': _('Material'),
- 'items': ['Material Request', 'BOM', 'Stock Entry']
- },
- {
- 'label': _('Sales'),
- 'items': ['Sales Order', 'Delivery Note', 'Sales Invoice']
- },
- {
- 'label': _('Purchase'),
- 'items': ['Purchase Order', 'Purchase Receipt', 'Purchase Invoice']
- },
- ]
+ {"label": _("Material"), "items": ["Material Request", "BOM", "Stock Entry"]},
+ {"label": _("Sales"), "items": ["Sales Order", "Delivery Note", "Sales Invoice"]},
+ {"label": _("Purchase"), "items": ["Purchase Order", "Purchase Receipt", "Purchase Invoice"]},
+ ],
}
diff --git a/erpnext/projects/doctype/project/test_project.py b/erpnext/projects/doctype/project/test_project.py
index df42e82ad47..8a599cef753 100644
--- a/erpnext/projects/doctype/project/test_project.py
+++ b/erpnext/projects/doctype/project/test_project.py
@@ -11,7 +11,7 @@ from erpnext.projects.doctype.task.test_task import create_task
from erpnext.selling.doctype.sales_order.sales_order import make_project as make_project_from_so
from erpnext.selling.doctype.sales_order.test_sales_order import make_sales_order
-test_records = frappe.get_test_records('Project')
+test_records = frappe.get_test_records("Project")
test_ignore = ["Sales Order"]
@@ -19,53 +19,83 @@ class TestProject(unittest.TestCase):
def test_project_with_template_having_no_parent_and_depend_tasks(self):
project_name = "Test Project with Template - No Parent and Dependend Tasks"
frappe.db.sql(""" delete from tabTask where project = %s """, project_name)
- frappe.delete_doc('Project', project_name)
+ frappe.delete_doc("Project", project_name)
task1 = task_exists("Test Template Task with No Parent and Dependency")
if not task1:
- task1 = create_task(subject="Test Template Task with No Parent and Dependency", is_template=1, begin=5, duration=3)
+ task1 = create_task(
+ subject="Test Template Task with No Parent and Dependency", is_template=1, begin=5, duration=3
+ )
- template = make_project_template("Test Project Template - No Parent and Dependend Tasks", [task1])
+ template = make_project_template(
+ "Test Project Template - No Parent and Dependend Tasks", [task1]
+ )
project = get_project(project_name, template)
- tasks = frappe.get_all('Task', ['subject','exp_end_date','depends_on_tasks'], dict(project=project.name), order_by='creation asc')
+ tasks = frappe.get_all(
+ "Task",
+ ["subject", "exp_end_date", "depends_on_tasks"],
+ dict(project=project.name),
+ order_by="creation asc",
+ )
- self.assertEqual(tasks[0].subject, 'Test Template Task with No Parent and Dependency')
+ self.assertEqual(tasks[0].subject, "Test Template Task with No Parent and Dependency")
self.assertEqual(getdate(tasks[0].exp_end_date), calculate_end_date(project, 5, 3))
self.assertEqual(len(tasks), 1)
def test_project_template_having_parent_child_tasks(self):
project_name = "Test Project with Template - Tasks with Parent-Child Relation"
- if frappe.db.get_value('Project', {'project_name': project_name}, 'name'):
- project_name = frappe.db.get_value('Project', {'project_name': project_name}, 'name')
+ if frappe.db.get_value("Project", {"project_name": project_name}, "name"):
+ project_name = frappe.db.get_value("Project", {"project_name": project_name}, "name")
frappe.db.sql(""" delete from tabTask where project = %s """, project_name)
- frappe.delete_doc('Project', project_name)
+ frappe.delete_doc("Project", project_name)
task1 = task_exists("Test Template Task Parent")
if not task1:
- task1 = create_task(subject="Test Template Task Parent", is_group=1, is_template=1, begin=1, duration=10)
+ task1 = create_task(
+ subject="Test Template Task Parent", is_group=1, is_template=1, begin=1, duration=10
+ )
task2 = task_exists("Test Template Task Child 1")
if not task2:
- task2 = create_task(subject="Test Template Task Child 1", parent_task=task1.name, is_template=1, begin=1, duration=3)
+ task2 = create_task(
+ subject="Test Template Task Child 1",
+ parent_task=task1.name,
+ is_template=1,
+ begin=1,
+ duration=3,
+ )
task3 = task_exists("Test Template Task Child 2")
if not task3:
- task3 = create_task(subject="Test Template Task Child 2", parent_task=task1.name, is_template=1, begin=2, duration=3)
+ task3 = create_task(
+ subject="Test Template Task Child 2",
+ parent_task=task1.name,
+ is_template=1,
+ begin=2,
+ duration=3,
+ )
- template = make_project_template("Test Project Template - Tasks with Parent-Child Relation", [task1, task2, task3])
+ template = make_project_template(
+ "Test Project Template - Tasks with Parent-Child Relation", [task1, task2, task3]
+ )
project = get_project(project_name, template)
- tasks = frappe.get_all('Task', ['subject','exp_end_date','depends_on_tasks', 'name', 'parent_task'], dict(project=project.name), order_by='creation asc')
+ tasks = frappe.get_all(
+ "Task",
+ ["subject", "exp_end_date", "depends_on_tasks", "name", "parent_task"],
+ dict(project=project.name),
+ order_by="creation asc",
+ )
- self.assertEqual(tasks[0].subject, 'Test Template Task Parent')
+ self.assertEqual(tasks[0].subject, "Test Template Task Parent")
self.assertEqual(getdate(tasks[0].exp_end_date), calculate_end_date(project, 1, 10))
- self.assertEqual(tasks[1].subject, 'Test Template Task Child 1')
+ self.assertEqual(tasks[1].subject, "Test Template Task Child 1")
self.assertEqual(getdate(tasks[1].exp_end_date), calculate_end_date(project, 1, 3))
self.assertEqual(tasks[1].parent_task, tasks[0].name)
- self.assertEqual(tasks[2].subject, 'Test Template Task Child 2')
+ self.assertEqual(tasks[2].subject, "Test Template Task Child 2")
self.assertEqual(getdate(tasks[2].exp_end_date), calculate_end_date(project, 2, 3))
self.assertEqual(tasks[2].parent_task, tasks[0].name)
@@ -74,26 +104,39 @@ class TestProject(unittest.TestCase):
def test_project_template_having_dependent_tasks(self):
project_name = "Test Project with Template - Dependent Tasks"
frappe.db.sql(""" delete from tabTask where project = %s """, project_name)
- frappe.delete_doc('Project', project_name)
+ frappe.delete_doc("Project", project_name)
task1 = task_exists("Test Template Task for Dependency")
if not task1:
- task1 = create_task(subject="Test Template Task for Dependency", is_template=1, begin=3, duration=1)
+ task1 = create_task(
+ subject="Test Template Task for Dependency", is_template=1, begin=3, duration=1
+ )
task2 = task_exists("Test Template Task with Dependency")
if not task2:
- task2 = create_task(subject="Test Template Task with Dependency", depends_on=task1.name, is_template=1, begin=2, duration=2)
+ task2 = create_task(
+ subject="Test Template Task with Dependency",
+ depends_on=task1.name,
+ is_template=1,
+ begin=2,
+ duration=2,
+ )
template = make_project_template("Test Project with Template - Dependent Tasks", [task1, task2])
project = get_project(project_name, template)
- tasks = frappe.get_all('Task', ['subject','exp_end_date','depends_on_tasks', 'name'], dict(project=project.name), order_by='creation asc')
+ tasks = frappe.get_all(
+ "Task",
+ ["subject", "exp_end_date", "depends_on_tasks", "name"],
+ dict(project=project.name),
+ order_by="creation asc",
+ )
- self.assertEqual(tasks[1].subject, 'Test Template Task with Dependency')
+ self.assertEqual(tasks[1].subject, "Test Template Task with Dependency")
self.assertEqual(getdate(tasks[1].exp_end_date), calculate_end_date(project, 2, 2))
- self.assertTrue(tasks[1].depends_on_tasks.find(tasks[0].name) >= 0 )
+ self.assertTrue(tasks[1].depends_on_tasks.find(tasks[0].name) >= 0)
- self.assertEqual(tasks[0].subject, 'Test Template Task for Dependency')
- self.assertEqual(getdate(tasks[0].exp_end_date), calculate_end_date(project, 3, 1) )
+ self.assertEqual(tasks[0].subject, "Test Template Task for Dependency")
+ self.assertEqual(getdate(tasks[0].exp_end_date), calculate_end_date(project, 3, 1))
self.assertEqual(len(tasks), 2)
@@ -112,32 +155,38 @@ class TestProject(unittest.TestCase):
so.reload()
self.assertFalse(so.project)
+
def get_project(name, template):
- project = frappe.get_doc(dict(
- doctype = 'Project',
- project_name = name,
- status = 'Open',
- project_template = template.name,
- expected_start_date = nowdate(),
- company="_Test Company"
- )).insert()
+ project = frappe.get_doc(
+ dict(
+ doctype="Project",
+ project_name=name,
+ status="Open",
+ project_template=template.name,
+ expected_start_date=nowdate(),
+ company="_Test Company",
+ )
+ ).insert()
return project
+
def make_project(args):
args = frappe._dict(args)
if args.project_name and frappe.db.exists("Project", {"project_name": args.project_name}):
return frappe.get_doc("Project", {"project_name": args.project_name})
- project = frappe.get_doc(dict(
- doctype = 'Project',
- project_name = args.project_name,
- status = 'Open',
- expected_start_date = args.start_date,
- company= args.company or '_Test Company'
- ))
+ project = frappe.get_doc(
+ dict(
+ doctype="Project",
+ project_name=args.project_name,
+ status="Open",
+ expected_start_date=args.start_date,
+ company=args.company or "_Test Company",
+ )
+ )
if args.project_template_name:
template = make_project_template(args.project_template_name)
@@ -147,12 +196,14 @@ def make_project(args):
return project
+
def task_exists(subject):
- result = frappe.db.get_list("Task", filters={"subject": subject},fields=["name"])
+ result = frappe.db.get_list("Task", filters={"subject": subject}, fields=["name"])
if not len(result):
return False
return frappe.get_doc("Task", result[0].name)
+
def calculate_end_date(project, start, duration):
start = add_days(project.expected_start_date, start)
start = project.update_if_holiday(start)
diff --git a/erpnext/projects/doctype/project_template/project_template.py b/erpnext/projects/doctype/project_template/project_template.py
index 3cc8d6855f2..89afb1bd770 100644
--- a/erpnext/projects/doctype/project_template/project_template.py
+++ b/erpnext/projects/doctype/project_template/project_template.py
@@ -9,7 +9,6 @@ from frappe.utils import get_link_to_form
class ProjectTemplate(Document):
-
def validate(self):
self.validate_dependencies()
@@ -19,9 +18,13 @@ class ProjectTemplate(Document):
if task_details.depends_on:
for dependency_task in task_details.depends_on:
if not self.check_dependent_task_presence(dependency_task.task):
- task_details_format = get_link_to_form("Task",task_details.name)
+ task_details_format = get_link_to_form("Task", task_details.name)
dependency_task_format = get_link_to_form("Task", dependency_task.task)
- frappe.throw(_("Task {0} depends on Task {1}. Please add Task {1} to the Tasks list.").format(frappe.bold(task_details_format), frappe.bold(dependency_task_format)))
+ frappe.throw(
+ _("Task {0} depends on Task {1}. Please add Task {1} to the Tasks list.").format(
+ frappe.bold(task_details_format), frappe.bold(dependency_task_format)
+ )
+ )
def check_dependent_task_presence(self, task):
for task_details in self.tasks:
diff --git a/erpnext/projects/doctype/project_template/project_template_dashboard.py b/erpnext/projects/doctype/project_template/project_template_dashboard.py
index 65cd8d4b55a..0c567c1e599 100644
--- a/erpnext/projects/doctype/project_template/project_template_dashboard.py
+++ b/erpnext/projects/doctype/project_template/project_template_dashboard.py
@@ -1,11 +1,2 @@
-
-
def get_data():
- return {
- 'fieldname': 'project_template',
- 'transactions': [
- {
- 'items': ['Project']
- }
- ]
- }
+ return {"fieldname": "project_template", "transactions": [{"items": ["Project"]}]}
diff --git a/erpnext/projects/doctype/project_template/test_project_template.py b/erpnext/projects/doctype/project_template/test_project_template.py
index 842483343a2..4fd24bf78a2 100644
--- a/erpnext/projects/doctype/project_template/test_project_template.py
+++ b/erpnext/projects/doctype/project_template/test_project_template.py
@@ -11,20 +11,16 @@ from erpnext.projects.doctype.task.test_task import create_task
class TestProjectTemplate(unittest.TestCase):
pass
+
def make_project_template(project_template_name, project_tasks=[]):
- if not frappe.db.exists('Project Template', project_template_name):
+ if not frappe.db.exists("Project Template", project_template_name):
project_tasks = project_tasks or [
- create_task(subject="_Test Template Task 1", is_template=1, begin=0, duration=3),
- create_task(subject="_Test Template Task 2", is_template=1, begin=0, duration=2),
- ]
- doc = frappe.get_doc(dict(
- doctype = 'Project Template',
- name = project_template_name
- ))
+ create_task(subject="_Test Template Task 1", is_template=1, begin=0, duration=3),
+ create_task(subject="_Test Template Task 2", is_template=1, begin=0, duration=2),
+ ]
+ doc = frappe.get_doc(dict(doctype="Project Template", name=project_template_name))
for task in project_tasks:
- doc.append("tasks",{
- "task": task.name
- })
+ doc.append("tasks", {"task": task.name})
doc.insert()
- return frappe.get_doc('Project Template', project_template_name)
+ return frappe.get_doc("Project Template", project_template_name)
diff --git a/erpnext/projects/doctype/project_update/project_update.py b/erpnext/projects/doctype/project_update/project_update.py
index 42ba5f6075c..5a29fb6c33e 100644
--- a/erpnext/projects/doctype/project_update/project_update.py
+++ b/erpnext/projects/doctype/project_update/project_update.py
@@ -7,36 +7,88 @@ from frappe.model.document import Document
class ProjectUpdate(Document):
- pass
+ pass
+
@frappe.whitelist()
def daily_reminder():
- project = frappe.db.sql("""SELECT `tabProject`.project_name,`tabProject`.frequency,`tabProject`.expected_start_date,`tabProject`.expected_end_date,`tabProject`.percent_complete FROM `tabProject`;""")
- for projects in project:
- project_name = projects[0]
- frequency = projects[1]
- date_start = projects[2]
- date_end = projects [3]
- progress = projects [4]
- draft = frappe.db.sql("""SELECT count(docstatus) from `tabProject Update` WHERE `tabProject Update`.project = %s AND `tabProject Update`.docstatus = 0;""",project_name)
- for drafts in draft:
- number_of_drafts = drafts[0]
- update = frappe.db.sql("""SELECT name,date,time,progress,progress_details FROM `tabProject Update` WHERE `tabProject Update`.project = %s AND date = DATE_ADD(CURDATE(), INTERVAL -1 DAY);""",project_name)
- email_sending(project_name,frequency,date_start,date_end,progress,number_of_drafts,update)
+ project = frappe.db.sql(
+ """SELECT `tabProject`.project_name,`tabProject`.frequency,`tabProject`.expected_start_date,`tabProject`.expected_end_date,`tabProject`.percent_complete FROM `tabProject`;"""
+ )
+ for projects in project:
+ project_name = projects[0]
+ frequency = projects[1]
+ date_start = projects[2]
+ date_end = projects[3]
+ progress = projects[4]
+ draft = frappe.db.sql(
+ """SELECT count(docstatus) from `tabProject Update` WHERE `tabProject Update`.project = %s AND `tabProject Update`.docstatus = 0;""",
+ project_name,
+ )
+ for drafts in draft:
+ number_of_drafts = drafts[0]
+ update = frappe.db.sql(
+ """SELECT name,date,time,progress,progress_details FROM `tabProject Update` WHERE `tabProject Update`.project = %s AND date = DATE_ADD(CURDATE(), INTERVAL -1 DAY);""",
+ project_name,
+ )
+ email_sending(project_name, frequency, date_start, date_end, progress, number_of_drafts, update)
-def email_sending(project_name,frequency,date_start,date_end,progress,number_of_drafts,update):
- holiday = frappe.db.sql("""SELECT holiday_date FROM `tabHoliday` where holiday_date = CURDATE();""")
- msg = "Project Name: " + project_name + "
Frequency: " + " " + frequency + "
Update Reminder:" + " " + str(date_start) + "
Expected Date End:" + " " + str(date_end) + "
Percent Progress:" + " " + str(progress) + "
Number of Updates:" + " " + str(len(update)) + "
" + "Number of drafts:" + " " + str(number_of_drafts) + "
" - msg += """| Project ID | Date Updated | Time Updated | Project Status | Notes | """ - for updates in update: - msg += "
|---|---|---|---|---|
| " + str(updates[0]) + " | " + str(updates[1]) + " | " + str(updates[2]) + " | " + str(updates[3]) + " | " + "" + str(updates[4]) + " |
| " + + str(updates[0]) + + " | " + + str(updates[1]) + + " | " + + str(updates[2]) + + " | " + + str(updates[3]) + + " | " + + "" + + str(updates[4]) + + " |
| {0} | {1} | -
" + _("Please create Landed Cost Vouchers against Invoices that have 'Update Stock' enabled.") + msg = _("Row {0}: Purchase Invoice {1} has no stock impact.").format( + d.idx, frappe.bold(d.receipt_document) + ) + msg += "
" + _( + "Please create Landed Cost Vouchers against Invoices that have 'Update Stock' enabled." + ) frappe.throw(msg, title=_("Incorrect Invoice")) receipt_documents.append(d.receipt_document) @@ -81,52 +90,64 @@ class LandedCostVoucher(Document): frappe.throw(_("Item must be added using 'Get Items from Purchase Receipts' button")) elif item.receipt_document not in receipt_documents: - frappe.throw(_("Item Row {0}: {1} {2} does not exist in above '{1}' table") - .format(item.idx, item.receipt_document_type, item.receipt_document)) + frappe.throw( + _("Item Row {0}: {1} {2} does not exist in above '{1}' table").format( + item.idx, item.receipt_document_type, item.receipt_document + ) + ) if not item.cost_center: - frappe.throw(_("Row {0}: Cost center is required for an item {1}") - .format(item.idx, item.item_code)) + frappe.throw( + _("Row {0}: Cost center is required for an item {1}").format(item.idx, item.item_code) + ) def set_total_taxes_and_charges(self): self.total_taxes_and_charges = sum(flt(d.base_amount) for d in self.get("taxes")) def set_applicable_charges_on_item(self): - if self.get('taxes') and self.distribute_charges_based_on != 'Distribute Manually': + if self.get("taxes") and self.distribute_charges_based_on != "Distribute Manually": total_item_cost = 0.0 total_charges = 0.0 item_count = 0 based_on_field = frappe.scrub(self.distribute_charges_based_on) - for item in self.get('items'): + for item in self.get("items"): total_item_cost += item.get(based_on_field) - for item in self.get('items'): - item.applicable_charges = flt(flt(item.get(based_on_field)) * (flt(self.total_taxes_and_charges) / flt(total_item_cost)), - item.precision('applicable_charges')) + for item in self.get("items"): + item.applicable_charges = flt( + flt(item.get(based_on_field)) * (flt(self.total_taxes_and_charges) / flt(total_item_cost)), + item.precision("applicable_charges"), + ) total_charges += item.applicable_charges item_count += 1 if total_charges != self.total_taxes_and_charges: diff = self.total_taxes_and_charges - total_charges - self.get('items')[item_count - 1].applicable_charges += diff + self.get("items")[item_count - 1].applicable_charges += diff def validate_applicable_charges_for_item(self): based_on = self.distribute_charges_based_on.lower() - if based_on != 'distribute manually': + if based_on != "distribute manually": total = sum(flt(d.get(based_on)) for d in self.get("items")) else: # consider for proportion while distributing manually - total = sum(flt(d.get('applicable_charges')) for d in self.get("items")) + total = sum(flt(d.get("applicable_charges")) for d in self.get("items")) if not total: - frappe.throw(_("Total {0} for all items is zero, may be you should change 'Distribute Charges Based On'").format(based_on)) + frappe.throw( + _( + "Total {0} for all items is zero, may be you should change 'Distribute Charges Based On'" + ).format(based_on) + ) total_applicable_charges = sum(flt(d.applicable_charges) for d in self.get("items")) - precision = get_field_precision(frappe.get_meta("Landed Cost Item").get_field("applicable_charges"), - currency=frappe.get_cached_value('Company', self.company, "default_currency")) + precision = get_field_precision( + frappe.get_meta("Landed Cost Item").get_field("applicable_charges"), + currency=frappe.get_cached_value("Company", self.company, "default_currency"), + ) diff = flt(self.total_taxes_and_charges) - flt(total_applicable_charges) diff = flt(diff, precision) @@ -134,7 +155,11 @@ class LandedCostVoucher(Document): if abs(diff) < (2.0 / (10**precision)): self.items[-1].applicable_charges += diff else: - frappe.throw(_("Total Applicable Charges in Purchase Receipt Items table must be same as Total Taxes and Charges")) + frappe.throw( + _( + "Total Applicable Charges in Purchase Receipt Items table must be same as Total Taxes and Charges" + ) + ) def on_submit(self): self.update_landed_cost() @@ -177,25 +202,41 @@ class LandedCostVoucher(Document): doc.repost_future_sle_and_gle() def validate_asset_qty_and_status(self, receipt_document_type, receipt_document): - for item in self.get('items'): + for item in self.get("items"): if item.is_fixed_asset: - receipt_document_type = 'purchase_invoice' if item.receipt_document_type == 'Purchase Invoice' \ - else 'purchase_receipt' - docs = frappe.db.get_all('Asset', filters={ receipt_document_type: item.receipt_document, - 'item_code': item.item_code }, fields=['name', 'docstatus']) + receipt_document_type = ( + "purchase_invoice" if item.receipt_document_type == "Purchase Invoice" else "purchase_receipt" + ) + docs = frappe.db.get_all( + "Asset", + filters={receipt_document_type: item.receipt_document, "item_code": item.item_code}, + fields=["name", "docstatus"], + ) if not docs or len(docs) != item.qty: - frappe.throw(_('There are not enough asset created or linked to {0}. Please create or link {1} Assets with respective document.').format( - item.receipt_document, item.qty)) + frappe.throw( + _( + "There are not enough asset created or linked to {0}. Please create or link {1} Assets with respective document." + ).format(item.receipt_document, item.qty) + ) if docs: for d in docs: if d.docstatus == 1: - frappe.throw(_('{2} {0} has submitted Assets. Remove Item {1} from table to continue.').format( - item.receipt_document, item.item_code, item.receipt_document_type)) + frappe.throw( + _( + "{2} {0} has submitted Assets. Remove Item {1} from table to continue." + ).format( + item.receipt_document, item.item_code, item.receipt_document_type + ) + ) def update_rate_in_serial_no_for_non_asset_items(self, receipt_document): for item in receipt_document.get("items"): if not item.is_fixed_asset and item.serial_no: serial_nos = get_serial_nos(item.serial_no) if serial_nos: - frappe.db.sql("update `tabSerial No` set purchase_rate=%s where name in ({0})" - .format(", ".join(["%s"]*len(serial_nos))), tuple([item.valuation_rate] + serial_nos)) + frappe.db.sql( + "update `tabSerial No` set purchase_rate=%s where name in ({0})".format( + ", ".join(["%s"] * len(serial_nos)) + ), + tuple([item.valuation_rate] + serial_nos), + ) diff --git a/erpnext/stock/doctype/landed_cost_voucher/test_landed_cost_voucher.py b/erpnext/stock/doctype/landed_cost_voucher/test_landed_cost_voucher.py index 9204842b8f6..790d284a3dc 100644 --- a/erpnext/stock/doctype/landed_cost_voucher/test_landed_cost_voucher.py +++ b/erpnext/stock/doctype/landed_cost_voucher/test_landed_cost_voucher.py @@ -2,53 +2,92 @@ # License: GNU General Public License v3. See license.txt - import frappe -from frappe.utils import flt +from frappe.tests.utils import FrappeTestCase +from frappe.utils import add_days, add_to_date, flt, now from erpnext.accounts.doctype.account.test_account import create_account, get_inventory_account from erpnext.accounts.doctype.purchase_invoice.test_purchase_invoice import make_purchase_invoice +from erpnext.accounts.utils import update_gl_entries_after from erpnext.assets.doctype.asset.test_asset import create_asset_category, create_fixed_asset_item +from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import ( get_gl_entries, make_purchase_receipt, ) -from erpnext.tests.utils import ERPNextTestCase -class TestLandedCostVoucher(ERPNextTestCase): +class TestLandedCostVoucher(FrappeTestCase): def test_landed_cost_voucher(self): frappe.db.set_value("Buying Settings", None, "allow_multiple_items", 1) - pr = make_purchase_receipt(company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", supplier_warehouse = "Work in Progress - TCP1", - get_multiple_items = True, get_taxes_and_charges = True) + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", + get_multiple_items=True, + get_taxes_and_charges=True, + ) - last_sle = frappe.db.get_value("Stock Ledger Entry", { + last_sle = frappe.db.get_value( + "Stock Ledger Entry", + { "voucher_type": pr.doctype, "voucher_no": pr.name, "item_code": "_Test Item", - "warehouse": "Stores - TCP1" + "warehouse": "Stores - TCP1", + "is_cancelled": 0, }, - fieldname=["qty_after_transaction", "stock_value"], as_dict=1) + fieldname=["qty_after_transaction", "stock_value"], + as_dict=1, + ) create_landed_cost_voucher("Purchase Receipt", pr.name, pr.company) - pr_lc_value = frappe.db.get_value("Purchase Receipt Item", {"parent": pr.name}, "landed_cost_voucher_amount") + pr_lc_value = frappe.db.get_value( + "Purchase Receipt Item", {"parent": pr.name}, "landed_cost_voucher_amount" + ) self.assertEqual(pr_lc_value, 25.0) - last_sle_after_landed_cost = frappe.db.get_value("Stock Ledger Entry", { + last_sle_after_landed_cost = frappe.db.get_value( + "Stock Ledger Entry", + { "voucher_type": pr.doctype, "voucher_no": pr.name, "item_code": "_Test Item", - "warehouse": "Stores - TCP1" + "warehouse": "Stores - TCP1", + "is_cancelled": 0, }, - fieldname=["qty_after_transaction", "stock_value"], as_dict=1) - - self.assertEqual(last_sle.qty_after_transaction, last_sle_after_landed_cost.qty_after_transaction) + fieldname=["qty_after_transaction", "stock_value"], + as_dict=1, + ) + self.assertEqual( + last_sle.qty_after_transaction, last_sle_after_landed_cost.qty_after_transaction + ) self.assertEqual(last_sle_after_landed_cost.stock_value - last_sle.stock_value, 25.0) + # assert after submit + self.assertPurchaseReceiptLCVGLEntries(pr) + + # Mess up cancelled SLE modified timestamp to check + # if they aren't effective in any business logic. + frappe.db.set_value( + "Stock Ledger Entry", + {"is_cancelled": 1, "voucher_type": pr.doctype, "voucher_no": pr.name}, + "is_cancelled", + 1, + modified=add_to_date(now(), hours=1, as_datetime=True, as_string=True), + ) + + items, warehouses = pr.get_items_and_warehouses() + update_gl_entries_after(pr.posting_date, pr.posting_time, warehouses, items, company=pr.company) + + # reassert after reposting + self.assertPurchaseReceiptLCVGLEntries(pr) + + def assertPurchaseReceiptLCVGLEntries(self, pr): + gl_entries = get_gl_entries("Purchase Receipt", pr.name) self.assertTrue(gl_entries) @@ -62,54 +101,129 @@ class TestLandedCostVoucher(ERPNextTestCase): "Stock Received But Not Billed - TCP1": [0.0, 500.0], "Expenses Included In Valuation - TCP1": [0.0, 50.0], "_Test Account Customs Duty - TCP1": [0.0, 150], - "_Test Account Shipping Charges - TCP1": [0.0, 100.00] + "_Test Account Shipping Charges - TCP1": [0.0, 100.00], } else: expected_values = { stock_in_hand_account: [400.0, 0.0], fixed_asset_account: [400.0, 0.0], "Stock Received But Not Billed - TCP1": [0.0, 500.0], - "Expenses Included In Valuation - TCP1": [0.0, 300.0] + "Expenses Included In Valuation - TCP1": [0.0, 300.0], } for gle in gl_entries: - if not gle.get('is_cancelled'): - self.assertEqual(expected_values[gle.account][0], gle.debit) - self.assertEqual(expected_values[gle.account][1], gle.credit) + if not gle.get("is_cancelled"): + self.assertEqual( + expected_values[gle.account][0], gle.debit, msg=f"incorrect debit for {gle.account}" + ) + self.assertEqual( + expected_values[gle.account][1], gle.credit, msg=f"incorrect credit for {gle.account}" + ) + def test_landed_cost_voucher_stock_impact(self): + "Test impact of LCV on future stock balances." + from erpnext.stock.doctype.item.test_item import make_item + + item = make_item("LCV Stock Item", {"is_stock_item": 1}) + warehouse = "Stores - _TC" + + pr1 = make_purchase_receipt( + item_code=item.name, + warehouse=warehouse, + qty=500, + rate=80, + posting_date=add_days(frappe.utils.nowdate(), -2), + ) + pr2 = make_purchase_receipt( + item_code=item.name, + warehouse=warehouse, + qty=100, + rate=80, + posting_date=frappe.utils.nowdate(), + ) + + last_sle = frappe.db.get_value( # SLE of second PR + "Stock Ledger Entry", + { + "voucher_type": pr2.doctype, + "voucher_no": pr2.name, + "item_code": item.name, + "warehouse": warehouse, + "is_cancelled": 0, + }, + fieldname=["qty_after_transaction", "stock_value"], + as_dict=1, + ) + + create_landed_cost_voucher("Purchase Receipt", pr1.name, pr1.company) + + last_sle_after_landed_cost = frappe.db.get_value( # SLE of second PR after LCV's effect + "Stock Ledger Entry", + { + "voucher_type": pr2.doctype, + "voucher_no": pr2.name, + "item_code": item.name, + "warehouse": warehouse, + "is_cancelled": 0, + }, + fieldname=["qty_after_transaction", "stock_value"], + as_dict=1, + ) + + self.assertEqual( + last_sle.qty_after_transaction, last_sle_after_landed_cost.qty_after_transaction + ) + self.assertEqual(last_sle_after_landed_cost.stock_value - last_sle.stock_value, 50.0) def test_landed_cost_voucher_against_purchase_invoice(self): - pi = make_purchase_invoice(update_stock=1, posting_date=frappe.utils.nowdate(), - posting_time=frappe.utils.nowtime(), cash_bank_account="Cash - TCP1", - company="_Test Company with perpetual inventory", supplier_warehouse="Work In Progress - TCP1", - warehouse= "Stores - TCP1", cost_center = "Main - TCP1", - expense_account ="_Test Account Cost for Goods Sold - TCP1") + pi = make_purchase_invoice( + update_stock=1, + posting_date=frappe.utils.nowdate(), + posting_time=frappe.utils.nowtime(), + cash_bank_account="Cash - TCP1", + company="_Test Company with perpetual inventory", + supplier_warehouse="Work In Progress - TCP1", + warehouse="Stores - TCP1", + cost_center="Main - TCP1", + expense_account="_Test Account Cost for Goods Sold - TCP1", + ) - last_sle = frappe.db.get_value("Stock Ledger Entry", { + last_sle = frappe.db.get_value( + "Stock Ledger Entry", + { "voucher_type": pi.doctype, "voucher_no": pi.name, "item_code": "_Test Item", - "warehouse": "Stores - TCP1" + "warehouse": "Stores - TCP1", }, - fieldname=["qty_after_transaction", "stock_value"], as_dict=1) + fieldname=["qty_after_transaction", "stock_value"], + as_dict=1, + ) create_landed_cost_voucher("Purchase Invoice", pi.name, pi.company) - pi_lc_value = frappe.db.get_value("Purchase Invoice Item", {"parent": pi.name}, - "landed_cost_voucher_amount") + pi_lc_value = frappe.db.get_value( + "Purchase Invoice Item", {"parent": pi.name}, "landed_cost_voucher_amount" + ) self.assertEqual(pi_lc_value, 50.0) - last_sle_after_landed_cost = frappe.db.get_value("Stock Ledger Entry", { + last_sle_after_landed_cost = frappe.db.get_value( + "Stock Ledger Entry", + { "voucher_type": pi.doctype, "voucher_no": pi.name, "item_code": "_Test Item", - "warehouse": "Stores - TCP1" + "warehouse": "Stores - TCP1", }, - fieldname=["qty_after_transaction", "stock_value"], as_dict=1) + fieldname=["qty_after_transaction", "stock_value"], + as_dict=1, + ) - self.assertEqual(last_sle.qty_after_transaction, last_sle_after_landed_cost.qty_after_transaction) + self.assertEqual( + last_sle.qty_after_transaction, last_sle_after_landed_cost.qty_after_transaction + ) self.assertEqual(last_sle_after_landed_cost.stock_value - last_sle.stock_value, 50.0) @@ -121,20 +235,26 @@ class TestLandedCostVoucher(ERPNextTestCase): expected_values = { stock_in_hand_account: [300.0, 0.0], "Creditors - TCP1": [0.0, 250.0], - "Expenses Included In Valuation - TCP1": [0.0, 50.0] + "Expenses Included In Valuation - TCP1": [0.0, 50.0], } for gle in gl_entries: - if not gle.get('is_cancelled'): + if not gle.get("is_cancelled"): self.assertEqual(expected_values[gle.account][0], gle.debit) self.assertEqual(expected_values[gle.account][1], gle.credit) - def test_landed_cost_voucher_for_serialized_item(self): - frappe.db.sql("delete from `tabSerial No` where name in ('SN001', 'SN002', 'SN003', 'SN004', 'SN005')") - pr = make_purchase_receipt(company="_Test Company with perpetual inventory", warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1", get_multiple_items = True, - get_taxes_and_charges = True, do_not_submit = True) + frappe.db.sql( + "delete from `tabSerial No` where name in ('SN001', 'SN002', 'SN003', 'SN004', 'SN005')" + ) + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", + get_multiple_items=True, + get_taxes_and_charges=True, + do_not_submit=True, + ) pr.items[0].item_code = "_Test Serialized Item" pr.items[0].serial_no = "SN001\nSN002\nSN003\nSN004\nSN005" @@ -144,24 +264,92 @@ class TestLandedCostVoucher(ERPNextTestCase): create_landed_cost_voucher("Purchase Receipt", pr.name, pr.company) - serial_no = frappe.db.get_value("Serial No", "SN001", - ["warehouse", "purchase_rate"], as_dict=1) + serial_no = frappe.db.get_value("Serial No", "SN001", ["warehouse", "purchase_rate"], as_dict=1) self.assertEqual(serial_no.purchase_rate - serial_no_rate, 5.0) self.assertEqual(serial_no.warehouse, "Stores - TCP1") + def test_serialized_lcv_delivered(self): + """In some cases you'd want to deliver before you can know all the + landed costs, this should be allowed for serial nos too. - def test_landed_cost_voucher_for_odd_numbers (self): - pr = make_purchase_receipt(company="_Test Company with perpetual inventory", warehouse = "Stores - TCP1", supplier_warehouse = "Work in Progress - TCP1", do_not_save=True) + Case: + - receipt a serial no @ X rate + - delivery the serial no @ X rate + - add LCV to receipt X + Y + - LCV should be successful + - delivery should reflect X+Y valuation. + """ + serial_no = "LCV_TEST_SR_NO" + item_code = "_Test Serialized Item" + warehouse = "Stores - TCP1" + + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + warehouse=warehouse, + qty=1, + rate=200, + item_code=item_code, + serial_no=serial_no, + ) + + serial_no_rate = frappe.db.get_value("Serial No", serial_no, "purchase_rate") + + # deliver it before creating LCV + dn = create_delivery_note( + item_code=item_code, + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + serial_no=serial_no, + qty=1, + rate=500, + cost_center="Main - TCP1", + expense_account="Cost of Goods Sold - TCP1", + ) + + charges = 10 + create_landed_cost_voucher("Purchase Receipt", pr.name, pr.company, charges=charges) + + new_purchase_rate = serial_no_rate + charges + + serial_no = frappe.db.get_value( + "Serial No", serial_no, ["warehouse", "purchase_rate"], as_dict=1 + ) + + self.assertEqual(serial_no.purchase_rate, new_purchase_rate) + + stock_value_difference = frappe.db.get_value( + "Stock Ledger Entry", + filters={ + "voucher_no": dn.name, + "voucher_type": dn.doctype, + "is_cancelled": 0, # LCV cancels with same name. + }, + fieldname="stock_value_difference", + ) + + # reposting should update the purchase rate in future delivery + self.assertEqual(stock_value_difference, -new_purchase_rate) + + def test_landed_cost_voucher_for_odd_numbers(self): + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", + do_not_save=True, + ) pr.items[0].cost_center = "Main - TCP1" for x in range(2): - pr.append("items", { - "item_code": "_Test Item", - "warehouse": "Stores - TCP1", - "cost_center": "Main - TCP1", - "qty": 5, - "rate": 50 - }) + pr.append( + "items", + { + "item_code": "_Test Item", + "warehouse": "Stores - TCP1", + "cost_center": "Main - TCP1", + "qty": 5, + "rate": 50, + }, + ) pr.submit() lcv = create_landed_cost_voucher("Purchase Receipt", pr.name, pr.company, 123.22) @@ -170,37 +358,50 @@ class TestLandedCostVoucher(ERPNextTestCase): self.assertEqual(flt(lcv.items[2].applicable_charges, 2), 41.08) def test_multiple_landed_cost_voucher_against_pr(self): - pr = make_purchase_receipt(company="_Test Company with perpetual inventory", warehouse = "Stores - TCP1", - supplier_warehouse = "Stores - TCP1", do_not_save=True) + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + supplier_warehouse="Stores - TCP1", + do_not_save=True, + ) - pr.append("items", { - "item_code": "_Test Item", - "warehouse": "Stores - TCP1", - "cost_center": "Main - TCP1", - "qty": 5, - "rate": 100 - }) + pr.append( + "items", + { + "item_code": "_Test Item", + "warehouse": "Stores - TCP1", + "cost_center": "Main - TCP1", + "qty": 5, + "rate": 100, + }, + ) pr.submit() - lcv1 = make_landed_cost_voucher(company = pr.company, receipt_document_type = 'Purchase Receipt', - receipt_document=pr.name, charges=100, do_not_save=True) + lcv1 = make_landed_cost_voucher( + company=pr.company, + receipt_document_type="Purchase Receipt", + receipt_document=pr.name, + charges=100, + do_not_save=True, + ) lcv1.insert() - lcv1.set('items', [ - lcv1.get('items')[0] - ]) + lcv1.set("items", [lcv1.get("items")[0]]) distribute_landed_cost_on_items(lcv1) lcv1.submit() - lcv2 = make_landed_cost_voucher(company = pr.company, receipt_document_type = 'Purchase Receipt', - receipt_document=pr.name, charges=100, do_not_save=True) + lcv2 = make_landed_cost_voucher( + company=pr.company, + receipt_document_type="Purchase Receipt", + receipt_document=pr.name, + charges=100, + do_not_save=True, + ) lcv2.insert() - lcv2.set('items', [ - lcv2.get('items')[1] - ]) + lcv2.set("items", [lcv2.get("items")[1]]) distribute_landed_cost_on_items(lcv2) lcv2.submit() @@ -219,22 +420,31 @@ class TestLandedCostVoucher(ERPNextTestCase): save_new_records(test_records) ## Create USD Shipping charges_account - usd_shipping = create_account(account_name="Shipping Charges USD", - parent_account="Duties and Taxes - TCP1", company="_Test Company with perpetual inventory", - account_currency="USD") + usd_shipping = create_account( + account_name="Shipping Charges USD", + parent_account="Duties and Taxes - TCP1", + company="_Test Company with perpetual inventory", + account_currency="USD", + ) - pr = make_purchase_receipt(company="_Test Company with perpetual inventory", warehouse = "Stores - TCP1", - supplier_warehouse = "Stores - TCP1") + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + supplier_warehouse="Stores - TCP1", + ) pr.submit() - lcv = make_landed_cost_voucher(company = pr.company, receipt_document_type = "Purchase Receipt", - receipt_document=pr.name, charges=100, do_not_save=True) + lcv = make_landed_cost_voucher( + company=pr.company, + receipt_document_type="Purchase Receipt", + receipt_document=pr.name, + charges=100, + do_not_save=True, + ) - lcv.append("taxes", { - "description": "Shipping Charges", - "expense_account": usd_shipping, - "amount": 10 - }) + lcv.append( + "taxes", {"description": "Shipping Charges", "expense_account": usd_shipping, "amount": 10} + ) lcv.save() lcv.submit() @@ -244,12 +454,18 @@ class TestLandedCostVoucher(ERPNextTestCase): self.assertEqual(lcv.total_taxes_and_charges, 729) self.assertEqual(pr.items[0].landed_cost_voucher_amount, 729) - gl_entries = frappe.get_all("GL Entry", fields=["account", "credit", "credit_in_account_currency"], - filters={"voucher_no": pr.name, "account": ("in", ["Shipping Charges USD - TCP1", "Expenses Included In Valuation - TCP1"])}) + gl_entries = frappe.get_all( + "GL Entry", + fields=["account", "credit", "credit_in_account_currency"], + filters={ + "voucher_no": pr.name, + "account": ("in", ["Shipping Charges USD - TCP1", "Expenses Included In Valuation - TCP1"]), + }, + ) expected_gl_entries = { "Shipping Charges USD - TCP1": [629, 10], - "Expenses Included In Valuation - TCP1": [100, 100] + "Expenses Included In Valuation - TCP1": [100, 100], } for entry in gl_entries: @@ -259,7 +475,9 @@ class TestLandedCostVoucher(ERPNextTestCase): def test_asset_lcv(self): "Check if LCV for an Asset updates the Assets Gross Purchase Amount correctly." - frappe.db.set_value("Company", "_Test Company", "capital_work_in_progress_account", "CWIP Account - _TC") + frappe.db.set_value( + "Company", "_Test Company", "capital_work_in_progress_account", "CWIP Account - _TC" + ) if not frappe.db.exists("Asset Category", "Computers"): create_asset_category() @@ -270,15 +488,16 @@ class TestLandedCostVoucher(ERPNextTestCase): pr = make_purchase_receipt(item_code="Macbook Pro", qty=1, rate=50000) # check if draft asset was created - assets = frappe.db.get_all('Asset', filters={'purchase_receipt': pr.name}) + assets = frappe.db.get_all("Asset", filters={"purchase_receipt": pr.name}) self.assertEqual(len(assets), 1) lcv = make_landed_cost_voucher( - company = pr.company, - receipt_document_type = "Purchase Receipt", + company=pr.company, + receipt_document_type="Purchase Receipt", receipt_document=pr.name, charges=80, - expense_account="Expenses Included In Valuation - _TC") + expense_account="Expenses Included In Valuation - _TC", + ) lcv.save() lcv.submit() @@ -290,27 +509,38 @@ class TestLandedCostVoucher(ERPNextTestCase): lcv.cancel() pr.cancel() -def make_landed_cost_voucher(** args): + +def make_landed_cost_voucher(**args): args = frappe._dict(args) ref_doc = frappe.get_doc(args.receipt_document_type, args.receipt_document) - lcv = frappe.new_doc('Landed Cost Voucher') - lcv.company = args.company or '_Test Company' - lcv.distribute_charges_based_on = 'Amount' + lcv = frappe.new_doc("Landed Cost Voucher") + lcv.company = args.company or "_Test Company" + lcv.distribute_charges_based_on = "Amount" - lcv.set('purchase_receipts', [{ - "receipt_document_type": args.receipt_document_type, - "receipt_document": args.receipt_document, - "supplier": ref_doc.supplier, - "posting_date": ref_doc.posting_date, - "grand_total": ref_doc.grand_total - }]) + lcv.set( + "purchase_receipts", + [ + { + "receipt_document_type": args.receipt_document_type, + "receipt_document": args.receipt_document, + "supplier": ref_doc.supplier, + "posting_date": ref_doc.posting_date, + "grand_total": ref_doc.grand_total, + } + ], + ) - lcv.set("taxes", [{ - "description": "Shipping Charges", - "expense_account": args.expense_account or "Expenses Included In Valuation - TCP1", - "amount": args.charges - }]) + lcv.set( + "taxes", + [ + { + "description": "Shipping Charges", + "expense_account": args.expense_account or "Expenses Included In Valuation - TCP1", + "amount": args.charges, + } + ], + ) if not args.do_not_save: lcv.insert() @@ -325,21 +555,31 @@ def create_landed_cost_voucher(receipt_document_type, receipt_document, company, lcv = frappe.new_doc("Landed Cost Voucher") lcv.company = company - lcv.distribute_charges_based_on = 'Amount' + lcv.distribute_charges_based_on = "Amount" - lcv.set("purchase_receipts", [{ - "receipt_document_type": receipt_document_type, - "receipt_document": receipt_document, - "supplier": ref_doc.supplier, - "posting_date": ref_doc.posting_date, - "grand_total": ref_doc.base_grand_total - }]) + lcv.set( + "purchase_receipts", + [ + { + "receipt_document_type": receipt_document_type, + "receipt_document": receipt_document, + "supplier": ref_doc.supplier, + "posting_date": ref_doc.posting_date, + "grand_total": ref_doc.base_grand_total, + } + ], + ) - lcv.set("taxes", [{ - "description": "Insurance Charges", - "expense_account": "Expenses Included In Valuation - TCP1", - "amount": charges - }]) + lcv.set( + "taxes", + [ + { + "description": "Insurance Charges", + "expense_account": "Expenses Included In Valuation - TCP1", + "amount": charges, + } + ], + ) lcv.insert() @@ -349,6 +589,7 @@ def create_landed_cost_voucher(receipt_document_type, receipt_document, company, return lcv + def distribute_landed_cost_on_items(lcv): based_on = lcv.distribute_charges_based_on.lower() total = sum(flt(d.get(based_on)) for d in lcv.get("items")) @@ -357,4 +598,5 @@ def distribute_landed_cost_on_items(lcv): item.applicable_charges = flt(item.get(based_on)) * flt(lcv.total_taxes_and_charges) / flt(total) item.applicable_charges = flt(item.applicable_charges, lcv.precision("applicable_charges", item)) -test_records = frappe.get_test_records('Landed Cost Voucher') + +test_records = frappe.get_test_records("Landed Cost Voucher") diff --git a/erpnext/stock/doctype/manufacturer/test_manufacturer.py b/erpnext/stock/doctype/manufacturer/test_manufacturer.py index 66323478c83..e176b28b85a 100644 --- a/erpnext/stock/doctype/manufacturer/test_manufacturer.py +++ b/erpnext/stock/doctype/manufacturer/test_manufacturer.py @@ -5,5 +5,6 @@ import unittest # test_records = frappe.get_test_records('Manufacturer') + class TestManufacturer(unittest.TestCase): pass diff --git a/erpnext/stock/doctype/material_request/material_request.js b/erpnext/stock/doctype/material_request/material_request.js index 087a7883e09..cc64b5caa52 100644 --- a/erpnext/stock/doctype/material_request/material_request.js +++ b/erpnext/stock/doctype/material_request/material_request.js @@ -214,6 +214,7 @@ frappe.ui.form.on('Material Request', { material_request_type: frm.doc.material_request_type, plc_conversion_rate: 1, rate: item.rate, + uom: item.uom, conversion_factor: item.conversion_factor }, overwrite_warehouse: overwrite_warehouse @@ -392,6 +393,7 @@ frappe.ui.form.on("Material Request Item", { item_code: function(frm, doctype, name) { const item = locals[doctype][name]; item.rate = 0; + item.uom = ''; set_schedule_date(frm); frm.events.get_item_data(frm, item, true); }, diff --git a/erpnext/stock/doctype/material_request/material_request.py b/erpnext/stock/doctype/material_request/material_request.py index d85970665e1..3474ca0db68 100644 --- a/erpnext/stock/doctype/material_request/material_request.py +++ b/erpnext/stock/doctype/material_request/material_request.py @@ -19,20 +19,19 @@ from erpnext.manufacturing.doctype.work_order.work_order import get_item_details from erpnext.stock.doctype.item.item import get_item_defaults from erpnext.stock.stock_balance import get_indented_qty, update_bin_qty -form_grid_templates = { - "items": "templates/form_grid/material_request_grid.html" -} +form_grid_templates = {"items": "templates/form_grid/material_request_grid.html"} + class MaterialRequest(BuyingController): def get_feed(self): - return _("{0}: {1}").format(self.status, self.material_request_type) + return def check_if_already_pulled(self): pass def validate_qty_against_so(self): - so_items = {} # Format --> {'SO/00001': {'Item/001': 120, 'Item/002': 24}} - for d in self.get('items'): + so_items = {} # Format --> {'SO/00001': {'Item/001': 120, 'Item/002': 24}} + for d in self.get("items"): if d.sales_order: if not d.sales_order in so_items: so_items[d.sales_order] = {d.item_code: flt(d.qty)} @@ -44,35 +43,57 @@ class MaterialRequest(BuyingController): for so_no in so_items.keys(): for item in so_items[so_no].keys(): - already_indented = frappe.db.sql("""select sum(qty) + already_indented = frappe.db.sql( + """select sum(qty) from `tabMaterial Request Item` where item_code = %s and sales_order = %s and - docstatus = 1 and parent != %s""", (item, so_no, self.name)) + docstatus = 1 and parent != %s""", + (item, so_no, self.name), + ) already_indented = already_indented and flt(already_indented[0][0]) or 0 - actual_so_qty = frappe.db.sql("""select sum(stock_qty) from `tabSales Order Item` - where parent = %s and item_code = %s and docstatus = 1""", (so_no, item)) + actual_so_qty = frappe.db.sql( + """select sum(stock_qty) from `tabSales Order Item` + where parent = %s and item_code = %s and docstatus = 1""", + (so_no, item), + ) actual_so_qty = actual_so_qty and flt(actual_so_qty[0][0]) or 0 if actual_so_qty and (flt(so_items[so_no][item]) + already_indented > actual_so_qty): - frappe.throw(_("Material Request of maximum {0} can be made for Item {1} against Sales Order {2}").format(actual_so_qty - already_indented, item, so_no)) + frappe.throw( + _("Material Request of maximum {0} can be made for Item {1} against Sales Order {2}").format( + actual_so_qty - already_indented, item, so_no + ) + ) - # Validate - # --------------------- def validate(self): super(MaterialRequest, self).validate() self.validate_schedule_date() - self.check_for_on_hold_or_closed_status('Sales Order', 'sales_order') + self.check_for_on_hold_or_closed_status("Sales Order", "sales_order") self.validate_uom_is_integer("uom", "qty") + self.validate_material_request_type() if not self.status: self.status = "Draft" from erpnext.controllers.status_updater import validate_status - validate_status(self.status, - ["Draft", "Submitted", "Stopped", "Cancelled", "Pending", - "Partially Ordered", "Ordered", "Issued", "Transferred", "Received"]) + + validate_status( + self.status, + [ + "Draft", + "Submitted", + "Stopped", + "Cancelled", + "Pending", + "Partially Ordered", + "Ordered", + "Issued", + "Transferred", + "Received", + ], + ) validate_for_items(self) @@ -84,17 +105,26 @@ class MaterialRequest(BuyingController): self.reset_default_field_value("set_warehouse", "items", "warehouse") self.reset_default_field_value("set_from_warehouse", "items", "from_warehouse") + def before_update_after_submit(self): + self.validate_schedule_date() + + def validate_material_request_type(self): + """Validate fields in accordance with selected type""" + + if self.material_request_type != "Customer Provided": + self.customer = None + def set_title(self): - '''Set title as comma separated list of items''' + """Set title as comma separated list of items""" if not self.title: - items = ', '.join([d.item_name for d in self.items][:3]) - self.title = _('{0} Request for {1}').format(self.material_request_type, items)[:100] + items = ", ".join([d.item_name for d in self.items][:3]) + self.title = _("{0} Request for {1}").format(self.material_request_type, items)[:100] def on_submit(self): # frappe.db.set(self, 'status', 'Submitted') self.update_requested_qty() self.update_requested_qty_in_production_plan() - if self.material_request_type == 'Purchase': + if self.material_request_type == "Purchase": self.validate_budget() def before_save(self): @@ -107,13 +137,15 @@ class MaterialRequest(BuyingController): # if MRQ is already closed, no point saving the document check_on_hold_or_closed_status(self.doctype, self.name) - self.set_status(update=True, status='Cancelled') + self.set_status(update=True, status="Cancelled") def check_modified_date(self): - mod_db = frappe.db.sql("""select modified from `tabMaterial Request` where name = %s""", - self.name) - date_diff = frappe.db.sql("""select TIMEDIFF('%s', '%s')""" - % (mod_db[0][0], cstr(self.modified))) + mod_db = frappe.db.sql( + """select modified from `tabMaterial Request` where name = %s""", self.name + ) + date_diff = frappe.db.sql( + """select TIMEDIFF('%s', '%s')""" % (mod_db[0][0], cstr(self.modified)) + ) if date_diff and date_diff[0][0]: frappe.throw(_("{0} {1} has been modified. Please refresh.").format(_(self.doctype), self.name)) @@ -129,22 +161,24 @@ class MaterialRequest(BuyingController): validates that `status` is acceptable for the present controller status and throws an Exception if otherwise. """ - if self.status and self.status == 'Cancelled': + if self.status and self.status == "Cancelled": # cancelled documents cannot change if status != self.status: frappe.throw( - _("{0} {1} is cancelled so the action cannot be completed"). - format(_(self.doctype), self.name), - frappe.InvalidStatusError + _("{0} {1} is cancelled so the action cannot be completed").format( + _(self.doctype), self.name + ), + frappe.InvalidStatusError, ) - elif self.status and self.status == 'Draft': + elif self.status and self.status == "Draft": # draft document to pending only - if status != 'Pending': + if status != "Pending": frappe.throw( - _("{0} {1} has not been submitted so the action cannot be completed"). - format(_(self.doctype), self.name), - frappe.InvalidStatusError + _("{0} {1} has not been submitted so the action cannot be completed").format( + _(self.doctype), self.name + ), + frappe.InvalidStatusError, ) def on_cancel(self): @@ -161,67 +195,90 @@ class MaterialRequest(BuyingController): for d in self.get("items"): if d.name in mr_items: if self.material_request_type in ("Material Issue", "Material Transfer", "Customer Provided"): - d.ordered_qty = flt(frappe.db.sql("""select sum(transfer_qty) + d.ordered_qty = flt( + frappe.db.sql( + """select sum(transfer_qty) from `tabStock Entry Detail` where material_request = %s and material_request_item = %s and docstatus = 1""", - (self.name, d.name))[0][0]) - mr_qty_allowance = frappe.db.get_single_value('Stock Settings', 'mr_qty_allowance') + (self.name, d.name), + )[0][0] + ) + mr_qty_allowance = frappe.db.get_single_value("Stock Settings", "mr_qty_allowance") if mr_qty_allowance: - allowed_qty = d.qty + (d.qty * (mr_qty_allowance/100)) + allowed_qty = d.qty + (d.qty * (mr_qty_allowance / 100)) if d.ordered_qty and d.ordered_qty > allowed_qty: - frappe.throw(_("The total Issue / Transfer quantity {0} in Material Request {1} \ - cannot be greater than allowed requested quantity {2} for Item {3}").format(d.ordered_qty, d.parent, allowed_qty, d.item_code)) + frappe.throw( + _( + "The total Issue / Transfer quantity {0} in Material Request {1} \ + cannot be greater than allowed requested quantity {2} for Item {3}" + ).format(d.ordered_qty, d.parent, allowed_qty, d.item_code) + ) elif d.ordered_qty and d.ordered_qty > d.stock_qty: - frappe.throw(_("The total Issue / Transfer quantity {0} in Material Request {1} \ - cannot be greater than requested quantity {2} for Item {3}").format(d.ordered_qty, d.parent, d.qty, d.item_code)) + frappe.throw( + _( + "The total Issue / Transfer quantity {0} in Material Request {1} \ + cannot be greater than requested quantity {2} for Item {3}" + ).format(d.ordered_qty, d.parent, d.qty, d.item_code) + ) elif self.material_request_type == "Manufacture": - d.ordered_qty = flt(frappe.db.sql("""select sum(qty) + d.ordered_qty = flt( + frappe.db.sql( + """select sum(qty) from `tabWork Order` where material_request = %s and material_request_item = %s and docstatus = 1""", - (self.name, d.name))[0][0]) + (self.name, d.name), + )[0][0] + ) frappe.db.set_value(d.doctype, d.name, "ordered_qty", d.ordered_qty) - self._update_percent_field({ - "target_dt": "Material Request Item", - "target_parent_dt": self.doctype, - "target_parent_field": "per_ordered", - "target_ref_field": "stock_qty", - "target_field": "ordered_qty", - "name": self.name, - }, update_modified) + self._update_percent_field( + { + "target_dt": "Material Request Item", + "target_parent_dt": self.doctype, + "target_parent_field": "per_ordered", + "target_ref_field": "stock_qty", + "target_field": "ordered_qty", + "name": self.name, + }, + update_modified, + ) def update_requested_qty(self, mr_item_rows=None): """update requested qty (before ordered_qty is updated)""" item_wh_list = [] for d in self.get("items"): - if (not mr_item_rows or d.name in mr_item_rows) and [d.item_code, d.warehouse] not in item_wh_list \ - and d.warehouse and frappe.db.get_value("Item", d.item_code, "is_stock_item") == 1 : + if ( + (not mr_item_rows or d.name in mr_item_rows) + and [d.item_code, d.warehouse] not in item_wh_list + and d.warehouse + and frappe.db.get_value("Item", d.item_code, "is_stock_item") == 1 + ): item_wh_list.append([d.item_code, d.warehouse]) for item_code, warehouse in item_wh_list: - update_bin_qty(item_code, warehouse, { - "indented_qty": get_indented_qty(item_code, warehouse) - }) + update_bin_qty(item_code, warehouse, {"indented_qty": get_indented_qty(item_code, warehouse)}) def update_requested_qty_in_production_plan(self): production_plans = [] - for d in self.get('items'): + for d in self.get("items"): if d.production_plan and d.material_request_plan_item: qty = d.qty if self.docstatus == 1 else 0 - frappe.db.set_value('Material Request Plan Item', - d.material_request_plan_item, 'requested_qty', qty) + frappe.db.set_value( + "Material Request Plan Item", d.material_request_plan_item, "requested_qty", qty + ) if d.production_plan not in production_plans: production_plans.append(d.production_plan) for production_plan in production_plans: - doc = frappe.get_doc('Production Plan', production_plan) + doc = frappe.get_doc("Production Plan", production_plan) doc.set_status() - doc.db_set('status', doc.status) + doc.db_set("status", doc.status) + def update_completed_and_requested_qty(stock_entry, method): if stock_entry.doctype == "Stock Entry": @@ -236,43 +293,55 @@ def update_completed_and_requested_qty(stock_entry, method): mr_obj = frappe.get_doc("Material Request", mr) if mr_obj.status in ["Stopped", "Cancelled"]: - frappe.throw(_("{0} {1} is cancelled or stopped").format(_("Material Request"), mr), - frappe.InvalidStatusError) + frappe.throw( + _("{0} {1} is cancelled or stopped").format(_("Material Request"), mr), + frappe.InvalidStatusError, + ) mr_obj.update_completed_qty(mr_item_rows) mr_obj.update_requested_qty(mr_item_rows) + def set_missing_values(source, target_doc): - if target_doc.doctype == "Purchase Order" and getdate(target_doc.schedule_date) < getdate(nowdate()): + if target_doc.doctype == "Purchase Order" and getdate(target_doc.schedule_date) < getdate( + nowdate() + ): target_doc.schedule_date = None target_doc.run_method("set_missing_values") target_doc.run_method("calculate_taxes_and_totals") + def update_item(obj, target, source_parent): target.conversion_factor = obj.conversion_factor - target.qty = flt(flt(obj.stock_qty) - flt(obj.ordered_qty))/ target.conversion_factor - target.stock_qty = (target.qty * target.conversion_factor) + target.qty = flt(flt(obj.stock_qty) - flt(obj.ordered_qty)) / target.conversion_factor + target.stock_qty = target.qty * target.conversion_factor if getdate(target.schedule_date) < getdate(nowdate()): target.schedule_date = None + def get_list_context(context=None): from erpnext.controllers.website_list_for_contact import get_list_context + list_context = get_list_context(context) - list_context.update({ - 'show_sidebar': True, - 'show_search': True, - 'no_breadcrumbs': True, - 'title': _('Material Request'), - }) + list_context.update( + { + "show_sidebar": True, + "show_search": True, + "no_breadcrumbs": True, + "title": _("Material Request"), + } + ) return list_context + @frappe.whitelist() def update_status(name, status): - material_request = frappe.get_doc('Material Request', name) - material_request.check_permission('write') + material_request = frappe.get_doc("Material Request", name) + material_request.check_permission("write") material_request.update_status(status) + @frappe.whitelist() def make_purchase_order(source_name, target_doc=None, args=None): if args is None: @@ -285,7 +354,7 @@ def make_purchase_order(source_name, target_doc=None, args=None): # items only for given default supplier supplier_items = [] for d in target_doc.items: - default_supplier = get_item_defaults(d.item_code, target_doc.company).get('default_supplier') + default_supplier = get_item_defaults(d.item_code, target_doc.company).get("default_supplier") if frappe.flags.args.default_supplier == default_supplier: supplier_items.append(d) target_doc.items = supplier_items @@ -293,58 +362,65 @@ def make_purchase_order(source_name, target_doc=None, args=None): set_missing_values(source, target_doc) def select_item(d): - filtered_items = args.get('filtered_children', []) + filtered_items = args.get("filtered_children", []) child_filter = d.name in filtered_items if filtered_items else True return d.ordered_qty < d.stock_qty and child_filter - doclist = get_mapped_doc("Material Request", source_name, { - "Material Request": { - "doctype": "Purchase Order", - "validation": { - "docstatus": ["=", 1], - "material_request_type": ["=", "Purchase"] - } + doclist = get_mapped_doc( + "Material Request", + source_name, + { + "Material Request": { + "doctype": "Purchase Order", + "validation": {"docstatus": ["=", 1], "material_request_type": ["=", "Purchase"]}, + }, + "Material Request Item": { + "doctype": "Purchase Order Item", + "field_map": [ + ["name", "material_request_item"], + ["parent", "material_request"], + ["uom", "stock_uom"], + ["uom", "uom"], + ["sales_order", "sales_order"], + ["sales_order_item", "sales_order_item"], + ], + "postprocess": update_item, + "condition": select_item, + }, }, - "Material Request Item": { - "doctype": "Purchase Order Item", - "field_map": [ - ["name", "material_request_item"], - ["parent", "material_request"], - ["uom", "stock_uom"], - ["uom", "uom"], - ["sales_order", "sales_order"], - ["sales_order_item", "sales_order_item"] - ], - "postprocess": update_item, - "condition": select_item - } - }, target_doc, postprocess) + target_doc, + postprocess, + ) return doclist + @frappe.whitelist() def make_request_for_quotation(source_name, target_doc=None): - doclist = get_mapped_doc("Material Request", source_name, { - "Material Request": { - "doctype": "Request for Quotation", - "validation": { - "docstatus": ["=", 1], - "material_request_type": ["=", "Purchase"] - } + doclist = get_mapped_doc( + "Material Request", + source_name, + { + "Material Request": { + "doctype": "Request for Quotation", + "validation": {"docstatus": ["=", 1], "material_request_type": ["=", "Purchase"]}, + }, + "Material Request Item": { + "doctype": "Request for Quotation Item", + "field_map": [ + ["name", "material_request_item"], + ["parent", "material_request"], + ["uom", "uom"], + ], + }, }, - "Material Request Item": { - "doctype": "Request for Quotation Item", - "field_map": [ - ["name", "material_request_item"], - ["parent", "material_request"], - ["uom", "uom"] - ] - } - }, target_doc) + target_doc, + ) return doclist + @frappe.whitelist() def make_purchase_order_based_on_supplier(source_name, target_doc=None, args=None): mr = source_name @@ -355,43 +431,59 @@ def make_purchase_order_based_on_supplier(source_name, target_doc=None, args=Non target_doc.supplier = args.get("supplier") if getdate(target_doc.schedule_date) < getdate(nowdate()): target_doc.schedule_date = None - target_doc.set("items", [d for d in target_doc.get("items") - if d.get("item_code") in supplier_items and d.get("qty") > 0]) + target_doc.set( + "items", + [ + d for d in target_doc.get("items") if d.get("item_code") in supplier_items and d.get("qty") > 0 + ], + ) set_missing_values(source, target_doc) - target_doc = get_mapped_doc("Material Request", mr, { - "Material Request": { - "doctype": "Purchase Order", + target_doc = get_mapped_doc( + "Material Request", + mr, + { + "Material Request": { + "doctype": "Purchase Order", + }, + "Material Request Item": { + "doctype": "Purchase Order Item", + "field_map": [ + ["name", "material_request_item"], + ["parent", "material_request"], + ["uom", "stock_uom"], + ["uom", "uom"], + ], + "postprocess": update_item, + "condition": lambda doc: doc.ordered_qty < doc.qty, + }, }, - "Material Request Item": { - "doctype": "Purchase Order Item", - "field_map": [ - ["name", "material_request_item"], - ["parent", "material_request"], - ["uom", "stock_uom"], - ["uom", "uom"] - ], - "postprocess": update_item, - "condition": lambda doc: doc.ordered_qty < doc.qty - } - }, target_doc, postprocess) + target_doc, + postprocess, + ) return target_doc + @frappe.whitelist() def get_items_based_on_default_supplier(supplier): - supplier_items = [d.parent for d in frappe.db.get_all("Item Default", - {"default_supplier": supplier, "parenttype": "Item"}, 'parent')] + supplier_items = [ + d.parent + for d in frappe.db.get_all( + "Item Default", {"default_supplier": supplier, "parenttype": "Item"}, "parent" + ) + ] return supplier_items + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_material_requests_based_on_supplier(doctype, txt, searchfield, start, page_len, filters): conditions = "" if txt: - conditions += "and mr.name like '%%"+txt+"%%' " + conditions += "and mr.name like '%%" + txt + "%%' " if filters.get("transaction_date"): date = filters.get("transaction_date")[1] @@ -403,7 +495,8 @@ def get_material_requests_based_on_supplier(doctype, txt, searchfield, start, pa if not supplier_items: frappe.throw(_("{0} is not the default supplier for any items.").format(supplier)) - material_requests = frappe.db.sql("""select distinct mr.name, transaction_date,company + material_requests = frappe.db.sql( + """select distinct mr.name, transaction_date,company from `tabMaterial Request` mr, `tabMaterial Request Item` mr_item where mr.name = mr_item.parent and mr_item.item_code in ({0}) @@ -414,12 +507,16 @@ def get_material_requests_based_on_supplier(doctype, txt, searchfield, start, pa and mr.company = '{1}' {2} order by mr_item.item_code ASC - limit {3} offset {4} """ \ - .format(', '.join(['%s']*len(supplier_items)), filters.get("company"), conditions, page_len, start), - tuple(supplier_items), as_dict=1) + limit {3} offset {4} """.format( + ", ".join(["%s"] * len(supplier_items)), filters.get("company"), conditions, page_len, start + ), + tuple(supplier_items), + as_dict=1, + ) return material_requests + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def get_default_supplier_query(doctype, txt, searchfield, start, page_len, filters): @@ -428,47 +525,63 @@ def get_default_supplier_query(doctype, txt, searchfield, start, page_len, filte for d in doc.items: item_list.append(d.item_code) - return frappe.db.sql("""select default_supplier + return frappe.db.sql( + """select default_supplier from `tabItem Default` where parent in ({0}) and default_supplier IS NOT NULL - """.format(', '.join(['%s']*len(item_list))),tuple(item_list)) + """.format( + ", ".join(["%s"] * len(item_list)) + ), + tuple(item_list), + ) + @frappe.whitelist() def make_supplier_quotation(source_name, target_doc=None): def postprocess(source, target_doc): set_missing_values(source, target_doc) - doclist = get_mapped_doc("Material Request", source_name, { - "Material Request": { - "doctype": "Supplier Quotation", - "validation": { - "docstatus": ["=", 1], - "material_request_type": ["=", "Purchase"] - } + doclist = get_mapped_doc( + "Material Request", + source_name, + { + "Material Request": { + "doctype": "Supplier Quotation", + "validation": {"docstatus": ["=", 1], "material_request_type": ["=", "Purchase"]}, + }, + "Material Request Item": { + "doctype": "Supplier Quotation Item", + "field_map": { + "name": "material_request_item", + "parent": "material_request", + "sales_order": "sales_order", + }, + }, }, - "Material Request Item": { - "doctype": "Supplier Quotation Item", - "field_map": { - "name": "material_request_item", - "parent": "material_request", - "sales_order": "sales_order" - } - } - }, target_doc, postprocess) + target_doc, + postprocess, + ) return doclist + @frappe.whitelist() def make_stock_entry(source_name, target_doc=None): def update_item(obj, target, source_parent): - qty = flt(flt(obj.stock_qty) - flt(obj.ordered_qty))/ target.conversion_factor \ - if flt(obj.stock_qty) > flt(obj.ordered_qty) else 0 + qty = ( + flt(flt(obj.stock_qty) - flt(obj.ordered_qty)) / target.conversion_factor + if flt(obj.stock_qty) > flt(obj.ordered_qty) + else 0 + ) target.qty = qty target.transfer_qty = qty * obj.conversion_factor target.conversion_factor = obj.conversion_factor - if source_parent.material_request_type == "Material Transfer" or source_parent.material_request_type == "Customer Provided": + if ( + source_parent.material_request_type == "Material Transfer" + or source_parent.material_request_type == "Customer Provided" + ): target.t_warehouse = obj.warehouse else: target.s_warehouse = obj.warehouse @@ -482,109 +595,128 @@ def make_stock_entry(source_name, target_doc=None): def set_missing_values(source, target): target.purpose = source.material_request_type if source.job_card: - target.purpose = 'Material Transfer for Manufacture' + target.purpose = "Material Transfer for Manufacture" if source.material_request_type == "Customer Provided": target.purpose = "Material Receipt" - target.run_method("calculate_rate_and_amount") + target.set_missing_values() target.set_stock_entry_type() target.set_job_card_data() - doclist = get_mapped_doc("Material Request", source_name, { - "Material Request": { - "doctype": "Stock Entry", - "validation": { - "docstatus": ["=", 1], - "material_request_type": ["in", ["Material Transfer", "Material Issue", "Customer Provided"]] - } - }, - "Material Request Item": { - "doctype": "Stock Entry Detail", - "field_map": { - "name": "material_request_item", - "parent": "material_request", - "uom": "stock_uom", - "job_card_item": "job_card_item" + doclist = get_mapped_doc( + "Material Request", + source_name, + { + "Material Request": { + "doctype": "Stock Entry", + "validation": { + "docstatus": ["=", 1], + "material_request_type": ["in", ["Material Transfer", "Material Issue", "Customer Provided"]], + }, }, - "postprocess": update_item, - "condition": lambda doc: doc.ordered_qty < doc.stock_qty - } - }, target_doc, set_missing_values) + "Material Request Item": { + "doctype": "Stock Entry Detail", + "field_map": { + "name": "material_request_item", + "parent": "material_request", + "uom": "stock_uom", + "job_card_item": "job_card_item", + }, + "postprocess": update_item, + "condition": lambda doc: doc.ordered_qty < doc.stock_qty, + }, + }, + target_doc, + set_missing_values, + ) return doclist + @frappe.whitelist() def raise_work_orders(material_request): - mr= frappe.get_doc("Material Request", material_request) - errors =[] + mr = frappe.get_doc("Material Request", material_request) + errors = [] work_orders = [] - default_wip_warehouse = frappe.db.get_single_value("Manufacturing Settings", "default_wip_warehouse") + default_wip_warehouse = frappe.db.get_single_value( + "Manufacturing Settings", "default_wip_warehouse" + ) for d in mr.items: if (d.stock_qty - d.ordered_qty) > 0: if frappe.db.exists("BOM", {"item": d.item_code, "is_default": 1}): wo_order = frappe.new_doc("Work Order") - wo_order.update({ - "production_item": d.item_code, - "qty": d.stock_qty - d.ordered_qty, - "fg_warehouse": d.warehouse, - "wip_warehouse": default_wip_warehouse, - "description": d.description, - "stock_uom": d.stock_uom, - "expected_delivery_date": d.schedule_date, - "sales_order": d.sales_order, - "bom_no": get_item_details(d.item_code).bom_no, - "material_request": mr.name, - "material_request_item": d.name, - "planned_start_date": mr.transaction_date, - "company": mr.company - }) + wo_order.update( + { + "production_item": d.item_code, + "qty": d.stock_qty - d.ordered_qty, + "fg_warehouse": d.warehouse, + "wip_warehouse": default_wip_warehouse, + "description": d.description, + "stock_uom": d.stock_uom, + "expected_delivery_date": d.schedule_date, + "sales_order": d.sales_order, + "sales_order_item": d.get("sales_order_item"), + "bom_no": get_item_details(d.item_code).bom_no, + "material_request": mr.name, + "material_request_item": d.name, + "planned_start_date": mr.transaction_date, + "company": mr.company, + } + ) wo_order.set_work_order_operations() wo_order.save() work_orders.append(wo_order.name) else: - errors.append(_("Row {0}: Bill of Materials not found for the Item {1}") - .format(d.idx, get_link_to_form("Item", d.item_code))) + errors.append( + _("Row {0}: Bill of Materials not found for the Item {1}").format( + d.idx, get_link_to_form("Item", d.item_code) + ) + ) if work_orders: work_orders_list = [get_link_to_form("Work Order", d) for d in work_orders] if len(work_orders) > 1: - msgprint(_("The following {0} were created: {1}") - .format(frappe.bold(_("Work Orders")), '
' + ', '.join(work_orders_list))) + msgprint( + _("The following {0} were created: {1}").format( + frappe.bold(_("Work Orders")), "
" + ", ".join(work_orders_list) + ) + ) else: - msgprint(_("The {0} {1} created sucessfully") - .format(frappe.bold(_("Work Order")), work_orders_list[0])) + msgprint( + _("The {0} {1} created sucessfully").format(frappe.bold(_("Work Order")), work_orders_list[0]) + ) if errors: - frappe.throw(_("Work Order cannot be created for following reason:
{0}") - .format(new_line_sep(errors))) + frappe.throw( + _("Work Order cannot be created for following reason:
{0}").format(new_line_sep(errors)) + ) return work_orders + @frappe.whitelist() def create_pick_list(source_name, target_doc=None): - doc = get_mapped_doc('Material Request', source_name, { - 'Material Request': { - 'doctype': 'Pick List', - 'field_map': { - 'material_request_type': 'purpose' + doc = get_mapped_doc( + "Material Request", + source_name, + { + "Material Request": { + "doctype": "Pick List", + "field_map": {"material_request_type": "purpose"}, + "validation": {"docstatus": ["=", 1]}, }, - 'validation': { - 'docstatus': ['=', 1] - } - }, - 'Material Request Item': { - 'doctype': 'Pick List Item', - 'field_map': { - 'name': 'material_request_item', - 'qty': 'stock_qty' + "Material Request Item": { + "doctype": "Pick List Item", + "field_map": {"name": "material_request_item", "qty": "stock_qty"}, }, }, - }, target_doc) + target_doc, + ) doc.set_item_locations() diff --git a/erpnext/stock/doctype/material_request/material_request_dashboard.py b/erpnext/stock/doctype/material_request/material_request_dashboard.py index 9133859b24f..b073e6a22ee 100644 --- a/erpnext/stock/doctype/material_request/material_request_dashboard.py +++ b/erpnext/stock/doctype/material_request/material_request_dashboard.py @@ -1,23 +1,15 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'material_request', - 'transactions': [ + "fieldname": "material_request", + "transactions": [ { - 'label': _('Reference'), - 'items': ['Request for Quotation', 'Supplier Quotation', 'Purchase Order'] + "label": _("Reference"), + "items": ["Request for Quotation", "Supplier Quotation", "Purchase Order"], }, - { - 'label': _('Stock'), - 'items': ['Stock Entry', 'Purchase Receipt', 'Pick List'] - - }, - { - 'label': _('Manufacturing'), - 'items': ['Work Order'] - } - ] + {"label": _("Stock"), "items": ["Stock Entry", "Purchase Receipt", "Pick List"]}, + {"label": _("Manufacturing"), "items": ["Work Order"]}, + ], } diff --git a/erpnext/stock/doctype/material_request/test_material_request.py b/erpnext/stock/doctype/material_request/test_material_request.py index 383b0ae806e..78af1532ea8 100644 --- a/erpnext/stock/doctype/material_request/test_material_request.py +++ b/erpnext/stock/doctype/material_request/test_material_request.py @@ -6,6 +6,7 @@ import frappe +from frappe.tests.utils import FrappeTestCase from frappe.utils import flt, today from erpnext.stock.doctype.item.test_item import create_item @@ -15,15 +16,13 @@ from erpnext.stock.doctype.material_request.material_request import ( make_supplier_quotation, raise_work_orders, ) -from erpnext.tests.utils import ERPNextTestCase -class TestMaterialRequest(ERPNextTestCase): +class TestMaterialRequest(FrappeTestCase): def test_make_purchase_order(self): mr = frappe.copy_doc(test_records[0]).insert() - self.assertRaises(frappe.ValidationError, make_purchase_order, - mr.name) + self.assertRaises(frappe.ValidationError, make_purchase_order, mr.name) mr = frappe.get_doc("Material Request", mr.name) mr.submit() @@ -44,7 +43,6 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(sq.doctype, "Supplier Quotation") self.assertEqual(len(sq.get("items")), len(mr.get("items"))) - def test_make_stock_entry(self): mr = frappe.copy_doc(test_records[0]).insert() @@ -58,42 +56,44 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(se.doctype, "Stock Entry") self.assertEqual(len(se.get("items")), len(mr.get("items"))) - def _insert_stock_entry(self, qty1, qty2, warehouse = None ): - se = frappe.get_doc({ - "company": "_Test Company", - "doctype": "Stock Entry", - "posting_date": "2013-03-01", - "posting_time": "00:00:00", - "purpose": "Material Receipt", - "items": [ - { - "conversion_factor": 1.0, - "doctype": "Stock Entry Detail", - "item_code": "_Test Item Home Desktop 100", - "parentfield": "items", - "basic_rate": 100, - "qty": qty1, - "stock_uom": "_Test UOM 1", - "transfer_qty": qty1, - "uom": "_Test UOM 1", - "t_warehouse": warehouse or "_Test Warehouse 1 - _TC", - "cost_center": "_Test Cost Center - _TC" - }, - { - "conversion_factor": 1.0, - "doctype": "Stock Entry Detail", - "item_code": "_Test Item Home Desktop 200", - "parentfield": "items", - "basic_rate": 100, - "qty": qty2, - "stock_uom": "_Test UOM 1", - "transfer_qty": qty2, - "uom": "_Test UOM 1", - "t_warehouse": warehouse or "_Test Warehouse 1 - _TC", - "cost_center": "_Test Cost Center - _TC" - } - ] - }) + def _insert_stock_entry(self, qty1, qty2, warehouse=None): + se = frappe.get_doc( + { + "company": "_Test Company", + "doctype": "Stock Entry", + "posting_date": "2013-03-01", + "posting_time": "00:00:00", + "purpose": "Material Receipt", + "items": [ + { + "conversion_factor": 1.0, + "doctype": "Stock Entry Detail", + "item_code": "_Test Item Home Desktop 100", + "parentfield": "items", + "basic_rate": 100, + "qty": qty1, + "stock_uom": "_Test UOM 1", + "transfer_qty": qty1, + "uom": "_Test UOM 1", + "t_warehouse": warehouse or "_Test Warehouse 1 - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + { + "conversion_factor": 1.0, + "doctype": "Stock Entry Detail", + "item_code": "_Test Item Home Desktop 200", + "parentfield": "items", + "basic_rate": 100, + "qty": qty2, + "stock_uom": "_Test UOM 1", + "transfer_qty": qty2, + "uom": "_Test UOM 1", + "t_warehouse": warehouse or "_Test Warehouse 1 - _TC", + "cost_center": "_Test Cost Center - _TC", + }, + ], + } + ) se.set_stock_entry_type() se.insert() @@ -106,19 +106,19 @@ class TestMaterialRequest(ERPNextTestCase): mr.load_from_db() mr.cancel() - self.assertRaises(frappe.ValidationError, mr.update_status, 'Stopped') + self.assertRaises(frappe.ValidationError, mr.update_status, "Stopped") def test_mr_changes_from_stopped_to_pending_after_reopen(self): mr = frappe.copy_doc(test_records[0]) mr.insert() mr.submit() - self.assertEqual('Pending', mr.status) + self.assertEqual("Pending", mr.status) - mr.update_status('Stopped') - self.assertEqual('Stopped', mr.status) + mr.update_status("Stopped") + self.assertEqual("Stopped", mr.status) - mr.update_status('Submitted') - self.assertEqual('Pending', mr.status) + mr.update_status("Submitted") + self.assertEqual("Pending", mr.status) def test_cannot_submit_cancelled_mr(self): mr = frappe.copy_doc(test_records[0]) @@ -133,7 +133,7 @@ class TestMaterialRequest(ERPNextTestCase): mr.insert() mr.submit() mr.cancel() - self.assertEqual('Cancelled', mr.status) + self.assertEqual("Cancelled", mr.status) def test_cannot_change_cancelled_mr(self): mr = frappe.copy_doc(test_records[0]) @@ -142,12 +142,12 @@ class TestMaterialRequest(ERPNextTestCase): mr.load_from_db() mr.cancel() - self.assertRaises(frappe.InvalidStatusError, mr.update_status, 'Draft') - self.assertRaises(frappe.InvalidStatusError, mr.update_status, 'Stopped') - self.assertRaises(frappe.InvalidStatusError, mr.update_status, 'Ordered') - self.assertRaises(frappe.InvalidStatusError, mr.update_status, 'Issued') - self.assertRaises(frappe.InvalidStatusError, mr.update_status, 'Transferred') - self.assertRaises(frappe.InvalidStatusError, mr.update_status, 'Pending') + self.assertRaises(frappe.InvalidStatusError, mr.update_status, "Draft") + self.assertRaises(frappe.InvalidStatusError, mr.update_status, "Stopped") + self.assertRaises(frappe.InvalidStatusError, mr.update_status, "Ordered") + self.assertRaises(frappe.InvalidStatusError, mr.update_status, "Issued") + self.assertRaises(frappe.InvalidStatusError, mr.update_status, "Transferred") + self.assertRaises(frappe.InvalidStatusError, mr.update_status, "Pending") def test_cannot_submit_deleted_material_request(self): mr = frappe.copy_doc(test_records[0]) @@ -169,9 +169,9 @@ class TestMaterialRequest(ERPNextTestCase): mr.submit() mr.load_from_db() - mr.update_status('Stopped') - mr.update_status('Submitted') - self.assertEqual(mr.status, 'Pending') + mr.update_status("Stopped") + mr.update_status("Submitted") + self.assertEqual(mr.status, "Pending") def test_pending_mr_changes_to_stopped_after_stop(self): mr = frappe.copy_doc(test_records[0]) @@ -179,17 +179,21 @@ class TestMaterialRequest(ERPNextTestCase): mr.submit() mr.load_from_db() - mr.update_status('Stopped') - self.assertEqual(mr.status, 'Stopped') + mr.update_status("Stopped") + self.assertEqual(mr.status, "Stopped") def test_cannot_stop_unsubmitted_mr(self): mr = frappe.copy_doc(test_records[0]) mr.insert() - self.assertRaises(frappe.InvalidStatusError, mr.update_status, 'Stopped') + self.assertRaises(frappe.InvalidStatusError, mr.update_status, "Stopped") def test_completed_qty_for_purchase(self): - existing_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - existing_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + existing_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + existing_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) # submit material request of type Purchase mr = frappe.copy_doc(test_records[0]) @@ -206,19 +210,18 @@ class TestMaterialRequest(ERPNextTestCase): po_doc.get("items")[0].schedule_date = "2013-07-09" po_doc.get("items")[1].schedule_date = "2013-07-09" - # check for stopped status of Material Request po = frappe.copy_doc(po_doc) po.insert() po.load_from_db() - mr.update_status('Stopped') + mr.update_status("Stopped") self.assertRaises(frappe.InvalidStatusError, po.submit) frappe.db.set(po, "docstatus", 1) self.assertRaises(frappe.InvalidStatusError, po.cancel) # resubmit and check for per complete mr.load_from_db() - mr.update_status('Submitted') + mr.update_status("Submitted") po = frappe.copy_doc(po_doc) po.insert() po.submit() @@ -229,8 +232,12 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.get("items")[0].ordered_qty, 27.0) self.assertEqual(mr.get("items")[1].ordered_qty, 1.5) - current_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - current_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + current_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + current_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) self.assertEqual(current_requested_qty_item1, existing_requested_qty_item1 + 27.0) self.assertEqual(current_requested_qty_item2, existing_requested_qty_item2 + 1.5) @@ -242,15 +249,23 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.get("items")[0].ordered_qty, 0) self.assertEqual(mr.get("items")[1].ordered_qty, 0) - current_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - current_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + current_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + current_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) self.assertEqual(current_requested_qty_item1, existing_requested_qty_item1 + 54.0) self.assertEqual(current_requested_qty_item2, existing_requested_qty_item2 + 3.0) def test_completed_qty_for_transfer(self): - existing_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - existing_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + existing_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + existing_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) # submit material request of type Purchase mr = frappe.copy_doc(test_records[0]) @@ -264,31 +279,31 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.get("items")[0].ordered_qty, 0) self.assertEqual(mr.get("items")[1].ordered_qty, 0) - current_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - current_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + current_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + current_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) self.assertEqual(current_requested_qty_item1, existing_requested_qty_item1 + 54.0) self.assertEqual(current_requested_qty_item2, existing_requested_qty_item2 + 3.0) # map a stock entry se_doc = make_stock_entry(mr.name) - se_doc.update({ - "posting_date": "2013-03-01", - "posting_time": "01:00", - "fiscal_year": "_Test Fiscal Year 2013", - }) - se_doc.get("items")[0].update({ - "qty": 27.0, - "transfer_qty": 27.0, - "s_warehouse": "_Test Warehouse 1 - _TC", - "basic_rate": 1.0 - }) - se_doc.get("items")[1].update({ - "qty": 1.5, - "transfer_qty": 1.5, - "s_warehouse": "_Test Warehouse 1 - _TC", - "basic_rate": 1.0 - }) + se_doc.update( + { + "posting_date": "2013-03-01", + "posting_time": "01:00", + "fiscal_year": "_Test Fiscal Year 2013", + } + ) + se_doc.get("items")[0].update( + {"qty": 27.0, "transfer_qty": 27.0, "s_warehouse": "_Test Warehouse 1 - _TC", "basic_rate": 1.0} + ) + se_doc.get("items")[1].update( + {"qty": 1.5, "transfer_qty": 1.5, "s_warehouse": "_Test Warehouse 1 - _TC", "basic_rate": 1.0} + ) # make available the qty in _Test Warehouse 1 before transfer self._insert_stock_entry(27.0, 1.5) @@ -296,17 +311,17 @@ class TestMaterialRequest(ERPNextTestCase): # check for stopped status of Material Request se = frappe.copy_doc(se_doc) se.insert() - mr.update_status('Stopped') + mr.update_status("Stopped") self.assertRaises(frappe.InvalidStatusError, se.submit) - mr.update_status('Submitted') + mr.update_status("Submitted") se.flags.ignore_validate_update_after_submit = True se.submit() - mr.update_status('Stopped') + mr.update_status("Stopped") self.assertRaises(frappe.InvalidStatusError, se.cancel) - mr.update_status('Submitted') + mr.update_status("Submitted") se = frappe.copy_doc(se_doc) se.insert() se.submit() @@ -317,8 +332,12 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.get("items")[0].ordered_qty, 27.0) self.assertEqual(mr.get("items")[1].ordered_qty, 1.5) - current_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - current_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + current_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + current_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) self.assertEqual(current_requested_qty_item1, existing_requested_qty_item1 + 27.0) self.assertEqual(current_requested_qty_item2, existing_requested_qty_item2 + 1.5) @@ -330,56 +349,70 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.get("items")[0].ordered_qty, 0) self.assertEqual(mr.get("items")[1].ordered_qty, 0) - current_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - current_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + current_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + current_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) self.assertEqual(current_requested_qty_item1, existing_requested_qty_item1 + 54.0) self.assertEqual(current_requested_qty_item2, existing_requested_qty_item2 + 3.0) def test_over_transfer_qty_allowance(self): - mr = frappe.new_doc('Material Request') + mr = frappe.new_doc("Material Request") mr.company = "_Test Company" mr.scheduled_date = today() - mr.append('items',{ - "item_code": "_Test FG Item", - "item_name": "_Test FG Item", - "qty": 10, - "schedule_date": today(), - "uom": "_Test UOM 1", - "warehouse": "_Test Warehouse - _TC" - }) + mr.append( + "items", + { + "item_code": "_Test FG Item", + "item_name": "_Test FG Item", + "qty": 10, + "schedule_date": today(), + "uom": "_Test UOM 1", + "warehouse": "_Test Warehouse - _TC", + }, + ) mr.material_request_type = "Material Transfer" mr.insert() mr.submit() - frappe.db.set_value('Stock Settings', None, 'mr_qty_allowance', 20) + frappe.db.set_value("Stock Settings", None, "mr_qty_allowance", 20) # map a stock entry se_doc = make_stock_entry(mr.name) - se_doc.update({ - "posting_date": today(), - "posting_time": "00:00", - }) - se_doc.get("items")[0].update({ - "qty": 13, - "transfer_qty": 12.0, - "s_warehouse": "_Test Warehouse - _TC", - "t_warehouse": "_Test Warehouse 1 - _TC", - "basic_rate": 1.0 - }) + se_doc.update( + { + "posting_date": today(), + "posting_time": "00:00", + } + ) + se_doc.get("items")[0].update( + { + "qty": 13, + "transfer_qty": 12.0, + "s_warehouse": "_Test Warehouse - _TC", + "t_warehouse": "_Test Warehouse 1 - _TC", + "basic_rate": 1.0, + } + ) # make available the qty in _Test Warehouse 1 before transfer sr = frappe.new_doc("Stock Reconciliation") sr.company = "_Test Company" sr.purpose = "Opening Stock" - sr.append('items', { - "item_code": "_Test FG Item", - "warehouse": "_Test Warehouse - _TC", - "qty": 20, - "valuation_rate": 0.01 - }) + sr.append( + "items", + { + "item_code": "_Test FG Item", + "warehouse": "_Test Warehouse - _TC", + "qty": 20, + "valuation_rate": 0.01, + }, + ) sr.insert() sr.submit() se = frappe.copy_doc(se_doc) @@ -389,8 +422,12 @@ class TestMaterialRequest(ERPNextTestCase): se.submit() def test_completed_qty_for_over_transfer(self): - existing_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - existing_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + existing_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + existing_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) # submit material request of type Purchase mr = frappe.copy_doc(test_records[0]) @@ -401,23 +438,19 @@ class TestMaterialRequest(ERPNextTestCase): # map a stock entry se_doc = make_stock_entry(mr.name) - se_doc.update({ - "posting_date": "2013-03-01", - "posting_time": "00:00", - "fiscal_year": "_Test Fiscal Year 2013", - }) - se_doc.get("items")[0].update({ - "qty": 54.0, - "transfer_qty": 54.0, - "s_warehouse": "_Test Warehouse 1 - _TC", - "basic_rate": 1.0 - }) - se_doc.get("items")[1].update({ - "qty": 3.0, - "transfer_qty": 3.0, - "s_warehouse": "_Test Warehouse 1 - _TC", - "basic_rate": 1.0 - }) + se_doc.update( + { + "posting_date": "2013-03-01", + "posting_time": "00:00", + "fiscal_year": "_Test Fiscal Year 2013", + } + ) + se_doc.get("items")[0].update( + {"qty": 54.0, "transfer_qty": 54.0, "s_warehouse": "_Test Warehouse 1 - _TC", "basic_rate": 1.0} + ) + se_doc.get("items")[1].update( + {"qty": 3.0, "transfer_qty": 3.0, "s_warehouse": "_Test Warehouse 1 - _TC", "basic_rate": 1.0} + ) # make available the qty in _Test Warehouse 1 before transfer self._insert_stock_entry(60.0, 3.0) @@ -426,11 +459,11 @@ class TestMaterialRequest(ERPNextTestCase): se = frappe.copy_doc(se_doc) se.set_stock_entry_type() se.insert() - mr.update_status('Stopped') + mr.update_status("Stopped") self.assertRaises(frappe.InvalidStatusError, se.submit) self.assertRaises(frappe.InvalidStatusError, se.cancel) - mr.update_status('Submitted') + mr.update_status("Submitted") se = frappe.copy_doc(se_doc) se.set_stock_entry_type() se.insert() @@ -443,8 +476,12 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.get("items")[0].ordered_qty, 54.0) self.assertEqual(mr.get("items")[1].ordered_qty, 3.0) - current_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - current_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + current_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + current_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) self.assertEqual(current_requested_qty_item1, existing_requested_qty_item1) self.assertEqual(current_requested_qty_item2, existing_requested_qty_item2) @@ -456,8 +493,12 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.get("items")[0].ordered_qty, 0) self.assertEqual(mr.get("items")[1].ordered_qty, 0) - current_requested_qty_item1 = self._get_requested_qty("_Test Item Home Desktop 100", "_Test Warehouse - _TC") - current_requested_qty_item2 = self._get_requested_qty("_Test Item Home Desktop 200", "_Test Warehouse - _TC") + current_requested_qty_item1 = self._get_requested_qty( + "_Test Item Home Desktop 100", "_Test Warehouse - _TC" + ) + current_requested_qty_item2 = self._get_requested_qty( + "_Test Item Home Desktop 200", "_Test Warehouse - _TC" + ) self.assertEqual(current_requested_qty_item1, existing_requested_qty_item1 + 54.0) self.assertEqual(current_requested_qty_item2, existing_requested_qty_item2 + 3.0) @@ -470,25 +511,31 @@ class TestMaterialRequest(ERPNextTestCase): mr.submit() se_doc = make_stock_entry(mr.name) - se_doc.update({ - "posting_date": "2013-03-01", - "posting_time": "00:00", - "fiscal_year": "_Test Fiscal Year 2013", - }) - se_doc.get("items")[0].update({ - "qty": 60.0, - "transfer_qty": 60.0, - "s_warehouse": "_Test Warehouse - _TC", - "t_warehouse": "_Test Warehouse 1 - _TC", - "basic_rate": 1.0 - }) - se_doc.get("items")[1].update({ - "item_code": "_Test Item Home Desktop 100", - "qty": 3.0, - "transfer_qty": 3.0, - "s_warehouse": "_Test Warehouse 1 - _TC", - "basic_rate": 1.0 - }) + se_doc.update( + { + "posting_date": "2013-03-01", + "posting_time": "00:00", + "fiscal_year": "_Test Fiscal Year 2013", + } + ) + se_doc.get("items")[0].update( + { + "qty": 60.0, + "transfer_qty": 60.0, + "s_warehouse": "_Test Warehouse - _TC", + "t_warehouse": "_Test Warehouse 1 - _TC", + "basic_rate": 1.0, + } + ) + se_doc.get("items")[1].update( + { + "item_code": "_Test Item Home Desktop 100", + "qty": 3.0, + "transfer_qty": 3.0, + "s_warehouse": "_Test Warehouse 1 - _TC", + "basic_rate": 1.0, + } + ) # check for stopped status of Material Request se = frappe.copy_doc(se_doc) @@ -505,18 +552,20 @@ class TestMaterialRequest(ERPNextTestCase): def test_warehouse_company_validation(self): from erpnext.stock.utils import InvalidWarehouseCompany + mr = frappe.copy_doc(test_records[0]) mr.company = "_Test Company 1" self.assertRaises(InvalidWarehouseCompany, mr.insert) def _get_requested_qty(self, item_code, warehouse): - return flt(frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse}, "indented_qty")) + return flt( + frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse}, "indented_qty") + ) def test_make_stock_entry_for_material_issue(self): mr = frappe.copy_doc(test_records[0]).insert() - self.assertRaises(frappe.ValidationError, make_stock_entry, - mr.name) + self.assertRaises(frappe.ValidationError, make_stock_entry, mr.name) mr = frappe.get_doc("Material Request", mr.name) mr.material_request_type = "Material Issue" @@ -528,8 +577,13 @@ class TestMaterialRequest(ERPNextTestCase): def test_completed_qty_for_issue(self): def _get_requested_qty(): - return flt(frappe.db.get_value("Bin", {"item_code": "_Test Item Home Desktop 100", - "warehouse": "_Test Warehouse - _TC"}, "indented_qty")) + return flt( + frappe.db.get_value( + "Bin", + {"item_code": "_Test Item Home Desktop 100", "warehouse": "_Test Warehouse - _TC"}, + "indented_qty", + ) + ) existing_requested_qty = _get_requested_qty() @@ -537,7 +591,7 @@ class TestMaterialRequest(ERPNextTestCase): mr.material_request_type = "Material Issue" mr.submit() - #testing bin value after material request is submitted + # testing bin value after material request is submitted self.assertEqual(_get_requested_qty(), existing_requested_qty - 54.0) # receive items to allow issue @@ -556,7 +610,7 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.get("items")[0].ordered_qty, 54.0) self.assertEqual(mr.get("items")[1].ordered_qty, 3.0) - #testing bin requested qty after issuing stock against material request + # testing bin requested qty after issuing stock against material request self.assertEqual(_get_requested_qty(), existing_requested_qty) def test_material_request_type_manufacture(self): @@ -564,8 +618,11 @@ class TestMaterialRequest(ERPNextTestCase): mr = frappe.get_doc("Material Request", mr.name) mr.submit() completed_qty = mr.items[0].ordered_qty - requested_qty = frappe.db.sql("""select indented_qty from `tabBin` where \ - item_code= %s and warehouse= %s """, (mr.items[0].item_code, mr.items[0].warehouse))[0][0] + requested_qty = frappe.db.sql( + """select indented_qty from `tabBin` where \ + item_code= %s and warehouse= %s """, + (mr.items[0].item_code, mr.items[0].warehouse), + )[0][0] prod_order = raise_work_orders(mr.name) po = frappe.get_doc("Work Order", prod_order[0]) @@ -575,8 +632,11 @@ class TestMaterialRequest(ERPNextTestCase): mr = frappe.get_doc("Material Request", mr.name) self.assertEqual(completed_qty + po.qty, mr.items[0].ordered_qty) - new_requested_qty = frappe.db.sql("""select indented_qty from `tabBin` where \ - item_code= %s and warehouse= %s """, (mr.items[0].item_code, mr.items[0].warehouse))[0][0] + new_requested_qty = frappe.db.sql( + """select indented_qty from `tabBin` where \ + item_code= %s and warehouse= %s """, + (mr.items[0].item_code, mr.items[0].warehouse), + )[0][0] self.assertEqual(requested_qty - po.qty, new_requested_qty) @@ -585,17 +645,24 @@ class TestMaterialRequest(ERPNextTestCase): mr = frappe.get_doc("Material Request", mr.name) self.assertEqual(completed_qty, mr.items[0].ordered_qty) - new_requested_qty = frappe.db.sql("""select indented_qty from `tabBin` where \ - item_code= %s and warehouse= %s """, (mr.items[0].item_code, mr.items[0].warehouse))[0][0] + new_requested_qty = frappe.db.sql( + """select indented_qty from `tabBin` where \ + item_code= %s and warehouse= %s """, + (mr.items[0].item_code, mr.items[0].warehouse), + )[0][0] self.assertEqual(requested_qty, new_requested_qty) def test_requested_qty_multi_uom(self): - existing_requested_qty = self._get_requested_qty('_Test FG Item', '_Test Warehouse - _TC') + existing_requested_qty = self._get_requested_qty("_Test FG Item", "_Test Warehouse - _TC") - mr = make_material_request(item_code='_Test FG Item', material_request_type='Manufacture', - uom="_Test UOM 1", conversion_factor=12) + mr = make_material_request( + item_code="_Test FG Item", + material_request_type="Manufacture", + uom="_Test UOM 1", + conversion_factor=12, + ) - requested_qty = self._get_requested_qty('_Test FG Item', '_Test Warehouse - _TC') + requested_qty = self._get_requested_qty("_Test FG Item", "_Test Warehouse - _TC") self.assertEqual(requested_qty, existing_requested_qty + 120) @@ -605,42 +672,36 @@ class TestMaterialRequest(ERPNextTestCase): wo.wip_warehouse = "_Test Warehouse 1 - _TC" wo.submit() - requested_qty = self._get_requested_qty('_Test FG Item', '_Test Warehouse - _TC') + requested_qty = self._get_requested_qty("_Test FG Item", "_Test Warehouse - _TC") self.assertEqual(requested_qty, existing_requested_qty + 70) wo.cancel() - requested_qty = self._get_requested_qty('_Test FG Item', '_Test Warehouse - _TC') + requested_qty = self._get_requested_qty("_Test FG Item", "_Test Warehouse - _TC") self.assertEqual(requested_qty, existing_requested_qty + 120) mr.reload() mr.cancel() - requested_qty = self._get_requested_qty('_Test FG Item', '_Test Warehouse - _TC') + requested_qty = self._get_requested_qty("_Test FG Item", "_Test Warehouse - _TC") self.assertEqual(requested_qty, existing_requested_qty) - def test_multi_uom_for_purchase(self): mr = frappe.copy_doc(test_records[0]) - mr.material_request_type = 'Purchase' + mr.material_request_type = "Purchase" item = mr.items[0] mr.schedule_date = today() - if not frappe.db.get_value('UOM Conversion Detail', - {'parent': item.item_code, 'uom': 'Kg'}): - item_doc = frappe.get_doc('Item', item.item_code) - item_doc.append('uoms', { - 'uom': 'Kg', - 'conversion_factor': 5 - }) - item_doc.save(ignore_permissions=True) + if not frappe.db.get_value("UOM Conversion Detail", {"parent": item.item_code, "uom": "Kg"}): + item_doc = frappe.get_doc("Item", item.item_code) + item_doc.append("uoms", {"uom": "Kg", "conversion_factor": 5}) + item_doc.save(ignore_permissions=True) - item.uom = 'Kg' + item.uom = "Kg" for item in mr.items: item.schedule_date = mr.schedule_date mr.insert() - self.assertRaises(frappe.ValidationError, make_purchase_order, - mr.name) + self.assertRaises(frappe.ValidationError, make_purchase_order, mr.name) mr = frappe.get_doc("Material Request", mr.name) mr.submit() @@ -654,17 +715,19 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(po.doctype, "Purchase Order") self.assertEqual(len(po.get("items")), len(mr.get("items"))) - po.supplier = '_Test Supplier' + po.supplier = "_Test Supplier" po.insert() po.submit() mr = frappe.get_doc("Material Request", mr.name) self.assertEqual(mr.per_ordered, 100) def test_customer_provided_parts_mr(self): - create_item('CUST-0987', is_customer_provided_item = 1, customer = '_Test Customer', is_purchase_item = 0) + create_item( + "CUST-0987", is_customer_provided_item=1, customer="_Test Customer", is_purchase_item=0 + ) existing_requested_qty = self._get_requested_qty("_Test Customer", "_Test Warehouse - _TC") - mr = make_material_request(item_code='CUST-0987', material_request_type='Customer Provided') + mr = make_material_request(item_code="CUST-0987", material_request_type="Customer Provided") se = make_stock_entry(mr.name) se.insert() se.submit() @@ -677,25 +740,30 @@ class TestMaterialRequest(ERPNextTestCase): self.assertEqual(mr.per_ordered, 100) self.assertEqual(existing_requested_qty, current_requested_qty) + def make_material_request(**args): args = frappe._dict(args) mr = frappe.new_doc("Material Request") mr.material_request_type = args.material_request_type or "Purchase" mr.company = args.company or "_Test Company" - mr.customer = args.customer or '_Test Customer' - mr.append("items", { - "item_code": args.item_code or "_Test Item", - "qty": args.qty or 10, - "uom": args.uom or "_Test UOM", - "conversion_factor": args.conversion_factor or 1, - "schedule_date": args.schedule_date or today(), - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "cost_center": args.cost_center or "_Test Cost Center - _TC" - }) + mr.customer = args.customer or "_Test Customer" + mr.append( + "items", + { + "item_code": args.item_code or "_Test Item", + "qty": args.qty or 10, + "uom": args.uom or "_Test UOM", + "conversion_factor": args.conversion_factor or 1, + "schedule_date": args.schedule_date or today(), + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "cost_center": args.cost_center or "_Test Cost Center - _TC", + }, + ) mr.insert() if not args.do_not_submit: mr.submit() return mr + test_dependencies = ["Currency Exchange", "BOM"] -test_records = frappe.get_test_records('Material Request') +test_records = frappe.get_test_records("Material Request") diff --git a/erpnext/stock/doctype/material_request_item/material_request_item.json b/erpnext/stock/doctype/material_request_item/material_request_item.json index 2bad42a0ebb..dd66cfff8be 100644 --- a/erpnext/stock/doctype/material_request_item/material_request_item.json +++ b/erpnext/stock/doctype/material_request_item/material_request_item.json @@ -177,6 +177,7 @@ "fieldtype": "Column Break" }, { + "allow_on_submit": 1, "bold": 1, "columns": 2, "fieldname": "schedule_date", @@ -459,7 +460,7 @@ "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-11-03 14:40:24.409826", + "modified": "2022-03-10 18:42:42.705190", "modified_by": "Administrator", "module": "Stock", "name": "Material Request Item", diff --git a/erpnext/stock/doctype/material_request_item/material_request_item.py b/erpnext/stock/doctype/material_request_item/material_request_item.py index 32407d0fb09..08c9ed27427 100644 --- a/erpnext/stock/doctype/material_request_item/material_request_item.py +++ b/erpnext/stock/doctype/material_request_item/material_request_item.py @@ -11,5 +11,6 @@ from frappe.model.document import Document class MaterialRequestItem(Document): pass + def on_doctype_update(): frappe.db.add_index("Material Request Item", ["item_code", "warehouse"]) diff --git a/erpnext/stock/doctype/packed_item/packed_item.json b/erpnext/stock/doctype/packed_item/packed_item.json index 830d5469bf0..cb8eb30cb30 100644 --- a/erpnext/stock/doctype/packed_item/packed_item.json +++ b/erpnext/stock/doctype/packed_item/packed_item.json @@ -26,8 +26,10 @@ "section_break_13", "actual_qty", "projected_qty", + "ordered_qty", "column_break_16", "incoming_rate", + "picked_qty", "page_break", "prevdoc_doctype", "parent_detail_docname" @@ -218,21 +220,35 @@ "label": "Conversion Factor" }, { - "fetch_from": "item_code.valuation_rate", - "fetch_if_empty": 1, "fieldname": "rate", "fieldtype": "Currency", "in_list_view": 1, "label": "Rate", + "options": "currency", "print_hide": 1, "read_only": 1 + }, + { + "allow_on_submit": 1, + "fieldname": "ordered_qty", + "fieldtype": "Float", + "label": "Ordered Qty", + "no_copy": 1, + "read_only": 1 + }, + { + "fieldname": "picked_qty", + "fieldtype": "Float", + "label": "Picked Qty", + "no_copy": 1, + "read_only": 1 } ], "idx": 1, "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2021-09-01 15:10:29.646399", + "modified": "2022-04-27 05:23:08.683245", "modified_by": "Administrator", "module": "Stock", "name": "Packed Item", @@ -240,5 +256,6 @@ "permissions": [], "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/stock/doctype/packed_item/packed_item.py b/erpnext/stock/doctype/packed_item/packed_item.py index e4091c40dc4..4d05d7a345c 100644 --- a/erpnext/stock/doctype/packed_item/packed_item.py +++ b/erpnext/stock/doctype/packed_item/packed_item.py @@ -8,187 +8,280 @@ import json import frappe from frappe.model.document import Document -from frappe.utils import cstr, flt +from frappe.utils import flt -from erpnext.stock.get_item_details import get_item_details +from erpnext.stock.get_item_details import get_item_details, get_price_list_rate class PackedItem(Document): pass -def get_product_bundle_items(item_code): - return frappe.db.sql("""select t1.item_code, t1.qty, t1.uom, t1.description - from `tabProduct Bundle Item` t1, `tabProduct Bundle` t2 - where t2.new_item_code=%s and t1.parent = t2.name order by t1.idx""", item_code, as_dict=1) - -def get_packing_item_details(item, company): - return frappe.db.sql(""" - select i.item_name, i.is_stock_item, i.description, i.stock_uom, id.default_warehouse - from `tabItem` i LEFT JOIN `tabItem Default` id ON id.parent=i.name and id.company=%s - where i.name = %s""", - (company, item), as_dict = 1)[0] - -def get_bin_qty(item, warehouse): - det = frappe.db.sql("""select actual_qty, projected_qty from `tabBin` - where item_code = %s and warehouse = %s""", (item, warehouse), as_dict = 1) - return det and det[0] or frappe._dict() - -def update_packing_list_item(doc, packing_item_code, qty, main_item_row, description): - if doc.amended_from: - old_packed_items_map = get_old_packed_item_details(doc.packed_items) - else: - old_packed_items_map = False - item = get_packing_item_details(packing_item_code, doc.company) - - # check if exists - exists = 0 - for d in doc.get("packed_items"): - if d.parent_item == main_item_row.item_code and d.item_code == packing_item_code: - if d.parent_detail_docname != main_item_row.name: - d.parent_detail_docname = main_item_row.name - - pi, exists = d, 1 - break - - if not exists: - pi = doc.append('packed_items', {}) - - pi.parent_item = main_item_row.item_code - pi.item_code = packing_item_code - pi.item_name = item.item_name - pi.parent_detail_docname = main_item_row.name - pi.uom = item.stock_uom - pi.qty = flt(qty) - pi.conversion_factor = main_item_row.conversion_factor - if description and not pi.description: - pi.description = description - if not pi.warehouse and not doc.amended_from: - pi.warehouse = (main_item_row.warehouse if ((doc.get('is_pos') or item.is_stock_item \ - or not item.default_warehouse) and main_item_row.warehouse) else item.default_warehouse) - if not pi.batch_no and not doc.amended_from: - pi.batch_no = cstr(main_item_row.get("batch_no")) - if not pi.target_warehouse: - pi.target_warehouse = main_item_row.get("target_warehouse") - bin = get_bin_qty(packing_item_code, pi.warehouse) - pi.actual_qty = flt(bin.get("actual_qty")) - pi.projected_qty = flt(bin.get("projected_qty")) - if old_packed_items_map and old_packed_items_map.get((packing_item_code, main_item_row.item_code)): - pi.batch_no = old_packed_items_map.get((packing_item_code, main_item_row.item_code))[0].batch_no - pi.serial_no = old_packed_items_map.get((packing_item_code, main_item_row.item_code))[0].serial_no - pi.warehouse = old_packed_items_map.get((packing_item_code, main_item_row.item_code))[0].warehouse def make_packing_list(doc): - """make packing list for Product Bundle item""" - if doc.get("_action") and doc._action == "update_after_submit": return - - parent_items = [] - for d in doc.get("items"): - if frappe.db.get_value("Product Bundle", {"new_item_code": d.item_code}): - for i in get_product_bundle_items(d.item_code): - update_packing_list_item(doc, i.item_code, flt(i.qty)*flt(d.stock_qty), d, i.description) - - if [d.item_code, d.name] not in parent_items: - parent_items.append([d.item_code, d.name]) - - cleanup_packing_list(doc, parent_items) - - if frappe.db.get_single_value("Selling Settings", "editable_bundle_item_rates"): - update_product_bundle_price(doc, parent_items) - -def cleanup_packing_list(doc, parent_items): - """Remove all those child items which are no longer present in main item table""" - delete_list = [] - for d in doc.get("packed_items"): - if [d.parent_item, d.parent_detail_docname] not in parent_items: - # mark for deletion from doclist - delete_list.append(d) - - if not delete_list: - return doc - - packed_items = doc.get("packed_items") - doc.set("packed_items", []) - - for d in packed_items: - if d not in delete_list: - add_item_to_packing_list(doc, d) - -def add_item_to_packing_list(doc, packed_item): - doc.append("packed_items", { - 'parent_item': packed_item.parent_item, - 'item_code': packed_item.item_code, - 'item_name': packed_item.item_name, - 'uom': packed_item.uom, - 'qty': packed_item.qty, - 'rate': packed_item.rate, - 'conversion_factor': packed_item.conversion_factor, - 'description': packed_item.description, - 'warehouse': packed_item.warehouse, - 'batch_no': packed_item.batch_no, - 'actual_batch_qty': packed_item.actual_batch_qty, - 'serial_no': packed_item.serial_no, - 'target_warehouse': packed_item.target_warehouse, - 'actual_qty': packed_item.actual_qty, - 'projected_qty': packed_item.projected_qty, - 'incoming_rate': packed_item.incoming_rate, - 'prevdoc_doctype': packed_item.prevdoc_doctype, - 'parent_detail_docname': packed_item.parent_detail_docname - }) - -def update_product_bundle_price(doc, parent_items): - """Updates the prices of Product Bundles based on the rates of the Items in the bundle.""" - - if not doc.get('items'): + "Make/Update packing list for Product Bundle Item." + if doc.get("_action") and doc._action == "update_after_submit": return - parent_items_index = 0 - bundle_price = 0 + parent_items_price, reset = {}, False + set_price_from_children = frappe.db.get_single_value( + "Selling Settings", "editable_bundle_item_rates" + ) - for bundle_item in doc.get("packed_items"): - if parent_items[parent_items_index][0] == bundle_item.parent_item: - bundle_item_rate = bundle_item.rate if bundle_item.rate else 0 - bundle_price += bundle_item.qty * bundle_item_rate - else: - update_parent_item_price(doc, parent_items[parent_items_index][0], bundle_price) + stale_packed_items_table = get_indexed_packed_items_table(doc) - bundle_item_rate = bundle_item.rate if bundle_item.rate else 0 - bundle_price = bundle_item.qty * bundle_item_rate - parent_items_index += 1 + reset = reset_packing_list(doc) - # for the last product bundle - if doc.get("packed_items"): - update_parent_item_price(doc, parent_items[parent_items_index][0], bundle_price) + for item_row in doc.get("items"): + if is_product_bundle(item_row.item_code): + for bundle_item in get_product_bundle_items(item_row.item_code): + pi_row = add_packed_item_row( + doc=doc, + packing_item=bundle_item, + main_item_row=item_row, + packed_items_table=stale_packed_items_table, + reset=reset, + ) + item_data = get_packed_item_details(bundle_item.item_code, doc.company) + update_packed_item_basic_data(item_row, pi_row, bundle_item, item_data) + update_packed_item_stock_data(item_row, pi_row, bundle_item, item_data, doc) + update_packed_item_price_data(pi_row, item_data, doc) + update_packed_item_from_cancelled_doc(item_row, bundle_item, pi_row, doc) -def update_parent_item_price(doc, parent_item_code, bundle_price): - parent_item_doc = doc.get('items', {'item_code': parent_item_code})[0] + if set_price_from_children: # create/update bundle item wise price dict + update_product_bundle_rate(parent_items_price, pi_row) - current_parent_item_price = parent_item_doc.amount - if current_parent_item_price != bundle_price: - parent_item_doc.amount = bundle_price - update_parent_item_rate(parent_item_doc, bundle_price) + if parent_items_price: + set_product_bundle_rate_amount(doc, parent_items_price) # set price in bundle item -def update_parent_item_rate(parent_item_doc, bundle_price): - parent_item_doc.rate = bundle_price/parent_item_doc.qty -@frappe.whitelist() -def get_items_from_product_bundle(args): - args = json.loads(args) - items = [] - bundled_items = get_product_bundle_items(args["item_code"]) - for item in bundled_items: - args.update({ - "item_code": item.item_code, - "qty": flt(args["quantity"]) * flt(item.qty) - }) - items.append(get_item_details(args)) +def is_product_bundle(item_code: str) -> bool: + return bool(frappe.db.exists("Product Bundle", {"new_item_code": item_code})) + + +def get_indexed_packed_items_table(doc): + """ + Create dict from stale packed items table like: + {(Parent Item 1, Bundle Item 1, ae4b5678): {...}, (key): {value}} + + Use: to quickly retrieve/check if row existed in table instead of looping n times + """ + indexed_table = {} + for packed_item in doc.get("packed_items"): + key = (packed_item.parent_item, packed_item.item_code, packed_item.parent_detail_docname) + indexed_table[key] = packed_item + + return indexed_table + + +def reset_packing_list(doc): + "Conditionally reset the table and return if it was reset or not." + reset_table = False + doc_before_save = doc.get_doc_before_save() + + if doc_before_save: + # reset table if: + # 1. items were deleted + # 2. if bundle item replaced by another item (same no. of items but different items) + # we maintain list to track recurring item rows as well + items_before_save = [item.item_code for item in doc_before_save.get("items")] + items_after_save = [item.item_code for item in doc.get("items")] + reset_table = items_before_save != items_after_save + else: + # reset: if via Update Items OR + # if new mapped doc with packed items set (SO -> DN) + # (cannot determine action) + reset_table = True + + if reset_table: + doc.set("packed_items", []) + return reset_table + + +def get_product_bundle_items(item_code): + product_bundle = frappe.qb.DocType("Product Bundle") + product_bundle_item = frappe.qb.DocType("Product Bundle Item") + + query = ( + frappe.qb.from_(product_bundle_item) + .join(product_bundle) + .on(product_bundle_item.parent == product_bundle.name) + .select( + product_bundle_item.item_code, + product_bundle_item.qty, + product_bundle_item.uom, + product_bundle_item.description, + ) + .where(product_bundle.new_item_code == item_code) + .orderby(product_bundle_item.idx) + ) + return query.run(as_dict=True) + + +def add_packed_item_row(doc, packing_item, main_item_row, packed_items_table, reset): + """Add and return packed item row. + doc: Transaction document + packing_item (dict): Packed Item details + main_item_row (dict): Items table row corresponding to packed item + packed_items_table (dict): Packed Items table before save (indexed) + reset (bool): State if table is reset or preserved as is + """ + exists, pi_row = False, {} + + # check if row already exists in packed items table + key = (main_item_row.item_code, packing_item.item_code, main_item_row.name) + if packed_items_table.get(key): + pi_row, exists = packed_items_table.get(key), True + + if not exists: + pi_row = doc.append("packed_items", {}) + elif reset: # add row if row exists but table is reset + pi_row.idx, pi_row.name = None, None + pi_row = doc.append("packed_items", pi_row) + + return pi_row + + +def get_packed_item_details(item_code, company): + item = frappe.qb.DocType("Item") + item_default = frappe.qb.DocType("Item Default") + query = ( + frappe.qb.from_(item) + .left_join(item_default) + .on((item_default.parent == item.name) & (item_default.company == company)) + .select( + item.item_name, + item.is_stock_item, + item.description, + item.stock_uom, + item.valuation_rate, + item_default.default_warehouse, + ) + .where(item.name == item_code) + ) + return query.run(as_dict=True)[0] + + +def update_packed_item_basic_data(main_item_row, pi_row, packing_item, item_data): + pi_row.parent_item = main_item_row.item_code + pi_row.parent_detail_docname = main_item_row.name + pi_row.item_code = packing_item.item_code + pi_row.item_name = item_data.item_name + pi_row.uom = item_data.stock_uom + pi_row.qty = flt(packing_item.qty) * flt(main_item_row.stock_qty) + pi_row.conversion_factor = main_item_row.conversion_factor + + if not pi_row.description: + pi_row.description = packing_item.get("description") + + +def update_packed_item_stock_data(main_item_row, pi_row, packing_item, item_data, doc): + # TODO batch_no, actual_batch_qty, incoming_rate + if not pi_row.warehouse and not doc.amended_from: + fetch_warehouse = doc.get("is_pos") or item_data.is_stock_item or not item_data.default_warehouse + pi_row.warehouse = ( + main_item_row.warehouse + if (fetch_warehouse and main_item_row.warehouse) + else item_data.default_warehouse + ) + + if not pi_row.target_warehouse: + pi_row.target_warehouse = main_item_row.get("target_warehouse") + + bin = get_packed_item_bin_qty(packing_item.item_code, pi_row.warehouse) + pi_row.actual_qty = flt(bin.get("actual_qty")) + pi_row.projected_qty = flt(bin.get("projected_qty")) + + +def update_packed_item_price_data(pi_row, item_data, doc): + "Set price as per price list or from the Item master." + if pi_row.rate: + return + + item_doc = frappe.get_cached_doc("Item", pi_row.item_code) + row_data = pi_row.as_dict().copy() + row_data.update( + { + "company": doc.get("company"), + "price_list": doc.get("selling_price_list"), + "currency": doc.get("currency"), + "conversion_rate": doc.get("conversion_rate"), + } + ) + rate = get_price_list_rate(row_data, item_doc).get("price_list_rate") + + pi_row.rate = rate or item_data.get("valuation_rate") or 0.0 + + +def update_packed_item_from_cancelled_doc(main_item_row, packing_item, pi_row, doc): + "Update packed item row details from cancelled doc into amended doc." + prev_doc_packed_items_map = None + if doc.amended_from: + prev_doc_packed_items_map = get_cancelled_doc_packed_item_details(doc.packed_items) + + if prev_doc_packed_items_map and prev_doc_packed_items_map.get( + (packing_item.item_code, main_item_row.item_code) + ): + prev_doc_row = prev_doc_packed_items_map.get((packing_item.item_code, main_item_row.item_code)) + pi_row.batch_no = prev_doc_row[0].batch_no + pi_row.serial_no = prev_doc_row[0].serial_no + pi_row.warehouse = prev_doc_row[0].warehouse + + +def get_packed_item_bin_qty(item, warehouse): + bin_data = frappe.db.get_values( + "Bin", + fieldname=["actual_qty", "projected_qty"], + filters={"item_code": item, "warehouse": warehouse}, + as_dict=True, + ) + + return bin_data[0] if bin_data else {} + + +def get_cancelled_doc_packed_item_details(old_packed_items): + prev_doc_packed_items_map = {} + for items in old_packed_items: + prev_doc_packed_items_map.setdefault((items.item_code, items.parent_item), []).append( + items.as_dict() + ) + return prev_doc_packed_items_map + + +def update_product_bundle_rate(parent_items_price, pi_row): + """ + Update the price dict of Product Bundles based on the rates of the Items in the bundle. + + Stucture: + {(Bundle Item 1, ae56fgji): 150.0, (Bundle Item 2, bc78fkjo): 200.0} + """ + key = (pi_row.parent_item, pi_row.parent_detail_docname) + rate = parent_items_price.get(key) + if not rate: + parent_items_price[key] = 0.0 + + parent_items_price[key] += flt(pi_row.rate) + + +def set_product_bundle_rate_amount(doc, parent_items_price): + "Set cumulative rate and amount in bundle item." + for item in doc.get("items"): + bundle_rate = parent_items_price.get((item.item_code, item.name)) + if bundle_rate and bundle_rate != item.rate: + item.rate = bundle_rate + item.amount = flt(bundle_rate * item.qty) - return items def on_doctype_update(): frappe.db.add_index("Packed Item", ["item_code", "warehouse"]) -def get_old_packed_item_details(old_packed_items): - old_packed_items_map = {} - for items in old_packed_items: - old_packed_items_map.setdefault((items.item_code ,items.parent_item), []).append(items.as_dict()) - return old_packed_items_map + +@frappe.whitelist() +def get_items_from_product_bundle(row): + row, items = json.loads(row), [] + + bundled_items = get_product_bundle_items(row["item_code"]) + for item in bundled_items: + row.update({"item_code": item.item_code, "qty": flt(row["quantity"]) * flt(item.qty)}) + items.append(get_item_details(row)) + + return items diff --git a/erpnext/stock/doctype/packed_item/test_packed_item.py b/erpnext/stock/doctype/packed_item/test_packed_item.py new file mode 100644 index 00000000000..ad7fd9a6976 --- /dev/null +++ b/erpnext/stock/doctype/packed_item/test_packed_item.py @@ -0,0 +1,279 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors +# License: GNU General Public License v3. See license.txt + +from typing import List, Optional, Tuple + +import frappe +from frappe.tests.utils import FrappeTestCase, change_settings +from frappe.utils import add_to_date, nowdate + +from erpnext.selling.doctype.sales_order.sales_order import make_delivery_note +from erpnext.selling.doctype.sales_order.test_sales_order import make_sales_order +from erpnext.stock.doctype.item.test_item import make_item +from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import get_gl_entries +from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry + + +def create_product_bundle( + quantities: Optional[List[int]] = None, warehouse: Optional[str] = None +) -> Tuple[str, List[str]]: + """Get a new product_bundle for use in tests. + + Create 10x required stock if warehouse is specified. + """ + if not quantities: + quantities = [2, 2] + + bundle = make_item(properties={"is_stock_item": 0}).name + + bundle_doc = frappe.get_doc({"doctype": "Product Bundle", "new_item_code": bundle}) + + components = [] + for qty in quantities: + compoenent = make_item().name + components.append(compoenent) + bundle_doc.append("items", {"item_code": compoenent, "qty": qty}) + if warehouse: + make_stock_entry(item=compoenent, to_warehouse=warehouse, qty=10 * qty, rate=100) + + bundle_doc.insert() + + return bundle, components + + +class TestPackedItem(FrappeTestCase): + "Test impact on Packed Items table in various scenarios." + + @classmethod + def setUpClass(cls) -> None: + super().setUpClass() + cls.warehouse = "_Test Warehouse - _TC" + + cls.bundle, cls.bundle_items = create_product_bundle(warehouse=cls.warehouse) + cls.bundle2, cls.bundle2_items = create_product_bundle(warehouse=cls.warehouse) + + cls.normal_item = make_item().name + + def test_adding_bundle_item(self): + "Test impact on packed items if bundle item row is added." + so = make_sales_order(item_code=self.bundle, qty=1, do_not_submit=True) + + self.assertEqual(so.items[0].qty, 1) + self.assertEqual(len(so.packed_items), 2) + self.assertEqual(so.packed_items[0].item_code, self.bundle_items[0]) + self.assertEqual(so.packed_items[0].qty, 2) + + def test_updating_bundle_item(self): + "Test impact on packed items if bundle item row is updated." + so = make_sales_order(item_code=self.bundle, qty=1, do_not_submit=True) + + so.items[0].qty = 2 # change qty + so.save() + + self.assertEqual(so.packed_items[0].qty, 4) + self.assertEqual(so.packed_items[1].qty, 4) + + # change item code to non bundle item + so.items[0].item_code = self.normal_item + so.save() + + self.assertEqual(len(so.packed_items), 0) + + def test_recurring_bundle_item(self): + "Test impact on packed items if same bundle item is added and removed." + so_items = [] + for qty in [2, 4, 6, 8]: + so_items.append( + {"item_code": self.bundle, "qty": qty, "rate": 400, "warehouse": "_Test Warehouse - _TC"} + ) + + # create SO with recurring bundle item + so = make_sales_order(item_list=so_items, do_not_submit=True) + + # check alternate rows for qty + self.assertEqual(len(so.packed_items), 8) + self.assertEqual(so.packed_items[1].item_code, self.bundle_items[1]) + self.assertEqual(so.packed_items[1].qty, 4) + self.assertEqual(so.packed_items[3].qty, 8) + self.assertEqual(so.packed_items[5].qty, 12) + self.assertEqual(so.packed_items[7].qty, 16) + + # delete intermediate row (2nd) + del so.items[1] + so.save() + + # check alternate rows for qty + self.assertEqual(len(so.packed_items), 6) + self.assertEqual(so.packed_items[1].qty, 4) + self.assertEqual(so.packed_items[3].qty, 12) + self.assertEqual(so.packed_items[5].qty, 16) + + # delete last row + del so.items[2] + so.save() + + # check alternate rows for qty + self.assertEqual(len(so.packed_items), 4) + self.assertEqual(so.packed_items[1].qty, 4) + self.assertEqual(so.packed_items[3].qty, 12) + + @change_settings("Selling Settings", {"editable_bundle_item_rates": 1}) + def test_bundle_item_cumulative_price(self): + "Test if Bundle Item rate is cumulative from packed items." + so = make_sales_order(item_code=self.bundle, qty=2, do_not_submit=True) + + so.packed_items[0].rate = 150 + so.packed_items[1].rate = 200 + so.save() + + self.assertEqual(so.items[0].rate, 350) + self.assertEqual(so.items[0].amount, 700) + + def test_newly_mapped_doc_packed_items(self): + "Test impact on packed items in newly mapped DN from SO." + so_items = [] + for qty in [2, 4]: + so_items.append( + {"item_code": self.bundle, "qty": qty, "rate": 400, "warehouse": "_Test Warehouse - _TC"} + ) + + # create SO with recurring bundle item + so = make_sales_order(item_list=so_items) + + dn = make_delivery_note(so.name) + dn.items[1].qty = 3 # change second row qty for inserting doc + dn.save() + + self.assertEqual(len(dn.packed_items), 4) + self.assertEqual(dn.packed_items[2].qty, 6) + self.assertEqual(dn.packed_items[3].qty, 6) + + def test_reposting_packed_items(self): + warehouse = "Stores - TCP1" + company = "_Test Company with perpetual inventory" + + today = nowdate() + yesterday = add_to_date(today, days=-1, as_string=True) + + for item in self.bundle_items: + make_stock_entry(item_code=item, to_warehouse=warehouse, qty=10, rate=100, posting_date=today) + + so = make_sales_order(item_code=self.bundle, qty=1, company=company, warehouse=warehouse) + + dn = make_delivery_note(so.name) + dn.save() + dn.submit() + + gles = get_gl_entries(dn.doctype, dn.name) + credit_before_repost = sum(gle.credit for gle in gles) + + # backdated stock entry + for item in self.bundle_items: + make_stock_entry( + item_code=item, to_warehouse=warehouse, qty=10, rate=200, posting_date=yesterday + ) + + # assert correct reposting + gles = get_gl_entries(dn.doctype, dn.name) + credit_after_reposting = sum(gle.credit for gle in gles) + self.assertNotEqual(credit_before_repost, credit_after_reposting) + self.assertAlmostEqual(credit_after_reposting, 2 * credit_before_repost) + + def assertReturns(self, original, returned): + self.assertEqual(len(original), len(returned)) + + sort_function = lambda p: (p.parent_item, p.item_code, p.qty) + + for sent, returned in zip( + sorted(original, key=sort_function), sorted(returned, key=sort_function) + ): + self.assertEqual(sent.item_code, returned.item_code) + self.assertEqual(sent.parent_item, returned.parent_item) + self.assertEqual(sent.qty, -1 * returned.qty) + + def test_returning_full_bundles(self): + from erpnext.stock.doctype.delivery_note.delivery_note import make_sales_return + + item_list = [ + { + "item_code": self.bundle, + "warehouse": self.warehouse, + "qty": 1, + "rate": 100, + }, + { + "item_code": self.bundle2, + "warehouse": self.warehouse, + "qty": 1, + "rate": 100, + }, + ] + so = make_sales_order(item_list=item_list, warehouse=self.warehouse) + + dn = make_delivery_note(so.name) + dn.save() + dn.submit() + + # create return + dn_ret = make_sales_return(dn.name) + dn_ret.save() + dn_ret.submit() + self.assertReturns(dn.packed_items, dn_ret.packed_items) + + def test_returning_partial_bundles(self): + from erpnext.stock.doctype.delivery_note.delivery_note import make_sales_return + + item_list = [ + { + "item_code": self.bundle, + "warehouse": self.warehouse, + "qty": 1, + "rate": 100, + }, + { + "item_code": self.bundle2, + "warehouse": self.warehouse, + "qty": 1, + "rate": 100, + }, + ] + so = make_sales_order(item_list=item_list, warehouse=self.warehouse) + + dn = make_delivery_note(so.name) + dn.save() + dn.submit() + + # create return + dn_ret = make_sales_return(dn.name) + # remove bundle 2 + dn_ret.items.pop() + + dn_ret.save() + dn_ret.submit() + dn_ret.reload() + + self.assertTrue(all(d.parent_item == self.bundle for d in dn_ret.packed_items)) + + expected_returns = [d for d in dn.packed_items if d.parent_item == self.bundle] + self.assertReturns(expected_returns, dn_ret.packed_items) + + def test_returning_partial_bundle_qty(self): + from erpnext.stock.doctype.delivery_note.delivery_note import make_sales_return + + so = make_sales_order(item_code=self.bundle, warehouse=self.warehouse, qty=2) + + dn = make_delivery_note(so.name) + dn.save() + dn.submit() + + # create return + dn_ret = make_sales_return(dn.name) + # halve the qty + dn_ret.items[0].qty = -1 + dn_ret.save() + dn_ret.submit() + + expected_returns = dn.packed_items + for d in expected_returns: + d.qty /= 2 + self.assertReturns(expected_returns, dn_ret.packed_items) diff --git a/erpnext/stock/doctype/packing_slip/packing_slip.py b/erpnext/stock/doctype/packing_slip/packing_slip.py index b092862415a..e9ccf5fc779 100644 --- a/erpnext/stock/doctype/packing_slip/packing_slip.py +++ b/erpnext/stock/doctype/packing_slip/packing_slip.py @@ -10,14 +10,13 @@ from frappe.utils import cint, flt class PackingSlip(Document): - def validate(self): """ - * Validate existence of submitted Delivery Note - * Case nos do not overlap - * Check if packed qty doesn't exceed actual qty of delivery note + * Validate existence of submitted Delivery Note + * Case nos do not overlap + * Check if packed qty doesn't exceed actual qty of delivery note - It is necessary to validate case nos before checking quantity + It is necessary to validate case nos before checking quantity """ self.validate_delivery_note() self.validate_items_mandatory() @@ -25,12 +24,13 @@ class PackingSlip(Document): self.validate_qty() from erpnext.utilities.transaction_base import validate_uom_is_integer + validate_uom_is_integer(self, "stock_uom", "qty") validate_uom_is_integer(self, "weight_uom", "net_weight") def validate_delivery_note(self): """ - Validates if delivery note has status as draft + Validates if delivery note has status as draft """ if cint(frappe.db.get_value("Delivery Note", self.delivery_note, "docstatus")) != 0: frappe.throw(_("Delivery Note {0} must not be submitted").format(self.delivery_note)) @@ -42,27 +42,33 @@ class PackingSlip(Document): def validate_case_nos(self): """ - Validate if case nos overlap. If they do, recommend next case no. + Validate if case nos overlap. If they do, recommend next case no. """ if not cint(self.from_case_no): frappe.msgprint(_("Please specify a valid 'From Case No.'"), raise_exception=1) elif not self.to_case_no: self.to_case_no = self.from_case_no elif cint(self.from_case_no) > cint(self.to_case_no): - frappe.msgprint(_("'To Case No.' cannot be less than 'From Case No.'"), - raise_exception=1) + frappe.msgprint(_("'To Case No.' cannot be less than 'From Case No.'"), raise_exception=1) - res = frappe.db.sql("""SELECT name FROM `tabPacking Slip` + res = frappe.db.sql( + """SELECT name FROM `tabPacking Slip` WHERE delivery_note = %(delivery_note)s AND docstatus = 1 AND ((from_case_no BETWEEN %(from_case_no)s AND %(to_case_no)s) OR (to_case_no BETWEEN %(from_case_no)s AND %(to_case_no)s) OR (%(from_case_no)s BETWEEN from_case_no AND to_case_no)) - """, {"delivery_note":self.delivery_note, - "from_case_no":self.from_case_no, - "to_case_no":self.to_case_no}) + """, + { + "delivery_note": self.delivery_note, + "from_case_no": self.from_case_no, + "to_case_no": self.to_case_no, + }, + ) if res: - frappe.throw(_("""Case No(s) already in use. Try from Case No {0}""").format(self.get_recommended_case_no())) + frappe.throw( + _("""Case No(s) already in use. Try from Case No {0}""").format(self.get_recommended_case_no()) + ) def validate_qty(self): """Check packed qty across packing slips and delivery note""" @@ -70,36 +76,37 @@ class PackingSlip(Document): dn_details, ps_item_qty, no_of_cases = self.get_details_for_packing() for item in dn_details: - new_packed_qty = (flt(ps_item_qty[item['item_code']]) * no_of_cases) + \ - flt(item['packed_qty']) - if new_packed_qty > flt(item['qty']) and no_of_cases: + new_packed_qty = (flt(ps_item_qty[item["item_code"]]) * no_of_cases) + flt(item["packed_qty"]) + if new_packed_qty > flt(item["qty"]) and no_of_cases: self.recommend_new_qty(item, ps_item_qty, no_of_cases) - def get_details_for_packing(self): """ - Returns - * 'Delivery Note Items' query result as a list of dict - * Item Quantity dict of current packing slip doc - * No. of Cases of this packing slip + Returns + * 'Delivery Note Items' query result as a list of dict + * Item Quantity dict of current packing slip doc + * No. of Cases of this packing slip """ rows = [d.item_code for d in self.get("items")] # also pick custom fields from delivery note - custom_fields = ', '.join('dni.`{0}`'.format(d.fieldname) + custom_fields = ", ".join( + "dni.`{0}`".format(d.fieldname) for d in frappe.get_meta("Delivery Note Item").get_custom_fields() - if d.fieldtype not in no_value_fields) + if d.fieldtype not in no_value_fields + ) if custom_fields: - custom_fields = ', ' + custom_fields + custom_fields = ", " + custom_fields condition = "" if rows: - condition = " and item_code in (%s)" % (", ".join(["%s"]*len(rows))) + condition = " and item_code in (%s)" % (", ".join(["%s"] * len(rows))) # gets item code, qty per item code, latest packed qty per item code and stock uom - res = frappe.db.sql("""select item_code, sum(qty) as qty, + res = frappe.db.sql( + """select item_code, sum(qty) as qty, (select sum(psi.qty * (abs(ps.to_case_no - ps.from_case_no) + 1)) from `tabPacking Slip` ps, `tabPacking Slip Item` psi where ps.name = psi.parent and ps.docstatus = 1 @@ -107,47 +114,57 @@ class PackingSlip(Document): stock_uom, item_name, description, dni.batch_no {custom_fields} from `tabDelivery Note Item` dni where parent=%s {condition} - group by item_code""".format(condition=condition, custom_fields=custom_fields), - tuple([self.delivery_note] + rows), as_dict=1) + group by item_code""".format( + condition=condition, custom_fields=custom_fields + ), + tuple([self.delivery_note] + rows), + as_dict=1, + ) ps_item_qty = dict([[d.item_code, d.qty] for d in self.get("items")]) no_of_cases = cint(self.to_case_no) - cint(self.from_case_no) + 1 return res, ps_item_qty, no_of_cases - def recommend_new_qty(self, item, ps_item_qty, no_of_cases): """ - Recommend a new quantity and raise a validation exception + Recommend a new quantity and raise a validation exception """ - item['recommended_qty'] = (flt(item['qty']) - flt(item['packed_qty'])) / no_of_cases - item['specified_qty'] = flt(ps_item_qty[item['item_code']]) - if not item['packed_qty']: item['packed_qty'] = 0 + item["recommended_qty"] = (flt(item["qty"]) - flt(item["packed_qty"])) / no_of_cases + item["specified_qty"] = flt(ps_item_qty[item["item_code"]]) + if not item["packed_qty"]: + item["packed_qty"] = 0 - frappe.throw(_("Quantity for Item {0} must be less than {1}").format(item.get("item_code"), item.get("recommended_qty"))) + frappe.throw( + _("Quantity for Item {0} must be less than {1}").format( + item.get("item_code"), item.get("recommended_qty") + ) + ) def update_item_details(self): """ - Fill empty columns in Packing Slip Item + Fill empty columns in Packing Slip Item """ if not self.from_case_no: self.from_case_no = self.get_recommended_case_no() for d in self.get("items"): - res = frappe.db.get_value("Item", d.item_code, - ["weight_per_unit", "weight_uom"], as_dict=True) + res = frappe.db.get_value("Item", d.item_code, ["weight_per_unit", "weight_uom"], as_dict=True) - if res and len(res)>0: + if res and len(res) > 0: d.net_weight = res["weight_per_unit"] d.weight_uom = res["weight_uom"] def get_recommended_case_no(self): """ - Returns the next case no. for a new packing slip for a delivery - note + Returns the next case no. for a new packing slip for a delivery + note """ - recommended_case_no = frappe.db.sql("""SELECT MAX(to_case_no) FROM `tabPacking Slip` - WHERE delivery_note = %s AND docstatus=1""", self.delivery_note) + recommended_case_no = frappe.db.sql( + """SELECT MAX(to_case_no) FROM `tabPacking Slip` + WHERE delivery_note = %s AND docstatus=1""", + self.delivery_note, + ) return cint(recommended_case_no[0][0]) + 1 @@ -160,7 +177,7 @@ class PackingSlip(Document): dn_details = self.get_details_for_packing()[0] for item in dn_details: if flt(item.qty) > flt(item.packed_qty): - ch = self.append('items', {}) + ch = self.append("items", {}) ch.item_code = item.item_code ch.item_name = item.item_name ch.stock_uom = item.stock_uom @@ -175,14 +192,18 @@ class PackingSlip(Document): self.update_item_details() + @frappe.whitelist() @frappe.validate_and_sanitize_search_inputs def item_details(doctype, txt, searchfield, start, page_len, filters): from erpnext.controllers.queries import get_match_cond - return frappe.db.sql("""select name, item_name, description from `tabItem` + + return frappe.db.sql( + """select name, item_name, description from `tabItem` where name in ( select item_code FROM `tabDelivery Note Item` where parent= %s) and %s like "%s" %s - limit %s, %s """ % ("%s", searchfield, "%s", - get_match_cond(doctype), "%s", "%s"), - ((filters or {}).get("delivery_note"), "%%%s%%" % txt, start, page_len)) + limit %s, %s """ + % ("%s", searchfield, "%s", get_match_cond(doctype), "%s", "%s"), + ((filters or {}).get("delivery_note"), "%%%s%%" % txt, start, page_len), + ) diff --git a/erpnext/stock/doctype/packing_slip/test_packing_slip.py b/erpnext/stock/doctype/packing_slip/test_packing_slip.py index 5eb6b7399ae..bc405b20995 100644 --- a/erpnext/stock/doctype/packing_slip/test_packing_slip.py +++ b/erpnext/stock/doctype/packing_slip/test_packing_slip.py @@ -4,7 +4,7 @@ import unittest # test_records = frappe.get_test_records('Packing Slip') -from erpnext.tests.utils import ERPNextTestCase +from frappe.tests.utils import FrappeTestCase class TestPackingSlip(unittest.TestCase): diff --git a/erpnext/stock/doctype/packing_slip_item/packing_slip_item.json b/erpnext/stock/doctype/packing_slip_item/packing_slip_item.json index 29c4193f9e9..4270839bfdb 100644 --- a/erpnext/stock/doctype/packing_slip_item/packing_slip_item.json +++ b/erpnext/stock/doctype/packing_slip_item/packing_slip_item.json @@ -1,451 +1,140 @@ { - "allow_copy": 0, - "allow_import": 0, - "allow_rename": 0, - "autoname": "hash", - "beta": 0, - "creation": "2013-04-08 13:10:16", - "custom": 0, - "docstatus": 0, - "doctype": "DocType", - "document_type": "Document", - "editable_grid": 1, - "engine": "InnoDB", + "actions": [], + "autoname": "hash", + "creation": "2013-04-08 13:10:16", + "doctype": "DocType", + "document_type": "Document", + "editable_grid": 1, + "engine": "InnoDB", + "field_order": [ + "item_code", + "column_break_2", + "item_name", + "batch_no", + "desc_section", + "description", + "quantity_section", + "qty", + "net_weight", + "column_break_10", + "stock_uom", + "weight_uom", + "page_break", + "dn_detail" + ], "fields": [ { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "item_code", - "fieldtype": "Link", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 1, - "in_list_view": 1, - "in_standard_filter": 0, - "label": "Item Code", - "length": 0, - "no_copy": 0, - "options": "Item", - "permlevel": 0, - "print_hide": 0, - "print_hide_if_no_value": 0, - "print_width": "100px", - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 1, - "search_index": 0, - "set_only_once": 0, - "unique": 0, + "fieldname": "item_code", + "fieldtype": "Link", + "in_global_search": 1, + "in_list_view": 1, + "label": "Item Code", + "options": "Item", + "print_width": "100px", + "reqd": 1, "width": "100px" - }, + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "column_break_2", - "fieldtype": "Column Break", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 0, - "in_standard_filter": 0, - "length": 0, - "no_copy": 0, - "permlevel": 0, - "precision": "", - "print_hide": 0, - "print_hide_if_no_value": 0, - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0 - }, + "fieldname": "column_break_2", + "fieldtype": "Column Break" + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "item_name", - "fieldtype": "Data", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 1, - "in_standard_filter": 0, - "label": "Item Name", - "length": 0, - "no_copy": 0, - "options": "item_code.item_name", - "permlevel": 0, - "print_hide": 0, - "print_hide_if_no_value": 0, - "print_width": "200px", - "read_only": 1, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0, + "fetch_from": "item_code.item_name", + "fieldname": "item_name", + "fieldtype": "Data", + "in_list_view": 1, + "label": "Item Name", + "print_width": "200px", + "read_only": 1, "width": "200px" - }, + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "batch_no", - "fieldtype": "Link", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 0, - "in_standard_filter": 0, - "label": "Batch No", - "length": 0, - "no_copy": 0, - "options": "Batch", - "permlevel": 0, - "precision": "", - "print_hide": 0, - "print_hide_if_no_value": 0, - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0 - }, + "fieldname": "batch_no", + "fieldtype": "Link", + "label": "Batch No", + "options": "Batch" + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 1, - "columns": 0, - "fieldname": "desc_section", - "fieldtype": "Section Break", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 0, - "in_standard_filter": 0, - "label": "Description", - "length": 0, - "no_copy": 0, - "permlevel": 0, - "precision": "", - "print_hide": 0, - "print_hide_if_no_value": 0, - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0 - }, + "collapsible": 1, + "fieldname": "desc_section", + "fieldtype": "Section Break", + "label": "Description" + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "description", - "fieldtype": "Text Editor", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 0, - "in_standard_filter": 0, - "label": "Description", - "length": 0, - "no_copy": 0, - "permlevel": 0, - "precision": "", - "print_hide": 0, - "print_hide_if_no_value": 0, - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0 - }, + "fieldname": "description", + "fieldtype": "Text Editor", + "label": "Description" + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "quantity_section", - "fieldtype": "Section Break", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 0, - "in_standard_filter": 0, - "label": "Quantity", - "length": 0, - "no_copy": 0, - "permlevel": 0, - "precision": "", - "print_hide": 0, - "print_hide_if_no_value": 0, - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0 - }, + "fieldname": "quantity_section", + "fieldtype": "Section Break", + "label": "Quantity" + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "qty", - "fieldtype": "Float", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 1, - "in_standard_filter": 0, - "label": "Quantity", - "length": 0, - "no_copy": 0, - "permlevel": 0, - "print_hide": 0, - "print_hide_if_no_value": 0, - "print_width": "100px", - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 1, - "search_index": 0, - "set_only_once": 0, - "unique": 0, + "fieldname": "qty", + "fieldtype": "Float", + "in_list_view": 1, + "label": "Quantity", + "print_width": "100px", + "reqd": 1, "width": "100px" - }, + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "net_weight", - "fieldtype": "Float", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 1, - "in_standard_filter": 0, - "label": "Net Weight", - "length": 0, - "no_copy": 0, - "permlevel": 0, - "print_hide": 0, - "print_hide_if_no_value": 0, - "print_width": "100px", - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0, + "fieldname": "net_weight", + "fieldtype": "Float", + "in_list_view": 1, + "label": "Net Weight", + "print_width": "100px", "width": "100px" - }, + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "column_break_10", - "fieldtype": "Column Break", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 0, - "in_standard_filter": 0, - "length": 0, - "no_copy": 0, - "permlevel": 0, - "precision": "", - "print_hide": 0, - "print_hide_if_no_value": 0, - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0 - }, + "fieldname": "column_break_10", + "fieldtype": "Column Break" + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "stock_uom", - "fieldtype": "Link", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 0, - "in_standard_filter": 0, - "label": "UOM", - "length": 0, - "no_copy": 0, - "options": "UOM", - "permlevel": 0, - "print_hide": 0, - "print_hide_if_no_value": 0, - "print_width": "100px", - "read_only": 1, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0, + "fieldname": "stock_uom", + "fieldtype": "Link", + "label": "UOM", + "options": "UOM", + "print_width": "100px", + "read_only": 1, "width": "100px" - }, + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "weight_uom", - "fieldtype": "Link", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 0, - "in_standard_filter": 0, - "label": "Weight UOM", - "length": 0, - "no_copy": 0, - "options": "UOM", - "permlevel": 0, - "print_hide": 0, - "print_hide_if_no_value": 0, - "print_width": "100px", - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0, + "fieldname": "weight_uom", + "fieldtype": "Link", + "label": "Weight UOM", + "options": "UOM", + "print_width": "100px", "width": "100px" - }, + }, { - "allow_on_submit": 1, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "page_break", - "fieldtype": "Check", - "hidden": 0, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 1, - "in_standard_filter": 0, - "label": "Page Break", - "length": 0, - "no_copy": 0, - "permlevel": 0, - "print_hide": 0, - "print_hide_if_no_value": 0, - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0 - }, + "allow_on_submit": 1, + "default": "0", + "fieldname": "page_break", + "fieldtype": "Check", + "in_list_view": 1, + "label": "Page Break" + }, { - "allow_on_submit": 0, - "bold": 0, - "collapsible": 0, - "columns": 0, - "fieldname": "dn_detail", - "fieldtype": "Data", - "hidden": 1, - "ignore_user_permissions": 0, - "ignore_xss_filter": 0, - "in_filter": 0, - "in_global_search": 0, - "in_list_view": 1, - "in_standard_filter": 0, - "label": "DN Detail", - "length": 0, - "no_copy": 0, - "permlevel": 0, - "print_hide": 0, - "print_hide_if_no_value": 0, - "read_only": 0, - "remember_last_selected_value": 0, - "report_hide": 0, - "reqd": 0, - "search_index": 0, - "set_only_once": 0, - "unique": 0 + "fieldname": "dn_detail", + "fieldtype": "Data", + "hidden": 1, + "in_list_view": 1, + "label": "DN Detail" } - ], - "hide_heading": 0, - "hide_toolbar": 0, - "idx": 1, - "image_view": 0, - "in_create": 0, - - "is_submittable": 0, - "issingle": 0, - "istable": 1, - "max_attachments": 0, - "modified": "2018-06-01 07:21:58.220980", - "modified_by": "Administrator", - "module": "Stock", - "name": "Packing Slip Item", - "owner": "Administrator", - "permissions": [], - "quick_entry": 0, - "read_only": 0, - "read_only_onload": 0, - "show_name_in_global_search": 0, - "track_changes": 1, - "track_seen": 0 + ], + "idx": 1, + "istable": 1, + "links": [], + "modified": "2021-12-14 01:22:00.715935", + "modified_by": "Administrator", + "module": "Stock", + "name": "Packing Slip Item", + "naming_rule": "Random", + "owner": "Administrator", + "permissions": [], + "sort_field": "modified", + "sort_order": "DESC", + "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/stock/doctype/pick_list/pick_list.js b/erpnext/stock/doctype/pick_list/pick_list.js index 730fd7a829c..13b74b5eb16 100644 --- a/erpnext/stock/doctype/pick_list/pick_list.js +++ b/erpnext/stock/doctype/pick_list/pick_list.js @@ -146,10 +146,6 @@ frappe.ui.form.on('Pick List', { customer: frm.doc.customer }; frm.get_items_btn = frm.add_custom_button(__('Get Items'), () => { - if (!frm.doc.customer) { - frappe.msgprint(__('Please select Customer first')); - return; - } erpnext.utils.map_current_doc({ method: 'erpnext.selling.doctype.sales_order.sales_order.create_pick_list', source_doctype: 'Sales Order', diff --git a/erpnext/stock/doctype/pick_list/pick_list.json b/erpnext/stock/doctype/pick_list/pick_list.json index c604c711ef5..dfa307de490 100644 --- a/erpnext/stock/doctype/pick_list/pick_list.json +++ b/erpnext/stock/doctype/pick_list/pick_list.json @@ -10,6 +10,7 @@ "company", "purpose", "customer", + "customer_name", "work_order", "material_request", "for_qty", @@ -114,6 +115,7 @@ "set_only_once": 1 }, { + "collapsible": 1, "fieldname": "print_settings_section", "fieldtype": "Section Break", "label": "Print Settings" @@ -125,11 +127,19 @@ "fieldtype": "Check", "label": "Group Same Items", "print_hide": 1 + }, + { + "depends_on": "eval:doc.purpose==='Delivery' && doc.customer", + "fetch_from": "customer.customer_name", + "fieldname": "customer_name", + "fieldtype": "Data", + "label": "Customer Name", + "read_only": 1 } ], "is_submittable": 1, "links": [], - "modified": "2021-10-05 15:08:40.369957", + "modified": "2022-07-19 11:03:04.442174", "modified_by": "Administrator", "module": "Stock", "name": "Pick List", @@ -199,5 +209,6 @@ ], "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 -} \ No newline at end of file +} diff --git a/erpnext/stock/doctype/pick_list/pick_list.py b/erpnext/stock/doctype/pick_list/pick_list.py index b7987543f2b..20affa92a7b 100644 --- a/erpnext/stock/doctype/pick_list/pick_list.py +++ b/erpnext/stock/doctype/pick_list/pick_list.py @@ -3,13 +3,15 @@ import json from collections import OrderedDict, defaultdict +from itertools import groupby +from typing import Dict, List, Set import frappe from frappe import _ from frappe.model.document import Document from frappe.model.mapper import map_child_doc from frappe.utils import cint, floor, flt, today -from six import iteritems +from frappe.utils.nestedset import get_descendants_of from erpnext.selling.doctype.sales_order.sales_order import ( make_delivery_note as create_delivery_note_from_sales_order, @@ -18,6 +20,7 @@ from erpnext.stock.get_item_details import get_conversion_factor # TODO: Prioritize SO or WO group warehouse + class PickList(Document): def validate(self): self.validate_for_qty() @@ -25,18 +28,86 @@ class PickList(Document): def before_save(self): self.set_item_locations() + # set percentage picked in SO + for location in self.get("locations"): + if ( + location.sales_order + and frappe.db.get_value("Sales Order", location.sales_order, "per_picked") == 100 + ): + frappe.throw("Row " + str(location.idx) + " has been picked already!") + def before_submit(self): + update_sales_orders = set() for item in self.locations: - if not frappe.get_cached_value('Item', item.item_code, 'has_serial_no'): + # if the user has not entered any picked qty, set it to stock_qty, before submit + if item.picked_qty == 0: + item.picked_qty = item.stock_qty + + if item.sales_order_item: + # update the picked_qty in SO Item + self.update_sales_order_item(item, item.picked_qty, item.item_code) + update_sales_orders.add(item.sales_order) + + if not frappe.get_cached_value("Item", item.item_code, "has_serial_no"): continue if not item.serial_no: - frappe.throw(_("Row #{0}: {1} does not have any available serial numbers in {2}").format( - frappe.bold(item.idx), frappe.bold(item.item_code), frappe.bold(item.warehouse)), - title=_("Serial Nos Required")) - if len(item.serial_no.split('\n')) == item.picked_qty: + frappe.throw( + _("Row #{0}: {1} does not have any available serial numbers in {2}").format( + frappe.bold(item.idx), frappe.bold(item.item_code), frappe.bold(item.warehouse) + ), + title=_("Serial Nos Required"), + ) + if len(item.serial_no.split("\n")) == item.picked_qty: continue - frappe.throw(_('For item {0} at row {1}, count of serial numbers does not match with the picked quantity') - .format(frappe.bold(item.item_code), frappe.bold(item.idx)), title=_("Quantity Mismatch")) + frappe.throw( + _( + "For item {0} at row {1}, count of serial numbers does not match with the picked quantity" + ).format(frappe.bold(item.item_code), frappe.bold(item.idx)), + title=_("Quantity Mismatch"), + ) + + self.update_bundle_picked_qty() + self.update_sales_order_picking_status(update_sales_orders) + + def before_cancel(self): + """Deduct picked qty on cancelling pick list""" + updated_sales_orders = set() + + for item in self.get("locations"): + if item.sales_order_item: + self.update_sales_order_item(item, -1 * item.picked_qty, item.item_code) + updated_sales_orders.add(item.sales_order) + + self.update_bundle_picked_qty() + self.update_sales_order_picking_status(updated_sales_orders) + + def update_sales_order_item(self, item, picked_qty, item_code): + item_table = "Sales Order Item" if not item.product_bundle_item else "Packed Item" + stock_qty_field = "stock_qty" if not item.product_bundle_item else "qty" + + already_picked, actual_qty = frappe.db.get_value( + item_table, + item.sales_order_item, + ["picked_qty", stock_qty_field], + ) + + if self.docstatus == 1: + if (((already_picked + picked_qty) / actual_qty) * 100) > ( + 100 + flt(frappe.db.get_single_value("Stock Settings", "over_delivery_receipt_allowance")) + ): + frappe.throw( + _( + "You are picking more than required quantity for {}. Check if there is any other pick list created for {}" + ).format(item_code, item.sales_order) + ) + + frappe.db.set_value(item_table, item.sales_order_item, "picked_qty", already_picked + picked_qty) + + @staticmethod + def update_sales_order_picking_status(sales_orders: Set[str]) -> None: + for sales_order in sales_orders: + if sales_order: + frappe.get_doc("Sales Order", sales_order).update_picking_status() @frappe.whitelist() def set_item_locations(self, save=False): @@ -46,48 +117,55 @@ class PickList(Document): from_warehouses = None if self.parent_warehouse: - from_warehouses = frappe.db.get_descendants('Warehouse', self.parent_warehouse) + from_warehouses = get_descendants_of("Warehouse", self.parent_warehouse) # Create replica before resetting, to handle empty table on update after submit. - locations_replica = self.get('locations') + locations_replica = self.get("locations") # reset - self.delete_key('locations') + self.delete_key("locations") for item_doc in items: item_code = item_doc.item_code - self.item_location_map.setdefault(item_code, - get_available_item_locations(item_code, from_warehouses, self.item_count_map.get(item_code), self.company)) + self.item_location_map.setdefault( + item_code, + get_available_item_locations( + item_code, from_warehouses, self.item_count_map.get(item_code), self.company + ), + ) - locations = get_items_with_location_and_quantity(item_doc, self.item_location_map, self.docstatus) + locations = get_items_with_location_and_quantity( + item_doc, self.item_location_map, self.docstatus + ) item_doc.idx = None item_doc.name = None for row in locations: - row.update({ - 'picked_qty': row.stock_qty - }) - location = item_doc.as_dict() location.update(row) - self.append('locations', location) + self.append("locations", location) # If table is empty on update after submit, set stock_qty, picked_qty to 0 so that indicator is red # and give feedback to the user. This is to avoid empty Pick Lists. - if not self.get('locations') and self.docstatus == 1: + if not self.get("locations") and self.docstatus == 1: for location in locations_replica: location.stock_qty = 0 location.picked_qty = 0 - self.append('locations', location) - frappe.msgprint(_("Please Restock Items and Update the Pick List to continue. To discontinue, cancel the Pick List."), - title=_("Out of Stock"), indicator="red") + self.append("locations", location) + frappe.msgprint( + _( + "Please Restock Items and Update the Pick List to continue. To discontinue, cancel the Pick List." + ), + title=_("Out of Stock"), + indicator="red", + ) if save: self.save() def aggregate_item_qty(self): - locations = self.get('locations') + locations = self.get("locations") self.item_count_map = {} # aggregate qty for same item item_map = OrderedDict() @@ -96,7 +174,7 @@ class PickList(Document): frappe.throw("Row #{0}: Item Code is Mandatory".format(item.idx)) item_code = item.item_code reference = item.sales_order_item or item.material_request_item - key = (item_code, item.uom, reference) + key = (item_code, item.uom, item.warehouse, reference) item.idx = None item.name = None @@ -114,20 +192,20 @@ class PickList(Document): return item_map.values() def validate_for_qty(self): - if self.purpose == "Material Transfer for Manufacture" \ - and (self.for_qty is None or self.for_qty == 0): + if self.purpose == "Material Transfer for Manufacture" and ( + self.for_qty is None or self.for_qty == 0 + ): frappe.throw(_("Qty of Finished Goods Item should be greater than 0.")) def before_print(self, settings=None): - if self.get("group_same_items"): - self.group_similar_items() + self.group_similar_items() def group_similar_items(self): group_item_qty = defaultdict(float) group_picked_qty = defaultdict(float) for item in self.locations: - group_item_qty[(item.item_code, item.warehouse)] += item.qty + group_item_qty[(item.item_code, item.warehouse)] += item.qty group_picked_qty[(item.item_code, item.warehouse)] += item.picked_qty duplicate_list = [] @@ -146,42 +224,104 @@ class PickList(Document): for idx, item in enumerate(self.locations, start=1): item.idx = idx + def update_bundle_picked_qty(self): + product_bundles = self._get_product_bundles() + product_bundle_qty_map = self._get_product_bundle_qty_map(product_bundles.values()) + + for so_row, item_code in product_bundles.items(): + picked_qty = self._compute_picked_qty_for_bundle(so_row, product_bundle_qty_map[item_code]) + item_table = "Sales Order Item" + already_picked = frappe.db.get_value(item_table, so_row, "picked_qty") + frappe.db.set_value( + item_table, + so_row, + "picked_qty", + already_picked + (picked_qty * (1 if self.docstatus == 1 else -1)), + ) + + def _get_product_bundles(self) -> Dict[str, str]: + # Dict[so_item_row: item_code] + product_bundles = {} + for item in self.locations: + if not item.product_bundle_item: + continue + product_bundles[item.product_bundle_item] = frappe.db.get_value( + "Sales Order Item", + item.product_bundle_item, + "item_code", + ) + return product_bundles + + def _get_product_bundle_qty_map(self, bundles: List[str]) -> Dict[str, Dict[str, float]]: + # bundle_item_code: Dict[component, qty] + product_bundle_qty_map = {} + for bundle_item_code in bundles: + bundle = frappe.get_last_doc("Product Bundle", {"new_item_code": bundle_item_code}) + product_bundle_qty_map[bundle_item_code] = {item.item_code: item.qty for item in bundle.items} + return product_bundle_qty_map + + def _compute_picked_qty_for_bundle(self, bundle_row, bundle_items) -> int: + """Compute how many full bundles can be created from picked items.""" + precision = frappe.get_precision("Stock Ledger Entry", "qty_after_transaction") + + possible_bundles = [] + for item in self.locations: + if item.product_bundle_item != bundle_row: + continue + + qty_in_bundle = bundle_items.get(item.item_code) + if qty_in_bundle: + possible_bundles.append(item.picked_qty / qty_in_bundle) + else: + possible_bundles.append(0) + return int(flt(min(possible_bundles), precision or 6)) + def validate_item_locations(pick_list): if not pick_list.locations: frappe.throw(_("Add items in the Item Locations table")) + def get_items_with_location_and_quantity(item_doc, item_location_map, docstatus): available_locations = item_location_map.get(item_doc.item_code) locations = [] # if stock qty is zero on submitted entry, show positive remaining qty to recalculate in case of restock. - remaining_stock_qty = item_doc.qty if (docstatus == 1 and item_doc.stock_qty == 0) else item_doc.stock_qty + remaining_stock_qty = ( + item_doc.qty if (docstatus == 1 and item_doc.stock_qty == 0) else item_doc.stock_qty + ) while remaining_stock_qty > 0 and available_locations: item_location = available_locations.pop(0) item_location = frappe._dict(item_location) - stock_qty = remaining_stock_qty if item_location.qty >= remaining_stock_qty else item_location.qty + stock_qty = ( + remaining_stock_qty if item_location.qty >= remaining_stock_qty else item_location.qty + ) qty = stock_qty / (item_doc.conversion_factor or 1) - uom_must_be_whole_number = frappe.db.get_value('UOM', item_doc.uom, 'must_be_whole_number') + uom_must_be_whole_number = frappe.db.get_value("UOM", item_doc.uom, "must_be_whole_number") if uom_must_be_whole_number: qty = floor(qty) stock_qty = qty * item_doc.conversion_factor - if not stock_qty: break + if not stock_qty: + break serial_nos = None if item_location.serial_no: - serial_nos = '\n'.join(item_location.serial_no[0: cint(stock_qty)]) + serial_nos = "\n".join(item_location.serial_no[0 : cint(stock_qty)]) - locations.append(frappe._dict({ - 'qty': qty, - 'stock_qty': stock_qty, - 'warehouse': item_location.warehouse, - 'serial_no': serial_nos, - 'batch_no': item_location.batch_no - })) + locations.append( + frappe._dict( + { + "qty": qty, + "stock_qty": stock_qty, + "warehouse": item_location.warehouse, + "serial_no": serial_nos, + "batch_no": item_location.batch_no, + } + ) + ) remaining_stock_qty -= stock_qty @@ -191,73 +331,87 @@ def get_items_with_location_and_quantity(item_doc, item_location_map, docstatus) item_location.qty = qty_diff if item_location.serial_no: # set remaining serial numbers - item_location.serial_no = item_location.serial_no[-int(qty_diff):] + item_location.serial_no = item_location.serial_no[-int(qty_diff) :] available_locations = [item_location] + available_locations # update available locations for the item item_location_map[item_doc.item_code] = available_locations return locations -def get_available_item_locations(item_code, from_warehouses, required_qty, company, ignore_validation=False): + +def get_available_item_locations( + item_code, from_warehouses, required_qty, company, ignore_validation=False +): locations = [] - has_serial_no = frappe.get_cached_value('Item', item_code, 'has_serial_no') - has_batch_no = frappe.get_cached_value('Item', item_code, 'has_batch_no') + has_serial_no = frappe.get_cached_value("Item", item_code, "has_serial_no") + has_batch_no = frappe.get_cached_value("Item", item_code, "has_batch_no") if has_batch_no and has_serial_no: - locations = get_available_item_locations_for_serial_and_batched_item(item_code, from_warehouses, required_qty, company) + locations = get_available_item_locations_for_serial_and_batched_item( + item_code, from_warehouses, required_qty, company + ) elif has_serial_no: - locations = get_available_item_locations_for_serialized_item(item_code, from_warehouses, required_qty, company) + locations = get_available_item_locations_for_serialized_item( + item_code, from_warehouses, required_qty, company + ) elif has_batch_no: - locations = get_available_item_locations_for_batched_item(item_code, from_warehouses, required_qty, company) + locations = get_available_item_locations_for_batched_item( + item_code, from_warehouses, required_qty, company + ) else: - locations = get_available_item_locations_for_other_item(item_code, from_warehouses, required_qty, company) + locations = get_available_item_locations_for_other_item( + item_code, from_warehouses, required_qty, company + ) - total_qty_available = sum(location.get('qty') for location in locations) + total_qty_available = sum(location.get("qty") for location in locations) remaining_qty = required_qty - total_qty_available if remaining_qty > 0 and not ignore_validation: - frappe.msgprint(_('{0} units of Item {1} is not available.') - .format(remaining_qty, frappe.get_desk_link('Item', item_code)), - title=_("Insufficient Stock")) + frappe.msgprint( + _("{0} units of Item {1} is not available.").format( + remaining_qty, frappe.get_desk_link("Item", item_code) + ), + title=_("Insufficient Stock"), + ) return locations -def get_available_item_locations_for_serialized_item(item_code, from_warehouses, required_qty, company): - filters = frappe._dict({ - 'item_code': item_code, - 'company': company, - 'warehouse': ['!=', ''] - }) +def get_available_item_locations_for_serialized_item( + item_code, from_warehouses, required_qty, company +): + filters = frappe._dict({"item_code": item_code, "company": company, "warehouse": ["!=", ""]}) if from_warehouses: - filters.warehouse = ['in', from_warehouses] + filters.warehouse = ["in", from_warehouses] - serial_nos = frappe.get_all('Serial No', - fields=['name', 'warehouse'], + serial_nos = frappe.get_all( + "Serial No", + fields=["name", "warehouse"], filters=filters, limit=required_qty, - order_by='purchase_date', - as_list=1) + order_by="purchase_date", + as_list=1, + ) warehouse_serial_nos_map = frappe._dict() for serial_no, warehouse in serial_nos: warehouse_serial_nos_map.setdefault(warehouse, []).append(serial_no) locations = [] - for warehouse, serial_nos in iteritems(warehouse_serial_nos_map): - locations.append({ - 'qty': len(serial_nos), - 'warehouse': warehouse, - 'serial_no': serial_nos - }) + for warehouse, serial_nos in warehouse_serial_nos_map.items(): + locations.append({"qty": len(serial_nos), "warehouse": warehouse, "serial_no": serial_nos}) return locations -def get_available_item_locations_for_batched_item(item_code, from_warehouses, required_qty, company): - warehouse_condition = 'and warehouse in %(warehouses)s' if from_warehouses else '' - batch_locations = frappe.db.sql(""" + +def get_available_item_locations_for_batched_item( + item_code, from_warehouses, required_qty, company +): + warehouse_condition = "and warehouse in %(warehouses)s" if from_warehouses else "" + batch_locations = frappe.db.sql( + """ SELECT sle.`warehouse`, sle.`batch_no`, @@ -273,118 +427,171 @@ def get_available_item_locations_for_batched_item(item_code, from_warehouses, re and IFNULL(batch.`expiry_date`, '2200-01-01') > %(today)s {warehouse_condition} GROUP BY - `warehouse`, - `batch_no`, - `item_code` + sle.`warehouse`, + sle.`batch_no`, + sle.`item_code` HAVING `qty` > 0 ORDER BY IFNULL(batch.`expiry_date`, '2200-01-01'), batch.`creation` - """.format(warehouse_condition=warehouse_condition), { #nosec - 'item_code': item_code, - 'company': company, - 'today': today(), - 'warehouses': from_warehouses - }, as_dict=1) + """.format( + warehouse_condition=warehouse_condition + ), + { # nosec + "item_code": item_code, + "company": company, + "today": today(), + "warehouses": from_warehouses, + }, + as_dict=1, + ) return batch_locations -def get_available_item_locations_for_serial_and_batched_item(item_code, from_warehouses, required_qty, company): - # Get batch nos by FIFO - locations = get_available_item_locations_for_batched_item(item_code, from_warehouses, required_qty, company) - filters = frappe._dict({ - 'item_code': item_code, - 'company': company, - 'warehouse': ['!=', ''], - 'batch_no': '' - }) +def get_available_item_locations_for_serial_and_batched_item( + item_code, from_warehouses, required_qty, company +): + # Get batch nos by FIFO + locations = get_available_item_locations_for_batched_item( + item_code, from_warehouses, required_qty, company + ) + + filters = frappe._dict( + {"item_code": item_code, "company": company, "warehouse": ["!=", ""], "batch_no": ""} + ) # Get Serial Nos by FIFO for Batch No for location in locations: filters.batch_no = location.batch_no filters.warehouse = location.warehouse - location.qty = required_qty if location.qty > required_qty else location.qty # if extra qty in batch + location.qty = ( + required_qty if location.qty > required_qty else location.qty + ) # if extra qty in batch - serial_nos = frappe.get_list('Serial No', - fields=['name'], - filters=filters, - limit=location.qty, - order_by='purchase_date') + serial_nos = frappe.get_list( + "Serial No", fields=["name"], filters=filters, limit=location.qty, order_by="purchase_date" + ) serial_nos = [sn.name for sn in serial_nos] location.serial_no = serial_nos return locations + def get_available_item_locations_for_other_item(item_code, from_warehouses, required_qty, company): # gets all items available in different warehouses - warehouses = [x.get('name') for x in frappe.get_list("Warehouse", {'company': company}, "name")] + warehouses = [x.get("name") for x in frappe.get_list("Warehouse", {"company": company}, "name")] - filters = frappe._dict({ - 'item_code': item_code, - 'warehouse': ['in', warehouses], - 'actual_qty': ['>', 0] - }) + filters = frappe._dict( + {"item_code": item_code, "warehouse": ["in", warehouses], "actual_qty": [">", 0]} + ) if from_warehouses: - filters.warehouse = ['in', from_warehouses] + filters.warehouse = ["in", from_warehouses] - item_locations = frappe.get_all('Bin', - fields=['warehouse', 'actual_qty as qty'], + item_locations = frappe.get_all( + "Bin", + fields=["warehouse", "actual_qty as qty"], filters=filters, limit=required_qty, - order_by='creation') + order_by="creation", + ) return item_locations @frappe.whitelist() def create_delivery_note(source_name, target_doc=None): - pick_list = frappe.get_doc('Pick List', source_name) + pick_list = frappe.get_doc("Pick List", source_name) validate_item_locations(pick_list) - - sales_orders = [d.sales_order for d in pick_list.locations if d.sales_order] - sales_orders = set(sales_orders) - + sales_dict = dict() + sales_orders = [] delivery_note = None - for sales_order in sales_orders: - delivery_note = create_delivery_note_from_sales_order(sales_order, - delivery_note, skip_item_mapping=True) + for location in pick_list.locations: + if location.sales_order: + sales_orders.append( + frappe.db.get_value( + "Sales Order", location.sales_order, ["customer", "name as sales_order"], as_dict=True + ) + ) - # map rows without sales orders as well - if not delivery_note: - delivery_note = frappe.new_doc("Delivery Note") + for customer, rows in groupby(sales_orders, key=lambda so: so["customer"]): + sales_dict[customer] = {row.sales_order for row in rows} - item_table_mapper = { - 'doctype': 'Delivery Note Item', - 'field_map': { - 'rate': 'rate', - 'name': 'so_detail', - 'parent': 'against_sales_order', - }, - 'condition': lambda doc: abs(doc.delivered_qty) < abs(doc.qty) and doc.delivered_by_supplier!=1 - } + if sales_dict: + delivery_note = create_dn_with_so(sales_dict, pick_list) + + if not all(item.sales_order for item in pick_list.locations): + delivery_note = create_dn_wo_so(pick_list) + + frappe.msgprint(_("Delivery Note(s) created for the Pick List")) + return delivery_note + + +def create_dn_wo_so(pick_list): + delivery_note = frappe.new_doc("Delivery Note") item_table_mapper_without_so = { - 'doctype': 'Delivery Note Item', - 'field_map': { - 'rate': 'rate', - 'name': 'name', - 'parent': '', - } + "doctype": "Delivery Note Item", + "field_map": { + "rate": "rate", + "name": "name", + "parent": "", + }, + } + map_pl_locations(pick_list, item_table_mapper_without_so, delivery_note) + delivery_note.insert(ignore_mandatory=True) + + return delivery_note + + +def create_dn_with_so(sales_dict, pick_list): + delivery_note = None + + item_table_mapper = { + "doctype": "Delivery Note Item", + "field_map": { + "rate": "rate", + "name": "so_detail", + "parent": "against_sales_order", + }, + "condition": lambda doc: abs(doc.delivered_qty) < abs(doc.qty) + and doc.delivered_by_supplier != 1, } + for customer in sales_dict: + for so in sales_dict[customer]: + delivery_note = None + delivery_note = create_delivery_note_from_sales_order(so, delivery_note, skip_item_mapping=True) + break + if delivery_note: + # map all items of all sales orders of that customer + for so in sales_dict[customer]: + map_pl_locations(pick_list, item_table_mapper, delivery_note, so) + delivery_note.flags.ignore_mandatory = True + delivery_note.insert() + update_packed_item_details(pick_list, delivery_note) + delivery_note.save() + + return delivery_note + + +def map_pl_locations(pick_list, item_mapper, delivery_note, sales_order=None): + for location in pick_list.locations: + if location.sales_order != sales_order or location.product_bundle_item: + continue + if location.sales_order_item: - sales_order_item = frappe.get_cached_doc('Sales Order Item', {'name':location.sales_order_item}) + sales_order_item = frappe.get_doc("Sales Order Item", location.sales_order_item) else: sales_order_item = None - source_doc, table_mapper = [sales_order_item, item_table_mapper] if sales_order_item \ - else [location, item_table_mapper_without_so] + source_doc = sales_order_item or location - dn_item = map_child_doc(source_doc, delivery_note, table_mapper) + dn_item = map_child_doc(source_doc, delivery_note, item_mapper) if dn_item: + dn_item.pick_list_item = location.name dn_item.warehouse = location.warehouse dn_item.qty = flt(location.picked_qty) / (flt(location.conversion_factor) or 1) dn_item.batch_no = location.batch_no @@ -392,41 +599,87 @@ def create_delivery_note(source_name, target_doc=None): update_delivery_note_item(source_doc, dn_item, delivery_note) + add_product_bundles_to_delivery_note(pick_list, delivery_note, item_mapper) set_delivery_note_missing_values(delivery_note) delivery_note.pick_list = pick_list.name - delivery_note.customer = pick_list.customer if pick_list.customer else None + delivery_note.company = pick_list.company + delivery_note.customer = frappe.get_value("Sales Order", sales_order, "customer") + + +def add_product_bundles_to_delivery_note( + pick_list: "PickList", delivery_note, item_mapper +) -> None: + """Add product bundles found in pick list to delivery note. + + When mapping pick list items, the bundle item itself isn't part of the + locations. Dynamically fetch and add parent bundle item into DN.""" + product_bundles = pick_list._get_product_bundles() + product_bundle_qty_map = pick_list._get_product_bundle_qty_map(product_bundles.values()) + + for so_row, item_code in product_bundles.items(): + sales_order_item = frappe.get_doc("Sales Order Item", so_row) + dn_bundle_item = map_child_doc(sales_order_item, delivery_note, item_mapper) + dn_bundle_item.qty = pick_list._compute_picked_qty_for_bundle( + so_row, product_bundle_qty_map[item_code] + ) + update_delivery_note_item(sales_order_item, dn_bundle_item, delivery_note) + + +def update_packed_item_details(pick_list: "PickList", delivery_note) -> None: + """Update stock details on packed items table of delivery note.""" + + def _find_so_row(packed_item): + for item in delivery_note.items: + if packed_item.parent_detail_docname == item.name: + return item.so_detail + + def _find_pick_list_location(bundle_row, packed_item): + if not bundle_row: + return + for loc in pick_list.locations: + if loc.product_bundle_item == bundle_row and loc.item_code == packed_item.item_code: + return loc + + for packed_item in delivery_note.packed_items: + so_row = _find_so_row(packed_item) + location = _find_pick_list_location(so_row, packed_item) + if not location: + continue + packed_item.warehouse = location.warehouse + packed_item.batch_no = location.batch_no + packed_item.serial_no = location.serial_no - return delivery_note @frappe.whitelist() def create_stock_entry(pick_list): pick_list = frappe.get_doc(json.loads(pick_list)) validate_item_locations(pick_list) - if stock_entry_exists(pick_list.get('name')): - return frappe.msgprint(_('Stock Entry has been already created against this Pick List')) + if stock_entry_exists(pick_list.get("name")): + return frappe.msgprint(_("Stock Entry has been already created against this Pick List")) - stock_entry = frappe.new_doc('Stock Entry') - stock_entry.pick_list = pick_list.get('name') - stock_entry.purpose = pick_list.get('purpose') + stock_entry = frappe.new_doc("Stock Entry") + stock_entry.pick_list = pick_list.get("name") + stock_entry.purpose = pick_list.get("purpose") stock_entry.set_stock_entry_type() - if pick_list.get('work_order'): + if pick_list.get("work_order"): stock_entry = update_stock_entry_based_on_work_order(pick_list, stock_entry) - elif pick_list.get('material_request'): + elif pick_list.get("material_request"): stock_entry = update_stock_entry_based_on_material_request(pick_list, stock_entry) else: stock_entry = update_stock_entry_items_with_no_reference(pick_list, stock_entry) - stock_entry.set_actual_qty() - stock_entry.calculate_rate_and_amount() + stock_entry.set_missing_values() return stock_entry.as_dict() + @frappe.whitelist() def get_pending_work_orders(doctype, txt, searchfield, start, page_length, filters, as_dict): - return frappe.db.sql(""" + return frappe.db.sql( + """ SELECT `name`, `company`, `planned_start_date` FROM @@ -442,25 +695,27 @@ def get_pending_work_orders(doctype, txt, searchfield, start, page_length, filte LIMIT %(start)s, %(page_length)s""", { - 'txt': "%%%s%%" % txt, - '_txt': txt.replace('%', ''), - 'start': start, - 'page_length': frappe.utils.cint(page_length), - 'company': filters.get('company') - }, as_dict=as_dict) + "txt": "%%%s%%" % txt, + "_txt": txt.replace("%", ""), + "start": start, + "page_length": frappe.utils.cint(page_length), + "company": filters.get("company"), + }, + as_dict=as_dict, + ) + @frappe.whitelist() def target_document_exists(pick_list_name, purpose): - if purpose == 'Delivery': - return frappe.db.exists('Delivery Note', { - 'pick_list': pick_list_name - }) + if purpose == "Delivery": + return frappe.db.exists("Delivery Note", {"pick_list": pick_list_name}) return stock_entry_exists(pick_list_name) + @frappe.whitelist() def get_item_details(item_code, uom=None): - details = frappe.db.get_value('Item', item_code, ['stock_uom', 'name'], as_dict=1) + details = frappe.db.get_value("Item", item_code, ["stock_uom", "name"], as_dict=1) details.uom = uom or details.stock_uom if uom: details.update(get_conversion_factor(item_code, uom)) @@ -469,37 +724,37 @@ def get_item_details(item_code, uom=None): def update_delivery_note_item(source, target, delivery_note): - cost_center = frappe.db.get_value('Project', delivery_note.project, 'cost_center') + cost_center = frappe.db.get_value("Project", delivery_note.project, "cost_center") if not cost_center: - cost_center = get_cost_center(source.item_code, 'Item', delivery_note.company) + cost_center = get_cost_center(source.item_code, "Item", delivery_note.company) if not cost_center: - cost_center = get_cost_center(source.item_group, 'Item Group', delivery_note.company) + cost_center = get_cost_center(source.item_group, "Item Group", delivery_note.company) target.cost_center = cost_center + def get_cost_center(for_item, from_doctype, company): - '''Returns Cost Center for Item or Item Group''' - return frappe.db.get_value('Item Default', - fieldname=['buying_cost_center'], - filters={ - 'parent': for_item, - 'parenttype': from_doctype, - 'company': company - }) + """Returns Cost Center for Item or Item Group""" + return frappe.db.get_value( + "Item Default", + fieldname=["buying_cost_center"], + filters={"parent": for_item, "parenttype": from_doctype, "company": company}, + ) + def set_delivery_note_missing_values(target): - target.run_method('set_missing_values') - target.run_method('set_po_nos') - target.run_method('calculate_taxes_and_totals') + target.run_method("set_missing_values") + target.run_method("set_po_nos") + target.run_method("calculate_taxes_and_totals") + def stock_entry_exists(pick_list_name): - return frappe.db.exists('Stock Entry', { - 'pick_list': pick_list_name - }) + return frappe.db.exists("Stock Entry", {"pick_list": pick_list_name}) + def update_stock_entry_based_on_work_order(pick_list, stock_entry): - work_order = frappe.get_doc("Work Order", pick_list.get('work_order')) + work_order = frappe.get_doc("Work Order", pick_list.get("work_order")) stock_entry.work_order = work_order.name stock_entry.company = work_order.company @@ -508,10 +763,11 @@ def update_stock_entry_based_on_work_order(pick_list, stock_entry): stock_entry.use_multi_level_bom = work_order.use_multi_level_bom stock_entry.fg_completed_qty = pick_list.for_qty if work_order.bom_no: - stock_entry.inspection_required = frappe.db.get_value('BOM', - work_order.bom_no, 'inspection_required') + stock_entry.inspection_required = frappe.db.get_value( + "BOM", work_order.bom_no, "inspection_required" + ) - is_wip_warehouse_group = frappe.db.get_value('Warehouse', work_order.wip_warehouse, 'is_group') + is_wip_warehouse_group = frappe.db.get_value("Warehouse", work_order.wip_warehouse, "is_group") if not (is_wip_warehouse_group and work_order.skip_transfer): wip_warehouse = work_order.wip_warehouse else: @@ -525,32 +781,36 @@ def update_stock_entry_based_on_work_order(pick_list, stock_entry): update_common_item_properties(item, location) item.t_warehouse = wip_warehouse - stock_entry.append('items', item) + stock_entry.append("items", item) return stock_entry + def update_stock_entry_based_on_material_request(pick_list, stock_entry): for location in pick_list.locations: target_warehouse = None if location.material_request_item: - target_warehouse = frappe.get_value('Material Request Item', - location.material_request_item, 'warehouse') + target_warehouse = frappe.get_value( + "Material Request Item", location.material_request_item, "warehouse" + ) item = frappe._dict() update_common_item_properties(item, location) item.t_warehouse = target_warehouse - stock_entry.append('items', item) + stock_entry.append("items", item) return stock_entry + def update_stock_entry_items_with_no_reference(pick_list, stock_entry): for location in pick_list.locations: item = frappe._dict() update_common_item_properties(item, location) - stock_entry.append('items', item) + stock_entry.append("items", item) return stock_entry + def update_common_item_properties(item, location): item.item_code = location.item_code item.s_warehouse = location.warehouse diff --git a/erpnext/stock/doctype/pick_list/pick_list_dashboard.py b/erpnext/stock/doctype/pick_list/pick_list_dashboard.py index d19bedeeafe..92e57bed220 100644 --- a/erpnext/stock/doctype/pick_list/pick_list_dashboard.py +++ b/erpnext/stock/doctype/pick_list/pick_list_dashboard.py @@ -1,11 +1,7 @@ - - def get_data(): return { - 'fieldname': 'pick_list', - 'transactions': [ - { - 'items': ['Stock Entry', 'Delivery Note'] - }, - ] + "fieldname": "pick_list", + "transactions": [ + {"items": ["Stock Entry", "Delivery Note"]}, + ], } diff --git a/erpnext/stock/doctype/pick_list/test_pick_list.py b/erpnext/stock/doctype/pick_list/test_pick_list.py index 41e3150f0d7..e8cebc8e622 100644 --- a/erpnext/stock/doctype/pick_list/test_pick_list.py +++ b/erpnext/stock/doctype/pick_list/test_pick_list.py @@ -3,162 +3,193 @@ import frappe from frappe import _dict +from frappe.tests.utils import FrappeTestCase -test_dependencies = ['Item', 'Sales Invoice', 'Stock Entry', 'Batch'] - -from erpnext.stock.doctype.item.test_item import create_item +from erpnext.selling.doctype.sales_order.sales_order import create_pick_list +from erpnext.selling.doctype.sales_order.test_sales_order import make_sales_order +from erpnext.stock.doctype.item.test_item import create_item, make_item +from erpnext.stock.doctype.packed_item.test_packed_item import create_product_bundle from erpnext.stock.doctype.pick_list.pick_list import create_delivery_note from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import make_purchase_receipt +from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry from erpnext.stock.doctype.stock_reconciliation.stock_reconciliation import ( EmptyStockReconciliationItemsError, ) -from erpnext.tests.utils import ERPNextTestCase + +test_dependencies = ["Item", "Sales Invoice", "Stock Entry", "Batch"] -class TestPickList(ERPNextTestCase): - +class TestPickList(FrappeTestCase): def test_pick_list_picks_warehouse_for_each_item(self): try: - frappe.get_doc({ - 'doctype': 'Stock Reconciliation', - 'company': '_Test Company', - 'purpose': 'Opening Stock', - 'expense_account': 'Temporary Opening - _TC', - 'items': [{ - 'item_code': '_Test Item', - 'warehouse': '_Test Warehouse - _TC', - 'valuation_rate': 100, - 'qty': 5 - }] - }).submit() + frappe.get_doc( + { + "doctype": "Stock Reconciliation", + "company": "_Test Company", + "purpose": "Opening Stock", + "expense_account": "Temporary Opening - _TC", + "items": [ + { + "item_code": "_Test Item", + "warehouse": "_Test Warehouse - _TC", + "valuation_rate": 100, + "qty": 5, + } + ], + } + ).submit() except EmptyStockReconciliationItemsError: pass - pick_list = frappe.get_doc({ - 'doctype': 'Pick List', - 'company': '_Test Company', - 'customer': '_Test Customer', - 'items_based_on': 'Sales Order', - 'purpose': 'Delivery', - 'locations': [{ - 'item_code': '_Test Item', - 'qty': 5, - 'stock_qty': 5, - 'conversion_factor': 1, - 'sales_order': '_T-Sales Order-1', - 'sales_order_item': '_T-Sales Order-1_item', - }] - }) + pick_list = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "customer": "_Test Customer", + "items_based_on": "Sales Order", + "purpose": "Delivery", + "locations": [ + { + "item_code": "_Test Item", + "qty": 5, + "stock_qty": 5, + "conversion_factor": 1, + "sales_order": "_T-Sales Order-1", + "sales_order_item": "_T-Sales Order-1_item", + } + ], + } + ) pick_list.set_item_locations() - self.assertEqual(pick_list.locations[0].item_code, '_Test Item') - self.assertEqual(pick_list.locations[0].warehouse, '_Test Warehouse - _TC') + self.assertEqual(pick_list.locations[0].item_code, "_Test Item") + self.assertEqual(pick_list.locations[0].warehouse, "_Test Warehouse - _TC") self.assertEqual(pick_list.locations[0].qty, 5) def test_pick_list_splits_row_according_to_warehouse_availability(self): try: - frappe.get_doc({ - 'doctype': 'Stock Reconciliation', - 'company': '_Test Company', - 'purpose': 'Opening Stock', - 'expense_account': 'Temporary Opening - _TC', - 'items': [{ - 'item_code': '_Test Item Warehouse Group Wise Reorder', - 'warehouse': '_Test Warehouse Group-C1 - _TC', - 'valuation_rate': 100, - 'qty': 5 - }] - }).submit() + frappe.get_doc( + { + "doctype": "Stock Reconciliation", + "company": "_Test Company", + "purpose": "Opening Stock", + "expense_account": "Temporary Opening - _TC", + "items": [ + { + "item_code": "_Test Item Warehouse Group Wise Reorder", + "warehouse": "_Test Warehouse Group-C1 - _TC", + "valuation_rate": 100, + "qty": 5, + } + ], + } + ).submit() except EmptyStockReconciliationItemsError: pass try: - frappe.get_doc({ - 'doctype': 'Stock Reconciliation', - 'company': '_Test Company', - 'purpose': 'Opening Stock', - 'expense_account': 'Temporary Opening - _TC', - 'items': [{ - 'item_code': '_Test Item Warehouse Group Wise Reorder', - 'warehouse': '_Test Warehouse 2 - _TC', - 'valuation_rate': 400, - 'qty': 10 - }] - }).submit() + frappe.get_doc( + { + "doctype": "Stock Reconciliation", + "company": "_Test Company", + "purpose": "Opening Stock", + "expense_account": "Temporary Opening - _TC", + "items": [ + { + "item_code": "_Test Item Warehouse Group Wise Reorder", + "warehouse": "_Test Warehouse 2 - _TC", + "valuation_rate": 400, + "qty": 10, + } + ], + } + ).submit() except EmptyStockReconciliationItemsError: pass - pick_list = frappe.get_doc({ - 'doctype': 'Pick List', - 'company': '_Test Company', - 'customer': '_Test Customer', - 'items_based_on': 'Sales Order', - 'purpose': 'Delivery', - 'locations': [{ - 'item_code': '_Test Item Warehouse Group Wise Reorder', - 'qty': 1000, - 'stock_qty': 1000, - 'conversion_factor': 1, - 'sales_order': '_T-Sales Order-1', - 'sales_order_item': '_T-Sales Order-1_item', - }] - }) + pick_list = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "customer": "_Test Customer", + "items_based_on": "Sales Order", + "purpose": "Delivery", + "locations": [ + { + "item_code": "_Test Item Warehouse Group Wise Reorder", + "qty": 1000, + "stock_qty": 1000, + "conversion_factor": 1, + "sales_order": "_T-Sales Order-1", + "sales_order_item": "_T-Sales Order-1_item", + } + ], + } + ) pick_list.set_item_locations() - self.assertEqual(pick_list.locations[0].item_code, '_Test Item Warehouse Group Wise Reorder') - self.assertEqual(pick_list.locations[0].warehouse, '_Test Warehouse Group-C1 - _TC') + self.assertEqual(pick_list.locations[0].item_code, "_Test Item Warehouse Group Wise Reorder") + self.assertEqual(pick_list.locations[0].warehouse, "_Test Warehouse Group-C1 - _TC") self.assertEqual(pick_list.locations[0].qty, 5) - self.assertEqual(pick_list.locations[1].item_code, '_Test Item Warehouse Group Wise Reorder') - self.assertEqual(pick_list.locations[1].warehouse, '_Test Warehouse 2 - _TC') + self.assertEqual(pick_list.locations[1].item_code, "_Test Item Warehouse Group Wise Reorder") + self.assertEqual(pick_list.locations[1].warehouse, "_Test Warehouse 2 - _TC") self.assertEqual(pick_list.locations[1].qty, 10) def test_pick_list_shows_serial_no_for_serialized_item(self): - stock_reconciliation = frappe.get_doc({ - 'doctype': 'Stock Reconciliation', - 'purpose': 'Stock Reconciliation', - 'company': '_Test Company', - 'items': [{ - 'item_code': '_Test Serialized Item', - 'warehouse': '_Test Warehouse - _TC', - 'valuation_rate': 100, - 'qty': 5, - 'serial_no': '123450\n123451\n123452\n123453\n123454' - }] - }) + stock_reconciliation = frappe.get_doc( + { + "doctype": "Stock Reconciliation", + "purpose": "Stock Reconciliation", + "company": "_Test Company", + "items": [ + { + "item_code": "_Test Serialized Item", + "warehouse": "_Test Warehouse - _TC", + "valuation_rate": 100, + "qty": 5, + "serial_no": "123450\n123451\n123452\n123453\n123454", + } + ], + } + ) try: stock_reconciliation.submit() except EmptyStockReconciliationItemsError: pass - pick_list = frappe.get_doc({ - 'doctype': 'Pick List', - 'company': '_Test Company', - 'customer': '_Test Customer', - 'items_based_on': 'Sales Order', - 'purpose': 'Delivery', - 'locations': [{ - 'item_code': '_Test Serialized Item', - 'qty': 1000, - 'stock_qty': 1000, - 'conversion_factor': 1, - 'sales_order': '_T-Sales Order-1', - 'sales_order_item': '_T-Sales Order-1_item', - }] - }) + pick_list = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "customer": "_Test Customer", + "items_based_on": "Sales Order", + "purpose": "Delivery", + "locations": [ + { + "item_code": "_Test Serialized Item", + "qty": 1000, + "stock_qty": 1000, + "conversion_factor": 1, + "sales_order": "_T-Sales Order-1", + "sales_order_item": "_T-Sales Order-1_item", + } + ], + } + ) pick_list.set_item_locations() - self.assertEqual(pick_list.locations[0].item_code, '_Test Serialized Item') - self.assertEqual(pick_list.locations[0].warehouse, '_Test Warehouse - _TC') + self.assertEqual(pick_list.locations[0].item_code, "_Test Serialized Item") + self.assertEqual(pick_list.locations[0].warehouse, "_Test Warehouse - _TC") self.assertEqual(pick_list.locations[0].qty, 5) - self.assertEqual(pick_list.locations[0].serial_no, '123450\n123451\n123452\n123453\n123454') + self.assertEqual(pick_list.locations[0].serial_no, "123450\n123451\n123452\n123453\n123454") def test_pick_list_shows_batch_no_for_batched_item(self): # check if oldest batch no is picked - item = frappe.db.exists("Item", {'item_name': 'Batched Item'}) + item = frappe.db.exists("Item", {"item_name": "Batched Item"}) if not item: item = create_item("Batched Item") item.has_batch_no = 1 @@ -166,7 +197,7 @@ class TestPickList(ERPNextTestCase): item.batch_number_series = "B-BATCH-.##" item.save() else: - item = frappe.get_doc("Item", {'item_name': 'Batched Item'}) + item = frappe.get_doc("Item", {"item_name": "Batched Item"}) pr1 = make_purchase_receipt(item_code="Batched Item", qty=1, rate=100.0) @@ -175,28 +206,30 @@ class TestPickList(ERPNextTestCase): pr2 = make_purchase_receipt(item_code="Batched Item", qty=2, rate=100.0) - pick_list = frappe.get_doc({ - 'doctype': 'Pick List', - 'company': '_Test Company', - 'purpose': 'Material Transfer', - 'locations': [{ - 'item_code': 'Batched Item', - 'qty': 1, - 'stock_qty': 1, - 'conversion_factor': 1, - }] - }) + pick_list = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "purpose": "Material Transfer", + "locations": [ + { + "item_code": "Batched Item", + "qty": 1, + "stock_qty": 1, + "conversion_factor": 1, + } + ], + } + ) pick_list.set_item_locations() - self.assertEqual(pick_list.locations[0].batch_no, oldest_batch_no) pr1.cancel() pr2.cancel() - def test_pick_list_for_batched_and_serialised_item(self): # check if oldest batch no and serial nos are picked - item = frappe.db.exists("Item", {'item_name': 'Batched and Serialised Item'}) + item = frappe.db.exists("Item", {"item_name": "Batched and Serialised Item"}) if not item: item = create_item("Batched and Serialised Item") item.has_batch_no = 1 @@ -206,7 +239,7 @@ class TestPickList(ERPNextTestCase): item.serial_no_series = "S-.####" item.save() else: - item = frappe.get_doc("Item", {'item_name': 'Batched and Serialised Item'}) + item = frappe.get_doc("Item", {"item_name": "Batched and Serialised Item"}) pr1 = make_purchase_receipt(item_code="Batched and Serialised Item", qty=2, rate=100.0) @@ -216,17 +249,21 @@ class TestPickList(ERPNextTestCase): pr2 = make_purchase_receipt(item_code="Batched and Serialised Item", qty=2, rate=100.0) - pick_list = frappe.get_doc({ - 'doctype': 'Pick List', - 'company': '_Test Company', - 'purpose': 'Material Transfer', - 'locations': [{ - 'item_code': 'Batched and Serialised Item', - 'qty': 2, - 'stock_qty': 2, - 'conversion_factor': 1, - }] - }) + pick_list = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "purpose": "Material Transfer", + "locations": [ + { + "item_code": "Batched and Serialised Item", + "qty": 2, + "stock_qty": 2, + "conversion_factor": 1, + } + ], + } + ) pick_list.set_item_locations() self.assertEqual(pick_list.locations[0].batch_no, oldest_batch_no) @@ -237,64 +274,71 @@ class TestPickList(ERPNextTestCase): def test_pick_list_for_items_from_multiple_sales_orders(self): try: - frappe.get_doc({ - 'doctype': 'Stock Reconciliation', - 'company': '_Test Company', - 'purpose': 'Opening Stock', - 'expense_account': 'Temporary Opening - _TC', - 'items': [{ - 'item_code': '_Test Item', - 'warehouse': '_Test Warehouse - _TC', - 'valuation_rate': 100, - 'qty': 10 - }] - }).submit() + frappe.get_doc( + { + "doctype": "Stock Reconciliation", + "company": "_Test Company", + "purpose": "Opening Stock", + "expense_account": "Temporary Opening - _TC", + "items": [ + { + "item_code": "_Test Item", + "warehouse": "_Test Warehouse - _TC", + "valuation_rate": 100, + "qty": 10, + } + ], + } + ).submit() except EmptyStockReconciliationItemsError: pass - sales_order = frappe.get_doc({ - 'doctype': "Sales Order", - 'customer': '_Test Customer', - 'company': '_Test Company', - 'items': [{ - 'item_code': '_Test Item', - 'qty': 10, - 'delivery_date': frappe.utils.today() - }], - }) + sales_order = frappe.get_doc( + { + "doctype": "Sales Order", + "customer": "_Test Customer", + "company": "_Test Company", + "items": [{"item_code": "_Test Item", "qty": 10, "delivery_date": frappe.utils.today()}], + } + ) sales_order.submit() - pick_list = frappe.get_doc({ - 'doctype': 'Pick List', - 'company': '_Test Company', - 'customer': '_Test Customer', - 'items_based_on': 'Sales Order', - 'purpose': 'Delivery', - 'locations': [{ - 'item_code': '_Test Item', - 'qty': 5, - 'stock_qty': 5, - 'conversion_factor': 1, - 'sales_order': '_T-Sales Order-1', - 'sales_order_item': '_T-Sales Order-1_item', - }, { - 'item_code': '_Test Item', - 'qty': 5, - 'stock_qty': 5, - 'conversion_factor': 1, - 'sales_order': sales_order.name, - 'sales_order_item': sales_order.items[0].name, - }] - }) + pick_list = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "customer": "_Test Customer", + "items_based_on": "Sales Order", + "purpose": "Delivery", + "locations": [ + { + "item_code": "_Test Item", + "qty": 5, + "stock_qty": 5, + "conversion_factor": 1, + "sales_order": "_T-Sales Order-1", + "sales_order_item": "_T-Sales Order-1_item", + }, + { + "item_code": "_Test Item", + "qty": 5, + "stock_qty": 5, + "conversion_factor": 1, + "sales_order": sales_order.name, + "sales_order_item": sales_order.items[0].name, + }, + ], + } + ) pick_list.set_item_locations() - self.assertEqual(pick_list.locations[0].item_code, '_Test Item') - self.assertEqual(pick_list.locations[0].warehouse, '_Test Warehouse - _TC') + self.assertEqual(pick_list.locations[0].item_code, "_Test Item") + self.assertEqual(pick_list.locations[0].warehouse, "_Test Warehouse - _TC") self.assertEqual(pick_list.locations[0].qty, 5) - self.assertEqual(pick_list.locations[0].sales_order_item, '_T-Sales Order-1_item') + self.assertEqual(pick_list.locations[0].sales_order_item, "_T-Sales Order-1_item") - self.assertEqual(pick_list.locations[1].item_code, '_Test Item') - self.assertEqual(pick_list.locations[1].warehouse, '_Test Warehouse - _TC') + self.assertEqual(pick_list.locations[1].item_code, "_Test Item") + self.assertEqual(pick_list.locations[1].warehouse, "_Test Warehouse - _TC") self.assertEqual(pick_list.locations[1].qty, 5) self.assertEqual(pick_list.locations[1].sales_order_item, sales_order.items[0].name) @@ -302,46 +346,57 @@ class TestPickList(ERPNextTestCase): purchase_receipt = make_purchase_receipt(item_code="_Test Item", qty=10) purchase_receipt.submit() - sales_order = frappe.get_doc({ - 'doctype': 'Sales Order', - 'customer': '_Test Customer', - 'company': '_Test Company', - 'items': [{ - 'item_code': '_Test Item', - 'qty': 1, - 'conversion_factor': 5, - 'delivery_date': frappe.utils.today() - }, { - 'item_code': '_Test Item', - 'qty': 1, - 'conversion_factor': 1, - 'delivery_date': frappe.utils.today() - }], - }).insert() + sales_order = frappe.get_doc( + { + "doctype": "Sales Order", + "customer": "_Test Customer", + "company": "_Test Company", + "items": [ + { + "item_code": "_Test Item", + "qty": 1, + "conversion_factor": 5, + "stock_qty": 5, + "delivery_date": frappe.utils.today(), + }, + { + "item_code": "_Test Item", + "qty": 1, + "conversion_factor": 1, + "delivery_date": frappe.utils.today(), + }, + ], + } + ).insert() sales_order.submit() - pick_list = frappe.get_doc({ - 'doctype': 'Pick List', - 'company': '_Test Company', - 'customer': '_Test Customer', - 'items_based_on': 'Sales Order', - 'purpose': 'Delivery', - 'locations': [{ - 'item_code': '_Test Item', - 'qty': 1, - 'stock_qty': 5, - 'conversion_factor': 5, - 'sales_order': sales_order.name, - 'sales_order_item': sales_order.items[0].name , - }, { - 'item_code': '_Test Item', - 'qty': 1, - 'stock_qty': 1, - 'conversion_factor': 1, - 'sales_order': sales_order.name, - 'sales_order_item': sales_order.items[1].name , - }] - }) + pick_list = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "customer": "_Test Customer", + "items_based_on": "Sales Order", + "purpose": "Delivery", + "locations": [ + { + "item_code": "_Test Item", + "qty": 2, + "stock_qty": 1, + "conversion_factor": 0.5, + "sales_order": sales_order.name, + "sales_order_item": sales_order.items[0].name, + }, + { + "item_code": "_Test Item", + "qty": 1, + "stock_qty": 1, + "conversion_factor": 1, + "sales_order": sales_order.name, + "sales_order_item": sales_order.items[1].name, + }, + ], + } + ) pick_list.set_item_locations() pick_list.submit() @@ -349,7 +404,9 @@ class TestPickList(ERPNextTestCase): self.assertEqual(pick_list.locations[0].qty, delivery_note.items[0].qty) self.assertEqual(pick_list.locations[1].qty, delivery_note.items[1].qty) - self.assertEqual(sales_order.items[0].conversion_factor, delivery_note.items[0].conversion_factor) + self.assertEqual( + sales_order.items[0].conversion_factor, delivery_note.items[0].conversion_factor + ) pick_list.cancel() sales_order.cancel() @@ -362,22 +419,30 @@ class TestPickList(ERPNextTestCase): self.assertEqual(b.get(key), value, msg=f"{key} doesn't match") # nothing should be grouped - pl = frappe.get_doc(doctype="Pick List", group_same_items=True, locations=[ - _dict(item_code="A", warehouse="X", qty=1, picked_qty=2), - _dict(item_code="B", warehouse="X", qty=1, picked_qty=2), - _dict(item_code="A", warehouse="Y", qty=1, picked_qty=2), - _dict(item_code="B", warehouse="Y", qty=1, picked_qty=2), - ]) + pl = frappe.get_doc( + doctype="Pick List", + group_same_items=True, + locations=[ + _dict(item_code="A", warehouse="X", qty=1, picked_qty=2), + _dict(item_code="B", warehouse="X", qty=1, picked_qty=2), + _dict(item_code="A", warehouse="Y", qty=1, picked_qty=2), + _dict(item_code="B", warehouse="Y", qty=1, picked_qty=2), + ], + ) pl.before_print() self.assertEqual(len(pl.locations), 4) # grouping should halve the number of items - pl = frappe.get_doc(doctype="Pick List", group_same_items=True, locations=[ - _dict(item_code="A", warehouse="X", qty=5, picked_qty=1), - _dict(item_code="B", warehouse="Y", qty=4, picked_qty=2), - _dict(item_code="A", warehouse="X", qty=3, picked_qty=2), - _dict(item_code="B", warehouse="Y", qty=2, picked_qty=2), - ]) + pl = frappe.get_doc( + doctype="Pick List", + group_same_items=True, + locations=[ + _dict(item_code="A", warehouse="X", qty=5, picked_qty=1), + _dict(item_code="B", warehouse="Y", qty=4, picked_qty=2), + _dict(item_code="A", warehouse="X", qty=3, picked_qty=2), + _dict(item_code="B", warehouse="Y", qty=2, picked_qty=2), + ], + ) pl.before_print() self.assertEqual(len(pl.locations), 2) @@ -388,14 +453,195 @@ class TestPickList(ERPNextTestCase): for expected_item, created_item in zip(expected_items, pl.locations): _compare_dicts(expected_item, created_item) - # def test_pick_list_skips_items_in_expired_batch(self): - # pass + def test_multiple_dn_creation(self): + sales_order_1 = frappe.get_doc( + { + "doctype": "Sales Order", + "customer": "_Test Customer", + "company": "_Test Company", + "items": [ + { + "item_code": "_Test Item", + "qty": 1, + "conversion_factor": 1, + "delivery_date": frappe.utils.today(), + } + ], + } + ).insert() + sales_order_1.submit() + sales_order_2 = frappe.get_doc( + { + "doctype": "Sales Order", + "customer": "_Test Customer 1", + "company": "_Test Company", + "items": [ + { + "item_code": "_Test Item 2", + "qty": 1, + "conversion_factor": 1, + "delivery_date": frappe.utils.today(), + }, + ], + } + ).insert() + sales_order_2.submit() + pick_list = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "items_based_on": "Sales Order", + "purpose": "Delivery", + "picker": "P001", + "locations": [ + { + "item_code": "_Test Item ", + "qty": 1, + "stock_qty": 1, + "conversion_factor": 1, + "sales_order": sales_order_1.name, + "sales_order_item": sales_order_1.items[0].name, + }, + { + "item_code": "_Test Item 2", + "qty": 1, + "stock_qty": 1, + "conversion_factor": 1, + "sales_order": sales_order_2.name, + "sales_order_item": sales_order_2.items[0].name, + }, + ], + } + ) + pick_list.set_item_locations() + pick_list.submit() + create_delivery_note(pick_list.name) + for dn in frappe.get_all( + "Delivery Note", + filters={"pick_list": pick_list.name, "customer": "_Test Customer"}, + fields={"name"}, + ): + for dn_item in frappe.get_doc("Delivery Note", dn.name).get("items"): + self.assertEqual(dn_item.item_code, "_Test Item") + self.assertEqual(dn_item.against_sales_order, sales_order_1.name) + self.assertEqual(dn_item.pick_list_item, pick_list.locations[dn_item.idx - 1].name) - # def test_pick_list_from_sales_order(self): - # pass + for dn in frappe.get_all( + "Delivery Note", + filters={"pick_list": pick_list.name, "customer": "_Test Customer 1"}, + fields={"name"}, + ): + for dn_item in frappe.get_doc("Delivery Note", dn.name).get("items"): + self.assertEqual(dn_item.item_code, "_Test Item 2") + self.assertEqual(dn_item.against_sales_order, sales_order_2.name) + # test DN creation without so + pick_list_1 = frappe.get_doc( + { + "doctype": "Pick List", + "company": "_Test Company", + "purpose": "Delivery", + "picker": "P001", + "locations": [ + { + "item_code": "_Test Item ", + "qty": 1, + "stock_qty": 1, + "conversion_factor": 1, + }, + { + "item_code": "_Test Item 2", + "qty": 2, + "stock_qty": 2, + "conversion_factor": 1, + }, + ], + } + ) + pick_list_1.set_item_locations() + pick_list_1.submit() + create_delivery_note(pick_list_1.name) + for dn in frappe.get_all( + "Delivery Note", filters={"pick_list": pick_list_1.name}, fields={"name"} + ): + for dn_item in frappe.get_doc("Delivery Note", dn.name).get("items"): + if dn_item.item_code == "_Test Item": + self.assertEqual(dn_item.qty, 1) + if dn_item.item_code == "_Test Item 2": + self.assertEqual(dn_item.qty, 2) - # def test_pick_list_from_work_order(self): - # pass + def test_picklist_with_multi_uom(self): + warehouse = "_Test Warehouse - _TC" + item = make_item(properties={"uoms": [dict(uom="Box", conversion_factor=24)]}).name + make_stock_entry(item=item, to_warehouse=warehouse, qty=1000) - # def test_pick_list_from_material_request(self): - # pass + so = make_sales_order(item_code=item, qty=10, rate=42, uom="Box") + pl = create_pick_list(so.name) + # pick half the qty + for loc in pl.locations: + loc.picked_qty = loc.stock_qty / 2 + pl.save() + pl.submit() + + so.reload() + self.assertEqual(so.per_picked, 50) + + def test_picklist_with_bundles(self): + warehouse = "_Test Warehouse - _TC" + + quantities = [5, 2] + bundle, components = create_product_bundle(quantities, warehouse=warehouse) + bundle_items = dict(zip(components, quantities)) + + so = make_sales_order(item_code=bundle, qty=3, rate=42) + + pl = create_pick_list(so.name) + pl.save() + self.assertEqual(len(pl.locations), 2) + for item in pl.locations: + self.assertEqual(item.stock_qty, bundle_items[item.item_code] * 3) + + # check picking status on sales order + pl.submit() + so.reload() + self.assertEqual(so.per_picked, 100) + + # deliver + dn = create_delivery_note(pl.name).submit() + self.assertEqual(dn.items[0].rate, 42) + self.assertEqual(dn.packed_items[0].warehouse, warehouse) + so.reload() + self.assertEqual(so.per_delivered, 100) + + def test_picklist_with_partial_bundles(self): + # from test_records.json + warehouse = "_Test Warehouse - _TC" + + quantities = [5, 2] + bundle, components = create_product_bundle(quantities, warehouse=warehouse) + + so = make_sales_order(item_code=bundle, qty=4, rate=42) + + pl = create_pick_list(so.name) + for loc in pl.locations: + loc.picked_qty = loc.qty / 2 + + pl.save().submit() + so.reload() + self.assertEqual(so.per_picked, 50) + + # deliver half qty + dn = create_delivery_note(pl.name).submit() + self.assertEqual(dn.items[0].rate, 42) + so.reload() + self.assertEqual(so.per_delivered, 50) + + pl = create_pick_list(so.name) + pl.save().submit() + so.reload() + self.assertEqual(so.per_picked, 100) + + # deliver remaining + dn = create_delivery_note(pl.name).submit() + self.assertEqual(dn.items[0].rate, 42) + so.reload() + self.assertEqual(so.per_delivered, 100) diff --git a/erpnext/stock/doctype/pick_list_item/pick_list_item.json b/erpnext/stock/doctype/pick_list_item/pick_list_item.json index 805286ddcc0..a96ebfcdee6 100644 --- a/erpnext/stock/doctype/pick_list_item/pick_list_item.json +++ b/erpnext/stock/doctype/pick_list_item/pick_list_item.json @@ -27,6 +27,7 @@ "column_break_15", "sales_order", "sales_order_item", + "product_bundle_item", "material_request", "material_request_item" ], @@ -146,6 +147,7 @@ { "fieldname": "sales_order_item", "fieldtype": "Data", + "hidden": 1, "label": "Sales Order Item", "read_only": 1 }, @@ -177,11 +179,19 @@ "fieldtype": "Data", "label": "Item Group", "read_only": 1 + }, + { + "description": "product bundle item row's name in sales order. Also indicates that picked item is to be used for a product bundle", + "fieldname": "product_bundle_item", + "fieldtype": "Data", + "hidden": 1, + "label": "Product Bundle Item", + "read_only": 1 } ], "istable": 1, "links": [], - "modified": "2021-09-28 12:02:16.923056", + "modified": "2022-04-22 05:27:38.497997", "modified_by": "Administrator", "module": "Stock", "name": "Pick List Item", @@ -190,5 +200,6 @@ "quick_entry": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "track_changes": 1 } \ No newline at end of file diff --git a/erpnext/stock/doctype/price_list/price_list.py b/erpnext/stock/doctype/price_list/price_list.py index 8a3172e9e22..554055fd839 100644 --- a/erpnext/stock/doctype/price_list/price_list.py +++ b/erpnext/stock/doctype/price_list/price_list.py @@ -31,9 +31,11 @@ class PriceList(Document): frappe.set_value("Buying Settings", "Buying Settings", "buying_price_list", self.name) def update_item_price(self): - frappe.db.sql("""update `tabItem Price` set currency=%s, + frappe.db.sql( + """update `tabItem Price` set currency=%s, buying=%s, selling=%s, modified=NOW() where price_list=%s""", - (self.currency, cint(self.buying), cint(self.selling), self.name)) + (self.currency, cint(self.buying), cint(self.selling), self.name), + ) def check_impact_on_shopping_cart(self): "Check if Price List currency change impacts E Commerce Cart." @@ -66,12 +68,14 @@ class PriceList(Document): def delete_price_list_details_key(self): frappe.cache().hdel("price_list_details", self.name) + def get_price_list_details(price_list): price_list_details = frappe.cache().hget("price_list_details", price_list) if not price_list_details: - price_list_details = frappe.get_cached_value("Price List", price_list, - ["currency", "price_not_uom_dependent", "enabled"], as_dict=1) + price_list_details = frappe.get_cached_value( + "Price List", price_list, ["currency", "price_not_uom_dependent", "enabled"], as_dict=1 + ) if not price_list_details or not price_list_details.get("enabled"): throw(_("Price List {0} is disabled or does not exist").format(price_list)) diff --git a/erpnext/stock/doctype/price_list/test_price_list.py b/erpnext/stock/doctype/price_list/test_price_list.py index b8218b942e7..93660930c79 100644 --- a/erpnext/stock/doctype/price_list/test_price_list.py +++ b/erpnext/stock/doctype/price_list/test_price_list.py @@ -6,4 +6,4 @@ import frappe # test_ignore = ["Item"] -test_records = frappe.get_test_records('Price List') +test_records = frappe.get_test_records("Price List") diff --git a/erpnext/stock/doctype/purchase_receipt/purchase_receipt.js b/erpnext/stock/doctype/purchase_receipt/purchase_receipt.js index befdad96924..e69d081b670 100644 --- a/erpnext/stock/doctype/purchase_receipt/purchase_receipt.js +++ b/erpnext/stock/doctype/purchase_receipt/purchase_receipt.js @@ -46,8 +46,6 @@ frappe.ui.form.on("Purchase Receipt", { erpnext.queries.setup_queries(frm, "Warehouse", function() { return erpnext.queries.warehouse(frm.doc); }); - - erpnext.accounts.dimensions.setup_dimension_filters(frm, frm.doctype); }, refresh: function(frm) { diff --git a/erpnext/stock/doctype/purchase_receipt/purchase_receipt.json b/erpnext/stock/doctype/purchase_receipt/purchase_receipt.json index 112ddedac29..26a9ac0475c 100755 --- a/erpnext/stock/doctype/purchase_receipt/purchase_receipt.json +++ b/erpnext/stock/doctype/purchase_receipt/purchase_receipt.json @@ -24,6 +24,10 @@ "apply_putaway_rule", "is_return", "return_against", + "accounting_dimensions_section", + "cost_center", + "dimension_col_break", + "project", "section_addresses", "supplier_address", "contact_person", @@ -104,10 +108,7 @@ "terms_section_break", "tc_name", "terms", - "bill_no", - "bill_date", "more_info", - "project", "status", "amended_from", "range", @@ -403,7 +404,6 @@ "fieldname": "ignore_pricing_rule", "fieldtype": "Check", "label": "Ignore Pricing Rule", - "no_copy": 1, "permlevel": 1, "print_hide": 1 }, @@ -865,24 +865,6 @@ "oldfieldname": "terms", "oldfieldtype": "Text Editor" }, - { - "fieldname": "bill_no", - "fieldtype": "Data", - "hidden": 1, - "label": "Bill No", - "oldfieldname": "bill_no", - "oldfieldtype": "Data", - "print_hide": 1 - }, - { - "fieldname": "bill_date", - "fieldtype": "Date", - "hidden": 1, - "label": "Bill Date", - "oldfieldname": "bill_date", - "oldfieldtype": "Date", - "print_hide": 1 - }, { "collapsible": 1, "fieldname": "more_info", @@ -1144,16 +1126,33 @@ "label": "Represents Company", "options": "Company", "read_only": 1 + }, + { + "collapsible": 1, + "fieldname": "accounting_dimensions_section", + "fieldtype": "Section Break", + "label": "Accounting Dimensions" + }, + { + "fieldname": "cost_center", + "fieldtype": "Link", + "label": "Cost Center", + "options": "Cost Center" + }, + { + "fieldname": "dimension_col_break", + "fieldtype": "Column Break" } ], "icon": "fa fa-truck", "idx": 261, "is_submittable": 1, "links": [], - "modified": "2021-09-28 13:11:10.181328", + "modified": "2022-09-16 17:45:58.430132", "modified_by": "Administrator", "module": "Stock", "name": "Purchase Receipt", + "naming_rule": "By \"Naming Series\" field", "owner": "Administrator", "permissions": [ { @@ -1214,6 +1213,7 @@ "show_name_in_global_search": 1, "sort_field": "modified", "sort_order": "DESC", + "states": [], "timeline_field": "supplier", "title_field": "title", "track_changes": 1 diff --git a/erpnext/stock/doctype/purchase_receipt/purchase_receipt.py b/erpnext/stock/doctype/purchase_receipt/purchase_receipt.py index e7e9e9c1d7f..390704fa3ed 100644 --- a/erpnext/stock/doctype/purchase_receipt/purchase_receipt.py +++ b/erpnext/stock/doctype/purchase_receipt/purchase_receipt.py @@ -9,6 +9,7 @@ from frappe.model.mapper import get_mapped_doc from frappe.utils import cint, flt, getdate, nowdate from six import iteritems +import erpnext from erpnext.accounts.utils import get_account_currency from erpnext.assets.doctype.asset.asset import get_asset_account, is_cwip_accounting_enabled from erpnext.assets.doctype.asset_category.asset_category import get_asset_category_account @@ -16,82 +17,85 @@ from erpnext.buying.utils import check_on_hold_or_closed_status from erpnext.controllers.buying_controller import BuyingController from erpnext.stock.doctype.delivery_note.delivery_note import make_inter_company_transaction -form_grid_templates = { - "items": "templates/form_grid/item_grid.html" -} +form_grid_templates = {"items": "templates/form_grid/item_grid.html"} + class PurchaseReceipt(BuyingController): def __init__(self, *args, **kwargs): super(PurchaseReceipt, self).__init__(*args, **kwargs) - self.status_updater = [{ - 'target_dt': 'Purchase Order Item', - 'join_field': 'purchase_order_item', - 'target_field': 'received_qty', - 'target_parent_dt': 'Purchase Order', - 'target_parent_field': 'per_received', - 'target_ref_field': 'qty', - 'source_dt': 'Purchase Receipt Item', - 'source_field': 'received_qty', - 'second_source_dt': 'Purchase Invoice Item', - 'second_source_field': 'received_qty', - 'second_join_field': 'po_detail', - 'percent_join_field': 'purchase_order', - 'overflow_type': 'receipt', - 'second_source_extra_cond': """ and exists(select name from `tabPurchase Invoice` - where name=`tabPurchase Invoice Item`.parent and update_stock = 1)""" - }, - { - 'source_dt': 'Purchase Receipt Item', - 'target_dt': 'Material Request Item', - 'join_field': 'material_request_item', - 'target_field': 'received_qty', - 'target_parent_dt': 'Material Request', - 'target_parent_field': 'per_received', - 'target_ref_field': 'stock_qty', - 'source_field': 'stock_qty', - 'percent_join_field': 'material_request' - }, - { - 'source_dt': 'Purchase Receipt Item', - 'target_dt': 'Purchase Invoice Item', - 'join_field': 'purchase_invoice_item', - 'target_field': 'received_qty', - 'target_parent_dt': 'Purchase Invoice', - 'target_parent_field': 'per_received', - 'target_ref_field': 'qty', - 'source_field': 'received_qty', - 'percent_join_field': 'purchase_invoice', - 'overflow_type': 'receipt' - }] + self.status_updater = [ + { + "target_dt": "Purchase Order Item", + "join_field": "purchase_order_item", + "target_field": "received_qty", + "target_parent_dt": "Purchase Order", + "target_parent_field": "per_received", + "target_ref_field": "qty", + "source_dt": "Purchase Receipt Item", + "source_field": "received_qty", + "second_source_dt": "Purchase Invoice Item", + "second_source_field": "received_qty", + "second_join_field": "po_detail", + "percent_join_field": "purchase_order", + "overflow_type": "receipt", + "second_source_extra_cond": """ and exists(select name from `tabPurchase Invoice` + where name=`tabPurchase Invoice Item`.parent and update_stock = 1)""", + }, + { + "source_dt": "Purchase Receipt Item", + "target_dt": "Material Request Item", + "join_field": "material_request_item", + "target_field": "received_qty", + "target_parent_dt": "Material Request", + "target_parent_field": "per_received", + "target_ref_field": "stock_qty", + "source_field": "stock_qty", + "percent_join_field": "material_request", + }, + { + "source_dt": "Purchase Receipt Item", + "target_dt": "Purchase Invoice Item", + "join_field": "purchase_invoice_item", + "target_field": "received_qty", + "target_parent_dt": "Purchase Invoice", + "target_parent_field": "per_received", + "target_ref_field": "qty", + "source_field": "received_qty", + "percent_join_field": "purchase_invoice", + "overflow_type": "receipt", + }, + ] if cint(self.is_return): - self.status_updater.extend([ - { - 'source_dt': 'Purchase Receipt Item', - 'target_dt': 'Purchase Order Item', - 'join_field': 'purchase_order_item', - 'target_field': 'returned_qty', - 'source_field': '-1 * qty', - 'second_source_dt': 'Purchase Invoice Item', - 'second_source_field': '-1 * qty', - 'second_join_field': 'po_detail', - 'extra_cond': """ and exists (select name from `tabPurchase Receipt` + self.status_updater.extend( + [ + { + "source_dt": "Purchase Receipt Item", + "target_dt": "Purchase Order Item", + "join_field": "purchase_order_item", + "target_field": "returned_qty", + "source_field": "-1 * qty", + "second_source_dt": "Purchase Invoice Item", + "second_source_field": "-1 * qty", + "second_join_field": "po_detail", + "extra_cond": """ and exists (select name from `tabPurchase Receipt` where name=`tabPurchase Receipt Item`.parent and is_return=1)""", - 'second_source_extra_cond': """ and exists (select name from `tabPurchase Invoice` - where name=`tabPurchase Invoice Item`.parent and is_return=1 and update_stock=1)""" - }, - { - 'source_dt': 'Purchase Receipt Item', - 'target_dt': 'Purchase Receipt Item', - 'join_field': 'purchase_receipt_item', - 'target_field': 'returned_qty', - 'target_parent_dt': 'Purchase Receipt', - 'target_parent_field': 'per_returned', - 'target_ref_field': 'received_stock_qty', - 'source_field': '-1 * received_stock_qty', - 'percent_join_field_parent': 'return_against' - } - ]) + "second_source_extra_cond": """ and exists (select name from `tabPurchase Invoice` + where name=`tabPurchase Invoice Item`.parent and is_return=1 and update_stock=1)""", + }, + { + "source_dt": "Purchase Receipt Item", + "target_dt": "Purchase Receipt Item", + "join_field": "purchase_receipt_item", + "target_field": "returned_qty", + "target_parent_dt": "Purchase Receipt", + "target_parent_field": "per_returned", + "target_ref_field": "received_stock_qty", + "source_field": "-1 * received_stock_qty", + "percent_join_field_parent": "return_against", + }, + ] + ) def before_validate(self): from erpnext.stock.doctype.putaway_rule.putaway_rule import apply_putaway_rule @@ -103,8 +107,8 @@ class PurchaseReceipt(BuyingController): self.validate_posting_time() super(PurchaseReceipt, self).validate() - if self._action=="submit": - self.make_batches('warehouse') + if self._action == "submit": + self.make_batches("warehouse") else: self.set_status() @@ -113,6 +117,7 @@ class PurchaseReceipt(BuyingController): self.validate_uom_is_integer("uom", ["qty", "received_qty"]) self.validate_uom_is_integer("stock_uom", "stock_qty") self.validate_cwip_accounts() + self.validate_provisional_expense_account() self.check_on_hold_or_closed_status() @@ -123,68 +128,95 @@ class PurchaseReceipt(BuyingController): self.reset_default_field_value("rejected_warehouse", "items", "rejected_warehouse") self.reset_default_field_value("set_from_warehouse", "items", "from_warehouse") - def validate_cwip_accounts(self): - for item in self.get('items'): + for item in self.get("items"): if item.is_fixed_asset and is_cwip_accounting_enabled(item.asset_category): # check cwip accounts before making auto assets # Improves UX by not giving messages of "Assets Created" before throwing error of not finding arbnb account arbnb_account = self.get_company_default("asset_received_but_not_billed") - cwip_account = get_asset_account("capital_work_in_progress_account", asset_category = item.asset_category, \ - company = self.company) + cwip_account = get_asset_account( + "capital_work_in_progress_account", asset_category=item.asset_category, company=self.company + ) break - def validate_with_previous_doc(self): - super(PurchaseReceipt, self).validate_with_previous_doc({ - "Purchase Order": { - "ref_dn_field": "purchase_order", - "compare_fields": [["supplier", "="], ["company", "="], ["currency", "="]], - }, - "Purchase Order Item": { - "ref_dn_field": "purchase_order_item", - "compare_fields": [["project", "="], ["uom", "="], ["item_code", "="]], - "is_child_table": True, - "allow_duplicate_prev_row_id": True - } - }) + def validate_provisional_expense_account(self): + provisional_accounting_for_non_stock_items = cint( + frappe.db.get_value( + "Company", self.company, "enable_provisional_accounting_for_non_stock_items" + ) + ) - if cint(frappe.db.get_single_value('Buying Settings', 'maintain_same_rate')) and not self.is_return: - self.validate_rate_with_reference_doc([["Purchase Order", "purchase_order", "purchase_order_item"]]) + if not provisional_accounting_for_non_stock_items: + return + + default_provisional_account = self.get_company_default("default_provisional_account") + for item in self.get("items"): + if not item.get("provisional_expense_account"): + item.provisional_expense_account = default_provisional_account + + def validate_with_previous_doc(self): + super(PurchaseReceipt, self).validate_with_previous_doc( + { + "Purchase Order": { + "ref_dn_field": "purchase_order", + "compare_fields": [["supplier", "="], ["company", "="], ["currency", "="]], + }, + "Purchase Order Item": { + "ref_dn_field": "purchase_order_item", + "compare_fields": [["project", "="], ["uom", "="], ["item_code", "="]], + "is_child_table": True, + "allow_duplicate_prev_row_id": True, + }, + } + ) + + if ( + cint(frappe.db.get_single_value("Buying Settings", "maintain_same_rate")) and not self.is_return + ): + self.validate_rate_with_reference_doc( + [["Purchase Order", "purchase_order", "purchase_order_item"]] + ) def po_required(self): - if frappe.db.get_value("Buying Settings", None, "po_required") == 'Yes': - for d in self.get('items'): + if frappe.db.get_value("Buying Settings", None, "po_required") == "Yes": + for d in self.get("items"): if not d.purchase_order: frappe.throw(_("Purchase Order number required for Item {0}").format(d.item_code)) def get_already_received_qty(self, po, po_detail): - qty = frappe.db.sql("""select sum(qty) from `tabPurchase Receipt Item` + qty = frappe.db.sql( + """select sum(qty) from `tabPurchase Receipt Item` where purchase_order_item = %s and docstatus = 1 and purchase_order=%s - and parent != %s""", (po_detail, po, self.name)) + and parent != %s""", + (po_detail, po, self.name), + ) return qty and flt(qty[0][0]) or 0.0 def get_po_qty_and_warehouse(self, po_detail): - po_qty, po_warehouse = frappe.db.get_value("Purchase Order Item", po_detail, - ["qty", "warehouse"]) + po_qty, po_warehouse = frappe.db.get_value( + "Purchase Order Item", po_detail, ["qty", "warehouse"] + ) return po_qty, po_warehouse # Check for Closed status def check_on_hold_or_closed_status(self): - check_list =[] - for d in self.get('items'): - if (d.meta.get_field('purchase_order') and d.purchase_order - and d.purchase_order not in check_list): + check_list = [] + for d in self.get("items"): + if ( + d.meta.get_field("purchase_order") and d.purchase_order and d.purchase_order not in check_list + ): check_list.append(d.purchase_order) - check_on_hold_or_closed_status('Purchase Order', d.purchase_order) + check_on_hold_or_closed_status("Purchase Order", d.purchase_order) # on submit def on_submit(self): super(PurchaseReceipt, self).on_submit() # Check for Approving Authority - frappe.get_doc('Authorization Control').validate_approving_authority(self.doctype, - self.company, self.base_grand_total) + frappe.get_doc("Authorization Control").validate_approving_authority( + self.doctype, self.company, self.base_grand_total + ) self.update_prevdoc_status() if flt(self.per_billed) < 100: @@ -192,13 +224,13 @@ class PurchaseReceipt(BuyingController): else: self.db_set("status", "Completed") - # Updating stock ledger should always be called after updating prevdoc status, # because updating ordered qty, reserved_qty_for_subcontract in bin # depends upon updated ordered qty in PO self.update_stock_ledger() from erpnext.stock.doctype.serial_no.serial_no import update_serial_nos_after_submit + update_serial_nos_after_submit(self, "items") self.make_gl_entries() @@ -206,10 +238,12 @@ class PurchaseReceipt(BuyingController): self.set_consumed_qty_in_po() def check_next_docstatus(self): - submit_rv = frappe.db.sql("""select t1.name + submit_rv = frappe.db.sql( + """select t1.name from `tabPurchase Invoice` t1,`tabPurchase Invoice Item` t2 where t1.name = t2.parent and t2.purchase_receipt = %s and t1.docstatus = 1""", - (self.name)) + (self.name), + ) if submit_rv: frappe.throw(_("Purchase Invoice {0} is already submitted").format(self.submit_rv[0][0])) @@ -218,10 +252,12 @@ class PurchaseReceipt(BuyingController): self.check_on_hold_or_closed_status() # Check if Purchase Invoice has been submitted against current Purchase Order - submitted = frappe.db.sql("""select t1.name + submitted = frappe.db.sql( + """select t1.name from `tabPurchase Invoice` t1,`tabPurchase Invoice Item` t2 where t1.name = t2.parent and t2.purchase_receipt = %s and t1.docstatus = 1""", - self.name) + self.name, + ) if submitted: frappe.throw(_("Purchase Invoice {0} is already submitted").format(submitted[0][0])) @@ -233,19 +269,24 @@ class PurchaseReceipt(BuyingController): self.update_stock_ledger() self.make_gl_entries_on_cancel() self.repost_future_sle_and_gle() - self.ignore_linked_doctypes = ('GL Entry', 'Stock Ledger Entry', 'Repost Item Valuation') + self.ignore_linked_doctypes = ("GL Entry", "Stock Ledger Entry", "Repost Item Valuation") self.delete_auto_created_batches() self.set_consumed_qty_in_po() @frappe.whitelist() def get_current_stock(self): - for d in self.get('supplied_items'): + for d in self.get("supplied_items"): if self.supplier_warehouse: - bin = frappe.db.sql("select actual_qty from `tabBin` where item_code = %s and warehouse = %s", (d.rm_item_code, self.supplier_warehouse), as_dict = 1) - d.current_stock = bin and flt(bin[0]['actual_qty']) or 0 + bin = frappe.db.sql( + "select actual_qty from `tabBin` where item_code = %s and warehouse = %s", + (d.rm_item_code, self.supplier_warehouse), + as_dict=1, + ) + d.current_stock = bin and flt(bin[0]["actual_qty"]) or 0 def get_gl_entries(self, warehouse_account=None): from erpnext.accounts.general_ledger import process_gl_map + gl_entries = [] self.make_item_gl_entries(gl_entries, warehouse_account=warehouse_account) @@ -255,37 +296,51 @@ class PurchaseReceipt(BuyingController): return process_gl_map(gl_entries) def make_item_gl_entries(self, gl_entries, warehouse_account=None): - stock_rbnb = self.get_company_default("stock_received_but_not_billed") - landed_cost_entries = get_item_account_wise_additional_cost(self.name) - expenses_included_in_valuation = self.get_company_default("expenses_included_in_valuation") - auto_accounting_for_non_stock_items = cint(frappe.db.get_value('Company', self.company, 'enable_perpetual_inventory_for_non_stock_items')) + if erpnext.is_perpetual_inventory_enabled(self.company): + stock_rbnb = self.get_company_default("stock_received_but_not_billed") + landed_cost_entries = get_item_account_wise_additional_cost(self.name) + expenses_included_in_valuation = self.get_company_default("expenses_included_in_valuation") warehouse_with_no_account = [] stock_items = self.get_stock_items() + provisional_accounting_for_non_stock_items = cint( + frappe.db.get_value( + "Company", self.company, "enable_provisional_accounting_for_non_stock_items" + ) + ) for d in self.get("items"): if d.item_code in stock_items and flt(d.valuation_rate) and flt(d.qty): if warehouse_account.get(d.warehouse): - stock_value_diff = frappe.db.get_value("Stock Ledger Entry", - {"voucher_type": "Purchase Receipt", "voucher_no": self.name, - "voucher_detail_no": d.name, "warehouse": d.warehouse}, "stock_value_difference") - - if not stock_value_diff: - continue + stock_value_diff = frappe.db.get_value( + "Stock Ledger Entry", + { + "voucher_type": "Purchase Receipt", + "voucher_no": self.name, + "voucher_detail_no": d.name, + "warehouse": d.warehouse, + "is_cancelled": 0, + }, + "stock_value_difference", + ) warehouse_account_name = warehouse_account[d.warehouse]["account"] warehouse_account_currency = warehouse_account[d.warehouse]["account_currency"] supplier_warehouse_account = warehouse_account.get(self.supplier_warehouse, {}).get("account") - supplier_warehouse_account_currency = warehouse_account.get(self.supplier_warehouse, {}).get("account_currency") + supplier_warehouse_account_currency = warehouse_account.get(self.supplier_warehouse, {}).get( + "account_currency" + ) remarks = self.get("remarks") or _("Accounting Entry for Stock") # If PR is sub-contracted and fg item rate is zero # in that case if account for source and target warehouse are same, # then GL entries should not be posted - if flt(stock_value_diff) == flt(d.rm_supp_cost) \ - and warehouse_account.get(self.supplier_warehouse) \ - and warehouse_account_name == supplier_warehouse_account: - continue + if ( + flt(stock_value_diff) == flt(d.rm_supp_cost) + and warehouse_account.get(self.supplier_warehouse) + and warehouse_account_name == supplier_warehouse_account + ): + continue self.add_gl_entry( gl_entries=gl_entries, @@ -296,37 +351,53 @@ class PurchaseReceipt(BuyingController): remarks=remarks, against_account=stock_rbnb, account_currency=warehouse_account_currency, - item=d) + item=d, + ) # GL Entry for from warehouse or Stock Received but not billed # Intentionally passed negative debit amount to avoid incorrect GL Entry validation - credit_currency = get_account_currency(warehouse_account[d.from_warehouse]['account']) \ - if d.from_warehouse else get_account_currency(stock_rbnb) + credit_currency = ( + get_account_currency(warehouse_account[d.from_warehouse]["account"]) + if d.from_warehouse + else get_account_currency(stock_rbnb) + ) + + credit_amount = ( + flt(d.base_net_amount, d.precision("base_net_amount")) + if credit_currency == self.company_currency + else flt(d.net_amount, d.precision("net_amount")) + ) + + outgoing_amount = d.base_net_amount + if self.is_internal_supplier and d.valuation_rate: + outgoing_amount = d.valuation_rate * d.stock_qty + credit_amount = outgoing_amount - credit_amount = flt(d.base_net_amount, d.precision("base_net_amount")) \ - if credit_currency == self.company_currency else flt(d.net_amount, d.precision("net_amount")) if credit_amount: - account = warehouse_account[d.from_warehouse]['account'] \ - if d.from_warehouse else stock_rbnb + account = warehouse_account[d.from_warehouse]["account"] if d.from_warehouse else stock_rbnb self.add_gl_entry( gl_entries=gl_entries, account=account, cost_center=d.cost_center, - debit=-1 * flt(d.base_net_amount, d.precision("base_net_amount")), + debit=-1 * flt(outgoing_amount, d.precision("base_net_amount")), credit=0.0, remarks=remarks, against_account=warehouse_account_name, debit_in_account_currency=-1 * credit_amount, account_currency=credit_currency, - item=d) + item=d, + ) # Amount added through landed-cos-voucher if d.landed_cost_voucher_amount and landed_cost_entries: for account, amount in iteritems(landed_cost_entries[(d.item_code, d.name)]): account_currency = get_account_currency(account) - credit_amount = (flt(amount["base_amount"]) if (amount["base_amount"] or - account_currency!=self.company_currency) else flt(amount["amount"])) + credit_amount = ( + flt(amount["base_amount"]) + if (amount["base_amount"] or account_currency != self.company_currency) + else flt(amount["amount"]) + ) self.add_gl_entry( gl_entries=gl_entries, @@ -339,7 +410,8 @@ class PurchaseReceipt(BuyingController): credit_in_account_currency=flt(amount["amount"]), account_currency=account_currency, project=d.project, - item=d) + item=d, + ) # sub-contracting warehouse if flt(d.rm_supp_cost) and warehouse_account.get(self.supplier_warehouse): @@ -352,22 +424,32 @@ class PurchaseReceipt(BuyingController): remarks=remarks, against_account=warehouse_account_name, account_currency=supplier_warehouse_account_currency, - item=d) + item=d, + ) # divisional loss adjustment - valuation_amount_as_per_doc = flt(d.base_net_amount, d.precision("base_net_amount")) + \ - flt(d.landed_cost_voucher_amount) + flt(d.rm_supp_cost) + flt(d.item_tax_amount) + valuation_amount_as_per_doc = ( + flt(outgoing_amount, d.precision("base_net_amount")) + + flt(d.landed_cost_voucher_amount) + + flt(d.rm_supp_cost) + + flt(d.item_tax_amount) + ) - divisional_loss = flt(valuation_amount_as_per_doc - stock_value_diff, - d.precision("base_net_amount")) + divisional_loss = flt( + valuation_amount_as_per_doc - stock_value_diff, d.precision("base_net_amount") + ) if divisional_loss: if self.is_return or flt(d.item_tax_amount): loss_account = expenses_included_in_valuation else: - loss_account = self.get_company_default("default_expense_account", ignore_validation=True) or stock_rbnb + loss_account = ( + self.get_company_default("default_expense_account", ignore_validation=True) or stock_rbnb + ) - cost_center = d.cost_center or frappe.get_cached_value("Company", self.company, "cost_center") + cost_center = d.cost_center or frappe.get_cached_value( + "Company", self.company, "cost_center" + ) self.add_gl_entry( gl_entries=gl_entries, @@ -379,58 +461,99 @@ class PurchaseReceipt(BuyingController): against_account=warehouse_account_name, account_currency=credit_currency, project=d.project, - item=d) + item=d, + ) - elif d.warehouse not in warehouse_with_no_account or \ - d.rejected_warehouse not in warehouse_with_no_account: - warehouse_with_no_account.append(d.warehouse) - elif d.item_code not in stock_items and not d.is_fixed_asset and flt(d.qty) and auto_accounting_for_non_stock_items: - service_received_but_not_billed_account = self.get_company_default("service_received_but_not_billed") - credit_currency = get_account_currency(service_received_but_not_billed_account) - debit_currency = get_account_currency(d.expense_account) - remarks = self.get("remarks") or _("Accounting Entry for Service") - - self.add_gl_entry( - gl_entries=gl_entries, - account=service_received_but_not_billed_account, - cost_center=d.cost_center, - debit=0.0, - credit=d.amount, - remarks=remarks, - against_account=d.expense_account, - account_currency=credit_currency, - project=d.project, - voucher_detail_no=d.name, item=d) - - self.add_gl_entry( - gl_entries=gl_entries, - account=d.expense_account, - cost_center=d.cost_center, - debit=d.amount, - credit=0.0, - remarks=remarks, - against_account=service_received_but_not_billed_account, - account_currency = debit_currency, - project=d.project, - voucher_detail_no=d.name, - item=d) + elif ( + d.warehouse not in warehouse_with_no_account + or d.rejected_warehouse not in warehouse_with_no_account + ): + warehouse_with_no_account.append(d.warehouse) + elif ( + d.item_code not in stock_items + and not d.is_fixed_asset + and flt(d.qty) + and provisional_accounting_for_non_stock_items + and d.get("provisional_expense_account") + ): + self.add_provisional_gl_entry( + d, gl_entries, self.posting_date, d.get("provisional_expense_account") + ) if warehouse_with_no_account: - frappe.msgprint(_("No accounting entries for the following warehouses") + ": \n" + - "\n".join(warehouse_with_no_account)) + frappe.msgprint( + _("No accounting entries for the following warehouses") + + ": \n" + + "\n".join(warehouse_with_no_account) + ) + + def add_provisional_gl_entry( + self, item, gl_entries, posting_date, provisional_account, reverse=0 + ): + credit_currency = get_account_currency(provisional_account) + debit_currency = get_account_currency(item.expense_account) + expense_account = item.expense_account + remarks = self.get("remarks") or _("Accounting Entry for Service") + multiplication_factor = 1 + + if reverse: + multiplication_factor = -1 + expense_account = frappe.db.get_value( + "Purchase Receipt Item", {"name": item.get("pr_detail")}, ["expense_account"] + ) + + self.add_gl_entry( + gl_entries=gl_entries, + account=provisional_account, + cost_center=item.cost_center, + debit=0.0, + credit=multiplication_factor * item.amount, + remarks=remarks, + against_account=expense_account, + account_currency=credit_currency, + project=item.project, + voucher_detail_no=item.name, + item=item, + posting_date=posting_date, + ) + + self.add_gl_entry( + gl_entries=gl_entries, + account=expense_account, + cost_center=item.cost_center, + debit=multiplication_factor * item.amount, + credit=0.0, + remarks=remarks, + against_account=provisional_account, + account_currency=debit_currency, + project=item.project, + voucher_detail_no=item.name, + item=item, + posting_date=posting_date, + ) def make_tax_gl_entries(self, gl_entries): - expenses_included_in_valuation = self.get_company_default("expenses_included_in_valuation") - negative_expense_to_be_booked = sum([flt(d.item_tax_amount) for d in self.get('items')]) + + if erpnext.is_perpetual_inventory_enabled(self.company): + expenses_included_in_valuation = self.get_company_default("expenses_included_in_valuation") + + negative_expense_to_be_booked = sum([flt(d.item_tax_amount) for d in self.get("items")]) # Cost center-wise amount breakup for other charges included for valuation valuation_tax = {} for tax in self.get("taxes"): - if tax.category in ("Valuation", "Valuation and Total") and flt(tax.base_tax_amount_after_discount_amount): + if tax.category in ("Valuation", "Valuation and Total") and flt( + tax.base_tax_amount_after_discount_amount + ): if not tax.cost_center: - frappe.throw(_("Cost Center is required in row {0} in Taxes table for type {1}").format(tax.idx, _(tax.category))) + frappe.throw( + _("Cost Center is required in row {0} in Taxes table for type {1}").format( + tax.idx, _(tax.category) + ) + ) valuation_tax.setdefault(tax.name, 0) - valuation_tax[tax.name] += \ - (tax.add_deduct_tax == "Add" and 1 or -1) * flt(tax.base_tax_amount_after_discount_amount) + valuation_tax[tax.name] += (tax.add_deduct_tax == "Add" and 1 or -1) * flt( + tax.base_tax_amount_after_discount_amount + ) if negative_expense_to_be_booked and valuation_tax: # Backward compatibility: @@ -439,10 +562,13 @@ class PurchaseReceipt(BuyingController): # post valuation related charges on "Stock Received But Not Billed" # introduced in 2014 for backward compatibility of expenses already booked in expenses_included_in_valuation account - negative_expense_booked_in_pi = frappe.db.sql("""select name from `tabPurchase Invoice Item` pi + negative_expense_booked_in_pi = frappe.db.sql( + """select name from `tabPurchase Invoice Item` pi where docstatus = 1 and purchase_receipt=%s and exists(select name from `tabGL Entry` where voucher_type='Purchase Invoice' - and voucher_no=pi.parent and account=%s)""", (self.name, expenses_included_in_valuation)) + and voucher_no=pi.parent and account=%s)""", + (self.name, expenses_included_in_valuation), + ) against_account = ", ".join([d.account for d in gl_entries if flt(d.debit) > 0]) total_valuation_amount = sum(valuation_tax.values()) @@ -460,7 +586,9 @@ class PurchaseReceipt(BuyingController): if i == len(valuation_tax): applicable_amount = amount_including_divisional_loss else: - applicable_amount = negative_expense_to_be_booked * (valuation_tax[tax.name] / total_valuation_amount) + applicable_amount = negative_expense_to_be_booked * ( + valuation_tax[tax.name] / total_valuation_amount + ) amount_including_divisional_loss -= applicable_amount self.add_gl_entry( @@ -471,13 +599,29 @@ class PurchaseReceipt(BuyingController): credit=applicable_amount, remarks=self.remarks or _("Accounting Entry for Stock"), against_account=against_account, - item=tax) + item=tax, + ) i += 1 - def add_gl_entry(self, gl_entries, account, cost_center, debit, credit, remarks, against_account, - debit_in_account_currency=None, credit_in_account_currency=None, account_currency=None, - project=None, voucher_detail_no=None, item=None): + def add_gl_entry( + self, + gl_entries, + account, + cost_center, + debit, + credit, + remarks, + against_account, + debit_in_account_currency=None, + credit_in_account_currency=None, + account_currency=None, + project=None, + voucher_detail_no=None, + item=None, + posting_date=None, + ): + gl_entry = { "account": account, "cost_center": cost_center, @@ -496,6 +640,9 @@ class PurchaseReceipt(BuyingController): if credit_in_account_currency: gl_entry.update({"credit_in_account_currency": credit_in_account_currency}) + if posting_date: + gl_entry.update({"posting_date": posting_date}) + gl_entries.append(self.get_gl_dict(gl_entry, item=item)) def get_asset_gl_entry(self, gl_entries): @@ -513,17 +660,20 @@ class PurchaseReceipt(BuyingController): def add_asset_gl_entries(self, item, gl_entries): arbnb_account = self.get_company_default("asset_received_but_not_billed") # This returns category's cwip account if not then fallback to company's default cwip account - cwip_account = get_asset_account("capital_work_in_progress_account", asset_category = item.asset_category, \ - company = self.company) + cwip_account = get_asset_account( + "capital_work_in_progress_account", asset_category=item.asset_category, company=self.company + ) - asset_amount = flt(item.net_amount) + flt(item.item_tax_amount/self.conversion_rate) + asset_amount = flt(item.net_amount) + flt(item.item_tax_amount / self.conversion_rate) base_asset_amount = flt(item.base_net_amount + item.item_tax_amount) remarks = self.get("remarks") or _("Accounting Entry for Asset") cwip_account_currency = get_account_currency(cwip_account) # debit cwip account - debit_in_account_currency = (base_asset_amount - if cwip_account_currency == self.company_currency else asset_amount) + debit_in_account_currency = ( + base_asset_amount if cwip_account_currency == self.company_currency else asset_amount + ) + self.add_gl_entry( gl_entries=gl_entries, account=cwip_account, @@ -533,12 +683,15 @@ class PurchaseReceipt(BuyingController): remarks=remarks, against_account=arbnb_account, debit_in_account_currency=debit_in_account_currency, - item=item) + item=item, + ) asset_rbnb_currency = get_account_currency(arbnb_account) # credit arbnb account - credit_in_account_currency = (base_asset_amount - if asset_rbnb_currency == self.company_currency else asset_amount) + credit_in_account_currency = ( + base_asset_amount if asset_rbnb_currency == self.company_currency else asset_amount + ) + self.add_gl_entry( gl_entries=gl_entries, account=arbnb_account, @@ -548,13 +701,17 @@ class PurchaseReceipt(BuyingController): remarks=remarks, against_account=cwip_account, credit_in_account_currency=credit_in_account_currency, - item=item) + item=item, + ) def add_lcv_gl_entries(self, item, gl_entries): - expenses_included_in_asset_valuation = self.get_company_default("expenses_included_in_asset_valuation") + expenses_included_in_asset_valuation = self.get_company_default( + "expenses_included_in_asset_valuation" + ) if not is_cwip_accounting_enabled(item.asset_category): - asset_account = get_asset_category_account(asset_category=item.asset_category, \ - fieldname='fixed_asset_account', company=self.company) + asset_account = get_asset_category_account( + asset_category=item.asset_category, fieldname="fixed_asset_account", company=self.company + ) else: # This returns company's default cwip account asset_account = get_asset_account("capital_work_in_progress_account", company=self.company) @@ -570,7 +727,8 @@ class PurchaseReceipt(BuyingController): remarks=remarks, against_account=asset_account, project=item.project, - item=item) + item=item, + ) self.add_gl_entry( gl_entries=gl_entries, @@ -581,11 +739,12 @@ class PurchaseReceipt(BuyingController): remarks=remarks, against_account=expenses_included_in_asset_valuation, project=item.project, - item=item) + item=item, + ) def update_assets(self, item, valuation_rate): - assets = frappe.db.get_all('Asset', - filters={ 'purchase_receipt': self.name, 'item_code': item.item_code } + assets = frappe.db.get_all( + "Asset", filters={"purchase_receipt": self.name, "item_code": item.item_code} ) for asset in assets: @@ -601,7 +760,7 @@ class PurchaseReceipt(BuyingController): updated_pr = [self.name] for d in self.get("items"): if d.get("purchase_invoice") and d.get("purchase_invoice_item"): - d.db_set('billed_amt', d.amount, update_modified=update_modified) + d.db_set("billed_amt", d.amount, update_modified=update_modified) elif d.purchase_order_item: updated_pr += update_billed_amount_based_on_po(d.purchase_order_item, update_modified) @@ -611,24 +770,35 @@ class PurchaseReceipt(BuyingController): self.load_from_db() + def update_billed_amount_based_on_po(po_detail, update_modified=True): # Billed against Sales Order directly - billed_against_po = frappe.db.sql("""select sum(amount) from `tabPurchase Invoice Item` - where po_detail=%s and (pr_detail is null or pr_detail = '') and docstatus=1""", po_detail) + billed_against_po = frappe.db.sql( + """select sum(amount) from `tabPurchase Invoice Item` + where po_detail=%s and (pr_detail is null or pr_detail = '') and docstatus=1""", + po_detail, + ) billed_against_po = billed_against_po and billed_against_po[0][0] or 0 # Get all Purchase Receipt Item rows against the Purchase Order Item row - pr_details = frappe.db.sql("""select pr_item.name, pr_item.amount, pr_item.parent + pr_details = frappe.db.sql( + """select pr_item.name, pr_item.amount, pr_item.parent from `tabPurchase Receipt Item` pr_item, `tabPurchase Receipt` pr where pr.name=pr_item.parent and pr_item.purchase_order_item=%s and pr.docstatus=1 and pr.is_return = 0 - order by pr.posting_date asc, pr.posting_time asc, pr.name asc""", po_detail, as_dict=1) + order by pr.posting_date asc, pr.posting_time asc, pr.name asc""", + po_detail, + as_dict=1, + ) updated_pr = [] for pr_item in pr_details: # Get billed amount directly against Purchase Receipt - billed_amt_agianst_pr = frappe.db.sql("""select sum(amount) from `tabPurchase Invoice Item` - where pr_detail=%s and docstatus=1""", pr_item.name) + billed_amt_agianst_pr = frappe.db.sql( + """select sum(amount) from `tabPurchase Invoice Item` + where pr_detail=%s and docstatus=1""", + pr_item.name, + ) billed_amt_agianst_pr = billed_amt_agianst_pr and billed_amt_agianst_pr[0][0] or 0 # Distribute billed amount directly against PO between PRs based on FIFO @@ -641,12 +811,19 @@ def update_billed_amount_based_on_po(po_detail, update_modified=True): billed_amt_agianst_pr += billed_against_po billed_against_po = 0 - frappe.db.set_value("Purchase Receipt Item", pr_item.name, "billed_amt", billed_amt_agianst_pr, update_modified=update_modified) + frappe.db.set_value( + "Purchase Receipt Item", + pr_item.name, + "billed_amt", + billed_amt_agianst_pr, + update_modified=update_modified, + ) updated_pr.append(pr_item.parent) return updated_pr + def update_billing_percentage(pr_doc, update_modified=True): # Reload as billed amount was set in db directly pr_doc.load_from_db() @@ -654,15 +831,15 @@ def update_billing_percentage(pr_doc, update_modified=True): # Update Billing % based on pending accepted qty total_amount, total_billed_amount = 0, 0 for item in pr_doc.items: - return_data = frappe.db.get_list("Purchase Receipt", - fields = [ - "sum(abs(`tabPurchase Receipt Item`.qty)) as qty" - ], - filters = [ + return_data = frappe.db.get_list( + "Purchase Receipt", + fields=["sum(abs(`tabPurchase Receipt Item`.qty)) as qty"], + filters=[ ["Purchase Receipt", "docstatus", "=", 1], ["Purchase Receipt", "is_return", "=", 1], - ["Purchase Receipt Item", "purchase_receipt_item", "=", item.name] - ]) + ["Purchase Receipt Item", "purchase_receipt_item", "=", item.name], + ], + ) returned_qty = return_data[0].qty if return_data else 0 returned_amount = flt(returned_qty) * flt(item.rate) @@ -680,11 +857,12 @@ def update_billing_percentage(pr_doc, update_modified=True): pr_doc.set_status(update=True) pr_doc.notify_update() + @frappe.whitelist() def make_purchase_invoice(source_name, target_doc=None): from erpnext.accounts.party import get_payment_terms_template - doc = frappe.get_doc('Purchase Receipt', source_name) + doc = frappe.get_doc("Purchase Receipt", source_name) returned_qty_map = get_returned_qty_map(source_name) invoiced_qty_map = get_invoiced_qty_map(source_name) @@ -693,8 +871,9 @@ def make_purchase_invoice(source_name, target_doc=None): frappe.throw(_("All items have already been Invoiced/Returned")) doc = frappe.get_doc(target) - doc.ignore_pricing_rule = 1 - doc.payment_terms_template = get_payment_terms_template(source.supplier, "Supplier", source.company) + doc.payment_terms_template = get_payment_terms_template( + source.supplier, "Supplier", source.company + ) doc.run_method("onload") doc.run_method("set_missing_values") doc.run_method("calculate_taxes_and_totals") @@ -702,14 +881,20 @@ def make_purchase_invoice(source_name, target_doc=None): def update_item(source_doc, target_doc, source_parent): target_doc.qty, returned_qty = get_pending_qty(source_doc) - if frappe.db.get_single_value("Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice"): + if frappe.db.get_single_value( + "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice" + ): target_doc.rejected_qty = 0 - target_doc.stock_qty = flt(target_doc.qty) * flt(target_doc.conversion_factor, target_doc.precision("conversion_factor")) + target_doc.stock_qty = flt(target_doc.qty) * flt( + target_doc.conversion_factor, target_doc.precision("conversion_factor") + ) returned_qty_map[source_doc.name] = returned_qty def get_pending_qty(item_row): qty = item_row.qty - if frappe.db.get_single_value("Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice"): + if frappe.db.get_single_value( + "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice" + ): qty = item_row.received_qty pending_qty = qty - invoiced_qty_map.get(item_row.name, 0) returned_qty = flt(returned_qty_map.get(item_row.name, 0)) @@ -722,68 +907,85 @@ def make_purchase_invoice(source_name, target_doc=None): returned_qty = 0 return pending_qty, returned_qty - - doclist = get_mapped_doc("Purchase Receipt", source_name, { - "Purchase Receipt": { - "doctype": "Purchase Invoice", - "field_map": { - "supplier_warehouse":"supplier_warehouse", - "is_return": "is_return", - "bill_date": "bill_date" + doclist = get_mapped_doc( + "Purchase Receipt", + source_name, + { + "Purchase Receipt": { + "doctype": "Purchase Invoice", + "field_map": { + "supplier_warehouse": "supplier_warehouse", + "is_return": "is_return", + "bill_date": "bill_date", + }, + "validation": { + "docstatus": ["=", 1], + }, }, - "validation": { - "docstatus": ["=", 1], + "Purchase Receipt Item": { + "doctype": "Purchase Invoice Item", + "field_map": { + "name": "pr_detail", + "parent": "purchase_receipt", + "purchase_order_item": "po_detail", + "purchase_order": "purchase_order", + "is_fixed_asset": "is_fixed_asset", + "asset_location": "asset_location", + "asset_category": "asset_category", + }, + "postprocess": update_item, + "filter": lambda d: get_pending_qty(d)[0] <= 0 + if not doc.get("is_return") + else get_pending_qty(d)[0] > 0, }, + "Purchase Taxes and Charges": {"doctype": "Purchase Taxes and Charges", "add_if_empty": True}, }, - "Purchase Receipt Item": { - "doctype": "Purchase Invoice Item", - "field_map": { - "name": "pr_detail", - "parent": "purchase_receipt", - "purchase_order_item": "po_detail", - "purchase_order": "purchase_order", - "is_fixed_asset": "is_fixed_asset", - "asset_location": "asset_location", - "asset_category": 'asset_category' - }, - "postprocess": update_item, - "filter": lambda d: get_pending_qty(d)[0] <= 0 if not doc.get("is_return") else get_pending_qty(d)[0] > 0 - }, - "Purchase Taxes and Charges": { - "doctype": "Purchase Taxes and Charges", - "add_if_empty": True - } - }, target_doc, set_missing_values) + target_doc, + set_missing_values, + ) + doclist.set_onload("ignore_price_list", True) return doclist + def get_invoiced_qty_map(purchase_receipt): """returns a map: {pr_detail: invoiced_qty}""" invoiced_qty_map = {} - for pr_detail, qty in frappe.db.sql("""select pr_detail, qty from `tabPurchase Invoice Item` - where purchase_receipt=%s and docstatus=1""", purchase_receipt): - if not invoiced_qty_map.get(pr_detail): - invoiced_qty_map[pr_detail] = 0 - invoiced_qty_map[pr_detail] += qty + for pr_detail, qty in frappe.db.sql( + """select pr_detail, qty from `tabPurchase Invoice Item` + where purchase_receipt=%s and docstatus=1""", + purchase_receipt, + ): + if not invoiced_qty_map.get(pr_detail): + invoiced_qty_map[pr_detail] = 0 + invoiced_qty_map[pr_detail] += qty return invoiced_qty_map + def get_returned_qty_map(purchase_receipt): """returns a map: {so_detail: returned_qty}""" - returned_qty_map = frappe._dict(frappe.db.sql("""select pr_item.purchase_receipt_item, abs(pr_item.qty) as qty + returned_qty_map = frappe._dict( + frappe.db.sql( + """select pr_item.purchase_receipt_item, abs(pr_item.qty) as qty from `tabPurchase Receipt Item` pr_item, `tabPurchase Receipt` pr where pr.name = pr_item.parent and pr.docstatus = 1 and pr.is_return = 1 and pr.return_against = %s - """, purchase_receipt)) + """, + purchase_receipt, + ) + ) return returned_qty_map + @frappe.whitelist() def make_purchase_return(source_name, target_doc=None): from erpnext.controllers.sales_and_purchase_return import make_return_doc + return make_return_doc("Purchase Receipt", source_name, target_doc) @@ -792,35 +994,48 @@ def update_purchase_receipt_status(docname, status): pr = frappe.get_doc("Purchase Receipt", docname) pr.update_status(status) + @frappe.whitelist() -def make_stock_entry(source_name,target_doc=None): +def make_stock_entry(source_name, target_doc=None): def set_missing_values(source, target): target.stock_entry_type = "Material Transfer" - target.purpose = "Material Transfer" + target.purpose = "Material Transfer" + target.set_missing_values() - doclist = get_mapped_doc("Purchase Receipt", source_name,{ - "Purchase Receipt": { - "doctype": "Stock Entry", - }, - "Purchase Receipt Item": { - "doctype": "Stock Entry Detail", - "field_map": { - "warehouse": "s_warehouse", - "parent": "reference_purchase_receipt", - "batch_no": "batch_no" + doclist = get_mapped_doc( + "Purchase Receipt", + source_name, + { + "Purchase Receipt": { + "doctype": "Stock Entry", + }, + "Purchase Receipt Item": { + "doctype": "Stock Entry Detail", + "field_map": { + "warehouse": "s_warehouse", + "parent": "reference_purchase_receipt", + "batch_no": "batch_no", + }, }, }, - }, target_doc, set_missing_values) + target_doc, + set_missing_values, + ) return doclist + @frappe.whitelist() def make_inter_company_delivery_note(source_name, target_doc=None): return make_inter_company_transaction("Purchase Receipt", source_name, target_doc) + def get_item_account_wise_additional_cost(purchase_document): - landed_cost_vouchers = frappe.get_all("Landed Cost Purchase Receipt", fields=["parent"], - filters = {"receipt_document": purchase_document, "docstatus": 1}) + landed_cost_vouchers = frappe.get_all( + "Landed Cost Purchase Receipt", + fields=["parent"], + filters={"receipt_document": purchase_document, "docstatus": 1}, + ) if not landed_cost_vouchers: return @@ -830,9 +1045,9 @@ def get_item_account_wise_additional_cost(purchase_document): for lcv in landed_cost_vouchers: landed_cost_voucher_doc = frappe.get_doc("Landed Cost Voucher", lcv.parent) - #Use amount field for total item cost for manually cost distributed LCVs - if landed_cost_voucher_doc.distribute_charges_based_on == 'Distribute Manually': - based_on_field = 'amount' + # Use amount field for total item cost for manually cost distributed LCVs + if landed_cost_voucher_doc.distribute_charges_based_on == "Distribute Manually": + based_on_field = "amount" else: based_on_field = frappe.scrub(landed_cost_voucher_doc.distribute_charges_based_on) @@ -845,15 +1060,20 @@ def get_item_account_wise_additional_cost(purchase_document): if item.receipt_document == purchase_document: for account in landed_cost_voucher_doc.taxes: item_account_wise_cost.setdefault((item.item_code, item.purchase_receipt_item), {}) - item_account_wise_cost[(item.item_code, item.purchase_receipt_item)].setdefault(account.expense_account, { - "amount": 0.0, - "base_amount": 0.0 - }) + item_account_wise_cost[(item.item_code, item.purchase_receipt_item)].setdefault( + account.expense_account, {"amount": 0.0, "base_amount": 0.0} + ) - item_account_wise_cost[(item.item_code, item.purchase_receipt_item)][account.expense_account]["amount"] += \ - account.amount * item.get(based_on_field) / total_item_cost + item_account_wise_cost[(item.item_code, item.purchase_receipt_item)][account.expense_account][ + "amount" + ] += (account.amount * item.get(based_on_field) / total_item_cost) - item_account_wise_cost[(item.item_code, item.purchase_receipt_item)][account.expense_account]["base_amount"] += \ - account.base_amount * item.get(based_on_field) / total_item_cost + item_account_wise_cost[(item.item_code, item.purchase_receipt_item)][account.expense_account][ + "base_amount" + ] += (account.base_amount * item.get(based_on_field) / total_item_cost) return item_account_wise_cost + + +def on_doctype_update(): + frappe.db.add_index("Purchase Receipt", ["supplier", "is_return", "return_against"]) diff --git a/erpnext/stock/doctype/purchase_receipt/purchase_receipt_dashboard.py b/erpnext/stock/doctype/purchase_receipt/purchase_receipt_dashboard.py index 18da88c3753..06ba9365561 100644 --- a/erpnext/stock/doctype/purchase_receipt/purchase_receipt_dashboard.py +++ b/erpnext/stock/doctype/purchase_receipt/purchase_receipt_dashboard.py @@ -1,38 +1,25 @@ - from frappe import _ def get_data(): return { - 'fieldname': 'purchase_receipt_no', - 'non_standard_fieldnames': { - 'Purchase Invoice': 'purchase_receipt', - 'Asset': 'purchase_receipt', - 'Landed Cost Voucher': 'receipt_document', - 'Auto Repeat': 'reference_document', - 'Purchase Receipt': 'return_against' + "fieldname": "purchase_receipt_no", + "non_standard_fieldnames": { + "Purchase Invoice": "purchase_receipt", + "Asset": "purchase_receipt", + "Landed Cost Voucher": "receipt_document", + "Auto Repeat": "reference_document", + "Purchase Receipt": "return_against", }, - 'internal_links': { - 'Purchase Order': ['items', 'purchase_order'], - 'Project': ['items', 'project'], - 'Quality Inspection': ['items', 'quality_inspection'], + "internal_links": { + "Purchase Order": ["items", "purchase_order"], + "Project": ["items", "project"], + "Quality Inspection": ["items", "quality_inspection"], }, - 'transactions': [ - { - 'label': _('Related'), - 'items': ['Purchase Invoice', 'Landed Cost Voucher', 'Asset'] - }, - { - 'label': _('Reference'), - 'items': ['Purchase Order', 'Quality Inspection', 'Project'] - }, - { - 'label': _('Returns'), - 'items': ['Purchase Receipt'] - }, - { - 'label': _('Subscription'), - 'items': ['Auto Repeat'] - }, - ] + "transactions": [ + {"label": _("Related"), "items": ["Purchase Invoice", "Landed Cost Voucher", "Asset"]}, + {"label": _("Reference"), "items": ["Purchase Order", "Quality Inspection", "Project"]}, + {"label": _("Returns"), "items": ["Purchase Receipt"]}, + {"label": _("Subscription"), "items": ["Auto Repeat"]}, + ], } diff --git a/erpnext/stock/doctype/purchase_receipt/test_purchase_receipt.py b/erpnext/stock/doctype/purchase_receipt/test_purchase_receipt.py index 6774dafb68c..e9c52436bc4 100644 --- a/erpnext/stock/doctype/purchase_receipt/test_purchase_receipt.py +++ b/erpnext/stock/doctype/purchase_receipt/test_purchase_receipt.py @@ -4,9 +4,12 @@ import json import unittest +from collections import defaultdict import frappe +from frappe.tests.utils import FrappeTestCase, change_settings from frappe.utils import add_days, cint, cstr, flt, today +from pypika import functions as fn from six import iteritems import erpnext @@ -17,24 +20,19 @@ from erpnext.stock.doctype.purchase_receipt.purchase_receipt import make_purchas from erpnext.stock.doctype.serial_no.serial_no import SerialNoDuplicateError, get_serial_nos from erpnext.stock.doctype.warehouse.test_warehouse import create_warehouse from erpnext.stock.stock_ledger import SerialNoExistsInFutureTransaction -from erpnext.tests.utils import ERPNextTestCase -class TestPurchaseReceipt(ERPNextTestCase): +class TestPurchaseReceipt(FrappeTestCase): def setUp(self): frappe.db.set_value("Buying Settings", None, "allow_multiple_items", 1) def test_purchase_receipt_received_qty(self): """ - 1. Test if received qty is validated against accepted + rejected - 2. Test if received qty is auto set on save + 1. Test if received qty is validated against accepted + rejected + 2. Test if received qty is auto set on save """ pr = make_purchase_receipt( - qty=1, - rejected_qty=1, - received_qty=3, - item_code="_Test Item Home Desktop 200", - do_not_save=True + qty=1, rejected_qty=1, received_qty=3, item_code="_Test Item Home Desktop 200", do_not_save=True ) self.assertRaises(QtyMismatchError, pr.save) @@ -51,11 +49,8 @@ class TestPurchaseReceipt(ERPNextTestCase): sl_entry = frappe.db.get_all( "Stock Ledger Entry", - { - "voucher_type": "Purchase Receipt", - "voucher_no": pr.name - }, - ['actual_qty'] + {"voucher_type": "Purchase Receipt", "voucher_no": pr.name}, + ["actual_qty"], ) self.assertEqual(len(sl_entry), 1) @@ -65,47 +60,44 @@ class TestPurchaseReceipt(ERPNextTestCase): sl_entry_cancelled = frappe.db.get_all( "Stock Ledger Entry", - { - "voucher_type": "Purchase Receipt", - "voucher_no": pr.name - }, - ['actual_qty'], - order_by='creation' + {"voucher_type": "Purchase Receipt", "voucher_no": pr.name}, + ["actual_qty"], + order_by="creation", ) self.assertEqual(len(sl_entry_cancelled), 2) self.assertEqual(sl_entry_cancelled[1].actual_qty, -0.5) def test_make_purchase_invoice(self): - if not frappe.db.exists('Payment Terms Template', '_Test Payment Terms Template For Purchase Invoice'): - frappe.get_doc({ - 'doctype': 'Payment Terms Template', - 'template_name': '_Test Payment Terms Template For Purchase Invoice', - 'allocate_payment_based_on_payment_terms': 1, - 'terms': [ - { - 'doctype': 'Payment Terms Template Detail', - 'invoice_portion': 50.00, - 'credit_days_based_on': 'Day(s) after invoice date', - 'credit_days': 00 - }, - { - 'doctype': 'Payment Terms Template Detail', - 'invoice_portion': 50.00, - 'credit_days_based_on': 'Day(s) after invoice date', - 'credit_days': 30 - }] - }).insert() + if not frappe.db.exists( + "Payment Terms Template", "_Test Payment Terms Template For Purchase Invoice" + ): + frappe.get_doc( + { + "doctype": "Payment Terms Template", + "template_name": "_Test Payment Terms Template For Purchase Invoice", + "allocate_payment_based_on_payment_terms": 1, + "terms": [ + { + "doctype": "Payment Terms Template Detail", + "invoice_portion": 50.00, + "credit_days_based_on": "Day(s) after invoice date", + "credit_days": 00, + }, + { + "doctype": "Payment Terms Template Detail", + "invoice_portion": 50.00, + "credit_days_based_on": "Day(s) after invoice date", + "credit_days": 30, + }, + ], + } + ).insert() template = frappe.db.get_value( - "Payment Terms Template", - "_Test Payment Terms Template For Purchase Invoice" - ) - old_template_in_supplier = frappe.db.get_value( - "Supplier", - "_Test Supplier", - "payment_terms" + "Payment Terms Template", "_Test Payment Terms Template For Purchase Invoice" ) + old_template_in_supplier = frappe.db.get_value("Supplier", "_Test Supplier", "payment_terms") frappe.db.set_value("Supplier", "_Test Supplier", "payment_terms", template) pr = make_purchase_receipt(do_not_save=True) @@ -123,23 +115,17 @@ class TestPurchaseReceipt(ERPNextTestCase): # test if payment terms are fetched and set in PI self.assertEqual(pi.payment_terms_template, template) - self.assertEqual(pi.payment_schedule[0].payment_amount, flt(pi.grand_total)/2) + self.assertEqual(pi.payment_schedule[0].payment_amount, flt(pi.grand_total) / 2) self.assertEqual(pi.payment_schedule[0].invoice_portion, 50) - self.assertEqual(pi.payment_schedule[1].payment_amount, flt(pi.grand_total)/2) + self.assertEqual(pi.payment_schedule[1].payment_amount, flt(pi.grand_total) / 2) self.assertEqual(pi.payment_schedule[1].invoice_portion, 50) # teardown - pi.delete() # draft PI + pi.delete() # draft PI pr.cancel() - frappe.db.set_value( - "Supplier", - "_Test Supplier", - "payment_terms", - old_template_in_supplier - ) + frappe.db.set_value("Supplier", "_Test Supplier", "payment_terms", old_template_in_supplier) frappe.get_doc( - "Payment Terms Template", - "_Test Payment Terms Template For Purchase Invoice" + "Payment Terms Template", "_Test Payment Terms Template For Purchase Invoice" ).delete() def test_purchase_receipt_no_gl_entry(self): @@ -147,20 +133,21 @@ class TestPurchaseReceipt(ERPNextTestCase): existing_bin_qty, existing_bin_stock_value = frappe.db.get_value( "Bin", - { - "item_code": "_Test Item", - "warehouse": "_Test Warehouse - _TC" - }, - ["actual_qty", "stock_value"] + {"item_code": "_Test Item", "warehouse": "_Test Warehouse - _TC"}, + ["actual_qty", "stock_value"], ) if existing_bin_qty < 0: make_stock_entry( - item_code="_Test Item", - target="_Test Warehouse - _TC", - qty=abs(existing_bin_qty) + item_code="_Test Item", target="_Test Warehouse - _TC", qty=abs(existing_bin_qty) ) + existing_bin_qty, existing_bin_stock_value = frappe.db.get_value( + "Bin", + {"item_code": "_Test Item", "warehouse": "_Test Warehouse - _TC"}, + ["actual_qty", "stock_value"], + ) + pr = make_purchase_receipt() stock_value_difference = frappe.db.get_value( @@ -169,20 +156,15 @@ class TestPurchaseReceipt(ERPNextTestCase): "voucher_type": "Purchase Receipt", "voucher_no": pr.name, "item_code": "_Test Item", - "warehouse": "_Test Warehouse - _TC" + "warehouse": "_Test Warehouse - _TC", }, - "stock_value_difference" + "stock_value_difference", ) self.assertEqual(stock_value_difference, 250) current_bin_stock_value = frappe.db.get_value( - "Bin", - { - "item_code": "_Test Item", - "warehouse": "_Test Warehouse - _TC" - }, - "stock_value" + "Bin", {"item_code": "_Test Item", "warehouse": "_Test Warehouse - _TC"}, "stock_value" ) self.assertEqual(current_bin_stock_value, existing_bin_stock_value + 250) @@ -191,7 +173,7 @@ class TestPurchaseReceipt(ERPNextTestCase): pr.cancel() def test_batched_serial_no_purchase(self): - item = frappe.db.exists("Item", {'item_name': 'Batched Serialized Item'}) + item = frappe.db.exists("Item", {"item_name": "Batched Serialized Item"}) if not item: item = create_item("Batched Serialized Item") item.has_batch_no = 1 @@ -201,34 +183,30 @@ class TestPurchaseReceipt(ERPNextTestCase): item.serial_no_series = "BS-.####" item.save() else: - item = frappe.get_doc("Item", {'item_name': 'Batched Serialized Item'}) + item = frappe.get_doc("Item", {"item_name": "Batched Serialized Item"}) pr = make_purchase_receipt(item_code=item.name, qty=5, rate=500) - self.assertTrue( - frappe.db.get_value('Batch', {'item': item.name, 'reference_name': pr.name}) - ) + self.assertTrue(frappe.db.get_value("Batch", {"item": item.name, "reference_name": pr.name})) pr.load_from_db() batch_no = pr.items[0].batch_no pr.cancel() - self.assertFalse( - frappe.db.get_value('Batch', {'item': item.name, 'reference_name': pr.name}) - ) - self.assertFalse(frappe.db.get_all('Serial No', {'batch_no': batch_no})) + self.assertFalse(frappe.db.get_value("Batch", {"item": item.name, "reference_name": pr.name})) + self.assertFalse(frappe.db.get_all("Serial No", {"batch_no": batch_no})) def test_duplicate_serial_nos(self): from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note - item = frappe.db.exists("Item", {'item_name': 'Test Serialized Item 123'}) + item = frappe.db.exists("Item", {"item_name": "Test Serialized Item 123"}) if not item: item = create_item("Test Serialized Item 123") item.has_serial_no = 1 item.serial_no_series = "TSI123-.####" item.save() else: - item = frappe.get_doc("Item", {'item_name': 'Test Serialized Item 123'}) + item = frappe.get_doc("Item", {"item_name": "Test Serialized Item 123"}) # First make purchase receipt pr = make_purchase_receipt(item_code=item.name, qty=2, rate=500) @@ -236,12 +214,8 @@ class TestPurchaseReceipt(ERPNextTestCase): serial_nos = frappe.db.get_value( "Stock Ledger Entry", - { - "voucher_type": "Purchase Receipt", - "voucher_no": pr.name, - "item_code": item.name - }, - "serial_no" + {"voucher_type": "Purchase Receipt", "voucher_no": pr.name, "item_code": item.name}, + "serial_no", ) serial_nos = get_serial_nos(serial_nos) @@ -253,21 +227,16 @@ class TestPurchaseReceipt(ERPNextTestCase): item_code=item.name, qty=2, rate=500, - serial_no='\n'.join(serial_nos), - company='_Test Company 1', + serial_no="\n".join(serial_nos), + company="_Test Company 1", do_not_submit=True, - warehouse = 'Stores - _TC1' + warehouse="Stores - _TC1", ) self.assertRaises(SerialNoDuplicateError, pr_different_company.submit) # Then made delivery note to remove the serial nos from stock - dn = create_delivery_note( - item_code=item.name, - qty=2, - rate=1500, - serial_no='\n'.join(serial_nos) - ) + dn = create_delivery_note(item_code=item.name, qty=2, rate=1500, serial_no="\n".join(serial_nos)) dn.load_from_db() self.assertEquals(get_serial_nos(dn.items[0].serial_no), serial_nos) @@ -279,8 +248,8 @@ class TestPurchaseReceipt(ERPNextTestCase): qty=2, rate=500, posting_date=posting_date, - serial_no='\n'.join(serial_nos), - do_not_submit=True + serial_no="\n".join(serial_nos), + do_not_submit=True, ) self.assertRaises(SerialNoExistsInFutureTransaction, pr1.submit) @@ -291,29 +260,28 @@ class TestPurchaseReceipt(ERPNextTestCase): qty=2, rate=500, posting_date=posting_date, - serial_no='\n'.join(serial_nos), + serial_no="\n".join(serial_nos), company="_Test Company 1", do_not_submit=True, - warehouse="Stores - _TC1" + warehouse="Stores - _TC1", ) self.assertRaises(SerialNoExistsInFutureTransaction, pr2.submit) # Receive the same serial nos after the delivery note posting date and time - make_purchase_receipt( - item_code=item.name, - qty=2, - rate=500, - serial_no='\n'.join(serial_nos) - ) + make_purchase_receipt(item_code=item.name, qty=2, rate=500, serial_no="\n".join(serial_nos)) # Raise the error for backdated deliver note entry cancel self.assertRaises(SerialNoExistsInFutureTransaction, dn.cancel) def test_purchase_receipt_gl_entry(self): - pr = make_purchase_receipt(company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", supplier_warehouse = "Work in Progress - TCP1", - get_multiple_items = True, get_taxes_and_charges = True) + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", + get_multiple_items=True, + get_taxes_and_charges=True, + ) self.assertEqual(cint(erpnext.is_perpetual_inventory_enabled(pr.company)), 1) @@ -329,14 +297,14 @@ class TestPurchaseReceipt(ERPNextTestCase): stock_in_hand_account: [750.0, 0.0], "Stock Received But Not Billed - TCP1": [0.0, 500.0], "_Test Account Shipping Charges - TCP1": [0.0, 100.0], - "_Test Account Customs Duty - TCP1": [0.0, 150.0] + "_Test Account Customs Duty - TCP1": [0.0, 150.0], } else: expected_values = { stock_in_hand_account: [375.0, 0.0], fixed_asset_account: [375.0, 0.0], "Stock Received But Not Billed - TCP1": [0.0, 500.0], - "_Test Account Shipping Charges - TCP1": [0.0, 250.0] + "_Test Account Shipping Charges - TCP1": [0.0, 250.0], } for gle in gl_entries: self.assertEqual(expected_values[gle.account][0], gle.debit) @@ -349,22 +317,19 @@ class TestPurchaseReceipt(ERPNextTestCase): from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry frappe.db.set_value( - "Buying Settings", None, - "backflush_raw_materials_of_subcontract_based_on", "BOM" + "Buying Settings", None, "backflush_raw_materials_of_subcontract_based_on", "BOM" ) make_stock_entry( - item_code="_Test Item", qty=100, - target="_Test Warehouse 1 - _TC", basic_rate=100 + item_code="_Test Item", qty=100, target="_Test Warehouse 1 - _TC", basic_rate=100 ) make_stock_entry( - item_code="_Test Item Home Desktop 100", qty=100, - target="_Test Warehouse 1 - _TC", basic_rate=100 - ) - pr = make_purchase_receipt( - item_code="_Test FG Item", qty=10, - rate=500, is_subcontracted="Yes" + item_code="_Test Item Home Desktop 100", + qty=100, + target="_Test Warehouse 1 - _TC", + basic_rate=100, ) + pr = make_purchase_receipt(item_code="_Test FG Item", qty=10, rate=500, is_subcontracted="Yes") self.assertEqual(len(pr.get("supplied_items")), 2) rm_supp_cost = sum(d.amount for d in pr.get("supplied_items")) @@ -374,32 +339,35 @@ class TestPurchaseReceipt(ERPNextTestCase): def test_subcontracting_gle_fg_item_rate_zero(self): from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry + frappe.db.set_value( - "Buying Settings", None, - "backflush_raw_materials_of_subcontract_based_on", "BOM" + "Buying Settings", None, "backflush_raw_materials_of_subcontract_based_on", "BOM" ) se1 = make_stock_entry( item_code="_Test Item", target="Work In Progress - TCP1", - qty=100, basic_rate=100, - company="_Test Company with perpetual inventory" + qty=100, + basic_rate=100, + company="_Test Company with perpetual inventory", ) se2 = make_stock_entry( item_code="_Test Item Home Desktop 100", target="Work In Progress - TCP1", - qty=100, basic_rate=100, - company="_Test Company with perpetual inventory" + qty=100, + basic_rate=100, + company="_Test Company with perpetual inventory", ) pr = make_purchase_receipt( item_code="_Test FG Item", - qty=10, rate=0, + qty=10, + rate=0, is_subcontracted="Yes", company="_Test Company with perpetual inventory", warehouse="Stores - TCP1", - supplier_warehouse="Work In Progress - TCP1" + supplier_warehouse="Work In Progress - TCP1", ) gl_entries = get_gl_entries("Purchase Receipt", pr.name) @@ -412,9 +380,9 @@ class TestPurchaseReceipt(ERPNextTestCase): def test_subcontracting_over_receipt(self): """ - Behaviour: Raise multiple PRs against one PO that in total - receive more than the required qty in the PO. - Expected Result: Error Raised for Over Receipt against PO. + Behaviour: Raise multiple PRs against one PO that in total + receive more than the required qty in the PO. + Expected Result: Error Raised for Over Receipt against PO. """ from erpnext.buying.doctype.purchase_order.purchase_order import make_purchase_receipt from erpnext.buying.doctype.purchase_order.purchase_order import ( @@ -433,26 +401,21 @@ class TestPurchaseReceipt(ERPNextTestCase): po = create_purchase_order( item_code=item_code, - qty=1, include_exploded_items=0, + qty=1, + include_exploded_items=0, is_subcontracted="Yes", - supplier_warehouse="_Test Warehouse 1 - _TC" + supplier_warehouse="_Test Warehouse 1 - _TC", ) # stock raw materials in a warehouse before transfer se1 = make_stock_entry( - target="_Test Warehouse - _TC", - item_code="Test Extra Item 1", - qty=10, basic_rate=100 + target="_Test Warehouse - _TC", item_code="Test Extra Item 1", qty=10, basic_rate=100 ) se2 = make_stock_entry( - target="_Test Warehouse - _TC", - item_code="_Test FG Item", - qty=1, basic_rate=100 + target="_Test Warehouse - _TC", item_code="_Test FG Item", qty=1, basic_rate=100 ) se3 = make_stock_entry( - target="_Test Warehouse - _TC", - item_code="Test Extra Item 2", - qty=1, basic_rate=100 + target="_Test Warehouse - _TC", item_code="Test Extra Item 2", qty=1, basic_rate=100 ) rm_items = [ @@ -462,7 +425,7 @@ class TestPurchaseReceipt(ERPNextTestCase): "item_name": "_Test FG Item", "qty": po.supplied_items[0].required_qty, "warehouse": "_Test Warehouse - _TC", - "stock_uom": "Nos" + "stock_uom": "Nos", }, { "item_code": item_code, @@ -470,8 +433,8 @@ class TestPurchaseReceipt(ERPNextTestCase): "item_name": "Test Extra Item 1", "qty": po.supplied_items[1].required_qty, "warehouse": "_Test Warehouse - _TC", - "stock_uom": "Nos" - } + "stock_uom": "Nos", + }, ] rm_item_string = json.dumps(rm_items) se = frappe.get_doc(make_subcontract_transfer_entry(po.name, rm_item_string)) @@ -493,8 +456,9 @@ class TestPurchaseReceipt(ERPNextTestCase): po.reload() pr2.load_from_db() - if pr2.docstatus == 1 and frappe.db.get_value('Stock Ledger Entry', - {'voucher_no': pr2.name, 'is_cancelled': 0}, 'name'): + if pr2.docstatus == 1 and frappe.db.get_value( + "Stock Ledger Entry", {"voucher_no": pr2.name, "is_cancelled": 0}, "name" + ): pr2.cancel() po.load_from_db() @@ -504,15 +468,10 @@ class TestPurchaseReceipt(ERPNextTestCase): pr = make_purchase_receipt(item_code="_Test Serialized Item With Series", qty=1) pr_row_1_serial_no = pr.get("items")[0].serial_no - self.assertEqual( - frappe.db.get_value("Serial No", pr_row_1_serial_no, "supplier"), - pr.supplier - ) + self.assertEqual(frappe.db.get_value("Serial No", pr_row_1_serial_no, "supplier"), pr.supplier) pr.cancel() - self.assertFalse( - frappe.db.get_value("Serial No", pr_row_1_serial_no, "warehouse") - ) + self.assertFalse(frappe.db.get_value("Serial No", pr_row_1_serial_no, "warehouse")) def test_rejected_serial_no(self): pr = frappe.copy_doc(test_records[0]) @@ -527,32 +486,34 @@ class TestPurchaseReceipt(ERPNextTestCase): accepted_serial_nos = pr.get("items")[0].serial_no.split("\n") self.assertEqual(len(accepted_serial_nos), 3) for serial_no in accepted_serial_nos: - self.assertEqual(frappe.db.get_value("Serial No", serial_no, "warehouse"), - pr.get("items")[0].warehouse) + self.assertEqual( + frappe.db.get_value("Serial No", serial_no, "warehouse"), pr.get("items")[0].warehouse + ) rejected_serial_nos = pr.get("items")[0].rejected_serial_no.split("\n") self.assertEqual(len(rejected_serial_nos), 2) for serial_no in rejected_serial_nos: - self.assertEqual(frappe.db.get_value("Serial No", serial_no, "warehouse"), - pr.get("items")[0].rejected_warehouse) + self.assertEqual( + frappe.db.get_value("Serial No", serial_no, "warehouse"), pr.get("items")[0].rejected_warehouse + ) pr.cancel() def test_purchase_return_partial(self): pr = make_purchase_receipt( company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1" + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", ) return_pr = make_purchase_receipt( company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1", + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", is_return=1, return_against=pr.name, qty=-2, - do_not_submit=1 + do_not_submit=1, ) return_pr.items[0].purchase_receipt_item = pr.items[0].name return_pr.submit() @@ -560,16 +521,12 @@ class TestPurchaseReceipt(ERPNextTestCase): # check sle outgoing_rate = frappe.db.get_value( "Stock Ledger Entry", - { - "voucher_type": "Purchase Receipt", - "voucher_no": return_pr.name - }, - "outgoing_rate" + {"voucher_type": "Purchase Receipt", "voucher_no": return_pr.name}, + "outgoing_rate", ) self.assertEqual(outgoing_rate, 50) - # check gl entries for return gl_entries = get_gl_entries("Purchase Receipt", return_pr.name) @@ -595,6 +552,7 @@ class TestPurchaseReceipt(ERPNextTestCase): self.assertEqual(pr.per_returned, 40) from erpnext.controllers.sales_and_purchase_return import make_return_doc + return_pr_2 = make_return_doc("Purchase Receipt", pr.name) # Check if unreturned amount is mapped in 2nd return @@ -617,7 +575,7 @@ class TestPurchaseReceipt(ERPNextTestCase): # PR should be completed on billing all unreturned amount self.assertEqual(pr.items[0].billed_amt, 150) self.assertEqual(pr.per_billed, 100) - self.assertEqual(pr.status, 'Completed') + self.assertEqual(pr.status, "Completed") pi.load_from_db() pi.cancel() @@ -631,18 +589,18 @@ class TestPurchaseReceipt(ERPNextTestCase): def test_purchase_return_full(self): pr = make_purchase_receipt( company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1" + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", ) return_pr = make_purchase_receipt( company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1", + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", is_return=1, return_against=pr.name, qty=-5, - do_not_submit=1 + do_not_submit=1, ) return_pr.items[0].purchase_receipt_item = pr.items[0].name return_pr.submit() @@ -655,7 +613,7 @@ class TestPurchaseReceipt(ERPNextTestCase): # Check if Original PR updated self.assertEqual(pr.items[0].returned_qty, 5) self.assertEqual(pr.per_returned, 100) - self.assertEqual(pr.status, 'Return Issued') + self.assertEqual(pr.status, "Return Issued") return_pr.cancel() pr.cancel() @@ -663,32 +621,32 @@ class TestPurchaseReceipt(ERPNextTestCase): def test_purchase_return_for_rejected_qty(self): from erpnext.stock.doctype.warehouse.test_warehouse import get_warehouse - rejected_warehouse="_Test Rejected Warehouse - TCP1" + rejected_warehouse = "_Test Rejected Warehouse - TCP1" if not frappe.db.exists("Warehouse", rejected_warehouse): get_warehouse( - company = "_Test Company with perpetual inventory", - abbr = " - TCP1", - warehouse_name = "_Test Rejected Warehouse" + company="_Test Company with perpetual inventory", + abbr=" - TCP1", + warehouse_name="_Test Rejected Warehouse", ).name pr = make_purchase_receipt( company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1", + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", qty=2, rejected_qty=2, - rejected_warehouse=rejected_warehouse + rejected_warehouse=rejected_warehouse, ) return_pr = make_purchase_receipt( company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1", + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", is_return=1, return_against=pr.name, qty=-2, - rejected_qty = -2, - rejected_warehouse=rejected_warehouse + rejected_qty=-2, + rejected_warehouse=rejected_warehouse, ) actual_qty = frappe.db.get_value( @@ -696,9 +654,9 @@ class TestPurchaseReceipt(ERPNextTestCase): { "voucher_type": "Purchase Receipt", "voucher_no": return_pr.name, - "warehouse": return_pr.items[0].rejected_warehouse + "warehouse": return_pr.items[0].rejected_warehouse, }, - "actual_qty" + "actual_qty", ) self.assertEqual(actual_qty, -2) @@ -706,6 +664,44 @@ class TestPurchaseReceipt(ERPNextTestCase): return_pr.cancel() pr.cancel() + def test_purchase_receipt_for_rejected_gle_without_accepted_warehouse(self): + from erpnext.stock.doctype.warehouse.test_warehouse import get_warehouse + + rejected_warehouse = "_Test Rejected Warehouse - TCP1" + if not frappe.db.exists("Warehouse", rejected_warehouse): + get_warehouse( + company="_Test Company with perpetual inventory", + abbr=" - TCP1", + warehouse_name="_Test Rejected Warehouse", + ).name + + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", + warehouse="Stores - TCP1", + received_qty=2, + rejected_qty=2, + rejected_warehouse=rejected_warehouse, + do_not_save=True, + ) + + pr.items[0].qty = 0.0 + pr.items[0].warehouse = "" + pr.submit() + + actual_qty = frappe.db.get_value( + "Stock Ledger Entry", + { + "voucher_type": "Purchase Receipt", + "voucher_no": pr.name, + "warehouse": pr.items[0].rejected_warehouse, + "is_cancelled": 0, + }, + "actual_qty", + ) + + self.assertEqual(actual_qty, 2) + self.assertFalse(pr.items[0].warehouse) + pr.cancel() def test_purchase_return_for_serialized_items(self): def _check_serial_no_values(serial_no, field_values): @@ -719,24 +715,22 @@ class TestPurchaseReceipt(ERPNextTestCase): serial_no = get_serial_nos(pr.get("items")[0].serial_no)[0] - _check_serial_no_values(serial_no, { - "warehouse": "_Test Warehouse - _TC", - "purchase_document_no": pr.name - }) + _check_serial_no_values( + serial_no, {"warehouse": "_Test Warehouse - _TC", "purchase_document_no": pr.name} + ) return_pr = make_purchase_receipt( item_code="_Test Serialized Item With Series", qty=-1, is_return=1, return_against=pr.name, - serial_no=serial_no + serial_no=serial_no, ) - _check_serial_no_values(serial_no, { - "warehouse": "", - "purchase_document_no": pr.name, - "delivery_document_no": return_pr.name - }) + _check_serial_no_values( + serial_no, + {"warehouse": "", "purchase_document_no": pr.name, "delivery_document_no": return_pr.name}, + ) return_pr.cancel() pr.reload() @@ -744,20 +738,12 @@ class TestPurchaseReceipt(ERPNextTestCase): def test_purchase_return_for_multi_uom(self): item_code = "_Test Purchase Return For Multi-UOM" - if not frappe.db.exists('Item', item_code): - item = make_item(item_code, {'stock_uom': 'Box'}) - row = item.append('uoms', { - 'uom': 'Unit', - 'conversion_factor': 0.1 - }) + if not frappe.db.exists("Item", item_code): + item = make_item(item_code, {"stock_uom": "Box"}) + row = item.append("uoms", {"uom": "Unit", "conversion_factor": 0.1}) row.db_update() - pr = make_purchase_receipt( - item_code=item_code, - qty=1, - uom="Box", - conversion_factor=1.0 - ) + pr = make_purchase_receipt(item_code=item_code, qty=1, uom="Box", conversion_factor=1.0) return_pr = make_purchase_receipt( item_code=item_code, qty=-10, @@ -765,7 +751,7 @@ class TestPurchaseReceipt(ERPNextTestCase): stock_uom="Box", conversion_factor=0.1, is_return=1, - return_against=pr.name + return_against=pr.name, ) self.assertEqual(abs(return_pr.items[0].stock_qty), 1.0) @@ -778,22 +764,19 @@ class TestPurchaseReceipt(ERPNextTestCase): update_purchase_receipt_status, ) - pr = make_purchase_receipt(do_not_submit=True) - pr.submit() + pr = make_purchase_receipt() update_purchase_receipt_status(pr.name, "Closed") - self.assertEqual( - frappe.db.get_value("Purchase Receipt", pr.name, "status"), "Closed" - ) + self.assertEqual(frappe.db.get_value("Purchase Receipt", pr.name, "status"), "Closed") pr.reload() pr.cancel() def test_pr_billing_status(self): """Flow: - 1. PO -> PR1 -> PI - 2. PO -> PI - 3. PO -> PR2. + 1. PO -> PR1 -> PI + 2. PO -> PI + 3. PO -> PR2. """ from erpnext.buying.doctype.purchase_order.purchase_order import ( make_purchase_invoice as make_purchase_invoice_from_po, @@ -855,19 +838,15 @@ class TestPurchaseReceipt(ERPNextTestCase): item = make_item(item_code, dict(has_serial_no=1)) serial_no = "12903812901" - pr_doc = make_purchase_receipt(item_code=item_code, - qty=1, serial_no = serial_no) + pr_doc = make_purchase_receipt(item_code=item_code, qty=1, serial_no=serial_no) self.assertEqual( serial_no, frappe.db.get_value( "Serial No", - { - "purchase_document_type": "Purchase Receipt", - "purchase_document_no": pr_doc.name - }, - "name" - ) + {"purchase_document_type": "Purchase Receipt", "purchase_document_no": pr_doc.name}, + "name", + ), ) pr_doc.cancel() @@ -884,12 +863,9 @@ class TestPurchaseReceipt(ERPNextTestCase): serial_no, frappe.db.get_value( "Serial No", - { - "purchase_document_type": "Purchase Receipt", - "purchase_document_no": new_pr_doc.name - }, - "name" - ) + {"purchase_document_type": "Purchase Receipt", "purchase_document_no": new_pr_doc.name}, + "name", + ), ) new_pr_doc.cancel() @@ -897,40 +873,52 @@ class TestPurchaseReceipt(ERPNextTestCase): def test_auto_asset_creation(self): asset_item = "Test Asset Item" - if not frappe.db.exists('Item', asset_item): - asset_category = frappe.get_all('Asset Category') + if not frappe.db.exists("Item", asset_item): + asset_category = frappe.get_all("Asset Category") if asset_category: asset_category = asset_category[0].name if not asset_category: - doc = frappe.get_doc({ - 'doctype': 'Asset Category', - 'asset_category_name': 'Test Asset Category', - 'depreciation_method': 'Straight Line', - 'total_number_of_depreciations': 12, - 'frequency_of_depreciation': 1, - 'accounts': [{ - 'company_name': '_Test Company', - 'fixed_asset_account': '_Test Fixed Asset - _TC', - 'accumulated_depreciation_account': '_Test Accumulated Depreciations - _TC', - 'depreciation_expense_account': '_Test Depreciations - _TC' - }] - }).insert() + doc = frappe.get_doc( + { + "doctype": "Asset Category", + "asset_category_name": "Test Asset Category", + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 12, + "frequency_of_depreciation": 1, + "accounts": [ + { + "company_name": "_Test Company", + "fixed_asset_account": "_Test Fixed Asset - _TC", + "accumulated_depreciation_account": "_Test Accumulated Depreciations - _TC", + "depreciation_expense_account": "_Test Depreciations - _TC", + } + ], + } + ).insert() asset_category = doc.name - item_data = make_item(asset_item, {'is_stock_item':0, - 'stock_uom': 'Box', 'is_fixed_asset': 1, 'auto_create_assets': 1, - 'asset_category': asset_category, 'asset_naming_series': 'ABC.###'}) + item_data = make_item( + asset_item, + { + "is_stock_item": 0, + "stock_uom": "Box", + "is_fixed_asset": 1, + "auto_create_assets": 1, + "asset_category": asset_category, + "asset_naming_series": "ABC.###", + }, + ) asset_item = item_data.item_code pr = make_purchase_receipt(item_code=asset_item, qty=3) - assets = frappe.db.get_all('Asset', filters={'purchase_receipt': pr.name}) + assets = frappe.db.get_all("Asset", filters={"purchase_receipt": pr.name}) self.assertEqual(len(assets), 3) - location = frappe.db.get_value('Asset', assets[0].name, 'location') + location = frappe.db.get_value("Asset", assets[0].name, "location") self.assertEqual(location, "Test Location") pr.cancel() @@ -940,17 +928,18 @@ class TestPurchaseReceipt(ERPNextTestCase): pr = make_purchase_receipt(item_code="Test Asset Item", qty=1) - asset = frappe.get_doc("Asset", { - 'purchase_receipt': pr.name - }) + asset = frappe.get_doc("Asset", {"purchase_receipt": pr.name}) asset.available_for_use_date = frappe.utils.nowdate() asset.gross_purchase_amount = 50.0 - asset.append("finance_books", { - "expected_value_after_useful_life": 10, - "depreciation_method": "Straight Line", - "total_number_of_depreciations": 3, - "frequency_of_depreciation": 1 - }) + asset.append( + "finance_books", + { + "expected_value_after_useful_life": 10, + "depreciation_method": "Straight Line", + "total_number_of_depreciations": 3, + "frequency_of_depreciation": 1, + }, + ) asset.submit() pr_return = make_purchase_return(pr.name) @@ -970,36 +959,27 @@ class TestPurchaseReceipt(ERPNextTestCase): cost_center = "_Test Cost Center for BS Account - TCP1" create_cost_center( cost_center_name="_Test Cost Center for BS Account", - company="_Test Company with perpetual inventory" + company="_Test Company with perpetual inventory", ) - if not frappe.db.exists('Location', 'Test Location'): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': 'Test Location' - }).insert() + if not frappe.db.exists("Location", "Test Location"): + frappe.get_doc({"doctype": "Location", "location_name": "Test Location"}).insert() pr = make_purchase_receipt( cost_center=cost_center, company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1" + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", ) - stock_in_hand_account = get_inventory_account( - pr.company, pr.get("items")[0].warehouse - ) + stock_in_hand_account = get_inventory_account(pr.company, pr.get("items")[0].warehouse) gl_entries = get_gl_entries("Purchase Receipt", pr.name) self.assertTrue(gl_entries) expected_values = { - "Stock Received But Not Billed - TCP1": { - "cost_center": cost_center - }, - stock_in_hand_account: { - "cost_center": cost_center - } + "Stock Received But Not Billed - TCP1": {"cost_center": cost_center}, + stock_in_hand_account: {"cost_center": cost_center}, } for i, gle in enumerate(gl_entries): self.assertEqual(expected_values[gle.account]["cost_center"], gle.cost_center) @@ -1007,33 +987,24 @@ class TestPurchaseReceipt(ERPNextTestCase): pr.cancel() def test_purchase_receipt_cost_center_with_balance_sheet_account(self): - if not frappe.db.exists('Location', 'Test Location'): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': 'Test Location' - }).insert() + if not frappe.db.exists("Location", "Test Location"): + frappe.get_doc({"doctype": "Location", "location_name": "Test Location"}).insert() pr = make_purchase_receipt( company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - supplier_warehouse = "Work in Progress - TCP1" + warehouse="Stores - TCP1", + supplier_warehouse="Work in Progress - TCP1", ) - stock_in_hand_account = get_inventory_account( - pr.company, pr.get("items")[0].warehouse - ) + stock_in_hand_account = get_inventory_account(pr.company, pr.get("items")[0].warehouse) gl_entries = get_gl_entries("Purchase Receipt", pr.name) self.assertTrue(gl_entries) - cost_center = pr.get('items')[0].cost_center + cost_center = pr.get("items")[0].cost_center expected_values = { - "Stock Received But Not Billed - TCP1": { - "cost_center": cost_center - }, - stock_in_hand_account: { - "cost_center": cost_center - } + "Stock Received But Not Billed - TCP1": {"cost_center": cost_center}, + stock_in_hand_account: {"cost_center": cost_center}, } for i, gle in enumerate(gl_entries): self.assertEqual(expected_values[gle.account]["cost_center"], gle.cost_center) @@ -1049,11 +1020,7 @@ class TestPurchaseReceipt(ERPNextTestCase): po = create_purchase_order() pr = create_pr_against_po(po.name) - pr1 = make_purchase_receipt( - qty=-1, - is_return=1, return_against=pr.name, - do_not_submit=True - ) + pr1 = make_purchase_receipt(qty=-1, is_return=1, return_against=pr.name, do_not_submit=True) pr1.items[0].purchase_order = po.name pr1.items[0].purchase_order_item = po.items[0].name pr1.items[0].purchase_receipt_item = pr.items[0].name @@ -1070,14 +1037,17 @@ class TestPurchaseReceipt(ERPNextTestCase): def test_make_purchase_invoice_from_pr_with_returned_qty_duplicate_items(self): pr1 = make_purchase_receipt(qty=8, do_not_submit=True) - pr1.append("items", { - "item_code": "_Test Item", - "warehouse": "_Test Warehouse - _TC", - "qty": 1, - "received_qty": 1, - "rate": 100, - "conversion_factor": 1.0, - }) + pr1.append( + "items", + { + "item_code": "_Test Item", + "warehouse": "_Test Warehouse - _TC", + "qty": 1, + "received_qty": 1, + "rate": 100, + "conversion_factor": 1.0, + }, + ) pr1.submit() pi1 = make_purchase_invoice(pr1.name) @@ -1086,11 +1056,7 @@ class TestPurchaseReceipt(ERPNextTestCase): pi1.save() pi1.submit() - pr2 = make_purchase_receipt( - qty=-2, - is_return=1, return_against=pr1.name, - do_not_submit=True - ) + pr2 = make_purchase_receipt(qty=-2, is_return=1, return_against=pr1.name, do_not_submit=True) pr2.items[0].purchase_receipt_item = pr1.items[0].name pr2.submit() @@ -1104,26 +1070,25 @@ class TestPurchaseReceipt(ERPNextTestCase): pr1.cancel() def test_stock_transfer_from_purchase_receipt(self): - pr1 = make_purchase_receipt(warehouse = 'Work In Progress - TCP1', - company="_Test Company with perpetual inventory") + pr1 = make_purchase_receipt( + warehouse="Work In Progress - TCP1", company="_Test Company with perpetual inventory" + ) - pr = make_purchase_receipt(company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", do_not_save=1) + pr = make_purchase_receipt( + company="_Test Company with perpetual inventory", warehouse="Stores - TCP1", do_not_save=1 + ) - pr.supplier_warehouse = '' - pr.items[0].from_warehouse = 'Work In Progress - TCP1' + pr.supplier_warehouse = "" + pr.items[0].from_warehouse = "Work In Progress - TCP1" pr.submit() - gl_entries = get_gl_entries('Purchase Receipt', pr.name) - sl_entries = get_sl_entries('Purchase Receipt', pr.name) + gl_entries = get_gl_entries("Purchase Receipt", pr.name) + sl_entries = get_sl_entries("Purchase Receipt", pr.name) self.assertFalse(gl_entries) - expected_sle = { - 'Work In Progress - TCP1': -5, - 'Stores - TCP1': 5 - } + expected_sle = {"Work In Progress - TCP1": -5, "Stores - TCP1": 5} for sle in sl_entries: self.assertEqual(expected_sle[sle.warehouse], sle.actual_qty) @@ -1135,48 +1100,45 @@ class TestPurchaseReceipt(ERPNextTestCase): create_warehouse( "_Test Warehouse for Valuation", company="_Test Company with perpetual inventory", - properties={"account": '_Test Account Stock In Hand - TCP1'} + properties={"account": "_Test Account Stock In Hand - TCP1"}, ) pr1 = make_purchase_receipt( - warehouse = '_Test Warehouse for Valuation - TCP1', - company="_Test Company with perpetual inventory" + warehouse="_Test Warehouse for Valuation - TCP1", + company="_Test Company with perpetual inventory", ) pr = make_purchase_receipt( - company="_Test Company with perpetual inventory", - warehouse = "Stores - TCP1", - do_not_save=1 + company="_Test Company with perpetual inventory", warehouse="Stores - TCP1", do_not_save=1 ) - pr.items[0].from_warehouse = '_Test Warehouse for Valuation - TCP1' - pr.supplier_warehouse = '' + pr.items[0].from_warehouse = "_Test Warehouse for Valuation - TCP1" + pr.supplier_warehouse = "" - - pr.append('taxes', { - 'charge_type': 'On Net Total', - 'account_head': '_Test Account Shipping Charges - TCP1', - 'category': 'Valuation and Total', - 'cost_center': 'Main - TCP1', - 'description': 'Test', - 'rate': 9 - }) + pr.append( + "taxes", + { + "charge_type": "On Net Total", + "account_head": "_Test Account Shipping Charges - TCP1", + "category": "Valuation and Total", + "cost_center": "Main - TCP1", + "description": "Test", + "rate": 9, + }, + ) pr.submit() - gl_entries = get_gl_entries('Purchase Receipt', pr.name) - sl_entries = get_sl_entries('Purchase Receipt', pr.name) + gl_entries = get_gl_entries("Purchase Receipt", pr.name) + sl_entries = get_sl_entries("Purchase Receipt", pr.name) expected_gle = [ - ['Stock In Hand - TCP1', 272.5, 0.0], - ['_Test Account Stock In Hand - TCP1', 0.0, 250.0], - ['_Test Account Shipping Charges - TCP1', 0.0, 22.5] + ["Stock In Hand - TCP1", 272.5, 0.0], + ["_Test Account Stock In Hand - TCP1", 0.0, 250.0], + ["_Test Account Shipping Charges - TCP1", 0.0, 22.5], ] - expected_sle = { - '_Test Warehouse for Valuation - TCP1': -5, - 'Stores - TCP1': 5 - } + expected_sle = {"_Test Warehouse for Valuation - TCP1": -5, "Stores - TCP1": 5} for sle in sl_entries: self.assertEqual(expected_sle[sle.warehouse], sle.actual_qty) @@ -1189,7 +1151,6 @@ class TestPurchaseReceipt(ERPNextTestCase): pr.cancel() pr1.cancel() - def test_subcontracted_pr_for_multi_transfer_batches(self): from erpnext.buying.doctype.purchase_order.purchase_order import ( make_purchase_receipt, @@ -1204,49 +1165,57 @@ class TestPurchaseReceipt(ERPNextTestCase): update_backflush_based_on("Material Transferred for Subcontract") item_code = "_Test Subcontracted FG Item 3" - make_item('Sub Contracted Raw Material 3', { - 'is_stock_item': 1, - 'is_sub_contracted_item': 1, - 'has_batch_no': 1, - 'create_new_batch': 1 - }) + make_item( + "Sub Contracted Raw Material 3", + {"is_stock_item": 1, "is_sub_contracted_item": 1, "has_batch_no": 1, "create_new_batch": 1}, + ) - create_subcontracted_item(item_code=item_code, has_batch_no=1, - raw_materials=["Sub Contracted Raw Material 3"]) + create_subcontracted_item( + item_code=item_code, has_batch_no=1, raw_materials=["Sub Contracted Raw Material 3"] + ) order_qty = 500 - po = create_purchase_order(item_code=item_code, qty=order_qty, - is_subcontracted="Yes", supplier_warehouse="_Test Warehouse 1 - _TC") + po = create_purchase_order( + item_code=item_code, + qty=order_qty, + is_subcontracted="Yes", + supplier_warehouse="_Test Warehouse 1 - _TC", + ) - ste1=make_stock_entry(target="_Test Warehouse - _TC", - item_code = "Sub Contracted Raw Material 3", qty=300, basic_rate=100) - ste2=make_stock_entry(target="_Test Warehouse - _TC", - item_code = "Sub Contracted Raw Material 3", qty=200, basic_rate=100) + ste1 = make_stock_entry( + target="_Test Warehouse - _TC", + item_code="Sub Contracted Raw Material 3", + qty=300, + basic_rate=100, + ) + ste2 = make_stock_entry( + target="_Test Warehouse - _TC", + item_code="Sub Contracted Raw Material 3", + qty=200, + basic_rate=100, + ) - transferred_batch = { - ste1.items[0].batch_no : 300, - ste2.items[0].batch_no : 200 - } + transferred_batch = {ste1.items[0].batch_no: 300, ste2.items[0].batch_no: 200} rm_items = [ { - "item_code":item_code, - "rm_item_code":"Sub Contracted Raw Material 3", - "item_name":"_Test Item", - "qty":300, - "warehouse":"_Test Warehouse - _TC", - "stock_uom":"Nos", - "name": po.supplied_items[0].name + "item_code": item_code, + "rm_item_code": "Sub Contracted Raw Material 3", + "item_name": "_Test Item", + "qty": 300, + "warehouse": "_Test Warehouse - _TC", + "stock_uom": "Nos", + "name": po.supplied_items[0].name, }, { - "item_code":item_code, - "rm_item_code":"Sub Contracted Raw Material 3", - "item_name":"_Test Item", - "qty":200, - "warehouse":"_Test Warehouse - _TC", - "stock_uom":"Nos", - "name": po.supplied_items[0].name - } + "item_code": item_code, + "rm_item_code": "Sub Contracted Raw Material 3", + "item_name": "_Test Item", + "qty": 200, + "warehouse": "_Test Warehouse - _TC", + "stock_uom": "Nos", + "name": po.supplied_items[0].name, + }, ] rm_item_string = json.dumps(rm_items) @@ -1258,11 +1227,8 @@ class TestPurchaseReceipt(ERPNextTestCase): supplied_qty = frappe.db.get_value( "Purchase Order Item Supplied", - { - "parent": po.name, - "rm_item_code": "Sub Contracted Raw Material 3" - }, - "supplied_qty" + {"parent": po.name, "rm_item_code": "Sub Contracted Raw Material 3"}, + "supplied_qty", ) self.assertEqual(supplied_qty, 500.00) @@ -1282,12 +1248,11 @@ class TestPurchaseReceipt(ERPNextTestCase): ste1.cancel() po.cancel() - def test_po_to_pi_and_po_to_pr_worflow_full(self): """Test following behaviour: - - Create PO - - Create PI from PO and submit - - Create PR from PO and submit + - Create PO + - Create PI from PO and submit + - Create PR from PO and submit """ from erpnext.buying.doctype.purchase_order import purchase_order, test_purchase_order @@ -1306,16 +1271,16 @@ class TestPurchaseReceipt(ERPNextTestCase): def test_po_to_pi_and_po_to_pr_worflow_partial(self): """Test following behaviour: - - Create PO - - Create partial PI from PO and submit - - Create PR from PO and submit + - Create PO + - Create partial PI from PO and submit + - Create PR from PO and submit """ from erpnext.buying.doctype.purchase_order import purchase_order, test_purchase_order po = test_purchase_order.create_purchase_order() pi = purchase_order.make_purchase_invoice(po.name) - pi.items[0].qty /= 2 # roughly 50%, ^ this function only creates PI with 1 item. + pi.items[0].qty /= 2 # roughly 50%, ^ this function only creates PI with 1 item. pi.submit() pr = purchase_order.make_purchase_receipt(po.name) @@ -1331,58 +1296,6 @@ class TestPurchaseReceipt(ERPNextTestCase): self.assertEqual(pr.status, "To Bill") self.assertAlmostEqual(pr.per_billed, 50.0, places=2) - def test_service_item_purchase_with_perpetual_inventory(self): - company = '_Test Company with perpetual inventory' - service_item = '_Test Non Stock Item' - - before_test_value = frappe.db.get_value( - 'Company', company, 'enable_perpetual_inventory_for_non_stock_items' - ) - frappe.db.set_value( - 'Company', company, - 'enable_perpetual_inventory_for_non_stock_items', 1 - ) - srbnb_account = 'Stock Received But Not Billed - TCP1' - frappe.db.set_value( - 'Company', company, - 'service_received_but_not_billed', srbnb_account - ) - - pr = make_purchase_receipt( - company=company, item=service_item, - warehouse='Finished Goods - TCP1', do_not_save=1 - ) - item_row_with_diff_rate = frappe.copy_doc(pr.items[0]) - item_row_with_diff_rate.rate = 100 - pr.append('items', item_row_with_diff_rate) - - pr.save() - pr.submit() - - item_one_gl_entry = frappe.db.get_all("GL Entry", { - 'voucher_type': pr.doctype, - 'voucher_no': pr.name, - 'account': srbnb_account, - 'voucher_detail_no': pr.items[0].name - }, pluck="name") - - item_two_gl_entry = frappe.db.get_all("GL Entry", { - 'voucher_type': pr.doctype, - 'voucher_no': pr.name, - 'account': srbnb_account, - 'voucher_detail_no': pr.items[1].name - }, pluck="name") - - # check if the entries are not merged into one - # seperate entries should be made since voucher_detail_no is different - self.assertEqual(len(item_one_gl_entry), 1) - self.assertEqual(len(item_two_gl_entry), 1) - - frappe.db.set_value( - 'Company', company, - 'enable_perpetual_inventory_for_non_stock_items', before_test_value - ) - def test_payment_terms_are_fetched_when_creating_purchase_invoice(self): from erpnext.accounts.doctype.payment_entry.test_payment_entry import ( create_payment_terms_template, @@ -1399,10 +1312,9 @@ class TestPurchaseReceipt(ERPNextTestCase): automatically_fetch_payment_terms() - po = create_purchase_order(qty=10, rate=100, do_not_save=1) create_payment_terms_template() - po.payment_terms_template = 'Test Receivable Template' + po.payment_terms_template = "Test Receivable Template" po.submit() pr = make_pr_against_po(po.name, received_qty=10) @@ -1419,94 +1331,295 @@ class TestPurchaseReceipt(ERPNextTestCase): automatically_fetch_payment_terms(enable=0) + @change_settings("Stock Settings", {"allow_negative_stock": 1}) + def test_neg_to_positive(self): + from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry + + item_code = "_TestNegToPosItem" + warehouse = "Stores - TCP1" + company = "_Test Company with perpetual inventory" + account = "Stock Received But Not Billed - TCP1" + + make_item(item_code) + se = make_stock_entry( + item_code=item_code, from_warehouse=warehouse, qty=50, do_not_save=True, rate=0 + ) + se.items[0].allow_zero_valuation_rate = 1 + se.save() + se.submit() + + pr = make_purchase_receipt( + qty=50, + rate=1, + item_code=item_code, + warehouse=warehouse, + get_taxes_and_charges=True, + company=company, + ) + gles = get_gl_entries(pr.doctype, pr.name) + + for gle in gles: + if gle.account == account: + self.assertEqual(gle.credit, 50) + + def test_backdated_transaction_for_internal_transfer(self): + from erpnext.stock.doctype.delivery_note.delivery_note import make_inter_company_purchase_receipt + from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note + + prepare_data_for_internal_transfer() + customer = "_Test Internal Customer 2" + company = "_Test Company with perpetual inventory" + + from_warehouse = create_warehouse("_Test Internal From Warehouse New", company=company) + to_warehouse = create_warehouse("_Test Internal To Warehouse New", company=company) + item_doc = create_item("Test Internal Transfer Item") + + target_warehouse = create_warehouse("_Test Internal GIT Warehouse New", company=company) + + make_purchase_receipt( + item_code=item_doc.name, + company=company, + posting_date=add_days(today(), -1), + warehouse=from_warehouse, + qty=1, + rate=100, + ) + + dn1 = create_delivery_note( + item_code=item_doc.name, + company=company, + customer=customer, + cost_center="Main - TCP1", + expense_account="Cost of Goods Sold - TCP1", + qty=1, + rate=500, + warehouse=from_warehouse, + target_warehouse=target_warehouse, + ) + + self.assertEqual(dn1.items[0].rate, 100) + + pr1 = make_inter_company_purchase_receipt(dn1.name) + pr1.items[0].warehouse = to_warehouse + self.assertEqual(pr1.items[0].rate, 100) + pr1.submit() + + # Backdated purchase receipt entry, the valuation rate should be updated for DN1 and PR1 + make_purchase_receipt( + item_code=item_doc.name, + company=company, + posting_date=add_days(today(), -2), + warehouse=from_warehouse, + qty=1, + rate=200, + ) + + dn_value = frappe.db.get_value( + "Stock Ledger Entry", + {"voucher_type": "Delivery Note", "voucher_no": dn1.name, "warehouse": target_warehouse}, + "stock_value_difference", + ) + + self.assertEqual(abs(dn_value), 200.00) + + pr_value = frappe.db.get_value( + "Stock Ledger Entry", + {"voucher_type": "Purchase Receipt", "voucher_no": pr1.name, "warehouse": to_warehouse}, + "stock_value_difference", + ) + + self.assertEqual(abs(pr_value), 200.00) + pr1.load_from_db() + + self.assertEqual(pr1.items[0].valuation_rate, 200) + self.assertEqual(pr1.items[0].rate, 100) + + Gl = frappe.qb.DocType("GL Entry") + + query = ( + frappe.qb.from_(Gl) + .select( + (fn.Sum(Gl.debit) - fn.Sum(Gl.credit)).as_("value"), + ) + .where((Gl.voucher_type == pr1.doctype) & (Gl.voucher_no == pr1.name)) + ).run(as_dict=True) + + self.assertEqual(query[0].value, 0) + + def test_batch_expiry_for_purchase_receipt(self): + from erpnext.controllers.sales_and_purchase_return import make_return_doc + + item = make_item( + "_Test Batch Item For Return Check", + { + "is_purchase_item": 1, + "is_stock_item": 1, + "has_batch_no": 1, + "create_new_batch": 1, + "batch_number_series": "TBIRC.#####", + }, + ) + + pi = make_purchase_receipt( + qty=1, + item_code=item.name, + update_stock=True, + ) + + pi.load_from_db() + batch_no = pi.items[0].batch_no + self.assertTrue(batch_no) + + frappe.db.set_value("Batch", batch_no, "expiry_date", add_days(today(), -1)) + + return_pi = make_return_doc(pi.doctype, pi.name) + return_pi.save().submit() + + self.assertTrue(return_pi.docstatus == 1) + + +def prepare_data_for_internal_transfer(): + from erpnext.accounts.doctype.sales_invoice.test_sales_invoice import create_internal_supplier + from erpnext.selling.doctype.customer.test_customer import create_internal_customer + + company = "_Test Company with perpetual inventory" + + create_internal_customer( + "_Test Internal Customer 2", + company, + company, + ) + + create_internal_supplier( + "_Test Internal Supplier 2", + company, + company, + ) + + if not frappe.db.get_value("Company", company, "unrealized_profit_loss_account"): + account = "Unrealized Profit and Loss - TCP1" + if not frappe.db.exists("Account", account): + frappe.get_doc( + { + "doctype": "Account", + "account_name": "Unrealized Profit and Loss", + "parent_account": "Direct Income - TCP1", + "company": company, + "is_group": 0, + "account_type": "Income Account", + } + ).insert() + + frappe.db.set_value("Company", company, "unrealized_profit_loss_account", account) + + def get_sl_entries(voucher_type, voucher_no): - return frappe.db.sql(""" select actual_qty, warehouse, stock_value_difference + return frappe.db.sql( + """ select actual_qty, warehouse, stock_value_difference from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s - order by posting_time desc""", (voucher_type, voucher_no), as_dict=1) + order by posting_time desc""", + (voucher_type, voucher_no), + as_dict=1, + ) + def get_gl_entries(voucher_type, voucher_no): - return frappe.db.sql("""select account, debit, credit, cost_center, is_cancelled + return frappe.db.sql( + """select account, debit, credit, cost_center, is_cancelled from `tabGL Entry` where voucher_type=%s and voucher_no=%s - order by account desc""", (voucher_type, voucher_no), as_dict=1) + order by account desc""", + (voucher_type, voucher_no), + as_dict=1, + ) + def get_taxes(**args): args = frappe._dict(args) - return [{'account_head': '_Test Account Shipping Charges - TCP1', - 'add_deduct_tax': 'Add', - 'category': 'Valuation and Total', - 'charge_type': 'Actual', - 'cost_center': args.cost_center or 'Main - TCP1', - 'description': 'Shipping Charges', - 'doctype': 'Purchase Taxes and Charges', - 'parentfield': 'taxes', - 'rate': 100.0, - 'tax_amount': 100.0}, - {'account_head': '_Test Account VAT - TCP1', - 'add_deduct_tax': 'Add', - 'category': 'Total', - 'charge_type': 'Actual', - 'cost_center': args.cost_center or 'Main - TCP1', - 'description': 'VAT', - 'doctype': 'Purchase Taxes and Charges', - 'parentfield': 'taxes', - 'rate': 120.0, - 'tax_amount': 120.0}, - {'account_head': '_Test Account Customs Duty - TCP1', - 'add_deduct_tax': 'Add', - 'category': 'Valuation', - 'charge_type': 'Actual', - 'cost_center': args.cost_center or 'Main - TCP1', - 'description': 'Customs Duty', - 'doctype': 'Purchase Taxes and Charges', - 'parentfield': 'taxes', - 'rate': 150.0, - 'tax_amount': 150.0}] + return [ + { + "account_head": "_Test Account Shipping Charges - TCP1", + "add_deduct_tax": "Add", + "category": "Valuation and Total", + "charge_type": "Actual", + "cost_center": args.cost_center or "Main - TCP1", + "description": "Shipping Charges", + "doctype": "Purchase Taxes and Charges", + "parentfield": "taxes", + "rate": 100.0, + "tax_amount": 100.0, + }, + { + "account_head": "_Test Account VAT - TCP1", + "add_deduct_tax": "Add", + "category": "Total", + "charge_type": "Actual", + "cost_center": args.cost_center or "Main - TCP1", + "description": "VAT", + "doctype": "Purchase Taxes and Charges", + "parentfield": "taxes", + "rate": 120.0, + "tax_amount": 120.0, + }, + { + "account_head": "_Test Account Customs Duty - TCP1", + "add_deduct_tax": "Add", + "category": "Valuation", + "charge_type": "Actual", + "cost_center": args.cost_center or "Main - TCP1", + "description": "Customs Duty", + "doctype": "Purchase Taxes and Charges", + "parentfield": "taxes", + "rate": 150.0, + "tax_amount": 150.0, + }, + ] + def get_items(**args): args = frappe._dict(args) - return [{ - "base_amount": 250.0, - "conversion_factor": 1.0, - "description": "_Test Item", - "doctype": "Purchase Receipt Item", - "item_code": "_Test Item", - "item_name": "_Test Item", - "parentfield": "items", - "qty": 5.0, - "rate": 50.0, - "received_qty": 5.0, - "rejected_qty": 0.0, - "stock_uom": "_Test UOM", - "uom": "_Test UOM", - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "cost_center": args.cost_center or "Main - _TC" - }, - { - "base_amount": 250.0, - "conversion_factor": 1.0, - "description": "_Test Item Home Desktop 100", - "doctype": "Purchase Receipt Item", - "item_code": "_Test Item Home Desktop 100", - "item_name": "_Test Item Home Desktop 100", - "parentfield": "items", - "qty": 5.0, - "rate": 50.0, - "received_qty": 5.0, - "rejected_qty": 0.0, - "stock_uom": "_Test UOM", - "uom": "_Test UOM", - "warehouse": args.warehouse or "_Test Warehouse 1 - _TC", - "cost_center": args.cost_center or "Main - _TC" - }] + return [ + { + "base_amount": 250.0, + "conversion_factor": 1.0, + "description": "_Test Item", + "doctype": "Purchase Receipt Item", + "item_code": "_Test Item", + "item_name": "_Test Item", + "parentfield": "items", + "qty": 5.0, + "rate": 50.0, + "received_qty": 5.0, + "rejected_qty": 0.0, + "stock_uom": "_Test UOM", + "uom": "_Test UOM", + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "cost_center": args.cost_center or "Main - _TC", + }, + { + "base_amount": 250.0, + "conversion_factor": 1.0, + "description": "_Test Item Home Desktop 100", + "doctype": "Purchase Receipt Item", + "item_code": "_Test Item Home Desktop 100", + "item_name": "_Test Item Home Desktop 100", + "parentfield": "items", + "qty": 5.0, + "rate": 50.0, + "received_qty": 5.0, + "rejected_qty": 0.0, + "stock_uom": "_Test UOM", + "uom": "_Test UOM", + "warehouse": args.warehouse or "_Test Warehouse 1 - _TC", + "cost_center": args.cost_center or "Main - _TC", + }, + ] + def make_purchase_receipt(**args): - if not frappe.db.exists('Location', 'Test Location'): - frappe.get_doc({ - 'doctype': 'Location', - 'location_name': 'Test Location' - }).insert() + if not frappe.db.exists("Location", "Test Location"): + frappe.get_doc({"doctype": "Location", "location_name": "Test Location"}).insert() frappe.db.set_value("Buying Settings", None, "allow_multiple_items", 1) pr = frappe.new_doc("Purchase Receipt") @@ -1530,27 +1643,34 @@ def make_purchase_receipt(**args): item_code = args.item or args.item_code or "_Test Item" uom = args.uom or frappe.db.get_value("Item", item_code, "stock_uom") or "_Test UOM" - pr.append("items", { - "item_code": item_code, - "warehouse": args.warehouse or "_Test Warehouse - _TC", - "qty": qty, - "received_qty": received_qty, - "rejected_qty": rejected_qty, - "rejected_warehouse": args.rejected_warehouse or "_Test Rejected Warehouse - _TC" if rejected_qty != 0 else "", - "rate": args.rate if args.rate != None else 50, - "conversion_factor": args.conversion_factor or 1.0, - "stock_qty": flt(qty) * (flt(args.conversion_factor) or 1.0), - "serial_no": args.serial_no, - "stock_uom": args.stock_uom or "_Test UOM", - "uom": uom, - "cost_center": args.cost_center or frappe.get_cached_value('Company', pr.company, 'cost_center'), - "asset_location": args.location or "Test Location" - }) + pr.append( + "items", + { + "item_code": item_code, + "warehouse": args.warehouse or "_Test Warehouse - _TC", + "qty": qty, + "received_qty": received_qty, + "rejected_qty": rejected_qty, + "rejected_warehouse": args.rejected_warehouse or "_Test Rejected Warehouse - _TC" + if rejected_qty != 0 + else "", + "rate": args.rate if args.rate != None else 50, + "conversion_factor": args.conversion_factor or 1.0, + "stock_qty": flt(qty) * (flt(args.conversion_factor) or 1.0), + "serial_no": args.serial_no, + "batch_no": args.batch_no, + "stock_uom": args.stock_uom or "_Test UOM", + "uom": uom, + "cost_center": args.cost_center + or frappe.get_cached_value("Company", pr.company, "cost_center"), + "asset_location": args.location or "Test Location", + }, + ) if args.get_multiple_items: pr.items = [] - company_cost_center = frappe.get_cached_value('Company', pr.company, 'cost_center') + company_cost_center = frappe.get_cached_value("Company", pr.company, "cost_center") cost_center = args.cost_center or company_cost_center for item in get_items(warehouse=args.warehouse, cost_center=cost_center): @@ -1566,33 +1686,44 @@ def make_purchase_receipt(**args): pr.submit() return pr + def create_subcontracted_item(**args): from erpnext.manufacturing.doctype.production_plan.test_production_plan import make_bom args = frappe._dict(args) - if not frappe.db.exists('Item', args.item_code): - make_item(args.item_code, { - 'is_stock_item': 1, - 'is_sub_contracted_item': 1, - 'has_batch_no': args.get("has_batch_no") or 0 - }) + if not frappe.db.exists("Item", args.item_code): + make_item( + args.item_code, + { + "is_stock_item": 1, + "is_sub_contracted_item": 1, + "has_batch_no": args.get("has_batch_no") or 0, + }, + ) if not args.raw_materials: - if not frappe.db.exists('Item', "Test Extra Item 1"): - make_item("Test Extra Item 1", { - 'is_stock_item': 1, - }) + if not frappe.db.exists("Item", "Test Extra Item 1"): + make_item( + "Test Extra Item 1", + { + "is_stock_item": 1, + }, + ) - if not frappe.db.exists('Item', "Test Extra Item 2"): - make_item("Test Extra Item 2", { - 'is_stock_item': 1, - }) + if not frappe.db.exists("Item", "Test Extra Item 2"): + make_item( + "Test Extra Item 2", + { + "is_stock_item": 1, + }, + ) - args.raw_materials = ['_Test FG Item', 'Test Extra Item 1'] + args.raw_materials = ["_Test FG Item", "Test Extra Item 1"] + + if not frappe.db.get_value("BOM", {"item": args.item_code}, "name"): + make_bom(item=args.item_code, raw_materials=args.get("raw_materials")) - if not frappe.db.get_value('BOM', {'item': args.item_code}, 'name'): - make_bom(item = args.item_code, raw_materials = args.get("raw_materials")) test_dependencies = ["BOM", "Item Price", "Location"] -test_records = frappe.get_test_records('Purchase Receipt') +test_records = frappe.get_test_records("Purchase Receipt") diff --git a/erpnext/stock/doctype/purchase_receipt_item/purchase_receipt_item.json b/erpnext/stock/doctype/purchase_receipt_item/purchase_receipt_item.json index 30ea1c3cadc..5a04e7d2eec 100644 --- a/erpnext/stock/doctype/purchase_receipt_item/purchase_receipt_item.json +++ b/erpnext/stock/doctype/purchase_receipt_item/purchase_receipt_item.json @@ -96,7 +96,6 @@ "include_exploded_items", "batch_no", "rejected_serial_no", - "expense_account", "item_tax_rate", "item_weight_details", "weight_per_unit", @@ -107,6 +106,10 @@ "manufacturer", "column_break_16", "manufacturer_part_no", + "accounting_details_section", + "expense_account", + "column_break_102", + "provisional_expense_account", "accounting_dimensions_section", "project", "dimension_col_break", @@ -783,10 +786,8 @@ { "fieldname": "expense_account", "fieldtype": "Link", - "hidden": 1, "label": "Expense Account", - "options": "Account", - "read_only": 1 + "options": "Account" }, { "fieldname": "accounting_dimensions_section", @@ -971,12 +972,27 @@ "label": "Product Bundle", "options": "Product Bundle", "read_only": 1 + }, + { + "fieldname": "provisional_expense_account", + "fieldtype": "Link", + "label": "Provisional Expense Account", + "options": "Account" + }, + { + "fieldname": "accounting_details_section", + "fieldtype": "Section Break", + "label": "Accounting Details" + }, + { + "fieldname": "column_break_102", + "fieldtype": "Column Break" } ], "idx": 1, "istable": 1, "links": [], - "modified": "2021-11-15 15:46:10.591600", + "modified": "2022-07-28 19:27:54.880781", "modified_by": "Administrator", "module": "Stock", "name": "Purchase Receipt Item", @@ -985,5 +1001,6 @@ "permissions": [], "quick_entry": 1, "sort_field": "modified", - "sort_order": "DESC" + "sort_order": "DESC", + "states": [] } \ No newline at end of file diff --git a/erpnext/stock/doctype/putaway_rule/putaway_rule.py b/erpnext/stock/doctype/putaway_rule/putaway_rule.py index 25330b71833..623fbde2b0b 100644 --- a/erpnext/stock/doctype/putaway_rule/putaway_rule.py +++ b/erpnext/stock/doctype/putaway_rule/putaway_rule.py @@ -9,8 +9,7 @@ from collections import defaultdict import frappe from frappe import _ from frappe.model.document import Document -from frappe.utils import cint, floor, flt, nowdate -from six import string_types +from frappe.utils import cint, cstr, floor, flt, nowdate from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos from erpnext.stock.utils import get_stock_balance @@ -25,11 +24,16 @@ class PutawayRule(Document): self.set_stock_capacity() def validate_duplicate_rule(self): - existing_rule = frappe.db.exists("Putaway Rule", {"item_code": self.item_code, "warehouse": self.warehouse}) + existing_rule = frappe.db.exists( + "Putaway Rule", {"item_code": self.item_code, "warehouse": self.warehouse} + ) if existing_rule and existing_rule != self.name: - frappe.throw(_("Putaway Rule already exists for Item {0} in Warehouse {1}.") - .format(frappe.bold(self.item_code), frappe.bold(self.warehouse)), - title=_("Duplicate")) + frappe.throw( + _("Putaway Rule already exists for Item {0} in Warehouse {1}.").format( + frappe.bold(self.item_code), frappe.bold(self.warehouse) + ), + title=_("Duplicate"), + ) def validate_priority(self): if self.priority < 1: @@ -38,18 +42,24 @@ class PutawayRule(Document): def validate_warehouse_and_company(self): company = frappe.db.get_value("Warehouse", self.warehouse, "company") if company != self.company: - frappe.throw(_("Warehouse {0} does not belong to Company {1}.") - .format(frappe.bold(self.warehouse), frappe.bold(self.company)), - title=_("Invalid Warehouse")) + frappe.throw( + _("Warehouse {0} does not belong to Company {1}.").format( + frappe.bold(self.warehouse), frappe.bold(self.company) + ), + title=_("Invalid Warehouse"), + ) def validate_capacity(self): stock_uom = frappe.db.get_value("Item", self.item_code, "stock_uom") balance_qty = get_stock_balance(self.item_code, self.warehouse, nowdate()) if flt(self.stock_capacity) < flt(balance_qty): - frappe.throw(_("Warehouse Capacity for Item '{0}' must be greater than the existing stock level of {1} {2}.") - .format(self.item_code, frappe.bold(balance_qty), stock_uom), - title=_("Insufficient Capacity")) + frappe.throw( + _( + "Warehouse Capacity for Item '{0}' must be greater than the existing stock level of {1} {2}." + ).format(self.item_code, frappe.bold(balance_qty), stock_uom), + title=_("Insufficient Capacity"), + ) if not self.capacity: frappe.throw(_("Capacity must be greater than 0"), title=_("Invalid")) @@ -57,25 +67,28 @@ class PutawayRule(Document): def set_stock_capacity(self): self.stock_capacity = (flt(self.conversion_factor) or 1) * flt(self.capacity) + @frappe.whitelist() def get_available_putaway_capacity(rule): - stock_capacity, item_code, warehouse = frappe.db.get_value("Putaway Rule", rule, - ["stock_capacity", "item_code", "warehouse"]) + stock_capacity, item_code, warehouse = frappe.db.get_value( + "Putaway Rule", rule, ["stock_capacity", "item_code", "warehouse"] + ) balance_qty = get_stock_balance(item_code, warehouse, nowdate()) free_space = flt(stock_capacity) - flt(balance_qty) return free_space if free_space > 0 else 0 + @frappe.whitelist() def apply_putaway_rule(doctype, items, company, sync=None, purpose=None): - """ Applies Putaway Rule on line items. + """Applies Putaway Rule on line items. - items: List of Purchase Receipt/Stock Entry Items - company: Company in the Purchase Receipt/Stock Entry - doctype: Doctype to apply rule on - purpose: Purpose of Stock Entry - sync (optional): Sync with client side only for client side calls + items: List of Purchase Receipt/Stock Entry Items + company: Company in the Purchase Receipt/Stock Entry + doctype: Doctype to apply rule on + purpose: Purpose of Stock Entry + sync (optional): Sync with client side only for client side calls """ - if isinstance(items, string_types): + if isinstance(items, str): items = json.loads(items) items_not_accomodated, updated_table = [], [] @@ -90,16 +103,18 @@ def apply_putaway_rule(doctype, items, company, sync=None, purpose=None): item.conversion_factor = flt(item.conversion_factor) or 1.0 pending_qty, item_code = flt(item.qty), item.item_code pending_stock_qty = flt(item.transfer_qty) if doctype == "Stock Entry" else flt(item.stock_qty) - uom_must_be_whole_number = frappe.db.get_value('UOM', item.uom, 'must_be_whole_number') + uom_must_be_whole_number = frappe.db.get_value("UOM", item.uom, "must_be_whole_number") if not pending_qty or not item_code: updated_table = add_row(item, pending_qty, source_warehouse or item.warehouse, updated_table) continue - at_capacity, rules = get_ordered_putaway_rules(item_code, company, source_warehouse=source_warehouse) + at_capacity, rules = get_ordered_putaway_rules( + item_code, company, source_warehouse=source_warehouse + ) if not rules: - warehouse = source_warehouse or item.get('warehouse') + warehouse = source_warehouse or item.get("warehouse") if at_capacity: # rules available, but no free space items_not_accomodated.append([item_code, pending_qty]) @@ -118,23 +133,28 @@ def apply_putaway_rule(doctype, items, company, sync=None, purpose=None): for rule in item_wise_rules[key]: if pending_stock_qty > 0 and rule.free_space: - stock_qty_to_allocate = flt(rule.free_space) if pending_stock_qty >= flt(rule.free_space) else pending_stock_qty + stock_qty_to_allocate = ( + flt(rule.free_space) if pending_stock_qty >= flt(rule.free_space) else pending_stock_qty + ) qty_to_allocate = stock_qty_to_allocate / item.conversion_factor if uom_must_be_whole_number: qty_to_allocate = floor(qty_to_allocate) stock_qty_to_allocate = qty_to_allocate * item.conversion_factor - if not qty_to_allocate: break + if not qty_to_allocate: + break - updated_table = add_row(item, qty_to_allocate, rule.warehouse, updated_table, - rule.name, serial_nos=serial_nos) + updated_table = add_row( + item, qty_to_allocate, rule.warehouse, updated_table, rule.name, serial_nos=serial_nos + ) pending_stock_qty -= stock_qty_to_allocate pending_qty -= qty_to_allocate rule["free_space"] -= stock_qty_to_allocate - if not pending_stock_qty > 0: break + if not pending_stock_qty > 0: + break # if pending qty after applying all rules, add row without warehouse if pending_stock_qty > 0: @@ -143,25 +163,66 @@ def apply_putaway_rule(doctype, items, company, sync=None, purpose=None): if items_not_accomodated: show_unassigned_items_message(items_not_accomodated) - items[:] = updated_table if updated_table else items # modify items table + if updated_table and _items_changed(items, updated_table, doctype): + items[:] = updated_table + frappe.msgprint(_("Applied putaway rules."), alert=True) - if sync and json.loads(sync): # sync with client side + if sync and json.loads(sync): # sync with client side return items + +def _items_changed(old, new, doctype: str) -> bool: + """Check if any items changed by application of putaway rules. + + If not, changing item table can have side effects since `name` items also changes. + """ + if len(old) != len(new): + return True + + old = [frappe._dict(item) if isinstance(item, dict) else item for item in old] + + if doctype == "Stock Entry": + compare_keys = ("item_code", "t_warehouse", "transfer_qty", "serial_no") + sort_key = lambda item: ( # noqa + item.item_code, + cstr(item.t_warehouse), + flt(item.transfer_qty), + cstr(item.serial_no), + ) + else: + # purchase receipt / invoice + compare_keys = ("item_code", "warehouse", "stock_qty", "received_qty", "serial_no") + sort_key = lambda item: ( # noqa + item.item_code, + cstr(item.warehouse), + flt(item.stock_qty), + flt(item.received_qty), + cstr(item.serial_no), + ) + + old_sorted = sorted(old, key=sort_key) + new_sorted = sorted(new, key=sort_key) + + # Once sorted by all relevant keys both tables should align if they are same. + for old_item, new_item in zip(old_sorted, new_sorted): + for key in compare_keys: + if old_item.get(key) != new_item.get(key): + return True + return False + + def get_ordered_putaway_rules(item_code, company, source_warehouse=None): """Returns an ordered list of putaway rules to apply on an item.""" - filters = { - "item_code": item_code, - "company": company, - "disable": 0 - } + filters = {"item_code": item_code, "company": company, "disable": 0} if source_warehouse: filters.update({"warehouse": ["!=", source_warehouse]}) - rules = frappe.get_all("Putaway Rule", + rules = frappe.get_all( + "Putaway Rule", fields=["name", "item_code", "stock_capacity", "priority", "warehouse"], filters=filters, - order_by="priority asc, capacity desc") + order_by="priority asc, capacity desc", + ) if not rules: return False, None @@ -179,10 +240,11 @@ def get_ordered_putaway_rules(item_code, company, source_warehouse=None): # then there is not enough space left in any rule return True, None - vacant_rules = sorted(vacant_rules, key = lambda i: (i['priority'], -i['free_space'])) + vacant_rules = sorted(vacant_rules, key=lambda i: (i["priority"], -i["free_space"])) return False, vacant_rules + def add_row(item, to_allocate, warehouse, updated_table, rule=None, serial_nos=None): new_updated_table_row = copy.deepcopy(item) new_updated_table_row.idx = 1 if not updated_table else cint(updated_table[-1].idx) + 1 @@ -191,7 +253,9 @@ def add_row(item, to_allocate, warehouse, updated_table, rule=None, serial_nos=N if item.doctype == "Stock Entry Detail": new_updated_table_row.t_warehouse = warehouse - new_updated_table_row.transfer_qty = flt(to_allocate) * flt(new_updated_table_row.conversion_factor) + new_updated_table_row.transfer_qty = flt(to_allocate) * flt( + new_updated_table_row.conversion_factor + ) else: new_updated_table_row.stock_qty = flt(to_allocate) * flt(new_updated_table_row.conversion_factor) new_updated_table_row.warehouse = warehouse @@ -206,6 +270,7 @@ def add_row(item, to_allocate, warehouse, updated_table, rule=None, serial_nos=N updated_table.append(new_updated_table_row) return updated_table + def show_unassigned_items_message(items_not_accomodated): msg = _("The following Items, having Putaway Rules, could not be accomodated:") + "
" formatted_item_rows = "" @@ -215,7 +280,9 @@ def show_unassigned_items_message(items_not_accomodated): formatted_item_rows += """
" + _("Please try again in an hour.") + frappe.throw(msg, title=_("Pending processing")) @frappe.whitelist() def restart_reposting(self): - self.set_status('Queued', write=False) + self.set_status("Queued", write=False) self.current_index = 0 self.distinct_item_and_warehouse = None self.items_to_be_repost = None + self.gl_reposting_index = 0 self.db_update() def deduplicate_similar_repost(self): - """ Deduplicate similar reposts based on item-warehouse-posting combination.""" + """Deduplicate similar reposts based on item-warehouse-posting combination.""" if self.based_on != "Item and Warehouse": return @@ -73,7 +103,8 @@ class RepostItemValuation(Document): "posting_time": self.posting_time, } - frappe.db.sql(""" + frappe.db.sql( + """ update `tabRepost Item Valuation` set status = 'Skipped' WHERE item_code = %(item_code)s @@ -84,9 +115,10 @@ class RepostItemValuation(Document): and status = 'Queued' and based_on = 'Item and Warehouse' """, - filters + filters, ) + def on_doctype_update(): frappe.db.add_index("Repost Item Valuation", ["warehouse", "item_code"], "item_warehouse") @@ -96,55 +128,106 @@ def repost(doc): if not frappe.db.exists("Repost Item Valuation", doc.name): return - doc.set_status('In Progress') - frappe.db.commit() + doc.set_status("In Progress") + if not frappe.flags.in_test: + frappe.db.commit() repost_sl_entries(doc) repost_gl_entries(doc) - doc.set_status('Completed') + doc.set_status("Completed") - except (Exception, JobTimeoutException): + except Exception as e: frappe.db.rollback() traceback = frappe.get_traceback() frappe.log_error(traceback) - message = frappe.message_log.pop() + message = frappe.message_log.pop() if frappe.message_log else "" if traceback: message += "
" + "Traceback:
" + traceback - frappe.db.set_value(doc.doctype, doc.name, 'error_log', message) + frappe.db.set_value(doc.doctype, doc.name, "error_log", message) - notify_error_to_stock_managers(doc, message) - doc.set_status('Failed') - raise + if not isinstance(e, RecoverableErrors): + notify_error_to_stock_managers(doc, message) + doc.set_status("Failed") finally: - frappe.db.commit() + if not frappe.flags.in_test: + frappe.db.commit() + def repost_sl_entries(doc): - if doc.based_on == 'Transaction': - repost_future_sle(doc=doc, voucher_type=doc.voucher_type, voucher_no=doc.voucher_no, - allow_negative_stock=doc.allow_negative_stock, via_landed_cost_voucher=doc.via_landed_cost_voucher) + if doc.based_on == "Transaction": + repost_future_sle( + doc=doc, + voucher_type=doc.voucher_type, + voucher_no=doc.voucher_no, + allow_negative_stock=doc.allow_negative_stock, + via_landed_cost_voucher=doc.via_landed_cost_voucher, + ) else: - repost_future_sle(args=[frappe._dict({ - "item_code": doc.item_code, - "warehouse": doc.warehouse, - "posting_date": doc.posting_date, - "posting_time": doc.posting_time - })], allow_negative_stock=doc.allow_negative_stock, via_landed_cost_voucher=doc.via_landed_cost_voucher) + repost_future_sle( + args=[ + frappe._dict( + { + "item_code": doc.item_code, + "warehouse": doc.warehouse, + "posting_date": doc.posting_date, + "posting_time": doc.posting_time, + } + ) + ], + allow_negative_stock=doc.allow_negative_stock, + via_landed_cost_voucher=doc.via_landed_cost_voucher, + doc=doc, + ) + def repost_gl_entries(doc): if not cint(erpnext.is_perpetual_inventory_enabled(doc.company)): return - if doc.based_on == 'Transaction': - ref_doc = frappe.get_doc(doc.voucher_type, doc.voucher_no) - items, warehouses = ref_doc.get_items_and_warehouses() - else: - items = [doc.item_code] - warehouses = [doc.warehouse] + # directly modified transactions + directly_dependent_transactions = _get_directly_dependent_vouchers(doc) + repost_affected_transaction = get_affected_transactions(doc) + repost_gle_for_stock_vouchers( + directly_dependent_transactions + list(repost_affected_transaction), + doc.posting_date, + doc.company, + repost_doc=doc, + ) + + +def _get_directly_dependent_vouchers(doc): + """Get stock vouchers that are directly affected by reposting + i.e. any one item-warehouse is present in the stock transaction""" + + items = set() + warehouses = set() + + if doc.based_on == "Transaction": + ref_doc = frappe.get_doc(doc.voucher_type, doc.voucher_no) + doc_items, doc_warehouses = ref_doc.get_items_and_warehouses() + items.update(doc_items) + warehouses.update(doc_warehouses) + + sles = get_items_to_be_repost(doc.voucher_type, doc.voucher_no) + sle_items = {sle.item_code for sle in sles} + sle_warehouses = {sle.warehouse for sle in sles} + items.update(sle_items) + warehouses.update(sle_warehouses) + else: + items.add(doc.item_code) + warehouses.add(doc.warehouse) + + affected_vouchers = get_future_stock_vouchers( + posting_date=doc.posting_date, + posting_time=doc.posting_time, + for_warehouses=list(warehouses), + for_items=list(items), + company=doc.company, + ) + return affected_vouchers - update_gl_entries_after(doc.posting_date, doc.posting_time, - warehouses, items, company=doc.company) def notify_error_to_stock_managers(doc, traceback): recipients = get_users_with_role("Stock Manager") @@ -152,22 +235,33 @@ def notify_error_to_stock_managers(doc, traceback): get_users_with_role("System Manager") subject = _("Error while reposting item valuation") - message = (_("Hi,") + "
" - + _("An error has been appeared while reposting item valuation via {0}") - .format(get_link_to_form(doc.doctype, doc.name)) + "
" - + _("Please check the error message and take necessary actions to fix the error and then restart the reposting again.") + message = ( + _("Hi,") + + "
" + + _("An error has been appeared while reposting item valuation via {0}").format( + get_link_to_form(doc.doctype, doc.name) + ) + + "
" + + _( + "Please check the error message and take necessary actions to fix the error and then restart the reposting again." + ) ) frappe.sendmail(recipients=recipients, subject=subject, message=message) + def repost_entries(): + """ + Reposts 'Repost Item Valuation' entries in queue. + Called hourly via hooks.py. + """ if not in_configured_timeslot(): return riv_entries = get_repost_item_valuation_entries() for row in riv_entries: - doc = frappe.get_doc('Repost Item Valuation', row.name) - if doc.status in ('Queued', 'In Progress'): + doc = frappe.get_doc("Repost Item Valuation", row.name) + if doc.status in ("Queued", "In Progress"): repost(doc) doc.deduplicate_similar_repost() @@ -175,14 +269,16 @@ def repost_entries(): if riv_entries: return - for d in frappe.get_all('Company', filters= {'enable_perpetual_inventory': 1}): - check_if_stock_and_account_balance_synced(today(), d.name) def get_repost_item_valuation_entries(): - return frappe.db.sql(""" SELECT name from `tabRepost Item Valuation` + return frappe.db.sql( + """ SELECT name from `tabRepost Item Valuation` WHERE status in ('Queued', 'In Progress') and creation <= %s and docstatus = 1 ORDER BY timestamp(posting_date, posting_time) asc, creation asc - """, now(), as_dict=1) + """, + now(), + as_dict=1, + ) def in_configured_timeslot(repost_settings=None, current_time=None): @@ -206,3 +302,9 @@ def in_configured_timeslot(repost_settings=None, current_time=None): return end_time >= now_time >= start_time else: return now_time >= start_time or now_time <= end_time + + +@frappe.whitelist() +def execute_repost_item_valuation(): + """Execute repost item valuation via scheduler.""" + frappe.get_doc("Scheduled Job Type", "repost_item_valuation.repost_entries").enqueue(force=True) diff --git a/erpnext/stock/doctype/repost_item_valuation/test_repost_item_valuation.py b/erpnext/stock/doctype/repost_item_valuation/test_repost_item_valuation.py index 78b432d564c..edd2553d5d1 100644 --- a/erpnext/stock/doctype/repost_item_valuation/test_repost_item_valuation.py +++ b/erpnext/stock/doctype/repost_item_valuation/test_repost_item_valuation.py @@ -1,20 +1,30 @@ # Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors # See license.txt -import unittest + +from unittest.mock import MagicMock, call import frappe +from frappe.tests.utils import FrappeTestCase from frappe.utils import nowdate +from frappe.utils.data import add_to_date, today +from erpnext.accounts.utils import repost_gle_for_stock_vouchers from erpnext.controllers.stock_controller import create_item_wise_repost_entries +from erpnext.stock.doctype.item.test_item import make_item from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import make_purchase_receipt from erpnext.stock.doctype.repost_item_valuation.repost_item_valuation import ( in_configured_timeslot, ) +from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry +from erpnext.stock.tests.test_utils import StockTestMixin from erpnext.stock.utils import PendingRepostingError -class TestRepostItemValuation(unittest.TestCase): +class TestRepostItemValuation(FrappeTestCase, StockTestMixin): + def tearDown(self): + frappe.flags.dont_execute_stock_reposts = False + def test_repost_time_slot(self): repost_settings = frappe.get_doc("Stock Reposting Settings") @@ -153,7 +163,7 @@ class TestRepostItemValuation(unittest.TestCase): posting_date=today, posting_time="00:01:00", ) - riv.flags.dont_run_in_test = True # keep it queued + riv.flags.dont_run_in_test = True # keep it queued riv.submit() stock_settings = frappe.get_doc("Stock Settings") @@ -162,3 +172,103 @@ class TestRepostItemValuation(unittest.TestCase): self.assertRaises(PendingRepostingError, stock_settings.save) riv.set_status("Skipped") + + def test_prevention_of_cancelled_transaction_riv(self): + frappe.flags.dont_execute_stock_reposts = True + + item = make_item() + warehouse = "_Test Warehouse - _TC" + old = make_stock_entry(item_code=item.name, to_warehouse=warehouse, qty=2, rate=5) + _new = make_stock_entry(item_code=item.name, to_warehouse=warehouse, qty=5, rate=10) + + old.cancel() + + riv = frappe.get_last_doc( + "Repost Item Valuation", {"voucher_type": old.doctype, "voucher_no": old.name} + ) + self.assertRaises(frappe.ValidationError, riv.cancel) + + riv.db_set("status", "Skipped") + riv.reload() + riv.cancel() # it should cancel now + + def test_queue_progress_serialization(self): + # Make sure set/tuple -> list behaviour is retained. + self.assertEqual( + [["a", "b"], ["c", "d"]], + sorted(frappe.parse_json(frappe.as_json(set([("a", "b"), ("c", "d")])))), + ) + + def test_gl_repost_progress(self): + from erpnext.accounts import utils + + # lower numbers to simplify test + orig_chunk_size = utils.GL_REPOSTING_CHUNK + utils.GL_REPOSTING_CHUNK = 1 + self.addCleanup(setattr, utils, "GL_REPOSTING_CHUNK", orig_chunk_size) + + doc = frappe.new_doc("Repost Item Valuation") + doc.db_set = MagicMock() + + vouchers = [] + company = "_Test Company with perpetual inventory" + posting_date = today() + + for _ in range(3): + se = make_stock_entry(company=company, qty=1, rate=2, target="Stores - TCP1") + vouchers.append((se.doctype, se.name)) + + repost_gle_for_stock_vouchers(stock_vouchers=vouchers, posting_date=posting_date, repost_doc=doc) + self.assertIn(call("gl_reposting_index", 1), doc.db_set.mock_calls) + doc.db_set.reset_mock() + + doc.gl_reposting_index = 1 + repost_gle_for_stock_vouchers(stock_vouchers=vouchers, posting_date=posting_date, repost_doc=doc) + + self.assertNotIn(call("gl_reposting_index", 1), doc.db_set.mock_calls) + + def test_gl_complete_gl_reposting(self): + from erpnext.accounts import utils + + # lower numbers to simplify test + orig_chunk_size = utils.GL_REPOSTING_CHUNK + utils.GL_REPOSTING_CHUNK = 2 + self.addCleanup(setattr, utils, "GL_REPOSTING_CHUNK", orig_chunk_size) + + item = self.make_item().name + + company = "_Test Company with perpetual inventory" + + for _ in range(10): + make_stock_entry(item=item, company=company, qty=1, rate=10, target="Stores - TCP1") + + # consume + consumption = make_stock_entry(item=item, company=company, qty=1, source="Stores - TCP1") + + self.assertGLEs( + consumption, + [{"credit": 10, "debit": 0}], + gle_filters={"account": "Stock In Hand - TCP1"}, + ) + + # backdated receipt + backdated_receipt = make_stock_entry( + item=item, + company=company, + qty=1, + rate=50, + target="Stores - TCP1", + posting_date=add_to_date(today(), days=-1), + ) + self.assertGLEs( + backdated_receipt, + [{"credit": 0, "debit": 50}], + gle_filters={"account": "Stock In Hand - TCP1"}, + ) + + # check that original consumption GLe is updated + self.assertGLEs( + consumption, + [{"credit": 50, "debit": 0}], + gle_filters={"account": "Stock In Hand - TCP1"}, + ) diff --git a/erpnext/stock/doctype/serial_no/serial_no.py b/erpnext/stock/doctype/serial_no/serial_no.py index b2321acf9e8..cfa5cee453a 100644 --- a/erpnext/stock/doctype/serial_no/serial_no.py +++ b/erpnext/stock/doctype/serial_no/serial_no.py @@ -3,28 +3,66 @@ import json +from typing import List, Optional, Union import frappe from frappe import ValidationError, _ from frappe.model.naming import make_autoname -from frappe.utils import add_days, cint, cstr, flt, get_link_to_form, getdate, nowdate -from six import string_types -from six.moves import map +from frappe.query_builder.functions import Coalesce +from frappe.utils import ( + add_days, + cint, + cstr, + flt, + get_link_to_form, + getdate, + nowdate, + safe_json_loads, +) from erpnext.controllers.stock_controller import StockController from erpnext.stock.get_item_details import get_reserved_qty_for_so -class SerialNoCannotCreateDirectError(ValidationError): pass -class SerialNoCannotCannotChangeError(ValidationError): pass -class SerialNoNotRequiredError(ValidationError): pass -class SerialNoRequiredError(ValidationError): pass -class SerialNoQtyError(ValidationError): pass -class SerialNoItemError(ValidationError): pass -class SerialNoWarehouseError(ValidationError): pass -class SerialNoBatchError(ValidationError): pass -class SerialNoNotExistsError(ValidationError): pass -class SerialNoDuplicateError(ValidationError): pass +class SerialNoCannotCreateDirectError(ValidationError): + pass + + +class SerialNoCannotCannotChangeError(ValidationError): + pass + + +class SerialNoNotRequiredError(ValidationError): + pass + + +class SerialNoRequiredError(ValidationError): + pass + + +class SerialNoQtyError(ValidationError): + pass + + +class SerialNoItemError(ValidationError): + pass + + +class SerialNoWarehouseError(ValidationError): + pass + + +class SerialNoBatchError(ValidationError): + pass + + +class SerialNoNotExistsError(ValidationError): + pass + + +class SerialNoDuplicateError(ValidationError): + pass + class SerialNo(StockController): def __init__(self, *args, **kwargs): @@ -33,7 +71,12 @@ class SerialNo(StockController): def validate(self): if self.get("__islocal") and self.warehouse and not self.via_stock_ledger: - frappe.throw(_("New Serial No cannot have Warehouse. Warehouse must be set by Stock Entry or Purchase Receipt"), SerialNoCannotCreateDirectError) + frappe.throw( + _( + "New Serial No cannot have Warehouse. Warehouse must be set by Stock Entry or Purchase Receipt" + ), + SerialNoCannotCreateDirectError, + ) self.set_maintenance_status() self.validate_warehouse() @@ -68,22 +111,21 @@ class SerialNo(StockController): def validate_warehouse(self): if not self.get("__islocal"): - item_code, warehouse = frappe.db.get_value("Serial No", - self.name, ["item_code", "warehouse"]) + item_code, warehouse = frappe.db.get_value("Serial No", self.name, ["item_code", "warehouse"]) if not self.via_stock_ledger and item_code != self.item_code: - frappe.throw(_("Item Code cannot be changed for Serial No."), - SerialNoCannotCannotChangeError) + frappe.throw(_("Item Code cannot be changed for Serial No."), SerialNoCannotCannotChangeError) if not self.via_stock_ledger and warehouse != self.warehouse: - frappe.throw(_("Warehouse cannot be changed for Serial No."), - SerialNoCannotCannotChangeError) + frappe.throw(_("Warehouse cannot be changed for Serial No."), SerialNoCannotCannotChangeError) def validate_item(self): """ - Validate whether serial no is required for this item + Validate whether serial no is required for this item """ item = frappe.get_cached_doc("Item", self.item_code) - if item.has_serial_no!=1: - frappe.throw(_("Item {0} is not setup for Serial Nos. Check Item master").format(self.item_code)) + if item.has_serial_no != 1: + frappe.throw( + _("Item {0} is not setup for Serial Nos. Check Item master").format(self.item_code) + ) self.item_group = item.item_group self.description = item.description @@ -99,17 +141,24 @@ class SerialNo(StockController): self.purchase_time = purchase_sle.posting_time self.purchase_rate = purchase_sle.incoming_rate if purchase_sle.voucher_type in ("Purchase Receipt", "Purchase Invoice"): - self.supplier, self.supplier_name = \ - frappe.db.get_value(purchase_sle.voucher_type, purchase_sle.voucher_no, - ["supplier", "supplier_name"]) + self.supplier, self.supplier_name = frappe.db.get_value( + purchase_sle.voucher_type, purchase_sle.voucher_no, ["supplier", "supplier_name"] + ) # If sales return entry - if self.purchase_document_type == 'Delivery Note': + if self.purchase_document_type == "Delivery Note": self.sales_invoice = None else: - for fieldname in ("purchase_document_type", "purchase_document_no", - "purchase_date", "purchase_time", "purchase_rate", "supplier", "supplier_name"): - self.set(fieldname, None) + for fieldname in ( + "purchase_document_type", + "purchase_document_no", + "purchase_date", + "purchase_time", + "purchase_rate", + "supplier", + "supplier_name", + ): + self.set(fieldname, None) def set_sales_details(self, delivery_sle): if delivery_sle: @@ -117,18 +166,25 @@ class SerialNo(StockController): self.delivery_document_no = delivery_sle.voucher_no self.delivery_date = delivery_sle.posting_date self.delivery_time = delivery_sle.posting_time - if delivery_sle.voucher_type in ("Delivery Note", "Sales Invoice"): - self.customer, self.customer_name = \ - frappe.db.get_value(delivery_sle.voucher_type, delivery_sle.voucher_no, - ["customer", "customer_name"]) + if delivery_sle.voucher_type in ("Delivery Note", "Sales Invoice"): + self.customer, self.customer_name = frappe.db.get_value( + delivery_sle.voucher_type, delivery_sle.voucher_no, ["customer", "customer_name"] + ) if self.warranty_period: - self.warranty_expiry_date = add_days(cstr(delivery_sle.posting_date), - cint(self.warranty_period)) + self.warranty_expiry_date = add_days( + cstr(delivery_sle.posting_date), cint(self.warranty_period) + ) else: - for fieldname in ("delivery_document_type", "delivery_document_no", - "delivery_date", "delivery_time", "customer", "customer_name", - "warranty_expiry_date"): - self.set(fieldname, None) + for fieldname in ( + "delivery_document_type", + "delivery_document_no", + "delivery_date", + "delivery_time", + "customer", + "customer_name", + "warranty_expiry_date", + ): + self.set(fieldname, None) def get_last_sle(self, serial_no=None): entries = {} @@ -150,7 +206,8 @@ class SerialNo(StockController): if not serial_no: serial_no = self.name - for sle in frappe.db.sql(""" + for sle in frappe.db.sql( + """ SELECT voucher_type, voucher_no, posting_date, posting_time, incoming_rate, actual_qty, serial_no FROM @@ -166,25 +223,30 @@ class SerialNo(StockController): ORDER BY posting_date desc, posting_time desc, creation desc""", ( - self.item_code, self.company, + self.item_code, + self.company, serial_no, - serial_no+'\n%', - '%\n'+serial_no, - '%\n'+serial_no+'\n%' + serial_no + "\n%", + "%\n" + serial_no, + "%\n" + serial_no + "\n%", ), - as_dict=1): - if serial_no.upper() in get_serial_nos(sle.serial_no): - if cint(sle.actual_qty) > 0: - sle_dict.setdefault("incoming", []).append(sle) - else: - sle_dict.setdefault("outgoing", []).append(sle) + as_dict=1, + ): + if serial_no.upper() in get_serial_nos(sle.serial_no): + if cint(sle.actual_qty) > 0: + sle_dict.setdefault("incoming", []).append(sle) + else: + sle_dict.setdefault("outgoing", []).append(sle) return sle_dict def on_trash(self): - sl_entries = frappe.db.sql("""select serial_no from `tabStock Ledger Entry` + sl_entries = frappe.db.sql( + """select serial_no from `tabStock Ledger Entry` where serial_no like %s and item_code=%s and is_cancelled=0""", - ("%%%s%%" % self.name, self.item_code), as_dict=True) + ("%%%s%%" % self.name, self.item_code), + as_dict=True, + ) # Find the exact match sle_exists = False @@ -194,7 +256,9 @@ class SerialNo(StockController): break if sle_exists: - frappe.throw(_("Cannot delete Serial No {0}, as it is used in stock transactions").format(self.name)) + frappe.throw( + _("Cannot delete Serial No {0}, as it is used in stock transactions").format(self.name) + ) def before_rename(self, old, new, merge=False): if merge: @@ -202,16 +266,24 @@ class SerialNo(StockController): def after_rename(self, old, new, merge=False): """rename serial_no text fields""" - for dt in frappe.db.sql("""select parent from tabDocField - where fieldname='serial_no' and fieldtype in ('Text', 'Small Text', 'Long Text')"""): + for dt in frappe.db.sql( + """select parent from tabDocField + where fieldname='serial_no' and fieldtype in ('Text', 'Small Text', 'Long Text')""" + ): - for item in frappe.db.sql("""select name, serial_no from `tab%s` - where serial_no like %s""" % (dt[0], frappe.db.escape('%' + old + '%'))): + for item in frappe.db.sql( + """select name, serial_no from `tab%s` + where serial_no like %s""" + % (dt[0], frappe.db.escape("%" + old + "%")) + ): - serial_nos = map(lambda i: new if i.upper()==old.upper() else i, item[1].split('\n')) - frappe.db.sql("""update `tab%s` set serial_no = %s - where name=%s""" % (dt[0], '%s', '%s'), - ('\n'.join(list(serial_nos)), item[0])) + serial_nos = map(lambda i: new if i.upper() == old.upper() else i, item[1].split("\n")) + frappe.db.sql( + """update `tab%s` set serial_no = %s + where name=%s""" + % (dt[0], "%s", "%s"), + ("\n".join(list(serial_nos)), item[0]), + ) def update_serial_no_reference(self, serial_no=None): last_sle = self.get_last_sle(serial_no) @@ -220,57 +292,95 @@ class SerialNo(StockController): self.set_maintenance_status() self.set_status() + def process_serial_no(sle): item_det = get_item_details(sle.item_code) validate_serial_no(sle, item_det) update_serial_nos(sle, item_det) + def validate_serial_no(sle, item_det): serial_nos = get_serial_nos(sle.serial_no) if sle.serial_no else [] validate_material_transfer_entry(sle) - if item_det.has_serial_no==0: + if item_det.has_serial_no == 0: if serial_nos: - frappe.throw(_("Item {0} is not setup for Serial Nos. Column must be blank").format(sle.item_code), - SerialNoNotRequiredError) + frappe.throw( + _("Item {0} is not setup for Serial Nos. Column must be blank").format(sle.item_code), + SerialNoNotRequiredError, + ) elif not sle.is_cancelled: if serial_nos: if cint(sle.actual_qty) != flt(sle.actual_qty): - frappe.throw(_("Serial No {0} quantity {1} cannot be a fraction").format(sle.item_code, sle.actual_qty)) + frappe.throw( + _("Serial No {0} quantity {1} cannot be a fraction").format(sle.item_code, sle.actual_qty) + ) if len(serial_nos) and len(serial_nos) != abs(cint(sle.actual_qty)): - frappe.throw(_("{0} Serial Numbers required for Item {1}. You have provided {2}.").format(abs(sle.actual_qty), sle.item_code, len(serial_nos)), - SerialNoQtyError) + frappe.throw( + _("{0} Serial Numbers required for Item {1}. You have provided {2}.").format( + abs(sle.actual_qty), sle.item_code, len(serial_nos) + ), + SerialNoQtyError, + ) if len(serial_nos) != len(set(serial_nos)): - frappe.throw(_("Duplicate Serial No entered for Item {0}").format(sle.item_code), SerialNoDuplicateError) + frappe.throw( + _("Duplicate Serial No entered for Item {0}").format(sle.item_code), SerialNoDuplicateError + ) for serial_no in serial_nos: if frappe.db.exists("Serial No", serial_no): - sr = frappe.db.get_value("Serial No", serial_no, ["name", "item_code", "batch_no", "sales_order", - "delivery_document_no", "delivery_document_type", "warehouse", "purchase_document_type", - "purchase_document_no", "company", "status"], as_dict=1) + sr = frappe.db.get_value( + "Serial No", + serial_no, + [ + "name", + "item_code", + "batch_no", + "sales_order", + "delivery_document_no", + "delivery_document_type", + "warehouse", + "purchase_document_type", + "purchase_document_no", + "company", + "status", + ], + as_dict=1, + ) - if sr.item_code!=sle.item_code: + if sr.item_code != sle.item_code: if not allow_serial_nos_with_different_item(serial_no, sle): - frappe.throw(_("Serial No {0} does not belong to Item {1}").format(serial_no, - sle.item_code), SerialNoItemError) + frappe.throw( + _("Serial No {0} does not belong to Item {1}").format(serial_no, sle.item_code), + SerialNoItemError, + ) if cint(sle.actual_qty) > 0 and has_serial_no_exists(sr, sle): doc_name = frappe.bold(get_link_to_form(sr.purchase_document_type, sr.purchase_document_no)) - frappe.throw(_("Serial No {0} has already been received in the {1} #{2}") - .format(frappe.bold(serial_no), sr.purchase_document_type, doc_name), SerialNoDuplicateError) + frappe.throw( + _("Serial No {0} has already been received in the {1} #{2}").format( + frappe.bold(serial_no), sr.purchase_document_type, doc_name + ), + SerialNoDuplicateError, + ) - if (sr.delivery_document_no and sle.voucher_type not in ['Stock Entry', 'Stock Reconciliation'] - and sle.voucher_type == sr.delivery_document_type): - return_against = frappe.db.get_value(sle.voucher_type, sle.voucher_no, 'return_against') + if ( + sr.delivery_document_no + and sle.voucher_type not in ["Stock Entry", "Stock Reconciliation"] + and sle.voucher_type == sr.delivery_document_type + ): + return_against = frappe.db.get_value(sle.voucher_type, sle.voucher_no, "return_against") if return_against and return_against != sr.delivery_document_no: frappe.throw(_("Serial no {0} has been already returned").format(sr.name)) if cint(sle.actual_qty) < 0: - if sr.warehouse!=sle.warehouse: - frappe.throw(_("Serial No {0} does not belong to Warehouse {1}").format(serial_no, - sle.warehouse), SerialNoWarehouseError) + if sr.warehouse != sle.warehouse: + frappe.throw( + _("Serial No {0} does not belong to Warehouse {1}").format(serial_no, sle.warehouse), + SerialNoWarehouseError, + ) if not sr.purchase_document_no: frappe.throw(_("Serial No {0} not in stock").format(serial_no), SerialNoNotExistsError) @@ -278,66 +388,100 @@ def validate_serial_no(sle, item_det): if sle.voucher_type in ("Delivery Note", "Sales Invoice"): if sr.batch_no and sr.batch_no != sle.batch_no: - frappe.throw(_("Serial No {0} does not belong to Batch {1}").format(serial_no, - sle.batch_no), SerialNoBatchError) + frappe.throw( + _("Serial No {0} does not belong to Batch {1}").format(serial_no, sle.batch_no), + SerialNoBatchError, + ) if not sle.is_cancelled and not sr.warehouse: - frappe.throw(_("Serial No {0} does not belong to any Warehouse") - .format(serial_no), SerialNoWarehouseError) + frappe.throw( + _("Serial No {0} does not belong to any Warehouse").format(serial_no), + SerialNoWarehouseError, + ) # if Sales Order reference in Serial No validate the Delivery Note or Invoice is against the same if sr.sales_order: if sle.voucher_type == "Sales Invoice": - if not frappe.db.exists("Sales Invoice Item", {"parent": sle.voucher_no, - "item_code": sle.item_code, "sales_order": sr.sales_order}): + if not frappe.db.exists( + "Sales Invoice Item", + {"parent": sle.voucher_no, "item_code": sle.item_code, "sales_order": sr.sales_order}, + ): frappe.throw( - _("Cannot deliver Serial No {0} of item {1} as it is reserved to fullfill Sales Order {2}") - .format(sr.name, sle.item_code, sr.sales_order) + _( + "Cannot deliver Serial No {0} of item {1} as it is reserved to fullfill Sales Order {2}" + ).format(sr.name, sle.item_code, sr.sales_order) ) elif sle.voucher_type == "Delivery Note": - if not frappe.db.exists("Delivery Note Item", {"parent": sle.voucher_no, - "item_code": sle.item_code, "against_sales_order": sr.sales_order}): - invoice = frappe.db.get_value("Delivery Note Item", {"parent": sle.voucher_no, - "item_code": sle.item_code}, "against_sales_invoice") - if not invoice or frappe.db.exists("Sales Invoice Item", - {"parent": invoice, "item_code": sle.item_code, - "sales_order": sr.sales_order}): + if not frappe.db.exists( + "Delivery Note Item", + { + "parent": sle.voucher_no, + "item_code": sle.item_code, + "against_sales_order": sr.sales_order, + }, + ): + invoice = frappe.db.get_value( + "Delivery Note Item", + {"parent": sle.voucher_no, "item_code": sle.item_code}, + "against_sales_invoice", + ) + if not invoice or frappe.db.exists( + "Sales Invoice Item", + {"parent": invoice, "item_code": sle.item_code, "sales_order": sr.sales_order}, + ): frappe.throw( - _("Cannot deliver Serial No {0} of item {1} as it is reserved to fullfill Sales Order {2}") - .format(sr.name, sle.item_code, sr.sales_order) + _( + "Cannot deliver Serial No {0} of item {1} as it is reserved to fullfill Sales Order {2}" + ).format(sr.name, sle.item_code, sr.sales_order) ) # if Sales Order reference in Delivery Note or Invoice validate SO reservations for item if sle.voucher_type == "Sales Invoice": - sales_order = frappe.db.get_value("Sales Invoice Item", {"parent": sle.voucher_no, - "item_code": sle.item_code}, "sales_order") + sales_order = frappe.db.get_value( + "Sales Invoice Item", + {"parent": sle.voucher_no, "item_code": sle.item_code}, + "sales_order", + ) if sales_order and get_reserved_qty_for_so(sales_order, sle.item_code): validate_so_serial_no(sr, sales_order) elif sle.voucher_type == "Delivery Note": - sales_order = frappe.get_value("Delivery Note Item", {"parent": sle.voucher_no, - "item_code": sle.item_code}, "against_sales_order") + sales_order = frappe.get_value( + "Delivery Note Item", + {"parent": sle.voucher_no, "item_code": sle.item_code}, + "against_sales_order", + ) if sales_order and get_reserved_qty_for_so(sales_order, sle.item_code): validate_so_serial_no(sr, sales_order) else: - sales_invoice = frappe.get_value("Delivery Note Item", {"parent": sle.voucher_no, - "item_code": sle.item_code}, "against_sales_invoice") + sales_invoice = frappe.get_value( + "Delivery Note Item", + {"parent": sle.voucher_no, "item_code": sle.item_code}, + "against_sales_invoice", + ) if sales_invoice: - sales_order = frappe.db.get_value("Sales Invoice Item", { - "parent": sales_invoice, "item_code": sle.item_code}, "sales_order") + sales_order = frappe.db.get_value( + "Sales Invoice Item", + {"parent": sales_invoice, "item_code": sle.item_code}, + "sales_order", + ) if sales_order and get_reserved_qty_for_so(sales_order, sle.item_code): validate_so_serial_no(sr, sales_order) elif cint(sle.actual_qty) < 0: # transfer out frappe.throw(_("Serial No {0} not in stock").format(serial_no), SerialNoNotExistsError) elif cint(sle.actual_qty) < 0 or not item_det.serial_no_series: - frappe.throw(_("Serial Nos Required for Serialized Item {0}").format(sle.item_code), - SerialNoRequiredError) + frappe.throw( + _("Serial Nos Required for Serialized Item {0}").format(sle.item_code), SerialNoRequiredError + ) elif serial_nos: # SLE is being cancelled and has serial nos for serial_no in serial_nos: check_serial_no_validity_on_cancel(serial_no, sle) + def check_serial_no_validity_on_cancel(serial_no, sle): - sr = frappe.db.get_value("Serial No", serial_no, ["name", "warehouse", "company", "status"], as_dict=1) + sr = frappe.db.get_value( + "Serial No", serial_no, ["name", "warehouse", "company", "status"], as_dict=1 + ) sr_link = frappe.utils.get_link_to_form("Serial No", serial_no) doc_link = frappe.utils.get_link_to_form(sle.voucher_type, sle.voucher_no) actual_qty = cint(sle.actual_qty) @@ -347,57 +491,65 @@ def check_serial_no_validity_on_cancel(serial_no, sle): if sr and (actual_qty < 0 or is_stock_reco) and (sr.warehouse and sr.warehouse != sle.warehouse): # receipt(inward) is being cancelled msg = _("Cannot cancel {0} {1} as Serial No {2} does not belong to the warehouse {3}").format( - sle.voucher_type, doc_link, sr_link, frappe.bold(sle.warehouse)) + sle.voucher_type, doc_link, sr_link, frappe.bold(sle.warehouse) + ) elif sr and actual_qty > 0 and not is_stock_reco: # delivery is being cancelled, check for warehouse. if sr.warehouse: # serial no is active in another warehouse/company. msg = _("Cannot cancel {0} {1} as Serial No {2} is active in warehouse {3}").format( - sle.voucher_type, doc_link, sr_link, frappe.bold(sr.warehouse)) + sle.voucher_type, doc_link, sr_link, frappe.bold(sr.warehouse) + ) elif sr.company != sle.company and sr.status == "Delivered": # serial no is inactive (allowed) or delivered from another company (block). msg = _("Cannot cancel {0} {1} as Serial No {2} does not belong to the company {3}").format( - sle.voucher_type, doc_link, sr_link, frappe.bold(sle.company)) + sle.voucher_type, doc_link, sr_link, frappe.bold(sle.company) + ) if msg: frappe.throw(msg, title=_("Cannot cancel")) -def validate_material_transfer_entry(sle_doc): - sle_doc.update({ - "skip_update_serial_no": False, - "skip_serial_no_validaiton": False - }) - if (sle_doc.voucher_type == "Stock Entry" and not sle_doc.is_cancelled and - frappe.get_cached_value("Stock Entry", sle_doc.voucher_no, "purpose") == "Material Transfer"): +def validate_material_transfer_entry(sle_doc): + sle_doc.update({"skip_update_serial_no": False, "skip_serial_no_validaiton": False}) + + if ( + sle_doc.voucher_type == "Stock Entry" + and not sle_doc.is_cancelled + and frappe.get_cached_value("Stock Entry", sle_doc.voucher_no, "purpose") == "Material Transfer" + ): if sle_doc.actual_qty < 0: sle_doc.skip_update_serial_no = True else: sle_doc.skip_serial_no_validaiton = True -def validate_so_serial_no(sr, sales_order): - if not sr.sales_order or sr.sales_order!= sales_order: - msg = (_("Sales Order {0} has reservation for the item {1}, you can only deliver reserved {1} against {0}.") - .format(sales_order, sr.item_code)) - frappe.throw(_("""{0} Serial No {1} cannot be delivered""") - .format(msg, sr.name)) +def validate_so_serial_no(sr, sales_order): + if not sr.sales_order or sr.sales_order != sales_order: + msg = _( + "Sales Order {0} has reservation for the item {1}, you can only deliver reserved {1} against {0}." + ).format(sales_order, sr.item_code) + + frappe.throw(_("""{0} Serial No {1} cannot be delivered""").format(msg, sr.name)) + def has_serial_no_exists(sn, sle): - if (sn.warehouse and not sle.skip_serial_no_validaiton - and sle.voucher_type != 'Stock Reconciliation'): + if ( + sn.warehouse and not sle.skip_serial_no_validaiton and sle.voucher_type != "Stock Reconciliation" + ): return True if sn.company != sle.company: return False + def allow_serial_nos_with_different_item(sle_serial_no, sle): """ - Allows same serial nos for raw materials and finished goods - in Manufacture / Repack type Stock Entry + Allows same serial nos for raw materials and finished goods + in Manufacture / Repack type Stock Entry """ allow_serial_nos = False - if sle.voucher_type=="Stock Entry" and cint(sle.actual_qty) > 0: + if sle.voucher_type == "Stock Entry" and cint(sle.actual_qty) > 0: stock_entry = frappe.get_cached_doc("Stock Entry", sle.voucher_no) if stock_entry.purpose in ("Repack", "Manufacture"): for d in stock_entry.get("items"): @@ -408,33 +560,49 @@ def allow_serial_nos_with_different_item(sle_serial_no, sle): return allow_serial_nos + def update_serial_nos(sle, item_det): - if sle.skip_update_serial_no: return - if not sle.is_cancelled and not sle.serial_no and cint(sle.actual_qty) > 0 \ - and item_det.has_serial_no == 1 and item_det.serial_no_series: + if sle.skip_update_serial_no: + return + if ( + not sle.is_cancelled + and not sle.serial_no + and cint(sle.actual_qty) > 0 + and item_det.has_serial_no == 1 + and item_det.serial_no_series + ): serial_nos = get_auto_serial_nos(item_det.serial_no_series, sle.actual_qty) - frappe.db.set(sle, "serial_no", serial_nos) + sle.db_set("serial_no", serial_nos) validate_serial_no(sle, item_det) if sle.serial_no: auto_make_serial_nos(sle) + def get_auto_serial_nos(serial_no_series, qty): serial_nos = [] for i in range(cint(qty)): - serial_nos.append(make_autoname(serial_no_series, "Serial No")) + serial_nos.append(get_new_serial_number(serial_no_series)) return "\n".join(serial_nos) + +def get_new_serial_number(series): + sr_no = make_autoname(series, "Serial No") + if frappe.db.exists("Serial No", sr_no): + sr_no = get_new_serial_number(series) + return sr_no + + def auto_make_serial_nos(args): - serial_nos = get_serial_nos(args.get('serial_no')) + serial_nos = get_serial_nos(args.get("serial_no")) created_numbers = [] - voucher_type = args.get('voucher_type') - item_code = args.get('item_code') + voucher_type = args.get("voucher_type") + item_code = args.get("item_code") for serial_no in serial_nos: is_new = False if frappe.db.exists("Serial No", serial_no): sr = frappe.get_cached_doc("Serial No", serial_no) - elif args.get('actual_qty', 0) > 0: + elif args.get("actual_qty", 0) > 0: sr = frappe.new_doc("Serial No") is_new = True @@ -442,7 +610,7 @@ def auto_make_serial_nos(args): if is_new: created_numbers.append(sr.name) - form_links = list(map(lambda d: get_link_to_form('Serial No', d), created_numbers)) + form_links = list(map(lambda d: get_link_to_form("Serial No", d), created_numbers)) # Setting up tranlated title field for all cases singular_title = _("Serial Number Created") @@ -454,29 +622,49 @@ def auto_make_serial_nos(args): if len(form_links) == 1: frappe.msgprint(_("Serial No {0} Created").format(form_links[0]), singular_title) elif len(form_links) > 0: - message = _("The following serial numbers were created:
{0}").format(get_items_html(form_links, item_code)) + message = _("The following serial numbers were created:
{0}").format( + get_items_html(form_links, item_code) + ) frappe.msgprint(message, multiple_title) + def get_items_html(serial_nos, item_code): - body = ', '.join(serial_nos) - return '''
+ body = ", ".join(serial_nos)
+ return """
{0}: {1} Serial Numbers
{2}
- '''.format(item_code, len(serial_nos), body)
+ """.format(
+ item_code, len(serial_nos), body
+ )
def get_item_details(item_code):
- return frappe.db.sql("""select name, has_batch_no, docstatus,
+ return frappe.db.sql(
+ """select name, has_batch_no, docstatus,
is_stock_item, has_serial_no, serial_no_series
- from tabItem where name=%s""", item_code, as_dict=True)[0]
+ from tabItem where name=%s""",
+ item_code,
+ as_dict=True,
+ )[0]
+
def get_serial_nos(serial_no):
if isinstance(serial_no, list):
return serial_no
- return [s.strip() for s in cstr(serial_no).strip().upper().replace(',', '\n').split('\n')
- if s.strip()]
+ return [
+ s.strip() for s in cstr(serial_no).strip().upper().replace(",", "\n").split("\n") if s.strip()
+ ]
+
+
+def clean_serial_no_string(serial_no: str) -> str:
+ if not serial_no:
+ return ""
+
+ serial_no_list = get_serial_nos(serial_no)
+ return "\n".join(serial_no_list)
+
def update_args_for_serial_no(serial_no_doc, serial_no, args, is_new=False):
for field in ["item_code", "work_order", "company", "batch_no", "supplier", "location"]:
@@ -484,14 +672,16 @@ def update_args_for_serial_no(serial_no_doc, serial_no, args, is_new=False):
serial_no_doc.set(field, args.get(field))
serial_no_doc.via_stock_ledger = args.get("via_stock_ledger") or True
- serial_no_doc.warehouse = (args.get("warehouse")
- if args.get("actual_qty", 0) > 0 else None)
+ serial_no_doc.warehouse = args.get("warehouse") if args.get("actual_qty", 0) > 0 else None
if is_new:
serial_no_doc.serial_no = serial_no
- if (serial_no_doc.sales_order and args.get("voucher_type") == "Stock Entry"
- and not args.get("actual_qty", 0) > 0):
+ if (
+ serial_no_doc.sales_order
+ and args.get("voucher_type") == "Stock Entry"
+ and not args.get("actual_qty", 0) > 0
+ ):
serial_no_doc.sales_order = None
serial_no_doc.validate_item()
@@ -504,146 +694,224 @@ def update_args_for_serial_no(serial_no_doc, serial_no, args, is_new=False):
return serial_no_doc
-def update_serial_nos_after_submit(controller, parentfield):
- stock_ledger_entries = frappe.db.sql("""select voucher_detail_no, serial_no, actual_qty, warehouse
- from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s""",
- (controller.doctype, controller.name), as_dict=True)
- if not stock_ledger_entries: return
+def update_serial_nos_after_submit(controller, parentfield):
+ stock_ledger_entries = frappe.db.sql(
+ """select voucher_detail_no, serial_no, actual_qty, warehouse
+ from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s""",
+ (controller.doctype, controller.name),
+ as_dict=True,
+ )
+
+ if not stock_ledger_entries:
+ return
for d in controller.get(parentfield):
if d.serial_no:
continue
- update_rejected_serial_nos = True if (controller.doctype in ("Purchase Receipt", "Purchase Invoice")
- and d.rejected_qty) else False
+ update_rejected_serial_nos = (
+ True
+ if (controller.doctype in ("Purchase Receipt", "Purchase Invoice") and d.rejected_qty)
+ else False
+ )
accepted_serial_nos_updated = False
if controller.doctype == "Stock Entry":
warehouse = d.t_warehouse
qty = d.transfer_qty
+ elif controller.doctype in ("Sales Invoice", "Delivery Note"):
+ warehouse = d.warehouse
+ qty = d.stock_qty
else:
warehouse = d.warehouse
- qty = (d.qty if controller.doctype == "Stock Reconciliation"
- else d.stock_qty)
+ qty = d.qty if controller.doctype == "Stock Reconciliation" else d.stock_qty
for sle in stock_ledger_entries:
- if sle.voucher_detail_no==d.name:
- if not accepted_serial_nos_updated and qty and abs(sle.actual_qty)==qty \
- and sle.warehouse == warehouse and sle.serial_no != d.serial_no:
- d.serial_no = sle.serial_no
- frappe.db.set_value(d.doctype, d.name, "serial_no", sle.serial_no)
- accepted_serial_nos_updated = True
- if not update_rejected_serial_nos:
- break
- elif update_rejected_serial_nos and abs(sle.actual_qty)==d.rejected_qty \
- and sle.warehouse == d.rejected_warehouse and sle.serial_no != d.rejected_serial_no:
- d.rejected_serial_no = sle.serial_no
- frappe.db.set_value(d.doctype, d.name, "rejected_serial_no", sle.serial_no)
- update_rejected_serial_nos = False
- if accepted_serial_nos_updated:
- break
+ if sle.voucher_detail_no == d.name:
+ if (
+ not accepted_serial_nos_updated
+ and qty
+ and abs(sle.actual_qty) == abs(qty)
+ and sle.warehouse == warehouse
+ and sle.serial_no != d.serial_no
+ ):
+ d.serial_no = sle.serial_no
+ frappe.db.set_value(d.doctype, d.name, "serial_no", sle.serial_no)
+ accepted_serial_nos_updated = True
+ if not update_rejected_serial_nos:
+ break
+ elif (
+ update_rejected_serial_nos
+ and abs(sle.actual_qty) == d.rejected_qty
+ and sle.warehouse == d.rejected_warehouse
+ and sle.serial_no != d.rejected_serial_no
+ ):
+ d.rejected_serial_no = sle.serial_no
+ frappe.db.set_value(d.doctype, d.name, "rejected_serial_no", sle.serial_no)
+ update_rejected_serial_nos = False
+ if accepted_serial_nos_updated:
+ break
+
def update_maintenance_status():
- serial_nos = frappe.db.sql('''select name from `tabSerial No` where (amc_expiry_date<%s or
- warranty_expiry_date<%s) and maintenance_status not in ('Out of Warranty', 'Out of AMC')''',
- (nowdate(), nowdate()))
+ serial_nos = frappe.db.sql(
+ """select name from `tabSerial No` where (amc_expiry_date<%s or
+ warranty_expiry_date<%s) and maintenance_status not in ('Out of Warranty', 'Out of AMC')""",
+ (nowdate(), nowdate()),
+ )
for serial_no in serial_nos:
doc = frappe.get_doc("Serial No", serial_no[0])
doc.set_maintenance_status()
- frappe.db.set_value('Serial No', doc.name, 'maintenance_status', doc.maintenance_status)
+ frappe.db.set_value("Serial No", doc.name, "maintenance_status", doc.maintenance_status)
+
def get_delivery_note_serial_no(item_code, qty, delivery_note):
- serial_nos = ''
- dn_serial_nos = frappe.db.sql_list(""" select name from `tabSerial No`
+ serial_nos = ""
+ dn_serial_nos = frappe.db.sql_list(
+ """ select name from `tabSerial No`
where item_code = %(item_code)s and delivery_document_no = %(delivery_note)s
- and sales_invoice is null limit {0}""".format(cint(qty)), {
- 'item_code': item_code,
- 'delivery_note': delivery_note
- })
+ and sales_invoice is null limit {0}""".format(
+ cint(qty)
+ ),
+ {"item_code": item_code, "delivery_note": delivery_note},
+ )
- if dn_serial_nos and len(dn_serial_nos)>0:
- serial_nos = '\n'.join(dn_serial_nos)
+ if dn_serial_nos and len(dn_serial_nos) > 0:
+ serial_nos = "\n".join(dn_serial_nos)
return serial_nos
+
@frappe.whitelist()
-def auto_fetch_serial_number(qty, item_code, warehouse, posting_date=None, batch_nos=None, for_doctype=None):
- filters = { "item_code": item_code, "warehouse": warehouse }
+def auto_fetch_serial_number(
+ qty: float,
+ item_code: str,
+ warehouse: str,
+ posting_date: Optional[str] = None,
+ batch_nos: Optional[Union[str, List[str]]] = None,
+ for_doctype: Optional[str] = None,
+ exclude_sr_nos: Optional[List[str]] = None,
+) -> List[str]:
+
+ filters = frappe._dict({"item_code": item_code, "warehouse": warehouse})
+
+ if exclude_sr_nos is None:
+ exclude_sr_nos = []
+ else:
+ exclude_sr_nos = safe_json_loads(exclude_sr_nos)
+ exclude_sr_nos = get_serial_nos(clean_serial_no_string("\n".join(exclude_sr_nos)))
if batch_nos:
- try:
- filters["batch_no"] = json.loads(batch_nos) if (type(json.loads(batch_nos)) == list) else [json.loads(batch_nos)]
- except Exception:
- filters["batch_no"] = [batch_nos]
+ batch_nos_list = safe_json_loads(batch_nos)
+ if isinstance(batch_nos_list, list):
+ filters.batch_no = batch_nos_list
+ else:
+ filters.batch_no = [batch_nos]
if posting_date:
- filters["expiry_date"] = posting_date
+ filters.expiry_date = posting_date
serial_numbers = []
- if for_doctype == 'POS Invoice':
- reserved_sr_nos = get_pos_reserved_serial_nos(filters)
- serial_numbers = fetch_serial_numbers(filters, qty, do_not_include=reserved_sr_nos)
- else:
- serial_numbers = fetch_serial_numbers(filters, qty)
+ if for_doctype == "POS Invoice":
+ exclude_sr_nos.extend(get_pos_reserved_serial_nos(filters))
+
+ serial_numbers = fetch_serial_numbers(filters, qty, do_not_include=exclude_sr_nos)
+
+ return sorted([d.get("name") for d in serial_numbers])
+
+
+def get_delivered_serial_nos(serial_nos):
+ """
+ Returns serial numbers that delivered from the list of serial numbers
+ """
+ from frappe.query_builder.functions import Coalesce
+
+ SerialNo = frappe.qb.DocType("Serial No")
+ serial_nos = get_serial_nos(serial_nos)
+ query = (
+ frappe.qb.select(SerialNo.name)
+ .from_(SerialNo)
+ .where((SerialNo.name.isin(serial_nos)) & (Coalesce(SerialNo.delivery_document_type, "") != ""))
+ )
+
+ result = query.run()
+ if result and len(result) > 0:
+ delivered_serial_nos = [row[0] for row in result]
+ return delivered_serial_nos
- return [d.get('name') for d in serial_numbers]
@frappe.whitelist()
def get_pos_reserved_serial_nos(filters):
- if isinstance(filters, string_types):
+ if isinstance(filters, str):
filters = json.loads(filters)
- pos_transacted_sr_nos = frappe.db.sql("""select item.serial_no as serial_no
- from `tabPOS Invoice` p, `tabPOS Invoice Item` item
- where p.name = item.parent
- and p.consolidated_invoice is NULL
- and p.docstatus = 1
- and item.docstatus = 1
- and item.item_code = %(item_code)s
- and item.warehouse = %(warehouse)s
- and item.serial_no is NOT NULL and item.serial_no != ''
- """, filters, as_dict=1)
+ POSInvoice = frappe.qb.DocType("POS Invoice")
+ POSInvoiceItem = frappe.qb.DocType("POS Invoice Item")
+ query = (
+ frappe.qb.from_(POSInvoice)
+ .from_(POSInvoiceItem)
+ .select(POSInvoice.is_return, POSInvoiceItem.serial_no)
+ .where(
+ (POSInvoice.name == POSInvoiceItem.parent)
+ & (POSInvoice.docstatus == 1)
+ & (POSInvoiceItem.docstatus == 1)
+ & (POSInvoiceItem.item_code == filters.get("item_code"))
+ & (POSInvoiceItem.warehouse == filters.get("warehouse"))
+ & (POSInvoiceItem.serial_no.isnotnull())
+ & (POSInvoiceItem.serial_no != "")
+ )
+ )
+
+ pos_transacted_sr_nos = query.run(as_dict=True)
reserved_sr_nos = []
+ returned_sr_nos = []
for d in pos_transacted_sr_nos:
- reserved_sr_nos += get_serial_nos(d.serial_no)
+ if d.is_return == 0:
+ reserved_sr_nos += get_serial_nos(d.serial_no)
+ elif d.is_return == 1:
+ returned_sr_nos += get_serial_nos(d.serial_no)
+
+ for sr_no in returned_sr_nos:
+ reserved_sr_nos.remove(sr_no)
return reserved_sr_nos
+
def fetch_serial_numbers(filters, qty, do_not_include=None):
if do_not_include is None:
do_not_include = []
- batch_join_selection = ""
- batch_no_condition = ""
+
batch_nos = filters.get("batch_no")
expiry_date = filters.get("expiry_date")
+ serial_no = frappe.qb.DocType("Serial No")
+
+ query = (
+ frappe.qb.from_(serial_no)
+ .select(serial_no.name)
+ .where(
+ (serial_no.item_code == filters["item_code"])
+ & (serial_no.warehouse == filters["warehouse"])
+ & (Coalesce(serial_no.sales_invoice, "") == "")
+ & (Coalesce(serial_no.delivery_document_no, "") == "")
+ )
+ .orderby(serial_no.creation)
+ .limit(qty or 1)
+ )
+
+ if do_not_include:
+ query = query.where(serial_no.name.notin(do_not_include))
+
if batch_nos:
- batch_no_condition = """and sr.batch_no in ({}) """.format(', '.join("'%s'" % d for d in batch_nos))
+ query = query.where(serial_no.batch_no.isin(batch_nos))
if expiry_date:
- batch_join_selection = "LEFT JOIN `tabBatch` batch on sr.batch_no = batch.name "
- expiry_date_cond = "AND ifnull(batch.expiry_date, '2500-12-31') >= %(expiry_date)s "
- batch_no_condition += expiry_date_cond
-
- excluded_sr_nos = ", ".join(["" + frappe.db.escape(sr) + "" for sr in do_not_include]) or "''"
- serial_numbers = frappe.db.sql("""
- SELECT sr.name FROM `tabSerial No` sr {batch_join_selection}
- WHERE
- sr.name not in ({excluded_sr_nos}) AND
- sr.item_code = %(item_code)s AND
- sr.warehouse = %(warehouse)s AND
- ifnull(sr.sales_invoice,'') = '' AND
- ifnull(sr.delivery_document_no, '') = ''
- {batch_no_condition}
- ORDER BY
- sr.creation
- LIMIT
- {qty}
- """.format(
- excluded_sr_nos=excluded_sr_nos,
- qty=qty or 1,
- batch_join_selection=batch_join_selection,
- batch_no_condition=batch_no_condition
- ), filters, as_dict=1)
+ batch = frappe.qb.DocType("Batch")
+ query = (
+ query.left_join(batch)
+ .on(serial_no.batch_no == batch.name)
+ .where(Coalesce(batch.expiry_date, "4000-12-31") >= expiry_date)
+ )
+ serial_numbers = query.run(as_dict=True)
return serial_numbers
diff --git a/erpnext/stock/doctype/serial_no/test_serial_no.py b/erpnext/stock/doctype/serial_no/test_serial_no.py
index 99000d12016..68623fba11e 100644
--- a/erpnext/stock/doctype/serial_no/test_serial_no.py
+++ b/erpnext/stock/doctype/serial_no/test_serial_no.py
@@ -6,21 +6,25 @@
import frappe
+from frappe.tests.utils import FrappeTestCase
from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note
+from erpnext.stock.doctype.item.test_item import make_item
from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import make_purchase_receipt
+from erpnext.stock.doctype.serial_no.serial_no import *
from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
+from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry
from erpnext.stock.doctype.stock_entry.test_stock_entry import make_serialized_item
from erpnext.stock.doctype.warehouse.test_warehouse import create_warehouse
test_dependencies = ["Item"]
-test_records = frappe.get_test_records('Serial No')
-
-from erpnext.stock.doctype.serial_no.serial_no import *
-from erpnext.tests.utils import ERPNextTestCase
+test_records = frappe.get_test_records("Serial No")
-class TestSerialNo(ERPNextTestCase):
+class TestSerialNo(FrappeTestCase):
+ def tearDown(self):
+ frappe.db.rollback()
+
def test_cannot_create_direct(self):
frappe.delete_doc_if_exists("Serial No", "_TCSER0001")
@@ -42,7 +46,9 @@ class TestSerialNo(ERPNextTestCase):
se = make_serialized_item(target_warehouse="_Test Warehouse - _TC")
serial_nos = get_serial_nos(se.get("items")[0].serial_no)
- dn = create_delivery_note(item_code="_Test Serialized Item With Series", qty=1, serial_no=serial_nos[0])
+ dn = create_delivery_note(
+ item_code="_Test Serialized Item With Series", qty=1, serial_no=serial_nos[0]
+ )
serial_no = frappe.get_doc("Serial No", serial_nos[0])
@@ -54,8 +60,13 @@ class TestSerialNo(ERPNextTestCase):
self.assertEqual(serial_no.delivery_document_no, dn.name)
wh = create_warehouse("_Test Warehouse", company="_Test Company 1")
- pr = make_purchase_receipt(item_code="_Test Serialized Item With Series", qty=1, serial_no=serial_nos[0],
- company="_Test Company 1", warehouse=wh)
+ pr = make_purchase_receipt(
+ item_code="_Test Serialized Item With Series",
+ qty=1,
+ serial_no=serial_nos[0],
+ company="_Test Company 1",
+ warehouse=wh,
+ )
serial_no.reload()
@@ -68,9 +79,9 @@ class TestSerialNo(ERPNextTestCase):
def test_inter_company_transfer_intermediate_cancellation(self):
"""
- Receive into and Deliver Serial No from one company.
- Then Receive into and Deliver from second company.
- Try to cancel intermediate receipts/deliveries to test if it is blocked.
+ Receive into and Deliver Serial No from one company.
+ Then Receive into and Deliver from second company.
+ Try to cancel intermediate receipts/deliveries to test if it is blocked.
"""
se = make_serialized_item(target_warehouse="_Test Warehouse - _TC")
serial_nos = get_serial_nos(se.get("items")[0].serial_no)
@@ -83,8 +94,9 @@ class TestSerialNo(ERPNextTestCase):
self.assertEqual(sn_doc.warehouse, "_Test Warehouse - _TC")
self.assertEqual(sn_doc.purchase_document_no, se.name)
- dn = create_delivery_note(item_code="_Test Serialized Item With Series",
- qty=1, serial_no=serial_nos[0])
+ dn = create_delivery_note(
+ item_code="_Test Serialized Item With Series", qty=1, serial_no=serial_nos[0]
+ )
sn_doc.reload()
# check Serial No details after delivery from **first** company
self.assertEqual(sn_doc.status, "Delivered")
@@ -98,8 +110,13 @@ class TestSerialNo(ERPNextTestCase):
# receive serial no in second company
wh = create_warehouse("_Test Warehouse", company="_Test Company 1")
- pr = make_purchase_receipt(item_code="_Test Serialized Item With Series",
- qty=1, serial_no=serial_nos[0], company="_Test Company 1", warehouse=wh)
+ pr = make_purchase_receipt(
+ item_code="_Test Serialized Item With Series",
+ qty=1,
+ serial_no=serial_nos[0],
+ company="_Test Company 1",
+ warehouse=wh,
+ )
sn_doc.reload()
self.assertEqual(sn_doc.warehouse, wh)
@@ -108,8 +125,13 @@ class TestSerialNo(ERPNextTestCase):
self.assertRaises(frappe.ValidationError, dn.cancel)
# deliver from second company
- dn_2 = create_delivery_note(item_code="_Test Serialized Item With Series",
- qty=1, serial_no=serial_nos[0], company="_Test Company 1", warehouse=wh)
+ dn_2 = create_delivery_note(
+ item_code="_Test Serialized Item With Series",
+ qty=1,
+ serial_no=serial_nos[0],
+ company="_Test Company 1",
+ warehouse=wh,
+ )
sn_doc.reload()
# check Serial No details after delivery from **second** company
@@ -125,9 +147,9 @@ class TestSerialNo(ERPNextTestCase):
def test_inter_company_transfer_fallback_on_cancel(self):
"""
- Test Serial No state changes on cancellation.
- If Delivery cancelled, it should fall back on last Receipt in the same company.
- If Receipt is cancelled, it should be Inactive in the same company.
+ Test Serial No state changes on cancellation.
+ If Delivery cancelled, it should fall back on last Receipt in the same company.
+ If Receipt is cancelled, it should be Inactive in the same company.
"""
# Receipt in **first** company
se = make_serialized_item(target_warehouse="_Test Warehouse - _TC")
@@ -135,17 +157,28 @@ class TestSerialNo(ERPNextTestCase):
sn_doc = frappe.get_doc("Serial No", serial_nos[0])
# Delivery from first company
- dn = create_delivery_note(item_code="_Test Serialized Item With Series",
- qty=1, serial_no=serial_nos[0])
+ dn = create_delivery_note(
+ item_code="_Test Serialized Item With Series", qty=1, serial_no=serial_nos[0]
+ )
# Receipt in **second** company
wh = create_warehouse("_Test Warehouse", company="_Test Company 1")
- pr = make_purchase_receipt(item_code="_Test Serialized Item With Series",
- qty=1, serial_no=serial_nos[0], company="_Test Company 1", warehouse=wh)
+ pr = make_purchase_receipt(
+ item_code="_Test Serialized Item With Series",
+ qty=1,
+ serial_no=serial_nos[0],
+ company="_Test Company 1",
+ warehouse=wh,
+ )
# Delivery from second company
- dn_2 = create_delivery_note(item_code="_Test Serialized Item With Series",
- qty=1, serial_no=serial_nos[0], company="_Test Company 1", warehouse=wh)
+ dn_2 = create_delivery_note(
+ item_code="_Test Serialized Item With Series",
+ qty=1,
+ serial_no=serial_nos[0],
+ company="_Test Company 1",
+ warehouse=wh,
+ )
sn_doc.reload()
self.assertEqual(sn_doc.status, "Delivered")
@@ -176,10 +209,27 @@ class TestSerialNo(ERPNextTestCase):
self.assertEqual(sn_doc.warehouse, "_Test Warehouse - _TC")
self.assertEqual(sn_doc.purchase_document_no, se.name)
+ def test_auto_creation_of_serial_no(self):
+ """
+ Test if auto created Serial No excludes existing serial numbers
+ """
+ item_code = make_item(
+ "_Test Auto Serial Item ", {"has_serial_no": 1, "serial_no_series": "XYZ.###"}
+ ).item_code
+
+ # Reserve XYZ005
+ pr_1 = make_purchase_receipt(item_code=item_code, qty=1, serial_no="XYZ005")
+ # XYZ005 is already used and will throw an error if used again
+ pr_2 = make_purchase_receipt(item_code=item_code, qty=10)
+
+ self.assertEqual(get_serial_nos(pr_1.get("items")[0].serial_no)[0], "XYZ005")
+ for serial_no in get_serial_nos(pr_2.get("items")[0].serial_no):
+ self.assertNotEqual(serial_no, "XYZ005")
+
def test_serial_no_sanitation(self):
"Test if Serial No input is sanitised before entering the DB."
item_code = "_Test Serialized Item"
- test_records = frappe.get_test_records('Stock Entry')
+ test_records = frappe.get_test_records("Stock Entry")
se = frappe.copy_doc(test_records[0])
se.get("items")[0].item_code = item_code
@@ -192,7 +242,95 @@ class TestSerialNo(ERPNextTestCase):
self.assertEqual(se.get("items")[0].serial_no, "_TS1\n_TS2\n_TS3\n_TS4 - 2021")
- frappe.db.rollback()
+ def test_correct_serial_no_incoming_rate(self):
+ """Check correct consumption rate based on serial no record."""
+ item_code = "_Test Serialized Item"
+ warehouse = "_Test Warehouse - _TC"
+ serial_nos = ["LOWVALUATION", "HIGHVALUATION"]
- def tearDown(self):
- frappe.db.rollback()
+ in1 = make_stock_entry(
+ item_code=item_code, to_warehouse=warehouse, qty=1, rate=42, serial_no=serial_nos[0]
+ )
+ in2 = make_stock_entry(
+ item_code=item_code, to_warehouse=warehouse, qty=1, rate=113, serial_no=serial_nos[1]
+ )
+
+ out = create_delivery_note(
+ item_code=item_code, qty=1, serial_no=serial_nos[0], do_not_submit=True
+ )
+
+ # change serial no
+ out.items[0].serial_no = serial_nos[1]
+ out.save()
+ out.submit()
+
+ value_diff = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_no": out.name, "voucher_type": "Delivery Note"},
+ "stock_value_difference",
+ )
+ self.assertEqual(value_diff, -113)
+
+ def test_auto_fetch(self):
+ item_code = make_item(
+ properties={
+ "has_serial_no": 1,
+ "has_batch_no": 1,
+ "create_new_batch": 1,
+ "serial_no_series": "TEST.#######",
+ }
+ ).name
+ warehouse = "_Test Warehouse - _TC"
+
+ in1 = make_stock_entry(item_code=item_code, to_warehouse=warehouse, qty=5)
+ in2 = make_stock_entry(item_code=item_code, to_warehouse=warehouse, qty=5)
+
+ in1.reload()
+ in2.reload()
+
+ batch1 = in1.items[0].batch_no
+ batch2 = in2.items[0].batch_no
+
+ batch_wise_serials = {
+ batch1: get_serial_nos(in1.items[0].serial_no),
+ batch2: get_serial_nos(in2.items[0].serial_no),
+ }
+
+ # Test FIFO
+ first_fetch = auto_fetch_serial_number(5, item_code, warehouse)
+ self.assertEqual(first_fetch, batch_wise_serials[batch1])
+
+ # partial FIFO
+ partial_fetch = auto_fetch_serial_number(2, item_code, warehouse)
+ self.assertTrue(
+ set(partial_fetch).issubset(set(first_fetch)),
+ msg=f"{partial_fetch} should be subset of {first_fetch}",
+ )
+
+ # exclusion
+ remaining = auto_fetch_serial_number(
+ 3, item_code, warehouse, exclude_sr_nos=json.dumps(partial_fetch)
+ )
+ self.assertEqual(sorted(remaining + partial_fetch), first_fetch)
+
+ # batchwise
+ for batch, expected_serials in batch_wise_serials.items():
+ fetched_sr = auto_fetch_serial_number(5, item_code, warehouse, batch_nos=batch)
+ self.assertEqual(fetched_sr, sorted(expected_serials))
+
+ # non existing warehouse
+ self.assertEqual(auto_fetch_serial_number(10, item_code, warehouse="Nonexisting"), [])
+
+ # multi batch
+ all_serials = [sr for sr_list in batch_wise_serials.values() for sr in sr_list]
+ fetched_serials = auto_fetch_serial_number(
+ 10, item_code, warehouse, batch_nos=list(batch_wise_serials.keys())
+ )
+ self.assertEqual(sorted(all_serials), fetched_serials)
+
+ # expiry date
+ frappe.db.set_value("Batch", batch1, "expiry_date", "1980-01-01")
+ non_expired_serials = auto_fetch_serial_number(
+ 5, item_code, warehouse, posting_date="2021-01-01", batch_nos=batch1
+ )
+ self.assertEqual(non_expired_serials, [])
diff --git a/erpnext/stock/doctype/shipment/shipment.py b/erpnext/stock/doctype/shipment/shipment.py
index 666de57f34f..42a67f42bec 100644
--- a/erpnext/stock/doctype/shipment/shipment.py
+++ b/erpnext/stock/doctype/shipment/shipment.py
@@ -17,22 +17,22 @@ class Shipment(Document):
self.validate_pickup_time()
self.set_value_of_goods()
if self.docstatus == 0:
- self.status = 'Draft'
+ self.status = "Draft"
def on_submit(self):
if not self.shipment_parcel:
- frappe.throw(_('Please enter Shipment Parcel information'))
+ frappe.throw(_("Please enter Shipment Parcel information"))
if self.value_of_goods == 0:
- frappe.throw(_('Value of goods cannot be 0'))
- self.db_set('status', 'Submitted')
+ frappe.throw(_("Value of goods cannot be 0"))
+ self.db_set("status", "Submitted")
def on_cancel(self):
- self.db_set('status', 'Cancelled')
+ self.db_set("status", "Cancelled")
def validate_weight(self):
for parcel in self.shipment_parcel:
if flt(parcel.weight) <= 0:
- frappe.throw(_('Parcel weight cannot be 0'))
+ frappe.throw(_("Parcel weight cannot be 0"))
def validate_pickup_time(self):
if self.pickup_from and self.pickup_to and get_time(self.pickup_to) < get_time(self.pickup_from):
@@ -44,26 +44,34 @@ class Shipment(Document):
value_of_goods += flt(entry.get("grand_total"))
self.value_of_goods = value_of_goods if value_of_goods else self.value_of_goods
+
@frappe.whitelist()
def get_address_name(ref_doctype, docname):
# Return address name
return get_party_shipping_address(ref_doctype, docname)
+
@frappe.whitelist()
def get_contact_name(ref_doctype, docname):
# Return address name
return get_default_contact(ref_doctype, docname)
+
@frappe.whitelist()
def get_company_contact(user):
- contact = frappe.db.get_value('User', user, [
- 'first_name',
- 'last_name',
- 'email',
- 'phone',
- 'mobile_no',
- 'gender',
- ], as_dict=1)
+ contact = frappe.db.get_value(
+ "User",
+ user,
+ [
+ "first_name",
+ "last_name",
+ "email",
+ "phone",
+ "mobile_no",
+ "gender",
+ ],
+ as_dict=1,
+ )
if not contact.phone:
contact.phone = contact.mobile_no
return contact
diff --git a/erpnext/stock/doctype/shipment/test_shipment.py b/erpnext/stock/doctype/shipment/test_shipment.py
index 705b2651f65..ae97e7af361 100644
--- a/erpnext/stock/doctype/shipment/test_shipment.py
+++ b/erpnext/stock/doctype/shipment/test_shipment.py
@@ -4,22 +4,23 @@
from datetime import date, timedelta
import frappe
+from frappe.tests.utils import FrappeTestCase
from erpnext.stock.doctype.delivery_note.delivery_note import make_shipment
-from erpnext.tests.utils import ERPNextTestCase
-class TestShipment(ERPNextTestCase):
+class TestShipment(FrappeTestCase):
def test_shipment_from_delivery_note(self):
delivery_note = create_test_delivery_note()
delivery_note.submit()
- shipment = create_test_shipment([ delivery_note ])
+ shipment = create_test_shipment([delivery_note])
shipment.submit()
second_shipment = make_shipment(delivery_note.name)
self.assertEqual(second_shipment.value_of_goods, delivery_note.grand_total)
self.assertEqual(len(second_shipment.shipment_delivery_note), 1)
self.assertEqual(second_shipment.shipment_delivery_note[0].delivery_note, delivery_note.name)
+
def create_test_delivery_note():
company = get_shipment_company()
customer = get_shipment_customer()
@@ -30,25 +31,26 @@ def create_test_delivery_note():
delivery_note = frappe.new_doc("Delivery Note")
delivery_note.company = company.name
delivery_note.posting_date = posting_date.strftime("%Y-%m-%d")
- delivery_note.posting_time = '10:00'
+ delivery_note.posting_time = "10:00"
delivery_note.customer = customer.name
- delivery_note.append('items',
+ delivery_note.append(
+ "items",
{
"item_code": item.name,
"item_name": item.item_name,
- "description": 'Test delivery note for shipment',
+ "description": "Test delivery note for shipment",
"qty": 5,
- "uom": 'Nos',
- "warehouse": 'Stores - SC',
+ "uom": "Nos",
+ "warehouse": "Stores - _TC",
"rate": item.standard_rate,
- "cost_center": 'Main - SC'
- }
+ "cost_center": "Main - _TC",
+ },
)
delivery_note.insert()
return delivery_note
-def create_test_shipment(delivery_notes = None):
+def create_test_shipment(delivery_notes=None):
company = get_shipment_company()
company_address = get_shipment_company_address(company.name)
customer = get_shipment_customer()
@@ -57,45 +59,35 @@ def create_test_shipment(delivery_notes = None):
posting_date = date.today() + timedelta(days=5)
shipment = frappe.new_doc("Shipment")
- shipment.pickup_from_type = 'Company'
+ shipment.pickup_from_type = "Company"
shipment.pickup_company = company.name
shipment.pickup_address_name = company_address.name
- shipment.delivery_to_type = 'Customer'
+ shipment.delivery_to_type = "Customer"
shipment.delivery_customer = customer.name
shipment.delivery_address_name = customer_address.name
shipment.delivery_contact_name = customer_contact.name
- shipment.pallets = 'No'
- shipment.shipment_type = 'Goods'
+ shipment.pallets = "No"
+ shipment.shipment_type = "Goods"
shipment.value_of_goods = 1000
- shipment.pickup_type = 'Pickup'
+ shipment.pickup_type = "Pickup"
shipment.pickup_date = posting_date.strftime("%Y-%m-%d")
- shipment.pickup_from = '09:00'
- shipment.pickup_to = '17:00'
- shipment.description_of_content = 'unit test entry'
+ shipment.pickup_from = "09:00"
+ shipment.pickup_to = "17:00"
+ shipment.description_of_content = "unit test entry"
for delivery_note in delivery_notes:
- shipment.append('shipment_delivery_note',
- {
- "delivery_note": delivery_note.name
- }
- )
- shipment.append('shipment_parcel',
- {
- "length": 5,
- "width": 5,
- "height": 5,
- "weight": 5,
- "count": 5
- }
+ shipment.append("shipment_delivery_note", {"delivery_note": delivery_note.name})
+ shipment.append(
+ "shipment_parcel", {"length": 5, "width": 5, "height": 5, "weight": 5, "count": 5}
)
shipment.insert()
return shipment
def get_shipment_customer_contact(customer_name):
- contact_fname = 'Customer Shipment'
- contact_lname = 'Testing'
- customer_name = contact_fname + ' ' + contact_lname
- contacts = frappe.get_all("Contact", fields=["name"], filters = {"name": customer_name})
+ contact_fname = "Customer Shipment"
+ contact_lname = "Testing"
+ customer_name = contact_fname + " " + contact_lname
+ contacts = frappe.get_all("Contact", fields=["name"], filters={"name": customer_name})
if len(contacts):
return contacts[0]
else:
@@ -103,121 +95,106 @@ def get_shipment_customer_contact(customer_name):
def get_shipment_customer_address(customer_name):
- address_title = customer_name + ' address 123'
- customer_address = frappe.get_all("Address", fields=["name"], filters = {"address_title": address_title})
+ address_title = customer_name + " address 123"
+ customer_address = frappe.get_all(
+ "Address", fields=["name"], filters={"address_title": address_title}
+ )
if len(customer_address):
return customer_address[0]
else:
return create_shipment_address(address_title, customer_name, 81929)
+
def get_shipment_customer():
- customer_name = 'Shipment Customer'
- customer = frappe.get_all("Customer", fields=["name"], filters = {"name": customer_name})
+ customer_name = "Shipment Customer"
+ customer = frappe.get_all("Customer", fields=["name"], filters={"name": customer_name})
if len(customer):
return customer[0]
else:
return create_shipment_customer(customer_name)
+
def get_shipment_company_address(company_name):
- address_title = company_name + ' address 123'
- addresses = frappe.get_all("Address", fields=["name"], filters = {"address_title": address_title})
+ address_title = company_name + " address 123"
+ addresses = frappe.get_all("Address", fields=["name"], filters={"address_title": address_title})
if len(addresses):
return addresses[0]
else:
return create_shipment_address(address_title, company_name, 80331)
+
def get_shipment_company():
- company_name = 'Shipment Company'
- abbr = 'SC'
- companies = frappe.get_all("Company", fields=["name"], filters = {"company_name": company_name})
- if len(companies):
- return companies[0]
- else:
- return create_shipment_company(company_name, abbr)
+ return frappe.get_doc("Company", "_Test Company")
+
def get_shipment_item(company_name):
- item_name = 'Testing Shipment item'
- items = frappe.get_all("Item",
+ item_name = "Testing Shipment item"
+ items = frappe.get_all(
+ "Item",
fields=["name", "item_name", "item_code", "standard_rate"],
- filters = {"item_name": item_name}
+ filters={"item_name": item_name},
)
if len(items):
return items[0]
else:
return create_shipment_item(item_name, company_name)
+
def create_shipment_address(address_title, company_name, postal_code):
address = frappe.new_doc("Address")
address.address_title = address_title
- address.address_type = 'Shipping'
- address.address_line1 = company_name + ' address line 1'
- address.city = 'Random City'
+ address.address_type = "Shipping"
+ address.address_line1 = company_name + " address line 1"
+ address.city = "Random City"
address.postal_code = postal_code
- address.country = 'Germany'
+ address.country = "Germany"
address.insert()
return address
def create_customer_contact(fname, lname):
customer = frappe.new_doc("Contact")
- customer.customer_name = fname + ' ' + lname
+ customer.customer_name = fname + " " + lname
customer.first_name = fname
customer.last_name = lname
customer.is_primary_contact = 1
customer.is_billing_contact = 1
- customer.append('email_ids',
- {
- 'email_id': 'randomme@email.com',
- 'is_primary': 1
- }
+ customer.append("email_ids", {"email_id": "randomme@email.com", "is_primary": 1})
+ customer.append(
+ "phone_nos", {"phone": "123123123", "is_primary_phone": 1, "is_primary_mobile_no": 1}
)
- customer.append('phone_nos',
- {
- 'phone': '123123123',
- 'is_primary_phone': 1,
- 'is_primary_mobile_no': 1
- }
- )
- customer.status = 'Passive'
+ customer.status = "Passive"
customer.insert()
return customer
-def create_shipment_company(company_name, abbr):
- company = frappe.new_doc("Company")
- company.company_name = company_name
- company.abbr = abbr
- company.default_currency = 'EUR'
- company.country = 'Germany'
- company.enable_perpetual_inventory = 0
- company.insert()
- return company
-
def create_shipment_customer(customer_name):
customer = frappe.new_doc("Customer")
customer.customer_name = customer_name
- customer.customer_type = 'Company'
- customer.customer_group = 'All Customer Groups'
- customer.territory = 'All Territories'
- customer.gst_category = 'Unregistered'
+ customer.customer_type = "Company"
+ customer.customer_group = "All Customer Groups"
+ customer.territory = "All Territories"
+ customer.gst_category = "Unregistered"
customer.insert()
return customer
+
def create_material_receipt(item, company):
posting_date = date.today()
stock = frappe.new_doc("Stock Entry")
stock.company = company
- stock.stock_entry_type = 'Material Receipt'
+ stock.stock_entry_type = "Material Receipt"
stock.posting_date = posting_date.strftime("%Y-%m-%d")
- stock.append('items',
+ stock.append(
+ "items",
{
- "t_warehouse": 'Stores - SC',
+ "t_warehouse": "Stores - _TC",
"item_code": item.name,
"qty": 5,
- "uom": 'Nos',
+ "uom": "Nos",
"basic_rate": item.standard_rate,
- "cost_center": 'Main - SC'
- }
+ "cost_center": "Main - _TC",
+ },
)
stock.insert()
stock.submit()
@@ -227,14 +204,9 @@ def create_shipment_item(item_name, company_name):
item = frappe.new_doc("Item")
item.item_name = item_name
item.item_code = item_name
- item.item_group = 'All Item Groups'
- item.stock_uom = 'Nos'
+ item.item_group = "All Item Groups"
+ item.stock_uom = "Nos"
item.standard_rate = 50
- item.append('item_defaults',
- {
- "company": company_name,
- "default_warehouse": 'Stores - SC'
- }
- )
+ item.append("item_defaults", {"company": company_name, "default_warehouse": "Stores - _TC"})
item.insert()
return item
diff --git a/erpnext/stock/doctype/stock_entry/stock_entry.js b/erpnext/stock/doctype/stock_entry/stock_entry.js
index fc9d1ed98f7..9cc8e237b6a 100644
--- a/erpnext/stock/doctype/stock_entry/stock_entry.js
+++ b/erpnext/stock/doctype/stock_entry/stock_entry.js
@@ -468,7 +468,9 @@ frappe.ui.form.on('Stock Entry', {
},
callback: function(r) {
if (!r.exc) {
- $.extend(child, r.message);
+ ["actual_qty", "basic_rate"].forEach((field) => {
+ frappe.model.set_value(cdt, cdn, field, (r.message[field] || 0.0));
+ });
frm.events.calculate_basic_amount(frm, child);
}
}
@@ -579,18 +581,23 @@ frappe.ui.form.on('Stock Entry', {
},
add_to_transit: function(frm) {
- if(frm.doc.add_to_transit && frm.doc.purpose=='Material Transfer') {
- frm.set_value('to_warehouse', '');
+ if(frm.doc.purpose=='Material Transfer') {
+ var filters = {
+ 'is_group': 0,
+ 'company': frm.doc.company
+ }
+
+ if(frm.doc.add_to_transit){
+ filters['warehouse_type'] = 'Transit';
+ frm.set_value('to_warehouse', '');
+ frm.trigger('set_transit_warehouse');
+ }
+
frm.fields_dict.to_warehouse.get_query = function() {
return {
- filters:{
- 'warehouse_type' : 'Transit',
- 'is_group': 0,
- 'company': frm.doc.company
- }
+ filters:filters
};
};
- frm.trigger('set_transit_warehouse');
}
},
@@ -627,6 +634,12 @@ frappe.ui.form.on('Stock Entry Detail', {
frm.events.set_serial_no(frm, cdt, cdn, () => {
frm.events.get_warehouse_details(frm, cdt, cdn);
});
+
+ // set allow_zero_valuation_rate to 0 if s_warehouse is selected.
+ let item = frappe.get_doc(cdt, cdn);
+ if (item.s_warehouse) {
+ frappe.model.set_value(cdt, cdn, "allow_zero_valuation_rate", 0);
+ }
},
t_warehouse: function(frm, cdt, cdn) {
@@ -1063,8 +1076,8 @@ function attach_bom_items(bom_no) {
function check_should_not_attach_bom_items(bom_no) {
return (
- bom_no === undefined ||
- (erpnext.stock.bom && erpnext.stock.bom.name === bom_no)
+ bom_no === undefined ||
+ (erpnext.stock.bom && erpnext.stock.bom.name === bom_no)
);
}
diff --git a/erpnext/stock/doctype/stock_entry/stock_entry.json b/erpnext/stock/doctype/stock_entry/stock_entry.json
index 2f377788961..f56e059f81c 100644
--- a/erpnext/stock/doctype/stock_entry/stock_entry.json
+++ b/erpnext/stock/doctype/stock_entry/stock_entry.json
@@ -8,7 +8,6 @@
"engine": "InnoDB",
"field_order": [
"items_section",
- "title",
"naming_series",
"stock_entry_type",
"outgoing_stock_entry",
@@ -47,9 +46,9 @@
"items",
"get_stock_and_rate",
"section_break_19",
- "total_incoming_value",
- "column_break_22",
"total_outgoing_value",
+ "column_break_22",
+ "total_incoming_value",
"value_difference",
"additional_costs_section",
"additional_costs",
@@ -83,14 +82,6 @@
"fieldtype": "Section Break",
"oldfieldtype": "Section Break"
},
- {
- "fieldname": "title",
- "fieldtype": "Data",
- "hidden": 1,
- "label": "Title",
- "no_copy": 1,
- "print_hide": 1
- },
{
"fieldname": "naming_series",
"fieldtype": "Select",
@@ -353,9 +344,9 @@
},
{
"fieldname": "scan_barcode",
- "options": "Barcode",
"fieldtype": "Data",
- "label": "Scan Barcode"
+ "label": "Scan Barcode",
+ "options": "Barcode"
},
{
"allow_bulk_edit": 1,
@@ -383,7 +374,7 @@
{
"fieldname": "total_incoming_value",
"fieldtype": "Currency",
- "label": "Total Incoming Value",
+ "label": "Total Incoming Value (Receipt)",
"options": "Company:company:default_currency",
"print_hide": 1,
"read_only": 1
@@ -395,7 +386,7 @@
{
"fieldname": "total_outgoing_value",
"fieldtype": "Currency",
- "label": "Total Outgoing Value",
+ "label": "Total Outgoing Value (Consumption)",
"options": "Company:company:default_currency",
"print_hide": 1,
"read_only": 1
@@ -403,7 +394,7 @@
{
"fieldname": "value_difference",
"fieldtype": "Currency",
- "label": "Total Value Difference (Out - In)",
+ "label": "Total Value Difference (Incoming - Outgoing)",
"options": "Company:company:default_currency",
"print_hide_if_no_value": 1,
"read_only": 1
@@ -628,10 +619,11 @@
"index_web_pages_for_search": 1,
"is_submittable": 1,
"links": [],
- "modified": "2021-08-20 19:19:31.514846",
+ "modified": "2022-05-02 05:21:39.060501",
"modified_by": "Administrator",
"module": "Stock",
"name": "Stock Entry",
+ "naming_rule": "By \"Naming Series\" field",
"owner": "Administrator",
"permissions": [
{
@@ -698,6 +690,7 @@
"show_name_in_global_search": 1,
"sort_field": "modified",
"sort_order": "DESC",
- "title_field": "title",
+ "states": [],
+ "title_field": "stock_entry_type",
"track_changes": 1
}
\ No newline at end of file
diff --git a/erpnext/stock/doctype/stock_entry/stock_entry.py b/erpnext/stock/doctype/stock_entry/stock_entry.py
index 5b27106b825..3dff7d2e003 100644
--- a/erpnext/stock/doctype/stock_entry/stock_entry.py
+++ b/erpnext/stock/doctype/stock_entry/stock_entry.py
@@ -8,6 +8,7 @@ from collections import defaultdict
import frappe
from frappe import _
from frappe.model.mapper import get_mapped_doc
+from frappe.query_builder.functions import Sum
from frappe.utils import cint, comma_or, cstr, flt, format_time, formatdate, getdate, nowdate
from six import iteritems, itervalues, string_types
@@ -36,16 +37,30 @@ from erpnext.stock.stock_ledger import NegativeStockError, get_previous_sle, get
from erpnext.stock.utils import get_bin, get_incoming_rate
-class IncorrectValuationRateError(frappe.ValidationError): pass
-class DuplicateEntryForWorkOrderError(frappe.ValidationError): pass
-class OperationsNotCompleteError(frappe.ValidationError): pass
-class MaxSampleAlreadyRetainedError(frappe.ValidationError): pass
+class FinishedGoodError(frappe.ValidationError):
+ pass
+
+
+class IncorrectValuationRateError(frappe.ValidationError):
+ pass
+
+
+class DuplicateEntryForWorkOrderError(frappe.ValidationError):
+ pass
+
+
+class OperationsNotCompleteError(frappe.ValidationError):
+ pass
+
+
+class MaxSampleAlreadyRetainedError(frappe.ValidationError):
+ pass
+
from erpnext.controllers.stock_controller import StockController
-form_grid_templates = {
- "items": "templates/form_grid/stock_entry_grid.html"
-}
+form_grid_templates = {"items": "templates/form_grid/stock_entry_grid.html"}
+
class StockEntry(StockController):
def get_feed(self):
@@ -57,20 +72,21 @@ class StockEntry(StockController):
def before_validate(self):
from erpnext.stock.doctype.putaway_rule.putaway_rule import apply_putaway_rule
- apply_rule = self.apply_putaway_rule and (self.purpose in ["Material Transfer", "Material Receipt"])
+
+ apply_rule = self.apply_putaway_rule and (
+ self.purpose in ["Material Transfer", "Material Receipt"]
+ )
if self.get("items") and apply_rule:
- apply_putaway_rule(self.doctype, self.get("items"), self.company,
- purpose=self.purpose)
+ apply_putaway_rule(self.doctype, self.get("items"), self.company, purpose=self.purpose)
def validate(self):
self.pro_doc = frappe._dict()
if self.work_order:
- self.pro_doc = frappe.get_doc('Work Order', self.work_order)
+ self.pro_doc = frappe.get_doc("Work Order", self.work_order)
self.validate_posting_time()
self.validate_purpose()
- self.set_title()
self.validate_item()
self.validate_customer_provided_item()
self.validate_qty()
@@ -80,8 +96,11 @@ class StockEntry(StockController):
self.validate_warehouse()
self.validate_work_order()
self.validate_bom()
- self.mark_finished_and_scrap_items()
- self.validate_finished_goods()
+
+ if self.purpose in ("Manufacture", "Repack"):
+ self.mark_finished_and_scrap_items()
+ self.validate_finished_goods()
+
self.validate_with_material_request()
self.validate_batch()
self.validate_inspection()
@@ -95,17 +114,21 @@ class StockEntry(StockController):
if not self.from_bom:
self.fg_completed_qty = 0.0
- if self._action == 'submit':
- self.make_batches('t_warehouse')
+ if self._action == "submit":
+ self.make_batches("t_warehouse")
else:
- set_batch_nos(self, 's_warehouse')
+ set_batch_nos(self, "s_warehouse")
self.validate_serialized_batch()
self.set_actual_qty()
self.calculate_rate_and_amount()
self.validate_putaway_capacity()
- self.reset_default_field_value("from_warehouse", "items", "s_warehouse")
- self.reset_default_field_value("to_warehouse", "items", "t_warehouse")
+
+ if not self.get("purpose") == "Manufacture":
+ # ignore scrap item wh difference and empty source/target wh
+ # in Manufacture Entry
+ self.reset_default_field_value("from_warehouse", "items", "s_warehouse")
+ self.reset_default_field_value("to_warehouse", "items", "t_warehouse")
def on_submit(self):
self.update_stock_ledger()
@@ -126,10 +149,10 @@ class StockEntry(StockController):
if self.work_order and self.purpose == "Manufacture":
self.update_so_in_serial_number()
- if self.purpose == 'Material Transfer' and self.add_to_transit:
- self.set_material_request_transfer_status('In Transit')
- if self.purpose == 'Material Transfer' and self.outgoing_stock_entry:
- self.set_material_request_transfer_status('Completed')
+ if self.purpose == "Material Transfer" and self.add_to_transit:
+ self.set_material_request_transfer_status("In Transit")
+ if self.purpose == "Material Transfer" and self.outgoing_stock_entry:
+ self.set_material_request_transfer_status("Completed")
def on_cancel(self):
self.update_purchase_order_supplied_items()
@@ -140,7 +163,7 @@ class StockEntry(StockController):
self.update_work_order()
self.update_stock_ledger()
- self.ignore_linked_doctypes = ('GL Entry', 'Stock Ledger Entry', 'Repost Item Valuation')
+ self.ignore_linked_doctypes = ("GL Entry", "Stock Ledger Entry", "Repost Item Valuation")
self.make_gl_entries_on_cancel()
self.repost_future_sle_and_gle()
@@ -150,15 +173,16 @@ class StockEntry(StockController):
self.delete_auto_created_batches()
self.delete_linked_stock_entry()
- if self.purpose == 'Material Transfer' and self.add_to_transit:
- self.set_material_request_transfer_status('Not Started')
- if self.purpose == 'Material Transfer' and self.outgoing_stock_entry:
- self.set_material_request_transfer_status('In Transit')
+ if self.purpose == "Material Transfer" and self.add_to_transit:
+ self.set_material_request_transfer_status("Not Started")
+ if self.purpose == "Material Transfer" and self.outgoing_stock_entry:
+ self.set_material_request_transfer_status("In Transit")
def set_job_card_data(self):
if self.job_card and not self.work_order:
- data = frappe.db.get_value('Job Card',
- self.job_card, ['for_quantity', 'work_order', 'bom_no'], as_dict=1)
+ data = frappe.db.get_value(
+ "Job Card", self.job_card, ["for_quantity", "work_order", "bom_no"], as_dict=1
+ )
self.fg_completed_qty = data.for_quantity
self.work_order = data.work_order
self.from_bom = 1
@@ -166,107 +190,158 @@ class StockEntry(StockController):
def validate_work_order_status(self):
pro_doc = frappe.get_doc("Work Order", self.work_order)
- if pro_doc.status == 'Completed':
+ if pro_doc.status == "Completed":
frappe.throw(_("Cannot cancel transaction for Completed Work Order."))
def validate_purpose(self):
- valid_purposes = ["Material Issue", "Material Receipt", "Material Transfer",
- "Material Transfer for Manufacture", "Manufacture", "Repack", "Send to Subcontractor",
- "Material Consumption for Manufacture"]
+ valid_purposes = [
+ "Material Issue",
+ "Material Receipt",
+ "Material Transfer",
+ "Material Transfer for Manufacture",
+ "Manufacture",
+ "Repack",
+ "Send to Subcontractor",
+ "Material Consumption for Manufacture",
+ ]
if self.purpose not in valid_purposes:
frappe.throw(_("Purpose must be one of {0}").format(comma_or(valid_purposes)))
- if self.job_card and self.purpose not in ['Material Transfer for Manufacture', 'Repack']:
- frappe.throw(_("For job card {0}, you can only make the 'Material Transfer for Manufacture' type stock entry")
- .format(self.job_card))
+ if self.job_card and self.purpose not in ["Material Transfer for Manufacture", "Repack"]:
+ frappe.throw(
+ _(
+ "For job card {0}, you can only make the 'Material Transfer for Manufacture' type stock entry"
+ ).format(self.job_card)
+ )
def delete_linked_stock_entry(self):
if self.purpose == "Send to Warehouse":
- for d in frappe.get_all("Stock Entry", filters={"docstatus": 0,
- "outgoing_stock_entry": self.name, "purpose": "Receive at Warehouse"}):
+ for d in frappe.get_all(
+ "Stock Entry",
+ filters={"docstatus": 0, "outgoing_stock_entry": self.name, "purpose": "Receive at Warehouse"},
+ ):
frappe.delete_doc("Stock Entry", d.name)
def set_transfer_qty(self):
for item in self.get("items"):
if not flt(item.qty):
- frappe.throw(_("Row {0}: Qty is mandatory").format(item.idx))
+ frappe.throw(_("Row {0}: Qty is mandatory").format(item.idx), title=_("Zero quantity"))
if not flt(item.conversion_factor):
frappe.throw(_("Row {0}: UOM Conversion Factor is mandatory").format(item.idx))
- item.transfer_qty = flt(flt(item.qty) * flt(item.conversion_factor),
- self.precision("transfer_qty", item))
+ item.transfer_qty = flt(
+ flt(item.qty) * flt(item.conversion_factor), self.precision("transfer_qty", item)
+ )
+ if not flt(item.transfer_qty):
+ frappe.throw(
+ _("Row {0}: Qty in Stock UOM can not be zero.").format(item.idx), title=_("Zero quantity")
+ )
def update_cost_in_project(self):
- if (self.work_order and not frappe.db.get_value("Work Order",
- self.work_order, "update_consumed_material_cost_in_project")):
+ if self.work_order and not frappe.db.get_value(
+ "Work Order", self.work_order, "update_consumed_material_cost_in_project"
+ ):
return
if self.project:
- amount = frappe.db.sql(""" select ifnull(sum(sed.amount), 0)
+ amount = frappe.db.sql(
+ """ select ifnull(sum(sed.amount), 0)
from
`tabStock Entry` se, `tabStock Entry Detail` sed
where
se.docstatus = 1 and se.project = %s and sed.parent = se.name
- and (sed.t_warehouse is null or sed.t_warehouse = '')""", self.project, as_list=1)
+ and (sed.t_warehouse is null or sed.t_warehouse = '')""",
+ self.project,
+ as_list=1,
+ )
amount = amount[0][0] if amount else 0
- additional_costs = frappe.db.sql(""" select ifnull(sum(sed.base_amount), 0)
+ additional_costs = frappe.db.sql(
+ """ select ifnull(sum(sed.base_amount), 0)
from
`tabStock Entry` se, `tabLanded Cost Taxes and Charges` sed
where
se.docstatus = 1 and se.project = %s and sed.parent = se.name
- and se.purpose = 'Manufacture'""", self.project, as_list=1)
+ and se.purpose = 'Manufacture'""",
+ self.project,
+ as_list=1,
+ )
additional_cost_amt = additional_costs[0][0] if additional_costs else 0
amount += additional_cost_amt
- frappe.db.set_value('Project', self.project, 'total_consumed_material_cost', amount)
+ frappe.db.set_value("Project", self.project, "total_consumed_material_cost", amount)
def validate_item(self):
stock_items = self.get_stock_items()
serialized_items = self.get_serialized_items()
for item in self.get("items"):
if flt(item.qty) and flt(item.qty) < 0:
- frappe.throw(_("Row {0}: The item {1}, quantity must be positive number")
- .format(item.idx, frappe.bold(item.item_code)))
+ frappe.throw(
+ _("Row {0}: The item {1}, quantity must be positive number").format(
+ item.idx, frappe.bold(item.item_code)
+ )
+ )
if item.item_code not in stock_items:
frappe.throw(_("{0} is not a stock Item").format(item.item_code))
- item_details = self.get_item_details(frappe._dict(
- {"item_code": item.item_code, "company": self.company,
- "project": self.project, "uom": item.uom, 's_warehouse': item.s_warehouse}),
- for_update=True)
+ item_details = self.get_item_details(
+ frappe._dict(
+ {
+ "item_code": item.item_code,
+ "company": self.company,
+ "project": self.project,
+ "uom": item.uom,
+ "s_warehouse": item.s_warehouse,
+ }
+ ),
+ for_update=True,
+ )
- for f in ("uom", "stock_uom", "description", "item_name", "expense_account",
- "cost_center", "conversion_factor"):
- if f == "stock_uom" or not item.get(f):
- item.set(f, item_details.get(f))
- if f == 'conversion_factor' and item.uom == item_details.get('stock_uom'):
- item.set(f, item_details.get(f))
+ reset_fields = ("stock_uom", "item_name")
+ for field in reset_fields:
+ item.set(field, item_details.get(field))
+
+ update_fields = ("uom", "description", "expense_account", "cost_center", "conversion_factor")
+
+ for field in update_fields:
+ if not item.get(field):
+ item.set(field, item_details.get(field))
+ if field == "conversion_factor" and item.uom == item_details.get("stock_uom"):
+ item.set(field, item_details.get(field))
if not item.transfer_qty and item.qty:
- item.transfer_qty = flt(flt(item.qty) * flt(item.conversion_factor),
- self.precision("transfer_qty", item))
+ item.transfer_qty = flt(
+ flt(item.qty) * flt(item.conversion_factor), self.precision("transfer_qty", item)
+ )
- if (self.purpose in ("Material Transfer", "Material Transfer for Manufacture")
+ if (
+ self.purpose in ("Material Transfer", "Material Transfer for Manufacture")
and not item.serial_no
- and item.item_code in serialized_items):
- frappe.throw(_("Row #{0}: Please specify Serial No for Item {1}").format(item.idx, item.item_code),
- frappe.MandatoryError)
+ and item.item_code in serialized_items
+ ):
+ frappe.throw(
+ _("Row #{0}: Please specify Serial No for Item {1}").format(item.idx, item.item_code),
+ frappe.MandatoryError,
+ )
def validate_qty(self):
manufacture_purpose = ["Manufacture", "Material Consumption for Manufacture"]
if self.purpose in manufacture_purpose and self.work_order:
- if not frappe.get_value('Work Order', self.work_order, 'skip_transfer'):
+ if not frappe.get_value("Work Order", self.work_order, "skip_transfer"):
item_code = []
for item in self.items:
- if cstr(item.t_warehouse) == '':
- req_items = frappe.get_all('Work Order Item',
- filters={'parent': self.work_order, 'item_code': item.item_code}, fields=["item_code"])
+ if cstr(item.t_warehouse) == "":
+ req_items = frappe.get_all(
+ "Work Order Item",
+ filters={"parent": self.work_order, "item_code": item.item_code},
+ fields=["item_code"],
+ )
- transferred_materials = frappe.db.sql("""
+ transferred_materials = frappe.db.sql(
+ """
select
sum(qty) as qty
from `tabStock Entry` se,`tabStock Entry Detail` sed
@@ -274,7 +349,10 @@ class StockEntry(StockController):
se.name = sed.parent and se.docstatus=1 and
(se.purpose='Material Transfer for Manufacture' or se.purpose='Manufacture')
and sed.item_code=%s and se.work_order= %s and ifnull(sed.t_warehouse, '') != ''
- """, (item.item_code, self.work_order), as_dict=1)
+ """,
+ (item.item_code, self.work_order),
+ as_dict=1,
+ )
stock_qty = flt(item.qty)
trans_qty = flt(transferred_materials[0].qty)
@@ -292,8 +370,11 @@ class StockEntry(StockController):
for item_code, qty_list in iteritems(item_wise_qty):
total = flt(sum(qty_list), frappe.get_precision("Stock Entry Detail", "qty"))
if self.fg_completed_qty != total:
- frappe.throw(_("The finished product {0} quantity {1} and For Quantity {2} cannot be different")
- .format(frappe.bold(item_code), frappe.bold(total), frappe.bold(self.fg_completed_qty)))
+ frappe.throw(
+ _("The finished product {0} quantity {1} and For Quantity {2} cannot be different").format(
+ frappe.bold(item_code), frappe.bold(total), frappe.bold(self.fg_completed_qty)
+ )
+ )
def validate_difference_account(self):
if not cint(erpnext.is_perpetual_inventory_enabled(self.company)):
@@ -301,33 +382,53 @@ class StockEntry(StockController):
for d in self.get("items"):
if not d.expense_account:
- frappe.throw(_("Please enter Difference Account or set default Stock Adjustment Account for company {0}")
- .format(frappe.bold(self.company)))
+ frappe.throw(
+ _(
+ "Please enter Difference Account or set default Stock Adjustment Account for company {0}"
+ ).format(frappe.bold(self.company))
+ )
- elif self.is_opening == "Yes" and frappe.db.get_value("Account", d.expense_account, "report_type") == "Profit and Loss":
- frappe.throw(_("Difference Account must be a Asset/Liability type account, since this Stock Entry is an Opening Entry"), OpeningEntryAccountError)
+ elif (
+ self.is_opening == "Yes"
+ and frappe.db.get_value("Account", d.expense_account, "report_type") == "Profit and Loss"
+ ):
+ frappe.throw(
+ _(
+ "Difference Account must be a Asset/Liability type account, since this Stock Entry is an Opening Entry"
+ ),
+ OpeningEntryAccountError,
+ )
def validate_warehouse(self):
"""perform various (sometimes conditional) validations on warehouse"""
- source_mandatory = ["Material Issue", "Material Transfer", "Send to Subcontractor", "Material Transfer for Manufacture",
- "Material Consumption for Manufacture"]
+ source_mandatory = [
+ "Material Issue",
+ "Material Transfer",
+ "Send to Subcontractor",
+ "Material Transfer for Manufacture",
+ "Material Consumption for Manufacture",
+ ]
- target_mandatory = ["Material Receipt", "Material Transfer", "Send to Subcontractor",
- "Material Transfer for Manufacture"]
+ target_mandatory = [
+ "Material Receipt",
+ "Material Transfer",
+ "Send to Subcontractor",
+ "Material Transfer for Manufacture",
+ ]
validate_for_manufacture = any([d.bom_no for d in self.get("items")])
if self.purpose in source_mandatory and self.purpose not in target_mandatory:
self.to_warehouse = None
- for d in self.get('items'):
+ for d in self.get("items"):
d.t_warehouse = None
elif self.purpose in target_mandatory and self.purpose not in source_mandatory:
self.from_warehouse = None
- for d in self.get('items'):
+ for d in self.get("items"):
d.s_warehouse = None
- for d in self.get('items'):
+ for d in self.get("items"):
if not d.s_warehouse and not d.t_warehouse:
d.s_warehouse = self.from_warehouse
d.t_warehouse = self.to_warehouse
@@ -344,7 +445,6 @@ class StockEntry(StockController):
else:
frappe.throw(_("Target warehouse is mandatory for row {0}").format(d.idx))
-
if self.purpose == "Manufacture":
if validate_for_manufacture:
if d.is_finished_item or d.is_scrap_item or d.is_process_loss:
@@ -356,18 +456,26 @@ class StockEntry(StockController):
if not d.s_warehouse:
frappe.throw(_("Source warehouse is mandatory for row {0}").format(d.idx))
- if cstr(d.s_warehouse) == cstr(d.t_warehouse) and not self.purpose == "Material Transfer for Manufacture":
+ if (
+ cstr(d.s_warehouse) == cstr(d.t_warehouse)
+ and not self.purpose == "Material Transfer for Manufacture"
+ ):
frappe.throw(_("Source and target warehouse cannot be same for row {0}").format(d.idx))
if not (d.s_warehouse or d.t_warehouse):
frappe.throw(_("Atleast one warehouse is mandatory"))
def validate_work_order(self):
- if self.purpose in ("Manufacture", "Material Transfer for Manufacture", "Material Consumption for Manufacture"):
+ if self.purpose in (
+ "Manufacture",
+ "Material Transfer for Manufacture",
+ "Material Consumption for Manufacture",
+ ):
# check if work order is entered
- if (self.purpose=="Manufacture" or self.purpose=="Material Consumption for Manufacture") \
- and self.work_order:
+ if (
+ self.purpose == "Manufacture" or self.purpose == "Material Consumption for Manufacture"
+ ) and self.work_order:
if not self.fg_completed_qty:
frappe.throw(_("For Quantity (Manufactured Qty) is mandatory"))
self.check_if_operations_completed()
@@ -378,40 +486,66 @@ class StockEntry(StockController):
def check_if_operations_completed(self):
"""Check if Time Sheets are completed against before manufacturing to capture operating costs."""
prod_order = frappe.get_doc("Work Order", self.work_order)
- allowance_percentage = flt(frappe.db.get_single_value("Manufacturing Settings",
- "overproduction_percentage_for_work_order"))
+ allowance_percentage = flt(
+ frappe.db.get_single_value("Manufacturing Settings", "overproduction_percentage_for_work_order")
+ )
for d in prod_order.get("operations"):
total_completed_qty = flt(self.fg_completed_qty) + flt(prod_order.produced_qty)
- completed_qty = d.completed_qty + (allowance_percentage/100 * d.completed_qty)
+ completed_qty = d.completed_qty + (allowance_percentage / 100 * d.completed_qty)
if total_completed_qty > flt(completed_qty):
- job_card = frappe.db.get_value('Job Card', {'operation_id': d.name}, 'name')
+ job_card = frappe.db.get_value("Job Card", {"operation_id": d.name}, "name")
if not job_card:
- frappe.throw(_("Work Order {0}: Job Card not found for the operation {1}")
- .format(self.work_order, d.operation))
+ frappe.throw(
+ _("Work Order {0}: Job Card not found for the operation {1}").format(
+ self.work_order, d.operation
+ )
+ )
- work_order_link = frappe.utils.get_link_to_form('Work Order', self.work_order)
- job_card_link = frappe.utils.get_link_to_form('Job Card', job_card)
- frappe.throw(_("Row #{0}: Operation {1} is not completed for {2} qty of finished goods in Work Order {3}. Please update operation status via Job Card {4}.")
- .format(d.idx, frappe.bold(d.operation), frappe.bold(total_completed_qty), work_order_link, job_card_link), OperationsNotCompleteError)
+ work_order_link = frappe.utils.get_link_to_form("Work Order", self.work_order)
+ job_card_link = frappe.utils.get_link_to_form("Job Card", job_card)
+ frappe.throw(
+ _(
+ "Row #{0}: Operation {1} is not completed for {2} qty of finished goods in Work Order {3}. Please update operation status via Job Card {4}."
+ ).format(
+ d.idx,
+ frappe.bold(d.operation),
+ frappe.bold(total_completed_qty),
+ work_order_link,
+ job_card_link,
+ ),
+ OperationsNotCompleteError,
+ )
def check_duplicate_entry_for_work_order(self):
- other_ste = [t[0] for t in frappe.db.get_values("Stock Entry", {
- "work_order": self.work_order,
- "purpose": self.purpose,
- "docstatus": ["!=", 2],
- "name": ["!=", self.name]
- }, "name")]
+ other_ste = [
+ t[0]
+ for t in frappe.db.get_values(
+ "Stock Entry",
+ {
+ "work_order": self.work_order,
+ "purpose": self.purpose,
+ "docstatus": ["!=", 2],
+ "name": ["!=", self.name],
+ },
+ "name",
+ )
+ ]
if other_ste:
- production_item, qty = frappe.db.get_value("Work Order",
- self.work_order, ["production_item", "qty"])
+ production_item, qty = frappe.db.get_value(
+ "Work Order", self.work_order, ["production_item", "qty"]
+ )
args = other_ste + [production_item]
- fg_qty_already_entered = frappe.db.sql("""select sum(transfer_qty)
+ fg_qty_already_entered = frappe.db.sql(
+ """select sum(transfer_qty)
from `tabStock Entry Detail`
where parent in (%s)
and item_code = %s
- and ifnull(s_warehouse,'')='' """ % (", ".join(["%s" * len(other_ste)]), "%s"), args)[0][0]
+ and ifnull(s_warehouse,'')='' """
+ % (", ".join(["%s" * len(other_ste)]), "%s"),
+ args,
+ )[0][0]
if fg_qty_already_entered and fg_qty_already_entered >= qty:
frappe.throw(
_("Stock Entries already created for Work Order {0}: {1}").format(
@@ -421,35 +555,58 @@ class StockEntry(StockController):
)
def set_actual_qty(self):
- allow_negative_stock = cint(frappe.db.get_value("Stock Settings", None, "allow_negative_stock"))
+ allow_negative_stock = cint(frappe.db.get_single_value("Stock Settings", "allow_negative_stock"))
- for d in self.get('items'):
- previous_sle = get_previous_sle({
- "item_code": d.item_code,
- "warehouse": d.s_warehouse or d.t_warehouse,
- "posting_date": self.posting_date,
- "posting_time": self.posting_time
- })
+ for d in self.get("items"):
+ previous_sle = get_previous_sle(
+ {
+ "item_code": d.item_code,
+ "warehouse": d.s_warehouse or d.t_warehouse,
+ "posting_date": self.posting_date,
+ "posting_time": self.posting_time,
+ }
+ )
# get actual stock at source warehouse
d.actual_qty = previous_sle.get("qty_after_transaction") or 0
# validate qty during submit
- if d.docstatus==1 and d.s_warehouse and not allow_negative_stock and flt(d.actual_qty, d.precision("actual_qty")) < flt(d.transfer_qty, d.precision("actual_qty")):
- frappe.throw(_("Row {0}: Quantity not available for {4} in warehouse {1} at posting time of the entry ({2} {3})").format(d.idx,
- frappe.bold(d.s_warehouse), formatdate(self.posting_date),
- format_time(self.posting_time), frappe.bold(d.item_code))
- + '
' + _("Available quantity is {0}, you need {1}").format(frappe.bold(d.actual_qty),
- frappe.bold(d.transfer_qty)),
- NegativeStockError, title=_('Insufficient Stock'))
+ if (
+ d.docstatus == 1
+ and d.s_warehouse
+ and not allow_negative_stock
+ and flt(d.actual_qty, d.precision("actual_qty"))
+ < flt(d.transfer_qty, d.precision("actual_qty"))
+ ):
+ frappe.throw(
+ _(
+ "Row {0}: Quantity not available for {4} in warehouse {1} at posting time of the entry ({2} {3})"
+ ).format(
+ d.idx,
+ frappe.bold(d.s_warehouse),
+ formatdate(self.posting_date),
+ format_time(self.posting_time),
+ frappe.bold(d.item_code),
+ )
+ + "
"
+ + _("Available quantity is {0}, you need {1}").format(
+ frappe.bold(flt(d.actual_qty, d.precision("actual_qty"))), frappe.bold(d.transfer_qty)
+ ),
+ NegativeStockError,
+ title=_("Insufficient Stock"),
+ )
def set_serial_nos(self, work_order):
- previous_se = frappe.db.get_value("Stock Entry", {"work_order": work_order,
- "purpose": "Material Transfer for Manufacture"}, "name")
+ previous_se = frappe.db.get_value(
+ "Stock Entry",
+ {"work_order": work_order, "purpose": "Material Transfer for Manufacture"},
+ "name",
+ )
- for d in self.get('items'):
- transferred_serial_no = frappe.db.get_value("Stock Entry Detail",{"parent": previous_se,
- "item_code": d.item_code}, "serial_no")
+ for d in self.get("items"):
+ transferred_serial_no = frappe.db.get_value(
+ "Stock Entry Detail", {"parent": previous_se, "item_code": d.item_code}, "serial_no"
+ )
if transferred_serial_no:
d.serial_no = transferred_serial_no
@@ -457,8 +614,8 @@ class StockEntry(StockController):
@frappe.whitelist()
def get_stock_and_rate(self):
"""
- Updates rate and availability of all the items.
- Called from Update Rate and Availability button.
+ Updates rate and availability of all the items.
+ Called from Update Rate and Availability button.
"""
self.set_work_order_details()
self.set_transfer_qty()
@@ -475,38 +632,52 @@ class StockEntry(StockController):
def set_basic_rate(self, reset_outgoing_rate=True, raise_error_if_no_rate=True):
"""
- Set rate for outgoing, scrapped and finished items
+ Set rate for outgoing, scrapped and finished items
"""
# Set rate for outgoing items
- outgoing_items_cost = self.set_rate_for_outgoing_items(reset_outgoing_rate, raise_error_if_no_rate)
- finished_item_qty = sum(d.transfer_qty for d in self.items if d.is_finished_item or d.is_process_loss)
+ outgoing_items_cost = self.set_rate_for_outgoing_items(
+ reset_outgoing_rate, raise_error_if_no_rate
+ )
+ finished_item_qty = sum(
+ d.transfer_qty for d in self.items if d.is_finished_item or d.is_process_loss
+ )
# Set basic rate for incoming items
- for d in self.get('items'):
- if d.s_warehouse or d.set_basic_rate_manually: continue
+ for d in self.get("items"):
+ if d.s_warehouse or d.set_basic_rate_manually:
+ continue
if d.allow_zero_valuation_rate:
d.basic_rate = 0.0
elif d.is_finished_item:
if self.purpose == "Manufacture":
- d.basic_rate = self.get_basic_rate_for_manufactured_item(finished_item_qty, outgoing_items_cost)
+ d.basic_rate = self.get_basic_rate_for_manufactured_item(
+ finished_item_qty, outgoing_items_cost
+ )
elif self.purpose == "Repack":
d.basic_rate = self.get_basic_rate_for_repacked_items(d.transfer_qty, outgoing_items_cost)
if not d.basic_rate and not d.allow_zero_valuation_rate:
- d.basic_rate = get_valuation_rate(d.item_code, d.t_warehouse,
- self.doctype, self.name, d.allow_zero_valuation_rate,
- currency=erpnext.get_company_currency(self.company), company=self.company,
- raise_error_if_no_rate=raise_error_if_no_rate)
+ d.basic_rate = get_valuation_rate(
+ d.item_code,
+ d.t_warehouse,
+ self.doctype,
+ self.name,
+ d.allow_zero_valuation_rate,
+ currency=erpnext.get_company_currency(self.company),
+ company=self.company,
+ raise_error_if_no_rate=raise_error_if_no_rate,
+ )
- d.basic_rate = flt(d.basic_rate, d.precision("basic_rate"))
+ # do not round off basic rate to avoid precision loss
+ d.basic_rate = flt(d.basic_rate)
if d.is_process_loss:
- d.basic_rate = flt(0.)
+ d.basic_rate = flt(0.0)
d.basic_amount = flt(flt(d.transfer_qty) * flt(d.basic_rate), d.precision("basic_amount"))
def set_rate_for_outgoing_items(self, reset_outgoing_rate=True, raise_error_if_no_rate=True):
outgoing_items_cost = 0.0
- for d in self.get('items'):
+ for d in self.get("items"):
if d.s_warehouse:
if reset_outgoing_rate:
args = self.get_args_for_incoming_rate(d)
@@ -521,18 +692,20 @@ class StockEntry(StockController):
return outgoing_items_cost
def get_args_for_incoming_rate(self, item):
- return frappe._dict({
- "item_code": item.item_code,
- "warehouse": item.s_warehouse or item.t_warehouse,
- "posting_date": self.posting_date,
- "posting_time": self.posting_time,
- "qty": item.s_warehouse and -1*flt(item.transfer_qty) or flt(item.transfer_qty),
- "serial_no": item.serial_no,
- "voucher_type": self.doctype,
- "voucher_no": self.name,
- "company": self.company,
- "allow_zero_valuation": item.allow_zero_valuation_rate,
- })
+ return frappe._dict(
+ {
+ "item_code": item.item_code,
+ "warehouse": item.s_warehouse or item.t_warehouse,
+ "posting_date": self.posting_date,
+ "posting_time": self.posting_time,
+ "qty": item.s_warehouse and -1 * flt(item.transfer_qty) or flt(item.transfer_qty),
+ "serial_no": item.serial_no,
+ "voucher_type": self.doctype,
+ "voucher_no": self.name,
+ "company": self.company,
+ "allow_zero_valuation": item.allow_zero_valuation_rate,
+ }
+ )
def get_basic_rate_for_repacked_items(self, finished_item_qty, outgoing_items_cost):
finished_items = [d.item_code for d in self.get("items") if d.is_finished_item]
@@ -544,13 +717,15 @@ class StockEntry(StockController):
total_fg_qty = sum([flt(d.transfer_qty) for d in self.items if d.is_finished_item])
return flt(outgoing_items_cost / total_fg_qty)
- def get_basic_rate_for_manufactured_item(self, finished_item_qty, outgoing_items_cost=0):
+ def get_basic_rate_for_manufactured_item(self, finished_item_qty, outgoing_items_cost=0) -> float:
scrap_items_cost = sum([flt(d.basic_amount) for d in self.get("items") if d.is_scrap_item])
# Get raw materials cost from BOM if multiple material consumption entries
- if not outgoing_items_cost and frappe.db.get_single_value("Manufacturing Settings", "material_consumption", cache=True):
+ if not outgoing_items_cost and frappe.db.get_single_value(
+ "Manufacturing Settings", "material_consumption", cache=True
+ ):
bom_items = self.get_bom_raw_materials(finished_item_qty)
- outgoing_items_cost = sum([flt(row.qty)*flt(row.rate) for row in bom_items.values()])
+ outgoing_items_cost = sum([flt(row.qty) * flt(row.rate) for row in bom_items.values()])
return flt((outgoing_items_cost - scrap_items_cost) / finished_item_qty)
@@ -582,8 +757,8 @@ class StockEntry(StockController):
for d in self.get("items"):
if d.transfer_qty:
d.amount = flt(flt(d.basic_amount) + flt(d.additional_cost), d.precision("amount"))
- d.valuation_rate = flt(flt(d.basic_rate) + (flt(d.additional_cost) / flt(d.transfer_qty)),
- d.precision("valuation_rate"))
+ # Do not round off valuation rate to avoid precision loss
+ d.valuation_rate = flt(d.basic_rate) + (flt(d.additional_cost) / flt(d.transfer_qty))
def set_total_incoming_outgoing_value(self):
self.total_incoming_value = self.total_outgoing_value = 0.0
@@ -597,92 +772,148 @@ class StockEntry(StockController):
def set_total_amount(self):
self.total_amount = None
- if self.purpose not in ['Manufacture', 'Repack']:
+ if self.purpose not in ["Manufacture", "Repack"]:
self.total_amount = sum([flt(item.amount) for item in self.get("items")])
def set_stock_entry_type(self):
if self.purpose:
- self.stock_entry_type = frappe.get_cached_value('Stock Entry Type',
- {'purpose': self.purpose}, 'name')
+ self.stock_entry_type = frappe.get_cached_value(
+ "Stock Entry Type", {"purpose": self.purpose}, "name"
+ )
def set_purpose_for_stock_entry(self):
if self.stock_entry_type and not self.purpose:
- self.purpose = frappe.get_cached_value('Stock Entry Type',
- self.stock_entry_type, 'purpose')
+ self.purpose = frappe.get_cached_value("Stock Entry Type", self.stock_entry_type, "purpose")
def validate_duplicate_serial_no(self):
warehouse_wise_serial_nos = {}
# In case of repack the source and target serial nos could be same
- for warehouse in ['s_warehouse', 't_warehouse']:
+ for warehouse in ["s_warehouse", "t_warehouse"]:
serial_nos = []
for row in self.items:
- if not (row.serial_no and row.get(warehouse)): continue
+ if not (row.serial_no and row.get(warehouse)):
+ continue
for sn in get_serial_nos(row.serial_no):
if sn in serial_nos:
- frappe.throw(_('The serial no {0} has added multiple times in the stock entry {1}')
- .format(frappe.bold(sn), self.name))
+ frappe.throw(
+ _("The serial no {0} has added multiple times in the stock entry {1}").format(
+ frappe.bold(sn), self.name
+ )
+ )
serial_nos.append(sn)
def validate_purchase_order(self):
"""Throw exception if more raw material is transferred against Purchase Order than in
the raw materials supplied table"""
- backflush_raw_materials_based_on = frappe.db.get_single_value("Buying Settings",
- "backflush_raw_materials_of_subcontract_based_on")
+ backflush_raw_materials_based_on = frappe.db.get_single_value(
+ "Buying Settings", "backflush_raw_materials_of_subcontract_based_on"
+ )
- qty_allowance = flt(frappe.db.get_single_value("Buying Settings",
- "over_transfer_allowance"))
+ qty_allowance = flt(frappe.db.get_single_value("Buying Settings", "over_transfer_allowance"))
- if not (self.purpose == "Send to Subcontractor" and self.purchase_order): return
+ if not (self.purpose == "Send to Subcontractor" and self.purchase_order):
+ return
- if (backflush_raw_materials_based_on == 'BOM'):
+ if backflush_raw_materials_based_on == "BOM":
purchase_order = frappe.get_doc("Purchase Order", self.purchase_order)
for se_item in self.items:
item_code = se_item.original_item or se_item.item_code
precision = cint(frappe.db.get_default("float_precision")) or 3
- required_qty = sum([flt(d.required_qty) for d in purchase_order.supplied_items \
- if d.rm_item_code == item_code])
+ required_qty = sum(
+ [flt(d.required_qty) for d in purchase_order.supplied_items if d.rm_item_code == item_code]
+ )
- total_allowed = required_qty + (required_qty * (qty_allowance/100))
+ total_allowed = required_qty + (required_qty * (qty_allowance / 100))
if not required_qty:
- bom_no = frappe.db.get_value("Purchase Order Item",
+ bom_no = frappe.db.get_value(
+ "Purchase Order Item",
{"parent": self.purchase_order, "item_code": se_item.subcontracted_item},
- "bom")
+ "bom",
+ )
if se_item.allow_alternative_item:
- original_item_code = frappe.get_value("Item Alternative", {"alternative_item_code": item_code}, "item_code")
+ original_item_code = frappe.get_value(
+ "Item Alternative", {"alternative_item_code": item_code}, "item_code"
+ )
- required_qty = sum([flt(d.required_qty) for d in purchase_order.supplied_items \
- if d.rm_item_code == original_item_code])
+ required_qty = sum(
+ [
+ flt(d.required_qty)
+ for d in purchase_order.supplied_items
+ if d.rm_item_code == original_item_code
+ ]
+ )
- total_allowed = required_qty + (required_qty * (qty_allowance/100))
+ total_allowed = required_qty + (required_qty * (qty_allowance / 100))
if not required_qty:
- frappe.throw(_("Item {0} not found in 'Raw Materials Supplied' table in Purchase Order {1}")
- .format(se_item.item_code, self.purchase_order))
- total_supplied = frappe.db.sql("""select sum(transfer_qty)
- from `tabStock Entry Detail`, `tabStock Entry`
- where `tabStock Entry`.purchase_order = %s
- and `tabStock Entry`.docstatus = 1
- and `tabStock Entry Detail`.item_code = %s
- and `tabStock Entry Detail`.parent = `tabStock Entry`.name""",
- (self.purchase_order, se_item.item_code))[0][0]
+ frappe.throw(
+ _("Item {0} not found in 'Raw Materials Supplied' table in Purchase Order {1}").format(
+ se_item.item_code, self.purchase_order
+ )
+ )
+
+ se = frappe.qb.DocType("Stock Entry")
+ se_detail = frappe.qb.DocType("Stock Entry Detail")
+
+ total_supplied = (
+ frappe.qb.from_(se)
+ .inner_join(se_detail)
+ .on(se.name == se_detail.parent)
+ .select(Sum(se_detail.transfer_qty))
+ .where(
+ (se.purpose == "Send to Subcontractor")
+ & (se.purchase_order == self.purchase_order)
+ & (se_detail.item_code == se_item.item_code)
+ & (se.docstatus == 1)
+ )
+ ).run()[0][0]
if flt(total_supplied, precision) > flt(total_allowed, precision):
- frappe.throw(_("Row {0}# Item {1} cannot be transferred more than {2} against Purchase Order {3}")
- .format(se_item.idx, se_item.item_code, total_allowed, self.purchase_order))
+ frappe.throw(
+ _("Row {0}# Item {1} cannot be transferred more than {2} against Purchase Order {3}").format(
+ se_item.idx, se_item.item_code, total_allowed, self.purchase_order
+ )
+ )
+ elif not se_item.get("po_detail"):
+ filters = {
+ "parent": self.purchase_order,
+ "docstatus": 1,
+ "rm_item_code": se_item.item_code,
+ "main_item_code": se_item.subcontracted_item,
+ }
+
+ order_rm_detail = frappe.db.get_value("Purchase Order Item Supplied", filters, "name")
+ if order_rm_detail:
+ se_item.db_set("po_detail", order_rm_detail)
+ else:
+ if not se_item.allow_alternative_item:
+ frappe.throw(
+ _("Row {0}# Item {1} not found in 'Raw Materials Supplied' table in {2} {3}").format(
+ se_item.idx,
+ se_item.item_code,
+ "Purchase Order",
+ self.purchase_order,
+ )
+ )
elif backflush_raw_materials_based_on == "Material Transferred for Subcontract":
for row in self.items:
if not row.subcontracted_item:
- frappe.throw(_("Row {0}: Subcontracted Item is mandatory for the raw material {1}")
- .format(row.idx, frappe.bold(row.item_code)))
+ frappe.throw(
+ _("Row {0}: Subcontracted Item is mandatory for the raw material {1}").format(
+ row.idx, frappe.bold(row.item_code)
+ )
+ )
elif not row.po_detail:
filters = {
- "parent": self.purchase_order, "docstatus": 1,
- "rm_item_code": row.item_code, "main_item_code": row.subcontracted_item
+ "parent": self.purchase_order,
+ "docstatus": 1,
+ "rm_item_code": row.item_code,
+ "main_item_code": row.subcontracted_item,
}
po_detail = frappe.db.get_value("Purchase Order Item Supplied", filters, "name")
@@ -690,27 +921,31 @@ class StockEntry(StockController):
row.db_set("po_detail", po_detail)
def validate_bom(self):
- for d in self.get('items'):
+ for d in self.get("items"):
if d.bom_no and d.is_finished_item:
item_code = d.original_item or d.item_code
validate_bom_no(item_code, d.bom_no)
def mark_finished_and_scrap_items(self):
- if self.purpose in ("Repack", "Manufacture"):
- if any([d.item_code for d in self.items if (d.is_finished_item and d.t_warehouse)]):
- return
+ if any([d.item_code for d in self.items if (d.is_finished_item and d.t_warehouse)]):
+ return
- finished_item = self.get_finished_item()
+ finished_item = self.get_finished_item()
- for d in self.items:
- if d.t_warehouse and not d.s_warehouse:
- if self.purpose=="Repack" or d.item_code == finished_item:
- d.is_finished_item = 1
- else:
- d.is_scrap_item = 1
+ if not finished_item and self.purpose == "Manufacture":
+ # In case of independent Manufacture entry, don't auto set
+ # user must decide and set
+ return
+
+ for d in self.items:
+ if d.t_warehouse and not d.s_warehouse:
+ if self.purpose == "Repack" or d.item_code == finished_item:
+ d.is_finished_item = 1
else:
- d.is_finished_item = 0
- d.is_scrap_item = 0
+ d.is_scrap_item = 1
+ else:
+ d.is_finished_item = 0
+ d.is_scrap_item = 0
def get_finished_item(self):
finished_item = None
@@ -722,38 +957,68 @@ class StockEntry(StockController):
return finished_item
def validate_finished_goods(self):
- """validation: finished good quantity should be same as manufacturing quantity"""
- if not self.work_order: return
+ """
+ 1. Check if FG exists (mfg, repack)
+ 2. Check if Multiple FG Items are present (mfg)
+ 3. Check FG Item and Qty against WO if present (mfg)
+ """
+ production_item, wo_qty, finished_items = None, 0, []
- production_item, wo_qty = frappe.db.get_value("Work Order",
- self.work_order, ["production_item", "qty"])
+ wo_details = frappe.db.get_value("Work Order", self.work_order, ["production_item", "qty"])
+ if wo_details:
+ production_item, wo_qty = wo_details
- finished_items = []
- for d in self.get('items'):
+ for d in self.get("items"):
if d.is_finished_item:
+ if not self.work_order:
+ # Independent MFG Entry/ Repack Entry, no WO to match against
+ finished_items.append(d.item_code)
+ continue
+
if d.item_code != production_item:
- frappe.throw(_("Finished Item {0} does not match with Work Order {1}")
- .format(d.item_code, self.work_order))
+ frappe.throw(
+ _("Finished Item {0} does not match with Work Order {1}").format(
+ d.item_code, self.work_order
+ )
+ )
elif flt(d.transfer_qty) > flt(self.fg_completed_qty):
- frappe.throw(_("Quantity in row {0} ({1}) must be same as manufactured quantity {2}"). \
- format(d.idx, d.transfer_qty, self.fg_completed_qty))
+ frappe.throw(
+ _("Quantity in row {0} ({1}) must be same as manufactured quantity {2}").format(
+ d.idx, d.transfer_qty, self.fg_completed_qty
+ )
+ )
+
finished_items.append(d.item_code)
- if len(set(finished_items)) > 1:
- frappe.throw(_("Multiple items cannot be marked as finished item"))
+ if not finished_items:
+ frappe.throw(
+ msg=_("There must be atleast 1 Finished Good in this Stock Entry").format(self.name),
+ title=_("Missing Finished Good"),
+ exc=FinishedGoodError,
+ )
if self.purpose == "Manufacture":
- if not finished_items:
- frappe.throw(_('Finished Good has not set in the stock entry {0}')
- .format(self.name))
+ if len(set(finished_items)) > 1:
+ frappe.throw(
+ msg=_("Multiple items cannot be marked as finished item"),
+ title=_("Note"),
+ exc=FinishedGoodError,
+ )
- allowance_percentage = flt(frappe.db.get_single_value("Manufacturing Settings",
- "overproduction_percentage_for_work_order"))
+ allowance_percentage = flt(
+ frappe.db.get_single_value(
+ "Manufacturing Settings", "overproduction_percentage_for_work_order"
+ )
+ )
+ allowed_qty = wo_qty + ((allowance_percentage / 100) * wo_qty)
- allowed_qty = wo_qty + (allowance_percentage/100 * wo_qty)
- if self.fg_completed_qty > allowed_qty:
- frappe.throw(_("For quantity {0} should not be greater than work order quantity {1}")
- .format(flt(self.fg_completed_qty), wo_qty))
+ # No work order could mean independent Manufacture entry, if so skip validation
+ if self.work_order and self.fg_completed_qty > allowed_qty:
+ frappe.throw(
+ _("For quantity {0} should not be greater than allowed quantity {1}").format(
+ flt(self.fg_completed_qty), allowed_qty
+ )
+ )
def update_stock_ledger(self):
sl_entries = []
@@ -774,35 +1039,38 @@ class StockEntry(StockController):
def get_finished_item_row(self):
finished_item_row = None
if self.purpose in ("Manufacture", "Repack"):
- for d in self.get('items'):
+ for d in self.get("items"):
if d.is_finished_item:
finished_item_row = d
return finished_item_row
def get_sle_for_source_warehouse(self, sl_entries, finished_item_row):
- for d in self.get('items'):
+ for d in self.get("items"):
if cstr(d.s_warehouse):
- sle = self.get_sl_entries(d, {
- "warehouse": cstr(d.s_warehouse),
- "actual_qty": -flt(d.transfer_qty),
- "incoming_rate": 0
- })
+ sle = self.get_sl_entries(
+ d, {"warehouse": cstr(d.s_warehouse), "actual_qty": -flt(d.transfer_qty), "incoming_rate": 0}
+ )
if cstr(d.t_warehouse):
sle.dependant_sle_voucher_detail_no = d.name
- elif finished_item_row and (finished_item_row.item_code != d.item_code or finished_item_row.t_warehouse != d.s_warehouse):
+ elif finished_item_row and (
+ finished_item_row.item_code != d.item_code or finished_item_row.t_warehouse != d.s_warehouse
+ ):
sle.dependant_sle_voucher_detail_no = finished_item_row.name
sl_entries.append(sle)
def get_sle_for_target_warehouse(self, sl_entries, finished_item_row):
- for d in self.get('items'):
+ for d in self.get("items"):
if cstr(d.t_warehouse):
- sle = self.get_sl_entries(d, {
- "warehouse": cstr(d.t_warehouse),
- "actual_qty": flt(d.transfer_qty),
- "incoming_rate": flt(d.valuation_rate)
- })
+ sle = self.get_sl_entries(
+ d,
+ {
+ "warehouse": cstr(d.t_warehouse),
+ "actual_qty": flt(d.transfer_qty),
+ "incoming_rate": flt(d.valuation_rate),
+ },
+ )
if cstr(d.s_warehouse) or (finished_item_row and d.name == finished_item_row.name):
sle.recalculate_rate = 1
@@ -832,40 +1100,55 @@ class StockEntry(StockController):
continue
item_account_wise_additional_cost.setdefault((d.item_code, d.name), {})
- item_account_wise_additional_cost[(d.item_code, d.name)].setdefault(t.expense_account, {
- "amount": 0.0,
- "base_amount": 0.0
- })
+ item_account_wise_additional_cost[(d.item_code, d.name)].setdefault(
+ t.expense_account, {"amount": 0.0, "base_amount": 0.0}
+ )
multiply_based_on = d.basic_amount if total_basic_amount else d.qty
- item_account_wise_additional_cost[(d.item_code, d.name)][t.expense_account]["amount"] += \
+ item_account_wise_additional_cost[(d.item_code, d.name)][t.expense_account]["amount"] += (
flt(t.amount * multiply_based_on) / divide_based_on
+ )
- item_account_wise_additional_cost[(d.item_code, d.name)][t.expense_account]["base_amount"] += \
+ item_account_wise_additional_cost[(d.item_code, d.name)][t.expense_account]["base_amount"] += (
flt(t.base_amount * multiply_based_on) / divide_based_on
+ )
if item_account_wise_additional_cost:
for d in self.get("items"):
- for account, amount in iteritems(item_account_wise_additional_cost.get((d.item_code, d.name), {})):
- if not amount: continue
+ for account, amount in iteritems(
+ item_account_wise_additional_cost.get((d.item_code, d.name), {})
+ ):
+ if not amount:
+ continue
- gl_entries.append(self.get_gl_dict({
- "account": account,
- "against": d.expense_account,
- "cost_center": d.cost_center,
- "remarks": self.get("remarks") or _("Accounting Entry for Stock"),
- "credit_in_account_currency": flt(amount["amount"]),
- "credit": flt(amount["base_amount"])
- }, item=d))
+ gl_entries.append(
+ self.get_gl_dict(
+ {
+ "account": account,
+ "against": d.expense_account,
+ "cost_center": d.cost_center,
+ "remarks": self.get("remarks") or _("Accounting Entry for Stock"),
+ "credit_in_account_currency": flt(amount["amount"]),
+ "credit": flt(amount["base_amount"]),
+ },
+ item=d,
+ )
+ )
- gl_entries.append(self.get_gl_dict({
- "account": d.expense_account,
- "against": account,
- "cost_center": d.cost_center,
- "remarks": self.get("remarks") or _("Accounting Entry for Stock"),
- "credit": -1 * amount['base_amount'] # put it as negative credit instead of debit purposefully
- }, item=d))
+ gl_entries.append(
+ self.get_gl_dict(
+ {
+ "account": d.expense_account,
+ "against": account,
+ "cost_center": d.cost_center,
+ "remarks": self.get("remarks") or _("Accounting Entry for Stock"),
+ "credit": -1
+ * amount["base_amount"], # put it as negative credit instead of debit purposefully
+ },
+ item=d,
+ )
+ )
return process_gl_map(gl_entries)
@@ -874,13 +1157,15 @@ class StockEntry(StockController):
if flt(pro_doc.docstatus) != 1:
frappe.throw(_("Work Order {0} must be submitted").format(self.work_order))
- if pro_doc.status == 'Stopped':
- frappe.throw(_("Transaction not allowed against stopped Work Order {0}").format(self.work_order))
+ if pro_doc.status == "Stopped":
+ frappe.throw(
+ _("Transaction not allowed against stopped Work Order {0}").format(self.work_order)
+ )
if self.job_card:
- job_doc = frappe.get_doc('Job Card', self.job_card)
+ job_doc = frappe.get_doc("Job Card", self.job_card)
job_doc.set_transferred_qty(update_status=True)
- job_doc.set_transferred_qty_in_job_card(self)
+ job_doc.set_transferred_qty_in_job_card_item(self)
if self.work_order:
pro_doc = frappe.get_doc("Work Order", self.work_order)
@@ -898,73 +1183,95 @@ class StockEntry(StockController):
@frappe.whitelist()
def get_item_details(self, args=None, for_update=False):
- item = frappe.db.sql("""select i.name, i.stock_uom, i.description, i.image, i.item_name, i.item_group,
+ item = frappe.db.sql(
+ """select i.name, i.stock_uom, i.description, i.image, i.item_name, i.item_group,
i.has_batch_no, i.sample_quantity, i.has_serial_no, i.allow_alternative_item,
id.expense_account, id.buying_cost_center
from `tabItem` i LEFT JOIN `tabItem Default` id ON i.name=id.parent and id.company=%s
where i.name=%s
and i.disabled=0
and (i.end_of_life is null or i.end_of_life='0000-00-00' or i.end_of_life > %s)""",
- (self.company, args.get('item_code'), nowdate()), as_dict = 1)
+ (self.company, args.get("item_code"), nowdate()),
+ as_dict=1,
+ )
if not item:
- frappe.throw(_("Item {0} is not active or end of life has been reached").format(args.get("item_code")))
+ frappe.throw(
+ _("Item {0} is not active or end of life has been reached").format(args.get("item_code"))
+ )
item = item[0]
item_group_defaults = get_item_group_defaults(item.name, self.company)
brand_defaults = get_brand_defaults(item.name, self.company)
- ret = frappe._dict({
- 'uom' : item.stock_uom,
- 'stock_uom' : item.stock_uom,
- 'description' : item.description,
- 'image' : item.image,
- 'item_name' : item.item_name,
- 'cost_center' : get_default_cost_center(args, item, item_group_defaults, brand_defaults, self.company),
- 'qty' : args.get("qty"),
- 'transfer_qty' : args.get('qty'),
- 'conversion_factor' : 1,
- 'batch_no' : '',
- 'actual_qty' : 0,
- 'basic_rate' : 0,
- 'serial_no' : '',
- 'has_serial_no' : item.has_serial_no,
- 'has_batch_no' : item.has_batch_no,
- 'sample_quantity' : item.sample_quantity,
- 'expense_account' : item.expense_account
- })
+ ret = frappe._dict(
+ {
+ "uom": item.stock_uom,
+ "stock_uom": item.stock_uom,
+ "description": item.description,
+ "image": item.image,
+ "item_name": item.item_name,
+ "cost_center": get_default_cost_center(
+ args, item, item_group_defaults, brand_defaults, self.company
+ ),
+ "qty": args.get("qty"),
+ "transfer_qty": args.get("qty"),
+ "conversion_factor": 1,
+ "batch_no": "",
+ "actual_qty": 0,
+ "basic_rate": 0,
+ "serial_no": "",
+ "has_serial_no": item.has_serial_no,
+ "has_batch_no": item.has_batch_no,
+ "sample_quantity": item.sample_quantity,
+ "expense_account": item.expense_account,
+ }
+ )
- if self.purpose == 'Send to Subcontractor':
+ if self.purpose == "Send to Subcontractor":
ret["allow_alternative_item"] = item.allow_alternative_item
# update uom
if args.get("uom") and for_update:
- ret.update(get_uom_details(args.get('item_code'), args.get('uom'), args.get('qty')))
+ ret.update(get_uom_details(args.get("item_code"), args.get("uom"), args.get("qty")))
- if self.purpose == 'Material Issue':
- ret["expense_account"] = (item.get("expense_account") or
- item_group_defaults.get("expense_account") or
- frappe.get_cached_value('Company', self.company, "default_expense_account"))
+ if self.purpose == "Material Issue":
+ ret["expense_account"] = (
+ item.get("expense_account")
+ or item_group_defaults.get("expense_account")
+ or frappe.get_cached_value("Company", self.company, "default_expense_account")
+ )
- for company_field, field in {'stock_adjustment_account': 'expense_account',
- 'cost_center': 'cost_center'}.items():
+ for company_field, field in {
+ "stock_adjustment_account": "expense_account",
+ "cost_center": "cost_center",
+ }.items():
if not ret.get(field):
- ret[field] = frappe.get_cached_value('Company', self.company, company_field)
+ ret[field] = frappe.get_cached_value("Company", self.company, company_field)
- args['posting_date'] = self.posting_date
- args['posting_time'] = self.posting_time
+ args["posting_date"] = self.posting_date
+ args["posting_time"] = self.posting_time
- stock_and_rate = get_warehouse_details(args) if args.get('warehouse') else {}
+ stock_and_rate = get_warehouse_details(args) if args.get("warehouse") else {}
ret.update(stock_and_rate)
# automatically select batch for outgoing item
- if (args.get('s_warehouse', None) and args.get('qty') and
- ret.get('has_batch_no') and not args.get('batch_no')):
- args.batch_no = get_batch_no(args['item_code'], args['s_warehouse'], args['qty'])
+ if (
+ args.get("s_warehouse", None)
+ and args.get("qty")
+ and ret.get("has_batch_no")
+ and not args.get("batch_no")
+ ):
+ args.batch_no = get_batch_no(args["item_code"], args["s_warehouse"], args["qty"])
- if self.purpose == "Send to Subcontractor" and self.get("purchase_order") and args.get('item_code'):
- subcontract_items = frappe.get_all("Purchase Order Item Supplied",
- {"parent": self.purchase_order, "rm_item_code": args.get('item_code')}, "main_item_code")
+ if (
+ self.purpose == "Send to Subcontractor" and self.get("purchase_order") and args.get("item_code")
+ ):
+ subcontract_items = frappe.get_all(
+ "Purchase Order Item Supplied",
+ {"parent": self.purchase_order, "rm_item_code": args.get("item_code")},
+ "main_item_code",
+ )
if subcontract_items and len(subcontract_items) == 1:
ret["subcontracted_item"] = subcontract_items[0].main_item_code
@@ -975,46 +1282,57 @@ class StockEntry(StockController):
def set_items_for_stock_in(self):
self.items = []
- if self.outgoing_stock_entry and self.purpose == 'Material Transfer':
- doc = frappe.get_doc('Stock Entry', self.outgoing_stock_entry)
+ if self.outgoing_stock_entry and self.purpose == "Material Transfer":
+ doc = frappe.get_doc("Stock Entry", self.outgoing_stock_entry)
if doc.per_transferred == 100:
- frappe.throw(_("Goods are already received against the outward entry {0}")
- .format(doc.name))
+ frappe.throw(_("Goods are already received against the outward entry {0}").format(doc.name))
for d in doc.items:
- self.append('items', {
- 's_warehouse': d.t_warehouse,
- 'item_code': d.item_code,
- 'qty': d.qty,
- 'uom': d.uom,
- 'against_stock_entry': d.parent,
- 'ste_detail': d.name,
- 'stock_uom': d.stock_uom,
- 'conversion_factor': d.conversion_factor,
- 'serial_no': d.serial_no,
- 'batch_no': d.batch_no
- })
+ self.append(
+ "items",
+ {
+ "s_warehouse": d.t_warehouse,
+ "item_code": d.item_code,
+ "qty": d.qty,
+ "uom": d.uom,
+ "against_stock_entry": d.parent,
+ "ste_detail": d.name,
+ "stock_uom": d.stock_uom,
+ "conversion_factor": d.conversion_factor,
+ "serial_no": d.serial_no,
+ "batch_no": d.batch_no,
+ },
+ )
@frappe.whitelist()
def get_items(self):
- self.set('items', [])
+ self.set("items", [])
self.validate_work_order()
if not self.posting_date or not self.posting_time:
frappe.throw(_("Posting date and posting time is mandatory"))
self.set_work_order_details()
- self.flags.backflush_based_on = frappe.db.get_single_value("Manufacturing Settings",
- "backflush_raw_materials_based_on")
+ self.flags.backflush_based_on = frappe.db.get_single_value(
+ "Manufacturing Settings", "backflush_raw_materials_based_on"
+ )
if self.bom_no:
- backflush_based_on = frappe.db.get_single_value("Manufacturing Settings",
- "backflush_raw_materials_based_on")
+ backflush_based_on = frappe.db.get_single_value(
+ "Manufacturing Settings", "backflush_raw_materials_based_on"
+ )
- if self.purpose in ["Material Issue", "Material Transfer", "Manufacture", "Repack",
- "Send to Subcontractor", "Material Transfer for Manufacture", "Material Consumption for Manufacture"]:
+ if self.purpose in [
+ "Material Issue",
+ "Material Transfer",
+ "Manufacture",
+ "Repack",
+ "Send to Subcontractor",
+ "Material Transfer for Manufacture",
+ "Material Consumption for Manufacture",
+ ]:
if self.work_order and self.purpose == "Material Transfer for Manufacture":
item_dict = self.get_pending_raw_materials(backflush_based_on)
@@ -1023,14 +1341,20 @@ class StockEntry(StockController):
item["to_warehouse"] = self.pro_doc.wip_warehouse
self.add_to_stock_entry_detail(item_dict)
- elif (self.work_order and (self.purpose == "Manufacture"
- or self.purpose == "Material Consumption for Manufacture") and not self.pro_doc.skip_transfer
- and self.flags.backflush_based_on == "Material Transferred for Manufacture"):
+ elif (
+ self.work_order
+ and (self.purpose == "Manufacture" or self.purpose == "Material Consumption for Manufacture")
+ and not self.pro_doc.skip_transfer
+ and self.flags.backflush_based_on == "Material Transferred for Manufacture"
+ ):
self.get_transfered_raw_materials()
- elif (self.work_order and (self.purpose == "Manufacture" or
- self.purpose == "Material Consumption for Manufacture") and self.flags.backflush_based_on== "BOM"
- and frappe.db.get_single_value("Manufacturing Settings", "material_consumption")== 1):
+ elif (
+ self.work_order
+ and (self.purpose == "Manufacture" or self.purpose == "Material Consumption for Manufacture")
+ and self.flags.backflush_based_on == "BOM"
+ and frappe.db.get_single_value("Manufacturing Settings", "material_consumption") == 1
+ ):
self.get_unconsumed_raw_materials()
else:
@@ -1039,31 +1363,36 @@ class StockEntry(StockController):
item_dict = self.get_bom_raw_materials(self.fg_completed_qty)
- #Get PO Supplied Items Details
+ # Get PO Supplied Items Details
if self.purchase_order and self.purpose == "Send to Subcontractor":
- #Get PO Supplied Items Details
- item_wh = frappe._dict(frappe.db.sql("""
+ # Get PO Supplied Items Details
+ item_wh = frappe._dict(
+ frappe.db.sql(
+ """
SELECT
rm_item_code, reserve_warehouse
FROM
`tabPurchase Order` po, `tabPurchase Order Item Supplied` poitemsup
WHERE
- po.name = poitemsup.parent and po.name = %s """,self.purchase_order))
+ po.name = poitemsup.parent and po.name = %s """,
+ self.purchase_order,
+ )
+ )
for item in itervalues(item_dict):
if self.pro_doc and cint(self.pro_doc.from_wip_warehouse):
item["from_warehouse"] = self.pro_doc.wip_warehouse
- #Get Reserve Warehouse from PO
- if self.purchase_order and self.purpose=="Send to Subcontractor":
+ # Get Reserve Warehouse from PO
+ if self.purchase_order and self.purpose == "Send to Subcontractor":
item["from_warehouse"] = item_wh.get(item.item_code)
- item["to_warehouse"] = self.to_warehouse if self.purpose=="Send to Subcontractor" else ""
+ item["to_warehouse"] = self.to_warehouse if self.purpose == "Send to Subcontractor" else ""
self.add_to_stock_entry_detail(item_dict)
# fetch the serial_no of the first stock entry for the second stock entry
if self.work_order and self.purpose == "Manufacture":
self.set_serial_nos(self.work_order)
- work_order = frappe.get_doc('Work Order', self.work_order)
+ work_order = frappe.get_doc("Work Order", self.work_order)
add_additional_cost(self, work_order)
# add finished goods item
@@ -1074,13 +1403,13 @@ class StockEntry(StockController):
self.set_actual_qty()
self.update_items_for_process_loss()
self.validate_customer_provided_item()
- self.calculate_rate_and_amount()
+ self.calculate_rate_and_amount(raise_error_if_no_rate=False)
def set_scrap_items(self):
if self.purpose != "Send to Subcontractor" and self.purpose in ["Manufacture", "Repack"]:
scrap_item_dict = self.get_bom_scrap_material(self.fg_completed_qty)
- for item in itervalues(scrap_item_dict):
- item.idx = ''
+
+ for item in scrap_item_dict.values():
if self.pro_doc and self.pro_doc.scrap_warehouse:
item["to_warehouse"] = self.pro_doc.scrap_warehouse
@@ -1093,7 +1422,7 @@ class StockEntry(StockController):
if self.work_order:
# common validations
if not self.pro_doc:
- self.pro_doc = frappe.get_doc('Work Order', self.work_order)
+ self.pro_doc = frappe.get_doc("Work Order", self.work_order)
if self.pro_doc:
self.bom_no = self.pro_doc.bom_no
@@ -1124,11 +1453,18 @@ class StockEntry(StockController):
"stock_uom": item.stock_uom,
"expense_account": item.get("expense_account"),
"cost_center": item.get("buying_cost_center"),
- "is_finished_item": 1
+ "is_finished_item": 1,
}
- if self.work_order and self.pro_doc.has_batch_no and cint(frappe.db.get_single_value('Manufacturing Settings',
- 'make_serial_no_batch_from_work_order', cache=True)):
+ if (
+ self.work_order
+ and self.pro_doc.has_batch_no
+ and cint(
+ frappe.db.get_single_value(
+ "Manufacturing Settings", "make_serial_no_batch_from_work_order", cache=True
+ )
+ )
+ ):
self.set_batchwise_finished_goods(args, item)
else:
self.add_finished_goods(args, item)
@@ -1137,12 +1473,12 @@ class StockEntry(StockController):
filters = {
"reference_name": self.pro_doc.name,
"reference_doctype": self.pro_doc.doctype,
- "qty_to_produce": (">", 0)
+ "qty_to_produce": (">", 0),
}
fields = ["qty_to_produce as qty", "produced_qty", "name"]
- data = frappe.get_all("Batch", filters = filters, fields = fields, order_by="creation asc")
+ data = frappe.get_all("Batch", filters=filters, fields=fields, order_by="creation asc")
if not data:
self.add_finished_goods(args, item)
@@ -1157,7 +1493,7 @@ class StockEntry(StockController):
if not batch_qty:
continue
- if qty <=0:
+ if qty <= 0:
break
fg_qty = batch_qty
@@ -1171,23 +1507,27 @@ class StockEntry(StockController):
self.add_finished_goods(args, item)
def add_finished_goods(self, args, item):
- self.add_to_stock_entry_detail({
- item.name: args
- }, bom_no = self.bom_no)
+ self.add_to_stock_entry_detail({item.name: args}, bom_no=self.bom_no)
def get_bom_raw_materials(self, qty):
from erpnext.manufacturing.doctype.bom.bom import get_bom_items_as_dict
# item dict = { item_code: {qty, description, stock_uom} }
- item_dict = get_bom_items_as_dict(self.bom_no, self.company, qty=qty,
- fetch_exploded = self.use_multi_level_bom, fetch_qty_in_stock_uom=False)
+ item_dict = get_bom_items_as_dict(
+ self.bom_no,
+ self.company,
+ qty=qty,
+ fetch_exploded=self.use_multi_level_bom,
+ fetch_qty_in_stock_uom=False,
+ )
- used_alternative_items = get_used_alternative_items(work_order = self.work_order)
+ used_alternative_items = get_used_alternative_items(work_order=self.work_order)
for item in itervalues(item_dict):
# if source warehouse presents in BOM set from_warehouse as bom source_warehouse
if item["allow_alternative_item"]:
- item["allow_alternative_item"] = frappe.db.get_value('Work Order',
- self.work_order, "allow_alternative_item")
+ item["allow_alternative_item"] = frappe.db.get_value(
+ "Work Order", self.work_order, "allow_alternative_item"
+ )
item.from_warehouse = self.from_warehouse or item.source_warehouse or item.default_warehouse
if item.item_code in used_alternative_items:
@@ -1205,8 +1545,10 @@ class StockEntry(StockController):
from erpnext.manufacturing.doctype.bom.bom import get_bom_items_as_dict
# item dict = { item_code: {qty, description, stock_uom} }
- item_dict = get_bom_items_as_dict(self.bom_no, self.company, qty=qty,
- fetch_exploded = 0, fetch_scrap_items = 1) or {}
+ item_dict = (
+ get_bom_items_as_dict(self.bom_no, self.company, qty=qty, fetch_exploded=0, fetch_scrap_items=1)
+ or {}
+ )
for item in itervalues(item_dict):
item.from_warehouse = ""
@@ -1220,16 +1562,18 @@ class StockEntry(StockController):
if not item_row:
item_row = frappe._dict({})
- item_row.update({
- 'uom': row.stock_uom,
- 'from_warehouse': '',
- 'qty': row.stock_qty + flt(item_row.stock_qty),
- 'converison_factor': 1,
- 'is_scrap_item': 1,
- 'item_name': row.item_name,
- 'description': row.description,
- 'allow_zero_valuation_rate': 1
- })
+ item_row.update(
+ {
+ "uom": row.stock_uom,
+ "from_warehouse": "",
+ "qty": row.stock_qty + flt(item_row.stock_qty),
+ "converison_factor": 1,
+ "is_scrap_item": 1,
+ "item_name": row.item_name,
+ "description": row.description,
+ "allow_zero_valuation_rate": 1,
+ }
+ )
item_dict[row.item_code] = item_row
@@ -1239,22 +1583,33 @@ class StockEntry(StockController):
if not self.pro_doc:
self.set_work_order_details()
- scrap_items = frappe.db.sql('''
- SELECT
- JCSI.item_code, JCSI.item_name, SUM(JCSI.stock_qty) as stock_qty, JCSI.stock_uom, JCSI.description
- FROM
- `tabJob Card` JC, `tabJob Card Scrap Item` JCSI
- WHERE
- JCSI.parent = JC.name AND JC.docstatus = 1
- AND JCSI.item_code IS NOT NULL AND JC.work_order = %s
- GROUP BY
- JCSI.item_code
- ''', self.work_order, as_dict=1)
-
- pending_qty = flt(self.pro_doc.qty) - flt(self.pro_doc.produced_qty)
- if pending_qty <=0:
+ if not self.pro_doc.operations:
return []
+ job_card = frappe.qb.DocType("Job Card")
+ job_card_scrap_item = frappe.qb.DocType("Job Card Scrap Item")
+
+ scrap_items = (
+ frappe.qb.from_(job_card)
+ .select(
+ Sum(job_card_scrap_item.stock_qty).as_("stock_qty"),
+ job_card_scrap_item.item_code,
+ job_card_scrap_item.item_name,
+ job_card_scrap_item.description,
+ job_card_scrap_item.stock_uom,
+ )
+ .join(job_card_scrap_item)
+ .on(job_card_scrap_item.parent == job_card.name)
+ .where(
+ (job_card_scrap_item.item_code.isnotnull())
+ & (job_card.work_order == self.work_order)
+ & (job_card.docstatus == 1)
+ )
+ .groupby(job_card_scrap_item.item_code)
+ ).run(as_dict=1)
+
+ pending_qty = flt(self.get_completed_job_card_qty()) - flt(self.pro_doc.produced_qty)
+
used_scrap_items = self.get_used_scrap_items()
for row in scrap_items:
row.stock_qty -= flt(used_scrap_items.get(row.item_code))
@@ -1263,24 +1618,25 @@ class StockEntry(StockController):
if used_scrap_items.get(row.item_code):
used_scrap_items[row.item_code] -= row.stock_qty
- if cint(frappe.get_cached_value('UOM', row.stock_uom, 'must_be_whole_number')):
+ if cint(frappe.get_cached_value("UOM", row.stock_uom, "must_be_whole_number")):
row.stock_qty = frappe.utils.ceil(row.stock_qty)
return scrap_items
+ def get_completed_job_card_qty(self):
+ return flt(min([d.completed_qty for d in self.pro_doc.operations]))
+
def get_used_scrap_items(self):
used_scrap_items = defaultdict(float)
data = frappe.get_all(
- 'Stock Entry',
- fields = [
- '`tabStock Entry Detail`.`item_code`', '`tabStock Entry Detail`.`qty`'
+ "Stock Entry",
+ fields=["`tabStock Entry Detail`.`item_code`", "`tabStock Entry Detail`.`qty`"],
+ filters=[
+ ["Stock Entry", "work_order", "=", self.work_order],
+ ["Stock Entry Detail", "is_scrap_item", "=", 1],
+ ["Stock Entry", "docstatus", "=", 1],
+ ["Stock Entry", "purpose", "in", ["Repack", "Manufacture"]],
],
- filters = [
- ['Stock Entry', 'work_order', '=', self.work_order],
- ['Stock Entry Detail', 'is_scrap_item', '=', 1],
- ['Stock Entry', 'docstatus', '=', 1],
- ['Stock Entry', 'purpose', 'in', ['Repack', 'Manufacture']]
- ]
)
for row in data:
@@ -1290,10 +1646,11 @@ class StockEntry(StockController):
def get_unconsumed_raw_materials(self):
wo = frappe.get_doc("Work Order", self.work_order)
- wo_items = frappe.get_all('Work Order Item',
- filters={'parent': self.work_order},
- fields=["item_code", "source_warehouse", "required_qty", "consumed_qty", "transferred_qty"]
- )
+ wo_items = frappe.get_all(
+ "Work Order Item",
+ filters={"parent": self.work_order},
+ fields=["item_code", "source_warehouse", "required_qty", "consumed_qty", "transferred_qty"],
+ )
work_order_qty = wo.material_transferred_for_manufacturing or wo.qty
for item in wo_items:
@@ -1310,21 +1667,24 @@ class StockEntry(StockController):
qty = req_qty_each * flt(self.fg_completed_qty)
if qty > 0:
- self.add_to_stock_entry_detail({
- item.item_code: {
- "from_warehouse": wo.wip_warehouse or item.source_warehouse,
- "to_warehouse": "",
- "qty": qty,
- "item_name": item.item_name,
- "description": item.description,
- "stock_uom": item_account_details.stock_uom,
- "expense_account": item_account_details.get("expense_account"),
- "cost_center": item_account_details.get("buying_cost_center"),
+ self.add_to_stock_entry_detail(
+ {
+ item.item_code: {
+ "from_warehouse": wo.wip_warehouse or item.source_warehouse,
+ "to_warehouse": "",
+ "qty": qty,
+ "item_name": item.item_name,
+ "description": item.description,
+ "stock_uom": item_account_details.stock_uom,
+ "expense_account": item_account_details.get("expense_account"),
+ "cost_center": item_account_details.get("buying_cost_center"),
+ }
}
- })
+ )
def get_transfered_raw_materials(self):
- transferred_materials = frappe.db.sql("""
+ transferred_materials = frappe.db.sql(
+ """
select
item_name, original_item, item_code, sum(qty) as qty, sed.t_warehouse as warehouse,
description, stock_uom, expense_account, cost_center
@@ -1333,9 +1693,13 @@ class StockEntry(StockController):
se.name = sed.parent and se.docstatus=1 and se.purpose='Material Transfer for Manufacture'
and se.work_order= %s and ifnull(sed.t_warehouse, '') != ''
group by sed.item_code, sed.t_warehouse
- """, self.work_order, as_dict=1)
+ """,
+ self.work_order,
+ as_dict=1,
+ )
- materials_already_backflushed = frappe.db.sql("""
+ materials_already_backflushed = frappe.db.sql(
+ """
select
item_code, sed.s_warehouse as warehouse, sum(qty) as qty
from
@@ -1345,26 +1709,34 @@ class StockEntry(StockController):
and (se.purpose='Manufacture' or se.purpose='Material Consumption for Manufacture')
and se.work_order= %s and ifnull(sed.s_warehouse, '') != ''
group by sed.item_code, sed.s_warehouse
- """, self.work_order, as_dict=1)
+ """,
+ self.work_order,
+ as_dict=1,
+ )
- backflushed_materials= {}
+ backflushed_materials = {}
for d in materials_already_backflushed:
- backflushed_materials.setdefault(d.item_code,[]).append({d.warehouse: d.qty})
+ backflushed_materials.setdefault(d.item_code, []).append({d.warehouse: d.qty})
- po_qty = frappe.db.sql("""select qty, produced_qty, material_transferred_for_manufacturing from
- `tabWork Order` where name=%s""", self.work_order, as_dict=1)[0]
+ po_qty = frappe.db.sql(
+ """select qty, produced_qty, material_transferred_for_manufacturing from
+ `tabWork Order` where name=%s""",
+ self.work_order,
+ as_dict=1,
+ )[0]
manufacturing_qty = flt(po_qty.qty) or 1
produced_qty = flt(po_qty.produced_qty)
trans_qty = flt(po_qty.material_transferred_for_manufacturing) or 1
for item in transferred_materials:
- qty= item.qty
+ qty = item.qty
item_code = item.original_item or item.item_code
- req_items = frappe.get_all('Work Order Item',
- filters={'parent': self.work_order, 'item_code': item_code},
- fields=["required_qty", "consumed_qty"]
- )
+ req_items = frappe.get_all(
+ "Work Order Item",
+ filters={"parent": self.work_order, "item_code": item_code},
+ fields=["required_qty", "consumed_qty"],
+ )
req_qty = flt(req_items[0].required_qty) if req_items else flt(4)
req_qty_each = flt(req_qty / manufacturing_qty)
@@ -1372,68 +1744,75 @@ class StockEntry(StockController):
if trans_qty and manufacturing_qty > (produced_qty + flt(self.fg_completed_qty)):
if qty >= req_qty:
- qty = (req_qty/trans_qty) * flt(self.fg_completed_qty)
+ qty = (req_qty / trans_qty) * flt(self.fg_completed_qty)
else:
qty = qty - consumed_qty
- if self.purpose == 'Manufacture':
+ if self.purpose == "Manufacture":
# If Material Consumption is booked, must pull only remaining components to finish product
if consumed_qty != 0:
remaining_qty = consumed_qty - (produced_qty * req_qty_each)
exhaust_qty = req_qty_each * produced_qty
- if remaining_qty > exhaust_qty :
- if (remaining_qty/(req_qty_each * flt(self.fg_completed_qty))) >= 1:
- qty =0
+ if remaining_qty > exhaust_qty:
+ if (remaining_qty / (req_qty_each * flt(self.fg_completed_qty))) >= 1:
+ qty = 0
else:
qty = (req_qty_each * flt(self.fg_completed_qty)) - remaining_qty
else:
if self.flags.backflush_based_on == "Material Transferred for Manufacture":
- qty = (item.qty/trans_qty) * flt(self.fg_completed_qty)
+ qty = (item.qty / trans_qty) * flt(self.fg_completed_qty)
else:
qty = req_qty_each * flt(self.fg_completed_qty)
elif backflushed_materials.get(item.item_code):
+ precision = frappe.get_precision("Stock Entry Detail", "qty")
for d in backflushed_materials.get(item.item_code):
- if d.get(item.warehouse):
- if (qty > req_qty):
- qty = (qty/trans_qty) * flt(self.fg_completed_qty)
+ if d.get(item.warehouse) > 0:
+ if qty > req_qty:
+ qty = (
+ (flt(qty, precision) - flt(d.get(item.warehouse), precision))
+ / (flt(trans_qty, precision) - flt(produced_qty, precision))
+ ) * flt(self.fg_completed_qty)
- if consumed_qty and frappe.db.get_single_value("Manufacturing Settings",
- "material_consumption"):
- qty -= consumed_qty
+ d[item.warehouse] -= qty
- if cint(frappe.get_cached_value('UOM', item.stock_uom, 'must_be_whole_number')):
+ if cint(frappe.get_cached_value("UOM", item.stock_uom, "must_be_whole_number")):
qty = frappe.utils.ceil(qty)
if qty > 0:
- self.add_to_stock_entry_detail({
- item.item_code: {
- "from_warehouse": item.warehouse,
- "to_warehouse": "",
- "qty": qty,
- "item_name": item.item_name,
- "description": item.description,
- "stock_uom": item.stock_uom,
- "expense_account": item.expense_account,
- "cost_center": item.buying_cost_center,
- "original_item": item.original_item
+ self.add_to_stock_entry_detail(
+ {
+ item.item_code: {
+ "from_warehouse": item.warehouse,
+ "to_warehouse": "",
+ "qty": qty,
+ "item_name": item.item_name,
+ "description": item.description,
+ "stock_uom": item.stock_uom,
+ "expense_account": item.expense_account,
+ "cost_center": item.buying_cost_center,
+ "original_item": item.original_item,
+ }
}
- })
+ )
def get_pending_raw_materials(self, backflush_based_on=None):
"""
- issue (item quantity) that is pending to issue or desire to transfer,
- whichever is less
+ issue (item quantity) that is pending to issue or desire to transfer,
+ whichever is less
"""
item_dict = self.get_pro_order_required_items(backflush_based_on)
max_qty = flt(self.pro_doc.qty)
allow_overproduction = False
- overproduction_percentage = flt(frappe.db.get_single_value("Manufacturing Settings",
- "overproduction_percentage_for_work_order"))
+ overproduction_percentage = flt(
+ frappe.db.get_single_value("Manufacturing Settings", "overproduction_percentage_for_work_order")
+ )
- to_transfer_qty = flt(self.pro_doc.material_transferred_for_manufacturing) + flt(self.fg_completed_qty)
+ to_transfer_qty = flt(self.pro_doc.material_transferred_for_manufacturing) + flt(
+ self.fg_completed_qty
+ )
transfer_limit_qty = max_qty + ((max_qty * overproduction_percentage) / 100)
if transfer_limit_qty >= to_transfer_qty:
@@ -1443,10 +1822,14 @@ class StockEntry(StockController):
pending_to_issue = flt(item_details.required_qty) - flt(item_details.transferred_qty)
desire_to_transfer = flt(self.fg_completed_qty) * flt(item_details.required_qty) / max_qty
- if (desire_to_transfer <= pending_to_issue
+ if (
+ desire_to_transfer <= pending_to_issue
or (desire_to_transfer > 0 and backflush_based_on == "Material Transferred for Manufacture")
- or allow_overproduction):
- item_dict[item]["qty"] = desire_to_transfer
+ or allow_overproduction
+ ):
+ # "No need for transfer but qty still pending to transfer" case can occur
+ # when transferring multiple RM in different Stock Entries
+ item_dict[item]["qty"] = desire_to_transfer if (desire_to_transfer > 0) else pending_to_issue
elif pending_to_issue > 0:
item_dict[item]["qty"] = pending_to_issue
else:
@@ -1466,7 +1849,7 @@ class StockEntry(StockController):
def get_pro_order_required_items(self, backflush_based_on=None):
"""
- Gets Work Order Required Items only if Stock Entry purpose is **Material Transferred for Manufacture**.
+ Gets Work Order Required Items only if Stock Entry purpose is **Material Transferred for Manufacture**.
"""
item_dict, job_card_items = frappe._dict(), []
work_order = frappe.get_doc("Work Order", self.work_order)
@@ -1485,7 +1868,9 @@ class StockEntry(StockController):
continue
transfer_pending = flt(d.required_qty) > flt(d.transferred_qty)
- can_transfer = transfer_pending or (backflush_based_on == "Material Transferred for Manufacture")
+ can_transfer = transfer_pending or (
+ backflush_based_on == "Material Transferred for Manufacture"
+ )
if not can_transfer:
continue
@@ -1496,11 +1881,7 @@ class StockEntry(StockController):
if consider_job_card:
job_card_item = frappe.db.get_value(
- "Job Card Item",
- {
- "item_code": d.item_code,
- "parent": self.get("job_card")
- }
+ "Job Card Item", {"item_code": d.item_code, "parent": self.get("job_card")}
)
item_row["job_card_item"] = job_card_item or None
@@ -1520,12 +1901,7 @@ class StockEntry(StockController):
return []
job_card_items = frappe.get_all(
- "Job Card Item",
- filters={
- "parent": job_card
- },
- fields=["item_code"],
- distinct=True
+ "Job Card Item", filters={"parent": job_card}, fields=["item_code"], distinct=True
)
return [d.item_code for d in job_card_items]
@@ -1534,60 +1910,86 @@ class StockEntry(StockController):
item_row = item_dict[d]
stock_uom = item_row.get("stock_uom") or frappe.db.get_value("Item", d, "stock_uom")
- se_child = self.append('items')
+ se_child = self.append("items")
se_child.s_warehouse = item_row.get("from_warehouse")
se_child.t_warehouse = item_row.get("to_warehouse")
- se_child.item_code = item_row.get('item_code') or cstr(d)
+ se_child.item_code = item_row.get("item_code") or cstr(d)
se_child.uom = item_row["uom"] if item_row.get("uom") else stock_uom
se_child.stock_uom = stock_uom
se_child.qty = flt(item_row["qty"], se_child.precision("qty"))
se_child.allow_alternative_item = item_row.get("allow_alternative_item", 0)
se_child.subcontracted_item = item_row.get("main_item_code")
- se_child.cost_center = (item_row.get("cost_center") or
- get_default_cost_center(item_row, company = self.company))
+ se_child.cost_center = item_row.get("cost_center") or get_default_cost_center(
+ item_row, company=self.company
+ )
se_child.is_finished_item = item_row.get("is_finished_item", 0)
se_child.is_scrap_item = item_row.get("is_scrap_item", 0)
se_child.is_process_loss = item_row.get("is_process_loss", 0)
- for field in ["idx", "po_detail", "original_item", "expense_account",
- "description", "item_name", "serial_no", "batch_no", "allow_zero_valuation_rate"]:
+ for field in [
+ "po_detail",
+ "original_item",
+ "expense_account",
+ "description",
+ "item_name",
+ "serial_no",
+ "batch_no",
+ "allow_zero_valuation_rate",
+ ]:
if item_row.get(field):
se_child.set(field, item_row.get(field))
- if se_child.s_warehouse==None:
+ if se_child.s_warehouse == None:
se_child.s_warehouse = self.from_warehouse
- if se_child.t_warehouse==None:
+ if se_child.t_warehouse == None:
se_child.t_warehouse = self.to_warehouse
# in stock uom
se_child.conversion_factor = flt(item_row.get("conversion_factor")) or 1
- se_child.transfer_qty = flt(item_row["qty"]*se_child.conversion_factor, se_child.precision("qty"))
+ se_child.transfer_qty = flt(
+ item_row["qty"] * se_child.conversion_factor, se_child.precision("qty")
+ )
- se_child.bom_no = bom_no # to be assigned for finished item
+ se_child.bom_no = bom_no # to be assigned for finished item
se_child.job_card_item = item_row.get("job_card_item") if self.get("job_card") else None
def validate_with_material_request(self):
for item in self.get("items"):
material_request = item.material_request or None
material_request_item = item.material_request_item or None
- if self.purpose == 'Material Transfer' and self.outgoing_stock_entry:
- parent_se = frappe.get_value("Stock Entry Detail", item.ste_detail, ['material_request','material_request_item'],as_dict=True)
+ if self.purpose == "Material Transfer" and self.outgoing_stock_entry:
+ parent_se = frappe.get_value(
+ "Stock Entry Detail",
+ item.ste_detail,
+ ["material_request", "material_request_item"],
+ as_dict=True,
+ )
if parent_se:
material_request = parent_se.material_request
material_request_item = parent_se.material_request_item
if material_request:
- mreq_item = frappe.db.get_value("Material Request Item",
+ mreq_item = frappe.db.get_value(
+ "Material Request Item",
{"name": material_request_item, "parent": material_request},
- ["item_code", "warehouse", "idx"], as_dict=True)
+ ["item_code", "warehouse", "idx"],
+ as_dict=True,
+ )
if mreq_item.item_code != item.item_code:
- frappe.throw(_("Item for row {0} does not match Material Request").format(item.idx),
- frappe.MappingMismatchError)
+ frappe.throw(
+ _("Item for row {0} does not match Material Request").format(item.idx),
+ frappe.MappingMismatchError,
+ )
elif self.purpose == "Material Transfer" and self.add_to_transit:
continue
def validate_batch(self):
- if self.purpose in ["Material Transfer for Manufacture", "Manufacture", "Repack", "Send to Subcontractor"]:
+ if self.purpose in [
+ "Material Transfer for Manufacture",
+ "Manufacture",
+ "Repack",
+ "Send to Subcontractor",
+ ]:
for item in self.get("items"):
if item.batch_no:
disabled = frappe.db.get_value("Batch", item.batch_no, "disabled")
@@ -1595,41 +1997,59 @@ class StockEntry(StockController):
expiry_date = frappe.db.get_value("Batch", item.batch_no, "expiry_date")
if expiry_date:
if getdate(self.posting_date) > getdate(expiry_date):
- frappe.throw(_("Batch {0} of Item {1} has expired.")
- .format(item.batch_no, item.item_code))
+ frappe.throw(_("Batch {0} of Item {1} has expired.").format(item.batch_no, item.item_code))
else:
- frappe.throw(_("Batch {0} of Item {1} is disabled.")
- .format(item.batch_no, item.item_code))
+ frappe.throw(_("Batch {0} of Item {1} is disabled.").format(item.batch_no, item.item_code))
def update_purchase_order_supplied_items(self):
- if (self.purchase_order and
- (self.purpose in ['Send to Subcontractor', 'Material Transfer'] or self.is_return)):
+ if self.purchase_order and (
+ self.purpose in ["Send to Subcontractor", "Material Transfer"] or self.is_return
+ ):
- #Get PO Supplied Items Details
- item_wh = frappe._dict(frappe.db.sql("""
- select rm_item_code, reserve_warehouse
- from `tabPurchase Order` po, `tabPurchase Order Item Supplied` poitemsup
- where po.name = poitemsup.parent
- and po.name = %s""", self.purchase_order))
+ # Get PO Supplied Items Details
+ po_supplied_items = frappe.db.get_all(
+ "Purchase Order Item Supplied",
+ filters={"parent": self.purchase_order},
+ fields=["name", "rm_item_code", "reserve_warehouse"],
+ )
+ # Get Items Supplied in Stock Entries against PO
supplied_items = get_supplied_items(self.purchase_order)
- for name, item in supplied_items.items():
- frappe.db.set_value('Purchase Order Item Supplied', name, item)
- #Update reserved sub contracted quantity in bin based on Supplied Item Details and
+ for row in po_supplied_items:
+ key, item = row.name, {}
+ if not supplied_items.get(key):
+ # no stock transferred against PO Supplied Items row
+ item = {"supplied_qty": 0, "returned_qty": 0, "total_supplied_qty": 0}
+ else:
+ item = supplied_items.get(key)
+
+ frappe.db.set_value("Purchase Order Item Supplied", row.name, item)
+
+ # RM Item-Reserve Warehouse Dict
+ item_wh = {x.get("rm_item_code"): x.get("reserve_warehouse") for x in po_supplied_items}
+
for d in self.get("items"):
- item_code = d.get('original_item') or d.get('item_code')
+ # Update reserved sub contracted quantity in bin based on Supplied Item Details and
+ item_code = d.get("original_item") or d.get("item_code")
reserve_warehouse = item_wh.get(item_code)
+ if not (reserve_warehouse and item_code):
+ continue
stock_bin = get_bin(item_code, reserve_warehouse)
stock_bin.update_reserved_qty_for_sub_contracting()
def update_so_in_serial_number(self):
- so_name, item_code = frappe.db.get_value("Work Order", self.work_order, ["sales_order", "production_item"])
+ so_name, item_code = frappe.db.get_value(
+ "Work Order", self.work_order, ["sales_order", "production_item"]
+ )
if so_name and item_code:
qty_to_reserve = get_reserved_qty_for_so(so_name, item_code)
if qty_to_reserve:
- reserved_qty = frappe.db.sql("""select count(name) from `tabSerial No` where item_code=%s and
- sales_order=%s""", (item_code, so_name))
+ reserved_qty = frappe.db.sql(
+ """select count(name) from `tabSerial No` where item_code=%s and
+ sales_order=%s""",
+ (item_code, so_name),
+ )
if reserved_qty and reserved_qty[0][0]:
qty_to_reserve -= reserved_qty[0][0]
if qty_to_reserve > 0:
@@ -1640,7 +2060,7 @@ class StockEntry(StockController):
for serial_no in serial_nos:
if qty_to_reserve > 0:
frappe.db.set_value("Serial No", serial_no, "sales_order", so_name)
- qty_to_reserve -=1
+ qty_to_reserve -= 1
def validate_reserved_serial_no_consumption(self):
for item in self.items:
@@ -1648,13 +2068,14 @@ class StockEntry(StockController):
for sr in get_serial_nos(item.serial_no):
sales_order = frappe.db.get_value("Serial No", sr, "sales_order")
if sales_order:
- msg = (_("(Serial No: {0}) cannot be consumed as it's reserverd to fullfill Sales Order {1}.")
- .format(sr, sales_order))
+ msg = _(
+ "(Serial No: {0}) cannot be consumed as it's reserverd to fullfill Sales Order {1}."
+ ).format(sr, sales_order)
frappe.throw(_("Item {0} {1}").format(item.item_code, msg))
def update_transferred_qty(self):
- if self.purpose == 'Material Transfer' and self.outgoing_stock_entry:
+ if self.purpose == "Material Transfer" and self.outgoing_stock_entry:
stock_entries = {}
stock_entries_child_list = []
for d in self.items:
@@ -1662,70 +2083,87 @@ class StockEntry(StockController):
continue
stock_entries_child_list.append(d.ste_detail)
- transferred_qty = frappe.get_all("Stock Entry Detail", fields = ["sum(qty) as qty"],
- filters = { 'against_stock_entry': d.against_stock_entry,
- 'ste_detail': d.ste_detail,'docstatus': 1})
+ transferred_qty = frappe.get_all(
+ "Stock Entry Detail",
+ fields=["sum(qty) as qty"],
+ filters={
+ "against_stock_entry": d.against_stock_entry,
+ "ste_detail": d.ste_detail,
+ "docstatus": 1,
+ },
+ )
- stock_entries[(d.against_stock_entry, d.ste_detail)] = (transferred_qty[0].qty
- if transferred_qty and transferred_qty[0] else 0.0) or 0.0
+ stock_entries[(d.against_stock_entry, d.ste_detail)] = (
+ transferred_qty[0].qty if transferred_qty and transferred_qty[0] else 0.0
+ ) or 0.0
- if not stock_entries: return None
+ if not stock_entries:
+ return None
- cond = ''
+ cond = ""
for data, transferred_qty in stock_entries.items():
cond += """ WHEN (parent = %s and name = %s) THEN %s
- """ %(frappe.db.escape(data[0]), frappe.db.escape(data[1]), transferred_qty)
+ """ % (
+ frappe.db.escape(data[0]),
+ frappe.db.escape(data[1]),
+ transferred_qty,
+ )
if stock_entries_child_list:
- frappe.db.sql(""" UPDATE `tabStock Entry Detail`
+ frappe.db.sql(
+ """ UPDATE `tabStock Entry Detail`
SET
transferred_qty = CASE {cond} END
WHERE
- name in ({ste_details}) """.format(cond=cond,
- ste_details = ','.join(['%s'] * len(stock_entries_child_list))),
- tuple(stock_entries_child_list))
+ name in ({ste_details}) """.format(
+ cond=cond, ste_details=",".join(["%s"] * len(stock_entries_child_list))
+ ),
+ tuple(stock_entries_child_list),
+ )
args = {
- 'source_dt': 'Stock Entry Detail',
- 'target_field': 'transferred_qty',
- 'target_ref_field': 'qty',
- 'target_dt': 'Stock Entry Detail',
- 'join_field': 'ste_detail',
- 'target_parent_dt': 'Stock Entry',
- 'target_parent_field': 'per_transferred',
- 'source_field': 'qty',
- 'percent_join_field': 'against_stock_entry'
+ "source_dt": "Stock Entry Detail",
+ "target_field": "transferred_qty",
+ "target_ref_field": "qty",
+ "target_dt": "Stock Entry Detail",
+ "join_field": "ste_detail",
+ "target_parent_dt": "Stock Entry",
+ "target_parent_field": "per_transferred",
+ "source_field": "qty",
+ "percent_join_field": "against_stock_entry",
}
self._update_percent_field_in_targets(args, update_modified=True)
def update_quality_inspection(self):
if self.inspection_required:
- reference_type = reference_name = ''
+ reference_type = reference_name = ""
if self.docstatus == 1:
reference_name = self.name
- reference_type = 'Stock Entry'
+ reference_type = "Stock Entry"
for d in self.items:
if d.quality_inspection:
- frappe.db.set_value("Quality Inspection", d.quality_inspection, {
- 'reference_type': reference_type,
- 'reference_name': reference_name
- })
+ frappe.db.set_value(
+ "Quality Inspection",
+ d.quality_inspection,
+ {"reference_type": reference_type, "reference_name": reference_name},
+ )
+
def set_material_request_transfer_status(self, status):
material_requests = []
if self.outgoing_stock_entry:
- parent_se = frappe.get_value("Stock Entry", self.outgoing_stock_entry, 'add_to_transit')
+ parent_se = frappe.get_value("Stock Entry", self.outgoing_stock_entry, "add_to_transit")
for item in self.items:
material_request = item.material_request or None
if self.purpose == "Material Transfer" and material_request not in material_requests:
if self.outgoing_stock_entry and parent_se:
- material_request = frappe.get_value("Stock Entry Detail", item.ste_detail, 'material_request')
+ material_request = frappe.get_value("Stock Entry Detail", item.ste_detail, "material_request")
if material_request and material_request not in material_requests:
material_requests.append(material_request)
- frappe.db.set_value('Material Request', material_request, 'transfer_status', status)
+ frappe.db.set_value("Material Request", material_request, "transfer_status", status)
def update_items_for_process_loss(self):
process_loss_dict = {}
@@ -1733,7 +2171,9 @@ class StockEntry(StockController):
if not d.is_process_loss:
continue
- scrap_warehouse = frappe.db.get_single_value("Manufacturing Settings", "default_scrap_warehouse")
+ scrap_warehouse = frappe.db.get_single_value(
+ "Manufacturing Settings", "default_scrap_warehouse"
+ )
if scrap_warehouse is not None:
d.t_warehouse = scrap_warehouse
d.is_scrap_item = 0
@@ -1750,7 +2190,6 @@ class StockEntry(StockController):
d.transfer_qty -= process_loss_dict[d.item_code][0]
d.qty -= process_loss_dict[d.item_code][1]
-
def set_serial_no_batch_for_finished_good(self):
args = {}
if self.pro_doc.serial_no:
@@ -1759,14 +2198,22 @@ class StockEntry(StockController):
for row in self.items:
if row.is_finished_item and row.item_code == self.pro_doc.production_item:
if args.get("serial_no"):
- row.serial_no = '\n'.join(args["serial_no"][0: cint(row.qty)])
+ row.serial_no = "\n".join(args["serial_no"][0 : cint(row.qty)])
def get_serial_nos_for_fg(self, args):
- fields = ["`tabStock Entry`.`name`", "`tabStock Entry Detail`.`qty`",
- "`tabStock Entry Detail`.`serial_no`", "`tabStock Entry Detail`.`batch_no`"]
+ fields = [
+ "`tabStock Entry`.`name`",
+ "`tabStock Entry Detail`.`qty`",
+ "`tabStock Entry Detail`.`serial_no`",
+ "`tabStock Entry Detail`.`batch_no`",
+ ]
- filters = [["Stock Entry","work_order","=",self.work_order], ["Stock Entry","purpose","=","Manufacture"],
- ["Stock Entry","docstatus","=",1], ["Stock Entry Detail","item_code","=",self.pro_doc.production_item]]
+ filters = [
+ ["Stock Entry", "work_order", "=", self.work_order],
+ ["Stock Entry", "purpose", "=", "Manufacture"],
+ ["Stock Entry", "docstatus", "=", 1],
+ ["Stock Entry Detail", "item_code", "=", self.pro_doc.production_item],
+ ]
stock_entries = frappe.get_all("Stock Entry", fields=fields, filters=filters)
@@ -1781,93 +2228,105 @@ class StockEntry(StockController):
return sorted(list(set(get_serial_nos(self.pro_doc.serial_no)) - set(used_serial_nos)))
- def set_title(self):
- if frappe.flags.in_import and self.title:
- # Allow updating title during data import/update
- return
-
- self.title = self.purpose
+ def set_missing_values(self):
+ "Updates rate and availability of all the items of mapped doc."
+ self.set_transfer_qty()
+ self.set_actual_qty()
+ self.calculate_rate_and_amount()
@frappe.whitelist()
def move_sample_to_retention_warehouse(company, items):
if isinstance(items, string_types):
items = json.loads(items)
- retention_warehouse = frappe.db.get_single_value('Stock Settings', 'sample_retention_warehouse')
+ retention_warehouse = frappe.db.get_single_value("Stock Settings", "sample_retention_warehouse")
stock_entry = frappe.new_doc("Stock Entry")
stock_entry.company = company
stock_entry.purpose = "Material Transfer"
stock_entry.set_stock_entry_type()
for item in items:
- if item.get('sample_quantity') and item.get('batch_no'):
- sample_quantity = validate_sample_quantity(item.get('item_code'), item.get('sample_quantity'),
- item.get('transfer_qty') or item.get('qty'), item.get('batch_no'))
+ if item.get("sample_quantity") and item.get("batch_no"):
+ sample_quantity = validate_sample_quantity(
+ item.get("item_code"),
+ item.get("sample_quantity"),
+ item.get("transfer_qty") or item.get("qty"),
+ item.get("batch_no"),
+ )
if sample_quantity:
- sample_serial_nos = ''
- if item.get('serial_no'):
- serial_nos = (item.get('serial_no')).split()
- if serial_nos and len(serial_nos) > item.get('sample_quantity'):
- serial_no_list = serial_nos[:-(len(serial_nos)-item.get('sample_quantity'))]
- sample_serial_nos = '\n'.join(serial_no_list)
+ sample_serial_nos = ""
+ if item.get("serial_no"):
+ serial_nos = (item.get("serial_no")).split()
+ if serial_nos and len(serial_nos) > item.get("sample_quantity"):
+ serial_no_list = serial_nos[: -(len(serial_nos) - item.get("sample_quantity"))]
+ sample_serial_nos = "\n".join(serial_no_list)
- stock_entry.append("items", {
- "item_code": item.get('item_code'),
- "s_warehouse": item.get('t_warehouse'),
- "t_warehouse": retention_warehouse,
- "qty": item.get('sample_quantity'),
- "basic_rate": item.get('valuation_rate'),
- 'uom': item.get('uom'),
- 'stock_uom': item.get('stock_uom'),
- "conversion_factor": 1.0,
- "serial_no": sample_serial_nos,
- 'batch_no': item.get('batch_no')
- })
- if stock_entry.get('items'):
+ stock_entry.append(
+ "items",
+ {
+ "item_code": item.get("item_code"),
+ "s_warehouse": item.get("t_warehouse"),
+ "t_warehouse": retention_warehouse,
+ "qty": item.get("sample_quantity"),
+ "basic_rate": item.get("valuation_rate"),
+ "uom": item.get("uom"),
+ "stock_uom": item.get("stock_uom"),
+ "conversion_factor": 1.0,
+ "serial_no": sample_serial_nos,
+ "batch_no": item.get("batch_no"),
+ },
+ )
+ if stock_entry.get("items"):
return stock_entry.as_dict()
+
@frappe.whitelist()
def make_stock_in_entry(source_name, target_doc=None):
-
def set_missing_values(source, target):
target.set_stock_entry_type()
+ target.set_missing_values()
def update_item(source_doc, target_doc, source_parent):
- target_doc.t_warehouse = ''
+ target_doc.t_warehouse = ""
- if source_doc.material_request_item and source_doc.material_request :
- add_to_transit = frappe.db.get_value('Stock Entry', source_name, 'add_to_transit')
+ if source_doc.material_request_item and source_doc.material_request:
+ add_to_transit = frappe.db.get_value("Stock Entry", source_name, "add_to_transit")
if add_to_transit:
- warehouse = frappe.get_value('Material Request Item', source_doc.material_request_item, 'warehouse')
+ warehouse = frappe.get_value(
+ "Material Request Item", source_doc.material_request_item, "warehouse"
+ )
target_doc.t_warehouse = warehouse
target_doc.s_warehouse = source_doc.t_warehouse
target_doc.qty = source_doc.qty - source_doc.transferred_qty
- doclist = get_mapped_doc("Stock Entry", source_name, {
- "Stock Entry": {
- "doctype": "Stock Entry",
- "field_map": {
- "name": "outgoing_stock_entry"
+ doclist = get_mapped_doc(
+ "Stock Entry",
+ source_name,
+ {
+ "Stock Entry": {
+ "doctype": "Stock Entry",
+ "field_map": {"name": "outgoing_stock_entry"},
+ "validation": {"docstatus": ["=", 1]},
},
- "validation": {
- "docstatus": ["=", 1]
- }
- },
- "Stock Entry Detail": {
- "doctype": "Stock Entry Detail",
- "field_map": {
- "name": "ste_detail",
- "parent": "against_stock_entry",
- "serial_no": "serial_no",
- "batch_no": "batch_no"
+ "Stock Entry Detail": {
+ "doctype": "Stock Entry Detail",
+ "field_map": {
+ "name": "ste_detail",
+ "parent": "against_stock_entry",
+ "serial_no": "serial_no",
+ "batch_no": "batch_no",
+ },
+ "postprocess": update_item,
+ "condition": lambda doc: flt(doc.qty) - flt(doc.transferred_qty) > 0.01,
},
- "postprocess": update_item,
- "condition": lambda doc: flt(doc.qty) - flt(doc.transferred_qty) > 0.01
},
- }, target_doc, set_missing_values)
+ target_doc,
+ set_missing_values,
+ )
return doclist
+
@frappe.whitelist()
def get_work_order_details(work_order, company):
work_order = frappe.get_doc("Work Order", work_order)
@@ -1879,9 +2338,10 @@ def get_work_order_details(work_order, company):
"use_multi_level_bom": work_order.use_multi_level_bom,
"wip_warehouse": work_order.wip_warehouse,
"fg_warehouse": work_order.fg_warehouse,
- "fg_completed_qty": pending_qty_to_produce
+ "fg_completed_qty": pending_qty_to_produce,
}
+
def get_operating_cost_per_unit(work_order=None, bom_no=None):
operating_cost_per_unit = 0
if work_order:
@@ -1900,54 +2360,78 @@ def get_operating_cost_per_unit(work_order=None, bom_no=None):
if bom.quantity:
operating_cost_per_unit = flt(bom.operating_cost) / flt(bom.quantity)
- if work_order and work_order.produced_qty and cint(frappe.db.get_single_value('Manufacturing Settings',
- 'add_corrective_operation_cost_in_finished_good_valuation')):
- operating_cost_per_unit += flt(work_order.corrective_operation_cost) / flt(work_order.produced_qty)
+ if (
+ work_order
+ and work_order.produced_qty
+ and cint(
+ frappe.db.get_single_value(
+ "Manufacturing Settings", "add_corrective_operation_cost_in_finished_good_valuation"
+ )
+ )
+ ):
+ operating_cost_per_unit += flt(work_order.corrective_operation_cost) / flt(
+ work_order.produced_qty
+ )
return operating_cost_per_unit
+
def get_used_alternative_items(purchase_order=None, work_order=None):
cond = ""
if purchase_order:
- cond = "and ste.purpose = 'Send to Subcontractor' and ste.purchase_order = '{0}'".format(purchase_order)
+ cond = "and ste.purpose = 'Send to Subcontractor' and ste.purchase_order = '{0}'".format(
+ purchase_order
+ )
elif work_order:
- cond = "and ste.purpose = 'Material Transfer for Manufacture' and ste.work_order = '{0}'".format(work_order)
+ cond = "and ste.purpose = 'Material Transfer for Manufacture' and ste.work_order = '{0}'".format(
+ work_order
+ )
- if not cond: return {}
+ if not cond:
+ return {}
used_alternative_items = {}
- data = frappe.db.sql(""" select sted.original_item, sted.uom, sted.conversion_factor,
+ data = frappe.db.sql(
+ """ select sted.original_item, sted.uom, sted.conversion_factor,
sted.item_code, sted.item_name, sted.conversion_factor,sted.stock_uom, sted.description
from
`tabStock Entry` ste, `tabStock Entry Detail` sted
where
sted.parent = ste.name and ste.docstatus = 1 and sted.original_item != sted.item_code
- {0} """.format(cond), as_dict=1)
+ {0} """.format(
+ cond
+ ),
+ as_dict=1,
+ )
for d in data:
used_alternative_items[d.original_item] = d
return used_alternative_items
+
def get_valuation_rate_for_finished_good_entry(work_order):
- work_order_qty = flt(frappe.get_cached_value("Work Order",
- work_order, 'material_transferred_for_manufacturing'))
+ work_order_qty = flt(
+ frappe.get_cached_value("Work Order", work_order, "material_transferred_for_manufacturing")
+ )
field = "(SUM(total_outgoing_value) / %s) as valuation_rate" % (work_order_qty)
- stock_data = frappe.get_all("Stock Entry",
- fields = field,
- filters = {
+ stock_data = frappe.get_all(
+ "Stock Entry",
+ fields=field,
+ filters={
"docstatus": 1,
"purpose": "Material Transfer for Manufacture",
- "work_order": work_order
- }
+ "work_order": work_order,
+ },
)
if stock_data:
return stock_data[0].valuation_rate
+
@frappe.whitelist()
def get_uom_details(item_code, uom, qty):
"""Returns dict `{"conversion_factor": [value], "transfer_qty": qty * [value]}`
@@ -1956,24 +2440,31 @@ def get_uom_details(item_code, uom, qty):
conversion_factor = get_conversion_factor(item_code, uom).get("conversion_factor")
if not conversion_factor:
- frappe.msgprint(_("UOM coversion factor required for UOM: {0} in Item: {1}")
- .format(uom, item_code))
- ret = {'uom' : ''}
+ frappe.msgprint(
+ _("UOM coversion factor required for UOM: {0} in Item: {1}").format(uom, item_code)
+ )
+ ret = {"uom": ""}
else:
ret = {
- 'conversion_factor' : flt(conversion_factor),
- 'transfer_qty' : flt(qty) * flt(conversion_factor)
+ "conversion_factor": flt(conversion_factor),
+ "transfer_qty": flt(qty) * flt(conversion_factor),
}
return ret
+
@frappe.whitelist()
def get_expired_batch_items():
- return frappe.db.sql("""select b.item, sum(sle.actual_qty) as qty, sle.batch_no, sle.warehouse, sle.stock_uom\
+ return frappe.db.sql(
+ """select b.item, sum(sle.actual_qty) as qty, sle.batch_no, sle.warehouse, sle.stock_uom\
from `tabBatch` b, `tabStock Ledger Entry` sle
where b.expiry_date <= %s
and b.expiry_date is not NULL
and b.batch_id = sle.batch_no and sle.is_cancelled = 0
- group by sle.warehouse, sle.item_code, sle.batch_no""",(nowdate()), as_dict=1)
+ group by sle.warehouse, sle.item_code, sle.batch_no""",
+ (nowdate()),
+ as_dict=1,
+ )
+
@frappe.whitelist()
def get_warehouse_details(args):
@@ -1984,51 +2475,73 @@ def get_warehouse_details(args):
ret = {}
if args.warehouse and args.item_code:
- args.update({
- "posting_date": args.posting_date,
- "posting_time": args.posting_time,
- })
+ args.update(
+ {
+ "posting_date": args.posting_date,
+ "posting_time": args.posting_time,
+ }
+ )
ret = {
- "actual_qty" : get_previous_sle(args).get("qty_after_transaction") or 0,
- "basic_rate" : get_incoming_rate(args)
+ "actual_qty": get_previous_sle(args).get("qty_after_transaction") or 0,
+ "basic_rate": get_incoming_rate(args),
}
return ret
+
@frappe.whitelist()
-def validate_sample_quantity(item_code, sample_quantity, qty, batch_no = None):
+def validate_sample_quantity(item_code, sample_quantity, qty, batch_no=None):
if cint(qty) < cint(sample_quantity):
- frappe.throw(_("Sample quantity {0} cannot be more than received quantity {1}").format(sample_quantity, qty))
- retention_warehouse = frappe.db.get_single_value('Stock Settings', 'sample_retention_warehouse')
+ frappe.throw(
+ _("Sample quantity {0} cannot be more than received quantity {1}").format(sample_quantity, qty)
+ )
+ retention_warehouse = frappe.db.get_single_value("Stock Settings", "sample_retention_warehouse")
retainted_qty = 0
if batch_no:
retainted_qty = get_batch_qty(batch_no, retention_warehouse, item_code)
- max_retain_qty = frappe.get_value('Item', item_code, 'sample_quantity')
+ max_retain_qty = frappe.get_value("Item", item_code, "sample_quantity")
if retainted_qty >= max_retain_qty:
- frappe.msgprint(_("Maximum Samples - {0} have already been retained for Batch {1} and Item {2} in Batch {3}.").
- format(retainted_qty, batch_no, item_code, batch_no), alert=True)
+ frappe.msgprint(
+ _(
+ "Maximum Samples - {0} have already been retained for Batch {1} and Item {2} in Batch {3}."
+ ).format(retainted_qty, batch_no, item_code, batch_no),
+ alert=True,
+ )
sample_quantity = 0
- qty_diff = max_retain_qty-retainted_qty
+ qty_diff = max_retain_qty - retainted_qty
if cint(sample_quantity) > cint(qty_diff):
- frappe.msgprint(_("Maximum Samples - {0} can be retained for Batch {1} and Item {2}.").
- format(max_retain_qty, batch_no, item_code), alert=True)
+ frappe.msgprint(
+ _("Maximum Samples - {0} can be retained for Batch {1} and Item {2}.").format(
+ max_retain_qty, batch_no, item_code
+ ),
+ alert=True,
+ )
sample_quantity = qty_diff
return sample_quantity
-def get_supplied_items(purchase_order):
- fields = ['`tabStock Entry Detail`.`transfer_qty`', '`tabStock Entry`.`is_return`',
- '`tabStock Entry Detail`.`po_detail`', '`tabStock Entry Detail`.`item_code`']
- filters = [['Stock Entry', 'docstatus', '=', 1], ['Stock Entry', 'purchase_order', '=', purchase_order]]
+def get_supplied_items(purchase_order):
+ fields = [
+ "`tabStock Entry Detail`.`transfer_qty`",
+ "`tabStock Entry`.`is_return`",
+ "`tabStock Entry Detail`.`po_detail`",
+ "`tabStock Entry Detail`.`item_code`",
+ ]
+
+ filters = [
+ ["Stock Entry", "docstatus", "=", 1],
+ ["Stock Entry", "purchase_order", "=", purchase_order],
+ ]
supplied_item_details = {}
- for row in frappe.get_all('Stock Entry', fields = fields, filters = filters):
+ for row in frappe.get_all("Stock Entry", fields=fields, filters=filters):
if not row.po_detail:
continue
key = row.po_detail
if key not in supplied_item_details:
- supplied_item_details.setdefault(key,
- frappe._dict({'supplied_qty': 0, 'returned_qty':0, 'total_supplied_qty':0}))
+ supplied_item_details.setdefault(
+ key, frappe._dict({"supplied_qty": 0, "returned_qty": 0, "total_supplied_qty": 0})
+ )
supplied_item = supplied_item_details[key]
@@ -2037,6 +2550,8 @@ def get_supplied_items(purchase_order):
else:
supplied_item.supplied_qty += row.transfer_qty
- supplied_item.total_supplied_qty = flt(supplied_item.supplied_qty) - flt(supplied_item.returned_qty)
+ supplied_item.total_supplied_qty = flt(supplied_item.supplied_qty) - flt(
+ supplied_item.returned_qty
+ )
return supplied_item_details
diff --git a/erpnext/stock/doctype/stock_entry/stock_entry_utils.py b/erpnext/stock/doctype/stock_entry/stock_entry_utils.py
index 5832fe49b2d..7badf475c57 100644
--- a/erpnext/stock/doctype/stock_entry/stock_entry_utils.py
+++ b/erpnext/stock/doctype/stock_entry/stock_entry_utils.py
@@ -2,16 +2,42 @@
# See license.txt
+from typing import TYPE_CHECKING, Optional, overload
+
import frappe
from frappe.utils import cint, flt
from six import string_types
import erpnext
+if TYPE_CHECKING:
+ from erpnext.stock.doctype.stock_entry.stock_entry import StockEntry
+
+
+@overload
+def make_stock_entry(
+ *,
+ item_code: str,
+ qty: float,
+ company: Optional[str] = None,
+ from_warehouse: Optional[str] = None,
+ to_warehouse: Optional[str] = None,
+ rate: Optional[float] = None,
+ serial_no: Optional[str] = None,
+ batch_no: Optional[str] = None,
+ posting_date: Optional[str] = None,
+ posting_time: Optional[str] = None,
+ purpose: Optional[str] = None,
+ do_not_save: bool = False,
+ do_not_submit: bool = False,
+ inspection_required: bool = False,
+) -> "StockEntry":
+ ...
+
@frappe.whitelist()
def make_stock_entry(**args):
- '''Helper function to make a Stock Entry
+ """Helper function to make a Stock Entry
:item_code: Item to be moved
:qty: Qty to be moved
@@ -26,16 +52,16 @@ def make_stock_entry(**args):
:purpose: Optional
:do_not_save: Optional flag
:do_not_submit: Optional flag
- '''
+ """
def process_serial_numbers(serial_nos_list):
serial_nos_list = [
- '\n'.join(serial_num['serial_no'] for serial_num in serial_nos_list if serial_num.serial_no)
+ "\n".join(serial_num["serial_no"] for serial_num in serial_nos_list if serial_num.serial_no)
]
- uniques = list(set(serial_nos_list[0].split('\n')))
+ uniques = list(set(serial_nos_list[0].split("\n")))
- return '\n'.join(uniques)
+ return "\n".join(uniques)
s = frappe.new_doc("Stock Entry")
args = frappe._dict(args)
@@ -61,7 +87,7 @@ def make_stock_entry(**args):
s.apply_putaway_rule = args.apply_putaway_rule
if isinstance(args.qty, string_types):
- if '.' in args.qty:
+ if "." in args.qty:
args.qty = flt(args.qty)
else:
args.qty = cint(args.qty)
@@ -80,16 +106,16 @@ def make_stock_entry(**args):
# company
if not args.company:
if args.source:
- args.company = frappe.db.get_value('Warehouse', args.source, 'company')
+ args.company = frappe.db.get_value("Warehouse", args.source, "company")
elif args.target:
- args.company = frappe.db.get_value('Warehouse', args.target, 'company')
+ args.company = frappe.db.get_value("Warehouse", args.target, "company")
# set vales from test
if frappe.flags.in_test:
if not args.company:
- args.company = '_Test Company'
+ args.company = "_Test Company"
if not args.item:
- args.item = '_Test Item'
+ args.item = "_Test Item"
s.company = args.company or erpnext.get_default_company()
s.purchase_receipt_no = args.purchase_receipt_no
@@ -97,42 +123,43 @@ def make_stock_entry(**args):
s.sales_invoice_no = args.sales_invoice_no
s.is_opening = args.is_opening or "No"
if not args.cost_center:
- args.cost_center = frappe.get_value('Company', s.company, 'cost_center')
+ args.cost_center = frappe.get_value("Company", s.company, "cost_center")
if not args.expense_account and s.is_opening == "No":
- args.expense_account = frappe.get_value('Company', s.company, 'stock_adjustment_account')
+ args.expense_account = frappe.get_value("Company", s.company, "stock_adjustment_account")
# We can find out the serial number using the batch source document
serial_number = args.serial_no
if not args.serial_no and args.qty and args.batch_no:
serial_number_list = frappe.get_list(
- doctype='Stock Ledger Entry',
- fields=['serial_no'],
- filters={
- 'batch_no': args.batch_no,
- 'warehouse': args.from_warehouse
- }
+ doctype="Stock Ledger Entry",
+ fields=["serial_no"],
+ filters={"batch_no": args.batch_no, "warehouse": args.from_warehouse},
)
serial_number = process_serial_numbers(serial_number_list)
args.serial_no = serial_number
- s.append("items", {
- "item_code": args.item,
- "s_warehouse": args.source,
- "t_warehouse": args.target,
- "qty": args.qty,
- "basic_rate": args.rate or args.basic_rate,
- "conversion_factor": args.conversion_factor or 1.0,
- "transfer_qty": flt(args.qty) * (flt(args.conversion_factor) or 1.0),
- "serial_no": args.serial_no,
- 'batch_no': args.batch_no,
- 'cost_center': args.cost_center,
- 'expense_account': args.expense_account
- })
+ s.append(
+ "items",
+ {
+ "item_code": args.item,
+ "s_warehouse": args.source,
+ "t_warehouse": args.target,
+ "qty": args.qty,
+ "basic_rate": args.rate or args.basic_rate,
+ "conversion_factor": args.conversion_factor or 1.0,
+ "transfer_qty": flt(args.qty) * (flt(args.conversion_factor) or 1.0),
+ "serial_no": args.serial_no,
+ "batch_no": args.batch_no,
+ "cost_center": args.cost_center,
+ "expense_account": args.expense_account,
+ },
+ )
s.set_stock_entry_type()
+
if not args.do_not_save:
s.insert()
if not args.do_not_submit:
diff --git a/erpnext/stock/doctype/stock_entry/test_stock_entry.py b/erpnext/stock/doctype/stock_entry/test_stock_entry.py
index 642c2636130..64ea0435e16 100644
--- a/erpnext/stock/doctype/stock_entry/test_stock_entry.py
+++ b/erpnext/stock/doctype/stock_entry/test_stock_entry.py
@@ -2,21 +2,24 @@
# License: GNU General Public License v3. See license.txt
-import unittest
-
import frappe
from frappe.permissions import add_user_permission, remove_user_permission
-from frappe.utils import flt, nowdate, nowtime
+from frappe.tests.utils import FrappeTestCase, change_settings
+from frappe.utils import add_days, flt, nowdate, nowtime, today
from six import iteritems
from erpnext.accounts.doctype.account.test_account import get_inventory_account
from erpnext.stock.doctype.item.test_item import (
create_item,
+ make_item,
make_item_variant,
set_item_variant_settings,
)
from erpnext.stock.doctype.serial_no.serial_no import * # noqa
-from erpnext.stock.doctype.stock_entry.stock_entry import move_sample_to_retention_warehouse
+from erpnext.stock.doctype.stock_entry.stock_entry import (
+ FinishedGoodError,
+ move_sample_to_retention_warehouse,
+)
from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry
from erpnext.stock.doctype.stock_ledger_entry.stock_ledger_entry import StockFreezeError
from erpnext.stock.doctype.stock_reconciliation.stock_reconciliation import (
@@ -26,7 +29,6 @@ from erpnext.stock.doctype.stock_reconciliation.test_stock_reconciliation import
create_stock_reconciliation,
)
from erpnext.stock.stock_ledger import NegativeStockError, get_previous_sle
-from erpnext.tests.utils import ERPNextTestCase, change_settings
def get_sle(**args):
@@ -36,50 +38,56 @@ def get_sle(**args):
condition += "`{0}`=%s".format(key)
values.append(value)
- return frappe.db.sql("""select * from `tabStock Ledger Entry` %s
- order by timestamp(posting_date, posting_time) desc, creation desc limit 1"""% condition,
- values, as_dict=1)
+ return frappe.db.sql(
+ """select * from `tabStock Ledger Entry` %s
+ order by timestamp(posting_date, posting_time) desc, creation desc limit 1"""
+ % condition,
+ values,
+ as_dict=1,
+ )
-class TestStockEntry(ERPNextTestCase):
+
+class TestStockEntry(FrappeTestCase):
def tearDown(self):
+ frappe.db.rollback()
frappe.set_user("Administrator")
- frappe.db.set_value("Manufacturing Settings", None, "material_consumption", "0")
def test_fifo(self):
frappe.db.set_value("Stock Settings", None, "allow_negative_stock", 1)
item_code = "_Test Item 2"
warehouse = "_Test Warehouse - _TC"
- create_stock_reconciliation(item_code="_Test Item 2", warehouse="_Test Warehouse - _TC",
- qty=0, rate=100)
+ create_stock_reconciliation(
+ item_code="_Test Item 2", warehouse="_Test Warehouse - _TC", qty=0, rate=100
+ )
make_stock_entry(item_code=item_code, target=warehouse, qty=1, basic_rate=10)
- sle = get_sle(item_code = item_code, warehouse = warehouse)[0]
+ sle = get_sle(item_code=item_code, warehouse=warehouse)[0]
self.assertEqual([[1, 10]], frappe.safe_eval(sle.stock_queue))
# negative qty
make_stock_entry(item_code=item_code, source=warehouse, qty=2, basic_rate=10)
- sle = get_sle(item_code = item_code, warehouse = warehouse)[0]
+ sle = get_sle(item_code=item_code, warehouse=warehouse)[0]
self.assertEqual([[-1, 10]], frappe.safe_eval(sle.stock_queue))
# further negative
make_stock_entry(item_code=item_code, source=warehouse, qty=1)
- sle = get_sle(item_code = item_code, warehouse = warehouse)[0]
+ sle = get_sle(item_code=item_code, warehouse=warehouse)[0]
self.assertEqual([[-2, 10]], frappe.safe_eval(sle.stock_queue))
# move stock to positive
make_stock_entry(item_code=item_code, target=warehouse, qty=3, basic_rate=20)
- sle = get_sle(item_code = item_code, warehouse = warehouse)[0]
+ sle = get_sle(item_code=item_code, warehouse=warehouse)[0]
self.assertEqual([[1, 20]], frappe.safe_eval(sle.stock_queue))
# incoming entry with diff rate
make_stock_entry(item_code=item_code, target=warehouse, qty=1, basic_rate=30)
- sle = get_sle(item_code = item_code, warehouse = warehouse)[0]
+ sle = get_sle(item_code=item_code, warehouse=warehouse)[0]
- self.assertEqual([[1, 20],[1, 30]], frappe.safe_eval(sle.stock_queue))
+ self.assertEqual([[1, 20], [1, 30]], frappe.safe_eval(sle.stock_queue))
frappe.db.set_default("allow_negative_stock", 0)
@@ -89,37 +97,48 @@ class TestStockEntry(ERPNextTestCase):
self._test_auto_material_request("_Test Item", material_request_type="Transfer")
def test_auto_material_request_for_variant(self):
- fields = [{'field_name': 'reorder_levels'}]
+ fields = [{"field_name": "reorder_levels"}]
set_item_variant_settings(fields)
make_item_variant()
template = frappe.get_doc("Item", "_Test Variant Item")
if not template.reorder_levels:
- template.append('reorder_levels', {
- "material_request_type": "Purchase",
- "warehouse": "_Test Warehouse - _TC",
- "warehouse_reorder_level": 20,
- "warehouse_reorder_qty": 20
- })
+ template.append(
+ "reorder_levels",
+ {
+ "material_request_type": "Purchase",
+ "warehouse": "_Test Warehouse - _TC",
+ "warehouse_reorder_level": 20,
+ "warehouse_reorder_qty": 20,
+ },
+ )
template.save()
self._test_auto_material_request("_Test Variant Item-S")
def test_auto_material_request_for_warehouse_group(self):
- self._test_auto_material_request("_Test Item Warehouse Group Wise Reorder", warehouse="_Test Warehouse Group-C1 - _TC")
+ self._test_auto_material_request(
+ "_Test Item Warehouse Group Wise Reorder", warehouse="_Test Warehouse Group-C1 - _TC"
+ )
- def _test_auto_material_request(self, item_code, material_request_type="Purchase", warehouse="_Test Warehouse - _TC"):
+ def _test_auto_material_request(
+ self, item_code, material_request_type="Purchase", warehouse="_Test Warehouse - _TC"
+ ):
variant = frappe.get_doc("Item", item_code)
- projected_qty, actual_qty = frappe.db.get_value("Bin", {"item_code": item_code,
- "warehouse": warehouse}, ["projected_qty", "actual_qty"]) or [0, 0]
+ projected_qty, actual_qty = frappe.db.get_value(
+ "Bin", {"item_code": item_code, "warehouse": warehouse}, ["projected_qty", "actual_qty"]
+ ) or [0, 0]
# stock entry reqd for auto-reorder
- create_stock_reconciliation(item_code=item_code, warehouse=warehouse,
- qty = actual_qty + abs(projected_qty) + 10, rate=100)
+ create_stock_reconciliation(
+ item_code=item_code, warehouse=warehouse, qty=actual_qty + abs(projected_qty) + 10, rate=100
+ )
- projected_qty = frappe.db.get_value("Bin", {"item_code": item_code,
- "warehouse": warehouse}, "projected_qty") or 0
+ projected_qty = (
+ frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse}, "projected_qty")
+ or 0
+ )
frappe.db.set_value("Stock Settings", None, "auto_indent", 1)
@@ -130,6 +149,7 @@ class TestStockEntry(ERPNextTestCase):
variant.save()
from erpnext.stock.reorder_item import reorder_item
+
mr_list = reorder_item()
frappe.db.set_value("Stock Settings", None, "auto_indent", 0)
@@ -142,65 +162,113 @@ class TestStockEntry(ERPNextTestCase):
self.assertTrue(item_code in items)
def test_material_receipt_gl_entry(self):
- company = frappe.db.get_value('Warehouse', 'Stores - TCP1', 'company')
+ company = frappe.db.get_value("Warehouse", "Stores - TCP1", "company")
- mr = make_stock_entry(item_code="_Test Item", target="Stores - TCP1", company= company,
- qty=50, basic_rate=100, expense_account="Stock Adjustment - TCP1")
+ mr = make_stock_entry(
+ item_code="_Test Item",
+ target="Stores - TCP1",
+ company=company,
+ qty=50,
+ basic_rate=100,
+ expense_account="Stock Adjustment - TCP1",
+ )
stock_in_hand_account = get_inventory_account(mr.company, mr.get("items")[0].t_warehouse)
- self.check_stock_ledger_entries("Stock Entry", mr.name,
- [["_Test Item", "Stores - TCP1", 50.0]])
+ self.check_stock_ledger_entries("Stock Entry", mr.name, [["_Test Item", "Stores - TCP1", 50.0]])
- self.check_gl_entries("Stock Entry", mr.name,
- sorted([
- [stock_in_hand_account, 5000.0, 0.0],
- ["Stock Adjustment - TCP1", 0.0, 5000.0]
- ])
+ self.check_gl_entries(
+ "Stock Entry",
+ mr.name,
+ sorted([[stock_in_hand_account, 5000.0, 0.0], ["Stock Adjustment - TCP1", 0.0, 5000.0]]),
)
mr.cancel()
- self.assertTrue(frappe.db.sql("""select * from `tabStock Ledger Entry`
- where voucher_type='Stock Entry' and voucher_no=%s""", mr.name))
+ self.assertTrue(
+ frappe.db.sql(
+ """select * from `tabStock Ledger Entry`
+ where voucher_type='Stock Entry' and voucher_no=%s""",
+ mr.name,
+ )
+ )
- self.assertTrue(frappe.db.sql("""select * from `tabGL Entry`
- where voucher_type='Stock Entry' and voucher_no=%s""", mr.name))
+ self.assertTrue(
+ frappe.db.sql(
+ """select * from `tabGL Entry`
+ where voucher_type='Stock Entry' and voucher_no=%s""",
+ mr.name,
+ )
+ )
def test_material_issue_gl_entry(self):
- company = frappe.db.get_value('Warehouse', 'Stores - TCP1', 'company')
- make_stock_entry(item_code="_Test Item", target="Stores - TCP1", company= company,
- qty=50, basic_rate=100, expense_account="Stock Adjustment - TCP1")
+ company = frappe.db.get_value("Warehouse", "Stores - TCP1", "company")
+ make_stock_entry(
+ item_code="_Test Item",
+ target="Stores - TCP1",
+ company=company,
+ qty=50,
+ basic_rate=100,
+ expense_account="Stock Adjustment - TCP1",
+ )
- mi = make_stock_entry(item_code="_Test Item", source="Stores - TCP1", company=company,
- qty=40, expense_account="Stock Adjustment - TCP1")
+ mi = make_stock_entry(
+ item_code="_Test Item",
+ source="Stores - TCP1",
+ company=company,
+ qty=40,
+ expense_account="Stock Adjustment - TCP1",
+ )
- self.check_stock_ledger_entries("Stock Entry", mi.name,
- [["_Test Item", "Stores - TCP1", -40.0]])
+ self.check_stock_ledger_entries("Stock Entry", mi.name, [["_Test Item", "Stores - TCP1", -40.0]])
stock_in_hand_account = get_inventory_account(mi.company, "Stores - TCP1")
- stock_value_diff = abs(frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Stock Entry",
- "voucher_no": mi.name}, "stock_value_difference"))
+ stock_value_diff = abs(
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Stock Entry", "voucher_no": mi.name},
+ "stock_value_difference",
+ )
+ )
- self.check_gl_entries("Stock Entry", mi.name,
- sorted([
- [stock_in_hand_account, 0.0, stock_value_diff],
- ["Stock Adjustment - TCP1", stock_value_diff, 0.0]
- ])
+ self.check_gl_entries(
+ "Stock Entry",
+ mi.name,
+ sorted(
+ [
+ [stock_in_hand_account, 0.0, stock_value_diff],
+ ["Stock Adjustment - TCP1", stock_value_diff, 0.0],
+ ]
+ ),
)
mi.cancel()
def test_material_transfer_gl_entry(self):
- company = frappe.db.get_value('Warehouse', 'Stores - TCP1', 'company')
+ company = frappe.db.get_value("Warehouse", "Stores - TCP1", "company")
- item_code = 'Hand Sanitizer - 001'
- create_item(item_code =item_code, is_stock_item = 1,
- is_purchase_item=1, opening_stock=1000, valuation_rate=10, company=company, warehouse="Stores - TCP1")
+ item_code = "Hand Sanitizer - 001"
+ create_item(
+ item_code=item_code,
+ is_stock_item=1,
+ is_purchase_item=1,
+ opening_stock=1000,
+ valuation_rate=10,
+ company=company,
+ warehouse="Stores - TCP1",
+ )
- mtn = make_stock_entry(item_code=item_code, source="Stores - TCP1",
- target="Finished Goods - TCP1", qty=45, company=company)
+ mtn = make_stock_entry(
+ item_code=item_code,
+ source="Stores - TCP1",
+ target="Finished Goods - TCP1",
+ qty=45,
+ company=company,
+ )
- self.check_stock_ledger_entries("Stock Entry", mtn.name,
- [[item_code, "Stores - TCP1", -45.0], [item_code, "Finished Goods - TCP1", 45.0]])
+ self.check_stock_ledger_entries(
+ "Stock Entry",
+ mtn.name,
+ [[item_code, "Stores - TCP1", -45.0], [item_code, "Finished Goods - TCP1", 45.0]],
+ )
source_warehouse_account = get_inventory_account(mtn.company, mtn.get("items")[0].s_warehouse)
@@ -208,28 +276,85 @@ class TestStockEntry(ERPNextTestCase):
if source_warehouse_account == target_warehouse_account:
# no gl entry as both source and target warehouse has linked to same account.
- self.assertFalse(frappe.db.sql("""select * from `tabGL Entry`
- where voucher_type='Stock Entry' and voucher_no=%s""", mtn.name, as_dict=1))
+ self.assertFalse(
+ frappe.db.sql(
+ """select * from `tabGL Entry`
+ where voucher_type='Stock Entry' and voucher_no=%s""",
+ mtn.name,
+ as_dict=1,
+ )
+ )
else:
- stock_value_diff = abs(frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Stock Entry",
- "voucher_no": mtn.name, "warehouse": "Stores - TCP1"}, "stock_value_difference"))
+ stock_value_diff = abs(
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Stock Entry", "voucher_no": mtn.name, "warehouse": "Stores - TCP1"},
+ "stock_value_difference",
+ )
+ )
- self.check_gl_entries("Stock Entry", mtn.name,
- sorted([
- [source_warehouse_account, 0.0, stock_value_diff],
- [target_warehouse_account, stock_value_diff, 0.0],
- ])
+ self.check_gl_entries(
+ "Stock Entry",
+ mtn.name,
+ sorted(
+ [
+ [source_warehouse_account, 0.0, stock_value_diff],
+ [target_warehouse_account, stock_value_diff, 0.0],
+ ]
+ ),
)
mtn.cancel()
- def test_repack_no_change_in_valuation(self):
- company = frappe.db.get_value('Warehouse', '_Test Warehouse - _TC', 'company')
+ def test_repack_multiple_fg(self):
+ "Test `is_finished_item` for one item repacked into two items."
+ make_stock_entry(item_code="_Test Item", target="_Test Warehouse - _TC", qty=100, basic_rate=100)
+ repack = frappe.copy_doc(test_records[3])
+ repack.posting_date = nowdate()
+ repack.posting_time = nowtime()
+
+ repack.items[0].qty = 100.0
+ repack.items[0].transfer_qty = 100.0
+ repack.items[1].qty = 50.0
+
+ repack.append(
+ "items",
+ {
+ "conversion_factor": 1.0,
+ "cost_center": "_Test Cost Center - _TC",
+ "doctype": "Stock Entry Detail",
+ "expense_account": "Stock Adjustment - _TC",
+ "basic_rate": 150,
+ "item_code": "_Test Item 2",
+ "parentfield": "items",
+ "qty": 50.0,
+ "stock_uom": "_Test UOM",
+ "t_warehouse": "_Test Warehouse - _TC",
+ "transfer_qty": 50.0,
+ "uom": "_Test UOM",
+ },
+ )
+ repack.set_stock_entry_type()
+ repack.insert()
+
+ self.assertEqual(repack.items[1].is_finished_item, 1)
+ self.assertEqual(repack.items[2].is_finished_item, 1)
+
+ repack.items[1].is_finished_item = 0
+ repack.items[2].is_finished_item = 0
+
+ # must raise error if 0 fg in repack entry
+ self.assertRaises(FinishedGoodError, repack.validate_finished_goods)
+
+ repack.delete() # teardown
+
+ def test_repack_no_change_in_valuation(self):
make_stock_entry(item_code="_Test Item", target="_Test Warehouse - _TC", qty=50, basic_rate=100)
- make_stock_entry(item_code="_Test Item Home Desktop 100", target="_Test Warehouse - _TC",
- qty=50, basic_rate=100)
+ make_stock_entry(
+ item_code="_Test Item Home Desktop 100", target="_Test Warehouse - _TC", qty=50, basic_rate=100
+ )
repack = frappe.copy_doc(test_records[3])
repack.posting_date = nowdate()
@@ -238,76 +363,113 @@ class TestStockEntry(ERPNextTestCase):
repack.insert()
repack.submit()
- self.check_stock_ledger_entries("Stock Entry", repack.name,
- [["_Test Item", "_Test Warehouse - _TC", -50.0],
- ["_Test Item Home Desktop 100", "_Test Warehouse - _TC", 1]])
+ self.check_stock_ledger_entries(
+ "Stock Entry",
+ repack.name,
+ [
+ ["_Test Item", "_Test Warehouse - _TC", -50.0],
+ ["_Test Item Home Desktop 100", "_Test Warehouse - _TC", 1],
+ ],
+ )
- gl_entries = frappe.db.sql("""select account, debit, credit
+ gl_entries = frappe.db.sql(
+ """select account, debit, credit
from `tabGL Entry` where voucher_type='Stock Entry' and voucher_no=%s
- order by account desc""", repack.name, as_dict=1)
+ order by account desc""",
+ repack.name,
+ as_dict=1,
+ )
self.assertFalse(gl_entries)
def test_repack_with_additional_costs(self):
- company = frappe.db.get_value('Warehouse', 'Stores - TCP1', 'company')
+ company = frappe.db.get_value("Warehouse", "Stores - TCP1", "company")
- make_stock_entry(item_code="_Test Item", target="Stores - TCP1", company= company,
- qty=50, basic_rate=100, expense_account="Stock Adjustment - TCP1")
+ make_stock_entry(
+ item_code="_Test Item",
+ target="Stores - TCP1",
+ company=company,
+ qty=50,
+ basic_rate=100,
+ expense_account="Stock Adjustment - TCP1",
+ )
-
- repack = make_stock_entry(company = company, purpose="Repack", do_not_save=True)
+ repack = make_stock_entry(company=company, purpose="Repack", do_not_save=True)
repack.posting_date = nowdate()
repack.posting_time = nowtime()
- expenses_included_in_valuation = frappe.get_value("Company", company, "expenses_included_in_valuation")
+ expenses_included_in_valuation = frappe.get_value(
+ "Company", company, "expenses_included_in_valuation"
+ )
items = get_multiple_items()
repack.items = []
for item in items:
repack.append("items", item)
- repack.set("additional_costs", [
- {
- "expense_account": expenses_included_in_valuation,
- "description": "Actual Operating Cost",
- "amount": 1000
- },
- {
- "expense_account": expenses_included_in_valuation,
- "description": "Additional Operating Cost",
- "amount": 200
- },
- ])
+ repack.set(
+ "additional_costs",
+ [
+ {
+ "expense_account": expenses_included_in_valuation,
+ "description": "Actual Operating Cost",
+ "amount": 1000,
+ },
+ {
+ "expense_account": expenses_included_in_valuation,
+ "description": "Additional Operating Cost",
+ "amount": 200,
+ },
+ ],
+ )
repack.set_stock_entry_type()
repack.insert()
repack.submit()
stock_in_hand_account = get_inventory_account(repack.company, repack.get("items")[1].t_warehouse)
- rm_stock_value_diff = abs(frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Stock Entry",
- "voucher_no": repack.name, "item_code": "_Test Item"}, "stock_value_difference"))
+ rm_stock_value_diff = abs(
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Stock Entry", "voucher_no": repack.name, "item_code": "_Test Item"},
+ "stock_value_difference",
+ )
+ )
- fg_stock_value_diff = abs(frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Stock Entry",
- "voucher_no": repack.name, "item_code": "_Test Item Home Desktop 100"}, "stock_value_difference"))
+ fg_stock_value_diff = abs(
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {
+ "voucher_type": "Stock Entry",
+ "voucher_no": repack.name,
+ "item_code": "_Test Item Home Desktop 100",
+ },
+ "stock_value_difference",
+ )
+ )
stock_value_diff = flt(fg_stock_value_diff - rm_stock_value_diff, 2)
self.assertEqual(stock_value_diff, 1200)
- self.check_gl_entries("Stock Entry", repack.name,
- sorted([
- [stock_in_hand_account, 1200, 0.0],
- ["Expenses Included In Valuation - TCP1", 0.0, 1200.0]
- ])
+ self.check_gl_entries(
+ "Stock Entry",
+ repack.name,
+ sorted(
+ [[stock_in_hand_account, 1200, 0.0], ["Expenses Included In Valuation - TCP1", 0.0, 1200.0]]
+ ),
)
def check_stock_ledger_entries(self, voucher_type, voucher_no, expected_sle):
expected_sle.sort(key=lambda x: x[1])
# check stock ledger entries
- sle = frappe.db.sql("""select item_code, warehouse, actual_qty
+ sle = frappe.db.sql(
+ """select item_code, warehouse, actual_qty
from `tabStock Ledger Entry` where voucher_type = %s
and voucher_no = %s order by item_code, warehouse, actual_qty""",
- (voucher_type, voucher_no), as_list=1)
+ (voucher_type, voucher_no),
+ as_list=1,
+ )
self.assertTrue(sle)
sle.sort(key=lambda x: x[1])
@@ -319,9 +481,13 @@ class TestStockEntry(ERPNextTestCase):
def check_gl_entries(self, voucher_type, voucher_no, expected_gl_entries):
expected_gl_entries.sort(key=lambda x: x[0])
- gl_entries = frappe.db.sql("""select account, debit, credit
+ gl_entries = frappe.db.sql(
+ """select account, debit, credit
from `tabGL Entry` where voucher_type=%s and voucher_no=%s
- order by account asc, debit asc""", (voucher_type, voucher_no), as_list=1)
+ order by account asc, debit asc""",
+ (voucher_type, voucher_no),
+ as_list=1,
+ )
self.assertTrue(gl_entries)
gl_entries.sort(key=lambda x: x[0])
@@ -422,7 +588,7 @@ class TestStockEntry(ERPNextTestCase):
def test_serial_item_error(self):
se, serial_nos = self.test_serial_by_series()
- if not frappe.db.exists('Serial No', 'ABCD'):
+ if not frappe.db.exists("Serial No", "ABCD"):
make_serialized_item(item_code="_Test Serialized Item", serial_no="ABCD\nEFGH")
se = frappe.copy_doc(test_records[0])
@@ -452,10 +618,14 @@ class TestStockEntry(ERPNextTestCase):
se.set_stock_entry_type()
se.insert()
se.submit()
- self.assertTrue(frappe.db.get_value("Serial No", serial_no, "warehouse"), "_Test Warehouse 1 - _TC")
+ self.assertTrue(
+ frappe.db.get_value("Serial No", serial_no, "warehouse"), "_Test Warehouse 1 - _TC"
+ )
se.cancel()
- self.assertTrue(frappe.db.get_value("Serial No", serial_no, "warehouse"), "_Test Warehouse - _TC")
+ self.assertTrue(
+ frappe.db.get_value("Serial No", serial_no, "warehouse"), "_Test Warehouse - _TC"
+ )
def test_serial_warehouse_error(self):
make_serialized_item(target_warehouse="_Test Warehouse 1 - _TC")
@@ -482,15 +652,115 @@ class TestStockEntry(ERPNextTestCase):
serial_no = get_serial_nos(se.get("items")[0].serial_no)[0]
self.assertFalse(frappe.db.get_value("Serial No", serial_no, "warehouse"))
+ def test_serial_batch_item_stock_entry(self):
+ """
+ Behaviour: 1) Submit Stock Entry (Receipt) with Serial & Batched Item
+ 2) Cancel same Stock Entry
+ Expected Result: 1) Batch is created with Reference in Serial No
+ 2) Batch is deleted and Serial No is Inactive
+ """
+ from erpnext.stock.doctype.batch.batch import get_batch_qty
+
+ item = frappe.db.exists("Item", {"item_name": "Batched and Serialised Item"})
+ if not item:
+ item = create_item("Batched and Serialised Item")
+ item.has_batch_no = 1
+ item.create_new_batch = 1
+ item.has_serial_no = 1
+ item.batch_number_series = "B-BATCH-.##"
+ item.serial_no_series = "S-.####"
+ item.save()
+ else:
+ item = frappe.get_doc("Item", {"item_name": "Batched and Serialised Item"})
+
+ se = make_stock_entry(
+ item_code=item.item_code, target="_Test Warehouse - _TC", qty=1, basic_rate=100
+ )
+ batch_no = se.items[0].batch_no
+ serial_no = get_serial_nos(se.items[0].serial_no)[0]
+ batch_qty = get_batch_qty(batch_no, "_Test Warehouse - _TC", item.item_code)
+
+ batch_in_serial_no = frappe.db.get_value("Serial No", serial_no, "batch_no")
+ self.assertEqual(batch_in_serial_no, batch_no)
+
+ self.assertEqual(batch_qty, 1)
+
+ se.cancel()
+
+ batch_in_serial_no = frappe.db.get_value("Serial No", serial_no, "batch_no")
+ self.assertEqual(batch_in_serial_no, None)
+
+ self.assertEqual(frappe.db.get_value("Serial No", serial_no, "status"), "Inactive")
+ self.assertEqual(frappe.db.exists("Batch", batch_no), None)
+
+ def test_serial_batch_item_qty_deduction(self):
+ """
+ Behaviour: Create 2 Stock Entries, both adding Serial Nos to same batch
+ Expected: 1) Cancelling first Stock Entry (origin transaction of created batch)
+ should throw a LinkExistsError
+ 2) Cancelling second Stock Entry should make Serial Nos that are, linked to mentioned batch
+ and in that transaction only, Inactive.
+ """
+ from erpnext.stock.doctype.batch.batch import get_batch_qty
+
+ item = frappe.db.exists("Item", {"item_name": "Batched and Serialised Item"})
+ if not item:
+ item = create_item("Batched and Serialised Item")
+ item.has_batch_no = 1
+ item.create_new_batch = 1
+ item.has_serial_no = 1
+ item.batch_number_series = "B-BATCH-.##"
+ item.serial_no_series = "S-.####"
+ item.save()
+ else:
+ item = frappe.get_doc("Item", {"item_name": "Batched and Serialised Item"})
+
+ se1 = make_stock_entry(
+ item_code=item.item_code, target="_Test Warehouse - _TC", qty=1, basic_rate=100
+ )
+ batch_no = se1.items[0].batch_no
+ serial_no1 = get_serial_nos(se1.items[0].serial_no)[0]
+
+ # Check Source (Origin) Document of Batch
+ self.assertEqual(frappe.db.get_value("Batch", batch_no, "reference_name"), se1.name)
+
+ se2 = make_stock_entry(
+ item_code=item.item_code,
+ target="_Test Warehouse - _TC",
+ qty=1,
+ basic_rate=100,
+ batch_no=batch_no,
+ )
+ serial_no2 = get_serial_nos(se2.items[0].serial_no)[0]
+
+ batch_qty = get_batch_qty(batch_no, "_Test Warehouse - _TC", item.item_code)
+ self.assertEqual(batch_qty, 2)
+
+ se2.cancel()
+
+ # Check decrease in Batch Qty
+ batch_qty = get_batch_qty(batch_no, "_Test Warehouse - _TC", item.item_code)
+ self.assertEqual(batch_qty, 1)
+
+ # Check if Serial No from Stock Entry 1 is intact
+ self.assertEqual(frappe.db.get_value("Serial No", serial_no1, "batch_no"), batch_no)
+ self.assertEqual(frappe.db.get_value("Serial No", serial_no1, "status"), "Active")
+
+ # Check if Serial No from Stock Entry 2 is Unlinked and Inactive
+ self.assertEqual(frappe.db.get_value("Serial No", serial_no2, "batch_no"), None)
+ self.assertEqual(frappe.db.get_value("Serial No", serial_no2, "status"), "Inactive")
+
def test_warehouse_company_validation(self):
- company = frappe.db.get_value('Warehouse', '_Test Warehouse 2 - _TC1', 'company')
- frappe.get_doc("User", "test2@example.com")\
- .add_roles("Sales User", "Sales Manager", "Stock User", "Stock Manager")
+ company = frappe.db.get_value("Warehouse", "_Test Warehouse 2 - _TC1", "company")
+ frappe.get_doc("User", "test2@example.com").add_roles(
+ "Sales User", "Sales Manager", "Stock User", "Stock Manager"
+ )
frappe.set_user("test2@example.com")
from erpnext.stock.utils import InvalidWarehouseCompany
+
st1 = frappe.copy_doc(test_records[0])
- st1.get("items")[0].t_warehouse="_Test Warehouse 2 - _TC1"
+ st1.get("items")[0].t_warehouse = "_Test Warehouse 2 - _TC1"
st1.set_stock_entry_type()
st1.insert()
self.assertRaises(InvalidWarehouseCompany, st1.submit)
@@ -504,14 +774,15 @@ class TestStockEntry(ERPNextTestCase):
test_user.add_roles("Sales User", "Sales Manager", "Stock User")
test_user.remove_roles("Stock Manager", "System Manager")
- frappe.get_doc("User", "test2@example.com")\
- .add_roles("Sales User", "Sales Manager", "Stock User", "Stock Manager")
+ frappe.get_doc("User", "test2@example.com").add_roles(
+ "Sales User", "Sales Manager", "Stock User", "Stock Manager"
+ )
st1 = frappe.copy_doc(test_records[0])
st1.company = "_Test Company 1"
frappe.set_user("test@example.com")
- st1.get("items")[0].t_warehouse="_Test Warehouse 2 - _TC1"
+ st1.get("items")[0].t_warehouse = "_Test Warehouse 2 - _TC1"
self.assertRaises(frappe.PermissionError, st1.insert)
test_user.add_roles("System Manager")
@@ -519,12 +790,13 @@ class TestStockEntry(ERPNextTestCase):
frappe.set_user("test2@example.com")
st1 = frappe.copy_doc(test_records[0])
st1.company = "_Test Company 1"
- st1.get("items")[0].t_warehouse="_Test Warehouse 2 - _TC1"
+ st1.get("items")[0].t_warehouse = "_Test Warehouse 2 - _TC1"
st1.get("items")[0].expense_account = "Stock Adjustment - _TC1"
st1.get("items")[0].cost_center = "Main - _TC1"
st1.set_stock_entry_type()
st1.insert()
st1.submit()
+ st1.cancel()
frappe.set_user("Administrator")
remove_user_permission("Warehouse", "_Test Warehouse 1 - _TC", "test@example.com")
@@ -532,14 +804,14 @@ class TestStockEntry(ERPNextTestCase):
remove_user_permission("Company", "_Test Company 1", "test2@example.com")
def test_freeze_stocks(self):
- frappe.db.set_value('Stock Settings', None,'stock_auth_role', '')
+ frappe.db.set_value("Stock Settings", None, "stock_auth_role", "")
# test freeze_stocks_upto
frappe.db.set_value("Stock Settings", None, "stock_frozen_upto", add_days(nowdate(), 5))
se = frappe.copy_doc(test_records[0]).insert()
self.assertRaises(StockFreezeError, se.submit)
- frappe.db.set_value("Stock Settings", None, "stock_frozen_upto", '')
+ frappe.db.set_value("Stock Settings", None, "stock_frozen_upto", "")
# test freeze_stocks_upto_days
frappe.db.set_value("Stock Settings", None, "stock_frozen_upto_days", -1)
@@ -555,20 +827,24 @@ class TestStockEntry(ERPNextTestCase):
from erpnext.manufacturing.doctype.work_order.work_order import (
make_stock_entry as _make_stock_entry,
)
- bom_no, bom_operation_cost = frappe.db.get_value("BOM", {"item": "_Test FG Item 2",
- "is_default": 1, "docstatus": 1}, ["name", "operating_cost"])
+
+ bom_no, bom_operation_cost = frappe.db.get_value(
+ "BOM", {"item": "_Test FG Item 2", "is_default": 1, "docstatus": 1}, ["name", "operating_cost"]
+ )
work_order = frappe.new_doc("Work Order")
- work_order.update({
- "company": "_Test Company",
- "fg_warehouse": "_Test Warehouse 1 - _TC",
- "production_item": "_Test FG Item 2",
- "bom_no": bom_no,
- "qty": 1.0,
- "stock_uom": "_Test UOM",
- "wip_warehouse": "_Test Warehouse - _TC",
- "additional_operating_cost": 1000
- })
+ work_order.update(
+ {
+ "company": "_Test Company",
+ "fg_warehouse": "_Test Warehouse 1 - _TC",
+ "production_item": "_Test FG Item 2",
+ "bom_no": bom_no,
+ "qty": 1.0,
+ "stock_uom": "_Test UOM",
+ "wip_warehouse": "_Test Warehouse - _TC",
+ "additional_operating_cost": 1000,
+ }
+ )
work_order.insert()
work_order.submit()
@@ -581,37 +857,40 @@ class TestStockEntry(ERPNextTestCase):
for d in stock_entry.get("items"):
if d.item_code != "_Test FG Item 2":
rm_cost += flt(d.amount)
- fg_cost = list(filter(lambda x: x.item_code=="_Test FG Item 2", stock_entry.get("items")))[0].amount
- self.assertEqual(fg_cost,
- flt(rm_cost + bom_operation_cost + work_order.additional_operating_cost, 2))
+ fg_cost = list(filter(lambda x: x.item_code == "_Test FG Item 2", stock_entry.get("items")))[
+ 0
+ ].amount
+ self.assertEqual(
+ fg_cost, flt(rm_cost + bom_operation_cost + work_order.additional_operating_cost, 2)
+ )
+ @change_settings("Manufacturing Settings", {"material_consumption": 1})
def test_work_order_manufacture_with_material_consumption(self):
from erpnext.manufacturing.doctype.work_order.work_order import (
make_stock_entry as _make_stock_entry,
)
- frappe.db.set_value("Manufacturing Settings", None, "material_consumption", "1")
- bom_no = frappe.db.get_value("BOM", {"item": "_Test FG Item",
- "is_default": 1, "docstatus": 1})
+ bom_no = frappe.db.get_value("BOM", {"item": "_Test FG Item", "is_default": 1, "docstatus": 1})
work_order = frappe.new_doc("Work Order")
- work_order.update({
- "company": "_Test Company",
- "fg_warehouse": "_Test Warehouse 1 - _TC",
- "production_item": "_Test FG Item",
- "bom_no": bom_no,
- "qty": 1.0,
- "stock_uom": "_Test UOM",
- "wip_warehouse": "_Test Warehouse - _TC"
- })
+ work_order.update(
+ {
+ "company": "_Test Company",
+ "fg_warehouse": "_Test Warehouse 1 - _TC",
+ "production_item": "_Test FG Item",
+ "bom_no": bom_no,
+ "qty": 1.0,
+ "stock_uom": "_Test UOM",
+ "wip_warehouse": "_Test Warehouse - _TC",
+ }
+ )
work_order.insert()
work_order.submit()
- make_stock_entry(item_code="_Test Item",
- target="Stores - _TC", qty=10, basic_rate=5000.0)
- make_stock_entry(item_code="_Test Item Home Desktop 100",
- target="Stores - _TC", qty=10, basic_rate=1000.0)
-
+ make_stock_entry(item_code="_Test Item", target="Stores - _TC", qty=10, basic_rate=5000.0)
+ make_stock_entry(
+ item_code="_Test Item Home Desktop 100", target="Stores - _TC", qty=10, basic_rate=1000.0
+ )
s = frappe.get_doc(_make_stock_entry(work_order.name, "Material Transfer for Manufacture", 1))
for d in s.get("items"):
@@ -623,13 +902,12 @@ class TestStockEntry(ERPNextTestCase):
s = frappe.get_doc(_make_stock_entry(work_order.name, "Manufacture", 1))
s.save()
rm_cost = 0
- for d in s.get('items'):
+ for d in s.get("items"):
if d.s_warehouse:
rm_cost += d.amount
- fg_cost = list(filter(lambda x: x.item_code=="_Test FG Item", s.get("items")))[0].amount
+ fg_cost = list(filter(lambda x: x.item_code == "_Test FG Item", s.get("items")))[0].amount
scrap_cost = list(filter(lambda x: x.is_scrap_item, s.get("items")))[0].amount
- self.assertEqual(fg_cost,
- flt(rm_cost - scrap_cost, 2))
+ self.assertEqual(fg_cost, flt(rm_cost - scrap_cost, 2))
# When Stock Entry has only FG + Scrap
s.items.pop(0)
@@ -637,29 +915,34 @@ class TestStockEntry(ERPNextTestCase):
s.submit()
rm_cost = 0
- for d in s.get('items'):
+ for d in s.get("items"):
if d.s_warehouse:
rm_cost += d.amount
self.assertEqual(rm_cost, 0)
expected_fg_cost = s.get_basic_rate_for_manufactured_item(1)
- fg_cost = list(filter(lambda x: x.item_code=="_Test FG Item", s.get("items")))[0].amount
+ fg_cost = list(filter(lambda x: x.item_code == "_Test FG Item", s.get("items")))[0].amount
self.assertEqual(flt(fg_cost, 2), flt(expected_fg_cost, 2))
def test_variant_work_order(self):
- bom_no = frappe.db.get_value("BOM", {"item": "_Test Variant Item",
- "is_default": 1, "docstatus": 1})
+ bom_no = frappe.db.get_value(
+ "BOM", {"item": "_Test Variant Item", "is_default": 1, "docstatus": 1}
+ )
+
+ make_item_variant() # make variant of _Test Variant Item if absent
work_order = frappe.new_doc("Work Order")
- work_order.update({
- "company": "_Test Company",
- "fg_warehouse": "_Test Warehouse 1 - _TC",
- "production_item": "_Test Variant Item-S",
- "bom_no": bom_no,
- "qty": 1.0,
- "stock_uom": "_Test UOM",
- "wip_warehouse": "_Test Warehouse - _TC",
- "skip_transfer": 1
- })
+ work_order.update(
+ {
+ "company": "_Test Company",
+ "fg_warehouse": "_Test Warehouse 1 - _TC",
+ "production_item": "_Test Variant Item-S",
+ "bom_no": bom_no,
+ "qty": 1.0,
+ "stock_uom": "_Test UOM",
+ "wip_warehouse": "_Test Warehouse - _TC",
+ "skip_transfer": 1,
+ }
+ )
work_order.insert()
work_order.submit()
@@ -673,19 +956,29 @@ class TestStockEntry(ERPNextTestCase):
s1 = make_serialized_item(target_warehouse="_Test Warehouse - _TC")
serial_nos = s1.get("items")[0].serial_no
- s2 = make_stock_entry(item_code="_Test Serialized Item With Series", source="_Test Warehouse - _TC",
- qty=2, basic_rate=100, purpose="Repack", serial_no=serial_nos, do_not_save=True)
+ s2 = make_stock_entry(
+ item_code="_Test Serialized Item With Series",
+ source="_Test Warehouse - _TC",
+ qty=2,
+ basic_rate=100,
+ purpose="Repack",
+ serial_no=serial_nos,
+ do_not_save=True,
+ )
- s2.append("items", {
- "item_code": "_Test Serialized Item",
- "t_warehouse": "_Test Warehouse - _TC",
- "qty": 2,
- "basic_rate": 120,
- "expense_account": "Stock Adjustment - _TC",
- "conversion_factor": 1.0,
- "cost_center": "_Test Cost Center - _TC",
- "serial_no": serial_nos
- })
+ s2.append(
+ "items",
+ {
+ "item_code": "_Test Serialized Item",
+ "t_warehouse": "_Test Warehouse - _TC",
+ "qty": 2,
+ "basic_rate": 120,
+ "expense_account": "Stock Adjustment - _TC",
+ "conversion_factor": 1.0,
+ "cost_center": "_Test Cost Center - _TC",
+ "serial_no": serial_nos,
+ },
+ )
s2.submit()
s2.cancel()
@@ -695,10 +988,15 @@ class TestStockEntry(ERPNextTestCase):
from erpnext.stock.doctype.warehouse.test_warehouse import create_warehouse
create_warehouse("Test Warehouse for Sample Retention")
- frappe.db.set_value("Stock Settings", None, "sample_retention_warehouse", "Test Warehouse for Sample Retention - _TC")
+ frappe.db.set_value(
+ "Stock Settings",
+ None,
+ "sample_retention_warehouse",
+ "Test Warehouse for Sample Retention - _TC",
+ )
test_item_code = "Retain Sample Item"
- if not frappe.db.exists('Item', test_item_code):
+ if not frappe.db.exists("Item", test_item_code):
item = frappe.new_doc("Item")
item.item_code = test_item_code
item.item_name = "Retain Sample Item"
@@ -714,44 +1012,58 @@ class TestStockEntry(ERPNextTestCase):
receipt_entry = frappe.new_doc("Stock Entry")
receipt_entry.company = "_Test Company"
receipt_entry.purpose = "Material Receipt"
- receipt_entry.append("items", {
- "item_code": test_item_code,
- "t_warehouse": "_Test Warehouse - _TC",
- "qty": 40,
- "basic_rate": 12,
- "cost_center": "_Test Cost Center - _TC",
- "sample_quantity": 4
- })
+ receipt_entry.append(
+ "items",
+ {
+ "item_code": test_item_code,
+ "t_warehouse": "_Test Warehouse - _TC",
+ "qty": 40,
+ "basic_rate": 12,
+ "cost_center": "_Test Cost Center - _TC",
+ "sample_quantity": 4,
+ },
+ )
receipt_entry.set_stock_entry_type()
receipt_entry.insert()
receipt_entry.submit()
- retention_data = move_sample_to_retention_warehouse(receipt_entry.company, receipt_entry.get("items"))
+ retention_data = move_sample_to_retention_warehouse(
+ receipt_entry.company, receipt_entry.get("items")
+ )
retention_entry = frappe.new_doc("Stock Entry")
retention_entry.company = retention_data.company
retention_entry.purpose = retention_data.purpose
- retention_entry.append("items", {
- "item_code": test_item_code,
- "t_warehouse": "Test Warehouse for Sample Retention - _TC",
- "s_warehouse": "_Test Warehouse - _TC",
- "qty": 4,
- "basic_rate": 12,
- "cost_center": "_Test Cost Center - _TC",
- "batch_no": receipt_entry.get("items")[0].batch_no
- })
+ retention_entry.append(
+ "items",
+ {
+ "item_code": test_item_code,
+ "t_warehouse": "Test Warehouse for Sample Retention - _TC",
+ "s_warehouse": "_Test Warehouse - _TC",
+ "qty": 4,
+ "basic_rate": 12,
+ "cost_center": "_Test Cost Center - _TC",
+ "batch_no": receipt_entry.get("items")[0].batch_no,
+ },
+ )
retention_entry.set_stock_entry_type()
retention_entry.insert()
retention_entry.submit()
- qty_in_usable_warehouse = get_batch_qty(receipt_entry.get("items")[0].batch_no, "_Test Warehouse - _TC", "_Test Item")
- qty_in_retention_warehouse = get_batch_qty(receipt_entry.get("items")[0].batch_no, "Test Warehouse for Sample Retention - _TC", "_Test Item")
+ qty_in_usable_warehouse = get_batch_qty(
+ receipt_entry.get("items")[0].batch_no, "_Test Warehouse - _TC", "_Test Item"
+ )
+ qty_in_retention_warehouse = get_batch_qty(
+ receipt_entry.get("items")[0].batch_no,
+ "Test Warehouse for Sample Retention - _TC",
+ "_Test Item",
+ )
self.assertEqual(qty_in_usable_warehouse, 36)
self.assertEqual(qty_in_retention_warehouse, 4)
def test_quality_check(self):
item_code = "_Test Item For QC"
- if not frappe.db.exists('Item', item_code):
+ if not frappe.db.exists("Item", item_code):
create_item(item_code)
repack = frappe.copy_doc(test_records[3])
@@ -767,54 +1079,64 @@ class TestStockEntry(ERPNextTestCase):
repack.insert()
self.assertRaises(frappe.ValidationError, repack.submit)
- # def test_material_consumption(self):
- # frappe.db.set_value("Manufacturing Settings", None, "backflush_raw_materials_based_on", "BOM")
- # frappe.db.set_value("Manufacturing Settings", None, "material_consumption", "0")
-
- # from erpnext.manufacturing.doctype.work_order.work_order \
- # import make_stock_entry as _make_stock_entry
- # bom_no = frappe.db.get_value("BOM", {"item": "_Test FG Item 2",
- # "is_default": 1, "docstatus": 1})
-
- # work_order = frappe.new_doc("Work Order")
- # work_order.update({
- # "company": "_Test Company",
- # "fg_warehouse": "_Test Warehouse 1 - _TC",
- # "production_item": "_Test FG Item 2",
- # "bom_no": bom_no,
- # "qty": 4.0,
- # "stock_uom": "_Test UOM",
- # "wip_warehouse": "_Test Warehouse - _TC",
- # "additional_operating_cost": 1000,
- # "use_multi_level_bom": 1
- # })
- # work_order.insert()
- # work_order.submit()
-
- # make_stock_entry(item_code="_Test Serialized Item With Series", target="_Test Warehouse - _TC", qty=50, basic_rate=100)
- # make_stock_entry(item_code="_Test Item 2", target="_Test Warehouse - _TC", qty=50, basic_rate=20)
-
- # item_quantity = {
- # '_Test Item': 2.0,
- # '_Test Item 2': 12.0,
- # '_Test Serialized Item With Series': 6.0
- # }
-
- # stock_entry = frappe.get_doc(_make_stock_entry(work_order.name, "Material Consumption for Manufacture", 2))
- # for d in stock_entry.get('items'):
- # self.assertEqual(item_quantity.get(d.item_code), d.qty)
-
def test_customer_provided_parts_se(self):
- create_item('CUST-0987', is_customer_provided_item = 1, customer = '_Test Customer', is_purchase_item = 0)
- se = make_stock_entry(item_code='CUST-0987', purpose = 'Material Receipt',
- qty=4, to_warehouse = "_Test Warehouse - _TC")
+ create_item(
+ "CUST-0987", is_customer_provided_item=1, customer="_Test Customer", is_purchase_item=0
+ )
+ se = make_stock_entry(
+ item_code="CUST-0987", purpose="Material Receipt", qty=4, to_warehouse="_Test Warehouse - _TC"
+ )
self.assertEqual(se.get("items")[0].allow_zero_valuation_rate, 1)
self.assertEqual(se.get("items")[0].amount, 0)
+ def test_zero_incoming_rate(self):
+ """Make sure incoming rate of 0 is allowed while consuming.
+
+ qty | rate | valuation rate
+ 1 | 100 | 100
+ 1 | 0 | 50
+ -1 | 100 | 0
+ -1 | 0 <--- assert this
+ """
+ item_code = "_TestZeroVal"
+ warehouse = "_Test Warehouse - _TC"
+ create_item("_TestZeroVal")
+ _receipt = make_stock_entry(item_code=item_code, qty=1, to_warehouse=warehouse, rate=100)
+ receipt2 = make_stock_entry(
+ item_code=item_code, qty=1, to_warehouse=warehouse, rate=0, do_not_save=True
+ )
+ receipt2.items[0].allow_zero_valuation_rate = 1
+ receipt2.save()
+ receipt2.submit()
+
+ issue = make_stock_entry(item_code=item_code, qty=1, from_warehouse=warehouse)
+
+ value_diff = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_no": issue.name, "voucher_type": "Stock Entry"},
+ "stock_value_difference",
+ )
+ self.assertEqual(value_diff, -100)
+
+ issue2 = make_stock_entry(item_code=item_code, qty=1, from_warehouse=warehouse)
+ value_diff = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_no": issue2.name, "voucher_type": "Stock Entry"},
+ "stock_value_difference",
+ )
+ self.assertEqual(value_diff, 0)
+
def test_gle_for_opening_stock_entry(self):
- mr = make_stock_entry(item_code="_Test Item", target="Stores - TCP1",
- company="_Test Company with perpetual inventory", qty=50, basic_rate=100,
- expense_account="Stock Adjustment - TCP1", is_opening="Yes", do_not_save=True)
+ mr = make_stock_entry(
+ item_code="_Test Item",
+ target="Stores - TCP1",
+ company="_Test Company with perpetual inventory",
+ qty=50,
+ basic_rate=100,
+ expense_account="Stock Adjustment - TCP1",
+ is_opening="Yes",
+ do_not_save=True,
+ )
self.assertRaises(OpeningEntryAccountError, mr.save)
@@ -823,52 +1145,61 @@ class TestStockEntry(ERPNextTestCase):
mr.save()
mr.submit()
- is_opening = frappe.db.get_value("GL Entry",
- filters={"voucher_type": "Stock Entry", "voucher_no": mr.name}, fieldname="is_opening")
+ is_opening = frappe.db.get_value(
+ "GL Entry",
+ filters={"voucher_type": "Stock Entry", "voucher_no": mr.name},
+ fieldname="is_opening",
+ )
self.assertEqual(is_opening, "Yes")
def test_total_basic_amount_zero(self):
- se = frappe.get_doc({"doctype":"Stock Entry",
- "purpose":"Material Receipt",
- "stock_entry_type":"Material Receipt",
- "posting_date": nowdate(),
- "company":"_Test Company with perpetual inventory",
- "items":[
- {
- "item_code":"_Test Item",
- "description":"_Test Item",
- "qty": 1,
- "basic_rate": 0,
- "uom":"Nos",
- "t_warehouse": "Stores - TCP1",
- "allow_zero_valuation_rate": 1,
- "cost_center": "Main - TCP1"
- },
- {
- "item_code":"_Test Item",
- "description":"_Test Item",
- "qty": 2,
- "basic_rate": 0,
- "uom":"Nos",
- "t_warehouse": "Stores - TCP1",
- "allow_zero_valuation_rate": 1,
- "cost_center": "Main - TCP1"
- },
- ],
- "additional_costs":[
- {"expense_account":"Miscellaneous Expenses - TCP1",
- "amount":100,
- "description": "miscellanous"
- }]
- })
+ se = frappe.get_doc(
+ {
+ "doctype": "Stock Entry",
+ "purpose": "Material Receipt",
+ "stock_entry_type": "Material Receipt",
+ "posting_date": nowdate(),
+ "company": "_Test Company with perpetual inventory",
+ "items": [
+ {
+ "item_code": "_Test Item",
+ "description": "_Test Item",
+ "qty": 1,
+ "basic_rate": 0,
+ "uom": "Nos",
+ "t_warehouse": "Stores - TCP1",
+ "allow_zero_valuation_rate": 1,
+ "cost_center": "Main - TCP1",
+ },
+ {
+ "item_code": "_Test Item",
+ "description": "_Test Item",
+ "qty": 2,
+ "basic_rate": 0,
+ "uom": "Nos",
+ "t_warehouse": "Stores - TCP1",
+ "allow_zero_valuation_rate": 1,
+ "cost_center": "Main - TCP1",
+ },
+ ],
+ "additional_costs": [
+ {
+ "expense_account": "Miscellaneous Expenses - TCP1",
+ "amount": 100,
+ "description": "miscellanous",
+ }
+ ],
+ }
+ )
se.insert()
se.submit()
- self.check_gl_entries("Stock Entry", se.name,
- sorted([
- ["Stock Adjustment - TCP1", 100.0, 0.0],
- ["Miscellaneous Expenses - TCP1", 0.0, 100.0]
- ])
+ self.check_gl_entries(
+ "Stock Entry",
+ se.name,
+ sorted(
+ [["Stock Adjustment - TCP1", 100.0, 0.0], ["Miscellaneous Expenses - TCP1", 0.0, 100.0]]
+ ),
)
def test_conversion_factor_change(self):
@@ -899,15 +1230,15 @@ class TestStockEntry(ERPNextTestCase):
def test_additional_cost_distribution_manufacture(self):
se = frappe.get_doc(
- doctype="Stock Entry",
- purpose="Manufacture",
- additional_costs=[frappe._dict(base_amount=100)],
- items=[
- frappe._dict(item_code="RM", basic_amount=10),
- frappe._dict(item_code="FG", basic_amount=20, t_warehouse="X", is_finished_item=1),
- frappe._dict(item_code="scrap", basic_amount=30, t_warehouse="X")
- ],
- )
+ doctype="Stock Entry",
+ purpose="Manufacture",
+ additional_costs=[frappe._dict(base_amount=100)],
+ items=[
+ frappe._dict(item_code="RM", basic_amount=10),
+ frappe._dict(item_code="FG", basic_amount=20, t_warehouse="X", is_finished_item=1),
+ frappe._dict(item_code="scrap", basic_amount=30, t_warehouse="X"),
+ ],
+ )
se.distribute_additional_costs()
@@ -916,14 +1247,14 @@ class TestStockEntry(ERPNextTestCase):
def test_additional_cost_distribution_non_manufacture(self):
se = frappe.get_doc(
- doctype="Stock Entry",
- purpose="Material Receipt",
- additional_costs=[frappe._dict(base_amount=100)],
- items=[
- frappe._dict(item_code="RECEIVED_1", basic_amount=20, t_warehouse="X"),
- frappe._dict(item_code="RECEIVED_2", basic_amount=30, t_warehouse="X")
- ],
- )
+ doctype="Stock Entry",
+ purpose="Material Receipt",
+ additional_costs=[frappe._dict(base_amount=100)],
+ items=[
+ frappe._dict(item_code="RECEIVED_1", basic_amount=20, t_warehouse="X"),
+ frappe._dict(item_code="RECEIVED_2", basic_amount=30, t_warehouse="X"),
+ ],
+ )
se.distribute_additional_costs()
@@ -933,40 +1264,42 @@ class TestStockEntry(ERPNextTestCase):
@change_settings("Stock Settings", {"allow_negative_stock": 0})
def test_future_negative_sle(self):
# Initialize item, batch, warehouse, opening qty
- item_code = '_Test Future Neg Item'
- batch_no = '_Test Future Neg Batch'
- warehouses = [
- '_Test Future Neg Warehouse Source',
- '_Test Future Neg Warehouse Destination'
- ]
+ item_code = "_Test Future Neg Item"
+ batch_no = "_Test Future Neg Batch"
+ warehouses = ["_Test Future Neg Warehouse Source", "_Test Future Neg Warehouse Destination"]
warehouse_names = initialize_records_for_future_negative_sle_test(
- item_code, batch_no, warehouses,
- opening_qty=2, posting_date='2021-07-01'
+ item_code, batch_no, warehouses, opening_qty=2, posting_date="2021-07-01"
)
# Executing an illegal sequence should raise an error
sequence_of_entries = [
- dict(item_code=item_code,
+ dict(
+ item_code=item_code,
qty=2,
from_warehouse=warehouse_names[0],
to_warehouse=warehouse_names[1],
batch_no=batch_no,
- posting_date='2021-07-03',
- purpose='Material Transfer'),
- dict(item_code=item_code,
+ posting_date="2021-07-03",
+ purpose="Material Transfer",
+ ),
+ dict(
+ item_code=item_code,
qty=2,
from_warehouse=warehouse_names[1],
to_warehouse=warehouse_names[0],
batch_no=batch_no,
- posting_date='2021-07-04',
- purpose='Material Transfer'),
- dict(item_code=item_code,
+ posting_date="2021-07-04",
+ purpose="Material Transfer",
+ ),
+ dict(
+ item_code=item_code,
qty=2,
from_warehouse=warehouse_names[0],
to_warehouse=warehouse_names[1],
batch_no=batch_no,
- posting_date='2021-07-02', # Illegal SE
- purpose='Material Transfer')
+ posting_date="2021-07-02", # Illegal SE
+ purpose="Material Transfer",
+ ),
]
self.assertRaises(NegativeStockError, create_stock_entries, sequence_of_entries)
@@ -976,36 +1309,268 @@ class TestStockEntry(ERPNextTestCase):
from erpnext.stock.doctype.batch.test_batch import TestBatch
# Initialize item, batch, warehouse, opening qty
- item_code = '_Test MultiBatch Item'
+ item_code = "_Test MultiBatch Item"
TestBatch.make_batch_item(item_code)
- batch_nos = [] # store generate batches
- warehouse = '_Test Warehouse - _TC'
+ batch_nos = [] # store generate batches
+ warehouse = "_Test Warehouse - _TC"
se1 = make_stock_entry(
- item_code=item_code,
- qty=2,
- to_warehouse=warehouse,
- posting_date='2021-09-01',
- purpose='Material Receipt'
- )
+ item_code=item_code,
+ qty=2,
+ to_warehouse=warehouse,
+ posting_date="2021-09-01",
+ purpose="Material Receipt",
+ )
batch_nos.append(se1.items[0].batch_no)
se2 = make_stock_entry(
- item_code=item_code,
- qty=2,
- to_warehouse=warehouse,
- posting_date='2021-09-03',
- purpose='Material Receipt'
- )
+ item_code=item_code,
+ qty=2,
+ to_warehouse=warehouse,
+ posting_date="2021-09-03",
+ purpose="Material Receipt",
+ )
batch_nos.append(se2.items[0].batch_no)
with self.assertRaises(NegativeStockError) as nse:
- make_stock_entry(item_code=item_code,
+ make_stock_entry(
+ item_code=item_code,
qty=1,
from_warehouse=warehouse,
batch_no=batch_nos[1],
- posting_date='2021-09-02', # backdated consumption of 2nd batch
- purpose='Material Issue')
+ posting_date="2021-09-02", # backdated consumption of 2nd batch
+ purpose="Material Issue",
+ )
+
+ def test_independent_manufacture_entry(self):
+ "Test FG items and incoming rate calculation in Maniufacture Entry without WO or BOM linked."
+ se = frappe.get_doc(
+ doctype="Stock Entry",
+ purpose="Manufacture",
+ stock_entry_type="Manufacture",
+ company="_Test Company",
+ items=[
+ frappe._dict(
+ item_code="_Test Item", qty=1, basic_rate=200, s_warehouse="_Test Warehouse - _TC"
+ ),
+ frappe._dict(item_code="_Test FG Item", qty=4, t_warehouse="_Test Warehouse 1 - _TC"),
+ ],
+ )
+ # SE must have atleast one FG
+ self.assertRaises(FinishedGoodError, se.save)
+
+ se.items[0].is_finished_item = 1
+ se.items[1].is_finished_item = 1
+ # SE cannot have multiple FGs
+ self.assertRaises(FinishedGoodError, se.save)
+
+ se.items[0].is_finished_item = 0
+ se.save()
+
+ # Check if FG cost is calculated based on RM total cost
+ # RM total cost = 200, FG rate = 200/4(FG qty) = 50
+ self.assertEqual(se.items[1].basic_rate, flt(se.items[0].basic_rate / 4))
+ self.assertEqual(se.value_difference, 0.0)
+ self.assertEqual(se.total_incoming_value, se.total_outgoing_value)
+
+ def test_transfer_qty_validation(self):
+ se = make_stock_entry(item_code="_Test Item", do_not_save=True, qty=0.001, rate=100)
+ se.items[0].uom = "Kg"
+ se.items[0].conversion_factor = 0.002
+
+ self.assertRaises(frappe.ValidationError, se.save)
+
+ def test_mapped_stock_entry(self):
+ "Check if rate and stock details are populated in mapped SE given warehouse."
+ from erpnext.stock.doctype.purchase_receipt.purchase_receipt import make_stock_entry
+ from erpnext.stock.doctype.purchase_receipt.test_purchase_receipt import make_purchase_receipt
+
+ item_code = "_TestMappedItem"
+ create_item(item_code, is_stock_item=True)
+
+ pr = make_purchase_receipt(
+ item_code=item_code, qty=2, rate=100, company="_Test Company", warehouse="Stores - _TC"
+ )
+
+ mapped_se = make_stock_entry(pr.name)
+
+ self.assertEqual(mapped_se.items[0].s_warehouse, "Stores - _TC")
+ self.assertEqual(mapped_se.items[0].actual_qty, 2)
+ self.assertEqual(mapped_se.items[0].basic_rate, 100)
+ self.assertEqual(mapped_se.items[0].basic_amount, 200)
+
+ def test_stock_entry_item_details(self):
+ item = make_item()
+
+ se = make_stock_entry(
+ item_code=item.name, qty=1, to_warehouse="_Test Warehouse - _TC", do_not_submit=True
+ )
+
+ self.assertEqual(se.items[0].item_name, item.item_name)
+ se.items[0].item_name = "wat"
+ se.items[0].stock_uom = "Kg"
+ se.save()
+
+ self.assertEqual(se.items[0].item_name, item.item_name)
+ self.assertEqual(se.items[0].stock_uom, item.stock_uom)
+
+ def test_reposting_for_depedent_warehouse(self):
+ from erpnext.stock.doctype.repost_item_valuation.repost_item_valuation import repost_sl_entries
+ from erpnext.stock.doctype.warehouse.test_warehouse import create_warehouse
+
+ # Inward at WH1 warehouse (Component)
+ # 1st Repack (Component (WH1) - Subcomponent (WH2))
+ # 2nd Repack (Subcomponent (WH2) - FG Item (WH3))
+ # Material Transfer of FG Item -> WH 3 -> WH2 -> Wh1 (Two transfer entries)
+ # Backdated transction which should update valuation rate in repack as well trasfer entries
+
+ for item_code in ["FG Item 1", "Sub Component 1", "Component 1"]:
+ create_item(item_code)
+
+ for warehouse in ["WH 1", "WH 2", "WH 3"]:
+ create_warehouse(warehouse)
+
+ make_stock_entry(
+ item_code="Component 1",
+ rate=100,
+ purpose="Material Receipt",
+ qty=10,
+ to_warehouse="WH 1 - _TC",
+ posting_date=add_days(nowdate(), -10),
+ )
+
+ repack1 = make_stock_entry(
+ item_code="Component 1",
+ purpose="Repack",
+ do_not_save=True,
+ qty=10,
+ from_warehouse="WH 1 - _TC",
+ posting_date=add_days(nowdate(), -9),
+ )
+
+ repack1.append(
+ "items",
+ {
+ "item_code": "Sub Component 1",
+ "qty": 10,
+ "t_warehouse": "WH 2 - _TC",
+ "transfer_qty": 10,
+ "uom": "Nos",
+ "stock_uom": "Nos",
+ "conversion_factor": 1.0,
+ },
+ )
+
+ repack1.save()
+ repack1.submit()
+
+ self.assertEqual(repack1.items[1].basic_rate, 100)
+ self.assertEqual(repack1.items[1].amount, 1000)
+
+ repack2 = make_stock_entry(
+ item_code="Sub Component 1",
+ purpose="Repack",
+ do_not_save=True,
+ qty=10,
+ from_warehouse="WH 2 - _TC",
+ posting_date=add_days(nowdate(), -8),
+ )
+
+ repack2.append(
+ "items",
+ {
+ "item_code": "FG Item 1",
+ "qty": 10,
+ "t_warehouse": "WH 3 - _TC",
+ "transfer_qty": 10,
+ "uom": "Nos",
+ "stock_uom": "Nos",
+ "conversion_factor": 1.0,
+ },
+ )
+
+ repack2.save()
+ repack2.submit()
+
+ self.assertEqual(repack2.items[1].basic_rate, 100)
+ self.assertEqual(repack2.items[1].amount, 1000)
+
+ transfer1 = make_stock_entry(
+ item_code="FG Item 1",
+ purpose="Material Transfer",
+ qty=10,
+ from_warehouse="WH 3 - _TC",
+ to_warehouse="WH 2 - _TC",
+ posting_date=add_days(nowdate(), -7),
+ )
+
+ self.assertEqual(transfer1.items[0].basic_rate, 100)
+ self.assertEqual(transfer1.items[0].amount, 1000)
+
+ transfer2 = make_stock_entry(
+ item_code="FG Item 1",
+ purpose="Material Transfer",
+ qty=10,
+ from_warehouse="WH 2 - _TC",
+ to_warehouse="WH 1 - _TC",
+ posting_date=add_days(nowdate(), -6),
+ )
+
+ self.assertEqual(transfer2.items[0].basic_rate, 100)
+ self.assertEqual(transfer2.items[0].amount, 1000)
+
+ # Backdated transaction
+ receipt2 = make_stock_entry(
+ item_code="Component 1",
+ rate=200,
+ purpose="Material Receipt",
+ qty=10,
+ to_warehouse="WH 1 - _TC",
+ posting_date=add_days(nowdate(), -15),
+ )
+
+ self.assertEqual(receipt2.items[0].basic_rate, 200)
+ self.assertEqual(receipt2.items[0].amount, 2000)
+
+ repost_name = frappe.db.get_value(
+ "Repost Item Valuation", {"voucher_no": receipt2.name, "docstatus": 1}, "name"
+ )
+
+ doc = frappe.get_doc("Repost Item Valuation", repost_name)
+ repost_sl_entries(doc)
+
+ for obj in [repack1, repack2, transfer1, transfer2]:
+ obj.load_from_db()
+
+ index = 1 if obj.purpose == "Repack" else 0
+ self.assertEqual(obj.items[index].basic_rate, 200)
+ self.assertEqual(obj.items[index].basic_amount, 2000)
+
+ def test_batch_expiry(self):
+ from erpnext.controllers.stock_controller import BatchExpiredError
+ from erpnext.stock.doctype.batch.test_batch import make_new_batch
+
+ item_code = "Test Batch Expiry Test Item - 001"
+ item_doc = create_item(item_code=item_code, is_stock_item=1, valuation_rate=10)
+
+ item_doc.has_batch_no = 1
+ item_doc.save()
+
+ batch = make_new_batch(
+ batch_id=frappe.generate_hash("", 5), item_code=item_doc.name, expiry_date=add_days(today(), -1)
+ )
+
+ se = make_stock_entry(
+ item_code=item_code,
+ purpose="Material Receipt",
+ qty=4,
+ to_warehouse="_Test Warehouse - _TC",
+ batch_no=batch.name,
+ do_not_save=True,
+ )
+
+ self.assertRaises(BatchExpiredError, se.save)
+
def make_serialized_item(**args):
args = frappe._dict(args)
@@ -1036,50 +1601,57 @@ def make_serialized_item(**args):
se.submit()
return se
+
def get_qty_after_transaction(**args):
args = frappe._dict(args)
- last_sle = get_previous_sle({
- "item_code": args.item_code or "_Test Item",
- "warehouse": args.warehouse or "_Test Warehouse - _TC",
- "posting_date": args.posting_date or nowdate(),
- "posting_time": args.posting_time or nowtime()
- })
+ last_sle = get_previous_sle(
+ {
+ "item_code": args.item_code or "_Test Item",
+ "warehouse": args.warehouse or "_Test Warehouse - _TC",
+ "posting_date": args.posting_date or nowdate(),
+ "posting_time": args.posting_time or nowtime(),
+ }
+ )
return flt(last_sle.get("qty_after_transaction"))
+
def get_multiple_items():
return [
- {
- "conversion_factor": 1.0,
- "cost_center": "Main - TCP1",
- "doctype": "Stock Entry Detail",
- "expense_account": "Stock Adjustment - TCP1",
- "basic_rate": 100,
- "item_code": "_Test Item",
- "qty": 50.0,
- "s_warehouse": "Stores - TCP1",
- "stock_uom": "_Test UOM",
- "transfer_qty": 50.0,
- "uom": "_Test UOM"
- },
- {
- "conversion_factor": 1.0,
- "cost_center": "Main - TCP1",
- "doctype": "Stock Entry Detail",
- "expense_account": "Stock Adjustment - TCP1",
- "basic_rate": 5000,
- "item_code": "_Test Item Home Desktop 100",
- "qty": 1,
- "stock_uom": "_Test UOM",
- "t_warehouse": "Stores - TCP1",
- "transfer_qty": 1,
- "uom": "_Test UOM"
- }
- ]
+ {
+ "conversion_factor": 1.0,
+ "cost_center": "Main - TCP1",
+ "doctype": "Stock Entry Detail",
+ "expense_account": "Stock Adjustment - TCP1",
+ "basic_rate": 100,
+ "item_code": "_Test Item",
+ "qty": 50.0,
+ "s_warehouse": "Stores - TCP1",
+ "stock_uom": "_Test UOM",
+ "transfer_qty": 50.0,
+ "uom": "_Test UOM",
+ },
+ {
+ "conversion_factor": 1.0,
+ "cost_center": "Main - TCP1",
+ "doctype": "Stock Entry Detail",
+ "expense_account": "Stock Adjustment - TCP1",
+ "basic_rate": 5000,
+ "item_code": "_Test Item Home Desktop 100",
+ "qty": 1,
+ "stock_uom": "_Test UOM",
+ "t_warehouse": "Stores - TCP1",
+ "transfer_qty": 1,
+ "uom": "_Test UOM",
+ },
+ ]
+
+
+test_records = frappe.get_test_records("Stock Entry")
-test_records = frappe.get_test_records('Stock Entry')
def initialize_records_for_future_negative_sle_test(
- item_code, batch_no, warehouses, opening_qty, posting_date):
+ item_code, batch_no, warehouses, opening_qty, posting_date
+):
from erpnext.stock.doctype.batch.test_batch import TestBatch, make_new_batch
from erpnext.stock.doctype.stock_reconciliation.test_stock_reconciliation import (
create_stock_reconciliation,
@@ -1090,9 +1662,9 @@ def initialize_records_for_future_negative_sle_test(
make_new_batch(item_code=item_code, batch_id=batch_no)
warehouse_names = [create_warehouse(w) for w in warehouses]
create_stock_reconciliation(
- purpose='Opening Stock',
+ purpose="Opening Stock",
posting_date=posting_date,
- posting_time='20:00:20',
+ posting_time="20:00:20",
item_code=item_code,
warehouse=warehouse_names[0],
valuation_rate=100,
diff --git a/erpnext/stock/doctype/stock_entry_detail/stock_entry_detail.json b/erpnext/stock/doctype/stock_entry_detail/stock_entry_detail.json
index 2282b6aa167..a6b21891715 100644
--- a/erpnext/stock/doctype/stock_entry_detail/stock_entry_detail.json
+++ b/erpnext/stock/doctype/stock_entry_detail/stock_entry_detail.json
@@ -1,7 +1,7 @@
{
"actions": [],
"autoname": "hash",
- "creation": "2013-03-29 18:22:12",
+ "creation": "2022-02-05 00:17:49.860824",
"doctype": "DocType",
"document_type": "Other",
"editable_grid": 1,
@@ -340,13 +340,13 @@
"label": "More Information"
},
{
- "allow_on_submit": 1,
"default": "0",
"fieldname": "allow_zero_valuation_rate",
"fieldtype": "Check",
"label": "Allow Zero Valuation Rate",
"no_copy": 1,
- "print_hide": 1
+ "print_hide": 1,
+ "read_only_depends_on": "eval:doc.s_warehouse"
},
{
"allow_on_submit": 1,
@@ -556,12 +556,14 @@
"index_web_pages_for_search": 1,
"istable": 1,
"links": [],
- "modified": "2021-06-22 16:47:11.268975",
+ "modified": "2022-02-26 00:51:24.963653",
"modified_by": "Administrator",
"module": "Stock",
"name": "Stock Entry Detail",
+ "naming_rule": "Random",
"owner": "Administrator",
"permissions": [],
"sort_field": "modified",
- "sort_order": "ASC"
+ "sort_order": "ASC",
+ "states": []
}
\ No newline at end of file
diff --git a/erpnext/stock/doctype/stock_entry_type/stock_entry_type.py b/erpnext/stock/doctype/stock_entry_type/stock_entry_type.py
index efd97c04ac6..7258cfbe2c9 100644
--- a/erpnext/stock/doctype/stock_entry_type/stock_entry_type.py
+++ b/erpnext/stock/doctype/stock_entry_type/stock_entry_type.py
@@ -8,5 +8,5 @@ from frappe.model.document import Document
class StockEntryType(Document):
def validate(self):
- if self.add_to_transit and self.purpose != 'Material Transfer':
+ if self.add_to_transit and self.purpose != "Material Transfer":
self.add_to_transit = 0
diff --git a/erpnext/stock/doctype/stock_ledger_entry/stock_ledger_entry.py b/erpnext/stock/doctype/stock_ledger_entry/stock_ledger_entry.py
index 39ca97a47bc..38eb80ad927 100644
--- a/erpnext/stock/doctype/stock_ledger_entry/stock_ledger_entry.py
+++ b/erpnext/stock/doctype/stock_ledger_entry/stock_ledger_entry.py
@@ -1,4 +1,3 @@
-
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: GNU General Public License v3. See license.txt
@@ -15,11 +14,17 @@ from erpnext.accounts.utils import get_fiscal_year
from erpnext.controllers.item_variant import ItemTemplateCannotHaveStock
-class StockFreezeError(frappe.ValidationError): pass
-class BackDatedStockTransaction(frappe.ValidationError): pass
+class StockFreezeError(frappe.ValidationError):
+ pass
+
+
+class BackDatedStockTransaction(frappe.ValidationError):
+ pass
+
exclude_from_linked_with = True
+
class StockLedgerEntry(Document):
def autoname(self):
"""
@@ -27,10 +32,13 @@ class StockLedgerEntry(Document):
name will be changed using autoname options (in a scheduled job)
"""
self.name = frappe.generate_hash(txt="", length=10)
+ if self.meta.autoname == "hash":
+ self.to_rename = 0
def validate(self):
self.flags.ignore_submit_comment = True
from erpnext.stock.utils import validate_disabled_warehouse, validate_warehouse_company
+
self.validate_mandatory()
self.validate_item()
self.validate_batch()
@@ -41,24 +49,29 @@ class StockLedgerEntry(Document):
self.block_transactions_against_group_warehouse()
self.validate_with_last_transaction_posting_time()
-
def on_submit(self):
self.check_stock_frozen_date()
self.calculate_batch_qty()
if not self.get("via_landed_cost_voucher"):
from erpnext.stock.doctype.serial_no.serial_no import process_serial_no
+
process_serial_no(self)
def calculate_batch_qty(self):
if self.batch_no:
- batch_qty = frappe.db.get_value("Stock Ledger Entry",
- {"docstatus": 1, "batch_no": self.batch_no, "is_cancelled": 0},
- "sum(actual_qty)") or 0
+ batch_qty = (
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"docstatus": 1, "batch_no": self.batch_no, "is_cancelled": 0},
+ "sum(actual_qty)",
+ )
+ or 0
+ )
frappe.db.set_value("Batch", self.batch_no, "batch_qty", batch_qty)
def validate_mandatory(self):
- mandatory = ['warehouse','posting_date','voucher_type','voucher_no','company']
+ mandatory = ["warehouse", "posting_date", "voucher_type", "voucher_no", "company"]
for k in mandatory:
if not self.get(k):
frappe.throw(_("{0} is required").format(self.meta.get_label(k)))
@@ -67,9 +80,13 @@ class StockLedgerEntry(Document):
frappe.throw(_("Actual Qty is mandatory"))
def validate_item(self):
- item_det = frappe.db.sql("""select name, item_name, has_batch_no, docstatus,
+ item_det = frappe.db.sql(
+ """select name, item_name, has_batch_no, docstatus,
is_stock_item, has_variants, stock_uom, create_new_batch
- from tabItem where name=%s""", self.item_code, as_dict=True)
+ from tabItem where name=%s""",
+ self.item_code,
+ as_dict=True,
+ )
if not item_det:
frappe.throw(_("Item {0} not found").format(self.item_code))
@@ -81,42 +98,64 @@ class StockLedgerEntry(Document):
# check if batch number is valid
if item_det.has_batch_no == 1:
- batch_item = self.item_code if self.item_code == item_det.item_name else self.item_code + ":" + item_det.item_name
+ batch_item = (
+ self.item_code
+ if self.item_code == item_det.item_name
+ else self.item_code + ":" + item_det.item_name
+ )
if not self.batch_no:
frappe.throw(_("Batch number is mandatory for Item {0}").format(batch_item))
- elif not frappe.db.get_value("Batch",{"item": self.item_code, "name": self.batch_no}):
- frappe.throw(_("{0} is not a valid Batch Number for Item {1}").format(self.batch_no, batch_item))
+ elif not frappe.db.get_value("Batch", {"item": self.item_code, "name": self.batch_no}):
+ frappe.throw(
+ _("{0} is not a valid Batch Number for Item {1}").format(self.batch_no, batch_item)
+ )
elif item_det.has_batch_no == 0 and self.batch_no and self.is_cancelled == 0:
frappe.throw(_("The Item {0} cannot have Batch").format(self.item_code))
if item_det.has_variants:
- frappe.throw(_("Stock cannot exist for Item {0} since has variants").format(self.item_code),
- ItemTemplateCannotHaveStock)
+ frappe.throw(
+ _("Stock cannot exist for Item {0} since has variants").format(self.item_code),
+ ItemTemplateCannotHaveStock,
+ )
self.stock_uom = item_det.stock_uom
def check_stock_frozen_date(self):
- stock_settings = frappe.get_cached_doc('Stock Settings')
+ stock_settings = frappe.get_cached_doc("Stock Settings")
if stock_settings.stock_frozen_upto:
- if (getdate(self.posting_date) <= getdate(stock_settings.stock_frozen_upto)
- and stock_settings.stock_auth_role not in frappe.get_roles()):
- frappe.throw(_("Stock transactions before {0} are frozen")
- .format(formatdate(stock_settings.stock_frozen_upto)), StockFreezeError)
+ if (
+ getdate(self.posting_date) <= getdate(stock_settings.stock_frozen_upto)
+ and stock_settings.stock_auth_role not in frappe.get_roles()
+ ):
+ frappe.throw(
+ _("Stock transactions before {0} are frozen").format(
+ formatdate(stock_settings.stock_frozen_upto)
+ ),
+ StockFreezeError,
+ )
stock_frozen_upto_days = cint(stock_settings.stock_frozen_upto_days)
if stock_frozen_upto_days:
- older_than_x_days_ago = (add_days(getdate(self.posting_date), stock_frozen_upto_days) <= date.today())
+ older_than_x_days_ago = (
+ add_days(getdate(self.posting_date), stock_frozen_upto_days) <= date.today()
+ )
if older_than_x_days_ago and stock_settings.stock_auth_role not in frappe.get_roles():
- frappe.throw(_("Not allowed to update stock transactions older than {0}").format(stock_frozen_upto_days), StockFreezeError)
+ frappe.throw(
+ _("Not allowed to update stock transactions older than {0}").format(stock_frozen_upto_days),
+ StockFreezeError,
+ )
def scrub_posting_time(self):
- if not self.posting_time or self.posting_time == '00:0':
- self.posting_time = '00:00'
+ if not self.posting_time or self.posting_time == "00:0":
+ self.posting_time = "00:00"
def validate_batch(self):
if self.batch_no and self.voucher_type != "Stock Entry":
+ if self.voucher_type in ["Purchase Receipt", "Purchase Invoice"] and self.actual_qty < 0:
+ return
+
expiry_date = frappe.db.get_value("Batch", self.batch_no, "expiry_date")
if expiry_date:
if getdate(self.posting_date) > getdate(expiry_date):
@@ -127,43 +166,61 @@ class StockLedgerEntry(Document):
self.fiscal_year = get_fiscal_year(self.posting_date, company=self.company)[0]
else:
from erpnext.accounts.utils import validate_fiscal_year
- validate_fiscal_year(self.posting_date, self.fiscal_year, self.company,
- self.meta.get_label("posting_date"), self)
+
+ validate_fiscal_year(
+ self.posting_date, self.fiscal_year, self.company, self.meta.get_label("posting_date"), self
+ )
def block_transactions_against_group_warehouse(self):
from erpnext.stock.utils import is_group_warehouse
+
is_group_warehouse(self.warehouse)
def validate_with_last_transaction_posting_time(self):
- authorized_role = frappe.db.get_single_value("Stock Settings", "role_allowed_to_create_edit_back_dated_transactions")
+ authorized_role = frappe.db.get_single_value(
+ "Stock Settings", "role_allowed_to_create_edit_back_dated_transactions"
+ )
if authorized_role:
authorized_users = get_users(authorized_role)
if authorized_users and frappe.session.user not in authorized_users:
- last_transaction_time = frappe.db.sql("""
+ last_transaction_time = frappe.db.sql(
+ """
select MAX(timestamp(posting_date, posting_time)) as posting_time
from `tabStock Ledger Entry`
where docstatus = 1 and is_cancelled = 0 and item_code = %s
- and warehouse = %s""", (self.item_code, self.warehouse))[0][0]
+ and warehouse = %s""",
+ (self.item_code, self.warehouse),
+ )[0][0]
- cur_doc_posting_datetime = "%s %s" % (self.posting_date, self.get("posting_time") or "00:00:00")
+ cur_doc_posting_datetime = "%s %s" % (
+ self.posting_date,
+ self.get("posting_time") or "00:00:00",
+ )
- if last_transaction_time and get_datetime(cur_doc_posting_datetime) < get_datetime(last_transaction_time):
- msg = _("Last Stock Transaction for item {0} under warehouse {1} was on {2}.").format(frappe.bold(self.item_code),
- frappe.bold(self.warehouse), frappe.bold(last_transaction_time))
+ if last_transaction_time and get_datetime(cur_doc_posting_datetime) < get_datetime(
+ last_transaction_time
+ ):
+ msg = _("Last Stock Transaction for item {0} under warehouse {1} was on {2}.").format(
+ frappe.bold(self.item_code), frappe.bold(self.warehouse), frappe.bold(last_transaction_time)
+ )
- msg += "
" + _("You are not authorized to make/edit Stock Transactions for Item {0} under warehouse {1} before this time.").format(
- frappe.bold(self.item_code), frappe.bold(self.warehouse))
+ msg += "
" + _(
+ "You are not authorized to make/edit Stock Transactions for Item {0} under warehouse {1} before this time."
+ ).format(frappe.bold(self.item_code), frappe.bold(self.warehouse))
msg += "
" + _("Please contact any of the following users to {} this transaction.")
msg += "
" + "
".join(authorized_users)
frappe.throw(msg, BackDatedStockTransaction, title=_("Backdated Stock Entry"))
+
def on_doctype_update():
- if not frappe.db.has_index('tabStock Ledger Entry', 'posting_sort_index'):
+ if not frappe.db.has_index("tabStock Ledger Entry", "posting_sort_index"):
frappe.db.commit()
- frappe.db.add_index("Stock Ledger Entry",
+ frappe.db.add_index(
+ "Stock Ledger Entry",
fields=["posting_date", "posting_time", "name"],
- index_name="posting_sort_index")
+ index_name="posting_sort_index",
+ )
frappe.db.add_index("Stock Ledger Entry", ["voucher_no", "voucher_type"])
frappe.db.add_index("Stock Ledger Entry", ["batch_no", "item_code", "warehouse"])
diff --git a/erpnext/stock/doctype/stock_ledger_entry/test_stock_ledger_entry.py b/erpnext/stock/doctype/stock_ledger_entry/test_stock_ledger_entry.py
index cafbd7581ce..e810c7933cc 100644
--- a/erpnext/stock/doctype/stock_ledger_entry/test_stock_ledger_entry.py
+++ b/erpnext/stock/doctype/stock_ledger_entry/test_stock_ledger_entry.py
@@ -1,10 +1,15 @@
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# See license.txt
+import json
+
import frappe
from frappe.core.page.permission_manager.permission_manager import reset
-from frappe.utils import add_days, today
+from frappe.custom.doctype.property_setter.property_setter import make_property_setter
+from frappe.tests.utils import FrappeTestCase, change_settings
+from frappe.utils import add_days, add_to_date, flt, today
+from erpnext.accounts.doctype.gl_entry.gl_entry import rename_gle_sle_docs
from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note
from erpnext.stock.doctype.item.test_item import make_item
from erpnext.stock.doctype.landed_cost_voucher.test_landed_cost_voucher import (
@@ -17,17 +22,50 @@ from erpnext.stock.doctype.stock_reconciliation.test_stock_reconciliation import
create_stock_reconciliation,
)
from erpnext.stock.stock_ledger import get_previous_sle
-from erpnext.tests.utils import ERPNextTestCase
+from erpnext.stock.tests.test_utils import StockTestMixin
-class TestStockLedgerEntry(ERPNextTestCase):
+class TestStockLedgerEntry(FrappeTestCase, StockTestMixin):
def setUp(self):
items = create_items()
- reset('Stock Entry')
+ reset("Stock Entry")
# delete SLE and BINs for all items
- frappe.db.sql("delete from `tabStock Ledger Entry` where item_code in (%s)" % (', '.join(['%s']*len(items))), items)
- frappe.db.sql("delete from `tabBin` where item_code in (%s)" % (', '.join(['%s']*len(items))), items)
+ frappe.db.sql(
+ "delete from `tabStock Ledger Entry` where item_code in (%s)"
+ % (", ".join(["%s"] * len(items))),
+ items,
+ )
+ frappe.db.sql(
+ "delete from `tabBin` where item_code in (%s)" % (", ".join(["%s"] * len(items))), items
+ )
+
+ def tearDown(self):
+ frappe.db.rollback()
+
+ def assertSLEs(self, doc, expected_sles, sle_filters=None):
+ """Compare sorted SLEs, useful for vouchers that create multiple SLEs for same line"""
+
+ filters = {"voucher_no": doc.name, "voucher_type": doc.doctype, "is_cancelled": 0}
+ if sle_filters:
+ filters.update(sle_filters)
+ sles = frappe.get_all(
+ "Stock Ledger Entry",
+ fields=["*"],
+ filters=filters,
+ order_by="timestamp(posting_date, posting_time), creation",
+ )
+
+ for exp_sle, act_sle in zip(expected_sles, sles):
+ for k, v in exp_sle.items():
+ act_value = act_sle[k]
+ if k == "stock_queue":
+ act_value = json.loads(act_value)
+ if act_value and act_value[0][0] == 0:
+ # ignore empty fifo bins
+ continue
+
+ self.assertEqual(v, act_value, msg=f"{k} doesn't match \n{exp_sle}\n{act_sle}")
def test_item_cost_reposting(self):
company = "_Test Company"
@@ -39,9 +77,11 @@ class TestStockLedgerEntry(ERPNextTestCase):
qty=50,
rate=100,
company=company,
- expense_account = "Stock Adjustment - _TC" if frappe.get_all("Stock Ledger Entry") else "Temporary Opening - _TC",
- posting_date='2020-04-10',
- posting_time='14:00'
+ expense_account="Stock Adjustment - _TC"
+ if frappe.get_all("Stock Ledger Entry")
+ else "Temporary Opening - _TC",
+ posting_date="2020-04-10",
+ posting_time="14:00",
)
# _Test Item for Reposting at FG warehouse on 20-04-2020: Qty = 10, Rate = 200
@@ -51,9 +91,11 @@ class TestStockLedgerEntry(ERPNextTestCase):
qty=10,
rate=200,
company=company,
- expense_account="Stock Adjustment - _TC" if frappe.get_all("Stock Ledger Entry") else "Temporary Opening - _TC",
- posting_date='2020-04-20',
- posting_time='14:00'
+ expense_account="Stock Adjustment - _TC"
+ if frappe.get_all("Stock Ledger Entry")
+ else "Temporary Opening - _TC",
+ posting_date="2020-04-20",
+ posting_time="14:00",
)
# _Test Item for Reposting transferred from Stores to FG warehouse on 30-04-2020
@@ -63,28 +105,40 @@ class TestStockLedgerEntry(ERPNextTestCase):
target="Finished Goods - _TC",
company=company,
qty=10,
- expense_account="Stock Adjustment - _TC" if frappe.get_all("Stock Ledger Entry") else "Temporary Opening - _TC",
- posting_date='2020-04-30',
- posting_time='14:00'
+ expense_account="Stock Adjustment - _TC"
+ if frappe.get_all("Stock Ledger Entry")
+ else "Temporary Opening - _TC",
+ posting_date="2020-04-30",
+ posting_time="14:00",
+ )
+ target_wh_sle = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {
+ "item_code": "_Test Item for Reposting",
+ "warehouse": "Finished Goods - _TC",
+ "voucher_type": "Stock Entry",
+ "voucher_no": se.name,
+ },
+ ["valuation_rate"],
+ as_dict=1,
)
- target_wh_sle = frappe.db.get_value('Stock Ledger Entry', {
- "item_code": "_Test Item for Reposting",
- "warehouse": "Finished Goods - _TC",
- "voucher_type": "Stock Entry",
- "voucher_no": se.name
- }, ["valuation_rate"], as_dict=1)
self.assertEqual(target_wh_sle.get("valuation_rate"), 150)
# Repack entry on 5-5-2020
- repack = create_repack_entry(company=company, posting_date='2020-05-05', posting_time='14:00')
+ repack = create_repack_entry(company=company, posting_date="2020-05-05", posting_time="14:00")
- finished_item_sle = frappe.db.get_value('Stock Ledger Entry', {
- "item_code": "_Test Finished Item for Reposting",
- "warehouse": "Finished Goods - _TC",
- "voucher_type": "Stock Entry",
- "voucher_no": repack.name
- }, ["incoming_rate", "valuation_rate"], as_dict=1)
+ finished_item_sle = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {
+ "item_code": "_Test Finished Item for Reposting",
+ "warehouse": "Finished Goods - _TC",
+ "voucher_type": "Stock Entry",
+ "voucher_no": repack.name,
+ },
+ ["incoming_rate", "valuation_rate"],
+ as_dict=1,
+ )
self.assertEqual(finished_item_sle.get("incoming_rate"), 540)
self.assertEqual(finished_item_sle.get("valuation_rate"), 540)
@@ -95,29 +149,37 @@ class TestStockLedgerEntry(ERPNextTestCase):
qty=50,
rate=150,
company=company,
- expense_account ="Stock Adjustment - _TC" if frappe.get_all("Stock Ledger Entry") else "Temporary Opening - _TC",
- posting_date='2020-04-12',
- posting_time='14:00'
+ expense_account="Stock Adjustment - _TC"
+ if frappe.get_all("Stock Ledger Entry")
+ else "Temporary Opening - _TC",
+ posting_date="2020-04-12",
+ posting_time="14:00",
)
-
# Check valuation rate of finished goods warehouse after back-dated entry at Stores
- target_wh_sle = get_previous_sle({
- "item_code": "_Test Item for Reposting",
- "warehouse": "Finished Goods - _TC",
- "posting_date": '2020-04-30',
- "posting_time": '14:00'
- })
+ target_wh_sle = get_previous_sle(
+ {
+ "item_code": "_Test Item for Reposting",
+ "warehouse": "Finished Goods - _TC",
+ "posting_date": "2020-04-30",
+ "posting_time": "14:00",
+ }
+ )
self.assertEqual(target_wh_sle.get("incoming_rate"), 150)
self.assertEqual(target_wh_sle.get("valuation_rate"), 175)
# Check valuation rate of repacked item after back-dated entry at Stores
- finished_item_sle = frappe.db.get_value('Stock Ledger Entry', {
- "item_code": "_Test Finished Item for Reposting",
- "warehouse": "Finished Goods - _TC",
- "voucher_type": "Stock Entry",
- "voucher_no": repack.name
- }, ["incoming_rate", "valuation_rate"], as_dict=1)
+ finished_item_sle = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {
+ "item_code": "_Test Finished Item for Reposting",
+ "warehouse": "Finished Goods - _TC",
+ "voucher_type": "Stock Entry",
+ "voucher_no": repack.name,
+ },
+ ["incoming_rate", "valuation_rate"],
+ as_dict=1,
+ )
self.assertEqual(finished_item_sle.get("incoming_rate"), 790)
self.assertEqual(finished_item_sle.get("valuation_rate"), 790)
@@ -127,76 +189,133 @@ class TestStockLedgerEntry(ERPNextTestCase):
self.assertEqual(repack.items[1].get("basic_rate"), 750)
def test_purchase_return_valuation_reposting(self):
- pr = make_purchase_receipt(company="_Test Company", posting_date='2020-04-10',
- warehouse="Stores - _TC", item_code="_Test Item for Reposting", qty=5, rate=100)
+ pr = make_purchase_receipt(
+ company="_Test Company",
+ posting_date="2020-04-10",
+ warehouse="Stores - _TC",
+ item_code="_Test Item for Reposting",
+ qty=5,
+ rate=100,
+ )
- return_pr = make_purchase_receipt(company="_Test Company", posting_date='2020-04-15',
- warehouse="Stores - _TC", item_code="_Test Item for Reposting", is_return=1, return_against=pr.name, qty=-2)
+ return_pr = make_purchase_receipt(
+ company="_Test Company",
+ posting_date="2020-04-15",
+ warehouse="Stores - _TC",
+ item_code="_Test Item for Reposting",
+ is_return=1,
+ return_against=pr.name,
+ qty=-2,
+ )
# check sle
- outgoing_rate, stock_value_difference = frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Purchase Receipt",
- "voucher_no": return_pr.name}, ["outgoing_rate", "stock_value_difference"])
+ outgoing_rate, stock_value_difference = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Purchase Receipt", "voucher_no": return_pr.name},
+ ["outgoing_rate", "stock_value_difference"],
+ )
self.assertEqual(outgoing_rate, 100)
self.assertEqual(stock_value_difference, -200)
create_landed_cost_voucher("Purchase Receipt", pr.name, pr.company)
- outgoing_rate, stock_value_difference = frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Purchase Receipt",
- "voucher_no": return_pr.name}, ["outgoing_rate", "stock_value_difference"])
+ outgoing_rate, stock_value_difference = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Purchase Receipt", "voucher_no": return_pr.name},
+ ["outgoing_rate", "stock_value_difference"],
+ )
self.assertEqual(outgoing_rate, 110)
self.assertEqual(stock_value_difference, -220)
def test_sales_return_valuation_reposting(self):
company = "_Test Company"
- item_code="_Test Item for Reposting"
+ item_code = "_Test Item for Reposting"
# Purchase Return: Qty = 5, Rate = 100
- pr = make_purchase_receipt(company=company, posting_date='2020-04-10',
- warehouse="Stores - _TC", item_code=item_code, qty=5, rate=100)
+ pr = make_purchase_receipt(
+ company=company,
+ posting_date="2020-04-10",
+ warehouse="Stores - _TC",
+ item_code=item_code,
+ qty=5,
+ rate=100,
+ )
- #Delivery Note: Qty = 5, Rate = 150
- dn = create_delivery_note(item_code=item_code, qty=5, rate=150, warehouse="Stores - _TC",
- company=company, expense_account="Cost of Goods Sold - _TC", cost_center="Main - _TC")
+ # Delivery Note: Qty = 5, Rate = 150
+ dn = create_delivery_note(
+ item_code=item_code,
+ qty=5,
+ rate=150,
+ warehouse="Stores - _TC",
+ company=company,
+ expense_account="Cost of Goods Sold - _TC",
+ cost_center="Main - _TC",
+ )
# check outgoing_rate for DN
- outgoing_rate = abs(frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Delivery Note",
- "voucher_no": dn.name}, "stock_value_difference") / 5)
+ outgoing_rate = abs(
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Delivery Note", "voucher_no": dn.name},
+ "stock_value_difference",
+ )
+ / 5
+ )
self.assertEqual(dn.items[0].incoming_rate, 100)
self.assertEqual(outgoing_rate, 100)
# Return Entry: Qty = -2, Rate = 150
- return_dn = create_delivery_note(is_return=1, return_against=dn.name, item_code=item_code, qty=-2, rate=150,
- company=company, warehouse="Stores - _TC", expense_account="Cost of Goods Sold - _TC", cost_center="Main - _TC")
+ return_dn = create_delivery_note(
+ is_return=1,
+ return_against=dn.name,
+ item_code=item_code,
+ qty=-2,
+ rate=150,
+ company=company,
+ warehouse="Stores - _TC",
+ expense_account="Cost of Goods Sold - _TC",
+ cost_center="Main - _TC",
+ )
# check incoming rate for Return entry
- incoming_rate, stock_value_difference = frappe.db.get_value("Stock Ledger Entry",
+ incoming_rate, stock_value_difference = frappe.db.get_value(
+ "Stock Ledger Entry",
{"voucher_type": "Delivery Note", "voucher_no": return_dn.name},
- ["incoming_rate", "stock_value_difference"])
+ ["incoming_rate", "stock_value_difference"],
+ )
self.assertEqual(return_dn.items[0].incoming_rate, 100)
self.assertEqual(incoming_rate, 100)
self.assertEqual(stock_value_difference, 200)
- #-------------------------------
+ # -------------------------------
# Landed Cost Voucher to update the rate of incoming Purchase Return: Additional cost = 50
lcv = create_landed_cost_voucher("Purchase Receipt", pr.name, pr.company)
# check outgoing_rate for DN after reposting
- outgoing_rate = abs(frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Delivery Note",
- "voucher_no": dn.name}, "stock_value_difference") / 5)
+ outgoing_rate = abs(
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Delivery Note", "voucher_no": dn.name},
+ "stock_value_difference",
+ )
+ / 5
+ )
self.assertEqual(outgoing_rate, 110)
dn.reload()
self.assertEqual(dn.items[0].incoming_rate, 110)
# check incoming rate for Return entry after reposting
- incoming_rate, stock_value_difference = frappe.db.get_value("Stock Ledger Entry",
+ incoming_rate, stock_value_difference = frappe.db.get_value(
+ "Stock Ledger Entry",
{"voucher_type": "Delivery Note", "voucher_no": return_dn.name},
- ["incoming_rate", "stock_value_difference"])
+ ["incoming_rate", "stock_value_difference"],
+ )
self.assertEqual(incoming_rate, 110)
self.assertEqual(stock_value_difference, 220)
@@ -212,55 +331,93 @@ class TestStockLedgerEntry(ERPNextTestCase):
def test_reposting_of_sales_return_for_packed_item(self):
company = "_Test Company"
- packed_item_code="_Test Item for Reposting"
+ packed_item_code = "_Test Item for Reposting"
bundled_item = "_Test Bundled Item for Reposting"
create_product_bundle_item(bundled_item, [[packed_item_code, 4]])
# Purchase Return: Qty = 50, Rate = 100
- pr = make_purchase_receipt(company=company, posting_date='2020-04-10',
- warehouse="Stores - _TC", item_code=packed_item_code, qty=50, rate=100)
+ pr = make_purchase_receipt(
+ company=company,
+ posting_date="2020-04-10",
+ warehouse="Stores - _TC",
+ item_code=packed_item_code,
+ qty=50,
+ rate=100,
+ )
- #Delivery Note: Qty = 5, Rate = 150
- dn = create_delivery_note(item_code=bundled_item, qty=5, rate=150, warehouse="Stores - _TC",
- company=company, expense_account="Cost of Goods Sold - _TC", cost_center="Main - _TC")
+ # Delivery Note: Qty = 5, Rate = 150
+ dn = create_delivery_note(
+ item_code=bundled_item,
+ qty=5,
+ rate=150,
+ warehouse="Stores - _TC",
+ company=company,
+ expense_account="Cost of Goods Sold - _TC",
+ cost_center="Main - _TC",
+ )
# check outgoing_rate for DN
- outgoing_rate = abs(frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Delivery Note",
- "voucher_no": dn.name}, "stock_value_difference") / 20)
+ outgoing_rate = abs(
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Delivery Note", "voucher_no": dn.name},
+ "stock_value_difference",
+ )
+ / 20
+ )
self.assertEqual(dn.packed_items[0].incoming_rate, 100)
self.assertEqual(outgoing_rate, 100)
# Return Entry: Qty = -2, Rate = 150
- return_dn = create_delivery_note(is_return=1, return_against=dn.name, item_code=bundled_item, qty=-2, rate=150,
- company=company, warehouse="Stores - _TC", expense_account="Cost of Goods Sold - _TC", cost_center="Main - _TC")
+ return_dn = create_delivery_note(
+ is_return=1,
+ return_against=dn.name,
+ item_code=bundled_item,
+ qty=-2,
+ rate=150,
+ company=company,
+ warehouse="Stores - _TC",
+ expense_account="Cost of Goods Sold - _TC",
+ cost_center="Main - _TC",
+ )
# check incoming rate for Return entry
- incoming_rate, stock_value_difference = frappe.db.get_value("Stock Ledger Entry",
+ incoming_rate, stock_value_difference = frappe.db.get_value(
+ "Stock Ledger Entry",
{"voucher_type": "Delivery Note", "voucher_no": return_dn.name},
- ["incoming_rate", "stock_value_difference"])
+ ["incoming_rate", "stock_value_difference"],
+ )
self.assertEqual(return_dn.packed_items[0].incoming_rate, 100)
self.assertEqual(incoming_rate, 100)
self.assertEqual(stock_value_difference, 800)
- #-------------------------------
+ # -------------------------------
# Landed Cost Voucher to update the rate of incoming Purchase Return: Additional cost = 50
lcv = create_landed_cost_voucher("Purchase Receipt", pr.name, pr.company)
# check outgoing_rate for DN after reposting
- outgoing_rate = abs(frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Delivery Note",
- "voucher_no": dn.name}, "stock_value_difference") / 20)
+ outgoing_rate = abs(
+ frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Delivery Note", "voucher_no": dn.name},
+ "stock_value_difference",
+ )
+ / 20
+ )
self.assertEqual(outgoing_rate, 101)
dn.reload()
self.assertEqual(dn.packed_items[0].incoming_rate, 101)
# check incoming rate for Return entry after reposting
- incoming_rate, stock_value_difference = frappe.db.get_value("Stock Ledger Entry",
+ incoming_rate, stock_value_difference = frappe.db.get_value(
+ "Stock Ledger Entry",
{"voucher_type": "Delivery Note", "voucher_no": return_dn.name},
- ["incoming_rate", "stock_value_difference"])
+ ["incoming_rate", "stock_value_difference"],
+ )
self.assertEqual(incoming_rate, 101)
self.assertEqual(stock_value_difference, 808)
@@ -278,20 +435,35 @@ class TestStockLedgerEntry(ERPNextTestCase):
from erpnext.manufacturing.doctype.production_plan.test_production_plan import make_bom
company = "_Test Company"
- rm_item_code="_Test Item for Reposting"
+ rm_item_code = "_Test Item for Reposting"
subcontracted_item = "_Test Subcontracted Item for Reposting"
- frappe.db.set_value("Buying Settings", None, "backflush_raw_materials_of_subcontract_based_on", "BOM")
- make_bom(item = subcontracted_item, raw_materials =[rm_item_code], currency="INR")
+ frappe.db.set_value(
+ "Buying Settings", None, "backflush_raw_materials_of_subcontract_based_on", "BOM"
+ )
+ make_bom(item=subcontracted_item, raw_materials=[rm_item_code], currency="INR")
# Purchase raw materials on supplier warehouse: Qty = 50, Rate = 100
- pr = make_purchase_receipt(company=company, posting_date='2020-04-10',
- warehouse="Stores - _TC", item_code=rm_item_code, qty=10, rate=100)
+ pr = make_purchase_receipt(
+ company=company,
+ posting_date="2020-04-10",
+ warehouse="Stores - _TC",
+ item_code=rm_item_code,
+ qty=10,
+ rate=100,
+ )
# Purchase Receipt for subcontracted item
- pr1 = make_purchase_receipt(company=company, posting_date='2020-04-20',
- warehouse="Finished Goods - _TC", supplier_warehouse="Stores - _TC",
- item_code=subcontracted_item, qty=10, rate=20, is_subcontracted="Yes")
+ pr1 = make_purchase_receipt(
+ company=company,
+ posting_date="2020-04-20",
+ warehouse="Finished Goods - _TC",
+ supplier_warehouse="Stores - _TC",
+ item_code=subcontracted_item,
+ qty=10,
+ rate=20,
+ is_subcontracted="Yes",
+ )
self.assertEqual(pr1.items[0].valuation_rate, 120)
@@ -302,8 +474,11 @@ class TestStockLedgerEntry(ERPNextTestCase):
self.assertEqual(pr1.items[0].valuation_rate, 125)
# check outgoing_rate for DN after reposting
- incoming_rate = frappe.db.get_value("Stock Ledger Entry", {"voucher_type": "Purchase Receipt",
- "voucher_no": pr1.name, "item_code": subcontracted_item}, "incoming_rate")
+ incoming_rate = frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_type": "Purchase Receipt", "voucher_no": pr1.name, "item_code": subcontracted_item},
+ "incoming_rate",
+ )
self.assertEqual(incoming_rate, 125)
# cleanup data
@@ -313,8 +488,9 @@ class TestStockLedgerEntry(ERPNextTestCase):
def test_back_dated_entry_not_allowed(self):
# Back dated stock transactions are only allowed to stock managers
- frappe.db.set_value("Stock Settings", None,
- "role_allowed_to_create_edit_back_dated_transactions", "Stock Manager")
+ frappe.db.set_value(
+ "Stock Settings", None, "role_allowed_to_create_edit_back_dated_transactions", "Stock Manager"
+ )
# Set User with Stock User role but not Stock Manager
try:
@@ -325,8 +501,13 @@ class TestStockLedgerEntry(ERPNextTestCase):
frappe.set_user(user.name)
stock_entry_on_today = make_stock_entry(target="_Test Warehouse - _TC", qty=10, basic_rate=100)
- back_dated_se_1 = make_stock_entry(target="_Test Warehouse - _TC", qty=10, basic_rate=100,
- posting_date=add_days(today(), -1), do_not_submit=True)
+ back_dated_se_1 = make_stock_entry(
+ target="_Test Warehouse - _TC",
+ qty=10,
+ basic_rate=100,
+ posting_date=add_days(today(), -1),
+ do_not_submit=True,
+ )
# Block back-dated entry
self.assertRaises(BackDatedStockTransaction, back_dated_se_1.submit)
@@ -336,17 +517,333 @@ class TestStockLedgerEntry(ERPNextTestCase):
frappe.set_user(user.name)
# Back dated entry allowed to Stock Manager
- back_dated_se_2 = make_stock_entry(target="_Test Warehouse - _TC", qty=10, basic_rate=100,
- posting_date=add_days(today(), -1))
+ back_dated_se_2 = make_stock_entry(
+ target="_Test Warehouse - _TC", qty=10, basic_rate=100, posting_date=add_days(today(), -1)
+ )
back_dated_se_2.cancel()
stock_entry_on_today.cancel()
finally:
- frappe.db.set_value("Stock Settings", None, "role_allowed_to_create_edit_back_dated_transactions", None)
+ frappe.db.set_value(
+ "Stock Settings", None, "role_allowed_to_create_edit_back_dated_transactions", None
+ )
frappe.set_user("Administrator")
user.remove_roles("Stock Manager")
+ def test_fifo_dependent_consumption(self):
+ item = make_item("_TestFifoTransferRates")
+ source = "_Test Warehouse - _TC"
+ target = "Stores - _TC"
+
+ rates = [10 * i for i in range(1, 20)]
+
+ receipt = make_stock_entry(item_code=item.name, target=source, qty=10, do_not_save=True, rate=10)
+ for rate in rates[1:]:
+ row = frappe.copy_doc(receipt.items[0], ignore_no_copy=False)
+ row.basic_rate = rate
+ receipt.append("items", row)
+
+ receipt.save()
+ receipt.submit()
+
+ expected_queues = []
+ for idx, rate in enumerate(rates, start=1):
+ expected_queues.append({"stock_queue": [[10, 10 * i] for i in range(1, idx + 1)]})
+ self.assertSLEs(receipt, expected_queues)
+
+ transfer = make_stock_entry(
+ item_code=item.name, source=source, target=target, qty=10, do_not_save=True, rate=10
+ )
+ for rate in rates[1:]:
+ row = frappe.copy_doc(transfer.items[0], ignore_no_copy=False)
+ transfer.append("items", row)
+
+ transfer.save()
+ transfer.submit()
+
+ # same exact queue should be transferred
+ self.assertSLEs(transfer, expected_queues, sle_filters={"warehouse": target})
+
+ def test_fifo_multi_item_repack_consumption(self):
+ rm = make_item("_TestFifoRepackRM")
+ packed = make_item("_TestFifoRepackFinished")
+ warehouse = "_Test Warehouse - _TC"
+
+ rates = [10 * i for i in range(1, 5)]
+
+ receipt = make_stock_entry(
+ item_code=rm.name, target=warehouse, qty=10, do_not_save=True, rate=10
+ )
+ for rate in rates[1:]:
+ row = frappe.copy_doc(receipt.items[0], ignore_no_copy=False)
+ row.basic_rate = rate
+ receipt.append("items", row)
+
+ receipt.save()
+ receipt.submit()
+
+ repack = make_stock_entry(
+ item_code=rm.name, source=warehouse, qty=10, do_not_save=True, rate=10, purpose="Repack"
+ )
+ for rate in rates[1:]:
+ row = frappe.copy_doc(repack.items[0], ignore_no_copy=False)
+ repack.append("items", row)
+
+ repack.append(
+ "items",
+ {
+ "item_code": packed.name,
+ "t_warehouse": warehouse,
+ "qty": 1,
+ "transfer_qty": 1,
+ },
+ )
+
+ repack.save()
+ repack.submit()
+
+ # same exact queue should be transferred
+ self.assertSLEs(
+ repack, [{"incoming_rate": sum(rates) * 10}], sle_filters={"item_code": packed.name}
+ )
+
+ @change_settings("Stock Settings", {"allow_negative_stock": 1})
+ def test_negative_fifo_valuation(self):
+ """
+ When stock goes negative discard FIFO queue.
+ Only pervailing valuation rate should be used for making transactions in such cases.
+ """
+ item = make_item(properties={"allow_negative_stock": 1}).name
+ warehouse = "_Test Warehouse - _TC"
+
+ receipt = make_stock_entry(item_code=item, target=warehouse, qty=10, rate=10)
+ consume1 = make_stock_entry(item_code=item, source=warehouse, qty=15)
+
+ self.assertSLEs(consume1, [{"stock_value": -5 * 10, "stock_queue": [[-5, 10]]}])
+
+ consume2 = make_stock_entry(item_code=item, source=warehouse, qty=5)
+ self.assertSLEs(consume2, [{"stock_value": -10 * 10, "stock_queue": [[-10, 10]]}])
+
+ receipt2 = make_stock_entry(item_code=item, target=warehouse, qty=15, rate=15)
+ self.assertSLEs(receipt2, [{"stock_queue": [[5, 15]], "stock_value_difference": 175}])
+
+ def test_dependent_gl_entry_reposting(self):
+ def _get_stock_credit(doc):
+ return frappe.db.get_value(
+ "GL Entry",
+ {
+ "voucher_no": doc.name,
+ "voucher_type": doc.doctype,
+ "is_cancelled": 0,
+ "account": "Stock In Hand - TCP1",
+ },
+ "sum(credit)",
+ )
+
+ def _day(days):
+ return add_to_date(date=today(), days=days)
+
+ item = make_item().name
+ A = "Stores - TCP1"
+ B = "Work In Progress - TCP1"
+ C = "Finished Goods - TCP1"
+
+ make_stock_entry(item_code=item, to_warehouse=A, qty=5, rate=10, posting_date=_day(0))
+ make_stock_entry(item_code=item, from_warehouse=A, to_warehouse=B, qty=5, posting_date=_day(1))
+ depdendent_consumption = make_stock_entry(
+ item_code=item, from_warehouse=B, qty=5, posting_date=_day(2)
+ )
+ self.assertEqual(50, _get_stock_credit(depdendent_consumption))
+
+ # backdated receipt - should trigger GL repost of all previous stock entries
+ bd_receipt = make_stock_entry(
+ item_code=item, to_warehouse=A, qty=5, rate=20, posting_date=_day(-1)
+ )
+ self.assertEqual(100, _get_stock_credit(depdendent_consumption))
+
+ # cancelling receipt should reset it back
+ bd_receipt.cancel()
+ self.assertEqual(50, _get_stock_credit(depdendent_consumption))
+
+ bd_receipt2 = make_stock_entry(
+ item_code=item, to_warehouse=A, qty=2, rate=20, posting_date=_day(-2)
+ )
+ # total as per FIFO -> 2 * 20 + 3 * 10 = 70
+ self.assertEqual(70, _get_stock_credit(depdendent_consumption))
+
+ # transfer WIP material to final destination and consume it all
+ depdendent_consumption.cancel()
+ make_stock_entry(item_code=item, from_warehouse=B, to_warehouse=C, qty=5, posting_date=_day(3))
+ final_consumption = make_stock_entry(
+ item_code=item, from_warehouse=C, qty=5, posting_date=_day(4)
+ )
+ # exact amount gets consumed
+ self.assertEqual(70, _get_stock_credit(final_consumption))
+
+ # cancel original backdated receipt - should repost A -> B -> C
+ bd_receipt2.cancel()
+ # original amount
+ self.assertEqual(50, _get_stock_credit(final_consumption))
+
+ def test_timestamp_clash(self):
+
+ item = make_item().name
+ warehouse = "_Test Warehouse - _TC"
+
+ reciept = make_stock_entry(
+ item_code=item,
+ to_warehouse=warehouse,
+ qty=100,
+ rate=10,
+ posting_date="2021-01-01",
+ posting_time="01:00:00",
+ )
+
+ consumption = make_stock_entry(
+ item_code=item,
+ from_warehouse=warehouse,
+ qty=50,
+ posting_date="2021-01-01",
+ posting_time="02:00:00.1234", # ms are possible when submitted without editing posting time
+ )
+
+ backdated_receipt = make_stock_entry(
+ item_code=item,
+ to_warehouse=warehouse,
+ qty=100,
+ posting_date="2021-01-01",
+ rate=10,
+ posting_time="02:00:00", # same posting time as consumption but ms part stripped
+ )
+
+ try:
+ backdated_receipt.cancel()
+ except Exception as e:
+ self.fail("Double processing of qty for clashing timestamp.")
+
+ @change_settings("System Settings", {"float_precision": 3, "currency_precision": 2})
+ def test_transfer_invariants(self):
+ """Extact stock value should be transferred."""
+
+ item = make_item(
+ properties={
+ "valuation_method": "Moving Average",
+ "stock_uom": "Kg",
+ }
+ ).name
+ source_warehouse = "Stores - TCP1"
+ target_warehouse = "Finished Goods - TCP1"
+
+ make_purchase_receipt(
+ item=item,
+ warehouse=source_warehouse,
+ qty=20,
+ conversion_factor=1000,
+ uom="Tonne",
+ rate=156_526.0,
+ company="_Test Company with perpetual inventory",
+ )
+ transfer = make_stock_entry(
+ item=item, from_warehouse=source_warehouse, to_warehouse=target_warehouse, qty=1_728.0
+ )
+
+ filters = {"voucher_no": transfer.name, "voucher_type": transfer.doctype, "is_cancelled": 0}
+ sles = frappe.get_all(
+ "Stock Ledger Entry",
+ fields=["*"],
+ filters=filters,
+ order_by="timestamp(posting_date, posting_time), creation",
+ )
+ self.assertEqual(abs(sles[0].stock_value_difference), sles[1].stock_value_difference)
+
+ @change_settings("System Settings", {"float_precision": 4})
+ def test_negative_qty_with_precision(self):
+ "Test if system precision is respected while validating negative qty."
+ from erpnext.stock.doctype.item.test_item import create_item
+ from erpnext.stock.utils import get_stock_balance
+
+ item_code = "ItemPrecisionTest"
+ warehouse = "_Test Warehouse - _TC"
+ create_item(item_code, is_stock_item=1, stock_uom="Kg")
+
+ create_stock_reconciliation(item_code=item_code, warehouse=warehouse, qty=559.8327, rate=100)
+
+ make_stock_entry(item_code=item_code, source=warehouse, qty=470.84, rate=100)
+ self.assertEqual(get_stock_balance(item_code, warehouse), 88.9927)
+
+ settings = frappe.get_doc("System Settings")
+ settings.float_precision = 3
+ settings.save()
+
+ # To deliver 100 qty we fall short of 11.0073 qty (11.007 with precision 3)
+ # Stock up with 11.007 (balance in db becomes 99.9997, on UI it will show as 100)
+ make_stock_entry(item_code=item_code, target=warehouse, qty=11.007, rate=100)
+ self.assertEqual(get_stock_balance(item_code, warehouse), 99.9997)
+
+ # See if delivery note goes through
+ # Negative qty error should not be raised as 99.9997 is 100 with precision 3 (system precision)
+ dn = create_delivery_note(
+ item_code=item_code,
+ qty=100,
+ rate=150,
+ warehouse=warehouse,
+ company="_Test Company",
+ expense_account="Cost of Goods Sold - _TC",
+ cost_center="Main - _TC",
+ do_not_submit=True,
+ )
+ dn.submit()
+
+ self.assertEqual(flt(get_stock_balance(item_code, warehouse), 3), 0.000)
+
+ @change_settings("System Settings", {"float_precision": 4})
+ def test_future_negative_qty_with_precision(self):
+ """
+ Ledger:
+ | Voucher | Qty | Balance
+ -------------------
+ | Reco | 559.8327| 559.8327
+ | SE | -470.84 | [Backdated] (new bal: 88.9927)
+ | SE | 11.007 | 570.8397 (new bal: 99.9997)
+ | DN | -100 | 470.8397 (new bal: -0.0003)
+
+ Check if future negative qty is asserted as per precision 3.
+ -0.0003 should be considered as 0.000
+ """
+ from erpnext.stock.doctype.item.test_item import create_item
+
+ item_code = "ItemPrecisionTest"
+ warehouse = "_Test Warehouse - _TC"
+ create_item(item_code, is_stock_item=1, stock_uom="Kg")
+
+ create_stock_reconciliation(
+ item_code=item_code,
+ warehouse=warehouse,
+ qty=559.8327,
+ rate=100,
+ posting_date=add_days(today(), -2),
+ )
+ make_stock_entry(item_code=item_code, target=warehouse, qty=11.007, rate=100)
+ create_delivery_note(
+ item_code=item_code,
+ qty=100,
+ rate=150,
+ warehouse=warehouse,
+ company="_Test Company",
+ expense_account="Cost of Goods Sold - _TC",
+ cost_center="Main - _TC",
+ )
+
+ settings = frappe.get_doc("System Settings")
+ settings.float_precision = 3
+ settings.save()
+
+ # Make backdated SE and make sure SE goes through as per precision (no negative qty error)
+ make_stock_entry(
+ item_code=item_code, source=warehouse, qty=470.84, rate=100, posting_date=add_days(today(), -1)
+ )
+
def create_repack_entry(**args):
args = frappe._dict(args)
@@ -355,51 +852,63 @@ def create_repack_entry(**args):
repack.company = args.company or "_Test Company"
repack.posting_date = args.posting_date
repack.set_posting_time = 1
- repack.append("items", {
- "item_code": "_Test Item for Reposting",
- "s_warehouse": "Stores - _TC",
- "qty": 5,
- "conversion_factor": 1,
- "expense_account": "Stock Adjustment - _TC",
- "cost_center": "Main - _TC"
- })
+ repack.append(
+ "items",
+ {
+ "item_code": "_Test Item for Reposting",
+ "s_warehouse": "Stores - _TC",
+ "qty": 5,
+ "conversion_factor": 1,
+ "expense_account": "Stock Adjustment - _TC",
+ "cost_center": "Main - _TC",
+ },
+ )
- repack.append("items", {
- "item_code": "_Test Finished Item for Reposting",
- "t_warehouse": "Finished Goods - _TC",
- "qty": 1,
- "conversion_factor": 1,
- "expense_account": "Stock Adjustment - _TC",
- "cost_center": "Main - _TC"
- })
+ repack.append(
+ "items",
+ {
+ "item_code": "_Test Finished Item for Reposting",
+ "t_warehouse": "Finished Goods - _TC",
+ "qty": 1,
+ "conversion_factor": 1,
+ "expense_account": "Stock Adjustment - _TC",
+ "cost_center": "Main - _TC",
+ },
+ )
- repack.append("additional_costs", {
- "expense_account": "Freight and Forwarding Charges - _TC",
- "description": "transport cost",
- "amount": 40
- })
+ repack.append(
+ "additional_costs",
+ {
+ "expense_account": "Freight and Forwarding Charges - _TC",
+ "description": "transport cost",
+ "amount": 40,
+ },
+ )
repack.save()
repack.submit()
return repack
+
def create_product_bundle_item(new_item_code, packed_items):
if not frappe.db.exists("Product Bundle", new_item_code):
item = frappe.new_doc("Product Bundle")
item.new_item_code = new_item_code
for d in packed_items:
- item.append("items", {
- "item_code": d[0],
- "qty": d[1]
- })
+ item.append("items", {"item_code": d[0], "qty": d[1]})
item.save()
+
def create_items():
- items = ["_Test Item for Reposting", "_Test Finished Item for Reposting",
- "_Test Subcontracted Item for Reposting", "_Test Bundled Item for Reposting"]
+ items = [
+ "_Test Item for Reposting",
+ "_Test Finished Item for Reposting",
+ "_Test Subcontracted Item for Reposting",
+ "_Test Bundled Item for Reposting",
+ ]
for d in items:
properties = {"valuation_method": "FIFO"}
if d == "_Test Bundled Item for Reposting":
@@ -410,3 +919,81 @@ def create_items():
make_item(d, properties=properties)
return items
+
+
+class TestDeferredNaming(FrappeTestCase):
+ @classmethod
+ def setUpClass(cls) -> None:
+ super().setUpClass()
+ cls.gle_autoname = frappe.get_meta("GL Entry").autoname
+ cls.sle_autoname = frappe.get_meta("Stock Ledger Entry").autoname
+
+ def setUp(self) -> None:
+ self.item = make_item().name
+ self.warehouse = "Stores - TCP1"
+ self.company = "_Test Company with perpetual inventory"
+
+ def tearDown(self) -> None:
+ make_property_setter(
+ doctype="GL Entry",
+ for_doctype=True,
+ property="autoname",
+ value=self.gle_autoname,
+ property_type="Data",
+ fieldname=None,
+ )
+ make_property_setter(
+ doctype="Stock Ledger Entry",
+ for_doctype=True,
+ property="autoname",
+ value=self.sle_autoname,
+ property_type="Data",
+ fieldname=None,
+ )
+
+ # since deferred naming autocommits, commit all changes to avoid flake
+ frappe.db.commit() # nosemgrep
+
+ @staticmethod
+ def get_gle_sles(se):
+ filters = {"voucher_type": se.doctype, "voucher_no": se.name}
+ gle = set(frappe.get_list("GL Entry", filters, pluck="name"))
+ sle = set(frappe.get_list("Stock Ledger Entry", filters, pluck="name"))
+ return gle, sle
+
+ def test_deferred_naming(self):
+ se = make_stock_entry(
+ item_code=self.item, to_warehouse=self.warehouse, qty=10, rate=100, company=self.company
+ )
+
+ gle, sle = self.get_gle_sles(se)
+ rename_gle_sle_docs()
+ renamed_gle, renamed_sle = self.get_gle_sles(se)
+
+ self.assertFalse(gle & renamed_gle, msg="GLEs not renamed")
+ self.assertFalse(sle & renamed_sle, msg="SLEs not renamed")
+ se.cancel()
+
+ def test_hash_naming(self):
+ # disable naming series
+ for doctype in ("GL Entry", "Stock Ledger Entry"):
+ make_property_setter(
+ doctype=doctype,
+ for_doctype=True,
+ property="autoname",
+ value="hash",
+ property_type="Data",
+ fieldname=None,
+ )
+
+ se = make_stock_entry(
+ item_code=self.item, to_warehouse=self.warehouse, qty=10, rate=100, company=self.company
+ )
+
+ gle, sle = self.get_gle_sles(se)
+ rename_gle_sle_docs()
+ renamed_gle, renamed_sle = self.get_gle_sles(se)
+
+ self.assertEqual(gle, renamed_gle, msg="GLEs are renamed while using hash naming")
+ self.assertEqual(sle, renamed_sle, msg="SLEs are renamed while using hash naming")
+ se.cancel()
diff --git a/erpnext/stock/doctype/stock_reconciliation/stock_reconciliation.json b/erpnext/stock/doctype/stock_reconciliation/stock_reconciliation.json
index 3402972bb89..a882a61e5a5 100644
--- a/erpnext/stock/doctype/stock_reconciliation/stock_reconciliation.json
+++ b/erpnext/stock/doctype/stock_reconciliation/stock_reconciliation.json
@@ -18,7 +18,6 @@
"items",
"section_break_9",
"expense_account",
- "reconciliation_json",
"column_break_13",
"difference_amount",
"amended_from",
@@ -111,15 +110,6 @@
"label": "Cost Center",
"options": "Cost Center"
},
- {
- "fieldname": "reconciliation_json",
- "fieldtype": "Long Text",
- "hidden": 1,
- "label": "Reconciliation JSON",
- "no_copy": 1,
- "print_hide": 1,
- "read_only": 1
- },
{
"fieldname": "column_break_13",
"fieldtype": "Column Break"
@@ -155,7 +145,7 @@
"idx": 1,
"is_submittable": 1,
"links": [],
- "modified": "2021-11-30 01:33:51.437194",
+ "modified": "2022-02-06 14:28:19.043905",
"modified_by": "Administrator",
"module": "Stock",
"name": "Stock Reconciliation",
@@ -178,5 +168,6 @@
"search_fields": "posting_date",
"show_name_in_global_search": 1,
"sort_field": "modified",
- "sort_order": "DESC"
+ "sort_order": "DESC",
+ "states": []
}
\ No newline at end of file
diff --git a/erpnext/stock/doctype/stock_reconciliation/stock_reconciliation.py b/erpnext/stock/doctype/stock_reconciliation/stock_reconciliation.py
index 8f65287c4e8..87cc8c6a957 100644
--- a/erpnext/stock/doctype/stock_reconciliation/stock_reconciliation.py
+++ b/erpnext/stock/doctype/stock_reconciliation/stock_reconciliation.py
@@ -14,8 +14,13 @@ from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
from erpnext.stock.utils import get_stock_balance
-class OpeningEntryAccountError(frappe.ValidationError): pass
-class EmptyStockReconciliationItemsError(frappe.ValidationError): pass
+class OpeningEntryAccountError(frappe.ValidationError):
+ pass
+
+
+class EmptyStockReconciliationItemsError(frappe.ValidationError):
+ pass
+
class StockReconciliation(StockController):
def __init__(self, *args, **kwargs):
@@ -24,9 +29,11 @@ class StockReconciliation(StockController):
def validate(self):
if not self.expense_account:
- self.expense_account = frappe.get_cached_value('Company', self.company, "stock_adjustment_account")
+ self.expense_account = frappe.get_cached_value(
+ "Company", self.company, "stock_adjustment_account"
+ )
if not self.cost_center:
- self.cost_center = frappe.get_cached_value('Company', self.company, "cost_center")
+ self.cost_center = frappe.get_cached_value("Company", self.company, "cost_center")
self.validate_posting_time()
self.remove_items_with_no_change()
self.validate_data()
@@ -37,8 +44,8 @@ class StockReconciliation(StockController):
self.set_total_qty_and_amount()
self.validate_putaway_capacity()
- if self._action=="submit":
- self.make_batches('warehouse')
+ if self._action == "submit":
+ self.make_batches("warehouse")
def on_submit(self):
self.update_stock_ledger()
@@ -46,24 +53,30 @@ class StockReconciliation(StockController):
self.repost_future_sle_and_gle()
from erpnext.stock.doctype.serial_no.serial_no import update_serial_nos_after_submit
+
update_serial_nos_after_submit(self, "items")
def on_cancel(self):
- self.ignore_linked_doctypes = ('GL Entry', 'Stock Ledger Entry', 'Repost Item Valuation')
+ self.ignore_linked_doctypes = ("GL Entry", "Stock Ledger Entry", "Repost Item Valuation")
self.make_sle_on_cancel()
self.make_gl_entries_on_cancel()
self.repost_future_sle_and_gle()
+ self.delete_auto_created_batches()
def remove_items_with_no_change(self):
"""Remove items if qty or rate is not changed"""
self.difference_amount = 0.0
- def _changed(item):
- item_dict = get_stock_balance_for(item.item_code, item.warehouse,
- self.posting_date, self.posting_time, batch_no=item.batch_no)
- if ((item.qty is None or item.qty==item_dict.get("qty")) and
- (item.valuation_rate is None or item.valuation_rate==item_dict.get("rate")) and
- (not item.serial_no or (item.serial_no == item_dict.get("serial_nos")) )):
+ def _changed(item):
+ item_dict = get_stock_balance_for(
+ item.item_code, item.warehouse, self.posting_date, self.posting_time, batch_no=item.batch_no
+ )
+
+ if (
+ (item.qty is None or item.qty == item_dict.get("qty"))
+ and (item.valuation_rate is None or item.valuation_rate == item_dict.get("rate"))
+ and (not item.serial_no or (item.serial_no == item_dict.get("serial_nos")))
+ ):
return False
else:
# set default as current rates
@@ -80,16 +93,20 @@ class StockReconciliation(StockController):
item.current_qty = item_dict.get("qty")
item.current_valuation_rate = item_dict.get("rate")
- self.difference_amount += (flt(item.qty, item.precision("qty")) * \
- flt(item.valuation_rate or item_dict.get("rate"), item.precision("valuation_rate")) \
- - flt(item_dict.get("qty"), item.precision("qty")) * flt(item_dict.get("rate"), item.precision("valuation_rate")))
+ self.difference_amount += flt(item.qty, item.precision("qty")) * flt(
+ item.valuation_rate or item_dict.get("rate"), item.precision("valuation_rate")
+ ) - flt(item_dict.get("qty"), item.precision("qty")) * flt(
+ item_dict.get("rate"), item.precision("valuation_rate")
+ )
return True
items = list(filter(lambda d: _changed(d), self.items))
if not items:
- frappe.throw(_("None of the items have any change in quantity or value."),
- EmptyStockReconciliationItemsError)
+ frappe.throw(
+ _("None of the items have any change in quantity or value."),
+ EmptyStockReconciliationItemsError,
+ )
elif len(items) != len(self.items):
self.items = items
@@ -99,7 +116,7 @@ class StockReconciliation(StockController):
def validate_data(self):
def _get_msg(row_num, msg):
- return _("Row # {0}:").format(row_num+1) + " " + msg
+ return _("Row # {0}:").format(row_num + 1) + " " + msg
self.validation_messages = []
item_warehouse_combinations = []
@@ -109,7 +126,7 @@ class StockReconciliation(StockController):
for row_num, row in enumerate(self.items):
# find duplicates
key = [row.item_code, row.warehouse]
- for field in ['serial_no', 'batch_no']:
+ for field in ["serial_no", "batch_no"]:
if row.get(field):
key.append(row.get(field))
@@ -126,32 +143,35 @@ class StockReconciliation(StockController):
# if both not specified
if row.qty in ["", None] and row.valuation_rate in ["", None]:
- self.validation_messages.append(_get_msg(row_num,
- _("Please specify either Quantity or Valuation Rate or both")))
+ self.validation_messages.append(
+ _get_msg(row_num, _("Please specify either Quantity or Valuation Rate or both"))
+ )
# do not allow negative quantity
if flt(row.qty) < 0:
- self.validation_messages.append(_get_msg(row_num,
- _("Negative Quantity is not allowed")))
+ self.validation_messages.append(_get_msg(row_num, _("Negative Quantity is not allowed")))
# do not allow negative valuation
if flt(row.valuation_rate) < 0:
- self.validation_messages.append(_get_msg(row_num,
- _("Negative Valuation Rate is not allowed")))
+ self.validation_messages.append(_get_msg(row_num, _("Negative Valuation Rate is not allowed")))
if row.qty and row.valuation_rate in ["", None]:
- row.valuation_rate = get_stock_balance(row.item_code, row.warehouse,
- self.posting_date, self.posting_time, with_valuation_rate=True)[1]
+ row.valuation_rate = get_stock_balance(
+ row.item_code, row.warehouse, self.posting_date, self.posting_time, with_valuation_rate=True
+ )[1]
if not row.valuation_rate:
# try if there is a buying price list in default currency
- buying_rate = frappe.db.get_value("Item Price", {"item_code": row.item_code,
- "buying": 1, "currency": default_currency}, "price_list_rate")
+ buying_rate = frappe.db.get_value(
+ "Item Price",
+ {"item_code": row.item_code, "buying": 1, "currency": default_currency},
+ "price_list_rate",
+ )
if buying_rate:
row.valuation_rate = buying_rate
else:
# get valuation rate from Item
- row.valuation_rate = frappe.get_value('Item', row.item_code, 'valuation_rate')
+ row.valuation_rate = frappe.get_value("Item", row.item_code, "valuation_rate")
# throw all validation messages
if self.validation_messages:
@@ -178,7 +198,9 @@ class StockReconciliation(StockController):
# item should not be serialized
if item.has_serial_no and not row.serial_no and not item.serial_no_series:
- raise frappe.ValidationError(_("Serial no(s) required for serialized item {0}").format(item_code))
+ raise frappe.ValidationError(
+ _("Serial no(s) required for serialized item {0}").format(item_code)
+ )
# item managed batch-wise not allowed
if item.has_batch_no and not row.batch_no and not item.create_new_batch:
@@ -191,8 +213,8 @@ class StockReconciliation(StockController):
self.validation_messages.append(_("Row #") + " " + ("%d: " % (row.idx)) + cstr(e))
def update_stock_ledger(self):
- """ find difference between current and expected entries
- and create stock ledger entries based on the difference"""
+ """find difference between current and expected entries
+ and create stock ledger entries based on the difference"""
from erpnext.stock.stock_ledger import get_previous_sle
sl_entries = []
@@ -208,15 +230,20 @@ class StockReconciliation(StockController):
self.get_sle_for_serialized_items(row, sl_entries)
else:
if row.serial_no or row.batch_no:
- frappe.throw(_("Row #{0}: Item {1} is not a Serialized/Batched Item. It cannot have a Serial No/Batch No against it.") \
- .format(row.idx, frappe.bold(row.item_code)))
+ frappe.throw(
+ _(
+ "Row #{0}: Item {1} is not a Serialized/Batched Item. It cannot have a Serial No/Batch No against it."
+ ).format(row.idx, frappe.bold(row.item_code))
+ )
- previous_sle = get_previous_sle({
- "item_code": row.item_code,
- "warehouse": row.warehouse,
- "posting_date": self.posting_date,
- "posting_time": self.posting_time
- })
+ previous_sle = get_previous_sle(
+ {
+ "item_code": row.item_code,
+ "warehouse": row.warehouse,
+ "posting_date": self.posting_date,
+ "posting_time": self.posting_time,
+ }
+ )
if previous_sle:
if row.qty in ("", None):
@@ -226,12 +253,16 @@ class StockReconciliation(StockController):
row.valuation_rate = previous_sle.get("valuation_rate", 0)
if row.qty and not row.valuation_rate and not row.allow_zero_valuation_rate:
- frappe.throw(_("Valuation Rate required for Item {0} at row {1}").format(row.item_code, row.idx))
+ frappe.throw(
+ _("Valuation Rate required for Item {0} at row {1}").format(row.item_code, row.idx)
+ )
- if ((previous_sle and row.qty == previous_sle.get("qty_after_transaction")
- and (row.valuation_rate == previous_sle.get("valuation_rate") or row.qty == 0))
- or (not previous_sle and not row.qty)):
- continue
+ if (
+ previous_sle
+ and row.qty == previous_sle.get("qty_after_transaction")
+ and (row.valuation_rate == previous_sle.get("valuation_rate") or row.qty == 0)
+ ) or (not previous_sle and not row.qty):
+ continue
sl_entries.append(self.get_sle_for_items(row))
@@ -253,21 +284,24 @@ class StockReconciliation(StockController):
serial_nos = get_serial_nos(row.serial_no)
-
# To issue existing serial nos
if row.current_qty and (row.current_serial_no or row.batch_no):
args = self.get_sle_for_items(row)
- args.update({
- 'actual_qty': -1 * row.current_qty,
- 'serial_no': row.current_serial_no,
- 'batch_no': row.batch_no,
- 'valuation_rate': row.current_valuation_rate
- })
+ args.update(
+ {
+ "actual_qty": -1 * row.current_qty,
+ "serial_no": row.current_serial_no,
+ "batch_no": row.batch_no,
+ "valuation_rate": row.current_valuation_rate,
+ }
+ )
if row.current_serial_no:
- args.update({
- 'qty_after_transaction': 0,
- })
+ args.update(
+ {
+ "qty_after_transaction": 0,
+ }
+ )
sl_entries.append(args)
@@ -275,42 +309,49 @@ class StockReconciliation(StockController):
for serial_no in serial_nos:
args = self.get_sle_for_items(row, [serial_no])
- previous_sle = get_previous_sle({
- "item_code": row.item_code,
- "posting_date": self.posting_date,
- "posting_time": self.posting_time,
- "serial_no": serial_no
- })
+ previous_sle = get_previous_sle(
+ {
+ "item_code": row.item_code,
+ "posting_date": self.posting_date,
+ "posting_time": self.posting_time,
+ "serial_no": serial_no,
+ }
+ )
if previous_sle and row.warehouse != previous_sle.get("warehouse"):
# If serial no exists in different warehouse
- warehouse = previous_sle.get("warehouse", '') or row.warehouse
+ warehouse = previous_sle.get("warehouse", "") or row.warehouse
if not qty_after_transaction:
- qty_after_transaction = get_stock_balance(row.item_code,
- warehouse, self.posting_date, self.posting_time)
+ qty_after_transaction = get_stock_balance(
+ row.item_code, warehouse, self.posting_date, self.posting_time
+ )
qty_after_transaction -= 1
new_args = args.copy()
- new_args.update({
- 'actual_qty': -1,
- 'qty_after_transaction': qty_after_transaction,
- 'warehouse': warehouse,
- 'valuation_rate': previous_sle.get("valuation_rate")
- })
+ new_args.update(
+ {
+ "actual_qty": -1,
+ "qty_after_transaction": qty_after_transaction,
+ "warehouse": warehouse,
+ "valuation_rate": previous_sle.get("valuation_rate"),
+ }
+ )
sl_entries.append(new_args)
if row.qty:
args = self.get_sle_for_items(row)
- args.update({
- 'actual_qty': row.qty,
- 'incoming_rate': row.valuation_rate,
- 'valuation_rate': row.valuation_rate
- })
+ args.update(
+ {
+ "actual_qty": row.qty,
+ "incoming_rate": row.valuation_rate,
+ "valuation_rate": row.valuation_rate,
+ }
+ )
sl_entries.append(args)
@@ -320,7 +361,8 @@ class StockReconciliation(StockController):
def update_valuation_rate_for_serial_no(self):
for d in self.items:
- if not d.serial_no: continue
+ if not d.serial_no:
+ continue
serial_nos = get_serial_nos(d.serial_no)
self.update_valuation_rate_for_serial_nos(d, serial_nos)
@@ -331,7 +373,7 @@ class StockReconciliation(StockController):
return
for d in serial_nos:
- frappe.db.set_value("Serial No", d, 'purchase_rate', valuation_rate)
+ frappe.db.set_value("Serial No", d, "purchase_rate", valuation_rate)
def get_sle_for_items(self, row, serial_nos=None):
"""Insert Stock Ledger Entries"""
@@ -339,22 +381,24 @@ class StockReconciliation(StockController):
if not serial_nos and row.serial_no:
serial_nos = get_serial_nos(row.serial_no)
- data = frappe._dict({
- "doctype": "Stock Ledger Entry",
- "item_code": row.item_code,
- "warehouse": row.warehouse,
- "posting_date": self.posting_date,
- "posting_time": self.posting_time,
- "voucher_type": self.doctype,
- "voucher_no": self.name,
- "voucher_detail_no": row.name,
- "company": self.company,
- "stock_uom": frappe.db.get_value("Item", row.item_code, "stock_uom"),
- "is_cancelled": 1 if self.docstatus == 2 else 0,
- "serial_no": '\n'.join(serial_nos) if serial_nos else '',
- "batch_no": row.batch_no,
- "valuation_rate": flt(row.valuation_rate, row.precision("valuation_rate"))
- })
+ data = frappe._dict(
+ {
+ "doctype": "Stock Ledger Entry",
+ "item_code": row.item_code,
+ "warehouse": row.warehouse,
+ "posting_date": self.posting_date,
+ "posting_time": self.posting_time,
+ "voucher_type": self.doctype,
+ "voucher_no": self.name,
+ "voucher_detail_no": row.name,
+ "company": self.company,
+ "stock_uom": frappe.db.get_value("Item", row.item_code, "stock_uom"),
+ "is_cancelled": 1 if self.docstatus == 2 else 0,
+ "serial_no": "\n".join(serial_nos) if serial_nos else "",
+ "batch_no": row.batch_no,
+ "valuation_rate": flt(row.valuation_rate, row.precision("valuation_rate")),
+ }
+ )
if not row.batch_no:
data.qty_after_transaction = flt(row.qty, row.precision("qty"))
@@ -382,7 +426,7 @@ class StockReconciliation(StockController):
for row in self.items:
if row.serial_no or row.batch_no or row.current_serial_no:
has_serial_no = True
- serial_nos = ''
+ serial_nos = ""
if row.current_serial_no:
serial_nos = get_serial_nos(row.current_serial_no)
@@ -395,10 +439,11 @@ class StockReconciliation(StockController):
sl_entries = self.merge_similar_item_serial_nos(sl_entries)
sl_entries.reverse()
- allow_negative_stock = cint(frappe.db.get_single_value("Stock Settings", "allow_negative_stock"))
+ allow_negative_stock = cint(
+ frappe.db.get_single_value("Stock Settings", "allow_negative_stock")
+ )
self.make_sl_entries(sl_entries, allow_negative_stock=allow_negative_stock)
-
def merge_similar_item_serial_nos(self, sl_entries):
# If user has put the same item in multiple row with different serial no
new_sl_entries = []
@@ -411,16 +456,16 @@ class StockReconciliation(StockController):
key = (d.item_code, d.warehouse)
if key not in merge_similar_entries:
- d.total_amount = (d.actual_qty * d.valuation_rate)
+ d.total_amount = flt(d.actual_qty) * d.valuation_rate
merge_similar_entries[key] = d
elif d.serial_no:
data = merge_similar_entries[key]
data.actual_qty += d.actual_qty
data.qty_after_transaction += d.qty_after_transaction
- data.total_amount += (d.actual_qty * d.valuation_rate)
+ data.total_amount += d.actual_qty * d.valuation_rate
data.valuation_rate = (data.total_amount) / data.actual_qty
- data.serial_no += '\n' + d.serial_no
+ data.serial_no += "\n" + d.serial_no
data.incoming_rate = (data.total_amount) / data.actual_qty
@@ -433,8 +478,9 @@ class StockReconciliation(StockController):
if not self.cost_center:
msgprint(_("Please enter Cost Center"), raise_exception=1)
- return super(StockReconciliation, self).get_gl_entries(warehouse_account,
- self.expense_account, self.cost_center)
+ return super(StockReconciliation, self).get_gl_entries(
+ warehouse_account, self.expense_account, self.cost_center
+ )
def validate_expense_account(self):
if not cint(erpnext.is_perpetual_inventory_enabled(self.company)):
@@ -442,29 +488,39 @@ class StockReconciliation(StockController):
if not self.expense_account:
frappe.throw(_("Please enter Expense Account"))
- elif self.purpose == "Opening Stock" or not frappe.db.sql("""select name from `tabStock Ledger Entry` limit 1"""):
+ elif self.purpose == "Opening Stock" or not frappe.db.sql(
+ """select name from `tabStock Ledger Entry` limit 1"""
+ ):
if frappe.db.get_value("Account", self.expense_account, "report_type") == "Profit and Loss":
- frappe.throw(_("Difference Account must be a Asset/Liability type account, since this Stock Reconciliation is an Opening Entry"), OpeningEntryAccountError)
+ frappe.throw(
+ _(
+ "Difference Account must be a Asset/Liability type account, since this Stock Reconciliation is an Opening Entry"
+ ),
+ OpeningEntryAccountError,
+ )
def set_zero_value_for_customer_provided_items(self):
changed_any_values = False
- for d in self.get('items'):
- is_customer_item = frappe.db.get_value('Item', d.item_code, 'is_customer_provided_item')
+ for d in self.get("items"):
+ is_customer_item = frappe.db.get_value("Item", d.item_code, "is_customer_provided_item")
if is_customer_item and d.valuation_rate:
d.valuation_rate = 0.0
changed_any_values = True
if changed_any_values:
- msgprint(_("Valuation rate for customer provided items has been set to zero."),
- title=_("Note"), indicator="blue")
-
+ msgprint(
+ _("Valuation rate for customer provided items has been set to zero."),
+ title=_("Note"),
+ indicator="blue",
+ )
def set_total_qty_and_amount(self):
for d in self.get("items"):
d.amount = flt(d.qty, d.precision("qty")) * flt(d.valuation_rate, d.precision("valuation_rate"))
- d.current_amount = (flt(d.current_qty,
- d.precision("current_qty")) * flt(d.current_valuation_rate, d.precision("current_valuation_rate")))
+ d.current_amount = flt(d.current_qty, d.precision("current_qty")) * flt(
+ d.current_valuation_rate, d.precision("current_valuation_rate")
+ )
d.quantity_difference = flt(d.qty) - flt(d.current_qty)
d.amount_difference = flt(d.amount) - flt(d.current_amount)
@@ -476,25 +532,33 @@ class StockReconciliation(StockController):
def submit(self):
if len(self.items) > 100:
- msgprint(_("The task has been enqueued as a background job. In case there is any issue on processing in background, the system will add a comment about the error on this Stock Reconciliation and revert to the Draft stage"))
- self.queue_action('submit', timeout=2000)
+ msgprint(
+ _(
+ "The task has been enqueued as a background job. In case there is any issue on processing in background, the system will add a comment about the error on this Stock Reconciliation and revert to the Draft stage"
+ )
+ )
+ self.queue_action("submit", timeout=2000)
else:
self._submit()
def cancel(self):
if len(self.items) > 100:
- msgprint(_("The task has been enqueued as a background job. In case there is any issue on processing in background, the system will add a comment about the error on this Stock Reconciliation and revert to the Submitted stage"))
- self.queue_action('cancel', timeout=2000)
+ msgprint(
+ _(
+ "The task has been enqueued as a background job. In case there is any issue on processing in background, the system will add a comment about the error on this Stock Reconciliation and revert to the Submitted stage"
+ )
+ )
+ self.queue_action("cancel", timeout=2000)
else:
self._cancel()
+
@frappe.whitelist()
-def get_items(warehouse, posting_date, posting_time, company, item_code=None, ignore_empty_stock=False):
+def get_items(
+ warehouse, posting_date, posting_time, company, item_code=None, ignore_empty_stock=False
+):
ignore_empty_stock = cint(ignore_empty_stock)
- items = [frappe._dict({
- 'item_code': item_code,
- 'warehouse': warehouse
- })]
+ items = [frappe._dict({"item_code": item_code, "warehouse": warehouse})]
if not item_code:
items = get_items_for_stock_reco(warehouse, company)
@@ -504,8 +568,9 @@ def get_items(warehouse, posting_date, posting_time, company, item_code=None, ig
for d in items:
if d.item_code in itemwise_batch_data:
- valuation_rate = get_stock_balance(d.item_code, d.warehouse,
- posting_date, posting_time, with_valuation_rate=True)[1]
+ valuation_rate = get_stock_balance(
+ d.item_code, d.warehouse, posting_date, posting_time, with_valuation_rate=True
+ )[1]
for row in itemwise_batch_data.get(d.item_code):
if ignore_empty_stock and not row.qty:
@@ -514,12 +579,22 @@ def get_items(warehouse, posting_date, posting_time, company, item_code=None, ig
args = get_item_data(row, row.qty, valuation_rate)
res.append(args)
else:
- stock_bal = get_stock_balance(d.item_code, d.warehouse, posting_date, posting_time,
- with_valuation_rate=True , with_serial_no=cint(d.has_serial_no))
- qty, valuation_rate, serial_no = stock_bal[0], stock_bal[1], stock_bal[2] if cint(d.has_serial_no) else ''
+ stock_bal = get_stock_balance(
+ d.item_code,
+ d.warehouse,
+ posting_date,
+ posting_time,
+ with_valuation_rate=True,
+ with_serial_no=cint(d.has_serial_no),
+ )
+ qty, valuation_rate, serial_no = (
+ stock_bal[0],
+ stock_bal[1],
+ stock_bal[2] if cint(d.has_serial_no) else "",
+ )
if ignore_empty_stock and not stock_bal[0]:
- continue
+ continue
args = get_item_data(d, qty, valuation_rate, serial_no)
@@ -527,9 +602,11 @@ def get_items(warehouse, posting_date, posting_time, company, item_code=None, ig
return res
+
def get_items_for_stock_reco(warehouse, company):
lft, rgt = frappe.db.get_value("Warehouse", warehouse, ["lft", "rgt"])
- items = frappe.db.sql(f"""
+ items = frappe.db.sql(
+ f"""
select
i.name as item_code, i.item_name, bin.warehouse as warehouse, i.has_serial_no, i.has_batch_no
from
@@ -542,9 +619,12 @@ def get_items_for_stock_reco(warehouse, company):
and exists(
select name from `tabWarehouse` where lft >= {lft} and rgt <= {rgt} and name = bin.warehouse
)
- """, as_dict=1)
+ """,
+ as_dict=1,
+ )
- items += frappe.db.sql("""
+ items += frappe.db.sql(
+ """
select
i.name as item_code, i.item_name, id.default_warehouse as warehouse, i.has_serial_no, i.has_batch_no
from
@@ -559,40 +639,50 @@ def get_items_for_stock_reco(warehouse, company):
and IFNULL(i.disabled, 0) = 0
and id.company = %s
group by i.name
- """, (lft, rgt, company), as_dict=1)
+ """,
+ (lft, rgt, company),
+ as_dict=1,
+ )
# remove duplicates
# check if item-warehouse key extracted from each entry exists in set iw_keys
# and update iw_keys
iw_keys = set()
- items = [item for item in items if [(item.item_code, item.warehouse) not in iw_keys, iw_keys.add((item.item_code, item.warehouse))][0]]
+ items = [
+ item
+ for item in items
+ if [
+ (item.item_code, item.warehouse) not in iw_keys,
+ iw_keys.add((item.item_code, item.warehouse)),
+ ][0]
+ ]
return items
+
def get_item_data(row, qty, valuation_rate, serial_no=None):
return {
- 'item_code': row.item_code,
- 'warehouse': row.warehouse,
- 'qty': qty,
- 'item_name': row.item_name,
- 'valuation_rate': valuation_rate,
- 'current_qty': qty,
- 'current_valuation_rate': valuation_rate,
- 'current_serial_no': serial_no,
- 'serial_no': serial_no,
- 'batch_no': row.get('batch_no')
+ "item_code": row.item_code,
+ "warehouse": row.warehouse,
+ "qty": qty,
+ "item_name": row.item_name,
+ "valuation_rate": valuation_rate,
+ "current_qty": qty,
+ "current_valuation_rate": valuation_rate,
+ "current_serial_no": serial_no,
+ "serial_no": serial_no,
+ "batch_no": row.get("batch_no"),
}
+
def get_itemwise_batch(warehouse, posting_date, company, item_code=None):
from erpnext.stock.report.batch_wise_balance_history.batch_wise_balance_history import execute
+
itemwise_batch_data = {}
- filters = frappe._dict({
- 'warehouse': warehouse,
- 'from_date': posting_date,
- 'to_date': posting_date,
- 'company': company
- })
+ filters = frappe._dict(
+ {"warehouse": warehouse, "from_date": posting_date, "to_date": posting_date, "company": company}
+ )
if item_code:
filters.item_code = item_code
@@ -600,23 +690,28 @@ def get_itemwise_batch(warehouse, posting_date, company, item_code=None):
columns, data = execute(filters)
for row in data:
- itemwise_batch_data.setdefault(row[0], []).append(frappe._dict({
- 'item_code': row[0],
- 'warehouse': warehouse,
- 'qty': row[8],
- 'item_name': row[1],
- 'batch_no': row[4]
- }))
+ itemwise_batch_data.setdefault(row[0], []).append(
+ frappe._dict(
+ {
+ "item_code": row[0],
+ "warehouse": warehouse,
+ "qty": row[8],
+ "item_name": row[1],
+ "batch_no": row[4],
+ }
+ )
+ )
return itemwise_batch_data
-@frappe.whitelist()
-def get_stock_balance_for(item_code, warehouse,
- posting_date, posting_time, batch_no=None, with_valuation_rate= True):
- frappe.has_permission("Stock Reconciliation", "write", throw = True)
- item_dict = frappe.db.get_value("Item", item_code,
- ["has_serial_no", "has_batch_no"], as_dict=1)
+@frappe.whitelist()
+def get_stock_balance_for(
+ item_code, warehouse, posting_date, posting_time, batch_no=None, with_valuation_rate=True
+):
+ frappe.has_permission("Stock Reconciliation", "write", throw=True)
+
+ item_dict = frappe.db.get_value("Item", item_code, ["has_serial_no", "has_batch_no"], as_dict=1)
if not item_dict:
# In cases of data upload to Items table
@@ -625,8 +720,14 @@ def get_stock_balance_for(item_code, warehouse,
serial_nos = ""
with_serial_no = True if item_dict.get("has_serial_no") else False
- data = get_stock_balance(item_code, warehouse, posting_date, posting_time,
- with_valuation_rate=with_valuation_rate, with_serial_no=with_serial_no)
+ data = get_stock_balance(
+ item_code,
+ warehouse,
+ posting_date,
+ posting_time,
+ with_valuation_rate=with_valuation_rate,
+ with_serial_no=with_serial_no,
+ )
if with_serial_no:
qty, rate, serial_nos = data
@@ -634,20 +735,20 @@ def get_stock_balance_for(item_code, warehouse,
qty, rate = data
if item_dict.get("has_batch_no"):
- qty = get_batch_qty(batch_no, warehouse, posting_date=posting_date, posting_time=posting_time) or 0
+ qty = (
+ get_batch_qty(batch_no, warehouse, posting_date=posting_date, posting_time=posting_time) or 0
+ )
+
+ return {"qty": qty, "rate": rate, "serial_nos": serial_nos}
- return {
- 'qty': qty,
- 'rate': rate,
- 'serial_nos': serial_nos
- }
@frappe.whitelist()
def get_difference_account(purpose, company):
- if purpose == 'Stock Reconciliation':
+ if purpose == "Stock Reconciliation":
account = get_company_default(company, "stock_adjustment_account")
else:
- account = frappe.db.get_value('Account', {'is_group': 0,
- 'company': company, 'account_type': 'Temporary'}, 'name')
+ account = frappe.db.get_value(
+ "Account", {"is_group": 0, "company": company, "account_type": "Temporary"}, "name"
+ )
return account
diff --git a/erpnext/stock/doctype/stock_reconciliation/test_stock_reconciliation.py b/erpnext/stock/doctype/stock_reconciliation/test_stock_reconciliation.py
index 48e339ae566..190ae9edaf9 100644
--- a/erpnext/stock/doctype/stock_reconciliation/test_stock_reconciliation.py
+++ b/erpnext/stock/doctype/stock_reconciliation/test_stock_reconciliation.py
@@ -6,7 +6,8 @@
import frappe
-from frappe.utils import add_days, flt, nowdate, nowtime, random_string
+from frappe.tests.utils import FrappeTestCase, change_settings
+from frappe.utils import add_days, cstr, flt, nowdate, nowtime, random_string
from erpnext.accounts.utils import get_stock_and_account_balance
from erpnext.stock.doctype.item.test_item import create_item
@@ -18,17 +19,21 @@ from erpnext.stock.doctype.stock_reconciliation.stock_reconciliation import (
)
from erpnext.stock.doctype.warehouse.test_warehouse import create_warehouse
from erpnext.stock.stock_ledger import get_previous_sle, update_entries_after
+from erpnext.stock.tests.test_utils import StockTestMixin
from erpnext.stock.utils import get_incoming_rate, get_stock_value_on, get_valuation_method
-from erpnext.tests.utils import ERPNextTestCase, change_settings
-class TestStockReconciliation(ERPNextTestCase):
+class TestStockReconciliation(FrappeTestCase, StockTestMixin):
@classmethod
- def setUpClass(self):
- super().setUpClass()
+ def setUpClass(cls):
create_batch_or_serial_no_items()
+ super().setUpClass()
frappe.db.set_value("Stock Settings", None, "allow_negative_stock", 1)
+ def tearDown(self):
+ frappe.local.future_sle = {}
+ frappe.flags.pop("dont_execute_stock_reposts", None)
+
def test_reco_for_fifo(self):
self._test_reco_sle_gle("FIFO")
@@ -36,55 +41,73 @@ class TestStockReconciliation(ERPNextTestCase):
self._test_reco_sle_gle("Moving Average")
def _test_reco_sle_gle(self, valuation_method):
- se1, se2, se3 = insert_existing_sle(warehouse='Stores - TCP1')
- company = frappe.db.get_value('Warehouse', 'Stores - TCP1', 'company')
+ item_code = self.make_item(properties={"valuation_method": valuation_method}).name
+
+ se1, se2, se3 = insert_existing_sle(warehouse="Stores - TCP1", item_code=item_code)
+ company = frappe.db.get_value("Warehouse", "Stores - TCP1", "company")
# [[qty, valuation_rate, posting_date,
- # posting_time, expected_stock_value, bin_qty, bin_valuation]]
+ # posting_time, expected_stock_value, bin_qty, bin_valuation]]
input_data = [
[50, 1000, "2012-12-26", "12:00"],
[25, 900, "2012-12-26", "12:00"],
["", 1000, "2012-12-20", "12:05"],
[20, "", "2012-12-26", "12:05"],
- [0, "", "2012-12-31", "12:10"]
+ [0, "", "2012-12-31", "12:10"],
]
for d in input_data:
- set_valuation_method("_Test Item", valuation_method)
-
- last_sle = get_previous_sle({
- "item_code": "_Test Item",
- "warehouse": "Stores - TCP1",
- "posting_date": d[2],
- "posting_time": d[3]
- })
+ last_sle = get_previous_sle(
+ {
+ "item_code": item_code,
+ "warehouse": "Stores - TCP1",
+ "posting_date": d[2],
+ "posting_time": d[3],
+ }
+ )
# submit stock reconciliation
- stock_reco = create_stock_reconciliation(qty=d[0], rate=d[1],
- posting_date=d[2], posting_time=d[3], warehouse="Stores - TCP1",
- company=company, expense_account = "Stock Adjustment - TCP1")
+ stock_reco = create_stock_reconciliation(
+ item_code=item_code,
+ qty=d[0],
+ rate=d[1],
+ posting_date=d[2],
+ posting_time=d[3],
+ warehouse="Stores - TCP1",
+ company=company,
+ expense_account="Stock Adjustment - TCP1",
+ )
# check stock value
- sle = frappe.db.sql("""select * from `tabStock Ledger Entry`
- where voucher_type='Stock Reconciliation' and voucher_no=%s""", stock_reco.name, as_dict=1)
+ sle = frappe.db.sql(
+ """select * from `tabStock Ledger Entry`
+ where voucher_type='Stock Reconciliation' and voucher_no=%s""",
+ stock_reco.name,
+ as_dict=1,
+ )
qty_after_transaction = flt(d[0]) if d[0] != "" else flt(last_sle.get("qty_after_transaction"))
valuation_rate = flt(d[1]) if d[1] != "" else flt(last_sle.get("valuation_rate"))
- if qty_after_transaction == last_sle.get("qty_after_transaction") \
- and valuation_rate == last_sle.get("valuation_rate"):
- self.assertFalse(sle)
+ if qty_after_transaction == last_sle.get(
+ "qty_after_transaction"
+ ) and valuation_rate == last_sle.get("valuation_rate"):
+ self.assertFalse(sle)
else:
self.assertEqual(flt(sle[0].qty_after_transaction, 1), flt(qty_after_transaction, 1))
self.assertEqual(flt(sle[0].stock_value, 1), flt(qty_after_transaction * valuation_rate, 1))
# no gl entries
- self.assertTrue(frappe.db.get_value("Stock Ledger Entry",
- {"voucher_type": "Stock Reconciliation", "voucher_no": stock_reco.name}))
+ self.assertTrue(
+ frappe.db.get_value(
+ "Stock Ledger Entry", {"voucher_type": "Stock Reconciliation", "voucher_no": stock_reco.name}
+ )
+ )
- acc_bal, stock_bal, wh_list = get_stock_and_account_balance("Stock In Hand - TCP1",
- stock_reco.posting_date, stock_reco.company)
+ acc_bal, stock_bal, wh_list = get_stock_and_account_balance(
+ "Stock In Hand - TCP1", stock_reco.posting_date, stock_reco.company
+ )
self.assertEqual(flt(acc_bal, 1), flt(stock_bal, 1))
stock_reco.cancel()
@@ -94,18 +117,33 @@ class TestStockReconciliation(ERPNextTestCase):
se1.cancel()
def test_get_items(self):
- create_warehouse("_Test Warehouse Group 1",
- {"is_group": 1, "company": "_Test Company", "parent_warehouse": "All Warehouses - _TC"})
- create_warehouse("_Test Warehouse Ledger 1",
- {"is_group": 0, "parent_warehouse": "_Test Warehouse Group 1 - _TC", "company": "_Test Company"})
+ create_warehouse(
+ "_Test Warehouse Group 1",
+ {"is_group": 1, "company": "_Test Company", "parent_warehouse": "All Warehouses - _TC"},
+ )
+ create_warehouse(
+ "_Test Warehouse Ledger 1",
+ {
+ "is_group": 0,
+ "parent_warehouse": "_Test Warehouse Group 1 - _TC",
+ "company": "_Test Company",
+ },
+ )
- create_item("_Test Stock Reco Item", is_stock_item=1, valuation_rate=100,
- warehouse="_Test Warehouse Ledger 1 - _TC", opening_stock=100)
+ create_item(
+ "_Test Stock Reco Item",
+ is_stock_item=1,
+ valuation_rate=100,
+ warehouse="_Test Warehouse Ledger 1 - _TC",
+ opening_stock=100,
+ )
items = get_items("_Test Warehouse Group 1 - _TC", nowdate(), nowtime(), "_Test Company")
- self.assertEqual(["_Test Stock Reco Item", "_Test Warehouse Ledger 1 - _TC", 100],
- [items[0]["item_code"], items[0]["warehouse"], items[0]["qty"]])
+ self.assertEqual(
+ ["_Test Stock Reco Item", "_Test Warehouse Ledger 1 - _TC", 100],
+ [items[0]["item_code"], items[0]["warehouse"], items[0]["qty"]],
+ )
def test_stock_reco_for_serialized_item(self):
to_delete_records = []
@@ -115,8 +153,9 @@ class TestStockReconciliation(ERPNextTestCase):
serial_item_code = "Stock-Reco-Serial-Item-1"
serial_warehouse = "_Test Warehouse for Stock Reco1 - _TC"
- sr = create_stock_reconciliation(item_code=serial_item_code,
- warehouse = serial_warehouse, qty=5, rate=200)
+ sr = create_stock_reconciliation(
+ item_code=serial_item_code, warehouse=serial_warehouse, qty=5, rate=200
+ )
serial_nos = get_serial_nos(sr.items[0].serial_no)
self.assertEqual(len(serial_nos), 5)
@@ -126,7 +165,7 @@ class TestStockReconciliation(ERPNextTestCase):
"warehouse": serial_warehouse,
"posting_date": nowdate(),
"posting_time": nowtime(),
- "serial_no": sr.items[0].serial_no
+ "serial_no": sr.items[0].serial_no,
}
valuation_rate = get_incoming_rate(args)
@@ -134,8 +173,9 @@ class TestStockReconciliation(ERPNextTestCase):
to_delete_records.append(sr.name)
- sr = create_stock_reconciliation(item_code=serial_item_code,
- warehouse = serial_warehouse, qty=5, rate=300)
+ sr = create_stock_reconciliation(
+ item_code=serial_item_code, warehouse=serial_warehouse, qty=5, rate=300
+ )
serial_nos1 = get_serial_nos(sr.items[0].serial_no)
self.assertEqual(len(serial_nos1), 5)
@@ -145,7 +185,7 @@ class TestStockReconciliation(ERPNextTestCase):
"warehouse": serial_warehouse,
"posting_date": nowdate(),
"posting_time": nowtime(),
- "serial_no": sr.items[0].serial_no
+ "serial_no": sr.items[0].serial_no,
}
valuation_rate = get_incoming_rate(args)
@@ -158,7 +198,6 @@ class TestStockReconciliation(ERPNextTestCase):
stock_doc = frappe.get_doc("Stock Reconciliation", d)
stock_doc.cancel()
-
def test_stock_reco_for_merge_serialized_item(self):
to_delete_records = []
@@ -166,23 +205,34 @@ class TestStockReconciliation(ERPNextTestCase):
serial_item_code = "Stock-Reco-Serial-Item-2"
serial_warehouse = "_Test Warehouse for Stock Reco1 - _TC"
- sr = create_stock_reconciliation(item_code=serial_item_code, serial_no=random_string(6),
- warehouse = serial_warehouse, qty=1, rate=100, do_not_submit=True, purpose='Opening Stock')
+ sr = create_stock_reconciliation(
+ item_code=serial_item_code,
+ serial_no=random_string(6),
+ warehouse=serial_warehouse,
+ qty=1,
+ rate=100,
+ do_not_submit=True,
+ purpose="Opening Stock",
+ )
for i in range(3):
- sr.append('items', {
- 'item_code': serial_item_code,
- 'warehouse': serial_warehouse,
- 'qty': 1,
- 'valuation_rate': 100,
- 'serial_no': random_string(6)
- })
+ sr.append(
+ "items",
+ {
+ "item_code": serial_item_code,
+ "warehouse": serial_warehouse,
+ "qty": 1,
+ "valuation_rate": 100,
+ "serial_no": random_string(6),
+ },
+ )
sr.save()
sr.submit()
- sle_entries = frappe.get_all('Stock Ledger Entry', filters= {'voucher_no': sr.name},
- fields = ['name', 'incoming_rate'])
+ sle_entries = frappe.get_all(
+ "Stock Ledger Entry", filters={"voucher_no": sr.name}, fields=["name", "incoming_rate"]
+ )
self.assertEqual(len(sle_entries), 1)
self.assertEqual(sle_entries[0].incoming_rate, 100)
@@ -202,16 +252,18 @@ class TestStockReconciliation(ERPNextTestCase):
item_code = "Stock-Reco-batch-Item-1"
warehouse = "_Test Warehouse for Stock Reco2 - _TC"
- sr = create_stock_reconciliation(item_code=item_code,
- warehouse = warehouse, qty=5, rate=200, do_not_submit=1)
+ sr = create_stock_reconciliation(
+ item_code=item_code, warehouse=warehouse, qty=5, rate=200, do_not_save=1
+ )
sr.save(ignore_permissions=True)
sr.submit()
self.assertTrue(sr.items[0].batch_no)
to_delete_records.append(sr.name)
- sr1 = create_stock_reconciliation(item_code=item_code,
- warehouse = warehouse, qty=6, rate=300, batch_no=sr.items[0].batch_no)
+ sr1 = create_stock_reconciliation(
+ item_code=item_code, warehouse=warehouse, qty=6, rate=300, batch_no=sr.items[0].batch_no
+ )
args = {
"item_code": item_code,
@@ -224,9 +276,9 @@ class TestStockReconciliation(ERPNextTestCase):
self.assertEqual(valuation_rate, 300)
to_delete_records.append(sr1.name)
-
- sr2 = create_stock_reconciliation(item_code=item_code,
- warehouse = warehouse, qty=0, rate=0, batch_no=sr.items[0].batch_no)
+ sr2 = create_stock_reconciliation(
+ item_code=item_code, warehouse=warehouse, qty=0, rate=0, batch_no=sr.items[0].batch_no
+ )
stock_value = get_stock_value_on(warehouse, nowdate(), item_code)
self.assertEqual(stock_value, 0)
@@ -237,12 +289,91 @@ class TestStockReconciliation(ERPNextTestCase):
stock_doc = frappe.get_doc("Stock Reconciliation", d)
stock_doc.cancel()
- def test_customer_provided_items(self):
- item_code = 'Stock-Reco-customer-Item-100'
- create_item(item_code, is_customer_provided_item = 1,
- customer = '_Test Customer', is_purchase_item = 0)
+ def test_stock_reco_for_serial_and_batch_item(self):
+ item = create_item("_TestBatchSerialItemReco")
+ item.has_batch_no = 1
+ item.create_new_batch = 1
+ item.has_serial_no = 1
+ item.batch_number_series = "TBS-BATCH-.##"
+ item.serial_no_series = "TBS-.####"
+ item.save()
- sr = create_stock_reconciliation(item_code = item_code, qty = 10, rate = 420)
+ warehouse = "_Test Warehouse for Stock Reco2 - _TC"
+
+ sr = create_stock_reconciliation(item_code=item.item_code, warehouse=warehouse, qty=1, rate=100)
+
+ batch_no = sr.items[0].batch_no
+
+ serial_nos = get_serial_nos(sr.items[0].serial_no)
+ self.assertEqual(len(serial_nos), 1)
+ self.assertEqual(frappe.db.get_value("Serial No", serial_nos[0], "batch_no"), batch_no)
+
+ sr.cancel()
+
+ self.assertEqual(frappe.db.get_value("Serial No", serial_nos[0], "status"), "Inactive")
+ self.assertEqual(frappe.db.exists("Batch", batch_no), None)
+
+ def test_stock_reco_for_serial_and_batch_item_with_future_dependent_entry(self):
+ """
+ Behaviour: 1) Create Stock Reconciliation, which will be the origin document
+ of a new batch having a serial no
+ 2) Create a Stock Entry that adds a serial no to the same batch following this
+ Stock Reconciliation
+ 3) Cancel Stock Entry
+ Expected Result: 3) Serial No only in the Stock Entry is Inactive and Batch qty decreases
+ """
+ from erpnext.stock.doctype.batch.batch import get_batch_qty
+ from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry
+
+ item = create_item("_TestBatchSerialItemDependentReco")
+ item.has_batch_no = 1
+ item.create_new_batch = 1
+ item.has_serial_no = 1
+ item.batch_number_series = "TBSD-BATCH-.##"
+ item.serial_no_series = "TBSD-.####"
+ item.save()
+
+ warehouse = "_Test Warehouse for Stock Reco2 - _TC"
+
+ stock_reco = create_stock_reconciliation(
+ item_code=item.item_code, warehouse=warehouse, qty=1, rate=100
+ )
+ batch_no = stock_reco.items[0].batch_no
+ reco_serial_no = get_serial_nos(stock_reco.items[0].serial_no)[0]
+
+ stock_entry = make_stock_entry(
+ item_code=item.item_code, target=warehouse, qty=1, basic_rate=100, batch_no=batch_no
+ )
+ serial_no_2 = get_serial_nos(stock_entry.items[0].serial_no)[0]
+
+ # Check Batch qty after 2 transactions
+ batch_qty = get_batch_qty(batch_no, warehouse, item.item_code)
+ self.assertEqual(batch_qty, 2)
+
+ # Cancel latest stock document
+ stock_entry.cancel()
+
+ # Check Batch qty after cancellation
+ batch_qty = get_batch_qty(batch_no, warehouse, item.item_code)
+ self.assertEqual(batch_qty, 1)
+
+ # Check if Serial No from Stock Reconcilation is intact
+ self.assertEqual(frappe.db.get_value("Serial No", reco_serial_no, "batch_no"), batch_no)
+ self.assertEqual(frappe.db.get_value("Serial No", reco_serial_no, "status"), "Active")
+
+ # Check if Serial No from Stock Entry is Unlinked and Inactive
+ self.assertEqual(frappe.db.get_value("Serial No", serial_no_2, "batch_no"), None)
+ self.assertEqual(frappe.db.get_value("Serial No", serial_no_2, "status"), "Inactive")
+
+ stock_reco.cancel()
+
+ def test_customer_provided_items(self):
+ item_code = "Stock-Reco-customer-Item-100"
+ create_item(
+ item_code, is_customer_provided_item=1, customer="_Test Customer", is_purchase_item=0
+ )
+
+ sr = create_stock_reconciliation(item_code=item_code, qty=10, rate=420)
self.assertEqual(sr.get("items")[0].allow_zero_valuation_rate, 1)
self.assertEqual(sr.get("items")[0].valuation_rate, 0)
@@ -250,106 +381,111 @@ class TestStockReconciliation(ERPNextTestCase):
def test_backdated_stock_reco_qty_reposting(self):
"""
- Test if a backdated stock reco recalculates future qty until next reco.
- -------------------------------------------
- Var | Doc | Qty | Balance
- -------------------------------------------
- SR5 | Reco | 0 | 8 (posting date: today-4) [backdated]
- PR1 | PR | 10 | 18 (posting date: today-3)
- PR2 | PR | 1 | 19 (posting date: today-2)
- SR4 | Reco | 0 | 6 (posting date: today-1) [backdated]
- PR3 | PR | 1 | 7 (posting date: today) # can't post future PR
+ Test if a backdated stock reco recalculates future qty until next reco.
+ -------------------------------------------
+ Var | Doc | Qty | Balance
+ -------------------------------------------
+ PR5 | PR | 10 | 10 (posting date: today-4) [backdated]
+ SR5 | Reco | 0 | 8 (posting date: today-4) [backdated]
+ PR1 | PR | 10 | 18 (posting date: today-3)
+ PR2 | PR | 1 | 19 (posting date: today-2)
+ SR4 | Reco | 0 | 6 (posting date: today-1) [backdated]
+ PR3 | PR | 1 | 7 (posting date: today) # can't post future PR
"""
- item_code = "Backdated-Reco-Item"
+ item_code = self.make_item().name
warehouse = "_Test Warehouse - _TC"
- create_item(item_code)
- pr1 = make_purchase_receipt(item_code=item_code, warehouse=warehouse, qty=10, rate=100,
- posting_date=add_days(nowdate(), -3))
- pr2 = make_purchase_receipt(item_code=item_code, warehouse=warehouse, qty=1, rate=100,
- posting_date=add_days(nowdate(), -2))
- pr3 = make_purchase_receipt(item_code=item_code, warehouse=warehouse, qty=1, rate=100,
- posting_date=nowdate())
+ frappe.flags.dont_execute_stock_reposts = True
- pr1_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": pr1.name, "is_cancelled": 0},
- "qty_after_transaction")
- pr3_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": pr3.name, "is_cancelled": 0},
- "qty_after_transaction")
- self.assertEqual(pr1_balance, 10)
- self.assertEqual(pr3_balance, 12)
+ def assertBalance(doc, qty_after_transaction):
+ sle_balance = frappe.db.get_value(
+ "Stock Ledger Entry", {"voucher_no": doc.name, "is_cancelled": 0}, "qty_after_transaction"
+ )
+ self.assertEqual(sle_balance, qty_after_transaction)
+
+ pr1 = make_purchase_receipt(
+ item_code=item_code, warehouse=warehouse, qty=10, rate=100, posting_date=add_days(nowdate(), -3)
+ )
+ pr2 = make_purchase_receipt(
+ item_code=item_code, warehouse=warehouse, qty=1, rate=100, posting_date=add_days(nowdate(), -2)
+ )
+ pr3 = make_purchase_receipt(
+ item_code=item_code, warehouse=warehouse, qty=1, rate=100, posting_date=nowdate()
+ )
+ assertBalance(pr1, 10)
+ assertBalance(pr3, 12)
# post backdated stock reco in between
- sr4 = create_stock_reconciliation(item_code=item_code, warehouse=warehouse, qty=6, rate=100,
- posting_date=add_days(nowdate(), -1))
- pr3_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": pr3.name, "is_cancelled": 0},
- "qty_after_transaction")
- self.assertEqual(pr3_balance, 7)
+ sr4 = create_stock_reconciliation(
+ item_code=item_code, warehouse=warehouse, qty=6, rate=100, posting_date=add_days(nowdate(), -1)
+ )
+ assertBalance(pr3, 7)
# post backdated stock reco at the start
- sr5 = create_stock_reconciliation(item_code=item_code, warehouse=warehouse, qty=8, rate=100,
- posting_date=add_days(nowdate(), -4))
- pr1_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": pr1.name, "is_cancelled": 0},
- "qty_after_transaction")
- pr2_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": pr2.name, "is_cancelled": 0},
- "qty_after_transaction")
- sr4_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": sr4.name, "is_cancelled": 0},
- "qty_after_transaction")
- self.assertEqual(pr1_balance, 18)
- self.assertEqual(pr2_balance, 19)
- self.assertEqual(sr4_balance, 6) # check if future stock reco is unaffected
+ sr5 = create_stock_reconciliation(
+ item_code=item_code, warehouse=warehouse, qty=8, rate=100, posting_date=add_days(nowdate(), -4)
+ )
+ assertBalance(pr1, 18)
+ assertBalance(pr2, 19)
+ assertBalance(sr4, 6) # check if future stock reco is unaffected
+
+ # Make a backdated receipt and check only entries till first SR are affected
+ pr5 = make_purchase_receipt(
+ item_code=item_code, warehouse=warehouse, qty=10, rate=100, posting_date=add_days(nowdate(), -5)
+ )
+ assertBalance(pr5, 10)
+ # check if future stock reco is unaffected
+ assertBalance(sr4, 6)
+ assertBalance(sr5, 8)
# cancel backdated stock reco and check future impact
sr5.cancel()
- pr1_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": pr1.name, "is_cancelled": 0},
- "qty_after_transaction")
- pr2_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": pr2.name, "is_cancelled": 0},
- "qty_after_transaction")
- sr4_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": sr4.name, "is_cancelled": 0},
- "qty_after_transaction")
- self.assertEqual(pr1_balance, 10)
- self.assertEqual(pr2_balance, 11)
- self.assertEqual(sr4_balance, 6) # check if future stock reco is unaffected
-
- # teardown
- sr4.cancel()
- pr3.cancel()
- pr2.cancel()
- pr1.cancel()
+ assertBalance(pr1, 10)
+ assertBalance(pr2, 11)
+ assertBalance(sr4, 6) # check if future stock reco is unaffected
@change_settings("Stock Settings", {"allow_negative_stock": 0})
def test_backdated_stock_reco_future_negative_stock(self):
"""
- Test if a backdated stock reco causes future negative stock and is blocked.
- -------------------------------------------
- Var | Doc | Qty | Balance
- -------------------------------------------
- PR1 | PR | 10 | 10 (posting date: today-2)
- SR3 | Reco | 0 | 1 (posting date: today-1) [backdated & blocked]
- DN2 | DN | -2 | 8(-1) (posting date: today)
+ Test if a backdated stock reco causes future negative stock and is blocked.
+ -------------------------------------------
+ Var | Doc | Qty | Balance
+ -------------------------------------------
+ PR1 | PR | 10 | 10 (posting date: today-2)
+ SR3 | Reco | 0 | 1 (posting date: today-1) [backdated & blocked]
+ DN2 | DN | -2 | 8(-1) (posting date: today)
"""
from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note
from erpnext.stock.stock_ledger import NegativeStockError
- item_code = "Backdated-Reco-Item"
+ item_code = self.make_item().name
warehouse = "_Test Warehouse - _TC"
- create_item(item_code)
+ pr1 = make_purchase_receipt(
+ item_code=item_code, warehouse=warehouse, qty=10, rate=100, posting_date=add_days(nowdate(), -2)
+ )
+ dn2 = create_delivery_note(
+ item_code=item_code, warehouse=warehouse, qty=2, rate=120, posting_date=nowdate()
+ )
- pr1 = make_purchase_receipt(item_code=item_code, warehouse=warehouse, qty=10, rate=100,
- posting_date=add_days(nowdate(), -2))
- dn2 = create_delivery_note(item_code=item_code, warehouse=warehouse, qty=2, rate=120,
- posting_date=nowdate())
-
- pr1_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": pr1.name, "is_cancelled": 0},
- "qty_after_transaction")
- dn2_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": dn2.name, "is_cancelled": 0},
- "qty_after_transaction")
+ pr1_balance = frappe.db.get_value(
+ "Stock Ledger Entry", {"voucher_no": pr1.name, "is_cancelled": 0}, "qty_after_transaction"
+ )
+ dn2_balance = frappe.db.get_value(
+ "Stock Ledger Entry", {"voucher_no": dn2.name, "is_cancelled": 0}, "qty_after_transaction"
+ )
self.assertEqual(pr1_balance, 10)
self.assertEqual(dn2_balance, 8)
# check if stock reco is blocked
- sr3 = create_stock_reconciliation(item_code=item_code, warehouse=warehouse, qty=1, rate=100,
- posting_date=add_days(nowdate(), -1), do_not_submit=True)
+ sr3 = create_stock_reconciliation(
+ item_code=item_code,
+ warehouse=warehouse,
+ qty=1,
+ rate=100,
+ posting_date=add_days(nowdate(), -1),
+ do_not_submit=True,
+ )
self.assertRaises(NegativeStockError, sr3.submit)
# teardown
@@ -357,33 +493,37 @@ class TestStockReconciliation(ERPNextTestCase):
dn2.cancel()
pr1.cancel()
-
@change_settings("Stock Settings", {"allow_negative_stock": 0})
def test_backdated_stock_reco_cancellation_future_negative_stock(self):
"""
- Test if a backdated stock reco cancellation that causes future negative stock is blocked.
- -------------------------------------------
- Var | Doc | Qty | Balance
- -------------------------------------------
- SR | Reco | 100 | 100 (posting date: today-1) (shouldn't be cancelled after DN)
- DN | DN | 100 | 0 (posting date: today)
+ Test if a backdated stock reco cancellation that causes future negative stock is blocked.
+ -------------------------------------------
+ Var | Doc | Qty | Balance
+ -------------------------------------------
+ SR | Reco | 100 | 100 (posting date: today-1) (shouldn't be cancelled after DN)
+ DN | DN | 100 | 0 (posting date: today)
"""
from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note
from erpnext.stock.stock_ledger import NegativeStockError
- item_code = "Backdated-Reco-Cancellation-Item"
+ item_code = self.make_item().name
warehouse = "_Test Warehouse - _TC"
- create_item(item_code)
+ sr = create_stock_reconciliation(
+ item_code=item_code,
+ warehouse=warehouse,
+ qty=100,
+ rate=100,
+ posting_date=add_days(nowdate(), -1),
+ )
- sr = create_stock_reconciliation(item_code=item_code, warehouse=warehouse, qty=100, rate=100,
- posting_date=add_days(nowdate(), -1))
+ dn = create_delivery_note(
+ item_code=item_code, warehouse=warehouse, qty=100, rate=120, posting_date=nowdate()
+ )
- dn = create_delivery_note(item_code=item_code, warehouse=warehouse, qty=100, rate=120,
- posting_date=nowdate())
-
- dn_balance = frappe.db.get_value("Stock Ledger Entry", {"voucher_no": dn.name, "is_cancelled": 0},
- "qty_after_transaction")
+ dn_balance = frappe.db.get_value(
+ "Stock Ledger Entry", {"voucher_no": dn.name, "is_cancelled": 0}, "qty_after_transaction"
+ )
self.assertEqual(dn_balance, 0)
# check if cancellation of stock reco is blocked
@@ -392,16 +532,58 @@ class TestStockReconciliation(ERPNextTestCase):
repost_exists = bool(frappe.db.exists("Repost Item Valuation", {"voucher_no": sr.name}))
self.assertFalse(repost_exists, msg="Negative stock validation not working on reco cancellation")
+ def test_intermediate_sr_bin_update(self):
+ """Bin should show correct qty even for backdated entries.
+
+ -------------------------------------------
+ | creation | Var | Doc | Qty | balance qty
+ -------------------------------------------
+ | 1 | SR | Reco | 10 | 10 (posting date: today+10)
+ | 3 | SR2 | Reco | 11 | 11 (posting date: today+11)
+ | 2 | DN | DN | 5 | 6 <-- assert in BIN (posting date: today+12)
+ """
+ from erpnext.stock.doctype.delivery_note.test_delivery_note import create_delivery_note
+
+ frappe.db.rollback()
+
+ # repost will make this test useless, qty should update in realtime without reposts
+ frappe.flags.dont_execute_stock_reposts = True
+
+ item_code = self.make_item().name
+ warehouse = "_Test Warehouse - _TC"
+
+ sr = create_stock_reconciliation(
+ item_code=item_code, warehouse=warehouse, qty=10, rate=100, posting_date=add_days(nowdate(), 10)
+ )
+
+ dn = create_delivery_note(
+ item_code=item_code, warehouse=warehouse, qty=5, rate=120, posting_date=add_days(nowdate(), 12)
+ )
+ old_bin_qty = frappe.db.get_value(
+ "Bin", {"item_code": item_code, "warehouse": warehouse}, "actual_qty"
+ )
+
+ sr2 = create_stock_reconciliation(
+ item_code=item_code, warehouse=warehouse, qty=11, rate=100, posting_date=add_days(nowdate(), 11)
+ )
+ new_bin_qty = frappe.db.get_value(
+ "Bin", {"item_code": item_code, "warehouse": warehouse}, "actual_qty"
+ )
+
+ self.assertEqual(old_bin_qty + 1, new_bin_qty)
+ frappe.db.rollback()
+
def test_valid_batch(self):
create_batch_item_with_batch("Testing Batch Item 1", "001")
create_batch_item_with_batch("Testing Batch Item 2", "002")
- sr = create_stock_reconciliation(item_code="Testing Batch Item 1", qty=1, rate=100, batch_no="002"
- , do_not_submit=True)
+ sr = create_stock_reconciliation(
+ item_code="Testing Batch Item 1", qty=1, rate=100, batch_no="002", do_not_submit=True
+ )
self.assertRaises(frappe.ValidationError, sr.submit)
def test_serial_no_cancellation(self):
-
from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry
+
item = create_item("Stock-Reco-Serial-Item-9", is_stock_item=1)
if not item.has_serial_no:
item.has_serial_no = 1
@@ -418,14 +600,49 @@ class TestStockReconciliation(ERPNextTestCase):
serial_nos.pop()
new_serial_nos = "\n".join(serial_nos)
- sr = create_stock_reconciliation(item_code=item.name, warehouse=warehouse, serial_no=new_serial_nos, qty=9)
+ sr = create_stock_reconciliation(
+ item_code=item.name, warehouse=warehouse, serial_no=new_serial_nos, qty=9
+ )
sr.cancel()
- active_sr_no = frappe.get_all("Serial No",
- filters={"item_code": item_code, "warehouse": warehouse, "status": "Active"})
+ active_sr_no = frappe.get_all(
+ "Serial No", filters={"item_code": item_code, "warehouse": warehouse, "status": "Active"}
+ )
self.assertEqual(len(active_sr_no), 10)
+ def test_serial_no_creation_and_inactivation(self):
+ item = create_item("_TestItemCreatedWithStockReco", is_stock_item=1)
+ if not item.has_serial_no:
+ item.has_serial_no = 1
+ item.save()
+
+ item_code = item.name
+ warehouse = "_Test Warehouse - _TC"
+
+ sr = create_stock_reconciliation(
+ item_code=item.name,
+ warehouse=warehouse,
+ serial_no="SR-CREATED-SR-NO",
+ qty=1,
+ do_not_submit=True,
+ rate=100,
+ )
+ sr.save()
+ self.assertEqual(cstr(sr.items[0].current_serial_no), "")
+ sr.submit()
+
+ active_sr_no = frappe.get_all(
+ "Serial No", filters={"item_code": item_code, "warehouse": warehouse, "status": "Active"}
+ )
+ self.assertEqual(len(active_sr_no), 1)
+
+ sr.cancel()
+ active_sr_no = frappe.get_all(
+ "Serial No", filters={"item_code": item_code, "warehouse": warehouse, "status": "Active"}
+ )
+ self.assertEqual(len(active_sr_no), 0)
+
def create_batch_item_with_batch(item_name, batch_id):
batch_item_doc = create_item(item_name, is_stock_item=1)
@@ -434,32 +651,51 @@ def create_batch_item_with_batch(item_name, batch_id):
batch_item_doc.create_new_batch = 1
batch_item_doc.save(ignore_permissions=True)
- if not frappe.db.exists('Batch', batch_id):
- b = frappe.new_doc('Batch')
+ if not frappe.db.exists("Batch", batch_id):
+ b = frappe.new_doc("Batch")
b.item = item_name
b.batch_id = batch_id
b.save()
-def insert_existing_sle(warehouse):
+
+def insert_existing_sle(warehouse, item_code="_Test Item"):
from erpnext.stock.doctype.stock_entry.test_stock_entry import make_stock_entry
- se1 = make_stock_entry(posting_date="2012-12-15", posting_time="02:00", item_code="_Test Item",
- target=warehouse, qty=10, basic_rate=700)
+ se1 = make_stock_entry(
+ posting_date="2012-12-15",
+ posting_time="02:00",
+ item_code=item_code,
+ target=warehouse,
+ qty=10,
+ basic_rate=700,
+ )
- se2 = make_stock_entry(posting_date="2012-12-25", posting_time="03:00", item_code="_Test Item",
- source=warehouse, qty=15)
+ se2 = make_stock_entry(
+ posting_date="2012-12-25", posting_time="03:00", item_code=item_code, source=warehouse, qty=15
+ )
- se3 = make_stock_entry(posting_date="2013-01-05", posting_time="07:00", item_code="_Test Item",
- target=warehouse, qty=15, basic_rate=1200)
+ se3 = make_stock_entry(
+ posting_date="2013-01-05",
+ posting_time="07:00",
+ item_code=item_code,
+ target=warehouse,
+ qty=15,
+ basic_rate=1200,
+ )
return se1, se2, se3
-def create_batch_or_serial_no_items():
- create_warehouse("_Test Warehouse for Stock Reco1",
- {"is_group": 0, "parent_warehouse": "_Test Warehouse Group - _TC"})
- create_warehouse("_Test Warehouse for Stock Reco2",
- {"is_group": 0, "parent_warehouse": "_Test Warehouse Group - _TC"})
+def create_batch_or_serial_no_items():
+ create_warehouse(
+ "_Test Warehouse for Stock Reco1",
+ {"is_group": 0, "parent_warehouse": "_Test Warehouse Group - _TC"},
+ )
+
+ create_warehouse(
+ "_Test Warehouse for Stock Reco2",
+ {"is_group": 0, "parent_warehouse": "_Test Warehouse Group - _TC"},
+ )
serial_item_doc = create_item("Stock-Reco-Serial-Item-1", is_stock_item=1)
if not serial_item_doc.has_serial_no:
@@ -480,6 +716,7 @@ def create_batch_or_serial_no_items():
serial_item_doc.batch_number_series = "BASR.#####"
batch_item_doc.save(ignore_permissions=True)
+
def create_stock_reconciliation(**args):
args = frappe._dict(args)
sr = frappe.new_doc("Stock Reconciliation")
@@ -488,28 +725,37 @@ def create_stock_reconciliation(**args):
sr.posting_time = args.posting_time or nowtime()
sr.set_posting_time = 1
sr.company = args.company or "_Test Company"
- sr.expense_account = args.expense_account or \
- ("Stock Adjustment - _TC" if frappe.get_all("Stock Ledger Entry") else "Temporary Opening - _TC")
- sr.cost_center = args.cost_center \
- or frappe.get_cached_value("Company", sr.company, "cost_center") \
+ sr.expense_account = args.expense_account or (
+ "Stock Adjustment - _TC" if frappe.get_all("Stock Ledger Entry") else "Temporary Opening - _TC"
+ )
+ sr.cost_center = (
+ args.cost_center
+ or frappe.get_cached_value("Company", sr.company, "cost_center")
or "_Test Cost Center - _TC"
+ )
- sr.append("items", {
- "item_code": args.item_code or "_Test Item",
- "warehouse": args.warehouse or "_Test Warehouse - _TC",
- "qty": args.qty,
- "valuation_rate": args.rate,
- "serial_no": args.serial_no,
- "batch_no": args.batch_no
- })
+ sr.append(
+ "items",
+ {
+ "item_code": args.item_code or "_Test Item",
+ "warehouse": args.warehouse or "_Test Warehouse - _TC",
+ "qty": args.qty,
+ "valuation_rate": args.rate,
+ "serial_no": args.serial_no,
+ "batch_no": args.batch_no,
+ },
+ )
- try:
- if not args.do_not_submit:
- sr.submit()
- except EmptyStockReconciliationItemsError:
- pass
+ if not args.do_not_save:
+ sr.insert()
+ try:
+ if not args.do_not_submit:
+ sr.submit()
+ except EmptyStockReconciliationItemsError:
+ pass
return sr
+
def set_valuation_method(item_code, valuation_method):
existing_valuation_method = get_valuation_method(item_code)
if valuation_method == existing_valuation_method:
@@ -517,11 +763,13 @@ def set_valuation_method(item_code, valuation_method):
frappe.db.set_value("Item", item_code, "valuation_method", valuation_method)
- for warehouse in frappe.get_all("Warehouse", filters={"company": "_Test Company"}, fields=["name", "is_group"]):
+ for warehouse in frappe.get_all(
+ "Warehouse", filters={"company": "_Test Company"}, fields=["name", "is_group"]
+ ):
if not warehouse.is_group:
- update_entries_after({
- "item_code": item_code,
- "warehouse": warehouse.name
- }, allow_negative_stock=1)
+ update_entries_after(
+ {"item_code": item_code, "warehouse": warehouse.name}, allow_negative_stock=1
+ )
+
test_dependencies = ["Item", "Warehouse"]
diff --git a/erpnext/stock/doctype/stock_reposting_settings/stock_reposting_settings.py b/erpnext/stock/doctype/stock_reposting_settings/stock_reposting_settings.py
index bab521d69fc..e0c8ed12e7d 100644
--- a/erpnext/stock/doctype/stock_reposting_settings/stock_reposting_settings.py
+++ b/erpnext/stock/doctype/stock_reposting_settings/stock_reposting_settings.py
@@ -6,8 +6,6 @@ from frappe.utils import add_to_date, get_datetime, get_time_str, time_diff_in_h
class StockRepostingSettings(Document):
-
-
def validate(self):
self.set_minimum_reposting_time_slot()
diff --git a/erpnext/stock/doctype/stock_settings/stock_settings.js b/erpnext/stock/doctype/stock_settings/stock_settings.js
index 6167becdaac..66da215dbbe 100644
--- a/erpnext/stock/doctype/stock_settings/stock_settings.js
+++ b/erpnext/stock/doctype/stock_settings/stock_settings.js
@@ -13,6 +13,25 @@ frappe.ui.form.on('Stock Settings', {
frm.set_query("default_warehouse", filters);
frm.set_query("sample_retention_warehouse", filters);
+ },
+ allow_negative_stock: function(frm) {
+ if (!frm.doc.allow_negative_stock) {
+ return;
+ }
+
+ let msg = __("Using negative stock disables FIFO/Moving average valuation when inventory is negative.");
+ msg += " ";
+ msg += __("This is considered dangerous from accounting point of view.")
+ msg += "
";
+ msg += ("Do you still want to enable negative inventory?");
+
+ frappe.confirm(
+ msg,
+ () => {},
+ () => {
+ frm.set_value("allow_negative_stock", 0);
+ }
+ );
}
});
diff --git a/erpnext/stock/doctype/stock_settings/stock_settings.py b/erpnext/stock/doctype/stock_settings/stock_settings.py
index c1293cbf0fa..e592a4be3c6 100644
--- a/erpnext/stock/doctype/stock_settings/stock_settings.py
+++ b/erpnext/stock/doctype/stock_settings/stock_settings.py
@@ -16,24 +16,40 @@ from erpnext.stock.utils import check_pending_reposting
class StockSettings(Document):
def validate(self):
- for key in ["item_naming_by", "item_group", "stock_uom",
- "allow_negative_stock", "default_warehouse", "set_qty_in_transactions_based_on_serial_no_input"]:
- frappe.db.set_default(key, self.get(key, ""))
+ for key in [
+ "item_naming_by",
+ "item_group",
+ "stock_uom",
+ "allow_negative_stock",
+ "default_warehouse",
+ "set_qty_in_transactions_based_on_serial_no_input",
+ ]:
+ frappe.db.set_default(key, self.get(key, ""))
from erpnext.setup.doctype.naming_series.naming_series import set_by_naming_series
- set_by_naming_series("Item", "item_code",
- self.get("item_naming_by")=="Naming Series", hide_name_field=True, make_mandatory=0)
+
+ set_by_naming_series(
+ "Item",
+ "item_code",
+ self.get("item_naming_by") == "Naming Series",
+ hide_name_field=True,
+ make_mandatory=0,
+ )
stock_frozen_limit = 356
submitted_stock_frozen = self.stock_frozen_upto_days or 0
if submitted_stock_frozen > stock_frozen_limit:
self.stock_frozen_upto_days = stock_frozen_limit
- frappe.msgprint (_("`Freeze Stocks Older Than` should be smaller than %d days.") %stock_frozen_limit)
+ frappe.msgprint(
+ _("`Freeze Stocks Older Than` should be smaller than %d days.") % stock_frozen_limit
+ )
# show/hide barcode field
for name in ["barcode", "barcodes", "scan_barcode"]:
- frappe.make_property_setter({'fieldname': name, 'property': 'hidden',
- 'value': 0 if self.show_barcode_field else 1}, validate_fields_for_doctype=False)
+ frappe.make_property_setter(
+ {"fieldname": name, "property": "hidden", "value": 0 if self.show_barcode_field else 1},
+ validate_fields_for_doctype=False,
+ )
self.validate_warehouses()
self.cant_change_valuation_method()
@@ -44,8 +60,12 @@ class StockSettings(Document):
warehouse_fields = ["default_warehouse", "sample_retention_warehouse"]
for field in warehouse_fields:
if frappe.db.get_value("Warehouse", self.get(field), "is_group"):
- frappe.throw(_("Group Warehouses cannot be used in transactions. Please change the value of {0}") \
- .format(frappe.bold(self.meta.get_field(field).label)), title =_("Incorrect Warehouse"))
+ frappe.throw(
+ _("Group Warehouses cannot be used in transactions. Please change the value of {0}").format(
+ frappe.bold(self.meta.get_field(field).label)
+ ),
+ title=_("Incorrect Warehouse"),
+ )
def cant_change_valuation_method(self):
db_valuation_method = frappe.db.get_single_value("Stock Settings", "valuation_method")
@@ -53,38 +73,73 @@ class StockSettings(Document):
if db_valuation_method and db_valuation_method != self.valuation_method:
# check if there are any stock ledger entries against items
# which does not have it's own valuation method
- sle = frappe.db.sql("""select name from `tabStock Ledger Entry` sle
+ sle = frappe.db.sql(
+ """select name from `tabStock Ledger Entry` sle
where exists(select name from tabItem
where name=sle.item_code and (valuation_method is null or valuation_method='')) limit 1
- """)
+ """
+ )
if sle:
- frappe.throw(_("Can't change the valuation method, as there are transactions against some items which do not have its own valuation method"))
+ frappe.throw(
+ _(
+ "Can't change the valuation method, as there are transactions against some items which do not have its own valuation method"
+ )
+ )
def validate_clean_description_html(self):
- if int(self.clean_description_html or 0) \
- and not int(self.db_get('clean_description_html') or 0):
+ if int(self.clean_description_html or 0) and not int(self.db_get("clean_description_html") or 0):
# changed to text
- frappe.enqueue('erpnext.stock.doctype.stock_settings.stock_settings.clean_all_descriptions', now=frappe.flags.in_test)
+ frappe.enqueue(
+ "erpnext.stock.doctype.stock_settings.stock_settings.clean_all_descriptions",
+ now=frappe.flags.in_test,
+ )
def validate_pending_reposts(self):
if self.stock_frozen_upto:
check_pending_reposting(self.stock_frozen_upto)
-
def on_update(self):
self.toggle_warehouse_field_for_inter_warehouse_transfer()
def toggle_warehouse_field_for_inter_warehouse_transfer(self):
- make_property_setter("Sales Invoice Item", "target_warehouse", "hidden", 1 - cint(self.allow_from_dn), "Check", validate_fields_for_doctype=False)
- make_property_setter("Delivery Note Item", "target_warehouse", "hidden", 1 - cint(self.allow_from_dn), "Check", validate_fields_for_doctype=False)
- make_property_setter("Purchase Invoice Item", "from_warehouse", "hidden", 1 - cint(self.allow_from_pr), "Check", validate_fields_for_doctype=False)
- make_property_setter("Purchase Receipt Item", "from_warehouse", "hidden", 1 - cint(self.allow_from_pr), "Check", validate_fields_for_doctype=False)
+ make_property_setter(
+ "Sales Invoice Item",
+ "target_warehouse",
+ "hidden",
+ 1 - cint(self.allow_from_dn),
+ "Check",
+ validate_fields_for_doctype=False,
+ )
+ make_property_setter(
+ "Delivery Note Item",
+ "target_warehouse",
+ "hidden",
+ 1 - cint(self.allow_from_dn),
+ "Check",
+ validate_fields_for_doctype=False,
+ )
+ make_property_setter(
+ "Purchase Invoice Item",
+ "from_warehouse",
+ "hidden",
+ 1 - cint(self.allow_from_pr),
+ "Check",
+ validate_fields_for_doctype=False,
+ )
+ make_property_setter(
+ "Purchase Receipt Item",
+ "from_warehouse",
+ "hidden",
+ 1 - cint(self.allow_from_pr),
+ "Check",
+ validate_fields_for_doctype=False,
+ )
def clean_all_descriptions():
- for item in frappe.get_all('Item', ['name', 'description']):
+ for item in frappe.get_all("Item", ["name", "description"]):
if item.description:
clean_description = clean_html(item.description)
if item.description != clean_description:
- frappe.db.set_value('Item', item.name, 'description', clean_description)
+ frappe.db.set_value("Item", item.name, "description", clean_description)
diff --git a/erpnext/stock/doctype/stock_settings/test_stock_settings.py b/erpnext/stock/doctype/stock_settings/test_stock_settings.py
index 072b54b8205..974e16339b7 100644
--- a/erpnext/stock/doctype/stock_settings/test_stock_settings.py
+++ b/erpnext/stock/doctype/stock_settings/test_stock_settings.py
@@ -4,45 +4,54 @@
import unittest
import frappe
-
-from erpnext.tests.utils import ERPNextTestCase
+from frappe.tests.utils import FrappeTestCase
-class TestStockSettings(ERPNextTestCase):
+class TestStockSettings(FrappeTestCase):
def setUp(self):
super().setUp()
frappe.db.set_value("Stock Settings", None, "clean_description_html", 0)
def test_settings(self):
- item = frappe.get_doc(dict(
- doctype = 'Item',
- item_code = 'Item for description test',
- item_group = 'Products',
- description = 'Drawing No. 07-xxx-PO132
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
'
- )).insert()
+ item = frappe.get_doc(
+ dict(
+ doctype="Item",
+ item_code="Item for description test",
+ item_group="Products",
+ description='Drawing No. 07-xxx-PO132
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
',
+ )
+ ).insert()
- settings = frappe.get_single('Stock Settings')
+ settings = frappe.get_single("Stock Settings")
settings.clean_description_html = 1
settings.save()
item.reload()
- self.assertEqual(item.description, 'Drawing No. 07-xxx-PO132
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
')
+ self.assertEqual(
+ item.description,
+ "Drawing No. 07-xxx-PO132
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
",
+ )
item.delete()
def test_clean_html(self):
- settings = frappe.get_single('Stock Settings')
+ settings = frappe.get_single("Stock Settings")
settings.clean_description_html = 1
settings.save()
- item = frappe.get_doc(dict(
- doctype = 'Item',
- item_code = 'Item for description test',
- item_group = 'Products',
- description = 'Drawing No. 07-xxx-PO132
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
'
- )).insert()
+ item = frappe.get_doc(
+ dict(
+ doctype="Item",
+ item_code="Item for description test",
+ item_group="Products",
+ description='Drawing No. 07-xxx-PO132
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
',
+ )
+ ).insert()
- self.assertEqual(item.description, 'Drawing No. 07-xxx-PO132
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
')
+ self.assertEqual(
+ item.description,
+ "Drawing No. 07-xxx-PO132
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
",
+ )
item.delete()
diff --git a/erpnext/stock/doctype/warehouse/test_warehouse.py b/erpnext/stock/doctype/warehouse/test_warehouse.py
index 26db2642e4b..5a7228a5068 100644
--- a/erpnext/stock/doctype/warehouse/test_warehouse.py
+++ b/erpnext/stock/doctype/warehouse/test_warehouse.py
@@ -3,21 +3,22 @@
import frappe
from frappe.test_runner import make_test_records
-from frappe.utils import cint
+from frappe.tests.utils import FrappeTestCase
import erpnext
-from erpnext.accounts.doctype.account.test_account import create_account, get_inventory_account
+from erpnext.accounts.doctype.account.test_account import create_account
from erpnext.stock.doctype.item.test_item import create_item
from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry
-from erpnext.tests.utils import ERPNextTestCase
+from erpnext.stock.doctype.warehouse.warehouse import convert_to_group_or_ledger, get_children
-test_records = frappe.get_test_records('Warehouse')
+test_records = frappe.get_test_records("Warehouse")
-class TestWarehouse(ERPNextTestCase):
+
+class TestWarehouse(FrappeTestCase):
def setUp(self):
super().setUp()
- if not frappe.get_value('Item', '_Test Item'):
- make_test_records('Item')
+ if not frappe.get_value("Item", "_Test Item"):
+ make_test_records("Item")
def test_parent_warehouse(self):
parent_warehouse = frappe.get_doc("Warehouse", "_Test Warehouse Group - _TC")
@@ -26,23 +27,37 @@ class TestWarehouse(ERPNextTestCase):
def test_warehouse_hierarchy(self):
p_warehouse = frappe.get_doc("Warehouse", "_Test Warehouse Group - _TC")
- child_warehouses = frappe.db.sql("""select name, is_group, parent_warehouse from `tabWarehouse` wh
- where wh.lft > %s and wh.rgt < %s""", (p_warehouse.lft, p_warehouse.rgt), as_dict=1)
+ child_warehouses = frappe.db.sql(
+ """select name, is_group, parent_warehouse from `tabWarehouse` wh
+ where wh.lft > %s and wh.rgt < %s""",
+ (p_warehouse.lft, p_warehouse.rgt),
+ as_dict=1,
+ )
for child_warehouse in child_warehouses:
self.assertEqual(p_warehouse.name, child_warehouse.parent_warehouse)
self.assertEqual(child_warehouse.is_group, 0)
+ def test_naming(self):
+ company = "Wind Power LLC"
+ warehouse_name = "Named Warehouse - WP"
+ wh = frappe.get_doc(doctype="Warehouse", warehouse_name=warehouse_name, company=company).insert()
+ self.assertEqual(wh.name, warehouse_name)
+
+ warehouse_name = "Unnamed Warehouse"
+ wh = frappe.get_doc(doctype="Warehouse", warehouse_name=warehouse_name, company=company).insert()
+ self.assertIn(warehouse_name, wh.name)
+
def test_unlinking_warehouse_from_item_defaults(self):
company = "_Test Company"
- warehouse_names = [f'_Test Warehouse {i} for Unlinking' for i in range(2)]
+ warehouse_names = [f"_Test Warehouse {i} for Unlinking" for i in range(2)]
warehouse_ids = []
for warehouse in warehouse_names:
warehouse_id = create_warehouse(warehouse, company=company)
warehouse_ids.append(warehouse_id)
- item_names = [f'_Test Item {i} for Unlinking' for i in range(2)]
+ item_names = [f"_Test Item {i} for Unlinking" for i in range(2)]
for item, warehouse in zip(item_names, warehouse_ids):
create_item(item, warehouse=warehouse, company=company)
@@ -52,19 +67,43 @@ class TestWarehouse(ERPNextTestCase):
# Check Item existance
for item in item_names:
- self.assertTrue(
- bool(frappe.db.exists("Item", item)),
- f"{item} doesn't exist"
- )
+ self.assertTrue(bool(frappe.db.exists("Item", item)), f"{item} doesn't exist")
item_doc = frappe.get_doc("Item", item)
for item_default in item_doc.item_defaults:
self.assertNotIn(
item_default.default_warehouse,
warehouse_ids,
- f"{item} linked to {item_default.default_warehouse} in {warehouse_ids}."
+ f"{item} linked to {item_default.default_warehouse} in {warehouse_ids}.",
)
+ def test_group_non_group_conversion(self):
+
+ warehouse = frappe.get_doc("Warehouse", create_warehouse("TestGroupConversion"))
+
+ convert_to_group_or_ledger(warehouse.name)
+ warehouse.reload()
+ self.assertEqual(warehouse.is_group, 1)
+
+ child = create_warehouse("GroupWHChild", {"parent_warehouse": warehouse.name})
+ # chid exists
+ self.assertRaises(frappe.ValidationError, convert_to_group_or_ledger, warehouse.name)
+ frappe.delete_doc("Warehouse", child)
+
+ convert_to_group_or_ledger(warehouse.name)
+ warehouse.reload()
+ self.assertEqual(warehouse.is_group, 0)
+
+ make_stock_entry(item_code="_Test Item", target=warehouse.name, qty=1)
+ # SLE exists
+ self.assertRaises(frappe.ValidationError, convert_to_group_or_ledger, warehouse.name)
+
+ def test_get_children(self):
+ company = "_Test Company"
+
+ children = get_children("Warehouse", parent=company, company=company, is_root=True)
+ self.assertTrue(any(wh["value"] == "_Test Warehouse - _TC" for wh in children))
+
def create_warehouse(warehouse_name, properties=None, company=None):
if not company:
@@ -84,40 +123,46 @@ def create_warehouse(warehouse_name, properties=None, company=None):
else:
return warehouse_id
+
def get_warehouse(**args):
args = frappe._dict(args)
- if(frappe.db.exists("Warehouse", args.warehouse_name + " - " + args.abbr)):
+ if frappe.db.exists("Warehouse", args.warehouse_name + " - " + args.abbr):
return frappe.get_doc("Warehouse", args.warehouse_name + " - " + args.abbr)
else:
- w = frappe.get_doc({
- "company": args.company or "_Test Company",
- "doctype": "Warehouse",
- "warehouse_name": args.warehouse_name,
- "is_group": 0,
- "account": get_warehouse_account(args.warehouse_name, args.company, args.abbr)
- })
+ w = frappe.get_doc(
+ {
+ "company": args.company or "_Test Company",
+ "doctype": "Warehouse",
+ "warehouse_name": args.warehouse_name,
+ "is_group": 0,
+ "account": get_warehouse_account(args.warehouse_name, args.company, args.abbr),
+ }
+ )
w.insert()
return w
+
def get_warehouse_account(warehouse_name, company, company_abbr=None):
if not company_abbr:
- company_abbr = frappe.get_cached_value("Company", company, 'abbr')
+ company_abbr = frappe.get_cached_value("Company", company, "abbr")
if not frappe.db.exists("Account", warehouse_name + " - " + company_abbr):
return create_account(
account_name=warehouse_name,
parent_account=get_group_stock_account(company, company_abbr),
- account_type='Stock',
- company=company)
+ account_type="Stock",
+ company=company,
+ )
else:
return warehouse_name + " - " + company_abbr
def get_group_stock_account(company, company_abbr=None):
- group_stock_account = frappe.db.get_value("Account",
- filters={'account_type': 'Stock', 'is_group': 1, 'company': company}, fieldname='name')
+ group_stock_account = frappe.db.get_value(
+ "Account", filters={"account_type": "Stock", "is_group": 1, "company": company}, fieldname="name"
+ )
if not group_stock_account:
if not company_abbr:
- company_abbr = frappe.get_cached_value("Company", company, 'abbr')
+ company_abbr = frappe.get_cached_value("Company", company, "abbr")
group_stock_account = "Current Assets - " + company_abbr
return group_stock_account
diff --git a/erpnext/stock/doctype/warehouse/warehouse.js b/erpnext/stock/doctype/warehouse/warehouse.js
index 4e1679c4116..332bfa56d91 100644
--- a/erpnext/stock/doctype/warehouse/warehouse.js
+++ b/erpnext/stock/doctype/warehouse/warehouse.js
@@ -1,89 +1,98 @@
// Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
// License: GNU General Public License v3. See license.txt
-
frappe.ui.form.on("Warehouse", {
- onload: function(frm) {
- frm.set_query("default_in_transit_warehouse", function() {
+ setup: function (frm) {
+ frm.set_query("default_in_transit_warehouse", function (doc) {
return {
- filters:{
- 'warehouse_type' : 'Transit',
- 'is_group': 0,
- 'company': frm.doc.company
- }
+ filters: {
+ warehouse_type: "Transit",
+ is_group: 0,
+ company: doc.company,
+ },
+ };
+ });
+
+ frm.set_query("parent_warehouse", function () {
+ return {
+ filters: {
+ is_group: 1,
+ },
+ };
+ });
+
+ frm.set_query("account", function (doc) {
+ return {
+ filters: {
+ is_group: 0,
+ account_type: "Stock",
+ company: doc.company,
+ },
};
});
},
- refresh: function(frm) {
- frm.toggle_display('warehouse_name', frm.doc.__islocal);
- frm.toggle_display(['address_html','contact_html'], !frm.doc.__islocal);
+ refresh: function (frm) {
+ frm.toggle_display("warehouse_name", frm.doc.__islocal);
+ frm.toggle_display(
+ ["address_html", "contact_html"],
+ !frm.doc.__islocal
+ );
-
- if(!frm.doc.__islocal) {
+ if (!frm.doc.__islocal) {
frappe.contacts.render_address_and_contact(frm);
-
} else {
frappe.contacts.clear_address_and_contact(frm);
}
- frm.add_custom_button(__("Stock Balance"), function() {
- frappe.set_route("query-report", "Stock Balance", {"warehouse": frm.doc.name});
+ frm.add_custom_button(__("Stock Balance"), function () {
+ frappe.set_route("query-report", "Stock Balance", {
+ warehouse: frm.doc.name,
+ });
});
- if (cint(frm.doc.is_group) == 1) {
- frm.add_custom_button(__('Group to Non-Group'),
- function() { convert_to_group_or_ledger(frm); }, 'fa fa-retweet', 'btn-default')
- } else if (cint(frm.doc.is_group) == 0) {
- if(frm.doc.__onload && frm.doc.__onload.account) {
- frm.add_custom_button(__("General Ledger"), function() {
+ frm.add_custom_button(
+ frm.doc.is_group
+ ? __("Convert to Ledger", null, "Warehouse")
+ : __("Convert to Group", null, "Warehouse"),
+ function () {
+ convert_to_group_or_ledger(frm);
+ },
+ );
+
+ if (!frm.doc.is_group && frm.doc.__onload && frm.doc.__onload.account) {
+ frm.add_custom_button(
+ __("General Ledger", null, "Warehouse"),
+ function () {
frappe.route_options = {
- "account": frm.doc.__onload.account,
- "company": frm.doc.company
- }
+ account: frm.doc.__onload.account,
+ company: frm.doc.company,
+ };
frappe.set_route("query-report", "General Ledger");
- });
- }
-
- frm.add_custom_button(__('Non-Group to Group'),
- function() { convert_to_group_or_ledger(frm); }, 'fa fa-retweet', 'btn-default')
- }
-
- frm.toggle_enable(['is_group', 'company'], false);
-
- frappe.dynamic_link = {doc: frm.doc, fieldname: 'name', doctype: 'Warehouse'};
-
- frm.fields_dict['parent_warehouse'].get_query = function(doc) {
- return {
- filters: {
- "is_group": 1,
}
- }
+ );
}
- frm.fields_dict['account'].get_query = function(doc) {
- return {
- filters: {
- "is_group": 0,
- "account_type": "Stock",
- "company": frm.doc.company
- }
- }
- }
- }
+ frm.toggle_enable(["is_group", "company"], false);
+
+ frappe.dynamic_link = {
+ doc: frm.doc,
+ fieldname: "name",
+ doctype: "Warehouse",
+ };
+ },
});
-function convert_to_group_or_ledger(frm){
+function convert_to_group_or_ledger(frm) {
frappe.call({
- method:"erpnext.stock.doctype.warehouse.warehouse.convert_to_group_or_ledger",
+ method: "erpnext.stock.doctype.warehouse.warehouse.convert_to_group_or_ledger",
args: {
docname: frm.doc.name,
- is_group: frm.doc.is_group
+ is_group: frm.doc.is_group,
},
- callback: function(){
+ callback: function () {
frm.refresh();
- }
-
- })
+ },
+ });
}
diff --git a/erpnext/stock/doctype/warehouse/warehouse.json b/erpnext/stock/doctype/warehouse/warehouse.json
index 05076b51a3e..c695d541bf9 100644
--- a/erpnext/stock/doctype/warehouse/warehouse.json
+++ b/erpnext/stock/doctype/warehouse/warehouse.json
@@ -244,7 +244,7 @@
"idx": 1,
"is_tree": 1,
"links": [],
- "modified": "2021-12-03 04:40:06.414630",
+ "modified": "2022-03-01 02:37:48.034944",
"modified_by": "Administrator",
"module": "Stock",
"name": "Warehouse",
@@ -301,5 +301,7 @@
"show_name_in_global_search": 1,
"sort_field": "modified",
"sort_order": "DESC",
- "title_field": "warehouse_name"
+ "states": [],
+ "title_field": "warehouse_name",
+ "track_changes": 1
}
\ No newline at end of file
diff --git a/erpnext/stock/doctype/warehouse/warehouse.py b/erpnext/stock/doctype/warehouse/warehouse.py
index 9cfad86f142..df16643d460 100644
--- a/erpnext/stock/doctype/warehouse/warehouse.py
+++ b/erpnext/stock/doctype/warehouse/warehouse.py
@@ -14,25 +14,31 @@ from erpnext.stock import get_warehouse_account
class Warehouse(NestedSet):
- nsm_parent_field = 'parent_warehouse'
+ nsm_parent_field = "parent_warehouse"
def autoname(self):
if self.company:
- suffix = " - " + frappe.get_cached_value('Company', self.company, "abbr")
+ suffix = " - " + frappe.get_cached_value("Company", self.company, "abbr")
if not self.warehouse_name.endswith(suffix):
self.name = self.warehouse_name + suffix
- else:
- self.name = self.warehouse_name
+ return
+
+ self.name = self.warehouse_name
def onload(self):
- '''load account name for General Ledger Report'''
- if self.company and cint(frappe.db.get_value("Company", self.company, "enable_perpetual_inventory")):
+ """load account name for General Ledger Report"""
+ if self.company and cint(
+ frappe.db.get_value("Company", self.company, "enable_perpetual_inventory")
+ ):
account = self.account or get_warehouse_account(self)
if account:
- self.set_onload('account', account)
+ self.set_onload("account", account)
load_address_and_contact(self)
+ def validate(self):
+ self.warn_about_multiple_warehouse_account()
+
def on_update(self):
self.update_nsm_model()
@@ -41,14 +47,21 @@ class Warehouse(NestedSet):
def on_trash(self):
# delete bin
- bins = frappe.db.sql("select * from `tabBin` where warehouse = %s",
- self.name, as_dict=1)
+ bins = frappe.get_all("Bin", fields="*", filters={"warehouse": self.name})
for d in bins:
- if d['actual_qty'] or d['reserved_qty'] or d['ordered_qty'] or \
- d['indented_qty'] or d['projected_qty'] or d['planned_qty']:
- throw(_("Warehouse {0} can not be deleted as quantity exists for Item {1}").format(self.name, d['item_code']))
- else:
- frappe.db.sql("delete from `tabBin` where name = %s", d['name'])
+ if (
+ d["actual_qty"]
+ or d["reserved_qty"]
+ or d["ordered_qty"]
+ or d["indented_qty"]
+ or d["projected_qty"]
+ or d["planned_qty"]
+ ):
+ throw(
+ _("Warehouse {0} can not be deleted as quantity exists for Item {1}").format(
+ self.name, d["item_code"]
+ )
+ )
if self.check_if_sle_exists():
throw(_("Warehouse can not be deleted as stock ledger entry exists for this warehouse."))
@@ -56,16 +69,62 @@ class Warehouse(NestedSet):
if self.check_if_child_exists():
throw(_("Child warehouse exists for this warehouse. You can not delete this warehouse."))
+ frappe.db.delete("Bin", filters={"warehouse": self.name})
self.update_nsm_model()
self.unlink_from_items()
+ def warn_about_multiple_warehouse_account(self):
+ "If Warehouse value is split across multiple accounts, warn."
+
+ def get_accounts_where_value_is_booked(name):
+ sle = frappe.qb.DocType("Stock Ledger Entry")
+ gle = frappe.qb.DocType("GL Entry")
+ ac = frappe.qb.DocType("Account")
+
+ return (
+ frappe.qb.from_(sle)
+ .join(gle)
+ .on(sle.voucher_no == gle.voucher_no)
+ .join(ac)
+ .on(ac.name == gle.account)
+ .select(gle.account)
+ .distinct()
+ .where((sle.warehouse == name) & (ac.account_type == "Stock"))
+ .orderby(sle.creation)
+ .run(as_dict=True)
+ )
+
+ if self.is_new():
+ return
+
+ old_wh_account = frappe.db.get_value("Warehouse", self.name, "account")
+
+ # WH account is being changed or set get all accounts against which wh value is booked
+ if self.account != old_wh_account:
+ accounts = get_accounts_where_value_is_booked(self.name)
+ accounts = [d.account for d in accounts]
+
+ if not accounts or (len(accounts) == 1 and self.account in accounts):
+ # if same singular account has stock value booked ignore
+ return
+
+ warning = _("Warehouse's Stock Value has already been booked in the following accounts:")
+ account_str = "
" + ", ".join(frappe.bold(ac) for ac in accounts)
+ reason = "
" + _(
+ "Booking stock value across multiple accounts will make it harder to track stock and account value."
+ )
+
+ frappe.msgprint(
+ warning + account_str + reason,
+ title=_("Multiple Warehouse Accounts"),
+ indicator="orange",
+ )
+
def check_if_sle_exists(self):
- return frappe.db.sql("""select name from `tabStock Ledger Entry`
- where warehouse = %s limit 1""", self.name)
+ return frappe.db.exists("Stock Ledger Entry", {"warehouse": self.name})
def check_if_child_exists(self):
- return frappe.db.sql("""select name from `tabWarehouse`
- where parent_warehouse = %s limit 1""", self.name)
+ return frappe.db.exists("Warehouse", {"parent_warehouse": self.name})
def convert_to_group_or_ledger(self):
if self.is_group:
@@ -92,28 +151,26 @@ class Warehouse(NestedSet):
return 1
def unlink_from_items(self):
- frappe.db.sql("""
- update `tabItem Default`
- set default_warehouse=NULL
- where default_warehouse=%s""", self.name)
+ frappe.db.set_value("Item Default", {"default_warehouse": self.name}, "default_warehouse", None)
+
@frappe.whitelist()
def get_children(doctype, parent=None, company=None, is_root=False):
if is_root:
parent = ""
- fields = ['name as value', 'is_group as expandable']
+ fields = ["name as value", "is_group as expandable"]
filters = [
- ['docstatus', '<', '2'],
- ['ifnull(`parent_warehouse`, "")', '=', parent],
- ['company', 'in', (company, None,'')]
+ ["docstatus", "<", "2"],
+ ['ifnull(`parent_warehouse`, "")', "=", parent],
+ ["company", "in", (company, None, "")],
]
- warehouses = frappe.get_list(doctype, fields=fields, filters=filters, order_by='name')
+ warehouses = frappe.get_list(doctype, fields=fields, filters=filters, order_by="name")
- company_currency = ''
+ company_currency = ""
if company:
- company_currency = frappe.get_cached_value('Company', company, 'default_currency')
+ company_currency = frappe.get_cached_value("Company", company, "default_currency")
warehouse_wise_value = get_warehouse_wise_stock_value(company)
@@ -124,14 +181,20 @@ def get_children(doctype, parent=None, company=None, is_root=False):
wh["company_currency"] = company_currency
return warehouses
-def get_warehouse_wise_stock_value(company):
- warehouses = frappe.get_all('Warehouse',
- fields = ['name', 'parent_warehouse'], filters = {'company': company})
- parent_warehouse = {d.name : d.parent_warehouse for d in warehouses}
- filters = {'warehouse': ('in', [data.name for data in warehouses])}
- bin_data = frappe.get_all('Bin', fields = ['sum(stock_value) as stock_value', 'warehouse'],
- filters = filters, group_by = 'warehouse')
+def get_warehouse_wise_stock_value(company):
+ warehouses = frappe.get_all(
+ "Warehouse", fields=["name", "parent_warehouse"], filters={"company": company}
+ )
+ parent_warehouse = {d.name: d.parent_warehouse for d in warehouses}
+
+ filters = {"warehouse": ("in", [data.name for data in warehouses])}
+ bin_data = frappe.get_all(
+ "Bin",
+ fields=["sum(stock_value) as stock_value", "warehouse"],
+ filters=filters,
+ group_by="warehouse",
+ )
warehouse_wise_stock_value = defaultdict(float)
for row in bin_data:
@@ -139,23 +202,30 @@ def get_warehouse_wise_stock_value(company):
continue
warehouse_wise_stock_value[row.warehouse] = row.stock_value
- update_value_in_parent_warehouse(warehouse_wise_stock_value,
- parent_warehouse, row.warehouse, row.stock_value)
+ update_value_in_parent_warehouse(
+ warehouse_wise_stock_value, parent_warehouse, row.warehouse, row.stock_value
+ )
return warehouse_wise_stock_value
-def update_value_in_parent_warehouse(warehouse_wise_stock_value, parent_warehouse_dict, warehouse, stock_value):
+
+def update_value_in_parent_warehouse(
+ warehouse_wise_stock_value, parent_warehouse_dict, warehouse, stock_value
+):
parent_warehouse = parent_warehouse_dict.get(warehouse)
if not parent_warehouse:
return
warehouse_wise_stock_value[parent_warehouse] += flt(stock_value)
- update_value_in_parent_warehouse(warehouse_wise_stock_value, parent_warehouse_dict,
- parent_warehouse, stock_value)
+ update_value_in_parent_warehouse(
+ warehouse_wise_stock_value, parent_warehouse_dict, parent_warehouse, stock_value
+ )
+
@frappe.whitelist()
def add_node():
from frappe.desk.treeview import make_tree_args
+
args = make_tree_args(**frappe.form_dict)
if cint(args.is_root):
@@ -163,32 +233,37 @@ def add_node():
frappe.get_doc(args).insert()
+
@frappe.whitelist()
-def convert_to_group_or_ledger():
- args = frappe.form_dict
- return frappe.get_doc("Warehouse", args.docname).convert_to_group_or_ledger()
+def convert_to_group_or_ledger(docname=None):
+ if not docname:
+ docname = frappe.form_dict.docname
+ return frappe.get_doc("Warehouse", docname).convert_to_group_or_ledger()
+
def get_child_warehouses(warehouse):
- lft, rgt = frappe.get_cached_value("Warehouse", warehouse, ["lft", "rgt"])
+ from frappe.utils.nestedset import get_descendants_of
+
+ children = get_descendants_of("Warehouse", warehouse, ignore_permissions=True, order_by="lft")
+ return children + [warehouse] # append self for backward compatibility
- return frappe.db.sql_list("""select name from `tabWarehouse`
- where lft >= %s and rgt <= %s""", (lft, rgt))
def get_warehouses_based_on_account(account, company=None):
warehouses = []
- for d in frappe.get_all("Warehouse", fields = ["name", "is_group"],
- filters = {"account": account}):
+ for d in frappe.get_all("Warehouse", fields=["name", "is_group"], filters={"account": account}):
if d.is_group:
warehouses.extend(get_child_warehouses(d.name))
else:
warehouses.append(d.name)
- if (not warehouses and company and
- frappe.get_cached_value("Company", company, "default_inventory_account") == account):
- warehouses = [d.name for d in frappe.get_all("Warehouse", filters={'is_group': 0})]
+ if (
+ not warehouses
+ and company
+ and frappe.get_cached_value("Company", company, "default_inventory_account") == account
+ ):
+ warehouses = [d.name for d in frappe.get_all("Warehouse", filters={"is_group": 0})]
if not warehouses:
- frappe.throw(_("Warehouse not found against the account {0}")
- .format(account))
+ frappe.throw(_("Warehouse not found against the account {0}").format(account))
return warehouses
diff --git a/erpnext/stock/get_item_details.py b/erpnext/stock/get_item_details.py
index 6c119e6c2bd..4db12dcb98b 100644
--- a/erpnext/stock/get_item_details.py
+++ b/erpnext/stock/get_item_details.py
@@ -23,31 +23,38 @@ from erpnext.stock.doctype.item.item import get_item_defaults, get_uom_conv_fact
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']
+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": "Yes" / "No",
- "ignore_pricing_rule": 0/1
- "project": ""
- "set_warehouse": ""
- }
+ 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": "Yes" / "No",
+ "ignore_pricing_rule": 0/1
+ "project": ""
+ "set_warehouse": ""
+ }
"""
args = process_args(args)
@@ -56,21 +63,24 @@ def get_item_details(args, doc=None, for_validate=False, overwrite_warehouse=Tru
item = frappe.get_cached_doc("Item", args.item_code)
validate_item_details(args, item)
- out = get_basic_details(args, item, overwrite_warehouse)
-
if isinstance(doc, string_types):
doc = json.loads(doc)
- if doc and doc.get('doctype') == 'Purchase Invoice':
- args['bill_date'] = doc.get('bill_date')
-
if doc:
- args['posting_date'] = doc.get('posting_date')
- args['transaction_date'] = doc.get('transaction_date')
+ 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)
+ 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)
@@ -83,12 +93,14 @@ def get_item_details(args, doc=None, for_validate=False, overwrite_warehouse=Tru
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"):
+ 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':
+ 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)
else:
@@ -101,31 +113,35 @@ def get_item_details(args, doc=None, for_validate=False, overwrite_warehouse=Tru
if args.get(key) is None:
args[key] = value
- data = get_pricing_rule_for_item(args, out.price_list_rate,
- doc, for_validate=for_validate)
+ data = get_pricing_rule_for_item(args, out.price_list_rate, 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)
+ out.schedule_date = out.lead_time_date = add_days(args.transaction_date, item.lead_time_days)
if args.get("is_subcontracted") == "Yes":
- out.bom = args.get('bom') or get_default_bom(args.item_code)
+ out.bom = args.get("bom") or get_default_bom(args.item_code)
get_gross_profit(out)
- if args.doctype == 'Material Request':
+ if args.doctype == "Material Request":
out.rate = args.rate or out.price_list_rate
out.amount = flt(args.qty) * flt(out.rate)
return out
+
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 (
+ (
+ 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_batch_no and not args.get("batch_no"):
out.batch_no = get_batch_no(out.item_code, out.warehouse, out.qty)
@@ -133,9 +149,9 @@ def update_stock(args, out):
if actual_batch_qty:
out.update(actual_batch_qty)
- if out.has_serial_no and args.get('batch_no'):
+ 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.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:
@@ -149,13 +165,14 @@ def set_valuation_rate(out, args):
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)
+ 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
- })
+ out.update({"valuation_rate": valuation_rate})
else:
out.update(get_valuation_rate(args.item_code, args.company, out.get("warehouse")))
@@ -178,11 +195,13 @@ def process_args(args):
set_transaction_type(args)
return args
+
def process_string_args(args):
if isinstance(args, string_types):
args = json.loads(args)
return args
+
@frappe.whitelist()
def get_item_code(barcode=None, serial_no=None):
if barcode:
@@ -202,6 +221,7 @@ def validate_item_details(args, item):
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 args.transaction_type == "selling" and cint(item.has_variants):
@@ -215,37 +235,37 @@ def validate_item_details(args, item):
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": "Yes" / "No",
- "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
- }
+ "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": "Yes" / "No",
+ "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
"""
@@ -260,77 +280,100 @@ def get_basic_details(args, item, overwrite_warehouse=True):
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
- })
+ 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)
+ 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:
+ 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:
+ 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'):
+ 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
- if (args.get("batch_no") and
- item.name != frappe.get_cached_value('Batch', args.get("batch_no"), 'item')):
- args['batch_no'] = ''
+ 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),
- "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,
- "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": 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")
- })
+ 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))
@@ -339,27 +382,33 @@ def get_basic_details(args, item, overwrite_warehouse=True):
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")
+ 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:
+ if args.get("doctype") in purchase_doctypes:
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)
+
+ 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
+ ["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", "barcodes", "brand", "stock_uom"):
+ for fieldname in ("item_name", "item_group", "brand", "stock_uom"):
out[fieldname] = item.get(fieldname)
if args.get("manufacturer"):
@@ -370,53 +419,58 @@ def get_basic_details(args, item, overwrite_warehouse=True):
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)
+ 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
- })
+ out.update(
+ {
+ "manufacturer": data.default_item_manufacturer,
+ "manufacturer_part_no": data.default_manufacturer_part_no,
+ }
+ )
- child_doctype = args.doctype + ' Item'
+ 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
+ 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)
- })
+ 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')
+ 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
- })
+ 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')
+ warehouse = args.get("warehouse")
if not warehouse:
default_warehouse = frappe.db.get_single_value("Stock Settings", "default_warehouse")
@@ -425,12 +479,14 @@ def get_item_warehouse(item, args, overwrite_warehouse, defaults=None):
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]
+ out["barcode"] = barcode_data.get(out.item_code)[0]
+
def get_barcode_data(items_list):
# get itemwise batch no data
@@ -439,9 +495,13 @@ def get_barcode_data(items_list):
itemwise_barcode = {}
for item in items_list:
- barcodes = frappe.db.sql("""
+ barcodes = frappe.db.sql(
+ """
select barcode from `tabItem Barcode` where parent = %s
- """, item.item_code, as_dict=1)
+ """,
+ item.item_code,
+ as_dict=1,
+ )
for barcode in barcodes:
if item.item_code not in itemwise_barcode:
@@ -450,6 +510,7 @@ def get_barcode_data(items_list):
return itemwise_barcode
+
@frappe.whitelist()
def get_item_tax_info(company, tax_category, item_codes, item_rates=None, item_tax_templates=None):
out = {}
@@ -475,22 +536,29 @@ def get_item_tax_info(company, tax_category, item_codes, item_rates=None, item_t
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])}
+ 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)
+ 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
- }
+ args = {
+ "tax_category": None
+ "item_tax_template": None
+ }
"""
item_tax_template = None
if item.taxes:
@@ -503,6 +571,7 @@ def get_item_tax_template(args, item, out):
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 = {}
@@ -510,36 +579,41 @@ def _get_item_tax_template(args, taxes, out=None, for_validate=False):
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):
+ 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('transaction_date') or args.get('bill_date') or args.get('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):
+ 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, reverse=True)
+ taxes = sorted(taxes_with_validity, key=lambda i: i.valid_from, 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))]
+ 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')
+ 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")):
@@ -547,15 +621,17 @@ def _get_item_tax_template(args, taxes, out=None, for_validate=False):
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):
+ 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 = {}
@@ -567,6 +643,7 @@ def get_item_tax_map(company, item_tax_template, as_json=True):
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)
@@ -585,53 +662,72 @@ def calculate_service_end_date(args, item=None):
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 = {"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")
+ return (
+ item.get("income_account")
or item_group.get("income_account")
or brand.get("income_account")
- or args.income_account)
+ or args.income_account
+ )
+
def get_default_expense_account(args, item, item_group, brand):
- return (item.get("expense_account")
+ return (
+ item.get("expense_account")
or item_group.get("expense_account")
or brand.get("expense_account")
- or args.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)
+ 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)
+ return (
+ item.get(fieldname)
or args.get(fieldname)
- or frappe.get_cached_value('Company', args.company, "default_"+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'):
+ 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')
+ 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')
+ 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"]:
@@ -644,20 +740,26 @@ def get_default_cost_center(args, item=None, item_group=None, brand=None, compan
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):
+ 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")
+ 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")
+ return (
+ item.get("default_supplier")
or item_group.get("default_supplier")
- or brand.get("default_supplier"))
+ or brand.get("default_supplier")
+ )
+
def get_price_list_rate(args, item_doc, out=None):
if out is None:
@@ -665,7 +767,7 @@ def get_price_list_rate(args, item_doc, out=None):
meta = frappe.get_meta(args.parenttype or args.doctype)
- if meta.get_field("currency") or args.get('currency'):
+ 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
@@ -687,54 +789,75 @@ def get_price_list_rate(args, item_doc, out=None):
insert_item_price(args)
return out
- out.price_list_rate = flt(price_list_rate) * flt(args.plc_conversion_rate) \
- / flt(args.conversion_rate)
+ out.price_list_rate = (
+ flt(price_list_rate) * flt(args.plc_conversion_rate) / flt(args.conversion_rate)
+ )
- if not out.price_list_rate and args.transaction_type=="buying":
+ 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))
+
+ 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.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 = (args.rate / args.get('conversion_factor')
- if args.get("conversion_factor") else args.rate)
+ price_list_rate = (
+ (args.rate + args.discount_amount) / args.get("conversion_factor")
+ if args.get("conversion_factor")
+ else (args.rate + 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)
+ 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)
+ 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
- })
+ 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)
+ 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
+ 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
"""
- args['item_code'] = item_code
+ args["item_code"] = item_code
conditions = """where item_code=%(item_code)s
and price_list=%(price_list)s
@@ -750,36 +873,37 @@ def get_item_price(args, item_code, ignore_party=False):
else:
conditions += "and (customer is null or customer = '') and (supplier is null or supplier = '')"
- if args.get('transaction_date'):
+ if args.get("transaction_date"):
conditions += """ and %(transaction_date)s between
ifnull(valid_from, '2000-01-01') and ifnull(valid_upto, '2500-12-31')"""
- if args.get('posting_date'):
- conditions += """ and %(posting_date)s between
- ifnull(valid_from, '2000-01-01') and ifnull(valid_upto, '2500-12-31')"""
-
- return frappe.db.sql(""" select name, price_list_rate, uom
+ return frappe.db.sql(
+ """ select name, price_list_rate, uom
from `tabItem Price` {conditions}
- order by valid_from desc, batch_no desc, uom desc """.format(conditions=conditions), args)
+ order by valid_from desc, batch_no desc, uom desc """.format(
+ conditions=conditions
+ ),
+ args,
+ )
+
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
+ :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'),
- "posting_date": args.get('posting_date'),
- "batch_no": args.get('batch_no')
+ "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
@@ -792,12 +916,15 @@ def get_price_list_rate_for(args, item_code):
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"))
+ 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"))
+ 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
@@ -805,18 +932,19 @@ def get_price_list_rate_for(args, item_code):
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'):
+ 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
+ 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
@@ -829,47 +957,62 @@ def check_packing_list(price_list_rate_name, desired_qty, item_code):
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):
+ 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
+ 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)
+ 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})))
+ 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)):
+ 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)
+ 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})))
+ 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:
+ if args.transaction_type == "selling" and args.customer:
out.customer_item_code = None
- if args.quotation_to and args.quotation_to != 'Customer':
+ if args.quotation_to and args.quotation_to != "Customer":
return
customer_item_code = item_doc.get("customer_items", {"customer_name": args.customer})
@@ -882,15 +1025,16 @@ def get_party_item_code(args, item_doc, out):
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:
+ 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'))
+ 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"):
@@ -902,70 +1046,89 @@ def get_pos_profile_item_details(company, args, pos_profile=None, update_data=Fa
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 pos_profile:
+ return frappe.get_cached_doc("POS Profile", pos_profile)
if not user:
- user = frappe.session['user']
+ user = frappe.session["user"]
condition = "pfu.user = %(user)s AND pfu.default=1"
if user and company:
condition = "pfu.user = %(user)s AND pf.company = %(company)s AND pfu.default=1"
- pos_profile = frappe.db.sql("""SELECT pf.*
+ pos_profile = frappe.db.sql(
+ """SELECT pf.*
FROM
`tabPOS Profile` pf LEFT JOIN `tabPOS Profile User` pfu
ON
pf.name = pfu.parent
WHERE
{cond} AND pf.disabled = 0
- """.format(cond = condition), {
- 'user': user,
- 'company': company
- }, as_dict=1)
+ """.format(
+ cond=condition
+ ),
+ {"user": user, "company": company},
+ as_dict=1,
+ )
if not pos_profile and company:
- pos_profile = frappe.db.sql("""SELECT pf.*
+ pos_profile = frappe.db.sql(
+ """SELECT pf.*
FROM
`tabPOS Profile` pf LEFT JOIN `tabPOS Profile User` pfu
ON
pf.name = pfu.parent
WHERE
pf.company = %(company)s AND pf.disabled = 0
- """, {
- 'company': company
- }, as_dict=1)
+ """,
+ {"company": company},
+ as_dict=1,
+ )
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"):
- return "\n".join(frappe.db.sql_list("""select name from `tabSerial No`
+ return "\n".join(
+ frappe.db.sql_list(
+ """select name from `tabSerial No`
where item_code=%(item_code)s and warehouse=%(warehouse)s and
sales_order=IF(%(sales_order)s IS NULL, sales_order, %(sales_order)s)
order by timestamp(purchase_date, purchase_time)
asc limit %(qty)s""",
- {
- "item_code": args.item_code,
- "warehouse": args.warehouse,
- "qty": abs(cint(args.stock_qty)),
- "sales_order": sales_order
- }))
+ {
+ "item_code": args.item_code,
+ "warehouse": args.warehouse,
+ "qty": abs(cint(args.stock_qty)),
+ "sales_order": sales_order,
+ },
+ )
+ )
+
def get_serial_no_batchwise(args, sales_order=None):
if frappe.db.get_single_value("Stock Settings", "automatically_set_serial_nos_based_on_fifo"):
- return "\n".join(frappe.db.sql_list("""select name from `tabSerial No`
+ return "\n".join(
+ frappe.db.sql_list(
+ """select name from `tabSerial No`
where item_code=%(item_code)s and warehouse=%(warehouse)s and
sales_order=IF(%(sales_order)s IS NULL, sales_order, %(sales_order)s)
and batch_no=IF(%(batch_no)s IS NULL, batch_no, %(batch_no)s) order
- by timestamp(purchase_date, purchase_time) asc limit %(qty)s""", {
- "item_code": args.item_code,
- "warehouse": args.warehouse,
- "batch_no": args.batch_no,
- "qty": abs(cint(args.stock_qty)),
- "sales_order": sales_order
- }))
+ by timestamp(purchase_date, purchase_time) asc limit %(qty)s""",
+ {
+ "item_code": args.item_code,
+ "warehouse": args.warehouse,
+ "batch_no": args.batch_no,
+ "qty": abs(cint(args.stock_qty)),
+ "sales_order": sales_order,
+ },
+ )
+ )
+
@frappe.whitelist()
def get_conversion_factor(item_code, uom):
@@ -973,69 +1136,94 @@ def get_conversion_factor(item_code, uom):
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")
+ 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")}
+ 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):
- bin_details = frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse},
- ["projected_qty", "actual_qty", "reserved_qty"], as_dict=True, cache=True) \
- or {"projected_qty": 0, "actual_qty": 0, "reserved_qty": 0}
+ bin_details = frappe.db.get_value(
+ "Bin",
+ {"item_code": item_code, "warehouse": warehouse},
+ ["projected_qty", "actual_qty", "reserved_qty"],
+ as_dict=True,
+ cache=True,
+ ) or {"projected_qty": 0, "actual_qty": 0, "reserved_qty": 0}
if company:
- bin_details['company_total_stock'] = get_company_total_stock(item_code, company)
+ bin_details["company_total_stock"] = get_company_total_stock(item_code, company)
return bin_details
+
def get_company_total_stock(item_code, company):
- return frappe.db.sql("""SELECT sum(actual_qty) from
+ return frappe.db.sql(
+ """SELECT sum(actual_qty) from
(`tabBin` INNER JOIN `tabWarehouse` ON `tabBin`.warehouse = `tabWarehouse`.name)
WHERE `tabWarehouse`.company = %s and `tabBin`.item_code = %s""",
- (company, item_code))[0][0]
+ (company, item_code),
+ )[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})
+ 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}
+ 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):
+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})
+ 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})
+ 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))
+ 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})
+ 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})
+ 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)}
+ return {"actual_batch_qty": batch.get_batch_qty(batch_no, warehouse)}
+
@frappe.whitelist()
def apply_price_list(args, as_doc=False):
@@ -1045,23 +1233,23 @@ def apply_price_list(args, as_doc=False):
: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 = {
+ "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)
@@ -1081,10 +1269,10 @@ def apply_price_list(args, as_doc=False):
children.append(item_details)
if as_doc:
- args.price_list_currency = parent.price_list_currency,
+ 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')):
+ 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
@@ -1092,26 +1280,25 @@ def apply_price_list(args, as_doc=False):
item[fieldname] = children[i][fieldname]
return args
else:
- return {
- "parent": parent,
- "children": children
- }
+ return {"parent": parent, "children": children}
+
def apply_price_list_on_item(args):
- item_doc = frappe.get_doc("Item", args.item_code)
+ 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, item_details.price_list_rate))
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']:
+ 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']:
+ 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)
@@ -1122,24 +1309,47 @@ def get_price_list_currency_and_exchange_rate(args):
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
+ 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,
+ }
+ )
- 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):
- if item_code:
- bom = frappe.db.get_value("BOM", {"docstatus": 1, "is_default": 1, "is_active": 1, "item": item_code})
- if bom:
- return bom
+ 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):
@@ -1149,43 +1359,57 @@ def get_valuation_rate(item_code, company, warehouse=None):
# 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")
+ 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}
+ 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"):
- valuation_rate =frappe.db.sql("""select sum(base_net_amount) / sum(qty*conversion_factor)
+ valuation_rate = frappe.db.sql(
+ """select sum(base_net_amount) / sum(qty*conversion_factor)
from `tabPurchase Invoice Item`
- where item_code = %s and docstatus=1""", item_code)
+ where item_code = %s and docstatus=1""",
+ item_code,
+ )
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)
- })
+ 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, string_types):
args = json.loads(args)
args = frappe._dict(args)
- if args.get('doctype') == 'Sales Invoice' and not args.get('update_stock'):
+ 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:
+ 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_no_batchwise(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 = 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)
@@ -1202,53 +1426,68 @@ def update_party_blanket_order(args, out):
if blanket_order_details:
out.update(blanket_order_details)
+
@frappe.whitelist()
def get_blanket_order_details(args):
if isinstance(args, string_types):
args = frappe._dict(json.loads(args))
blanket_order_details = None
- condition = ''
+ condition = ""
if args.item_code:
if args.customer and args.doctype == "Sales Order":
- condition = ' and bo.customer=%(customer)s'
+ condition = " and bo.customer=%(customer)s"
elif args.supplier and args.doctype == "Purchase Order":
- condition = ' and bo.supplier=%(supplier)s'
+ condition = " and bo.supplier=%(supplier)s"
if args.blanket_order:
- condition += ' and bo.name =%(blanket_order)s'
+ condition += " and bo.name =%(blanket_order)s"
if args.transaction_date:
- condition += ' and bo.to_date>=%(transaction_date)s'
+ condition += " and bo.to_date>=%(transaction_date)s"
- blanket_order_details = frappe.db.sql('''
+ blanket_order_details = frappe.db.sql(
+ """
select boi.rate as blanket_order_rate, bo.name as blanket_order
from `tabBlanket Order` bo, `tabBlanket Order Item` boi
where bo.company=%(company)s and boi.item_code=%(item_code)s
and bo.docstatus=1 and bo.name = boi.parent {0}
- '''.format(condition), args, as_dict=True)
+ """.format(
+ condition
+ ),
+ args,
+ as_dict=True,
+ )
- blanket_order_details = blanket_order_details[0] if blanket_order_details else ''
+ 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.sql("""select sales_order from `tabSales Invoice Item` where
- parent=%s and item_code=%s""", (args.get('against_sales_invoice'), args.get('item_code')))
+ 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.sql(
+ """select sales_order from `tabSales Invoice Item` where
+ parent=%s and item_code=%s""",
+ (args.get("against_sales_invoice"), args.get("item_code")),
+ )
if sales_order and sales_order[0]:
- if get_reserved_qty_for_so(sales_order[0][0], args.get('item_code')):
+ if get_reserved_qty_for_so(sales_order[0][0], 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')
+ 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.sql("""select sum(qty) from `tabSales Order Item`
+ reserved_qty = frappe.db.sql(
+ """select sum(qty) from `tabSales Order Item`
where parent=%s and item_code=%s and ensure_delivery_based_on_produced_serial_no=1
- """, (sales_order, item_code))
+ """,
+ (sales_order, item_code),
+ )
if reserved_qty and reserved_qty[0][0]:
return reserved_qty[0][0]
else:
diff --git a/erpnext/stock/reorder_item.py b/erpnext/stock/reorder_item.py
index 21f2573a279..f2594f65fab 100644
--- a/erpnext/stock/reorder_item.py
+++ b/erpnext/stock/reorder_item.py
@@ -13,22 +13,29 @@ import erpnext
def reorder_item():
- """ Reorder item if stock reaches reorder level"""
+ """Reorder item if stock reaches reorder level"""
# if initial setup not completed, return
if not (frappe.db.a_row_exists("Company") and frappe.db.a_row_exists("Fiscal Year")):
return
- if cint(frappe.db.get_value('Stock Settings', None, 'auto_indent')):
+ if cint(frappe.db.get_value("Stock Settings", None, "auto_indent")):
return _reorder_item()
+
def _reorder_item():
material_requests = {"Purchase": {}, "Transfer": {}, "Material Issue": {}, "Manufacture": {}}
- warehouse_company = frappe._dict(frappe.db.sql("""select name, company from `tabWarehouse`
- where disabled=0"""))
- default_company = (erpnext.get_default_company() or
- frappe.db.sql("""select name from tabCompany limit 1""")[0][0])
+ warehouse_company = frappe._dict(
+ frappe.db.sql(
+ """select name, company from `tabWarehouse`
+ where disabled=0"""
+ )
+ )
+ default_company = (
+ erpnext.get_default_company() or frappe.db.sql("""select name from tabCompany limit 1""")[0][0]
+ )
- items_to_consider = frappe.db.sql_list("""select name from `tabItem` item
+ items_to_consider = frappe.db.sql_list(
+ """select name from `tabItem` item
where is_stock_item=1 and has_variants=0
and disabled=0
and (end_of_life is null or end_of_life='0000-00-00' or end_of_life > %(today)s)
@@ -36,14 +43,17 @@ def _reorder_item():
or (variant_of is not null and variant_of != ''
and exists (select name from `tabItem Reorder` ir where ir.parent=item.variant_of))
)""",
- {"today": nowdate()})
+ {"today": nowdate()},
+ )
if not items_to_consider:
return
item_warehouse_projected_qty = get_item_warehouse_projected_qty(items_to_consider)
- def add_to_material_request(item_code, warehouse, reorder_level, reorder_qty, material_request_type, warehouse_group=None):
+ def add_to_material_request(
+ item_code, warehouse, reorder_level, reorder_qty, material_request_type, warehouse_group=None
+ ):
if warehouse not in warehouse_company:
# a disabled warehouse
return
@@ -64,11 +74,9 @@ def _reorder_item():
company = warehouse_company.get(warehouse) or default_company
- material_requests[material_request_type].setdefault(company, []).append({
- "item_code": item_code,
- "warehouse": warehouse,
- "reorder_qty": reorder_qty
- })
+ material_requests[material_request_type].setdefault(company, []).append(
+ {"item_code": item_code, "warehouse": warehouse, "reorder_qty": reorder_qty}
+ )
for item_code in items_to_consider:
item = frappe.get_doc("Item", item_code)
@@ -78,19 +86,30 @@ def _reorder_item():
if item.get("reorder_levels"):
for d in item.get("reorder_levels"):
- add_to_material_request(item_code, d.warehouse, d.warehouse_reorder_level,
- d.warehouse_reorder_qty, d.material_request_type, warehouse_group=d.warehouse_group)
+ add_to_material_request(
+ item_code,
+ d.warehouse,
+ d.warehouse_reorder_level,
+ d.warehouse_reorder_qty,
+ d.material_request_type,
+ warehouse_group=d.warehouse_group,
+ )
if material_requests:
return create_material_request(material_requests)
+
def get_item_warehouse_projected_qty(items_to_consider):
item_warehouse_projected_qty = {}
- for item_code, warehouse, projected_qty in frappe.db.sql("""select item_code, warehouse, projected_qty
+ for item_code, warehouse, projected_qty in frappe.db.sql(
+ """select item_code, warehouse, projected_qty
from tabBin where item_code in ({0})
- and (warehouse != "" and warehouse is not null)"""\
- .format(", ".join(["%s"] * len(items_to_consider))), items_to_consider):
+ and (warehouse != "" and warehouse is not null)""".format(
+ ", ".join(["%s"] * len(items_to_consider))
+ ),
+ items_to_consider,
+ ):
if item_code not in item_warehouse_projected_qty:
item_warehouse_projected_qty.setdefault(item_code, {})
@@ -102,15 +121,18 @@ def get_item_warehouse_projected_qty(items_to_consider):
while warehouse_doc.parent_warehouse:
if not item_warehouse_projected_qty.get(item_code, {}).get(warehouse_doc.parent_warehouse):
- item_warehouse_projected_qty.setdefault(item_code, {})[warehouse_doc.parent_warehouse] = flt(projected_qty)
+ item_warehouse_projected_qty.setdefault(item_code, {})[warehouse_doc.parent_warehouse] = flt(
+ projected_qty
+ )
else:
item_warehouse_projected_qty[item_code][warehouse_doc.parent_warehouse] += flt(projected_qty)
warehouse_doc = frappe.get_doc("Warehouse", warehouse_doc.parent_warehouse)
return item_warehouse_projected_qty
+
def create_material_request(material_requests):
- """ Create indent on reaching reorder level """
+ """Create indent on reaching reorder level"""
mr_list = []
exceptions_list = []
@@ -131,11 +153,13 @@ def create_material_request(material_requests):
continue
mr = frappe.new_doc("Material Request")
- mr.update({
- "company": company,
- "transaction_date": nowdate(),
- "material_request_type": "Material Transfer" if request_type=="Transfer" else request_type
- })
+ mr.update(
+ {
+ "company": company,
+ "transaction_date": nowdate(),
+ "material_request_type": "Material Transfer" if request_type == "Transfer" else request_type,
+ }
+ )
for d in items:
d = frappe._dict(d)
@@ -143,30 +167,37 @@ def create_material_request(material_requests):
uom = item.stock_uom
conversion_factor = 1.0
- if request_type == 'Purchase':
+ if request_type == "Purchase":
uom = item.purchase_uom or item.stock_uom
if uom != item.stock_uom:
- conversion_factor = frappe.db.get_value("UOM Conversion Detail",
- {'parent': item.name, 'uom': uom}, 'conversion_factor') or 1.0
+ conversion_factor = (
+ frappe.db.get_value(
+ "UOM Conversion Detail", {"parent": item.name, "uom": uom}, "conversion_factor"
+ )
+ or 1.0
+ )
must_be_whole_number = frappe.db.get_value("UOM", uom, "must_be_whole_number", cache=True)
qty = d.reorder_qty / conversion_factor
if must_be_whole_number:
qty = ceil(qty)
- mr.append("items", {
- "doctype": "Material Request Item",
- "item_code": d.item_code,
- "schedule_date": add_days(nowdate(),cint(item.lead_time_days)),
- "qty": qty,
- "uom": uom,
- "stock_uom": item.stock_uom,
- "warehouse": d.warehouse,
- "item_name": item.item_name,
- "description": item.description,
- "item_group": item.item_group,
- "brand": item.brand,
- })
+ mr.append(
+ "items",
+ {
+ "doctype": "Material Request Item",
+ "item_code": d.item_code,
+ "schedule_date": add_days(nowdate(), cint(item.lead_time_days)),
+ "qty": qty,
+ "uom": uom,
+ "stock_uom": item.stock_uom,
+ "warehouse": d.warehouse,
+ "item_name": item.item_name,
+ "description": item.description,
+ "item_group": item.item_group,
+ "brand": item.brand,
+ },
+ )
schedule_dates = [d.schedule_date for d in mr.items]
mr.schedule_date = max(schedule_dates or [nowdate()])
@@ -180,10 +211,11 @@ def create_material_request(material_requests):
if mr_list:
if getattr(frappe.local, "reorder_email_notify", None) is None:
- frappe.local.reorder_email_notify = cint(frappe.db.get_value('Stock Settings', None,
- 'reorder_email_notify'))
+ frappe.local.reorder_email_notify = cint(
+ frappe.db.get_value("Stock Settings", None, "reorder_email_notify")
+ )
- if(frappe.local.reorder_email_notify):
+ if frappe.local.reorder_email_notify:
send_email_notification(mr_list)
if exceptions_list:
@@ -191,33 +223,47 @@ def create_material_request(material_requests):
return mr_list
-def send_email_notification(mr_list):
- """ Notify user about auto creation of indent"""
- email_list = frappe.db.sql_list("""select distinct r.parent
+def send_email_notification(mr_list):
+ """Notify user about auto creation of indent"""
+
+ email_list = frappe.db.sql_list(
+ """select distinct r.parent
from `tabHas Role` r, tabUser p
where p.name = r.parent and p.enabled = 1 and p.docstatus < 2
and r.role in ('Purchase Manager','Stock Manager')
- and p.name not in ('Administrator', 'All', 'Guest')""")
+ and p.name not in ('Administrator', 'All', 'Guest')"""
+ )
- msg = frappe.render_template("templates/emails/reorder_item.html", {
- "mr_list": mr_list
- })
+ msg = frappe.render_template("templates/emails/reorder_item.html", {"mr_list": mr_list})
+
+ frappe.sendmail(recipients=email_list, subject=_("Auto Material Requests Generated"), message=msg)
- frappe.sendmail(recipients=email_list,
- subject=_('Auto Material Requests Generated'), message = msg)
def notify_errors(exceptions_list):
subject = _("[Important] [ERPNext] Auto Reorder Errors")
- content = _("Dear System Manager,") + "
" + _("An error occured for certain Items while creating Material Requests based on Re-order level. \
- Please rectify these issues :") + "
"
+ content = (
+ _("Dear System Manager,")
+ + "
"
+ + _(
+ "An error occured for certain Items while creating Material Requests based on Re-order level. \
+ Please rectify these issues :"
+ )
+ + "
"
+ )
for exception in exceptions_list:
- exception = json.loads(exception)
- error_message = """{0}
""".format(_(exception.get("message")))
- content += error_message
+ try:
+ exception = json.loads(exception)
+ error_message = """{0}
""".format(
+ _(exception.get("message"))
+ )
+ content += error_message
+ except Exception:
+ pass
content += _("Regards,") + "
" + _("Administrator")
from frappe.email import sendmail_to_system_managers
+
sendmail_to_system_managers(subject, content)
diff --git a/erpnext/stock/report/batch_item_expiry_status/batch_item_expiry_status.py b/erpnext/stock/report/batch_item_expiry_status/batch_item_expiry_status.py
index 44e13869ddb..3d9b0461977 100644
--- a/erpnext/stock/report/batch_item_expiry_status/batch_item_expiry_status.py
+++ b/erpnext/stock/report/batch_item_expiry_status/batch_item_expiry_status.py
@@ -8,7 +8,8 @@ from frappe.utils import cint, getdate
def execute(filters=None):
- if not filters: filters = {}
+ if not filters:
+ filters = {}
float_precision = cint(frappe.db.get_default("float_precision")) or 3
@@ -22,22 +23,37 @@ def execute(filters=None):
for batch in sorted(iwb_map[item][wh]):
qty_dict = iwb_map[item][wh][batch]
- data.append([item, item_map[item]["item_name"], item_map[item]["description"], wh, batch,
- frappe.db.get_value('Batch', batch, 'expiry_date'), qty_dict.expiry_status
- ])
-
+ data.append(
+ [
+ item,
+ item_map[item]["item_name"],
+ item_map[item]["description"],
+ wh,
+ batch,
+ frappe.db.get_value("Batch", batch, "expiry_date"),
+ qty_dict.expiry_status,
+ ]
+ )
return columns, data
+
def get_columns(filters):
"""return columns based on filters"""
- columns = [_("Item") + ":Link/Item:100"] + [_("Item Name") + "::150"] + [_("Description") + "::150"] + \
- [_("Warehouse") + ":Link/Warehouse:100"] + [_("Batch") + ":Link/Batch:100"] + [_("Expires On") + ":Date:90"] + \
- [_("Expiry (In Days)") + ":Int:120"]
+ columns = (
+ [_("Item") + ":Link/Item:100"]
+ + [_("Item Name") + "::150"]
+ + [_("Description") + "::150"]
+ + [_("Warehouse") + ":Link/Warehouse:100"]
+ + [_("Batch") + ":Link/Batch:100"]
+ + [_("Expires On") + ":Date:90"]
+ + [_("Expiry (In Days)") + ":Int:120"]
+ )
return columns
+
def get_conditions(filters):
conditions = ""
if not filters.get("from_date"):
@@ -50,13 +66,19 @@ def get_conditions(filters):
return conditions
+
def get_stock_ledger_entries(filters):
conditions = get_conditions(filters)
- return frappe.db.sql("""select item_code, batch_no, warehouse,
+ return frappe.db.sql(
+ """select item_code, batch_no, warehouse,
posting_date, actual_qty
from `tabStock Ledger Entry`
- where docstatus < 2 and ifnull(batch_no, '') != '' %s order by item_code, warehouse""" %
- conditions, as_dict=1)
+ where is_cancelled = 0
+ and docstatus < 2 and ifnull(batch_no, '') != '' %s order by item_code, warehouse"""
+ % conditions,
+ as_dict=1,
+ )
+
def get_item_warehouse_batch_map(filters, float_precision):
sle = get_stock_ledger_entries(filters)
@@ -66,13 +88,13 @@ def get_item_warehouse_batch_map(filters, float_precision):
to_date = getdate(filters["to_date"])
for d in sle:
- iwb_map.setdefault(d.item_code, {}).setdefault(d.warehouse, {})\
- .setdefault(d.batch_no, frappe._dict({
- "expires_on": None, "expiry_status": None}))
+ iwb_map.setdefault(d.item_code, {}).setdefault(d.warehouse, {}).setdefault(
+ d.batch_no, frappe._dict({"expires_on": None, "expiry_status": None})
+ )
qty_dict = iwb_map[d.item_code][d.warehouse][d.batch_no]
- expiry_date_unicode = frappe.db.get_value('Batch', d.batch_no, 'expiry_date')
+ expiry_date_unicode = frappe.db.get_value("Batch", d.batch_no, "expiry_date")
qty_dict.expires_on = expiry_date_unicode
exp_date = frappe.utils.data.getdate(expiry_date_unicode)
@@ -87,6 +109,7 @@ def get_item_warehouse_batch_map(filters, float_precision):
return iwb_map
+
def get_item_details(filters):
item_map = {}
for d in frappe.db.sql("select name, item_name, description from tabItem", as_dict=1):
diff --git a/erpnext/stock/report/batch_wise_balance_history/batch_wise_balance_history.py b/erpnext/stock/report/batch_wise_balance_history/batch_wise_balance_history.py
index 9b21deabcd4..8a13300dc83 100644
--- a/erpnext/stock/report/batch_wise_balance_history/batch_wise_balance_history.py
+++ b/erpnext/stock/report/batch_wise_balance_history/batch_wise_balance_history.py
@@ -8,7 +8,8 @@ from frappe.utils import cint, flt, getdate
def execute(filters=None):
- if not filters: filters = {}
+ if not filters:
+ filters = {}
if filters.from_date > filters.to_date:
frappe.throw(_("From Date must be before To Date"))
@@ -26,11 +27,20 @@ def execute(filters=None):
for batch in sorted(iwb_map[item][wh]):
qty_dict = iwb_map[item][wh][batch]
if qty_dict.opening_qty or qty_dict.in_qty or qty_dict.out_qty or qty_dict.bal_qty:
- data.append([item, item_map[item]["item_name"], item_map[item]["description"], wh, batch,
- flt(qty_dict.opening_qty, float_precision), flt(qty_dict.in_qty, float_precision),
- flt(qty_dict.out_qty, float_precision), flt(qty_dict.bal_qty, float_precision),
- item_map[item]["stock_uom"]
- ])
+ data.append(
+ [
+ item,
+ item_map[item]["item_name"],
+ item_map[item]["description"],
+ wh,
+ batch,
+ flt(qty_dict.opening_qty, float_precision),
+ flt(qty_dict.in_qty, float_precision),
+ flt(qty_dict.out_qty, float_precision),
+ flt(qty_dict.bal_qty, float_precision),
+ item_map[item]["stock_uom"],
+ ]
+ )
return columns, data
@@ -38,10 +48,18 @@ def execute(filters=None):
def get_columns(filters):
"""return columns based on filters"""
- columns = [_("Item") + ":Link/Item:100"] + [_("Item Name") + "::150"] + [_("Description") + "::150"] + \
- [_("Warehouse") + ":Link/Warehouse:100"] + [_("Batch") + ":Link/Batch:100"] + [_("Opening Qty") + ":Float:90"] + \
- [_("In Qty") + ":Float:80"] + [_("Out Qty") + ":Float:80"] + [_("Balance Qty") + ":Float:90"] + \
- [_("UOM") + "::90"]
+ columns = (
+ [_("Item") + ":Link/Item:100"]
+ + [_("Item Name") + "::150"]
+ + [_("Description") + "::150"]
+ + [_("Warehouse") + ":Link/Warehouse:100"]
+ + [_("Batch") + ":Link/Batch:100"]
+ + [_("Opening Qty") + ":Float:90"]
+ + [_("In Qty") + ":Float:80"]
+ + [_("Out Qty") + ":Float:80"]
+ + [_("Balance Qty") + ":Float:90"]
+ + [_("UOM") + "::90"]
+ )
return columns
@@ -66,13 +84,16 @@ def get_conditions(filters):
# get all details
def get_stock_ledger_entries(filters):
conditions = get_conditions(filters)
- return frappe.db.sql("""
+ return frappe.db.sql(
+ """
select item_code, batch_no, warehouse, posting_date, sum(actual_qty) as actual_qty
from `tabStock Ledger Entry`
where is_cancelled = 0 and docstatus < 2 and ifnull(batch_no, '') != '' %s
group by voucher_no, batch_no, item_code, warehouse
- order by item_code, warehouse""" %
- conditions, as_dict=1)
+ order by item_code, warehouse"""
+ % conditions,
+ as_dict=1,
+ )
def get_item_warehouse_batch_map(filters, float_precision):
@@ -83,20 +104,21 @@ def get_item_warehouse_batch_map(filters, float_precision):
to_date = getdate(filters["to_date"])
for d in sle:
- iwb_map.setdefault(d.item_code, {}).setdefault(d.warehouse, {})\
- .setdefault(d.batch_no, frappe._dict({
- "opening_qty": 0.0, "in_qty": 0.0, "out_qty": 0.0, "bal_qty": 0.0
- }))
+ iwb_map.setdefault(d.item_code, {}).setdefault(d.warehouse, {}).setdefault(
+ d.batch_no, frappe._dict({"opening_qty": 0.0, "in_qty": 0.0, "out_qty": 0.0, "bal_qty": 0.0})
+ )
qty_dict = iwb_map[d.item_code][d.warehouse][d.batch_no]
if d.posting_date < from_date:
- qty_dict.opening_qty = flt(qty_dict.opening_qty, float_precision) \
- + flt(d.actual_qty, float_precision)
+ qty_dict.opening_qty = flt(qty_dict.opening_qty, float_precision) + flt(
+ d.actual_qty, float_precision
+ )
elif d.posting_date >= from_date and d.posting_date <= to_date:
if flt(d.actual_qty) > 0:
qty_dict.in_qty = flt(qty_dict.in_qty, float_precision) + flt(d.actual_qty, float_precision)
else:
- qty_dict.out_qty = flt(qty_dict.out_qty, float_precision) \
- + abs(flt(d.actual_qty, float_precision))
+ qty_dict.out_qty = flt(qty_dict.out_qty, float_precision) + abs(
+ flt(d.actual_qty, float_precision)
+ )
qty_dict.bal_qty = flt(qty_dict.bal_qty, float_precision) + flt(d.actual_qty, float_precision)
diff --git a/erpnext/stock/report/bom_search/bom_search.py b/erpnext/stock/report/bom_search/bom_search.py
index 960396d5345..ec5da6236d6 100644
--- a/erpnext/stock/report/bom_search/bom_search.py
+++ b/erpnext/stock/report/bom_search/bom_search.py
@@ -11,11 +11,13 @@ def execute(filters=None):
parents = {
"Product Bundle Item": "Product Bundle",
"BOM Explosion Item": "BOM",
- "BOM Item": "BOM"
+ "BOM Item": "BOM",
}
- for doctype in ("Product Bundle Item",
- "BOM Explosion Item" if filters.search_sub_assemblies else "BOM Item"):
+ for doctype in (
+ "Product Bundle Item",
+ "BOM Explosion Item" if filters.search_sub_assemblies else "BOM Item",
+ ):
all_boms = {}
for d in frappe.get_all(doctype, fields=["parent", "item_code"]):
all_boms.setdefault(d.parent, []).append(d.item_code)
@@ -30,16 +32,13 @@ def execute(filters=None):
if valid:
data.append((parent, parents[doctype]))
- return [{
- "fieldname": "parent",
- "label": "BOM",
- "width": 200,
- "fieldtype": "Dynamic Link",
- "options": "doctype"
- },
- {
- "fieldname": "doctype",
- "label": "Type",
- "width": 200,
- "fieldtype": "Data"
- }], data
+ return [
+ {
+ "fieldname": "parent",
+ "label": "BOM",
+ "width": 200,
+ "fieldtype": "Dynamic Link",
+ "options": "doctype",
+ },
+ {"fieldname": "doctype", "label": "Type", "width": 200, "fieldtype": "Data"},
+ ], data
diff --git a/erpnext/stock/report/cogs_by_item_group/cogs_by_item_group.py b/erpnext/stock/report/cogs_by_item_group/cogs_by_item_group.py
index 5f6184d6f35..4642a535b63 100644
--- a/erpnext/stock/report/cogs_by_item_group/cogs_by_item_group.py
+++ b/erpnext/stock/report/cogs_by_item_group/cogs_by_item_group.py
@@ -41,18 +41,8 @@ def validate_filters(filters: Filters) -> None:
def get_columns() -> Columns:
return [
- {
- 'label': _('Item Group'),
- 'fieldname': 'item_group',
- 'fieldtype': 'Data',
- 'width': '200'
- },
- {
- 'label': _('COGS Debit'),
- 'fieldname': 'cogs_debit',
- 'fieldtype': 'Currency',
- 'width': '200'
- }
+ {"label": _("Item Group"), "fieldname": "item_group", "fieldtype": "Data", "width": "200"},
+ {"label": _("COGS Debit"), "fieldname": "cogs_debit", "fieldtype": "Currency", "width": "200"},
]
@@ -67,11 +57,11 @@ def get_data(filters: Filters) -> Data:
data = []
for item in leveled_dict.items():
i = item[1]
- if i['agg_value'] == 0:
+ if i["agg_value"] == 0:
continue
- data.append(get_row(i['name'], i['agg_value'], i['is_group'], i['level']))
- if i['self_value'] < i['agg_value'] and i['self_value'] > 0:
- data.append(get_row(i['name'], i['self_value'], 0, i['level'] + 1))
+ data.append(get_row(i["name"], i["agg_value"], i["is_group"], i["level"]))
+ if i["self_value"] < i["agg_value"] and i["self_value"] > 0:
+ data.append(get_row(i["name"], i["self_value"], 0, i["level"] + 1))
return data
@@ -79,8 +69,8 @@ def get_filtered_entries(filters: Filters) -> FilteredEntries:
gl_entries = get_gl_entries(filters, [])
filtered_entries = []
for entry in gl_entries:
- posting_date = entry.get('posting_date')
- from_date = filters.get('from_date')
+ posting_date = entry.get("posting_date")
+ from_date = filters.get("from_date")
if date_diff(from_date, posting_date) > 0:
continue
filtered_entries.append(entry)
@@ -88,10 +78,11 @@ def get_filtered_entries(filters: Filters) -> FilteredEntries:
def get_stock_value_difference_list(filtered_entries: FilteredEntries) -> SVDList:
- voucher_nos = [fe.get('voucher_no') for fe in filtered_entries]
+ voucher_nos = [fe.get("voucher_no") for fe in filtered_entries]
svd_list = frappe.get_list(
- 'Stock Ledger Entry', fields=['item_code','stock_value_difference'],
- filters=[('voucher_no', 'in', voucher_nos)]
+ "Stock Ledger Entry",
+ fields=["item_code", "stock_value_difference"],
+ filters=[("voucher_no", "in", voucher_nos), ("is_cancelled", "=", 0)],
)
assign_item_groups_to_svd_list(svd_list)
return svd_list
@@ -99,7 +90,7 @@ def get_stock_value_difference_list(filtered_entries: FilteredEntries) -> SVDLis
def get_leveled_dict() -> OrderedDict:
item_groups_dict = get_item_groups_dict()
- lr_list = sorted(item_groups_dict, key=lambda x : int(x[0]))
+ lr_list = sorted(item_groups_dict, key=lambda x: int(x[0]))
leveled_dict = OrderedDict()
current_level = 0
nesting_r = []
@@ -108,10 +99,10 @@ def get_leveled_dict() -> OrderedDict:
nesting_r.pop()
current_level -= 1
- leveled_dict[(l,r)] = {
- 'level' : current_level,
- 'name' : item_groups_dict[(l,r)]['name'],
- 'is_group' : item_groups_dict[(l,r)]['is_group']
+ leveled_dict[(l, r)] = {
+ "level": current_level,
+ "name": item_groups_dict[(l, r)]["name"],
+ "is_group": item_groups_dict[(l, r)]["is_group"],
}
if int(r) - int(l) > 1:
@@ -123,38 +114,38 @@ def get_leveled_dict() -> OrderedDict:
def assign_self_values(leveled_dict: OrderedDict, svd_list: SVDList) -> None:
- key_dict = {v['name']:k for k, v in leveled_dict.items()}
+ key_dict = {v["name"]: k for k, v in leveled_dict.items()}
for item in svd_list:
key = key_dict[item.get("item_group")]
- leveled_dict[key]['self_value'] += -item.get("stock_value_difference")
+ leveled_dict[key]["self_value"] += -item.get("stock_value_difference")
def assign_agg_values(leveled_dict: OrderedDict) -> None:
keys = list(leveled_dict.keys())[::-1]
- prev_level = leveled_dict[keys[-1]]['level']
+ prev_level = leveled_dict[keys[-1]]["level"]
accu = [0]
for k in keys[:-1]:
- curr_level = leveled_dict[k]['level']
+ curr_level = leveled_dict[k]["level"]
if curr_level == prev_level:
- accu[-1] += leveled_dict[k]['self_value']
- leveled_dict[k]['agg_value'] = leveled_dict[k]['self_value']
+ accu[-1] += leveled_dict[k]["self_value"]
+ leveled_dict[k]["agg_value"] = leveled_dict[k]["self_value"]
elif curr_level > prev_level:
- accu.append(leveled_dict[k]['self_value'])
- leveled_dict[k]['agg_value'] = accu[-1]
+ accu.append(leveled_dict[k]["self_value"])
+ leveled_dict[k]["agg_value"] = accu[-1]
elif curr_level < prev_level:
- accu[-1] += leveled_dict[k]['self_value']
- leveled_dict[k]['agg_value'] = accu[-1]
+ accu[-1] += leveled_dict[k]["self_value"]
+ leveled_dict[k]["agg_value"] = accu[-1]
prev_level = curr_level
# root node
rk = keys[-1]
- leveled_dict[rk]['agg_value'] = sum(accu) + leveled_dict[rk]['self_value']
+ leveled_dict[rk]["agg_value"] = sum(accu) + leveled_dict[rk]["self_value"]
-def get_row(name:str, value:float, is_bold:int, indent:int) -> Row:
+def get_row(name: str, value: float, is_bold: int, indent: int) -> Row:
item_group = name
if is_bold:
item_group = frappe.bold(item_group)
@@ -168,20 +159,20 @@ def assign_item_groups_to_svd_list(svd_list: SVDList) -> None:
def get_item_groups_map(svd_list: SVDList) -> Dict[str, str]:
- item_codes = set(i['item_code'] for i in svd_list)
+ item_codes = set(i["item_code"] for i in svd_list)
ig_list = frappe.get_list(
- 'Item', fields=['item_code','item_group'],
- filters=[('item_code', 'in', item_codes)]
+ "Item", fields=["item_code", "item_group"], filters=[("item_code", "in", item_codes)]
)
- return {i['item_code']:i['item_group'] for i in ig_list}
+ return {i["item_code"]: i["item_group"] for i in ig_list}
def get_item_groups_dict() -> ItemGroupsDict:
item_groups_list = frappe.get_all("Item Group", fields=("name", "is_group", "lft", "rgt"))
- return {(i['lft'],i['rgt']):{'name':i['name'], 'is_group':i['is_group']}
- for i in item_groups_list}
+ return {
+ (i["lft"], i["rgt"]): {"name": i["name"], "is_group": i["is_group"]} for i in item_groups_list
+ }
def update_leveled_dict(leveled_dict: OrderedDict) -> None:
for k in leveled_dict:
- leveled_dict[k].update({'self_value':0, 'agg_value':0})
+ leveled_dict[k].update({"self_value": 0, "agg_value": 0})
diff --git a/erpnext/stock/report/delayed_item_report/delayed_item_report.py b/erpnext/stock/report/delayed_item_report/delayed_item_report.py
index 4ec36ea417f..9df24d65596 100644
--- a/erpnext/stock/report/delayed_item_report/delayed_item_report.py
+++ b/erpnext/stock/report/delayed_item_report/delayed_item_report.py
@@ -7,11 +7,12 @@ from frappe import _
from frappe.utils import date_diff
-def execute(filters=None, consolidated = False):
+def execute(filters=None, consolidated=False):
data, columns = DelayedItemReport(filters).run()
return data, columns
+
class DelayedItemReport(object):
def __init__(self, filters=None):
self.filters = frappe._dict(filters or {})
@@ -23,28 +24,38 @@ class DelayedItemReport(object):
conditions = ""
doctype = self.filters.get("based_on")
- child_doc= "%s Item" % doctype
+ child_doc = "%s Item" % doctype
if doctype == "Sales Invoice":
conditions = " and `tabSales Invoice`.update_stock = 1 and `tabSales Invoice`.is_pos = 0"
if self.filters.get("item_group"):
- conditions += " and `tab%s`.item_group = %s" % (child_doc,
- frappe.db.escape(self.filters.get("item_group")))
+ conditions += " and `tab%s`.item_group = %s" % (
+ child_doc,
+ frappe.db.escape(self.filters.get("item_group")),
+ )
for field in ["customer", "customer_group", "company"]:
if self.filters.get(field):
- conditions += " and `tab%s`.%s = %s" % (doctype,
- field, frappe.db.escape(self.filters.get(field)))
+ conditions += " and `tab%s`.%s = %s" % (
+ doctype,
+ field,
+ frappe.db.escape(self.filters.get(field)),
+ )
sales_order_field = "against_sales_order"
if doctype == "Sales Invoice":
sales_order_field = "sales_order"
if self.filters.get("sales_order"):
- conditions = " and `tab%s`.%s = '%s'" %(child_doc, sales_order_field, self.filters.get("sales_order"))
+ conditions = " and `tab%s`.%s = '%s'" % (
+ child_doc,
+ sales_order_field,
+ self.filters.get("sales_order"),
+ )
- self.transactions = frappe.db.sql(""" SELECT `tab{child_doc}`.item_code, `tab{child_doc}`.item_name,
+ self.transactions = frappe.db.sql(
+ """ SELECT `tab{child_doc}`.item_code, `tab{child_doc}`.item_name,
`tab{child_doc}`.item_group, `tab{child_doc}`.qty, `tab{child_doc}`.rate, `tab{child_doc}`.amount,
`tab{child_doc}`.so_detail, `tab{child_doc}`.{so_field} as sales_order,
`tab{doctype}`.shipping_address_name, `tab{doctype}`.po_no, `tab{doctype}`.customer,
@@ -54,10 +65,12 @@ class DelayedItemReport(object):
`tab{child_doc}`.parent = `tab{doctype}`.name and `tab{doctype}`.docstatus = 1 and
`tab{doctype}`.posting_date between %(from_date)s and %(to_date)s and
`tab{child_doc}`.{so_field} is not null and `tab{child_doc}`.{so_field} != '' {cond}
- """.format(cond=conditions, doctype=doctype, child_doc=child_doc, so_field=sales_order_field), {
- 'from_date': self.filters.get('from_date'),
- 'to_date': self.filters.get('to_date')
- }, as_dict=1)
+ """.format(
+ cond=conditions, doctype=doctype, child_doc=child_doc, so_field=sales_order_field
+ ),
+ {"from_date": self.filters.get("from_date"), "to_date": self.filters.get("to_date")},
+ as_dict=1,
+ )
if self.transactions:
self.filter_transactions_data(consolidated)
@@ -67,112 +80,85 @@ class DelayedItemReport(object):
def filter_transactions_data(self, consolidated=False):
sales_orders = [d.sales_order for d in self.transactions]
doctype = "Sales Order"
- filters = {'name': ('in', sales_orders)}
+ filters = {"name": ("in", sales_orders)}
if not consolidated:
sales_order_items = [d.so_detail for d in self.transactions]
doctype = "Sales Order Item"
- filters = {'parent': ('in', sales_orders), 'name': ('in', sales_order_items)}
+ filters = {"parent": ("in", sales_orders), "name": ("in", sales_order_items)}
so_data = {}
- for d in frappe.get_all(doctype, filters = filters,
- fields = ["delivery_date", "parent", "name"]):
+ for d in frappe.get_all(doctype, filters=filters, fields=["delivery_date", "parent", "name"]):
key = d.name if consolidated else (d.parent, d.name)
if key not in so_data:
so_data.setdefault(key, d.delivery_date)
for row in self.transactions:
key = row.sales_order if consolidated else (row.sales_order, row.so_detail)
- row.update({
- 'delivery_date': so_data.get(key),
- 'delayed_days': date_diff(row.posting_date, so_data.get(key))
- })
+ row.update(
+ {
+ "delivery_date": so_data.get(key),
+ "delayed_days": date_diff(row.posting_date, so_data.get(key)),
+ }
+ )
return self.transactions
def get_columns(self):
based_on = self.filters.get("based_on")
- return [{
- "label": _(based_on),
- "fieldname": "name",
- "fieldtype": "Link",
- "options": based_on,
- "width": 100
- },
- {
- "label": _("Customer"),
- "fieldname": "customer",
- "fieldtype": "Link",
- "options": "Customer",
- "width": 200
- },
- {
- "label": _("Shipping Address"),
- "fieldname": "shipping_address_name",
- "fieldtype": "Link",
- "options": "Address",
- "width": 120
- },
- {
- "label": _("Expected Delivery Date"),
- "fieldname": "delivery_date",
- "fieldtype": "Date",
- "width": 100
- },
- {
- "label": _("Actual Delivery Date"),
- "fieldname": "posting_date",
- "fieldtype": "Date",
- "width": 100
- },
- {
- "label": _("Item Code"),
- "fieldname": "item_code",
- "fieldtype": "Link",
- "options": "Item",
- "width": 100
- },
- {
- "label": _("Item Name"),
- "fieldname": "item_name",
- "fieldtype": "Data",
- "width": 100
- },
- {
- "label": _("Quantity"),
- "fieldname": "qty",
- "fieldtype": "Float",
- "width": 100
- },
- {
- "label": _("Rate"),
- "fieldname": "rate",
- "fieldtype": "Currency",
- "width": 100
- },
- {
- "label": _("Amount"),
- "fieldname": "amount",
- "fieldtype": "Currency",
- "width": 100
- },
- {
- "label": _("Delayed Days"),
- "fieldname": "delayed_days",
- "fieldtype": "Int",
- "width": 100
- },
- {
- "label": _("Sales Order"),
- "fieldname": "sales_order",
- "fieldtype": "Link",
- "options": "Sales Order",
- "width": 100
- },
- {
- "label": _("Customer PO"),
- "fieldname": "po_no",
- "fieldtype": "Data",
- "width": 100
- }]
+ return [
+ {
+ "label": _(based_on),
+ "fieldname": "name",
+ "fieldtype": "Link",
+ "options": based_on,
+ "width": 100,
+ },
+ {
+ "label": _("Customer"),
+ "fieldname": "customer",
+ "fieldtype": "Link",
+ "options": "Customer",
+ "width": 200,
+ },
+ {
+ "label": _("Shipping Address"),
+ "fieldname": "shipping_address_name",
+ "fieldtype": "Link",
+ "options": "Address",
+ "width": 120,
+ },
+ {
+ "label": _("Expected Delivery Date"),
+ "fieldname": "delivery_date",
+ "fieldtype": "Date",
+ "width": 100,
+ },
+ {
+ "label": _("Actual Delivery Date"),
+ "fieldname": "posting_date",
+ "fieldtype": "Date",
+ "width": 100,
+ },
+ {
+ "label": _("Item Code"),
+ "fieldname": "item_code",
+ "fieldtype": "Link",
+ "options": "Item",
+ "width": 100,
+ },
+ {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 100},
+ {"label": _("Quantity"), "fieldname": "qty", "fieldtype": "Float", "width": 100},
+ {"label": _("Rate"), "fieldname": "rate", "fieldtype": "Currency", "width": 100},
+ {"label": _("Amount"), "fieldname": "amount", "fieldtype": "Currency", "width": 100},
+ {"label": _("Delayed Days"), "fieldname": "delayed_days", "fieldtype": "Int", "width": 100},
+ {
+ "label": _("Sales Order"),
+ "fieldname": "sales_order",
+ "fieldtype": "Link",
+ "options": "Sales Order",
+ "width": 100,
+ },
+ {"label": _("Customer PO"), "fieldname": "po_no", "fieldtype": "Data", "width": 100},
+ ]
diff --git a/erpnext/stock/report/delayed_order_report/delayed_order_report.py b/erpnext/stock/report/delayed_order_report/delayed_order_report.py
index 26090ab8ffb..197218d7ff4 100644
--- a/erpnext/stock/report/delayed_order_report/delayed_order_report.py
+++ b/erpnext/stock/report/delayed_order_report/delayed_order_report.py
@@ -14,6 +14,7 @@ def execute(filters=None):
return columns, data
+
class DelayedOrderReport(DelayedItemReport):
def run(self):
return self.get_columns(), self.get_data(consolidated=True) or []
@@ -33,60 +34,48 @@ class DelayedOrderReport(DelayedItemReport):
def get_columns(self):
based_on = self.filters.get("based_on")
- return [{
- "label": _(based_on),
- "fieldname": "name",
- "fieldtype": "Link",
- "options": based_on,
- "width": 100
- },{
- "label": _("Customer"),
- "fieldname": "customer",
- "fieldtype": "Link",
- "options": "Customer",
- "width": 200
- },
- {
- "label": _("Shipping Address"),
- "fieldname": "shipping_address_name",
- "fieldtype": "Link",
- "options": "Address",
- "width": 140
- },
- {
- "label": _("Expected Delivery Date"),
- "fieldname": "delivery_date",
- "fieldtype": "Date",
- "width": 100
- },
- {
- "label": _("Actual Delivery Date"),
- "fieldname": "posting_date",
- "fieldtype": "Date",
- "width": 100
- },
- {
- "label": _("Amount"),
- "fieldname": "grand_total",
- "fieldtype": "Currency",
- "width": 100
- },
- {
- "label": _("Delayed Days"),
- "fieldname": "delayed_days",
- "fieldtype": "Int",
- "width": 100
- },
- {
- "label": _("Sales Order"),
- "fieldname": "sales_order",
- "fieldtype": "Link",
- "options": "Sales Order",
- "width": 150
- },
- {
- "label": _("Customer PO"),
- "fieldname": "po_no",
- "fieldtype": "Data",
- "width": 110
- }]
+ return [
+ {
+ "label": _(based_on),
+ "fieldname": "name",
+ "fieldtype": "Link",
+ "options": based_on,
+ "width": 100,
+ },
+ {
+ "label": _("Customer"),
+ "fieldname": "customer",
+ "fieldtype": "Link",
+ "options": "Customer",
+ "width": 200,
+ },
+ {
+ "label": _("Shipping Address"),
+ "fieldname": "shipping_address_name",
+ "fieldtype": "Link",
+ "options": "Address",
+ "width": 140,
+ },
+ {
+ "label": _("Expected Delivery Date"),
+ "fieldname": "delivery_date",
+ "fieldtype": "Date",
+ "width": 100,
+ },
+ {
+ "label": _("Actual Delivery Date"),
+ "fieldname": "posting_date",
+ "fieldtype": "Date",
+ "width": 100,
+ },
+ {"label": _("Amount"), "fieldname": "grand_total", "fieldtype": "Currency", "width": 100},
+ {"label": _("Delayed Days"), "fieldname": "delayed_days", "fieldtype": "Int", "width": 100},
+ {
+ "label": _("Sales Order"),
+ "fieldname": "sales_order",
+ "fieldtype": "Link",
+ "options": "Sales Order",
+ "width": 150,
+ },
+ {"label": _("Customer PO"), "fieldname": "po_no", "fieldtype": "Data", "width": 110},
+ ]
diff --git a/erpnext/stock/report/delivery_note_trends/delivery_note_trends.py b/erpnext/stock/report/delivery_note_trends/delivery_note_trends.py
index b7ac7ff6a53..7a1b8c0cee9 100644
--- a/erpnext/stock/report/delivery_note_trends/delivery_note_trends.py
+++ b/erpnext/stock/report/delivery_note_trends/delivery_note_trends.py
@@ -8,7 +8,8 @@ from erpnext.controllers.trends import get_columns, get_data
def execute(filters=None):
- if not filters: filters ={}
+ if not filters:
+ filters = {}
data = []
conditions = get_columns(filters, "Delivery Note")
data = get_data(filters, conditions)
@@ -17,6 +18,7 @@ def execute(filters=None):
return conditions["columns"], data, None, chart_data
+
def get_chart_data(data, filters):
if not data:
return []
@@ -27,7 +29,7 @@ def get_chart_data(data, filters):
# consider only consolidated row
data = [row for row in data if row[0]]
- data = sorted(data, key = lambda i: i[-1],reverse=True)
+ data = sorted(data, key=lambda i: i[-1], reverse=True)
if len(data) > 10:
# get top 10 if data too long
@@ -39,13 +41,8 @@ def get_chart_data(data, filters):
return {
"data": {
- "labels" : labels,
- "datasets" : [
- {
- "name": _("Total Delivered Amount"),
- "values": datapoints
- }
- ]
+ "labels": labels,
+ "datasets": [{"name": _("Total Delivered Amount"), "values": datapoints}],
},
- "type" : "bar"
+ "type": "bar",
}
diff --git a/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/__init__.py b/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/__init__.py
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.js b/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.js
new file mode 100644
index 00000000000..0b8f49653dd
--- /dev/null
+++ b/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.js
@@ -0,0 +1,53 @@
+// Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors
+// For license information, please see license.txt
+/* eslint-disable */
+
+const DIFFERNCE_FIELD_NAMES = [
+ "fifo_qty_diff",
+ "fifo_value_diff",
+];
+
+frappe.query_reports["FIFO Queue vs Qty After Transaction Comparison"] = {
+ "filters": [
+ {
+ "fieldname": "item_code",
+ "fieldtype": "Link",
+ "label": "Item",
+ "options": "Item",
+ get_query: function() {
+ return {
+ filters: {is_stock_item: 1, has_serial_no: 0}
+ }
+ }
+ },
+ {
+ "fieldname": "item_group",
+ "fieldtype": "Link",
+ "label": "Item Group",
+ "options": "Item Group",
+ },
+ {
+ "fieldname": "warehouse",
+ "fieldtype": "Link",
+ "label": "Warehouse",
+ "options": "Warehouse",
+ },
+ {
+ "fieldname": "from_date",
+ "fieldtype": "Date",
+ "label": "From Posting Date",
+ },
+ {
+ "fieldname": "to_date",
+ "fieldtype": "Date",
+ "label": "From Posting Date",
+ }
+ ],
+ formatter (value, row, column, data, default_formatter) {
+ value = default_formatter(value, row, column, data);
+ if (DIFFERNCE_FIELD_NAMES.includes(column.fieldname) && Math.abs(data[column.fieldname]) > 0.001) {
+ value = "" + value + "";
+ }
+ return value;
+ },
+};
diff --git a/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.json b/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.json
new file mode 100644
index 00000000000..5e958aa1b03
--- /dev/null
+++ b/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.json
@@ -0,0 +1,27 @@
+{
+ "add_total_row": 0,
+ "columns": [],
+ "creation": "2022-05-11 04:09:13.460652",
+ "disable_prepared_report": 0,
+ "disabled": 0,
+ "docstatus": 0,
+ "doctype": "Report",
+ "filters": [],
+ "idx": 0,
+ "is_standard": "Yes",
+ "letter_head": "abc",
+ "modified": "2022-05-11 04:09:20.232177",
+ "modified_by": "Administrator",
+ "module": "Stock",
+ "name": "FIFO Queue vs Qty After Transaction Comparison",
+ "owner": "Administrator",
+ "prepared_report": 0,
+ "ref_doctype": "Stock Ledger Entry",
+ "report_name": "FIFO Queue vs Qty After Transaction Comparison",
+ "report_type": "Script Report",
+ "roles": [
+ {
+ "role": "Administrator"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.py b/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.py
new file mode 100644
index 00000000000..91ded6260e6
--- /dev/null
+++ b/erpnext/stock/report/fifo_queue_vs_qty_after_transaction_comparison/fifo_queue_vs_qty_after_transaction_comparison.py
@@ -0,0 +1,207 @@
+# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors
+# For license information, please see license.txt
+
+import json
+
+import frappe
+from frappe import _
+from frappe.utils import flt
+from frappe.utils.nestedset import get_descendants_of
+
+SLE_FIELDS = (
+ "name",
+ "item_code",
+ "warehouse",
+ "posting_date",
+ "posting_time",
+ "creation",
+ "voucher_type",
+ "voucher_no",
+ "actual_qty",
+ "qty_after_transaction",
+ "stock_queue",
+ "batch_no",
+ "stock_value",
+ "valuation_rate",
+)
+
+
+def execute(filters=None):
+ columns = get_columns()
+ data = get_data(filters)
+ return columns, data
+
+
+def get_data(filters):
+ if not any([filters.warehouse, filters.item_code, filters.item_group]):
+ frappe.throw(_("Any one of following filters required: warehouse, Item Code, Item Group"))
+ sles = get_stock_ledger_entries(filters)
+ return find_first_bad_queue(sles)
+
+
+def get_stock_ledger_entries(filters):
+
+ sle_filters = {"is_cancelled": 0}
+
+ if filters.warehouse:
+ children = get_descendants_of("Warehouse", filters.warehouse)
+ sle_filters["warehouse"] = ("in", children + [filters.warehouse])
+
+ if filters.item_code:
+ sle_filters["item_code"] = filters.item_code
+ elif filters.get("item_group"):
+ item_group = filters.get("item_group")
+ children = get_descendants_of("Item Group", item_group)
+ item_group_filter = {"item_group": ("in", children + [item_group])}
+ sle_filters["item_code"] = (
+ "in",
+ frappe.get_all("Item", filters=item_group_filter, pluck="name", order_by=None),
+ )
+
+ if filters.from_date:
+ sle_filters["posting_date"] = (">=", filters.from_date)
+ if filters.to_date:
+ sle_filters["posting_date"] = ("<=", filters.to_date)
+
+ return frappe.get_all(
+ "Stock Ledger Entry",
+ fields=SLE_FIELDS,
+ filters=sle_filters,
+ order_by="timestamp(posting_date, posting_time), creation",
+ )
+
+
+def find_first_bad_queue(sles):
+ item_warehouse_sles = {}
+ for sle in sles:
+ item_warehouse_sles.setdefault((sle.item_code, sle.warehouse), []).append(sle)
+
+ data = []
+
+ for _item_wh, sles in item_warehouse_sles.items():
+ for idx, sle in enumerate(sles):
+ queue = json.loads(sle.stock_queue or "[]")
+
+ sle.fifo_queue_qty = 0.0
+ sle.fifo_stock_value = 0.0
+ for qty, rate in queue:
+ sle.fifo_queue_qty += flt(qty)
+ sle.fifo_stock_value += flt(qty) * flt(rate)
+
+ sle.fifo_qty_diff = sle.qty_after_transaction - sle.fifo_queue_qty
+ sle.fifo_value_diff = sle.stock_value - sle.fifo_stock_value
+
+ if abs(sle.fifo_qty_diff) > 0.001 or abs(sle.fifo_value_diff) > 0.1:
+ if idx:
+ data.append(sles[idx - 1])
+ data.append(sle)
+ data.append({})
+ break
+
+ return data
+
+
+def get_columns():
+ return [
+ {
+ "fieldname": "name",
+ "fieldtype": "Link",
+ "label": _("Stock Ledger Entry"),
+ "options": "Stock Ledger Entry",
+ },
+ {
+ "fieldname": "item_code",
+ "fieldtype": "Link",
+ "label": _("Item Code"),
+ "options": "Item",
+ },
+ {
+ "fieldname": "warehouse",
+ "fieldtype": "Link",
+ "label": _("Warehouse"),
+ "options": "Warehouse",
+ },
+ {
+ "fieldname": "posting_date",
+ "fieldtype": "Data",
+ "label": _("Posting Date"),
+ },
+ {
+ "fieldname": "posting_time",
+ "fieldtype": "Data",
+ "label": _("Posting Time"),
+ },
+ {
+ "fieldname": "creation",
+ "fieldtype": "Data",
+ "label": _("Creation"),
+ },
+ {
+ "fieldname": "voucher_type",
+ "fieldtype": "Link",
+ "label": _("Voucher Type"),
+ "options": "DocType",
+ },
+ {
+ "fieldname": "voucher_no",
+ "fieldtype": "Dynamic Link",
+ "label": _("Voucher No"),
+ "options": "voucher_type",
+ },
+ {
+ "fieldname": "batch_no",
+ "fieldtype": "Link",
+ "label": _("Batch"),
+ "options": "Batch",
+ },
+ {
+ "fieldname": "use_batchwise_valuation",
+ "fieldtype": "Check",
+ "label": _("Batchwise Valuation"),
+ },
+ {
+ "fieldname": "actual_qty",
+ "fieldtype": "Float",
+ "label": _("Qty Change"),
+ },
+ {
+ "fieldname": "qty_after_transaction",
+ "fieldtype": "Float",
+ "label": _("(A) Qty After Transaction"),
+ },
+ {
+ "fieldname": "stock_queue",
+ "fieldtype": "Data",
+ "label": _("FIFO/LIFO Queue"),
+ },
+ {
+ "fieldname": "fifo_queue_qty",
+ "fieldtype": "Float",
+ "label": _("(C) Total qty in queue"),
+ },
+ {
+ "fieldname": "fifo_qty_diff",
+ "fieldtype": "Float",
+ "label": _("A - C"),
+ },
+ {
+ "fieldname": "stock_value",
+ "fieldtype": "Float",
+ "label": _("(D) Balance Stock Value"),
+ },
+ {
+ "fieldname": "fifo_stock_value",
+ "fieldtype": "Float",
+ "label": _("(E) Balance Stock Value in Queue"),
+ },
+ {
+ "fieldname": "fifo_value_diff",
+ "fieldtype": "Float",
+ "label": _("D - E"),
+ },
+ {
+ "fieldname": "valuation_rate",
+ "fieldtype": "Float",
+ "label": _("(H) Valuation Rate"),
+ },
+ ]
diff --git a/erpnext/stock/report/incorrect_balance_qty_after_transaction/incorrect_balance_qty_after_transaction.py b/erpnext/stock/report/incorrect_balance_qty_after_transaction/incorrect_balance_qty_after_transaction.py
index 7d7e9644854..af91b248b8c 100644
--- a/erpnext/stock/report/incorrect_balance_qty_after_transaction/incorrect_balance_qty_after_transaction.py
+++ b/erpnext/stock/report/incorrect_balance_qty_after_transaction/incorrect_balance_qty_after_transaction.py
@@ -13,6 +13,7 @@ def execute(filters=None):
data = get_data(filters)
return columns, data
+
def get_data(filters):
data = get_stock_ledger_entries(filters)
itewise_balance_qty = {}
@@ -24,6 +25,7 @@ def get_data(filters):
res = validate_data(itewise_balance_qty)
return res
+
def validate_data(itewise_balance_qty):
res = []
for key, data in iteritems(itewise_balance_qty):
@@ -34,6 +36,7 @@ def validate_data(itewise_balance_qty):
return res
+
def get_incorrect_data(data):
balance_qty = 0.0
for row in data:
@@ -46,67 +49,84 @@ def get_incorrect_data(data):
row.differnce = abs(flt(row.expected_balance_qty) - flt(row.qty_after_transaction))
return row
+
def get_stock_ledger_entries(report_filters):
filters = {"is_cancelled": 0}
- fields = ['name', 'voucher_type', 'voucher_no', 'item_code', 'actual_qty',
- 'posting_date', 'posting_time', 'company', 'warehouse', 'qty_after_transaction', 'batch_no']
+ fields = [
+ "name",
+ "voucher_type",
+ "voucher_no",
+ "item_code",
+ "actual_qty",
+ "posting_date",
+ "posting_time",
+ "company",
+ "warehouse",
+ "qty_after_transaction",
+ "batch_no",
+ ]
- for field in ['warehouse', 'item_code', 'company']:
+ for field in ["warehouse", "item_code", "company"]:
if report_filters.get(field):
filters[field] = report_filters.get(field)
- return frappe.get_all('Stock Ledger Entry', fields = fields, filters = filters,
- order_by = 'timestamp(posting_date, posting_time) asc, creation asc')
+ return frappe.get_all(
+ "Stock Ledger Entry",
+ fields=fields,
+ filters=filters,
+ order_by="timestamp(posting_date, posting_time) asc, creation asc",
+ )
+
def get_columns():
- return [{
- 'label': _('Id'),
- 'fieldtype': 'Link',
- 'fieldname': 'name',
- 'options': 'Stock Ledger Entry',
- 'width': 120
- }, {
- 'label': _('Posting Date'),
- 'fieldtype': 'Date',
- 'fieldname': 'posting_date',
- 'width': 110
- }, {
- 'label': _('Voucher Type'),
- 'fieldtype': 'Link',
- 'fieldname': 'voucher_type',
- 'options': 'DocType',
- 'width': 120
- }, {
- 'label': _('Voucher No'),
- 'fieldtype': 'Dynamic Link',
- 'fieldname': 'voucher_no',
- 'options': 'voucher_type',
- 'width': 120
- }, {
- 'label': _('Item Code'),
- 'fieldtype': 'Link',
- 'fieldname': 'item_code',
- 'options': 'Item',
- 'width': 120
- }, {
- 'label': _('Warehouse'),
- 'fieldtype': 'Link',
- 'fieldname': 'warehouse',
- 'options': 'Warehouse',
- 'width': 120
- }, {
- 'label': _('Expected Balance Qty'),
- 'fieldtype': 'Float',
- 'fieldname': 'expected_balance_qty',
- 'width': 170
- }, {
- 'label': _('Actual Balance Qty'),
- 'fieldtype': 'Float',
- 'fieldname': 'qty_after_transaction',
- 'width': 150
- }, {
- 'label': _('Difference'),
- 'fieldtype': 'Float',
- 'fieldname': 'differnce',
- 'width': 110
- }]
+ return [
+ {
+ "label": _("Id"),
+ "fieldtype": "Link",
+ "fieldname": "name",
+ "options": "Stock Ledger Entry",
+ "width": 120,
+ },
+ {"label": _("Posting Date"), "fieldtype": "Date", "fieldname": "posting_date", "width": 110},
+ {
+ "label": _("Voucher Type"),
+ "fieldtype": "Link",
+ "fieldname": "voucher_type",
+ "options": "DocType",
+ "width": 120,
+ },
+ {
+ "label": _("Voucher No"),
+ "fieldtype": "Dynamic Link",
+ "fieldname": "voucher_no",
+ "options": "voucher_type",
+ "width": 120,
+ },
+ {
+ "label": _("Item Code"),
+ "fieldtype": "Link",
+ "fieldname": "item_code",
+ "options": "Item",
+ "width": 120,
+ },
+ {
+ "label": _("Warehouse"),
+ "fieldtype": "Link",
+ "fieldname": "warehouse",
+ "options": "Warehouse",
+ "width": 120,
+ },
+ {
+ "label": _("Expected Balance Qty"),
+ "fieldtype": "Float",
+ "fieldname": "expected_balance_qty",
+ "width": 170,
+ },
+ {
+ "label": _("Actual Balance Qty"),
+ "fieldtype": "Float",
+ "fieldname": "qty_after_transaction",
+ "width": 150,
+ },
+ {"label": _("Difference"), "fieldtype": "Float", "fieldname": "differnce", "width": 110},
+ ]
diff --git a/erpnext/stock/report/incorrect_serial_no_valuation/incorrect_serial_no_valuation.py b/erpnext/stock/report/incorrect_serial_no_valuation/incorrect_serial_no_valuation.py
index 5f03c7cbe0a..26892407d99 100644
--- a/erpnext/stock/report/incorrect_serial_no_valuation/incorrect_serial_no_valuation.py
+++ b/erpnext/stock/report/incorrect_serial_no_valuation/incorrect_serial_no_valuation.py
@@ -16,6 +16,7 @@ def execute(filters=None):
data = get_data(filters)
return columns, data
+
def get_data(filters):
data = get_stock_ledger_entries(filters)
serial_nos_data = prepare_serial_nos(data)
@@ -23,6 +24,7 @@ def get_data(filters):
return data
+
def prepare_serial_nos(data):
serial_no_wise_data = {}
for row in data:
@@ -38,13 +40,16 @@ def prepare_serial_nos(data):
return serial_no_wise_data
+
def get_incorrect_serial_nos(serial_nos_data):
result = []
- total_value = frappe._dict({'qty': 0, 'valuation_rate': 0, 'serial_no': frappe.bold(_('Balance'))})
+ total_value = frappe._dict(
+ {"qty": 0, "valuation_rate": 0, "serial_no": frappe.bold(_("Balance"))}
+ )
for serial_no, data in iteritems(serial_nos_data):
- total_dict = frappe._dict({'qty': 0, 'valuation_rate': 0, 'serial_no': frappe.bold(_('Total'))})
+ total_dict = frappe._dict({"qty": 0, "valuation_rate": 0, "serial_no": frappe.bold(_("Total"))})
if check_incorrect_serial_data(data, total_dict):
result.extend(data)
@@ -59,93 +64,111 @@ def get_incorrect_serial_nos(serial_nos_data):
return result
+
def check_incorrect_serial_data(data, total_dict):
incorrect_data = False
for row in data:
total_dict.qty += row.qty
total_dict.valuation_rate += row.valuation_rate
- if ((total_dict.qty == 0 and abs(total_dict.valuation_rate) > 0) or total_dict.qty < 0):
+ if (total_dict.qty == 0 and abs(total_dict.valuation_rate) > 0) or total_dict.qty < 0:
incorrect_data = True
return incorrect_data
+
def get_stock_ledger_entries(report_filters):
- fields = ['name', 'voucher_type', 'voucher_no', 'item_code', 'serial_no as serial_nos', 'actual_qty',
- 'posting_date', 'posting_time', 'company', 'warehouse', '(stock_value_difference / actual_qty) as valuation_rate']
+ fields = [
+ "name",
+ "voucher_type",
+ "voucher_no",
+ "item_code",
+ "serial_no as serial_nos",
+ "actual_qty",
+ "posting_date",
+ "posting_time",
+ "company",
+ "warehouse",
+ "(stock_value_difference / actual_qty) as valuation_rate",
+ ]
- filters = {'serial_no': ("is", "set")}
+ filters = {"serial_no": ("is", "set"), "is_cancelled": 0}
- if report_filters.get('item_code'):
- filters['item_code'] = report_filters.get('item_code')
+ if report_filters.get("item_code"):
+ filters["item_code"] = report_filters.get("item_code")
- if report_filters.get('from_date') and report_filters.get('to_date'):
- filters['posting_date'] = ('between', [report_filters.get('from_date'), report_filters.get('to_date')])
+ if report_filters.get("from_date") and report_filters.get("to_date"):
+ filters["posting_date"] = (
+ "between",
+ [report_filters.get("from_date"), report_filters.get("to_date")],
+ )
+
+ return frappe.get_all(
+ "Stock Ledger Entry",
+ fields=fields,
+ filters=filters,
+ order_by="timestamp(posting_date, posting_time) asc, creation asc",
+ )
- return frappe.get_all('Stock Ledger Entry', fields = fields, filters = filters,
- order_by = 'timestamp(posting_date, posting_time) asc, creation asc')
def get_columns():
- return [{
- 'label': _('Company'),
- 'fieldtype': 'Link',
- 'fieldname': 'company',
- 'options': 'Company',
- 'width': 120
- }, {
- 'label': _('Id'),
- 'fieldtype': 'Link',
- 'fieldname': 'name',
- 'options': 'Stock Ledger Entry',
- 'width': 120
- }, {
- 'label': _('Posting Date'),
- 'fieldtype': 'Date',
- 'fieldname': 'posting_date',
- 'width': 90
- }, {
- 'label': _('Posting Time'),
- 'fieldtype': 'Time',
- 'fieldname': 'posting_time',
- 'width': 90
- }, {
- 'label': _('Voucher Type'),
- 'fieldtype': 'Link',
- 'fieldname': 'voucher_type',
- 'options': 'DocType',
- 'width': 100
- }, {
- 'label': _('Voucher No'),
- 'fieldtype': 'Dynamic Link',
- 'fieldname': 'voucher_no',
- 'options': 'voucher_type',
- 'width': 110
- }, {
- 'label': _('Item Code'),
- 'fieldtype': 'Link',
- 'fieldname': 'item_code',
- 'options': 'Item',
- 'width': 120
- }, {
- 'label': _('Warehouse'),
- 'fieldtype': 'Link',
- 'fieldname': 'warehouse',
- 'options': 'Warehouse',
- 'width': 120
- }, {
- 'label': _('Serial No'),
- 'fieldtype': 'Link',
- 'fieldname': 'serial_no',
- 'options': 'Serial No',
- 'width': 100
- }, {
- 'label': _('Qty'),
- 'fieldtype': 'Float',
- 'fieldname': 'qty',
- 'width': 80
- }, {
- 'label': _('Valuation Rate (In / Out)'),
- 'fieldtype': 'Currency',
- 'fieldname': 'valuation_rate',
- 'width': 110
- }]
+ return [
+ {
+ "label": _("Company"),
+ "fieldtype": "Link",
+ "fieldname": "company",
+ "options": "Company",
+ "width": 120,
+ },
+ {
+ "label": _("Id"),
+ "fieldtype": "Link",
+ "fieldname": "name",
+ "options": "Stock Ledger Entry",
+ "width": 120,
+ },
+ {"label": _("Posting Date"), "fieldtype": "Date", "fieldname": "posting_date", "width": 90},
+ {"label": _("Posting Time"), "fieldtype": "Time", "fieldname": "posting_time", "width": 90},
+ {
+ "label": _("Voucher Type"),
+ "fieldtype": "Link",
+ "fieldname": "voucher_type",
+ "options": "DocType",
+ "width": 100,
+ },
+ {
+ "label": _("Voucher No"),
+ "fieldtype": "Dynamic Link",
+ "fieldname": "voucher_no",
+ "options": "voucher_type",
+ "width": 110,
+ },
+ {
+ "label": _("Item Code"),
+ "fieldtype": "Link",
+ "fieldname": "item_code",
+ "options": "Item",
+ "width": 120,
+ },
+ {
+ "label": _("Warehouse"),
+ "fieldtype": "Link",
+ "fieldname": "warehouse",
+ "options": "Warehouse",
+ "width": 120,
+ },
+ {
+ "label": _("Serial No"),
+ "fieldtype": "Link",
+ "fieldname": "serial_no",
+ "options": "Serial No",
+ "width": 100,
+ },
+ {"label": _("Qty"), "fieldtype": "Float", "fieldname": "qty", "width": 80},
+ {
+ "label": _("Valuation Rate (In / Out)"),
+ "fieldtype": "Currency",
+ "fieldname": "valuation_rate",
+ "width": 110,
+ },
+ ]
diff --git a/erpnext/stock/report/incorrect_stock_value_report/incorrect_stock_value_report.py b/erpnext/stock/report/incorrect_stock_value_report/incorrect_stock_value_report.py
index 7cce4a7d22e..46bcd94e278 100644
--- a/erpnext/stock/report/incorrect_stock_value_report/incorrect_stock_value_report.py
+++ b/erpnext/stock/report/incorrect_stock_value_report/incorrect_stock_value_report.py
@@ -4,6 +4,8 @@
import frappe
from frappe import _
+from frappe.query_builder import Field
+from frappe.query_builder.functions import Min, Timestamp
from frappe.utils import add_days, getdate, today
from six import iteritems
@@ -14,32 +16,38 @@ from erpnext.stock.utils import get_stock_value_on
def execute(filters=None):
if not erpnext.is_perpetual_inventory_enabled(filters.company):
- frappe.throw(_("Perpetual inventory required for the company {0} to view this report.")
- .format(filters.company))
+ frappe.throw(
+ _("Perpetual inventory required for the company {0} to view this report.").format(
+ filters.company
+ )
+ )
data = get_data(filters)
columns = get_columns(filters)
return columns, data
+
def get_unsync_date(filters):
date = filters.from_date
if not date:
- date = frappe.db.sql(""" SELECT min(posting_date) from `tabStock Ledger Entry`""")
+ date = (frappe.qb.from_("Stock Ledger Entry").select(Min(Field("posting_date")))).run()
date = date[0][0]
if not date:
return
while getdate(date) < getdate(today()):
- account_bal, stock_bal, warehouse_list = get_stock_and_account_balance(posting_date=date,
- company=filters.company, account = filters.account)
+ account_bal, stock_bal, warehouse_list = get_stock_and_account_balance(
+ posting_date=date, company=filters.company, account=filters.account
+ )
if abs(account_bal - stock_bal) > 0.1:
return date
date = add_days(date, 1)
+
def get_data(report_filters):
from_date = get_unsync_date(report_filters)
@@ -49,25 +57,36 @@ def get_data(report_filters):
result = []
voucher_wise_dict = {}
- data = frappe.db.sql('''
- SELECT
- name, posting_date, posting_time, voucher_type, voucher_no,
- stock_value_difference, stock_value, warehouse, item_code
- FROM
- `tabStock Ledger Entry`
- WHERE
- posting_date
- = %s and company = %s
- and is_cancelled = 0
- ORDER BY timestamp(posting_date, posting_time) asc, creation asc
- ''', (from_date, report_filters.company), as_dict=1)
+ sle = frappe.qb.DocType("Stock Ledger Entry")
+ data = (
+ frappe.qb.from_(sle)
+ .select(
+ sle.name,
+ sle.posting_date,
+ sle.posting_time,
+ sle.voucher_type,
+ sle.voucher_no,
+ sle.stock_value_difference,
+ sle.stock_value,
+ sle.warehouse,
+ sle.item_code,
+ )
+ .where(
+ (sle.posting_date == from_date)
+ & (sle.company == report_filters.company)
+ & (sle.is_cancelled == 0)
+ )
+ .orderby(Timestamp(sle.posting_date, sle.posting_time), sle.creation)
+ ).run(as_dict=True)
for d in data:
voucher_wise_dict.setdefault((d.item_code, d.warehouse), []).append(d)
closing_date = add_days(from_date, -1)
for key, stock_data in iteritems(voucher_wise_dict):
- prev_stock_value = get_stock_value_on(posting_date = closing_date, item_code=key[0], warehouse =key[1])
+ prev_stock_value = get_stock_value_on(
+ posting_date=closing_date, item_code=key[0], warehouse=key[1]
+ )
for data in stock_data:
expected_stock_value = prev_stock_value + data.stock_value_difference
if abs(data.stock_value - expected_stock_value) > 0.1:
@@ -77,6 +96,7 @@ def get_data(report_filters):
return result
+
def get_columns(filters):
return [
{
@@ -84,60 +104,43 @@ def get_columns(filters):
"fieldname": "name",
"fieldtype": "Link",
"options": "Stock Ledger Entry",
- "width": "80"
- },
- {
- "label": _("Posting Date"),
- "fieldname": "posting_date",
- "fieldtype": "Date"
- },
- {
- "label": _("Posting Time"),
- "fieldname": "posting_time",
- "fieldtype": "Time"
- },
- {
- "label": _("Voucher Type"),
- "fieldname": "voucher_type",
- "width": "110"
+ "width": "80",
},
+ {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date"},
+ {"label": _("Posting Time"), "fieldname": "posting_time", "fieldtype": "Time"},
+ {"label": _("Voucher Type"), "fieldname": "voucher_type", "width": "110"},
{
"label": _("Voucher No"),
"fieldname": "voucher_no",
"fieldtype": "Dynamic Link",
"options": "voucher_type",
- "width": "110"
+ "width": "110",
},
{
"label": _("Item Code"),
"fieldname": "item_code",
"fieldtype": "Link",
"options": "Item",
- "width": "110"
+ "width": "110",
},
{
"label": _("Warehouse"),
"fieldname": "warehouse",
"fieldtype": "Link",
"options": "Warehouse",
- "width": "110"
+ "width": "110",
},
{
"label": _("Expected Stock Value"),
"fieldname": "expected_stock_value",
"fieldtype": "Currency",
- "width": "150"
- },
- {
- "label": _("Stock Value"),
- "fieldname": "stock_value",
- "fieldtype": "Currency",
- "width": "120"
+ "width": "150",
},
+ {"label": _("Stock Value"), "fieldname": "stock_value", "fieldtype": "Currency", "width": "120"},
{
"label": _("Difference Value"),
"fieldname": "difference_value",
"fieldtype": "Currency",
- "width": "150"
- }
+ "width": "150",
+ },
]
diff --git a/erpnext/stock/report/item_price_stock/item_price_stock.py b/erpnext/stock/report/item_price_stock/item_price_stock.py
index 65af9f51cdf..1b07f596c7b 100644
--- a/erpnext/stock/report/item_price_stock/item_price_stock.py
+++ b/erpnext/stock/report/item_price_stock/item_price_stock.py
@@ -7,10 +7,11 @@ from frappe import _
def execute(filters=None):
columns, data = [], []
- columns=get_columns()
- data=get_data(filters,columns)
+ columns = get_columns()
+ data = get_data(filters, columns)
return columns, data
+
def get_columns():
return [
{
@@ -18,77 +19,70 @@ def get_columns():
"fieldname": "item_code",
"fieldtype": "Link",
"options": "Item",
- "width": 120
- },
- {
- "label": _("Item Name"),
- "fieldname": "item_name",
- "fieldtype": "Data",
- "width": 120
- },
- {
- "label": _("Brand"),
- "fieldname": "brand",
- "fieldtype": "Data",
- "width": 100
+ "width": 120,
},
+ {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 120},
+ {"label": _("Brand"), "fieldname": "brand", "fieldtype": "Data", "width": 100},
{
"label": _("Warehouse"),
"fieldname": "warehouse",
"fieldtype": "Link",
"options": "Warehouse",
- "width": 120
+ "width": 120,
},
{
"label": _("Stock Available"),
"fieldname": "stock_available",
"fieldtype": "Float",
- "width": 120
+ "width": 120,
},
{
"label": _("Buying Price List"),
"fieldname": "buying_price_list",
"fieldtype": "Link",
"options": "Price List",
- "width": 120
- },
- {
- "label": _("Buying Rate"),
- "fieldname": "buying_rate",
- "fieldtype": "Currency",
- "width": 120
+ "width": 120,
},
+ {"label": _("Buying Rate"), "fieldname": "buying_rate", "fieldtype": "Currency", "width": 120},
{
"label": _("Selling Price List"),
"fieldname": "selling_price_list",
"fieldtype": "Link",
"options": "Price List",
- "width": 120
+ "width": 120,
},
- {
- "label": _("Selling Rate"),
- "fieldname": "selling_rate",
- "fieldtype": "Currency",
- "width": 120
- }
+ {"label": _("Selling Rate"), "fieldname": "selling_rate", "fieldtype": "Currency", "width": 120},
]
+
def get_data(filters, columns):
item_price_qty_data = []
item_price_qty_data = get_item_price_qty_data(filters)
return item_price_qty_data
-def get_item_price_qty_data(filters):
- conditions = ""
- if filters.get("item_code"):
- conditions += "where a.item_code=%(item_code)s"
- item_results = frappe.db.sql("""select a.item_code, a.item_name, a.name as price_list_name,
- a.brand as brand, b.warehouse as warehouse, b.actual_qty as actual_qty
- from `tabItem Price` a left join `tabBin` b
- ON a.item_code = b.item_code
- {conditions}"""
- .format(conditions=conditions), filters, as_dict=1)
+def get_item_price_qty_data(filters):
+ item_price = frappe.qb.DocType("Item Price")
+ bin = frappe.qb.DocType("Bin")
+
+ query = (
+ frappe.qb.from_(item_price)
+ .left_join(bin)
+ .on(item_price.item_code == bin.item_code)
+ .select(
+ item_price.item_code,
+ item_price.item_name,
+ item_price.name.as_("price_list_name"),
+ item_price.brand.as_("brand"),
+ bin.warehouse.as_("warehouse"),
+ bin.actual_qty.as_("actual_qty"),
+ )
+ )
+
+ if filters.get("item_code"):
+ query = query.where(item_price.item_code == filters.get("item_code"))
+
+ item_results = query.run(as_dict=True)
price_list_names = list(set(item.price_list_name for item in item_results))
@@ -99,15 +93,15 @@ def get_item_price_qty_data(filters):
if item_results:
for item_dict in item_results:
data = {
- 'item_code': item_dict.item_code,
- 'item_name': item_dict.item_name,
- 'brand': item_dict.brand,
- 'warehouse': item_dict.warehouse,
- 'stock_available': item_dict.actual_qty or 0,
- 'buying_price_list': "",
- 'buying_rate': 0.0,
- 'selling_price_list': "",
- 'selling_rate': 0.0
+ "item_code": item_dict.item_code,
+ "item_name": item_dict.item_name,
+ "brand": item_dict.brand,
+ "warehouse": item_dict.warehouse,
+ "stock_available": item_dict.actual_qty or 0,
+ "buying_price_list": "",
+ "buying_rate": 0.0,
+ "selling_price_list": "",
+ "selling_rate": 0.0,
}
price_list = item_dict["price_list_name"]
@@ -122,6 +116,7 @@ def get_item_price_qty_data(filters):
return result
+
def get_price_map(price_list_names, buying=0, selling=0):
price_map = {}
@@ -137,14 +132,12 @@ def get_price_map(price_list_names, buying=0, selling=0):
else:
filters["selling"] = 1
- pricing_details = frappe.get_all("Item Price",
- fields = ["name", "price_list", "price_list_rate"], filters=filters)
+ pricing_details = frappe.get_all(
+ "Item Price", fields=["name", "price_list", "price_list_rate"], filters=filters
+ )
for d in pricing_details:
name = d["name"]
- price_map[name] = {
- price_list_key :d["price_list"],
- rate_key :d["price_list_rate"]
- }
+ price_map[name] = {price_list_key: d["price_list"], rate_key: d["price_list_rate"]}
return price_map
diff --git a/erpnext/stock/report/item_prices/item_prices.py b/erpnext/stock/report/item_prices/item_prices.py
index 0d0e8d22924..87f1a42e2b2 100644
--- a/erpnext/stock/report/item_prices/item_prices.py
+++ b/erpnext/stock/report/item_prices/item_prices.py
@@ -8,7 +8,8 @@ from frappe.utils import flt
def execute(filters=None):
- if not filters: filters = {}
+ if not filters:
+ filters = {}
columns = get_columns(filters)
conditions = get_condition(filters)
@@ -19,64 +20,95 @@ def execute(filters=None):
val_rate_map = get_valuation_rate()
from erpnext.accounts.utils import get_currency_precision
+
precision = get_currency_precision() or 2
data = []
for item in sorted(item_map):
- data.append([item, item_map[item]["item_name"],item_map[item]["item_group"],
- item_map[item]["brand"], item_map[item]["description"], item_map[item]["stock_uom"],
- flt(last_purchase_rate.get(item, 0), precision),
- flt(val_rate_map.get(item, 0), precision),
- pl.get(item, {}).get("Selling"),
- pl.get(item, {}).get("Buying"),
- flt(bom_rate.get(item, 0), precision)
- ])
+ data.append(
+ [
+ item,
+ item_map[item]["item_name"],
+ item_map[item]["item_group"],
+ item_map[item]["brand"],
+ item_map[item]["description"],
+ item_map[item]["stock_uom"],
+ flt(last_purchase_rate.get(item, 0), precision),
+ flt(val_rate_map.get(item, 0), precision),
+ pl.get(item, {}).get("Selling"),
+ pl.get(item, {}).get("Buying"),
+ flt(bom_rate.get(item, 0), precision),
+ ]
+ )
return columns, data
+
def get_columns(filters):
"""return columns based on filters"""
- columns = [_("Item") + ":Link/Item:100", _("Item Name") + "::150",_("Item Group") + ":Link/Item Group:125",
- _("Brand") + "::100", _("Description") + "::150", _("UOM") + ":Link/UOM:80",
- _("Last Purchase Rate") + ":Currency:90", _("Valuation Rate") + ":Currency:80", _("Sales Price List") + "::180",
- _("Purchase Price List") + "::180", _("BOM Rate") + ":Currency:90"]
+ columns = [
+ _("Item") + ":Link/Item:100",
+ _("Item Name") + "::150",
+ _("Item Group") + ":Link/Item Group:125",
+ _("Brand") + "::100",
+ _("Description") + "::150",
+ _("UOM") + ":Link/UOM:80",
+ _("Last Purchase Rate") + ":Currency:90",
+ _("Valuation Rate") + ":Currency:80",
+ _("Sales Price List") + "::180",
+ _("Purchase Price List") + "::180",
+ _("BOM Rate") + ":Currency:90",
+ ]
return columns
+
def get_item_details(conditions):
"""returns all items details"""
item_map = {}
- for i in frappe.db.sql("""select name, item_group, item_name, description,
+ for i in frappe.db.sql(
+ """select name, item_group, item_name, description,
brand, stock_uom from tabItem %s
- order by item_code, item_group""" % (conditions), as_dict=1):
- item_map.setdefault(i.name, i)
+ order by item_code, item_group"""
+ % (conditions),
+ as_dict=1,
+ ):
+ item_map.setdefault(i.name, i)
return item_map
+
def get_price_list():
"""Get selling & buying price list of every item"""
rate = {}
- price_list = frappe.db.sql("""select ip.item_code, ip.buying, ip.selling,
+ price_list = frappe.db.sql(
+ """select ip.item_code, ip.buying, ip.selling,
concat(ifnull(cu.symbol,ip.currency), " ", round(ip.price_list_rate,2), " - ", ip.price_list) as price
from `tabItem Price` ip, `tabPrice List` pl, `tabCurrency` cu
- where ip.price_list=pl.name and pl.currency=cu.name and pl.enabled=1""", as_dict=1)
+ where ip.price_list=pl.name and pl.currency=cu.name and pl.enabled=1""",
+ as_dict=1,
+ )
for j in price_list:
if j.price:
- rate.setdefault(j.item_code, {}).setdefault("Buying" if j.buying else "Selling", []).append(j.price)
+ rate.setdefault(j.item_code, {}).setdefault("Buying" if j.buying else "Selling", []).append(
+ j.price
+ )
item_rate_map = {}
for item in rate:
for buying_or_selling in rate[item]:
- item_rate_map.setdefault(item, {}).setdefault(buying_or_selling,
- ", ".join(rate[item].get(buying_or_selling, [])))
+ item_rate_map.setdefault(item, {}).setdefault(
+ buying_or_selling, ", ".join(rate[item].get(buying_or_selling, []))
+ )
return item_rate_map
+
def get_last_purchase_rate():
item_last_purchase_rate_map = {}
@@ -108,29 +140,38 @@ def get_last_purchase_rate():
return item_last_purchase_rate_map
+
def get_item_bom_rate():
"""Get BOM rate of an item from BOM"""
item_bom_map = {}
- for b in frappe.db.sql("""select item, (total_cost/quantity) as bom_rate
- from `tabBOM` where is_active=1 and is_default=1""", as_dict=1):
- item_bom_map.setdefault(b.item, flt(b.bom_rate))
+ for b in frappe.db.sql(
+ """select item, (total_cost/quantity) as bom_rate
+ from `tabBOM` where is_active=1 and is_default=1""",
+ as_dict=1,
+ ):
+ item_bom_map.setdefault(b.item, flt(b.bom_rate))
return item_bom_map
+
def get_valuation_rate():
"""Get an average valuation rate of an item from all warehouses"""
item_val_rate_map = {}
- for d in frappe.db.sql("""select item_code,
+ for d in frappe.db.sql(
+ """select item_code,
sum(actual_qty*valuation_rate)/sum(actual_qty) as val_rate
- from tabBin where actual_qty > 0 group by item_code""", as_dict=1):
- item_val_rate_map.setdefault(d.item_code, d.val_rate)
+ from tabBin where actual_qty > 0 group by item_code""",
+ as_dict=1,
+ ):
+ item_val_rate_map.setdefault(d.item_code, d.val_rate)
return item_val_rate_map
+
def get_condition(filters):
"""Get Filter Items"""
diff --git a/erpnext/stock/report/item_shortage_report/item_shortage_report.py b/erpnext/stock/report/item_shortage_report/item_shortage_report.py
index 30c761421fd..9fafe91c3f9 100644
--- a/erpnext/stock/report/item_shortage_report/item_shortage_report.py
+++ b/erpnext/stock/report/item_shortage_report/item_shortage_report.py
@@ -8,8 +8,7 @@ from frappe import _
def execute(filters=None):
columns = get_columns()
- conditions = get_conditions(filters)
- data = get_data(conditions, filters)
+ data = get_data(filters)
if not data:
return [], [], None, []
@@ -18,42 +17,41 @@ def execute(filters=None):
return columns, data, None, chart_data
-def get_conditions(filters):
- conditions = ""
- if filters.get("warehouse"):
- conditions += "AND warehouse in %(warehouse)s"
- if filters.get("company"):
- conditions += "AND company = %(company)s"
+def get_data(filters):
+ bin = frappe.qb.DocType("Bin")
+ wh = frappe.qb.DocType("Warehouse")
+ item = frappe.qb.DocType("Item")
- return conditions
-
-def get_data(conditions, filters):
- data = frappe.db.sql("""
- SELECT
+ query = (
+ frappe.qb.from_(bin)
+ .from_(wh)
+ .from_(item)
+ .select(
bin.warehouse,
bin.item_code,
- bin.actual_qty ,
- bin.ordered_qty ,
- bin.planned_qty ,
- bin.reserved_qty ,
+ bin.actual_qty,
+ bin.ordered_qty,
+ bin.planned_qty,
+ bin.reserved_qty,
bin.reserved_qty_for_production,
- bin.projected_qty ,
- warehouse.company,
- item.item_name ,
- item.description
- FROM
- `tabBin` bin,
- `tabWarehouse` warehouse,
- `tabItem` item
- WHERE
- bin.projected_qty<0
- AND warehouse.name = bin.warehouse
- AND bin.item_code=item.name
- {0}
- ORDER BY bin.projected_qty;""".format(conditions), filters, as_dict=1)
+ bin.projected_qty,
+ wh.company,
+ item.item_name,
+ item.description,
+ )
+ .where((bin.projected_qty < 0) & (wh.name == bin.warehouse) & (bin.item_code == item.name))
+ .orderby(bin.projected_qty)
+ )
+
+ if filters.get("warehouse"):
+ query = query.where(bin.warehouse.isin(filters.get("warehouse")))
+
+ if filters.get("company"):
+ query = query.where(wh.company == filters.get("company"))
+
+ return query.run(as_dict=True)
- return data
def get_chart_data(data):
labels, datapoints = [], []
@@ -67,18 +65,11 @@ def get_chart_data(data):
datapoints = datapoints[:10]
return {
- "data": {
- "labels": labels,
- "datasets":[
- {
- "name": _("Projected Qty"),
- "values": datapoints
- }
- ]
- },
- "type": "bar"
+ "data": {"labels": labels, "datasets": [{"name": _("Projected Qty"), "values": datapoints}]},
+ "type": "bar",
}
+
def get_columns():
columns = [
{
@@ -86,76 +77,66 @@ def get_columns():
"fieldname": "warehouse",
"fieldtype": "Link",
"options": "Warehouse",
- "width": 150
+ "width": 150,
},
{
"label": _("Item"),
"fieldname": "item_code",
"fieldtype": "Link",
"options": "Item",
- "width": 150
+ "width": 150,
},
{
"label": _("Actual Quantity"),
"fieldname": "actual_qty",
"fieldtype": "Float",
"width": 120,
- "convertible": "qty"
+ "convertible": "qty",
},
{
"label": _("Ordered Quantity"),
"fieldname": "ordered_qty",
"fieldtype": "Float",
"width": 120,
- "convertible": "qty"
+ "convertible": "qty",
},
{
"label": _("Planned Quantity"),
"fieldname": "planned_qty",
"fieldtype": "Float",
"width": 120,
- "convertible": "qty"
+ "convertible": "qty",
},
{
"label": _("Reserved Quantity"),
"fieldname": "reserved_qty",
"fieldtype": "Float",
"width": 120,
- "convertible": "qty"
+ "convertible": "qty",
},
{
"label": _("Reserved Quantity for Production"),
"fieldname": "reserved_qty_for_production",
"fieldtype": "Float",
"width": 120,
- "convertible": "qty"
+ "convertible": "qty",
},
{
"label": _("Projected Quantity"),
"fieldname": "projected_qty",
"fieldtype": "Float",
"width": 120,
- "convertible": "qty"
+ "convertible": "qty",
},
{
"label": _("Company"),
"fieldname": "company",
"fieldtype": "Link",
"options": "Company",
- "width": 120
+ "width": 120,
},
- {
- "label": _("Item Name"),
- "fieldname": "item_name",
- "fieldtype": "Data",
- "width": 100
- },
- {
- "label": _("Description"),
- "fieldname": "description",
- "fieldtype": "Data",
- "width": 120
- }
+ {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 100},
+ {"label": _("Description"), "fieldname": "description", "fieldtype": "Data", "width": 120},
]
return columns
diff --git a/erpnext/stock/report/item_shortage_report/test_item_shortage_report.py b/erpnext/stock/report/item_shortage_report/test_item_shortage_report.py
new file mode 100644
index 00000000000..5884c32acc7
--- /dev/null
+++ b/erpnext/stock/report/item_shortage_report/test_item_shortage_report.py
@@ -0,0 +1,51 @@
+# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors
+# For license information, please see license.txt
+
+import frappe
+from frappe.tests.utils import FrappeTestCase
+
+from erpnext.selling.doctype.sales_order.test_sales_order import make_sales_order
+from erpnext.stock.doctype.item.test_item import make_item
+from erpnext.stock.report.item_shortage_report.item_shortage_report import (
+ execute as item_shortage_report,
+)
+
+
+class TestItemShortageReport(FrappeTestCase):
+ def test_item_shortage_report(self):
+ item = make_item().name
+ so = make_sales_order(item_code=item)
+
+ reserved_qty, projected_qty = frappe.db.get_value(
+ "Bin",
+ {
+ "item_code": item,
+ "warehouse": so.items[0].warehouse,
+ },
+ ["reserved_qty", "projected_qty"],
+ )
+ self.assertEqual(reserved_qty, so.items[0].qty)
+ self.assertEqual(projected_qty, -(so.items[0].qty))
+
+ filters = {
+ "company": so.company,
+ }
+ report_data = item_shortage_report(filters)[1]
+ item_code_list = [row.get("item_code") for row in report_data]
+ self.assertIn(item, item_code_list)
+
+ filters = {
+ "company": so.company,
+ "warehouse": [so.items[0].warehouse],
+ }
+ report_data = item_shortage_report(filters)[1]
+ item_code_list = [row.get("item_code") for row in report_data]
+ self.assertIn(item, item_code_list)
+
+ filters = {
+ "company": so.company,
+ "warehouse": ["Work In Progress - _TC"],
+ }
+ report_data = item_shortage_report(filters)[1]
+ item_code_list = [row.get("item_code") for row in report_data]
+ self.assertNotIn(item, item_code_list)
diff --git a/erpnext/stock/report/item_variant_details/item_variant_details.py b/erpnext/stock/report/item_variant_details/item_variant_details.py
index 10cef70215b..d1bf2203f17 100644
--- a/erpnext/stock/report/item_variant_details/item_variant_details.py
+++ b/erpnext/stock/report/item_variant_details/item_variant_details.py
@@ -11,25 +11,21 @@ def execute(filters=None):
data = get_data(filters.item)
return columns, data
+
def get_data(item):
if not item:
return []
item_dicts = []
variant_results = frappe.db.get_all(
- "Item",
- fields=["name"],
- filters={
- "variant_of": ["=", item],
- "disabled": 0
- }
+ "Item", fields=["name"], filters={"variant_of": ["=", item], "disabled": 0}
)
if not variant_results:
frappe.msgprint(_("There aren't any item variants for the selected item"))
return []
else:
- variant_list = [variant['name'] for variant in variant_results]
+ variant_list = [variant["name"] for variant in variant_results]
order_count_map = get_open_sales_orders_count(variant_list)
stock_details_map = get_stock_details_map(variant_list)
@@ -40,15 +36,13 @@ def get_data(item):
attributes = frappe.db.get_all(
"Item Variant Attribute",
fields=["attribute"],
- filters={
- "parent": ["in", variant_list]
- },
- group_by="attribute"
+ filters={"parent": ["in", variant_list]},
+ group_by="attribute",
)
attribute_list = [row.get("attribute") for row in attributes]
# Prepare dicts
- variant_dicts = [{"variant_name": d['name']} for d in variant_results]
+ variant_dicts = [{"variant_name": d["name"]} for d in variant_results]
for item_dict in variant_dicts:
name = item_dict.get("variant_name")
@@ -72,73 +66,66 @@ def get_data(item):
return item_dicts
+
def get_columns(item):
- columns = [{
- "fieldname": "variant_name",
- "label": "Variant",
- "fieldtype": "Link",
- "options": "Item",
- "width": 200
- }]
+ columns = [
+ {
+ "fieldname": "variant_name",
+ "label": "Variant",
+ "fieldtype": "Link",
+ "options": "Item",
+ "width": 200,
+ }
+ ]
item_doc = frappe.get_doc("Item", item)
for entry in item_doc.attributes:
- columns.append({
- "fieldname": frappe.scrub(entry.attribute),
- "label": entry.attribute,
- "fieldtype": "Data",
- "width": 100
- })
+ columns.append(
+ {
+ "fieldname": frappe.scrub(entry.attribute),
+ "label": entry.attribute,
+ "fieldtype": "Data",
+ "width": 100,
+ }
+ )
additional_columns = [
{
"fieldname": "avg_buying_price_list_rate",
"label": _("Avg. Buying Price List Rate"),
"fieldtype": "Currency",
- "width": 150
+ "width": 150,
},
{
"fieldname": "avg_selling_price_list_rate",
"label": _("Avg. Selling Price List Rate"),
"fieldtype": "Currency",
- "width": 150
- },
- {
- "fieldname": "current_stock",
- "label": _("Current Stock"),
- "fieldtype": "Float",
- "width": 120
- },
- {
- "fieldname": "in_production",
- "label": _("In Production"),
- "fieldtype": "Float",
- "width": 150
+ "width": 150,
},
+ {"fieldname": "current_stock", "label": _("Current Stock"), "fieldtype": "Float", "width": 120},
+ {"fieldname": "in_production", "label": _("In Production"), "fieldtype": "Float", "width": 150},
{
"fieldname": "open_orders",
"label": _("Open Sales Orders"),
"fieldtype": "Float",
- "width": 150
- }
+ "width": 150,
+ },
]
columns.extend(additional_columns)
return columns
+
def get_open_sales_orders_count(variants_list):
open_sales_orders = frappe.db.get_list(
"Sales Order",
- fields=[
- "name",
- "`tabSales Order Item`.item_code"
- ],
+ fields=["name", "`tabSales Order Item`.item_code"],
filters=[
["Sales Order", "docstatus", "=", 1],
- ["Sales Order Item", "item_code", "in", variants_list]
+ ["Sales Order Item", "item_code", "in", variants_list],
],
- distinct=1
+ distinct=1,
)
order_count_map = {}
@@ -151,6 +138,7 @@ def get_open_sales_orders_count(variants_list):
return order_count_map
+
def get_stock_details_map(variant_list):
stock_details = frappe.db.get_all(
"Bin",
@@ -160,10 +148,8 @@ def get_stock_details_map(variant_list):
"sum(projected_qty) as projected_qty",
"item_code",
],
- filters={
- "item_code": ["in", variant_list]
- },
- group_by="item_code"
+ filters={"item_code": ["in", variant_list]},
+ group_by="item_code",
)
stock_details_map = {}
@@ -171,11 +157,12 @@ def get_stock_details_map(variant_list):
name = row.get("item_code")
stock_details_map[name] = {
"Inventory": row.get("actual_qty"),
- "In Production": row.get("planned_qty")
+ "In Production": row.get("planned_qty"),
}
return stock_details_map
+
def get_buying_price_map(variant_list):
buying = frappe.db.get_all(
"Item Price",
@@ -183,11 +170,8 @@ def get_buying_price_map(variant_list):
"avg(price_list_rate) as avg_rate",
"item_code",
],
- filters={
- "item_code": ["in", variant_list],
- "buying": 1
- },
- group_by="item_code"
+ filters={"item_code": ["in", variant_list], "buying": 1},
+ group_by="item_code",
)
buying_price_map = {}
@@ -196,6 +180,7 @@ def get_buying_price_map(variant_list):
return buying_price_map
+
def get_selling_price_map(variant_list):
selling = frappe.db.get_all(
"Item Price",
@@ -203,11 +188,8 @@ def get_selling_price_map(variant_list):
"avg(price_list_rate) as avg_rate",
"item_code",
],
- filters={
- "item_code": ["in", variant_list],
- "selling": 1
- },
- group_by="item_code"
+ filters={"item_code": ["in", variant_list], "selling": 1},
+ group_by="item_code",
)
selling_price_map = {}
@@ -216,17 +198,12 @@ def get_selling_price_map(variant_list):
return selling_price_map
+
def get_attribute_values_map(variant_list):
attribute_list = frappe.db.get_all(
"Item Variant Attribute",
- fields=[
- "attribute",
- "attribute_value",
- "parent"
- ],
- filters={
- "parent": ["in", variant_list]
- }
+ fields=["attribute", "attribute_value", "parent"],
+ filters={"parent": ["in", variant_list]},
)
attr_val_map = {}
diff --git a/erpnext/stock/report/itemwise_recommended_reorder_level/itemwise_recommended_reorder_level.py b/erpnext/stock/report/itemwise_recommended_reorder_level/itemwise_recommended_reorder_level.py
index 314f1608fa1..f308e9e41f1 100644
--- a/erpnext/stock/report/itemwise_recommended_reorder_level/itemwise_recommended_reorder_level.py
+++ b/erpnext/stock/report/itemwise_recommended_reorder_level/itemwise_recommended_reorder_level.py
@@ -7,13 +7,14 @@ from frappe.utils import flt, getdate
def execute(filters=None):
- if not filters: filters = {}
+ if not filters:
+ filters = {}
float_precision = frappe.db.get_default("float_precision")
condition = get_condition(filters)
avg_daily_outgoing = 0
- diff = ((getdate(filters.get("to_date")) - getdate(filters.get("from_date"))).days)+1
+ diff = ((getdate(filters.get("to_date")) - getdate(filters.get("from_date"))).days) + 1
if diff <= 0:
frappe.throw(_("'From Date' must be after 'To Date'"))
@@ -24,41 +25,72 @@ def execute(filters=None):
data = []
for item in items:
- total_outgoing = flt(consumed_item_map.get(item.name, 0)) + flt(delivered_item_map.get(item.name,0))
+ total_outgoing = flt(consumed_item_map.get(item.name, 0)) + flt(
+ delivered_item_map.get(item.name, 0)
+ )
avg_daily_outgoing = flt(total_outgoing / diff, float_precision)
reorder_level = (avg_daily_outgoing * flt(item.lead_time_days)) + flt(item.safety_stock)
- data.append([item.name, item.item_name, item.item_group, item.brand, item.description,
- item.safety_stock, item.lead_time_days, consumed_item_map.get(item.name, 0),
- delivered_item_map.get(item.name,0), total_outgoing, avg_daily_outgoing, reorder_level])
+ data.append(
+ [
+ item.name,
+ item.item_name,
+ item.item_group,
+ item.brand,
+ item.description,
+ item.safety_stock,
+ item.lead_time_days,
+ consumed_item_map.get(item.name, 0),
+ delivered_item_map.get(item.name, 0),
+ total_outgoing,
+ avg_daily_outgoing,
+ reorder_level,
+ ]
+ )
+
+ return columns, data
- return columns , data
def get_columns():
- return[
- _("Item") + ":Link/Item:120", _("Item Name") + ":Data:120", _("Item Group") + ":Link/Item Group:100",
- _("Brand") + ":Link/Brand:100", _("Description") + "::160",
- _("Safety Stock") + ":Float:160", _("Lead Time Days") + ":Float:120", _("Consumed") + ":Float:120",
- _("Delivered") + ":Float:120", _("Total Outgoing") + ":Float:120", _("Avg Daily Outgoing") + ":Float:160",
- _("Reorder Level") + ":Float:120"
+ return [
+ _("Item") + ":Link/Item:120",
+ _("Item Name") + ":Data:120",
+ _("Item Group") + ":Link/Item Group:100",
+ _("Brand") + ":Link/Brand:100",
+ _("Description") + "::160",
+ _("Safety Stock") + ":Float:160",
+ _("Lead Time Days") + ":Float:120",
+ _("Consumed") + ":Float:120",
+ _("Delivered") + ":Float:120",
+ _("Total Outgoing") + ":Float:120",
+ _("Avg Daily Outgoing") + ":Float:160",
+ _("Reorder Level") + ":Float:120",
]
+
def get_item_info(filters):
from erpnext.stock.report.stock_ledger.stock_ledger import get_item_group_condition
+
conditions = [get_item_group_condition(filters.get("item_group"))]
if filters.get("brand"):
conditions.append("item.brand=%(brand)s")
+ conditions.append("is_stock_item = 1")
- return frappe.db.sql("""select name, item_name, description, brand, item_group,
- safety_stock, lead_time_days from `tabItem` item where {}"""
- .format(" and ".join(conditions)), filters, as_dict=1)
+ return frappe.db.sql(
+ """select name, item_name, description, brand, item_group,
+ safety_stock, lead_time_days from `tabItem` item where {}""".format(
+ " and ".join(conditions)
+ ),
+ filters,
+ as_dict=1,
+ )
def get_consumed_items(condition):
purpose_to_exclude = [
"Material Transfer for Manufacture",
"Material Transfer",
- "Send to Subcontractor"
+ "Send to Subcontractor",
]
condition += """
@@ -66,33 +98,49 @@ def get_consumed_items(condition):
purpose is NULL
or purpose not in ({})
)
- """.format(', '.join(f"'{p}'" for p in purpose_to_exclude))
+ """.format(
+ ", ".join(f"'{p}'" for p in purpose_to_exclude)
+ )
condition = condition.replace("posting_date", "sle.posting_date")
- consumed_items = frappe.db.sql("""
+ consumed_items = frappe.db.sql(
+ """
select item_code, abs(sum(actual_qty)) as consumed_qty
from `tabStock Ledger Entry` as sle left join `tabStock Entry` as se
on sle.voucher_no = se.name
where
actual_qty < 0
+ and is_cancelled = 0
and voucher_type not in ('Delivery Note', 'Sales Invoice')
%s
- group by item_code""" % condition, as_dict=1)
+ group by item_code"""
+ % condition,
+ as_dict=1,
+ )
- consumed_items_map = {item.item_code : item.consumed_qty for item in consumed_items}
+ consumed_items_map = {item.item_code: item.consumed_qty for item in consumed_items}
return consumed_items_map
+
def get_delivered_items(condition):
- dn_items = frappe.db.sql("""select dn_item.item_code, sum(dn_item.stock_qty) as dn_qty
+ dn_items = frappe.db.sql(
+ """select dn_item.item_code, sum(dn_item.stock_qty) as dn_qty
from `tabDelivery Note` dn, `tabDelivery Note Item` dn_item
where dn.name = dn_item.parent and dn.docstatus = 1 %s
- group by dn_item.item_code""" % (condition), as_dict=1)
+ group by dn_item.item_code"""
+ % (condition),
+ as_dict=1,
+ )
- si_items = frappe.db.sql("""select si_item.item_code, sum(si_item.stock_qty) as si_qty
+ si_items = frappe.db.sql(
+ """select si_item.item_code, sum(si_item.stock_qty) as si_qty
from `tabSales Invoice` si, `tabSales Invoice Item` si_item
where si.name = si_item.parent and si.docstatus = 1 and
si.update_stock = 1 %s
- group by si_item.item_code""" % (condition), as_dict=1)
+ group by si_item.item_code"""
+ % (condition),
+ as_dict=1,
+ )
dn_item_map = {}
for item in dn_items:
@@ -103,10 +151,14 @@ def get_delivered_items(condition):
return dn_item_map
+
def get_condition(filters):
conditions = ""
if filters.get("from_date") and filters.get("to_date"):
- conditions += " and posting_date between '%s' and '%s'" % (filters["from_date"],filters["to_date"])
+ conditions += " and posting_date between '%s' and '%s'" % (
+ filters["from_date"],
+ filters["to_date"],
+ )
else:
frappe.throw(_("From and To dates required"))
return conditions
diff --git a/erpnext/stock/report/product_bundle_balance/product_bundle_balance.py b/erpnext/stock/report/product_bundle_balance/product_bundle_balance.py
index 3c4dbce73a6..88b29e60130 100644
--- a/erpnext/stock/report/product_bundle_balance/product_bundle_balance.py
+++ b/erpnext/stock/report/product_bundle_balance/product_bundle_balance.py
@@ -45,7 +45,9 @@ def execute(filters=None):
child_rows = []
for child_item_detail in required_items:
- child_item_balance = stock_balance.get(child_item_detail.item_code, frappe._dict()).get(warehouse, frappe._dict())
+ child_item_balance = stock_balance.get(child_item_detail.item_code, frappe._dict()).get(
+ warehouse, frappe._dict()
+ )
child_row = {
"indent": 1,
"parent_item": parent_item,
@@ -74,16 +76,46 @@ def execute(filters=None):
def get_columns():
columns = [
- {"fieldname": "item_code", "label": _("Item"), "fieldtype": "Link", "options": "Item", "width": 300},
- {"fieldname": "warehouse", "label": _("Warehouse"), "fieldtype": "Link", "options": "Warehouse", "width": 100},
+ {
+ "fieldname": "item_code",
+ "label": _("Item"),
+ "fieldtype": "Link",
+ "options": "Item",
+ "width": 300,
+ },
+ {
+ "fieldname": "warehouse",
+ "label": _("Warehouse"),
+ "fieldtype": "Link",
+ "options": "Warehouse",
+ "width": 100,
+ },
{"fieldname": "uom", "label": _("UOM"), "fieldtype": "Link", "options": "UOM", "width": 70},
{"fieldname": "bundle_qty", "label": _("Bundle Qty"), "fieldtype": "Float", "width": 100},
{"fieldname": "actual_qty", "label": _("Actual Qty"), "fieldtype": "Float", "width": 100},
{"fieldname": "minimum_qty", "label": _("Minimum Qty"), "fieldtype": "Float", "width": 100},
- {"fieldname": "item_group", "label": _("Item Group"), "fieldtype": "Link", "options": "Item Group", "width": 100},
- {"fieldname": "brand", "label": _("Brand"), "fieldtype": "Link", "options": "Brand", "width": 100},
+ {
+ "fieldname": "item_group",
+ "label": _("Item Group"),
+ "fieldtype": "Link",
+ "options": "Item Group",
+ "width": 100,
+ },
+ {
+ "fieldname": "brand",
+ "label": _("Brand"),
+ "fieldtype": "Link",
+ "options": "Brand",
+ "width": 100,
+ },
{"fieldname": "description", "label": _("Description"), "width": 140},
- {"fieldname": "company", "label": _("Company"), "fieldtype": "Link", "options": "Company", "width": 100}
+ {
+ "fieldname": "company",
+ "label": _("Company"),
+ "fieldtype": "Link",
+ "options": "Company",
+ "width": 100,
+ },
]
return columns
@@ -93,12 +125,18 @@ def get_items(filters):
item_details = frappe._dict()
conditions = get_parent_item_conditions(filters)
- parent_item_details = frappe.db.sql("""
+ parent_item_details = frappe.db.sql(
+ """
select item.name as item_code, item.item_name, pb.description, item.item_group, item.brand, item.stock_uom
from `tabItem` item
inner join `tabProduct Bundle` pb on pb.new_item_code = item.name
where ifnull(item.disabled, 0) = 0 {0}
- """.format(conditions), filters, as_dict=1) # nosec
+ """.format(
+ conditions
+ ),
+ filters,
+ as_dict=1,
+ ) # nosec
parent_items = []
for d in parent_item_details:
@@ -106,7 +144,8 @@ def get_items(filters):
item_details[d.item_code] = d
if parent_items:
- child_item_details = frappe.db.sql("""
+ child_item_details = frappe.db.sql(
+ """
select
pb.new_item_code as parent_item, pbi.item_code, item.item_name, pbi.description, item.item_group, item.brand,
item.stock_uom, pbi.uom, pbi.qty
@@ -114,7 +153,12 @@ def get_items(filters):
inner join `tabProduct Bundle` pb on pb.name = pbi.parent
inner join `tabItem` item on item.name = pbi.item_code
where pb.new_item_code in ({0})
- """.format(", ".join(["%s"] * len(parent_items))), parent_items, as_dict=1) # nosec
+ """.format(
+ ", ".join(["%s"] * len(parent_items))
+ ),
+ parent_items,
+ as_dict=1,
+ ) # nosec
else:
child_item_details = []
@@ -141,12 +185,14 @@ def get_stock_ledger_entries(filters, items):
if not items:
return []
- item_conditions_sql = ' and sle.item_code in ({})' \
- .format(', '.join(frappe.db.escape(i) for i in items))
+ item_conditions_sql = " and sle.item_code in ({})".format(
+ ", ".join(frappe.db.escape(i) for i in items)
+ )
conditions = get_sle_conditions(filters)
- return frappe.db.sql("""
+ return frappe.db.sql(
+ """
select
sle.item_code, sle.warehouse, sle.qty_after_transaction, sle.company
from
@@ -154,7 +200,10 @@ def get_stock_ledger_entries(filters, items):
left join `tabStock Ledger Entry` sle2 on
sle.item_code = sle2.item_code and sle.warehouse = sle2.warehouse
and (sle.posting_date, sle.posting_time, sle.name) < (sle2.posting_date, sle2.posting_time, sle2.name)
- where sle2.name is null and sle.docstatus < 2 %s %s""" % (item_conditions_sql, conditions), as_dict=1) # nosec
+ where sle2.name is null and sle.docstatus < 2 %s %s"""
+ % (item_conditions_sql, conditions),
+ as_dict=1,
+ ) # nosec
def get_parent_item_conditions(filters):
@@ -180,9 +229,14 @@ def get_sle_conditions(filters):
conditions += " and sle.posting_date <= %s" % frappe.db.escape(filters.get("date"))
if filters.get("warehouse"):
- warehouse_details = frappe.db.get_value("Warehouse", filters.get("warehouse"), ["lft", "rgt"], as_dict=1)
+ warehouse_details = frappe.db.get_value(
+ "Warehouse", filters.get("warehouse"), ["lft", "rgt"], as_dict=1
+ )
if warehouse_details:
- conditions += " and exists (select name from `tabWarehouse` wh \
- where wh.lft >= %s and wh.rgt <= %s and sle.warehouse = wh.name)" % (warehouse_details.lft, warehouse_details.rgt) # nosec
+ conditions += (
+ " and exists (select name from `tabWarehouse` wh \
+ where wh.lft >= %s and wh.rgt <= %s and sle.warehouse = wh.name)"
+ % (warehouse_details.lft, warehouse_details.rgt)
+ ) # nosec
return conditions
diff --git a/erpnext/stock/report/purchase_receipt_trends/purchase_receipt_trends.py b/erpnext/stock/report/purchase_receipt_trends/purchase_receipt_trends.py
index 97384427fa4..fe2d55a3913 100644
--- a/erpnext/stock/report/purchase_receipt_trends/purchase_receipt_trends.py
+++ b/erpnext/stock/report/purchase_receipt_trends/purchase_receipt_trends.py
@@ -8,7 +8,8 @@ from erpnext.controllers.trends import get_columns, get_data
def execute(filters=None):
- if not filters: filters ={}
+ if not filters:
+ filters = {}
data = []
conditions = get_columns(filters, "Purchase Receipt")
data = get_data(filters, conditions)
@@ -17,6 +18,7 @@ def execute(filters=None):
return conditions["columns"], data, None, chart_data
+
def get_chart_data(data, filters):
if not data:
return []
@@ -27,7 +29,7 @@ def get_chart_data(data, filters):
# consider only consolidated row
data = [row for row in data if row[0]]
- data = sorted(data, key = lambda i: i[-1], reverse=True)
+ data = sorted(data, key=lambda i: i[-1], reverse=True)
if len(data) > 10:
# get top 10 if data too long
@@ -39,14 +41,9 @@ def get_chart_data(data, filters):
return {
"data": {
- "labels" : labels,
- "datasets" : [
- {
- "name": _("Total Received Amount"),
- "values": datapoints
- }
- ]
+ "labels": labels,
+ "datasets": [{"name": _("Total Received Amount"), "values": datapoints}],
},
- "type" : "bar",
- "colors":["#5e64ff"]
+ "type": "bar",
+ "colors": ["#5e64ff"],
}
diff --git a/erpnext/stock/report/serial_no_ledger/serial_no_ledger.py b/erpnext/stock/report/serial_no_ledger/serial_no_ledger.py
index 80ec848e5b6..e439f51dd69 100644
--- a/erpnext/stock/report/serial_no_ledger/serial_no_ledger.py
+++ b/erpnext/stock/report/serial_no_ledger/serial_no_ledger.py
@@ -12,42 +12,43 @@ def execute(filters=None):
data = get_data(filters)
return columns, data
+
def get_columns(filters):
- columns = [{
- 'label': _('Posting Date'),
- 'fieldtype': 'Date',
- 'fieldname': 'posting_date'
- }, {
- 'label': _('Posting Time'),
- 'fieldtype': 'Time',
- 'fieldname': 'posting_time'
- }, {
- 'label': _('Voucher Type'),
- 'fieldtype': 'Link',
- 'fieldname': 'voucher_type',
- 'options': 'DocType',
- 'width': 220
- }, {
- 'label': _('Voucher No'),
- 'fieldtype': 'Dynamic Link',
- 'fieldname': 'voucher_no',
- 'options': 'voucher_type',
- 'width': 220
- }, {
- 'label': _('Company'),
- 'fieldtype': 'Link',
- 'fieldname': 'company',
- 'options': 'Company',
- 'width': 220
- }, {
- 'label': _('Warehouse'),
- 'fieldtype': 'Link',
- 'fieldname': 'warehouse',
- 'options': 'Warehouse',
- 'width': 220
- }]
+ columns = [
+ {"label": _("Posting Date"), "fieldtype": "Date", "fieldname": "posting_date"},
+ {"label": _("Posting Time"), "fieldtype": "Time", "fieldname": "posting_time"},
+ {
+ "label": _("Voucher Type"),
+ "fieldtype": "Link",
+ "fieldname": "voucher_type",
+ "options": "DocType",
+ "width": 220,
+ },
+ {
+ "label": _("Voucher No"),
+ "fieldtype": "Dynamic Link",
+ "fieldname": "voucher_no",
+ "options": "voucher_type",
+ "width": 220,
+ },
+ {
+ "label": _("Company"),
+ "fieldtype": "Link",
+ "fieldname": "company",
+ "options": "Company",
+ "width": 220,
+ },
+ {
+ "label": _("Warehouse"),
+ "fieldtype": "Link",
+ "fieldname": "warehouse",
+ "options": "Warehouse",
+ "width": 220,
+ },
+ ]
return columns
+
def get_data(filters):
- return get_stock_ledger_entries(filters, '<=', order="asc") or []
+ return get_stock_ledger_entries(filters, "<=", order="asc") or []
diff --git a/erpnext/stock/report/stock_ageing/stock_ageing.py b/erpnext/stock/report/stock_ageing/stock_ageing.py
index 1209be21eda..7c430e491ab 100644
--- a/erpnext/stock/report/stock_ageing/stock_ageing.py
+++ b/erpnext/stock/report/stock_ageing/stock_ageing.py
@@ -3,52 +3,78 @@
from operator import itemgetter
+from typing import Dict, List, Tuple, Union
import frappe
from frappe import _
from frappe.utils import cint, date_diff, flt
-from six import iteritems
from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
+Filters = frappe._dict
-def execute(filters=None):
- columns = get_columns(filters)
- item_details = get_fifo_queue(filters)
+
+def execute(filters: Filters = None) -> Tuple:
to_date = filters["to_date"]
+ columns = get_columns(filters)
+
+ item_details = FIFOSlots(filters).generate()
+ data = format_report_data(filters, item_details, to_date)
+
+ chart_data = get_chart_data(data, filters)
+
+ return columns, data, None, chart_data
+
+
+def format_report_data(filters: Filters, item_details: Dict, to_date: str) -> List[Dict]:
+ "Returns ordered, formatted data with ranges."
_func = itemgetter(1)
-
data = []
- for item, item_dict in iteritems(item_details):
- earliest_age, latest_age = 0, 0
- fifo_queue = sorted(filter(_func, item_dict["fifo_queue"]), key=_func)
+ precision = cint(frappe.db.get_single_value("System Settings", "float_precision", cache=True))
+
+ for item, item_dict in item_details.items():
+ if not flt(item_dict.get("total_qty"), precision):
+ continue
+
+ earliest_age, latest_age = 0, 0
details = item_dict["details"]
- if not fifo_queue: continue
+ fifo_queue = sorted(filter(_func, item_dict["fifo_queue"]), key=_func)
+
+ if not fifo_queue:
+ continue
average_age = get_average_age(fifo_queue, to_date)
earliest_age = date_diff(to_date, fifo_queue[0][1])
latest_age = date_diff(to_date, fifo_queue[-1][1])
range1, range2, range3, above_range3 = get_range_age(filters, fifo_queue, to_date, item_dict)
- row = [details.name, details.item_name,
- details.description, details.item_group, details.brand]
+ row = [details.name, details.item_name, details.description, details.item_group, details.brand]
if filters.get("show_warehouse_wise_stock"):
row.append(details.warehouse)
- row.extend([item_dict.get("total_qty"), average_age,
- range1, range2, range3, above_range3,
- earliest_age, latest_age, details.stock_uom])
+ row.extend(
+ [
+ flt(item_dict.get("total_qty"), precision),
+ average_age,
+ range1,
+ range2,
+ range3,
+ above_range3,
+ earliest_age,
+ latest_age,
+ details.stock_uom,
+ ]
+ )
data.append(row)
- chart_data = get_chart_data(data, filters)
+ return data
- return columns, data, None, chart_data
-def get_average_age(fifo_queue, to_date):
+def get_average_age(fifo_queue: List, to_date: str) -> float:
batch_age = age_qty = total_qty = 0.0
for batch in fifo_queue:
batch_age = date_diff(to_date, batch[1])
@@ -62,7 +88,11 @@ def get_average_age(fifo_queue, to_date):
return flt(age_qty / total_qty, 2) if total_qty else 0.0
-def get_range_age(filters, fifo_queue, to_date, item_dict):
+
+def get_range_age(filters: Filters, fifo_queue: List, to_date: str, item_dict: Dict) -> Tuple:
+
+ precision = cint(frappe.db.get_single_value("System Settings", "float_precision", cache=True))
+
range1 = range2 = range3 = above_range3 = 0.0
for item in fifo_queue:
@@ -70,17 +100,18 @@ def get_range_age(filters, fifo_queue, to_date, item_dict):
qty = flt(item[0]) if not item_dict["has_serial_no"] else 1.0
if age <= filters.range1:
- range1 += qty
+ range1 = flt(range1 + qty, precision)
elif age <= filters.range2:
- range2 += qty
+ range2 = flt(range2 + qty, precision)
elif age <= filters.range3:
- range3 += qty
+ range3 = flt(range3 + qty, precision)
else:
- above_range3 += qty
+ above_range3 = flt(above_range3 + qty, precision)
return range1, range2, range3, above_range3
-def get_columns(filters):
+
+def get_columns(filters: Filters) -> List[Dict]:
range_columns = []
setup_ageing_columns(filters, range_columns)
columns = [
@@ -89,182 +120,56 @@ def get_columns(filters):
"fieldname": "item_code",
"fieldtype": "Link",
"options": "Item",
- "width": 100
- },
- {
- "label": _("Item Name"),
- "fieldname": "item_name",
- "fieldtype": "Data",
- "width": 100
- },
- {
- "label": _("Description"),
- "fieldname": "description",
- "fieldtype": "Data",
- "width": 200
+ "width": 100,
},
+ {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 100},
+ {"label": _("Description"), "fieldname": "description", "fieldtype": "Data", "width": 200},
{
"label": _("Item Group"),
"fieldname": "item_group",
"fieldtype": "Link",
"options": "Item Group",
- "width": 100
+ "width": 100,
},
{
"label": _("Brand"),
"fieldname": "brand",
"fieldtype": "Link",
"options": "Brand",
- "width": 100
- }]
+ "width": 100,
+ },
+ ]
if filters.get("show_warehouse_wise_stock"):
- columns +=[{
- "label": _("Warehouse"),
- "fieldname": "warehouse",
- "fieldtype": "Link",
- "options": "Warehouse",
- "width": 100
- }]
+ columns += [
+ {
+ "label": _("Warehouse"),
+ "fieldname": "warehouse",
+ "fieldtype": "Link",
+ "options": "Warehouse",
+ "width": 100,
+ }
+ ]
- columns.extend([
- {
- "label": _("Available Qty"),
- "fieldname": "qty",
- "fieldtype": "Float",
- "width": 100
- },
- {
- "label": _("Average Age"),
- "fieldname": "average_age",
- "fieldtype": "Float",
- "width": 100
- }])
+ columns.extend(
+ [
+ {"label": _("Available Qty"), "fieldname": "qty", "fieldtype": "Float", "width": 100},
+ {"label": _("Average Age"), "fieldname": "average_age", "fieldtype": "Float", "width": 100},
+ ]
+ )
columns.extend(range_columns)
- columns.extend([
- {
- "label": _("Earliest"),
- "fieldname": "earliest",
- "fieldtype": "Int",
- "width": 80
- },
- {
- "label": _("Latest"),
- "fieldname": "latest",
- "fieldtype": "Int",
- "width": 80
- },
- {
- "label": _("UOM"),
- "fieldname": "uom",
- "fieldtype": "Link",
- "options": "UOM",
- "width": 100
- }
- ])
+ columns.extend(
+ [
+ {"label": _("Earliest"), "fieldname": "earliest", "fieldtype": "Int", "width": 80},
+ {"label": _("Latest"), "fieldname": "latest", "fieldtype": "Int", "width": 80},
+ {"label": _("UOM"), "fieldname": "uom", "fieldtype": "Link", "options": "UOM", "width": 100},
+ ]
+ )
return columns
-def get_fifo_queue(filters, sle=None):
- item_details = {}
- transferred_item_details = {}
- serial_no_batch_purchase_details = {}
- if sle == None:
- sle = get_stock_ledger_entries(filters)
-
- for d in sle:
- key = (d.name, d.warehouse) if filters.get('show_warehouse_wise_stock') else d.name
- item_details.setdefault(key, {"details": d, "fifo_queue": []})
- fifo_queue = item_details[key]["fifo_queue"]
-
- transferred_item_key = (d.voucher_no, d.name, d.warehouse)
- transferred_item_details.setdefault(transferred_item_key, [])
-
- if d.voucher_type == "Stock Reconciliation":
- d.actual_qty = flt(d.qty_after_transaction) - flt(item_details[key].get("qty_after_transaction", 0))
-
- serial_no_list = get_serial_nos(d.serial_no) if d.serial_no else []
-
- if d.actual_qty > 0:
- if transferred_item_details.get(transferred_item_key):
- batch = transferred_item_details[transferred_item_key][0]
- fifo_queue.append(batch)
- transferred_item_details[transferred_item_key].pop(0)
- else:
- if serial_no_list:
- for serial_no in serial_no_list:
- if serial_no_batch_purchase_details.get(serial_no):
- fifo_queue.append([serial_no, serial_no_batch_purchase_details.get(serial_no)])
- else:
- serial_no_batch_purchase_details.setdefault(serial_no, d.posting_date)
- fifo_queue.append([serial_no, d.posting_date])
- else:
- fifo_queue.append([d.actual_qty, d.posting_date])
- else:
- if serial_no_list:
- fifo_queue[:] = [serial_no for serial_no in fifo_queue if serial_no[0] not in serial_no_list]
- else:
- qty_to_pop = abs(d.actual_qty)
- while qty_to_pop:
- batch = fifo_queue[0] if fifo_queue else [0, None]
- if 0 < flt(batch[0]) <= qty_to_pop:
- # if batch qty > 0
- # not enough or exactly same qty in current batch, clear batch
- qty_to_pop -= flt(batch[0])
- transferred_item_details[transferred_item_key].append(fifo_queue.pop(0))
- else:
- # all from current batch
- batch[0] = flt(batch[0]) - qty_to_pop
- transferred_item_details[transferred_item_key].append([qty_to_pop, batch[1]])
- qty_to_pop = 0
-
- item_details[key]["qty_after_transaction"] = d.qty_after_transaction
-
- if "total_qty" not in item_details[key]:
- item_details[key]["total_qty"] = d.actual_qty
- else:
- item_details[key]["total_qty"] += d.actual_qty
-
- item_details[key]["has_serial_no"] = d.has_serial_no
-
- return item_details
-
-def get_stock_ledger_entries(filters):
- return frappe.db.sql("""select
- item.name, item.item_name, item_group, brand, description, item.stock_uom, item.has_serial_no,
- actual_qty, posting_date, voucher_type, voucher_no, serial_no, batch_no, qty_after_transaction, warehouse
- from `tabStock Ledger Entry` sle,
- (select name, item_name, description, stock_uom, brand, item_group, has_serial_no
- from `tabItem` {item_conditions}) item
- where item_code = item.name and
- company = %(company)s and
- posting_date <= %(to_date)s and
- is_cancelled != 1
- {sle_conditions}
- order by posting_date, posting_time, sle.creation, actual_qty""" #nosec
- .format(item_conditions=get_item_conditions(filters),
- sle_conditions=get_sle_conditions(filters)), filters, as_dict=True)
-
-def get_item_conditions(filters):
- conditions = []
- if filters.get("item_code"):
- conditions.append("item_code=%(item_code)s")
- if filters.get("brand"):
- conditions.append("brand=%(brand)s")
-
- return "where {}".format(" and ".join(conditions)) if conditions else ""
-
-def get_sle_conditions(filters):
- conditions = []
- if filters.get("warehouse"):
- lft, rgt = frappe.db.get_value('Warehouse', filters.get("warehouse"), ['lft', 'rgt'])
- conditions.append("""warehouse in (select wh.name from `tabWarehouse` wh
- where wh.lft >= {0} and rgt <= {1})""".format(lft, rgt))
-
- return "and {}".format(" and ".join(conditions)) if conditions else ""
-
-def get_chart_data(data, filters):
+def get_chart_data(data: List, filters: Filters) -> Dict:
if not data:
return []
@@ -273,7 +178,7 @@ def get_chart_data(data, filters):
if filters.get("show_warehouse_wise_stock"):
return {}
- data.sort(key = lambda row: row[6], reverse=True)
+ data.sort(key=lambda row: row[6], reverse=True)
if len(data) > 10:
data = data[:10]
@@ -283,29 +188,263 @@ def get_chart_data(data, filters):
datapoints.append(row[6])
return {
- "data" : {
- "labels": labels,
- "datasets": [
- {
- "name": _("Average Age"),
- "values": datapoints
- }
- ]
- },
- "type" : "bar"
+ "data": {"labels": labels, "datasets": [{"name": _("Average Age"), "values": datapoints}]},
+ "type": "bar",
}
-def setup_ageing_columns(filters, range_columns):
- for i, label in enumerate(["0-{range1}".format(range1=filters["range1"]),
- "{range1}-{range2}".format(range1=cint(filters["range1"])+ 1, range2=filters["range2"]),
- "{range2}-{range3}".format(range2=cint(filters["range2"])+ 1, range3=filters["range3"]),
- "{range3}-{above}".format(range3=cint(filters["range3"])+ 1, above=_("Above"))]):
- add_column(range_columns, label="Age ("+ label +")", fieldname='range' + str(i+1))
-def add_column(range_columns, label, fieldname, fieldtype='Float', width=140):
- range_columns.append(dict(
- label=label,
- fieldname=fieldname,
- fieldtype=fieldtype,
- width=width
- ))
+def setup_ageing_columns(filters: Filters, range_columns: List):
+ ranges = [
+ f"0 - {filters['range1']}",
+ f"{cint(filters['range1']) + 1} - {cint(filters['range2'])}",
+ f"{cint(filters['range2']) + 1} - {cint(filters['range3'])}",
+ f"{cint(filters['range3']) + 1} - {_('Above')}",
+ ]
+ for i, label in enumerate(ranges):
+ fieldname = "range" + str(i + 1)
+ add_column(range_columns, label=f"Age ({label})", fieldname=fieldname)
+
+
+def add_column(
+ range_columns: List, label: str, fieldname: str, fieldtype: str = "Float", width: int = 140
+):
+ range_columns.append(dict(label=label, fieldname=fieldname, fieldtype=fieldtype, width=width))
+
+
+class FIFOSlots:
+ "Returns FIFO computed slots of inwarded stock as per date."
+
+ def __init__(self, filters: Dict = None, sle: List = None):
+ self.item_details = {}
+ self.transferred_item_details = {}
+ self.serial_no_batch_purchase_details = {}
+ self.filters = filters
+ self.sle = sle
+
+ def generate(self) -> Dict:
+ """
+ Returns dict of the foll.g structure:
+ Key = Item A / (Item A, Warehouse A)
+ Key: {
+ 'details' -> Dict: ** item details **,
+ 'fifo_queue' -> List: ** list of lists containing entries/slots for existing stock,
+ consumed/updated and maintained via FIFO. **
+ }
+ """
+ if self.sle is None:
+ self.sle = self.__get_stock_ledger_entries()
+
+ for d in self.sle:
+ key, fifo_queue, transferred_item_key = self.__init_key_stores(d)
+
+ if d.voucher_type == "Stock Reconciliation":
+ # get difference in qty shift as actual qty
+ prev_balance_qty = self.item_details[key].get("qty_after_transaction", 0)
+ d.actual_qty = flt(d.qty_after_transaction) - flt(prev_balance_qty)
+
+ serial_nos = get_serial_nos(d.serial_no) if d.serial_no else []
+
+ if d.actual_qty > 0:
+ self.__compute_incoming_stock(d, fifo_queue, transferred_item_key, serial_nos)
+ else:
+ self.__compute_outgoing_stock(d, fifo_queue, transferred_item_key, serial_nos)
+
+ self.__update_balances(d, key)
+
+ if not self.filters.get("show_warehouse_wise_stock"):
+ # (Item 1, WH 1), (Item 1, WH 2) => (Item 1)
+ self.item_details = self.__aggregate_details_by_item(self.item_details)
+
+ return self.item_details
+
+ def __init_key_stores(self, row: Dict) -> Tuple:
+ "Initialise keys and FIFO Queue."
+
+ key = (row.name, row.warehouse)
+ self.item_details.setdefault(key, {"details": row, "fifo_queue": []})
+ fifo_queue = self.item_details[key]["fifo_queue"]
+
+ transferred_item_key = (row.voucher_no, row.name, row.warehouse)
+ self.transferred_item_details.setdefault(transferred_item_key, [])
+
+ return key, fifo_queue, transferred_item_key
+
+ def __compute_incoming_stock(
+ self, row: Dict, fifo_queue: List, transfer_key: Tuple, serial_nos: List
+ ):
+ "Update FIFO Queue on inward stock."
+
+ transfer_data = self.transferred_item_details.get(transfer_key)
+ if transfer_data:
+ # inward/outward from same voucher, item & warehouse
+ # eg: Repack with same item, Stock reco for batch item
+ # consume transfer data and add stock to fifo queue
+ self.__adjust_incoming_transfer_qty(transfer_data, fifo_queue, row)
+ else:
+ if not serial_nos:
+ if fifo_queue and flt(fifo_queue[0][0]) <= 0:
+ # neutralize 0/negative stock by adding positive stock
+ fifo_queue[0][0] += flt(row.actual_qty)
+ fifo_queue[0][1] = row.posting_date
+ else:
+ fifo_queue.append([flt(row.actual_qty), row.posting_date])
+ return
+
+ for serial_no in serial_nos:
+ if self.serial_no_batch_purchase_details.get(serial_no):
+ fifo_queue.append([serial_no, self.serial_no_batch_purchase_details.get(serial_no)])
+ else:
+ self.serial_no_batch_purchase_details.setdefault(serial_no, row.posting_date)
+ fifo_queue.append([serial_no, row.posting_date])
+
+ def __compute_outgoing_stock(
+ self, row: Dict, fifo_queue: List, transfer_key: Tuple, serial_nos: List
+ ):
+ "Update FIFO Queue on outward stock."
+ if serial_nos:
+ fifo_queue[:] = [serial_no for serial_no in fifo_queue if serial_no[0] not in serial_nos]
+ return
+
+ qty_to_pop = abs(row.actual_qty)
+ while qty_to_pop:
+ slot = fifo_queue[0] if fifo_queue else [0, None]
+ if 0 < flt(slot[0]) <= qty_to_pop:
+ # qty to pop >= slot qty
+ # if +ve and not enough or exactly same balance in current slot, consume whole slot
+ qty_to_pop -= flt(slot[0])
+ self.transferred_item_details[transfer_key].append(fifo_queue.pop(0))
+ elif not fifo_queue:
+ # negative stock, no balance but qty yet to consume
+ fifo_queue.append([-(qty_to_pop), row.posting_date])
+ self.transferred_item_details[transfer_key].append([qty_to_pop, row.posting_date])
+ qty_to_pop = 0
+ else:
+ # qty to pop < slot qty, ample balance
+ # consume actual_qty from first slot
+ slot[0] = flt(slot[0]) - qty_to_pop
+ self.transferred_item_details[transfer_key].append([qty_to_pop, slot[1]])
+ qty_to_pop = 0
+
+ def __adjust_incoming_transfer_qty(self, transfer_data: Dict, fifo_queue: List, row: Dict):
+ "Add previously removed stock back to FIFO Queue."
+ transfer_qty_to_pop = flt(row.actual_qty)
+
+ def add_to_fifo_queue(slot):
+ if fifo_queue and flt(fifo_queue[0][0]) <= 0:
+ # neutralize 0/negative stock by adding positive stock
+ fifo_queue[0][0] += flt(slot[0])
+ fifo_queue[0][1] = slot[1]
+ else:
+ fifo_queue.append(slot)
+
+ while transfer_qty_to_pop:
+ if transfer_data and 0 < transfer_data[0][0] <= transfer_qty_to_pop:
+ # bucket qty is not enough, consume whole
+ transfer_qty_to_pop -= transfer_data[0][0]
+ add_to_fifo_queue(transfer_data.pop(0))
+ elif not transfer_data:
+ # transfer bucket is empty, extra incoming qty
+ add_to_fifo_queue([transfer_qty_to_pop, row.posting_date])
+ transfer_qty_to_pop = 0
+ else:
+ # ample bucket qty to consume
+ transfer_data[0][0] -= transfer_qty_to_pop
+ add_to_fifo_queue([transfer_qty_to_pop, transfer_data[0][1]])
+ transfer_qty_to_pop = 0
+
+ def __update_balances(self, row: Dict, key: Union[Tuple, str]):
+ self.item_details[key]["qty_after_transaction"] = row.qty_after_transaction
+
+ if "total_qty" not in self.item_details[key]:
+ self.item_details[key]["total_qty"] = row.actual_qty
+ else:
+ self.item_details[key]["total_qty"] += row.actual_qty
+
+ self.item_details[key]["has_serial_no"] = row.has_serial_no
+
+ def __aggregate_details_by_item(self, wh_wise_data: Dict) -> Dict:
+ "Aggregate Item-Wh wise data into single Item entry."
+ item_aggregated_data = {}
+ for key, row in wh_wise_data.items():
+ item = key[0]
+ if not item_aggregated_data.get(item):
+ item_aggregated_data.setdefault(
+ item,
+ {"details": frappe._dict(), "fifo_queue": [], "qty_after_transaction": 0.0, "total_qty": 0.0},
+ )
+ item_row = item_aggregated_data.get(item)
+ item_row["details"].update(row["details"])
+ item_row["fifo_queue"].extend(row["fifo_queue"])
+ item_row["qty_after_transaction"] += flt(row["qty_after_transaction"])
+ item_row["total_qty"] += flt(row["total_qty"])
+ item_row["has_serial_no"] = row["has_serial_no"]
+
+ return item_aggregated_data
+
+ def __get_stock_ledger_entries(self) -> List[Dict]:
+ sle = frappe.qb.DocType("Stock Ledger Entry")
+ item = self.__get_item_query() # used as derived table in sle query
+
+ sle_query = (
+ frappe.qb.from_(sle)
+ .from_(item)
+ .select(
+ item.name,
+ item.item_name,
+ item.item_group,
+ item.brand,
+ item.description,
+ item.stock_uom,
+ item.has_serial_no,
+ sle.actual_qty,
+ sle.posting_date,
+ sle.voucher_type,
+ sle.voucher_no,
+ sle.serial_no,
+ sle.batch_no,
+ sle.qty_after_transaction,
+ sle.warehouse,
+ )
+ .where(
+ (sle.item_code == item.name)
+ & (sle.company == self.filters.get("company"))
+ & (sle.posting_date <= self.filters.get("to_date"))
+ & (sle.is_cancelled != 1)
+ )
+ )
+
+ if self.filters.get("warehouse"):
+ sle_query = self.__get_warehouse_conditions(sle, sle_query)
+
+ sle_query = sle_query.orderby(sle.posting_date, sle.posting_time, sle.creation, sle.actual_qty)
+
+ return sle_query.run(as_dict=True)
+
+ def __get_item_query(self) -> str:
+ item_table = frappe.qb.DocType("Item")
+
+ item = frappe.qb.from_("Item").select(
+ "name", "item_name", "description", "stock_uom", "brand", "item_group", "has_serial_no"
+ )
+
+ if self.filters.get("item_code"):
+ item = item.where(item_table.item_code == self.filters.get("item_code"))
+
+ if self.filters.get("brand"):
+ item = item.where(item_table.brand == self.filters.get("brand"))
+
+ return item
+
+ def __get_warehouse_conditions(self, sle, sle_query) -> str:
+ warehouse = frappe.qb.DocType("Warehouse")
+ lft, rgt = frappe.db.get_value("Warehouse", self.filters.get("warehouse"), ["lft", "rgt"])
+
+ warehouse_results = (
+ frappe.qb.from_(warehouse)
+ .select("name")
+ .where((warehouse.lft >= lft) & (warehouse.rgt <= rgt))
+ .run()
+ )
+ warehouse_results = [x[0] for x in warehouse_results]
+
+ return sle_query.where(sle.warehouse.isin(warehouse_results))
diff --git a/erpnext/stock/report/stock_ageing/stock_ageing_fifo_logic.md b/erpnext/stock/report/stock_ageing/stock_ageing_fifo_logic.md
new file mode 100644
index 00000000000..3d759dd9989
--- /dev/null
+++ b/erpnext/stock/report/stock_ageing/stock_ageing_fifo_logic.md
@@ -0,0 +1,109 @@
+### Concept of FIFO Slots
+
+Since we need to know age-wise remaining stock, we maintain all the inward entries as slots. So each time stock comes in, a slot is added for the same.
+
+Eg. For Item A:
+----------------------
+Date | Qty | Queue
+----------------------
+1st | +50 | [[50, 1-12-2021]]
+2nd | +20 | [[50, 1-12-2021], [20, 2-12-2021]]
+----------------------
+
+Now the queue can tell us the total stock and also how old the stock is.
+Here, the balance qty is 70.
+50 qty is (today-the 1st) days old
+20 qty is (today-the 2nd) days old
+
+> Note: We generate FIFO slots warehouse wise as stock reconciliations from different warehouses can cause incorrect values.
+### Calculation of FIFO Slots
+
+#### Case 1: Outward from sufficient balance qty
+----------------------
+Date | Qty | Queue
+----------------------
+1st | +50 | [[50, 1-12-2021]]
+2nd | -20 | [[30, 1-12-2021]]
+2nd | +20 | [[30, 1-12-2021], [20, 2-12-2021]]
+
+Here after the first entry, while issuing 20 qty:
+- **since 20 is lesser than the balance**, **qty_to_pop (20)** is simply consumed from first slot (FIFO consumption)
+- Any inward entry after as usual will get its own slot added to the queue
+
+#### Case 2: Outward from sufficient cumulative (slots) balance qty
+----------------------
+Date | Qty | Queue
+----------------------
+1st | +50 | [[50, 1-12-2021]]
+2nd | +20 | [[50, 1-12-2021], [20, 2-12-2021]]
+2nd | -60 | [[10, 2-12-2021]]
+
+- Consumption happens slot wise. First slot 1 is consumed
+- Since **qty_to_pop (60) is greater than slot 1 qty (50)**, the entire slot is consumed and popped
+- Now the queue is [[20, 2-12-2021]], and **qty_to_pop=10** (remaining qty to pop)
+- It then goes ahead to the next slot and consumes 10 from it
+- Now the queue is [[10, 2-12-2021]]
+
+#### Case 3: Outward from insufficient balance qty
+> This case is possible only if **Allow Negative Stock** was enabled at some point/is enabled.
+
+----------------------
+Date | Qty | Queue
+----------------------
+1st | +50 | [[50, 1-12-2021]]
+2nd | -60 | [[-10, 1-12-2021]]
+
+- Since **qty_to_pop (60)** is more than the balance in slot 1, the entire slot is consumed and popped
+- Now the queue is **empty**, and **qty_to_pop=10** (remaining qty to pop)
+- Since we still have more to consume, we append the balance since 60 is issued from 50 i.e. -10.
+- We register this negative value, since the stock issue has caused the balance to become negative
+
+Now when stock is inwarded:
+- Instead of adding a slot we check if there are any negative balances.
+- If yes, we keep adding positive stock to it until we make the balance positive.
+- Once the balance is positive, the next inward entry will add a new slot in the queue
+
+Eg:
+----------------------
+Date | Qty | Queue
+----------------------
+1st | +50 | [[50, 1-12-2021]]
+2nd | -60 | [[-10, 1-12-2021]]
+3rd | +5 | [[-5, 3-12-2021]]
+4th | +10 | [[5, 4-12-2021]]
+4th | +20 | [[5, 4-12-2021], [20, 4-12-2021]]
+
+### Concept of Transfer Qty Bucket
+In the case of **Repack**, Quantity that comes in, isn't really incoming. It is just new stock repurposed from old stock, due to incoming-outgoing of the same warehouse.
+
+Here, stock is consumed from the FIFO Queue. It is then re-added back to the queue.
+While adding stock back to the queue we need to know how much to add.
+For this we need to keep track of how much was previously consumed.
+Hence we use **Transfer Qty Bucket**.
+
+While re-adding stock, we try to add buckets that were consumed earlier (date intact), to maintain correctness.
+
+#### Case 1: Same Item-Warehouse in Repack
+Eg:
+-------------------------------------------------------------------------------------
+Date | Qty | Voucher | FIFO Queue | Transfer Qty Buckets
+-------------------------------------------------------------------------------------
+1st | +500 | PR | [[500, 1-12-2021]] |
+2nd | -50 | Repack | [[450, 1-12-2021]] | [[50, 1-12-2021]]
+2nd | +50 | Repack | [[450, 1-12-2021], [50, 1-12-2021]] | []
+
+- The balance at the end is restored back to 500
+- However, the initial 500 qty bucket is now split into 450 and 50, with the same date
+- The net effect is the same as that before the Repack
+
+#### Case 2: Same Item-Warehouse in Repack with Split Consumption rows
+Eg:
+-------------------------------------------------------------------------------------
+Date | Qty | Voucher | FIFO Queue | Transfer Qty Buckets
+-------------------------------------------------------------------------------------
+1st | +500 | PR | [[500, 1-12-2021]] |
+2nd | -50 | Repack | [[450, 1-12-2021]] | [[50, 1-12-2021]]
+2nd | -50 | Repack | [[400, 1-12-2021]] | [[50, 1-12-2021],
+- | | | |[50, 1-12-2021]]
+2nd | +100 | Repack | [[400, 1-12-2021], [50, 1-12-2021], | []
+- | | | [50, 1-12-2021]] |
diff --git a/erpnext/stock/report/stock_ageing/test_stock_ageing.py b/erpnext/stock/report/stock_ageing/test_stock_ageing.py
new file mode 100644
index 00000000000..fb363606233
--- /dev/null
+++ b/erpnext/stock/report/stock_ageing/test_stock_ageing.py
@@ -0,0 +1,736 @@
+# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors
+# See license.txt
+
+import frappe
+from frappe.tests.utils import FrappeTestCase
+
+from erpnext.stock.report.stock_ageing.stock_ageing import FIFOSlots, format_report_data
+
+
+class TestStockAgeing(FrappeTestCase):
+ def setUp(self) -> None:
+ self.filters = frappe._dict(
+ company="_Test Company", to_date="2021-12-10", range1=30, range2=60, range3=90
+ )
+
+ def test_normal_inward_outward_queue(self):
+ "Reference: Case 1 in stock_ageing_fifo_logic.md (same wh)"
+ sle = [
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=30,
+ qty_after_transaction=30,
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=20,
+ qty_after_transaction=50,
+ warehouse="WH 1",
+ posting_date="2021-12-02",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-10),
+ qty_after_transaction=40,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="003",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+
+ slots = FIFOSlots(self.filters, sle).generate()
+
+ self.assertTrue(slots["Flask Item"]["fifo_queue"])
+ result = slots["Flask Item"]
+ queue = result["fifo_queue"]
+
+ self.assertEqual(result["qty_after_transaction"], result["total_qty"])
+ self.assertEqual(queue[0][0], 20.0)
+
+ def test_insufficient_balance(self):
+ "Reference: Case 3 in stock_ageing_fifo_logic.md (same wh)"
+ sle = [
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-30),
+ qty_after_transaction=(-30),
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=20,
+ qty_after_transaction=(-10),
+ warehouse="WH 1",
+ posting_date="2021-12-02",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=20,
+ qty_after_transaction=10,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="003",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=10,
+ qty_after_transaction=20,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="004",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+
+ slots = FIFOSlots(self.filters, sle).generate()
+
+ result = slots["Flask Item"]
+ queue = result["fifo_queue"]
+
+ self.assertEqual(result["qty_after_transaction"], result["total_qty"])
+ self.assertEqual(queue[0][0], 10.0)
+ self.assertEqual(queue[1][0], 10.0)
+
+ def test_basic_stock_reconciliation(self):
+ """
+ Ledger (same wh): [+30, reco reset >> 50, -10]
+ Bal: 40
+ """
+ sle = [
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=30,
+ qty_after_transaction=30,
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=0,
+ qty_after_transaction=50,
+ warehouse="WH 1",
+ posting_date="2021-12-02",
+ voucher_type="Stock Reconciliation",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-10),
+ qty_after_transaction=40,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="003",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+
+ slots = FIFOSlots(self.filters, sle).generate()
+
+ result = slots["Flask Item"]
+ queue = result["fifo_queue"]
+
+ self.assertEqual(result["qty_after_transaction"], result["total_qty"])
+ self.assertEqual(result["total_qty"], 40.0)
+ self.assertEqual(queue[0][0], 20.0)
+ self.assertEqual(queue[1][0], 20.0)
+
+ def test_sequential_stock_reco_same_warehouse(self):
+ """
+ Test back to back stock recos (same warehouse).
+ Ledger: [reco opening >> +1000, reco reset >> 400, -10]
+ Bal: 390
+ """
+ sle = [
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=0,
+ qty_after_transaction=1000,
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Reconciliation",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=0,
+ qty_after_transaction=400,
+ warehouse="WH 1",
+ posting_date="2021-12-02",
+ voucher_type="Stock Reconciliation",
+ voucher_no="003",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-10),
+ qty_after_transaction=390,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="003",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+ slots = FIFOSlots(self.filters, sle).generate()
+
+ result = slots["Flask Item"]
+ queue = result["fifo_queue"]
+
+ self.assertEqual(result["qty_after_transaction"], result["total_qty"])
+ self.assertEqual(result["total_qty"], 390.0)
+ self.assertEqual(queue[0][0], 390.0)
+
+ def test_sequential_stock_reco_different_warehouse(self):
+ """
+ Ledger:
+ WH | Voucher | Qty
+ -------------------
+ WH1 | Reco | 1000
+ WH2 | Reco | 400
+ WH1 | SE | -10
+
+ Bal: WH1 bal + WH2 bal = 990 + 400 = 1390
+ """
+ sle = [
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=0,
+ qty_after_transaction=1000,
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Reconciliation",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=0,
+ qty_after_transaction=400,
+ warehouse="WH 2",
+ posting_date="2021-12-02",
+ voucher_type="Stock Reconciliation",
+ voucher_no="003",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-10),
+ qty_after_transaction=990,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="004",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+
+ item_wise_slots, item_wh_wise_slots = generate_item_and_item_wh_wise_slots(
+ filters=self.filters, sle=sle
+ )
+
+ # test without 'show_warehouse_wise_stock'
+ item_result = item_wise_slots["Flask Item"]
+ queue = item_result["fifo_queue"]
+
+ self.assertEqual(item_result["qty_after_transaction"], item_result["total_qty"])
+ self.assertEqual(item_result["total_qty"], 1390.0)
+ self.assertEqual(queue[0][0], 990.0)
+ self.assertEqual(queue[1][0], 400.0)
+
+ # test with 'show_warehouse_wise_stock' checked
+ item_wh_balances = [
+ item_wh_wise_slots.get(i).get("qty_after_transaction") for i in item_wh_wise_slots
+ ]
+ self.assertEqual(sum(item_wh_balances), item_result["qty_after_transaction"])
+
+ def test_repack_entry_same_item_split_rows(self):
+ """
+ Split consumption rows and have single repacked item row (same warehouse).
+ Ledger:
+ Item | Qty | Voucher
+ ------------------------
+ Item 1 | 500 | 001
+ Item 1 | -50 | 002 (repack)
+ Item 1 | -50 | 002 (repack)
+ Item 1 | 100 | 002 (repack)
+
+ Case most likely for batch items. Test time bucket computation.
+ """
+ sle = [
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=500,
+ qty_after_transaction=500,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-50),
+ qty_after_transaction=450,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-50),
+ qty_after_transaction=400,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=100,
+ qty_after_transaction=500,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+ slots = FIFOSlots(self.filters, sle).generate()
+ item_result = slots["Flask Item"]
+ queue = item_result["fifo_queue"]
+
+ self.assertEqual(item_result["total_qty"], 500.0)
+ self.assertEqual(queue[0][0], 400.0)
+ self.assertEqual(queue[1][0], 50.0)
+ self.assertEqual(queue[2][0], 50.0)
+ # check if time buckets add up to balance qty
+ self.assertEqual(sum([i[0] for i in queue]), 500.0)
+
+ def test_repack_entry_same_item_overconsume(self):
+ """
+ Over consume item and have less repacked item qty (same warehouse).
+ Ledger:
+ Item | Qty | Voucher
+ ------------------------
+ Item 1 | 500 | 001
+ Item 1 | -100 | 002 (repack)
+ Item 1 | 50 | 002 (repack)
+
+ Case most likely for batch items. Test time bucket computation.
+ """
+ sle = [
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=500,
+ qty_after_transaction=500,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-100),
+ qty_after_transaction=400,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=50,
+ qty_after_transaction=450,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+ slots = FIFOSlots(self.filters, sle).generate()
+ item_result = slots["Flask Item"]
+ queue = item_result["fifo_queue"]
+
+ self.assertEqual(item_result["total_qty"], 450.0)
+ self.assertEqual(queue[0][0], 400.0)
+ self.assertEqual(queue[1][0], 50.0)
+ # check if time buckets add up to balance qty
+ self.assertEqual(sum([i[0] for i in queue]), 450.0)
+
+ def test_repack_entry_same_item_overconsume_with_split_rows(self):
+ """
+ Over consume item and have less repacked item qty (same warehouse).
+ Ledger:
+ Item | Qty | Voucher
+ ------------------------
+ Item 1 | 20 | 001
+ Item 1 | -50 | 002 (repack)
+ Item 1 | -50 | 002 (repack)
+ Item 1 | 50 | 002 (repack)
+ """
+ sle = [
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=20,
+ qty_after_transaction=20,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-50),
+ qty_after_transaction=(-30),
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-50),
+ qty_after_transaction=(-80),
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=50,
+ qty_after_transaction=(-30),
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+ fifo_slots = FIFOSlots(self.filters, sle)
+ slots = fifo_slots.generate()
+ item_result = slots["Flask Item"]
+ queue = item_result["fifo_queue"]
+
+ self.assertEqual(item_result["total_qty"], -30.0)
+ self.assertEqual(queue[0][0], -30.0)
+
+ # check transfer bucket
+ transfer_bucket = fifo_slots.transferred_item_details[("002", "Flask Item", "WH 1")]
+ self.assertEqual(transfer_bucket[0][0], 50)
+
+ def test_repack_entry_same_item_overproduce(self):
+ """
+ Under consume item and have more repacked item qty (same warehouse).
+ Ledger:
+ Item | Qty | Voucher
+ ------------------------
+ Item 1 | 500 | 001
+ Item 1 | -50 | 002 (repack)
+ Item 1 | 100 | 002 (repack)
+
+ Case most likely for batch items. Test time bucket computation.
+ """
+ sle = [
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=500,
+ qty_after_transaction=500,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-50),
+ qty_after_transaction=450,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=100,
+ qty_after_transaction=550,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+ slots = FIFOSlots(self.filters, sle).generate()
+ item_result = slots["Flask Item"]
+ queue = item_result["fifo_queue"]
+
+ self.assertEqual(item_result["total_qty"], 550.0)
+ self.assertEqual(queue[0][0], 450.0)
+ self.assertEqual(queue[1][0], 50.0)
+ self.assertEqual(queue[2][0], 50.0)
+ # check if time buckets add up to balance qty
+ self.assertEqual(sum([i[0] for i in queue]), 550.0)
+
+ def test_repack_entry_same_item_overproduce_with_split_rows(self):
+ """
+ Over consume item and have less repacked item qty (same warehouse).
+ Ledger:
+ Item | Qty | Voucher
+ ------------------------
+ Item 1 | 20 | 001
+ Item 1 | -50 | 002 (repack)
+ Item 1 | 50 | 002 (repack)
+ Item 1 | 50 | 002 (repack)
+ """
+ sle = [
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=20,
+ qty_after_transaction=20,
+ warehouse="WH 1",
+ posting_date="2021-12-03",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=(-50),
+ qty_after_transaction=(-30),
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=50,
+ qty_after_transaction=20,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=50,
+ qty_after_transaction=70,
+ warehouse="WH 1",
+ posting_date="2021-12-04",
+ voucher_type="Stock Entry",
+ voucher_no="002",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+ fifo_slots = FIFOSlots(self.filters, sle)
+ slots = fifo_slots.generate()
+ item_result = slots["Flask Item"]
+ queue = item_result["fifo_queue"]
+
+ self.assertEqual(item_result["total_qty"], 70.0)
+ self.assertEqual(queue[0][0], 20.0)
+ self.assertEqual(queue[1][0], 50.0)
+
+ # check transfer bucket
+ transfer_bucket = fifo_slots.transferred_item_details[("002", "Flask Item", "WH 1")]
+ self.assertFalse(transfer_bucket)
+
+ def test_negative_stock_same_voucher(self):
+ """
+ Test negative stock scenario in transfer bucket via repack entry (same wh).
+ Ledger:
+ Item | Qty | Voucher
+ ------------------------
+ Item 1 | -50 | 001
+ Item 1 | -50 | 001
+ Item 1 | 30 | 001
+ Item 1 | 80 | 001
+ """
+ sle = [
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=(-50),
+ qty_after_transaction=(-50),
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=(-50),
+ qty_after_transaction=(-100),
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=30,
+ qty_after_transaction=(-70),
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+ fifo_slots = FIFOSlots(self.filters, sle)
+ slots = fifo_slots.generate()
+ item_result = slots["Flask Item"]
+
+ # check transfer bucket
+ transfer_bucket = fifo_slots.transferred_item_details[("001", "Flask Item", "WH 1")]
+ self.assertEqual(transfer_bucket[0][0], 20)
+ self.assertEqual(transfer_bucket[1][0], 50)
+ self.assertEqual(item_result["fifo_queue"][0][0], -70.0)
+
+ sle.append(
+ frappe._dict(
+ name="Flask Item",
+ actual_qty=80,
+ qty_after_transaction=10,
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ )
+ )
+
+ fifo_slots = FIFOSlots(self.filters, sle)
+ slots = fifo_slots.generate()
+ item_result = slots["Flask Item"]
+
+ transfer_bucket = fifo_slots.transferred_item_details[("001", "Flask Item", "WH 1")]
+ self.assertFalse(transfer_bucket)
+ self.assertEqual(item_result["fifo_queue"][0][0], 10.0)
+
+ def test_precision(self):
+ "Test if final balance qty is rounded off correctly."
+ sle = [
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=0.3,
+ qty_after_transaction=0.3,
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ frappe._dict( # stock up item
+ name="Flask Item",
+ actual_qty=0.6,
+ qty_after_transaction=0.9,
+ warehouse="WH 1",
+ posting_date="2021-12-01",
+ voucher_type="Stock Entry",
+ voucher_no="001",
+ has_serial_no=False,
+ serial_no=None,
+ ),
+ ]
+
+ slots = FIFOSlots(self.filters, sle).generate()
+ report_data = format_report_data(self.filters, slots, self.filters["to_date"])
+ row = report_data[0] # first row in report
+ bal_qty = row[5]
+ range_qty_sum = sum([i for i in row[7:11]]) # get sum of range balance
+
+ # check if value of Available Qty column matches with range bucket post format
+ self.assertEqual(bal_qty, 0.9)
+ self.assertEqual(bal_qty, range_qty_sum)
+
+
+def generate_item_and_item_wh_wise_slots(filters, sle):
+ "Return results with and without 'show_warehouse_wise_stock'"
+ item_wise_slots = FIFOSlots(filters, sle).generate()
+
+ filters.show_warehouse_wise_stock = True
+ item_wh_wise_slots = FIFOSlots(filters, sle).generate()
+ filters.show_warehouse_wise_stock = False
+
+ return item_wise_slots, item_wh_wise_slots
diff --git a/erpnext/stock/report/stock_analytics/stock_analytics.py b/erpnext/stock/report/stock_analytics/stock_analytics.py
index ddc831037bf..89ca9d9126e 100644
--- a/erpnext/stock/report/stock_analytics/stock_analytics.py
+++ b/erpnext/stock/report/stock_analytics/stock_analytics.py
@@ -1,6 +1,7 @@
# Copyright (c) 2013, Frappe Technologies Pvt. Ltd. and contributors
# For license information, please see license.txt
import datetime
+from typing import List
import frappe
from frappe import _, scrub
@@ -25,84 +26,64 @@ def execute(filters=None):
return columns, data, None, chart
+
def get_columns(filters):
columns = [
- {
- "label": _("Item"),
- "options":"Item",
- "fieldname": "name",
- "fieldtype": "Link",
- "width": 140
- },
+ {"label": _("Item"), "options": "Item", "fieldname": "name", "fieldtype": "Link", "width": 140},
{
"label": _("Item Name"),
- "options":"Item",
+ "options": "Item",
"fieldname": "item_name",
"fieldtype": "Link",
- "width": 140
+ "width": 140,
},
{
"label": _("Item Group"),
- "options":"Item Group",
+ "options": "Item Group",
"fieldname": "item_group",
"fieldtype": "Link",
- "width": 140
+ "width": 140,
},
- {
- "label": _("Brand"),
- "fieldname": "brand",
- "fieldtype": "Data",
- "width": 120
- },
- {
- "label": _("UOM"),
- "fieldname": "uom",
- "fieldtype": "Data",
- "width": 120
- }]
+ {"label": _("Brand"), "fieldname": "brand", "fieldtype": "Data", "width": 120},
+ {"label": _("UOM"), "fieldname": "uom", "fieldtype": "Data", "width": 120},
+ ]
ranges = get_period_date_ranges(filters)
for dummy, end_date in ranges:
period = get_period(end_date, filters)
- columns.append({
- "label": _(period),
- "fieldname":scrub(period),
- "fieldtype": "Float",
- "width": 120
- })
+ columns.append(
+ {"label": _(period), "fieldname": scrub(period), "fieldtype": "Float", "width": 120}
+ )
return columns
+
def get_period_date_ranges(filters):
- from dateutil.relativedelta import relativedelta
- from_date = round_down_to_nearest_frequency(filters.from_date, filters.range)
- to_date = getdate(filters.to_date)
+ from dateutil.relativedelta import relativedelta
- increment = {
- "Monthly": 1,
- "Quarterly": 3,
- "Half-Yearly": 6,
- "Yearly": 12
- }.get(filters.range,1)
+ from_date = round_down_to_nearest_frequency(filters.from_date, filters.range)
+ to_date = getdate(filters.to_date)
- periodic_daterange = []
- for dummy in range(1, 53, increment):
- if filters.range == "Weekly":
- period_end_date = from_date + relativedelta(days=6)
- else:
- period_end_date = from_date + relativedelta(months=increment, days=-1)
+ increment = {"Monthly": 1, "Quarterly": 3, "Half-Yearly": 6, "Yearly": 12}.get(filters.range, 1)
- if period_end_date > to_date:
- period_end_date = to_date
- periodic_daterange.append([from_date, period_end_date])
+ periodic_daterange = []
+ for dummy in range(1, 53, increment):
+ if filters.range == "Weekly":
+ period_end_date = from_date + relativedelta(days=6)
+ else:
+ period_end_date = from_date + relativedelta(months=increment, days=-1)
- from_date = period_end_date + relativedelta(days=1)
- if period_end_date == to_date:
- break
+ if period_end_date > to_date:
+ period_end_date = to_date
+ periodic_daterange.append([from_date, period_end_date])
- return periodic_daterange
+ from_date = period_end_date + relativedelta(days=1)
+ if period_end_date == to_date:
+ break
+
+ return periodic_daterange
def round_down_to_nearest_frequency(date: str, frequency: str) -> datetime.datetime:
@@ -132,12 +113,12 @@ def round_down_to_nearest_frequency(date: str, frequency: str) -> datetime.datet
def get_period(posting_date, filters):
months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
- if filters.range == 'Weekly':
+ if filters.range == "Weekly":
period = "Week " + str(posting_date.isocalendar()[1]) + " " + str(posting_date.year)
- elif filters.range == 'Monthly':
+ elif filters.range == "Monthly":
period = str(months[posting_date.month - 1]) + " " + str(posting_date.year)
- elif filters.range == 'Quarterly':
- period = "Quarter " + str(((posting_date.month-1)//3)+1) +" " + str(posting_date.year)
+ elif filters.range == "Quarterly":
+ period = "Quarter " + str(((posting_date.month - 1) // 3) + 1) + " " + str(posting_date.year)
else:
year = get_fiscal_year(posting_date, company=filters.company)
period = str(year[2])
@@ -147,60 +128,103 @@ def get_period(posting_date, filters):
def get_periodic_data(entry, filters):
"""Structured as:
- Item 1
- - Balance (updated and carried forward):
- - Warehouse A : bal_qty/value
- - Warehouse B : bal_qty/value
- - Jun 2021 (sum of warehouse quantities used in report)
- - Warehouse A : bal_qty/value
- - Warehouse B : bal_qty/value
- - Jul 2021 (sum of warehouse quantities used in report)
- - Warehouse A : bal_qty/value
- - Warehouse B : bal_qty/value
- Item 2
- - Balance (updated and carried forward):
- - Warehouse A : bal_qty/value
- - Warehouse B : bal_qty/value
- - Jun 2021 (sum of warehouse quantities used in report)
- - Warehouse A : bal_qty/value
- - Warehouse B : bal_qty/value
- - Jul 2021 (sum of warehouse quantities used in report)
- - Warehouse A : bal_qty/value
- - Warehouse B : bal_qty/value
+ Item 1
+ - Balance (updated and carried forward):
+ - Warehouse A : bal_qty/value
+ - Warehouse B : bal_qty/value
+ - Jun 2021 (sum of warehouse quantities used in report)
+ - Warehouse A : bal_qty/value
+ - Warehouse B : bal_qty/value
+ - Jul 2021 (sum of warehouse quantities used in report)
+ - Warehouse A : bal_qty/value
+ - Warehouse B : bal_qty/value
+ Item 2
+ - Balance (updated and carried forward):
+ - Warehouse A : bal_qty/value
+ - Warehouse B : bal_qty/value
+ - Jun 2021 (sum of warehouse quantities used in report)
+ - Warehouse A : bal_qty/value
+ - Warehouse B : bal_qty/value
+ - Jul 2021 (sum of warehouse quantities used in report)
+ - Warehouse A : bal_qty/value
+ - Warehouse B : bal_qty/value
"""
+
+ expected_ranges = get_period_date_ranges(filters)
+ expected_periods = []
+ for _start_date, end_date in expected_ranges:
+ expected_periods.append(get_period(end_date, filters))
+
periodic_data = {}
for d in entry:
period = get_period(d.posting_date, filters)
bal_qty = 0
+ fill_intermediate_periods(periodic_data, d.item_code, period, expected_periods)
+
# if period against item does not exist yet, instantiate it
# insert existing balance dict against period, and add/subtract to it
if periodic_data.get(d.item_code) and not periodic_data.get(d.item_code).get(period):
- previous_balance = periodic_data[d.item_code]['balance'].copy()
+ previous_balance = periodic_data[d.item_code]["balance"].copy()
periodic_data[d.item_code][period] = previous_balance
- if d.voucher_type == "Stock Reconciliation":
- if periodic_data.get(d.item_code) and periodic_data.get(d.item_code).get('balance').get(d.warehouse):
- bal_qty = periodic_data[d.item_code]['balance'][d.warehouse]
+ if d.voucher_type == "Stock Reconciliation" and not d.batch_no:
+ if periodic_data.get(d.item_code) and periodic_data.get(d.item_code).get("balance").get(
+ d.warehouse
+ ):
+ bal_qty = periodic_data[d.item_code]["balance"][d.warehouse]
qty_diff = d.qty_after_transaction - bal_qty
else:
qty_diff = d.actual_qty
- if filters["value_quantity"] == 'Quantity':
+ if filters["value_quantity"] == "Quantity":
value = qty_diff
else:
value = d.stock_value_difference
# period-warehouse wise balance
- periodic_data.setdefault(d.item_code, {}).setdefault('balance', {}).setdefault(d.warehouse, 0.0)
+ periodic_data.setdefault(d.item_code, {}).setdefault("balance", {}).setdefault(d.warehouse, 0.0)
periodic_data.setdefault(d.item_code, {}).setdefault(period, {}).setdefault(d.warehouse, 0.0)
- periodic_data[d.item_code]['balance'][d.warehouse] += value
- periodic_data[d.item_code][period][d.warehouse] = periodic_data[d.item_code]['balance'][d.warehouse]
+ periodic_data[d.item_code]["balance"][d.warehouse] += value
+ periodic_data[d.item_code][period][d.warehouse] = periodic_data[d.item_code]["balance"][
+ d.warehouse
+ ]
return periodic_data
+
+def fill_intermediate_periods(
+ periodic_data, item_code: str, current_period: str, all_periods: List[str]
+) -> None:
+ """There might be intermediate periods where no stock ledger entry exists, copy previous previous data.
+
+ Previous data is ONLY copied if period falls in report range and before period being processed currently.
+
+ args:
+ current_period: process till this period (exclusive)
+ all_periods: all periods expected in report via filters
+ periodic_data: report's periodic data
+ item_code: item_code being processed
+ """
+
+ previous_period_data = None
+ for period in all_periods:
+ if period == current_period:
+ return
+
+ if (
+ periodic_data.get(item_code)
+ and not periodic_data.get(item_code).get(period)
+ and previous_period_data
+ ):
+ # This period should exist since it's in report range, assign previous period data
+ periodic_data[item_code][period] = previous_period_data.copy()
+
+ previous_period_data = periodic_data.get(item_code, {}).get(period)
+
+
def get_data(filters):
data = []
items = get_items(filters)
@@ -209,6 +233,8 @@ def get_data(filters):
periodic_data = get_periodic_data(sle, filters)
ranges = get_period_date_ranges(filters)
+ today = getdate()
+
for dummy, item_data in item_details.items():
row = {
"name": item_data.name,
@@ -217,26 +243,23 @@ def get_data(filters):
"uom": item_data.stock_uom,
"brand": item_data.brand,
}
- total = 0
- for dummy, end_date in ranges:
+ previous_period_value = 0.0
+ for start_date, end_date in ranges:
period = get_period(end_date, filters)
period_data = periodic_data.get(item_data.name, {}).get(period)
- amount = sum(period_data.values()) if period_data else 0
- row[scrub(period)] = amount
- total += amount
- row["total"] = total
+ if period_data:
+ row[scrub(period)] = previous_period_value = sum(period_data.values())
+ else:
+ row[scrub(period)] = previous_period_value if today >= start_date else None
+
data.append(row)
return data
+
def get_chart_data(columns):
labels = [d.get("label") for d in columns[5:]]
- chart = {
- "data": {
- 'labels': labels,
- 'datasets':[]
- }
- }
+ chart = {"data": {"labels": labels, "datasets": []}}
chart["type"] = "line"
return chart
diff --git a/erpnext/stock/report/stock_analytics/test_stock_analytics.py b/erpnext/stock/report/stock_analytics/test_stock_analytics.py
index 32df5859375..dd8f8d80385 100644
--- a/erpnext/stock/report/stock_analytics/test_stock_analytics.py
+++ b/erpnext/stock/report/stock_analytics/test_stock_analytics.py
@@ -1,14 +1,59 @@
import datetime
-import unittest
+import frappe
from frappe import _dict
+from frappe.tests.utils import FrappeTestCase
+from frappe.utils.data import add_to_date, get_datetime, getdate, nowdate
from erpnext.accounts.utils import get_fiscal_year
-from erpnext.stock.report.stock_analytics.stock_analytics import get_period_date_ranges
-from erpnext.tests.utils import ERPNextTestCase
+from erpnext.stock.doctype.item.test_item import make_item
+from erpnext.stock.doctype.stock_entry.stock_entry_utils import make_stock_entry
+from erpnext.stock.report.stock_analytics.stock_analytics import execute, get_period_date_ranges
-class TestStockAnalyticsReport(ERPNextTestCase):
+def stock_analytics(filters):
+ col, data, *_ = execute(filters)
+ return col, data
+
+
+class TestStockAnalyticsReport(FrappeTestCase):
+ def setUp(self) -> None:
+ self.item = make_item().name
+ self.warehouse = "_Test Warehouse - _TC"
+
+ def assert_single_item_report(self, movement, expected_buckets):
+ self.generate_stock(movement)
+ filters = _dict(
+ range="Monthly",
+ from_date=movement[0][1].replace(day=1),
+ to_date=movement[-1][1].replace(day=28),
+ value_quantity="Quantity",
+ company="_Test Company",
+ item_code=self.item,
+ )
+
+ cols, data = stock_analytics(filters)
+
+ self.assertEqual(len(data), 1)
+ row = frappe._dict(data[0])
+ self.assertEqual(row.name, self.item)
+ self.compare_analytics_row(row, cols, expected_buckets)
+
+ def generate_stock(self, movement):
+ for qty, posting_date in movement:
+ args = {"item": self.item, "qty": abs(qty), "posting_date": posting_date}
+ args["to_warehouse" if qty > 0 else "from_warehouse"] = self.warehouse
+ make_stock_entry(**args)
+
+ def compare_analytics_row(self, report_row, columns, expected_buckets):
+ # last (N) cols will be monthly data
+ no_of_buckets = len(expected_buckets)
+ month_cols = [col["fieldname"] for col in columns[-no_of_buckets:]]
+
+ actual_buckets = [report_row.get(col) for col in month_cols]
+
+ self.assertEqual(actual_buckets, expected_buckets)
+
def test_get_period_date_ranges(self):
filters = _dict(range="Monthly", from_date="2020-12-28", to_date="2021-02-06")
@@ -34,3 +79,38 @@ class TestStockAnalyticsReport(ERPNextTestCase):
]
self.assertEqual(ranges, expected_ranges)
+
+ def test_basic_report_functionality(self):
+ """Stock analytics report generates balance "as of" periods based on
+ user defined ranges. Check that this behaviour is correct."""
+
+ # create stock movement in 3 months at 15th of month
+ today = getdate()
+ movement = [
+ (10, add_to_date(today, months=0).replace(day=15)),
+ (-5, add_to_date(today, months=1).replace(day=15)),
+ (10, add_to_date(today, months=2).replace(day=15)),
+ ]
+ self.assert_single_item_report(movement, [10, 5, 15])
+
+ def test_empty_month_in_between(self):
+ today = getdate()
+ movement = [
+ (100, add_to_date(today, months=0).replace(day=15)),
+ (-50, add_to_date(today, months=1).replace(day=15)),
+ # Skip a month
+ (20, add_to_date(today, months=3).replace(day=15)),
+ ]
+ self.assert_single_item_report(movement, [100, 50, 50, 70])
+
+ def test_multi_month_missings(self):
+ today = getdate()
+ movement = [
+ (100, add_to_date(today, months=0).replace(day=15)),
+ (-50, add_to_date(today, months=1).replace(day=15)),
+ # Skip a month
+ (20, add_to_date(today, months=3).replace(day=15)),
+ # Skip another month
+ (-10, add_to_date(today, months=5).replace(day=15)),
+ ]
+ self.assert_single_item_report(movement, [100, 50, 50, 70, 70, 60])
diff --git a/erpnext/stock/report/stock_and_account_value_comparison/stock_and_account_value_comparison.py b/erpnext/stock/report/stock_and_account_value_comparison/stock_and_account_value_comparison.py
index 6fd3fe7da48..99f820ecac6 100644
--- a/erpnext/stock/report/stock_and_account_value_comparison/stock_and_account_value_comparison.py
+++ b/erpnext/stock/report/stock_and_account_value_comparison/stock_and_account_value_comparison.py
@@ -12,21 +12,25 @@ from erpnext.stock.doctype.warehouse.warehouse import get_warehouses_based_on_ac
def execute(filters=None):
if not erpnext.is_perpetual_inventory_enabled(filters.company):
- frappe.throw(_("Perpetual inventory required for the company {0} to view this report.")
- .format(filters.company))
+ frappe.throw(
+ _("Perpetual inventory required for the company {0} to view this report.").format(
+ filters.company
+ )
+ )
data = get_data(filters)
columns = get_columns(filters)
return columns, data
+
def get_data(report_filters):
data = []
filters = {
"is_cancelled": 0,
"company": report_filters.company,
- "posting_date": ("<=", report_filters.as_on_date)
+ "posting_date": ("<=", report_filters.as_on_date),
}
currency_precision = get_currency_precision() or 2
@@ -43,18 +47,28 @@ def get_data(report_filters):
return data
+
def get_stock_ledger_data(report_filters, filters):
if report_filters.account:
- warehouses = get_warehouses_based_on_account(report_filters.account,
- report_filters.company)
+ warehouses = get_warehouses_based_on_account(report_filters.account, report_filters.company)
filters["warehouse"] = ("in", warehouses)
- return frappe.get_all("Stock Ledger Entry", filters=filters,
- fields = ["name", "voucher_type", "voucher_no",
- "sum(stock_value_difference) as stock_value", "posting_date", "posting_time"],
- group_by = "voucher_type, voucher_no",
- order_by = "posting_date ASC, posting_time ASC")
+ return frappe.get_all(
+ "Stock Ledger Entry",
+ filters=filters,
+ fields=[
+ "name",
+ "voucher_type",
+ "voucher_no",
+ "sum(stock_value_difference) as stock_value",
+ "posting_date",
+ "posting_time",
+ ],
+ group_by="voucher_type, voucher_no",
+ order_by="posting_date ASC, posting_time ASC",
+ )
+
def get_gl_data(report_filters, filters):
if report_filters.account:
@@ -62,17 +76,22 @@ def get_gl_data(report_filters, filters):
else:
stock_accounts = get_stock_accounts(report_filters.company)
- filters.update({
- "account": ("in", stock_accounts)
- })
+ filters.update({"account": ("in", stock_accounts)})
if filters.get("warehouse"):
del filters["warehouse"]
- gl_entries = frappe.get_all("GL Entry", filters=filters,
- fields = ["name", "voucher_type", "voucher_no",
- "sum(debit_in_account_currency) - sum(credit_in_account_currency) as account_value"],
- group_by = "voucher_type, voucher_no")
+ gl_entries = frappe.get_all(
+ "GL Entry",
+ filters=filters,
+ fields=[
+ "name",
+ "voucher_type",
+ "voucher_no",
+ "sum(debit_in_account_currency) - sum(credit_in_account_currency) as account_value",
+ ],
+ group_by="voucher_type, voucher_no",
+ )
voucher_wise_gl_data = {}
for d in gl_entries:
@@ -81,6 +100,7 @@ def get_gl_data(report_filters, filters):
return voucher_wise_gl_data
+
def get_columns(filters):
return [
{
@@ -88,46 +108,29 @@ def get_columns(filters):
"fieldname": "name",
"fieldtype": "Link",
"options": "Stock Ledger Entry",
- "width": "80"
- },
- {
- "label": _("Posting Date"),
- "fieldname": "posting_date",
- "fieldtype": "Date"
- },
- {
- "label": _("Posting Time"),
- "fieldname": "posting_time",
- "fieldtype": "Time"
- },
- {
- "label": _("Voucher Type"),
- "fieldname": "voucher_type",
- "width": "110"
+ "width": "80",
},
+ {"label": _("Posting Date"), "fieldname": "posting_date", "fieldtype": "Date"},
+ {"label": _("Posting Time"), "fieldname": "posting_time", "fieldtype": "Time"},
+ {"label": _("Voucher Type"), "fieldname": "voucher_type", "width": "110"},
{
"label": _("Voucher No"),
"fieldname": "voucher_no",
"fieldtype": "Dynamic Link",
"options": "voucher_type",
- "width": "110"
- },
- {
- "label": _("Stock Value"),
- "fieldname": "stock_value",
- "fieldtype": "Currency",
- "width": "120"
+ "width": "110",
},
+ {"label": _("Stock Value"), "fieldname": "stock_value", "fieldtype": "Currency", "width": "120"},
{
"label": _("Account Value"),
"fieldname": "account_value",
"fieldtype": "Currency",
- "width": "120"
+ "width": "120",
},
{
"label": _("Difference Value"),
"fieldname": "difference_value",
"fieldtype": "Currency",
- "width": "120"
- }
+ "width": "120",
+ },
]
diff --git a/erpnext/stock/report/stock_balance/stock_balance.py b/erpnext/stock/report/stock_balance/stock_balance.py
index 963c4489e44..261383d4a20 100644
--- a/erpnext/stock/report/stock_balance/stock_balance.py
+++ b/erpnext/stock/report/stock_balance/stock_balance.py
@@ -10,17 +10,18 @@ from frappe.utils import cint, date_diff, flt, getdate
from six import iteritems
import erpnext
-from erpnext.stock.report.stock_ageing.stock_ageing import get_average_age, get_fifo_queue
+from erpnext.stock.report.stock_ageing.stock_ageing import FIFOSlots, get_average_age
from erpnext.stock.report.stock_ledger.stock_ledger import get_item_group_condition
from erpnext.stock.utils import add_additional_uom_columns, is_reposting_item_valuation_in_progress
def execute(filters=None):
is_reposting_item_valuation_in_progress()
- if not filters: filters = {}
+ if not filters:
+ filters = {}
- from_date = filters.get('from_date')
- to_date = filters.get('to_date')
+ from_date = filters.get("from_date")
+ to_date = filters.get("to_date")
if filters.get("company"):
company_currency = erpnext.get_company_currency(filters.get("company"))
@@ -32,9 +33,9 @@ def execute(filters=None):
items = get_items(filters)
sle = get_stock_ledger_entries(filters, items)
- if filters.get('show_stock_ageing_data'):
- filters['show_warehouse_wise_stock'] = True
- item_wise_fifo_queue = get_fifo_queue(filters, sle)
+ if filters.get("show_stock_ageing_data"):
+ filters["show_warehouse_wise_stock"] = True
+ item_wise_fifo_queue = FIFOSlots(filters, sle).generate()
# if no stock ledger entry found return
if not sle:
@@ -59,12 +60,12 @@ def execute(filters=None):
item_reorder_qty = item_reorder_detail_map[item + warehouse]["warehouse_reorder_qty"]
report_data = {
- 'currency': company_currency,
- 'item_code': item,
- 'warehouse': warehouse,
- 'company': company,
- 'reorder_level': item_reorder_level,
- 'reorder_qty': item_reorder_qty,
+ "currency": company_currency,
+ "item_code": item,
+ "warehouse": warehouse,
+ "company": company,
+ "reorder_level": item_reorder_level,
+ "reorder_qty": item_reorder_qty,
}
report_data.update(item_map[item])
report_data.update(qty_dict)
@@ -72,21 +73,18 @@ def execute(filters=None):
if include_uom:
conversion_factors.setdefault(item, item_map[item].conversion_factor)
- if filters.get('show_stock_ageing_data'):
- fifo_queue = item_wise_fifo_queue[(item, warehouse)].get('fifo_queue')
+ if filters.get("show_stock_ageing_data"):
+ fifo_queue = item_wise_fifo_queue[(item, warehouse)].get("fifo_queue")
- stock_ageing_data = {
- 'average_age': 0,
- 'earliest_age': 0,
- 'latest_age': 0
- }
+ stock_ageing_data = {"average_age": 0, "earliest_age": 0, "latest_age": 0}
if fifo_queue:
fifo_queue = sorted(filter(_func, fifo_queue), key=_func)
- if not fifo_queue: continue
+ if not fifo_queue:
+ continue
- stock_ageing_data['average_age'] = get_average_age(fifo_queue, to_date)
- stock_ageing_data['earliest_age'] = date_diff(to_date, fifo_queue[0][1])
- stock_ageing_data['latest_age'] = date_diff(to_date, fifo_queue[-1][1])
+ stock_ageing_data["average_age"] = get_average_age(fifo_queue, to_date)
+ stock_ageing_data["earliest_age"] = date_diff(to_date, fifo_queue[0][1])
+ stock_ageing_data["latest_age"] = date_diff(to_date, fifo_queue[-1][1])
report_data.update(stock_ageing_data)
@@ -95,38 +93,130 @@ def execute(filters=None):
add_additional_uom_columns(columns, data, include_uom, conversion_factors)
return columns, data
+
def get_columns(filters):
"""return columns"""
columns = [
- {"label": _("Item"), "fieldname": "item_code", "fieldtype": "Link", "options": "Item", "width": 100},
+ {
+ "label": _("Item"),
+ "fieldname": "item_code",
+ "fieldtype": "Link",
+ "options": "Item",
+ "width": 100,
+ },
{"label": _("Item Name"), "fieldname": "item_name", "width": 150},
- {"label": _("Item Group"), "fieldname": "item_group", "fieldtype": "Link", "options": "Item Group", "width": 100},
- {"label": _("Warehouse"), "fieldname": "warehouse", "fieldtype": "Link", "options": "Warehouse", "width": 100},
- {"label": _("Stock UOM"), "fieldname": "stock_uom", "fieldtype": "Link", "options": "UOM", "width": 90},
- {"label": _("Balance Qty"), "fieldname": "bal_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Balance Value"), "fieldname": "bal_val", "fieldtype": "Currency", "width": 100, "options": "currency"},
- {"label": _("Opening Qty"), "fieldname": "opening_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Opening Value"), "fieldname": "opening_val", "fieldtype": "Currency", "width": 110, "options": "currency"},
- {"label": _("In Qty"), "fieldname": "in_qty", "fieldtype": "Float", "width": 80, "convertible": "qty"},
+ {
+ "label": _("Item Group"),
+ "fieldname": "item_group",
+ "fieldtype": "Link",
+ "options": "Item Group",
+ "width": 100,
+ },
+ {
+ "label": _("Warehouse"),
+ "fieldname": "warehouse",
+ "fieldtype": "Link",
+ "options": "Warehouse",
+ "width": 100,
+ },
+ {
+ "label": _("Stock UOM"),
+ "fieldname": "stock_uom",
+ "fieldtype": "Link",
+ "options": "UOM",
+ "width": 90,
+ },
+ {
+ "label": _("Balance Qty"),
+ "fieldname": "bal_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Balance Value"),
+ "fieldname": "bal_val",
+ "fieldtype": "Currency",
+ "width": 100,
+ "options": "currency",
+ },
+ {
+ "label": _("Opening Qty"),
+ "fieldname": "opening_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Opening Value"),
+ "fieldname": "opening_val",
+ "fieldtype": "Currency",
+ "width": 110,
+ "options": "currency",
+ },
+ {
+ "label": _("In Qty"),
+ "fieldname": "in_qty",
+ "fieldtype": "Float",
+ "width": 80,
+ "convertible": "qty",
+ },
{"label": _("In Value"), "fieldname": "in_val", "fieldtype": "Float", "width": 80},
- {"label": _("Out Qty"), "fieldname": "out_qty", "fieldtype": "Float", "width": 80, "convertible": "qty"},
+ {
+ "label": _("Out Qty"),
+ "fieldname": "out_qty",
+ "fieldtype": "Float",
+ "width": 80,
+ "convertible": "qty",
+ },
{"label": _("Out Value"), "fieldname": "out_val", "fieldtype": "Float", "width": 80},
- {"label": _("Valuation Rate"), "fieldname": "val_rate", "fieldtype": "Currency", "width": 90, "convertible": "rate", "options": "currency"},
- {"label": _("Reorder Level"), "fieldname": "reorder_level", "fieldtype": "Float", "width": 80, "convertible": "qty"},
- {"label": _("Reorder Qty"), "fieldname": "reorder_qty", "fieldtype": "Float", "width": 80, "convertible": "qty"},
- {"label": _("Company"), "fieldname": "company", "fieldtype": "Link", "options": "Company", "width": 100}
+ {
+ "label": _("Valuation Rate"),
+ "fieldname": "val_rate",
+ "fieldtype": "Currency",
+ "width": 90,
+ "convertible": "rate",
+ "options": "currency",
+ },
+ {
+ "label": _("Reorder Level"),
+ "fieldname": "reorder_level",
+ "fieldtype": "Float",
+ "width": 80,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Reorder Qty"),
+ "fieldname": "reorder_qty",
+ "fieldtype": "Float",
+ "width": 80,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Company"),
+ "fieldname": "company",
+ "fieldtype": "Link",
+ "options": "Company",
+ "width": 100,
+ },
]
- if filters.get('show_stock_ageing_data'):
- columns += [{'label': _('Average Age'), 'fieldname': 'average_age', 'width': 100},
- {'label': _('Earliest Age'), 'fieldname': 'earliest_age', 'width': 100},
- {'label': _('Latest Age'), 'fieldname': 'latest_age', 'width': 100}]
+ if filters.get("show_stock_ageing_data"):
+ columns += [
+ {"label": _("Average Age"), "fieldname": "average_age", "width": 100},
+ {"label": _("Earliest Age"), "fieldname": "earliest_age", "width": 100},
+ {"label": _("Latest Age"), "fieldname": "latest_age", "width": 100},
+ ]
- if filters.get('show_variant_attributes'):
- columns += [{'label': att_name, 'fieldname': att_name, 'width': 100} for att_name in get_variants_attributes()]
+ if filters.get("show_variant_attributes"):
+ columns += [
+ {"label": att_name, "fieldname": att_name, "width": 100}
+ for att_name in get_variants_attributes()
+ ]
return columns
+
def get_conditions(filters):
conditions = ""
if not filters.get("from_date"):
@@ -141,38 +231,50 @@ def get_conditions(filters):
conditions += " and sle.company = %s" % frappe.db.escape(filters.get("company"))
if filters.get("warehouse"):
- warehouse_details = frappe.db.get_value("Warehouse",
- filters.get("warehouse"), ["lft", "rgt"], as_dict=1)
+ warehouse_details = frappe.db.get_value(
+ "Warehouse", filters.get("warehouse"), ["lft", "rgt"], as_dict=1
+ )
if warehouse_details:
- conditions += " and exists (select name from `tabWarehouse` wh \
- where wh.lft >= %s and wh.rgt <= %s and sle.warehouse = wh.name)"%(warehouse_details.lft,
- warehouse_details.rgt)
+ conditions += (
+ " and exists (select name from `tabWarehouse` wh \
+ where wh.lft >= %s and wh.rgt <= %s and sle.warehouse = wh.name)"
+ % (warehouse_details.lft, warehouse_details.rgt)
+ )
if filters.get("warehouse_type") and not filters.get("warehouse"):
- conditions += " and exists (select name from `tabWarehouse` wh \
- where wh.warehouse_type = '%s' and sle.warehouse = wh.name)"%(filters.get("warehouse_type"))
+ conditions += (
+ " and exists (select name from `tabWarehouse` wh \
+ where wh.warehouse_type = '%s' and sle.warehouse = wh.name)"
+ % (filters.get("warehouse_type"))
+ )
return conditions
+
def get_stock_ledger_entries(filters, items):
- item_conditions_sql = ''
+ item_conditions_sql = ""
if items:
- item_conditions_sql = ' and sle.item_code in ({})'\
- .format(', '.join(frappe.db.escape(i, percent=False) for i in items))
+ item_conditions_sql = " and sle.item_code in ({})".format(
+ ", ".join(frappe.db.escape(i, percent=False) for i in items)
+ )
conditions = get_conditions(filters)
- return frappe.db.sql("""
+ return frappe.db.sql(
+ """
select
sle.item_code, warehouse, sle.posting_date, sle.actual_qty, sle.valuation_rate,
sle.company, sle.voucher_type, sle.qty_after_transaction, sle.stock_value_difference,
sle.item_code as name, sle.voucher_no, sle.stock_value, sle.batch_no
from
- `tabStock Ledger Entry` sle force index (posting_sort_index)
+ `tabStock Ledger Entry` sle
where sle.docstatus < 2 %s %s
and is_cancelled = 0
- order by sle.posting_date, sle.posting_time, sle.creation, sle.actual_qty""" % #nosec
- (item_conditions_sql, conditions), as_dict=1)
+ order by sle.posting_date, sle.posting_time, sle.creation, sle.actual_qty"""
+ % (item_conditions_sql, conditions), # nosec
+ as_dict=1,
+ )
+
def get_item_warehouse_map(filters, sle):
iwb_map = {}
@@ -184,13 +286,19 @@ def get_item_warehouse_map(filters, sle):
for d in sle:
key = (d.company, d.item_code, d.warehouse)
if key not in iwb_map:
- iwb_map[key] = frappe._dict({
- "opening_qty": 0.0, "opening_val": 0.0,
- "in_qty": 0.0, "in_val": 0.0,
- "out_qty": 0.0, "out_val": 0.0,
- "bal_qty": 0.0, "bal_val": 0.0,
- "val_rate": 0.0
- })
+ iwb_map[key] = frappe._dict(
+ {
+ "opening_qty": 0.0,
+ "opening_val": 0.0,
+ "in_qty": 0.0,
+ "in_val": 0.0,
+ "out_qty": 0.0,
+ "out_val": 0.0,
+ "bal_qty": 0.0,
+ "bal_val": 0.0,
+ "val_rate": 0.0,
+ }
+ )
qty_dict = iwb_map[(d.company, d.item_code, d.warehouse)]
@@ -201,9 +309,11 @@ def get_item_warehouse_map(filters, sle):
value_diff = flt(d.stock_value_difference)
- if d.posting_date < from_date or (d.posting_date == from_date
- and d.voucher_type == "Stock Reconciliation" and
- frappe.db.get_value("Stock Reconciliation", d.voucher_no, "purpose") == "Opening Stock"):
+ if d.posting_date < from_date or (
+ d.posting_date == from_date
+ and d.voucher_type == "Stock Reconciliation"
+ and frappe.db.get_value("Stock Reconciliation", d.voucher_no, "purpose") == "Opening Stock"
+ ):
qty_dict.opening_qty += qty_diff
qty_dict.opening_val += value_diff
@@ -223,6 +333,7 @@ def get_item_warehouse_map(filters, sle):
return iwb_map
+
def filter_items_with_no_transactions(iwb_map, float_precision):
for (company, item, warehouse) in sorted(iwb_map):
qty_dict = iwb_map[(company, item, warehouse)]
@@ -239,6 +350,7 @@ def filter_items_with_no_transactions(iwb_map, float_precision):
return iwb_map
+
def get_items(filters):
"Get items based on item code, item group or brand."
conditions = []
@@ -247,15 +359,17 @@ def get_items(filters):
else:
if filters.get("item_group"):
conditions.append(get_item_group_condition(filters.get("item_group")))
- if filters.get("brand"): # used in stock analytics report
+ if filters.get("brand"): # used in stock analytics report
conditions.append("item.brand=%(brand)s")
items = []
if conditions:
- items = frappe.db.sql_list("""select name from `tabItem` item where {}"""
- .format(" and ".join(conditions)), filters)
+ items = frappe.db.sql_list(
+ """select name from `tabItem` item where {}""".format(" and ".join(conditions)), filters
+ )
return items
+
def get_item_details(items, sle, filters):
item_details = {}
if not items:
@@ -267,10 +381,13 @@ def get_item_details(items, sle, filters):
cf_field = cf_join = ""
if filters.get("include_uom"):
cf_field = ", ucd.conversion_factor"
- cf_join = "left join `tabUOM Conversion Detail` ucd on ucd.parent=item.name and ucd.uom=%s" \
+ cf_join = (
+ "left join `tabUOM Conversion Detail` ucd on ucd.parent=item.name and ucd.uom=%s"
% frappe.db.escape(filters.get("include_uom"))
+ )
- res = frappe.db.sql("""
+ res = frappe.db.sql(
+ """
select
item.name, item.item_name, item.description, item.item_group, item.brand, item.stock_uom %s
from
@@ -278,40 +395,57 @@ def get_item_details(items, sle, filters):
%s
where
item.name in (%s)
- """ % (cf_field, cf_join, ','.join(['%s'] *len(items))), items, as_dict=1)
+ """
+ % (cf_field, cf_join, ",".join(["%s"] * len(items))),
+ items,
+ as_dict=1,
+ )
for item in res:
item_details.setdefault(item.name, item)
- if filters.get('show_variant_attributes', 0) == 1:
+ if filters.get("show_variant_attributes", 0) == 1:
variant_values = get_variant_values_for(list(item_details))
item_details = {k: v.update(variant_values.get(k, {})) for k, v in iteritems(item_details)}
return item_details
+
def get_item_reorder_details(items):
item_reorder_details = frappe._dict()
if items:
- item_reorder_details = frappe.db.sql("""
+ item_reorder_details = frappe.db.sql(
+ """
select parent, warehouse, warehouse_reorder_qty, warehouse_reorder_level
from `tabItem Reorder`
where parent in ({0})
- """.format(', '.join(frappe.db.escape(i, percent=False) for i in items)), as_dict=1)
+ """.format(
+ ", ".join(frappe.db.escape(i, percent=False) for i in items)
+ ),
+ as_dict=1,
+ )
return dict((d.parent + d.warehouse, d) for d in item_reorder_details)
+
def get_variants_attributes():
- '''Return all item variant attributes.'''
- return [i.name for i in frappe.get_all('Item Attribute')]
+ """Return all item variant attributes."""
+ return [i.name for i in frappe.get_all("Item Attribute")]
+
def get_variant_values_for(items):
- '''Returns variant values for items.'''
+ """Returns variant values for items."""
attribute_map = {}
- for attr in frappe.db.sql('''select parent, attribute, attribute_value
+ for attr in frappe.db.sql(
+ """select parent, attribute, attribute_value
from `tabItem Variant Attribute` where parent in (%s)
- ''' % ", ".join(["%s"] * len(items)), tuple(items), as_dict=1):
- attribute_map.setdefault(attr['parent'], {})
- attribute_map[attr['parent']].update({attr['attribute']: attr['attribute_value']})
+ """
+ % ", ".join(["%s"] * len(items)),
+ tuple(items),
+ as_dict=1,
+ ):
+ attribute_map.setdefault(attr["parent"], {})
+ attribute_map[attr["parent"]].update({attr["attribute"]: attr["attribute_value"]})
return attribute_map
diff --git a/erpnext/stock/report/stock_ledger/stock_ledger.js b/erpnext/stock/report/stock_ledger/stock_ledger.js
index fe2417bba7e..ef7c2cc7d9e 100644
--- a/erpnext/stock/report/stock_ledger/stock_ledger.js
+++ b/erpnext/stock/report/stock_ledger/stock_ledger.js
@@ -86,10 +86,10 @@ frappe.query_reports["Stock Ledger"] = {
],
"formatter": function (value, row, column, data, default_formatter) {
value = default_formatter(value, row, column, data);
- if (column.fieldname == "out_qty" && data.out_qty < 0) {
+ if (column.fieldname == "out_qty" && data && data.out_qty < 0) {
value = "" + value + "";
}
- else if (column.fieldname == "in_qty" && data.in_qty > 0) {
+ else if (column.fieldname == "in_qty" && data && data.in_qty > 0) {
value = "" + value + "";
}
diff --git a/erpnext/stock/report/stock_ledger/stock_ledger.py b/erpnext/stock/report/stock_ledger/stock_ledger.py
index c60a6ca56ea..b1fdaacac9d 100644
--- a/erpnext/stock/report/stock_ledger/stock_ledger.py
+++ b/erpnext/stock/report/stock_ledger/stock_ledger.py
@@ -41,19 +41,13 @@ def execute(filters=None):
actual_qty += flt(sle.actual_qty, precision)
stock_value += sle.stock_value_difference
- if sle.voucher_type == 'Stock Reconciliation' and not sle.actual_qty:
+ if sle.voucher_type == "Stock Reconciliation" and not sle.actual_qty:
actual_qty = sle.qty_after_transaction
stock_value = sle.stock_value
- sle.update({
- "qty_after_transaction": actual_qty,
- "stock_value": stock_value
- })
+ sle.update({"qty_after_transaction": actual_qty, "stock_value": stock_value})
- sle.update({
- "in_qty": max(sle.actual_qty, 0),
- "out_qty": min(sle.actual_qty, 0)
- })
+ sle.update({"in_qty": max(sle.actual_qty, 0), "out_qty": min(sle.actual_qty, 0)})
if sle.serial_no:
update_available_serial_nos(available_serial_nos, sle)
@@ -66,6 +60,7 @@ def execute(filters=None):
update_included_uom_in_report(columns, data, include_uom, conversion_factors)
return columns, data
+
def update_available_serial_nos(available_serial_nos, sle):
serial_nos = get_serial_nos(sle.serial_no)
key = (sle.item_code, sle.warehouse)
@@ -85,44 +80,158 @@ def update_available_serial_nos(available_serial_nos, sle):
else:
existing_serial_no.append(sn)
- sle.balance_serial_no = '\n'.join(existing_serial_no)
+ sle.balance_serial_no = "\n".join(existing_serial_no)
+
def get_columns():
columns = [
{"label": _("Date"), "fieldname": "date", "fieldtype": "Datetime", "width": 150},
- {"label": _("Item"), "fieldname": "item_code", "fieldtype": "Link", "options": "Item", "width": 100},
+ {
+ "label": _("Item"),
+ "fieldname": "item_code",
+ "fieldtype": "Link",
+ "options": "Item",
+ "width": 100,
+ },
{"label": _("Item Name"), "fieldname": "item_name", "width": 100},
- {"label": _("Stock UOM"), "fieldname": "stock_uom", "fieldtype": "Link", "options": "UOM", "width": 90},
- {"label": _("In Qty"), "fieldname": "in_qty", "fieldtype": "Float", "width": 80, "convertible": "qty"},
- {"label": _("Out Qty"), "fieldname": "out_qty", "fieldtype": "Float", "width": 80, "convertible": "qty"},
- {"label": _("Balance Qty"), "fieldname": "qty_after_transaction", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Voucher #"), "fieldname": "voucher_no", "fieldtype": "Dynamic Link", "options": "voucher_type", "width": 150},
- {"label": _("Warehouse"), "fieldname": "warehouse", "fieldtype": "Link", "options": "Warehouse", "width": 150},
- {"label": _("Item Group"), "fieldname": "item_group", "fieldtype": "Link", "options": "Item Group", "width": 100},
- {"label": _("Brand"), "fieldname": "brand", "fieldtype": "Link", "options": "Brand", "width": 100},
+ {
+ "label": _("Stock UOM"),
+ "fieldname": "stock_uom",
+ "fieldtype": "Link",
+ "options": "UOM",
+ "width": 90,
+ },
+ {
+ "label": _("In Qty"),
+ "fieldname": "in_qty",
+ "fieldtype": "Float",
+ "width": 80,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Out Qty"),
+ "fieldname": "out_qty",
+ "fieldtype": "Float",
+ "width": 80,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Balance Qty"),
+ "fieldname": "qty_after_transaction",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Voucher #"),
+ "fieldname": "voucher_no",
+ "fieldtype": "Dynamic Link",
+ "options": "voucher_type",
+ "width": 150,
+ },
+ {
+ "label": _("Warehouse"),
+ "fieldname": "warehouse",
+ "fieldtype": "Link",
+ "options": "Warehouse",
+ "width": 150,
+ },
+ {
+ "label": _("Item Group"),
+ "fieldname": "item_group",
+ "fieldtype": "Link",
+ "options": "Item Group",
+ "width": 100,
+ },
+ {
+ "label": _("Brand"),
+ "fieldname": "brand",
+ "fieldtype": "Link",
+ "options": "Brand",
+ "width": 100,
+ },
{"label": _("Description"), "fieldname": "description", "width": 200},
- {"label": _("Incoming Rate"), "fieldname": "incoming_rate", "fieldtype": "Currency", "width": 110, "options": "Company:company:default_currency", "convertible": "rate"},
- {"label": _("Valuation Rate"), "fieldname": "valuation_rate", "fieldtype": "Currency", "width": 110, "options": "Company:company:default_currency", "convertible": "rate"},
- {"label": _("Balance Value"), "fieldname": "stock_value", "fieldtype": "Currency", "width": 110, "options": "Company:company:default_currency"},
+ {
+ "label": _("Incoming Rate"),
+ "fieldname": "incoming_rate",
+ "fieldtype": "Currency",
+ "width": 110,
+ "options": "Company:company:default_currency",
+ "convertible": "rate",
+ },
+ {
+ "label": _("Valuation Rate"),
+ "fieldname": "valuation_rate",
+ "fieldtype": "Currency",
+ "width": 110,
+ "options": "Company:company:default_currency",
+ "convertible": "rate",
+ },
+ {
+ "label": _("Balance Value"),
+ "fieldname": "stock_value",
+ "fieldtype": "Currency",
+ "width": 110,
+ "options": "Company:company:default_currency",
+ },
+ {
+ "label": _("Value Change"),
+ "fieldname": "stock_value_difference",
+ "fieldtype": "Currency",
+ "width": 110,
+ "options": "Company:company:default_currency",
+ },
{"label": _("Voucher Type"), "fieldname": "voucher_type", "width": 110},
- {"label": _("Voucher #"), "fieldname": "voucher_no", "fieldtype": "Dynamic Link", "options": "voucher_type", "width": 100},
- {"label": _("Batch"), "fieldname": "batch_no", "fieldtype": "Link", "options": "Batch", "width": 100},
- {"label": _("Serial No"), "fieldname": "serial_no", "fieldtype": "Link", "options": "Serial No", "width": 100},
+ {
+ "label": _("Voucher #"),
+ "fieldname": "voucher_no",
+ "fieldtype": "Dynamic Link",
+ "options": "voucher_type",
+ "width": 100,
+ },
+ {
+ "label": _("Batch"),
+ "fieldname": "batch_no",
+ "fieldtype": "Link",
+ "options": "Batch",
+ "width": 100,
+ },
+ {
+ "label": _("Serial No"),
+ "fieldname": "serial_no",
+ "fieldtype": "Link",
+ "options": "Serial No",
+ "width": 100,
+ },
{"label": _("Balance Serial No"), "fieldname": "balance_serial_no", "width": 100},
- {"label": _("Project"), "fieldname": "project", "fieldtype": "Link", "options": "Project", "width": 100},
- {"label": _("Company"), "fieldname": "company", "fieldtype": "Link", "options": "Company", "width": 110}
+ {
+ "label": _("Project"),
+ "fieldname": "project",
+ "fieldtype": "Link",
+ "options": "Project",
+ "width": 100,
+ },
+ {
+ "label": _("Company"),
+ "fieldname": "company",
+ "fieldtype": "Link",
+ "options": "Company",
+ "width": 110,
+ },
]
return columns
def get_stock_ledger_entries(filters, items):
- item_conditions_sql = ''
+ item_conditions_sql = ""
if items:
- item_conditions_sql = 'and sle.item_code in ({})'\
- .format(', '.join(frappe.db.escape(i) for i in items))
+ item_conditions_sql = "and sle.item_code in ({})".format(
+ ", ".join(frappe.db.escape(i) for i in items)
+ )
- sl_entries = frappe.db.sql("""
+ sl_entries = frappe.db.sql(
+ """
SELECT
concat_ws(" ", posting_date, posting_time) AS date,
item_code,
@@ -148,8 +257,12 @@ def get_stock_ledger_entries(filters, items):
{item_conditions_sql}
ORDER BY
posting_date asc, posting_time asc, creation asc
- """.format(sle_conditions=get_sle_conditions(filters), item_conditions_sql=item_conditions_sql),
- filters, as_dict=1)
+ """.format(
+ sle_conditions=get_sle_conditions(filters), item_conditions_sql=item_conditions_sql
+ ),
+ filters,
+ as_dict=1,
+ )
return sl_entries
@@ -166,8 +279,9 @@ def get_items(filters):
items = []
if conditions:
- items = frappe.db.sql_list("""select name from `tabItem` item where {}"""
- .format(" and ".join(conditions)), filters)
+ items = frappe.db.sql_list(
+ """select name from `tabItem` item where {}""".format(" and ".join(conditions)), filters
+ )
return items
@@ -182,10 +296,13 @@ def get_item_details(items, sl_entries, include_uom):
cf_field = cf_join = ""
if include_uom:
cf_field = ", ucd.conversion_factor"
- cf_join = "left join `tabUOM Conversion Detail` ucd on ucd.parent=item.name and ucd.uom=%s" \
+ cf_join = (
+ "left join `tabUOM Conversion Detail` ucd on ucd.parent=item.name and ucd.uom=%s"
% frappe.db.escape(include_uom)
+ )
- res = frappe.db.sql("""
+ res = frappe.db.sql(
+ """
select
item.name, item.item_name, item.description, item.item_group, item.brand, item.stock_uom {cf_field}
from
@@ -193,7 +310,12 @@ def get_item_details(items, sl_entries, include_uom):
{cf_join}
where
item.name in ({item_codes})
- """.format(cf_field=cf_field, cf_join=cf_join, item_codes=','.join(['%s'] *len(items))), items, as_dict=1)
+ """.format(
+ cf_field=cf_field, cf_join=cf_join, item_codes=",".join(["%s"] * len(items))
+ ),
+ items,
+ as_dict=1,
+ )
for item in res:
item_details.setdefault(item.name, item)
@@ -222,16 +344,20 @@ def get_opening_balance(filters, columns, sl_entries):
return
from erpnext.stock.stock_ledger import get_previous_sle
- last_entry = get_previous_sle({
- "item_code": filters.item_code,
- "warehouse_condition": get_warehouse_condition(filters.warehouse),
- "posting_date": filters.from_date,
- "posting_time": "00:00:00"
- })
+
+ last_entry = get_previous_sle(
+ {
+ "item_code": filters.item_code,
+ "warehouse_condition": get_warehouse_condition(filters.warehouse),
+ "posting_date": filters.from_date,
+ "posting_time": "00:00:00",
+ }
+ )
# check if any SLEs are actually Opening Stock Reconciliation
for sle in sl_entries:
- if (sle.get("voucher_type") == "Stock Reconciliation"
+ if (
+ sle.get("voucher_type") == "Stock Reconciliation"
and sle.get("date").split()[0] == filters.from_date
and frappe.db.get_value("Stock Reconciliation", sle.voucher_no, "purpose") == "Opening Stock"
):
@@ -242,7 +368,7 @@ def get_opening_balance(filters, columns, sl_entries):
"item_code": _("'Opening'"),
"qty_after_transaction": last_entry.get("qty_after_transaction", 0),
"valuation_rate": last_entry.get("valuation_rate", 0),
- "stock_value": last_entry.get("stock_value", 0)
+ "stock_value": last_entry.get("stock_value", 0),
}
return row
@@ -251,18 +377,22 @@ def get_opening_balance(filters, columns, sl_entries):
def get_warehouse_condition(warehouse):
warehouse_details = frappe.db.get_value("Warehouse", warehouse, ["lft", "rgt"], as_dict=1)
if warehouse_details:
- return " exists (select name from `tabWarehouse` wh \
- where wh.lft >= %s and wh.rgt <= %s and warehouse = wh.name)"%(warehouse_details.lft,
- warehouse_details.rgt)
+ return (
+ " exists (select name from `tabWarehouse` wh \
+ where wh.lft >= %s and wh.rgt <= %s and warehouse = wh.name)"
+ % (warehouse_details.lft, warehouse_details.rgt)
+ )
- return ''
+ return ""
def get_item_group_condition(item_group):
item_group_details = frappe.db.get_value("Item Group", item_group, ["lft", "rgt"], as_dict=1)
if item_group_details:
- return "item.item_group in (select ig.name from `tabItem Group` ig \
- where ig.lft >= %s and ig.rgt <= %s and item.item_group = ig.name)"%(item_group_details.lft,
- item_group_details.rgt)
+ return (
+ "item.item_group in (select ig.name from `tabItem Group` ig \
+ where ig.lft >= %s and ig.rgt <= %s and item.item_group = ig.name)"
+ % (item_group_details.lft, item_group_details.rgt)
+ )
- return ''
+ return ""
diff --git a/erpnext/stock/report/stock_ledger_invariant_check/stock_ledger_invariant_check.js b/erpnext/stock/report/stock_ledger_invariant_check/stock_ledger_invariant_check.js
index c484516a163..31f389f236e 100644
--- a/erpnext/stock/report/stock_ledger_invariant_check/stock_ledger_invariant_check.js
+++ b/erpnext/stock/report/stock_ledger_invariant_check/stock_ledger_invariant_check.js
@@ -8,7 +8,8 @@ const DIFFERNCE_FIELD_NAMES = [
"fifo_value_diff",
"fifo_valuation_diff",
"valuation_diff",
- "fifo_difference_diff"
+ "fifo_difference_diff",
+ "diff_value_diff"
];
frappe.query_reports["Stock Ledger Invariant Check"] = {
diff --git a/erpnext/stock/report/stock_ledger_invariant_check/stock_ledger_invariant_check.py b/erpnext/stock/report/stock_ledger_invariant_check/stock_ledger_invariant_check.py
index ca47a1ec5b8..208b265afb8 100644
--- a/erpnext/stock/report/stock_ledger_invariant_check/stock_ledger_invariant_check.py
+++ b/erpnext/stock/report/stock_ledger_invariant_check/stock_ledger_invariant_check.py
@@ -21,6 +21,7 @@ SLE_FIELDS = (
"stock_value",
"stock_value_difference",
"valuation_rate",
+ "voucher_detail_no",
)
@@ -39,17 +40,14 @@ def get_stock_ledger_entries(filters):
return frappe.get_all(
"Stock Ledger Entry",
fields=SLE_FIELDS,
- filters={
- "item_code": filters.item_code,
- "warehouse": filters.warehouse,
- "is_cancelled": 0
- },
+ filters={"item_code": filters.item_code, "warehouse": filters.warehouse, "is_cancelled": 0},
order_by="timestamp(posting_date, posting_time), creation",
)
def add_invariant_check_fields(sles):
balance_qty = 0.0
+ balance_stock_value = 0.0
for idx, sle in enumerate(sles):
queue = json.loads(sle.stock_queue)
@@ -59,9 +57,15 @@ def add_invariant_check_fields(sles):
fifo_qty += qty
fifo_value += qty * rate
+ if sle.actual_qty < 0:
+ sle.consumption_rate = sle.stock_value_difference / sle.actual_qty
+
balance_qty += sle.actual_qty
+ balance_stock_value += sle.stock_value_difference
if sle.voucher_type == "Stock Reconciliation" and not sle.batch_no:
- balance_qty = sle.qty_after_transaction
+ balance_qty = frappe.db.get_value("Stock Reconciliation Item", sle.voucher_detail_no, "qty")
+ if balance_qty is None:
+ balance_qty = sle.qty_after_transaction
sle.fifo_queue_qty = fifo_qty
sle.fifo_stock_value = fifo_value
@@ -70,6 +74,7 @@ def add_invariant_check_fields(sles):
sle.stock_value / sle.qty_after_transaction if sle.qty_after_transaction else None
)
sle.expected_qty_after_transaction = balance_qty
+ sle.stock_value_from_diff = balance_stock_value
# set difference fields
sle.difference_in_qty = sle.qty_after_transaction - sle.expected_qty_after_transaction
@@ -81,6 +86,7 @@ def add_invariant_check_fields(sles):
sle.valuation_diff = (
sle.valuation_rate - sle.balance_value_by_qty if sle.balance_value_by_qty else None
)
+ sle.diff_value_diff = sle.stock_value_from_diff - sle.stock_value
if idx > 0:
sle.fifo_stock_diff = sle.fifo_stock_value - sles[idx - 1].fifo_stock_value
@@ -99,17 +105,17 @@ def get_columns():
},
{
"fieldname": "posting_date",
- "fieldtype": "Date",
+ "fieldtype": "Data",
"label": "Posting Date",
},
{
"fieldname": "posting_time",
- "fieldtype": "Time",
+ "fieldtype": "Data",
"label": "Posting Time",
},
{
"fieldname": "creation",
- "fieldtype": "Datetime",
+ "fieldtype": "Data",
"label": "Creation",
},
{
@@ -141,9 +147,9 @@ def get_columns():
"label": "Incoming Rate",
},
{
- "fieldname": "outgoing_rate",
+ "fieldname": "consumption_rate",
"fieldtype": "Float",
- "label": "Outgoing Rate",
+ "label": "Consumption Rate",
},
{
"fieldname": "qty_after_transaction",
@@ -165,7 +171,6 @@ def get_columns():
"fieldtype": "Data",
"label": "FIFO Queue",
},
-
{
"fieldname": "fifo_queue_qty",
"fieldtype": "Float",
@@ -191,12 +196,21 @@ def get_columns():
"fieldtype": "Float",
"label": "D - E",
},
-
{
"fieldname": "stock_value_difference",
"fieldtype": "Float",
"label": "(F) Stock Value Difference",
},
+ {
+ "fieldname": "stock_value_from_diff",
+ "fieldtype": "Float",
+ "label": "Balance Stock Value using (F)",
+ },
+ {
+ "fieldname": "diff_value_diff",
+ "fieldtype": "Float",
+ "label": "K - D",
+ },
{
"fieldname": "fifo_stock_diff",
"fieldtype": "Float",
@@ -217,7 +231,6 @@ def get_columns():
"fieldtype": "Float",
"label": "(I) Valuation Rate as per FIFO",
},
-
{
"fieldname": "fifo_valuation_diff",
"fieldtype": "Float",
diff --git a/erpnext/stock/report/stock_projected_qty/stock_projected_qty.py b/erpnext/stock/report/stock_projected_qty/stock_projected_qty.py
index a28b75250bf..49e797d6a30 100644
--- a/erpnext/stock/report/stock_projected_qty/stock_projected_qty.py
+++ b/erpnext/stock/report/stock_projected_qty/stock_projected_qty.py
@@ -32,8 +32,9 @@ def execute(filters=None):
continue
# item = item_map.setdefault(bin.item_code, get_item(bin.item_code))
- company = warehouse_company.setdefault(bin.warehouse,
- frappe.db.get_value("Warehouse", bin.warehouse, "company"))
+ company = warehouse_company.setdefault(
+ bin.warehouse, frappe.db.get_value("Warehouse", bin.warehouse, "company")
+ )
if filters.brand and filters.brand != item.brand:
continue
@@ -59,10 +60,29 @@ def execute(filters=None):
if reserved_qty_for_pos:
bin.projected_qty -= reserved_qty_for_pos
- data.append([item.name, item.item_name, item.description, item.item_group, item.brand, bin.warehouse,
- item.stock_uom, bin.actual_qty, bin.planned_qty, bin.indented_qty, bin.ordered_qty,
- bin.reserved_qty, bin.reserved_qty_for_production, bin.reserved_qty_for_sub_contract, reserved_qty_for_pos,
- bin.projected_qty, re_order_level, re_order_qty, shortage_qty])
+ data.append(
+ [
+ item.name,
+ item.item_name,
+ item.description,
+ item.item_group,
+ item.brand,
+ bin.warehouse,
+ item.stock_uom,
+ bin.actual_qty,
+ bin.planned_qty,
+ bin.indented_qty,
+ bin.ordered_qty,
+ bin.reserved_qty,
+ bin.reserved_qty_for_production,
+ bin.reserved_qty_for_sub_contract,
+ reserved_qty_for_pos,
+ bin.projected_qty,
+ re_order_level,
+ re_order_qty,
+ shortage_qty,
+ ]
+ )
if include_uom:
conversion_factors.append(item.conversion_factor)
@@ -70,66 +90,180 @@ def execute(filters=None):
update_included_uom_in_report(columns, data, include_uom, conversion_factors)
return columns, data
+
def get_columns():
return [
- {"label": _("Item Code"), "fieldname": "item_code", "fieldtype": "Link", "options": "Item", "width": 140},
+ {
+ "label": _("Item Code"),
+ "fieldname": "item_code",
+ "fieldtype": "Link",
+ "options": "Item",
+ "width": 140,
+ },
{"label": _("Item Name"), "fieldname": "item_name", "width": 100},
{"label": _("Description"), "fieldname": "description", "width": 200},
- {"label": _("Item Group"), "fieldname": "item_group", "fieldtype": "Link", "options": "Item Group", "width": 100},
- {"label": _("Brand"), "fieldname": "brand", "fieldtype": "Link", "options": "Brand", "width": 100},
- {"label": _("Warehouse"), "fieldname": "warehouse", "fieldtype": "Link", "options": "Warehouse", "width": 120},
- {"label": _("UOM"), "fieldname": "stock_uom", "fieldtype": "Link", "options": "UOM", "width": 100},
- {"label": _("Actual Qty"), "fieldname": "actual_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Planned Qty"), "fieldname": "planned_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Requested Qty"), "fieldname": "indented_qty", "fieldtype": "Float", "width": 110, "convertible": "qty"},
- {"label": _("Ordered Qty"), "fieldname": "ordered_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Reserved Qty"), "fieldname": "reserved_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Reserved for Production"), "fieldname": "reserved_qty_for_production", "fieldtype": "Float",
- "width": 100, "convertible": "qty"},
- {"label": _("Reserved for Sub Contracting"), "fieldname": "reserved_qty_for_sub_contract", "fieldtype": "Float",
- "width": 100, "convertible": "qty"},
- {"label": _("Reserved for POS Transactions"), "fieldname": "reserved_qty_for_pos", "fieldtype": "Float",
- "width": 100, "convertible": "qty"},
- {"label": _("Projected Qty"), "fieldname": "projected_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Reorder Level"), "fieldname": "re_order_level", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Reorder Qty"), "fieldname": "re_order_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"},
- {"label": _("Shortage Qty"), "fieldname": "shortage_qty", "fieldtype": "Float", "width": 100, "convertible": "qty"}
+ {
+ "label": _("Item Group"),
+ "fieldname": "item_group",
+ "fieldtype": "Link",
+ "options": "Item Group",
+ "width": 100,
+ },
+ {
+ "label": _("Brand"),
+ "fieldname": "brand",
+ "fieldtype": "Link",
+ "options": "Brand",
+ "width": 100,
+ },
+ {
+ "label": _("Warehouse"),
+ "fieldname": "warehouse",
+ "fieldtype": "Link",
+ "options": "Warehouse",
+ "width": 120,
+ },
+ {
+ "label": _("UOM"),
+ "fieldname": "stock_uom",
+ "fieldtype": "Link",
+ "options": "UOM",
+ "width": 100,
+ },
+ {
+ "label": _("Actual Qty"),
+ "fieldname": "actual_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Planned Qty"),
+ "fieldname": "planned_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Requested Qty"),
+ "fieldname": "indented_qty",
+ "fieldtype": "Float",
+ "width": 110,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Ordered Qty"),
+ "fieldname": "ordered_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Reserved Qty"),
+ "fieldname": "reserved_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Reserved for Production"),
+ "fieldname": "reserved_qty_for_production",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Reserved for Sub Contracting"),
+ "fieldname": "reserved_qty_for_sub_contract",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Reserved for POS Transactions"),
+ "fieldname": "reserved_qty_for_pos",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Projected Qty"),
+ "fieldname": "projected_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Reorder Level"),
+ "fieldname": "re_order_level",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Reorder Qty"),
+ "fieldname": "re_order_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
+ {
+ "label": _("Shortage Qty"),
+ "fieldname": "shortage_qty",
+ "fieldtype": "Float",
+ "width": 100,
+ "convertible": "qty",
+ },
]
+
def get_bin_list(filters):
conditions = []
if filters.item_code:
- conditions.append("item_code = '%s' "%filters.item_code)
+ conditions.append("item_code = '%s' " % filters.item_code)
if filters.warehouse:
- warehouse_details = frappe.db.get_value("Warehouse", filters.warehouse, ["lft", "rgt"], as_dict=1)
+ warehouse_details = frappe.db.get_value(
+ "Warehouse", filters.warehouse, ["lft", "rgt"], as_dict=1
+ )
if warehouse_details:
- conditions.append(" exists (select name from `tabWarehouse` wh \
- where wh.lft >= %s and wh.rgt <= %s and bin.warehouse = wh.name)"%(warehouse_details.lft,
- warehouse_details.rgt))
+ conditions.append(
+ " exists (select name from `tabWarehouse` wh \
+ where wh.lft >= %s and wh.rgt <= %s and bin.warehouse = wh.name)"
+ % (warehouse_details.lft, warehouse_details.rgt)
+ )
- bin_list = frappe.db.sql("""select item_code, warehouse, actual_qty, planned_qty, indented_qty,
+ bin_list = frappe.db.sql(
+ """select item_code, warehouse, actual_qty, planned_qty, indented_qty,
ordered_qty, reserved_qty, reserved_qty_for_production, reserved_qty_for_sub_contract, projected_qty
from tabBin bin {conditions} order by item_code, warehouse
- """.format(conditions=" where " + " and ".join(conditions) if conditions else ""), as_dict=1)
+ """.format(
+ conditions=" where " + " and ".join(conditions) if conditions else ""
+ ),
+ as_dict=1,
+ )
return bin_list
+
def get_item_map(item_code, include_uom):
"""Optimization: get only the item doc and re_order_levels table"""
condition = ""
if item_code:
- condition = 'and item_code = {0}'.format(frappe.db.escape(item_code, percent=False))
+ condition = "and item_code = {0}".format(frappe.db.escape(item_code, percent=False))
cf_field = cf_join = ""
if include_uom:
cf_field = ", ucd.conversion_factor"
- cf_join = "left join `tabUOM Conversion Detail` ucd on ucd.parent=item.name and ucd.uom=%(include_uom)s"
+ cf_join = (
+ "left join `tabUOM Conversion Detail` ucd on ucd.parent=item.name and ucd.uom=%(include_uom)s"
+ )
- items = frappe.db.sql("""
+ items = frappe.db.sql(
+ """
select item.name, item.item_name, item.description, item.item_group, item.brand, item.stock_uom{cf_field}
from `tabItem` item
{cf_join}
@@ -137,16 +271,21 @@ def get_item_map(item_code, include_uom):
and item.disabled=0
{condition}
and (item.end_of_life > %(today)s or item.end_of_life is null or item.end_of_life='0000-00-00')
- and exists (select name from `tabBin` bin where bin.item_code=item.name)"""\
- .format(cf_field=cf_field, cf_join=cf_join, condition=condition),
- {"today": today(), "include_uom": include_uom}, as_dict=True)
+ and exists (select name from `tabBin` bin where bin.item_code=item.name)""".format(
+ cf_field=cf_field, cf_join=cf_join, condition=condition
+ ),
+ {"today": today(), "include_uom": include_uom},
+ as_dict=True,
+ )
condition = ""
if item_code:
- condition = 'where parent={0}'.format(frappe.db.escape(item_code, percent=False))
+ condition = "where parent={0}".format(frappe.db.escape(item_code, percent=False))
reorder_levels = frappe._dict()
- for ir in frappe.db.sql("""select * from `tabItem Reorder` {condition}""".format(condition=condition), as_dict=1):
+ for ir in frappe.db.sql(
+ """select * from `tabItem Reorder` {condition}""".format(condition=condition), as_dict=1
+ ):
if ir.parent not in reorder_levels:
reorder_levels[ir.parent] = []
diff --git a/erpnext/stock/report/stock_qty_vs_serial_no_count/stock_qty_vs_serial_no_count.py b/erpnext/stock/report/stock_qty_vs_serial_no_count/stock_qty_vs_serial_no_count.py
index a7b48356b8d..70f04da4753 100644
--- a/erpnext/stock/report/stock_qty_vs_serial_no_count/stock_qty_vs_serial_no_count.py
+++ b/erpnext/stock/report/stock_qty_vs_serial_no_count/stock_qty_vs_serial_no_count.py
@@ -12,12 +12,14 @@ def execute(filters=None):
data = get_data(filters.warehouse)
return columns, data
+
def validate_warehouse(filters):
company = filters.company
warehouse = filters.warehouse
if not frappe.db.exists("Warehouse", {"name": warehouse, "company": company}):
frappe.throw(_("Warehouse: {0} does not belong to {1}").format(warehouse, company))
+
def get_columns():
columns = [
{
@@ -25,49 +27,37 @@ def get_columns():
"fieldname": "item_code",
"fieldtype": "Link",
"options": "Item",
- "width": 200
- },
- {
- "label": _("Item Name"),
- "fieldname": "item_name",
- "fieldtype": "Data",
- "width": 200
- },
- {
- "label": _("Serial No Count"),
- "fieldname": "total",
- "fieldtype": "Float",
- "width": 150
- },
- {
- "label": _("Stock Qty"),
- "fieldname": "stock_qty",
- "fieldtype": "Float",
- "width": 150
- },
- {
- "label": _("Difference"),
- "fieldname": "difference",
- "fieldtype": "Float",
- "width": 150
+ "width": 200,
},
+ {"label": _("Item Name"), "fieldname": "item_name", "fieldtype": "Data", "width": 200},
+ {"label": _("Serial No Count"), "fieldname": "total", "fieldtype": "Float", "width": 150},
+ {"label": _("Stock Qty"), "fieldname": "stock_qty", "fieldtype": "Float", "width": 150},
+ {"label": _("Difference"), "fieldname": "difference", "fieldtype": "Float", "width": 150},
]
return columns
-def get_data(warehouse):
- serial_item_list = frappe.get_all("Item", filters={
- 'has_serial_no': True,
- }, fields=['item_code', 'item_name'])
- status_list = ['Active', 'Expired']
+def get_data(warehouse):
+ serial_item_list = frappe.get_all(
+ "Item",
+ filters={
+ "has_serial_no": True,
+ },
+ fields=["item_code", "item_name"],
+ )
+
+ status_list = ["Active", "Expired"]
data = []
for item in serial_item_list:
- total_serial_no = frappe.db.count("Serial No",
- filters={"item_code": item.item_code, "status": ("in", status_list), "warehouse": warehouse})
+ total_serial_no = frappe.db.count(
+ "Serial No",
+ filters={"item_code": item.item_code, "status": ("in", status_list), "warehouse": warehouse},
+ )
- actual_qty = frappe.db.get_value('Bin', fieldname=['actual_qty'],
- filters={"warehouse": warehouse, "item_code": item.item_code})
+ actual_qty = frappe.db.get_value(
+ "Bin", fieldname=["actual_qty"], filters={"warehouse": warehouse, "item_code": item.item_code}
+ )
# frappe.db.get_value returns null if no record exist.
if not actual_qty:
diff --git a/erpnext/stock/report/supplier_wise_sales_analytics/supplier_wise_sales_analytics.py b/erpnext/stock/report/supplier_wise_sales_analytics/supplier_wise_sales_analytics.py
index 11559aa2081..0a482fe90a9 100644
--- a/erpnext/stock/report/supplier_wise_sales_analytics/supplier_wise_sales_analytics.py
+++ b/erpnext/stock/report/supplier_wise_sales_analytics/supplier_wise_sales_analytics.py
@@ -21,11 +21,11 @@ def execute(filters=None):
if consumed_details.get(item_code):
for cd in consumed_details.get(item_code):
- if (cd.voucher_no not in material_transfer_vouchers):
+ if cd.voucher_no not in material_transfer_vouchers:
if cd.voucher_type in ["Delivery Note", "Sales Invoice"]:
delivered_qty += abs(flt(cd.actual_qty))
delivered_amount += abs(flt(cd.stock_value_difference))
- elif cd.voucher_type!="Delivery Note":
+ elif cd.voucher_type != "Delivery Note":
consumed_qty += abs(flt(cd.actual_qty))
consumed_amount += abs(flt(cd.stock_value_difference))
@@ -33,66 +33,98 @@ def execute(filters=None):
total_qty += delivered_qty + consumed_qty
total_amount += delivered_amount + consumed_amount
- row = [cd.item_code, cd.item_name, cd.description, cd.stock_uom, \
- consumed_qty, consumed_amount, delivered_qty, delivered_amount, \
- total_qty, total_amount, ','.join(list(set(suppliers)))]
+ row = [
+ cd.item_code,
+ cd.item_name,
+ cd.description,
+ cd.stock_uom,
+ consumed_qty,
+ consumed_amount,
+ delivered_qty,
+ delivered_amount,
+ total_qty,
+ total_amount,
+ ",".join(list(set(suppliers))),
+ ]
data.append(row)
return columns, data
+
def get_columns(filters):
"""return columns based on filters"""
- columns = [_("Item") + ":Link/Item:100"] + [_("Item Name") + "::100"] + \
- [_("Description") + "::150"] + [_("UOM") + ":Link/UOM:90"] + \
- [_("Consumed Qty") + ":Float:110"] + [_("Consumed Amount") + ":Currency:130"] + \
- [_("Delivered Qty") + ":Float:110"] + [_("Delivered Amount") + ":Currency:130"] + \
- [_("Total Qty") + ":Float:110"] + [_("Total Amount") + ":Currency:130"] + \
- [_("Supplier(s)") + "::250"]
+ columns = (
+ [_("Item") + ":Link/Item:100"]
+ + [_("Item Name") + "::100"]
+ + [_("Description") + "::150"]
+ + [_("UOM") + ":Link/UOM:90"]
+ + [_("Consumed Qty") + ":Float:110"]
+ + [_("Consumed Amount") + ":Currency:130"]
+ + [_("Delivered Qty") + ":Float:110"]
+ + [_("Delivered Amount") + ":Currency:130"]
+ + [_("Total Qty") + ":Float:110"]
+ + [_("Total Amount") + ":Currency:130"]
+ + [_("Supplier(s)") + "::250"]
+ )
return columns
+
def get_conditions(filters):
conditions = ""
values = []
- if filters.get('from_date') and filters.get('to_date'):
+ if filters.get("from_date") and filters.get("to_date"):
conditions = "and sle.posting_date>=%s and sle.posting_date<=%s"
- values = [filters.get('from_date'), filters.get('to_date')]
+ values = [filters.get("from_date"), filters.get("to_date")]
return conditions, values
+
def get_consumed_details(filters):
conditions, values = get_conditions(filters)
consumed_details = {}
- for d in frappe.db.sql("""select sle.item_code, i.item_name, i.description,
+ for d in frappe.db.sql(
+ """select sle.item_code, i.item_name, i.description,
i.stock_uom, sle.actual_qty, sle.stock_value_difference,
sle.voucher_no, sle.voucher_type
from `tabStock Ledger Entry` sle, `tabItem` i
- where sle.is_cancelled = 0 and sle.item_code=i.name and sle.actual_qty < 0 %s""" % conditions, values, as_dict=1):
- consumed_details.setdefault(d.item_code, []).append(d)
+ where sle.is_cancelled = 0 and sle.item_code=i.name and sle.actual_qty < 0 %s"""
+ % conditions,
+ values,
+ as_dict=1,
+ ):
+ consumed_details.setdefault(d.item_code, []).append(d)
return consumed_details
+
def get_suppliers_details(filters):
item_supplier_map = {}
- supplier = filters.get('supplier')
+ supplier = filters.get("supplier")
- for d in frappe.db.sql("""select pr.supplier, pri.item_code from
+ for d in frappe.db.sql(
+ """select pr.supplier, pri.item_code from
`tabPurchase Receipt` pr, `tabPurchase Receipt Item` pri
where pr.name=pri.parent and pr.docstatus=1 and
pri.item_code=(select name from `tabItem` where
- is_stock_item=1 and name=pri.item_code)""", as_dict=1):
- item_supplier_map.setdefault(d.item_code, []).append(d.supplier)
+ is_stock_item=1 and name=pri.item_code)""",
+ as_dict=1,
+ ):
+ item_supplier_map.setdefault(d.item_code, []).append(d.supplier)
- for d in frappe.db.sql("""select pr.supplier, pri.item_code from
+ for d in frappe.db.sql(
+ """select pr.supplier, pri.item_code from
`tabPurchase Invoice` pr, `tabPurchase Invoice Item` pri
where pr.name=pri.parent and pr.docstatus=1 and
ifnull(pr.update_stock, 0) = 1 and pri.item_code=(select name from `tabItem`
- where is_stock_item=1 and name=pri.item_code)""", as_dict=1):
- if d.item_code not in item_supplier_map:
- item_supplier_map.setdefault(d.item_code, []).append(d.supplier)
+ where is_stock_item=1 and name=pri.item_code)""",
+ as_dict=1,
+ ):
+ if d.item_code not in item_supplier_map:
+ item_supplier_map.setdefault(d.item_code, []).append(d.supplier)
if supplier:
invalid_items = []
@@ -105,6 +137,9 @@ def get_suppliers_details(filters):
return item_supplier_map
+
def get_material_transfer_vouchers():
- return frappe.db.sql_list("""select name from `tabStock Entry` where
- purpose='Material Transfer' and docstatus=1""")
+ return frappe.db.sql_list(
+ """select name from `tabStock Entry` where
+ purpose='Material Transfer' and docstatus=1"""
+ )
diff --git a/erpnext/stock/report/test_reports.py b/erpnext/stock/report/test_reports.py
index 1dcf863a9d0..7e69718614f 100644
--- a/erpnext/stock/report/test_reports.py
+++ b/erpnext/stock/report/test_reports.py
@@ -37,16 +37,23 @@ REPORT_FILTER_TEST_CASES: List[Tuple[ReportName, ReportFilters]] = [
},
),
("Warehouse wise Item Balance Age and Value", {"_optional": True}),
- ("Item Variant Details", {"item": "_Test Variant Item",}),
- ("Total Stock Summary", {"group_by": "warehouse",}),
+ (
+ "Item Variant Details",
+ {
+ "item": "_Test Variant Item",
+ },
+ ),
+ (
+ "Total Stock Summary",
+ {
+ "group_by": "warehouse",
+ },
+ ),
("Batch Item Expiry Status", {}),
("Stock Ageing", {"range1": 30, "range2": 60, "range3": 90, "_optional": True}),
- ("Stock Ledger Invariant Check",
- {
- "warehouse": "_Test Warehouse - _TC",
- "item": "_Test Item"
- }
- ),
+ ("Stock Ledger Invariant Check", {"warehouse": "_Test Warehouse - _TC", "item": "_Test Item"}),
+ ("FIFO Queue vs Qty After Transaction Comparison", {"warehouse": "_Test Warehouse - _TC"}),
+ ("FIFO Queue vs Qty After Transaction Comparison", {"item_group": "All Item Groups"}),
]
OPTIONAL_FILTERS = {
diff --git a/erpnext/stock/report/total_stock_summary/total_stock_summary.py b/erpnext/stock/report/total_stock_summary/total_stock_summary.py
index 6f27558b887..21529da2a12 100644
--- a/erpnext/stock/report/total_stock_summary/total_stock_summary.py
+++ b/erpnext/stock/report/total_stock_summary/total_stock_summary.py
@@ -15,6 +15,7 @@ def execute(filters=None):
return columns, stock
+
def get_columns():
columns = [
_("Company") + ":Link/Company:250",
@@ -26,13 +27,16 @@ def get_columns():
return columns
+
def get_total_stock(filters):
conditions = ""
columns = ""
if filters.get("group_by") == "Warehouse":
if filters.get("company"):
- conditions += " AND warehouse.company = %s" % frappe.db.escape(filters.get("company"), percent=False)
+ conditions += " AND warehouse.company = %s" % frappe.db.escape(
+ filters.get("company"), percent=False
+ )
conditions += " GROUP BY ledger.warehouse, item.item_code"
columns += "'' as company, ledger.warehouse"
@@ -40,7 +44,8 @@ def get_total_stock(filters):
conditions += " GROUP BY warehouse.company, item.item_code"
columns += " warehouse.company, '' as warehouse"
- return frappe.db.sql("""
+ return frappe.db.sql(
+ """
SELECT
%s,
item.item_code,
@@ -53,4 +58,6 @@ def get_total_stock(filters):
INNER JOIN `tabWarehouse` warehouse
ON warehouse.name = ledger.warehouse
WHERE
- ledger.actual_qty != 0 %s""" % (columns, conditions))
+ ledger.actual_qty != 0 %s"""
+ % (columns, conditions)
+ )
diff --git a/erpnext/stock/report/warehouse_wise_item_balance_age_and_value/warehouse_wise_item_balance_age_and_value.py b/erpnext/stock/report/warehouse_wise_item_balance_age_and_value/warehouse_wise_item_balance_age_and_value.py
index 3c4e6a9023d..10d951b7bd4 100644
--- a/erpnext/stock/report/warehouse_wise_item_balance_age_and_value/warehouse_wise_item_balance_age_and_value.py
+++ b/erpnext/stock/report/warehouse_wise_item_balance_age_and_value/warehouse_wise_item_balance_age_and_value.py
@@ -10,7 +10,7 @@ from frappe import _
from frappe.utils import flt
from six import iteritems
-from erpnext.stock.report.stock_ageing.stock_ageing import get_average_age, get_fifo_queue
+from erpnext.stock.report.stock_ageing.stock_ageing import FIFOSlots, get_average_age
from erpnext.stock.report.stock_balance.stock_balance import (
get_item_details,
get_item_warehouse_map,
@@ -22,7 +22,8 @@ from erpnext.stock.utils import is_reposting_item_valuation_in_progress
def execute(filters=None):
is_reposting_item_valuation_in_progress()
- if not filters: filters = {}
+ if not filters:
+ filters = {}
validate_filters(filters)
@@ -34,13 +35,14 @@ def execute(filters=None):
item_map = get_item_details(items, sle, filters)
iwb_map = get_item_warehouse_map(filters, sle)
warehouse_list = get_warehouse_list(filters)
- item_ageing = get_fifo_queue(filters)
+ item_ageing = FIFOSlots(filters).generate()
data = []
item_balance = {}
item_value = {}
for (company, item, warehouse) in sorted(iwb_map):
- if not item_map.get(item): continue
+ if not item_map.get(item):
+ continue
row = []
qty_dict = iwb_map[(company, item, warehouse)]
@@ -51,13 +53,13 @@ def execute(filters=None):
total_stock_value += qty_dict.bal_val if wh.name == warehouse else 0.00
item_balance[(item, item_map[item]["item_group"])].append(row)
- item_value.setdefault((item, item_map[item]["item_group"]),[])
+ item_value.setdefault((item, item_map[item]["item_group"]), [])
item_value[(item, item_map[item]["item_group"])].append(total_stock_value)
-
# sum bal_qty by item
for (item, item_group), wh_balance in iteritems(item_balance):
- if not item_ageing.get(item): continue
+ if not item_ageing.get(item):
+ continue
total_stock_value = sum(item_value[(item, item_group)])
row = [item, item_group, total_stock_value]
@@ -82,17 +84,19 @@ def execute(filters=None):
add_warehouse_column(columns, warehouse_list)
return columns, data
+
def get_columns(filters):
"""return columns"""
columns = [
- _("Item")+":Link/Item:180",
- _("Item Group")+"::100",
- _("Value")+":Currency:100",
- _("Age")+":Float:60",
+ _("Item") + ":Link/Item:180",
+ _("Item Group") + "::100",
+ _("Value") + ":Currency:100",
+ _("Age") + ":Float:60",
]
return columns
+
def validate_filters(filters):
if not (filters.get("item_code") or filters.get("warehouse")):
sle_count = flt(frappe.db.sql("""select count(name) from `tabStock Ledger Entry`""")[0][0])
@@ -101,11 +105,12 @@ def validate_filters(filters):
if not filters.get("company"):
filters["company"] = frappe.defaults.get_user_default("Company")
+
def get_warehouse_list(filters):
from frappe.core.doctype.user_permission.user_permission import get_permitted_documents
- condition = ''
- user_permitted_warehouse = get_permitted_documents('Warehouse')
+ condition = ""
+ user_permitted_warehouse = get_permitted_documents("Warehouse")
value = ()
if user_permitted_warehouse:
condition = "and name in %s"
@@ -114,13 +119,20 @@ def get_warehouse_list(filters):
condition = "and name = %s"
value = filters.get("warehouse")
- return frappe.db.sql("""select name
+ return frappe.db.sql(
+ """select name
from `tabWarehouse` where is_group = 0
- {condition}""".format(condition=condition), value, as_dict=1)
+ {condition}""".format(
+ condition=condition
+ ),
+ value,
+ as_dict=1,
+ )
+
def add_warehouse_column(columns, warehouse_list):
if len(warehouse_list) > 1:
- columns += [_("Total Qty")+":Int:50"]
+ columns += [_("Total Qty") + ":Int:50"]
for wh in warehouse_list:
- columns += [_(wh.name)+":Int:54"]
+ columns += [_(wh.name) + ":Int:54"]
diff --git a/erpnext/stock/stock_balance.py b/erpnext/stock/stock_balance.py
index 6663458e651..9a7d8bbfe42 100644
--- a/erpnext/stock/stock_balance.py
+++ b/erpnext/stock/stock_balance.py
@@ -3,7 +3,7 @@
import frappe
-from frappe.utils import cstr, flt, nowdate, nowtime
+from frappe.utils import cstr, flt, now, nowdate, nowtime
from erpnext.controllers.stock_controller import create_repost_item_valuation_entry
from erpnext.stock.utils import update_bin
@@ -16,16 +16,20 @@ def repost(only_actual=False, allow_negative_stock=False, allow_zero_rate=False,
frappe.db.auto_commit_on_many_writes = 1
if allow_negative_stock:
- existing_allow_negative_stock = frappe.db.get_value("Stock Settings", None, "allow_negative_stock")
+ existing_allow_negative_stock = frappe.db.get_value(
+ "Stock Settings", None, "allow_negative_stock"
+ )
frappe.db.set_value("Stock Settings", None, "allow_negative_stock", 1)
- item_warehouses = frappe.db.sql("""
+ item_warehouses = frappe.db.sql(
+ """
select distinct item_code, warehouse
from
(select item_code, warehouse from tabBin
union
select item_code, warehouse from `tabStock Ledger Entry`) a
- """)
+ """
+ )
for d in item_warehouses:
try:
repost_stock(d[0], d[1], allow_zero_rate, only_actual, only_bin, allow_negative_stock)
@@ -34,11 +38,20 @@ def repost(only_actual=False, allow_negative_stock=False, allow_zero_rate=False,
frappe.db.rollback()
if allow_negative_stock:
- frappe.db.set_value("Stock Settings", None, "allow_negative_stock", existing_allow_negative_stock)
+ frappe.db.set_value(
+ "Stock Settings", None, "allow_negative_stock", existing_allow_negative_stock
+ )
frappe.db.auto_commit_on_many_writes = 0
-def repost_stock(item_code, warehouse, allow_zero_rate=False,
- only_actual=False, only_bin=False, allow_negative_stock=False):
+
+def repost_stock(
+ item_code,
+ warehouse,
+ allow_zero_rate=False,
+ only_actual=False,
+ only_bin=False,
+ allow_negative_stock=False,
+):
if not only_bin:
repost_actual_qty(item_code, warehouse, allow_zero_rate, allow_negative_stock)
@@ -48,35 +61,42 @@ def repost_stock(item_code, warehouse, allow_zero_rate=False,
"reserved_qty": get_reserved_qty(item_code, warehouse),
"indented_qty": get_indented_qty(item_code, warehouse),
"ordered_qty": get_ordered_qty(item_code, warehouse),
- "planned_qty": get_planned_qty(item_code, warehouse)
+ "planned_qty": get_planned_qty(item_code, warehouse),
}
if only_bin:
- qty_dict.update({
- "actual_qty": get_balance_qty_from_sle(item_code, warehouse)
- })
+ qty_dict.update({"actual_qty": get_balance_qty_from_sle(item_code, warehouse)})
update_bin_qty(item_code, warehouse, qty_dict)
+
def repost_actual_qty(item_code, warehouse, allow_zero_rate=False, allow_negative_stock=False):
- create_repost_item_valuation_entry({
- "item_code": item_code,
- "warehouse": warehouse,
- "posting_date": "1900-01-01",
- "posting_time": "00:01",
- "allow_negative_stock": allow_negative_stock,
- "allow_zero_rate": allow_zero_rate
- })
+ create_repost_item_valuation_entry(
+ {
+ "item_code": item_code,
+ "warehouse": warehouse,
+ "posting_date": "1900-01-01",
+ "posting_time": "00:01",
+ "allow_negative_stock": allow_negative_stock,
+ "allow_zero_rate": allow_zero_rate,
+ }
+ )
+
def get_balance_qty_from_sle(item_code, warehouse):
- balance_qty = frappe.db.sql("""select qty_after_transaction from `tabStock Ledger Entry`
+ balance_qty = frappe.db.sql(
+ """select qty_after_transaction from `tabStock Ledger Entry`
where item_code=%s and warehouse=%s and is_cancelled=0
order by posting_date desc, posting_time desc, creation desc
- limit 1""", (item_code, warehouse))
+ limit 1""",
+ (item_code, warehouse),
+ )
return flt(balance_qty[0][0]) if balance_qty else 0.0
+
def get_reserved_qty(item_code, warehouse):
- reserved_qty = frappe.db.sql("""
+ reserved_qty = frappe.db.sql(
+ """
select
sum(dnpi_qty * ((so_item_qty - so_item_delivered_qty) / so_item_qty))
from
@@ -116,58 +136,76 @@ def get_reserved_qty(item_code, warehouse):
) tab
where
so_item_qty >= so_item_delivered_qty
- """, (item_code, warehouse, item_code, warehouse))
+ """,
+ (item_code, warehouse, item_code, warehouse),
+ )
return flt(reserved_qty[0][0]) if reserved_qty else 0
+
def get_indented_qty(item_code, warehouse):
# Ordered Qty is always maintained in stock UOM
- inward_qty = frappe.db.sql("""
+ inward_qty = frappe.db.sql(
+ """
select sum(mr_item.stock_qty - mr_item.ordered_qty)
from `tabMaterial Request Item` mr_item, `tabMaterial Request` mr
where mr_item.item_code=%s and mr_item.warehouse=%s
and mr.material_request_type in ('Purchase', 'Manufacture', 'Customer Provided', 'Material Transfer')
and mr_item.stock_qty > mr_item.ordered_qty and mr_item.parent=mr.name
and mr.status!='Stopped' and mr.docstatus=1
- """, (item_code, warehouse))
+ """,
+ (item_code, warehouse),
+ )
inward_qty = flt(inward_qty[0][0]) if inward_qty else 0
- outward_qty = frappe.db.sql("""
+ outward_qty = frappe.db.sql(
+ """
select sum(mr_item.stock_qty - mr_item.ordered_qty)
from `tabMaterial Request Item` mr_item, `tabMaterial Request` mr
where mr_item.item_code=%s and mr_item.warehouse=%s
and mr.material_request_type = 'Material Issue'
and mr_item.stock_qty > mr_item.ordered_qty and mr_item.parent=mr.name
and mr.status!='Stopped' and mr.docstatus=1
- """, (item_code, warehouse))
+ """,
+ (item_code, warehouse),
+ )
outward_qty = flt(outward_qty[0][0]) if outward_qty else 0
requested_qty = inward_qty - outward_qty
return requested_qty
+
def get_ordered_qty(item_code, warehouse):
- ordered_qty = frappe.db.sql("""
+ ordered_qty = frappe.db.sql(
+ """
select sum((po_item.qty - po_item.received_qty)*po_item.conversion_factor)
from `tabPurchase Order Item` po_item, `tabPurchase Order` po
where po_item.item_code=%s and po_item.warehouse=%s
and po_item.qty > po_item.received_qty and po_item.parent=po.name
and po.status not in ('Closed', 'Delivered') and po.docstatus=1
- and po_item.delivered_by_supplier = 0""", (item_code, warehouse))
+ and po_item.delivered_by_supplier = 0""",
+ (item_code, warehouse),
+ )
return flt(ordered_qty[0][0]) if ordered_qty else 0
+
def get_planned_qty(item_code, warehouse):
- planned_qty = frappe.db.sql("""
+ planned_qty = frappe.db.sql(
+ """
select sum(qty - produced_qty) from `tabWork Order`
where production_item = %s and fg_warehouse = %s and status not in ("Stopped", "Completed", "Closed")
- and docstatus=1 and qty > produced_qty""", (item_code, warehouse))
+ and docstatus=1 and qty > produced_qty""",
+ (item_code, warehouse),
+ )
return flt(planned_qty[0][0]) if planned_qty else 0
def update_bin_qty(item_code, warehouse, qty_dict=None):
from erpnext.stock.utils import get_bin
+
bin = get_bin(item_code, warehouse)
mismatch = False
for field, value in qty_dict.items():
@@ -175,46 +213,60 @@ def update_bin_qty(item_code, warehouse, qty_dict=None):
bin.set(field, flt(value))
mismatch = True
+ bin.modified = now()
if mismatch:
bin.set_projected_qty()
bin.db_update()
bin.clear_cache()
-def set_stock_balance_as_per_serial_no(item_code=None, posting_date=None, posting_time=None,
- fiscal_year=None):
- if not posting_date: posting_date = nowdate()
- if not posting_time: posting_time = nowtime()
- condition = " and item.name='%s'" % item_code.replace("'", "\'") if item_code else ""
+def set_stock_balance_as_per_serial_no(
+ item_code=None, posting_date=None, posting_time=None, fiscal_year=None
+):
+ if not posting_date:
+ posting_date = nowdate()
+ if not posting_time:
+ posting_time = nowtime()
- bin = frappe.db.sql("""select bin.item_code, bin.warehouse, bin.actual_qty, item.stock_uom
+ condition = " and item.name='%s'" % item_code.replace("'", "'") if item_code else ""
+
+ bin = frappe.db.sql(
+ """select bin.item_code, bin.warehouse, bin.actual_qty, item.stock_uom
from `tabBin` bin, tabItem item
- where bin.item_code = item.name and item.has_serial_no = 1 %s""" % condition)
+ where bin.item_code = item.name and item.has_serial_no = 1 %s"""
+ % condition
+ )
for d in bin:
- serial_nos = frappe.db.sql("""select count(name) from `tabSerial No`
- where item_code=%s and warehouse=%s and docstatus < 2""", (d[0], d[1]))
+ serial_nos = frappe.db.sql(
+ """select count(name) from `tabSerial No`
+ where item_code=%s and warehouse=%s and docstatus < 2""",
+ (d[0], d[1]),
+ )
- sle = frappe.db.sql("""select valuation_rate, company from `tabStock Ledger Entry`
+ sle = frappe.db.sql(
+ """select valuation_rate, company from `tabStock Ledger Entry`
where item_code = %s and warehouse = %s and is_cancelled = 0
- order by posting_date desc limit 1""", (d[0], d[1]))
+ order by posting_date desc limit 1""",
+ (d[0], d[1]),
+ )
sle_dict = {
- 'doctype' : 'Stock Ledger Entry',
- 'item_code' : d[0],
- 'warehouse' : d[1],
- 'transaction_date' : nowdate(),
- 'posting_date' : posting_date,
- 'posting_time' : posting_time,
- 'voucher_type' : 'Stock Reconciliation (Manual)',
- 'voucher_no' : '',
- 'voucher_detail_no' : '',
- 'actual_qty' : flt(serial_nos[0][0]) - flt(d[2]),
- 'stock_uom' : d[3],
- 'incoming_rate' : sle and flt(serial_nos[0][0]) > flt(d[2]) and flt(sle[0][0]) or 0,
- 'company' : sle and cstr(sle[0][1]) or 0,
- 'batch_no' : '',
- 'serial_no' : ''
+ "doctype": "Stock Ledger Entry",
+ "item_code": d[0],
+ "warehouse": d[1],
+ "transaction_date": nowdate(),
+ "posting_date": posting_date,
+ "posting_time": posting_time,
+ "voucher_type": "Stock Reconciliation (Manual)",
+ "voucher_no": "",
+ "voucher_detail_no": "",
+ "actual_qty": flt(serial_nos[0][0]) - flt(d[2]),
+ "stock_uom": d[3],
+ "incoming_rate": sle and flt(serial_nos[0][0]) > flt(d[2]) and flt(sle[0][0]) or 0,
+ "company": sle and cstr(sle[0][1]) or 0,
+ "batch_no": "",
+ "serial_no": "",
}
sle_doc = frappe.get_doc(sle_dict)
@@ -223,18 +275,19 @@ def set_stock_balance_as_per_serial_no(item_code=None, posting_date=None, postin
sle_doc.insert()
args = sle_dict.copy()
- args.update({
- "sle_id": sle_doc.name
- })
+ args.update({"sle_id": sle_doc.name})
update_bin(args)
- create_repost_item_valuation_entry({
- "item_code": d[0],
- "warehouse": d[1],
- "posting_date": posting_date,
- "posting_time": posting_time
- })
+ create_repost_item_valuation_entry(
+ {
+ "item_code": d[0],
+ "warehouse": d[1],
+ "posting_date": posting_date,
+ "posting_time": posting_time,
+ }
+ )
+
def reset_serial_no_status_and_warehouse(serial_nos=None):
if not serial_nos:
diff --git a/erpnext/stock/stock_ledger.py b/erpnext/stock/stock_ledger.py
index 90c6ae67fb3..0dadda46807 100644
--- a/erpnext/stock/stock_ledger.py
+++ b/erpnext/stock/stock_ledger.py
@@ -1,13 +1,14 @@
-# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
+# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors
# License: GNU General Public License v3. See license.txt
import copy
import json
+from typing import Set, Tuple
import frappe
from frappe import _
from frappe.model.meta import get_field_precision
-from frappe.utils import cint, cstr, flt, get_link_to_form, getdate, now, nowdate
+from frappe.utils import cint, cstr, flt, get_datetime, get_link_to_form, getdate, now, nowdate
from six import iteritems
import erpnext
@@ -19,41 +20,56 @@ from erpnext.stock.utils import (
)
-class NegativeStockError(frappe.ValidationError): pass
+class NegativeStockError(frappe.ValidationError):
+ pass
+
+
class SerialNoExistsInFutureTransaction(frappe.ValidationError):
pass
-_exceptions = frappe.local('stockledger_exceptions')
def make_sl_entries(sl_entries, allow_negative_stock=False, via_landed_cost_voucher=False):
+ """Create SL entries from SL entry dicts
+
+ args:
+ - allow_negative_stock: disable negative stock valiations if true
+ - via_landed_cost_voucher: landed cost voucher cancels and reposts
+ entries of purchase document. This flag is used to identify if
+ cancellation and repost is happening via landed cost voucher, in
+ such cases certain validations need to be ignored (like negative
+ stock)
+ """
from erpnext.controllers.stock_controller import future_sle_exists
+
if sl_entries:
cancel = sl_entries[0].get("is_cancelled")
if cancel:
validate_cancellation(sl_entries)
- set_as_cancel(sl_entries[0].get('voucher_type'), sl_entries[0].get('voucher_no'))
+ set_as_cancel(sl_entries[0].get("voucher_type"), sl_entries[0].get("voucher_no"))
args = get_args_for_future_sle(sl_entries[0])
future_sle_exists(args, sl_entries)
for sle in sl_entries:
- if sle.serial_no:
+ if sle.serial_no and not via_landed_cost_voucher:
validate_serial_no(sle)
if cancel:
- sle['actual_qty'] = -flt(sle.get('actual_qty'))
+ sle["actual_qty"] = -flt(sle.get("actual_qty"))
- if sle['actual_qty'] < 0 and not sle.get('outgoing_rate'):
- sle['outgoing_rate'] = get_incoming_outgoing_rate_for_cancel(sle.item_code,
- sle.voucher_type, sle.voucher_no, sle.voucher_detail_no)
- sle['incoming_rate'] = 0.0
+ if sle["actual_qty"] < 0 and not sle.get("outgoing_rate"):
+ sle["outgoing_rate"] = get_incoming_outgoing_rate_for_cancel(
+ sle.item_code, sle.voucher_type, sle.voucher_no, sle.voucher_detail_no
+ )
+ sle["incoming_rate"] = 0.0
- if sle['actual_qty'] > 0 and not sle.get('incoming_rate'):
- sle['incoming_rate'] = get_incoming_outgoing_rate_for_cancel(sle.item_code,
- sle.voucher_type, sle.voucher_no, sle.voucher_detail_no)
- sle['outgoing_rate'] = 0.0
+ if sle["actual_qty"] > 0 and not sle.get("incoming_rate"):
+ sle["incoming_rate"] = get_incoming_outgoing_rate_for_cancel(
+ sle.item_code, sle.voucher_type, sle.voucher_no, sle.voucher_detail_no
+ )
+ sle["outgoing_rate"] = 0.0
- if sle.get("actual_qty") or sle.get("voucher_type")=="Stock Reconciliation":
+ if sle.get("actual_qty") or sle.get("voucher_type") == "Stock Reconciliation":
sle_doc = make_entry(sle, allow_negative_stock, via_landed_cost_voucher)
args = sle_doc.as_dict()
@@ -62,125 +78,172 @@ def make_sl_entries(sl_entries, allow_negative_stock=False, via_landed_cost_vouc
# preserve previous_qty_after_transaction for qty reposting
args.previous_qty_after_transaction = sle.get("previous_qty_after_transaction")
- is_stock_item = frappe.get_cached_value('Item', args.get("item_code"), 'is_stock_item')
+ is_stock_item = frappe.get_cached_value("Item", args.get("item_code"), "is_stock_item")
if is_stock_item:
bin_name = get_or_make_bin(args.get("item_code"), args.get("warehouse"))
- update_bin_qty(bin_name, args)
repost_current_voucher(args, allow_negative_stock, via_landed_cost_voucher)
+ update_bin_qty(bin_name, args)
else:
- frappe.msgprint(_("Item {0} ignored since it is not a stock item").format(args.get("item_code")))
+ frappe.msgprint(
+ _("Item {0} ignored since it is not a stock item").format(args.get("item_code"))
+ )
+
def repost_current_voucher(args, allow_negative_stock=False, via_landed_cost_voucher=False):
if args.get("actual_qty") or args.get("voucher_type") == "Stock Reconciliation":
if not args.get("posting_date"):
args["posting_date"] = nowdate()
- if args.get("is_cancelled") and via_landed_cost_voucher:
- return
-
- # Reposts only current voucher SL Entries
- # Updates valuation rate, stock value, stock queue for current transaction
- update_entries_after({
- "item_code": args.get('item_code'),
- "warehouse": args.get('warehouse'),
- "posting_date": args.get("posting_date"),
- "posting_time": args.get("posting_time"),
- "voucher_type": args.get("voucher_type"),
- "voucher_no": args.get("voucher_no"),
- "sle_id": args.get('name'),
- "creation": args.get('creation')
- }, allow_negative_stock=allow_negative_stock, via_landed_cost_voucher=via_landed_cost_voucher)
+ if not (args.get("is_cancelled") and via_landed_cost_voucher):
+ # Reposts only current voucher SL Entries
+ # Updates valuation rate, stock value, stock queue for current transaction
+ update_entries_after(
+ {
+ "item_code": args.get("item_code"),
+ "warehouse": args.get("warehouse"),
+ "posting_date": args.get("posting_date"),
+ "posting_time": args.get("posting_time"),
+ "voucher_type": args.get("voucher_type"),
+ "voucher_no": args.get("voucher_no"),
+ "sle_id": args.get("name"),
+ "creation": args.get("creation"),
+ },
+ allow_negative_stock=allow_negative_stock,
+ via_landed_cost_voucher=via_landed_cost_voucher,
+ )
# update qty in future sle and Validate negative qty
+ # For LCV: update future balances with -ve LCV SLE, which will be balanced by +ve LCV SLE
update_qty_in_future_sle(args, allow_negative_stock)
def get_args_for_future_sle(row):
- return frappe._dict({
- 'voucher_type': row.get('voucher_type'),
- 'voucher_no': row.get('voucher_no'),
- 'posting_date': row.get('posting_date'),
- 'posting_time': row.get('posting_time')
- })
+ return frappe._dict(
+ {
+ "voucher_type": row.get("voucher_type"),
+ "voucher_no": row.get("voucher_no"),
+ "posting_date": row.get("posting_date"),
+ "posting_time": row.get("posting_time"),
+ }
+ )
+
def validate_serial_no(sle):
from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
+
for sn in get_serial_nos(sle.serial_no):
args = copy.deepcopy(sle)
args.serial_no = sn
- args.warehouse = ''
+ args.warehouse = ""
vouchers = []
- for row in get_stock_ledger_entries(args, '>'):
+ for row in get_stock_ledger_entries(args, ">"):
voucher_type = frappe.bold(row.voucher_type)
voucher_no = frappe.bold(get_link_to_form(row.voucher_type, row.voucher_no))
- vouchers.append(f'{voucher_type} {voucher_no}')
+ vouchers.append(f"{voucher_type} {voucher_no}")
if vouchers:
serial_no = frappe.bold(sn)
- msg = (f'''The serial no {serial_no} has been used in the future transactions so you need to cancel them first.
- The list of the transactions are as below.''' + '
- ')
+ msg = (
+ f"""The serial no {serial_no} has been used in the future transactions so you need to cancel them first.
+ The list of the transactions are as below."""
+ + "
- "
+ )
- msg += '
- '.join(vouchers)
- msg += '
'
+ msg += " - ".join(vouchers)
+ msg += "
"
- title = 'Cannot Submit' if not sle.get('is_cancelled') else 'Cannot Cancel'
+ title = "Cannot Submit" if not sle.get("is_cancelled") else "Cannot Cancel"
frappe.throw(_(msg), title=_(title), exc=SerialNoExistsInFutureTransaction)
+
def validate_cancellation(args):
if args[0].get("is_cancelled"):
- repost_entry = frappe.db.get_value("Repost Item Valuation", {
- 'voucher_type': args[0].voucher_type,
- 'voucher_no': args[0].voucher_no,
- 'docstatus': 1
- }, ['name', 'status'], as_dict=1)
+ repost_entry = frappe.db.get_value(
+ "Repost Item Valuation",
+ {"voucher_type": args[0].voucher_type, "voucher_no": args[0].voucher_no, "docstatus": 1},
+ ["name", "status"],
+ as_dict=1,
+ )
if repost_entry:
- if repost_entry.status == 'In Progress':
- frappe.throw(_("Cannot cancel the transaction. Reposting of item valuation on submission is not completed yet."))
- if repost_entry.status == 'Queued':
+ if repost_entry.status == "In Progress":
+ frappe.throw(
+ _(
+ "Cannot cancel the transaction. Reposting of item valuation on submission is not completed yet."
+ )
+ )
+ if repost_entry.status == "Queued":
doc = frappe.get_doc("Repost Item Valuation", repost_entry.name)
+ doc.status = "Skipped"
doc.flags.ignore_permissions = True
doc.cancel()
- doc.delete()
+
def set_as_cancel(voucher_type, voucher_no):
- frappe.db.sql("""update `tabStock Ledger Entry` set is_cancelled=1,
+ frappe.db.sql(
+ """update `tabStock Ledger Entry` set is_cancelled=1,
modified=%s, modified_by=%s
where voucher_type=%s and voucher_no=%s and is_cancelled = 0""",
- (now(), frappe.session.user, voucher_type, voucher_no))
+ (now(), frappe.session.user, voucher_type, voucher_no),
+ )
+
def make_entry(args, allow_negative_stock=False, via_landed_cost_voucher=False):
args["doctype"] = "Stock Ledger Entry"
sle = frappe.get_doc(args)
sle.flags.ignore_permissions = 1
- sle.allow_negative_stock=allow_negative_stock
+ sle.allow_negative_stock = allow_negative_stock
sle.via_landed_cost_voucher = via_landed_cost_voucher
sle.submit()
return sle
-def repost_future_sle(args=None, doc=None, voucher_type=None, voucher_no=None, allow_negative_stock=None, via_landed_cost_voucher=False):
- if not args and voucher_type and voucher_no:
- args = get_items_to_be_repost(voucher_type, voucher_no, doc)
+
+def repost_future_sle(
+ args=None,
+ doc=None,
+ voucher_type=None,
+ voucher_no=None,
+ allow_negative_stock=None,
+ via_landed_cost_voucher=False,
+):
+ if not args:
+ args = [] # set args to empty list if None to avoid enumerate error
+
+ items_to_be_repost = get_items_to_be_repost(
+ voucher_type=voucher_type, voucher_no=voucher_no, doc=doc
+ )
+ if items_to_be_repost:
+ args = items_to_be_repost
distinct_item_warehouses = get_distinct_item_warehouse(args, doc)
+ affected_transactions = get_affected_transactions(doc)
i = get_current_index(doc) or 0
while i < len(args):
- obj = update_entries_after({
- "item_code": args[i].get('item_code'),
- "warehouse": args[i].get('warehouse'),
- "posting_date": args[i].get('posting_date'),
- "posting_time": args[i].get('posting_time'),
- "creation": args[i].get("creation"),
- "distinct_item_warehouses": distinct_item_warehouses
- }, allow_negative_stock=allow_negative_stock, via_landed_cost_voucher=via_landed_cost_voucher)
+ obj = update_entries_after(
+ {
+ "item_code": args[i].get("item_code"),
+ "warehouse": args[i].get("warehouse"),
+ "posting_date": args[i].get("posting_date"),
+ "posting_time": args[i].get("posting_time"),
+ "creation": args[i].get("creation"),
+ "distinct_item_warehouses": distinct_item_warehouses,
+ },
+ allow_negative_stock=allow_negative_stock,
+ via_landed_cost_voucher=via_landed_cost_voucher,
+ )
+ affected_transactions.update(obj.affected_transactions)
- distinct_item_warehouses[(args[i].get('item_code'), args[i].get('warehouse'))].reposting_status = True
+ distinct_item_warehouses[
+ (args[i].get("item_code"), args[i].get("warehouse"))
+ ].reposting_status = True
if obj.new_items_found:
for item_wh, data in iteritems(distinct_item_warehouses):
- if ('args_idx' not in data and not data.reposting_status) or (data.sle_changed and data.reposting_status):
+ if ("args_idx" not in data and not data.reposting_status) or (
+ data.sle_changed and data.reposting_status
+ ):
data.args_idx = len(args)
args.append(data.sle)
elif data.sle_changed and not data.reposting_status:
@@ -189,118 +252,153 @@ def repost_future_sle(args=None, doc=None, voucher_type=None, voucher_no=None, a
data.sle_changed = False
i += 1
- if doc and i % 2 == 0:
- update_args_in_repost_item_valuation(doc, i, args, distinct_item_warehouses)
+ if doc:
+ update_args_in_repost_item_valuation(
+ doc, i, args, distinct_item_warehouses, affected_transactions
+ )
- if doc and args:
- update_args_in_repost_item_valuation(doc, i, args, distinct_item_warehouses)
-def update_args_in_repost_item_valuation(doc, index, args, distinct_item_warehouses):
- frappe.db.set_value(doc.doctype, doc.name, {
- 'items_to_be_repost': json.dumps(args, default=str),
- 'distinct_item_and_warehouse': json.dumps({str(k): v for k,v in distinct_item_warehouses.items()}, default=str),
- 'current_index': index
- })
-
- frappe.db.commit()
-
- frappe.publish_realtime('item_reposting_progress', {
- 'name': doc.name,
- 'items_to_be_repost': json.dumps(args, default=str),
- 'current_index': index
- })
-
-def get_items_to_be_repost(voucher_type, voucher_no, doc=None):
- if doc and doc.items_to_be_repost:
- return json.loads(doc.items_to_be_repost) or []
-
- return frappe.db.get_all("Stock Ledger Entry",
- filters={"voucher_type": voucher_type, "voucher_no": voucher_no},
- fields=["item_code", "warehouse", "posting_date", "posting_time", "creation"],
- order_by="creation asc",
- group_by="item_code, warehouse"
+def update_args_in_repost_item_valuation(
+ doc, index, args, distinct_item_warehouses, affected_transactions
+):
+ doc.db_set(
+ {
+ "items_to_be_repost": json.dumps(args, default=str),
+ "distinct_item_and_warehouse": json.dumps(
+ {str(k): v for k, v in distinct_item_warehouses.items()}, default=str
+ ),
+ "current_index": index,
+ "affected_transactions": frappe.as_json(affected_transactions),
+ }
)
+ if not frappe.flags.in_test:
+ frappe.db.commit()
+
+ frappe.publish_realtime(
+ "item_reposting_progress",
+ {"name": doc.name, "items_to_be_repost": json.dumps(args, default=str), "current_index": index},
+ )
+
+
+def get_items_to_be_repost(voucher_type=None, voucher_no=None, doc=None):
+ items_to_be_repost = []
+ if doc and doc.items_to_be_repost:
+ items_to_be_repost = json.loads(doc.items_to_be_repost) or []
+
+ if not items_to_be_repost and voucher_type and voucher_no:
+ items_to_be_repost = frappe.db.get_all(
+ "Stock Ledger Entry",
+ filters={"voucher_type": voucher_type, "voucher_no": voucher_no},
+ fields=["item_code", "warehouse", "posting_date", "posting_time", "creation"],
+ order_by="creation asc",
+ group_by="item_code, warehouse",
+ )
+
+ return items_to_be_repost
+
+
def get_distinct_item_warehouse(args=None, doc=None):
distinct_item_warehouses = {}
if doc and doc.distinct_item_and_warehouse:
distinct_item_warehouses = json.loads(doc.distinct_item_and_warehouse)
- distinct_item_warehouses = {frappe.safe_eval(k): frappe._dict(v) for k, v in distinct_item_warehouses.items()}
+ distinct_item_warehouses = {
+ frappe.safe_eval(k): frappe._dict(v) for k, v in distinct_item_warehouses.items()
+ }
else:
for i, d in enumerate(args):
- distinct_item_warehouses.setdefault((d.item_code, d.warehouse), frappe._dict({
- "reposting_status": False,
- "sle": d,
- "args_idx": i
- }))
+ distinct_item_warehouses.setdefault(
+ (d.item_code, d.warehouse), frappe._dict({"reposting_status": False, "sle": d, "args_idx": i})
+ )
return distinct_item_warehouses
+
+def get_affected_transactions(doc) -> Set[Tuple[str, str]]:
+ if not doc.affected_transactions:
+ return set()
+
+ transactions = frappe.parse_json(doc.affected_transactions)
+ return {tuple(transaction) for transaction in transactions}
+
+
def get_current_index(doc=None):
if doc and doc.current_index:
return doc.current_index
+
class update_entries_after(object):
"""
- update valution rate and qty after transaction
- from the current time-bucket onwards
+ update valution rate and qty after transaction
+ from the current time-bucket onwards
- :param args: args as dict
+ :param args: args as dict
- args = {
- "item_code": "ABC",
- "warehouse": "XYZ",
- "posting_date": "2012-12-12",
- "posting_time": "12:00"
- }
+ args = {
+ "item_code": "ABC",
+ "warehouse": "XYZ",
+ "posting_date": "2012-12-12",
+ "posting_time": "12:00"
+ }
"""
- def __init__(self, args, allow_zero_rate=False, allow_negative_stock=None, via_landed_cost_voucher=False, verbose=1):
+
+ def __init__(
+ self,
+ args,
+ allow_zero_rate=False,
+ allow_negative_stock=None,
+ via_landed_cost_voucher=False,
+ verbose=1,
+ ):
self.exceptions = {}
self.verbose = verbose
self.allow_zero_rate = allow_zero_rate
self.via_landed_cost_voucher = via_landed_cost_voucher
- self.allow_negative_stock = allow_negative_stock \
- or cint(frappe.db.get_single_value("Stock Settings", "allow_negative_stock"))
+ self.allow_negative_stock = allow_negative_stock or cint(
+ frappe.db.get_single_value("Stock Settings", "allow_negative_stock")
+ )
self.args = frappe._dict(args)
self.item_code = args.get("item_code")
if self.args.sle_id:
- self.args['name'] = self.args.sle_id
+ self.args["name"] = self.args.sle_id
self.company = frappe.get_cached_value("Warehouse", self.args.warehouse, "company")
- self.get_precision()
+ self.set_precision()
self.valuation_method = get_valuation_method(self.item_code)
self.new_items_found = False
self.distinct_item_warehouses = args.get("distinct_item_warehouses", frappe._dict())
+ self.affected_transactions: Set[Tuple[str, str]] = set()
self.data = frappe._dict()
self.initialize_previous_data(self.args)
self.build()
- def get_precision(self):
- company_base_currency = frappe.get_cached_value('Company', self.company, "default_currency")
- self.precision = get_field_precision(frappe.get_meta("Stock Ledger Entry").get_field("stock_value"),
- currency=company_base_currency)
+ def set_precision(self):
+ self.flt_precision = cint(frappe.db.get_default("float_precision")) or 2
+ self.currency_precision = get_field_precision(
+ frappe.get_meta("Stock Ledger Entry").get_field("stock_value")
+ )
def initialize_previous_data(self, args):
"""
- Get previous sl entries for current item for each related warehouse
- and assigns into self.data dict
+ Get previous sl entries for current item for each related warehouse
+ and assigns into self.data dict
- :Data Structure:
+ :Data Structure:
- self.data = {
- warehouse1: {
- 'previus_sle': {},
- 'qty_after_transaction': 10,
- 'valuation_rate': 100,
- 'stock_value': 1000,
- 'prev_stock_value': 1000,
- 'stock_queue': '[[10, 100]]',
- 'stock_value_difference': 1000
- }
- }
+ self.data = {
+ warehouse1: {
+ 'previus_sle': {},
+ 'qty_after_transaction': 10,
+ 'valuation_rate': 100,
+ 'stock_value': 1000,
+ 'prev_stock_value': 1000,
+ 'stock_queue': '[[10, 100]]',
+ 'stock_value_difference': 1000
+ }
+ }
"""
self.data.setdefault(args.warehouse, frappe._dict())
@@ -311,11 +409,13 @@ class update_entries_after(object):
for key in ("qty_after_transaction", "valuation_rate", "stock_value"):
setattr(warehouse_dict, key, flt(previous_sle.get(key)))
- warehouse_dict.update({
- "prev_stock_value": previous_sle.stock_value or 0.0,
- "stock_queue": json.loads(previous_sle.stock_queue or "[]"),
- "stock_value_difference": 0.0
- })
+ warehouse_dict.update(
+ {
+ "prev_stock_value": previous_sle.stock_value or 0.0,
+ "stock_queue": json.loads(previous_sle.stock_queue or "[]"),
+ "stock_value_difference": 0.0,
+ }
+ )
def build(self):
from erpnext.controllers.stock_controller import future_sle_exists
@@ -348,9 +448,10 @@ class update_entries_after(object):
self.process_sle(sle)
def get_sle_against_current_voucher(self):
- self.args['time_format'] = '%H:%i:%s'
+ self.args["time_format"] = "%H:%i:%s"
- return frappe.db.sql("""
+ return frappe.db.sql(
+ """
select
*, timestamp(posting_date, posting_time) as "timestamp"
from
@@ -364,22 +465,29 @@ class update_entries_after(object):
order by
creation ASC
for update
- """, self.args, as_dict=1)
+ """,
+ self.args,
+ as_dict=1,
+ )
def get_future_entries_to_fix(self):
# includes current entry!
- args = self.data[self.args.warehouse].previous_sle \
- or frappe._dict({"item_code": self.item_code, "warehouse": self.args.warehouse})
+ args = self.data[self.args.warehouse].previous_sle or frappe._dict(
+ {"item_code": self.item_code, "warehouse": self.args.warehouse}
+ )
return list(self.get_sle_after_datetime(args))
def get_dependent_entries_to_fix(self, entries_to_fix, sle):
- dependant_sle = get_sle_by_voucher_detail_no(sle.dependant_sle_voucher_detail_no,
- excluded_sle=sle.name)
+ dependant_sle = get_sle_by_voucher_detail_no(
+ sle.dependant_sle_voucher_detail_no, excluded_sle=sle.name
+ )
if not dependant_sle:
return entries_to_fix
- elif dependant_sle.item_code == self.item_code and dependant_sle.warehouse == self.args.warehouse:
+ elif (
+ dependant_sle.item_code == self.item_code and dependant_sle.warehouse == self.args.warehouse
+ ):
return entries_to_fix
elif dependant_sle.item_code != self.item_code:
self.update_distinct_item_warehouses(dependant_sle)
@@ -387,36 +495,31 @@ class update_entries_after(object):
elif dependant_sle.item_code == self.item_code and dependant_sle.warehouse in self.data:
return entries_to_fix
else:
- return self.append_future_sle_for_dependant(dependant_sle, entries_to_fix)
+ self.initialize_previous_data(dependant_sle)
+ self.update_distinct_item_warehouses(dependant_sle)
+ return entries_to_fix
def update_distinct_item_warehouses(self, dependant_sle):
key = (dependant_sle.item_code, dependant_sle.warehouse)
- val = frappe._dict({
- "sle": dependant_sle
- })
+ val = frappe._dict({"sle": dependant_sle})
if key not in self.distinct_item_warehouses:
self.distinct_item_warehouses[key] = val
self.new_items_found = True
else:
- existing_sle_posting_date = self.distinct_item_warehouses[key].get("sle", {}).get("posting_date")
+ existing_sle_posting_date = (
+ self.distinct_item_warehouses[key].get("sle", {}).get("posting_date")
+ )
if getdate(dependant_sle.posting_date) < getdate(existing_sle_posting_date):
val.sle_changed = True
self.distinct_item_warehouses[key] = val
self.new_items_found = True
- def append_future_sle_for_dependant(self, dependant_sle, entries_to_fix):
- self.initialize_previous_data(dependant_sle)
-
- args = self.data[dependant_sle.warehouse].previous_sle \
- or frappe._dict({"item_code": self.item_code, "warehouse": dependant_sle.warehouse})
- future_sle_for_dependant = list(self.get_sle_after_datetime(args))
-
- entries_to_fix.extend(future_sle_for_dependant)
- return sorted(entries_to_fix, key=lambda k: k['timestamp'])
-
def process_sle(self, sle):
+ from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
+
# previous sle data for this warehouse
self.wh_data = self.data[sle.warehouse]
+ self.affected_transactions.add((sle.voucher_type, sle.voucher_no))
if (sle.serial_no and not self.via_landed_cost_voucher) or not cint(self.allow_negative_stock):
# validate negative stock for serialized items, fifo valuation
@@ -429,32 +532,43 @@ class update_entries_after(object):
if not self.args.get("sle_id"):
self.get_dynamic_incoming_outgoing_rate(sle)
- if sle.serial_no:
+ if get_serial_nos(sle.serial_no):
self.get_serialized_values(sle)
self.wh_data.qty_after_transaction += flt(sle.actual_qty)
if sle.voucher_type == "Stock Reconciliation":
self.wh_data.qty_after_transaction = sle.qty_after_transaction
- self.wh_data.stock_value = flt(self.wh_data.qty_after_transaction) * flt(self.wh_data.valuation_rate)
+ self.wh_data.stock_value = flt(self.wh_data.qty_after_transaction) * flt(
+ self.wh_data.valuation_rate
+ )
else:
- if sle.voucher_type=="Stock Reconciliation" and not sle.batch_no:
+ if sle.voucher_type == "Stock Reconciliation" and not sle.batch_no:
# assert
self.wh_data.valuation_rate = sle.valuation_rate
self.wh_data.qty_after_transaction = sle.qty_after_transaction
- self.wh_data.stock_queue = [[self.wh_data.qty_after_transaction, self.wh_data.valuation_rate]]
- self.wh_data.stock_value = flt(self.wh_data.qty_after_transaction) * flt(self.wh_data.valuation_rate)
+ self.wh_data.stock_value = flt(self.wh_data.qty_after_transaction) * flt(
+ self.wh_data.valuation_rate
+ )
+ if self.valuation_method != "Moving Average":
+ self.wh_data.stock_queue = [[self.wh_data.qty_after_transaction, self.wh_data.valuation_rate]]
else:
if self.valuation_method == "Moving Average":
self.get_moving_average_values(sle)
self.wh_data.qty_after_transaction += flt(sle.actual_qty)
- self.wh_data.stock_value = flt(self.wh_data.qty_after_transaction) * flt(self.wh_data.valuation_rate)
+ self.wh_data.stock_value = flt(self.wh_data.qty_after_transaction) * flt(
+ self.wh_data.valuation_rate
+ )
else:
self.get_fifo_values(sle)
self.wh_data.qty_after_transaction += flt(sle.actual_qty)
- self.wh_data.stock_value = sum((flt(batch[0]) * flt(batch[1]) for batch in self.wh_data.stock_queue))
+ self.wh_data.stock_value = sum(
+ (flt(batch[0]) * flt(batch[1]) for batch in self.wh_data.stock_queue)
+ )
# rounding as per precision
- self.wh_data.stock_value = flt(self.wh_data.stock_value, self.precision)
+ self.wh_data.stock_value = flt(self.wh_data.stock_value, self.currency_precision)
+ if not self.wh_data.qty_after_transaction:
+ self.wh_data.stock_value = 0.0
stock_value_difference = self.wh_data.stock_value - self.wh_data.prev_stock_value
self.wh_data.prev_stock_value = self.wh_data.stock_value
@@ -464,7 +578,7 @@ class update_entries_after(object):
sle.stock_value = self.wh_data.stock_value
sle.stock_queue = json.dumps(self.wh_data.stock_queue)
sle.stock_value_difference = stock_value_difference
- sle.doctype="Stock Ledger Entry"
+ sle.doctype = "Stock Ledger Entry"
frappe.get_doc(sle).db_update()
if not self.args.get("sle_id"):
@@ -472,10 +586,11 @@ class update_entries_after(object):
def validate_negative_stock(self, sle):
"""
- validate negative stock for entries current datetime onwards
- will not consider cancelled entries
+ validate negative stock for entries current datetime onwards
+ will not consider cancelled entries
"""
diff = self.wh_data.qty_after_transaction + flt(sle.actual_qty)
+ diff = flt(diff, self.flt_precision) # respect system precision
if diff < 0 and abs(diff) > 0.0001:
# negative stock!
@@ -502,13 +617,46 @@ class update_entries_after(object):
self.recalculate_amounts_in_stock_entry(sle.voucher_no)
rate = frappe.db.get_value("Stock Entry Detail", sle.voucher_detail_no, "valuation_rate")
# Sales and Purchase Return
- elif sle.voucher_type in ("Purchase Receipt", "Purchase Invoice", "Delivery Note", "Sales Invoice"):
+ elif sle.voucher_type in (
+ "Purchase Receipt",
+ "Purchase Invoice",
+ "Delivery Note",
+ "Sales Invoice",
+ ):
if frappe.get_cached_value(sle.voucher_type, sle.voucher_no, "is_return"):
from erpnext.controllers.sales_and_purchase_return import (
get_rate_for_return, # don't move this import to top
)
- rate = get_rate_for_return(sle.voucher_type, sle.voucher_no, sle.item_code,
- voucher_detail_no=sle.voucher_detail_no, sle = sle)
+
+ rate = get_rate_for_return(
+ sle.voucher_type,
+ sle.voucher_no,
+ sle.item_code,
+ voucher_detail_no=sle.voucher_detail_no,
+ sle=sle,
+ )
+
+ elif (
+ sle.voucher_type in ["Purchase Receipt", "Purchase Invoice"]
+ and sle.voucher_detail_no
+ and frappe.get_cached_value(sle.voucher_type, sle.voucher_no, "is_internal_supplier")
+ ):
+ field = (
+ "delivery_note_item" if sle.voucher_type == "Purchase Receipt" else "sales_invoice_item"
+ )
+ doctype = (
+ "Delivery Note Item" if sle.voucher_type == "Purchase Receipt" else "Sales Invoice Item"
+ )
+ refernce_name = frappe.get_cached_value(
+ sle.voucher_type + " Item", sle.voucher_detail_no, field
+ )
+
+ if refernce_name:
+ rate = frappe.get_cached_value(
+ doctype,
+ refernce_name,
+ "incoming_rate",
+ )
else:
if sle.voucher_type in ("Purchase Receipt", "Purchase Invoice"):
rate_field = "valuation_rate"
@@ -516,8 +664,9 @@ class update_entries_after(object):
rate_field = "incoming_rate"
# check in item table
- item_code, incoming_rate = frappe.db.get_value(sle.voucher_type + " Item",
- sle.voucher_detail_no, ["item_code", rate_field])
+ item_code, incoming_rate = frappe.db.get_value(
+ sle.voucher_type + " Item", sle.voucher_detail_no, ["item_code", rate_field]
+ )
if item_code == sle.item_code:
rate = incoming_rate
@@ -527,15 +676,18 @@ class update_entries_after(object):
else:
ref_doctype = "Purchase Receipt Item Supplied"
- rate = frappe.db.get_value(ref_doctype, {"parent_detail_docname": sle.voucher_detail_no,
- "item_code": sle.item_code}, rate_field)
+ rate = frappe.db.get_value(
+ ref_doctype,
+ {"parent_detail_docname": sle.voucher_detail_no, "item_code": sle.item_code},
+ rate_field,
+ )
return rate
def update_outgoing_rate_on_transaction(self, sle):
"""
- Update outgoing rate in Stock Entry, Delivery Note, Sales Invoice and Sales Return
- In case of Stock Entry, also calculate FG Item rate and total incoming/outgoing amount
+ Update outgoing rate in Stock Entry, Delivery Note, Sales Invoice and Sales Return
+ In case of Stock Entry, also calculate FG Item rate and total incoming/outgoing amount
"""
if sle.actual_qty and sle.voucher_detail_no:
outgoing_rate = abs(flt(sle.stock_value_difference)) / abs(sle.actual_qty)
@@ -565,24 +717,38 @@ class update_entries_after(object):
# Update item's incoming rate on transaction
item_code = frappe.db.get_value(sle.voucher_type + " Item", sle.voucher_detail_no, "item_code")
if item_code == sle.item_code:
- frappe.db.set_value(sle.voucher_type + " Item", sle.voucher_detail_no, "incoming_rate", outgoing_rate)
+ frappe.db.set_value(
+ sle.voucher_type + " Item", sle.voucher_detail_no, "incoming_rate", outgoing_rate
+ )
else:
# packed item
- frappe.db.set_value("Packed Item",
+ frappe.db.set_value(
+ "Packed Item",
{"parent_detail_docname": sle.voucher_detail_no, "item_code": sle.item_code},
- "incoming_rate", outgoing_rate)
+ "incoming_rate",
+ outgoing_rate,
+ )
def update_rate_on_purchase_receipt(self, sle, outgoing_rate):
if frappe.db.exists(sle.voucher_type + " Item", sle.voucher_detail_no):
- frappe.db.set_value(sle.voucher_type + " Item", sle.voucher_detail_no, "base_net_rate", outgoing_rate)
+ frappe.db.set_value(
+ sle.voucher_type + " Item",
+ sle.voucher_detail_no,
+ {
+ "base_net_rate": outgoing_rate,
+ "valuation_rate": outgoing_rate,
+ },
+ )
else:
- frappe.db.set_value("Purchase Receipt Item Supplied", sle.voucher_detail_no, "rate", outgoing_rate)
+ frappe.db.set_value(
+ "Purchase Receipt Item Supplied", sle.voucher_detail_no, "rate", outgoing_rate
+ )
# Recalculate subcontracted item's rate in case of subcontracted purchase receipt/invoice
- if frappe.get_cached_value(sle.voucher_type, sle.voucher_no, "is_subcontracted") == 'Yes':
+ if frappe.get_cached_value(sle.voucher_type, sle.voucher_no, "is_subcontracted") == "Yes":
doc = frappe.get_doc(sle.voucher_type, sle.voucher_no)
doc.update_valuation_rate(reset_outgoing_rate=False)
- for d in (doc.items + doc.supplied_items):
+ for d in doc.items + doc.supplied_items:
d.db_update()
def get_serialized_values(self, sle):
@@ -595,9 +761,9 @@ class update_entries_after(object):
incoming_rate = self.wh_data.valuation_rate
stock_value_change = 0
- if incoming_rate:
+ if actual_qty > 0:
stock_value_change = actual_qty * incoming_rate
- elif actual_qty < 0:
+ else:
# In case of delivery/stock issue, get average purchase rate
# of serial nos of current entry
if not sle.is_cancelled:
@@ -609,36 +775,40 @@ class update_entries_after(object):
new_stock_qty = self.wh_data.qty_after_transaction + actual_qty
if new_stock_qty > 0:
- new_stock_value = (self.wh_data.qty_after_transaction * self.wh_data.valuation_rate) + stock_value_change
+ new_stock_value = (
+ self.wh_data.qty_after_transaction * self.wh_data.valuation_rate
+ ) + stock_value_change
if new_stock_value >= 0:
# calculate new valuation rate only if stock value is positive
# else it remains the same as that of previous entry
self.wh_data.valuation_rate = new_stock_value / new_stock_qty
if not self.wh_data.valuation_rate and sle.voucher_detail_no:
- allow_zero_rate = self.check_if_allow_zero_valuation_rate(sle.voucher_type, sle.voucher_detail_no)
+ allow_zero_rate = self.check_if_allow_zero_valuation_rate(
+ sle.voucher_type, sle.voucher_detail_no
+ )
if not allow_zero_rate:
- self.wh_data.valuation_rate = get_valuation_rate(sle.item_code, sle.warehouse,
- sle.voucher_type, sle.voucher_no, self.allow_zero_rate,
- currency=erpnext.get_company_currency(sle.company), company=sle.company)
+ self.wh_data.valuation_rate = self.get_fallback_rate(sle)
def get_incoming_value_for_serial_nos(self, sle, serial_nos):
# get rate from serial nos within same company
- all_serial_nos = frappe.get_all("Serial No",
- fields=["purchase_rate", "name", "company"],
- filters = {'name': ('in', serial_nos)})
+ all_serial_nos = frappe.get_all(
+ "Serial No", fields=["purchase_rate", "name", "company"], filters={"name": ("in", serial_nos)}
+ )
- incoming_values = sum(flt(d.purchase_rate) for d in all_serial_nos if d.company==sle.company)
+ incoming_values = sum(flt(d.purchase_rate) for d in all_serial_nos if d.company == sle.company)
# Get rate for serial nos which has been transferred to other company
- invalid_serial_nos = [d.name for d in all_serial_nos if d.company!=sle.company]
+ invalid_serial_nos = [d.name for d in all_serial_nos if d.company != sle.company]
for serial_no in invalid_serial_nos:
- incoming_rate = frappe.db.sql("""
+ incoming_rate = frappe.db.sql(
+ """
select incoming_rate
from `tabStock Ledger Entry`
where
company = %s
and actual_qty > 0
+ and is_cancelled = 0
and (serial_no = %s
or serial_no like %s
or serial_no like %s
@@ -646,7 +816,9 @@ class update_entries_after(object):
)
order by posting_date desc
limit 1
- """, (sle.company, serial_no, serial_no+'\n%', '%\n'+serial_no, '%\n'+serial_no+'\n%'))
+ """,
+ (sle.company, serial_no, serial_no + "\n%", "%\n" + serial_no, "%\n" + serial_no + "\n%"),
+ )
incoming_values += flt(incoming_rate[0][0]) if incoming_rate else 0
@@ -660,15 +832,17 @@ class update_entries_after(object):
if flt(self.wh_data.qty_after_transaction) <= 0:
self.wh_data.valuation_rate = sle.incoming_rate
else:
- new_stock_value = (self.wh_data.qty_after_transaction * self.wh_data.valuation_rate) + \
- (actual_qty * sle.incoming_rate)
+ new_stock_value = (self.wh_data.qty_after_transaction * self.wh_data.valuation_rate) + (
+ actual_qty * sle.incoming_rate
+ )
self.wh_data.valuation_rate = new_stock_value / new_stock_qty
elif sle.outgoing_rate:
if new_stock_qty:
- new_stock_value = (self.wh_data.qty_after_transaction * self.wh_data.valuation_rate) + \
- (actual_qty * sle.outgoing_rate)
+ new_stock_value = (self.wh_data.qty_after_transaction * self.wh_data.valuation_rate) + (
+ actual_qty * sle.outgoing_rate
+ )
self.wh_data.valuation_rate = new_stock_value / new_stock_qty
else:
@@ -683,11 +857,11 @@ class update_entries_after(object):
# Get valuation rate from previous SLE or Item master, if item does not have the
# allow zero valuration rate flag set
if not self.wh_data.valuation_rate and sle.voucher_detail_no:
- allow_zero_valuation_rate = self.check_if_allow_zero_valuation_rate(sle.voucher_type, sle.voucher_detail_no)
+ allow_zero_valuation_rate = self.check_if_allow_zero_valuation_rate(
+ sle.voucher_type, sle.voucher_detail_no
+ )
if not allow_zero_valuation_rate:
- self.wh_data.valuation_rate = get_valuation_rate(sle.item_code, sle.warehouse,
- sle.voucher_type, sle.voucher_no, self.allow_zero_rate,
- currency=erpnext.get_company_currency(sle.company), company=sle.company)
+ self.wh_data.valuation_rate = self.get_fallback_rate(sle)
def get_fifo_values(self, sle):
incoming_rate = flt(sle.incoming_rate)
@@ -699,28 +873,28 @@ class update_entries_after(object):
self.wh_data.stock_queue.append([0, 0])
# last row has the same rate, just updated the qty
- if self.wh_data.stock_queue[-1][1]==incoming_rate:
+ if self.wh_data.stock_queue[-1][1] == incoming_rate:
self.wh_data.stock_queue[-1][0] += actual_qty
else:
# Item has a positive balance qty, add new entry
if self.wh_data.stock_queue[-1][0] > 0:
self.wh_data.stock_queue.append([actual_qty, incoming_rate])
- else: # negative balance qty
+ else: # negative balance qty
qty = self.wh_data.stock_queue[-1][0] + actual_qty
- if qty > 0: # new balance qty is positive
+ if qty > 0: # new balance qty is positive
self.wh_data.stock_queue[-1] = [qty, incoming_rate]
- else: # new balance qty is still negative, maintain same rate
+ else: # new balance qty is still negative, maintain same rate
self.wh_data.stock_queue[-1][0] = qty
else:
qty_to_pop = abs(actual_qty)
while qty_to_pop:
if not self.wh_data.stock_queue:
# Get valuation rate from last sle if exists or from valuation rate field in item master
- allow_zero_valuation_rate = self.check_if_allow_zero_valuation_rate(sle.voucher_type, sle.voucher_detail_no)
+ allow_zero_valuation_rate = self.check_if_allow_zero_valuation_rate(
+ sle.voucher_type, sle.voucher_detail_no
+ )
if not allow_zero_valuation_rate:
- _rate = get_valuation_rate(sle.item_code, sle.warehouse,
- sle.voucher_type, sle.voucher_no, self.allow_zero_rate,
- currency=erpnext.get_company_currency(sle.company), company=sle.company)
+ _rate = self.get_fallback_rate(sle)
else:
_rate = 0
@@ -734,12 +908,9 @@ class update_entries_after(object):
index = i
break
- # If no entry found with outgoing rate, collapse stack
+ # If no entry found with outgoing rate, consume as per FIFO
if index is None: # nosemgrep
- new_stock_value = sum((d[0]*d[1] for d in self.wh_data.stock_queue)) - qty_to_pop*outgoing_rate
- new_stock_qty = sum((d[0] for d in self.wh_data.stock_queue)) - qty_to_pop
- self.wh_data.stock_queue = [[new_stock_qty, new_stock_value/new_stock_qty if new_stock_qty > 0 else outgoing_rate]]
- break
+ index = 0
else:
index = 0
@@ -761,14 +932,18 @@ class update_entries_after(object):
batch[0] = batch[0] - qty_to_pop
qty_to_pop = 0
- stock_value = _round_off_if_near_zero(sum((flt(batch[0]) * flt(batch[1]) for batch in self.wh_data.stock_queue)))
+ stock_value = _round_off_if_near_zero(
+ sum((flt(batch[0]) * flt(batch[1]) for batch in self.wh_data.stock_queue))
+ )
stock_qty = _round_off_if_near_zero(sum((flt(batch[0]) for batch in self.wh_data.stock_queue)))
if stock_qty:
self.wh_data.valuation_rate = stock_value / flt(stock_qty)
if not self.wh_data.stock_queue:
- self.wh_data.stock_queue.append([0, sle.incoming_rate or sle.outgoing_rate or self.wh_data.valuation_rate])
+ self.wh_data.stock_queue.append(
+ [0, sle.incoming_rate or sle.outgoing_rate or self.wh_data.valuation_rate]
+ )
def check_if_allow_zero_valuation_rate(self, voucher_type, voucher_detail_no):
ref_item_dt = ""
@@ -783,6 +958,19 @@ class update_entries_after(object):
else:
return 0
+ def get_fallback_rate(self, sle) -> float:
+ """When exact incoming rate isn't available use any of other "average" rates as fallback.
+ This should only get used for negative stock."""
+ return get_valuation_rate(
+ sle.item_code,
+ sle.warehouse,
+ sle.voucher_type,
+ sle.voucher_no,
+ self.allow_zero_rate,
+ currency=erpnext.get_company_currency(sle.company),
+ company=sle.company,
+ )
+
def get_sle_before_datetime(self, args):
"""get previous stock ledger entry before current time-bucket"""
sle = get_stock_ledger_entries(args, "<", "desc", "limit 1", for_update=False)
@@ -798,18 +986,27 @@ class update_entries_after(object):
for warehouse, exceptions in iteritems(self.exceptions):
deficiency = min(e["diff"] for e in exceptions)
- if ((exceptions[0]["voucher_type"], exceptions[0]["voucher_no"]) in
- frappe.local.flags.currently_saving):
+ if (
+ exceptions[0]["voucher_type"],
+ exceptions[0]["voucher_no"],
+ ) in frappe.local.flags.currently_saving:
msg = _("{0} units of {1} needed in {2} to complete this transaction.").format(
- abs(deficiency), frappe.get_desk_link('Item', exceptions[0]["item_code"]),
- frappe.get_desk_link('Warehouse', warehouse))
+ abs(deficiency),
+ frappe.get_desk_link("Item", exceptions[0]["item_code"]),
+ frappe.get_desk_link("Warehouse", warehouse),
+ )
else:
- msg = _("{0} units of {1} needed in {2} on {3} {4} for {5} to complete this transaction.").format(
- abs(deficiency), frappe.get_desk_link('Item', exceptions[0]["item_code"]),
- frappe.get_desk_link('Warehouse', warehouse),
- exceptions[0]["posting_date"], exceptions[0]["posting_time"],
- frappe.get_desk_link(exceptions[0]["voucher_type"], exceptions[0]["voucher_no"]))
+ msg = _(
+ "{0} units of {1} needed in {2} on {3} {4} for {5} to complete this transaction."
+ ).format(
+ abs(deficiency),
+ frappe.get_desk_link("Item", exceptions[0]["item_code"]),
+ frappe.get_desk_link("Warehouse", warehouse),
+ exceptions[0]["posting_date"],
+ exceptions[0]["posting_time"],
+ frappe.get_desk_link(exceptions[0]["voucher_type"], exceptions[0]["voucher_no"]),
+ )
if msg:
msg_list.append(msg)
@@ -817,7 +1014,7 @@ class update_entries_after(object):
if msg_list:
message = "\n\n".join(msg_list)
if self.verbose:
- frappe.throw(message, NegativeStockError, title='Insufficient Stock')
+ frappe.throw(message, NegativeStockError, title=_("Insufficient Stock"))
else:
raise NegativeStockError(message)
@@ -826,17 +1023,16 @@ class update_entries_after(object):
for warehouse, data in self.data.items():
bin_name = get_or_make_bin(self.item_code, warehouse)
- frappe.db.set_value('Bin', bin_name, {
- "valuation_rate": data.valuation_rate,
- "actual_qty": data.qty_after_transaction,
- "stock_value": data.stock_value
- })
+ updated_values = {"actual_qty": data.qty_after_transaction, "stock_value": data.stock_value}
+ if data.valuation_rate is not None:
+ updated_values["valuation_rate"] = data.valuation_rate
+ frappe.db.set_value("Bin", bin_name, updated_values)
def get_previous_sle_of_current_voucher(args, exclude_current_voucher=False):
"""get stock ledger entries filtered by specific posting datetime conditions"""
- args['time_format'] = '%H:%i:%s'
+ args["time_format"] = "%H:%i:%s"
if not args.get("posting_date"):
args["posting_date"] = "1900-01-01"
if not args.get("posting_time"):
@@ -847,7 +1043,8 @@ def get_previous_sle_of_current_voucher(args, exclude_current_voucher=False):
voucher_no = args.get("voucher_no")
voucher_condition = f"and voucher_no != '{voucher_no}'"
- sle = frappe.db.sql("""
+ sle = frappe.db.sql(
+ """
select *, timestamp(posting_date, posting_time) as "timestamp"
from `tabStock Ledger Entry`
where item_code = %(item_code)s
@@ -857,32 +1054,48 @@ def get_previous_sle_of_current_voucher(args, exclude_current_voucher=False):
and timestamp(posting_date, time_format(posting_time, %(time_format)s)) < timestamp(%(posting_date)s, time_format(%(posting_time)s, %(time_format)s))
order by timestamp(posting_date, posting_time) desc, creation desc
limit 1
- for update""".format(voucher_condition=voucher_condition), args, as_dict=1)
+ for update""".format(
+ voucher_condition=voucher_condition
+ ),
+ args,
+ as_dict=1,
+ )
return sle[0] if sle else frappe._dict()
+
def get_previous_sle(args, for_update=False):
"""
- get the last sle on or before the current time-bucket,
- to get actual qty before transaction, this function
- is called from various transaction like stock entry, reco etc
+ get the last sle on or before the current time-bucket,
+ to get actual qty before transaction, this function
+ is called from various transaction like stock entry, reco etc
- args = {
- "item_code": "ABC",
- "warehouse": "XYZ",
- "posting_date": "2012-12-12",
- "posting_time": "12:00",
- "sle": "name of reference Stock Ledger Entry"
- }
+ args = {
+ "item_code": "ABC",
+ "warehouse": "XYZ",
+ "posting_date": "2012-12-12",
+ "posting_time": "12:00",
+ "sle": "name of reference Stock Ledger Entry"
+ }
"""
args["name"] = args.get("sle", None) or ""
sle = get_stock_ledger_entries(args, "<=", "desc", "limit 1", for_update=for_update)
return sle and sle[0] or {}
-def get_stock_ledger_entries(previous_sle, operator=None,
- order="desc", limit=None, for_update=False, debug=False, check_serial_no=True):
+
+def get_stock_ledger_entries(
+ previous_sle,
+ operator=None,
+ order="desc",
+ limit=None,
+ for_update=False,
+ debug=False,
+ check_serial_no=True,
+):
"""get stock ledger entries filtered by specific posting datetime conditions"""
- conditions = " and timestamp(posting_date, posting_time) {0} timestamp(%(posting_date)s, %(posting_time)s)".format(operator)
+ conditions = " and timestamp(posting_date, posting_time) {0} timestamp(%(posting_date)s, %(posting_time)s)".format(
+ operator
+ )
if previous_sle.get("warehouse"):
conditions += " and warehouse = %(warehouse)s"
elif previous_sle.get("warehouse_condition"):
@@ -891,15 +1104,21 @@ def get_stock_ledger_entries(previous_sle, operator=None,
if check_serial_no and previous_sle.get("serial_no"):
# conditions += " and serial_no like {}".format(frappe.db.escape('%{0}%'.format(previous_sle.get("serial_no"))))
serial_no = previous_sle.get("serial_no")
- conditions += (""" and
+ conditions += (
+ """ and
(
serial_no = {0}
or serial_no like {1}
or serial_no like {2}
or serial_no like {3}
)
- """).format(frappe.db.escape(serial_no), frappe.db.escape('{}\n%'.format(serial_no)),
- frappe.db.escape('%\n{}'.format(serial_no)), frappe.db.escape('%\n{}\n%'.format(serial_no)))
+ """
+ ).format(
+ frappe.db.escape(serial_no),
+ frappe.db.escape("{}\n%".format(serial_no)),
+ frappe.db.escape("%\n{}".format(serial_no)),
+ frappe.db.escape("%\n{}\n%".format(serial_no)),
+ )
if not previous_sle.get("posting_date"):
previous_sle["posting_date"] = "1900-01-01"
@@ -909,51 +1128,83 @@ def get_stock_ledger_entries(previous_sle, operator=None,
if operator in (">", "<=") and previous_sle.get("name"):
conditions += " and name!=%(name)s"
- return frappe.db.sql("""
+ return frappe.db.sql(
+ """
select *, timestamp(posting_date, posting_time) as "timestamp"
from `tabStock Ledger Entry`
where item_code = %%(item_code)s
and is_cancelled = 0
%(conditions)s
order by timestamp(posting_date, posting_time) %(order)s, creation %(order)s
- %(limit)s %(for_update)s""" % {
+ %(limit)s %(for_update)s"""
+ % {
"conditions": conditions,
"limit": limit or "",
"for_update": for_update and "for update" or "",
- "order": order
- }, previous_sle, as_dict=1, debug=debug)
+ "order": order,
+ },
+ previous_sle,
+ as_dict=1,
+ debug=debug,
+ )
+
def get_sle_by_voucher_detail_no(voucher_detail_no, excluded_sle=None):
- return frappe.db.get_value('Stock Ledger Entry',
- {'voucher_detail_no': voucher_detail_no, 'name': ['!=', excluded_sle]},
- ['item_code', 'warehouse', 'posting_date', 'posting_time', 'timestamp(posting_date, posting_time) as timestamp'],
- as_dict=1)
+ return frappe.db.get_value(
+ "Stock Ledger Entry",
+ {"voucher_detail_no": voucher_detail_no, "name": ["!=", excluded_sle]},
+ [
+ "item_code",
+ "warehouse",
+ "posting_date",
+ "posting_time",
+ "timestamp(posting_date, posting_time) as timestamp",
+ ],
+ as_dict=1,
+ )
-def get_valuation_rate(item_code, warehouse, voucher_type, voucher_no,
- allow_zero_rate=False, currency=None, company=None, raise_error_if_no_rate=True):
+
+def get_valuation_rate(
+ item_code,
+ warehouse,
+ voucher_type,
+ voucher_no,
+ allow_zero_rate=False,
+ currency=None,
+ company=None,
+ raise_error_if_no_rate=True,
+):
if not company:
- company = frappe.get_cached_value("Warehouse", warehouse, "company")
+ company = frappe.get_cached_value("Warehouse", warehouse, "company")
# Get valuation rate from last sle for the same item and warehouse
- last_valuation_rate = frappe.db.sql("""select valuation_rate
+ last_valuation_rate = frappe.db.sql(
+ """select valuation_rate
from `tabStock Ledger Entry` force index (item_warehouse)
where
item_code = %s
AND warehouse = %s
AND valuation_rate >= 0
+ AND is_cancelled = 0
AND NOT (voucher_no = %s AND voucher_type = %s)
- order by posting_date desc, posting_time desc, name desc limit 1""", (item_code, warehouse, voucher_no, voucher_type))
+ order by posting_date desc, posting_time desc, name desc limit 1""",
+ (item_code, warehouse, voucher_no, voucher_type),
+ )
if not last_valuation_rate:
# Get valuation rate from last sle for the item against any warehouse
- last_valuation_rate = frappe.db.sql("""select valuation_rate
+ last_valuation_rate = frappe.db.sql(
+ """select valuation_rate
from `tabStock Ledger Entry` force index (item_code)
where
item_code = %s
AND valuation_rate > 0
+ AND is_cancelled = 0
AND NOT(voucher_no = %s AND voucher_type = %s)
- order by posting_date desc, posting_time desc, name desc limit 1""", (item_code, voucher_no, voucher_type))
+ order by posting_date desc, posting_time desc, name desc limit 1""",
+ (item_code, voucher_no, voucher_type),
+ )
if last_valuation_rate:
return flt(last_valuation_rate[0][0])
@@ -968,19 +1219,37 @@ def get_valuation_rate(item_code, warehouse, voucher_type, voucher_no,
if not valuation_rate:
# try in price list
- valuation_rate = frappe.db.get_value('Item Price',
- dict(item_code=item_code, buying=1, currency=currency),
- 'price_list_rate')
+ valuation_rate = frappe.db.get_value(
+ "Item Price", dict(item_code=item_code, buying=1, currency=currency), "price_list_rate"
+ )
- if not allow_zero_rate and not valuation_rate and raise_error_if_no_rate \
- and cint(erpnext.is_perpetual_inventory_enabled(company)):
+ if (
+ not allow_zero_rate
+ and not valuation_rate
+ and raise_error_if_no_rate
+ and cint(erpnext.is_perpetual_inventory_enabled(company))
+ ):
frappe.local.message_log = []
form_link = get_link_to_form("Item", item_code)
- message = _("Valuation Rate for the Item {0}, is required to do accounting entries for {1} {2}.").format(form_link, voucher_type, voucher_no)
+ message = _(
+ "Valuation Rate for the Item {0}, is required to do accounting entries for {1} {2}."
+ ).format(form_link, voucher_type, voucher_no)
message += "
" + _("Here are the options to proceed:")
- solutions = "" + _("If the item is transacting as a Zero Valuation Rate item in this entry, please enable 'Allow Zero Valuation Rate' in the {0} Item table.").format(voucher_type) + " "
- solutions += "" + _("If not, you can Cancel / Submit this entry") + " {0} ".format(frappe.bold("after")) + _("performing either one below:") + " "
+ solutions = (
+ ""
+ + _(
+ "If the item is transacting as a Zero Valuation Rate item in this entry, please enable 'Allow Zero Valuation Rate' in the {0} Item table."
+ ).format(voucher_type)
+ + " "
+ )
+ solutions += (
+ ""
+ + _("If not, you can Cancel / Submit this entry")
+ + " {0} ".format(frappe.bold("after"))
+ + _("performing either one below:")
+ + " "
+ )
sub_solutions = "- " + _("Create an incoming stock transaction for the Item.") + "
"
sub_solutions += "- " + _("Mention Valuation Rate in the Item master.") + "
"
msg = message + solutions + sub_solutions + ""
@@ -989,11 +1258,14 @@ def get_valuation_rate(item_code, warehouse, voucher_type, voucher_no,
return valuation_rate
+
def update_qty_in_future_sle(args, allow_negative_stock=False):
"""Recalculate Qty after Transaction in future SLEs based on current SLE."""
datetime_limit_condition = ""
qty_shift = args.actual_qty
+ args["time_format"] = "%H:%i:%s"
+
# find difference/shift in qty caused by stock reconciliation
if args.voucher_type == "Stock Reconciliation":
qty_shift = get_stock_reco_qty_shift(args)
@@ -1005,7 +1277,8 @@ def update_qty_in_future_sle(args, allow_negative_stock=False):
# add condition to update SLEs before this date & time
datetime_limit_condition = get_datetime_limit_condition(detail)
- frappe.db.sql("""
+ frappe.db.sql(
+ f"""
update `tabStock Ledger Entry`
set qty_after_transaction = qty_after_transaction + {qty_shift}
where
@@ -1013,17 +1286,16 @@ def update_qty_in_future_sle(args, allow_negative_stock=False):
and warehouse = %(warehouse)s
and voucher_no != %(voucher_no)s
and is_cancelled = 0
- and (timestamp(posting_date, posting_time) > timestamp(%(posting_date)s, %(posting_time)s)
- or (
- timestamp(posting_date, posting_time) = timestamp(%(posting_date)s, %(posting_time)s)
- and creation > %(creation)s
- )
- )
+ and timestamp(posting_date, time_format(posting_time, %(time_format)s))
+ > timestamp(%(posting_date)s, time_format(%(posting_time)s, %(time_format)s))
{datetime_limit_condition}
- """.format(qty_shift=qty_shift, datetime_limit_condition=datetime_limit_condition), args)
+ """,
+ args,
+ )
validate_negative_qty_in_future_sle(args, allow_negative_stock)
+
def get_stock_reco_qty_shift(args):
stock_reco_qty_shift = 0
if args.get("is_cancelled"):
@@ -1035,8 +1307,9 @@ def get_stock_reco_qty_shift(args):
stock_reco_qty_shift = flt(args.actual_qty)
else:
# reco is being submitted
- last_balance = get_previous_sle_of_current_voucher(args,
- exclude_current_voucher=True).get("qty_after_transaction")
+ last_balance = get_previous_sle_of_current_voucher(args, exclude_current_voucher=True).get(
+ "qty_after_transaction"
+ )
if last_balance is not None:
stock_reco_qty_shift = flt(args.qty_after_transaction) - flt(last_balance)
@@ -1045,10 +1318,12 @@ def get_stock_reco_qty_shift(args):
return stock_reco_qty_shift
+
def get_next_stock_reco(args):
"""Returns next nearest stock reconciliaton's details."""
- return frappe.db.sql("""
+ return frappe.db.sql(
+ """
select
name, posting_date, posting_time, creation, voucher_no
from
@@ -1065,8 +1340,13 @@ def get_next_stock_reco(args):
and creation > %(creation)s
)
)
+ order by timestamp(posting_date, posting_time) asc, creation asc
limit 1
- """, args, as_dict=1)
+ """,
+ args,
+ as_dict=1,
+ )
+
def get_datetime_limit_condition(detail):
return f"""
@@ -1078,9 +1358,11 @@ def get_datetime_limit_condition(detail):
)
)"""
+
def validate_negative_qty_in_future_sle(args, allow_negative_stock=False):
- allow_negative_stock = cint(allow_negative_stock) \
- or cint(frappe.db.get_single_value("Stock Settings", "allow_negative_stock"))
+ allow_negative_stock = cint(allow_negative_stock) or cint(
+ frappe.db.get_single_value("Stock Settings", "allow_negative_stock")
+ )
if allow_negative_stock:
return
@@ -1088,33 +1370,58 @@ def validate_negative_qty_in_future_sle(args, allow_negative_stock=False):
return
neg_sle = get_future_sle_with_negative_qty(args)
- if neg_sle:
- message = _("{0} units of {1} needed in {2} on {3} {4} for {5} to complete this transaction.").format(
+
+ if is_negative_with_precision(neg_sle):
+ message = _(
+ "{0} units of {1} needed in {2} on {3} {4} for {5} to complete this transaction."
+ ).format(
abs(neg_sle[0]["qty_after_transaction"]),
- frappe.get_desk_link('Item', args.item_code),
- frappe.get_desk_link('Warehouse', args.warehouse),
- neg_sle[0]["posting_date"], neg_sle[0]["posting_time"],
- frappe.get_desk_link(neg_sle[0]["voucher_type"], neg_sle[0]["voucher_no"]))
-
- frappe.throw(message, NegativeStockError, title='Insufficient Stock')
+ frappe.get_desk_link("Item", args.item_code),
+ frappe.get_desk_link("Warehouse", args.warehouse),
+ neg_sle[0]["posting_date"],
+ neg_sle[0]["posting_time"],
+ frappe.get_desk_link(neg_sle[0]["voucher_type"], neg_sle[0]["voucher_no"]),
+ )
+ frappe.throw(message, NegativeStockError, title=_("Insufficient Stock"))
if not args.batch_no:
return
neg_batch_sle = get_future_sle_with_negative_batch_qty(args)
- if neg_batch_sle:
- message = _("{0} units of {1} needed in {2} on {3} {4} for {5} to complete this transaction.").format(
+ if is_negative_with_precision(neg_batch_sle, is_batch=True):
+ message = _(
+ "{0} units of {1} needed in {2} on {3} {4} for {5} to complete this transaction."
+ ).format(
abs(neg_batch_sle[0]["cumulative_total"]),
- frappe.get_desk_link('Batch', args.batch_no),
- frappe.get_desk_link('Warehouse', args.warehouse),
- neg_batch_sle[0]["posting_date"], neg_batch_sle[0]["posting_time"],
- frappe.get_desk_link(neg_batch_sle[0]["voucher_type"], neg_batch_sle[0]["voucher_no"]))
- frappe.throw(message, NegativeStockError, title="Insufficient Stock for Batch")
+ frappe.get_desk_link("Batch", args.batch_no),
+ frappe.get_desk_link("Warehouse", args.warehouse),
+ neg_batch_sle[0]["posting_date"],
+ neg_batch_sle[0]["posting_time"],
+ frappe.get_desk_link(neg_batch_sle[0]["voucher_type"], neg_batch_sle[0]["voucher_no"]),
+ )
+ frappe.throw(message, NegativeStockError, title=_("Insufficient Stock for Batch"))
+
+
+def is_negative_with_precision(neg_sle, is_batch=False):
+ """
+ Returns whether system precision rounded qty is insufficient.
+ E.g: -0.0003 in precision 3 (0.000) is sufficient for the user.
+ """
+
+ if not neg_sle:
+ return False
+
+ field = "cumulative_total" if is_batch else "qty_after_transaction"
+ precision = cint(frappe.db.get_default("float_precision")) or 2
+ qty_deficit = flt(neg_sle[0][field], precision)
+
+ return qty_deficit < 0 and abs(qty_deficit) > 0.0001
def get_future_sle_with_negative_qty(args):
- return frappe.db.sql("""
+ return frappe.db.sql(
+ """
select
qty_after_transaction, posting_date, posting_time,
voucher_type, voucher_no
@@ -1128,34 +1435,48 @@ def get_future_sle_with_negative_qty(args):
and qty_after_transaction < 0
order by timestamp(posting_date, posting_time) asc
limit 1
- """, args, as_dict=1)
+ """,
+ args,
+ as_dict=1,
+ )
def get_future_sle_with_negative_batch_qty(args):
- return frappe.db.sql("""
- with batch_ledger as (
- select
- posting_date, posting_time, voucher_type, voucher_no,
- sum(actual_qty) over (order by posting_date, posting_time, creation) as cumulative_total
- from `tabStock Ledger Entry`
- where
- item_code = %(item_code)s
- and warehouse = %(warehouse)s
- and batch_no=%(batch_no)s
- and is_cancelled = 0
- order by posting_date, posting_time, creation
- )
- select * from batch_ledger
+ batch_ledger = frappe.db.sql(
+ """
+ select
+ posting_date, posting_time, voucher_type, voucher_no, actual_qty
+ from `tabStock Ledger Entry`
where
- cumulative_total < 0.0
- and timestamp(posting_date, posting_time) >= timestamp(%(posting_date)s, %(posting_time)s)
- limit 1
- """, args, as_dict=1)
+ item_code = %(item_code)s
+ and warehouse = %(warehouse)s
+ and batch_no=%(batch_no)s
+ and is_cancelled = 0
+ order by timestamp(posting_date, posting_time), creation
+ """,
+ args,
+ as_dict=1,
+ )
+
+ cumulative_total = 0.0
+ current_posting_datetime = get_datetime(str(args.posting_date) + " " + str(args.posting_time))
+ for entry in batch_ledger:
+ cumulative_total += entry.actual_qty
+ if cumulative_total > -1e-6:
+ continue
+
+ if (
+ get_datetime(str(entry.posting_date) + " " + str(entry.posting_time))
+ >= current_posting_datetime
+ ):
+
+ entry.cumulative_total = cumulative_total
+ return [entry]
def _round_off_if_near_zero(number: float, precision: int = 6) -> float:
- """ Rounds off the number to zero only if number is close to zero for decimal
- specified in precision. Precision defaults to 6.
+ """Rounds off the number to zero only if number is close to zero for decimal
+ specified in precision. Precision defaults to 6.
"""
if abs(0.0 - flt(number)) < (1.0 / (10**precision)):
return 0.0
diff --git a/erpnext/stock/tests/test_utils.py b/erpnext/stock/tests/test_utils.py
new file mode 100644
index 00000000000..17d129990dc
--- /dev/null
+++ b/erpnext/stock/tests/test_utils.py
@@ -0,0 +1,53 @@
+import json
+
+import frappe
+
+
+class StockTestMixin:
+ """Mixin to simplfy stock ledger tests, useful for all stock transactions."""
+
+ def make_item(self, item_code=None, properties=None, *args, **kwargs):
+ from erpnext.stock.doctype.item.test_item import make_item
+
+ return make_item(item_code, properties, *args, **kwargs)
+
+ def assertSLEs(self, doc, expected_sles, sle_filters=None):
+ """Compare sorted SLEs, useful for vouchers that create multiple SLEs for same line"""
+
+ filters = {"voucher_no": doc.name, "voucher_type": doc.doctype, "is_cancelled": 0}
+ if sle_filters:
+ filters.update(sle_filters)
+ sles = frappe.get_all(
+ "Stock Ledger Entry",
+ fields=["*"],
+ filters=filters,
+ order_by="timestamp(posting_date, posting_time), creation",
+ )
+
+ for exp_sle, act_sle in zip(expected_sles, sles):
+ for k, v in exp_sle.items():
+ act_value = act_sle[k]
+ if k == "stock_queue":
+ act_value = json.loads(act_value)
+ if act_value and act_value[0][0] == 0:
+ # ignore empty fifo bins
+ continue
+
+ self.assertEqual(v, act_value, msg=f"{k} doesn't match \n{exp_sle}\n{act_sle}")
+
+ def assertGLEs(self, doc, expected_gles, gle_filters=None, order_by=None):
+ filters = {"voucher_no": doc.name, "voucher_type": doc.doctype, "is_cancelled": 0}
+
+ if gle_filters:
+ filters.update(gle_filters)
+ actual_gles = frappe.get_all(
+ "GL Entry",
+ fields=["*"],
+ filters=filters,
+ order_by=order_by or "posting_date, creation",
+ )
+
+ for exp_gle, act_gle in zip(expected_gles, actual_gles):
+ for k, exp_value in exp_gle.items():
+ act_value = act_gle[k]
+ self.assertEqual(exp_value, act_value, msg=f"{k} doesn't match \n{exp_gle}\n{act_gle}")
diff --git a/erpnext/stock/utils.py b/erpnext/stock/utils.py
index dd87e4ff499..98eaecf7907 100644
--- a/erpnext/stock/utils.py
+++ b/erpnext/stock/utils.py
@@ -12,8 +12,13 @@ from six import string_types
import erpnext
-class InvalidWarehouseCompany(frappe.ValidationError): pass
-class PendingRepostingError(frappe.ValidationError): pass
+class InvalidWarehouseCompany(frappe.ValidationError):
+ pass
+
+
+class PendingRepostingError(frappe.ValidationError):
+ pass
+
def get_stock_value_from_bin(warehouse=None, item_code=None):
values = {}
@@ -26,22 +31,27 @@ def get_stock_value_from_bin(warehouse=None, item_code=None):
and w2.lft between w1.lft and w1.rgt
) """
- values['warehouse'] = warehouse
+ values["warehouse"] = warehouse
if item_code:
conditions += " and `tabBin`.item_code = %(item_code)s"
- values['item_code'] = item_code
+ values["item_code"] = item_code
- query = """select sum(stock_value) from `tabBin`, `tabItem` where 1 = 1
- and `tabItem`.name = `tabBin`.item_code and ifnull(`tabItem`.disabled, 0) = 0 %s""" % conditions
+ query = (
+ """select sum(stock_value) from `tabBin`, `tabItem` where 1 = 1
+ and `tabItem`.name = `tabBin`.item_code and ifnull(`tabItem`.disabled, 0) = 0 %s"""
+ % conditions
+ )
stock_value = frappe.db.sql(query, values)
return stock_value
+
def get_stock_value_on(warehouse=None, posting_date=None, item_code=None):
- if not posting_date: posting_date = nowdate()
+ if not posting_date:
+ posting_date = nowdate()
values, condition = [posting_date], ""
@@ -63,13 +73,19 @@ def get_stock_value_on(warehouse=None, posting_date=None, item_code=None):
values.append(item_code)
condition += " AND item_code = %s"
- stock_ledger_entries = frappe.db.sql("""
+ stock_ledger_entries = frappe.db.sql(
+ """
SELECT item_code, stock_value, name, warehouse
FROM `tabStock Ledger Entry` sle
WHERE posting_date <= %s {0}
and is_cancelled = 0
ORDER BY timestamp(posting_date, posting_time) DESC, creation DESC
- """.format(condition), values, as_dict=1)
+ """.format(
+ condition
+ ),
+ values,
+ as_dict=1,
+ )
sle_map = {}
for sle in stock_ledger_entries:
@@ -78,23 +94,32 @@ def get_stock_value_on(warehouse=None, posting_date=None, item_code=None):
return sum(sle_map.values())
+
@frappe.whitelist()
-def get_stock_balance(item_code, warehouse, posting_date=None, posting_time=None,
- with_valuation_rate=False, with_serial_no=False):
+def get_stock_balance(
+ item_code,
+ warehouse,
+ posting_date=None,
+ posting_time=None,
+ with_valuation_rate=False,
+ with_serial_no=False,
+):
"""Returns stock balance quantity at given warehouse on given posting date or current date.
If `with_valuation_rate` is True, will return tuple (qty, rate)"""
from erpnext.stock.stock_ledger import get_previous_sle
- if not posting_date: posting_date = nowdate()
- if not posting_time: posting_time = nowtime()
+ if posting_date is None:
+ posting_date = nowdate()
+ if posting_time is None:
+ posting_time = nowtime()
args = {
"item_code": item_code,
- "warehouse":warehouse,
+ "warehouse": warehouse,
"posting_date": posting_date,
- "posting_time": posting_time
+ "posting_time": posting_time,
}
last_entry = get_previous_sle(args)
@@ -103,33 +128,41 @@ def get_stock_balance(item_code, warehouse, posting_date=None, posting_time=None
if with_serial_no:
serial_nos = get_serial_nos_data_after_transactions(args)
- return ((last_entry.qty_after_transaction, last_entry.valuation_rate, serial_nos)
- if last_entry else (0.0, 0.0, 0.0))
+ return (
+ (last_entry.qty_after_transaction, last_entry.valuation_rate, serial_nos)
+ if last_entry
+ else (0.0, 0.0, None)
+ )
else:
- return (last_entry.qty_after_transaction, last_entry.valuation_rate) if last_entry else (0.0, 0.0)
+ return (
+ (last_entry.qty_after_transaction, last_entry.valuation_rate) if last_entry else (0.0, 0.0)
+ )
else:
return last_entry.qty_after_transaction if last_entry else 0.0
+
def get_serial_nos_data_after_transactions(args):
from pypika import CustomFunction
serial_nos = set()
args = frappe._dict(args)
- sle = frappe.qb.DocType('Stock Ledger Entry')
- Timestamp = CustomFunction('timestamp', ['date', 'time'])
+ sle = frappe.qb.DocType("Stock Ledger Entry")
+ Timestamp = CustomFunction("timestamp", ["date", "time"])
- stock_ledger_entries = frappe.qb.from_(
- sle
- ).select(
- 'serial_no','actual_qty'
- ).where(
- (sle.item_code == args.item_code)
- & (sle.warehouse == args.warehouse)
- & (Timestamp(sle.posting_date, sle.posting_time) < Timestamp(args.posting_date, args.posting_time))
- & (sle.is_cancelled == 0)
- ).orderby(
- sle.posting_date, sle.posting_time, sle.creation
- ).run(as_dict=1)
+ stock_ledger_entries = (
+ frappe.qb.from_(sle)
+ .select("serial_no", "actual_qty")
+ .where(
+ (sle.item_code == args.item_code)
+ & (sle.warehouse == args.warehouse)
+ & (
+ Timestamp(sle.posting_date, sle.posting_time) < Timestamp(args.posting_date, args.posting_time)
+ )
+ & (sle.is_cancelled == 0)
+ )
+ .orderby(sle.posting_date, sle.posting_time, sle.creation)
+ .run(as_dict=1)
+ )
for stock_ledger_entry in stock_ledger_entries:
changed_serial_no = get_serial_nos_data(stock_ledger_entry.serial_no)
@@ -138,12 +171,15 @@ def get_serial_nos_data_after_transactions(args):
else:
serial_nos.difference_update(changed_serial_no)
- return '\n'.join(serial_nos)
+ return "\n".join(serial_nos)
+
def get_serial_nos_data(serial_nos):
from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
+
return get_serial_nos(serial_nos)
+
@frappe.whitelist()
def get_latest_stock_qty(item_code, warehouse=None):
values, condition = [item_code], ""
@@ -160,64 +196,81 @@ def get_latest_stock_qty(item_code, warehouse=None):
values.append(warehouse)
condition += " AND warehouse = %s"
- actual_qty = frappe.db.sql("""select sum(actual_qty) from tabBin
- where item_code=%s {0}""".format(condition), values)[0][0]
+ actual_qty = frappe.db.sql(
+ """select sum(actual_qty) from tabBin
+ where item_code=%s {0}""".format(
+ condition
+ ),
+ values,
+ )[0][0]
return actual_qty
def get_latest_stock_balance():
bin_map = {}
- for d in frappe.db.sql("""SELECT item_code, warehouse, stock_value as stock_value
- FROM tabBin""", as_dict=1):
- bin_map.setdefault(d.warehouse, {}).setdefault(d.item_code, flt(d.stock_value))
+ for d in frappe.db.sql(
+ """SELECT item_code, warehouse, stock_value as stock_value
+ FROM tabBin""",
+ as_dict=1,
+ ):
+ bin_map.setdefault(d.warehouse, {}).setdefault(d.item_code, flt(d.stock_value))
return bin_map
+
def get_bin(item_code, warehouse):
bin = frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse})
if not bin:
- bin_obj = frappe.get_doc({
- "doctype": "Bin",
- "item_code": item_code,
- "warehouse": warehouse,
- })
- bin_obj.flags.ignore_permissions = 1
- bin_obj.insert()
+ bin_obj = _create_bin(item_code, warehouse)
else:
- bin_obj = frappe.get_doc('Bin', bin, for_update=True)
+ bin_obj = frappe.get_doc("Bin", bin, for_update=True)
bin_obj.flags.ignore_permissions = True
return bin_obj
-def get_or_make_bin(item_code: str , warehouse: str) -> str:
- bin_record = frappe.db.get_value('Bin', {'item_code': item_code, 'warehouse': warehouse})
+
+def get_or_make_bin(item_code: str, warehouse: str) -> str:
+ bin_record = frappe.db.get_value("Bin", {"item_code": item_code, "warehouse": warehouse})
if not bin_record:
- bin_obj = frappe.get_doc({
- "doctype": "Bin",
- "item_code": item_code,
- "warehouse": warehouse,
- })
+ bin_obj = _create_bin(item_code, warehouse)
+ bin_record = bin_obj.name
+ return bin_record
+
+
+def _create_bin(item_code, warehouse):
+ """Create a bin and take care of concurrent inserts."""
+
+ bin_creation_savepoint = "create_bin"
+ try:
+ frappe.db.savepoint(bin_creation_savepoint)
+ bin_obj = frappe.get_doc(doctype="Bin", item_code=item_code, warehouse=warehouse)
bin_obj.flags.ignore_permissions = 1
bin_obj.insert()
- bin_record = bin_obj.name
+ except frappe.UniqueValidationError:
+ frappe.db.rollback(save_point=bin_creation_savepoint) # preserve transaction in postgres
+ bin_obj = frappe.get_last_doc("Bin", {"item_code": item_code, "warehouse": warehouse})
+
+ return bin_obj
- return bin_record
def update_bin(args, allow_negative_stock=False, via_landed_cost_voucher=False):
"""WARNING: This function is deprecated. Inline this function instead of using it."""
from erpnext.stock.doctype.bin.bin import update_stock
- is_stock_item = frappe.get_cached_value('Item', args.get("item_code"), 'is_stock_item')
+
+ is_stock_item = frappe.get_cached_value("Item", args.get("item_code"), "is_stock_item")
if is_stock_item:
bin_name = get_or_make_bin(args.get("item_code"), args.get("warehouse"))
update_stock(bin_name, args, allow_negative_stock, via_landed_cost_voucher)
else:
frappe.msgprint(_("Item {0} ignored since it is not a stock item").format(args.get("item_code")))
+
@frappe.whitelist()
def get_incoming_rate(args, raise_error_if_no_rate=True):
"""Get Incoming Rate based on valuation method"""
from erpnext.stock.stock_ledger import get_previous_sle, get_valuation_rate
+
if isinstance(args, string_types):
args = json.loads(args)
@@ -227,37 +280,53 @@ def get_incoming_rate(args, raise_error_if_no_rate=True):
else:
valuation_method = get_valuation_method(args.get("item_code"))
previous_sle = get_previous_sle(args)
- if valuation_method == 'FIFO':
+ if valuation_method == "FIFO":
if previous_sle:
- previous_stock_queue = json.loads(previous_sle.get('stock_queue', '[]') or '[]')
- in_rate = get_fifo_rate(previous_stock_queue, args.get("qty") or 0) if previous_stock_queue else 0
- elif valuation_method == 'Moving Average':
- in_rate = previous_sle.get('valuation_rate') or 0
+ previous_stock_queue = json.loads(previous_sle.get("stock_queue", "[]") or "[]")
+ in_rate = (
+ get_fifo_rate(previous_stock_queue, args.get("qty") or 0) if previous_stock_queue else 0
+ )
+ elif valuation_method == "Moving Average":
+ in_rate = previous_sle.get("valuation_rate") or 0
if not in_rate:
- voucher_no = args.get('voucher_no') or args.get('name')
- in_rate = get_valuation_rate(args.get('item_code'), args.get('warehouse'),
- args.get('voucher_type'), voucher_no, args.get('allow_zero_valuation'),
- currency=erpnext.get_company_currency(args.get('company')), company=args.get('company'),
- raise_error_if_no_rate=raise_error_if_no_rate)
+ voucher_no = args.get("voucher_no") or args.get("name")
+ in_rate = get_valuation_rate(
+ args.get("item_code"),
+ args.get("warehouse"),
+ args.get("voucher_type"),
+ voucher_no,
+ args.get("allow_zero_valuation"),
+ currency=erpnext.get_company_currency(args.get("company")),
+ company=args.get("company"),
+ raise_error_if_no_rate=raise_error_if_no_rate,
+ )
return flt(in_rate)
+
def get_avg_purchase_rate(serial_nos):
"""get average value of serial numbers"""
serial_nos = get_valid_serial_nos(serial_nos)
- return flt(frappe.db.sql("""select avg(purchase_rate) from `tabSerial No`
- where name in (%s)""" % ", ".join(["%s"] * len(serial_nos)),
- tuple(serial_nos))[0][0])
+ return flt(
+ frappe.db.sql(
+ """select avg(purchase_rate) from `tabSerial No`
+ where name in (%s)"""
+ % ", ".join(["%s"] * len(serial_nos)),
+ tuple(serial_nos),
+ )[0][0]
+ )
+
def get_valuation_method(item_code):
"""get valuation method from item or default"""
- val_method = frappe.db.get_value('Item', item_code, 'valuation_method', cache=True)
+ val_method = frappe.db.get_value("Item", item_code, "valuation_method", cache=True)
if not val_method:
val_method = frappe.db.get_value("Stock Settings", None, "valuation_method") or "FIFO"
return val_method
+
def get_fifo_rate(previous_stock_queue, qty):
"""get FIFO (average) Rate from Queue"""
if flt(qty) >= 0:
@@ -284,10 +353,11 @@ def get_fifo_rate(previous_stock_queue, qty):
return outgoing_cost / available_qty_for_outgoing
-def get_valid_serial_nos(sr_nos, qty=0, item_code=''):
+
+def get_valid_serial_nos(sr_nos, qty=0, item_code=""):
"""split serial nos, validate and return list of valid serial nos"""
# TODO: remove duplicates in client side
- serial_nos = cstr(sr_nos).strip().replace(',', '\n').split('\n')
+ serial_nos = cstr(sr_nos).strip().replace(",", "\n").split("\n")
valid_serial_nos = []
for val in serial_nos:
@@ -303,19 +373,29 @@ def get_valid_serial_nos(sr_nos, qty=0, item_code=''):
return valid_serial_nos
+
def validate_warehouse_company(warehouse, company):
warehouse_company = frappe.db.get_value("Warehouse", warehouse, "company", cache=True)
if warehouse_company and warehouse_company != company:
- frappe.throw(_("Warehouse {0} does not belong to company {1}").format(warehouse, company),
- InvalidWarehouseCompany)
+ frappe.throw(
+ _("Warehouse {0} does not belong to company {1}").format(warehouse, company),
+ InvalidWarehouseCompany,
+ )
+
def is_group_warehouse(warehouse):
if frappe.db.get_value("Warehouse", warehouse, "is_group", cache=True):
frappe.throw(_("Group node warehouse is not allowed to select for transactions"))
+
def validate_disabled_warehouse(warehouse):
if frappe.db.get_value("Warehouse", warehouse, "disabled", cache=True):
- frappe.throw(_("Disabled Warehouse {0} cannot be used for this transaction.").format(get_link_to_form('Warehouse', warehouse)))
+ frappe.throw(
+ _("Disabled Warehouse {0} cannot be used for this transaction.").format(
+ get_link_to_form("Warehouse", warehouse)
+ )
+ )
+
def update_included_uom_in_report(columns, result, include_uom, conversion_factors):
if not include_uom or not conversion_factors:
@@ -333,11 +413,14 @@ def update_included_uom_in_report(columns, result, include_uom, conversion_facto
convertible_columns.setdefault(key, d.get("convertible"))
# Add new column to show qty/rate as per the selected UOM
- columns.insert(idx+1, {
- 'label': "{0} (per {1})".format(d.get("label"), include_uom),
- 'fieldname': "{0}_{1}".format(d.get("fieldname"), frappe.scrub(include_uom)),
- 'fieldtype': 'Currency' if d.get("convertible") == 'rate' else 'Float'
- })
+ columns.insert(
+ idx + 1,
+ {
+ "label": "{0} (per {1})".format(d.get("label"), include_uom),
+ "fieldname": "{0}_{1}".format(d.get("fieldname"), frappe.scrub(include_uom)),
+ "fieldtype": "Currency" if d.get("convertible") == "rate" else "Float",
+ },
+ )
update_dict_values = []
for row_idx, row in enumerate(result):
@@ -349,13 +432,13 @@ def update_included_uom_in_report(columns, result, include_uom, conversion_facto
if not conversion_factors[row_idx]:
conversion_factors[row_idx] = 1
- if convertible_columns.get(key) == 'rate':
+ if convertible_columns.get(key) == "rate":
new_value = flt(value) * conversion_factors[row_idx]
else:
new_value = flt(value) / conversion_factors[row_idx]
if not is_dict_obj:
- row.insert(key+1, new_value)
+ row.insert(key + 1, new_value)
else:
new_key = "{0}_{1}".format(key, frappe.scrub(include_uom))
update_dict_values.append([row, new_key, new_value])
@@ -364,11 +447,17 @@ def update_included_uom_in_report(columns, result, include_uom, conversion_facto
row, key, value = data
row[key] = value
+
def get_available_serial_nos(args):
- return frappe.db.sql(""" SELECT name from `tabSerial No`
+ return frappe.db.sql(
+ """ SELECT name from `tabSerial No`
WHERE item_code = %(item_code)s and warehouse = %(warehouse)s
and timestamp(purchase_date, purchase_time) <= timestamp(%(posting_date)s, %(posting_time)s)
- """, args, as_dict=1)
+ """,
+ args,
+ as_dict=1,
+ )
+
def add_additional_uom_columns(columns, result, include_uom, conversion_factors):
if not include_uom or not conversion_factors:
@@ -377,70 +466,80 @@ def add_additional_uom_columns(columns, result, include_uom, conversion_factors)
convertible_column_map = {}
for col_idx in list(reversed(range(0, len(columns)))):
col = columns[col_idx]
- if isinstance(col, dict) and col.get('convertible') in ['rate', 'qty']:
+ if isinstance(col, dict) and col.get("convertible") in ["rate", "qty"]:
next_col = col_idx + 1
columns.insert(next_col, col.copy())
- columns[next_col]['fieldname'] += '_alt'
- convertible_column_map[col.get('fieldname')] = frappe._dict({
- 'converted_col': columns[next_col]['fieldname'],
- 'for_type': col.get('convertible')
- })
- if col.get('convertible') == 'rate':
- columns[next_col]['label'] += ' (per {})'.format(include_uom)
+ columns[next_col]["fieldname"] += "_alt"
+ convertible_column_map[col.get("fieldname")] = frappe._dict(
+ {"converted_col": columns[next_col]["fieldname"], "for_type": col.get("convertible")}
+ )
+ if col.get("convertible") == "rate":
+ columns[next_col]["label"] += " (per {})".format(include_uom)
else:
- columns[next_col]['label'] += ' ({})'.format(include_uom)
+ columns[next_col]["label"] += " ({})".format(include_uom)
for row_idx, row in enumerate(result):
for convertible_col, data in convertible_column_map.items():
- conversion_factor = conversion_factors[row.get('item_code')] or 1
+ conversion_factor = conversion_factors[row.get("item_code")] or 1
for_type = data.for_type
value_before_conversion = row.get(convertible_col)
- if for_type == 'rate':
+ if for_type == "rate":
row[data.converted_col] = flt(value_before_conversion) * conversion_factor
else:
row[data.converted_col] = flt(value_before_conversion) / conversion_factor
result[row_idx] = row
+
def get_incoming_outgoing_rate_for_cancel(item_code, voucher_type, voucher_no, voucher_detail_no):
- outgoing_rate = frappe.db.sql("""SELECT abs(stock_value_difference / actual_qty)
+ outgoing_rate = frappe.db.sql(
+ """SELECT abs(stock_value_difference / actual_qty)
FROM `tabStock Ledger Entry`
WHERE voucher_type = %s and voucher_no = %s
and item_code = %s and voucher_detail_no = %s
ORDER BY CREATION DESC limit 1""",
- (voucher_type, voucher_no, item_code, voucher_detail_no))
+ (voucher_type, voucher_no, item_code, voucher_detail_no),
+ )
outgoing_rate = outgoing_rate[0][0] if outgoing_rate else 0.0
return outgoing_rate
+
def is_reposting_item_valuation_in_progress():
- reposting_in_progress = frappe.db.exists("Repost Item Valuation",
- {'docstatus': 1, 'status': ['in', ['Queued','In Progress']]})
+ reposting_in_progress = frappe.db.exists(
+ "Repost Item Valuation", {"docstatus": 1, "status": ["in", ["Queued", "In Progress"]]}
+ )
if reposting_in_progress:
- frappe.msgprint(_("Item valuation reposting in progress. Report might show incorrect item valuation."), alert=1)
+ frappe.msgprint(
+ _("Item valuation reposting in progress. Report might show incorrect item valuation."), alert=1
+ )
+
def check_pending_reposting(posting_date: str, throw_error: bool = True) -> bool:
"""Check if there are pending reposting job till the specified posting date."""
filters = {
"docstatus": 1,
- "status": ["in", ["Queued","In Progress", "Failed"]],
+ "status": ["in", ["Queued", "In Progress"]],
"posting_date": ["<=", posting_date],
}
- reposting_pending = frappe.db.exists("Repost Item Valuation", filters)
+ reposting_pending = frappe.db.exists("Repost Item Valuation", filters)
if reposting_pending and throw_error:
- msg = _("Stock/Accounts can not be frozen as processing of backdated entries is going on. Please try again later.")
- frappe.msgprint(msg,
- raise_exception=PendingRepostingError,
- title="Stock Reposting Ongoing",
- indicator="red",
- primary_action={
- "label": _("Show pending entries"),
- "client_action": "erpnext.route_to_pending_reposts",
- "args": filters,
- }
- )
+ msg = _(
+ "Stock/Accounts can not be frozen as processing of backdated entries is going on. Please try again later."
+ )
+ frappe.msgprint(
+ msg,
+ raise_exception=PendingRepostingError,
+ title="Stock Reposting Ongoing",
+ indicator="red",
+ primary_action={
+ "label": _("Show pending entries"),
+ "client_action": "erpnext.route_to_pending_reposts",
+ "args": filters,
+ },
+ )
return bool(reposting_pending)
diff --git a/erpnext/support/__init__.py b/erpnext/support/__init__.py
index b9a7c1e8cee..7b6845d2fd1 100644
--- a/erpnext/support/__init__.py
+++ b/erpnext/support/__init__.py
@@ -1,6 +1,5 @@
-
install_docs = [
- {'doctype':'Role', 'role_name':'Support Team', 'name':'Support Team'},
- {'doctype':'Role', 'role_name':'Maintenance User', 'name':'Maintenance User'},
- {'doctype':'Role', 'role_name':'Maintenance Manager', 'name':'Maintenance Manager'}
+ {"doctype": "Role", "role_name": "Support Team", "name": "Support Team"},
+ {"doctype": "Role", "role_name": "Maintenance User", "name": "Maintenance User"},
+ {"doctype": "Role", "role_name": "Maintenance Manager", "name": "Maintenance Manager"},
]
diff --git a/erpnext/support/doctype/issue/issue.py b/erpnext/support/doctype/issue/issue.py
index 744b2989ff2..62e8d342f94 100644
--- a/erpnext/support/doctype/issue/issue.py
+++ b/erpnext/support/doctype/issue/issue.py
@@ -67,8 +67,9 @@ class Issue(Document):
self.customer = contact.get_link_for("Customer")
if not self.company:
- self.company = frappe.db.get_value("Lead", self.lead, "company") or \
- frappe.db.get_default("Company")
+ self.company = frappe.db.get_value("Lead", self.lead, "company") or frappe.db.get_default(
+ "Company"
+ )
def reset_sla_fields(self):
self.agreement_status = ""
@@ -103,19 +104,20 @@ class Issue(Document):
def handle_hold_time(self, status):
if self.service_level_agreement:
# set response and resolution variance as None as the issue is on Hold
- pause_sla_on = frappe.db.get_all("Pause SLA On Status", fields=["status"],
- filters={"parent": self.service_level_agreement})
+ pause_sla_on = frappe.db.get_all(
+ "Pause SLA On Status", fields=["status"], filters={"parent": self.service_level_agreement}
+ )
hold_statuses = [entry.status for entry in pause_sla_on]
update_values = {}
if hold_statuses:
if self.status in hold_statuses and status not in hold_statuses:
- update_values['on_hold_since'] = frappe.flags.current_time or now_datetime()
+ update_values["on_hold_since"] = frappe.flags.current_time or now_datetime()
if not self.first_responded_on:
- update_values['response_by'] = None
- update_values['response_by_variance'] = 0
- update_values['resolution_by'] = None
- update_values['resolution_by_variance'] = 0
+ update_values["response_by"] = None
+ update_values["response_by_variance"] = 0
+ update_values["resolution_by"] = None
+ update_values["resolution_by_variance"] = 0
# calculate hold time when status is changed from any hold status to any non-hold status
if self.status not in hold_statuses and status in hold_statuses:
@@ -125,7 +127,7 @@ class Issue(Document):
if self.on_hold_since:
# last_hold_time will be added to the sla variables
last_hold_time = time_diff_in_seconds(now_time, self.on_hold_since)
- update_values['total_hold_time'] = hold_time + last_hold_time
+ update_values["total_hold_time"] = hold_time + last_hold_time
# re-calculate SLA variables after issue changes from any hold status to any non-hold status
# add hold time to SLA variables
@@ -134,25 +136,31 @@ class Issue(Document):
now_time = frappe.flags.current_time or now_datetime()
if not self.first_responded_on:
- response_by = get_expected_time_for(parameter="response", service_level=priority, start_date_time=start_date_time)
+ response_by = get_expected_time_for(
+ parameter="response", service_level=priority, start_date_time=start_date_time
+ )
response_by = add_to_date(response_by, seconds=round(last_hold_time))
response_by_variance = round(time_diff_in_seconds(response_by, now_time))
- update_values['response_by'] = response_by
- update_values['response_by_variance'] = response_by_variance + last_hold_time
+ update_values["response_by"] = response_by
+ update_values["response_by_variance"] = response_by_variance + last_hold_time
- resolution_by = get_expected_time_for(parameter="resolution", service_level=priority, start_date_time=start_date_time)
+ resolution_by = get_expected_time_for(
+ parameter="resolution", service_level=priority, start_date_time=start_date_time
+ )
resolution_by = add_to_date(resolution_by, seconds=round(last_hold_time))
resolution_by_variance = round(time_diff_in_seconds(resolution_by, now_time))
- update_values['resolution_by'] = resolution_by
- update_values['resolution_by_variance'] = resolution_by_variance + last_hold_time
- update_values['on_hold_since'] = None
+ update_values["resolution_by"] = resolution_by
+ update_values["resolution_by_variance"] = resolution_by_variance + last_hold_time
+ update_values["on_hold_since"] = None
self.db_set(update_values)
def update_agreement_status(self):
if self.service_level_agreement and self.agreement_status == "Ongoing":
- if cint(frappe.db.get_value("Issue", self.name, "response_by_variance")) < 0 or \
- cint(frappe.db.get_value("Issue", self.name, "resolution_by_variance")) < 0:
+ if (
+ cint(frappe.db.get_value("Issue", self.name, "response_by_variance")) < 0
+ or cint(frappe.db.get_value("Issue", self.name, "resolution_by_variance")) < 0
+ ):
self.agreement_status = "Failed"
else:
@@ -160,30 +168,34 @@ class Issue(Document):
def update_agreement_status_on_custom_status(self):
"""
- Update Agreement Fulfilled status using Custom Scripts for Custom Issue Status
+ Update Agreement Fulfilled status using Custom Scripts for Custom Issue Status
"""
- if not self.first_responded_on: # first_responded_on set when first reply is sent to customer
+ if not self.first_responded_on: # first_responded_on set when first reply is sent to customer
self.response_by_variance = round(time_diff_in_seconds(self.response_by, now_datetime()), 2)
- if not self.resolution_date: # resolution_date set when issue has been closed
+ if not self.resolution_date: # resolution_date set when issue has been closed
self.resolution_by_variance = round(time_diff_in_seconds(self.resolution_by, now_datetime()), 2)
- self.agreement_status = "Fulfilled" if self.response_by_variance > 0 and self.resolution_by_variance > 0 else "Failed"
+ self.agreement_status = (
+ "Fulfilled" if self.response_by_variance > 0 and self.resolution_by_variance > 0 else "Failed"
+ )
def create_communication(self):
communication = frappe.new_doc("Communication")
- communication.update({
- "communication_type": "Communication",
- "communication_medium": "Email",
- "sent_or_received": "Received",
- "email_status": "Open",
- "subject": self.subject,
- "sender": self.raised_by,
- "content": self.description,
- "status": "Linked",
- "reference_doctype": "Issue",
- "reference_name": self.name
- })
+ communication.update(
+ {
+ "communication_type": "Communication",
+ "communication_medium": "Email",
+ "sent_or_received": "Received",
+ "email_status": "Open",
+ "subject": self.subject,
+ "sender": self.raised_by,
+ "content": self.description,
+ "status": "Linked",
+ "reference_doctype": "Issue",
+ "reference_name": self.name,
+ }
+ )
communication.ignore_permissions = True
communication.ignore_mandatory = True
communication.save()
@@ -216,23 +228,31 @@ class Issue(Document):
# Replicate linked Communications
# TODO: get all communications in timeline before this, and modify them to append them to new doc
comm_to_split_from = frappe.get_doc("Communication", communication_id)
- communications = frappe.get_all("Communication",
- filters={"reference_doctype": "Issue",
+ communications = frappe.get_all(
+ "Communication",
+ filters={
+ "reference_doctype": "Issue",
"reference_name": comm_to_split_from.reference_name,
- "creation": (">=", comm_to_split_from.creation)})
+ "creation": (">=", comm_to_split_from.creation),
+ },
+ )
for communication in communications:
doc = frappe.get_doc("Communication", communication.name)
doc.reference_name = replicated_issue.name
doc.save(ignore_permissions=True)
- frappe.get_doc({
- "doctype": "Comment",
- "comment_type": "Info",
- "reference_doctype": "Issue",
- "reference_name": replicated_issue.name,
- "content": " - Split the Issue from {1}".format(self.name, frappe.bold(self.name)),
- }).insert(ignore_permissions=True)
+ frappe.get_doc(
+ {
+ "doctype": "Comment",
+ "comment_type": "Info",
+ "reference_doctype": "Issue",
+ "reference_name": replicated_issue.name,
+ "content": " - Split the Issue from {1}".format(
+ self.name, frappe.bold(self.name)
+ ),
+ }
+ ).insert(ignore_permissions=True)
return replicated_issue.name
@@ -243,7 +263,9 @@ class Issue(Document):
def before_insert(self):
if frappe.db.get_single_value("Support Settings", "track_service_level_agreement"):
if frappe.flags.in_test:
- self.set_response_and_resolution_time(priority=self.priority, service_level_agreement=self.service_level_agreement)
+ self.set_response_and_resolution_time(
+ priority=self.priority, service_level_agreement=self.service_level_agreement
+ )
else:
self.set_response_and_resolution_time()
@@ -252,11 +274,19 @@ class Issue(Document):
if not service_level_agreement:
if frappe.db.get_value("Issue", self.name, "service_level_agreement"):
- frappe.throw(_("Couldn't Set Service Level Agreement {0}.").format(self.service_level_agreement))
+ frappe.throw(
+ _("Couldn't Set Service Level Agreement {0}.").format(self.service_level_agreement)
+ )
return
- if (service_level_agreement.customer and self.customer) and not (service_level_agreement.customer == self.customer):
- frappe.throw(_("This Service Level Agreement is specific to Customer {0}").format(service_level_agreement.customer))
+ if (service_level_agreement.customer and self.customer) and not (
+ service_level_agreement.customer == self.customer
+ ):
+ frappe.throw(
+ _("This Service Level Agreement is specific to Customer {0}").format(
+ service_level_agreement.customer
+ )
+ )
self.service_level_agreement = service_level_agreement.name
if not self.priority:
@@ -269,40 +299,59 @@ class Issue(Document):
self.service_level_agreement_creation = now_datetime()
start_date_time = get_datetime(self.service_level_agreement_creation)
- self.response_by = get_expected_time_for(parameter="response", service_level=priority, start_date_time=start_date_time)
- self.resolution_by = get_expected_time_for(parameter="resolution", service_level=priority, start_date_time=start_date_time)
+ self.response_by = get_expected_time_for(
+ parameter="response", service_level=priority, start_date_time=start_date_time
+ )
+ self.resolution_by = get_expected_time_for(
+ parameter="resolution", service_level=priority, start_date_time=start_date_time
+ )
self.response_by_variance = round(time_diff_in_seconds(self.response_by, now_datetime()))
self.resolution_by_variance = round(time_diff_in_seconds(self.resolution_by, now_datetime()))
def change_service_level_agreement_and_priority(self):
- if self.service_level_agreement and frappe.db.exists("Issue", self.name) and \
- frappe.db.get_single_value("Support Settings", "track_service_level_agreement"):
+ if (
+ self.service_level_agreement
+ and frappe.db.exists("Issue", self.name)
+ and frappe.db.get_single_value("Support Settings", "track_service_level_agreement")
+ ):
if not self.priority == frappe.db.get_value("Issue", self.name, "priority"):
- self.set_response_and_resolution_time(priority=self.priority, service_level_agreement=self.service_level_agreement)
+ self.set_response_and_resolution_time(
+ priority=self.priority, service_level_agreement=self.service_level_agreement
+ )
frappe.msgprint(_("Priority has been changed to {0}.").format(self.priority))
- if not self.service_level_agreement == frappe.db.get_value("Issue", self.name, "service_level_agreement"):
- self.set_response_and_resolution_time(priority=self.priority, service_level_agreement=self.service_level_agreement)
- frappe.msgprint(_("Service Level Agreement has been changed to {0}.").format(self.service_level_agreement))
+ if not self.service_level_agreement == frappe.db.get_value(
+ "Issue", self.name, "service_level_agreement"
+ ):
+ self.set_response_and_resolution_time(
+ priority=self.priority, service_level_agreement=self.service_level_agreement
+ )
+ frappe.msgprint(
+ _("Service Level Agreement has been changed to {0}.").format(self.service_level_agreement)
+ )
@frappe.whitelist()
def reset_service_level_agreement(self, reason, user):
if not frappe.db.get_single_value("Support Settings", "allow_resetting_service_level_agreement"):
frappe.throw(_("Allow Resetting Service Level Agreement from Support Settings."))
- frappe.get_doc({
- "doctype": "Comment",
- "comment_type": "Info",
- "reference_doctype": self.doctype,
- "reference_name": self.name,
- "comment_email": user,
- "content": " resetted Service Level Agreement - {0}".format(_(reason)),
- }).insert(ignore_permissions=True)
+ frappe.get_doc(
+ {
+ "doctype": "Comment",
+ "comment_type": "Info",
+ "reference_doctype": self.doctype,
+ "reference_name": self.name,
+ "comment_email": user,
+ "content": " resetted Service Level Agreement - {0}".format(_(reason)),
+ }
+ ).insert(ignore_permissions=True)
self.service_level_agreement_creation = now_datetime()
- self.set_response_and_resolution_time(priority=self.priority, service_level_agreement=self.service_level_agreement)
+ self.set_response_and_resolution_time(
+ priority=self.priority, service_level_agreement=self.service_level_agreement
+ )
self.agreement_status = "Ongoing"
self.save()
@@ -310,10 +359,12 @@ class Issue(Document):
def get_priority(issue):
service_level_agreement = frappe.get_doc("Service Level Agreement", issue.service_level_agreement)
priority = service_level_agreement.get_service_level_agreement_priority(issue.priority)
- priority.update({
- "support_and_resolution": service_level_agreement.support_and_resolution,
- "holiday_list": service_level_agreement.holiday_list
- })
+ priority.update(
+ {
+ "support_and_resolution": service_level_agreement.support_and_resolution,
+ "holiday_list": service_level_agreement.holiday_list,
+ }
+ )
return priority
@@ -334,10 +385,12 @@ def get_expected_time_for(parameter, service_level, start_date_time):
support_days = {}
for service in service_level.get("support_and_resolution"):
- support_days[service.workday] = frappe._dict({
- "start_time": service.start_time,
- "end_time": service.end_time,
- })
+ support_days[service.workday] = frappe._dict(
+ {
+ "start_time": service.start_time,
+ "end_time": service.end_time,
+ }
+ )
holidays = get_holidays(service_level.get("holiday_list"))
weekdays = get_weekdays()
@@ -346,14 +399,19 @@ def get_expected_time_for(parameter, service_level, start_date_time):
current_weekday = weekdays[current_date_time.weekday()]
if not is_holiday(current_date_time, holidays) and current_weekday in support_days:
- start_time = current_date_time - datetime(current_date_time.year, current_date_time.month, current_date_time.day) \
- if getdate(current_date_time) == getdate(start_date_time) and get_time_in_timedelta(current_date_time.time()) > support_days[current_weekday].start_time \
+ start_time = (
+ current_date_time
+ - datetime(current_date_time.year, current_date_time.month, current_date_time.day)
+ if getdate(current_date_time) == getdate(start_date_time)
+ and get_time_in_timedelta(current_date_time.time()) > support_days[current_weekday].start_time
else support_days[current_weekday].start_time
+ )
end_time = support_days[current_weekday].end_time
time_left_today = time_diff_in_seconds(end_time, start_time)
# no time left for support today
- if time_left_today <= 0: pass
+ if time_left_today <= 0:
+ pass
elif allotted_seconds:
if time_left_today >= allotted_seconds:
expected_time = datetime.combine(getdate(current_date_time), get_time(start_time))
@@ -372,6 +430,7 @@ def get_expected_time_for(parameter, service_level, start_date_time):
return current_date_time
+
def set_service_level_agreement_variance(issue=None):
current_time = frappe.flags.current_time or now_datetime()
@@ -382,17 +441,25 @@ def set_service_level_agreement_variance(issue=None):
for issue in frappe.get_list("Issue", filters=filters):
doc = frappe.get_doc("Issue", issue.name)
- if not doc.first_responded_on: # first_responded_on set when first reply is sent to customer
+ if not doc.first_responded_on: # first_responded_on set when first reply is sent to customer
variance = round(time_diff_in_seconds(doc.response_by, current_time), 2)
- frappe.db.set_value(dt="Issue", dn=doc.name, field="response_by_variance", val=variance, update_modified=False)
+ frappe.db.set_value(
+ dt="Issue", dn=doc.name, field="response_by_variance", val=variance, update_modified=False
+ )
if variance < 0:
- frappe.db.set_value(dt="Issue", dn=doc.name, field="agreement_status", val="Failed", update_modified=False)
+ frappe.db.set_value(
+ dt="Issue", dn=doc.name, field="agreement_status", val="Failed", update_modified=False
+ )
- if not doc.resolution_date: # resolution_date set when issue has been closed
+ if not doc.resolution_date: # resolution_date set when issue has been closed
variance = round(time_diff_in_seconds(doc.resolution_by, current_time), 2)
- frappe.db.set_value(dt="Issue", dn=doc.name, field="resolution_by_variance", val=variance, update_modified=False)
+ frappe.db.set_value(
+ dt="Issue", dn=doc.name, field="resolution_by_variance", val=variance, update_modified=False
+ )
if variance < 0:
- frappe.db.set_value(dt="Issue", dn=doc.name, field="agreement_status", val="Failed", update_modified=False)
+ frappe.db.set_value(
+ dt="Issue", dn=doc.name, field="agreement_status", val="Failed", update_modified=False
+ )
def set_resolution_time(issue):
@@ -403,18 +470,20 @@ def set_resolution_time(issue):
def set_user_resolution_time(issue):
# total time taken by a user to close the issue apart from wait_time
- communications = frappe.get_list("Communication", filters={
- "reference_doctype": issue.doctype,
- "reference_name": issue.name
- },
+ communications = frappe.get_list(
+ "Communication",
+ filters={"reference_doctype": issue.doctype, "reference_name": issue.name},
fields=["sent_or_received", "name", "creation"],
- order_by="creation"
+ order_by="creation",
)
pending_time = []
for i in range(len(communications)):
- if communications[i].sent_or_received == "Received" and communications[i-1].sent_or_received == "Sent":
- wait_time = time_diff_in_seconds(communications[i].creation, communications[i-1].creation)
+ if (
+ communications[i].sent_or_received == "Received"
+ and communications[i - 1].sent_or_received == "Sent"
+ ):
+ wait_time = time_diff_in_seconds(communications[i].creation, communications[i - 1].creation)
if wait_time > 0:
pending_time.append(wait_time)
@@ -431,7 +500,7 @@ def get_list_context(context=None):
"row_template": "templates/includes/issue_row.html",
"show_sidebar": True,
"show_search": True,
- "no_breadcrumbs": True
+ "no_breadcrumbs": True,
}
@@ -448,7 +517,8 @@ def get_issue_list(doctype, txt, filters, limit_start, limit_page_length=20, ord
ignore_permissions = False
if is_website_user():
- if not filters: filters = {}
+ if not filters:
+ filters = {}
if customer:
filters["customer"] = customer
@@ -457,7 +527,9 @@ def get_issue_list(doctype, txt, filters, limit_start, limit_page_length=20, ord
ignore_permissions = True
- return get_list(doctype, txt, filters, limit_start, limit_page_length, ignore_permissions=ignore_permissions)
+ return get_list(
+ doctype, txt, filters, limit_start, limit_page_length, ignore_permissions=ignore_permissions
+ )
@frappe.whitelist()
@@ -466,18 +538,26 @@ def set_multiple_status(names, status):
for name in names:
set_status(name, status)
+
@frappe.whitelist()
def set_status(name, status):
st = frappe.get_doc("Issue", name)
st.status = status
st.save()
+
def auto_close_tickets():
"""Auto-close replied support tickets after 7 days"""
- auto_close_after_days = frappe.db.get_value("Support Settings", "Support Settings", "close_issue_after_days") or 7
+ auto_close_after_days = (
+ frappe.db.get_value("Support Settings", "Support Settings", "close_issue_after_days") or 7
+ )
- issues = frappe.db.sql(""" select name from tabIssue where status='Replied' and
- modified resolution:
- frappe.throw(_("Response Time for {0} priority in row {1} can't be greater than Resolution Time.").format(priority.priority, priority.idx))
+ frappe.throw(
+ _("Response Time for {0} priority in row {1} can't be greater than Resolution Time.").format(
+ priority.priority, priority.idx
+ )
+ )
# Check if repeated priority
if not len(set(priorities)) == len(priorities):
@@ -59,15 +66,27 @@ class ServiceLevelAgreement(Document):
for support_and_resolution in self.support_and_resolution:
# Check if start and end time is set for every support day
if not (support_and_resolution.start_time or support_and_resolution.end_time):
- frappe.throw(_("Set Start Time and End Time for \
- Support Day {0} at index {1}.".format(support_and_resolution.workday, support_and_resolution.idx)))
+ frappe.throw(
+ _(
+ "Set Start Time and End Time for \
+ Support Day {0} at index {1}.".format(
+ support_and_resolution.workday, support_and_resolution.idx
+ )
+ )
+ )
support_days.append(support_and_resolution.workday)
support_and_resolution.idx = week.index(support_and_resolution.workday) + 1
if support_and_resolution.start_time >= support_and_resolution.end_time:
- frappe.throw(_("Start Time can't be greater than or equal to End Time \
- for {0}.".format(support_and_resolution.workday)))
+ frappe.throw(
+ _(
+ "Start Time can't be greater than or equal to End Time \
+ for {0}.".format(
+ support_and_resolution.workday
+ )
+ )
+ )
# Check for repeated workday
if not len(set(support_days)) == len(support_days):
@@ -75,12 +94,21 @@ class ServiceLevelAgreement(Document):
frappe.throw(_("Workday {0} has been repeated.").format(repeated_days))
def validate_doc(self):
- if not frappe.db.get_single_value("Support Settings", "track_service_level_agreement") and self.enable:
- frappe.throw(_("{0} is not enabled in {1}").format(frappe.bold("Track Service Level Agreement"),
- get_link_to_form("Support Settings", "Support Settings")))
+ if (
+ not frappe.db.get_single_value("Support Settings", "track_service_level_agreement")
+ and self.enable
+ ):
+ frappe.throw(
+ _("{0} is not enabled in {1}").format(
+ frappe.bold("Track Service Level Agreement"),
+ get_link_to_form("Support Settings", "Support Settings"),
+ )
+ )
if self.default_service_level_agreement:
- if frappe.db.exists("Service Level Agreement", {"default_service_level_agreement": "1", "name": ["!=", self.name]}):
+ if frappe.db.exists(
+ "Service Level Agreement", {"default_service_level_agreement": "1", "name": ["!=", self.name]}
+ ):
frappe.throw(_("A Default Service Level Agreement already exists."))
else:
if self.start_date and self.end_date:
@@ -91,11 +119,18 @@ class ServiceLevelAgreement(Document):
frappe.throw(_("End Date of Agreement can't be less than today."))
if self.entity_type and self.entity:
- if frappe.db.exists("Service Level Agreement", {"entity_type": self.entity_type, "entity": self.entity, "name": ["!=", self.name]}):
- frappe.throw(_("Service Level Agreement with Entity Type {0} and Entity {1} already exists.").format(self.entity_type, self.entity))
+ if frappe.db.exists(
+ "Service Level Agreement",
+ {"entity_type": self.entity_type, "entity": self.entity, "name": ["!=", self.name]},
+ ):
+ frappe.throw(
+ _("Service Level Agreement with Entity Type {0} and Entity {1} already exists.").format(
+ self.entity_type, self.entity
+ )
+ )
def validate_condition(self):
- temp_doc = frappe.new_doc('Issue')
+ temp_doc = frappe.new_doc("Issue")
if self.condition:
try:
frappe.safe_eval(self.condition, None, get_context(temp_doc))
@@ -105,58 +140,77 @@ class ServiceLevelAgreement(Document):
def get_service_level_agreement_priority(self, priority):
priority = frappe.get_doc("Service Level Priority", {"priority": priority, "parent": self.name})
- return frappe._dict({
- "priority": priority.priority,
- "response_time": priority.response_time,
- "resolution_time": priority.resolution_time
- })
+ return frappe._dict(
+ {
+ "priority": priority.priority,
+ "response_time": priority.response_time,
+ "resolution_time": priority.resolution_time,
+ }
+ )
+
def check_agreement_status():
- service_level_agreements = frappe.get_list("Service Level Agreement", filters=[
- {"active": 1},
- {"default_service_level_agreement": 0}
- ], fields=["name"])
+ service_level_agreements = frappe.get_list(
+ "Service Level Agreement",
+ filters=[{"active": 1}, {"default_service_level_agreement": 0}],
+ fields=["name"],
+ )
for service_level_agreement in service_level_agreements:
doc = frappe.get_doc("Service Level Agreement", service_level_agreement.name)
if doc.end_date and getdate(doc.end_date) < getdate(frappe.utils.getdate()):
frappe.db.set_value("Service Level Agreement", service_level_agreement.name, "active", 0)
+
def get_active_service_level_agreement_for(doc):
if not frappe.db.get_single_value("Support Settings", "track_service_level_agreement"):
return
filters = [
["Service Level Agreement", "active", "=", 1],
- ["Service Level Agreement", "enable", "=", 1]
+ ["Service Level Agreement", "enable", "=", 1],
]
- if doc.get('priority'):
- filters.append(["Service Level Priority", "priority", "=", doc.get('priority')])
+ if doc.get("priority"):
+ filters.append(["Service Level Priority", "priority", "=", doc.get("priority")])
- customer = doc.get('customer')
+ customer = doc.get("customer")
or_filters = [
- ["Service Level Agreement", "entity", "in", [customer, get_customer_group(customer), get_customer_territory(customer)]]
+ [
+ "Service Level Agreement",
+ "entity",
+ "in",
+ [customer, get_customer_group(customer), get_customer_territory(customer)],
+ ]
]
- service_level_agreement = doc.get('service_level_agreement')
+ service_level_agreement = doc.get("service_level_agreement")
if service_level_agreement:
or_filters = [
- ["Service Level Agreement", "name", "=", doc.get('service_level_agreement')],
+ ["Service Level Agreement", "name", "=", doc.get("service_level_agreement")],
]
- default_sla_filter = filters + [["Service Level Agreement", "default_service_level_agreement", "=", 1]]
- default_sla = frappe.get_all("Service Level Agreement", filters=default_sla_filter,
- fields=["name", "default_priority", "condition"])
+ default_sla_filter = filters + [
+ ["Service Level Agreement", "default_service_level_agreement", "=", 1]
+ ]
+ default_sla = frappe.get_all(
+ "Service Level Agreement",
+ filters=default_sla_filter,
+ fields=["name", "default_priority", "condition"],
+ )
filters += [["Service Level Agreement", "default_service_level_agreement", "=", 0]]
- agreements = frappe.get_all("Service Level Agreement", filters=filters, or_filters=or_filters,
- fields=["name", "default_priority", "condition"])
+ agreements = frappe.get_all(
+ "Service Level Agreement",
+ filters=filters,
+ or_filters=or_filters,
+ fields=["name", "default_priority", "condition"],
+ )
# check if the current document on which SLA is to be applied fulfills all the conditions
filtered_agreements = []
for agreement in agreements:
- condition = agreement.get('condition')
+ condition = agreement.get("condition")
if not condition or (condition and frappe.safe_eval(condition, None, get_context(doc))):
filtered_agreements.append(agreement)
@@ -165,17 +219,25 @@ def get_active_service_level_agreement_for(doc):
return filtered_agreements[0] if filtered_agreements else None
+
def get_context(doc):
- return {"doc": doc.as_dict(), "nowdate": nowdate, "frappe": frappe._dict(utils=get_safe_globals().get("frappe").get("utils"))}
+ return {
+ "doc": doc.as_dict(),
+ "nowdate": nowdate,
+ "frappe": frappe._dict(utils=get_safe_globals().get("frappe").get("utils")),
+ }
+
def get_customer_group(customer):
if customer:
return frappe.db.get_value("Customer", customer, "customer_group")
+
def get_customer_territory(customer):
if customer:
return frappe.db.get_value("Customer", customer, "territory")
+
@frappe.whitelist()
def get_service_level_agreement_filters(name, customer=None):
if not frappe.db.get_single_value("Support Settings", "track_service_level_agreement"):
@@ -183,25 +245,37 @@ def get_service_level_agreement_filters(name, customer=None):
filters = [
["Service Level Agreement", "active", "=", 1],
- ["Service Level Agreement", "enable", "=", 1]
+ ["Service Level Agreement", "enable", "=", 1],
]
if not customer:
- or_filters = [
- ["Service Level Agreement", "default_service_level_agreement", "=", 1]
- ]
+ or_filters = [["Service Level Agreement", "default_service_level_agreement", "=", 1]]
else:
# Include SLA with No Entity and Entity Type
or_filters = [
- ["Service Level Agreement", "entity", "in", [customer, get_customer_group(customer), get_customer_territory(customer), ""]],
- ["Service Level Agreement", "default_service_level_agreement", "=", 1]
+ [
+ "Service Level Agreement",
+ "entity",
+ "in",
+ [customer, get_customer_group(customer), get_customer_territory(customer), ""],
+ ],
+ ["Service Level Agreement", "default_service_level_agreement", "=", 1],
]
return {
- "priority": [priority.priority for priority in frappe.get_list("Service Level Priority", filters={"parent": name}, fields=["priority"])],
- "service_level_agreements": [d.name for d in frappe.get_list("Service Level Agreement", filters=filters, or_filters=or_filters)]
+ "priority": [
+ priority.priority
+ for priority in frappe.get_list(
+ "Service Level Priority", filters={"parent": name}, fields=["priority"]
+ )
+ ],
+ "service_level_agreements": [
+ d.name
+ for d in frappe.get_list("Service Level Agreement", filters=filters, or_filters=or_filters)
+ ],
}
+
def get_repeated(values):
unique_list = []
diff = []
diff --git a/erpnext/support/doctype/service_level_agreement/service_level_agreement_dashboard.py b/erpnext/support/doctype/service_level_agreement/service_level_agreement_dashboard.py
index 22e2c374e12..8fd3025c30a 100644
--- a/erpnext/support/doctype/service_level_agreement/service_level_agreement_dashboard.py
+++ b/erpnext/support/doctype/service_level_agreement/service_level_agreement_dashboard.py
@@ -3,11 +3,6 @@ from frappe import _
def get_data():
return {
- 'fieldname': 'service_level_agreement',
- 'transactions': [
- {
- 'label': _('Issue'),
- 'items': ['Issue']
- }
- ]
+ "fieldname": "service_level_agreement",
+ "transactions": [{"label": _("Issue"), "items": ["Issue"]}],
}
diff --git a/erpnext/support/doctype/service_level_agreement/test_service_level_agreement.py b/erpnext/support/doctype/service_level_agreement/test_service_level_agreement.py
index 4c4a684333f..0137be08f8d 100644
--- a/erpnext/support/doctype/service_level_agreement/test_service_level_agreement.py
+++ b/erpnext/support/doctype/service_level_agreement/test_service_level_agreement.py
@@ -16,55 +16,131 @@ class TestServiceLevelAgreement(unittest.TestCase):
def test_service_level_agreement(self):
# Default Service Level Agreement
- create_default_service_level_agreement = create_service_level_agreement(default_service_level_agreement=1,
- holiday_list="__Test Holiday List", employee_group="_Test Employee Group",
- entity_type=None, entity=None, response_time=14400, resolution_time=21600)
+ create_default_service_level_agreement = create_service_level_agreement(
+ default_service_level_agreement=1,
+ holiday_list="__Test Holiday List",
+ employee_group="_Test Employee Group",
+ entity_type=None,
+ entity=None,
+ response_time=14400,
+ resolution_time=21600,
+ )
- get_default_service_level_agreement = get_service_level_agreement(default_service_level_agreement=1)
+ get_default_service_level_agreement = get_service_level_agreement(
+ default_service_level_agreement=1
+ )
- self.assertEqual(create_default_service_level_agreement.name, get_default_service_level_agreement.name)
- self.assertEqual(create_default_service_level_agreement.entity_type, get_default_service_level_agreement.entity_type)
- self.assertEqual(create_default_service_level_agreement.entity, get_default_service_level_agreement.entity)
- self.assertEqual(create_default_service_level_agreement.default_service_level_agreement, get_default_service_level_agreement.default_service_level_agreement)
+ self.assertEqual(
+ create_default_service_level_agreement.name, get_default_service_level_agreement.name
+ )
+ self.assertEqual(
+ create_default_service_level_agreement.entity_type,
+ get_default_service_level_agreement.entity_type,
+ )
+ self.assertEqual(
+ create_default_service_level_agreement.entity, get_default_service_level_agreement.entity
+ )
+ self.assertEqual(
+ create_default_service_level_agreement.default_service_level_agreement,
+ get_default_service_level_agreement.default_service_level_agreement,
+ )
# Service Level Agreement for Customer
customer = create_customer()
- create_customer_service_level_agreement = create_service_level_agreement(default_service_level_agreement=0,
- holiday_list="__Test Holiday List", employee_group="_Test Employee Group",
- entity_type="Customer", entity=customer, response_time=7200, resolution_time=10800)
- get_customer_service_level_agreement = get_service_level_agreement(entity_type="Customer", entity=customer)
+ create_customer_service_level_agreement = create_service_level_agreement(
+ default_service_level_agreement=0,
+ holiday_list="__Test Holiday List",
+ employee_group="_Test Employee Group",
+ entity_type="Customer",
+ entity=customer,
+ response_time=7200,
+ resolution_time=10800,
+ )
+ get_customer_service_level_agreement = get_service_level_agreement(
+ entity_type="Customer", entity=customer
+ )
- self.assertEqual(create_customer_service_level_agreement.name, get_customer_service_level_agreement.name)
- self.assertEqual(create_customer_service_level_agreement.entity_type, get_customer_service_level_agreement.entity_type)
- self.assertEqual(create_customer_service_level_agreement.entity, get_customer_service_level_agreement.entity)
- self.assertEqual(create_customer_service_level_agreement.default_service_level_agreement, get_customer_service_level_agreement.default_service_level_agreement)
+ self.assertEqual(
+ create_customer_service_level_agreement.name, get_customer_service_level_agreement.name
+ )
+ self.assertEqual(
+ create_customer_service_level_agreement.entity_type,
+ get_customer_service_level_agreement.entity_type,
+ )
+ self.assertEqual(
+ create_customer_service_level_agreement.entity, get_customer_service_level_agreement.entity
+ )
+ self.assertEqual(
+ create_customer_service_level_agreement.default_service_level_agreement,
+ get_customer_service_level_agreement.default_service_level_agreement,
+ )
# Service Level Agreement for Customer Group
customer_group = create_customer_group()
- create_customer_group_service_level_agreement = create_service_level_agreement(default_service_level_agreement=0,
- holiday_list="__Test Holiday List", employee_group="_Test Employee Group",
- entity_type="Customer Group", entity=customer_group, response_time=7200, resolution_time=10800)
- get_customer_group_service_level_agreement = get_service_level_agreement(entity_type="Customer Group", entity=customer_group)
+ create_customer_group_service_level_agreement = create_service_level_agreement(
+ default_service_level_agreement=0,
+ holiday_list="__Test Holiday List",
+ employee_group="_Test Employee Group",
+ entity_type="Customer Group",
+ entity=customer_group,
+ response_time=7200,
+ resolution_time=10800,
+ )
+ get_customer_group_service_level_agreement = get_service_level_agreement(
+ entity_type="Customer Group", entity=customer_group
+ )
- self.assertEqual(create_customer_group_service_level_agreement.name, get_customer_group_service_level_agreement.name)
- self.assertEqual(create_customer_group_service_level_agreement.entity_type, get_customer_group_service_level_agreement.entity_type)
- self.assertEqual(create_customer_group_service_level_agreement.entity, get_customer_group_service_level_agreement.entity)
- self.assertEqual(create_customer_group_service_level_agreement.default_service_level_agreement, get_customer_group_service_level_agreement.default_service_level_agreement)
+ self.assertEqual(
+ create_customer_group_service_level_agreement.name,
+ get_customer_group_service_level_agreement.name,
+ )
+ self.assertEqual(
+ create_customer_group_service_level_agreement.entity_type,
+ get_customer_group_service_level_agreement.entity_type,
+ )
+ self.assertEqual(
+ create_customer_group_service_level_agreement.entity,
+ get_customer_group_service_level_agreement.entity,
+ )
+ self.assertEqual(
+ create_customer_group_service_level_agreement.default_service_level_agreement,
+ get_customer_group_service_level_agreement.default_service_level_agreement,
+ )
# Service Level Agreement for Territory
territory = create_territory()
- create_territory_service_level_agreement = create_service_level_agreement(default_service_level_agreement=0,
- holiday_list="__Test Holiday List", employee_group="_Test Employee Group",
- entity_type="Territory", entity=territory, response_time=7200, resolution_time=10800)
- get_territory_service_level_agreement = get_service_level_agreement(entity_type="Territory", entity=territory)
+ create_territory_service_level_agreement = create_service_level_agreement(
+ default_service_level_agreement=0,
+ holiday_list="__Test Holiday List",
+ employee_group="_Test Employee Group",
+ entity_type="Territory",
+ entity=territory,
+ response_time=7200,
+ resolution_time=10800,
+ )
+ get_territory_service_level_agreement = get_service_level_agreement(
+ entity_type="Territory", entity=territory
+ )
- self.assertEqual(create_territory_service_level_agreement.name, get_territory_service_level_agreement.name)
- self.assertEqual(create_territory_service_level_agreement.entity_type, get_territory_service_level_agreement.entity_type)
- self.assertEqual(create_territory_service_level_agreement.entity, get_territory_service_level_agreement.entity)
- self.assertEqual(create_territory_service_level_agreement.default_service_level_agreement, get_territory_service_level_agreement.default_service_level_agreement)
+ self.assertEqual(
+ create_territory_service_level_agreement.name, get_territory_service_level_agreement.name
+ )
+ self.assertEqual(
+ create_territory_service_level_agreement.entity_type,
+ get_territory_service_level_agreement.entity_type,
+ )
+ self.assertEqual(
+ create_territory_service_level_agreement.entity, get_territory_service_level_agreement.entity
+ )
+ self.assertEqual(
+ create_territory_service_level_agreement.default_service_level_agreement,
+ get_territory_service_level_agreement.default_service_level_agreement,
+ )
-def get_service_level_agreement(default_service_level_agreement=None, entity_type=None, entity=None):
+def get_service_level_agreement(
+ default_service_level_agreement=None, entity_type=None, entity=None
+):
if default_service_level_agreement:
filters = {"default_service_level_agreement": default_service_level_agreement}
else:
@@ -73,93 +149,96 @@ def get_service_level_agreement(default_service_level_agreement=None, entity_typ
service_level_agreement = frappe.get_doc("Service Level Agreement", filters)
return service_level_agreement
-def create_service_level_agreement(default_service_level_agreement, holiday_list, employee_group,
- response_time, entity_type, entity, resolution_time):
+
+def create_service_level_agreement(
+ default_service_level_agreement,
+ holiday_list,
+ employee_group,
+ response_time,
+ entity_type,
+ entity,
+ resolution_time,
+):
employee_group = make_employee_group()
make_holiday_list()
make_priorities()
- service_level_agreement = frappe.get_doc({
- "doctype": "Service Level Agreement",
- "enable": 1,
- "service_level": "__Test Service Level",
- "default_service_level_agreement": default_service_level_agreement,
- "default_priority": "Medium",
- "holiday_list": holiday_list,
- "employee_group": employee_group,
- "entity_type": entity_type,
- "entity": entity,
- "start_date": frappe.utils.getdate(),
- "end_date": frappe.utils.add_to_date(frappe.utils.getdate(), days=100),
- "priorities": [
- {
- "priority": "Low",
- "response_time": response_time,
- "response_time_period": "Hour",
- "resolution_time": resolution_time,
- "resolution_time_period": "Hour",
- },
- {
- "priority": "Medium",
- "response_time": response_time,
- "default_priority": 1,
- "response_time_period": "Hour",
- "resolution_time": resolution_time,
- "resolution_time_period": "Hour",
- },
- {
- "priority": "High",
- "response_time": response_time,
- "response_time_period": "Hour",
- "resolution_time": resolution_time,
- "resolution_time_period": "Hour",
- }
- ],
- "pause_sla_on": [
- {
- "status": "Replied"
- }
- ],
- "support_and_resolution": [
- {
- "workday": "Monday",
- "start_time": "10:00:00",
- "end_time": "18:00:00",
- },
- {
- "workday": "Tuesday",
- "start_time": "10:00:00",
- "end_time": "18:00:00",
- },
- {
- "workday": "Wednesday",
- "start_time": "10:00:00",
- "end_time": "18:00:00",
- },
- {
- "workday": "Thursday",
- "start_time": "10:00:00",
- "end_time": "18:00:00",
- },
- {
- "workday": "Friday",
- "start_time": "10:00:00",
- "end_time": "18:00:00",
- }
- ]
- })
+ service_level_agreement = frappe.get_doc(
+ {
+ "doctype": "Service Level Agreement",
+ "enable": 1,
+ "service_level": "__Test Service Level",
+ "default_service_level_agreement": default_service_level_agreement,
+ "default_priority": "Medium",
+ "holiday_list": holiday_list,
+ "employee_group": employee_group,
+ "entity_type": entity_type,
+ "entity": entity,
+ "start_date": frappe.utils.getdate(),
+ "end_date": frappe.utils.add_to_date(frappe.utils.getdate(), days=100),
+ "priorities": [
+ {
+ "priority": "Low",
+ "response_time": response_time,
+ "response_time_period": "Hour",
+ "resolution_time": resolution_time,
+ "resolution_time_period": "Hour",
+ },
+ {
+ "priority": "Medium",
+ "response_time": response_time,
+ "default_priority": 1,
+ "response_time_period": "Hour",
+ "resolution_time": resolution_time,
+ "resolution_time_period": "Hour",
+ },
+ {
+ "priority": "High",
+ "response_time": response_time,
+ "response_time_period": "Hour",
+ "resolution_time": resolution_time,
+ "resolution_time_period": "Hour",
+ },
+ ],
+ "pause_sla_on": [{"status": "Replied"}],
+ "support_and_resolution": [
+ {
+ "workday": "Monday",
+ "start_time": "10:00:00",
+ "end_time": "18:00:00",
+ },
+ {
+ "workday": "Tuesday",
+ "start_time": "10:00:00",
+ "end_time": "18:00:00",
+ },
+ {
+ "workday": "Wednesday",
+ "start_time": "10:00:00",
+ "end_time": "18:00:00",
+ },
+ {
+ "workday": "Thursday",
+ "start_time": "10:00:00",
+ "end_time": "18:00:00",
+ },
+ {
+ "workday": "Friday",
+ "start_time": "10:00:00",
+ "end_time": "18:00:00",
+ },
+ ],
+ }
+ )
filters = {
"default_service_level_agreement": service_level_agreement.default_service_level_agreement,
- "service_level": service_level_agreement.service_level
+ "service_level": service_level_agreement.service_level,
}
if not default_service_level_agreement:
- filters.update({
- "entity_type": entity_type,
- "entity": entity
- })
+ filters.update({"entity_type": entity_type, "entity": entity})
service_level_agreement_exists = frappe.db.exists("Service Level Agreement", filters)
@@ -171,24 +250,26 @@ def create_service_level_agreement(default_service_level_agreement, holiday_list
def create_customer():
- customer = frappe.get_doc({
- "doctype": "Customer",
- "customer_name": "_Test Customer",
- "customer_group": "Commercial",
- "customer_type": "Individual",
- "territory": "Rest Of The World"
- })
+ customer = frappe.get_doc(
+ {
+ "doctype": "Customer",
+ "customer_name": "_Test Customer",
+ "customer_group": "Commercial",
+ "customer_type": "Individual",
+ "territory": "Rest Of The World",
+ }
+ )
if not frappe.db.exists("Customer", "_Test Customer"):
customer.insert(ignore_permissions=True)
return customer.name
else:
return frappe.db.exists("Customer", "_Test Customer")
+
def create_customer_group():
- customer_group = frappe.get_doc({
- "doctype": "Customer Group",
- "customer_group_name": "_Test SLA Customer Group"
- })
+ customer_group = frappe.get_doc(
+ {"doctype": "Customer Group", "customer_group_name": "_Test SLA Customer Group"}
+ )
if not frappe.db.exists("Customer Group", {"customer_group_name": "_Test SLA Customer Group"}):
customer_group.insert()
@@ -196,11 +277,14 @@ def create_customer_group():
else:
return frappe.db.exists("Customer Group", {"customer_group_name": "_Test SLA Customer Group"})
+
def create_territory():
- territory = frappe.get_doc({
- "doctype": "Territory",
- "territory_name": "_Test SLA Territory",
- })
+ territory = frappe.get_doc(
+ {
+ "doctype": "Territory",
+ "territory_name": "_Test SLA Territory",
+ }
+ )
if not frappe.db.exists("Territory", {"territory_name": "_Test SLA Territory"}):
territory.insert()
@@ -208,42 +292,65 @@ def create_territory():
else:
return frappe.db.exists("Territory", {"territory_name": "_Test SLA Territory"})
+
def create_service_level_agreements_for_issues():
- create_service_level_agreement(default_service_level_agreement=1, holiday_list="__Test Holiday List",
- employee_group="_Test Employee Group", entity_type=None, entity=None, response_time=14400, resolution_time=21600)
+ create_service_level_agreement(
+ default_service_level_agreement=1,
+ holiday_list="__Test Holiday List",
+ employee_group="_Test Employee Group",
+ entity_type=None,
+ entity=None,
+ response_time=14400,
+ resolution_time=21600,
+ )
create_customer()
- create_service_level_agreement(default_service_level_agreement=0, holiday_list="__Test Holiday List",
- employee_group="_Test Employee Group", entity_type="Customer", entity="_Test Customer", response_time=7200, resolution_time=10800)
+ create_service_level_agreement(
+ default_service_level_agreement=0,
+ holiday_list="__Test Holiday List",
+ employee_group="_Test Employee Group",
+ entity_type="Customer",
+ entity="_Test Customer",
+ response_time=7200,
+ resolution_time=10800,
+ )
create_customer_group()
- create_service_level_agreement(default_service_level_agreement=0, holiday_list="__Test Holiday List",
- employee_group="_Test Employee Group", entity_type="Customer Group", entity="_Test SLA Customer Group", response_time=7200, resolution_time=10800)
+ create_service_level_agreement(
+ default_service_level_agreement=0,
+ holiday_list="__Test Holiday List",
+ employee_group="_Test Employee Group",
+ entity_type="Customer Group",
+ entity="_Test SLA Customer Group",
+ response_time=7200,
+ resolution_time=10800,
+ )
create_territory()
- create_service_level_agreement(default_service_level_agreement=0, holiday_list="__Test Holiday List",
- employee_group="_Test Employee Group", entity_type="Territory", entity="_Test SLA Territory", response_time=7200, resolution_time=10800)
+ create_service_level_agreement(
+ default_service_level_agreement=0,
+ holiday_list="__Test Holiday List",
+ employee_group="_Test Employee Group",
+ entity_type="Territory",
+ entity="_Test SLA Territory",
+ response_time=7200,
+ resolution_time=10800,
+ )
+
def make_holiday_list():
holiday_list = frappe.db.exists("Holiday List", "__Test Holiday List")
if not holiday_list:
- holiday_list = frappe.get_doc({
- "doctype": "Holiday List",
- "holiday_list_name": "__Test Holiday List",
- "from_date": "2019-01-01",
- "to_date": "2019-12-31",
- "holidays": [
- {
- "description": "Test Holiday 1",
- "holiday_date": "2019-03-05"
- },
- {
- "description": "Test Holiday 2",
- "holiday_date": "2019-03-07"
- },
- {
- "description": "Test Holiday 3",
- "holiday_date": "2019-02-11"
- },
- ]
- }).insert()
+ holiday_list = frappe.get_doc(
+ {
+ "doctype": "Holiday List",
+ "holiday_list_name": "__Test Holiday List",
+ "from_date": "2019-01-01",
+ "to_date": "2019-12-31",
+ "holidays": [
+ {"description": "Test Holiday 1", "holiday_date": "2019-03-05"},
+ {"description": "Test Holiday 2", "holiday_date": "2019-03-07"},
+ {"description": "Test Holiday 3", "holiday_date": "2019-02-11"},
+ ],
+ }
+ ).insert()
diff --git a/erpnext/support/doctype/warranty_claim/test_warranty_claim.py b/erpnext/support/doctype/warranty_claim/test_warranty_claim.py
index f022d55a4b1..19e23493fe5 100644
--- a/erpnext/support/doctype/warranty_claim/test_warranty_claim.py
+++ b/erpnext/support/doctype/warranty_claim/test_warranty_claim.py
@@ -5,7 +5,8 @@ import unittest
import frappe
-test_records = frappe.get_test_records('Warranty Claim')
+test_records = frappe.get_test_records("Warranty Claim")
+
class TestWarrantyClaim(unittest.TestCase):
pass
diff --git a/erpnext/support/doctype/warranty_claim/warranty_claim.py b/erpnext/support/doctype/warranty_claim/warranty_claim.py
index 87e95410264..5e2ea067a86 100644
--- a/erpnext/support/doctype/warranty_claim/warranty_claim.py
+++ b/erpnext/support/doctype/warranty_claim/warranty_claim.py
@@ -2,7 +2,6 @@
# License: GNU General Public License v3. See license.txt
-
import frappe
from frappe import _, session
from frappe.utils import now_datetime
@@ -15,27 +14,33 @@ class WarrantyClaim(TransactionBase):
return _("{0}: From {1}").format(self.status, self.customer_name)
def validate(self):
- if session['user'] != 'Guest' and not self.customer:
+ if session["user"] != "Guest" and not self.customer:
frappe.throw(_("Customer is required"))
- if self.status=="Closed" and not self.resolution_date and \
- frappe.db.get_value("Warranty Claim", self.name, "status")!="Closed":
+ if (
+ self.status == "Closed"
+ and not self.resolution_date
+ and frappe.db.get_value("Warranty Claim", self.name, "status") != "Closed"
+ ):
self.resolution_date = now_datetime()
def on_cancel(self):
- lst = frappe.db.sql("""select t1.name
+ lst = frappe.db.sql(
+ """select t1.name
from `tabMaintenance Visit` t1, `tabMaintenance Visit Purpose` t2
where t2.parent = t1.name and t2.prevdoc_docname = %s and t1.docstatus!=2""",
- (self.name))
+ (self.name),
+ )
if lst:
- lst1 = ','.join(x[0] for x in lst)
+ lst1 = ",".join(x[0] for x in lst)
frappe.throw(_("Cancel Material Visit {0} before cancelling this Warranty Claim").format(lst1))
else:
- frappe.db.set(self, 'status', 'Cancelled')
+ frappe.db.set(self, "status", "Cancelled")
def on_update(self):
pass
+
@frappe.whitelist()
def make_maintenance_visit(source_name, target_doc=None):
from frappe.model.mapper import get_mapped_doc, map_child_doc
@@ -44,25 +49,25 @@ def make_maintenance_visit(source_name, target_doc=None):
target_doc.prevdoc_doctype = source_parent.doctype
target_doc.prevdoc_docname = source_parent.name
- visit = frappe.db.sql("""select t1.name
+ visit = frappe.db.sql(
+ """select t1.name
from `tabMaintenance Visit` t1, `tabMaintenance Visit Purpose` t2
where t2.parent=t1.name and t2.prevdoc_docname=%s
- and t1.docstatus=1 and t1.completion_status='Fully Completed'""", source_name)
+ and t1.docstatus=1 and t1.completion_status='Fully Completed'""",
+ source_name,
+ )
if not visit:
- target_doc = get_mapped_doc("Warranty Claim", source_name, {
- "Warranty Claim": {
- "doctype": "Maintenance Visit",
- "field_map": {}
- }
- }, target_doc)
+ target_doc = get_mapped_doc(
+ "Warranty Claim",
+ source_name,
+ {"Warranty Claim": {"doctype": "Maintenance Visit", "field_map": {}}},
+ target_doc,
+ )
source_doc = frappe.get_doc("Warranty Claim", source_name)
if source_doc.get("item_code"):
- table_map = {
- "doctype": "Maintenance Visit Purpose",
- "postprocess": _update_links
- }
+ table_map = {"doctype": "Maintenance Visit Purpose", "postprocess": _update_links}
map_child_doc(source_doc, target_doc, table_map, source_doc)
return target_doc
diff --git a/erpnext/support/report/first_response_time_for_issues/first_response_time_for_issues.py b/erpnext/support/report/first_response_time_for_issues/first_response_time_for_issues.py
index 2ab0fb88a7f..5b51ef81c7b 100644
--- a/erpnext/support/report/first_response_time_for_issues/first_response_time_for_issues.py
+++ b/erpnext/support/report/first_response_time_for_issues/first_response_time_for_issues.py
@@ -7,21 +7,17 @@ import frappe
def execute(filters=None):
columns = [
+ {"fieldname": "creation_date", "label": "Date", "fieldtype": "Date", "width": 300},
{
- 'fieldname': 'creation_date',
- 'label': 'Date',
- 'fieldtype': 'Date',
- 'width': 300
- },
- {
- 'fieldname': 'first_response_time',
- 'fieldtype': 'Duration',
- 'label': 'First Response Time',
- 'width': 300
+ "fieldname": "first_response_time",
+ "fieldtype": "Duration",
+ "label": "First Response Time",
+ "width": 300,
},
]
- data = frappe.db.sql('''
+ data = frappe.db.sql(
+ """
SELECT
date(creation) as creation_date,
avg(first_response_time) as avg_response_time
@@ -31,6 +27,8 @@ def execute(filters=None):
and first_response_time > 0
GROUP BY creation_date
ORDER BY creation_date desc
- ''', (filters.from_date, filters.to_date))
+ """,
+ (filters.from_date, filters.to_date),
+ )
return columns, data
diff --git a/erpnext/support/report/issue_analytics/issue_analytics.py b/erpnext/support/report/issue_analytics/issue_analytics.py
index 543a34cb304..d8a200ad686 100644
--- a/erpnext/support/report/issue_analytics/issue_analytics.py
+++ b/erpnext/support/report/issue_analytics/issue_analytics.py
@@ -15,6 +15,7 @@ from erpnext.accounts.utils import get_fiscal_year
def execute(filters=None):
return IssueAnalytics(filters).run()
+
class IssueAnalytics(object):
def __init__(self, filters=None):
"""Issue Analytics Report"""
@@ -31,101 +32,98 @@ class IssueAnalytics(object):
def get_columns(self):
self.columns = []
- if self.filters.based_on == 'Customer':
- self.columns.append({
- 'label': _('Customer'),
- 'options': 'Customer',
- 'fieldname': 'customer',
- 'fieldtype': 'Link',
- 'width': 200
- })
+ if self.filters.based_on == "Customer":
+ self.columns.append(
+ {
+ "label": _("Customer"),
+ "options": "Customer",
+ "fieldname": "customer",
+ "fieldtype": "Link",
+ "width": 200,
+ }
+ )
- elif self.filters.based_on == 'Assigned To':
- self.columns.append({
- 'label': _('User'),
- 'fieldname': 'user',
- 'fieldtype': 'Link',
- 'options': 'User',
- 'width': 200
- })
+ elif self.filters.based_on == "Assigned To":
+ self.columns.append(
+ {"label": _("User"), "fieldname": "user", "fieldtype": "Link", "options": "User", "width": 200}
+ )
- elif self.filters.based_on == 'Issue Type':
- self.columns.append({
- 'label': _('Issue Type'),
- 'fieldname': 'issue_type',
- 'fieldtype': 'Link',
- 'options': 'Issue Type',
- 'width': 200
- })
+ elif self.filters.based_on == "Issue Type":
+ self.columns.append(
+ {
+ "label": _("Issue Type"),
+ "fieldname": "issue_type",
+ "fieldtype": "Link",
+ "options": "Issue Type",
+ "width": 200,
+ }
+ )
- elif self.filters.based_on == 'Issue Priority':
- self.columns.append({
- 'label': _('Issue Priority'),
- 'fieldname': 'priority',
- 'fieldtype': 'Link',
- 'options': 'Issue Priority',
- 'width': 200
- })
+ elif self.filters.based_on == "Issue Priority":
+ self.columns.append(
+ {
+ "label": _("Issue Priority"),
+ "fieldname": "priority",
+ "fieldtype": "Link",
+ "options": "Issue Priority",
+ "width": 200,
+ }
+ )
for end_date in self.periodic_daterange:
period = self.get_period(end_date)
- self.columns.append({
- 'label': _(period),
- 'fieldname': scrub(period),
- 'fieldtype': 'Int',
- 'width': 120
- })
+ self.columns.append(
+ {"label": _(period), "fieldname": scrub(period), "fieldtype": "Int", "width": 120}
+ )
- self.columns.append({
- 'label': _('Total'),
- 'fieldname': 'total',
- 'fieldtype': 'Int',
- 'width': 120
- })
+ self.columns.append(
+ {"label": _("Total"), "fieldname": "total", "fieldtype": "Int", "width": 120}
+ )
def get_data(self):
self.get_issues()
self.get_rows()
def get_period(self, date):
- months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
- if self.filters.range == 'Weekly':
- period = 'Week ' + str(date.isocalendar()[1])
- elif self.filters.range == 'Monthly':
+ if self.filters.range == "Weekly":
+ period = "Week " + str(date.isocalendar()[1])
+ elif self.filters.range == "Monthly":
period = str(months[date.month - 1])
- elif self.filters.range == 'Quarterly':
- period = 'Quarter ' + str(((date.month - 1) // 3) + 1)
+ elif self.filters.range == "Quarterly":
+ period = "Quarter " + str(((date.month - 1) // 3) + 1)
else:
year = get_fiscal_year(date, self.filters.company)
period = str(year[0])
- if getdate(self.filters.from_date).year != getdate(self.filters.to_date).year and self.filters.range != 'Yearly':
- period += ' ' + str(date.year)
+ if (
+ getdate(self.filters.from_date).year != getdate(self.filters.to_date).year
+ and self.filters.range != "Yearly"
+ ):
+ period += " " + str(date.year)
return period
def get_period_date_ranges(self):
from dateutil.relativedelta import MO, relativedelta
+
from_date, to_date = getdate(self.filters.from_date), getdate(self.filters.to_date)
- increment = {
- 'Monthly': 1,
- 'Quarterly': 3,
- 'Half-Yearly': 6,
- 'Yearly': 12
- }.get(self.filters.range, 1)
+ increment = {"Monthly": 1, "Quarterly": 3, "Half-Yearly": 6, "Yearly": 12}.get(
+ self.filters.range, 1
+ )
- if self.filters.range in ['Monthly', 'Quarterly']:
+ if self.filters.range in ["Monthly", "Quarterly"]:
from_date = from_date.replace(day=1)
- elif self.filters.range == 'Yearly':
+ elif self.filters.range == "Yearly":
from_date = get_fiscal_year(from_date)[1]
else:
from_date = from_date + relativedelta(from_date, weekday=MO(-1))
self.periodic_daterange = []
for dummy in range(1, 53):
- if self.filters.range == 'Weekly':
+ if self.filters.range == "Weekly":
period_end_date = add_days(from_date, 6)
else:
period_end_date = add_to_date(from_date, months=increment, days=-1)
@@ -142,25 +140,26 @@ class IssueAnalytics(object):
def get_issues(self):
filters = self.get_common_filters()
self.field_map = {
- 'Customer': 'customer',
- 'Issue Type': 'issue_type',
- 'Issue Priority': 'priority',
- 'Assigned To': '_assign'
+ "Customer": "customer",
+ "Issue Type": "issue_type",
+ "Issue Priority": "priority",
+ "Assigned To": "_assign",
}
- self.entries = frappe.db.get_all('Issue',
- fields=[self.field_map.get(self.filters.based_on), 'name', 'opening_date'],
- filters=filters
+ self.entries = frappe.db.get_all(
+ "Issue",
+ fields=[self.field_map.get(self.filters.based_on), "name", "opening_date"],
+ filters=filters,
)
def get_common_filters(self):
filters = {}
- filters['opening_date'] = ('between', [self.filters.from_date, self.filters.to_date])
+ filters["opening_date"] = ("between", [self.filters.from_date, self.filters.to_date])
- if self.filters.get('assigned_to'):
- filters['_assign'] = ('like', '%' + self.filters.get('assigned_to') + '%')
+ if self.filters.get("assigned_to"):
+ filters["_assign"] = ("like", "%" + self.filters.get("assigned_to") + "%")
- for entry in ['company', 'status', 'priority', 'customer', 'project']:
+ for entry in ["company", "status", "priority", "customer", "project"]:
if self.filters.get(entry):
filters[entry] = self.filters.get(entry)
@@ -171,14 +170,14 @@ class IssueAnalytics(object):
self.get_periodic_data()
for entity, period_data in iteritems(self.issue_periodic_data):
- if self.filters.based_on == 'Customer':
- row = {'customer': entity}
- elif self.filters.based_on == 'Assigned To':
- row = {'user': entity}
- elif self.filters.based_on == 'Issue Type':
- row = {'issue_type': entity}
- elif self.filters.based_on == 'Issue Priority':
- row = {'priority': entity}
+ if self.filters.based_on == "Customer":
+ row = {"customer": entity}
+ elif self.filters.based_on == "Assigned To":
+ row = {"user": entity}
+ elif self.filters.based_on == "Issue Type":
+ row = {"issue_type": entity}
+ elif self.filters.based_on == "Issue Priority":
+ row = {"priority": entity}
total = 0
for end_date in self.periodic_daterange:
@@ -187,7 +186,7 @@ class IssueAnalytics(object):
row[scrub(period)] = amount
total += amount
- row['total'] = total
+ row["total"] = total
self.data.append(row)
@@ -195,9 +194,9 @@ class IssueAnalytics(object):
self.issue_periodic_data = frappe._dict()
for d in self.entries:
- period = self.get_period(d.get('opening_date'))
+ period = self.get_period(d.get("opening_date"))
- if self.filters.based_on == 'Assigned To':
+ if self.filters.based_on == "Assigned To":
if d._assign:
for entry in json.loads(d._assign):
self.issue_periodic_data.setdefault(entry, frappe._dict()).setdefault(period, 0.0)
@@ -207,18 +206,12 @@ class IssueAnalytics(object):
field = self.field_map.get(self.filters.based_on)
value = d.get(field)
if not value:
- value = _('Not Specified')
+ value = _("Not Specified")
self.issue_periodic_data.setdefault(value, frappe._dict()).setdefault(period, 0.0)
self.issue_periodic_data[value][period] += 1
def get_chart_data(self):
length = len(self.columns)
- labels = [d.get('label') for d in self.columns[1:length-1]]
- self.chart = {
- 'data': {
- 'labels': labels,
- 'datasets': []
- },
- 'type': 'line'
- }
+ labels = [d.get("label") for d in self.columns[1 : length - 1]]
+ self.chart = {"data": {"labels": labels, "datasets": []}, "type": "line"}
diff --git a/erpnext/support/report/issue_analytics/test_issue_analytics.py b/erpnext/support/report/issue_analytics/test_issue_analytics.py
index b27dc46ad28..169392e5e92 100644
--- a/erpnext/support/report/issue_analytics/test_issue_analytics.py
+++ b/erpnext/support/report/issue_analytics/test_issue_analytics.py
@@ -1,4 +1,3 @@
-
import unittest
import frappe
@@ -11,7 +10,8 @@ from erpnext.support.doctype.service_level_agreement.test_service_level_agreemen
)
from erpnext.support.report.issue_analytics.issue_analytics import execute
-months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
+
class TestIssueAnalytics(unittest.TestCase):
@classmethod
@@ -24,8 +24,8 @@ class TestIssueAnalytics(unittest.TestCase):
self.current_month = str(months[current_month_date.month - 1]).lower()
self.last_month = str(months[last_month_date.month - 1]).lower()
if current_month_date.year != last_month_date.year:
- self.current_month += '_' + str(current_month_date.year)
- self.last_month += '_' + str(last_month_date.year)
+ self.current_month += "_" + str(current_month_date.year)
+ self.last_month += "_" + str(last_month_date.year)
def test_issue_analytics(self):
create_service_level_agreements_for_issues()
@@ -39,146 +39,88 @@ class TestIssueAnalytics(unittest.TestCase):
def compare_result_for_customer(self):
filters = {
- 'company': '_Test Company',
- 'based_on': 'Customer',
- 'from_date': add_months(getdate(), -1),
- 'to_date': getdate(),
- 'range': 'Monthly'
+ "company": "_Test Company",
+ "based_on": "Customer",
+ "from_date": add_months(getdate(), -1),
+ "to_date": getdate(),
+ "range": "Monthly",
}
report = execute(filters)
expected_data = [
- {
- 'customer': '__Test Customer 2',
- self.last_month: 1.0,
- self.current_month: 0.0,
- 'total': 1.0
- },
- {
- 'customer': '__Test Customer 1',
- self.last_month: 0.0,
- self.current_month: 1.0,
- 'total': 1.0
- },
- {
- 'customer': '__Test Customer',
- self.last_month: 1.0,
- self.current_month: 1.0,
- 'total': 2.0
- }
+ {"customer": "__Test Customer 2", self.last_month: 1.0, self.current_month: 0.0, "total": 1.0},
+ {"customer": "__Test Customer 1", self.last_month: 0.0, self.current_month: 1.0, "total": 1.0},
+ {"customer": "__Test Customer", self.last_month: 1.0, self.current_month: 1.0, "total": 2.0},
]
- self.assertEqual(expected_data, report[1]) # rows
- self.assertEqual(len(report[0]), 4) # cols
+ self.assertEqual(expected_data, report[1]) # rows
+ self.assertEqual(len(report[0]), 4) # cols
def compare_result_for_issue_type(self):
filters = {
- 'company': '_Test Company',
- 'based_on': 'Issue Type',
- 'from_date': add_months(getdate(), -1),
- 'to_date': getdate(),
- 'range': 'Monthly'
+ "company": "_Test Company",
+ "based_on": "Issue Type",
+ "from_date": add_months(getdate(), -1),
+ "to_date": getdate(),
+ "range": "Monthly",
}
report = execute(filters)
expected_data = [
- {
- 'issue_type': 'Discomfort',
- self.last_month: 1.0,
- self.current_month: 0.0,
- 'total': 1.0
- },
- {
- 'issue_type': 'Service Request',
- self.last_month: 0.0,
- self.current_month: 1.0,
- 'total': 1.0
- },
- {
- 'issue_type': 'Bug',
- self.last_month: 1.0,
- self.current_month: 1.0,
- 'total': 2.0
- }
+ {"issue_type": "Discomfort", self.last_month: 1.0, self.current_month: 0.0, "total": 1.0},
+ {"issue_type": "Service Request", self.last_month: 0.0, self.current_month: 1.0, "total": 1.0},
+ {"issue_type": "Bug", self.last_month: 1.0, self.current_month: 1.0, "total": 2.0},
]
- self.assertEqual(expected_data, report[1]) # rows
- self.assertEqual(len(report[0]), 4) # cols
+ self.assertEqual(expected_data, report[1]) # rows
+ self.assertEqual(len(report[0]), 4) # cols
def compare_result_for_issue_priority(self):
filters = {
- 'company': '_Test Company',
- 'based_on': 'Issue Priority',
- 'from_date': add_months(getdate(), -1),
- 'to_date': getdate(),
- 'range': 'Monthly'
+ "company": "_Test Company",
+ "based_on": "Issue Priority",
+ "from_date": add_months(getdate(), -1),
+ "to_date": getdate(),
+ "range": "Monthly",
}
report = execute(filters)
expected_data = [
- {
- 'priority': 'Medium',
- self.last_month: 1.0,
- self.current_month: 1.0,
- 'total': 2.0
- },
- {
- 'priority': 'Low',
- self.last_month: 1.0,
- self.current_month: 0.0,
- 'total': 1.0
- },
- {
- 'priority': 'High',
- self.last_month: 0.0,
- self.current_month: 1.0,
- 'total': 1.0
- }
+ {"priority": "Medium", self.last_month: 1.0, self.current_month: 1.0, "total": 2.0},
+ {"priority": "Low", self.last_month: 1.0, self.current_month: 0.0, "total": 1.0},
+ {"priority": "High", self.last_month: 0.0, self.current_month: 1.0, "total": 1.0},
]
- self.assertEqual(expected_data, report[1]) # rows
- self.assertEqual(len(report[0]), 4) # cols
+ self.assertEqual(expected_data, report[1]) # rows
+ self.assertEqual(len(report[0]), 4) # cols
def compare_result_for_assignment(self):
filters = {
- 'company': '_Test Company',
- 'based_on': 'Assigned To',
- 'from_date': add_months(getdate(), -1),
- 'to_date': getdate(),
- 'range': 'Monthly'
+ "company": "_Test Company",
+ "based_on": "Assigned To",
+ "from_date": add_months(getdate(), -1),
+ "to_date": getdate(),
+ "range": "Monthly",
}
report = execute(filters)
expected_data = [
- {
- 'user': 'test@example.com',
- self.last_month: 1.0,
- self.current_month: 1.0,
- 'total': 2.0
- },
- {
- 'user': 'test1@example.com',
- self.last_month: 2.0,
- self.current_month: 1.0,
- 'total': 3.0
- }
+ {"user": "test@example.com", self.last_month: 1.0, self.current_month: 1.0, "total": 2.0},
+ {"user": "test1@example.com", self.last_month: 2.0, self.current_month: 1.0, "total": 3.0},
]
- self.assertEqual(expected_data, report[1]) # rows
- self.assertEqual(len(report[0]), 4) # cols
+ self.assertEqual(expected_data, report[1]) # rows
+ self.assertEqual(len(report[0]), 4) # cols
def create_issue_types():
- for entry in ['Bug', 'Service Request', 'Discomfort']:
- if not frappe.db.exists('Issue Type', entry):
- frappe.get_doc({
- 'doctype': 'Issue Type',
- '__newname': entry
- }).insert()
+ for entry in ["Bug", "Service Request", "Discomfort"]:
+ if not frappe.db.exists("Issue Type", entry):
+ frappe.get_doc({"doctype": "Issue Type", "__newname": entry}).insert()
def create_records():
@@ -190,29 +132,15 @@ def create_records():
last_month_date = add_months(current_month_date, -1)
issue = make_issue(current_month_date, "__Test Customer", 2, "High", "Bug")
- add_assignment({
- "assign_to": ["test@example.com"],
- "doctype": "Issue",
- "name": issue.name
- })
+ add_assignment({"assign_to": ["test@example.com"], "doctype": "Issue", "name": issue.name})
issue = make_issue(last_month_date, "__Test Customer", 2, "Low", "Bug")
- add_assignment({
- "assign_to": ["test1@example.com"],
- "doctype": "Issue",
- "name": issue.name
- })
+ add_assignment({"assign_to": ["test1@example.com"], "doctype": "Issue", "name": issue.name})
issue = make_issue(current_month_date, "__Test Customer 1", 2, "Medium", "Service Request")
- add_assignment({
- "assign_to": ["test1@example.com"],
- "doctype": "Issue",
- "name": issue.name
- })
+ add_assignment({"assign_to": ["test1@example.com"], "doctype": "Issue", "name": issue.name})
issue = make_issue(last_month_date, "__Test Customer 2", 2, "Medium", "Discomfort")
- add_assignment({
- "assign_to": ["test@example.com", "test1@example.com"],
- "doctype": "Issue",
- "name": issue.name
- })
+ add_assignment(
+ {"assign_to": ["test@example.com", "test1@example.com"], "doctype": "Issue", "name": issue.name}
+ )
diff --git a/erpnext/support/report/issue_summary/issue_summary.py b/erpnext/support/report/issue_summary/issue_summary.py
index b5d52278b89..a81bcc7f32a 100644
--- a/erpnext/support/report/issue_summary/issue_summary.py
+++ b/erpnext/support/report/issue_summary/issue_summary.py
@@ -13,6 +13,7 @@ from six import iteritems
def execute(filters=None):
return IssueSummary(filters).run()
+
class IssueSummary(object):
def __init__(self, filters=None):
self.filters = frappe._dict(filters or {})
@@ -28,82 +29,77 @@ class IssueSummary(object):
def get_columns(self):
self.columns = []
- if self.filters.based_on == 'Customer':
- self.columns.append({
- 'label': _('Customer'),
- 'options': 'Customer',
- 'fieldname': 'customer',
- 'fieldtype': 'Link',
- 'width': 200
- })
+ if self.filters.based_on == "Customer":
+ self.columns.append(
+ {
+ "label": _("Customer"),
+ "options": "Customer",
+ "fieldname": "customer",
+ "fieldtype": "Link",
+ "width": 200,
+ }
+ )
- elif self.filters.based_on == 'Assigned To':
- self.columns.append({
- 'label': _('User'),
- 'fieldname': 'user',
- 'fieldtype': 'Link',
- 'options': 'User',
- 'width': 200
- })
+ elif self.filters.based_on == "Assigned To":
+ self.columns.append(
+ {"label": _("User"), "fieldname": "user", "fieldtype": "Link", "options": "User", "width": 200}
+ )
- elif self.filters.based_on == 'Issue Type':
- self.columns.append({
- 'label': _('Issue Type'),
- 'fieldname': 'issue_type',
- 'fieldtype': 'Link',
- 'options': 'Issue Type',
- 'width': 200
- })
+ elif self.filters.based_on == "Issue Type":
+ self.columns.append(
+ {
+ "label": _("Issue Type"),
+ "fieldname": "issue_type",
+ "fieldtype": "Link",
+ "options": "Issue Type",
+ "width": 200,
+ }
+ )
- elif self.filters.based_on == 'Issue Priority':
- self.columns.append({
- 'label': _('Issue Priority'),
- 'fieldname': 'priority',
- 'fieldtype': 'Link',
- 'options': 'Issue Priority',
- 'width': 200
- })
+ elif self.filters.based_on == "Issue Priority":
+ self.columns.append(
+ {
+ "label": _("Issue Priority"),
+ "fieldname": "priority",
+ "fieldtype": "Link",
+ "options": "Issue Priority",
+ "width": 200,
+ }
+ )
- self.statuses = ['Open', 'Replied', 'On Hold', 'Resolved', 'Closed']
+ self.statuses = ["Open", "Replied", "On Hold", "Resolved", "Closed"]
for status in self.statuses:
- self.columns.append({
- 'label': _(status),
- 'fieldname': scrub(status),
- 'fieldtype': 'Int',
- 'width': 80
- })
+ self.columns.append(
+ {"label": _(status), "fieldname": scrub(status), "fieldtype": "Int", "width": 80}
+ )
- self.columns.append({
- 'label': _('Total Issues'),
- 'fieldname': 'total_issues',
- 'fieldtype': 'Int',
- 'width': 100
- })
+ self.columns.append(
+ {"label": _("Total Issues"), "fieldname": "total_issues", "fieldtype": "Int", "width": 100}
+ )
self.sla_status_map = {
- 'SLA Failed': 'failed',
- 'SLA Fulfilled': 'fulfilled',
- 'SLA Ongoing': 'ongoing'
+ "SLA Failed": "failed",
+ "SLA Fulfilled": "fulfilled",
+ "SLA Ongoing": "ongoing",
}
for label, fieldname in self.sla_status_map.items():
- self.columns.append({
- 'label': _(label),
- 'fieldname': fieldname,
- 'fieldtype': 'Int',
- 'width': 100
- })
+ self.columns.append(
+ {"label": _(label), "fieldname": fieldname, "fieldtype": "Int", "width": 100}
+ )
- self.metrics = ['Avg First Response Time', 'Avg Response Time', 'Avg Hold Time',
- 'Avg Resolution Time', 'Avg User Resolution Time']
+ self.metrics = [
+ "Avg First Response Time",
+ "Avg Response Time",
+ "Avg Hold Time",
+ "Avg Resolution Time",
+ "Avg User Resolution Time",
+ ]
for metric in self.metrics:
- self.columns.append({
- 'label': _(metric),
- 'fieldname': scrub(metric),
- 'fieldtype': 'Duration',
- 'width': 170
- })
+ self.columns.append(
+ {"label": _(metric), "fieldname": scrub(metric), "fieldtype": "Duration", "width": 170}
+ )
def get_data(self):
self.get_issues()
@@ -112,26 +108,37 @@ class IssueSummary(object):
def get_issues(self):
filters = self.get_common_filters()
self.field_map = {
- 'Customer': 'customer',
- 'Issue Type': 'issue_type',
- 'Issue Priority': 'priority',
- 'Assigned To': '_assign'
+ "Customer": "customer",
+ "Issue Type": "issue_type",
+ "Issue Priority": "priority",
+ "Assigned To": "_assign",
}
- self.entries = frappe.db.get_all('Issue',
- fields=[self.field_map.get(self.filters.based_on), 'name', 'opening_date', 'status', 'avg_response_time',
- 'first_response_time', 'total_hold_time', 'user_resolution_time', 'resolution_time', 'agreement_status'],
- filters=filters
+ self.entries = frappe.db.get_all(
+ "Issue",
+ fields=[
+ self.field_map.get(self.filters.based_on),
+ "name",
+ "opening_date",
+ "status",
+ "avg_response_time",
+ "first_response_time",
+ "total_hold_time",
+ "user_resolution_time",
+ "resolution_time",
+ "agreement_status",
+ ],
+ filters=filters,
)
def get_common_filters(self):
filters = {}
- filters['opening_date'] = ('between', [self.filters.from_date, self.filters.to_date])
+ filters["opening_date"] = ("between", [self.filters.from_date, self.filters.to_date])
- if self.filters.get('assigned_to'):
- filters['_assign'] = ('like', '%' + self.filters.get('assigned_to') + '%')
+ if self.filters.get("assigned_to"):
+ filters["_assign"] = ("like", "%" + self.filters.get("assigned_to") + "%")
- for entry in ['company', 'status', 'priority', 'customer', 'project']:
+ for entry in ["company", "status", "priority", "customer", "project"]:
if self.filters.get(entry):
filters[entry] = self.filters.get(entry)
@@ -142,20 +149,20 @@ class IssueSummary(object):
self.get_summary_data()
for entity, data in iteritems(self.issue_summary_data):
- if self.filters.based_on == 'Customer':
- row = {'customer': entity}
- elif self.filters.based_on == 'Assigned To':
- row = {'user': entity}
- elif self.filters.based_on == 'Issue Type':
- row = {'issue_type': entity}
- elif self.filters.based_on == 'Issue Priority':
- row = {'priority': entity}
+ if self.filters.based_on == "Customer":
+ row = {"customer": entity}
+ elif self.filters.based_on == "Assigned To":
+ row = {"user": entity}
+ elif self.filters.based_on == "Issue Type":
+ row = {"issue_type": entity}
+ elif self.filters.based_on == "Issue Priority":
+ row = {"priority": entity}
for status in self.statuses:
count = flt(data.get(status, 0.0))
row[scrub(status)] = count
- row['total_issues'] = data.get('total_issues', 0.0)
+ row["total_issues"] = data.get("total_issues", 0.0)
for sla_status in self.sla_status_map.values():
value = flt(data.get(sla_status), 0.0)
@@ -174,36 +181,41 @@ class IssueSummary(object):
status = d.status
agreement_status = scrub(d.agreement_status)
- if self.filters.based_on == 'Assigned To':
+ if self.filters.based_on == "Assigned To":
if d._assign:
for entry in json.loads(d._assign):
self.issue_summary_data.setdefault(entry, frappe._dict()).setdefault(status, 0.0)
self.issue_summary_data.setdefault(entry, frappe._dict()).setdefault(agreement_status, 0.0)
- self.issue_summary_data.setdefault(entry, frappe._dict()).setdefault('total_issues', 0.0)
+ self.issue_summary_data.setdefault(entry, frappe._dict()).setdefault("total_issues", 0.0)
self.issue_summary_data[entry][status] += 1
self.issue_summary_data[entry][agreement_status] += 1
- self.issue_summary_data[entry]['total_issues'] += 1
+ self.issue_summary_data[entry]["total_issues"] += 1
else:
field = self.field_map.get(self.filters.based_on)
value = d.get(field)
if not value:
- value = _('Not Specified')
+ value = _("Not Specified")
self.issue_summary_data.setdefault(value, frappe._dict()).setdefault(status, 0.0)
self.issue_summary_data.setdefault(value, frappe._dict()).setdefault(agreement_status, 0.0)
- self.issue_summary_data.setdefault(value, frappe._dict()).setdefault('total_issues', 0.0)
+ self.issue_summary_data.setdefault(value, frappe._dict()).setdefault("total_issues", 0.0)
self.issue_summary_data[value][status] += 1
self.issue_summary_data[value][agreement_status] += 1
- self.issue_summary_data[value]['total_issues'] += 1
+ self.issue_summary_data[value]["total_issues"] += 1
self.get_metrics_data()
def get_metrics_data(self):
issues = []
- metrics_list = ['avg_response_time', 'avg_first_response_time', 'avg_hold_time',
- 'avg_resolution_time', 'avg_user_resolution_time']
+ metrics_list = [
+ "avg_response_time",
+ "avg_first_response_time",
+ "avg_hold_time",
+ "avg_resolution_time",
+ "avg_user_resolution_time",
+ ]
for entry in self.entries:
issues.append(entry.name)
@@ -211,7 +223,7 @@ class IssueSummary(object):
field = self.field_map.get(self.filters.based_on)
if issues:
- if self.filters.based_on == 'Assigned To':
+ if self.filters.based_on == "Assigned To":
assignment_map = frappe._dict()
for d in self.entries:
if d._assign:
@@ -219,11 +231,15 @@ class IssueSummary(object):
for metric in metrics_list:
self.issue_summary_data.setdefault(entry, frappe._dict()).setdefault(metric, 0.0)
- self.issue_summary_data[entry]['avg_response_time'] += d.get('avg_response_time') or 0.0
- self.issue_summary_data[entry]['avg_first_response_time'] += d.get('first_response_time') or 0.0
- self.issue_summary_data[entry]['avg_hold_time'] += d.get('total_hold_time') or 0.0
- self.issue_summary_data[entry]['avg_resolution_time'] += d.get('resolution_time') or 0.0
- self.issue_summary_data[entry]['avg_user_resolution_time'] += d.get('user_resolution_time') or 0.0
+ self.issue_summary_data[entry]["avg_response_time"] += d.get("avg_response_time") or 0.0
+ self.issue_summary_data[entry]["avg_first_response_time"] += (
+ d.get("first_response_time") or 0.0
+ )
+ self.issue_summary_data[entry]["avg_hold_time"] += d.get("total_hold_time") or 0.0
+ self.issue_summary_data[entry]["avg_resolution_time"] += d.get("resolution_time") or 0.0
+ self.issue_summary_data[entry]["avg_user_resolution_time"] += (
+ d.get("user_resolution_time") or 0.0
+ )
if not assignment_map.get(entry):
assignment_map[entry] = 0
@@ -234,7 +250,8 @@ class IssueSummary(object):
self.issue_summary_data[entry][metric] /= flt(assignment_map.get(entry))
else:
- data = frappe.db.sql("""
+ data = frappe.db.sql(
+ """
SELECT
{0}, AVG(first_response_time) as avg_frt,
AVG(avg_response_time) as avg_resp_time,
@@ -245,21 +262,30 @@ class IssueSummary(object):
WHERE
name IN %(issues)s
GROUP BY {0}
- """.format(field), {'issues': issues}, as_dict=1)
+ """.format(
+ field
+ ),
+ {"issues": issues},
+ as_dict=1,
+ )
for entry in data:
value = entry.get(field)
if not value:
- value = _('Not Specified')
+ value = _("Not Specified")
for metric in metrics_list:
self.issue_summary_data.setdefault(value, frappe._dict()).setdefault(metric, 0.0)
- self.issue_summary_data[value]['avg_response_time'] = entry.get('avg_resp_time') or 0.0
- self.issue_summary_data[value]['avg_first_response_time'] = entry.get('avg_frt') or 0.0
- self.issue_summary_data[value]['avg_hold_time'] = entry.get('avg_hold_time') or 0.0
- self.issue_summary_data[value]['avg_resolution_time'] = entry.get('avg_resolution_time') or 0.0
- self.issue_summary_data[value]['avg_user_resolution_time'] = entry.get('avg_user_resolution_time') or 0.0
+ self.issue_summary_data[value]["avg_response_time"] = entry.get("avg_resp_time") or 0.0
+ self.issue_summary_data[value]["avg_first_response_time"] = entry.get("avg_frt") or 0.0
+ self.issue_summary_data[value]["avg_hold_time"] = entry.get("avg_hold_time") or 0.0
+ self.issue_summary_data[value]["avg_resolution_time"] = (
+ entry.get("avg_resolution_time") or 0.0
+ )
+ self.issue_summary_data[value]["avg_user_resolution_time"] = (
+ entry.get("avg_user_resolution_time") or 0.0
+ )
def get_chart_data(self):
self.chart = []
@@ -273,47 +299,30 @@ class IssueSummary(object):
entity = self.filters.based_on
entity_field = self.field_map.get(entity)
- if entity == 'Assigned To':
- entity_field = 'user'
+ if entity == "Assigned To":
+ entity_field = "user"
for entry in self.data:
labels.append(entry.get(entity_field))
- open_issues.append(entry.get('open'))
- replied_issues.append(entry.get('replied'))
- on_hold_issues.append(entry.get('on_hold'))
- resolved_issues.append(entry.get('resolved'))
- closed_issues.append(entry.get('closed'))
+ open_issues.append(entry.get("open"))
+ replied_issues.append(entry.get("replied"))
+ on_hold_issues.append(entry.get("on_hold"))
+ resolved_issues.append(entry.get("resolved"))
+ closed_issues.append(entry.get("closed"))
self.chart = {
- 'data': {
- 'labels': labels[:30],
- 'datasets': [
- {
- 'name': 'Open',
- 'values': open_issues[:30]
- },
- {
- 'name': 'Replied',
- 'values': replied_issues[:30]
- },
- {
- 'name': 'On Hold',
- 'values': on_hold_issues[:30]
- },
- {
- 'name': 'Resolved',
- 'values': resolved_issues[:30]
- },
- {
- 'name': 'Closed',
- 'values': closed_issues[:30]
- }
- ]
+ "data": {
+ "labels": labels[:30],
+ "datasets": [
+ {"name": "Open", "values": open_issues[:30]},
+ {"name": "Replied", "values": replied_issues[:30]},
+ {"name": "On Hold", "values": on_hold_issues[:30]},
+ {"name": "Resolved", "values": resolved_issues[:30]},
+ {"name": "Closed", "values": closed_issues[:30]},
+ ],
},
- 'type': 'bar',
- 'barOptions': {
- 'stacked': True
- }
+ "type": "bar",
+ "barOptions": {"stacked": True},
}
def get_report_summary(self):
@@ -326,41 +335,41 @@ class IssueSummary(object):
closed = 0
for entry in self.data:
- open_issues += entry.get('open')
- replied += entry.get('replied')
- on_hold += entry.get('on_hold')
- resolved += entry.get('resolved')
- closed += entry.get('closed')
+ open_issues += entry.get("open")
+ replied += entry.get("replied")
+ on_hold += entry.get("on_hold")
+ resolved += entry.get("resolved")
+ closed += entry.get("closed")
self.report_summary = [
{
- 'value': open_issues,
- 'indicator': 'Red',
- 'label': _('Open'),
- 'datatype': 'Int',
+ "value": open_issues,
+ "indicator": "Red",
+ "label": _("Open"),
+ "datatype": "Int",
},
{
- 'value': replied,
- 'indicator': 'Grey',
- 'label': _('Replied'),
- 'datatype': 'Int',
+ "value": replied,
+ "indicator": "Grey",
+ "label": _("Replied"),
+ "datatype": "Int",
},
{
- 'value': on_hold,
- 'indicator': 'Grey',
- 'label': _('On Hold'),
- 'datatype': 'Int',
+ "value": on_hold,
+ "indicator": "Grey",
+ "label": _("On Hold"),
+ "datatype": "Int",
},
{
- 'value': resolved,
- 'indicator': 'Green',
- 'label': _('Resolved'),
- 'datatype': 'Int',
+ "value": resolved,
+ "indicator": "Green",
+ "label": _("Resolved"),
+ "datatype": "Int",
},
{
- 'value': closed,
- 'indicator': 'Green',
- 'label': _('Closed'),
- 'datatype': 'Int',
- }
+ "value": closed,
+ "indicator": "Green",
+ "label": _("Closed"),
+ "datatype": "Int",
+ },
]
diff --git a/erpnext/support/report/support_hour_distribution/support_hour_distribution.py b/erpnext/support/report/support_hour_distribution/support_hour_distribution.py
index e3a7e5f54b1..b4bd460a67f 100644
--- a/erpnext/support/report/support_hour_distribution/support_hour_distribution.py
+++ b/erpnext/support/report/support_hour_distribution/support_hour_distribution.py
@@ -8,34 +8,36 @@ from frappe.utils import add_to_date, get_datetime, getdate
from six import iteritems
time_slots = {
- '12AM - 3AM': '00:00:00-03:00:00',
- '3AM - 6AM': '03:00:00-06:00:00',
- '6AM - 9AM': '06:00:00-09:00:00',
- '9AM - 12PM': '09:00:00-12:00:00',
- '12PM - 3PM': '12:00:00-15:00:00',
- '3PM - 6PM': '15:00:00-18:00:00',
- '6PM - 9PM': '18:00:00-21:00:00',
- '9PM - 12AM': '21:00:00-23:00:00'
+ "12AM - 3AM": "00:00:00-03:00:00",
+ "3AM - 6AM": "03:00:00-06:00:00",
+ "6AM - 9AM": "06:00:00-09:00:00",
+ "9AM - 12PM": "09:00:00-12:00:00",
+ "12PM - 3PM": "12:00:00-15:00:00",
+ "3PM - 6PM": "15:00:00-18:00:00",
+ "6PM - 9PM": "18:00:00-21:00:00",
+ "9PM - 12AM": "21:00:00-23:00:00",
}
+
def execute(filters=None):
columns, data = [], []
- if not filters.get('periodicity'):
- filters['periodicity'] = 'Daily'
+ if not filters.get("periodicity"):
+ filters["periodicity"] = "Daily"
columns = get_columns()
data, timeslot_wise_count = get_data(filters)
chart = get_chart_data(timeslot_wise_count)
return columns, data, None, chart
+
def get_data(filters):
start_date = getdate(filters.from_date)
data = []
time_slot_wise_total_count = {}
- while(start_date <= getdate(filters.to_date)):
- hours_count = {'date': start_date}
+ while start_date <= getdate(filters.to_date):
+ hours_count = {"date": start_date}
for key, value in iteritems(time_slots):
- start_time, end_time = value.split('-')
+ start_time, end_time = value.split("-")
start_time = get_datetime("{0} {1}".format(start_date.strftime("%Y-%m-%d"), start_time))
end_time = get_datetime("{0} {1}".format(start_date.strftime("%Y-%m-%d"), end_time))
hours_count[key] = get_hours_count(start_time, end_time)
@@ -48,49 +50,57 @@ def get_data(filters):
return data, time_slot_wise_total_count
+
def get_hours_count(start_time, end_time):
- data = frappe.db.sql(""" select count(*) from `tabIssue` where creation
- between %(start_time)s and %(end_time)s""", {
- 'start_time': start_time,
- 'end_time': end_time
- }, as_list=1) or []
+ data = (
+ frappe.db.sql(
+ """ select count(*) from `tabIssue` where creation
+ between %(start_time)s and %(end_time)s""",
+ {"start_time": start_time, "end_time": end_time},
+ as_list=1,
+ )
+ or []
+ )
return data[0][0] if len(data) > 0 else 0
-def get_columns():
- columns = [{
- "fieldname": "date",
- "label": _("Date"),
- "fieldtype": "Date",
- "width": 100
- }]
- for label in ['12AM - 3AM', '3AM - 6AM', '6AM - 9AM',
- '9AM - 12PM', '12PM - 3PM', '3PM - 6PM', '6PM - 9PM', '9PM - 12AM']:
- columns.append({
- "fieldname": label,
- "label": _(label),
- "fieldtype": "Data",
- "width": 120
- })
+def get_columns():
+ columns = [{"fieldname": "date", "label": _("Date"), "fieldtype": "Date", "width": 100}]
+
+ for label in [
+ "12AM - 3AM",
+ "3AM - 6AM",
+ "6AM - 9AM",
+ "9AM - 12PM",
+ "12PM - 3PM",
+ "3PM - 6PM",
+ "6PM - 9PM",
+ "9PM - 12AM",
+ ]:
+ columns.append({"fieldname": label, "label": _(label), "fieldtype": "Data", "width": 120})
return columns
+
def get_chart_data(timeslot_wise_count):
total_count = []
- timeslots = ['12AM - 3AM', '3AM - 6AM', '6AM - 9AM',
- '9AM - 12PM', '12PM - 3PM', '3PM - 6PM', '6PM - 9PM', '9PM - 12AM']
+ timeslots = [
+ "12AM - 3AM",
+ "3AM - 6AM",
+ "6AM - 9AM",
+ "9AM - 12PM",
+ "12PM - 3PM",
+ "3PM - 6PM",
+ "6PM - 9PM",
+ "9PM - 12AM",
+ ]
datasets = []
for data in timeslots:
total_count.append(timeslot_wise_count.get(data, 0))
- datasets.append({'values': total_count})
+ datasets.append({"values": total_count})
- chart = {
- "data": {
- 'labels': timeslots,
- 'datasets': datasets
- }
- }
+ chart = {"data": {"labels": timeslots, "datasets": datasets}}
chart["type"] = "line"
return chart
diff --git a/erpnext/support/web_form/issues/issues.py b/erpnext/support/web_form/issues/issues.py
index 19b550feea7..02e3e933330 100644
--- a/erpnext/support/web_form/issues/issues.py
+++ b/erpnext/support/web_form/issues/issues.py
@@ -1,5 +1,3 @@
-
-
def get_context(context):
# do your magic here
pass
diff --git a/erpnext/telephony/doctype/call_log/call_log.json b/erpnext/telephony/doctype/call_log/call_log.json
index 1d6c39edf6e..cd749e8a018 100644
--- a/erpnext/telephony/doctype/call_log/call_log.json
+++ b/erpnext/telephony/doctype/call_log/call_log.json
@@ -1,7 +1,7 @@
{
"actions": [],
"autoname": "field:id",
- "creation": "2019-06-05 12:07:02.634534",
+ "creation": "2022-02-21 11:54:58.414784",
"doctype": "DocType",
"engine": "InnoDB",
"field_order": [
@@ -9,6 +9,8 @@
"id",
"from",
"to",
+ "call_received_by",
+ "employee_user_id",
"medium",
"start_time",
"end_time",
@@ -20,6 +22,7 @@
"recording_url",
"recording_html",
"section_break_11",
+ "type_of_call",
"summary",
"section_break_19",
"links"
@@ -103,7 +106,8 @@
},
{
"fieldname": "summary",
- "fieldtype": "Small Text"
+ "fieldtype": "Small Text",
+ "label": "Summary"
},
{
"fieldname": "section_break_11",
@@ -134,15 +138,34 @@
"fieldname": "call_details_section",
"fieldtype": "Section Break",
"label": "Call Details"
+ },
+ {
+ "fieldname": "employee_user_id",
+ "fieldtype": "Data",
+ "hidden": 1,
+ "label": "Employee User Id"
+ },
+ {
+ "fieldname": "type_of_call",
+ "fieldtype": "Data",
+ "label": "Type Of Call"
+ },
+ {
+ "depends_on": "to",
+ "fieldname": "call_received_by",
+ "fieldtype": "Data",
+ "label": "Call Received By",
+ "read_only": 1
}
],
"in_create": 1,
"index_web_pages_for_search": 1,
"links": [],
- "modified": "2021-02-08 14:23:28.744844",
+ "modified": "2022-02-25 14:37:48.575230",
"modified_by": "Administrator",
"module": "Telephony",
"name": "Call Log",
+ "naming_rule": "By fieldname",
"owner": "Administrator",
"permissions": [
{
@@ -164,6 +187,7 @@
],
"sort_field": "creation",
"sort_order": "DESC",
+ "states": [],
"title_field": "from",
"track_changes": 1,
"track_views": 1
diff --git a/erpnext/telephony/doctype/call_log/call_log.py b/erpnext/telephony/doctype/call_log/call_log.py
index 0c24484bdfb..8d6867dc154 100644
--- a/erpnext/telephony/doctype/call_log/call_log.py
+++ b/erpnext/telephony/doctype/call_log/call_log.py
@@ -11,8 +11,8 @@ from frappe.model.document import Document
from erpnext.crm.doctype.lead.lead import get_lead_with_phone_number
from erpnext.crm.doctype.utils import get_scheduled_employees_for_popup, strip_number
-END_CALL_STATUSES = ['No Answer', 'Completed', 'Busy', 'Failed']
-ONGOING_CALL_STATUSES = ['Ringing', 'In Progress']
+END_CALL_STATUSES = ["No Answer", "Completed", "Busy", "Failed"]
+ONGOING_CALL_STATUSES = ["Ringing", "In Progress"]
class CallLog(Document):
@@ -20,18 +20,21 @@ class CallLog(Document):
deduplicate_dynamic_links(self)
def before_insert(self):
- """Add lead(third party person) links to the document.
- """
- lead_number = self.get('from') if self.is_incoming_call() else self.get('to')
+ """Add lead(third party person) links to the document."""
+ lead_number = self.get("from") if self.is_incoming_call() else self.get("to")
lead_number = strip_number(lead_number)
contact = get_contact_with_phone_number(strip_number(lead_number))
if contact:
- self.add_link(link_type='Contact', link_name=contact)
+ self.add_link(link_type="Contact", link_name=contact)
lead = get_lead_with_phone_number(lead_number)
if lead:
- self.add_link(link_type='Lead', link_name=lead)
+ self.add_link(link_type="Lead", link_name=lead)
+
+ # Add Employee Name
+ if self.is_incoming_call():
+ self.update_received_by()
def after_insert(self):
self.trigger_call_popup()
@@ -39,86 +42,107 @@ class CallLog(Document):
def on_update(self):
def _is_call_missed(doc_before_save, doc_after_save):
# FIXME: This works for Exotel but not for all telepony providers
- return doc_before_save.to != doc_after_save.to and doc_after_save.status not in END_CALL_STATUSES
+ return (
+ doc_before_save.to != doc_after_save.to and doc_after_save.status not in END_CALL_STATUSES
+ )
def _is_call_ended(doc_before_save, doc_after_save):
return doc_before_save.status not in END_CALL_STATUSES and self.status in END_CALL_STATUSES
doc_before_save = self.get_doc_before_save()
- if not doc_before_save: return
+ if not doc_before_save:
+ return
+
+ if self.is_incoming_call() and self.has_value_changed("to"):
+ self.update_received_by()
if _is_call_missed(doc_before_save, self):
- frappe.publish_realtime('call_{id}_missed'.format(id=self.id), self)
+ frappe.publish_realtime("call_{id}_missed".format(id=self.id), self)
self.trigger_call_popup()
if _is_call_ended(doc_before_save, self):
- frappe.publish_realtime('call_{id}_ended'.format(id=self.id), self)
+ frappe.publish_realtime("call_{id}_ended".format(id=self.id), self)
def is_incoming_call(self):
- return self.type == 'Incoming'
+ return self.type == "Incoming"
def add_link(self, link_type, link_name):
- self.append('links', {
- 'link_doctype': link_type,
- 'link_name': link_name
- })
+ self.append("links", {"link_doctype": link_type, "link_name": link_name})
def trigger_call_popup(self):
if self.is_incoming_call():
scheduled_employees = get_scheduled_employees_for_popup(self.medium)
- employee_emails = get_employees_with_number(self.to)
+ employees = get_employees_with_number(self.to)
+ employee_emails = [employee.get("user_id") for employee in employees]
# check if employees with matched number are scheduled to receive popup
emails = set(scheduled_employees).intersection(employee_emails)
if frappe.conf.developer_mode:
- self.add_comment(text=f"""
+ self.add_comment(
+ text=f"""
Scheduled Employees: {scheduled_employees}
Matching Employee: {employee_emails}
Show Popup To: {emails}
- """)
+ """
+ )
if employee_emails and not emails:
self.add_comment(text=_("No employee was scheduled for call popup"))
for email in emails:
- frappe.publish_realtime('show_call_popup', self, user=email)
+ frappe.publish_realtime("show_call_popup", self, user=email)
+
+ def update_received_by(self):
+ employees = get_employees_with_number(self.get("to"))
+ if employees:
+ self.call_received_by = employees[0].get("name")
+ self.employee_user_id = employees[0].get("user_id")
@frappe.whitelist()
-def add_call_summary(call_log, summary):
- doc = frappe.get_doc('Call Log', call_log)
- doc.add_comment('Comment', frappe.bold(_('Call Summary')) + '
' + summary)
+def add_call_summary_and_call_type(call_log, summary, call_type):
+ doc = frappe.get_doc("Call Log", call_log)
+ doc.type_of_call = call_type
+ doc.save()
+ doc.add_comment("Comment", frappe.bold(_("Call Summary")) + "
" + summary)
+
def get_employees_with_number(number):
number = strip_number(number)
- if not number: return []
+ if not number:
+ return []
- employee_emails = frappe.cache().hget('employees_with_number', number)
- if employee_emails: return employee_emails
+ employee_doc_name_and_emails = frappe.cache().hget("employees_with_number", number)
+ if employee_doc_name_and_emails:
+ return employee_doc_name_and_emails
- employees = frappe.get_all('Employee', filters={
- 'cell_number': ['like', '%{}%'.format(number)],
- 'user_id': ['!=', '']
- }, fields=['user_id'])
+ employee_doc_name_and_emails = frappe.get_all(
+ "Employee",
+ filters={"cell_number": ["like", "%{}%".format(number)], "user_id": ["!=", ""]},
+ fields=["name", "user_id"],
+ )
- employee_emails = [employee.user_id for employee in employees]
- frappe.cache().hset('employees_with_number', number, employee_emails)
+ frappe.cache().hset("employees_with_number", number, employee_doc_name_and_emails)
+
+ return employee_doc_name_and_emails
- return employee_emails
def link_existing_conversations(doc, state):
"""
Called from hooks on creation of Contact or Lead to link all the existing conversations.
"""
- if doc.doctype != 'Contact': return
+ if doc.doctype != "Contact":
+ return
try:
numbers = [d.phone for d in doc.phone_nos]
for number in numbers:
number = strip_number(number)
- if not number: continue
- logs = frappe.db.sql_list("""
+ if not number:
+ continue
+ logs = frappe.db.sql_list(
+ """
SELECT cl.name FROM `tabCall Log` cl
LEFT JOIN `tabDynamic Link` dl
ON cl.name = dl.parent
@@ -131,44 +155,42 @@ def link_existing_conversations(doc, state):
ELSE 0
END
)=0
- """, dict(
- phone_number='%{}'.format(number),
- docname=doc.name,
- doctype = doc.doctype
- )
+ """,
+ dict(phone_number="%{}".format(number), docname=doc.name, doctype=doc.doctype),
)
for log in logs:
- call_log = frappe.get_doc('Call Log', log)
+ call_log = frappe.get_doc("Call Log", log)
call_log.add_link(link_type=doc.doctype, link_name=doc.name)
call_log.save(ignore_permissions=True)
frappe.db.commit()
except Exception:
- frappe.log_error(title=_('Error during caller information update'))
+ frappe.log_error(title=_("Error during caller information update"))
+
def get_linked_call_logs(doctype, docname):
# content will be shown in timeline
- logs = frappe.get_all('Dynamic Link', fields=['parent'], filters={
- 'parenttype': 'Call Log',
- 'link_doctype': doctype,
- 'link_name': docname
- })
+ logs = frappe.get_all(
+ "Dynamic Link",
+ fields=["parent"],
+ filters={"parenttype": "Call Log", "link_doctype": doctype, "link_name": docname},
+ )
logs = set([log.parent for log in logs])
- logs = frappe.get_all('Call Log', fields=['*'], filters={
- 'name': ['in', logs]
- })
+ logs = frappe.get_all("Call Log", fields=["*"], filters={"name": ["in", logs]})
timeline_contents = []
for log in logs:
log.show_call_button = 0
- timeline_contents.append({
- 'icon': 'call',
- 'is_card': True,
- 'creation': log.creation,
- 'template': 'call_link',
- 'template_data': log
- })
+ timeline_contents.append(
+ {
+ "icon": "call",
+ "is_card": True,
+ "creation": log.creation,
+ "template": "call_link",
+ "template_data": log,
+ }
+ )
return timeline_contents
diff --git a/erpnext/telephony/doctype/incoming_call_settings/incoming_call_settings.py b/erpnext/telephony/doctype/incoming_call_settings/incoming_call_settings.py
index 08e244d8897..5edf81df736 100644
--- a/erpnext/telephony/doctype/incoming_call_settings/incoming_call_settings.py
+++ b/erpnext/telephony/doctype/incoming_call_settings/incoming_call_settings.py
@@ -20,35 +20,38 @@ class IncomingCallSettings(Document):
self.validate_call_schedule_overlaps(self.call_handling_schedule)
def validate_call_schedule_timeslot(self, schedule: list):
- """ Make sure that to time slot is ahead of from time slot.
- """
+ """Make sure that to time slot is ahead of from time slot."""
errors = []
for record in schedule:
from_time = self.time_to_seconds(record.from_time)
to_time = self.time_to_seconds(record.to_time)
if from_time >= to_time:
errors.append(
- _('Call Schedule Row {0}: To time slot should always be ahead of From time slot.').format(record.idx)
+ _("Call Schedule Row {0}: To time slot should always be ahead of From time slot.").format(
+ record.idx
+ )
)
if errors:
- frappe.throw('
'.join(errors))
+ frappe.throw("
".join(errors))
def validate_call_schedule_overlaps(self, schedule: list):
- """Check if any time slots are overlapped in a day schedule.
- """
+ """Check if any time slots are overlapped in a day schedule."""
week_days = set([each.day_of_week for each in schedule])
for day in week_days:
- timeslots = [(record.from_time, record.to_time) for record in schedule if record.day_of_week==day]
+ timeslots = [
+ (record.from_time, record.to_time) for record in schedule if record.day_of_week == day
+ ]
# convert time in timeslot into an integer represents number of seconds
timeslots = sorted(map(lambda seq: tuple(map(self.time_to_seconds, seq)), timeslots))
- if len(timeslots) < 2: continue
+ if len(timeslots) < 2:
+ continue
for i in range(1, len(timeslots)):
- if self.check_timeslots_overlap(timeslots[i-1], timeslots[i]):
- frappe.throw(_('Please fix overlapping time slots for {0}.').format(day))
+ if self.check_timeslots_overlap(timeslots[i - 1], timeslots[i]):
+ frappe.throw(_("Please fix overlapping time slots for {0}.").format(day))
@staticmethod
def check_timeslots_overlap(ts1: Tuple[int, int], ts2: Tuple[int, int]) -> bool:
@@ -58,7 +61,6 @@ class IncomingCallSettings(Document):
@staticmethod
def time_to_seconds(time: str) -> int:
- """Convert time string of format HH:MM:SS into seconds
- """
+ """Convert time string of format HH:MM:SS into seconds"""
date_time = datetime.strptime(time, "%H:%M:%S")
return date_time - datetime(1900, 1, 1)
diff --git a/erpnext/telephony/doctype/telephony_call_type/__init__.py b/erpnext/telephony/doctype/telephony_call_type/__init__.py
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.js b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.js
new file mode 100644
index 00000000000..efba2b86ff5
--- /dev/null
+++ b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.js
@@ -0,0 +1,8 @@
+// Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors
+// For license information, please see license.txt
+
+frappe.ui.form.on('Telephony Call Type', {
+ // refresh: function(frm) {
+
+ // }
+});
diff --git a/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.json b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.json
new file mode 100644
index 00000000000..603709e98f9
--- /dev/null
+++ b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.json
@@ -0,0 +1,58 @@
+{
+ "actions": [],
+ "allow_rename": 1,
+ "autoname": "field:call_type",
+ "creation": "2022-02-25 16:13:37.321312",
+ "doctype": "DocType",
+ "editable_grid": 1,
+ "engine": "InnoDB",
+ "field_order": [
+ "call_type",
+ "amended_from"
+ ],
+ "fields": [
+ {
+ "fieldname": "call_type",
+ "fieldtype": "Data",
+ "in_list_view": 1,
+ "label": "Call Type",
+ "reqd": 1,
+ "unique": 1
+ },
+ {
+ "fieldname": "amended_from",
+ "fieldtype": "Link",
+ "label": "Amended From",
+ "no_copy": 1,
+ "options": "Telephony Call Type",
+ "print_hide": 1,
+ "read_only": 1
+ }
+ ],
+ "index_web_pages_for_search": 1,
+ "is_submittable": 1,
+ "links": [],
+ "modified": "2022-02-25 16:14:07.087461",
+ "modified_by": "Administrator",
+ "module": "Telephony",
+ "name": "Telephony Call Type",
+ "naming_rule": "By fieldname",
+ "owner": "Administrator",
+ "permissions": [
+ {
+ "create": 1,
+ "delete": 1,
+ "email": 1,
+ "export": 1,
+ "print": 1,
+ "read": 1,
+ "report": 1,
+ "role": "System Manager",
+ "share": 1,
+ "write": 1
+ }
+ ],
+ "sort_field": "modified",
+ "sort_order": "DESC",
+ "states": []
+}
\ No newline at end of file
diff --git a/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.py b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.py
new file mode 100644
index 00000000000..944ffef36f2
--- /dev/null
+++ b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.py
@@ -0,0 +1,9 @@
+# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors
+# For license information, please see license.txt
+
+# import frappe
+from frappe.model.document import Document
+
+
+class TelephonyCallType(Document):
+ pass
diff --git a/erpnext/telephony/doctype/telephony_call_type/test_telephony_call_type.py b/erpnext/telephony/doctype/telephony_call_type/test_telephony_call_type.py
new file mode 100644
index 00000000000..b3c19c39102
--- /dev/null
+++ b/erpnext/telephony/doctype/telephony_call_type/test_telephony_call_type.py
@@ -0,0 +1,9 @@
+# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors
+# See license.txt
+
+# import frappe
+import unittest
+
+
+class TestTelephonyCallType(unittest.TestCase):
+ pass
diff --git a/erpnext/templates/emails/request_for_quotation.html b/erpnext/templates/emails/request_for_quotation.html
index 3283987fab0..5b073e604ff 100644
--- a/erpnext/templates/emails/request_for_quotation.html
+++ b/erpnext/templates/emails/request_for_quotation.html
@@ -1,24 +1,29 @@
{{_("Request for Quotation")}}
{{ supplier_salutation if supplier_salutation else ''}} {{ supplier_name }},
{{ message }}
-
{{_("The Request for Quotation can be accessed by clicking on the following button")}}:
-
-
-
-
-{{_("Regards")}},
-{{ user_fullname }}
-
+
+
+ {{ _("Submit your Quotation") }}
+
+
+
{% if update_password_link %}
-
+
{{_("Please click on the following button to set your new password")}}:
-
-
-
-
+
+ {{_("Set Password") }}
+
+
+
{% endif %}
+
+ {{_("Regards")}},
+ {{ user_fullname }}
+
diff --git a/erpnext/templates/generators/item/item_configure.js b/erpnext/templates/generators/item/item_configure.js
index b5f92989ef4..231ae0587ed 100644
--- a/erpnext/templates/generators/item/item_configure.js
+++ b/erpnext/templates/generators/item/item_configure.js
@@ -214,7 +214,7 @@ class ItemConfigure {
? `
${one_item}
- ${product_info && product_info.price && !$.isEmptyObject()
+ ${product_info && product_info.price && !$.isEmptyObject(product_info.price)
? '(' + product_info.price.formatted_price_sales_uom + ')'
: ''
}
diff --git a/erpnext/templates/generators/item/item_image.html b/erpnext/templates/generators/item/item_image.html
index 930bb7a67d6..e1bb3b98655 100644
--- a/erpnext/templates/generators/item/item_image.html
+++ b/erpnext/templates/generators/item/item_image.html
@@ -24,7 +24,7 @@
})
{% else %}
- {{ product_image(doc.website_image or doc.image, alt=doc.website_image_alt or doc.item_name) }}
+ {{ product_image(doc.website_image, alt=doc.website_image_alt or doc.item_name) }}
{% endif %}
diff --git a/erpnext/templates/generators/item_group.html b/erpnext/templates/generators/item_group.html
index 218481581c5..3926f77b1fa 100644
--- a/erpnext/templates/generators/item_group.html
+++ b/erpnext/templates/generators/item_group.html
@@ -52,24 +52,6 @@
-
diff --git a/erpnext/templates/includes/macros.html b/erpnext/templates/includes/macros.html
index 892d62513e2..3e20e50c3d8 100644
--- a/erpnext/templates/includes/macros.html
+++ b/erpnext/templates/includes/macros.html
@@ -74,7 +74,7 @@
{%- set col_size = 3 if is_full_width else 4 -%}
{%- set title = item.web_item_name or item.item_name or item.item_code -%}
{%- set title = title[:50] + "..." if title|len > 50 else title -%}
-{%- set image = item.website_image or item.image -%}
+{%- set image = item.website_image -%}
{%- set description = item.website_description or item.description-%}
{% if is_featured %}
@@ -300,13 +300,13 @@
{% if values | len > 20 %}
-
+
{% endif %}
{% if values %}
{0}: {1} Serial Numbers
{2}
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
1800 x 1685 x 750
All parts made of Marine Ply
Top w/ Corian dd
CO, CS, VIP Day Cabin
- " + ) - msg += '
- '.join(vouchers) - msg += '
' + summary) +def add_call_summary_and_call_type(call_log, summary, call_type): + doc = frappe.get_doc("Call Log", call_log) + doc.type_of_call = call_type + doc.save() + doc.add_comment("Comment", frappe.bold(_("Call Summary")) + "
" + summary) + def get_employees_with_number(number): number = strip_number(number) - if not number: return [] + if not number: + return [] - employee_emails = frappe.cache().hget('employees_with_number', number) - if employee_emails: return employee_emails + employee_doc_name_and_emails = frappe.cache().hget("employees_with_number", number) + if employee_doc_name_and_emails: + return employee_doc_name_and_emails - employees = frappe.get_all('Employee', filters={ - 'cell_number': ['like', '%{}%'.format(number)], - 'user_id': ['!=', ''] - }, fields=['user_id']) + employee_doc_name_and_emails = frappe.get_all( + "Employee", + filters={"cell_number": ["like", "%{}%".format(number)], "user_id": ["!=", ""]}, + fields=["name", "user_id"], + ) - employee_emails = [employee.user_id for employee in employees] - frappe.cache().hset('employees_with_number', number, employee_emails) + frappe.cache().hset("employees_with_number", number, employee_doc_name_and_emails) + + return employee_doc_name_and_emails - return employee_emails def link_existing_conversations(doc, state): """ Called from hooks on creation of Contact or Lead to link all the existing conversations. """ - if doc.doctype != 'Contact': return + if doc.doctype != "Contact": + return try: numbers = [d.phone for d in doc.phone_nos] for number in numbers: number = strip_number(number) - if not number: continue - logs = frappe.db.sql_list(""" + if not number: + continue + logs = frappe.db.sql_list( + """ SELECT cl.name FROM `tabCall Log` cl LEFT JOIN `tabDynamic Link` dl ON cl.name = dl.parent @@ -131,44 +155,42 @@ def link_existing_conversations(doc, state): ELSE 0 END )=0 - """, dict( - phone_number='%{}'.format(number), - docname=doc.name, - doctype = doc.doctype - ) + """, + dict(phone_number="%{}".format(number), docname=doc.name, doctype=doc.doctype), ) for log in logs: - call_log = frappe.get_doc('Call Log', log) + call_log = frappe.get_doc("Call Log", log) call_log.add_link(link_type=doc.doctype, link_name=doc.name) call_log.save(ignore_permissions=True) frappe.db.commit() except Exception: - frappe.log_error(title=_('Error during caller information update')) + frappe.log_error(title=_("Error during caller information update")) + def get_linked_call_logs(doctype, docname): # content will be shown in timeline - logs = frappe.get_all('Dynamic Link', fields=['parent'], filters={ - 'parenttype': 'Call Log', - 'link_doctype': doctype, - 'link_name': docname - }) + logs = frappe.get_all( + "Dynamic Link", + fields=["parent"], + filters={"parenttype": "Call Log", "link_doctype": doctype, "link_name": docname}, + ) logs = set([log.parent for log in logs]) - logs = frappe.get_all('Call Log', fields=['*'], filters={ - 'name': ['in', logs] - }) + logs = frappe.get_all("Call Log", fields=["*"], filters={"name": ["in", logs]}) timeline_contents = [] for log in logs: log.show_call_button = 0 - timeline_contents.append({ - 'icon': 'call', - 'is_card': True, - 'creation': log.creation, - 'template': 'call_link', - 'template_data': log - }) + timeline_contents.append( + { + "icon": "call", + "is_card": True, + "creation": log.creation, + "template": "call_link", + "template_data": log, + } + ) return timeline_contents diff --git a/erpnext/telephony/doctype/incoming_call_settings/incoming_call_settings.py b/erpnext/telephony/doctype/incoming_call_settings/incoming_call_settings.py index 08e244d8897..5edf81df736 100644 --- a/erpnext/telephony/doctype/incoming_call_settings/incoming_call_settings.py +++ b/erpnext/telephony/doctype/incoming_call_settings/incoming_call_settings.py @@ -20,35 +20,38 @@ class IncomingCallSettings(Document): self.validate_call_schedule_overlaps(self.call_handling_schedule) def validate_call_schedule_timeslot(self, schedule: list): - """ Make sure that to time slot is ahead of from time slot. - """ + """Make sure that to time slot is ahead of from time slot.""" errors = [] for record in schedule: from_time = self.time_to_seconds(record.from_time) to_time = self.time_to_seconds(record.to_time) if from_time >= to_time: errors.append( - _('Call Schedule Row {0}: To time slot should always be ahead of From time slot.').format(record.idx) + _("Call Schedule Row {0}: To time slot should always be ahead of From time slot.").format( + record.idx + ) ) if errors: - frappe.throw('
'.join(errors)) + frappe.throw("
".join(errors)) def validate_call_schedule_overlaps(self, schedule: list): - """Check if any time slots are overlapped in a day schedule. - """ + """Check if any time slots are overlapped in a day schedule.""" week_days = set([each.day_of_week for each in schedule]) for day in week_days: - timeslots = [(record.from_time, record.to_time) for record in schedule if record.day_of_week==day] + timeslots = [ + (record.from_time, record.to_time) for record in schedule if record.day_of_week == day + ] # convert time in timeslot into an integer represents number of seconds timeslots = sorted(map(lambda seq: tuple(map(self.time_to_seconds, seq)), timeslots)) - if len(timeslots) < 2: continue + if len(timeslots) < 2: + continue for i in range(1, len(timeslots)): - if self.check_timeslots_overlap(timeslots[i-1], timeslots[i]): - frappe.throw(_('Please fix overlapping time slots for {0}.').format(day)) + if self.check_timeslots_overlap(timeslots[i - 1], timeslots[i]): + frappe.throw(_("Please fix overlapping time slots for {0}.").format(day)) @staticmethod def check_timeslots_overlap(ts1: Tuple[int, int], ts2: Tuple[int, int]) -> bool: @@ -58,7 +61,6 @@ class IncomingCallSettings(Document): @staticmethod def time_to_seconds(time: str) -> int: - """Convert time string of format HH:MM:SS into seconds - """ + """Convert time string of format HH:MM:SS into seconds""" date_time = datetime.strptime(time, "%H:%M:%S") return date_time - datetime(1900, 1, 1) diff --git a/erpnext/telephony/doctype/telephony_call_type/__init__.py b/erpnext/telephony/doctype/telephony_call_type/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.js b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.js new file mode 100644 index 00000000000..efba2b86ff5 --- /dev/null +++ b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.js @@ -0,0 +1,8 @@ +// Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +// For license information, please see license.txt + +frappe.ui.form.on('Telephony Call Type', { + // refresh: function(frm) { + + // } +}); diff --git a/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.json b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.json new file mode 100644 index 00000000000..603709e98f9 --- /dev/null +++ b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.json @@ -0,0 +1,58 @@ +{ + "actions": [], + "allow_rename": 1, + "autoname": "field:call_type", + "creation": "2022-02-25 16:13:37.321312", + "doctype": "DocType", + "editable_grid": 1, + "engine": "InnoDB", + "field_order": [ + "call_type", + "amended_from" + ], + "fields": [ + { + "fieldname": "call_type", + "fieldtype": "Data", + "in_list_view": 1, + "label": "Call Type", + "reqd": 1, + "unique": 1 + }, + { + "fieldname": "amended_from", + "fieldtype": "Link", + "label": "Amended From", + "no_copy": 1, + "options": "Telephony Call Type", + "print_hide": 1, + "read_only": 1 + } + ], + "index_web_pages_for_search": 1, + "is_submittable": 1, + "links": [], + "modified": "2022-02-25 16:14:07.087461", + "modified_by": "Administrator", + "module": "Telephony", + "name": "Telephony Call Type", + "naming_rule": "By fieldname", + "owner": "Administrator", + "permissions": [ + { + "create": 1, + "delete": 1, + "email": 1, + "export": 1, + "print": 1, + "read": 1, + "report": 1, + "role": "System Manager", + "share": 1, + "write": 1 + } + ], + "sort_field": "modified", + "sort_order": "DESC", + "states": [] +} \ No newline at end of file diff --git a/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.py b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.py new file mode 100644 index 00000000000..944ffef36f2 --- /dev/null +++ b/erpnext/telephony/doctype/telephony_call_type/telephony_call_type.py @@ -0,0 +1,9 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and contributors +# For license information, please see license.txt + +# import frappe +from frappe.model.document import Document + + +class TelephonyCallType(Document): + pass diff --git a/erpnext/telephony/doctype/telephony_call_type/test_telephony_call_type.py b/erpnext/telephony/doctype/telephony_call_type/test_telephony_call_type.py new file mode 100644 index 00000000000..b3c19c39102 --- /dev/null +++ b/erpnext/telephony/doctype/telephony_call_type/test_telephony_call_type.py @@ -0,0 +1,9 @@ +# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors +# See license.txt + +# import frappe +import unittest + + +class TestTelephonyCallType(unittest.TestCase): + pass diff --git a/erpnext/templates/emails/request_for_quotation.html b/erpnext/templates/emails/request_for_quotation.html index 3283987fab0..5b073e604ff 100644 --- a/erpnext/templates/emails/request_for_quotation.html +++ b/erpnext/templates/emails/request_for_quotation.html @@ -1,24 +1,29 @@
{{_("Request for Quotation")}}
{{ supplier_salutation if supplier_salutation else ''}} {{ supplier_name }},
{{ message }}
-{{_("The Request for Quotation can be accessed by clicking on the following button")}}:
-- -
- -
{{_("Regards")}},
-{{ user_fullname }}
- +
+ + {{ _("Submit your Quotation") }} + +
+
{% if update_password_link %} - +
{{_("Please click on the following button to set your new password")}}:
-- -
- + + {{_("Set Password") }} + ++
{% endif %} +
+ {{_("Regards")}},
+ {{ user_fullname }}
+
${one_item}
- ${product_info && product_info.price && !$.isEmptyObject()
+ ${product_info && product_info.price && !$.isEmptyObject(product_info.price)
? '(' + product_info.price.formatted_price_sales_uom + ')'
: ''
}
diff --git a/erpnext/templates/generators/item/item_image.html b/erpnext/templates/generators/item/item_image.html
index 930bb7a67d6..e1bb3b98655 100644
--- a/erpnext/templates/generators/item/item_image.html
+++ b/erpnext/templates/generators/item/item_image.html
@@ -24,7 +24,7 @@
})
{% else %}
- {{ product_image(doc.website_image or doc.image, alt=doc.website_image_alt or doc.item_name) }}
+ {{ product_image(doc.website_image, alt=doc.website_image_alt or doc.item_name) }}
{% endif %}
diff --git a/erpnext/templates/generators/item_group.html b/erpnext/templates/generators/item_group.html
index 218481581c5..3926f77b1fa 100644
--- a/erpnext/templates/generators/item_group.html
+++ b/erpnext/templates/generators/item_group.html
@@ -52,24 +52,6 @@
-