blob: 78645e0d4ff8b4a7d984dea514137a378fed462c [file] [log] [blame]
Anand Doshi885e0742015-03-03 14:55:30 +05301# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
Rushabh Mehtae67d1fb2013-08-05 14:59:54 +05302# License: GNU General Public License v3. See license.txt
Nabin Hait2df4d542013-01-29 11:34:39 +05303
Chillar Anand915b3432021-09-02 16:44:59 +05304
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08005import json
Chillar Anand915b3432021-09-02 16:44:59 +05306
7import frappe
Rushabh Mehta793ba6b2014-02-14 15:47:51 +05308from frappe import _, throw
Chillar Anand915b3432021-09-02 16:44:59 +05309from frappe.model.workflow import get_workflow_name, is_transition_condition_satisfied
Pruthvi Patel6c96ed42021-10-30 16:44:15 +053010from frappe.query_builder.functions import Sum
Chillar Anand915b3432021-09-02 16:44:59 +053011from frappe.utils import (
12 add_days,
13 add_months,
14 cint,
15 flt,
16 fmt_money,
17 formatdate,
18 get_last_day,
19 get_link_to_form,
20 getdate,
21 nowdate,
GangaManojd24cfff2021-10-28 20:06:48 +053022 today,
Chillar Anand915b3432021-09-02 16:44:59 +053023)
Chillar Anand915b3432021-09-02 16:44:59 +053024
25import erpnext
26from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import (
27 get_accounting_dimensions,
28)
29from erpnext.accounts.doctype.pricing_rule.utils import (
30 apply_pricing_rule_for_free_items,
31 apply_pricing_rule_on_transaction,
32 get_applied_pricing_rules,
33)
34from erpnext.accounts.party import (
35 get_party_account,
36 get_party_account_currency,
37 validate_party_frozen_disabled,
38)
39from erpnext.accounts.utils import get_account_currency, get_fiscal_years, validate_fiscal_year
40from erpnext.buying.utils import update_last_purchase_rate
41from erpnext.controllers.print_settings import (
42 set_print_templates_for_item_table,
43 set_print_templates_for_taxes,
44)
45from erpnext.controllers.sales_and_purchase_return import validate_return
46from erpnext.exceptions import InvalidCurrency
47from erpnext.setup.utils import get_exchange_rate
Marica3dee5272020-06-23 10:33:47 +053048from erpnext.stock.doctype.packed_item.packed_item import make_packing_list
Chillar Anand915b3432021-09-02 16:44:59 +053049from erpnext.stock.get_item_details import (
50 _get_item_tax_template,
51 get_conversion_factor,
52 get_item_details,
53 get_item_tax_map,
54 get_item_warehouse,
55)
56from erpnext.utilities.transaction_base import TransactionBase
57
Nabin Hait1d218422015-07-17 15:19:02 +053058
Ankush Menat494bd9e2022-03-28 18:52:46 +053059class AccountMissingError(frappe.ValidationError):
60 pass
marination53b1a9a2020-11-03 15:45:25 +053061
Ankush Menat494bd9e2022-03-28 18:52:46 +053062
63force_item_fields = (
64 "item_group",
65 "brand",
66 "stock_uom",
67 "is_fixed_asset",
68 "item_tax_rate",
69 "pricing_rules",
70 "weight_per_unit",
71 "weight_uom",
72 "total_weight",
73)
74
Doridel Cahanap6f06cc22018-05-17 16:28:58 +080075
Nabin Haitbf495c92013-01-30 12:49:08 +053076class AccountsController(TransactionBase):
Nabin Hait7eba1a32017-10-02 15:59:27 +053077 def __init__(self, *args, **kwargs):
78 super(AccountsController, self).__init__(*args, **kwargs)
Anand Doshi979326b2015-09-11 16:22:37 +053079
prssanna71e5b602020-10-29 14:19:34 +053080 def get_print_settings(self):
81 print_setting_fields = []
Ankush Menat494bd9e2022-03-28 18:52:46 +053082 items_field = self.meta.get_field("items")
prssanna71e5b602020-10-29 14:19:34 +053083
Ankush Menat494bd9e2022-03-28 18:52:46 +053084 if items_field and items_field.fieldtype == "Table":
85 print_setting_fields += ["compact_item_print", "print_uom_after_quantity"]
prssanna71e5b602020-10-29 14:19:34 +053086
Ankush Menat494bd9e2022-03-28 18:52:46 +053087 taxes_field = self.meta.get_field("taxes")
88 if taxes_field and taxes_field.fieldtype == "Table":
89 print_setting_fields += ["print_taxes_with_zero_amount"]
prssanna71e5b602020-10-29 14:19:34 +053090
91 return print_setting_fields
92
Nabin Hait4ffd7f32015-08-27 12:28:36 +053093 @property
94 def company_currency(self):
95 if not hasattr(self, "__company_currency"):
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +053096 self.__company_currency = erpnext.get_company_currency(self.company)
Anand Doshi979326b2015-09-11 16:22:37 +053097
Nabin Hait4ffd7f32015-08-27 12:28:36 +053098 return self.__company_currency
Anand Doshi979326b2015-09-11 16:22:37 +053099
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530100 def onload(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530101 self.set_onload(
102 "make_payment_via_journal_entry",
103 frappe.db.get_single_value("Accounts Settings", "make_payment_via_journal_entry"),
104 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530105
tundee52bb822017-09-25 09:02:23 +0100106 if self.is_new():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530107 relevant_docs = (
108 "Quotation",
109 "Purchase Order",
110 "Sales Order",
111 "Purchase Invoice",
112 "Sales Invoice",
113 )
tundee52bb822017-09-25 09:02:23 +0100114 if self.doctype in relevant_docs:
115 self.set_payment_schedule()
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530116
tundebabzyad08d4c2018-05-16 07:01:41 +0100117 def ensure_supplier_is_not_blocked(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530118 is_supplier_payment = self.doctype == "Payment Entry" and self.party_type == "Supplier"
119 is_buying_invoice = self.doctype in ["Purchase Invoice", "Purchase Order"]
tundebabzyad08d4c2018-05-16 07:01:41 +0100120 supplier = None
121 supplier_name = None
122
123 if is_buying_invoice or is_supplier_payment:
124 supplier_name = self.supplier if is_buying_invoice else self.party
Ankush Menat494bd9e2022-03-28 18:52:46 +0530125 supplier = frappe.get_doc("Supplier", supplier_name)
tundebabzyad08d4c2018-05-16 07:01:41 +0100126
127 if supplier and supplier_name and supplier.on_hold:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530128 if (is_buying_invoice and supplier.hold_type in ["All", "Invoices"]) or (
129 is_supplier_payment and supplier.hold_type in ["All", "Payments"]
130 ):
tundebabzyad08d4c2018-05-16 07:01:41 +0100131 if not supplier.release_date or getdate(nowdate()) <= supplier.release_date:
132 frappe.msgprint(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530133 _("{0} is blocked so this transaction cannot proceed").format(supplier_name),
134 raise_exception=1,
135 )
tundebabzyad08d4c2018-05-16 07:01:41 +0100136
Saurabh6f753182013-03-20 12:55:28 +0530137 def validate(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530138 if not self.get("is_return") and not self.get("is_debit_note"):
Deepesh Gargd301d262019-07-31 15:58:19 +0530139 self.validate_qty_is_not_zero()
140
nabinhait23cce732014-07-03 12:25:06 +0530141 if self.get("_action") and self._action != "update_after_submit":
Nabin Hait704a4532014-06-05 16:55:31 +0530142 self.set_missing_values(for_validate=True)
tunde62af5c52017-09-22 15:16:38 +0100143
tundebabzyad08d4c2018-05-16 07:01:41 +0100144 self.ensure_supplier_is_not_blocked()
145
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530146 self.validate_date_with_fiscal_year()
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530147 self.validate_party_accounts()
148
Deepesh Gargb4be2922021-01-28 13:09:56 +0530149 self.validate_inter_company_reference()
150
151 self.set_incoming_rate()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530152
Anand Doshi3543f302013-05-24 19:25:01 +0530153 if self.meta.get_field("currency"):
Anand Doshi923d41d2013-05-28 17:23:36 +0530154 self.calculate_taxes_and_totals()
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530155
Nabin Hait1d218422015-07-17 15:19:02 +0530156 if not self.meta.get_field("is_return") or not self.is_return:
157 self.validate_value("base_grand_total", ">=", 0)
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530158
Nabin Hait3cf67a42015-07-24 13:26:36 +0530159 validate_return(self)
Anand Doshi3543f302013-05-24 19:25:01 +0530160 self.set_total_in_words()
Anand Doshid2946502014-04-08 20:10:03 +0530161
tunde62af5c52017-09-22 15:16:38 +0100162 self.validate_all_documents_schedule()
Anand Doshid2946502014-04-08 20:10:03 +0530163
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530164 if self.meta.get_field("taxes_and_charges"):
165 self.validate_enabled_taxes_and_charges()
Nabin Haita2426fc2018-01-15 17:45:46 +0530166 self.validate_tax_account_company()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530167
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +0530168 self.validate_party()
Nabin Hait895029d2015-08-20 14:55:39 +0530169 self.validate_currency()
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530170
Ankush Menat494bd9e2022-03-28 18:52:46 +0530171 if self.doctype in ["Purchase Invoice", "Sales Invoice"]:
172 pos_check_field = "is_pos" if self.doctype == "Sales Invoice" else "is_paid"
Nabin Hait4a994d42019-04-25 17:47:26 +0530173 if cint(self.allocate_advances_automatically) and not cint(self.get(pos_check_field)):
Nabin Hait041a5c22018-08-01 18:07:39 +0530174 self.set_advances()
175
Saqiba20999c2021-07-12 14:33:23 +0530176 self.set_advance_gain_or_loss()
177
Nabin Hait041a5c22018-08-01 18:07:39 +0530178 if self.is_return:
179 self.validate_qty()
Nabin Haitacdd5082019-12-04 15:30:01 +0530180 else:
181 self.validate_deferred_start_and_end_date()
rohitwaghchaure70489252018-06-11 12:02:14 +0530182
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530183 self.validate_deferred_income_expense_account()
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530184 self.set_inter_company_account()
185
Ankush Menat494bd9e2022-03-28 18:52:46 +0530186 if self.doctype == "Purchase Invoice":
Deepesh Garg7f06c8c2021-11-26 10:27:57 +0530187 self.calculate_paid_amount()
188 # apply tax withholding only if checked and applicable
189 self.set_tax_withholding()
190
Gauravf1e28e02019-02-13 16:46:24 +0530191 validate_regional(self)
Deepesh Garg7c300852020-12-26 20:14:51 +0530192
Saqib Ansaric5782b02022-01-27 20:09:56 +0530193 validate_einvoice_fields(self)
194
Ankush Menat494bd9e2022-03-28 18:52:46 +0530195 if self.doctype != "Material Request":
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530196 apply_pricing_rule_on_transaction(self)
Gauravf1e28e02019-02-13 16:46:24 +0530197
Saqib Ansaric5782b02022-01-27 20:09:56 +0530198 def before_cancel(self):
199 validate_einvoice_fields(self)
200
Saqib8e556772021-01-28 12:26:45 +0530201 def on_trash(self):
202 # delete sl and gl entries on deletion of transaction
Ankush Menat494bd9e2022-03-28 18:52:46 +0530203 if frappe.db.get_single_value("Accounts Settings", "delete_linked_ledger_entries"):
204 frappe.db.sql(
205 "delete from `tabGL Entry` where voucher_type=%s and voucher_no=%s", (self.doctype, self.name)
206 )
207 frappe.db.sql(
208 "delete from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s",
209 (self.doctype, self.name),
210 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530211
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530212 def validate_deferred_income_expense_account(self):
213 field_map = {
214 "Sales Invoice": "deferred_revenue_account",
215 "Purchase Invoice": "deferred_expense_account",
216 }
217
218 for item in self.get("items"):
219 if item.get("enable_deferred_revenue") or item.get("enable_deferred_expense"):
220 if not item.get(field_map.get(self.doctype)):
221 default_deferred_account = frappe.db.get_value(
222 "Company", self.company, "default_" + field_map.get(self.doctype)
223 )
224 if not default_deferred_account:
225 frappe.throw(
226 _(
227 "Row #{0}: Please update deferred revenue/expense account in item row or default account in company master"
228 ).format(item.idx)
229 )
230 else:
231 item.set(field_map.get(self.doctype), default_deferred_account)
232
Nabin Haitacdd5082019-12-04 15:30:01 +0530233 def validate_deferred_start_and_end_date(self):
234 for d in self.items:
235 if d.get("enable_deferred_revenue") or d.get("enable_deferred_expense"):
236 if not (d.service_start_date and d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530237 frappe.throw(
238 _("Row #{0}: Service Start and End Date is required for deferred accounting").format(d.idx)
239 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530240 elif getdate(d.service_start_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530241 frappe.throw(
242 _("Row #{0}: Service Start Date cannot be greater than Service End Date").format(d.idx)
243 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530244 elif getdate(self.posting_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530245 frappe.throw(
246 _("Row #{0}: Service End Date cannot be before Invoice Posting Date").format(d.idx)
247 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530248
tunde62af5c52017-09-22 15:16:38 +0100249 def validate_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530250 self.validate_payment_schedule_dates()
251 self.set_due_date()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530252 self.set_payment_schedule()
253 self.validate_payment_schedule_amount()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530254 if not self.get("ignore_default_payment_terms_template"):
Deepesh Gargbd709f82021-08-23 19:05:52 +0530255 self.validate_due_date()
tunde62af5c52017-09-22 15:16:38 +0100256 self.validate_advance_entries()
257
258 def validate_non_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530259 self.set_payment_schedule()
Nabin Hait2f9f4f92017-12-20 12:24:59 +0530260 self.validate_payment_schedule_dates()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530261 self.validate_payment_schedule_amount()
tunde62af5c52017-09-22 15:16:38 +0100262
263 def validate_all_documents_schedule(self):
264 if self.doctype in ("Sales Invoice", "Purchase Invoice") and not self.is_return:
265 self.validate_invoice_documents_schedule()
266 elif self.doctype in ("Quotation", "Purchase Order", "Sales Order"):
267 self.validate_non_invoice_documents_schedule()
268
prssanna71e5b602020-10-29 14:19:34 +0530269 def before_print(self, settings=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530270 if self.doctype in [
271 "Purchase Order",
272 "Sales Order",
273 "Sales Invoice",
274 "Purchase Invoice",
275 "Supplier Quotation",
276 "Purchase Receipt",
277 "Delivery Note",
278 "Quotation",
279 ]:
KanchanChauhan49a50fe2016-11-18 13:57:53 +0530280 if self.get("group_same_items"):
281 self.group_similar_items()
282
Zarrar5be6d192018-11-08 12:16:26 +0530283 df = self.meta.get_field("discount_amount")
284 if self.get("discount_amount") and hasattr(self, "taxes") and not len(self.taxes):
285 df.set("print_hide", 0)
286 self.discount_amount = -self.discount_amount
287 else:
288 df.set("print_hide", 1)
289
prssanna71e5b602020-10-29 14:19:34 +0530290 set_print_templates_for_item_table(self, settings)
291 set_print_templates_for_taxes(self, settings)
292
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530293 def calculate_paid_amount(self):
Saurabh43520f92016-03-21 18:32:48 +0530294 if hasattr(self, "is_pos") or hasattr(self, "is_paid"):
295 is_paid = self.get("is_pos") or self.get("is_paid")
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530296
297 if is_paid:
298 if not self.cash_bank_account:
299 # show message that the amount is not paid
Ankush Menat494bd9e2022-03-28 18:52:46 +0530300 frappe.throw(
301 _("Note: Payment Entry will not be created since 'Cash or Bank Account' was not specified")
302 )
Marica23d7b092019-09-25 17:17:36 +0530303
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530304 if cint(self.is_return) and self.grand_total > self.paid_amount:
305 self.paid_amount = flt(flt(self.grand_total), self.precision("paid_amount"))
306
307 elif not flt(self.paid_amount) and flt(self.outstanding_amount) > 0:
308 self.paid_amount = flt(flt(self.outstanding_amount), self.precision("paid_amount"))
309
Ankush Menat494bd9e2022-03-28 18:52:46 +0530310 self.base_paid_amount = flt(
311 self.paid_amount * self.conversion_rate, self.precision("base_paid_amount")
312 )
Saurabh43520f92016-03-21 18:32:48 +0530313
Anand Doshiabc10032013-06-14 17:44:03 +0530314 def set_missing_values(self, for_validate=False):
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530315 if frappe.flags.in_test:
tunde62af5c52017-09-22 15:16:38 +0100316 for fieldname in ["posting_date", "transaction_date"]:
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530317 if self.meta.get_field(fieldname) and not self.get(fieldname):
318 self.set(fieldname, today())
319 break
Anand Doshid2946502014-04-08 20:10:03 +0530320
Nabin Hait3237c752015-02-17 11:11:11 +0530321 def calculate_taxes_and_totals(self):
Nabin Haitfe81da22015-02-18 12:23:18 +0530322 from erpnext.controllers.taxes_and_totals import calculate_taxes_and_totals
Ankush Menat494bd9e2022-03-28 18:52:46 +0530323
Nabin Haitfe81da22015-02-18 12:23:18 +0530324 calculate_taxes_and_totals(self)
Nabin Hait3237c752015-02-17 11:11:11 +0530325
Raffael Meyere10ab162021-11-30 13:24:18 +0100326 if self.doctype in (
Ankush Menat494bd9e2022-03-28 18:52:46 +0530327 "Sales Order",
328 "Delivery Note",
329 "Sales Invoice",
330 "POS Invoice",
Raffael Meyere10ab162021-11-30 13:24:18 +0100331 ):
Nabin Hait3237c752015-02-17 11:11:11 +0530332 self.calculate_commission()
333 self.calculate_contribution()
334
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530335 def validate_date_with_fiscal_year(self):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +0800336 if self.meta.get_field("fiscal_year"):
Rohan Bansal1e3a3b22021-05-26 15:18:10 +0530337 date_field = None
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530338 if self.meta.get_field("posting_date"):
339 date_field = "posting_date"
340 elif self.meta.get_field("transaction_date"):
341 date_field = "transaction_date"
Anand Doshid2946502014-04-08 20:10:03 +0530342
Rushabh Mehtaf2227d02014-03-31 23:37:40 +0530343 if date_field and self.get(date_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530344 validate_fiscal_year(
345 self.get(date_field), self.fiscal_year, self.company, self.meta.get_label(date_field), self
346 )
Anand Doshid2946502014-04-08 20:10:03 +0530347
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530348 def validate_party_accounts(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530349 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530350 return
351
Ankush Menat494bd9e2022-03-28 18:52:46 +0530352 if self.doctype == "Sales Invoice":
353 party_account_field = "debit_to"
354 item_field = "income_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530355 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530356 party_account_field = "credit_to"
357 item_field = "expense_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530358
Ankush Menat494bd9e2022-03-28 18:52:46 +0530359 for item in self.get("items"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530360 if item.get(item_field) == self.get(party_account_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530361 frappe.throw(
362 _("Row {0}: {1} {2} cannot be same as {3} (Party Account) {4}").format(
363 item.idx,
364 frappe.bold(frappe.unscrub(item_field)),
365 item.get(item_field),
366 frappe.bold(frappe.unscrub(party_account_field)),
367 self.get(party_account_field),
368 )
369 )
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530370
Deepesh Gargb4be2922021-01-28 13:09:56 +0530371 def validate_inter_company_reference(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530372 if self.doctype not in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"):
Deepesh Gargb4be2922021-01-28 13:09:56 +0530373 return
374
375 if self.is_internal_transfer():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530376 if not (
377 self.get("inter_company_reference")
378 or self.get("inter_company_invoice_reference")
379 or self.get("inter_company_order_reference")
380 ):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530381 msg = _("Internal Sale or Delivery Reference missing.")
Deepesh Gargb4be2922021-01-28 13:09:56 +0530382 msg += _("Please create purchase from internal sale or delivery document itself")
383 frappe.throw(msg, title=_("Internal Sales Reference Missing"))
384
Nabin Haite9daefe2014-08-27 16:46:33 +0530385 def validate_due_date(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530386 if self.get("is_pos"):
387 return
rohitwaghchaureea943c62018-07-06 12:28:58 +0530388
Nabin Haite9daefe2014-08-27 16:46:33 +0530389 from erpnext.accounts.party import validate_due_date
Ankush Menat494bd9e2022-03-28 18:52:46 +0530390
Nabin Haite9daefe2014-08-27 16:46:33 +0530391 if self.doctype == "Sales Invoice":
Nabin Hait04d244a2015-07-22 17:47:49 +0530392 if not self.due_date:
393 frappe.throw(_("Due Date is mandatory"))
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530394
Ankush Menat494bd9e2022-03-28 18:52:46 +0530395 validate_due_date(
396 self.posting_date,
397 self.due_date,
398 "Customer",
399 self.customer,
400 self.company,
401 self.payment_terms_template,
402 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530403 elif self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +0530404 validate_due_date(
405 self.bill_date or self.posting_date,
406 self.due_date,
407 "Supplier",
408 self.supplier,
409 self.company,
410 self.bill_date,
411 self.payment_terms_template,
412 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530413
Nabin Hait096d3632013-10-17 17:01:14 +0530414 def set_price_list_currency(self, buying_or_selling):
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530415 if self.meta.get_field("posting_date"):
Nabin Hait288a18e2016-12-08 15:36:23 +0530416 transaction_date = self.posting_date
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530417 else:
Nabin Hait288a18e2016-12-08 15:36:23 +0530418 transaction_date = self.transaction_date
Rushabh Mehta66958302017-01-16 16:57:53 +0530419
Rushabh Mehta4a404e92013-08-09 18:11:35 +0530420 if self.meta.get_field("currency"):
Nabin Hait7a75e102013-09-17 10:21:20 +0530421 # price list part
Shreya3f778522018-05-15 16:59:20 +0530422 if buying_or_selling.lower() == "selling":
423 fieldname = "selling_price_list"
424 args = "for_selling"
425 else:
426 fieldname = "buying_price_list"
427 args = "for_buying"
428
Anand Doshif78d1ae2014-03-28 13:55:00 +0530429 if self.meta.get_field(fieldname) and self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530430 self.price_list_currency = frappe.db.get_value("Price List", self.get(fieldname), "currency")
Anand Doshid2946502014-04-08 20:10:03 +0530431
Nabin Hait6e439a52015-08-28 19:24:22 +0530432 if self.price_list_currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530433 self.plc_conversion_rate = 1.0
Nabin Hait11f41952013-09-24 14:36:55 +0530434
Anand Doshif78d1ae2014-03-28 13:55:00 +0530435 elif not self.plc_conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530436 self.plc_conversion_rate = get_exchange_rate(
437 self.price_list_currency, self.company_currency, transaction_date, args
438 )
Anand Doshid2946502014-04-08 20:10:03 +0530439
Nabin Hait7a75e102013-09-17 10:21:20 +0530440 # currency
Anand Doshif78d1ae2014-03-28 13:55:00 +0530441 if not self.currency:
442 self.currency = self.price_list_currency
443 self.conversion_rate = self.plc_conversion_rate
Nabin Hait6e439a52015-08-28 19:24:22 +0530444 elif self.currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530445 self.conversion_rate = 1.0
446 elif not self.conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530447 self.conversion_rate = get_exchange_rate(
448 self.currency, self.company_currency, transaction_date, args
449 )
Nabin Hait7a75e102013-09-17 10:21:20 +0530450
Nabin Haitcccc45e2016-10-05 17:15:43 +0530451 def set_missing_item_details(self, for_validate=False):
Anand Doshi3543f302013-05-24 19:25:01 +0530452 """set missing item values"""
Nabin Haitf37d43d2017-07-18 12:14:42 +0530453 from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530454
Nabin Haitdd38a262014-12-26 13:15:21 +0530455 if hasattr(self, "items"):
Nabin Hait444f9562014-06-20 15:59:49 +0530456 parent_dict = {}
Pratik Vyasf7daab72014-04-10 17:53:30 +0530457 for fieldname in self.meta.get_valid_columns():
458 parent_dict[fieldname] = self.get(fieldname)
459
mbauskara52472c2016-03-05 15:10:25 +0530460 if self.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice"]:
461 document_type = "{} Item".format(self.doctype)
mbauskarc97becb2016-01-18 16:28:21 +0530462 parent_dict.update({"document_type": document_type})
463
Nabin Hait34c551d2019-07-03 10:34:31 +0530464 # party_name field used for customer in quotation
Ankush Menat494bd9e2022-03-28 18:52:46 +0530465 if (
466 self.doctype == "Quotation"
467 and self.quotation_to == "Customer"
468 and parent_dict.get("party_name")
469 ):
Nabin Hait34c551d2019-07-03 10:34:31 +0530470 parent_dict.update({"customer": parent_dict.get("party_name")})
471
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530472 self.pricing_rules = []
Nabin Haitdd38a262014-12-26 13:15:21 +0530473 for item in self.get("items"):
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530474 if item.get("item_code"):
Nabin Hait444f9562014-06-20 15:59:49 +0530475 args = parent_dict.copy()
476 args.update(item.as_dict())
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530477
Nabin Hait34d28222016-01-19 15:45:49 +0530478 args["doctype"] = self.doctype
479 args["name"] = self.name
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530480 args["child_docname"] = item.name
Ankush Menat494bd9e2022-03-28 18:52:46 +0530481 args["ignore_pricing_rule"] = (
482 self.ignore_pricing_rule if hasattr(self, "ignore_pricing_rule") else 0
483 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530484
Nabin Haite2f054c2015-03-09 14:54:37 +0530485 if not args.get("transaction_date"):
486 args["transaction_date"] = args.get("posting_date")
Anand Doshi2b2b6392015-03-20 14:18:09 +0530487
488 if self.get("is_subcontracted"):
489 args["is_subcontracted"] = self.is_subcontracted
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530490
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530491 ret = get_item_details(args, self, for_validate=True, overwrite_warehouse=False)
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530492
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530493 for fieldname, value in ret.items():
Anand Doshi602e8252015-11-16 19:05:46 +0530494 if item.meta.get_field(fieldname) and value is not None:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530495 if item.get(fieldname) is None or fieldname in force_item_fields:
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530496 item.set(fieldname, value)
Anand Doshid2946502014-04-08 20:10:03 +0530497
Ankush Menat494bd9e2022-03-28 18:52:46 +0530498 elif fieldname in ["cost_center", "conversion_factor"] and not item.get(fieldname):
Anand Doshi602e8252015-11-16 19:05:46 +0530499 item.set(fieldname, value)
500
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530501 elif fieldname == "serial_no":
Alchez9155e402018-07-09 16:57:42 +0530502 # Ensure that serial numbers are matched against Stock UOM
503 item_conversion_factor = item.get("conversion_factor") or 1.0
504 item_qty = abs(item.get("qty")) * item_conversion_factor
Alchez8f2a0f32018-07-06 14:36:52 +0530505
Ankush Menat494bd9e2022-03-28 18:52:46 +0530506 if item_qty != len(get_serial_nos(item.get("serial_no"))):
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530507 item.set(fieldname, value)
Nabin Haita74468b2014-12-30 18:33:52 +0530508
Saqib Ansariab36b272022-02-09 10:10:17 +0530509 elif (
510 ret.get("pricing_rule_removed")
511 and value is not None
512 and fieldname
513 in [
514 "discount_percentage",
515 "discount_amount",
516 "rate",
517 "margin_rate_or_amount",
518 "margin_type",
519 "remove_free_item",
520 ]
521 ):
Saqib Ansarib8c41e32022-01-20 13:06:08 +0530522 # reset pricing rule fields if pricing_rule_removed
523 item.set(fieldname, value)
524
Ankush Menat494bd9e2022-03-28 18:52:46 +0530525 if self.doctype in ["Purchase Invoice", "Sales Invoice"] and item.meta.get_field(
526 "is_fixed_asset"
527 ):
528 item.set("is_fixed_asset", ret.get("is_fixed_asset", 0))
Rohit Waghchauref6f503a2018-12-19 15:06:44 +0530529
Deepesh Garga60c3082021-05-11 16:38:33 +0530530 # Double check for cost center
531 # Items add via promotional scheme may not have cost center set
Ankush Menat494bd9e2022-03-28 18:52:46 +0530532 if hasattr(item, "cost_center") and not item.get("cost_center"):
533 item.set(
534 "cost_center", self.get("cost_center") or erpnext.get_default_cost_center(self.company)
535 )
Deepesh Garga60c3082021-05-11 16:38:33 +0530536
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530537 if ret.get("pricing_rules"):
538 self.apply_pricing_rule_on_items(item, ret)
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530539 self.set_pricing_rule_details(item, ret)
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530540
Nabin Hait14aa9c52016-04-18 15:54:01 +0530541 if self.doctype == "Purchase Invoice":
Nabin Haitcccc45e2016-10-05 17:15:43 +0530542 self.set_expense_account(for_validate)
Nabin Haita3dd72a2014-05-28 12:49:20 +0530543
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530544 def apply_pricing_rule_on_items(self, item, pricing_rule_args):
545 if not pricing_rule_args.get("validate_applied_rule", 0):
546 # if user changed the discount percentage then set user's discount percentage ?
Ankush Menat494bd9e2022-03-28 18:52:46 +0530547 if pricing_rule_args.get("price_or_product_discount") == "Price":
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530548 item.set("pricing_rules", pricing_rule_args.get("pricing_rules"))
549 item.set("discount_percentage", pricing_rule_args.get("discount_percentage"))
550 item.set("discount_amount", pricing_rule_args.get("discount_amount"))
551 if pricing_rule_args.get("pricing_rule_for") == "Rate":
552 item.set("price_list_rate", pricing_rule_args.get("price_list_rate"))
553
554 if item.get("price_list_rate"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530555 item.rate = flt(
556 item.price_list_rate * (1.0 - (flt(item.discount_percentage) / 100.0)),
557 item.precision("rate"),
558 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530559
Ankush Menat494bd9e2022-03-28 18:52:46 +0530560 if item.get("discount_amount"):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530561 item.rate = item.price_list_rate - item.discount_amount
562
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530563 if item.get("apply_discount_on_discounted_rate") and pricing_rule_args.get("rate"):
564 item.rate = pricing_rule_args.get("rate")
565
Ankush Menat494bd9e2022-03-28 18:52:46 +0530566 elif pricing_rule_args.get("free_item_data"):
567 apply_pricing_rule_for_free_items(self, pricing_rule_args.get("free_item_data"))
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530568
569 elif pricing_rule_args.get("validate_applied_rule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530570 for pricing_rule in get_applied_pricing_rules(item.get("pricing_rules")):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530571 pricing_rule_doc = frappe.get_cached_doc("Pricing Rule", pricing_rule)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530572 for field in ["discount_percentage", "discount_amount", "rate"]:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530573 if item.get(field) < pricing_rule_doc.get(field):
574 title = get_link_to_form("Pricing Rule", pricing_rule)
575
Ankush Menat494bd9e2022-03-28 18:52:46 +0530576 frappe.msgprint(
577 _("Row {0}: user has not applied the rule {1} on the item {2}").format(
578 item.idx, frappe.bold(title), frappe.bold(item.item_code)
579 )
580 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530581
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530582 def set_pricing_rule_details(self, item_row, args):
583 pricing_rules = get_applied_pricing_rules(args.get("pricing_rules"))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530584 if not pricing_rules:
585 return
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530586
587 for pricing_rule in pricing_rules:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530588 self.append(
589 "pricing_rules",
590 {
591 "pricing_rule": pricing_rule,
592 "item_code": item_row.item_code,
593 "child_docname": item_row.name,
594 "rule_applied": True,
595 },
596 )
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530597
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530598 def set_taxes(self):
599 if not self.meta.get_field("taxes"):
Anand Doshi3543f302013-05-24 19:25:01 +0530600 return
Anand Doshid2946502014-04-08 20:10:03 +0530601
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530602 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530603
rohitwaghchaure57914f12018-04-24 19:19:47 +0530604 if (self.is_new() or self.is_pos_profile_changed()) and not self.get("taxes"):
rohitwaghchaure505661b2017-12-11 14:52:28 +0530605 if self.company and not self.get("taxes_and_charges"):
Anand Doshi3543f302013-05-24 19:25:01 +0530606 # get the default tax master
Ankush Menat494bd9e2022-03-28 18:52:46 +0530607 self.taxes_and_charges = frappe.db.get_value(
608 tax_master_doctype, {"is_default": 1, "company": self.company}
609 )
Anand Doshid2946502014-04-08 20:10:03 +0530610
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530611 self.append_taxes_from_master(tax_master_doctype)
Anand Doshid2946502014-04-08 20:10:03 +0530612
rohitwaghchaure57914f12018-04-24 19:19:47 +0530613 def is_pos_profile_changed(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530614 if (
615 self.doctype == "Sales Invoice"
616 and self.is_pos
617 and self.pos_profile != frappe.db.get_value("Sales Invoice", self.name, "pos_profile")
618 ):
rohitwaghchaure57914f12018-04-24 19:19:47 +0530619 return True
620
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530621 def append_taxes_from_master(self, tax_master_doctype=None):
622 if self.get("taxes_and_charges"):
Anand Doshi99100a42013-07-04 17:13:53 +0530623 if not tax_master_doctype:
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530624 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530625
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530626 self.extend("taxes", get_taxes_and_charges(tax_master_doctype, self.get("taxes_and_charges")))
Akhilesh Darjee4cdb7992014-01-30 13:56:57 +0530627
Anand Doshiac32bad2014-04-18 01:30:14 +0530628 def set_other_charges(self):
Nabin Haite7d15362014-12-25 16:01:55 +0530629 self.set("taxes", [])
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530630 self.set_taxes()
Anand Doshid2946502014-04-08 20:10:03 +0530631
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530632 def validate_enabled_taxes_and_charges(self):
633 taxes_and_charges_doctype = self.meta.get_options("taxes_and_charges")
634 if frappe.db.get_value(taxes_and_charges_doctype, self.taxes_and_charges, "disabled"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530635 frappe.throw(
636 _("{0} '{1}' is disabled").format(taxes_and_charges_doctype, self.taxes_and_charges)
637 )
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530638
Nabin Haita2426fc2018-01-15 17:45:46 +0530639 def validate_tax_account_company(self):
640 for d in self.get("taxes"):
641 if d.account_head:
642 tax_account_company = frappe.db.get_value("Account", d.account_head, "company")
643 if tax_account_company != self.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530644 frappe.throw(
645 _("Row #{0}: Account {1} does not belong to company {2}").format(
646 d.idx, d.account_head, self.company
647 )
648 )
Nabin Haita2426fc2018-01-15 17:45:46 +0530649
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530650 def get_gl_dict(self, args, account_currency=None, item=None):
Nabin Hait2df4d542013-01-29 11:34:39 +0530651 """this method populates the common properties of a gl entry record"""
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530652
Ankush Menat494bd9e2022-03-28 18:52:46 +0530653 posting_date = args.get("posting_date") or self.get("posting_date")
Rohit Waghchaureaa7b4342018-05-11 01:56:05 +0530654 fiscal_years = get_fiscal_years(posting_date, company=self.company)
Nabin Hait2ed0b592016-03-29 13:14:17 +0530655 if len(fiscal_years) > 1:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530656 frappe.throw(
657 _("Multiple fiscal years exist for the date {0}. Please set company in Fiscal Year").format(
658 formatdate(posting_date)
659 )
660 )
Nabin Hait2ed0b592016-03-29 13:14:17 +0530661 else:
662 fiscal_year = fiscal_years[0][0]
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530663
Ankush Menat494bd9e2022-03-28 18:52:46 +0530664 gl_dict = frappe._dict(
665 {
666 "company": self.company,
667 "posting_date": posting_date,
668 "fiscal_year": fiscal_year,
669 "voucher_type": self.doctype,
670 "voucher_no": self.name,
671 "remarks": self.get("remarks") or self.get("remark"),
672 "debit": 0,
673 "credit": 0,
674 "debit_in_account_currency": 0,
675 "credit_in_account_currency": 0,
676 "is_opening": self.get("is_opening") or "No",
677 "party_type": None,
678 "party": None,
679 "project": self.get("project"),
680 "post_net_value": args.get("post_net_value"),
681 }
682 )
deepeshgarg007d83cf652019-05-12 18:34:23 +0530683
684 accounting_dimensions = get_accounting_dimensions()
685 dimension_dict = frappe._dict()
686
687 for dimension in accounting_dimensions:
688 dimension_dict[dimension] = self.get(dimension)
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530689 if item and item.get(dimension):
690 dimension_dict[dimension] = item.get(dimension)
deepeshgarg007d83cf652019-05-12 18:34:23 +0530691
692 gl_dict.update(dimension_dict)
Nabin Hait2df4d542013-01-29 11:34:39 +0530693 gl_dict.update(args)
Anand Doshi979326b2015-09-11 16:22:37 +0530694
Nabin Hait895029d2015-08-20 14:55:39 +0530695 if not account_currency:
Anand Doshicd0989e2015-09-28 13:31:17 +0530696 account_currency = get_account_currency(gl_dict.account)
Anand Doshi979326b2015-09-11 16:22:37 +0530697
Ankush Menat494bd9e2022-03-28 18:52:46 +0530698 if gl_dict.account and self.doctype not in [
699 "Journal Entry",
700 "Period Closing Voucher",
701 "Payment Entry",
702 "Purchase Receipt",
703 "Purchase Invoice",
704 "Stock Entry",
705 ]:
Anand Doshibe6cfdd2015-09-17 21:07:04 +0530706 self.validate_account_currency(gl_dict.account, account_currency)
Deepesh Garg7c300852020-12-26 20:14:51 +0530707
Ankush Menat494bd9e2022-03-28 18:52:46 +0530708 if gl_dict.account and self.doctype not in [
709 "Journal Entry",
710 "Period Closing Voucher",
711 "Payment Entry",
712 ]:
713 set_balance_in_account_currency(
714 gl_dict, account_currency, self.get("conversion_rate"), self.company_currency
715 )
Anand Doshi979326b2015-09-11 16:22:37 +0530716
Nabin Haitc561a492015-08-19 19:22:34 +0530717 return gl_dict
Anand Doshi979326b2015-09-11 16:22:37 +0530718
Anurag Mishrae657fe82018-11-26 15:19:17 +0530719 def validate_qty_is_not_zero(self):
Maricac68a9402019-12-03 12:59:22 +0530720 if self.doctype != "Purchase Receipt":
721 for item in self.items:
722 if not item.qty:
723 frappe.throw(_("Item quantity can not be zero"))
Anurag Mishrae657fe82018-11-26 15:19:17 +0530724
Nabin Hait895029d2015-08-20 14:55:39 +0530725 def validate_account_currency(self, account, account_currency=None):
Nabin Hait6e439a52015-08-28 19:24:22 +0530726 valid_currency = [self.company_currency]
727 if self.get("currency") and self.currency != self.company_currency:
728 valid_currency.append(self.currency)
729
Nabin Hait895029d2015-08-20 14:55:39 +0530730 if account_currency not in valid_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530731 frappe.throw(
732 _("Account {0} is invalid. Account Currency must be {1}").format(
733 account, (" " + _("or") + " ").join(valid_currency)
734 )
735 )
Anand Doshi979326b2015-09-11 16:22:37 +0530736
Anand Doshi613cb6a2013-02-06 17:33:46 +0530737 def clear_unallocated_advances(self, childtype, parentfield):
Rushabh Mehtaf191f852014-04-02 18:09:34 +0530738 self.set(parentfield, self.get(parentfield, {"allocated_amount": ["not in", [0, None, ""]]}))
739
Ankush Menat494bd9e2022-03-28 18:52:46 +0530740 frappe.db.sql(
741 """delete from `tab%s` where parentfield=%s and parent = %s
742 and allocated_amount = 0"""
743 % (childtype, "%s", "%s"),
744 (parentfield, self.name),
745 )
Anand Doshid2946502014-04-08 20:10:03 +0530746
Walstan Baptistad6360752021-03-31 12:30:32 +0530747 @frappe.whitelist()
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530748 def apply_shipping_rule(self):
749 if self.shipping_rule:
750 shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule)
751 shipping_rule.apply(self)
752 self.calculate_taxes_and_totals()
753
754 def get_shipping_address(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530755 """Returns Address object from shipping address fields if present"""
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530756
757 # shipping address fields can be `shipping_address_name` or `shipping_address`
758 # try getting value from both
759
Ankush Menat494bd9e2022-03-28 18:52:46 +0530760 for fieldname in ("shipping_address_name", "shipping_address"):
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530761 shipping_field = self.meta.get_field(fieldname)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530762 if shipping_field and shipping_field.fieldtype == "Link":
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530763 if self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530764 return frappe.get_doc("Address", self.get(fieldname))
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530765
766 return {}
767
Walstan Baptistad6360752021-03-31 12:30:32 +0530768 @frappe.whitelist()
Nabin Hait041a5c22018-08-01 18:07:39 +0530769 def set_advances(self):
770 """Returns list of advances against Account, Party, Reference"""
771
772 res = self.get_advance_entries()
773
774 self.set("advances", [])
775 advance_allocated = 0
776 for d in res:
777 if d.against_order:
778 allocated_amount = flt(d.amount)
779 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530780 if self.get("party_account_currency") == self.company_currency:
781 amount = self.get("base_rounded_total") or self.base_grand_total
Deepesh Garg26210162020-08-11 16:06:13 +0530782 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530783 amount = self.get("rounded_total") or self.grand_total
Deepesh Garg26210162020-08-11 16:06:13 +0530784
Rohit Waghchaure6cc2f522018-11-27 12:07:03 +0530785 allocated_amount = min(amount - advance_allocated, d.amount)
Nabin Hait041a5c22018-08-01 18:07:39 +0530786 advance_allocated += flt(allocated_amount)
Rushabh Mehta708e47a2018-08-08 16:37:31 +0530787
Saqiba20999c2021-07-12 14:33:23 +0530788 advance_row = {
Nabin Hait041a5c22018-08-01 18:07:39 +0530789 "doctype": self.doctype + " Advance",
790 "reference_type": d.reference_type,
791 "reference_name": d.reference_name,
792 "reference_row": d.reference_row,
793 "remarks": d.remarks,
794 "advance_amount": flt(d.amount),
Saqiba20999c2021-07-12 14:33:23 +0530795 "allocated_amount": allocated_amount,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530796 "ref_exchange_rate": flt(d.exchange_rate), # exchange_rate of advance entry
Saqiba20999c2021-07-12 14:33:23 +0530797 }
798
799 self.append("advances", advance_row)
Nabin Hait041a5c22018-08-01 18:07:39 +0530800
Nabin Hait28a05282016-06-27 17:41:39 +0530801 def get_advance_entries(self, include_unallocated=True):
802 if self.doctype == "Sales Invoice":
803 party_account = self.debit_to
804 party_type = "Customer"
805 party = self.customer
806 amount_field = "credit_in_account_currency"
807 order_field = "sales_order"
808 order_doctype = "Sales Order"
809 else:
810 party_account = self.credit_to
811 party_type = "Supplier"
812 party = self.supplier
813 amount_field = "debit_in_account_currency"
814 order_field = "purchase_order"
815 order_doctype = "Purchase Order"
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530816
Ankush Menat494bd9e2022-03-28 18:52:46 +0530817 order_list = list(set(d.get(order_field) for d in self.get("items") if d.get(order_field)))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530818
Ankush Menat494bd9e2022-03-28 18:52:46 +0530819 journal_entries = get_advance_journal_entries(
820 party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated
821 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530822
Ankush Menat494bd9e2022-03-28 18:52:46 +0530823 payment_entries = get_advance_payment_entries(
824 party_type, party, party_account, order_doctype, order_list, include_unallocated
825 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530826
Nabin Hait28a05282016-06-27 17:41:39 +0530827 res = journal_entries + payment_entries
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530828
Nabin Hait28a05282016-06-27 17:41:39 +0530829 return res
Nabin Hait48f5fa62014-09-18 15:03:54 +0530830
rohitwaghchaurebf4c1142018-01-08 15:20:15 +0530831 def is_inclusive_tax(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530832 is_inclusive = cint(
833 frappe.db.get_single_value("Accounts Settings", "show_inclusive_tax_in_print")
834 )
rohitwaghchaurebf4c1142018-01-08 15:20:15 +0530835
836 if is_inclusive:
837 is_inclusive = 0
838 if self.get("taxes", filters={"included_in_print_rate": 1}):
839 is_inclusive = 1
840
841 return is_inclusive
842
Nabin Hait28a05282016-06-27 17:41:39 +0530843 def validate_advance_entries(self):
Nabin Hait05aefbb2016-06-28 19:42:19 +0530844 order_field = "sales_order" if self.doctype == "Sales Invoice" else "purchase_order"
Ankush Menat494bd9e2022-03-28 18:52:46 +0530845 order_list = list(set(d.get(order_field) for d in self.get("items") if d.get(order_field)))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530846
Ankush Menat494bd9e2022-03-28 18:52:46 +0530847 if not order_list:
848 return
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530849
Nabin Hait28a05282016-06-27 17:41:39 +0530850 advance_entries = self.get_advance_entries(include_unallocated=False)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530851
Nabin Hait28a05282016-06-27 17:41:39 +0530852 if advance_entries:
853 advance_entries_against_si = [d.reference_name for d in self.get("advances")]
854 for d in advance_entries:
855 if not advance_entries_against_si or d.reference_name not in advance_entries_against_si:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530856 frappe.msgprint(
857 _(
858 "Payment Entry {0} is linked against Order {1}, check if it should be pulled as advance in this invoice."
859 ).format(d.reference_name, d.against_order)
860 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530861
Saqiba20999c2021-07-12 14:33:23 +0530862 def set_advance_gain_or_loss(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530863 if self.get("conversion_rate") == 1 or not self.get("advances"):
Saqib Ansari64efe8b2021-09-26 15:46:13 +0530864 return
865
Ankush Menat494bd9e2022-03-28 18:52:46 +0530866 is_purchase_invoice = self.doctype == "Purchase Invoice"
Saqib Ansari64efe8b2021-09-26 15:46:13 +0530867 party_account = self.credit_to if is_purchase_invoice else self.debit_to
868 if get_account_currency(party_account) != self.currency:
Saqiba20999c2021-07-12 14:33:23 +0530869 return
870
871 for d in self.get("advances"):
872 advance_exchange_rate = d.ref_exchange_rate
Ankush Menat494bd9e2022-03-28 18:52:46 +0530873 if d.allocated_amount and self.conversion_rate != advance_exchange_rate:
Saqiba20999c2021-07-12 14:33:23 +0530874
875 base_allocated_amount_in_ref_rate = advance_exchange_rate * d.allocated_amount
876 base_allocated_amount_in_inv_rate = self.conversion_rate * d.allocated_amount
877 difference = base_allocated_amount_in_ref_rate - base_allocated_amount_in_inv_rate
878
879 d.exchange_gain_loss = difference
880
881 def make_exchange_gain_loss_gl_entries(self, gl_entries):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530882 if self.get("doctype") in ["Purchase Invoice", "Sales Invoice"]:
Saqiba20999c2021-07-12 14:33:23 +0530883 for d in self.get("advances"):
884 if d.exchange_gain_loss:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530885 is_purchase_invoice = self.get("doctype") == "Purchase Invoice"
Saqibd4ae1fe2021-07-30 11:21:49 +0530886 party = self.supplier if is_purchase_invoice else self.customer
887 party_account = self.credit_to if is_purchase_invoice else self.debit_to
888 party_type = "Supplier" if is_purchase_invoice else "Customer"
Saqiba20999c2021-07-12 14:33:23 +0530889
Ankush Menat494bd9e2022-03-28 18:52:46 +0530890 gain_loss_account = frappe.db.get_value("Company", self.company, "exchange_gain_loss_account")
Saqibd4ae1fe2021-07-30 11:21:49 +0530891 if not gain_loss_account:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530892 frappe.throw(
893 _("Please set default Exchange Gain/Loss Account in Company {}").format(self.get("company"))
894 )
Saqiba20999c2021-07-12 14:33:23 +0530895 account_currency = get_account_currency(gain_loss_account)
896 if account_currency != self.company_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530897 frappe.throw(
898 _("Currency for {0} must be {1}").format(gain_loss_account, self.company_currency)
899 )
Saqiba20999c2021-07-12 14:33:23 +0530900
901 # for purchase
Ankush Menat494bd9e2022-03-28 18:52:46 +0530902 dr_or_cr = "debit" if d.exchange_gain_loss > 0 else "credit"
Saqibd4ae1fe2021-07-30 11:21:49 +0530903 if not is_purchase_invoice:
904 # just reverse for sales?
Ankush Menat494bd9e2022-03-28 18:52:46 +0530905 dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
Saqiba20999c2021-07-12 14:33:23 +0530906
907 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530908 self.get_gl_dict(
909 {
910 "account": gain_loss_account,
911 "account_currency": account_currency,
912 "against": party,
913 dr_or_cr + "_in_account_currency": abs(d.exchange_gain_loss),
914 dr_or_cr: abs(d.exchange_gain_loss),
915 "cost_center": self.cost_center or erpnext.get_default_cost_center(self.company),
916 "project": self.project,
917 },
918 item=d,
919 )
Saqiba20999c2021-07-12 14:33:23 +0530920 )
921
Ankush Menat494bd9e2022-03-28 18:52:46 +0530922 dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
Saqiba20999c2021-07-12 14:33:23 +0530923
924 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530925 self.get_gl_dict(
926 {
927 "account": party_account,
928 "party_type": party_type,
929 "party": party,
930 "against": gain_loss_account,
931 dr_or_cr + "_in_account_currency": flt(abs(d.exchange_gain_loss) / self.conversion_rate),
932 dr_or_cr: abs(d.exchange_gain_loss),
933 "cost_center": self.cost_center,
934 "project": self.project,
935 },
936 self.party_account_currency,
937 item=self,
938 )
Saqiba20999c2021-07-12 14:33:23 +0530939 )
940
Nabin Hait28a05282016-06-27 17:41:39 +0530941 def update_against_document_in_jv(self):
942 """
Ankush Menat494bd9e2022-03-28 18:52:46 +0530943 Links invoice and advance voucher:
944 1. cancel advance voucher
945 2. split into multiple rows if partially adjusted, assign against voucher
946 3. submit advance voucher
Nabin Hait28a05282016-06-27 17:41:39 +0530947 """
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530948
Nabin Hait28a05282016-06-27 17:41:39 +0530949 if self.doctype == "Sales Invoice":
Nabin Haitff2f3ef2016-07-04 11:41:14 +0530950 party_type = "Customer"
Nabin Hait28a05282016-06-27 17:41:39 +0530951 party = self.customer
952 party_account = self.debit_to
953 dr_or_cr = "credit_in_account_currency"
954 else:
Nabin Haitff2f3ef2016-07-04 11:41:14 +0530955 party_type = "Supplier"
Nabin Hait28a05282016-06-27 17:41:39 +0530956 party = self.supplier
957 party_account = self.credit_to
958 dr_or_cr = "debit_in_account_currency"
Nabin Hait48f5fa62014-09-18 15:03:54 +0530959
Nabin Hait28a05282016-06-27 17:41:39 +0530960 lst = []
Ankush Menat494bd9e2022-03-28 18:52:46 +0530961 for d in self.get("advances"):
Nabin Hait28a05282016-06-27 17:41:39 +0530962 if flt(d.allocated_amount) > 0:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530963 args = frappe._dict(
964 {
965 "voucher_type": d.reference_type,
966 "voucher_no": d.reference_name,
967 "voucher_detail_no": d.reference_row,
968 "against_voucher_type": self.doctype,
969 "against_voucher": self.name,
970 "account": party_account,
971 "party_type": party_type,
972 "party": party,
973 "is_advance": "Yes",
974 "dr_or_cr": dr_or_cr,
975 "unadjusted_amount": flt(d.advance_amount),
976 "allocated_amount": flt(d.allocated_amount),
977 "precision": d.precision("advance_amount"),
978 "exchange_rate": (
979 self.conversion_rate if self.party_account_currency != self.company_currency else 1
980 ),
981 "grand_total": (
982 self.base_grand_total
983 if self.party_account_currency == self.company_currency
984 else self.grand_total
985 ),
986 "outstanding_amount": self.outstanding_amount,
987 "difference_account": frappe.db.get_value(
988 "Company", self.company, "exchange_gain_loss_account"
989 ),
990 "exchange_gain_loss": flt(d.get("exchange_gain_loss")),
991 }
992 )
Nabin Hait28a05282016-06-27 17:41:39 +0530993 lst.append(args)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +0530994
Nabin Hait28a05282016-06-27 17:41:39 +0530995 if lst:
996 from erpnext.accounts.utils import reconcile_against_document
Ankush Menat494bd9e2022-03-28 18:52:46 +0530997
Nabin Hait28a05282016-06-27 17:41:39 +0530998 reconcile_against_document(lst)
Anand Doshid2946502014-04-08 20:10:03 +0530999
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301000 def on_cancel(self):
1001 from erpnext.accounts.utils import unlink_ref_doc_from_payment_entries
1002
1003 if self.doctype in ["Sales Invoice", "Purchase Invoice"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301004 if frappe.db.get_single_value("Accounts Settings", "unlink_payment_on_cancellation_of_invoice"):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301005 unlink_ref_doc_from_payment_entries(self)
1006
1007 elif self.doctype in ["Sales Order", "Purchase Order"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301008 if frappe.db.get_single_value(
1009 "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order"
1010 ):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301011 unlink_ref_doc_from_payment_entries(self)
1012
GangaManoj8396f242021-09-20 19:01:46 +05301013 if self.doctype == "Sales Order":
1014 self.unlink_ref_doc_from_po()
1015
1016 def unlink_ref_doc_from_po(self):
GangaManoj8396f242021-09-20 19:01:46 +05301017 so_items = []
1018 for item in self.items:
1019 so_items.append(item.name)
1020
Ankush Menat494bd9e2022-03-28 18:52:46 +05301021 linked_po = list(
1022 set(
1023 frappe.get_all(
1024 "Purchase Order Item",
1025 filters={
1026 "sales_order": self.name,
1027 "sales_order_item": ["in", so_items],
1028 "docstatus": ["<", 2],
1029 },
1030 pluck="parent",
1031 )
1032 )
1033 )
GangaManoj8396f242021-09-20 19:01:46 +05301034
GangaManoj8396f242021-09-20 19:01:46 +05301035 if linked_po:
GangaManoje77534f2021-09-20 19:01:46 +05301036 frappe.db.set_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301037 "Purchase Order Item",
1038 {"sales_order": self.name, "sales_order_item": ["in", so_items], "docstatus": ["<", 2]},
1039 {"sales_order": None, "sales_order_item": None},
GangaManoje77534f2021-09-20 19:01:46 +05301040 )
GangaManoj8396f242021-09-20 19:01:46 +05301041
1042 frappe.msgprint(_("Purchase Orders {0} are un-linked").format("\n".join(linked_po)))
1043
Deepesh Gargd18dde72020-11-29 21:40:04 +05301044 def get_tax_map(self):
1045 tax_map = {}
Ankush Menat494bd9e2022-03-28 18:52:46 +05301046 for tax in self.get("taxes"):
Deepesh Gargd18dde72020-11-29 21:40:04 +05301047 tax_map.setdefault(tax.account_head, 0.0)
1048 tax_map[tax.account_head] += tax.tax_amount
1049
1050 return tax_map
1051
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301052 def get_amount_and_base_amount(self, item, enable_discount_accounting):
1053 amount = item.net_amount
1054 base_amount = item.base_net_amount
1055
Ankush Menat494bd9e2022-03-28 18:52:46 +05301056 if (
1057 enable_discount_accounting
1058 and self.get("discount_amount")
1059 and self.get("additional_discount_account")
1060 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301061 amount = item.amount
1062 base_amount = item.base_amount
1063
1064 return amount, base_amount
1065
1066 def get_tax_amounts(self, tax, enable_discount_accounting):
1067 amount = tax.tax_amount_after_discount_amount
1068 base_amount = tax.base_tax_amount_after_discount_amount
1069
Ankush Menat494bd9e2022-03-28 18:52:46 +05301070 if (
1071 enable_discount_accounting
1072 and self.get("discount_amount")
1073 and self.get("additional_discount_account")
1074 and self.get("apply_discount_on") == "Grand Total"
1075 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301076 amount = tax.tax_amount
1077 base_amount = tax.base_tax_amount
1078
1079 return amount, base_amount
1080
GangaManoj8f7b0a12021-07-13 03:01:02 +05301081 def make_discount_gl_entries(self, gl_entries):
rahib-hassanf3fa6ac2022-04-20 16:01:12 +05301082 if self.doctype == "Purchase Invoice":
1083 enable_discount_accounting = cint(
1084 frappe.db.get_single_value("Buying Settings", "enable_discount_accounting")
1085 )
1086 elif self.doctype == "Sales Invoice":
1087 enable_discount_accounting = cint(
1088 frappe.db.get_single_value("Selling Settings", "enable_discount_accounting")
1089 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301090
1091 if enable_discount_accounting:
GangaManoj4105e272021-07-20 03:46:02 +05301092 if self.doctype == "Purchase Invoice":
1093 dr_or_cr = "credit"
1094 rev_dr_cr = "debit"
1095 supplier_or_customer = self.supplier
Ankush Menat4551d7d2021-08-19 13:41:10 +05301096
GangaManoj4105e272021-07-20 03:46:02 +05301097 else:
1098 dr_or_cr = "debit"
1099 rev_dr_cr = "credit"
1100 supplier_or_customer = self.customer
1101
GangaManoj8f7b0a12021-07-13 03:01:02 +05301102 for item in self.get("items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301103 if item.get("discount_amount") and item.get("discount_account"):
Deepesh Gargad7bb312021-07-28 11:38:44 +05301104 discount_amount = item.discount_amount * item.qty
GangaManoj8f7b0a12021-07-13 03:01:02 +05301105 if self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301106 income_or_expense_account = (
1107 item.expense_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301108 if (not item.enable_deferred_expense or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301109 else item.deferred_expense_account
1110 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301111 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301112 income_or_expense_account = (
1113 item.income_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301114 if (not item.enable_deferred_revenue or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301115 else item.deferred_revenue_account
1116 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301117
1118 account_currency = get_account_currency(item.discount_account)
1119 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301120 self.get_gl_dict(
1121 {
1122 "account": item.discount_account,
1123 "against": supplier_or_customer,
1124 dr_or_cr: flt(discount_amount, item.precision("discount_amount")),
1125 dr_or_cr
1126 + "_in_account_currency": flt(
1127 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1128 ),
1129 "cost_center": item.cost_center,
1130 "project": item.project,
1131 },
1132 account_currency,
1133 item=item,
1134 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301135 )
1136
1137 account_currency = get_account_currency(income_or_expense_account)
1138 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301139 self.get_gl_dict(
1140 {
1141 "account": income_or_expense_account,
1142 "against": supplier_or_customer,
1143 rev_dr_cr: flt(discount_amount, item.precision("discount_amount")),
1144 rev_dr_cr
1145 + "_in_account_currency": flt(
1146 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1147 ),
1148 "cost_center": item.cost_center,
1149 "project": item.project or self.project,
1150 },
1151 account_currency,
1152 item=item,
1153 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301154 )
GangaManoj857501c2021-07-15 22:03:46 +05301155
Ankush Menat494bd9e2022-03-28 18:52:46 +05301156 if self.get("discount_amount") and self.get("additional_discount_account"):
GangaManoj857501c2021-07-15 22:03:46 +05301157 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301158 self.get_gl_dict(
1159 {
1160 "account": self.additional_discount_account,
1161 "against": supplier_or_customer,
1162 dr_or_cr: self.discount_amount,
1163 "cost_center": self.cost_center,
1164 },
1165 item=self,
1166 )
Ankush Menat4551d7d2021-08-19 13:41:10 +05301167 )
1168
Nabin Hait19d945a2013-07-29 18:35:39 +05301169 def validate_multiple_billing(self, ref_dt, item_ref_dn, based_on, parentfield):
Nabin Hait868766d2019-07-15 18:02:58 +05301170 from erpnext.controllers.status_updater import get_allowance_for
Saqib9c913c92021-11-26 12:00:13 +05301171
Nabin Hait868766d2019-07-15 18:02:58 +05301172 item_allowance = {}
1173 global_qty_allowance, global_amount_allowance = None, None
Anand Doshid2946502014-04-08 20:10:03 +05301174
Ankush Menat494bd9e2022-03-28 18:52:46 +05301175 role_allowed_to_over_bill = frappe.db.get_single_value(
1176 "Accounts Settings", "role_allowed_to_over_bill"
1177 )
Ankush Menat648b2d72021-09-20 15:27:12 +05301178 user_roles = frappe.get_roles()
1179
Ankush Menat43bf82b2021-09-20 16:31:20 +05301180 total_overbilled_amt = 0.0
1181
Nabin Hait4b8185d2014-12-25 18:19:39 +05301182 for item in self.get("items"):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301183 if not item.get(item_ref_dn):
1184 continue
Anand Doshid2946502014-04-08 20:10:03 +05301185
Ankush Menat494bd9e2022-03-28 18:52:46 +05301186 ref_amt = flt(
1187 frappe.db.get_value(ref_dt + " Item", item.get(item_ref_dn), based_on),
1188 self.precision(based_on, item),
1189 )
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301190 if not ref_amt:
1191 frappe.msgprint(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301192 _("System will not check overbilling since amount for Item {0} in {1} is zero").format(
1193 item.item_code, ref_dt
1194 ),
1195 title=_("Warning"),
1196 indicator="orange",
1197 )
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301198 continue
Anand Doshid2946502014-04-08 20:10:03 +05301199
Saqib9c913c92021-11-26 12:00:13 +05301200 already_billed = self.get_billed_amount_for_item(item, item_ref_dn, based_on)
Anand Doshid2946502014-04-08 20:10:03 +05301201
Ankush Menat494bd9e2022-03-28 18:52:46 +05301202 total_billed_amt = flt(
1203 flt(already_billed) + flt(item.get(based_on)), self.precision(based_on, item)
1204 )
Anand Doshid2946502014-04-08 20:10:03 +05301205
Ankush Menat494bd9e2022-03-28 18:52:46 +05301206 allowance, item_allowance, global_qty_allowance, global_amount_allowance = get_allowance_for(
1207 item.item_code, item_allowance, global_qty_allowance, global_amount_allowance, "amount"
1208 )
rohitwaghchaure285344e2019-10-11 11:02:11 +05301209
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301210 max_allowed_amt = flt(ref_amt * (100 + allowance) / 100)
Deepesh Gargcb718fc2021-04-19 13:25:15 +05301211
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301212 if total_billed_amt < 0 and max_allowed_amt < 0:
1213 # while making debit note against purchase return entry(purchase receipt) getting overbill error
1214 total_billed_amt = abs(total_billed_amt)
1215 max_allowed_amt = abs(max_allowed_amt)
Afshan53fefd72021-06-24 10:09:02 +05301216
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301217 overbill_amt = total_billed_amt - max_allowed_amt
1218 total_overbilled_amt += overbill_amt
1219
1220 if overbill_amt > 0.01 and role_allowed_to_over_bill not in user_roles:
1221 if self.doctype != "Purchase Invoice":
1222 self.throw_overbill_exception(item, max_allowed_amt)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301223 elif not cint(
1224 frappe.db.get_single_value(
1225 "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice"
1226 )
1227 ):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301228 self.throw_overbill_exception(item, max_allowed_amt)
1229
1230 if role_allowed_to_over_bill in user_roles and total_overbilled_amt > 0.1:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301231 frappe.msgprint(
1232 _("Overbilling of {} ignored because you have {} role.").format(
1233 total_overbilled_amt, role_allowed_to_over_bill
1234 ),
1235 indicator="orange",
1236 alert=True,
1237 )
Afshan53fefd72021-06-24 10:09:02 +05301238
Saqib9c913c92021-11-26 12:00:13 +05301239 def get_billed_amount_for_item(self, item, item_ref_dn, based_on):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301240 """
1241 Returns Sum of Amount of
1242 Sales/Purchase Invoice Items
1243 that are linked to `item_ref_dn` (`dn_detail` / `pr_detail`)
1244 that are submitted OR not submitted but are under current invoice
1245 """
Saqib9c913c92021-11-26 12:00:13 +05301246
1247 from frappe.query_builder import Criterion
1248 from frappe.query_builder.functions import Sum
1249
1250 item_doctype = frappe.qb.DocType(item.doctype)
1251 based_on_field = frappe.qb.Field(based_on)
1252 join_field = frappe.qb.Field(item_ref_dn)
1253
1254 result = (
1255 frappe.qb.from_(item_doctype)
1256 .select(Sum(based_on_field))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301257 .where(join_field == item.get(item_ref_dn))
Saqib9c913c92021-11-26 12:00:13 +05301258 .where(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301259 Criterion.any(
1260 [ # select all items from other invoices OR current invoices
1261 Criterion.all(
1262 [ # for selecting items from other invoices
1263 item_doctype.docstatus == 1,
1264 item_doctype.parent != self.name,
1265 ]
1266 ),
1267 Criterion.all(
1268 [ # for selecting items from current invoice, that are linked to same reference
1269 item_doctype.docstatus == 0,
1270 item_doctype.parent == self.name,
1271 item_doctype.name != item.name,
1272 ]
1273 ),
1274 ]
1275 )
Saqib9c913c92021-11-26 12:00:13 +05301276 )
1277 ).run()
1278
1279 return result[0][0] if result else 0
1280
Afshan53fefd72021-06-24 10:09:02 +05301281 def throw_overbill_exception(self, item, max_allowed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301282 frappe.throw(
1283 _(
1284 "Cannot overbill for Item {0} in row {1} more than {2}. To allow over-billing, please set allowance in Accounts Settings"
1285 ).format(item.item_code, item.idx, max_allowed_amt)
1286 )
Anand Doshid2946502014-04-08 20:10:03 +05301287
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301288 def get_company_default(self, fieldname, ignore_validation=False):
Rushabh Mehta1f847992013-12-12 19:12:19 +05301289 from erpnext.accounts.utils import get_company_default
Ankush Menat494bd9e2022-03-28 18:52:46 +05301290
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301291 return get_company_default(self.company, fieldname, ignore_validation=ignore_validation)
Anand Doshid2946502014-04-08 20:10:03 +05301292
Nabin Haita36adbd2013-08-02 14:50:12 +05301293 def get_stock_items(self):
1294 stock_items = []
Nabin Haitdd38a262014-12-26 13:15:21 +05301295 item_codes = list(set(item.item_code for item in self.get("items")))
Nabin Haita36adbd2013-08-02 14:50:12 +05301296 if item_codes:
Saqib Ansari199a6da2022-03-31 11:41:52 +05301297 stock_items = frappe.db.get_values(
1298 "Item", {"name": ["in", item_codes], "is_stock_item": 1}, pluck="name", cache=True
1299 )
Anand Doshid2946502014-04-08 20:10:03 +05301300
Nabin Haita36adbd2013-08-02 14:50:12 +05301301 return stock_items
Anand Doshid2946502014-04-08 20:10:03 +05301302
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301303 def set_total_advance_paid(self):
1304 if self.doctype == "Sales Order":
Nabin Hait6e439a52015-08-28 19:24:22 +05301305 dr_or_cr = "credit_in_account_currency"
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301306 rev_dr_or_cr = "debit_in_account_currency"
Nabin Haitb2206d12016-01-27 15:43:12 +05301307 party = self.customer
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301308 else:
Nabin Hait6e439a52015-08-28 19:24:22 +05301309 dr_or_cr = "debit_in_account_currency"
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301310 rev_dr_or_cr = "credit_in_account_currency"
Nabin Haitb2206d12016-01-27 15:43:12 +05301311 party = self.supplier
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301312
Ankush Menat494bd9e2022-03-28 18:52:46 +05301313 advance = frappe.db.sql(
1314 """
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301315 select
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301316 account_currency, sum({dr_or_cr}) - sum({rev_dr_cr}) as amount
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301317 from
Nabin Hait12e2a512016-06-26 01:37:21 +05301318 `tabGL Entry`
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301319 where
Nabin Hait12e2a512016-06-26 01:37:21 +05301320 against_voucher_type = %s and against_voucher = %s and party=%s
1321 and docstatus = 1
Ankush Menat494bd9e2022-03-28 18:52:46 +05301322 """.format(
1323 dr_or_cr=dr_or_cr, rev_dr_cr=rev_dr_or_cr
1324 ),
1325 (self.doctype, self.name, party),
1326 as_dict=1,
1327 ) # nosec
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301328
Nabin Haitb2206d12016-01-27 15:43:12 +05301329 if advance:
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301330 advance = advance[0]
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301331
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301332 advance_paid = flt(advance.amount, self.precision("advance_paid"))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301333 formatted_advance_paid = fmt_money(
1334 advance_paid, precision=self.precision("advance_paid"), currency=advance.account_currency
1335 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301336
Ankush Menat494bd9e2022-03-28 18:52:46 +05301337 frappe.db.set_value(self.doctype, self.name, "party_account_currency", advance.account_currency)
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301338
1339 if advance.account_currency == self.currency:
finbyz5efc7972019-01-05 11:12:11 +05301340 order_total = self.get("rounded_total") or self.grand_total
1341 precision = "rounded_total" if self.get("rounded_total") else "grand_total"
Nabin Haitb2206d12016-01-27 15:43:12 +05301342 else:
finbyz5efc7972019-01-05 11:12:11 +05301343 order_total = self.get("base_rounded_total") or self.base_grand_total
1344 precision = "base_rounded_total" if self.get("base_rounded_total") else "base_grand_total"
Sagar Voraf733a392019-01-07 14:24:01 +05301345
Ankush Menat494bd9e2022-03-28 18:52:46 +05301346 formatted_order_total = fmt_money(
1347 order_total, precision=self.precision(precision), currency=advance.account_currency
1348 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301349
Nabin Hait9db1b222016-06-30 12:37:53 +05301350 if self.currency == self.company_currency and advance_paid > order_total:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301351 frappe.throw(
1352 _(
1353 "Total advance ({0}) against Order {1} cannot be greater than the Grand Total ({2})"
1354 ).format(formatted_advance_paid, self.name, formatted_order_total)
1355 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301356
Nabin Hait13093b42016-06-29 18:04:37 +05301357 frappe.db.set_value(self.doctype, self.name, "advance_paid", advance_paid)
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301358
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301359 @property
1360 def company_abbr(self):
Nabin Hait6a5695f2018-08-09 11:30:21 +05301361 if not hasattr(self, "_abbr"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301362 self._abbr = frappe.db.get_value("Company", self.company, "abbr")
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301363
1364 return self._abbr
1365
marination4be5b5c2020-10-08 19:08:27 +05301366 def raise_missing_debit_credit_account_error(self, party_type, party):
marination53b1a9a2020-11-03 15:45:25 +05301367 """Raise an error if debit to/credit to account does not exist."""
Ankush Menat494bd9e2022-03-28 18:52:46 +05301368 db_or_cr = (
1369 frappe.bold("Debit To") if self.doctype == "Sales Invoice" else frappe.bold("Credit To")
1370 )
marination4be5b5c2020-10-08 19:08:27 +05301371 rec_or_pay = "Receivable" if self.doctype == "Sales Invoice" else "Payable"
1372
1373 link_to_party = frappe.utils.get_link_to_form(party_type, party)
1374 link_to_company = frappe.utils.get_link_to_form("Company", self.company)
1375
Ankush Menat494bd9e2022-03-28 18:52:46 +05301376 message = _("{0} Account not found against Customer {1}.").format(
1377 db_or_cr, frappe.bold(party) or ""
1378 )
marination4be5b5c2020-10-08 19:08:27 +05301379 message += "<br>" + _("Please set one of the following:") + "<br>"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301380 message += (
1381 "<br><ul><li>"
1382 + _("'Account' in the Accounting section of Customer {0}").format(link_to_party)
1383 + "</li>"
1384 )
1385 message += (
1386 "<li>"
1387 + _("'Default {0} Account' in Company {1}").format(rec_or_pay, link_to_company)
1388 + "</li></ul>"
1389 )
marination4be5b5c2020-10-08 19:08:27 +05301390
marination53b1a9a2020-11-03 15:45:25 +05301391 frappe.throw(message, title=_("Account Missing"), exc=AccountMissingError)
marination4be5b5c2020-10-08 19:08:27 +05301392
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301393 def validate_party(self):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301394 party_type, party = self.get_party()
shreyaseba9ca42016-01-26 14:56:52 +05301395 validate_party_frozen_disabled(party_type, party)
Anand Doshi979326b2015-09-11 16:22:37 +05301396
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301397 def get_party(self):
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301398 party_type = None
shreyas29b565f2016-01-25 17:30:49 +05301399 if self.doctype in ("Opportunity", "Quotation", "Sales Order", "Delivery Note", "Sales Invoice"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301400 party_type = "Customer"
shreyas29b565f2016-01-25 17:30:49 +05301401
Ankush Menat494bd9e2022-03-28 18:52:46 +05301402 elif self.doctype in (
1403 "Supplier Quotation",
1404 "Purchase Order",
1405 "Purchase Receipt",
1406 "Purchase Invoice",
1407 ):
1408 party_type = "Supplier"
shreyas29b565f2016-01-25 17:30:49 +05301409
1410 elif self.meta.get_field("customer"):
1411 party_type = "Customer"
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301412
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301413 elif self.meta.get_field("supplier"):
shreyas29b565f2016-01-25 17:30:49 +05301414 party_type = "Supplier"
Anand Doshi979326b2015-09-11 16:22:37 +05301415
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301416 party = self.get(party_type.lower()) if party_type else None
Anand Doshi979326b2015-09-11 16:22:37 +05301417
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301418 return party_type, party
Anand Doshi979326b2015-09-11 16:22:37 +05301419
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301420 def validate_currency(self):
Nabin Hait6e439a52015-08-28 19:24:22 +05301421 if self.get("currency"):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301422 party_type, party = self.get_party()
Nabin Hait6e439a52015-08-28 19:24:22 +05301423 if party_type and party:
Anand Doshib20baf82015-09-25 16:17:50 +05301424 party_account_currency = get_party_account_currency(party_type, party, self.company)
Anand Doshi979326b2015-09-11 16:22:37 +05301425
Ankush Menat494bd9e2022-03-28 18:52:46 +05301426 if (
1427 party_account_currency
1428 and party_account_currency != self.company_currency
1429 and self.currency != party_account_currency
1430 ):
1431 frappe.throw(
1432 _("Accounting Entry for {0}: {1} can only be made in currency: {2}").format(
1433 party_type, party, party_account_currency
1434 ),
1435 InvalidCurrency,
1436 )
Anand Doshi979326b2015-09-11 16:22:37 +05301437
shreyas29b565f2016-01-25 17:30:49 +05301438 # Note: not validating with gle account because we don't have the account
1439 # at quotation / sales order level and we shouldn't stop someone
1440 # from creating a sales invoice if sales order is already created
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +05301441
Nabin Hait297d74a2016-11-23 15:58:51 +05301442 def delink_advance_entries(self, linked_doc_name):
1443 total_allocated_amount = 0
1444 for adv in self.advances:
1445 consider_for_total_advance = True
1446 if adv.reference_name == linked_doc_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301447 frappe.db.sql(
1448 """delete from `tab{0} Advance`
1449 where name = %s""".format(
1450 self.doctype
1451 ),
1452 adv.name,
1453 )
Nabin Hait297d74a2016-11-23 15:58:51 +05301454 consider_for_total_advance = False
1455
1456 if consider_for_total_advance:
1457 total_allocated_amount += flt(adv.allocated_amount, adv.precision("allocated_amount"))
1458
Ankush Menat494bd9e2022-03-28 18:52:46 +05301459 frappe.db.set_value(
1460 self.doctype, self.name, "total_advance", total_allocated_amount, update_modified=False
1461 )
Rohit Waghchaure6087fe12016-04-09 14:31:09 +05301462
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301463 def group_similar_items(self):
1464 group_item_qty = {}
1465 group_item_amount = {}
Shreya Shah785f1aa2018-10-11 10:14:25 +05301466 # to update serial number in print
1467 count = 0
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301468
1469 for item in self.items:
1470 group_item_qty[item.item_code] = group_item_qty.get(item.item_code, 0) + item.qty
1471 group_item_amount[item.item_code] = group_item_amount.get(item.item_code, 0) + item.amount
1472
1473 duplicate_list = []
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301474 for item in self.items:
1475 if item.item_code in group_item_qty:
Shreya Shah785f1aa2018-10-11 10:14:25 +05301476 count += 1
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301477 item.qty = group_item_qty[item.item_code]
1478 item.amount = group_item_amount[item.item_code]
deepeshgarg007e8d21cd2019-06-24 17:46:44 +05301479
1480 if item.qty:
1481 item.rate = flt(flt(item.amount) / flt(item.qty), item.precision("rate"))
1482 else:
1483 item.rate = 0
1484
Shreya Shah785f1aa2018-10-11 10:14:25 +05301485 item.idx = count
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301486 del group_item_qty[item.item_code]
1487 else:
1488 duplicate_list.append(item)
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301489 for item in duplicate_list:
1490 self.remove(item)
1491
tunde32aa7c12017-09-07 06:52:15 +01001492 def set_payment_schedule(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301493 if self.doctype == "Sales Invoice" and self.is_pos:
1494 self.payment_terms_template = ""
Manas Solankia7f55892018-04-02 10:32:00 +05301495 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05301496
Ankush Menat494bd9e2022-03-28 18:52:46 +05301497 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05301498 if not party_account_currency:
1499 party_type, party = self.get_party()
1500
1501 if party_type and party:
1502 party_account_currency = get_party_account_currency(party_type, party, self.company)
1503
rohitwaghchaureda941af2018-01-17 16:23:04 +05301504 posting_date = self.get("bill_date") or self.get("posting_date") or self.get("transaction_date")
tundedf3a1752017-09-11 11:02:57 +01001505 date = self.get("due_date")
1506 due_date = date or posting_date
Deepesh Garg26210162020-08-11 16:06:13 +05301507
Saqib Ansarid552fe62021-04-23 14:46:52 +05301508 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
1509 grand_total = self.get("rounded_total") or self.grand_total
Deepesh Garg26210162020-08-11 16:06:13 +05301510
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301511 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301512 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301513 grand_total = grand_total - flt(self.write_off_amount)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301514 po_or_so, doctype, fieldname = self.get_order_details()
Ankush Menat494bd9e2022-03-28 18:52:46 +05301515 automatically_fetch_payment_terms = cint(
1516 frappe.db.get_single_value("Accounts Settings", "automatically_fetch_payment_terms")
1517 )
tunde96b8f222017-09-08 15:35:59 +01001518
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301519 if self.get("total_advance"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301520 if party_account_currency == self.company_currency:
1521 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301522 grand_total = flt(
1523 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
1524 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05301525 else:
1526 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301527 base_grand_total = flt(
1528 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
1529 )
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301530
Nabin Hait0551f7b2017-11-21 19:58:16 +05301531 if not self.get("payment_schedule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301532 if (
1533 self.doctype in ["Sales Invoice", "Purchase Invoice"]
1534 and automatically_fetch_payment_terms
1535 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
1536 ):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301537 self.fetch_payment_terms_from_order(po_or_so, doctype)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301538 if self.get("payment_terms_template"):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301539 self.ignore_default_payment_terms_template = 1
1540 elif self.get("payment_terms_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301541 data = get_payment_terms(
1542 self.payment_terms_template, posting_date, grand_total, base_grand_total
1543 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05301544 for item in data:
1545 self.append("payment_schedule", item)
GangaManoj4323f4b2021-07-22 05:57:42 +05301546 elif self.doctype not in ["Purchase Receipt"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301547 data = dict(
1548 due_date=due_date,
1549 invoice_portion=100,
1550 payment_amount=grand_total,
1551 base_payment_amount=base_grand_total,
1552 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05301553 self.append("payment_schedule", data)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301554
1555 for d in self.get("payment_schedule"):
1556 if d.invoice_portion:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301557 d.payment_amount = flt(
1558 grand_total * flt(d.invoice_portion / 100), d.precision("payment_amount")
1559 )
1560 d.base_payment_amount = flt(
1561 base_grand_total * flt(d.invoice_portion / 100), d.precision("base_payment_amount")
1562 )
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301563 d.outstanding = d.payment_amount
1564 elif not d.invoice_portion:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301565 d.base_payment_amount = flt(
1566 d.payment_amount * self.get("conversion_rate"), d.precision("base_payment_amount")
1567 )
tunde43870aa2017-08-18 11:59:30 +01001568
GangaManoj4323f4b2021-07-22 05:57:42 +05301569 def get_order_details(self):
1570 if self.doctype == "Sales Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301571 po_or_so = self.get("items")[0].get("sales_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05301572 po_or_so_doctype = "Sales Order"
1573 po_or_so_doctype_name = "sales_order"
1574
tunde43870aa2017-08-18 11:59:30 +01001575 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301576 po_or_so = self.get("items")[0].get("purchase_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05301577 po_or_so_doctype = "Purchase Order"
1578 po_or_so_doctype_name = "purchase_order"
Ankush Menat4551d7d2021-08-19 13:41:10 +05301579
GangaManoj4323f4b2021-07-22 05:57:42 +05301580 return po_or_so, po_or_so_doctype, po_or_so_doctype_name
1581
GangaManojc7c90242021-07-29 19:18:35 +05301582 def linked_order_has_payment_terms(self, po_or_so, fieldname, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05301583 if po_or_so and self.all_items_have_same_po_or_so(po_or_so, fieldname):
GangaManojc7c90242021-07-29 19:18:35 +05301584 if self.linked_order_has_payment_terms_template(po_or_so, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05301585 return True
1586 elif self.linked_order_has_payment_schedule(po_or_so):
1587 return True
Ankush Menat4551d7d2021-08-19 13:41:10 +05301588
GangaManoj4323f4b2021-07-22 05:57:42 +05301589 return False
1590
1591 def all_items_have_same_po_or_so(self, po_or_so, fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301592 for item in self.get("items"):
GangaManoj4323f4b2021-07-22 05:57:42 +05301593 if item.get(fieldname) != po_or_so:
1594 return False
Ankush Menat4551d7d2021-08-19 13:41:10 +05301595
GangaManoj4323f4b2021-07-22 05:57:42 +05301596 return True
1597
GangaManojc7c90242021-07-29 19:18:35 +05301598 def linked_order_has_payment_terms_template(self, po_or_so, doctype):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301599 return frappe.get_value(doctype, po_or_so, "payment_terms_template")
GangaManoj4323f4b2021-07-22 05:57:42 +05301600
1601 def linked_order_has_payment_schedule(self, po_or_so):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301602 return frappe.get_all("Payment Schedule", filters={"parent": po_or_so})
GangaManoj4323f4b2021-07-22 05:57:42 +05301603
1604 def fetch_payment_terms_from_order(self, po_or_so, po_or_so_doctype):
1605 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301606 Fetch Payment Terms from Purchase/Sales Order on creating a new Purchase/Sales Invoice.
GangaManoj4323f4b2021-07-22 05:57:42 +05301607 """
1608 po_or_so = frappe.get_cached_doc(po_or_so_doctype, po_or_so)
1609
1610 self.payment_schedule = []
1611 self.payment_terms_template = po_or_so.payment_terms_template
1612
1613 for schedule in po_or_so.payment_schedule:
1614 payment_schedule = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05301615 "payment_term": schedule.payment_term,
1616 "due_date": schedule.due_date,
1617 "invoice_portion": schedule.invoice_portion,
1618 "mode_of_payment": schedule.mode_of_payment,
1619 "description": schedule.description,
GangaManoj4323f4b2021-07-22 05:57:42 +05301620 }
GangaManoj5b33e752021-08-05 21:50:09 +05301621
Ankush Menat494bd9e2022-03-28 18:52:46 +05301622 if schedule.discount_type == "Percentage":
1623 payment_schedule["discount_type"] = schedule.discount_type
1624 payment_schedule["discount"] = schedule.discount
GangaManoj5b33e752021-08-05 21:50:09 +05301625
ruthra kumar9bd56b02022-02-01 14:14:04 +05301626 if not schedule.invoice_portion:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301627 payment_schedule["payment_amount"] = schedule.payment_amount
ruthra kumar9bd56b02022-02-01 14:14:04 +05301628
GangaManoj4323f4b2021-07-22 05:57:42 +05301629 self.append("payment_schedule", payment_schedule)
tunde43870aa2017-08-18 11:59:30 +01001630
tundebe1b8712017-08-19 08:21:44 +01001631 def set_due_date(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +05301632 due_dates = [d.due_date for d in self.get("payment_schedule") if d.due_date]
1633 if due_dates:
1634 self.due_date = max(due_dates)
tunde62af5c52017-09-22 15:16:38 +01001635
1636 def validate_payment_schedule_dates(self):
tunde77ecacc2017-09-22 23:12:55 +01001637 dates = []
tunde9bed2de2017-09-25 10:19:35 +01001638 li = []
tunde43870aa2017-08-18 11:59:30 +01001639
Ankush Menat494bd9e2022-03-28 18:52:46 +05301640 if self.doctype == "Sales Invoice" and self.is_pos:
1641 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05301642
tunde43870aa2017-08-18 11:59:30 +01001643 for d in self.get("payment_schedule"):
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301644 if self.doctype == "Sales Order" and getdate(d.due_date) < getdate(self.transaction_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301645 frappe.throw(
1646 _("Row {0}: Due Date in the Payment Terms table cannot be before Posting Date").format(d.idx)
1647 )
tunde77ecacc2017-09-22 23:12:55 +01001648 elif d.due_date in dates:
mnatalia5f0e8d62018-05-22 06:38:50 +03001649 li.append(_("{0} in row {1}").format(d.due_date, d.idx))
tunde9bed2de2017-09-25 10:19:35 +01001650 dates.append(d.due_date)
1651
1652 if li:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301653 duplicates = "<br>" + "<br>".join(li)
1654 frappe.throw(
1655 _("Rows with duplicate due dates in other rows were found: {0}").format(duplicates)
1656 )
tunde43870aa2017-08-18 11:59:30 +01001657
tunde62af5c52017-09-22 15:16:38 +01001658 def validate_payment_schedule_amount(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301659 if self.doctype == "Sales Invoice" and self.is_pos:
1660 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05301661
Ankush Menat494bd9e2022-03-28 18:52:46 +05301662 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05301663 if not party_account_currency:
1664 party_type, party = self.get_party()
1665
1666 if party_type and party:
1667 party_account_currency = get_party_account_currency(party_type, party, self.company)
1668
Nabin Hait0551f7b2017-11-21 19:58:16 +05301669 if self.get("payment_schedule"):
1670 total = 0
Saqib Ansarid552fe62021-04-23 14:46:52 +05301671 base_total = 0
Nabin Hait0551f7b2017-11-21 19:58:16 +05301672 for d in self.get("payment_schedule"):
Deepesh Garg9c170522021-10-25 20:06:24 +05301673 total += flt(d.payment_amount, d.precision("payment_amount"))
1674 base_total += flt(d.base_payment_amount, d.precision("base_payment_amount"))
tunde43870aa2017-08-18 11:59:30 +01001675
Saqib Ansarid552fe62021-04-23 14:46:52 +05301676 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
1677 grand_total = self.get("rounded_total") or self.grand_total
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301678
Nabin Haite591c852017-12-21 11:46:30 +05301679 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301680 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Haite591c852017-12-21 11:46:30 +05301681 grand_total = grand_total - flt(self.write_off_amount)
Saqib Ansarid552fe62021-04-23 14:46:52 +05301682
1683 if self.get("total_advance"):
1684 if party_account_currency == self.company_currency:
1685 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301686 grand_total = flt(
1687 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
1688 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05301689 else:
1690 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301691 base_grand_total = flt(
1692 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
1693 )
Deepesh Garg9c170522021-10-25 20:06:24 +05301694
Ankush Menat494bd9e2022-03-28 18:52:46 +05301695 if (
1696 flt(total, self.precision("grand_total")) - flt(grand_total, self.precision("grand_total"))
1697 > 0.1
1698 or flt(base_total, self.precision("base_grand_total"))
1699 - flt(base_grand_total, self.precision("base_grand_total"))
1700 > 0.1
1701 ):
1702 frappe.throw(
1703 _("Total Payment Amount in Payment Schedule must be equal to Grand / Rounded Total")
1704 )
tunde43870aa2017-08-18 11:59:30 +01001705
Nabin Hait877e1bb2017-11-17 12:27:43 +05301706 def is_rounded_total_disabled(self):
1707 if self.meta.get_field("disable_rounded_total"):
1708 return self.disable_rounded_total
1709 else:
1710 return frappe.db.get_single_value("Global Defaults", "disable_rounded_total")
1711
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05301712 def set_inter_company_account(self):
1713 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301714 Set intercompany account for inter warehouse transactions
1715 This account will be used in case billing company and internal customer's
1716 representation company is same
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05301717 """
1718
1719 if self.is_internal_transfer() and not self.unrealized_profit_loss_account:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301720 unrealized_profit_loss_account = frappe.db.get_value(
1721 "Company", self.company, "unrealized_profit_loss_account"
1722 )
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05301723
1724 if not unrealized_profit_loss_account:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301725 msg = _(
1726 "Please select Unrealized Profit / Loss account or add default Unrealized Profit / Loss account account for company {0}"
1727 ).format(frappe.bold(self.company))
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05301728 frappe.throw(msg)
1729
1730 self.unrealized_profit_loss_account = unrealized_profit_loss_account
1731
1732 def is_internal_transfer(self):
1733 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301734 It will an internal transfer if its an internal customer and representation
1735 company is same as billing company
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05301736 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301737 if self.doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
1738 internal_party_field = "is_internal_customer"
1739 elif self.doctype in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"):
1740 internal_party_field = "is_internal_supplier"
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05301741
1742 if self.get(internal_party_field) and (self.represents_company == self.company):
1743 return True
1744
1745 return False
1746
Saqib Ansari977b09b2021-08-19 17:57:30 +05301747 def process_common_party_accounting(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301748 is_invoice = self.doctype in ["Sales Invoice", "Purchase Invoice"]
Saqib Ansari977b09b2021-08-19 17:57:30 +05301749 if not is_invoice:
1750 return
1751
Ankush Menat494bd9e2022-03-28 18:52:46 +05301752 if frappe.db.get_single_value("Accounts Settings", "enable_common_party_accounting"):
Saqib Ansari977b09b2021-08-19 17:57:30 +05301753 party_link = self.get_common_party_link()
1754 if party_link and self.outstanding_amount:
1755 self.create_advance_and_reconcile(party_link)
1756
1757 def get_common_party_link(self):
1758 party_type, party = self.get_party()
Saqib Ansari72543682021-08-25 20:15:23 +05301759 return frappe.db.get_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301760 doctype="Party Link",
1761 filters={"secondary_role": party_type, "secondary_party": party},
1762 fieldname=["primary_role", "primary_party"],
1763 as_dict=True,
Saqib Ansari72543682021-08-25 20:15:23 +05301764 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05301765
1766 def create_advance_and_reconcile(self, party_link):
1767 secondary_party_type, secondary_party = self.get_party()
1768 primary_party_type, primary_party = party_link.primary_role, party_link.primary_party
1769
1770 primary_account = get_party_account(primary_party_type, primary_party, self.company)
1771 secondary_account = get_party_account(secondary_party_type, secondary_party, self.company)
1772
Ankush Menat494bd9e2022-03-28 18:52:46 +05301773 jv = frappe.new_doc("Journal Entry")
1774 jv.voucher_type = "Journal Entry"
Saqib Ansari977b09b2021-08-19 17:57:30 +05301775 jv.posting_date = self.posting_date
1776 jv.company = self.company
Ankush Menat494bd9e2022-03-28 18:52:46 +05301777 jv.remark = "Adjustment for {} {}".format(self.doctype, self.name)
Saqib Ansari977b09b2021-08-19 17:57:30 +05301778
1779 reconcilation_entry = frappe._dict()
1780 advance_entry = frappe._dict()
Saqib Ansari977b09b2021-08-19 17:57:30 +05301781
1782 reconcilation_entry.account = secondary_account
1783 reconcilation_entry.party_type = secondary_party_type
1784 reconcilation_entry.party = secondary_party
1785 reconcilation_entry.reference_type = self.doctype
1786 reconcilation_entry.reference_name = self.name
Saqib Ansaric6c7a8b2021-08-25 20:17:04 +05301787 reconcilation_entry.cost_center = self.cost_center
Saqib Ansari977b09b2021-08-19 17:57:30 +05301788
1789 advance_entry.account = primary_account
1790 advance_entry.party_type = primary_party_type
1791 advance_entry.party = primary_party
Saqib Ansaric6c7a8b2021-08-25 20:17:04 +05301792 advance_entry.cost_center = self.cost_center
Ankush Menat494bd9e2022-03-28 18:52:46 +05301793 advance_entry.is_advance = "Yes"
Saqib Ansari977b09b2021-08-19 17:57:30 +05301794
Ankush Menat494bd9e2022-03-28 18:52:46 +05301795 if self.doctype == "Sales Invoice":
Saqib Ansari977b09b2021-08-19 17:57:30 +05301796 reconcilation_entry.credit_in_account_currency = self.outstanding_amount
1797 advance_entry.debit_in_account_currency = self.outstanding_amount
1798 else:
1799 advance_entry.credit_in_account_currency = self.outstanding_amount
1800 reconcilation_entry.debit_in_account_currency = self.outstanding_amount
1801
Ankush Menat494bd9e2022-03-28 18:52:46 +05301802 jv.append("accounts", reconcilation_entry)
1803 jv.append("accounts", advance_entry)
Saqib Ansari977b09b2021-08-19 17:57:30 +05301804
1805 jv.save()
1806 jv.submit()
1807
Ankush Menat494bd9e2022-03-28 18:52:46 +05301808
Rushabh Mehta793ba6b2014-02-14 15:47:51 +05301809@frappe.whitelist()
Rushabh Mehtaf56d73c2013-10-10 16:35:09 +05301810def get_tax_rate(account_head):
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +05301811 return frappe.db.get_value("Account", account_head, ["tax_rate", "account_name"], as_dict=True)
Rushabh Mehtaa33d4682015-06-01 17:15:42 +05301812
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08001813
Nabin Haitffc7f3f2015-05-12 15:07:02 +05301814@frappe.whitelist()
Nabin Haita2426fc2018-01-15 17:45:46 +05301815def get_default_taxes_and_charges(master_doctype, tax_template=None, company=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301816 if not company:
1817 return {}
rohitwaghchaure505661b2017-12-11 14:52:28 +05301818
Nabin Haita2426fc2018-01-15 17:45:46 +05301819 if tax_template and company:
1820 tax_template_company = frappe.db.get_value(master_doctype, tax_template, "company")
1821 if tax_template_company == company:
1822 return
1823
1824 default_tax = frappe.db.get_value(master_doctype, {"is_default": 1, "company": company})
rohitwaghchaure505661b2017-12-11 14:52:28 +05301825
Rushabh Mehta98aa5812017-11-14 09:32:32 +05301826 return {
Ankush Menat494bd9e2022-03-28 18:52:46 +05301827 "taxes_and_charges": default_tax,
1828 "taxes": get_taxes_and_charges(master_doctype, default_tax),
Rushabh Mehta98aa5812017-11-14 09:32:32 +05301829 }
Nabin Hait6b039142014-05-02 15:45:10 +05301830
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08001831
Nabin Hait6b039142014-05-02 15:45:10 +05301832@frappe.whitelist()
Nabin Haitffc7f3f2015-05-12 15:07:02 +05301833def get_taxes_and_charges(master_doctype, master_name):
Nabin Hait1fe50122015-05-16 12:14:39 +05301834 if not master_name:
1835 return
Nabin Hait6b039142014-05-02 15:45:10 +05301836 from frappe.model import default_fields
Ankush Menat494bd9e2022-03-28 18:52:46 +05301837
Nabin Hait6b039142014-05-02 15:45:10 +05301838 tax_master = frappe.get_doc(master_doctype, master_name)
1839
1840 taxes_and_charges = []
Nabin Haitffc7f3f2015-05-12 15:07:02 +05301841 for i, tax in enumerate(tax_master.get("taxes")):
Nabin Hait6b039142014-05-02 15:45:10 +05301842 tax = tax.as_dict()
1843
1844 for fieldname in default_fields:
1845 if fieldname in tax:
1846 del tax[fieldname]
1847
1848 taxes_and_charges.append(tax)
1849
1850 return taxes_and_charges
Rushabh Mehta66e08e32014-09-29 12:17:03 +05301851
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08001852
Rushabh Mehta66e08e32014-09-29 12:17:03 +05301853def validate_conversion_rate(currency, conversion_rate, conversion_rate_label, company):
1854 """common validation for currency and price list currency"""
1855
Ankush Menat494bd9e2022-03-28 18:52:46 +05301856 company_currency = frappe.get_cached_value("Company", company, "default_currency")
Rushabh Mehta66e08e32014-09-29 12:17:03 +05301857
1858 if not conversion_rate:
Saqib60212ff2020-10-26 11:17:04 +05301859 throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301860 _("{0} is mandatory. Maybe Currency Exchange record is not created for {1} to {2}.").format(
1861 conversion_rate_label, currency, company_currency
1862 )
Saqib60212ff2020-10-26 11:17:04 +05301863 )
Nabin Hait613d0812015-02-23 11:58:15 +05301864
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08001865
Nabin Hait613d0812015-02-23 11:58:15 +05301866def validate_taxes_and_charges(tax):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301867 if tax.charge_type in ["Actual", "On Net Total", "On Paid Amount"] and tax.row_id:
1868 frappe.throw(
1869 _("Can refer row only if the charge type is 'On Previous Row Amount' or 'Previous Row Total'")
1870 )
1871 elif tax.charge_type in ["On Previous Row Amount", "On Previous Row Total"]:
Nabin Hait613d0812015-02-23 11:58:15 +05301872 if cint(tax.idx) == 1:
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08001873 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301874 _(
1875 "Cannot select charge type as 'On Previous Row Amount' or 'On Previous Row Total' for first row"
1876 )
1877 )
Nabin Hait613d0812015-02-23 11:58:15 +05301878 elif not tax.row_id:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301879 frappe.throw(
1880 _("Please specify a valid Row ID for row {0} in table {1}").format(tax.idx, _(tax.doctype))
1881 )
Nabin Hait613d0812015-02-23 11:58:15 +05301882 elif tax.row_id and cint(tax.row_id) >= cint(tax.idx):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301883 frappe.throw(
1884 _("Cannot refer row number greater than or equal to current row number for this Charge type")
1885 )
Nabin Hait613d0812015-02-23 11:58:15 +05301886
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05301887 if tax.charge_type == "Actual":
Nabin Haitbc6c3602015-02-27 23:40:56 +05301888 tax.rate = None
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05301889
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08001890
Ankush Menat494bd9e2022-03-28 18:52:46 +05301891def validate_account_head(idx, account, company, context=""):
1892 account_company = frappe.get_cached_value("Account", account, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05301893
Deepesh Garg5a2b5712022-02-18 20:05:49 +05301894 if account_company != company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301895 frappe.throw(
1896 _("Row {0}: {3} Account {1} does not belong to Company {2}").format(
1897 idx, frappe.bold(account), frappe.bold(company), context
1898 ),
1899 title=_("Invalid Account"),
1900 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05301901
1902
1903def validate_cost_center(tax, doc):
1904 if not tax.cost_center:
1905 return
1906
Ankush Menat494bd9e2022-03-28 18:52:46 +05301907 company = frappe.get_cached_value("Cost Center", tax.cost_center, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05301908
1909 if company != doc.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301910 frappe.throw(
1911 _("Row {0}: Cost Center {1} does not belong to Company {2}").format(
1912 tax.idx, frappe.bold(tax.cost_center), frappe.bold(doc.company)
1913 ),
1914 title=_("Invalid Cost Center"),
1915 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05301916
1917
Nabin Hait613d0812015-02-23 11:58:15 +05301918def validate_inclusive_tax(tax, doc):
1919 def _on_previous_row_error(row_range):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301920 throw(
1921 _("To include tax in row {0} in Item rate, taxes in rows {1} must also be included").format(
1922 tax.idx, row_range
1923 )
1924 )
Nabin Hait613d0812015-02-23 11:58:15 +05301925
1926 if cint(getattr(tax, "included_in_print_rate", None)):
1927 if tax.charge_type == "Actual":
1928 # inclusive tax cannot be of type Actual
Ankush Menat494bd9e2022-03-28 18:52:46 +05301929 throw(
1930 _("Charge of type 'Actual' in row {0} cannot be included in Item Rate or Paid Amount").format(
1931 tax.idx
1932 )
1933 )
1934 elif tax.charge_type == "On Previous Row Amount" and not cint(
1935 doc.get("taxes")[cint(tax.row_id) - 1].included_in_print_rate
1936 ):
Nabin Hait613d0812015-02-23 11:58:15 +05301937 # referred row should also be inclusive
1938 _on_previous_row_error(tax.row_id)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301939 elif tax.charge_type == "On Previous Row Total" and not all(
1940 [cint(t.included_in_print_rate) for t in doc.get("taxes")[: cint(tax.row_id) - 1]]
1941 ):
Deepesh Garg5ef9a622021-06-14 14:34:44 +05301942 # all rows about the referred tax should be inclusive
Nabin Hait613d0812015-02-23 11:58:15 +05301943 _on_previous_row_error("1 - %d" % (tax.row_id,))
Nabin Hait93b3a372015-02-24 17:08:34 +05301944 elif tax.get("category") == "Valuation":
Nabin Hait19ea7212020-08-11 20:34:57 +05301945 frappe.throw(_("Valuation type charges can not be marked as Inclusive"))
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05301946
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05301947
Ankush Menat494bd9e2022-03-28 18:52:46 +05301948def set_balance_in_account_currency(
1949 gl_dict, account_currency=None, conversion_rate=None, company_currency=None
1950):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08001951 if (not conversion_rate) and (account_currency != company_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301952 frappe.throw(
1953 _("Account: {0} with currency: {1} can not be selected").format(
1954 gl_dict.account, account_currency
1955 )
1956 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08001957
Ankush Menat494bd9e2022-03-28 18:52:46 +05301958 gl_dict["account_currency"] = (
1959 company_currency if account_currency == company_currency else account_currency
1960 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05301961
1962 # set debit/credit in account currency if not provided
1963 if flt(gl_dict.debit) and not flt(gl_dict.debit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301964 gl_dict.debit_in_account_currency = (
1965 gl_dict.debit
1966 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05301967 else flt(gl_dict.debit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301968 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05301969
1970 if flt(gl_dict.credit) and not flt(gl_dict.credit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301971 gl_dict.credit_in_account_currency = (
1972 gl_dict.credit
1973 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05301974 else flt(gl_dict.credit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301975 )
Nabin Hait1991c7b2016-06-27 20:09:05 +05301976
1977
Ankush Menat494bd9e2022-03-28 18:52:46 +05301978def get_advance_journal_entries(
1979 party_type,
1980 party,
1981 party_account,
1982 amount_field,
1983 order_doctype,
1984 order_list,
1985 include_unallocated=True,
1986):
1987 dr_or_cr = (
1988 "credit_in_account_currency" if party_type == "Customer" else "debit_in_account_currency"
1989 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301990
Nabin Hait1991c7b2016-06-27 20:09:05 +05301991 conditions = []
1992 if include_unallocated:
1993 conditions.append("ifnull(t2.reference_name, '')=''")
1994
1995 if order_list:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301996 order_condition = ", ".join(["%s"] * len(order_list))
1997 conditions.append(
1998 " (t2.reference_type = '{0}' and ifnull(t2.reference_name, '') in ({1}))".format(
1999 order_doctype, order_condition
2000 )
2001 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302002
Nabin Hait1991c7b2016-06-27 20:09:05 +05302003 reference_condition = " and (" + " or ".join(conditions) + ")" if conditions else ""
Rushabh Mehta66958302017-01-16 16:57:53 +05302004
Deepesh Gargc38be532022-04-14 13:26:47 +05302005 # nosemgrep
Ankush Menat494bd9e2022-03-28 18:52:46 +05302006 journal_entries = frappe.db.sql(
2007 """
Nabin Hait1991c7b2016-06-27 20:09:05 +05302008 select
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302009 "Journal Entry" as reference_type, t1.name as reference_name,
Nabin Hait1991c7b2016-06-27 20:09:05 +05302010 t1.remark as remarks, t2.{0} as amount, t2.name as reference_row,
Deepesh Garg31883b62022-04-13 20:52:25 +05302011 t2.reference_name as against_order, t2.exchange_rate
Nabin Hait1991c7b2016-06-27 20:09:05 +05302012 from
2013 `tabJournal Entry` t1, `tabJournal Entry Account` t2
2014 where
2015 t1.name = t2.parent and t2.account = %s
2016 and t2.party_type = %s and t2.party = %s
2017 and t2.is_advance = 'Yes' and t1.docstatus = 1
Nabin Haitca627fb2016-09-05 16:16:53 +05302018 and {1} > 0 {2}
Ankush Menat494bd9e2022-03-28 18:52:46 +05302019 order by t1.posting_date""".format(
2020 amount_field, dr_or_cr, reference_condition
2021 ),
2022 [party_account, party_type, party] + order_list,
2023 as_dict=1,
2024 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302025
Nabin Hait1991c7b2016-06-27 20:09:05 +05302026 return list(journal_entries)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302027
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002028
Ankush Menat494bd9e2022-03-28 18:52:46 +05302029def get_advance_payment_entries(
2030 party_type,
2031 party,
2032 party_account,
2033 order_doctype,
2034 order_list=None,
2035 include_unallocated=True,
2036 against_all_orders=False,
2037 limit=None,
2038 condition=None,
2039):
Nabin Hait1991c7b2016-06-27 20:09:05 +05302040 party_account_field = "paid_from" if party_type == "Customer" else "paid_to"
Ankush Menat494bd9e2022-03-28 18:52:46 +05302041 currency_field = (
2042 "paid_from_account_currency" if party_type == "Customer" else "paid_to_account_currency"
2043 )
Nabin Hait1991c7b2016-06-27 20:09:05 +05302044 payment_type = "Receive" if party_type == "Customer" else "Pay"
Ankush Menat494bd9e2022-03-28 18:52:46 +05302045 exchange_rate_field = (
2046 "source_exchange_rate" if payment_type == "Receive" else "target_exchange_rate"
2047 )
Saqiba20999c2021-07-12 14:33:23 +05302048
Nabin Hait1991c7b2016-06-27 20:09:05 +05302049 payment_entries_against_order, unallocated_payment_entries = [], []
Nabin Hait34c551d2019-07-03 10:34:31 +05302050 limit_cond = "limit %s" % limit if limit else ""
Nabin Haitff2f3ef2016-07-04 11:41:14 +05302051
Nabin Hait1991c7b2016-06-27 20:09:05 +05302052 if order_list or against_all_orders:
2053 if order_list:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302054 reference_condition = " and t2.reference_name in ({0})".format(
2055 ", ".join(["%s"] * len(order_list))
2056 )
Nabin Hait1991c7b2016-06-27 20:09:05 +05302057 else:
2058 reference_condition = ""
2059 order_list = []
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302060
Ankush Menat494bd9e2022-03-28 18:52:46 +05302061 payment_entries_against_order = frappe.db.sql(
2062 """
Nabin Hait1991c7b2016-06-27 20:09:05 +05302063 select
2064 "Payment Entry" as reference_type, t1.name as reference_name,
2065 t1.remarks, t2.allocated_amount as amount, t2.name as reference_row,
Deepesh Gargc7eadfc2020-07-22 17:59:37 +05302066 t2.reference_name as against_order, t1.posting_date,
Saqiba20999c2021-07-12 14:33:23 +05302067 t1.{0} as currency, t1.{4} as exchange_rate
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302068 from `tabPayment Entry` t1, `tabPayment Entry Reference` t2
Nabin Hait1991c7b2016-06-27 20:09:05 +05302069 where
Deepesh Gargc7eadfc2020-07-22 17:59:37 +05302070 t1.name = t2.parent and t1.{1} = %s and t1.payment_type = %s
Nabin Hait1991c7b2016-06-27 20:09:05 +05302071 and t1.party_type = %s and t1.party = %s and t1.docstatus = 1
Deepesh Gargc7eadfc2020-07-22 17:59:37 +05302072 and t2.reference_doctype = %s {2}
2073 order by t1.posting_date {3}
Ankush Menat494bd9e2022-03-28 18:52:46 +05302074 """.format(
2075 currency_field, party_account_field, reference_condition, limit_cond, exchange_rate_field
2076 ),
2077 [party_account, payment_type, party_type, party, order_doctype] + order_list,
2078 as_dict=1,
2079 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302080
Nabin Hait1991c7b2016-06-27 20:09:05 +05302081 if include_unallocated:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302082 unallocated_payment_entries = frappe.db.sql(
2083 """
Anuja Pawar3e404f12021-08-31 18:59:29 +05302084 select "Payment Entry" as reference_type, name as reference_name, posting_date,
2085 remarks, unallocated_amount as amount, {2} as exchange_rate, {3} as currency
Nabin Hait1991c7b2016-06-27 20:09:05 +05302086 from `tabPayment Entry`
2087 where
2088 {0} = %s and party_type = %s and party = %s and payment_type = %s
Anuja Pawar3e404f12021-08-31 18:59:29 +05302089 and docstatus = 1 and unallocated_amount > 0 {condition}
Rohit Waghchauref7258162019-01-15 18:12:04 +05302090 order by posting_date {1}
Ankush Menat494bd9e2022-03-28 18:52:46 +05302091 """.format(
2092 party_account_field, limit_cond, exchange_rate_field, currency_field, condition=condition or ""
2093 ),
2094 (party_account, party_type, party, payment_type),
2095 as_dict=1,
2096 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302097
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302098 return list(payment_entries_against_order) + list(unallocated_payment_entries)
2099
Ankush Menat494bd9e2022-03-28 18:52:46 +05302100
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302101def update_invoice_status():
Sagar Vorac8b9a552021-09-22 12:11:35 +05302102 """Updates status as Overdue for applicable invoices. Runs daily."""
Sagar Vora8d9d0982021-10-20 19:15:35 +05302103 today = getdate()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302104 payment_schedule = frappe.qb.DocType("Payment Schedule")
Sagar Vorac8b9a552021-09-22 12:11:35 +05302105 for doctype in ("Sales Invoice", "Purchase Invoice"):
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302106 invoice = frappe.qb.DocType(doctype)
2107
2108 consider_base_amount = invoice.party_account_currency != invoice.currency
2109 payment_amount = (
2110 frappe.qb.terms.Case()
2111 .when(consider_base_amount, payment_schedule.base_payment_amount)
2112 .else_(payment_schedule.payment_amount)
Sagar Vora8d9d0982021-10-20 19:15:35 +05302113 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002114
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302115 payable_amount = (
2116 frappe.qb.from_(payment_schedule)
2117 .select(Sum(payment_amount))
Ankush Menat494bd9e2022-03-28 18:52:46 +05302118 .where((payment_schedule.parent == invoice.name) & (payment_schedule.due_date < today))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302119 )
2120
2121 total = (
2122 frappe.qb.terms.Case()
2123 .when(invoice.disable_rounded_total, invoice.grand_total)
2124 .else_(invoice.rounded_total)
2125 )
2126
2127 base_total = (
2128 frappe.qb.terms.Case()
2129 .when(invoice.disable_rounded_total, invoice.base_grand_total)
2130 .else_(invoice.base_rounded_total)
2131 )
2132
Ankush Menat494bd9e2022-03-28 18:52:46 +05302133 total_amount = frappe.qb.terms.Case().when(consider_base_amount, base_total).else_(total)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302134
2135 is_overdue = total_amount - invoice.outstanding_amount < payable_amount
2136
2137 conditions = (
2138 (invoice.docstatus == 1)
2139 & (invoice.outstanding_amount > 0)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302140 & (invoice.status.like("Unpaid%") | invoice.status.like("Partly Paid%"))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302141 & (
Pruthvi Patel16a90d32021-12-20 13:24:19 +05302142 ((invoice.is_pos & invoice.due_date < today) | is_overdue)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302143 if doctype == "Sales Invoice"
2144 else is_overdue
2145 )
2146 )
2147
Pruthvi Patel0799f372021-11-12 12:56:29 +05302148 status = (
2149 frappe.qb.terms.Case()
2150 .when(invoice.status.like("%Discounted"), "Overdue and Discounted")
2151 .else_("Overdue")
2152 )
2153
2154 frappe.qb.update(invoice).set("status", status).where(conditions).run()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302155
2156
Nabin Hait92759692017-08-15 08:23:51 +05302157@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302158def get_payment_terms(
2159 terms_template, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2160):
Nabin Hait92759692017-08-15 08:23:51 +05302161 if not terms_template:
2162 return
2163
2164 terms_doc = frappe.get_doc("Payment Terms Template", terms_template)
2165
2166 schedule = []
tundefb144302017-08-19 15:01:40 +01002167 for d in terms_doc.get("terms"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302168 term_details = get_payment_term_details(
2169 d, posting_date, grand_total, base_grand_total, bill_date
2170 )
Nabin Hait92759692017-08-15 08:23:51 +05302171 schedule.append(term_details)
2172
2173 return schedule
2174
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002175
Nabin Hait92759692017-08-15 08:23:51 +05302176@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302177def get_payment_term_details(
2178 term, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2179):
Nabin Hait92759692017-08-15 08:23:51 +05302180 term_details = frappe._dict()
Ankush Menat8fe5feb2021-11-04 19:48:32 +05302181 if isinstance(term, str):
Nabin Hait92759692017-08-15 08:23:51 +05302182 term = frappe.get_doc("Payment Term", term)
2183 else:
2184 term_details.payment_term = term.payment_term
2185 term_details.description = term.description
2186 term_details.invoice_portion = term.invoice_portion
Rohit Waghchaure52bf56d2017-11-27 11:43:52 +05302187 term_details.payment_amount = flt(term.invoice_portion) * flt(grand_total) / 100
Saqib Ansarid552fe62021-04-23 14:46:52 +05302188 term_details.base_payment_amount = flt(term.invoice_portion) * flt(base_grand_total) / 100
Saqib0586b7d2021-03-31 15:03:53 +05302189 term_details.discount_type = term.discount_type
2190 term_details.discount = term.discount
Saqib0586b7d2021-03-31 15:03:53 +05302191 term_details.outstanding = term_details.payment_amount
2192 term_details.mode_of_payment = term.mode_of_payment
2193
Shreya Shah3a9eec22018-02-16 13:05:21 +05302194 if bill_date:
2195 term_details.due_date = get_due_date(term, bill_date)
Saqib0586b7d2021-03-31 15:03:53 +05302196 term_details.discount_date = get_discount_date(term, bill_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302197 elif posting_date:
2198 term_details.due_date = get_due_date(term, posting_date)
Saqib0586b7d2021-03-31 15:03:53 +05302199 term_details.discount_date = get_discount_date(term, posting_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302200
2201 if getdate(term_details.due_date) < getdate(posting_date):
2202 term_details.due_date = posting_date
2203
Nabin Hait92759692017-08-15 08:23:51 +05302204 return term_details
2205
Ankush Menat494bd9e2022-03-28 18:52:46 +05302206
Shreya Shah3a9eec22018-02-16 13:05:21 +05302207def get_due_date(term, posting_date=None, bill_date=None):
Nabin Hait92759692017-08-15 08:23:51 +05302208 due_date = None
Shreya Shah3a9eec22018-02-16 13:05:21 +05302209 date = bill_date or posting_date
Nabin Hait92759692017-08-15 08:23:51 +05302210 if term.due_date_based_on == "Day(s) after invoice date":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302211 due_date = add_days(date, term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302212 elif term.due_date_based_on == "Day(s) after the end of the invoice month":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302213 due_date = add_days(get_last_day(date), term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302214 elif term.due_date_based_on == "Month(s) after the end of the invoice month":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302215 due_date = add_months(get_last_day(date), term.credit_months)
tunde96b8f222017-09-08 15:35:59 +01002216 return due_date
tundebabzyad08d4c2018-05-16 07:01:41 +01002217
Ankush Menat494bd9e2022-03-28 18:52:46 +05302218
Saqib0586b7d2021-03-31 15:03:53 +05302219def get_discount_date(term, posting_date=None, bill_date=None):
2220 discount_validity = None
2221 date = bill_date or posting_date
2222 if term.discount_validity_based_on == "Day(s) after invoice date":
2223 discount_validity = add_days(date, term.discount_validity)
2224 elif term.discount_validity_based_on == "Day(s) after the end of the invoice month":
2225 discount_validity = add_days(get_last_day(date), term.discount_validity)
2226 elif term.discount_validity_based_on == "Month(s) after the end of the invoice month":
2227 discount_validity = add_months(get_last_day(date), term.discount_validity)
2228 return discount_validity
tundebabzyad08d4c2018-05-16 07:01:41 +01002229
Ankush Menat494bd9e2022-03-28 18:52:46 +05302230
tundebabzyad08d4c2018-05-16 07:01:41 +01002231def get_supplier_block_status(party_name):
2232 """
2233 Returns a dict containing the values of `on_hold`, `release_date` and `hold_type` of
2234 a `Supplier`
2235 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302236 supplier = frappe.get_doc("Supplier", party_name)
tundebabzyad08d4c2018-05-16 07:01:41 +01002237 info = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302238 "on_hold": supplier.on_hold,
2239 "release_date": supplier.release_date,
2240 "hold_type": supplier.hold_type,
tundebabzyad08d4c2018-05-16 07:01:41 +01002241 }
2242 return info
2243
Ankush Menat494bd9e2022-03-28 18:52:46 +05302244
marination698d9832020-08-19 14:59:46 +05302245def set_child_tax_template_and_map(item, child_item, parent_doc):
2246 args = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302247 "item_code": item.item_code,
2248 "posting_date": parent_doc.transaction_date,
2249 "tax_category": parent_doc.get("tax_category"),
2250 "company": parent_doc.get("company"),
2251 }
marination698d9832020-08-19 14:59:46 +05302252
2253 child_item.item_tax_template = _get_item_tax_template(args, item.taxes)
2254 if child_item.get("item_tax_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302255 child_item.item_tax_rate = get_item_tax_map(
2256 parent_doc.get("company"), child_item.item_tax_template, as_json=True
2257 )
2258
marination698d9832020-08-19 14:59:46 +05302259
Afshanb3bbebd2021-08-09 14:39:32 +05302260def add_taxes_from_tax_template(child_item, parent_doc, db_insert=True):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302261 add_taxes_from_item_tax_template = frappe.db.get_single_value(
2262 "Accounts Settings", "add_taxes_from_item_tax_template"
2263 )
Marica3b1be2b2020-10-22 17:04:31 +05302264
2265 if child_item.get("item_tax_rate") and add_taxes_from_item_tax_template:
2266 tax_map = json.loads(child_item.get("item_tax_rate"))
2267 for tax_type in tax_map:
2268 tax_rate = flt(tax_map[tax_type])
Ankush Menat494bd9e2022-03-28 18:52:46 +05302269 taxes = parent_doc.get("taxes") or []
Marica3b1be2b2020-10-22 17:04:31 +05302270 # add new row for tax head only if missing
2271 found = any(tax.account_head == tax_type for tax in taxes)
2272 if not found:
2273 tax_row = parent_doc.append("taxes", {})
Ankush Menat494bd9e2022-03-28 18:52:46 +05302274 tax_row.update(
2275 {
2276 "description": str(tax_type).split(" - ")[0],
2277 "charge_type": "On Net Total",
2278 "account_head": tax_type,
2279 "rate": tax_rate,
2280 }
2281 )
Marica3b1be2b2020-10-22 17:04:31 +05302282 if parent_doc.doctype == "Purchase Order":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302283 tax_row.update({"category": "Total", "add_deduct_tax": "Add"})
Afshanb3bbebd2021-08-09 14:39:32 +05302284 if db_insert:
2285 tax_row.db_insert()
Marica3b1be2b2020-10-22 17:04:31 +05302286
Ankush Menat494bd9e2022-03-28 18:52:46 +05302287
2288def set_order_defaults(
2289 parent_doctype, parent_doctype_name, child_doctype, child_docname, trans_item
2290):
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002291 """
pateljannat637ddff2021-02-09 16:17:30 +05302292 Returns a Sales/Purchase Order Item child item containing the default values
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002293 """
Saqib438e0432020-04-03 10:02:56 +05302294 p_doc = frappe.get_doc(parent_doctype, parent_doctype_name)
pateljannat637ddff2021-02-09 16:17:30 +05302295 child_item = frappe.new_doc(child_doctype, p_doc, child_docname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302296 item = frappe.get_doc("Item", trans_item.get("item_code"))
marination0673f552021-03-31 01:38:22 +05302297
pateljannat637ddff2021-02-09 16:17:30 +05302298 for field in ("item_code", "item_name", "description", "item_group"):
marination0673f552021-03-31 01:38:22 +05302299 child_item.update({field: item.get(field)})
2300
pateljannat637ddff2021-02-09 16:17:30 +05302301 date_fieldname = "delivery_date" if child_doctype == "Sales Order Item" else "schedule_date"
Jannat Patelbb0d8f82021-02-11 20:59:28 +05302302 child_item.update({date_fieldname: trans_item.get(date_fieldname) or p_doc.get(date_fieldname)})
marination0673f552021-03-31 01:38:22 +05302303 child_item.stock_uom = item.stock_uom
Saqib61314242020-09-15 11:14:31 +05302304 child_item.uom = trans_item.get("uom") or item.stock_uom
Andy Zhu1062d7e2020-10-06 10:51:42 +13002305 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302306 conversion_factor = flt(
2307 get_conversion_factor(item.item_code, child_item.uom).get("conversion_factor")
2308 )
2309 child_item.conversion_factor = flt(trans_item.get("conversion_factor")) or conversion_factor
marination0673f552021-03-31 01:38:22 +05302310
pateljannat637ddff2021-02-09 16:17:30 +05302311 if child_doctype == "Purchase Order Item":
marination0673f552021-03-31 01:38:22 +05302312 # Initialized value will update in parent validation
2313 child_item.base_rate = 1
2314 child_item.base_amount = 1
pateljannat637ddff2021-02-09 16:17:30 +05302315 if child_doctype == "Sales Order Item":
2316 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
2317 if not child_item.warehouse:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302318 frappe.throw(
2319 _("Cannot find {} for item {}. Please set the same in Item Master or Stock Settings.").format(
2320 frappe.bold("default warehouse"), frappe.bold(item.item_code)
2321 )
2322 )
marination0673f552021-03-31 01:38:22 +05302323
marination698d9832020-08-19 14:59:46 +05302324 set_child_tax_template_and_map(item, child_item, p_doc)
Marica3b1be2b2020-10-22 17:04:31 +05302325 add_taxes_from_tax_template(child_item, p_doc)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002326 return child_item
2327
Ankush Menat494bd9e2022-03-28 18:52:46 +05302328
marination0673f552021-03-31 01:38:22 +05302329def validate_child_on_delete(row, parent):
2330 """Check if partially transacted item (row) is being deleted."""
2331 if parent.doctype == "Sales Order":
2332 if flt(row.delivered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302333 frappe.throw(
2334 _("Row #{0}: Cannot delete item {1} which has already been delivered").format(
2335 row.idx, row.item_code
2336 )
2337 )
marination0673f552021-03-31 01:38:22 +05302338 if flt(row.work_order_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302339 frappe.throw(
2340 _("Row #{0}: Cannot delete item {1} which has work order assigned to it.").format(
2341 row.idx, row.item_code
2342 )
2343 )
marination0673f552021-03-31 01:38:22 +05302344 if flt(row.ordered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302345 frappe.throw(
2346 _("Row #{0}: Cannot delete item {1} which is assigned to customer's purchase order.").format(
2347 row.idx, row.item_code
2348 )
2349 )
marination0673f552021-03-31 01:38:22 +05302350
2351 if parent.doctype == "Purchase Order" and flt(row.received_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302352 frappe.throw(
2353 _("Row #{0}: Cannot delete item {1} which has already been received").format(
2354 row.idx, row.item_code
2355 )
2356 )
marination0673f552021-03-31 01:38:22 +05302357
2358 if flt(row.billed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302359 frappe.throw(
2360 _("Row #{0}: Cannot delete item {1} which has already been billed.").format(
2361 row.idx, row.item_code
2362 )
2363 )
2364
marination0673f552021-03-31 01:38:22 +05302365
2366def update_bin_on_delete(row, doctype):
2367 """Update bin for deleted item (row)."""
Chillar Anand915b3432021-09-02 16:44:59 +05302368 from erpnext.stock.stock_balance import (
2369 get_indented_qty,
2370 get_ordered_qty,
2371 get_reserved_qty,
2372 update_bin_qty,
2373 )
Ankush Menat494bd9e2022-03-28 18:52:46 +05302374
marination0673f552021-03-31 01:38:22 +05302375 qty_dict = {}
2376
2377 if doctype == "Sales Order":
2378 qty_dict["reserved_qty"] = get_reserved_qty(row.item_code, row.warehouse)
2379 else:
2380 if row.material_request_item:
2381 qty_dict["indented_qty"] = get_indented_qty(row.item_code, row.warehouse)
2382
2383 qty_dict["ordered_qty"] = get_ordered_qty(row.item_code, row.warehouse)
2384
Deepesh Garga61790c2022-02-22 20:58:10 +05302385 if row.warehouse:
2386 update_bin_qty(row.item_code, row.warehouse, qty_dict)
marination0673f552021-03-31 01:38:22 +05302387
Ankush Menat494bd9e2022-03-28 18:52:46 +05302388
Saqib6db92fb2020-09-14 19:54:17 +05302389def validate_and_delete_children(parent, data):
Saqib0ad74492019-12-24 16:42:30 +05302390 deleted_children = []
2391 updated_item_names = [d.get("docname") for d in data]
2392 for item in parent.items:
2393 if item.name not in updated_item_names:
2394 deleted_children.append(item)
2395
2396 for d in deleted_children:
marination0673f552021-03-31 01:38:22 +05302397 validate_child_on_delete(d, parent)
Saqib0ad74492019-12-24 16:42:30 +05302398 d.cancel()
2399 d.delete()
marination0673f552021-03-31 01:38:22 +05302400
2401 # need to update ordered qty in Material Request first
2402 # bin uses Material Request Items to recalculate & update
2403 parent.update_prevdoc_status()
2404
2405 for d in deleted_children:
2406 update_bin_on_delete(d, parent.doctype)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002407
Rohan Bansala93b5142021-04-06 17:10:52 +05302408
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002409@frappe.whitelist()
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002410def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, child_docname="items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302411 def check_doc_permissions(doc, perm_type="create"):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05302412 try:
2413 doc.check_permission(perm_type)
Saqib6db92fb2020-09-14 19:54:17 +05302414 except frappe.PermissionError:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302415 actions = {"create": "add", "write": "update"}
Saqib6db92fb2020-09-14 19:54:17 +05302416
Ankush Menat494bd9e2022-03-28 18:52:46 +05302417 frappe.throw(
2418 _("You do not have permissions to {} items in a {}.").format(
2419 actions[perm_type], parent_doctype
2420 ),
2421 title=_("Insufficient Permissions"),
2422 )
marination665c27a2020-09-15 12:04:38 +05302423
Saqib6db92fb2020-09-14 19:54:17 +05302424 def validate_workflow_conditions(doc):
2425 workflow = get_workflow_name(doc.doctype)
2426 if not workflow:
2427 return
2428
2429 workflow_doc = frappe.get_doc("Workflow", workflow)
2430 current_state = doc.get(workflow_doc.workflow_state_field)
2431 roles = frappe.get_roles()
2432
2433 transitions = []
2434 for transition in workflow_doc.transitions:
2435 if transition.next_state == current_state and transition.allowed in roles:
2436 if not is_transition_condition_satisfied(transition, doc):
2437 continue
2438 transitions.append(transition.as_dict())
2439
2440 if not transitions:
Saqib18318932020-09-23 13:01:49 +05302441 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302442 _("You are not allowed to update as per the conditions set in {} Workflow.").format(
2443 get_link_to_form("Workflow", workflow)
2444 ),
2445 title=_("Insufficient Permissions"),
Saqib18318932020-09-23 13:01:49 +05302446 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05302447
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05302448 def get_new_child_item(item_row):
Rohit Waghchaureff70e612021-03-06 22:08:08 +05302449 child_doctype = "Sales Order Item" if parent_doctype == "Sales Order" else "Purchase Order Item"
Ankush Menat494bd9e2022-03-28 18:52:46 +05302450 return set_order_defaults(
2451 parent_doctype, parent_doctype_name, child_doctype, child_docname, item_row
2452 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05302453
2454 def validate_quantity(child_item, d):
2455 if parent_doctype == "Sales Order" and flt(d.get("qty")) < flt(child_item.delivered_qty):
2456 frappe.throw(_("Cannot set quantity less than delivered quantity"))
2457
2458 if parent_doctype == "Purchase Order" and flt(d.get("qty")) < flt(child_item.received_qty):
2459 frappe.throw(_("Cannot set quantity less than received quantity"))
2460
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002461 data = json.loads(trans_items)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002462
Ankush Menat494bd9e2022-03-28 18:52:46 +05302463 sales_doctypes = ["Sales Order", "Sales Invoice", "Delivery Note", "Quotation"]
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302464 parent = frappe.get_doc(parent_doctype, parent_doctype_name)
marination665c27a2020-09-15 12:04:38 +05302465
Ankush Menat494bd9e2022-03-28 18:52:46 +05302466 check_doc_permissions(parent, "write")
Saqib6db92fb2020-09-14 19:54:17 +05302467 validate_and_delete_children(parent, data)
Saqib0ad74492019-12-24 16:42:30 +05302468
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002469 for d in data:
2470 new_child_flag = False
Ankush Menat6de7b8e2021-08-24 12:18:40 +05302471
2472 if not d.get("item_code"):
2473 # ignore empty rows
2474 continue
2475
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002476 if not d.get("docname"):
2477 new_child_flag = True
Ankush Menat494bd9e2022-03-28 18:52:46 +05302478 check_doc_permissions(parent, "create")
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05302479 child_item = get_new_child_item(d)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002480 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302481 check_doc_permissions(parent, "write")
2482 child_item = frappe.get_doc(parent_doctype + " Item", d.get("docname"))
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05302483
Saqib Ansaric579b082020-05-29 22:21:50 +05302484 prev_rate, new_rate = flt(child_item.get("rate")), flt(d.get("rate"))
2485 prev_qty, new_qty = flt(child_item.get("qty")), flt(d.get("qty"))
Ankush Menat494bd9e2022-03-28 18:52:46 +05302486 prev_con_fac, new_con_fac = flt(child_item.get("conversion_factor")), flt(
2487 d.get("conversion_factor")
2488 )
Saqib61314242020-09-15 11:14:31 +05302489 prev_uom, new_uom = child_item.get("uom"), d.get("uom")
Saqib Ansaric579b082020-05-29 22:21:50 +05302490
Ankush Menat494bd9e2022-03-28 18:52:46 +05302491 if parent_doctype == "Sales Order":
Saqib Ansaric579b082020-05-29 22:21:50 +05302492 prev_date, new_date = child_item.get("delivery_date"), d.get("delivery_date")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302493 elif parent_doctype == "Purchase Order":
marinationb7e94cc2020-06-15 11:32:42 +05302494 prev_date, new_date = child_item.get("schedule_date"), d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05302495
2496 rate_unchanged = prev_rate == new_rate
marinationf9c4b202020-06-12 15:49:53 +05302497 qty_unchanged = prev_qty == new_qty
Saqib61314242020-09-15 11:14:31 +05302498 uom_unchanged = prev_uom == new_uom
Saqib Ansaric579b082020-05-29 22:21:50 +05302499 conversion_factor_unchanged = prev_con_fac == new_con_fac
Ankush Menat494bd9e2022-03-28 18:52:46 +05302500 date_unchanged = (
2501 prev_date == getdate(new_date) if prev_date and new_date else False
2502 ) # in case of delivery note etc
2503 if (
2504 rate_unchanged
2505 and qty_unchanged
2506 and conversion_factor_unchanged
2507 and uom_unchanged
2508 and date_unchanged
2509 ):
Saqibdd374ff2020-02-27 12:51:31 +05302510 continue
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002511
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05302512 validate_quantity(child_item, d)
deepeshgarg00777cde832018-12-27 15:56:51 +05302513
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002514 child_item.qty = flt(d.get("qty"))
Saqib56fea7d2020-10-09 21:19:25 +05302515 rate_precision = child_item.precision("rate") or 2
2516 conv_fac_precision = child_item.precision("conversion_factor") or 2
2517 qty_precision = child_item.precision("qty") or 2
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002518
Ankush Menat494bd9e2022-03-28 18:52:46 +05302519 if flt(child_item.billed_amt, rate_precision) > flt(
2520 flt(d.get("rate"), rate_precision) * flt(d.get("qty"), qty_precision), rate_precision
2521 ):
2522 frappe.throw(
2523 _("Row #{0}: Cannot set Rate if amount is greater than billed amount for Item {1}.").format(
2524 child_item.idx, child_item.item_code
2525 )
2526 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002527 else:
Saqib56fea7d2020-10-09 21:19:25 +05302528 child_item.rate = flt(d.get("rate"), rate_precision)
marinationf9c4b202020-06-12 15:49:53 +05302529
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05302530 if d.get("conversion_factor"):
marinationf9c4b202020-06-12 15:49:53 +05302531 if child_item.stock_uom == child_item.uom:
2532 child_item.conversion_factor = 1
2533 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302534 child_item.conversion_factor = flt(d.get("conversion_factor"), conv_fac_precision)
marination665c27a2020-09-15 12:04:38 +05302535
Saqib61314242020-09-15 11:14:31 +05302536 if d.get("uom"):
2537 child_item.uom = d.get("uom")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302538 conversion_factor = flt(
2539 get_conversion_factor(child_item.item_code, child_item.uom).get("conversion_factor")
2540 )
2541 child_item.conversion_factor = (
2542 flt(d.get("conversion_factor"), conv_fac_precision) or conversion_factor
2543 )
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05302544
Ankush Menat494bd9e2022-03-28 18:52:46 +05302545 if d.get("delivery_date") and parent_doctype == "Sales Order":
2546 child_item.delivery_date = d.get("delivery_date")
marinationf9c4b202020-06-12 15:49:53 +05302547
Ankush Menat494bd9e2022-03-28 18:52:46 +05302548 if d.get("schedule_date") and parent_doctype == "Purchase Order":
2549 child_item.schedule_date = d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05302550
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05302551 if flt(child_item.price_list_rate):
Maricaf0674472019-10-11 10:47:09 +05302552 if flt(child_item.rate) > flt(child_item.price_list_rate):
2553 # if rate is greater than price_list_rate, set margin
2554 # or set discount
2555 child_item.discount_percentage = 0
rohitwaghchaure81c21752019-10-31 15:56:10 +05302556
2557 if parent_doctype in sales_doctypes:
2558 child_item.margin_type = "Amount"
Ankush Menat494bd9e2022-03-28 18:52:46 +05302559 child_item.margin_rate_or_amount = flt(
2560 child_item.rate - child_item.price_list_rate, child_item.precision("margin_rate_or_amount")
2561 )
rohitwaghchaure81c21752019-10-31 15:56:10 +05302562 child_item.rate_with_margin = child_item.rate
Maricaf0674472019-10-11 10:47:09 +05302563 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302564 child_item.discount_percentage = flt(
2565 (1 - flt(child_item.rate) / flt(child_item.price_list_rate)) * 100.0,
2566 child_item.precision("discount_percentage"),
2567 )
2568 child_item.discount_amount = flt(child_item.price_list_rate) - flt(child_item.rate)
rohitwaghchaure81c21752019-10-31 15:56:10 +05302569
2570 if parent_doctype in sales_doctypes:
2571 child_item.margin_type = ""
2572 child_item.margin_rate_or_amount = 0
2573 child_item.rate_with_margin = 0
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05302574
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002575 child_item.flags.ignore_validate_update_after_submit = True
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002576 if new_child_flag:
Saqib Ansarif53299e2020-04-15 22:08:12 +05302577 parent.load_from_db()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302578 child_item.idx = len(parent.items) + 1
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002579 child_item.insert()
2580 else:
2581 child_item.save()
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002582
Rushabh Mehtafafbb022018-12-24 22:09:15 +05302583 parent.reload()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302584 parent.flags.ignore_validate_update_after_submit = True
2585 parent.set_qty_as_per_stock_uom()
2586 parent.calculate_taxes_and_totals()
Ankush Menatdf6e2082021-02-11 11:04:39 +05302587 parent.set_total_in_words()
Nabin Hait49a46f02019-10-21 13:35:43 +05302588 if parent_doctype == "Sales Order":
Marica3dee5272020-06-23 10:33:47 +05302589 make_packing_list(parent)
Nabin Hait49a46f02019-10-21 13:35:43 +05302590 parent.set_gross_profit()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302591 frappe.get_doc("Authorization Control").validate_approving_authority(
2592 parent.doctype, parent.company, parent.base_grand_total
2593 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002594
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302595 parent.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302596 if parent_doctype == "Purchase Order":
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302597 parent.validate_minimum_order_qty()
2598 parent.validate_budget()
2599 if parent.is_against_so():
2600 parent.update_status_updater()
Nabin Haitb2da0822018-07-13 17:01:40 +05302601 else:
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302602 parent.check_credit_limit()
Ankush Menat733c9de2022-01-04 18:39:30 +05302603
2604 # reset index of child table
2605 for idx, row in enumerate(parent.get(child_docname), start=1):
2606 row.idx = idx
2607
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302608 parent.save()
Nabin Haitb2da0822018-07-13 17:01:40 +05302609
Ankush Menat494bd9e2022-03-28 18:52:46 +05302610 if parent_doctype == "Purchase Order":
2611 update_last_purchase_rate(parent, is_submit=1)
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302612 parent.update_prevdoc_status()
2613 parent.update_requested_qty()
2614 parent.update_ordered_qty()
2615 parent.update_ordered_and_reserved_qty()
2616 parent.update_receiving_percentage()
Sagar Sharmad074c932022-03-31 19:57:42 +05302617 if parent.is_subcontracted:
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302618 parent.update_reserved_qty_for_subcontract()
Saqib61314242020-09-15 11:14:31 +05302619 parent.create_raw_materials_supplied("supplied_items")
2620 parent.save()
Nabin Haitb2da0822018-07-13 17:01:40 +05302621 else:
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302622 parent.update_reserved_qty()
2623 parent.update_project()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302624 parent.update_prevdoc_status("submit")
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302625 parent.update_delivery_status()
Nabin Haitb2da0822018-07-13 17:01:40 +05302626
Saqib6db92fb2020-09-14 19:54:17 +05302627 parent.reload()
2628 validate_workflow_conditions(parent)
2629
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05302630 parent.update_blanket_order()
2631 parent.update_billing_percentage()
2632 parent.set_status()
Gauravf1e28e02019-02-13 16:46:24 +05302633
Ankush Menat494bd9e2022-03-28 18:52:46 +05302634
Gauravf1e28e02019-02-13 16:46:24 +05302635@erpnext.allow_regional
2636def validate_regional(doc):
2637 pass
Saqib Ansaric5782b02022-01-27 20:09:56 +05302638
Ankush Menat494bd9e2022-03-28 18:52:46 +05302639
Saqib Ansaric5782b02022-01-27 20:09:56 +05302640@erpnext.allow_regional
2641def validate_einvoice_fields(doc):
2642 pass